Difference between revisions of "Kazoo Templates Documentation"

From TASTE
Jump to: navigation, search
Line 80: Line 80:
 
|-
 
|-
 
|Glue
 
|Glue
 +
|DOCUMENTATION MISSING
 +
|-
 +
|CPU_Platform
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Is_FPGA
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|}
 
|}
Line 149: Line 155:
 
|-
 
|-
 
|List_Of_PIs
 
|List_Of_PIs
|DOCUMENTATION MISSING
+
|List of all provided interfaces (names only)
 
|-
 
|-
 
|ASync_RI_Param_Type
 
|ASync_RI_Param_Type
Line 161: Line 167:
 
|-
 
|-
 
|Debug_Flag
 
|Debug_Flag
|DOCUMENTATION MISSING
 
|-
 
|ASync_PI_Param_Name
 
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
Line 180: Line 183:
 
|Interface_View
 
|Interface_View
 
|Interface view filename
 
|Interface view filename
|-
 
|ASync_PI_Param_Type
 
|DOCUMENTATION MISSING
 
 
|-
 
|-
 
|ASync_RI_Param_Name
 
|ASync_RI_Param_Name
Line 203: Line 203:
 
|-
 
|-
 
|List_Of_ASync_PIs
 
|List_Of_ASync_PIs
 +
|Vector tag: list of async Provided interfaces
 +
|-
 +
|ASync_PI_Kind
 +
|  ↳ CYCLIC_OPERATION or SPORADIC_OPERATION
 +
|-
 +
|ASync_PI_Is_Connected
 +
|  ↳ Flag set to true if PI is connected
 +
|-
 +
|ASync_PI_Param_Name
 +
|DOCUMENTATION MISSING
 +
|-
 +
|ASync_PI_Param_Type
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
Line 270: Line 282:
 
|Name
 
|Name
 
|The name of the function
 
|The name of the function
 +
|-
 +
|Language
 +
|DOCUMENTATION MISSING
 
|}
 
|}
 
=== templates/skeletons/sub/function-filename.tmplt ===
 
=== templates/skeletons/sub/function-filename.tmplt ===
Line 279: Line 294:
 
|Name
 
|Name
 
|The name of the function
 
|The name of the function
 +
|-
 +
|Language
 +
|DOCUMENTATION MISSING
 
|}
 
|}
 
=== templates/skeletons/sub/function.tmplt ===
 
=== templates/skeletons/sub/function.tmplt ===
Line 353: Line 371:
 
| ↳ ASN.1 typename of the parameter
 
| ↳ ASN.1 typename of the parameter
 
|-
 
|-
|Async_RIs_Parent
+
|ASync_PI_Kind
| ↳ and corresponding parent function name
+
| ↳ CYCLIC_OPERATION or SPORADIC_OPERATION
 +
|-
 +
|ASync_PI_Is_Connected
 +
|  ↳ Flag set to true if PI is connected
 
|-
 
|-
 
|Timers
 
|Timers
Line 376: Line 397:
 
|List_Of_ASync_RIs
 
|List_Of_ASync_RIs
 
|vector tag: list of asynchronous required interfaces
 
|vector tag: list of asynchronous required interfaces
 +
|-
 +
|Async_RIs_Parent
 +
| ↳ Corresponding parent function name
 
|-
 
|-
 
|ASync_RI_Param_Name
 
|ASync_RI_Param_Name
Line 382: Line 406:
 
|ASync_RI_Param_Type
 
|ASync_RI_Param_Type
 
| ↳ ASN1 typename of the parameter
 
| ↳ 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
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
|Name
+
|Data_View
|The name of the interface
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Direction
+
|Shared_Lib_Dir
|"PI" or "RI"
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Kind
+
|Binary_Path
|The RCM Kind
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Parent_Function
+
|Timer_Resolution
|The name of the function
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Language
+
|Skeletons
|The implementation language of the function
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Property_Names
+
|Other_Files
|All AADL properties (names) associated to the function
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Property_Values
+
|Check_Data_View
|↳ and corresponding values
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_Names
+
|Shared_Types
|List of parameter names
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_Types
+
|Output_Dir
| ↳ Corresponding parameter types
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_Directions
+
|Use_POHIC
| ↳ Corresponding direction
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_Encodings
+
|Debug_Flag
| ↳ Corresponding ASN.1 encoding
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Is_Timer
+
|Target
|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
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Remote_Languages
+
|Interface_View
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_ASN1_Modules
+
|Glue
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Remote_Interface_Names
+
|No_Stdlib_Flag
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Remote_Function_Names
+
|Deployment_View
|DOCUMENTATION MISSING
 
|-
 
|Param_Basic_Types
 
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|}
 
