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

Примеры тривиальных и универсальных выходных выражений

Рассмотрим эту блок-схему. Блок задержки имеет несколько пунктов назначения, но его выход обозначается как тривиальное выходное выражение, так что он может использоваться более одного раза без ухудшения эффективности кода.

Этот фрагмент кода показывает код, сгенерированный из блока «Unit Delay» в данной блок-схеме. Три корневых выхода назначаются непосредственно из состояния блока единичной задержки, который хранится в поле глобальной структуры данных. rtDWork. Поскольку назначение является прямым, без выражений не существует никакого штрафа производительности, связанного с использованием тривиального выражения для нескольких назначений.

void MdlOutputs(int_T tid)
{
   ...
  /* Outport: <Root>/Out1 incorporates:

   *   UnitDelay: <Root>/Unit Delay */
  rtY.Out1 = rtDWork.Unit_Delay_DSTATE;

  /* Outport: <Root>/Out2 incorporates:
   *   UnitDelay: <Root>/Unit Delay */
  rtY.Out2 = rtDWork.Unit_Delay_DSTATE;

  /* Outport: <Root>/Out3 incorporates:
   *   UnitDelay: <Root>/Unit Delay */
  rtY.Out3 = rtDWork.Unit_Delay_DSTATE;

   ...
}

Созданный код показывает, как создается код для блоков Sum с одним и несколькими адресатами.

С другой стороны, рассмотрим блоки суммы в этой модели:

Верхний блок суммы в модели генерирует сигнал с меткой non_triv. Вычисление этого выходного сигнала включает в себя два умножения и сложение. Если бы выводу блока Sum было разрешено генерировать выражение, даже если блок имел несколько мест назначения, то операции блока дублировались бы в сгенерированном коде. В этом случае генерируемые выражения будут размножаться до четырех умножений и двух дополнений. Это приведет к снижению эффективности программы. Соответственно, выходной сигнал блока Sum не может быть выражением, поскольку он имеет несколько адресатов.

Механизм Simulink не позволяет выходному сигналу верхнего блока Sum быть выражением, поскольку сигнал non_triv маршрутизируется в два места назначения вывода. Вместо этого результат операций умножения и сложения сохраняется во временной переменной. (rtb_non_triv) это дважды упоминается в следующих инструкциях, как показано в приведенном ниже фрагменте кода.

Напротив, нижний блок Sum, который имеет только одно выходное назначение (Out2), создает выражение.

void MdlOutputs(int_T tid)
{
  /* local block i/o variables */
  real_T rtb_non_triv;
  real_T rtb_Sine_Wave;

  /* Sum: <Root>/Sum incorporates:
   *   Gain: <Root>/Gain
   *   Inport: <Root>/u1
   *   Gain: <Root>/Gain1
   *   Inport: <Root>/u2
   *
   * Regarding <Root>/Gain:
   *   Gain value: rtP.Gain_Gain
   *
   * Regarding <Root>/Gain1:
   *   Gain value: rtP.Gain1_Gain
   */
  rtb_non_triv = (rtP.Gain_Gain * rtU.u1) + (rtP.Gain1_Gain * 
rtU.u2);

  /* Outport: <Root>/Out1 */
  rtY.Out1 = rtb_non_triv;

  /* Sin Block: <Root>/Sine Wave */

  rtb_Sine_Wave = rtP.Sine_Wave_Amp *
	sin(rtP.Sine_Wave_Freq * rtmGetT(rtM_model) + 
	rtP.Sine_Wave_Phase) + rtP.Sine_Wave_Bias;

  /* Outport: <Root>/Out2 incorporates:
   *   Sum: <Root>/Sum1
   */
  rtY.Out2 = (rtb_non_triv + rtb_Sine_Wave);
}

Указание категории выходного выражения

S-Function API предоставляет макросы, которые позволяют объявить, должен ли вывод блока быть выражением, и если да, то указать категорию выражения. В этой таблице указывается, когда объявить вывод блока константой, тривиальным или обобщенным выражением вывода.

Необходимо объявить выходные данные как выражения в mdlSetWorkWidths с использованием макросов, определенных в S-Function API. Макросы имеют следующие аргументы:

