Difference between revisions of "Kazoo Templates Documentation"
Line 11: | Line 11: | ||
|- | |- | ||
|Language | |Language | ||
− | | | + | |↳ and corresponding implementation language |
|- | |- | ||
|Is_Type | |Is_Type | ||
− | | | + | |↳ and flag if it is a function type |
|- | |- | ||
|Has_Context_Param | |Has_Context_Param | ||
− | | | + | |↳ and flag to indicate if function has context parameters |
|- | |- | ||
|CP_Files | |CP_Files | ||
Line 95: | Line 95: | ||
|- | |- | ||
|Module_Set | |Module_Set | ||
− | | | + | |↳ corresponding module (needed for ASN.1 "IMPORTS") |
|- | |- | ||
|CP_Name | |CP_Name | ||
Line 101: | Line 101: | ||
|- | |- | ||
|CP_Sort | |CP_Sort | ||
− | | | + | |↳ corresponding ASN.1 type |
|- | |- | ||
|CP_ASN1_Module | |CP_ASN1_Module | ||
− | | | + | |↳ in ASN.1 module |
|- | |- | ||
|CP_Value | |CP_Value | ||
− | | | + | |↳ with default value |
|- | |- | ||
|Is_Type | |Is_Type | ||
Line 173: | Line 173: | ||
|- | |- | ||
|Property_Values | |Property_Values | ||
− | | | + | | ↳ corresponding AADL property value |
|- | |- | ||
|Skeletons | |Skeletons | ||
Line 327: | Line 327: | ||
|- | |- | ||
|CP_Types | |CP_Types | ||
− | | | + | | ↳ corresponding ASN.1 type |
|- | |- | ||
|CP_Values | |CP_Values | ||
− | | | + | | ↳ corresponding value |
|- | |- | ||
|CP_Asn1Modules | |CP_Asn1Modules | ||
− | | | + | | ↳ corresponding ASN.1 module containing the type |
|- | |- | ||
|CP_Asn1Filenames | |CP_Asn1Filenames | ||
− | | | + | | ↳ corresponding ASN.1 filename |
|- | |- | ||
|Property_Names | |Property_Names | ||
Line 342: | Line 342: | ||
|- | |- | ||
|Property_Values | |Property_Values | ||
− | | | + | | ↳ corresponding value |
|- | |- | ||
|List_Of_ASync_PIs | |List_Of_ASync_PIs | ||
Line 348: | Line 348: | ||
|- | |- | ||
|ASync_PI_Param_Name | |ASync_PI_Param_Name | ||
− | | | + | | ↳ name of the parameter |
|- | |- | ||
|ASync_PI_Param_Type | |ASync_PI_Param_Type | ||
− | | | + | | ↳ ASN.1 typename of the parameter |
|- | |- | ||
|Async_RIs_Parent | |Async_RIs_Parent | ||
− | | | + | | ↳ and corresponding parent function name |
|- | |- | ||
|Timers | |Timers | ||
Line 366: | Line 366: | ||
|- | |- | ||
|Sync_RIs_Parent | |Sync_RIs_Parent | ||
− | | | + | | ↳ and corresponding parent function name |
|- | |- | ||
|ASN1_Modules | |ASN1_Modules | ||
Line 378: | Line 378: | ||
|- | |- | ||
|ASync_RI_Param_Name | |ASync_RI_Param_Name | ||
− | | | + | | ↳ parameter name of the required interface |
|- | |- | ||
|ASync_RI_Param_Type | |ASync_RI_Param_Type | ||
− | | | + | | ↳ ASN1 typename of the parameter |
|} | |} | ||
=== templates/skeletons/sub/interface.tmplt === | === templates/skeletons/sub/interface.tmplt === | ||
Line 408: | Line 408: | ||
|- | |- | ||
|Property_Values | |Property_Values | ||
− | | | + | |↳ and corresponding values |
|- | |- | ||
|Param_Names | |Param_Names | ||
Line 414: | Line 414: | ||
|- | |- | ||
|Param_Types | |Param_Types | ||
− | | | + | | ↳ Corresponding parameter types |
|- | |- | ||
|Param_Directions | |Param_Directions | ||
− | | | + | | ↳ Corresponding direction |
|- | |- | ||
|Param_Encodings | |Param_Encodings | ||
− | | | + | | ↳ Corresponding ASN.1 encoding |
|- | |- | ||
|Is_Timer | |Is_Timer | ||
Line 598: | Line 598: | ||
|- | |- | ||
|Remote_PIs | |Remote_PIs | ||
− | | | + | | ↳ Associated PI Name |
|- | |- | ||
|Remote_PI_Sorts | |Remote_PI_Sorts | ||
− | | | + | | ↳ Optional param type of the remote thread |
|- | |- | ||
|Remote_PI_Modules | |Remote_PI_Modules | ||
− | | | + | | ↳ Asn1 module of the optional param type |
|- | |- | ||
|Name | |Name | ||
Line 743: | Line 743: | ||
|- | |- | ||
|Param_Types | |Param_Types | ||
− | | | + | | ↳ Corresponding parameter types |
|- | |- | ||
|Param_Directions | |Param_Directions | ||
− | | | + | | ↳ Corresponding direction |
|- | |- | ||
|Is_Timer | |Is_Timer | ||
Line 900: | Line 900: | ||
|- | |- | ||
|ASync_RI_Param_Name | |ASync_RI_Param_Name | ||
− | | | + | | ↳ corresponding parameter Name |
|- | |- | ||
|ASync_RI_Param_Type | |ASync_RI_Param_Type | ||
− | | | + | | ↳ corresponding parameter ASN.1 type |
|- | |- | ||
|RIs_Have_Params | |RIs_Have_Params | ||
Line 915: | Line 915: | ||
|- | |- | ||
|ASync_PI_Param_Name | |ASync_PI_Param_Name | ||
− | | | + | | ↳ corresponding parameter Name |
|- | |- | ||
|ASync_PI_Param_Type | |ASync_PI_Param_Type | ||
− | | | + | | ↳ corresponding parameter ASN.1 type |
|- | |- | ||
|Timer_Resolution | |Timer_Resolution | ||
Line 927: | Line 927: | ||
|- | |- | ||
|Property_Values | |Property_Values | ||
− | | | + | | ↳ corresponding AADL property value |
|- | |- | ||
|Skeletons | |Skeletons | ||
Line 942: | Line 942: | ||
|- | |- | ||
|CP_Values | |CP_Values | ||
− | | | + | | ↳ value |
|- | |- | ||
|CP_Asn1Modules | |CP_Asn1Modules | ||
− | | | + | | ↳ ASN.1 module |
|- | |- | ||
|CP_Asn1Filenames | |CP_Asn1Filenames | ||
− | | | + | | ↳ ASN.1 file name |
|- | |- | ||
|CP_Types | |CP_Types | ||
− | | | + | | ↳ Context parameter ASN.1 type |
|- | |- | ||
|Deployment_View | |Deployment_View | ||
Line 1,107: | Line 1,107: | ||
|- | |- | ||
|In_Port_Thread_Name | |In_Port_Thread_Name | ||
− | | | + | | ↳ corresponding thread inside the partition |
|- | |- | ||
|In_Port_Type_Name | |In_Port_Type_Name | ||
− | | | + | | ↳ corresponding parameter type name (optional) |
|- | |- | ||
|Out_Port_Names | |Out_Port_Names | ||
Line 1,116: | Line 1,116: | ||
|- | |- | ||
|Out_Port_Type_Name | |Out_Port_Type_Name | ||
− | | | + | | ↳ corresponding parameter type name (optional) |
|- | |- | ||
|Part_Out_Port_Name | |Part_Out_Port_Name | ||
Line 1,122: | Line 1,122: | ||
|- | |- | ||
|Connected_Threads | |Connected_Threads | ||
− | | | + | | ↳ Corresponding thread connected to it |
|- | |- | ||
|Block_Instance_Of | |Block_Instance_Of | ||
Line 1,227: | Line 1,227: | ||
|- | |- | ||
|VP_Package_Names | |VP_Package_Names | ||
− | | | + | | ↳ Corresponding package name |
|- | |- | ||
|VP_Platforms | |VP_Platforms | ||
− | | | + | | ↳ Corresponding platform name |
|- | |- | ||
|VP_Classifiers | |VP_Classifiers | ||
− | | | + | | ↳ Corresponding aadl classifier |
|- | |- | ||
|Package_Name | |Package_Name | ||
Line 1,309: | Line 1,309: | ||
|- | |- | ||
|Node_CPU_Classifier | |Node_CPU_Classifier | ||
− | | | + | | ↳ Corresponding CPU Classifier (ocarina...::x86_linux) |
|- | |- | ||
|Node_Major_Frame | |Node_Major_Frame | ||
− | | | + | | ↳ Corresponding Time in milliseconds allocated to the CPU (TSP only) |
|- | |- | ||
|Partition_Names | |Partition_Names | ||
Line 1,318: | Line 1,318: | ||
|- | |- | ||
|Partition_Node | |Partition_Node | ||
− | | | + | | ↳ Corresponding node name |
|- | |- | ||
|Partition_CPU | |Partition_CPU | ||
− | | | + | | ↳ Corresponding CPU name |
|- | |- | ||
|Partition_Duration | |Partition_Duration | ||
− | | | + | | ↳ Corresponding time allocation (TSP only) |
|- | |- | ||
|Partition_VP | |Partition_VP | ||
− | | | + | | ↳ Corresponding Virtual processor binding (TSP only) |
|- | |- | ||
|Threads | |Threads | ||
Line 1,342: | Line 1,342: | ||
|- | |- | ||
|Part_Source_Port | |Part_Source_Port | ||
− | | | + | | ↳ Corresponding port name |
|- | |- | ||
|Part_Dest_Name | |Part_Dest_Name | ||
− | | | + | | ↳ Corresponding name of the remote partition |
|- | |- | ||
|Part_Dest_Port | |Part_Dest_Port | ||
− | | | + | | ↳ Corresponding name of the port on the remote partition |
|- | |- | ||
|Bus_Names | |Bus_Names | ||
Line 1,354: | Line 1,354: | ||
|- | |- | ||
|Bus_AADL_Package | |Bus_AADL_Package | ||
− | | | + | | ↳ Corresponding AADL Package |
|- | |- | ||
|Bus_Classifier | |Bus_Classifier | ||
− | | | + | | ↳ Corresponding AADL classifier |
|- | |- | ||
|Device_Node_Name | |Device_Node_Name | ||
Line 1,395: | Line 1,395: | ||
|- | |- | ||
|Unique_Dev_ASN1_Mod | |Unique_Dev_ASN1_Mod | ||
− | | | + | | ↳ corresponding asn1 module |
|- | |- | ||
|Unique_Dev_ASN1_Sorts | |Unique_Dev_ASN1_Sorts | ||
− | | | + | | ↳ type name |
|- | |- | ||
|Connect_From_Part | |Connect_From_Part | ||
Line 1,404: | Line 1,404: | ||
|- | |- | ||
|Connect_Via_Bus | |Connect_Via_Bus | ||
− | | | + | | ↳ bus name |
|- | |- | ||
|Connect_Port_Name | |Connect_Port_Name | ||
− | | | + | | ↳ port name |
|- | |- | ||
|Debug_Flag | |Debug_Flag |
Revision as of 06:39, 20 August 2020
Contents
- 1 Templates
- 1.1 templates/skeletons/makefile.tmplt
- 1.2 templates/skeletons/context-parameters.tmplt
- 1.3 templates/skeletons/sub/trigger.tmplt
- 1.4 templates/skeletons/sub/makefile-filename.tmplt
- 1.5 templates/skeletons/sub/function-filename.tmplt
- 1.6 templates/skeletons/sub/function.tmplt
- 1.7 templates/skeletons/sub/interface.tmplt
- 1.8 templates/skeletons/sub/makefile.tmplt
- 1.9 templates/concurrency_view/sub/trigger.tmplt
- 1.10 templates/concurrency_view/sub/thread.tmplt
- 1.11 templates/concurrency_view/sub/pi.tmplt
- 1.12 templates/concurrency_view/sub/ri.tmplt
- 1.13 templates/concurrency_view/sub/block.tmplt
- 1.14 templates/concurrency_view/sub/partition.tmplt
- 1.15 templates/concurrency_view/sub/node.tmplt
- 1.16 templates/concurrency_view/sub/system.tmplt
Templates
templates/skeletons/makefile.tmplt
This template is evaluated only once. The output is saved to the Makefile within output directory.
Parameter name | Description |
---|---|
Function_Names | Combined table: list of fuction names... |
Language | ↳ and corresponding implementation language |
Is_Type | ↳ and flag if it is a function type |
Has_Context_Param | ↳ and flag to indicate if function has context parameters |
CP_Files | List of all context parameters ASN.1 files |
Unique_Languages | List of all languages used in the system |
ASN1_Files | List of all ASN.1 files |
ACN_Files | List of all ACN files |
ASN1_Modules | List of all ASN.1 modules |
Skeletons | DOCUMENTATION MISSING |
Timer_Resolution | DOCUMENTATION MISSING |
Other_Files | DOCUMENTATION MISSING |
Target | DOCUMENTATION MISSING |
Output_Dir | DOCUMENTATION MISSING |
Shared_Types | List of available component types |
Check_Data_View | DOCUMENTATION MISSING |
No_Stdlib_Flag | DOCUMENTATION MISSING |
Shared_Lib_Dir | Folder hosting the shared component types |
Binary_Path | DOCUMENTATION MISSING |
Data_View | DOCUMENTATION MISSING |
Deployment_View | DOCUMENTATION MISSING |
Debug_Flag | DOCUMENTATION MISSING |
Interface_View | DOCUMENTATION MISSING |
Use_POHIC | DOCUMENTATION MISSING |
Glue | DOCUMENTATION MISSING |
templates/skeletons/context-parameters.tmplt
This template is evaluated for every function which has context parameters. The output is saved to the file Context-<function name>.asn
Parameter name | Description |
---|---|
Name | Function name |
Sort_Set | Set of types used for this Context Parameter file |
Module_Set | ↳ corresponding module (needed for ASN.1 "IMPORTS") |
CP_Name | Table of context parameter names |
CP_Sort | ↳ corresponding ASN.1 type |
CP_ASN1_Module | ↳ in ASN.1 module |
CP_Value | ↳ with default value |
Is_Type | DOCUMENTATION MISSING |
Instance_Of | DOCUMENTATION MISSING |
templates/skeletons/sub/trigger.tmplt
This template is evaluated to trigger processing of other files from given directory. If the result of evaluation is equal to "TRUE", then other files will be processed. This template is identical for Skeleton and Glue subfolders.
Parameter name | Description |
---|---|
Name | The name of the function |
Is_Type | True if function type |
Instance_Of | Name of instance or empty string |
Language | Implementation language for the function |
Filename_Is_Present | True if target function output already exists |
Makefile_Is_Present | True if target build script already exists |
Zip_File | Optional path to zip file |
Use_POHIC | Value of command line flag --polyorb-hi-c (or -p) |
List_Of_PIs | DOCUMENTATION MISSING |
ASync_RI_Param_Type | DOCUMENTATION MISSING |
RIs_Have_Params | DOCUMENTATION MISSING |
List_Of_Sync_RIs | DOCUMENTATION MISSING |
Debug_Flag | DOCUMENTATION MISSING |
ASync_PI_Param_Name | DOCUMENTATION MISSING |
Timer_Resolution | DOCUMENTATION MISSING |
Property_Names | Vector tag: AADL Property name |
Property_Values | ↳ corresponding AADL property value |
Skeletons | DOCUMENTATION MISSING |
Interface_View | Interface view filename |
ASync_PI_Param_Type | DOCUMENTATION MISSING |
ASync_RI_Param_Name | DOCUMENTATION MISSING |
CP_Asn1Modules | DOCUMENTATION MISSING |
Binary_Path | DOCUMENTATION MISSING |
CP_Values | DOCUMENTATION MISSING |
Deployment_View | DOCUMENTATION MISSING |
No_Stdlib_Flag | DOCUMENTATION MISSING |
List_Of_ASync_PIs | DOCUMENTATION MISSING |
Glue | DOCUMENTATION MISSING |
Async_RIs_Parent | DOCUMENTATION MISSING |
CP_Names | DOCUMENTATION MISSING |
List_Of_Sync_PIs | DOCUMENTATION MISSING |
List_Of_ASync_RIs | DOCUMENTATION MISSING |
Has_Context | DOCUMENTATION MISSING |
Output_Dir | DOCUMENTATION MISSING |
PIs_Have_Params | DOCUMENTATION MISSING |
CP_Asn1Filenames | DOCUMENTATION MISSING |
Timers | DOCUMENTATION MISSING |
Check_Data_View | Value of command line flag --check-dataview |
CP_Types | DOCUMENTATION MISSING |
Other_Files | List of AADL files passed to the command line |
Sync_RIs_Parent | DOCUMENTATION MISSING |
List_Of_RIs | DOCUMENTATION MISSING |
Data_View | Data view filename |
Target | Value of command line flag --target=Target |
Shared_Types | List of available component types |
Shared_Lib_Dir | Folder hosting the shared component types |
templates/skeletons/sub/makefile-filename.tmplt
This file is optional, if exists the result of parsing of this file is a name of output file for makefile.tmplt, otherwise this template will not be processed.
Parameter name | Description |
---|---|
Name | The name of the function |
templates/skeletons/sub/function-filename.tmplt
This file is optional, if exists the result of parsing of this file is a name of output file for function.tmplt, otherwise this template will not be processed.
Parameter name | Description |
---|---|
Name | The name of the function |
templates/skeletons/sub/function.tmplt
Template for a function in the skeleton or glue folder
Parameter name | Description | |
---|---|---|
Name | The name of the function | |
Language | Implementation language | |
List_Of_PIs | List of all provided interfaces (names only) | |
List_Of_RIs | List of all required interfaces (names only) | |
Provided_Interfaces | Generated from interfaces.tmplt | |
Required_Interfaces | Generated from interfaces.tmplt | |
RIs_Have_Params | True if at least one RI has an ASN.1 parameter | |
PIs_Have_Params | True if at least one PI has an ASN.1 parameter | |
Zip_File | Path to optional zip file containing the code of the function | (deprecated functionality) |
Is_Type | True if it is a function type | |
Instance_Of | Name of the function type if it is an instance | |
Has_Context | True if function has context parameters | |
CP_Names | Vector tag: context parameters (names) | |
CP_Types | ↳ corresponding ASN.1 type | |
CP_Values | ↳ corresponding value | |
CP_Asn1Modules | ↳ corresponding ASN.1 module containing the type | |
CP_Asn1Filenames | ↳ corresponding ASN.1 filename | |
Property_Names | Vector tag: user defined AADL property names | |
Property_Values | ↳ corresponding value | |
List_Of_ASync_PIs | List of asynchronous provided interfaces | |
ASync_PI_Param_Name | ↳ name of the parameter | |
ASync_PI_Param_Type | ↳ ASN.1 typename of the parameter | |
Async_RIs_Parent | ↳ and corresponding parent function name | |
Timers | List of timers (names) | |
List_Of_Sync_RIs | List of synchronous required interfaces | |
List_Of_Sync_PIs | List of synchronous provided interfaces | |
Sync_RIs_Parent | ↳ and corresponding parent function name | |
ASN1_Modules | List of ASN.1 modules containing types used in this function | |
ASN1_Files | List of ASN.1 files containing types used in this function | |
List_Of_ASync_RIs | vector tag: list of asynchronous required interfaces | |
ASync_RI_Param_Name | ↳ parameter name of the required interface | |
ASync_RI_Param_Type | ↳ ASN1 typename of the parameter |
templates/skeletons/sub/interface.tmplt
This file is processed twice, first time for required interfaces of the function from Interface View, second time for the provided interfaces. The results are parameters for processing function.tmplt
Parameter name | Description |
---|---|
Name | The name of the interface |
Direction | "PI" or "RI" |
Kind | The RCM Kind |
Parent_Function | The name of the function |
Language | The implementation language of the function |
Property_Names | All AADL properties (names) associated to the function |
Property_Values | ↳ and corresponding values |
Param_Names | List of parameter names |
Param_Types | ↳ Corresponding parameter types |
Param_Directions | ↳ Corresponding direction |
Param_Encodings | ↳ Corresponding ASN.1 encoding |
Is_Timer | Flag set to true if this is a timer interface |
Period | Property of the interface |
WCET | Property of the interface |
Queue_Size | Property of the interface |
IF_Property_Names | and Values User-defined properties (vector tag) |
IF_Property_Values | DOCUMENTATION MISSING |
Remote_Languages | DOCUMENTATION MISSING |
Param_ASN1_Modules | DOCUMENTATION MISSING |
Remote_Interface_Names | DOCUMENTATION MISSING |
Remote_Function_Names | DOCUMENTATION MISSING |
Param_Basic_Types | DOCUMENTATION MISSING |
templates/skeletons/sub/makefile.tmplt
This template is processed when makefile-filename.tmplt exists. The output of this template is saved to the file with name returned by processing makefile-filename.tmplt In directory [functionname]/[ languagename]
Parameter name | Description |
---|---|
Name | The function name |
ASN1_Files | List of all ASN.1 files |
ASN1_Modules | List of all ASN.1 modules |
Is_Type | Flag set to True for function type |
Instance_Of | Name of function type if instance |
Has_CP | True if context parameters are defined for this function |
Property_Names | Function user-defined property names (goes in pair with Property_Values) |
Property_Values | Function user-defined property values (goes in pair with Property_Names) |
Is_Shared_Type | True if component is an instance of a function in the shared types folder |
Language | Implementation language of the function |
Shared_Lib_Dir | Path to the shared component type folder |
templates/concurrency_view/sub/trigger.tmplt
This file is processed for every node. The result of this file indicates if the rest of templates for given node will be processed.
Parameter name | Description |
---|---|
Filename_Is_Present | true if file with name returned by filenode.tmplt exists |
Skeletons | from kazoo configuration |
Glue | from kazoo configuration |
No_Stdlib_Flag | Command line-flag --no-stdlib to avoid loading ocarina_components.aadl |
Timer_Resolution | Value of command line --timer |
Output_Dir | Value or command line -o to set the output folder |
Interface_View | Interface view filename |
Binary_Path | DOCUMENTATION MISSING |
Check_Data_View | Value of command line flag --check-dataview |
Debug_Flag | Value of command line flag --debug (or -g) |
Use_POHIC | Value of command line flag --polyorb-hi-c (or -p) |
Other_Files | List of AADL files passed to the command line |
Deployment_View | Deployment view filename |
Data_View | Data view filename |
CPU_Family | CPU Kind (e.g. leon3) |
CPU_Platform | AADL CPU_Platform (e.g. PLATFORM_NATIVE) |
CPU_Name | CPU AADL Identifier (e.g. x86_inst) |
Target | Value of command line flag --target=Target |
CPU_Classifier | AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux) |
Shared_Types | List of available component types |
Shared_Lib_Dir | Folder hosting the shared component types |
Is_Distributed | True if the system contains at least one bus |
templates/concurrency_view/sub/thread.tmplt
This file is processed for every thread in every partition in every node.
Parameter name | Description |
---|---|
Thread_Name | Thread name |
Partition_Name | Partition containing this thread |
Entry_Port_Name | Name of the PI |
RCM | One of "CYCLIC_OPERATION", "SPORADIC_OPERATION" |
Need_Mutex | True if the PI is shared with others in the protected block |
Pro_Block_Name | Name of the protected function |
Node_Name | Name of the deployment node |
Remote_Threads | Vector tag: output remote thread list |
Remote_PIs | ↳ Associated PI Name |
Remote_PI_Sorts | ↳ Optional param type of the remote thread |
Remote_PI_Modules | ↳ Asn1 module of the optional param type |
Name | |
Kind | |
Parent_Function | Tags related to the PI that is at the origin of the thread creation: shoud be useless here |
Param_Names | |
Period | |
WCET | |
Queue_Size | relevant here |
IF_Property_Names | |
Skeletons | from kazoo configuration |
Glue | from kazoo configuration |
Param_Directions | DOCUMENTATION MISSING |
Is_Timer | DOCUMENTATION MISSING |
Debug_Flag | DOCUMENTATION MISSING |
Timer_Resolution | DOCUMENTATION MISSING |
Param_Encodings | DOCUMENTATION MISSING |
Interface_View | Interface view filename |
IF_Property_Values | DOCUMENTATION MISSING |
Language | Implementation language of the function |
Binary_Path | DOCUMENTATION MISSING |
Remote_Function_Names | DOCUMENTATION MISSING |
Deployment_View | DOCUMENTATION MISSING |
No_Stdlib_Flag | DOCUMENTATION MISSING |
Remote_Languages | DOCUMENTATION MISSING |
Param_ASN1_Modules | DOCUMENTATION MISSING |
Output_Dir | DOCUMENTATION MISSING |
RI_Port_Names | DOCUMENTATION MISSING |
Param_Types | DOCUMENTATION MISSING |
Remote_Interface_Names | DOCUMENTATION MISSING |
Check_Data_View | Value of command line flag --check-dataview |
Use_POHIC | Value of command line flag --polyorb-hi-c (or -p) |
Other_Files | List of AADL files passed to the command line |
Data_View | Data view filename |
Param_Basic_Types | DOCUMENTATION MISSING |
Target | Value of command line flag --target=Target |
Priority | DOCUMENTATION MISSING |
Dispatch_Offset_ms | DOCUMENTATION MISSING |
Stack_Size_In_Bytes | DOCUMENTATION MISSING |
Shared_Types | List of available component types |
Shared_Lib_Dir | Folder hosting the shared component types |
templates/concurrency_view/sub/pi.tmplt
The template pi.tmplt is evaluated many times for every protected and unprotected provided interface. The result of every evaluation is joined to one string and passed as a parameter to block.tmplt
Parameter name | Description |
---|---|
Name | The name of the interface |
Kind | The RCM Kind |
Parent_Function | The name of the function |
Param_Names | List of parameter names |
Param_Types | ↳ Corresponding parameter types |
Param_Directions | ↳ Corresponding direction |
Is_Timer | DOCUMENTATION MISSING |
Param_Encodings | DOCUMENTATION MISSING |
Caller_Is_Local | DOCUMENTATION MISSING |
IF_Property_Values | DOCUMENTATION MISSING |
Queue_Size | DOCUMENTATION MISSING |
Language | Implementation language of the function |
Protected_Block_Name | DOCUMENTATION MISSING |
Remote_Languages | DOCUMENTATION MISSING |
Param_ASN1_Modules | DOCUMENTATION MISSING |
Partition_Name | DOCUMENTATION MISSING |
Calling_Threads | DOCUMENTATION MISSING |
IF_Property_Names | DOCUMENTATION MISSING |
Period | DOCUMENTATION MISSING |
Remote_Interface_Names | DOCUMENTATION MISSING |
WCET | DOCUMENTATION MISSING |
Remote_Function_Names | DOCUMENTATION MISSING |
Param_Basic_Types | DOCUMENTATION MISSING |
templates/concurrency_view/sub/ri.tmplt
The template ri.tmplt is evaluated many times for every required interface. The result of every evaluation is koined to one string and passed as a parameter to block.tmplt
Parameter name | Description |
---|---|
Name | The name of the interface |
Kind | The RCM Kind |
Parent_Function | The name of the function |
Param_Names | List of parameter names |
Param_Types | Corresponding parameter types |
Param_Directions | Corresponding direction |
Is_Timer | DOCUMENTATION MISSING |
Param_Encodings | DOCUMENTATION MISSING |
IF_Property_Values | DOCUMENTATION MISSING |
Queue_Size | DOCUMENTATION MISSING |
Language | DOCUMENTATION MISSING |
Remote_Languages | DOCUMENTATION MISSING |
Param_ASN1_Modules | DOCUMENTATION MISSING |
Partition_Name | DOCUMENTATION MISSING |
Calling_Threads | DOCUMENTATION MISSING |
IF_Property_Names | DOCUMENTATION MISSING |
Period | DOCUMENTATION MISSING |
Remote_Interface_Names | DOCUMENTATION MISSING |
WCET | DOCUMENTATION MISSING |
Remote_Function_Names | DOCUMENTATION MISSING |
Param_Basic_Types | DOCUMENTATION MISSING |
templates/concurrency_view/sub/block.tmplt
This template is evaluated for every block.
Parameter name | Description |
---|---|
Name | Protected block name |
Language | Implementation language |
Calling_Threads | List of calling threads |
Protected_PIs | Protected Provided interfaces (from pi.tmplt) |
Unprotected_PIs | Unprotected Provided interfaces (from pi.tmplt) |
Required | Required interfaces (from ri.tmplt) |
List_Of_PIs | Complete list of provided interfaces |
List_Of_ASync_RIs | Vector tag: name of asynchronous RIs |
ASync_RI_Param_Name | ↳ corresponding parameter Name |
ASync_RI_Param_Type | ↳ corresponding parameter ASN.1 type |
RIs_Have_Params | DOCUMENTATION MISSING |
List_Of_Sync_RIs | List of synchronous RIs |
List_Of_ASync_PIs | Vector tag: name of asynchronous PIs |
ASync_PI_Param_Name | ↳ corresponding parameter Name |
ASync_PI_Param_Type | ↳ corresponding parameter ASN.1 type |
Timer_Resolution | DOCUMENTATION MISSING |
Property_Names | Vector tag: AADL Property name |
Property_Values | ↳ corresponding AADL property value |
Skeletons | Command line flag (--gw) |
Interface_View | Interface view filename |
Binary_Path | DOCUMENTATION MISSING |
CP_Names | Vector tag: context parameter names |
CP_Values | ↳ value |
CP_Asn1Modules | ↳ ASN.1 module |
CP_Asn1Filenames | ↳ ASN.1 file name |
CP_Types | ↳ Context parameter ASN.1 type |
Deployment_View | Path/name of Deployment view file |
No_Stdlib_Flag | command line flag --no-stdlib |
Glue | command line flag --glue |
Partition_Name | Name of the partition containing this function |
Async_RIs_Parent | DOCUMENTATION MISSING |
Zip_File | DOCUMENTATION MISSING |
Node_Name | DOCUMENTATION MISSING |
List_Of_Sync_PIs | DOCUMENTATION MISSING |
Has_Context | True if function has context parameters |
Output_Dir | Output folder (by default: work) |
PIs_Have_Params | DOCUMENTATION MISSING |
Timers | DOCUMENTATION MISSING |
Check_Data_View | Value of command line flag --check-dataview |
Use_POHIC | Value of command line flag --polyorb-hi-c (or -p) |
Other_Files | List of AADL files passed to the command line |
Sync_RIs_Parent | DOCUMENTATION MISSING |
List_Of_RIs | List of required interface |
Data_View | Data view filename |
Target | Value of command line flag --target=Target |
Shared_Types | List of available component types |
Shared_Lib_Dir | Folder hosting the shared component types |
Is_Type | True if function is a function type |
Instance_Of | DOCUMENTATION MISSING |
Debug_Flag | if -g is set in the command line |
Is_Shared_Type | True if component is an instance of a function in the shared types folder |
templates/concurrency_view/sub/partition.tmplt
This file is evaluated for every partition.
Parameter name | Description |
---|---|
Name | Partition name (usually the name of the binary) |
Threads | Code generated for the threads |
Thread_Names | Tag: list of thread names |
Node_Name | Name of the node containing this partition |
Blocks | Code generated for protected functions |
Block_Names | Tag: list of block (user functions) names |
Coverage | True if user requested code coverage enable |
Package_Name | AADL Package name for the target (e.g. ocarina_porocessors_x86) |
CPU_Name | CPU AADL Identifier (e.g. x86_inst) |
CPU_Family | CPU Kind (e.g. leon3) |
CPU_Instance | AADL component instance (e.g. rtems_posix) |
CPU_Platform | AADL CPU_Platform (e.g. PLATFORM_NATIVE) |
CPU_Classifier | AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux) |
VP_Name | Virtual processor name on which the partition is bounded |
VP_Platform | Virtual processor platform (e.g. PLATFORM_AIR) |
VP_Classifier | Virtual processor classifier |
Bound_Functions | List of user functions from Interface view |
Thread_Src_Name | Vector tag : connection thread name (source) |
Thread_Dst_Name | Vector tag : connection thread name (dest) |
Thread_Src_Port | Vector tag : connection port name (source) |
Thread_Dst_Port | Vector tag : connection port name (dest) |
In_Port_Names | Vector tag: input ports of the partition |
In_Port_Thread_Name | ↳ corresponding thread inside the partition |
In_Port_Type_Name | ↳ corresponding parameter type name (optional) |
Out_Port_Names | Vector tag: output ports of the partition |
Out_Port_Type_Name | ↳ corresponding parameter type name (optional) |
Part_Out_Port_Name | Vector tag: output ports of the partition (can be several times the same) |
Connected_Threads | ↳ Corresponding thread connected to it |
Block_Instance_Of | DOCUMENTATION MISSING |
Thread_Has_Param | DOCUMENTATION MISSING |
Memory_Region | DOCUMENTATION MISSING |
VP_Package_Name | DOCUMENTATION MISSING |
Ada_Runtime | DOCUMENTATION MISSING |
Block_Languages | For each block: implementation language |
VP_Duration | DOCUMENTATION MISSING |
Device_CPU | DOCUMENTATION MISSING |
Device_Bus_Name | DOCUMENTATION MISSING |
Device_Init | DOCUMENTATION MISSING |
Device_AADL_Pkg | DOCUMENTATION MISSING |
Device_ASN1_Module | DOCUMENTATION MISSING |
Device_Port_Name | DOCUMENTATION MISSING |
Device_Config | DOCUMENTATION MISSING |
Device_Names | DOCUMENTATION MISSING |
Device_ASN1_File | DOCUMENTATION MISSING |
Device_Classifier | DOCUMENTATION MISSING |
Device_Language | DOCUMENTATION MISSING |
Device_ASN1_Sort | DOCUMENTATION MISSING |
Out_Port_Remote_Function | DOCUMENTATION MISSING |
In_Port_Queue_Size | DOCUMENTATION MISSING |
Block_FPGAConf | DOCUMENTATION MISSING |
Out_Port_Remote_Port_Name | DOCUMENTATION MISSING |
Out_Port_Remote_Partition | DOCUMENTATION MISSING |
Out_Port_Queue_Size | DOCUMENTATION MISSING |
Block_Is_Shared_Type | True if parent of the instance is a shared component |
Shared_Lib_Dir | Folder hosting the shared component types |
templates/concurrency_view/sub/node.tmplt
This file is evaluated for every node. The result of this file is saved to the file with name returned by filenode.tmplt. The result is also used as a parameter for system.tmplt.
Parameter name | Description |
---|---|
Node_Name | Name of the node from deployment view |
Partition_Names | Tag listing the partitions in this node |
Has_Memory | Boolean flag indicating that a memory is defined for this node |
Partitions | List of rendered code for partitions |
VP_Names | Vector tag: list of virtual processors on this node |
VP_Package_Names | ↳ Corresponding package name |
VP_Platforms | ↳ Corresponding platform name |
VP_Classifiers | ↳ Corresponding aadl classifier |
Package_Name | DOCUMENTATION MISSING |
CPU_Family | DOCUMENTATION MISSING |
CPU_Classifier | AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux) |
CPU_Name | DOCUMENTATION MISSING |
CPU_Platform | DOCUMENTATION MISSING |
Ada_Runtime | DOCUMENTATION MISSING |
CPU_Instance | DOCUMENTATION MISSING |
Device_CPU | DOCUMENTATION MISSING |
Device_Bus_Name | DOCUMENTATION MISSING |
Device_AADL_Pkg | DOCUMENTATION MISSING |
Device_ASN1_Module | DOCUMENTATION MISSING |
Device_Port_Name | DOCUMENTATION MISSING |
Device_Config | DOCUMENTATION MISSING |
Device_Names | DOCUMENTATION MISSING |
Device_ASN1_File | DOCUMENTATION MISSING |
Device_Classifier | DOCUMENTATION MISSING |
Device_Language | DOCUMENTATION MISSING |
Device_ASN1_Sort | DOCUMENTATION MISSING |
Device_Init | DOCUMENTATION MISSING |
templates/concurrency_view/sub/system.tmplt
This file is evaluated for every node. The result of this file is save to the file with name returned by filesys.tmplt.
Parameter name | Description |
---|---|
Nodes | Code generated for the nodes |
Node_Names | Vector Tag of node names |
Node_CPU | -> Corresponding CPU name (eg x86_linux) |
Node_CPU_Classifier | ↳ Corresponding CPU Classifier (ocarina...::x86_linux) |
Node_Major_Frame | ↳ Corresponding Time in milliseconds allocated to the CPU (TSP only) |
Partition_Names | Vector Tag of partition names |
Partition_Node | ↳ Corresponding node name |
Partition_CPU | ↳ Corresponding CPU name |
Partition_Duration | ↳ Corresponding time allocation (TSP only) |
Partition_VP | ↳ Corresponding Virtual processor binding (TSP only) |
Threads | Code generated for the threads (from thread.tmplt) |
Thread_Names | List of all threads in the complete system |
Target_Packages | List of all target package names in the complete system |
Part_Source_Name | Inter-partition connections : partition source name (vector tag) |
Part_Source_Port | ↳ Corresponding port name |
Part_Dest_Name | ↳ Corresponding name of the remote partition |
Part_Dest_Port | ↳ Corresponding name of the port on the remote partition |
Bus_Names | Vector tag: busses present in the system |
Bus_AADL_Package | ↳ Corresponding AADL Package |
Bus_Classifier | ↳ Corresponding AADL classifier |
Device_Node_Name | |
Device_Partition | |
Device_AADL_Pkg | |
Device_Classifier | |
Device_CPU | |
Device_Config | |
Device_Bus_Name | |
Device_Port_Name | |
Device_ASN1_File | |
Device_ASN1_Sort | |
Device_ASN1_Module | Device drivers (vector tag) |
Unique_Dev_ASN1_Files | List of ASN.1 files/module/type for device configuration with no duplicates (vector tag) |
Unique_Dev_ASN1_Mod | ↳ corresponding asn1 module |
Unique_Dev_ASN1_Sorts | ↳ type name |
Connect_From_Part | Vector tag - bus connection: partition source |
Connect_Via_Bus | ↳ bus name |
Connect_Port_Name | ↳ port name |
Debug_Flag | DOCUMENTATION MISSING |
Timer_Resolution | DOCUMENTATION MISSING |
Skeletons | DOCUMENTATION MISSING |
Interface_View | Interface view filename |
Binary_Path | DOCUMENTATION MISSING |
Block_Names | DOCUMENTATION MISSING |
Deployment_View | DOCUMENTATION MISSING |
No_Stdlib_Flag | DOCUMENTATION MISSING |
Glue | DOCUMENTATION MISSING |
Device_Names | DOCUMENTATION MISSING |
Output_Dir | DOCUMENTATION MISSING |
Node_Has_Memory | DOCUMENTATION MISSING |
Check_Data_View | Value of command line flag --check-dataview |
Use_POHIC | Value of command line flag --polyorb-hi-c (or -p) |
Other_Files | List of AADL files passed to the command line |
Data_View | Data view filename |
Target | Value of command line flag --target=Target |
Device_Language | DOCUMENTATION MISSING |
Device_Init | DOCUMENTATION MISSING |
Shared_Types | Complete list of available component types |
Shared_Lib_Dir | Folder hosting the shared component types |
Used_Shared_Types | List of actually used shared component types |