Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

STF_make_rtw_hook ファイルによるビルド プロセスのカスタマイズ

ビルド プロセスでは、コード生成と make プロセスの特定の時点で実行されるフック メソッドに、オプションのカスタム コードを追加できます。フック メソッドを使用してターゲット固有の行動をビルド プロセスに追加することができます。

STF_make_rtw_hook ファイル

一般に STF_make_rtw_hook.m と呼ばれるファイル内のフック メソッドは変更できます。この STF はシステム ターゲット ファイルの名前です (たとえば、ertmytarget など)。このファイルは関数 STF_make_rtw_hook を実装します。この関数は渡された hookMethod 引数に依存し、特定の行動を送信します。

ビルド プロセスは STF_make_rtw_hook を呼び出し、引数 hookMethod などの引数を渡します。ビルド プロセスに必要なフック メソッドのみを実装してください。

モデルに参照モデルが含まれている場合は、必要に応じて参照モデルごとに STF_make_rtw_hook.m を実装できます。ビルド プロセスは参照モデルごとにそれぞれ STF_make_rtw_hook を呼び出し、これらのファイルを (依存関係の順に) 再帰的に処理します。

STF_make_rtw_hook ファイルの使用に関する規則

ビルド プロセスが必ず STF_make_rtw_hook を呼び出すように、以下の条件が満たされていることを確認します。

  • STF_make_rtw_hook.m ファイルが MATLAB® パス上にあること。

  • ファイル名がシステム ターゲット ファイル (STF) の名前であり、テキスト _make_rtw_hook.m に付加されていること。たとえば、カスタムのシステム ターゲット ファイル mytarget.tlc でコードを生成する場合、フック ファイルの名前は mytarget_make_rtw_hook.m とし、そのファイル内で実装されたフック関数の名前は mytarget_make_rtw_hook とします。

  • ファイル内で実装されたフック関数が関数プロトタイプ STF_make_rtw_hook.m と引数で説明する関数プロトタイプを使用すること。

関数プロトタイプ STF_make_rtw_hook.m と引数

STF_make_rtw_hook 用の関数プロトタイプは、次のとおりです。

function STF_make_rtw_hook(hookMethod, modelName, rtwRoot, templateMakefile,
buildOpts, buildArgs, buildInfo)

引数は、次のように定義されます。

  • hookMethod:関数 STF_make_rtw_hook が呼び出されるビルド プロセスの段階を指定する文字ベクトル。以下のフロー チャートはビルド プロセスをまとめたもので、フック点を強調表示しています。hookMethod 用の有効値は、'entry''before_tlc''after_tlc''before_make''after_make''exit''error' です。関数 STF_make_rtw_hookswitch ステートメントで関連コードへ送信します。

  • modelName:モデルの名前を指定する文字ベクトル。ビルド プロセスのすべての段階で有効です。

  • rtwRoot:予備。

  • templateMakefile:テンプレート makefile の名前。

  • buildOpts:Boolean のフィールド codeWasUpToDate が含まれている MATLAB 構造体。'before_make''after_make''exit' 段階のみで有効です。buildOpts フィールドには以下を含みます。

  • buildArgs:make_rtw への引数が含まれる文字ベクトル。ビルド プロセスを呼び出すと、buildArgs[コンフィギュレーション パラメーター] + [コード生成] + [make コマンド] フィールド内で "make_rtw" に続く引数からコピーされます。

    たとえば、次の [make コマンド] フィールドの make 引数

    make_rtw VAR1=0 VAR2=4

    は、以下を生成します。

    % make -f untitled.mk VAR1=0 VAR2=4

    buildArgs 引数がツールチェーン アプローチのビルドに適用されないのは、これらのビルドが make_rtw 呼び出しに make 引数を追加することができないためです。コンパイラ コマンド ラインで、TMF アプローチのビルドとツールチェーン アプローチのビルドの両方に適用されるカスタム定義 (たとえば、VAR1=0 VAR2=4) を指定するには、[コンフィギュレーション パラメーター][コード生成][カスタム コード][定義] フィールドを使用します。

  • buildInfo: モデルのビルド情報フィールドが含まれる MATLAB 構造体。'after_tlc''before_make''after_make' および 'exit' 段階のみで有効です。これらのフィールドとフィールドにアクセスする関数の詳細については、ビルド プロセスのカスタマイズを参照してください。

STF_make_rtw_hook.m の応用

ここでは、STF_make_rtw_hook.m フック メソッドの適用方法の例を示します。

