ocarina-backends-xtratum_conf-partition_table.adb 17.5 KB
Newer Older
1
2
3
4
5
6
7
8
------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--              OCARINA.BACKENDS.XTRATUM_CONF.PARTITION_TABLE               --
--                                                                          --
--                                 B o d y                                  --
--                                                                          --
9
--                   Copyright (C) 2011-2016 ESA & ISAE.                    --
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
--                                                                          --
-- Ocarina  is free software; you can redistribute it and/or modify under   --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion. Ocarina is distributed in the hope that it will be useful, but     --
-- WITHOUT ANY WARRANTY; without even the implied warranty of               --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
26
--                                                                          --
jhugues's avatar
jhugues committed
27
28
--                 Ocarina is maintained by the TASTE project               --
--                      (taste-users@lists.tuxfamily.org)                   --
29
30
31
--                                                                          --
------------------------------------------------------------------------------

32
with Ocarina.Namet; use Ocarina.Namet;
yoogx's avatar
yoogx committed
33
with Utils;         use Utils;
34
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

with Ocarina.ME_AADL;
with Ocarina.ME_AADL.AADL_Tree.Nodes;
with Ocarina.ME_AADL.AADL_Tree.Entities;
with Ocarina.ME_AADL.AADL_Instances.Nodes;
with Ocarina.ME_AADL.AADL_Instances.Nutils;
with Ocarina.ME_AADL.AADL_Instances.Entities;

with Ocarina.Backends.Utils;
with Ocarina.Instances.Queries;

with Ocarina.Backends.Messages;
with Ocarina.Backends.Properties;
with Ocarina.Backends.XML_Tree.Nodes;
with Ocarina.Backends.XML_Tree.Nutils;

package body Ocarina.Backends.Xtratum_Conf.Partition_Table is

   use Ocarina.ME_AADL;
   use Ocarina.ME_AADL.AADL_Instances.Nodes;
   use Ocarina.ME_AADL.AADL_Instances.Entities;

   use Ocarina.Instances.Queries;

   use Ocarina.Backends.Utils;
   use Ocarina.Backends.Messages;
   use Ocarina.Backends.Properties;
   use Ocarina.Backends.XML_Tree.Nutils;

   package ATN renames Ocarina.ME_AADL.AADL_Tree.Nodes;
   package ATE renames Ocarina.ME_AADL.AADL_Tree.Entities;
   package AIN renames Ocarina.ME_AADL.AADL_Instances.Nodes;
   package AINU renames Ocarina.ME_AADL.AADL_Instances.Nutils;
   package XTN renames Ocarina.Backends.XML_Tree.Nodes;

   procedure Visit_Architecture_Instance (E : Node_Id);
   procedure Visit_Component_Instance (E : Node_Id);
   procedure Visit_System_Instance (E : Node_Id);
   procedure Visit_Process_Instance (E : Node_Id);
   procedure Visit_Memory_Instance (E : Node_Id);
   procedure Visit_Processor_Instance (E : Node_Id);
   procedure Visit_Virtual_Processor_Instance (E : Node_Id);

77
78
   Current_System : Node_Id := No_Node;

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
   -----------
   -- Visit --
   -----------

   procedure Visit (E : Node_Id) is
   begin
      case Kind (E) is
         when K_Architecture_Instance =>
            Visit_Architecture_Instance (E);

         when K_Component_Instance =>
            Visit_Component_Instance (E);

         when others =>
            null;
      end case;
   end Visit;

   ---------------------------------
   -- Visit_Architecture_Instance --
   ---------------------------------

   procedure Visit_Architecture_Instance (E : Node_Id) is
   begin
      Visit (Root_System (E));
   end Visit_Architecture_Instance;

   ------------------------------
   -- Visit_Component_Instance --
   ------------------------------

   procedure Visit_Component_Instance (E : Node_Id) is
111
      Category : constant Component_Category := Get_Category_Of_Component (E);
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
   begin
      case Category is
         when CC_System =>
            Visit_System_Instance (E);

         when CC_Process =>
            Visit_Process_Instance (E);

         when CC_Processor =>
            Visit_Processor_Instance (E);

         when CC_Memory =>
            Visit_Memory_Instance (E);

         when CC_Virtual_Processor =>
            Visit_Virtual_Processor_Instance (E);

         when others =>
            null;
      end case;
   end Visit_Component_Instance;

   ----------------------------
   -- Visit_Process_Instance --
   ----------------------------

   procedure Visit_Process_Instance (E : Node_Id) is
      Partition_Node       : Node_Id;
