Simulink 環境内での統合コードのビルド

ワークフロー

生成コードと外部 C または C++ コードを統合する実行可能プログラムをビルドするには、次の表のタスクを反復します。

タスク	アクション	詳細
1	ビルドアプローチを選択します。	Simulink モデルから生成されたコードのビルドに使用するアプローチ例については、リアルタイムシステムのビルドプロセスワークフローを参照してください。
2	外部コードのビルドプロセスサポートを構成します。	統合コードビルドプロセスのパラメーターの構成
3	外部コードの S-Function ビルドサポートを構成します。	S-Function のビルドサポート生成される makefile を makecfg を使用して S-Function 用にカスタマイズする例については、シミュレーションおよびコード生成のための再利用可能な外部アルゴリズムコードの呼び出しを参照してください。
4	外部コードソース、ライブラリ、ヘッダーファイルを検索するようビルドプロセスを構成します。	ビルドプロセスのファイルの依存関係の管理ビルド中のライブラリの位置および名前付けの制御
5	外部コードの統合に必要なカスタムのビルド処理を設定します。	ビルドプロセスのカスタマイズワークフローについては、コード生成後のビルドプロセスのカスタマイズを参照してください。ビルドカスタマイズのツールチェーンアプローチビルドへの適用を自動化するには、sl_customization.m によるビルドプロセスのカスタマイズを参照してください。ビルドカスタマイズのテンプレート makefile アプローチビルドへの適用を自動化するには、STF_make_rtw_hook ファイルによるビルドプロセスのカスタマイズを参照してください。

統合コードビルドプロセスのパラメーターの構成

次の表に、外部コード統合のビルドプロセスをサポートする [モデルコンフィギュレーションパラメーター] ダイアログボックスの [コード生成] 、 [カスタムコード] ペインのモデルコンフィギュレーションパラメーターのガイドを示します。外部コードのフォルダーの詳細については、ビルドプロセスのフォルダーの管理を参照してください。Code generation folderに外部コードを配置する場合は、ビルドフォルダーでの外部コードファイルの保持を参照してください。

目的	選択
ヘッダーファイルを含んでいるインクルードフォルダーをビルドプロセスに追加する	[コード情報] 、 [インクルードディレクトリ] を選択し、フォルダーの絶対パスまたは相対パスを入力します。相対パスを指定する場合、そのパスは、ビルドフォルダーではなく、モデルファイルを含んでいるフォルダーに対して相対的でなければなりません。フォルダーを指定する順序は、ヘッダー、ソースおよびライブラリファイルが検索される順序です。
コンパイルおよびリンク対象のソースファイルを追加する	[コード情報] 、 [ソースファイル] を選択し、ファイルの絶対パスまたはファイル名のみを入力します。ファイルが現在の MATLAB^® フォルダーまたはインクルードフォルダーのいずれかにある場合、ファイル名のみを入力します。指定した追加のソースごとに、ビルドプロセスは、ソースファイルが存在するフォルダーのテンプレート makefile に一般的なルールを拡張します。たとえば、ソースファイルがフォルダー `inc` にある場合、ビルドプロセスは次のようなルールを追加します。 %.obj: buildir\inc\%.c $(CC) -c -Fo$(@F) $(CFLAGS) $< ビルドプロセスは、ソースファイルがリストされている順序でルールを追加します。
リンクするライブラリを追加する	[コード情報] 、 [ライブラリ] を選択し、ライブラリの絶対パスまたはファイル名のみを入力します。ライブラリが現在の MATLAB フォルダーまたはインクルードフォルダーのいずれかにある場合、ファイル名のみを入力します。
MATLAB Function ブロック、Stateflow^® チャートおよび Truth Table ブロックのシミュレーションに指定された設定と同じカスタムコード設定を使用する	[シミュレーションターゲットと同じカスタムコードの設定を使用] を選択します。このパラメーターは、[コンフィギュレーションパラメーター] ダイアログボックスの [シミュレーションターゲット] ペインを参照します。
ライブラリがリンクしている親モデルから一意のカスタムコード設定をライブラリモデルで使用できるようにする	[ローカルなカスタムコード設定を使用 (メインモデルから継承しません)] を選択します。このパラメーターは、MATLAB Function ブロック、Stateflow チャートまたは Truth Table ブロックを含むライブラリモデルに対してのみ使用可能です。