|}
=== templates/skeletons/sub/makefile.tmplt ===
+
=== templates/skeletons/sub/interface.tmplt ===
This template is processed when makefile-filename.tmplt exists.
+
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
The output of this template is saved to the file with name returned by processing makefile-filename.tmplt In directory [functionname]/[ languagename]
 
 
{| class="wikitable"
 
{| class="wikitable"
 
!Parameter name
 
!Parameter name
Line 463: Line 462:
 
|-
 
|-
 
|Name
 
|Name
|The function name
+
|The name of the interface
 
|-
 
|-
|ASN1_Files
+
|Direction
|List of all ASN.1 files
+
|"PI" or "RI"
 
|-
 
|-
|ASN1_Modules
+
|Kind
|List of all ASN.1 modules
+
|The RCM Kind (SPORADIC|CYCLIC|PROTECTED|UNPROTECTED_OPERATION)
 
|-
 
|-
|Is_Type
+
|Parent_Function
|Flag set to True for function type
+
|The name of the function
 
|-
 
|-
|Instance_Of
+
|Language
|Name of function type if instance
+
|The implementation language of the function
|-
 
|Has_CP
 
|True if context parameters are defined for this function
 
 
|-
 
|-
 
|Property_Names
 
|Property_Names
|Function user-defined property names (goes in pair with Property_Values)
+
|All AADL properties (names) associated to the function
 
|-
 
|-
 
|Property_Values
 
|Property_Values
|Function user-defined property values (goes in pair with Property_Names)
+
|↳ and corresponding values
 
|-
 
|-
|Is_Shared_Type
+
|Param_Names
|True if component is an instance of a function in the shared types folder
+
|List of parameter names
 
|-
 
|-
|Language
+
|Param_Types
|Implementation language of the function
+
| ↳ Corresponding parameter types
 
|-
 
|-
|Shared_Lib_Dir
+
|Param_Directions
|Path to the shared component type folder
+
| ↳ Corresponding direction
|}
 
=== 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.
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
|Filename_Is_Present
+
|Param_Encodings
|true if file with name returned by filenode.tmplt exists
+
| ↳ Corresponding ASN.1 encoding
 
|-
 
|-
|Skeletons
+
|Is_Timer
|from kazoo configuration
+
|Flag set to true if this is a timer interface
 
|-
 
|-
|Glue
+
|Period
|from kazoo configuration
+
|Property of the interface
 
|-
 
|-
|No_Stdlib_Flag
+
|WCET
|Command line-flag --no-stdlib to avoid loading ocarina_components.aadl
+
|Property of the interface
 
|-
 
|-
|Timer_Resolution
+
|Queue_Size
|Value of command line --timer
+
|Property of the interface
 
|-
 
|-
|Output_Dir
+
|IF_Property_Names
|Value or command line -o to set the output folder
+
| and Values User-defined properties (vector tag)
 
|-
 
|-
|Interface_View
+
|IF_Property_Values
|Interface view filename
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Binary_Path
+
|Remote_Languages
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Check_Data_View
+
|Param_ASN1_Modules
|Value of command line flag --check-dataview
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Debug_Flag
+
|Remote_Interface_Names
|Value of command line flag --debug (or -g)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Use_POHIC
+
|Remote_Function_Names
|Value of command line flag --polyorb-hi-c (or -p)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Other_Files
+
|Param_Basic_Types
|List of AADL files passed to the command line
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Deployment_View
+
|Interface_View
|Deployment view filename
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Data_View
+
|Check_Data_View
|Data view filename
+
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Family
+
|Shared_Lib_Dir
|CPU Kind (e.g. leon3)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Platform
+
|Use_POHIC
|AADL CPU_Platform (e.g. PLATFORM_NATIVE)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Name
+
|Skeletons
|CPU AADL Identifier (e.g. x86_inst)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Target
+
|Debug_Flag
|Value of command line flag --target=Target
+
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Classifier
+
|Output_Dir
|AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Shared_Types
+
|Timer_Resolution
|List of available component types
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Shared_Lib_Dir
+
|Target
|Folder hosting the shared component types
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Is_Distributed
+
|Binary_Path
|True if the system contains at least one bus
+
|DOCUMENTATION MISSING
|}
 
=== templates/concurrency_view/sub/thread.tmplt ===
 
This file is processed for every thread in every partition in every node.
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
|Thread_Name
+
|Other_Files
|Thread name
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Partition_Name
+
|Deployment_View
|Partition containing this thread
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Entry_Port_Name
+
|Shared_Types
|Name of the PI
+
|DOCUMENTATION MISSING
 
|-
 
|-
|RCM
+
|Data_View
|One of "CYCLIC_OPERATION", "SPORADIC_OPERATION"
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Need_Mutex
+
|No_Stdlib_Flag
|True if the PI is shared with others in the protected block
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Pro_Block_Name
+
|Glue
|Name of the protected function
+
|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]
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 
|-
 
|-
|Node_Name
+
|Name
|Name of the deployment node
+
|The function name
 
|-
 
|-
|Remote_Threads
+
|ASN1_Files
|Vector tag: output remote thread list
+
|List of all ASN.1 files
 
|-
 
|-
|Remote_PIs
+
|ASN1_Modules
| ↳ Associated PI Name
+
|List of all ASN.1 modules
 
|-
 
|-
|Remote_PI_Sorts
+
|Is_Type
| ↳ Optional param type of the remote thread
+
|Flag set to True for function type
 
|-
 
|-
|Remote_PI_Modules
+
|Instance_Of
| ↳ Asn1 module of the optional param type
+
|Name of function type if instance
 
|-
 
|-
|Name
+
|Has_CP
|
+
|True if context parameters are defined for this function
 
|-
 
|-
|Kind
+
|Property_Names
|
+
|Function user-defined property names (goes in pair with Property_Values)
 
|-
 