140
141
      Base_Address_Value   : Unsigned_Long_Long;
      Byte_Count_Value     : Unsigned_Long_Long;
142
143
144
145
146
      Associated_Processor : Node_Id;
      Associated_Module    : Node_Id;
      Associated_Memory    : Node_Id;
      Physical_Areas_Node  : Node_Id;
      Temporal_Req_Node    : Node_Id;
147
148
      Port_Table_Node      : Node_Id;
      Port_Node            : Node_Id;
149
150
151
152
      Area_Node            : Node_Id;
      P                    : Node_Id;
      Q                    : Node_Id;
      S                    : Node_Id;
153
      F                    : Node_Id;
154
155
   begin
      Associated_Processor := Get_Bound_Processor (E);
156
157
158
      Associated_Memory    := Get_Bound_Memory (E);
      Associated_Module    :=
        Parent_Component (Parent_Subcomponent (Associated_Processor));
159
160
161
162
163
164

      --  Some checks on the model in order to make sure that
      --  everything is correctly defined.

      if Associated_Processor = No_Node then
         Display_Located_Error
165
166
167
           (AIN.Loc (E),
            "A partition has to be associated with one virtual processor.",
            Fatal => True);
168
169
170
171
      end if;

      if Associated_Memory = No_Node then
         Display_Located_Error
172
173
174
           (AIN.Loc (E),
            "A partition has to be associated with one memory.",
            Fatal => True);
175
176
177
178
      end if;

      if Associated_Module = No_Node then
         Display_Located_Error
179
180
181
           (AIN.Loc (E),
            "Unable to retrieve the module that executes this partition.",
            Fatal => True);
182
183
184
185
186
187
188
      end if;

      --  Create the main partition node that defines all partition
      --  requirements.

      Partition_Node := Make_XML_Node ("Partition");

189
190
      --  a) id of the partition

191
      Set_Str_To_Name_Buffer ("id");
192
193
194
      P := Make_Defining_Identifier (Name_Find);
      Q := Copy_Node (Backend_Node (Identifier (Associated_Processor)));
      Append_Node_To_List
195
196
        (Make_Assignement (P, Q),
         XTN.Items (Partition_Node));
197

198
199
      --  b) name of the partition

200
201
202
      Set_Str_To_Name_Buffer ("name");
      P := Make_Defining_Identifier (Name_Find);
      Get_Name_String
203
        (To_Lower (Display_Name (Identifier (Parent_Subcomponent (E)))));
204
205
      Q := Make_Defining_Identifier (Name_Find);
      Append_Node_To_List
206
207
        (Make_Assignement (P, Q),
         XTN.Items (Partition_Node));
208

209
210
211
212
      --  c) hard-coded configuration parameters, part 1

      Set_Str_To_Name_Buffer ("flags");
      P := Make_Defining_Identifier (Name_Find);
213
      Set_Str_To_Name_Buffer ("system fp");
214
215
216
217
218
219
220
      Q := Make_Defining_Identifier (Name_Find);
      Append_Node_To_List
        (Make_Assignement (P, Q),
         XTN.Items (Partition_Node));

      --  d) hard-coded configuration parameters, part 2

221
222
223
224
225
      Set_Str_To_Name_Buffer ("console");
      P := Make_Defining_Identifier (Name_Find);
      Set_Str_To_Name_Buffer ("Uart");
      Q := Make_Defining_Identifier (Name_Find);
      Append_Node_To_List
226
227
        (Make_Assignement (P, Q),
         XTN.Items (Partition_Node));
228
229
230
231
232
233

      --  Create the PhysicalAreasNode associated with the partition.
      --  It maps the requirements of the memory component associated
      --  with the partition.
      Physical_Areas_Node := Make_XML_Node ("PhysicalMemoryAreas");

234
      Append_Node_To_List (Physical_Areas_Node, XTN.Subitems (Partition_Node));
235
236
237

      Area_Node := Make_XML_Node ("Area");

238
      Base_Address_Value :=
239
        Get_Integer_Property (Associated_Memory, "base_address");
240
      Byte_Count_Value :=
241
        Get_Integer_Property (Associated_Memory, "byte_count");
242
243
      Set_Str_To_Name_Buffer ("start");
      P := Make_Defining_Identifier (Name_Find);
244
      Set_Str_To_Name_Buffer ("0x");
245
      Add_ULL_To_Name_Buffer (Base_Address_Value, 16);
