MATLAB: How to build and run the Simulink model in accelerator mode without copying the necessary wrapper files to the model’s directory

simulink

I have a large Simulink model which contains a number of S-functions written in C. Some of these S-functions are inlined with TLC files and wrapper .h and .c files, and the S-functions are set to use TLC when in accelerator mode.

The issue that I have is that the model will not build correctly in accelerator mode, unless copies of the wrapper .c and .h files are located in the same directory as the model. Is there any way to get around this?

Best Answer

When an S-function is configured to be inlined using a TLC file in accelerator mode, the required TLC, .c and .h files must be on the compiler path. By default this is ensured by placing them in the current directory.

There are two workarounds to allow them to not be in the current directory:

1) Normally, the compiler will look at the current directory where the model resides to find these two additional files. When the compiler does not find these files, it produces an error. If you do not want to have to copy these files to each model directory that uses this S-function, you can customize the generated makefile such that the source and include directories have been added. The documentation covering this can be found at the following web address:

 <http://www.mathworks.com/help/releases/R2013a/rtw/ug/customizing-template-makefiles.html>

2) The second method involves making a change to the model’s configuration set. In the model, open the configuration parameters window, and go to the “Custom Code” tab on the left. Then, add the directory where the files are located to the “Include directories” dialog window. For more detailed information on how to add include directories, please refer to the following documentation.

 <http://www.mathworks.com/help/releases/R2013a/rtw/ref/code-generation-pane-custom-code.html>

Related Solutions

MATLAB: How to know which source files, compiler options, and link options are needed to build the code generated from Real-Time Workshop on a PC that does not have MATLAB

The ability to generate a file that contains source files, compiler options, and link options is not available in Real-Time Workshop.

For releases prior to Real-Time Workshop v.v (R2007a), there are 2 methods to port generated code. Both require a lot of manual copying and extracting information from the makefile. Either the MATLAB file hierachy must be maintained and the generated makefile can be used with minor modifications, or the files must be copied, and some information form the makefile must be extracted. Both methods are summarized below.

%%%METHOD 1: Maintaining the MATLAB hierarchy

Note: "Host PC" refers to the PC running MATLAB, while "Target PC" refers to

the PC that the code will be compiled on (without MATLAB installed)

1) Generate code for the model on the Host PC

2) Copy the entire build dir (usually called model_ert_rtw) to the Target PC For example (rtwdemo_counter is the model):

Host PC: C:\myproject\rtwdemo_counter_ert_rtw

Target PC: C:\my_target_port\rtwdemo_counter_ert_rtw

3) Copy the entire slprj dir to the Target PC:

Host PC: C:\myproject\slprj\...

Target PC: C:\my_target_port\slprj\...

4) Open the generated makefile (the .mk file) and look for the definition of

MATLAB_INCLUDES. There will be several directories listed similar to these:

$(MATLAB_ROOT)\rtw\c\ert

$(MATLAB_ROOT)\extern\include

$(MATLAB_ROOT)\simulink\include

...

All of these directories must be copied from the Host PC to the Target PC, maintaining the relative path hierarchy. On the Target PC, a directory should be created for these directories. For example create this directory on the Target PC:

C:\my_target_port\MATLAB_files

assuming MATLAB is installed on the Host PC here:

C:\Program Files\MATLAB71

Then the directories listed in the makefile should be copied:

Host PC: C:\Program Files\MATLAB71\rtw\c\ert

Target PC: C:\my_target_port\MATLAB_files\rtw\c\ert

Host PC: C:\Program Files\MATLAB71\extern\include

Target PC: C:\my_target_port\MATLAB_files\extern\include

Host PC: C:\Program Files\MATLAB71\simulink\include

Target PC: C:\my_target_port\MATLAB_files\simulink\include

...

5) Step 4 must be repeated for build rules that contain $(MATLAB_ROOT) in them. For example, if this rule appears (this is from an MSVC build):

{$(MATLAB_ROOT)\rtw\c\ert}.c.obj

Then the source files in that directory should be copied

6) Copy vctools.mk from the Host PC to the Target PC:

Host PC: C:\Program Files\MATLAB71\rtw\c\tools\vctools.mk

Target PC: C:\my_target_port\MATLAB_files\rtw\c\tools\vctools.mk

7) In the makefile (.mk file) on the Target PC, change the definition of MATLAB_ROOT and ALT_MATLAB_ROOT MATLAB_BIN and ALT_MATLABBIN to the location on the Target PC:

Host PC:

MATLAB_ROOT = C:\Program Files\MATLAB71

ALT_MATLAB_ROOT = C:\PROGRA~1\MATLAB71

MATLAB_BIN = C:\Program Files\MATLAB71\bin\win32

ALT_MATLAB_BIN = C:\PROGRA~1\MATLAB71\bin\win32

Target PC:

