グローバル変数のコード生成

グローバル変数を使用する MATLAB^® 関数の C/C++ コードと MEX 関数を生成できます。グローバル変数を使用する MATLAB コードの MEX 関数を実行すると、生成された関数と MATLAB にそれぞれ独自の変数のコピーが保持されます。それらのコピー間でデータを同期する方法を決めなければなりません。また、コード生成用の MATLAB コードでグローバルデータを使用している場合、一定の制限が適用されます。

グローバルデータを使用する MATLAB 関数のコードの生成

グローバル変数を使用する MATLAB 関数のコードを生成するときは、コード生成前かコード生成時に変数を定義して初期化する必要があります。コード生成時にグローバル変数が定義されていない場合、コードジェネレーターは MATLAB グローバルワークスペース内でグローバル変数を探します。グローバル変数が存在しない場合、コード生成は失敗します。

グローバル変数を使用する MATLAB 関数のコードを生成するには、次のいずれかの方法を使用します。

MATLAB Coder™ アプリまたは codegen コマンドを使用して、コード生成前に MATLAB グローバルワークスペースでグローバル変数を定義および初期化する。
MATLAB Coder アプリの [エントリポイント] ペインでコード生成前にグローバル変数を定義して初期化する。
コマンドラインで codegen コマンドを -globals オプション付きで使用してグローバル変数を定義および初期化する。

グローバルワークスペースでのグローバル変数の定義と初期化

コード生成前に MATLAB グローバルワークスペースでグローバル変数を定義および初期化するには、コマンドラインで global 関数を使用します。以下に例を示します。

global A B;
A = ones(4);
B = [1 2 3];

その後、MATLAB Coder アプリまたは codegen コマンドを使用してコードを生成します。グローバル変数について、それ以上の指定は必要ありません。

MATLAB Coder アプリでのグローバル変数の定義と初期化

MATLAB Coder アプリでグローバル変数を定義および初期化するには、[新規エントリポイント]、[新規グローバル] をクリックします。各グローバル変数の名前、型、および初期値を指定します。Define Global Variables in the MATLAB Coder Appを参照してください。その後、アプリを使用してコードを生成します。

`codegen` コマンドでのグローバル変数の定義と初期化

コマンドラインで codegen コマンドを使用してコードを生成する場合は、コード生成時にグローバル変数を定義および初期化できます。-globals オプションを使用して、グローバル変数の名前と初期値の cell 配列を codegen コマンドに渡します。この cell 配列の形式は {global1,value1,global2,value2,...} です。以下に例を示します。

codegen use_globals -globals {"A",ones(4),"B",[1 2 3]} -args {0}

または、coder.typeof 関数を使用してグローバル変数の型を指定できます。この場合、-globals オプションに渡す cell 配列の形式は {global1,{type1,value1},global2,{type2,value2},...} です。以下に例を示します。

codegen use_globals -globals {"A",{coder.typeof(0,[4 4]),ones(4)},"B",{coder.typeof(0,[1 3]),[1 2 3]}} -args {0}

グローバル変数が cell 配列の場合は coder.typeof を使用する必要があります。コマンドラインでのグローバル cell 配列の指定を参照してください。

定数のグローバルデータの定義

グローバル変数の値が実行時に変化しないことがわかっている場合、グローバル変数が定数値をもつと指定することで生成コードのオーバーヘッドを減らすことができます。定数のグローバル変数には書き込みできません。また、定数のグローバル変数の値を MATLAB と同期することはできません。

定数のグローバル変数を定義するには、次のいずれかの方法を使用します。

コマンドラインで、codegen コマンドの -globals オプションに渡す cell 配列で coder.Constant クラスを使用します。以下に例を示します。
```
codegen use_globals -globals {"A",ones(4),"B",coder.Constant([1 2 3])} -args {0}
```
MATLAB Coder アプリで、[エントリポイント] ペインの [グローバル] セクションで変数をポイントし、[モードおよびアクション] ボタンをクリックします。[モード] セクションで [定数の使用] を選択します。

生成された MEX 関数と MATLAB の間でのグローバルデータの同期

MEX 関数を生成して実行すると、生成された関数と MATLAB のそれぞれでグローバルデータのコピーが保持されます。それらのコピーの一貫性を維持するために、MEX 関数と MATLAB が情報をやりとりするときにそれらのグローバルデータを同期しなければなりません。データを同期しないと、グローバル変数は異なるものになる可能性があります。グローバルデータを同期する頻度は、生成された関数でグローバルデータがどの程度変更されるかによって決まります。

グローバルデータを定数として定義している場合、生成された関数で使用されるグローバルデータを MATLAB と同期することはできません。代わりに、生成された関数コード内の定数のグローバル変数と MATLAB グローバルワークスペース内の変数で値が異なる場合、MEX 関数でエラーが生成されます。