|-
|Parent_Function
+
|Property_Values
|Tags related to the PI that is at the origin of the thread creation: shoud be useless here
+
|Function user-defined property values (goes in pair with Property_Names)
 
|-
 
|-
|Param_Names
+
|Is_Shared_Type
|
+
|True if component is an instance of a function in the shared types folder
 
|-
 
|-
|Period
+
|Language
|
+
|Implementation language of the function
 
|-
 
|-
|WCET
+
|Shared_Lib_Dir
|
+
|Path to the shared component type folder
 
|-
 
|-
|Queue_Size
+
|List_Of_PIs
|relevant here
+
|List of all provided interfaces (names only)
 +
|}
 +
=== 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.
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 
|-
 
|-
|IF_Property_Names
+
|Filename_Is_Present
|
+
|true if file with name returned by filenode.tmplt exists
 
|-
 
|-
 
|Skeletons
 
|Skeletons
Line 636: Line 633:
 
|from kazoo configuration
 
|from kazoo configuration
 
|-
 
|-
|Param_Directions
+
|No_Stdlib_Flag
|DOCUMENTATION MISSING
+
|Command line-flag --no-stdlib to avoid loading ocarina_components.aadl
|-
 
|Is_Timer
 
|DOCUMENTATION MISSING
 
|-
 
|Debug_Flag
 
|DOCUMENTATION MISSING
 
 
|-
 
|-
 
|Timer_Resolution
 
|Timer_Resolution
|DOCUMENTATION MISSING
+
|Value of command line --timer
 
|-
 
|-
|Param_Encodings
+
|Output_Dir
|DOCUMENTATION MISSING
+
|Value or command line -o to set the output folder
 
|-
 
|-
 
|Interface_View
 
|Interface_View
 
|Interface view filename
 
|Interface view filename
 
|-
 
|-
|IF_Property_Values
+
|Binary_Path
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Language
+
|Check_Data_View
|Implementation language of the function
+
|Value of command line flag --check-dataview
 
|-
 
|-
|Binary_Path
+
|Debug_Flag
|DOCUMENTATION MISSING
+
|Value of command line flag --debug (or -g)
 
|-
 
|-
|Remote_Function_Names
+
|Use_POHIC
|DOCUMENTATION MISSING
+
|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
|DOCUMENTATION MISSING
+
|Deployment view filename
 
|-
 
|-
|No_Stdlib_Flag
+
|Data_View
|DOCUMENTATION MISSING
+
|Data view filename
 
|-
 
|-
|Remote_Languages
+
|CPU_Family
|DOCUMENTATION MISSING
+
|CPU Kind (e.g. leon3)
 
|-
 
|-
|Param_ASN1_Modules
+
|CPU_Platform
|DOCUMENTATION MISSING
+
|AADL CPU_Platform (e.g. PLATFORM_NATIVE)
 
|-
 
|-
|Output_Dir
+
|CPU_Name
|DOCUMENTATION MISSING
+
|CPU AADL Identifier (e.g. x86_inst)
 
|-
 
|-
|RI_Port_Names
+
|Target
|DOCUMENTATION MISSING
+
|Value of command line flag --target=Target
 
|-
 
|-
|Param_Types
+
|CPU_Classifier
|DOCUMENTATION MISSING
+
|AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux)
 
|-
 
|-
|Remote_Interface_Names
+
|Shared_Types
|DOCUMENTATION MISSING
+
|List of available component types
 
|-
 
|-
|Check_Data_View
+
|Shared_Lib_Dir
|Value of command line flag --check-dataview
+
|Folder hosting the shared component types
 
|-
 
|-
|Use_POHIC
+
|Is_Distributed
|Value of command line flag --polyorb-hi-c (or -p)
+
|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.
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 
|-
 
|-
|Other_Files
+
|Thread_Name
|List of AADL files passed to the command line
+
|Thread name
 
|-
 
|-
|Data_View
+
|Partition_Name
|Data view filename
+
|Partition containing this thread
 
|-
 
|-
|Param_Basic_Types
+
|Entry_Port_Name
|DOCUMENTATION MISSING
+
|Name of the PI
 
|-
 
|-
|Target
+
|RCM
|Value of command line flag --target=Target
+
|One of "CYCLIC_OPERATION", "SPORADIC_OPERATION"
 
|-
 
|-
|Priority
+
|Need_Mutex
|DOCUMENTATION MISSING
+
|True if the PI is shared with others in the protected block
 
|-
 
|-
|Dispatch_Offset_ms
+
|Pro_Block_Name
|DOCUMENTATION MISSING
+
|Name of the protected function
 
|-
 
|-
|Stack_Size_In_Bytes
+
|Node_Name
|DOCUMENTATION MISSING
+
|Name of the deployment node
 
|-
 
|-
|Shared_Types
+
|Remote_Threads
|List of available component types
+
|Vector tag: output remote thread list
 +
|-
 +
|Remote_PIs
 +
| ↳ Associated PI Name
 +
|-
 +
|Remote_PI_Sorts
 +
| ↳ Optional param type of the remote thread
 
|-
 
|-
|Shared_Lib_Dir
+
|Remote_PI_Modules
|Folder hosting the shared component types
+
| ↳ Asn1 module of the optional param type
|}
 
=== 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
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
 
|Name
 
