Документация

Сравнение неинлинированных и встроенных версий модели.c

Без файла TLC для определения специфики S-функции генератор кода должен вызвать S-функцию MEX-файла через API S-функции. Следующий код: model.c файл для неинлинной S-функции (т.е. соответствующий файл TLC не существует).

Неинлинированная S-функция

/*
 * model.c
.
.
.
*/
real_T untitled_RGND = 0.0;             /* real_T ground */
/* Start the model */
void MdlStart(void)
{
  /* (no start code required) */
}
/* Compute block outputs */
void MdlOutputs(int_T tid)
{
  /* Level2 S-Function Block: <Root>/S-Function (foogain) */
  {
    SimStruct *rts = ssGetSFunction(rtS, 0);
    sfcnOutputs(rts, tid);
  }
}
/* Perform model update */
void MdlUpdate(int_T tid)
{
  /* (no update code required) */
}
/* Terminate function */
void MdlTerminate(void)
{
  /* Level2 S-Function Block: <Root>/S-Function (foogain) */
  {
    SimStruct *rts = ssGetSFunction(rtS, 0);
    sfcnTerminate(rts);
  }
}
#include "model_reg.h"
/* [EOF] model.c */

Встроенная S-функция.  Этот код: model.c с foogain S-функция полностью встроена:

/*
 * model.c
.
.
.
*/
/* Start the model */
void MdlStart(void)
{
  /* (no start code required) */
}

/* Compute block outputs */
void MdlOutputs(int_T tid)

  /* S-Function block: <Root>/S-Function */
  /* NOTE: There are no calls to the S-function API in the inlined 
     version of model.c. */
  rtB.S_Function = 0.0 * rtP.S_Function_Gain;
}

/* Perform model update */
void MdlUpdate(int_T tid)
{
  /* (no update code required) */
}

/* Terminate function */
void MdlTerminate(void)
{
  /* (no terminate code required) */
}

#include "model_reg.h"

/* [EOF] model.c */

Если включить этот целевой файл для этого S-функционального блока, результат model.c код -

rtB.S_Function = 0.0 * rtP.S_Function_Gain;

Включение файла TLC резко уменьшило размер кода и увеличило эффективность выполнения сгенерированного кода. В этих примечаниях представлена некоторая информация о коде TLC и сгенерированных выходных данных:

Сравнение неинлинированных и встроенных версий model_reg.h

Включение S-функции уровня 2 значительно уменьшает размер model_reg.h код. Функции регистрации моделей являются длительными; в этом примере большая часть кода была исключена. Код ниже подчеркивает разницу между неинлайнированной и встроенной версиями model_reg.h; встраивание устраняет этот код:

/*
 * model_reg.h
 *
*/
/* Normal model initialization code independent of 
      S-functions  */

/* child S-Function registration */
  ssSetNumSFunctions(rtS, 1);

  /* register each child */
  {
    static SimStruct childSFunctions[1];
    static SimStruct *childSFunctionPtrs[1];

    (void)memset((char_T *)&childSFunctions[0], 0, 
                  sizeof(childSFunctions));
    ssSetSFunctions(rtS, &childSFunctionPtrs[0]);
    {
      int_T i;

      for(i = 0; i < 1; i++) {
        ssSetSFunction(rtS, i, &childSFunctions[i]);
      }
    }

    /* Level2 S-Function Block: untitled/<Root>/S-Function 
       (foogain) */
    {
      extern void foogain(SimStruct *rts);
      SimStruct *rts = ssGetSFunction(rtS, 0);

      /* timing info */
      static time_T sfcnPeriod[1];
      static time_T sfcnOffset[1];
      static int_T sfcnTsMap[1];

      {
        int_T i;

        for(i = 0; i < 1; i++) {
          sfcnPeriod[i] = sfcnOffset[i] = 0.0;
        }
      }
      ssSetSampleTimePtr(rts, &sfcnPeriod[0]);
      ssSetOffsetTimePtr(rts, &sfcnOffset[0]);
      ssSetSampleTimeTaskIDPtr(rts, sfcnTsMap);
      ssSetMdlInfoPtr(rts, ssGetMdlInfoPtr(rtS));

      /* inputs */
      {
        static struct _ssPortInputs inputPortInfo[1];

        _ssSetNumInputPorts(rts, 1);
        ssSetPortInfoForInputs(rts, &inputPortInfo[0]);

        /* port 0 */
        {
          static real_T const *sfcnUPtrs[1];

          sfcnUPtrs[0] = &untitled_RGND;
          ssSetInputPortWidth(rts, 0, 1);
          ssSetInputPortSignalPtrs(rts, 0, 
              (InputPtrsType)&sfcnUPtrs[0]);
        }
      }

      /* outputs */
      {
        static struct _ssPortOutputs outputPortInfo[1];
        _ssSetNumOutputPorts(rts, 1);
        ssSetPortInfoForOutputs(rts, &outputPortInfo[0]);
        ssSetOutputPortWidth(rts, 0, 1);
        ssSetOutputPortSignal(rts, 0, &rtB.S_Function);
      }

      /* path info */
      ssSetModelName(rts, "S-Function");
      ssSetPath(rts, "untitled/S-Function");
      ssSetParentSS(rts, rtS);
      ssSetRootSS(rts, ssGetRootSS(rtS));
      ssSetVersion(rts, SIMSTRUCT_VERSION_LEVEL2);

      /* parameters */
      {
        static mxArray const *sfcnParams[1];

        ssSetSFcnParamsCount(rts, 1);
        ssSetSFcnParamsPtr(rts, &sfcnParams[0]);

        ssSetSFcnParam(rts, 0, &rtP.S_Function_P1Size[0]);
      }

      /* registration */
      foogain(rts);

      sfcnInitializeSizes(rts);
      sfcnInitializeSampleTimes(rts);

      /* adjust sample time */
      ssSetSampleTime(rts, 0, 0.2);
      ssSetOffsetTime(rts, 0, 0.0);
      sfcnTsMap[0] = 0;

      /* Update the InputPortReusable and BufferDstPort flags for 
        each input port */
      ssSetInputPortReusable(rts, 0, 0);
      ssSetInputPortBufferDstPort(rts, 0, -1);

      /* Update the OutputPortReusable flag of each output port */
    }
  }