ビルドフォルダーでの外部コードファイルの保持

既定では、ビルドプロセスで外部のソースファイルは削除されます。次のガイドラインに従って、外部ソースファイルを保持できます。

.c/.cpp または .h ソースファイルをビルドフォルダーに入れて、コードジェネレーターで TLC コード生成プロセス時にこのソースファイルが削除されないようにするには、.c/.cpp または .h ファイルの 1 行目にテキスト target specific file を挿入します。以下に例を示します。

/*  COMPANY-NAME target specific file
 *
 *   This file is created for use with the 
 *   COMPANY-NAME target.
 *   It is used for ...
 */
...

前の例で示されているように、正確にテキスト "target specific file" を入力し、この文字列がソースファイルの 1 行目に置かれるようにしてください。その他のテキストは、このテキストの前または後に表示されます。

この方法でユーザーファイルにフラグを設定すると、ユーザーファイルへの後処理が回避されて、生成されたソースファイルと共にユーザーファイルがインデントされないようになります。旧リリースでは、パターン model_*.c/.cpp (ここで * はテキスト) の名前をもつフォルダーファイルをビルドするために自動インデントが行われていました。インデントは無害ですが、ソース管理ソフトウェアによって違いが検出されることがあり、そのために不必要な更新がトリガーされる可能性があります。

S-Function のビルドサポート

ユーザーが記述する S-Function ブロックには、外部コードを Simulink^® 開発環境に組み込むための強力な方法が用意されています。多くの場合、S-Function を使用して既存の外部コードを生成コードに統合します。以下のように、S-Function の記述に使用できる方法がいくつかあります。

古い形式のコードファイルやカスタムコードファイルのビルド情報をビルドプロセスに含めるために、S-Function にも柔軟で機能的な方法が用意されています。

S-Functions をビルドプロセスに追加するさまざまな方法があります。

暗黙的なビルドサポート

S-Function を使用してモデルをビルドする場合、ビルドプロセスによって、規則、インクルードパスおよびソースファイル名が生成済みの makefile に追加されます。S-Function のソースファイル (.h、.c および .cpp) を S-Function MEX ファイルと同じフォルダーに配置しなければなりません。ビルドにツールチェーンアプローチを使用しているかテンプレート makefile アプローチを使用しているかにかかわらず、ビルドプロセスではツールチェーンまたはテンプレート makefile を介してこの情報が伝播されます。

ファイル sfcnname.h が S-Function MEX ファイル (sfcnname.mexext など) と同じフォルダーに存在する場合、そのフォルダーはインクルードパスに追加されます。
ファイル sfcnname.c または sfcnname.cpp が S-Function MEX ファイルと同じフォルダーに存在する場合、ビルドプロセスはそのフォルダーからファイルをコンパイルするための makefile 規則を追加します。
S-Function が TLC ファイルでインライン化されていないと、ビルドプロセスはその S-Function のソースファイルをコンパイルしなければなりません。ソースファイルの名前をコンパイルするファイルのリストに追加するかどうかを決定するために、ビルドプロセスは MATLAB パスで sfcnname.cpp を検索します。ソースファイルを見つけると、ビルドプロセスはそのソースファイル名を makefile に追加します。パスで sfcnname.cpp が見つからないと、ビルドプロセスはファイル名 sfcnname.c が MATLAB パス上にあるかどうかにかかわらず、この名前を makefile に追加します。
メモ
Simulink エンジンでシミュレーションやコード生成のための MEX ファイルを見つけるには、ファイルが MATLAB パス上か、現在の MATLAB 作業フォルダー内になければなりません。

S-Function の追加ソースファイルの指定

S-Function に追加のソースファイルの依存関係がある場合は、追加モジュールの名前をビルドプロセスに追加しなければなりません。次のようにファイル名を指定します。

S-Function ブロックパラメーターダイアログボックスの [S-Function モジュール] フィールドで指定
関数 set_param の呼び出しの SFunctionModules パラメーターを使用して指定

たとえば、複数のモジュールで S-Function をビルドするとします。

mex sfun_main.c sfun_module1.c sfun_module2.c

次のいずれかを実行すると、モジュールをビルドプロセスに追加できます。

S-Function ブロックパラメーターダイアログボックスの [S-Function モジュール] フィールドで sfun_main、sfun_module1 および sfun_module2 を指定します。

MATLAB コマンドプロンプトで、次のように入力します。

