templates_from_wiki 28.5 KB
Newer Older
1
== Templates ==
2

3
=== templates/skeletons/makefile.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
4
5
6
7
8
9
10
11
12
This template is evaluated only once. The output is saved to the Makefile within output directory.
{| class="wikitable"
!Parameter name
!Description
|-
|Function_Names
|Combined table: list of fuction names...
|-
|Language
Maxime Perrotin's avatar
Maxime Perrotin committed
13
|↳ and corresponding implementation language
Maxime Perrotin's avatar
Maxime Perrotin committed
14
15
|-
|Is_Type
Maxime Perrotin's avatar
Maxime Perrotin committed
16
|↳ and flag if it is a function type
Maxime Perrotin's avatar
Maxime Perrotin committed
17
18
|-
|Has_Context_Param
Maxime Perrotin's avatar
Maxime Perrotin committed
19
|↳ and flag to indicate if function has context parameters
Maxime Perrotin's avatar
Maxime Perrotin committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|-
|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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
83
|}
84
=== templates/skeletons/context-parameters.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
85
86
87
88
89
90
91
92
93
94
95
96
This template is evaluated for every function which has context parameters. The output is saved to the file Context-<function name>.asn
{| class="wikitable"
!Parameter name
!Description
|-
|Name
|Function name
|-
|Sort_Set
|Set of types used for this Context Parameter file
|-
|Module_Set
Maxime Perrotin's avatar
Maxime Perrotin committed
97
|&#8627; corresponding module (needed for ASN.1 "IMPORTS")
Maxime Perrotin's avatar
Maxime Perrotin committed
98
99
100
101
102
|-
|CP_Name
|Table of context parameter names
|-
|CP_Sort
Maxime Perrotin's avatar
Maxime Perrotin committed
103
|&#8627; corresponding ASN.1 type
Maxime Perrotin's avatar
Maxime Perrotin committed
104
105
|-
|CP_ASN1_Module
Maxime Perrotin's avatar
Maxime Perrotin committed
106
|&#8627; in ASN.1 module
Maxime Perrotin's avatar
Maxime Perrotin committed
107
108
|-
|CP_Value
Maxime Perrotin's avatar
Maxime Perrotin committed
109
|&#8627; with default value
110
111
112
113
114
115
|-
|Is_Type
|DOCUMENTATION MISSING
|-
|Instance_Of
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
116
|}
117
=== templates/skeletons/sub/trigger.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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.