Файл TLC для встроенной S-функции foogain

Чтобы избежать ненужных вызовов S-функции и создать минимальный код, необходимый для S-функции, следующий файл TLC, foogain.tlc, приводится в качестве примера.

%implements "foogain" "C"

%function Outputs (block, system) Output
  /* %<Type> block: %<Name> */
  %%
  %assign y = LibBlockOutputSignal (0, "", "", 0)
  %assign u = LibBlockInputSignal (0, "", "", 0)
  %assign p = LibBlockParameter (Gain, "", "", 0)
  %<y> = %<u> * %<p>;
%endfunction

Управление данными экземпляра блока с целью создания кода

Данные экземпляра - это дополнительные данные или рабочая память, уникальная для каждого экземпляра блока в модели Simulink. Это не включает в себя данные параметров или состояний (которые хранятся в параметрах модели и векторах состояний соответственно), а скорее используется для кэширования промежуточных результатов или производных представлений параметров и режимов. Одним из примеров данных экземпляра является буфер, используемый блоком задержки передачи.

Выделение и использование памяти для каждого экземпляра может быть выполнено несколькими способами в S-функции уровня 2: ssSetUserData, рабочие векторы (например, ssSetRWorkValue, ssSetIWorkValue) или рабочие векторы типа данных, известные как DWork векторы. Для наименьших усилий при написании целевого файла S-функции и блока и для автоматического соответствия как статическим, так и malloc данные экземпляра о целевых объектах, таких как grtиспользуйте рабочие векторы типа данных при записи S-функций с данными экземпляра.

Преимущества двояки. Во-первых, написание S-функции более прост, в том, что распределение памяти и освобождения обрабатываются для вас Simulink. Во-вторых, DWork векторы записываются в model.rtw для вас автоматически, включая DWork имя, тип данных и размер. Это упрощает запись целевого файла блока, так как не нужно писать код TLC для выделения и освобождения DWork память.

Кроме того, если требуется объединить группы DWork векторы в структуры для передачи в функции, можно заполнить структуру указателями на DWork массивы в обеих S-функциях mdlStart и целевой файл блока Start способ обеспечивает согласованность между S-функцией и обработкой данных сгенерированным кодом.

Наконец, использование DWork делает простым создание определенной версии кода (типы данных, скаляр и векторизация и т.д.) для каждого экземпляра блока, который соответствует реализации в S-функции. Обе реализации используют DWork таким же образом, чтобы встроенный код можно было использовать с программным обеспечением Simulink Accelerator™ без изменений функции C MEX S или целевого файла блока.

Использование встроенного кода с программным обеспечением Simulink Accelerator

По умолчанию программа Simulink Accelerator вызывает функцию C MEX S как часть ускоренного моделирования модели. Если перед запуском ускоренной модели акселератор должен быть встроен в S-функцию, попросите акселератор использовать целевой файл блока для встраивания S-функции с помощью SS_OPTION_USE_TLC_WITH_ACCELERATOR флаг в вызове ssSetOptions() в mdlInitializeSizes функции этой S-функции.

Следует отметить, что размер и использование памяти и рабочего вектора должны быть одинаковыми для сгенерированного кода TLC и S-функции C MEX, или программное обеспечение Simulink Accelerator не может правильно выполнить встроенный код. Это происходит потому, что S-функция C MEX вызывается для инициализации блока и его рабочих векторов, вызывая mdlInitializeSizes, mdlInitializeConditions, mdlCheckParameters, mdlProcessParameters, и mdlStart функции. В случае постоянного распространения сигнала mdlOutputs вызывается из S-функции C MEX во время фазы инициализации выполнения модели.

В течение фазы временного сдвига ускоренного выполнения модели код, генерируемый Output и Update будут выполняться блочные методы TLC, плюс Derivatives и методы пересечения нуля, если они существуют. Start способ целевого файла блока не используется при формировании кода для ускоренной модели.