Main Content

Simulink.ModelReference.protect

Obscure referenced model contents to hide intellectual property

Description

example

Simulink.ModelReference.protect(model) creates a protected model from the specified model. It places the protected model in the current working folder. The protected model has the same name as the source model. It has the extension .slxp.

example

Simulink.ModelReference.protect(model,Name,Value) uses additional options specified by one or more name-value pair arguments.

example

[harnessHandle] = Simulink.ModelReference.protect(model,'Harness',true) creates a harness model for the protected model. It returns the handle of the harnessed model in harnessHandle.

example

[~ ,neededVars] = Simulink.ModelReference.protect(model) returns a cell array that includes the names of base workspace variables used by the protected model.

Examples

collapse all

Protect a referenced model and place the protected model in the current working folder.

openExample('sldemo_mdlref_bus');
model= 'sldemo_mdlref_counter_bus'

Simulink.ModelReference.protect(model);

A protected model named sldemo_mdlref_counter_bus.slxp is created. The protected model file is placed in the current working folder.

Protect a referenced model and place the protected model in a specified folder.

openExample('sldemo_mdlref_bus');
model= 'sldemo_mdlref_counter_bus'

Simulink.ModelReference.protect(model,'Path','C:\Work');

A protected model named sldemo_mdlref_counter_bus.slxp is created. The protected model file is placed in C:\Work.

Protect a referenced model, generate code for it in normal mode, and obfuscate the code.

openExample('sldemo_mdlref_bus');
model= 'sldemo_mdlref_counter_bus'

Simulink.ModelReference.protect(model,'Path','C:\Work','Mode','CodeGeneration',...
'ObfuscateCode',true);

A protected model named sldemo_mdlref_counter_bus.slxp is created. The protected model file is placed in the C:\Work folder. The protected model runs as a child of the parent model. The code generated for the protected model is obfuscated by the software.

Protect a referenced model, and generate HDL code for it in normal mode.

parent_model= 'hdlcoder_protected_model_parent_harness';
reference_model_to_protect = 'hdlcoder_referenced_model_gain';

Simulink.ModelReference.protect(reference_model_to_protect, ...
                        'Mode','HDLCodeGeneration')

A protected model named hdlcoder_referenced_model_gain.slxp is created. The protected model file is placed in the same folder as the parent model and the referenced model. The protected model runs as a child of the parent model.

Set the hdl option to true with Mode set to CodeGeneration to enable both C code generation and HDL code generation support for a protected model that you create.

parent_model= 'hdlcoder_protected_model_parent_harness';
reference_model_to_protect = 'hdlcoder_referenced_model_gain';

Simulink.ModelReference.protect(reference_model_to_protect, ...
                        'Mode','CodeGeneration','hdl',true)

Control code visibility by allowing users to view only binary files and headers in the code generated for a protected model.

openExample('sldemo_mdlref_bus');
model= 'sldemo_mdlref_counter_bus'

Simulink.ModelReference.protect(model,'Mode','CodeGeneration','OutputFormat',...
'CompiledBinaries');

A protected model named sldemo_mdlref_counter_bus.slxp is created. The protected model file is placed in the current working folder. Users can view only binary files and headers in the code generated for the protected model.

Create a harness model for a protected model and generate an HTML report.

openExample('sldemo_mdlref_bus');
modelPath= 'sldemo_mdlref_bus/CounterA'

[harnessHandle] = Simulink.ModelReference.protect(modelPath,'Path','C:\Work',...
'Harness',true,'Report',true);

A protected model named sldemo_mdlref_counter_bus.slxp is created, along with an untitled harness model. The protected model file is placed in the C:\Work folder. The folder also contains an HTML report. The handle of the harness model is returned in harnessHandle.

To simulate a model that references a protected model, you might need to define variables in the base workspace or data dictionaries. For example, the sldemo_mdlref_counter_bus model needs the variables that specify the buses at the root input and output ports of the model. When you ship a protected model, you must include definitions of the required variables or the model is unusable.

Tip

To automatically package required variable definitions with the protected model in a project, set Project to true.