グローバルデータを同期するタイミング

既定では、MEX 関数の実行の開始時、MEX 関数の実行の終了時、および各外部関数呼び出しの後にグローバルデータの同期が行われます。この動作により、生成された関数と MATLAB の間で最大の一貫性が得られますが、生成コードの関数のパフォーマンスが低下する可能性があります。

生成された関数と MATLAB の間でのグローバルデータの同期は、構成パラメーター [グローバルなデータ同期モード] を使用して制御できます。個々の外部関数については、coder.extrinsic 関数の "-sync" 引数を使用してグローバルデータの同期を制御できます。

次の表は、MEX 関数を生成する際のこれらのパラメーターの設定方法を目的別にまとめたものです。

目的	[グローバルなデータ同期モード] パラメーターの設定	`coder.extrinsic` を使用する関数呼び出し	生成コードの動作
最大の一貫性。	`MEX 関数エントリ時、終了時、および外部の呼び出し時`	不使用	MEX 関数の実行の開始時と終了時に MEX 関数と MATLAB の間で一貫性が確保される。外部関数呼び出しの後に一貫性が確保される。この動作は既定です。
ほとんどの外部関数呼び出しがグローバルデータを変更し、一部の外部関数が変更しないときの同期の動作を最適化する。	`MEX 関数エントリ時、終了時、および外部の呼び出し時`	特定の外部関数について、引数 `"-sync:off"` を使用して同期と定数値のチェックを無効にする	MEX 関数の実行の開始時と終了時に MEX 関数と MATLAB の間で一貫性が確保される。外部呼び出しに `"-sync:off"` 引数が含まれている場合を除き、外部関数呼び出しの後に一貫性が確保される。
少数の外部関数呼び出しのみがグローバルデータを変更するときの同期の動作を最適化する。	`MEX 関数エントリ時と終了時`	特定の外部関数について、引数 `"-sync:on"` を使用して同期と定数値のチェックを有効にする	MEX 関数の実行の開始時と終了時に MEX 関数と MATLAB の間で一貫性が確保される。外部呼び出しに `"-sync:on"` 引数が含まれている場合にのみ、外部関数呼び出しの後に一貫性が確保される。
外部呼び出しがグローバルデータを変更しないときの同期の動作を最適化する。	`MEX 関数エントリ時と終了時`	不使用	MEX 関数の実行の開始時と終了時に MEX 関数と MATLAB の間で一貫性が確保される。外部関数呼び出しの後に一貫性が確保されない。
同期を無効にすることで潜在的にパフォーマンスを最適化する。コードがグローバルデータを変更しない場合を除き、このモードは使用しない。	`無効`	使用不可	MEX 関数と MATLAB の間で一貫性が確保されない。外部関数呼び出しの後に一貫性が確保されない。グローバルデータの同期が無効になっているときは、`"-sync:on"` 引数を使用して外部関数の同期を有効にすることはできない。

グローバルデータのクリア

MEX 関数と MATLAB にはグローバルデータの独自のコピーがそれぞれ存在するため、MEX の連続実行で必ず同じ結果が得られるように、どちらのコピーもクリアしなければなりません。

MATLAB ワークスペース内のグローバルデータのコピーを消去するには、次のコマンドを使用します。

clear global

MEX ワークスペース内のグローバルデータのコピーを消去するには、次のコマンドを使用します。

clear MEX

あるいは、次のコマンドを使用して両方のグローバルデータのコピーを削除します。

clear all

生成されたコードのグローバルデータ制限

グローバル構造体変数には、ハンドルオブジェクトまたはスパース配列を含めることができません。
coder.cstructname はグローバル変数に直接適用できません。グローバル変数で使用する構造体型に名前を付けるには、coder.cstructname を使用して、構造体型に名前を付ける型オブジェクトを作成します。次に、codegen を実行するときに、グローバル変数にその型があることを指定します。グローバル構造体変数と共に使用するための C 構造体型の命名を参照してください。
SIL または PIL の実行中にランタイムエラーが発生すると、グローバル変数は同期されません。グローバル変数 g をインクリメントし、ランタイムエラーを生成する関数 SILtest について考えます。
```
function SILtest
global g;
g = g + 1;
error('MyError');
end
```
MATLAB および MEX の実行では、SILtest はワークスペース内のグローバル変数 g をインクリメントして同期します。しかし、SIL の実行では、ランタイムエラーのため、ワークスペース内でグローバル変数 g がインクリメントされません。グローバル変数を用いた SIL および PIL の実行に関する詳細については、Speed Up SIL/PIL Execution by Disabling Constant Input Checking and Global Data Synchronization (Embedded Coder)を参照してください。

参考

MATLAB Coder | global | codegen