|Name
|The name of the interface
+
|
 
|-
 
|-
 
|Kind
 
|Kind
|The RCM Kind
+
|
 
|-
 
|-
 
|Parent_Function
 
|Parent_Function
|The name of the function
+
|Tags related to the PI that is at the origin of the thread creation: shoud be useless here
 
|-
 
|-
 
|Param_Names
 
|Param_Names
|List of parameter names
+
|
 +
|-
 +
|Period
 +
|
 +
|-
 +
|WCET
 +
|
 +
|-
 +
|Queue_Size
 +
|relevant here
 +
|-
 +
|IF_Property_Names
 +
|
 +
|-
 +
|Skeletons
 +
|from kazoo configuration
 
|-
 
|-
|Param_Types
+
|Glue
| ↳ Corresponding parameter types
+
|from kazoo configuration
 
|-
 
|-
 
|Param_Directions
 
|Param_Directions
| ↳ Corresponding direction
+
|DOCUMENTATION MISSING
 
|-
 
|-
 
|Is_Timer
 
|Is_Timer
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_Encodings
+
|Debug_Flag
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Caller_Is_Local
+
|Timer_Resolution
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|IF_Property_Values
+
|Param_Encodings
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Queue_Size
+
|Interface_View
 +
|Interface view filename
 +
|-
 +
|IF_Property_Values
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
Line 766: Line 783:
 
|Implementation language of the function
 
|Implementation language of the function
 
|-
 
|-
|Protected_Block_Name
+
|Binary_Path
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Remote_Languages
+
|Remote_Function_Names
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Param_ASN1_Modules
+
|Deployment_View
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Partition_Name
+
|No_Stdlib_Flag
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Calling_Threads
+
|Remote_Languages
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|IF_Property_Names
+
|Param_ASN1_Modules
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Period
+
|Output_Dir
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Remote_Interface_Names
+
|RI_Port_Names
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|WCET
+
|Param_Types
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Remote_Function_Names
+
|Remote_Interface_Names
 
|DOCUMENTATION MISSING
 
|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
 
|Param_Basic_Types
 
|DOCUMENTATION MISSING
 
|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
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
|Name
+
|Target
|The name of the interface
+
|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
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 +
|-
 +
|Name
 +
|The name of the interface
 
|-
 
|-
 
|Kind
 
|Kind
Line 819: Line 866:
 
|-
 
|-
 
|Param_Types
 
|Param_Types
|Corresponding parameter types
+
| ↳ Corresponding parameter types
 
|-
 
|-
 
|Param_Directions
 
|Param_Directions
|Corresponding direction
+
| ↳ Corresponding direction
 
|-
 
|-
 
|Is_Timer
 
|Is_Timer
Line 828: Line 875:
 
|-
 
|-
 
|Param_Encodings
 
|Param_Encodings
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Caller_Is_Local
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
Line 837: Line 887:
 
|-
 
|-
 
|Language
 
|Language
 +
|Implementation language of the function
 +
|-
 +
|Protected_Block_Name
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
Line 869: Line 922:
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|}
 
|}
=== templates/concurrency_view/sub/block.tmplt ===
+
=== templates/concurrency_view/sub/ri.tmplt ===
This template is evaluated for every block.
+
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
 