Generate the protected model and determine the required variables.

openExample('sldemo_mdlref_bus');
model= 'sldemo_mdlref_counter_bus'

[~, neededVars] = Simulink.ModelReference.protect(model)

The second output, neededVars, determines the variables you must send to the recipient. The value of neededVars is a cell array that contains the names of the variables required by the protected model. However, the cell array might also contain the names of variables that the model does not need.

Before you share the protected model, edit neededVars to delete the names of any variables that the model does not need. Save the required variables in a data dictionary.

Input Arguments

collapse all

Model name, specified as a character vector or string scalar. It contains the name of a model or the path name of a Model block that references the model to be protected.

Data Types: char | string

Name-Value Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Mode','CodeGeneration','OutputFormat','Binaries','ObfuscateCode',true specifies that obfuscated code be generated for the protected model. It also specifies that only binary files and headers in the generated code be visible to users of the protected model.

Option to collect dependencies in project, specified as the comma-separated pair consisting of 'Project' and true or false.

The protected model, its dependencies, and its harness model are saved in a project archive (.mlproj). The project archive provides a way to share a project in a single file. You must open the project archive to create the interactive project.

Note

Before sharing the project, check whether the project contains the necessary supporting files. If supporting files are missing, simulating or generating code for the related harness model can help identify them. Add the missing dependencies to the project and update the harness model as needed.

Example: 'Project',true

Data Types: logical

Custom project name, specified as the comma-separated pair consisting of 'ProjectName' and a character vector or string scalar.

If you do not specify a custom project name, the default name for the project is the protected model name followed by _protected.

Example: 'ProjectName','myname'

Dependencies

To enable ProjectName, set Project to true.

Data Types: char | string

Option to create harness model, specified as the comma-separated pair consisting of 'Harness' and a Boolean value.

When you create a harness model for a protected model that relies on base workspace definitions, Simulink® creates a MAT-file that contains the base workspace definitions.

The harness model must have access to supporting files, such as a MAT-file with base workspace definitions or a data dictionary.

Example: 'Harness',true

Data Types: logical

Model protection mode, specified as the comma-separated pair consisting of 'Mode' and one of the following values:

  • 'Normal': If the top model is running in 'Normal' mode, the protected model runs as a child of the top model.

  • 'Accelerator': The top model can run in 'Normal', 'Accelerator', or 'Rapid Accelerator' mode.

  • 'CodeGeneration': The top model can run in 'Normal', 'Accelerator', or 'Rapid Accelerator' mode and support code generation.

  • 'HDLCodeGeneration': The top model can run in 'Normal', 'Accelerator', or 'Rapid Accelerator' mode and support HDL code generation. Requires HDL Coder™ license.

  • 'ViewOnly': This value turns off Simulate and Generate code functionality modes and turns on the read-only view mode.

Example: 'Mode','Accelerator'

Interface through which generated code is accessed by a Model block, specified as the comma-separated pair consisting of 'CodeInterface' and one of the following values:

  • 'Model reference': Code access through the model reference code interface, which allows use of the protected model within a model reference hierarchy. Users of the protected model can generate code from a parent model that contains the protected model. In addition, users can run Model block SIL/PIL simulations with the protected model.

  • 'Top model': Code access through the standalone interface. Users of the protected model can run Model block SIL/PIL simulations with the protected model.

Example: 'CodeInterface','Top model'

Dependencies

The system target file (SystemTargetFile) must be set to an ERT-based system target file, for example, ert.tlc). Requires Embedded Coder® license.

Option to obfuscate generated code, specified as the comma-separated pair consisting of 'ObfuscateCode' and a Boolean value. Applicable only when code generation during protection is enabled. Obfuscation is not supported for HDL code generation.

Example: 'ObfuscateCode',true

Data Types: logical

Folder for protected model, specified as the comma-separated pair consisting of 'Path' and a character vector or string scalar.

Example: 'Path','C:\Work'

Data Types: char | string

Option to generate report, specified as the comma-separated pair consisting of 'Report' and a Boolean value.

