生成コードを共有ライブラリとしてパッケージ化

Embedded Coder^® のライセンスがある場合は、モデルコンポーネントから生成されたソースコードをパッケージ化して配布を容易にし、コードを Windows^® ダイナミックリンクライブラリ (.dll)、UNIX^® 共有オブジェクト (.so)、または Macintosh OS X ダイナミックライブラリ (.dylib) の共有ライブラリとしてビルドして、共有して使用することができます。自分自身または他のユーザーが、Windows、UNIX または Macintosh OS X 開発用コンピューターで実行されるアプリケーションに共有ライブラリを統合できます。生成された .dll、.so、または .dylib ファイルはさまざまなアプリケーション間で共有可能で、そのファイルを使用するアプリケーションを再コンパイルせずにアップグレードできます。

生成された共有ライブラリについて

システムターゲットファイル ert_shrlib.tlc を使用するようにコードジェネレーターを設定して、共有ライブラリをビルドします。システムターゲットファイルのコード生成では次をエクスポートします。

データとしての ExportedGlobal 型の変数と信号
データとしてのリアルタイムモデル構造体 (model_M)
モデルコードを実行するために必要な関数

生成された共有ライブラリに含まれるシンボルのリストを表示するには、次のようにします。

Windows では、Dependency Walker ユーティリティ (https://www.dependencywalker.com からダウンロード可能) を使用します。
UNIX では、nm -D model.so を使用します。
Macintosh OS X では、nm -g model.dylib を使用します。

共有ライブラリを生成および使用するには、次のようにします。

モデルコードの共有ライブラリバージョンを生成します。
共有ライブラリファイルを読み込んで使用するアプリケーションコードを作成します。

モデルコードの共有ライブラリバージョンの生成

モデルコードの共有ライブラリバージョンを生成します。

モデルを開き、ert_shrlib.tlc システムターゲットファイルを使用するように構成します。
ert_shrlib.tlc システムターゲットファイルを選択すると、ビルドプロセスでモデルコードの共有ライブラリバージョンが現在の作業フォルダーに生成されます。この選択によって、コードジェネレーターがモデルに対して生成するコードは変更されません。
モデルを作成します。
ビルドが完了したら、モデルサブフォルダーの生成コードを確認し、現在のフォルダーの .dll、.so、または .dylib ファイルを確認します。

共有ライブラリを使用するアプリケーションコードの作成

アプリケーションコードで共有ライブラリファイルを読み込み、その関数とデータにアクセスする方法の例を示すために、MathWorks はモデル SharedLibraryCode を提供しています。モデルを検査するには、MATLAB^® コマンドウィンドウから次のコマンドを実行します。

モデルで、青いボタンをクリックしてスクリプトを実行します。スクリプトは以下を実行します。

モデルから共有ライブラリファイル (64 ビットの Windows 上の SharedLibraryCode_win64.dll など) をビルドします。
共有ライブラリファイルを読み込んで使用するサンプルアプリケーション SharedLibraryCode_app をコンパイルしてリンクします。
サンプルアプリケーションを実行します。

ヒント

移植性のために、明示的なリンクが推奨されます。ただし、Windows システムでは、暗黙のリンクをサポートするために ert_shrlib システムターゲットファイルで .lib ファイルが生成されて、保持されます。

暗黙のリンクを使用するには、生成されたヘッダーファイルを少しだけ変更して、生成された C ファイルで使用できるようにする必要があります。たとえば、Visual C++^® を使用する場合は、共有ライブラリファイルから暗黙的にインポートされるデータの前に __declspec(dllimport) を宣言します。

このモデルでは次のサンプルアプリケーションファイルを使用します。

ファイル	説明
`SharedLibraryCode_app.h`	サンプルアプリケーションのヘッダーファイル
`SharedLibraryCode_app.c`	モデル用に生成された共有ライブラリファイルを読み込んで使用するサンプルアプリケーション
`run_SharedLibraryCode_app.m`	サンプルアプリケーションをコンパイル、リンク、および実行するスクリプト

モデルウィンドウで白いボタンをクリックして、これらの各ファイルを表示できます。さらに、スクリプトを実行すると、関連するソースファイルおよび生成コードファイルが現在のフォルダーに配置されます。ファイルは、独自の ERT 共有ライブラリファイルのアプリケーションコードを記述するためのテンプレートとして使用できます。

以下の節では、サンプルアプリケーションファイルの主要な抜粋を示します。

サンプルアプリケーションのヘッダーファイル

サンプルアプリケーションのヘッダーファイル SharedLibraryCode_app.h には、モデルの外部入力と出力の型宣言が含まれます。

#ifndef _APP_MAIN_HEADER_
#define _APP_MAIN_HEADER_

typedef struct {
    int32_T Input;
} ExternalInputs_SharedLibraryCode;

typedef struct {
    int32_T Output;
} ExternalOutputs_SharedLibraryCode;

#endif /*_APP_MAIN_HEADER_*/

サンプルアプリケーションの C コード

サンプルアプリケーションの SharedLibraryCode_app.c には、共有ライブラリファイルを動的に読み込むための次のコードが含まれています。プラットフォームに応じて、コードは Windows または UNIX のライブラリコマンドを呼び出します。

#if (defined(_WIN32)||defined(_WIN64)) /* WINDOWS */
#include <windows.h>
#define GETSYMBOLADDR GetProcAddress
#define LOADLIB LoadLibrary
#define CLOSELIB FreeLibrary

#else /* UNIX */
#include <dlfcn.h>
#define GETSYMBOLADDR dlsym
#define LOADLIB dlopen
#define CLOSELIB dlclose

#endif

int main()
{
    void* handleLib;
...
#if defined(_WIN64)
    handleLib = LOADLIB("./SharedLibraryCode_win64.dll");
#else
#if defined(_WIN32)
    handleLib = LOADLIB("./SharedLibraryCode_win32.dll");
#else /* UNIX */
    handleLib = LOADLIB("./SharedLibraryCode.so", RTLD_LAZY);
#endif
#endif
...
    return(CLOSELIB(handleLib));
}

以下のコードの抜粋は、C アプリケーションでモデルのエクスポートされたデータと関数にアクセスする方法を示しています。ユーザー定義の初期化コード、ステップコード、および終了コードを追加するためのフックに注目してください。

    int32_T i;
 ...
    void (*mdl_initialize)(boolean_T);
    void (*mdl_step)(void);
    void (*mdl_terminate)(void);

    ExternalInputs_SharedLibraryCode (*mdl_Uptr);
    ExternalOutputs_SharedLibraryCode (*mdl_Yptr);
        
    uint8_T (*sum_outptr);
...
#if (defined(LCCDLL)||defined(BORLANDCDLL))
    /* Exported symbols contain leading underscores when DLL is linked with
       LCC or BORLANDC */
    mdl_initialize =(void(*)(boolean_T))GETSYMBOLADDR(handleLib ,
                     "_SharedLibraryCode_initialize");
    mdl_step       =(void(*)(void))GETSYMBOLADDR(handleLib ,
                     "_SharedLibraryCode_step");
    mdl_terminate  =(void(*)(void))GETSYMBOLADDR(handleLib ,
                     "_SharedLibraryCode_terminate");
    mdl_Uptr       =(ExternalInputs_SharedLibraryCode*)GETSYMBOLADDR(handleLib ,
                     "_SharedLibraryCode_U");
    mdl_Yptr       =(ExternalOutputs_SharedLibraryCode*)GETSYMBOLADDR(handleLib ,
                     "_SharedLibraryCode_Y");
    sum_outptr     =(uint8_T*)GETSYMBOLADDR(handleLib , "_sum_out");
#else   
    mdl_initialize =(void(*)(boolean_T))GETSYMBOLADDR(handleLib ,
                     "SharedLibraryCode_initialize");
    mdl_step       =(void(*)(void))GETSYMBOLADDR(handleLib ,
                     "SharedLibraryCode_step");
    mdl_terminate  =(void(*)(void))GETSYMBOLADDR(handleLib ,
                     "SharedLibraryCode_terminate");
    mdl_Uptr       =(ExternalInputs_SharedLibraryCode*)GETSYMBOLADDR(handleLib ,
                     "SharedLibraryCode_U");
    mdl_Yptr       =(ExternalOutputs_SharedLibraryCode*)GETSYMBOLADDR(handleLib ,
                     "SharedLibraryCode_Y");
    sum_outptr     =(uint8_T*)GETSYMBOLADDR(handleLib , "sum_out");
#endif
    
    if ((mdl_initialize && mdl_step && mdl_terminate && mdl_Uptr && mdl_Yptr && 
         sum_outptr)) {
        /* === user application initialization function === */
        mdl_initialize(1); 
        /* insert other user defined application initialization code here */
        
        /* === user application step function === */
        for(i=0;i<=12;i++){ 
            mdl_Uptr->Input = i;
            mdl_step(); 
            printf("Counter out(sum_out): %d\tAmplifier in(Input): %d\tout(Output): %d\n",
                   *sum_outptr, i, mdl_Yptr->Output); 
            /* insert other user defined application step function code here */
        }
        
        /* === user application terminate function === */
        mdl_terminate();
        /* insert other user defined application termination code here */
    }
    else {
        printf("Cannot locate the specified reference(s) in the shared library.\n");
        return(-1);
    }

サンプルアプリケーションのスクリプト

アプリケーションスクリプト run_SharedLibraryCode_app はモデルを読み込んでリビルドした後に、モデルの共有ライブラリターゲットファイルをコンパイル、リンク、および実行します。SharedLibraryCode を開き、白いボタンをクリックしてソースコードを表示して、スクリプトソースファイルを表示できます。スクリプトで、開発環境に適用される可能性のあるコンパイル、リンク、および実行用のプラットフォーム依存コマンドの文字ベクトルを構成します。スクリプトを実行するには、青いボタンをクリックします。

メモ

1 つの行で終了関数を 2 回呼び出すのは無効です。終了関数はポインターをクリアし、それらを NULL に設定します。関数を 2 回目に呼び出すと NULL ポインターが逆参照され、プログラムエラーになります。

共有ライブラリの制限

共有ライブラリのビルドには、次のような制限が適用されます。

ert_shrlib.tlc システムターゲットファイルのコード生成では、次のものをデータとしてエクスポートします。
- ExportedGlobal 型の変数と信号
- リアルタイムモデル構造体 (model_M)
Function-Call Subsystem を含むモデルでは、ert_shrlib.tlc システムターゲットファイルのコード生成で、初期化エントリポイント関数と終了エントリポイント関数に関連付けられたシンボルのみが共有ライブラリにエクスポートされます。
ert_shrlib.tlc システムターゲットファイルのコード生成では、C 言語のみがサポートされています (C++ ではない)。ert_shrlib.tlc を選択すると、モデルコンフィギュレーションパラメーターの [言語] はグレー表示になります。
生成された共有ライブラリを使用してモデルシミュレーションを再構成するには、アプリケーションの作成者は、システムと元のアプリケーションの共有ライブラリ関数呼び出しの間でタイミングを維持しなければなりません。シミュレーション結果と統合結果を比較できるように、タイミングは一貫していなければなりません。モデルコンフィギュレーションパラメーターの [サポート: 連続時間] と [1 つの出力/更新関数] を有効にするモデルから共有ライブラリを生成している場合、シミュレーションに関するさらなる考慮事項が適用されます。詳細については、1 つの出力/更新関数依存関係を参照してください。