{| class="wikitable"
 
{| class="wikitable"
 
!Parameter name
 
!Parameter name
Line 876: Line 930:
 
|-
 
|-
 
|Name
 
|Name
|Protected block name
+
|The name of the interface
 
|-
 
|-
|Language
+
|Kind
|Implementation language
+
|The RCM Kind
 
|-
 
|-
|Calling_Threads
+
|Parent_Function
|List of calling threads
+
|The name of the function
 
|-
 
|-
|Protected_PIs
+
|Param_Names
|Protected Provided interfaces (from pi.tmplt)
+
|List of parameter names
 
|-
 
|-
|Unprotected_PIs
+
|Param_Types
|Unprotected Provided interfaces (from pi.tmplt)
+
|Corresponding parameter types
 
|-
 
|-
|Required
+
|Param_Directions
|Required interfaces (from ri.tmplt)
+
|Corresponding direction
 
|-
 
|-
|List_Of_PIs
+
|Is_Timer
|Complete list of provided interfaces
+
|DOCUMENTATION MISSING
 
|-
 
|-
|List_Of_ASync_RIs
+
|Param_Encodings
|Vector tag: name of asynchronous RIs
+
|DOCUMENTATION MISSING
 
|-
 
|-
|ASync_RI_Param_Name
+
|IF_Property_Values
| ↳ corresponding parameter Name
+
|DOCUMENTATION MISSING
 
|-
 
|-
|ASync_RI_Param_Type
+
|Queue_Size
|  ↳ corresponding parameter ASN.1 type
 
|-
 
|RIs_Have_Params
 
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|List_Of_Sync_RIs
+
|Language
|List of synchronous RIs
+
|DOCUMENTATION MISSING
 
|-
 
|-
|List_Of_ASync_PIs
+
|Remote_Languages
|Vector tag: name of asynchronous PIs
+
|DOCUMENTATION MISSING
 
|-
 
|-
|ASync_PI_Param_Name
+
|Param_ASN1_Modules
| ↳ corresponding parameter Name
+
|DOCUMENTATION MISSING
 
|-
 
|-
|ASync_PI_Param_Type
+
|Partition_Name
| ↳ corresponding parameter ASN.1 type
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Timer_Resolution
+
|Calling_Threads
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Property_Names
+
|IF_Property_Names
|Vector tag: AADL Property name
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Property_Values
+
|Period
| ↳ corresponding AADL property value
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Skeletons
+
|Remote_Interface_Names
|Command line flag (--gw)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Interface_View
+
|WCET
|Interface view filename
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Binary_Path
+
|Remote_Function_Names
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|CP_Names
+
|Param_Basic_Types
|Vector tag: context parameter names
+
|DOCUMENTATION MISSING
 +
|}
 +
=== templates/concurrency_view/sub/block.tmplt ===
 +
This template is evaluated for every block.
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 
|-
 
|-
|CP_Values
+
|Name
| ↳ value
+
|Protected block name
 
|-
 
|-
|CP_Asn1Modules
+
|Language
| ↳ ASN.1 module
+
|Implementation language
 
|-
 
|-
|CP_Asn1Filenames
+
|Calling_Threads
| ↳ ASN.1 file name
+
|List of calling threads
 
|-
 
|-
|CP_Types
+
|Protected_PIs
| ↳ Context parameter ASN.1 type
+
|Protected Provided interfaces (from pi.tmplt)
 
|-
 
|-
|Deployment_View
+
|Unprotected_PIs
|Path/name of Deployment view file
+
|Unprotected Provided interfaces (from pi.tmplt)
 
|-
 
|-
|No_Stdlib_Flag
+
|Required
|command line flag --no-stdlib
+
|Required interfaces (from ri.tmplt)
 
|-
 
|-
|Glue
+
|List_Of_PIs
|command line flag --glue
+
|List of all provided interfaces (names only)
 
|-
 
|-
|Partition_Name
+
|List_Of_ASync_RIs
|Name of the partition containing this function
+
|Vector tag: name of asynchronous RIs
 
|-
 
|-
|Async_RIs_Parent
+
|ASync_RI_Param_Name
|DOCUMENTATION MISSING
+
| ↳ corresponding parameter Name
 
|-
 
|-
|Zip_File
+
|ASync_RI_Param_Type
|DOCUMENTATION MISSING
+
| ↳ corresponding parameter ASN.1 type
 
|-
 
|-
|Node_Name
+
|RIs_Have_Params
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|List_Of_Sync_PIs
+
|List_Of_Sync_RIs
|DOCUMENTATION MISSING
+
|List of synchronous RIs
 
|-
 
|-
|Has_Context
+
|List_Of_ASync_PIs
|True if function has context parameters
+
|Vector tag: name of asynchronous PIs
 
|-
 
|-
|Output_Dir
+
|ASync_PI_Kind
|Output folder (by default: work)
+
| ↳ CYCLIC_OPERATION or SPORADIC_OPERATION
 
|-
 
|-
|PIs_Have_Params
+
|ASync_PI_Is_Connected
|DOCUMENTATION MISSING
+
| ↳ Flag set to true if PI is connected
 
|-
 
|-
|Timers
+
|ASync_PI_Param_Name
|DOCUMENTATION MISSING
+
| ↳ corresponding parameter Name
 
|-
 
|-
|Check_Data_View
+
|ASync_PI_Param_Type
|Value of command line flag --check-dataview
+
| ↳ corresponding parameter ASN.1 type
 
|-
 
|-
|Use_POHIC
+
|Timer_Resolution
|Value of command line flag --polyorb-hi-c (or -p)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Other_Files
+
|Property_Names
|List of AADL files passed to the command line
+
|Vector tag: AADL Property name
 
|-
 
|-
|Sync_RIs_Parent
+
|Property_Values
|DOCUMENTATION MISSING
+
| ↳ corresponding AADL property value
 
|-
 
|-
|List_Of_RIs
+
|Skeletons
|List of required interface
+
|Command line flag (--gw)
 
|-
 
|-
|Data_View
+
|Interface_View
|Data view filename
+
|Interface view filename
 
|-
 
|-
|Target
+
|Binary_Path
|Value of command line flag --target=Target
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Shared_Types
+
|CP_Names
|List of available component types
+
|Vector tag: context parameter names
 
|-
 
|-
|Shared_Lib_Dir
+
|CP_Values
|Folder hosting the shared component types
+
| ↳ value
 
|-
 
|-
|Is_Type
+
|CP_Asn1Modules
|True if function is a function type
+
| ↳ ASN.1 module
 
|-
 
|-
|Instance_Of
+
|CP_Asn1Filenames
|DOCUMENTATION MISSING
+
| ↳ ASN.1 file name
 
|-
 
|-
|Debug_Flag
+
|CP_Types
|if -g is set in the command line
+
| ↳ Context parameter ASN.1 type
 
|-
 
|-
|Is_Shared_Type
+
|Deployment_View
|True if component is an instance of a function in the shared types folder
+
|Path/name of Deployment view file
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
=== templates/concurrency_view/sub/partition.tmplt ===
 
This file is evaluated for every partition.
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
|Name
+
|No_Stdlib_Flag
|Partition name (usually the name of the binary)
+
|command line flag --no-stdlib
 
|-
 
|-
|Threads
+
|Glue
|Code generated for the threads
+
|command line flag --glue
 
|-
 
|-
|Thread_Names
+
|Partition_Name
|Tag: list of thread names
+
|Name of the partition containing this function
 
|-
 
|-
|Node_Name
+
|Async_RIs_Parent
|Name of the node containing this partition
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Blocks
+
|Zip_File
|Code generated for protected functions
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Block_Names
+
|Node_Name
|Tag: list of block (user functions) names
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Coverage
+
|List_Of_Sync_PIs
|True if user requested code coverage enable
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Package_Name
+
|Has_Context
|AADL Package name for the target (e.g. ocarina_porocessors_x86)
+
|True if function has context parameters
 
|-
 
|-
|CPU_Name
+
|Output_Dir
|CPU AADL Identifier (e.g. x86_inst)
+
|Output folder (by default: work)
 
|-
 
|-
|CPU_Family
+
|PIs_Have_Params
|CPU Kind (e.g. leon3)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Instance
+
|Timers
|AADL component instance (e.g. rtems_posix)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Platform
+
|Check_Data_View
|AADL CPU_Platform (e.g. PLATFORM_NATIVE)
+
|Value of command line flag --check-dataview
 
|-
 
|-
|CPU_Classifier
+
|Use_POHIC
|AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux)
+
|Value of command line flag --polyorb-hi-c (or -p)
 