set_param(sfun_block,'SFunctionModules','sfun_module1 sfun_module2')

または、変数を定義してパラメーター値を表すことができます。

modules = 'sfun_module1 sfun_module2'
          set_param(sfun_block,'SFunctionModules', modules)

[S-Function モジュール] フィールドと SFunctionModules パラメーターは、完全なソースファイルパスの仕様をサポートしません。パラメーターを使用するには、makefile の実行時にコードジェネレーターが追加ソースファイルを検出しなければなりません。コードジェネレーターが追加ファイルの場所を特定するように、そのファイルを S-Function MEX ファイルと同じフォルダーに配置します。これで、暗黙的なビルドサポートに記載されている暗黙的なビルドサポートを活用できます。

コードを生成する準備ができたら、最上位モデルコードの再生成の制御の説明にあるように、コードジェネレーターで最上位モデルを強制的にリビルドします。

他の場所にあるソースファイルの指定やライブラリまたはオブジェクトファイルの指定など、複雑な S-Function ファイルの依存関係では、生成された makefile を rtwmakecfg.m API を使用してカスタマイズで説明されているように rtwmakecfg.m API を使用します。

TLC ライブラリ関数の使用

TLC ファイルを記述して S-Function をインライン化する場合、TLC ライブラリ関数 LibAddToModelSources を使用してソースファイル名をビルドプロセスに追加できます。詳細については、LibAddSourceFileCustomSection(file, builtInSection, newSection)を参照してください。

メモ

この関数は完全なソースファイルパスの指定をサポートしません。makefile の実行時にコードジェネレーターが追加のソースファイルを検出できるものとみなします。

その他に、LibAddToCommonIncludes という TLC ライブラリ関数が役立ちます。この関数は、生成された model.h ヘッダーファイルに S-Function ヘッダーファイルを含めるために、#include ステートメントで使用します。詳細については、LibAddToCommonIncludes(incFileName)を参照してください。

S-Function ライブラリのプリコンパイル

MATLAB 言語関数 rtw_precompile_libs を使用することによって、モデルに適した新しいまたは更新した S-Function ライブラリ (MEX ファイル) をプリコンパイルできます。この関数は、指定されたモデルおよびライブラリビルド仕様を使用し、ライブラリを作成してプリコンパイル済みのライブラリフォルダーにライブラリを配置します。

S-Function ライブラリをプリコンパイルすることによって、システムビルドを最適化できます。プリコンパイル済みのライブラリが存在する場合、ビルドプロセスはその後のビルドからライブラリのコンパイルを省略できます。多数のライブラリを使用するモデルでは、ビルドプロセスでの時間短縮は大きな意味があります。

rtw_precompile_libs を使用するには、次を行います。

システムプラットフォームに基づいたファイルタイプの拡張子など、ライブラリファイルの接尾辞を設定します。

プラットフォームのタイプを特定したら、TargetLibSuffix パラメーターを使用してそれに対応したライブラリ接尾辞を設定することを検討します。たとえば、GRT ターゲットの接尾辞を適用する場合、UNIX^® プラットフォームの _std.a および Windows^® プラットフォームの _vcx64.lib に接尾辞を設定できます。

  if isunix
    suffix = '_std.a';
  else
    suffix = '_vcx64.lib';
  end

set_param(my_model,'TargetLibSuffix', suffix);

プリコンパイル済みのライブラリ接尾辞と拡張子に影響する要因はいくつかあります。以下の表に、接尾辞と拡張子の選択肢に影響するシステムターゲットファイル、コンパイラツールチェーン、その他のオプションの典型的な選択例を示します。詳細は、matlab/rtw/c/grt フォルダーまたは matlab/rtw/c/ert フォルダーでテンプレート makefile を確認してください。

TMF ファイル	COMPILER _TOOL_CHAIN 値	プリコンパイラライブラリ (PRECOMP_LIBRARIES)
TMF ファイル	COMPILER _TOOL_CHAIN 値	S-Function のライブラリ接尾辞 (EXPAND _LIBRARY _NAME 値)	整数のみのコードのライブラリ接尾辞 (EXPAND _LIBRARY _NAME 値)	速度を最適化するライブラリ接尾辞 (EXPAND _LIBRARY _NAME 値)	ライブラリ拡張子 (EXPAND _LIBRARY _NAME 値)
ert_vcx64.tmf	vcx64	_rtwsfcn_vcx64	_int_ert_vcx64	_ert_vcx64	.lib
ert_unix.tmf	unix	_rtwsfcn	_int_ert	_ert	.a
grt_vcx64.tmf	vcx64	N/A	N/A	_vcx64	.lib
grt_unix.tmf	unix	N/A	N/A	_std	.a