Для задания вывода в качестве константы, тривиального или общего выражения доступны следующие макросы:

Для запроса состояния, заданного предыдущими вызовами макросов выше, доступны следующие макросы:

Набор базовых выражений является надсетью набора тривиальных выражений, а набор тривиальных выражений является надсетью набора константных выражений.

Поэтому при запросе выходного документа, для которого задано постоянное выражение с ssGetOutputPortTrivialOutputExprInRTW, возвращается True. Константное выражение считается тривиальным выражением, поскольку это прямой доступ к памяти, который может повторяться без ухудшения эффективности генерируемого кода.

Аналогично, вывод, настроенный как константа или тривиальное выражение, возвращает True при запросе состояния в качестве общего выражения.

S-Function API для определения приемки входного выражения

S-Function API предоставляет макросы, которые позволяют:

По умолчанию входные данные блоков не принимают некондиционные выражения.

Необходимо вызвать макросы в mdlSetWorkWidths функция. Макросы имеют следующие аргументы:

Макрос, доступный для указания, должен ли вводимый блок принимать неконкретное выражение:

void ssSetInputPortAcceptExprInRTW(SimStruct *S, int portIdx, bool value)

Соответствующий макрос, доступный для запроса состояния, установленного любыми предыдущими вызовами ssSetInputPortAcceptExprInRTW является:

bool ssGetInputPortAcceptExprInRTW(SimStruct *S, int portIdx)

Отказ в блокировании запросов на выходные выражения

Даже после того, как конкретный блок запрашивает разрешение на создание выходного выражения, этот запрос может быть отклонен по общим причинам. Эти причины включают, но не ограничиваются ими:

Не нужно учитывать эти общие факторы при принятии решения об использовании сворачивания выражения для конкретного блока. Однако эти правила могут быть полезны при изучении сгенерированного кода и анализе случаев, когда подавляется оптимизация сворачивания выражения.

Соответствие сворачиванию выражений

В BlockInstanceSetup функция вашей S-функции, зарегистрируйте ваш блок, чтобы он соответствовал сворачиванию выражений. В противном случае затребованное или разрешенное сворачивание выражения на выходах или входах блока будет отключено, и будут использоваться временные переменные.

Для регистрации соответствия сворачивания выражений вызовите функцию библиотеки TLC LibBlockSetIsExpressionCompliant(block), которая определена в matlabroot/rtw/c/tlc/lib/utillib.tlc. Например:

%% Function: BlockInstanceSetup ===========================================
%%
%function BlockInstanceSetup(block, system) void
  %%
  %<LibBlockSetIsExpressionCompliant(block)>
  %%
%endfunction

Можно условно отключить сворачивание выражения на входах и выходах блока, сделав вызов этой функции условно.

При переопределении одной из реализаций TLC-блоков, поставляемых генератором кода с собственной реализацией, не следует выполнять предыдущий вызов до тех пор, пока не будет обновлена реализация.

Выходные выражения

BlockOutputSignal функция используется для генерации кода для скалярного выходного выражения или одного элемента нескалярного выходного выражения. Если блок выводит выражение, необходимо добавить BlockOutputSignal функция. Прототип BlockOutputSignal является

%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void

Аргументы для BlockOutputSignal таковы:

BlockOutputSignal функция возвращает символьный вектор для выходного сигнала или адреса. Символьный вектор должен обеспечивать приоритет выражения, используя открывающие и завершающие круглые скобки, если выражение не состоит из вызова функции. Адрес выражения может быть возвращен только для константного выражения; это адрес параметра, к памяти которого осуществляется доступ. Код, реализующий BlockOutputSignal функция для блока Константа:

%% Function: BlockOutputSignal =================================================
%% Abstract:
%%      Return the reference to the parameter.  This function *may*
%%      be used by Simulink when optimizing the Block IO data structure.
%%
%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void
  %switch retType
    %case "Signal"
      %return LibBlockParameter(Value,ucv,lcv,idx)
    %case "SignalAddr"
      %return LibBlockParameterAddr(Value,ucv,lcv,idx)
    %default
      %assign errTxt = "Unsupported return type: %<retType>"
      %<LibBlockReportError(block,errTxt)>
  %endswitch
%endfunction