|-
 
|-
|VP_Name
+
|Other_Files
|Virtual processor name on which the partition is bounded
+
|List of AADL files passed to the command line
 
|-
 
|-
|VP_Platform
+
|Sync_RIs_Parent
|Virtual processor platform (e.g. PLATFORM_AIR)
+
|DOCUMENTATION MISSING
 
|-
 
|-
|VP_Classifier
+
|List_Of_RIs
|Virtual processor classifier
+
|List of required interface
 
|-
 
|-
|Bound_Functions
+
|Data_View
|List of user functions from Interface view
+
|Data view filename
 
|-
 
|-
|Thread_Src_Name
+
|Target
|Vector tag : connection thread name (source)
+
|Value of command line flag --target=Target
 
|-
 
|-
|Thread_Dst_Name
+
|Shared_Types
|Vector tag : connection thread name (dest)
+
|List of available component types
 
|-
 
|-
|Thread_Src_Port
+
|Shared_Lib_Dir
|Vector tag : connection port name (source)
+
|Folder hosting the shared component types
 
|-
 
|-
|Thread_Dst_Port
+
|Is_Type
|Vector tag : connection port name (dest)
+
|True if function is a function type
 
|-
 
|-
|In_Port_Names
+
|Instance_Of
|Vector tag: input ports of the partition
+
|DOCUMENTATION MISSING
 
|-
 
|-
|In_Port_Thread_Name
+
|Debug_Flag
| ↳ corresponding thread inside the partition
+
|if -g is set in the command line
 
|-
 
|-
|In_Port_Type_Name
+
|Is_Shared_Type
| ↳ corresponding parameter type name (optional)
+
|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.
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 
|-
 
|-
|Out_Port_Names
+
|Name
|Vector tag: output ports of the partition
+
|Partition name (usually the name of the binary)
 
|-
 
|-
|Out_Port_Type_Name
+
|Threads
| ↳ corresponding parameter type name (optional)
+
|Code generated for the threads
 
|-
 
|-
|Part_Out_Port_Name
+
|Thread_Names
|Vector tag: output ports of the partition (can be several times the same)
+
|Tag: list of thread names
 
|-
 
|-
|Connected_Threads
+
|Node_Name
| ↳ Corresponding thread connected to it
+
|Name of the node containing this partition
 
|-
 
|-
|Block_Instance_Of
+
|Blocks
|DOCUMENTATION MISSING
+
|Code generated for protected functions
 
|-
 
|-
|Thread_Has_Param
+
|Block_Names
|DOCUMENTATION MISSING
+
|Tag: list of block (user functions) names
 
|-
 
|-
|Memory_Region
+
|Coverage
|DOCUMENTATION MISSING
+
|True if user requested code coverage enable
 
|-
 
|-
|VP_Package_Name
+
|Package_Name
|DOCUMENTATION MISSING
+
|AADL Package name for the target (e.g. ocarina_porocessors_x86)
 
|-
 
|-
|Ada_Runtime
+
|CPU_Name
|DOCUMENTATION MISSING
+
|CPU AADL Identifier (e.g. x86_inst)
 
|-
 
|-
|Block_Languages
+
|CPU_Family
|For each block: implementation language
+
|CPU Kind (e.g. leon3)
 
|-
 
|-
|VP_Duration
+
|CPU_Instance
|DOCUMENTATION MISSING
+
|AADL component instance (e.g. rtems_posix)
 
|-
 
|-
|Device_CPU
+
|CPU_Platform
|DOCUMENTATION MISSING
+
|AADL CPU_Platform (e.g. PLATFORM_NATIVE)
 
|-
 
|-
|Device_Bus_Name
+
|CPU_Classifier
|DOCUMENTATION MISSING
+
|AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux)
 
|-
 
|-
|Device_Init
+
|VP_Name
|DOCUMENTATION MISSING
+
|Virtual processor name on which the partition is bounded
 
|-
 