プリコンパイル済みのライブラリフォルダーを設定します。
次のメソッドのいずれかを使用して、プリコンパイル済みのライブラリフォルダーを設定します。
- プリコンパイル済みのライブラリの位置を指定で説明されている TargetPreCompLibLocation パラメーターを設定します。
- rtwmakecfg.m 関数ファイルで makeInfo.precompile フィールドを設定します (詳細については、生成された makefile を rtwmakecfg.m API を使用してカスタマイズを参照してください)。
TargetPreCompLibLocation と makeInfo.precompile の両方を設定する場合は、TargetPreCompLibLocation の設定内容が優先されます。
次のコマンドは、モデル my_model のプリコンパイル済みライブラリフォルダーを、現在の作業フォルダーの下にあるフォルダー lib に設定します。
```
set_param(my_model,'TargetPreCompLibLocation', fullfile(pwd,'lib'));
```
メモ
プリコンパイル済みライブラリファイルのターゲットフォルダーとターゲットライブラリファイルの接尾辞の両方を設定する場合、ビルドプロセスは、ビルド処理中にプリコンパイル済みライブラリファイルが失われているかどうかを検出します。

ビルド仕様を定義します。

ビルド仕様を定義する構造体を設定します。次の表では、構造体で定義できるフィールドを説明します。これらのフィールドは rtwmakecfgDirs を除き、オプションです。

フィールド	説明
`rtwmakecfgDirs`	プリコンパイルするライブラリの `rtwmakecfg` ファイルを含んでいるフォルダーに名前を付ける文字ベクトルの cell 配列。この関数は `rtwmakecfg` が返すのと同様に、`makeInfo.library` の `Name` 要素と `Location` 要素を使用して、プリコンパイル済みライブラリの名前と位置を指定します。`TargetPreCompLibLocation` パラメーターをライブラリフォルダーを指定するように設定すると、その設定は `makeInfo.library.Location` の設定をオーバーライドします。メモ: 指定したモデルは、`rtwmakecfg` ファイルで指定されるプリコンパイル済みライブラリを使用するブロックを含んでいなければなりません。これは、ビルドプロセスでライブラリを使用する場合に限って、TMF から makefile への変換でライブラリの規則が生成されるからです。
`libSuffix`	各ライブラリの名前 (`.a`、`_vc.lib` など) に追加する、ファイルタイプの拡張子を含むサフィックスを指定する文字ベクトル。文字ベクトルはピリオド (.) を含まなければなりません。このフィールドか `TargetLibSuffix` パラメーターを使用してサフィックスを設定します。両方の方法で接尾辞を指定した場合はこのフィールドの設定内容が `TargetLibSuffix` の設定によってオーバーライドされます。
`intOnlyBuild`	boolean フラグ。true に設定すると、フラグは、ライブラリが整数コードからしかコンパイルされないようにライブラリが最適化されることを示します。このフィールドは ERT ターゲットにのみ適用されます。
`makeOpts`	`rtwMake` コマンドラインに含まれるオプションを指定する文字ベクトル。
`addLibs`	関数 `rtwmakecfg` で指定されない作成対象のライブラリを指定する構造体の cell 配列。各構造体は、文字配列である 2 つのフィールドで定義されなければなりません。 `libName` — サフィックスのないライブラリ名 `libLoc` — プリコンパイル済みライブラリの位置ターゲット makefile (TMF) では、他のライブラリと、ライブラリのビルド方法を指定できます。このフィールドを使用して、それらのライブラリをプリコンパイルします。

次のコマンドはビルド仕様 build_spec を設定します。これによって、コンパイル対象のファイルが現在の作業フォルダーの下にあるフォルダー src 内に存在することが示されます。

build_spec = [];
build_spec.rtwmakecfgDirs = {fullfile(pwd,'src')};

rtw_precompile_libs を呼び出します。
この呼び出しでは、プリコンパイル済みのライブラリとビルド仕様を作成するモデルを指定しなければなりません。次に例を示します。
```
rtw_precompile_libs(my_model,build_spec);
```