グローバルデータを含むコードからの C コードの生成

ワークフローの概要

グローバルデータを使用する MATLAB^® コードから MEX 関数を生成するには、次の手順に従います。

コード内で変数をグローバルとして宣言します。
グローバルデータを使用する前にそれを定義し初期化します。
詳細は、グローバルデータの定義を参照してください。
fiaccel を使用してコードをコンパイルします。

グローバルデータを使用する場合は、MATLAB と生成されるコードの間でこのデータを同期するかどうかも指定しなければなりません。MATLAB と生成されるコードの間で相互作用がない場合は、同期を無効にするほうが安全です。相互作用がある場合は、同期を有効にします。詳細は、グローバルデータと MATLAB の同期を参照してください。

グローバル変数の宣言

コードを生成する際には、MATLAB コード内でグローバル変数を使用する前に、グローバル変数を宣言しなければなりません。2 つのグローバル変数 AR と B を使用する関数 use_globals を考えてみます。

function y = use_globals()
%#codegen
% Turn off inlining to make 
% generated code easier to read
coder.inline('never');
% Declare AR and B as global variables
global AR;
global B;
AR(1) = B(1);
y = AR * 2;

グローバルデータの定義

グローバルデータの定義は、MATLAB グローバルワークスペースまたはコマンドラインのいずれでも行えます。コマンドラインでグローバルデータを初期化しなかった場合は、fiaccel は MATLAB グローバルワークスペース内で変数を探します。変数が存在しない場合、fiaccel はエラーを返します。

MATLAB グローバルワークスペース内でのグローバルデータの定義

fiaccel を使用して、グローバル変数の宣言で説明されているように関数 use_globals をコンパイルするには、次の手順に従います。

MATLAB ワークスペース内でグローバルデータを定義します。MATLAB プロンプトで、次のように入力します。
```
global AR B;
AR = fi(ones(4),1,16,14);
B = fi([1 2 3],1,16,13);
```
関数をコンパイルして、use_globalsx という名前の MEX ファイルを生成します。
```
fiaccel -o use_globalsx use_globals
```

コマンドラインでのグローバルデータの定義

コマンドラインでグローバルデータを定義するには、fiaccel -global オプションを使用します。たとえば、グローバル変数の宣言で説明されているように関数 use_globals をコンパイルするには、コマンドラインで 2 つのグローバル入力 AR と B を指定します。

fiaccel -o use_globalsx ...
   -global {'AR',fi(ones(4)),'B',fi([1 2 3])} use_globals

または、-globals フラグを使用し、-globals {'g', {type, initial_value}} の形式でデータ型と初期値を指定します。

可変サイズのグローバルデータの定義. 可変サイズのグローバルデータの初期値を指定するには、-globals フラグを使用し、-globals {'g', {type, initial_value}} の形式でデータ型と初期値を指定します。たとえば、初期値 [1 1] と上限 [2 2] をもつグローバル変数 g1 を指定するには、次のように入力します。

fiaccel foo -globals {'g1',{coder.typeof(0,[2 2],1),[1 1]}}

coder.typeof 構文の詳細については、coder.typeof (MATLAB Coder) を参照してください。

グローバルデータと MATLAB の同期

グローバルデータを同期する理由

生成されたコードと MATLAB は、それぞれ独自のグローバルデータのコピーをもっています。一貫性を維持するために、これらの 2 つが情報をやり取りするときには必ずそれらのグローバルデータを同期しなければなりません。データを同期しないと、グローバル変数は異なるものになる可能性があります。グローバルデータをいつ同期するかは、相互作用のレベルによって決まります。

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

既定では、MATLAB と生成されたコードの間でのグローバルデータの同期は、すべての "外部" 呼び出しで MEX 関数のエントリ時と終了時に行われます。外部呼び出しとは、fiaccel によって MATLAB にディスパッチされて実行される、MATLAB パス上にある MATLAB 関数の呼び出しです。これによって、生成されたコードと MATLAB の間で最大の一貫性を確保できます。

パフォーマンスを向上させるには、次のことを行うことができます。

MEX 関数の入口と出口でのみ同期するように選択します。
グローバルデータが相互作用を行わないときは同期を無効にします。
各外部呼び出しの前後で同期するかどうかを選択します。

以下の表に、グローバルデータ同期オプションの使い方をまとめて示します。これらのオプションの設定方法については、グローバルデータを同期する方法を参照してください。

グローバルデータ同期オプション

