%% ============================================================================ %% %% $Revision: 1.1.6.10 $ %% %% %% Abstract: %% This system file makes a code format independent pass through the %% model. %% %% Copyright 1994-2004 The MathWorks, Inc. %% %selectfile NULL_FILE %if EXISTS("_COMMONPASS_") == 0 %assign _COMMONPASS_ = 1 %selectfile STDOUT %if RTWVerbose ### Initial pass through model to cache user defined code %endif %selectfile NULL_FILE % %% Load Model reference blocks' interfaces from binfo information mat-file. % %% Mark each parameter in the const section %% - ConstRTPWithInit = InConstWithInitSection %% - ConstRTP = InConstSection %% %with CompiledModel.ModelParameters %foreach i = NumParameters %addtorecord Parameter[i] InConstSection 0 %addtorecord Parameter[i] InConstWithInitSection 0 %addtorecord Parameter[i] WasAccessedAsVariable 0 %endforeach %assign startIdx = NumInrtP %foreach i = NumConstPrmsWithInit %assign Parameter[startIdx + i].InConstWithInitSection = 1 %endforeach %assign startIdx = startIdx+NumConstPrmsWithInit %foreach i = NumConstPrms %assign Parameter[startIdx + i].InConstSection = 1 %endforeach %endwith %% ============================================================================ %% Before code generation begins, make a pass through the model and: %% %% o Initialize UserDefinedRWork, UserDefinedIWork, and UserDefinedPWork %% to zero. This initialization must be performed before calling the %% block's BlockInstanceSetup function since it is there that the user %% will define (redefine) their work vectors. %% %% o Execute each blocks "BlockInstanceSetup" function. %% %% o Execute a blocks "BlockTypeSetup" function the first time the block %% type is encountered. %% %% o Promote defined RWork, IWork, PWork and DWork into parent scope. %% %% o Initialize each block output as not needed to be declared in function %% scope. This will be used to track block output signals that are not in %% the global BlockIO vector, and hence need to be locally declared in the %% appropriate functions. %% %% o Force expression folding off if the block is not compliant. %% %% o Force scalar expanded input expressions off unless otherwise specified. %% %% ============================================================================ %% Loop through the System records and ... %% %foreach sysIdx = NumSystems %assign system = System[sysIdx] %with system %foreach blkIdx = NumBlocks+NumVirtualOutportBlocks %assign block = Block[blkIdx] %with block %if Type != "Opaque" %% Promote RWork defines into parent scope if the block defines RWorks %if EXISTS("block.NumRWorkDefines") %foreach idx = NumRWorkDefines %assign work = RWorkDefine[idx] %if !EXISTS("block.%") %assign % = work %assign block = block + % %endif %endforeach %endif %% Promote IWork defines into parent scope if the block defines IWorks %if EXISTS("block.NumIWorkDefines") %foreach idx = NumIWorkDefines %assign work = IWorkDefine[idx] %assign % = work %assign block = block + % %endforeach %endif %% Promote IWork defines into parent scope if the block defines PWorks %if EXISTS("block.NumPWorkDefines") %foreach idx = NumPWorkDefines %assign work = PWorkDefine[idx] %if !EXISTS("block.%") %assign % = work %assign block = block + % %endif %endforeach %endif %% Promote DWork into parent scope. %if block.NumDWork > 0 %foreach idx = block.NumDWork %assign work = DWork[idx] %assign % = work %assign block = block + % %endforeach %endif %endif %% Type != "Opaque" %addtorecord block BlkSysIdx SystemIdx %% Execute the block's BlockTypeSetup function %% if it hasn't been called yet (note that S-function %% blocks are special) %if Type == "S-Function" %assign sfuncName = ParamSettings.FunctionName %assign globalVar = "BlockTypeSetupForSFunction_%" %elseif Type == "M-S-Function" %assign msfunName = ParamSettings.MFile %assign globalVar = "BlockTypeSetupForBlockType_%" %else %assign globalVar = "BlockTypeSetupForBlockType_%" %endif %if !EXISTS("%") %\ %assign % = 1 %endif %% Execute the block's BlockInstanceSetup function %assign ::BlockFcn = "BlockInstanceSetup" %\ %assign ::BlockFcn = "Unknown" %% Check expression folding compliance %% If not compliant, don't allow nonconst expressions at the %% output port, nor (nonconst) expressions at the input ports. %if !block.TLCExprCompliant %foreach ipIdx = NumDataInputPorts % %endforeach %foreach ipIdx = NumControlInputPorts % %endforeach %if ISFIELD(block, "HiddenDataInputPort") % %endif %if ISFIELD(block, "HiddenControlInputPort") % %endif % %endif %% Disallow scalar expanded expression (unless otherwise specified) %% This is why: %% Suppose we have a block with multiple input expressions, at least %% one wide, at one scalar. Then expansion of the scalar inputs %% causes those inputs to be duplicated which harms throughput. %% %% For example, say we have a Sum block with a wide input "u1" %% and scalar input "u2". If we accept expressions at the scalar %% input we will end up with something like %% %% for (i = 0; i < 10; i++) { %% output[i] = sin(cos(u1[i])) + sin(cos(u2)); %% } %% %% Here we see sin(cos(u2)) repeatedly and calculated due to scalar %% expansion of an expression. %if block.TLCExprCompliant %foreach opIdx = NumDataOutputPorts %if LibBlockOutputSignalWidth(opIdx) > 1 %foreach ipIdx = NumDataInputPorts %if LibBlockInputSignalWidth(ipIdx) == 1 && ... !block.DataInputPort[ipIdx].AllowScalarExpandedExpr % %endif %endforeach %endif %endforeach %endif %endwith %% block %endforeach %% Check each non-virtual system for the existence of RTWdata in a %% empty subsystem. If EmptySubsysInfo exists and RTWdata.TLCFile %% exists, execute the designated TLC file. This loop is used for the %% custom code block, but can also be used to call a tlc file for any %% other empty subsystems that have RTWdata records by assigning the %% field TLCFile to be the name of the tlc file. Note: the RTWdata %% attached to a block should be processed by that blocks own tlc file. %if EXISTS("EmptySubsysInfo") %with EmptySubsysInfo %foreach idx = NumRTWdatas %assign temp = RTWdata[idx] %if EXISTS("temp.IncludePath") %addincludepath temp.IncludePath %endif %if EXISTS("temp.TLCFile") %if FILE_EXISTS(GENERATE_FILENAME(temp.TLCFile)) % %else %if system.Type != "root" %assign sysName = LibUnmangledPathName(system.Name) %else %assign sysName = CompiledModel.Name %endif %openfile errTxt Cannot locate TLC file %.tlc A block specified RTWData without a corresponding TLC file. \ RTWData must include the TLC file name. For example, data.Foo = '1'; data.TLCFile = 'foofile'; set_param(gcb, 'RTWData', data); RTWData { Foo "1" TLCFile "foofile" } The specified TLC file either does not exist, or is not on the TLC \ path, or is incorrect. The block was located in system: % %closefile errTxt % %endif %endif %endforeach %endwith %endif %endwith %% system %endforeach %% clean up %undef system, block, param, bo, work, temp %% ============================================================================= %% Loop through the Block Output records and attach the following three fields %% to each record: %% %% DeclareInFcnScope: %% Attach a "DeclareInFcnScope" to each block output record and initialize %% this field to zero. This flag will be used to decide if a block output %% that is not in the global BlockIO vector and needs to be declared in %% the root Start or a System's Output or OutputUpdate function scope. %% %% RequiredInBlockIO: %% This setting determines if the block output needs to be declared in the %% global BlockIO structure. This is true if a) if it is a TestPoint, b) it %% is not constant valued and it is required in the global scope. %% %% RequiredInConstBlockIO: %% This setting determines if the block output needs to be declared in the %% global ConstBlockIO structure. Firstly the initial value of this setting %% depends on the level that InlineInvariantSignals is set to, i.e., %% %% -> If InlineInvariantSignals=0, then RequiredInConstBlockIO=1 for all %% invaraint block outputs. %% %% -> If InlineInvariantSignals=1, then it is assumed (at this time) that %% none of the invariant block outputs are required in the ConstBlockIO %% structure, i.e., we expect all of these signals to be #def'ed to their %% (invariant) initial values in model.h This assumption will be corrected %% during the process of code generation, for those invaraint signals that %% are referenced by their address. Hence after all the code has been %% generated into model.c and model.prm, we will end up with the *minimal* %% number of invariant block outputs marked as required in the %% ConstBlockIO structure. %% %% Also keep a count of a) the number of signals in the BlockIO structure, %% b) the number of signals in the ConstBlockIO structure, c) the number %% of signals that are invariant in the BlockIO structure, and d) the number %% of external signals. %% % % % % % % % % %assign nMdlRefOut = 0 %assign nInBlkIO = BlockOutputs.NumGlobalBlockOutputs %assign nConstExpr = BlockOutputs.NumConstOutputExpr %assign nInConstBlkIO = 0 %assign nExtGlobal = 0 %assign nImpExtern = 0 %assign nImpExternPtr = 0 %assign nCustom = 0 %foreach boIdx = BlockOutputs.NumGlobalBlockOutputs %assign globalBO = BlockOutputs.GlobalBlockOutput[boIdx] %if SIZE(globalBO.SigSrc,1) > 0 %assign srcSys = CompiledModel.System[globalBO.SigSrc[0]] %assign srcBlk = srcSys.Block[globalBO.SigSrc[2]] %if ISEQUAL(srcBlk.TID, "constant") %% Mark this block so that its Outputs function gets %% generated in mdlStart outside of #if 0 ... #endif % %endif %endif %assign isMdlrefOutput = 0 %assign baseSystemIdx = GetBaseSystemIdx() %if globalBO.OwnerSysIdx[0] != -1 && ... globalBO.OwnerSysIdx[0] > baseSystemIdx %% This signal is allocated by the parent, and should not be initialized %% Currently this is the case for buffers feeding the root output %% ports of referenced models %% %assert(IsModelReferenceTarget()) %assign nMdlRefOut = nMdlRefOut + 1 %assign isMdlrefOutput = 1 %assign globalBO.DeclareInScope = 1 %endif %assign required = [1, %] % %endforeach %assign BlockOutputs.NumModelReferenceRootOutput = nMdlRefOut %foreach boIdx = BlockOutputs.NumExternalBlockOutputs %assign externBO = BlockOutputs.ExternalBlockOutput[boIdx] %if SIZE(externBO.SigSrc,1) > 0 %assign srcSys = CompiledModel.System[externBO.SigSrc[0]] %assign srcBlk = srcSys.Block[externBO.SigSrc[2]] %if ISEQUAL(srcBlk.TID, "constant") %% Mark this block so that its Outputs function gets %% generated in mdlStart outside of #if 0 ... #endif % %endif %endif %switch externBO.StorageClass %case "ExportedGlobal" %assign nExtGlobal = nExtGlobal + 1 %break %case "ImportedExtern" %assign nImpExtern = nImpExtern + 1 %break %case "ImportedExternPointer" %assign nImpExternPtr = nImpExternPtr + 1 %break %case "Custom" %assign nCustom = nCustom + 1 %break %default %assign errTxt = "Unknown storage class: %" % %endswitch %endforeach %foreach boIdx = BlockOutputs.NumConstBlockOutputs %assign constBO = BlockOutputs.ConstBlockOutput[boIdx] %if constBO.RequiredInConstBlockIO %assign nInConstBlkIO = nInConstBlkIO + 1 %elseif InlineInvariantSignals == 0 || CompiledModel.PadderActive %assign constBO.RequiredInConstBlockIO = 1 %assign nInConstBlkIO = nInConstBlkIO + 1 %endif %if SIZE(constBO.SigSrc,1) > 0 %assign srcSys = CompiledModel.System[constBO.SigSrc[0]] %assign srcBlk = srcSys.Block[constBO.SigSrc[2]] %% %% If the initial value is empty then it implies that SL and the normal %% TLC library functions cannot initialize this signal. This could be due %% to the fact that the data type of signal is not known to Simulink. In %% such an event, check if the block target file has "BlockInitialValues" %% method, that can provide the required initialization. If this method %% does not exist in the block target file, then mark the block so that %% its Outputs function gets generated in mdlStart outside the #if 0 ... %% #endif statements. %% %if ISEMPTY(constBO.InitialValue) %assign initInMdlStart = 0 %if LibBlockFunctionExists(srcBlk, "BlockInitialValues") %assign vType = "Y%" %with srcSys %assign initVal = GENERATE(srcBlk,"BlockInitialValues",srcSys,vType) %endwith %% srcSys %if WHITE_SPACE(initVal) %assign warnTxt = "Ignoring bogus initial output value." % %assign initInMdlStart = 1 %else % %endif %else %assign initInMdlStart = 1 %endif %if initInMdlStart %assign initVal = [0] % %assign constBO.RequiredInConstBlockIO = 1 %assign constBO.DoNotConstify = 1 %assign nInConstBlkIO = nInConstBlkIO + 1 % %endif %undef initInMdlStart, vType, initVal %endif %endif %endforeach %assign BlockOutputs.NumSignalsInBlockIO = nInBlkIO %assign BlockOutputs.NumSignalsInConstBlockIO = nInConstBlkIO %assign BlockOutputs.NumExportedGlobalSignals = nExtGlobal %assign BlockOutputs.NumImportedExternSignals = nImpExtern %assign BlockOutputs.NumImportedExternPointerSignals = nImpExternPtr %assign BlockOutputs.NumCustomSignals = nCustom %% Total number of accessible signals for external mode. %assign BlockOutputs.NumAccessibleSignals = ... nInBlkIO + nExtGlobal + nImpExtern + nImpExternPtr + nCustom %% ============================================================================= %% Loop through the ExternalInputs records and attach the following to %% determine the number of external signals. %% % % % % % %assign nAuto = 0 %assign nExtGlobal = 0 %assign nImpExtern = 0 %assign nImpExternPtr = 0 %foreach eiIdx = ExternalInputs.NumExternalInputs %assign ei = ExternalInputs.ExternalInput[eiIdx] %switch ei.StorageClass %case "Auto" %assign nAuto = nAuto + 1 %break %case "ExportedGlobal" %assign nExtGlobal = nExtGlobal + 1 %break %case "ImportedExtern" %assign nImpExtern = nImpExtern + 1 %break %case "ImportedExternPointer" %assign nImpExternPtr = nImpExternPtr + 1 %break %case "Custom" %assign nCustom = nCustom + 1 %break %default %assign errTxt = "Unknown storage class: %" % %endswitch %endforeach %assign ExternalInputs.NumAutoSignals = nAuto %assign ExternalInputs.NumExportedGlobalSignals = nExtGlobal %assign ExternalInputs.NumImportedExternSignals = nImpExtern %assign ExternalInputs.NumImportedExternPointerSignals = nImpExternPtr %assign ExternalInputs.NumCustomSignals = nCustom %% ============================================================================= %% Add total number of external signals (block io + external inputs) to %% CompiledModel for future reference. %% % % % % %% ============================================================================= %% Add total number of external dwork to CompiledModel for future reference. %% %assign nCustom = 0 %assign nExtGlobal = 0 %assign nImpExtern = 0 %assign nImpExternPtr = 0 %assign nActDWork = 0 %assign numDWorks = CompiledModel.DWorks.NumDWorks %% Function: FcnSetOptimizedAwayInTLC ==========================================%% Abstract: %% Optimize away some dworks in TLC, e.g. for model reference block %% whose model interface reveals that it does not have dwork. This %% is a bit of a hack designed to address g230338 and should only be %% used for the dworks of model reference blocks, since NumDWorks %% is subject to misinterpretation with respect to this optimization. %% We have made sure that where NumDWorks is used we take this %% optimization into account with the assumption that it will only %% apply to the dworks of model reference blocks. %function FcnSetOptimizedAwayInTLC(dwRec) void %assign blkType = System[dwRec.SigSrc[0]].Block[dwRec.SigSrc[2]].Type %assign isMdlRef = blkType == "ModelReference" %assign hasDWork = TLC_TRUE %% Model reference block SIM target always registers one dwork. %% However, the dwork may be optimized in the RTW target. (see geck 230338) %if isMdlRef %assign block = System[dwRec.SigSrc[0]].Block[dwRec.SigSrc[2]] %assign blockInterface = GetModelrefInterface(block) %assign hasDWork = blockInterface.HasDWork %if !hasDWork %assign dwRec.OptimizedAwayInTLC = 1 %endif %endif %endfunction %foreach dwIdx = numDWorks %assign dwRec = CompiledModel.DWorks.DWork[dwIdx] %switch dwRec.StorageClass %case "Custom" %assign nCustom = nCustom + 1 %break %case "ExportedGlobal" %assign nExtGlobal = nExtGlobal + 1 %break %case "ImportedExtern" %assign nImpExtern = nImpExtern + 1 %break %case "ImportedExternPointer" %assign nImpExternPtr = nImpExternPtr + 1 %break %default % %if !dwRec.OptimizedAwayInTLC %assign nActDWork = nActDWork + 1 %endif %endswitch %endforeach % % % % % %undef bo, boIdx, nInBlkIO, nInConstBlkIO, currentStackSize %undef ei, eiIdx, nAuto, nExtGlobal, nImpExtern, nImpExternPtr, nActDWork %assign CompiledModel.InCommonPass = 0 %endif %% _COMMONPASS_ %% [EOF] commonpass.tlc