|-
|Device_AADL_Pkg
+
|VP_Platform
|DOCUMENTATION MISSING
+
|Virtual processor platform (e.g. PLATFORM_AIR)
 
|-
 
|-
|Device_ASN1_Module
+
|VP_Classifier
|DOCUMENTATION MISSING
+
|Virtual processor classifier
 
|-
 
|-
|Device_Port_Name
+
|Bound_Functions
|DOCUMENTATION MISSING
+
|List of user functions from Interface view
 
|-
 
|-
|Device_Config
+
|Thread_Src_Name
|DOCUMENTATION MISSING
+
|Vector tag : connection thread name (source)
 
|-
 
|-
|Device_Names
+
|Thread_Dst_Name
|DOCUMENTATION MISSING
+
| ↳ connection thread name (destination)
 
|-
 
|-
|Device_ASN1_File
+
|Thread_Src_Port
|DOCUMENTATION MISSING
+
| ↳ connection port name (source)
 
|-
 
|-
|Device_Classifier
+
|Thread_Dst_Port
|DOCUMENTATION MISSING
+
| ↳ connection port name (dest)
 
|-
 
|-
|Device_Language
+
|In_Port_Names
|DOCUMENTATION MISSING
+
|Vector tag: input ports of the partition
 
|-
 
|-
|Device_ASN1_Sort
+
|In_Port_Thread_Name
|DOCUMENTATION MISSING
+
| ↳ corresponding thread inside the partition
 
|-
 
|-
|Out_Port_Remote_Function
+
|In_Port_Type_Name
|DOCUMENTATION MISSING
+
| ↳ corresponding parameter type name (optional)
 
|-
 
|-
|In_Port_Queue_Size
+
|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
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Block_FPGAConf
+
|Thread_Has_Param
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Out_Port_Remote_Port_Name
+
|Memory_Region
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Out_Port_Remote_Partition
+
|VP_Package_Name
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Out_Port_Queue_Size
+
|Ada_Runtime
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Block_Is_Shared_Type
+
|Block_Languages
|True if parent of the instance is a shared component
+
|For each block: implementation language
 
|-
 
|-
|Shared_Lib_Dir
+
|VP_Duration
|Folder hosting the shared component types
+
|DOCUMENTATION MISSING
|}
 
=== 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.
 
{| class="wikitable"
 
!Parameter name
 
!Description
 
 
|-
 
|-
|Node_Name
+
|Device_CPU
|Name of the node from deployment view
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Partition_Names
+
|Device_Bus_Name
|Tag listing the partitions in this node
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Has_Memory
+
|Device_Init
|Boolean flag indicating that a memory is defined for this node
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Partitions
+
|Device_AADL_Pkg
|List of rendered code for partitions
+
|DOCUMENTATION MISSING
 
|-
 
|-
|VP_Names
+
|Device_ASN1_Module
|Vector tag: list of virtual processors on this node
+
|DOCUMENTATION MISSING
 
|-
 
|-
|VP_Package_Names
+
|Device_Port_Name
| ↳ Corresponding package name
+
|DOCUMENTATION MISSING
 
|-
 
|-
|VP_Platforms
+
|Device_Config
| ↳ Corresponding platform name
+
|DOCUMENTATION MISSING
 
|-
 
|-
|VP_Classifiers
+
|Device_Names
| ↳ Corresponding aadl classifier
+
|DOCUMENTATION MISSING
 
|-
 
|-
|Package_Name
+
|Device_ASN1_File
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Family
+
|Device_Classifier
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Classifier
+
|Device_Language
|AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux)
 
|-
 
|CPU_Name
 
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Platform
+
|Device_ASN1_Sort
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Ada_Runtime
+
|Out_Port_Remote_Function
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|CPU_Instance
+
|In_Port_Queue_Size
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_CPU
+
|Block_FPGAConf
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_Bus_Name
+
|Out_Port_Remote_Port_Name
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_AADL_Pkg
+
|Out_Port_Remote_Partition
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_ASN1_Module
+
|Out_Port_Queue_Size
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_Port_Name
+
|Block_Is_Shared_Type
|DOCUMENTATION MISSING
+
|True if parent of the instance is a shared component
 
|-
 
|-
|Device_Config
+
|Shared_Lib_Dir
|DOCUMENTATION MISSING
+
|Folder hosting the shared component types
 
|-
 
|-
|Device_Names
+
|Property_Names
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_ASN1_File
+
|Property_Values
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|-
 