Код, реализующий BlockOutputSignal функция для блока реляционного оператора:

%% Function: BlockOutputSignal =================================================
%% Abstract:
%%      Return an output expression.  This function *may*
%%      be used by Simulink when optimizing the Block IO data structure.
%%
%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void
%switch retType
%case "Signal"
%assign logicOperator = ParamSettings.Operator
 %if ISEQUAL(logicOperator, "~=")
 %assign op = "!="
elseif ISEQUAL(logicOperator, "==") %assign op = "=="
  %else
%assign op = logicOperator
%endif
 %assign u0 = LibBlockInputSignal(0, ucv, lcv, idx)
%assign u1 = LibBlockInputSignal(1, ucv, lcv, idx)
  %return "(%<u0> %<op> %<u1>)"
 %default
 %assign errTxt = "Unsupported return type: %<retType>"
 %<LibBlockReportError(block,errTxt)>
%endswitch
%endfunction

Сворачивание выражения для блоков с несколькими выходами

Когда блок имеет один выход, Outputs функция в TLC-файле блока вызывается только в том случае, если выходной порт не является выражением. В противном случае BlockOutputSignal вызывается функция.

Если блок имеет несколько выходов, Outputs вызывается, если любой выходной порт не является выражением. Outputs функция должна защищать от генерации кода для выходных портов, которые являются выражениями. Это достигается путем защиты разделов кода, соответствующих отдельным портам вывода с вызовами LibBlockOutputSignalIsExpr().

Например, рассмотрим S-функцию с двумя входами и двумя выходами, где

Outputs и BlockOutputSignal функции для S-функции показаны в этом фрагменте кода:

%% Function: BlockOutputSignal =================================================
%% Abstract:
%%      Return an output expression.  This function *may*
%%      be used by Simulink when optimizing the Block IO data structure.
%%
%function BlockOutputSignal(block,system,portIdx,ucv,lcv,idx,retType) void
%switch retType
%case "Signal"
   %assign u = LibBlockInputSignal(portIdx, ucv, lcv, idx)
 %case "Signal"
 %if portIdx == 0
  %return "(2 * %<u>)"
%elseif portIdx == 1
 %return "(4 * %<u>)"
%endif
%default
%assign errTxt = "Unsupported return type: %<retType>"
 %<LibBlockReportError(block,errTxt)>
%endswitch
%endfunction  
%%
%% Function: Outputs =================================================
%% Abstract:
%%      Compute output signals of block
%%
%function Outputs(block,system) Output
%assign rollVars = ["U", "Y"]
%roll sigIdx = RollRegions, lcv = RollThreshold, block, "Roller", rollVars 
%assign u0 = LibBlockInputSignal(0, "", lcv, sigIdx)
 %assign u1 = LibBlockInputSignal(1, "", lcv, sigIdx)
 %assign y0 = LibBlockOutputSignal(0, "", lcv, sigIdx)
 %assign y1 = LibBlockOutputSignal(1, "", lcv, sigIdx)
%if !LibBlockOutputSignalIsExpr(0)
%<y0> = 2 * %<u0>;
%endif
%if !LibBlockOutputSignalIsExpr(1)
 %<y1> = 4 * %<u1>;
%endif
%endroll
%endfunction

Комментарии для блоков, совместимых со складыванием выражений

В прошлом блоки предваряли свои выходные коды комментариями формы

/* %<Type> Block: %<Name> */

Если блок совместим со складыванием выражений, начальная строка, показанная выше, генерируется автоматически. Не включайте комментарий в реализацию TLC блока. Зарегистрируйте дополнительную информацию с помощью LibCacheBlockComment функция.

LibCacheBlockComment функция принимает вектор символов в качестве ввода, определяя тело комментария, за исключением открывающего заголовка, последней новой строки однострочного или многострочного комментария и закрывающего трейлера.

Следующий код TLC иллюстрирует регистрацию блочного комментария. Обратите внимание на использование функции LibBlockParameterForComment, который возвращает вектор символов, подходящий для комментария блока, указывающий значение параметра блока.

%openfile commentBuf
  $c(*) Gain value: %<LibBlockParameterForComment(Gain)>
  %closefile commentBuf
  %<LibCacheBlockComment(block, commentBuf)>