MATLAB_ROOT = C:\my_target_port\MATLAB_files

ALT_MATLAB_ROOT = C:\my_target_port\MATLAB_files

MATLAB_BIN = C:\my_target_port\MATLAB_files\bin\win32

ALT_MATLAB_BIN = C:\my_target_port\MATLAB_files\bin\win32

8) In the additional includes area of the makefile, the start dir and build dir should be updated to the location on the Target PC (example with rtwdemo_counter model shown here):

Host PC:

MATLAB_INCLUDES = $(MATLAB_INCLUDES);c:\myproject

MATLAB_INCLUDES =

$(MATLAB_INCLUDES);c:\myproject\rtwdemo_counter_ert_rtw

Target PC:

MATLAB_INCLUDES = $(MATLAB_INCLUDES);c:\my_target_port\

MATLAB_INCLUDES =

$(MATLAB_INCLUDES);c:my_target_port\rtwdemo_counter_ert_rtw

9) On the Target PC the environment must be set up for MSVC. TMSVC ususally

installs a batch file called vcvars32.bat (or similar). run this on the Target PC.

10) In the generated BAT file(the model .bat file), copy the line that starts with

'nmake -f...' into a DOS cmd shell that is in the Target PC build directory

(c:\my_target_port).

%%%METHOD 2: Copying the sources to the Target PC

Note: in this method all files can be coipied to the same directory

1) Generate code for the model on the Host PC

2) Copy the entire build dir (usually called model_ert_rtw) to the Target PC For example (rtwdemo_counter is the model):

Host PC: C:\myproject\rtwdemo_counter_ert_rtw

Target PC: C:\my_target_port\

3) Copy the entire slprj dir to the Target PC:

Host PC: C:\myproject\slprj\...

Target PC: C:\my_target_port\

Steps 4 and 5 are the same as for Method 1, except all files can go into the

same target dir.

4) In the generated makefile (the model .mak file) the defines must be extracted:

First look for the definition of CPP_REQ_DEFINEs. It should look similar to this:

CPP_REQ_DEFINES = -DMODEL=$(MODEL) -DNUMST=$(NUMST) -DNCSTATES=$(NCSTATES) \

-DMAT_FILE=$(MAT_FILE) -DINTEGER_CODE=$(INTEGER_CODE) \

-DONESTEPFCN=$(ONESTEPFCN) -DTERMFCN=$(TERMFCN) \

-DHAVESTDIO -DMULTI_INSTANCE_CODE=$(MULTI_INSTANCE_CODE) \

-DADD_MDL_NAME_TO_GLOBALS=$(ADD_MDL_NAME_TO_GLOBALS)

For each make var that looks similar to "$(...)" the value most be searched for in the makefile. Most, if not all of them will be near the beginning of the makefile and look similar to this:

...

NUMST = 1

NCSTATES = 0

BUILDARGS = GENERATE_REPORT=1

MULTITASKING = 0

INTEGER_CODE = 1

MAT_FILE = 0

ONESTEPFCN = 1

TERMFCN = 0

...

These must be expanded and put into a temporary text buffer. So the final defines will look similar to this:

/DMODEL=rtwdemo_counter /DNUMST=1 /DNCSTATES=0 /DMAT_FILE=0 /DINTEGER_CODE=1

/DONESTEPFCN=1 /DTERMFCN=0 /DHAVESTDIO /DMULTI_INSTANCE_CODE=0

/DADD_MDL_NAME_TO_GLOBALS=0

Additionally, if External mode is used, then the "-D" definitions in the

external mode section of the makefile must be copied as well.

5) The defines obtained in step 4 must either be put on the compile line (if a custom makefile is being created), or they must be imported into the IDE.

MATLAB: Does Accelerator Mode not include file(s) provided in the custom code configurations

We have identified two ways of having your required files linked while running in accelerator mode. I have listed these below:

1. Manually edit the makeInfo.includePath and makeInfo.sources section of the file "libs\timesn\rtwmakecfg.m" to reflect the following:

makeInfo.includePath = {pwd};
makeInfo.sources = {'filename1', 'filename2'};

Note: if you have a custom S-function created without the S-function builder, you may need to create the rtwmakecfg.m manually and put it in the same directory as the S-function itself. To have an additional include directory, the function would look like:

function makeInfo = rtwmakecfg()
makeInfo.Name        = 'MyCustomConfig';
makeInfo.includePath = {'YOUR_PATH_NAME'};
end

2. Build the S-Function using S-Function builder block and under the libraries pane, include the following:

...\filename1
...\filename2

Note: include the full path to the source files

Note: define the input and output data types under the data properties pane

Best Answer

Related Solutions

MATLAB: How to know which source files, compiler options, and link options are needed to build the code generated from Real-Time Workshop on a PC that does not have MATLAB

MATLAB: Does Accelerator Mode not include file(s) provided in the custom code configurations

Related Question