246
247

      Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
248

249
      Append_Node_To_List (Make_Assignement (P, Q), XTN.Items (Area_Node));
250
251

      Set_Str_To_Name_Buffer ("size");
252
      P                := Make_Defining_Identifier (Name_Find);
253
      Byte_Count_Value := Byte_Count_Value / 1024;
254
      Set_Str_To_Name_Buffer (Unsigned_Long_Long'Image (Byte_Count_Value));
255
      Add_Str_To_Name_Buffer ("KB");
256
      Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
257

258
      Append_Node_To_List (Make_Assignement (P, Q), XTN.Items (Area_Node));
259

260
      Append_Node_To_List (Area_Node, XTN.Subitems (Physical_Areas_Node));
261
262
263
264
265
266
267
268

      --  Create the TemporalRequirements node associated with the partition.
      --  It maps the requirements of the virtual processor component
      --  associated with the partition.

      Temporal_Req_Node := Make_XML_Node ("TemporalRequirements");

      declare
269
270
         Slots : constant Time_Array := Get_POK_Slots (Associated_Module);
         Slots_Allocation : constant List_Id    :=
271
            Get_POK_Slots_Allocation (Associated_Module);
272
273
         Duration    : Unsigned_Long_Long          := 0;
         Major_Frame : constant Unsigned_Long_Long :=
274
            To_Milliseconds (Get_POK_Major_Frame (Associated_Module));
275
         Part : Node_Id;
276
      begin
277
278
279
280
281
282
283
284
285
286
287
288
289
         if Present (Slots_Allocation) then
            --   XXX this code must be adjusted, the property
            --   Slots_Allocation has been deprecated by AADL, and the
            --   TemporalRequirements node in XtratuM is reserved for
            --   future usage.

            S := ATN.First_Node (Slots_Allocation);
            for J in Slots'Range loop
               Part := ATE.Get_Referenced_Entity (S);

               if Part = Associated_Processor then
                  Duration := Duration + To_Milliseconds (Slots (J));
               end if;
290

291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
               S := ATN.Next_Node (S);
            end loop;
            Set_Str_To_Name_Buffer ("duration");
            P := Make_Defining_Identifier (Name_Find);
            Set_Str_To_Name_Buffer (Unsigned_Long_Long'Image (Duration));
            Add_Str_To_Name_Buffer ("ms");
            Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));

            Append_Node_To_List
              (Make_Assignement (P, Q),
               XTN.Items (Temporal_Req_Node));

            Set_Str_To_Name_Buffer ("period");
            P := Make_Defining_Identifier (Name_Find);
            Set_Str_To_Name_Buffer (Unsigned_Long_Long'Image (Major_Frame));
            Add_Str_To_Name_Buffer ("ms");
            Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));

            Append_Node_To_List
              (Make_Assignement (P, Q),
               XTN.Items (Temporal_Req_Node));
312
313
314

            Append_Node_To_List
              (Temporal_Req_Node, XTN.Subitems (Partition_Node));
315
         end if;
316
317
      end;

318
      --  Now, handle the ports of the partition.
319

320
321
322
323
324
325
326
      if Has_Ports (E) then
         Port_Table_Node := Make_XML_Node ("PortTable");

         F := First_Node (Features (E));
         while Present (F) loop
            if Kind (F) = K_Port_Spec_Instance then

327
328
               --  XXX move out as REAL checks

329
330
               if not Is_Data (F) then
                  Display_Located_Error
331
332
333
                    (AIN.Loc (F),
                     "Pure events ports are not allowed.",
                     Fatal => True);
334
335
336
337
               end if;

               if Is_In (F) and then Is_Out (F) then
                  Display_Located_Error
338
339
340
                    (AIN.Loc (F),
                     "in/out ports are not allowed.",
                     Fatal => True);
341
342
343
344
345
346
347
348
349
350
               end if;

               Port_Node := Make_XML_Node ("Port");

               Set_Str_To_Name_Buffer ("type");
               P := Make_Defining_Identifier (Name_Find);

               if Is_Data (F) and then not Is_Event (F) then
                  Set_Str_To_Name_Buffer ("sampling");
               else
351
                  Set_Str_To_Name_Buffer ("queuing");
352
353
354
355
               end if;

               Q := Make_Defining_Identifier (Name_Find);
               Append_Node_To_List
356
357
                 (Make_Assignement (P, Q),
                  XTN.Items (Port_Node));
