Difference between revisions of "Kazoo concurrency view templates"

From TASTE
Jump to: navigation, search
Line 190: Line 190:
 
=== <template_subdir>/pi.tmplt ===
 
=== <template_subdir>/pi.tmplt ===
 
This file is evaluated for every protected and unprotected provided interface.
 
This file is evaluated for every protected and unprotected provided interface.
The result of every evaluation is joined to single string and passed as a parameter to [[#<template_subdir>/block.tmplt|block template]]
+
The result of every evaluation is joined to single string and passed as a parameter to [[#<template_subdir>/block.tmplt|block template]].
 
{| class="wikitable"
 
{| class="wikitable"
 
!Parameter name
 
!Parameter name
Line 807: Line 807:
 
|DOCUMENTATION MISSING
 
|DOCUMENTATION MISSING
 
|}
 
|}
 +
 +
=== <template_subdir>/fileblock.tmplt ===
 +
TODO
 +
 +
=== <template_subdir>/filenode.tmplt ===
 +
TODO
 +
 +
=== <template_subdir>/filepart.tmplt ===
 +
TODO
 +
 +
=== <template_subdir>/filesys.tmplt ===
 +
TODO
 +
 +
=== <template_subdir>/filethread.tmplt ===
 +
TODO

Revision as of 14:57, 13 December 2019

This page lists all files present in each Concurrency View templates. For each file it's parameters are described. Templates are processed according to Concurrency View template processing algorithm.

Skeleton code templates are stored in templates/concurrency_view kazoo subdirectory.

<tmeplate-subdir>/trigger.tmplt

This file is processed for every node. The result of this file indicates if the rest of files 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
Deployment_View DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING

<template_subdir>/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
Remote_Languages DOCUMENTATION MISSING
Language DOCUMENTATION MISSING
Deployment_View DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Param_Encodings DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
Param_ASN1_Modules DOCUMENTATION MISSING
IF_Property_Values DOCUMENTATION MISSING
RI_Port_Names DOCUMENTATION MISSING
Param_Types DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
Is_Timer DOCUMENTATION MISSING
Param_Directions DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING
Remote_Interface_Names DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
Remote_Function_Names DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING

<template_subdir>/pi.tmplt

This file is evaluated for every protected and unprotected provided interface. The result of every evaluation is joined to single string and passed as a parameter to block template.

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
Remote_Languages DOCUMENTATION MISSING
Language DOCUMENTATION MISSING
Param_Encodings DOCUMENTATION MISSING
Protected_Block_Name DOCUMENTATION MISSING
Period DOCUMENTATION MISSING
WCET DOCUMENTATION MISSING
Param_ASN1_Modules DOCUMENTATION MISSING
Queue_Size DOCUMENTATION MISSING
Partition_Name DOCUMENTATION MISSING
IF_Property_Values DOCUMENTATION MISSING
IF_Property_Names DOCUMENTATION MISSING
Caller_Is_Local DOCUMENTATION MISSING
Is_Timer DOCUMENTATION MISSING
Remote_Interface_Names DOCUMENTATION MISSING
Calling_Threads DOCUMENTATION MISSING
Remote_Function_Names DOCUMENTATION MISSING

<template_subdir>/ri.tmplt

This file is evaluated for every required interface. The result of every evaluation is joined to single string and passed as a parameter to block template.

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
Remote_Languages DOCUMENTATION MISSING
Language DOCUMENTATION MISSING
Param_Encodings DOCUMENTATION MISSING
Period DOCUMENTATION MISSING
WCET DOCUMENTATION MISSING
Param_ASN1_Modules DOCUMENTATION MISSING
Queue_Size DOCUMENTATION MISSING
Partition_Name DOCUMENTATION MISSING
IF_Property_Values DOCUMENTATION MISSING
IF_Property_Names DOCUMENTATION MISSING
Is_Timer DOCUMENTATION MISSING
Remote_Interface_Names DOCUMENTATION MISSING
Calling_Threads DOCUMENTATION MISSING
Remote_Function_Names DOCUMENTATION MISSING

<template_subdir>/block.tmplt

This file 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)
Deployment_View DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Zip_File DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Skeletons DOCUMENTATION MISSING
List_Of_PIs DOCUMENTATION MISSING
ASync_PI_Param_Name DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
Instance_Of DOCUMENTATION MISSING
PIs_Have_Params DOCUMENTATION MISSING
List_Of_ASync_PIs DOCUMENTATION MISSING
Is_Type DOCUMENTATION MISSING
List_Of_RIs DOCUMENTATION MISSING
Partition_Name DOCUMENTATION MISSING
ASync_RI_Param_Type DOCUMENTATION MISSING
Property_Values DOCUMENTATION MISSING
CP_Names DOCUMENTATION MISSING
List_Of_ASync_RIs DOCUMENTATION MISSING
Node_Name DOCUMENTATION MISSING
RIs_Have_Params DOCUMENTATION MISSING
CP_Types DOCUMENTATION MISSING
CP_Asn1Modules DOCUMENTATION MISSING
Async_RIs_Parent DOCUMENTATION MISSING
Sync_RIs_Parent DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
ASync_RI_Param_Name DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING
List_Of_Sync_RIs DOCUMENTATION MISSING
Glue DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
CP_Values DOCUMENTATION MISSING
Property_Names DOCUMENTATION MISSING
List_Of_Sync_PIs DOCUMENTATION MISSING
Has_Context DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
Timers DOCUMENTATION MISSING
CP_Asn1Filenames DOCUMENTATION MISSING
ASync_PI_Param_Type DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING

<template_subdir>/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_Languages DOCUMENTATION MISSING
VP_Duration DOCUMENTATION MISSING
VP_Package_Name DOCUMENTATION MISSING
Memory_Region DOCUMENTATION MISSING
Block_Instance_Of DOCUMENTATION MISSING
Ada_Runtime DOCUMENTATION MISSING
Thread_Has_Param DOCUMENTATION MISSING

<template_subdir>/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
CPU_Platform DOCUMENTATION MISSING
CPU_Name DOCUMENTATION MISSING
CPU_Instance DOCUMENTATION MISSING
Ada_Runtime DOCUMENTATION MISSING
CPU_Classifier DOCUMENTATION MISSING
Package_Name DOCUMENTATION MISSING
CPU_Family DOCUMENTATION MISSING

<template_subdir>/system.tmplt

This file is evaluated for every node. The result of the evaluation are stored 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 CPU Classifier (ocarina...::x86_linux)
Node_Major_Frame 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 Virtual processor binding (TSP only)
Threads Code generated for the threads
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
Deployment_View DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
Skeletons DOCUMENTATION MISSING
Node_Has_Memory DOCUMENTATION MISSING
Device_Names DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
Block_Names DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING
Glue DOCUMENTATION MISSING
Use_POHIC DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING

<template_subdir>/fileblock.tmplt

TODO

<template_subdir>/filenode.tmplt

TODO

<template_subdir>/filepart.tmplt

TODO

<template_subdir>/filesys.tmplt

TODO

<template_subdir>/filethread.tmplt

TODO