通常、'entry' フックを使用してビルド プロセスを初期化し、コードを生成する前に、たとえば、設定を変更したり有効にしたりすることができます。'entry' フックの応用の 1 つは、ターゲットの選択時に最初に起動した自動コンフィギュレーション スクリプトを再度実行し、スクリプトが認証を実行する前と後のモデル パラメーターを比較することです。

他のフック ポイント 'before_tlc''after_tlc''before_make''after_make''exit''error' は、外部のツール チェーン、ソース管理ツール、および他の環境ツールとインターフェイスする際に役立ちます。

たとえば、'entry' 後の段階で STF_make_rtw_hook.m ファイルを使用し、ビルド フォルダーへのパスを取得することができます。それから 'exit' 段階で、ビルド フォルダー内で生成コードファイルを見つけ、それらをバージョン制御システム内にチェック インすることができます。コード生成中またはビルド プロセス時にエラーが発生する場合は、'error' を使用して、フック関数が使用した静的データまたはグローバル データをクリーン アップすることができます。

メモ

ビルド プロセスは MATLAB 作業フォルダーを一時的に段階 'before_make''after_make''exit''error' 用のビルド フォルダーに変更します。STF_make_rtw_hook.m ファイルはビルド フォルダーの位置に関して誤った仮定をしてはなりません。'entry' 段階後、ビルド フォルダーへのパスを取得することができます。以下の MATLAB コード例では、ビルド フォルダー パスは変数 buildDirPath に文字ベクトルとして返されます。

buildDirPath = rtwprivate('get_makertwsettings',gcs,'BuildDirectory');

メモ

STF_make_rtw_hook.m ファイル内のモデル コンフィギュレーションの変更 (バリアントの切り替えを含む) によって、コード生成で予期しない結果になる可能性があります。

STF_make_rtw_hook.m を使用したコード再生成の制御

モデルをリビルドするとき、既定の設定では、ビルド プロセスはモデルまたは関連する設定の変更によって、最上位モデルの再生成が必要かどうかを判断するために、チェックを実行します。(詳細については、Control Regeneration of Top Model Codeを参照)。チェック結果が最上位モデル コードの生成が必要であることを示している場合は、ビルド プロセスはモデル コードの完全な再生成とコンパイルを実行します。チェック結果が、最上位モデルの生成コードがモデルに対して最新であり、モデル設定に完全な再生成が必要ないことを示している場合、ビルド プロセスは最上位モデル コードの再生成を省略します。

最上位モデル コードが再生成されたかどうかに関わりなく、ビルド プロセスは続けて関数 STF_make_rtw_hook やコード生成後のコマンドを含むビルド プロセス フックを呼び出します。次のメカニズムにより、関数 STF_make_rtw_hook のコード再生成に関連するアクションを実行できます。

  • 強制的にコードを再生成するには、'entry' フックから次の関数呼び出しを使用します。

    rtw.targetNeedsCodeGen('set', true);
  • 'before_tlc' から 'exit' までのフックでは、フックに渡される buildOpts 構造体には論理値のフィールド codeWasUpToDate があります。このフィールドは、モデル コードが最新の状態であったために再生成されなかった場合に true にセットされます。コードが最新の状態ではなく再生成が必要だった場合には、false になります。このフィールドの値に基づいてフック処理をカスタマイズできます。以下に例を示します。

    ...
    case 'before_tlc'
        if buildOpts.codeWasUpToDate
            %Perform hook actions for up to date model
        else
            %Perform hook actions for full code generation
        end
    ...

ビルド プロセス用に STF_make_rtw_hook.m を使用

ビルド プロセス用にカスタムの STF_make_rtw_hook フック ファイルを作成するには、matlabroot/toolbox/coder/embeddedcoder (開く) フォルダーに配置されている例ファイル ert_make_rtw_hook.m を以下のようにコピーして編集します。

  1. ert_make_rtw_hook.m を MATLAB パスのフォルダーにコピーします。STF_make_rtw_hook ファイルの使用に関する規則で説明する命名規則に従ってその名前を変更します。たとえば、GRT ターゲット grt.tlc でそれを使用する場合は、その名前を grt_make_rtw_hook.m に変更します。

  2. ファイル内で関数 ert_make_rtw_hook の名前を変更して、ファイル名と一致させます。

  3. switch hookMethod ステートメント内のケース ステートメントにコードを追加することにより、必要なフックを実装します。