358
359
360
361
362
363
364
365
366
367
368
369

               Set_Str_To_Name_Buffer ("direction");
               P := Make_Defining_Identifier (Name_Find);

               if Is_In (F) then
                  Set_Str_To_Name_Buffer ("destination");
               else
                  Set_Str_To_Name_Buffer ("source");
               end if;

               Q := Make_Defining_Identifier (Name_Find);
               Append_Node_To_List
370
371
                 (Make_Assignement (P, Q),
                  XTN.Items (Port_Node));
372

373
374
375
376
377
378
379
380
381
               Set_Str_To_Name_Buffer ("name");
               P := Make_Defining_Identifier (Name_Find);

               Get_Name_String (Display_Name (Identifier (F)));
               Q := Make_Defining_Identifier (To_Lower (Name_Find));
               Append_Node_To_List
                 (Make_Assignement (P, Q),
                  XTN.Items (Port_Node));

382
               Append_Node_To_List (Port_Node, XTN.Subitems (Port_Table_Node));
383
384
385
386
387
388
389
            end if;
            F := Next_Node (F);
         end loop;

         Append_Node_To_List (Port_Table_Node, XTN.Subitems (Partition_Node));
      end if;

390
      Append_Node_To_List (Partition_Node, XTN.Subitems (Current_XML_Node));
391
392
393
394
395
396
397
   end Visit_Process_Instance;

   ---------------------------
   -- Visit_System_Instance --
   ---------------------------

   procedure Visit_System_Instance (E : Node_Id) is
398
399
400
      S : Node_Id;
      U : Node_Id;
      R : Node_Id;
401
402
403
404
   begin
      U := XTN.Unit (Backend_Node (Identifier (E)));
      R := XTN.Node (Backend_Node (Identifier (E)));

405
406
      Current_System := E;

407
408
409
410
411
412
413
414
      Current_XML_Node := XTN.Root_Node (XTN.XML_File (U));

      Push_Entity (U);
      Push_Entity (R);

      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
415
416
            --  Visit the component instance corresponding to the
            --  subcomponent S.
417
418
419
            if AINU.Is_Processor (Corresponding_Instance (S)) then
               Visit (Corresponding_Instance (S));
            end if;
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
            S := Next_Node (S);
         end loop;
      end if;

      Pop_Entity;
      Pop_Entity;
   end Visit_System_Instance;

   ------------------------------
   -- Visit_Processor_Instance --
   ------------------------------

   procedure Visit_Processor_Instance (E : Node_Id) is
      S                    : Node_Id;
      Partition_Table_Node : Node_Id;
   begin
      --  Create the main PartitionTable node.

      Partition_Table_Node := Make_XML_Node ("PartitionTable");

440
441
442
      Append_Node_To_List
        (Partition_Table_Node,
         XTN.Subitems (Current_XML_Node));
443

444
445
446
447
448
      Current_XML_Node := Partition_Table_Node;

      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
449
450
            --  Visit the component instance corresponding to the
            --  subcomponent S.
451
452
453
454
455

            Visit (Corresponding_Instance (S));
            S := Next_Node (S);
         end loop;
      end if;
456

457
458
459
460
461
462
463
   end Visit_Processor_Instance;

   --------------------------------------
   -- Visit_Virtual_Processor_Instance --
   --------------------------------------

   procedure Visit_Virtual_Processor_Instance (E : Node_Id) is
464
      S : Node_Id;
465
   begin
466
467
468
      if not AINU.Is_Empty (Subcomponents (Current_System)) then
         S := First_Node (Subcomponents (Current_System));
         while Present (S) loop
469
470
471
472
473
            --  Visit the component instance corresponding to the
            --  subcomponent S.
            if AINU.Is_Process (Corresponding_Instance (S))
              and then Get_Bound_Processor (Corresponding_Instance (S)) = E
            then
474
475
476
477
478
479
               Visit (Corresponding_Instance (S));
            end if;
            S := Next_Node (S);
         end loop;
      end if;

480
481
482
      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
483
484
            --  Visit the component instance corresponding to the
            --  subcomponent S.
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502

            Visit (Corresponding_Instance (S));
            S := Next_Node (S);
         end loop;
      end if;
   end Visit_Virtual_Processor_Instance;

   ---------------------------
   -- Visit_Memory_Instance --
   ---------------------------

   procedure Visit_Memory_Instance (E : Node_Id) is
      pragma Unreferenced (E);
   begin
      null;
   end Visit_Memory_Instance;

end Ocarina.Backends.Xtratum_Conf.Partition_Table;