|-
|Device_Classifier
+
|Block_Default_Codegen
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
|-
+
|}
|Device_Language
+
=== templates/concurrency_view/sub/node.tmplt ===
|DOCUMENTATION MISSING
+
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.
|-
+
{| class="wikitable"
|Device_ASN1_Sort
+
!Parameter name
|DOCUMENTATION MISSING
+
!Description
|-
+
|-
|Device_Init
+
|Node_Name
|DOCUMENTATION MISSING
+
|Name of the node from deployment view
|}
+
|-
=== templates/concurrency_view/sub/system.tmplt ===
+
|Partition_Names
This file is evaluated for every node. The result of this file is save to the file with name returned by  
+
|Tag listing the partitions in this node
filesys.tmplt.
+
|-
{| class="wikitable"
+
|Has_Memory
!Parameter name
+
|Boolean flag indicating that a memory is defined for this node
!Description
+
|-
|-
+
|Partitions
|Nodes
+
|List of rendered code for partitions
|Code generated for the nodes
+
|-
|-
+
|VP_Names
|Node_Names
+
|Vector tag: list of virtual processors on this node
|Vector Tag of node names
+
|-
|-
+
|VP_Package_Names
|Node_CPU
+
| ↳ Corresponding package name
| -> Corresponding CPU name (eg x86_linux)
+
|-
|-
+
|VP_Platforms
|Node_CPU_Classifier
+
| ↳ Corresponding platform name
| ↳ Corresponding CPU Classifier (ocarina...::x86_linux)
+
|-
|-
+
|VP_Classifiers
|Node_Major_Frame
+
| ↳ Corresponding aadl classifier
| ↳ Corresponding Time in milliseconds allocated to the CPU (TSP only)
+
|-
 +
|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
 +
|-
 +
|Timer_Resolution
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Interface_View
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Data_View
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Shared_Lib_Dir
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Check_Data_View
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Other_Files
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Target
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Output_Dir
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Deployment_View
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Binary_Path
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Use_POHIC
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Debug_Flag
 +
|DOCUMENTATION MISSING
 +
|-
 +
|No_Stdlib_Flag
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Shared_Types
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Skeletons
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Glue
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Block_Instance_Of
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Block_Languages
 +
|DOCUMENTATION MISSING
 +
|-
 +
|Block_Names
 +
|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.
 +
{| class="wikitable"
 +
!Parameter name
 +
!Description
 +
|-
 +
|Nodes
 +
|Code generated for the nodes
 +
|-
 +
|Node_Names
 +
|Vector Tag of node names
 +
|-
 +
|Node_CPU
 +
| ↳ Corresponding CPU name (e.g. x86_linux)
 +
|-
 +
|Node_Platform
 +
| ↳ Corresponding platform (e.g. PLATFORM_AIR)
 +
|-
 +
|Node_CPU_Classifier
 +
| ↳ Corresponding CPU Classifier (ocarina...::x86_linux)
 +
|-
 +
|Node_Major_Frame
 +
| ↳ Corresponding Time in milliseconds allocated to the CPU (TSP only)
 
|-
 
|-
 
|Partition_Names
 
|Partition_Names
Line 1,474: Line 1,667:
 
|Used_Shared_Types
 
|Used_Shared_Types
 
|List of actually used shared component types
 
|List of actually used shared component types
 +
|-
 +
|Block_Languages
 +
|DOCUMENTATION MISSING
 
|}
 
|}

Revision as of 08:59, 3 March 2021

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
CPU_Platform DOCUMENTATION MISSING
Is_FPGA 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 List of all provided interfaces (names only)
ASync_RI_Param_Type DOCUMENTATION MISSING
RIs_Have_Params DOCUMENTATION MISSING
List_Of_Sync_RIs DOCUMENTATION MISSING
Debug_Flag 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_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 Vector tag: list of async Provided interfaces
ASync_PI_Kind ↳ CYCLIC_OPERATION or SPORADIC_OPERATION
ASync_PI_Is_Connected ↳ Flag set to true if PI is connected
ASync_PI_Param_Name DOCUMENTATION MISSING
ASync_PI_Param_Type 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
Language DOCUMENTATION MISSING

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
Language DOCUMENTATION MISSING

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_PI_Kind ↳ CYCLIC_OPERATION or SPORADIC_OPERATION
ASync_PI_Is_Connected ↳ Flag set to true if PI is connected
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_RIs_Parent ↳ Corresponding parent function name
ASync_RI_Param_Name ↳ parameter name of the required interface
ASync_RI_Param_Type ↳ ASN1 typename of the parameter
Data_View DOCUMENTATION MISSING
Shared_Lib_Dir DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING
Skeletons DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
Shared_Types DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
Target DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Glue DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING
Deployment_View DOCUMENTATION MISSING

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 CYCLIC|PROTECTED|UNPROTECTED_OPERATION)
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
Interface_View DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
Shared_Lib_Dir DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
Skeletons DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING
Target DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
Deployment_View DOCUMENTATION MISSING
Shared_Types DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING
Glue 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
List_Of_PIs List of all provided interfaces (names only)

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 List of all provided interfaces (names only)
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_Kind ↳ CYCLIC_OPERATION or SPORADIC_OPERATION
ASync_PI_Is_Connected ↳ Flag set to true if PI is connected
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 ↳ connection thread name (destination)
Thread_Src_Port ↳ connection port name (source)
Thread_Dst_Port ↳ 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
Property_Names DOCUMENTATION MISSING
Property_Values DOCUMENTATION MISSING
Block_Default_Codegen DOCUMENTATION MISSING

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
Timer_Resolution DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
Shared_Lib_Dir DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
Target DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Deployment_View DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING
Shared_Types DOCUMENTATION MISSING
Skeletons DOCUMENTATION MISSING
Glue DOCUMENTATION MISSING
Block_Instance_Of DOCUMENTATION MISSING
Block_Languages DOCUMENTATION MISSING
Block_Names 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 (e.g. x86_linux)
Node_Platform ↳ Corresponding platform (e.g. PLATFORM_AIR)
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
Block_Languages DOCUMENTATION MISSING