{| class="wikitable"
!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
Maxime Perrotin's avatar
Maxime Perrotin committed
148
|Value of command line flag --polyorb-hi-c (or -p)
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|-
|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
|-
|Timer_Resolution
|DOCUMENTATION MISSING
|-
|Property_Names
Maxime Perrotin's avatar
Maxime Perrotin committed
169
170
171
|Vector tag: AADL Property name
|-
|Property_Values
Maxime Perrotin's avatar
Maxime Perrotin committed
172
|  &#8627; corresponding AADL property value
173
174
175
176
177
|-
|Skeletons
|DOCUMENTATION MISSING
|-
|Interface_View
Maxime Perrotin's avatar
Maxime Perrotin committed
178
|Interface view filename
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|-
|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
199
200
201
202
203
|Vector tag: list of async Provided interfaces
|-
|ASync_PI_Kind
|  &#8627; CYCLIC_OPERATION or SPORADIC_OPERATION
|-
Maxime Perrotin's avatar
Maxime Perrotin committed
204
205
206
|ASync_PI_Is_Connected
|  &#8627; Flag set to true if PI is connected
|-
207
208
209
210
|ASync_PI_Param_Name
|DOCUMENTATION MISSING
|-
|ASync_PI_Param_Type
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
244
|Value of command line flag --check-dataview
245
246
247
248
249
|-
|CP_Types
|DOCUMENTATION MISSING
|-
|Other_Files
Maxime Perrotin's avatar
Maxime Perrotin committed
250
|List of AADL files passed to the command line
251
252
253
254
255
256
257
258
|-
|Sync_RIs_Parent
|DOCUMENTATION MISSING
|-
|List_Of_RIs
|DOCUMENTATION MISSING
|-
|Data_View
Maxime Perrotin's avatar
Maxime Perrotin committed
259
|Data view filename
Maxime Perrotin's avatar
Maxime Perrotin committed
260
261
|-
|Target
Maxime Perrotin's avatar
Maxime Perrotin committed
262
|Value of command line flag --target=Target
263
264
265
266
267
268
|-
|Shared_Types
|List of available component types
|-
|Shared_Lib_Dir
|Folder hosting the shared component types
Maxime Perrotin's avatar
Maxime Perrotin committed
269
|}
270
=== templates/skeletons/sub/makefile-filename.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
271
272
273
274
275
276
277
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.
{| class="wikitable"
!Parameter name
!Description
|-
|Name
|The name of the function
278
279
280
|-
|Language
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
281
|}
282
=== templates/skeletons/sub/function-filename.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
283
284
285
286
287
288
289
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.
{| class="wikitable"
!Parameter name
!Description
|-
|Name
|The name of the function
290
291
292
|-
|Language
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
293
|}
Maxime Perrotin's avatar
Maxime Perrotin committed
294
295
296
297
298
299
300
301
302
=== templates/skeletons/sub/function.tmplt ===
Template for a function in the skeleton or glue folder
{| class="wikitable"
!Parameter name
!Description
|-
|Name
|The name of the function
|-
303
304
|Language
|Implementation language
Maxime Perrotin's avatar
Maxime Perrotin committed
305
|-
306
307
|List_Of_PIs
|List of all provided interfaces (names only)
Maxime Perrotin's avatar
Maxime Perrotin committed
308
|-
309
310
|List_Of_RIs
|List of all required interfaces (names only)
Maxime Perrotin's avatar
Maxime Perrotin committed
311
|-
312
313
|Provided_Interfaces
|Generated from interfaces.tmplt
Maxime Perrotin's avatar
Maxime Perrotin committed
314
|-
315
316
|Required_Interfaces
|Generated from interfaces.tmplt
Maxime Perrotin's avatar
Maxime Perrotin committed
317
|-
318
319
|RIs_Have_Params
|True if at least one RI has an ASN.1 parameter
Maxime Perrotin's avatar
Maxime Perrotin committed
320
|-
321
322
323
324
325
326
327
328
329
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
330
331
|-
|Instance_Of
332
|Name of the function type if it is an instance
Maxime Perrotin's avatar
Maxime Perrotin committed
333
|-
334
335
|Has_Context
|True if function has context parameters
336
|-
337
338
|CP_Names
|Vector tag: context parameters (names)
Maxime Perrotin's avatar
Maxime Perrotin committed
339
|-
340
|CP_Types
Maxime Perrotin's avatar
Maxime Perrotin committed
341
| &#8627; corresponding ASN.1 type
Maxime Perrotin's avatar
Maxime Perrotin committed
342
|-
343
|CP_Values
Maxime Perrotin's avatar
Maxime Perrotin committed
344
| &#8627; corresponding value
Maxime Perrotin's avatar
Maxime Perrotin committed
345
|-
346
|CP_Asn1Modules
Maxime Perrotin's avatar
Maxime Perrotin committed
347
| &#8627; corresponding ASN.1 module containing the type
Maxime Perrotin's avatar
Maxime Perrotin committed
348
|-
349
|CP_Asn1Filenames
Maxime Perrotin's avatar
Maxime Perrotin committed
350
| &#8627; corresponding ASN.1 filename
Maxime Perrotin's avatar
Maxime Perrotin committed
351
|-
352
353
|Property_Names
|Vector tag: user defined AADL property names
Maxime Perrotin's avatar
Maxime Perrotin committed
354
|-
355
|Property_Values
Maxime Perrotin's avatar
Maxime Perrotin committed
356
| &#8627; corresponding value
Maxime Perrotin's avatar
Maxime Perrotin committed
357
|-
358
359
|List_Of_ASync_PIs
|List of asynchronous provided interfaces
Maxime Perrotin's avatar
Maxime Perrotin committed
360
|-
361
|ASync_PI_Param_Name
Maxime Perrotin's avatar
Maxime Perrotin committed
362
| &#8627; name of the parameter
Maxime Perrotin's avatar
Maxime Perrotin committed
363
364
|-
|ASync_PI_Param_Type
Maxime Perrotin's avatar
Maxime Perrotin committed
365
| &#8627; ASN.1 typename of the parameter
Maxime Perrotin's avatar
Maxime Perrotin committed
366
|-
367
368
|ASync_PI_Kind
| &#8627; CYCLIC_OPERATION or SPORADIC_OPERATION
Maxime Perrotin's avatar
Maxime Perrotin committed
369
|-
Maxime Perrotin's avatar
Maxime Perrotin committed
370
371
372
|ASync_PI_Is_Connected
|  &#8627; Flag set to true if PI is connected
|-
Maxime Perrotin's avatar
Maxime Perrotin committed
373
|Timers
374
|List of timers (names)
Maxime Perrotin's avatar
Maxime Perrotin committed
375
376
|-
|List_Of_Sync_RIs
377
|List of synchronous required interfaces
Maxime Perrotin's avatar
Maxime Perrotin committed
378
379
|-
|List_Of_Sync_PIs
380
|List of synchronous provided interfaces
Maxime Perrotin's avatar
Maxime Perrotin committed
381
|-
382
|Sync_RIs_Parent
Maxime Perrotin's avatar
Maxime Perrotin committed
383
| &#8627; and corresponding parent function name
Maxime Perrotin's avatar
Maxime Perrotin committed
384
385
|-
|ASN1_Modules
386
|List of ASN.1 modules containing types used in this function
Maxime Perrotin's avatar
Maxime Perrotin committed
387
|-
388
389
|ASN1_Files
|List of ASN.1 files containing types used in this function
Maxime Perrotin's avatar
Maxime Perrotin committed
390
391
|-
|List_Of_ASync_RIs
392
|vector tag: list of asynchronous required interfaces
Maxime Perrotin's avatar
Maxime Perrotin committed
393
|-
394
395
396
|Async_RIs_Parent
| &#8627; Corresponding parent function name
|-
397
|ASync_RI_Param_Name
Maxime Perrotin's avatar
Maxime Perrotin committed
398
| &#8627; parameter name of the required interface
399
400
|-
|ASync_RI_Param_Type
Maxime Perrotin's avatar
Maxime Perrotin committed
401
| &#8627; ASN1 typename of the parameter
Maxime Perrotin's avatar
Maxime Perrotin committed
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
450
|}
451
=== templates/skeletons/sub/interface.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
456
457
458
459
460
461
462
463
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
|The name of the interface
|-
|Direction
|"PI" or "RI"
|-
|Kind
464
|The RCM Kind (SPORADIC|CYCLIC|PROTECTED|UNPROTECTED_OPERATION)
Maxime Perrotin's avatar
Maxime Perrotin committed
465
466
467
468
469
470
471
472
473
474
475
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
476
|&#8627; and corresponding values
Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
480
481
|-
|Param_Names
|List of parameter names
|-
|Param_Types
Maxime Perrotin's avatar
Maxime Perrotin committed
482
| &#8627; Corresponding parameter types
Maxime Perrotin's avatar
Maxime Perrotin committed
483
484
|-
|Param_Directions
Maxime Perrotin's avatar
Maxime Perrotin committed
485
| &#8627; Corresponding direction
Maxime Perrotin's avatar
Maxime Perrotin committed
486
487
|-
|Param_Encodings
Maxime Perrotin's avatar
Maxime Perrotin committed
488
| &#8627; Corresponding ASN.1 encoding
Maxime Perrotin's avatar
Maxime Perrotin committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|-
|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)
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
|-
|IF_Property_Values
|DOCUMENTATION MISSING
|-
|Remote_Languages
|DOCUMENTATION MISSING
|-
|Param_ASN1_Modules
|DOCUMENTATION MISSING
|-
|Remote_Interface_Names
|DOCUMENTATION MISSING
|-
|Remote_Function_Names
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
519
520
521
|-
|Param_Basic_Types
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
570
|}
571
=== templates/skeletons/sub/makefile.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
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
|-
|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
592
593
|-
|Has_CP
Maxime Perrotin's avatar
Maxime Perrotin committed
594
|True if context parameters are defined for this function
Maxime Perrotin's avatar
Maxime Perrotin committed
595
596
|-
|Property_Names
Maxime Perrotin's avatar
Maxime Perrotin committed
597
|Function user-defined property names (goes in pair with Property_Values)
Maxime Perrotin's avatar
Maxime Perrotin committed
598
599
|-
|Property_Values
Maxime Perrotin's avatar
Maxime Perrotin committed
600
|Function user-defined property values (goes in pair with Property_Names)
601
602
603
604
605
606
607
608
609
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
610
|}
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
=== 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
|true if file with name returned by filenode.tmplt exists
|-
|Skeletons
|from kazoo configuration
|-
|Glue
|from kazoo configuration
|-
626
|No_Stdlib_Flag
Maxime Perrotin's avatar
Maxime Perrotin committed
627
|Command line-flag --no-stdlib to avoid loading ocarina_components.aadl
628
|-
629
|Timer_Resolution
Maxime Perrotin's avatar
Maxime Perrotin committed
630
|Value of command line --timer
Maxime Perrotin's avatar
Maxime Perrotin committed
631
|-
632
|Output_Dir
Maxime Perrotin's avatar
Maxime Perrotin committed
633
|Value or command line -o to set the output folder
Maxime Perrotin's avatar
Maxime Perrotin committed
634
|-
635
|Interface_View
Maxime Perrotin's avatar
Maxime Perrotin committed
636
|Interface view filename
637
638
639
640
641
|-
|Binary_Path
|DOCUMENTATION MISSING
|-
|Check_Data_View
Maxime Perrotin's avatar
Maxime Perrotin committed
642
|Value of command line flag --check-dataview
643
644
|-
|Debug_Flag
Maxime Perrotin's avatar
Maxime Perrotin committed
645
|Value of command line flag --debug (or -g)
646
647
|-
|Use_POHIC
Maxime Perrotin's avatar
Maxime Perrotin committed
648
|Value of command line flag --polyorb-hi-c (or -p)
649
650
|-
|Other_Files
Maxime Perrotin's avatar
Maxime Perrotin committed
651
|List of AADL files passed to the command line
652
653
|-
|Deployment_View
Maxime Perrotin's avatar
Maxime Perrotin committed
654
|Deployment view filename
655
656
|-
|Data_View
Maxime Perrotin's avatar
Maxime Perrotin committed
657
|Data view filename
Maxime Perrotin's avatar
Maxime Perrotin committed
658
659
|-
|CPU_Family
Maxime Perrotin's avatar
Maxime Perrotin committed
660
|CPU Kind (e.g. leon3)
Maxime Perrotin's avatar
Maxime Perrotin committed
661
662
|-
|CPU_Platform
Maxime Perrotin's avatar
Maxime Perrotin committed
663
|AADL CPU_Platform (e.g. PLATFORM_NATIVE)
Maxime Perrotin's avatar
Maxime Perrotin committed
664
665
|-
|CPU_Name
Maxime Perrotin's avatar
Maxime Perrotin committed
666
|CPU AADL Identifier (e.g. x86_inst)
Maxime Perrotin's avatar
Maxime Perrotin committed
667
668
|-
|Target
Maxime Perrotin's avatar
Maxime Perrotin committed
669
|Value of command line flag --target=Target
Maxime Perrotin's avatar
Maxime Perrotin committed
670
671
|-
|CPU_Classifier
Maxime Perrotin's avatar
Maxime Perrotin committed
672
|AADL CPU Classifier (e.g. ocarina_processors_x86::x86.linux)
673
674
675
676
677
678
|-
|Shared_Types
|List of available component types
|-
|Shared_Lib_Dir
|Folder hosting the shared component types
Maxime Perrotin's avatar
Maxime Perrotin committed
679
680
681
|-
|Is_Distributed
|True if the system contains at least one bus
Maxime Perrotin's avatar
Maxime Perrotin committed
682
|}
683
=== templates/concurrency_view/sub/thread.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
This file is processed for every thread in every partition in every node.
{| class="wikitable"
!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
Maxime Perrotin's avatar
Maxime Perrotin committed
714
| &#8627; Associated PI Name
Maxime Perrotin's avatar
Maxime Perrotin committed
715
716
|-
|Remote_PI_Sorts
Maxime Perrotin's avatar
Maxime Perrotin committed
717
| &#8627; Optional param type of the remote thread
Maxime Perrotin's avatar
Maxime Perrotin committed
718
719
|-
|Remote_PI_Modules
Maxime Perrotin's avatar
Maxime Perrotin committed
720
| &#8627; Asn1 module of the optional param type
Maxime Perrotin's avatar
Maxime Perrotin committed
721
722
|-
|Name
723
|
Maxime Perrotin's avatar
Maxime Perrotin committed
724
725
|-
|Kind
726
|
Maxime Perrotin's avatar
Maxime Perrotin committed
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
|-
|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
|-
752
753
|Param_Directions
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
754
|-
755
756
|Is_Timer
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
757
|-
758
759
|Debug_Flag
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
760
|-
761
762
763
764
765
766
767
|Timer_Resolution
|DOCUMENTATION MISSING
|-
|Param_Encodings
|DOCUMENTATION MISSING
|-
|Interface_View
Maxime Perrotin's avatar
Maxime Perrotin committed
768
|Interface view filename
769
770
771
772
773
|-
|IF_Property_Values
|DOCUMENTATION MISSING
|-
|Language
774
|Implementation language of the function
775
776
777
778
779
780
|-
|Binary_Path
|DOCUMENTATION MISSING
|-
|Remote_Function_Names
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
781
|-
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
807
|Value of command line flag --check-dataview
808
809
|-
|Use_POHIC
Maxime Perrotin's avatar
Maxime Perrotin committed
810
|Value of command line flag --polyorb-hi-c (or -p)
811
812
|-
|Other_Files
Maxime Perrotin's avatar
Maxime Perrotin committed
813
|List of AADL files passed to the command line
814
815
|-
|Data_View
Maxime Perrotin's avatar
Maxime Perrotin committed
816
|Data view filename
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
819
820
821
|-
|Param_Basic_Types
|DOCUMENTATION MISSING
|-
|Target
Maxime Perrotin's avatar
Maxime Perrotin committed
822
|Value of command line flag --target=Target
Maxime Perrotin's avatar
Maxime Perrotin committed
823
824
825
826
827
828
829
830
831
|-
|Priority
|DOCUMENTATION MISSING
|-
|Dispatch_Offset_ms
|DOCUMENTATION MISSING
|-
|Stack_Size_In_Bytes
|DOCUMENTATION MISSING
832
833
834
835
836
837
|-
|Shared_Types
|List of available component types
|-
|Shared_Lib_Dir
|Folder hosting the shared component types
Maxime Perrotin's avatar
Maxime Perrotin committed
838
|}
839
=== templates/concurrency_view/sub/pi.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
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
|The RCM Kind
|-
|Parent_Function
|The name of the function
|-
|Param_Names
|List of parameter names
|-
|Param_Types
Maxime Perrotin's avatar
Maxime Perrotin committed
859
| &#8627; Corresponding parameter types
Maxime Perrotin's avatar
Maxime Perrotin committed
860
861
|-
|Param_Directions
Maxime Perrotin's avatar
Maxime Perrotin committed
862
| &#8627; Corresponding direction
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
|-
|Is_Timer
|DOCUMENTATION MISSING
|-
|Param_Encodings
|DOCUMENTATION MISSING
|-
|Caller_Is_Local
|DOCUMENTATION MISSING
|-
|IF_Property_Values
|DOCUMENTATION MISSING
|-
|Queue_Size
|DOCUMENTATION MISSING
|-
|Language
880
|Implementation language of the function
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
911
912
913
|-
|Param_Basic_Types
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
914
|}
915
=== templates/concurrency_view/sub/ri.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
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
|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
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
|-
|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
Maxime Perrotin's avatar
Maxime Perrotin committed
981
982
983
|-
|Param_Basic_Types
|DOCUMENTATION MISSING
Maxime Perrotin's avatar
Maxime Perrotin committed
984
|}
985
=== templates/concurrency_view/sub/block.tmplt ===
Maxime Perrotin's avatar
Maxime Perrotin committed
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
This template is evaluated for every block.
{| class="wikitable"
!Parameter name
!Description
|-
|Name
|Protected block name
|-
|Language
|Implementation language
|-
|Calling_Threads
|List of calling threads
|-
|Protected_PIs