実行する操作	グローバルデータ同期モードの設定値	外部呼び出しの前後で同期する機能
すべての外部呼び出しがグローバルデータを変更するときに最大の一貫性を確保します。	`[MEX 関数エントリ時、終了時、および外部の呼び出し時]` (既定値)	あり。既定の動作。
ほとんどの外部呼び出しがグローバルデータを変更し、一部が変更しないときに最大の一貫性を確保します。	`[MEX 関数エントリ時、終了時、および外部の呼び出し時]` (既定値)	あり。グローバルデータに影響しない外部呼び出しには、`coder.extrinsic` `-sync:off` オプションを使用して同期をオフにします。
ほとんどの外部呼び出しがグローバルデータを変更することはなく、一部が変更するときに最大の一貫性を確保します。	`MEX 関数エントリ時と終了時`	あり。グローバルデータを変更する呼び出しのみを同期するように `coder.extrinsic` `-sync:on` オプションを使用します。
いずれの外部呼び出しもグローバルデータを変更しないときのグローバルデータの同期のパフォーマンスを最大化する。	`MEX 関数エントリ時と終了時`	なし。
生成されたコードのファイル間のやり取りのみ。MATLAB と生成されたコード間でグローバルデータの相互作用なし。	`無効`	なし。

グローバルデータを同期する方法

グローバルデータの同期をコントロールするには、グローバルデータ同期モードを設定し、外部関数を同期するかどうかを選択します。どのオプションを使用するかのガイドラインについては、グローバルデータを同期するタイミングを参照してください。

外部関数でグローバルデータの同期を制御するには、-sync:on coder.extrinsic および -sync:off オプションを使用します。

コマンドラインからのグローバルデータ同期モードのコントロール

コンストラクターコマンドを発行して、MATLAB ワークスペースでコンパイラオプションオブジェクトを定義します。
```
comp_cfg = coder.mexconfig
```
コマンドラインから、状況に応じて GlobalDataSyncMethod プロパティを Always、SyncAtEntryAndExits、または NoSync に設定します。以下に例を示します。
```
comp_cfg.GlobalDataSyncMethod = 'SyncAtEntryAndExits';
```
コードをコンパイルするときに、-config コンパイルオプションを使用して指定することで、comp_cfg 構成オブジェクトを使用します。以下に例を示します。
```
fiaccel -config comp_cfg myFile
```

外部関数呼び出しのための同期のコントロール. 外部関数を呼び出す前後に MATLAB と生成されたコードのグローバルデータ間で同期を行うかどうかを制御できます。これを行うには、coder.extrinsic -sync:on と -sync:off のオプションを使用します。

既定では、グローバルデータは以下のようになります。

グローバルデータ同期モードが At MEX-function entry, exit and extrinsic calls である場合は、各外部呼び出しの前後で同期されます。ある特定の外部呼び出しがグローバルデータに影響を及ぼさないことが分かっている場合は、-sync:off オプションを使用してこれらの呼び出しに対して同期を無効にしてください。同期をオフにすると、パフォーマンスが向上します。たとえば、関数 foo1 と関数 foo2 がグローバルデータに影響を "与えない" 場合は、これらの関数に対して同期を無効にします。
```
coder.extrinsic('-sync:off', 'foo1', 'foo2');
```
グローバルデータ同期モードが At MEX-function entry and exit の場合は同期されません。グローバルデータに影響を及ぼす外部呼び出しがいくつかコードにある場合は、-sync:on オプションを使用してこれらの呼び出しに対して同期を有効にしてください。たとえば、関数 foo1 と foo2 がグローバルデータに影響を "与える" 場合は、これらの関数に対して同期を有効にします。
```
coder.extrinsic('-sync:on', 'foo1', 'foo2');
```
グローバルデータ同期モードが Disabled の場合は同期されません。同期が無効になっているときは、特定の外部呼び出しには同期をコントロールすることはできません。-sync:on オプションは効果がありません。

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

MEX 関数および MATLAB には、グローバルデータの独自のコピーがそれぞれ存在するため、MEX の連続実行で必ず同じ結果が得られるように、clear を使用してどちらのコピーもクリアしなければなりません。clear global コマンドは、MATLAB ワークスペース内のグローバルデータのみを削除します。両方のデータを削除するには、clear global コマンドと clear mex コマンドを一緒に使用します。clear all コマンドも両方を削除します。

グローバルデータ使用の制限

関数 coder.varsize ではグローバルデータは使用できません。代わりに、可変サイズのグローバルデータの定義に説明されているように coder.typeof オブジェクトを使用して可変サイズのグローバルデータを定義します。