メモリ関数のコード置換

この例では、関数 memcpy に対するコード置換の定義方法に関する情報を提供することで、メモリ関数のパフォーマンスを最適化するコード置換ライブラリを開発する方法を示します。コード置換ライブラリを開発するには、対話的な方法またはプログラムによる方法のいずれかを使用します。詳細については、コード置換ライブラリの開発を参照してください。

対話的なコード置換ライブラリの開発

MATLAB コマンドラインから次のコマンドを使用してコード置換ツール (crtool) を開きます。
```
>>crtool
```
table を作成します。
1. crtool のコンテキストメニューから、[ファイル]、[新しいテーブル] を選択します。
2. 右側のペインで、table に crl_table_memcpy と名前を付けます。[適用] をクリックします。
エントリを作成します。crtool のコンテキストメニューから、[ファイル]、[新しいエントリ]、[関数] を選択します。
エントリパラメーターを作成します。[関数] ドロップダウンリストで、[memcpy] を選択します。
概念表現を作成します。概念表現は、置換する関数のシグネチャを記述します。crtool の [概念関数] サブセクションで、void の [データ型] およびポインターの [引数タイプ] をもつ戻り引数 y1、void の [データ型] およびポインターの [引数タイプ] をもつ入力引数 u1 および u2、符号なし整数の [データ型] およびスカラーの [引数タイプ] をもつ u3 を指定します。
実装表現を作成します。実装表現は最適化関数のシグネチャを記述します。この例では、概念引数と同じ順序およびプロパティをもつ実装引数を指定するために、[概念引数と実装引数のタイプを同じにする] チェックボックスをオンにします。
[関数プロトタイプ] の下にある置換関数に対して [名前] を指定します。
ビルド情報を指定します。[ビルド情報] タブをクリックして、ビルド要件のペインを開きます。コードジェネレーターがコード置換に必要なファイル (ソース、ヘッダー、オブジェクト) を指定します。この例では、ビルド情報を指定する必要はありません。
table を確認して保存します。[マッピング情報] タブで、[エントリの検証] をクリックします。crtool のコンテキストメニューから、[ファイル]、[テーブルの保存]、[保存] を選択します。
コード置換ライブラリを登録します。登録することにより、指定した table で構成されるライブラリが作成されます。[ファイル]、[登録ファイルの作成] を選択します。[登録ファイルの作成] ダイアログボックスで、以下のフィールドに入力します。
コード置換ライブラリを使用するには、現在の MATLAB セッションを次のコマンドで更新します。
```
>>sl_refresh_customizations
```
コード置換ライブラリを確認します。MATLAB コマンドラインから、コード置換ビューアーを使用してライブラリを開き、table およびエントリが正しく指定されていることを確認します。詳細については、Verify Code Replacement Libraryを参照してください。コード置換ライブラリを使用するようにモデルを構成し、コードを生成して、その置換が予期したとおりに行われることを確認します。予期しない動作が行われた場合、ヒットログとミスログを調べて問題のトラブルシューティングを行います。

プログラムによるコード置換ライブラリの開発

[新規]、[関数] を選択し、[MATLAB] メニューからプログラムインターフェイスを開きます。
table を作成します。
1. コード置換ライブラリテーブルを呼び出す関数を作成します。この関数は引数をもつべきではなく、table オブジェクトを返します。
2. RTW.TflTable を呼び出して table オブジェクトを作成します。
```
function hTable = crl_table_memcpy()
% Create a function to call the code replacement library table 

%% Create a table object
hTable = RTW.TflTable;
```
エントリを作成します。この例では関数を置き換えるため、エントリ関数 RTW.TflCFunctionEntry を呼び出して table にコード置換エントリを作成します。
```
function hTable = crl_table_memcpy()
% Create a code replacement library table 

%% Create a table object
hTable = RTW.TflTable;

%% Create an entry
hEntry = rtw.TflCFunctionEntry;
```

エントリパラメーターを作成します。この例では関数を置き換えるため、関数 setTflCFunctionEntryParameters を呼び出してエントリパラメーターを作成します。

function hTable = crl_table_memcpy()
% Create a code replacement library table 

%% Create a table object
hTable = RTW.TflTable;

%% Create an entry 
hEntry = RTW.TflCFunctionEntry;


%% Create entry parameters
% Set SideEffects to 'true' for function returning void to prevent it from 
% being optimized away.
hEntry.setTflCFunctionEntryParameters(...
                               'Key',                      'memcpy', ...
                               'Priority',                 90, ...
                               'ImplementationName',       'memcpy_int', ...
                               'ImplementationHeaderFile', 'memcpy_int.h',...
                               'SideEffects',              true);