To view the report, right-click the protected-model badge icon and select Display Report. Or, call the Simulink.ProtectedModel.open function with the report option.

The report is generated in HTML format. It includes information on the environment, functionality, and interface for the protected model.

Example: 'Report',true

Data Types: logical

Option to generate HDL code, specified as the comma-separated pair consisting of 'hdl' and a Boolean value.

This option requires an HDL Coder license. When you enable this option, make sure that you specify the Mode. You can set this option to true in conjunction with the Mode set to CodeGeneration to enable both C code and HDL code generation support for the protected model.

If you want to enable only simulation and HDL code generation support, but not C code generation, set Mode to HDLCodeGeneration. You do not have to set the hdl option to true.

Example: 'hdl',true

Data Types: logical

Protected code visibility, specified as the comma-separated pair consisting of 'OutputFormat' and one of the following values:

  • 'CompiledBinaries': Only binary files and headers are visible.

  • 'MinimalCode': Includes only the minimal header files required to build the code with the chosen build settings. All code in the build folder is visible. Users can inspect the code in the protected model report and recompile it for their purposes.

  • 'AllReferencedHeaders': Includes header files found on the include path. All code in the build folder is visible. All headers referenced by the code are also visible.

This argument determines what part of the code generated for a protected model is visible to users.

Example: 'OutputFormat','AllReferencedHeaders'

Dependencies

This argument affects the output only when you specify Mode as 'Accelerator' or 'CodeGeneration'. When you specify Mode as 'Normal', only a MEX-file is part of the output package.

Option to include read-only Web view of protected model, specified as the comma-separated pair consisting of 'Webview' and a Boolean value.

To open the Web view of a protected model, use one of the following methods:

  • Right-click the protected-model badge icon and select Show Web view.

  • Use the Simulink.ProtectedModel.open function. For example, to display the Web view for protected model sldemo_mdlref_counter, call:

    Simulink.ProtectedModel.open('sldemo_mdlref_counter', 'webview');

  • Double-click the .slxp protected model file in the Current Folder browser.

  • In the Block Parameter dialog box for the protected model, click Open Model.

Example: 'Webview',true

Data Types: logical

Option to encrypt protected model, specified as the comma-separated pair consisting of 'Encrypt' and a Boolean value. Applicable when you have specified a password during protection, or by using the following methods:

Example: 'Encrypt',true

Data Types: logical

Option to add a postprocessing function for protected model files, specified as the comma-separated pair consisting of 'CustomPostProcessingHook' and a function handle.

The function accepts a Simulink.ModelReference.ProtectedModel.HookInfo object as an input variable. This object provides information on the source code files and other files generated during protected model creation. It also provides information on exported symbols that you must not modify. Prior to packaging the protected model, the postprocessing function is called.

For a protected model with a top model interface, the Simulink.ModelReference.ProtectedModel.HookInfo object cannot provide information on exported symbols.

Example: 'CustomPostProcessingHook',@(protectedMdlInf)myHook(protectedMdlInf)

Option to create modifiable protected model, specified as the comma-separated pair consisting of 'Modifiable' and a Boolean value. To use this option:

Example: 'Modifiable',true

Data Types: logical

Option to specify callbacks for protected model, specified as the comma-separated pair consisting of 'Callbacks' and a cell array of Simulink.ProtectedModel.Callback objects.

Example: 'Callbacks',{pmcallback_sim, pmcallback_cg}

Data Types: cell

Option to sign protected model with digital certificate, specified as the comma-separated pair consisting of 'Sign' and a character vector or string scalar that specifies the digital certificate. If the certificate file is password-protected, use the Simulink.ModelReference.ProtectedModel.setPasswordForCertificate function to provide the password before you use the certificate.

Example: 'Sign','my_certificate.pfx'

Data Types: char | string

Output Arguments

collapse all

Handle of harness model, returned as a double or 0, depending on the value of Harness.

If Harness is true, the value is the handle of the harness model. Otherwise, the value is 0.

Names of base workspace variables that the protected model uses, returned as a cell array.

The cell array can also include variables that the protected model does not use.

Introduced in R2012b