概念表現を作成します。概念表現は、置換する関数のシグネチャを記述します。引数プロパティを明示的に指定するには、関数 getTflArgFromString を呼び出します。

function hTable = crl_table_memcpy()
% Create a code replacement library table 

%% Create a table object
hTable = RTW.TflTable;

%% Create an entry 
hEntry = RTW.TflCFunctionEntry;


%% Create entry parameters
% Set SideEffects to 'true' for function returning void to prevent it from 
% being optimized away.
hEntry.setTflCFunctionEntryParameters(...
                               'Key',                      'memcpy', ...
                               'Priority',                 90, ...
                               'ImplementationName',       'memcpy_int', ...
                               'ImplementationHeaderFile', 'memcpy_int.h',...
                               'SideEffects',              true);

%% Create conceptual arguments
arg = getTflArgFromString(hTable, 'y1', 'void*');
arg.IOType = 'RTW_IO_OUTPUT';
addConceptualArg(hEntry, arg);

arg = getTflArgFromString(hTable, 'u1', 'void*');
addConceptualArg(hEntry, arg);

arg = getTflArgFromString(hTable, 'u2', 'void*');
addConceptualArg(hEntry, arg);

arg = getTflArgFromString(hTable, 'u3', 'size_t');
addConceptualArg(hEntry, arg);

実装表現を作成します。実装表現は最適化関数のシグネチャを記述します。実装引数が概念引数と同じ順序とプロパティをもつように指定するには、関数 copyConceptualArgsToImplementation を呼び出します。関数 addEntry を呼び出して、table に完全なエントリを追加します。

function hTable = crl_table_memcpy()
% Create a code replacement library table 

%% Create a table object
hTable = RTW.TflTable;

%% Create an entry 
hEntry = RTW.TflCFunctionEntry;

%% Create entry parameters
setTflCFunctionEntryParameters(hEntry, ...
                               'Key',                      'memcpy', ...
                               'Priority',                 90, ...
                               'ImplementationName',       'memcpy_int', ...
                               'ImplementationHeaderFile', 'memcpy_int.h',...
                               'SideEffects',              true);


%% Create conceptual arguments
arg = getTflArgFromString(hTable, 'y1', 'void*');
arg.IOType = 'RTW_IO_OUTPUT';
addConceptualArg(hEntry, arg);

arg = getTflArgFromString(hTable, 'u1', 'void*');
addConceptualArg(hEntry, arg);

arg = getTflArgFromString(hTable, 'u2', 'void*');
addConceptualArg(hEntry, arg);

arg = getTflArgFromString(hTable, 'u3', 'size_t');
addConceptualArg(hEntry, arg);

%% Create the Implementation Representation
copyConceptualArgsToImplementation(hEntry);

%% Add the entry to the table
hTable.addEntry(hEntry);

ビルド情報を指定します。エントリパラメーターで、コードジェネレーターがコード置換に必要なファイル (ソース、ヘッダー、オブジェクト) を指定します。この例では、ビルド情報は必要ありません。
カスタマイズファイルを確認して保存します。[MATLAB] メニューから、[ファイル]、[保存] を選択して、このカスタマイズファイルを保存します。コマンドラインから、次のようにしてコード置換ライブラリテーブルを呼び出し、確認します。
```
>> hTable = crl_table_memcpy
```
コード置換ライブラリを登録します。登録では、ライブラリ名、コード置換テーブル、その他の情報を定義することにより、コード置換ライブラリが作成されます。以下の仕様を使用して登録ファイルを作成します。
```
function rtwTargetInfo(cm)
 
cm.registerTargetInfo(@loc_register_crl);
end
 
function this = loc_register_crl 
 
this(1) = RTW.TflRegistry; 
this(1).Name = 'CRL for memory function replacement’;
this(1).TableList = {'crl_table_memcpy.m'}; % table created in this example
this(1).TargetHWDeviceType = {'*'};
this(1).Description = 'Example code replacement library';

end
```
コード置換ライブラリを使用するには、現在の MATLAB セッションを次のコマンドで更新します。
```
>>sl_refresh_customizations
```
コード置換ライブラリを確認します。MATLAB コマンドラインから、コード置換ビューアーを使用してライブラリを開き、table およびエントリが正しく指定されていることを確認します。詳細については、Verify Code Replacement Libraryを参照してください。コード置換ライブラリを使用するようにモデルを構成し、コードを生成して、その置換が予期したとおりに行われることを確認します。予期しない動作が行われた場合、ヒットログとミスログを調べて問題のトラブルシューティングを行います。