ocarina-backends-xtratum_conf-hardware_description.adb 17 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--           OCARINA.BACKENDS.XTRATUM_CONF.HARDWARE_DESCRIPTION             --
--                                                                          --
--                                 B o d y                                  --
--                                                                          --
--            Copyright (C) 2011, European Space Agency (ESA).              --
--                                                                          --
-- Ocarina  is free software;  you  can  redistribute  it and/or  modify    --
-- it under terms of the GNU General Public License as published by the     --
-- Free Software Foundation; either version 2, or (at your option) any      --
-- later version. 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. See the GNU General --
-- Public License for more details. You should have received  a copy of the --
-- GNU General Public License distributed with Ocarina; see file COPYING.   --
-- If not, write to the Free Software Foundation, 51 Franklin Street, Fifth --
-- Floor, Boston, MA 02111-1301, USA.                                       --
--                                                                          --
-- As a special exception,  if other files  instantiate  generics from this --
-- unit, or you link  this unit with other files  to produce an executable, --
-- this  unit  does not  by itself cause  the resulting  executable to be   --
-- covered  by the  GNU  General  Public  License. This exception does not  --
-- however invalidate  any other reasons why the executable file might be   --
-- covered by the GNU Public License.                                       --
--                                                                          --
--                 Ocarina is maintained by the Ocarina team                --
--                       (ocarina-users@listes.enst.fr)                     --
--                                                                          --
------------------------------------------------------------------------------

with Namet; use Namet;
35
with Utils; use Utils;
36
37

with Ocarina.ME_AADL;
38
with Ocarina.ME_AADL.AADL_Tree.Nodes;
39
with Ocarina.ME_AADL.AADL_Tree.Entities;
40
41
42
43
with Ocarina.ME_AADL.AADL_Instances.Nodes;
with Ocarina.ME_AADL.AADL_Instances.Nutils;
with Ocarina.ME_AADL.AADL_Instances.Entities;

44
45
with Ocarina.Instances.Queries;

46
with Ocarina.Backends.Utils;
47
with Ocarina.Backends.Messages;
48
49
50
51
52
53
54
55
56
57
with Ocarina.Backends.Properties;
with Ocarina.Backends.XML_Values;
with Ocarina.Backends.XML_Tree.Nodes;
with Ocarina.Backends.XML_Tree.Nutils;

package body Ocarina.Backends.Xtratum_Conf.Hardware_Description is

   use Ocarina.ME_AADL;
   use Ocarina.ME_AADL.AADL_Instances.Nodes;
   use Ocarina.ME_AADL.AADL_Instances.Entities;
58
59
60

   use Ocarina.Instances.Queries;

61
   use Ocarina.Backends.Utils;
62
   use Ocarina.Backends.Messages;
63
64
65
66
   use Ocarina.Backends.Properties;
   use Ocarina.Backends.XML_Values;
   use Ocarina.Backends.XML_Tree.Nutils;

67
   package ATN renames Ocarina.ME_AADL.AADL_Tree.Nodes;
68
   package ATE renames Ocarina.ME_AADL.AADL_Tree.Entities;
69
70
71
72
73
74
75
76
   package AINU renames Ocarina.ME_AADL.AADL_Instances.Nutils;
   package XTN renames Ocarina.Backends.XML_Tree.Nodes;
   package XV  renames Ocarina.Backends.XML_Values;

   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);
77
   procedure Visit_Memory_Instance (E : Node_Id);
78
79
80
   procedure Visit_Processor_Instance (E : Node_Id);
   procedure Visit_Virtual_Processor_Instance (E : Node_Id);

81
   Processor_Identifier : Unsigned_Long_Long := 0;
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

   -----------
   -- 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
      Category : constant Component_Category
        := Get_Category_Of_Component (E);
   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);

128
129
130
         when CC_Memory =>
            Visit_Memory_Instance (E);

131
132
133
134
135
136
137
138
139
140
141
142
143
         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
144
      pragma Unreferenced (E);
145
   begin
146
      null;
147
148
149
150
151
152
153
   end Visit_Process_Instance;

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

   procedure Visit_System_Instance (E : Node_Id) is
154
155
156
      S              : Node_Id;
      Hw_Desc_Node   : Node_Id;
      Processor_Node : Node_Id;
157
      Memory_Node    : Node_Id;
158
      Device_Node    : Node_Id;
159
160
      U              : Node_Id;
      R              : Node_Id;
161
162
163
164
165
166
167
168
169
170
171
   begin
      U := XTN.Unit (Backend_Node (Identifier (E)));
      R := XTN.Node (Backend_Node (Identifier (E)));

      Current_XML_Node := XTN.Root_Node (XTN.XML_File (U));

      Push_Entity (U);
      Push_Entity (R);

      Hw_Desc_Node := Make_XML_Node ("HwDescription");

172
173
174
175
176
177
178
179
180
181
      Append_Node_To_List (Hw_Desc_Node,
                           XTN.Subitems (Current_XML_Node));

      Processor_Node := Make_XML_Node ("ProcessorTable");

      Append_Node_To_List (Processor_Node,
                           XTN.Subitems (Hw_Desc_Node));

      Current_XML_Node := Processor_Node;

182
183
184
      --  First, create the <ProcessorTable> section of the hardware
      --  description of the system.

185
186
187
188
189
190
191
192
193
194
195
      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
         --  Visit the component instance corresponding to the
         --  subcomponent S.
            if AINU.Is_Processor (Corresponding_Instance (S)) then
               Visit (Corresponding_Instance (S));
            end if;
            S := Next_Node (S);
         end loop;
      end if;
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

      --  Then, create the <MemoryLayout> section of the hardware
      --  description of the system.

      Memory_Node := Make_XML_Node ("MemoryLayout");

      Append_Node_To_List (Memory_Node,
                           XTN.Subitems (Hw_Desc_Node));

      Current_XML_Node := Memory_Node;

      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
         --  Visit the component instance corresponding to the
         --  subcomponent S.
            if AINU.Is_Memory (Corresponding_Instance (S)) then
               Visit (Corresponding_Instance (S));
            end if;
            S := Next_Node (S);
         end loop;
      end if;

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
244
245
246
247
248
249
250
251
252
253
254
255
256
      Device_Node := Make_XML_Node ("Devices");

      --  Automatically add an UART device for debugging purposes.
      declare
         Uart_Node : Node_Id;
         P         : Node_Id;
         Q         : Node_Id;
      begin
         Uart_Node := Make_XML_Node ("Uart");

         Set_Str_To_Name_Buffer ("id");
         P := Make_Defining_Identifier (Name_Find);
         Set_Str_To_Name_Buffer ("0");
         Q := Make_Defining_Identifier (Name_Find);
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Uart_Node));

         Set_Str_To_Name_Buffer ("baudRate");
         P := Make_Defining_Identifier (Name_Find);
         Set_Str_To_Name_Buffer ("115200");
         Q := Make_Defining_Identifier (Name_Find);
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Uart_Node));

         Set_Str_To_Name_Buffer ("name");
         P := Make_Defining_Identifier (Name_Find);
         Set_Str_To_Name_Buffer ("Uart");
         Q := Make_Defining_Identifier (Name_Find);
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Uart_Node));

         Append_Node_To_List (Uart_Node,
                              XTN.Subitems (Device_Node));
      end;

      Append_Node_To_List (Device_Node,
                           XTN.Subitems (Hw_Desc_Node));

257
258
259
260
261
262
263
264
265
      Pop_Entity;
      Pop_Entity;
   end Visit_System_Instance;

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

   procedure Visit_Processor_Instance (E : Node_Id) is
266
267
268
269
270
271
272
273
      S                 : Node_Id;
      P                 : Node_Id;
      Q                 : Node_Id;
      Processor_Node    : Node_Id;
      Plan_Table_Node   : Node_Id;
      Plan_Node         : Node_Id;
      Start_Time        : Unsigned_Long_Long := 0;
      Slot_Node         : Node_Id;
274
      Partition         : Node_Id;
275
276
277
278
279
      Slot_Identifier   : Unsigned_Long_Long := 0;
      Slots             : constant Time_Array
                           := Get_POK_Slots (E);
      Slots_Allocation  : constant List_Id
                           := Get_POK_Slots_Allocation (E);
280
   begin
281
282
283
284
285
      if Slots_Allocation = No_List then
         Display_Error
           ("You must provide the slots allocation for each processor",
            Fatal => True);
      end if;
286

287
288
289
290
      --  First, add a <Processor> node
      Processor_Node := Make_XML_Node ("Processor");

      Set_Str_To_Name_Buffer ("id");
291
292
      P := Make_Defining_Identifier (Name_Find);
      Q := Make_Literal
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
         (XV.New_Numeric_Value (Processor_Identifier, 0, 10));

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

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

      Set_Str_To_Name_Buffer ("50Mhz");
      Q := Make_Defining_Identifier (Name_Find);

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

      --  Within the <processor/> node, add a <CyclicPlanTable/>
      --  node.
      Plan_Table_Node := Make_XML_Node ("CyclicPlanTable");
      Append_Node_To_List (Plan_Table_Node, XTN.Subitems (Processor_Node));

      --  Then, describe the scheduling plan for this node.
      --  At this time, we support only one plan for each processor.
      Plan_Node := Make_XML_Node ("Plan");
      Append_Node_To_List (Plan_Node, XTN.Subitems (Plan_Table_Node));

      Set_Str_To_Name_Buffer ("id");
      P := Make_Defining_Identifier (Name_Find);
      Q := Make_Literal (XV.New_Numeric_Value (0, 0, 10));
320
321

      Append_Node_To_List
322
323
324
325
326
327
328
329
330
         (Make_Assignement (P, Q), XTN.Items (Plan_Node));

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

      Set_Str_To_Name_Buffer
         (Unsigned_Long_Long'Image
            (To_Milliseconds (Get_POK_Major_Frame (E))));
      Add_Str_To_Name_Buffer ("ms");
331
      Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
332
333
334
335
336
337
338
339
340

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

      --  For each time slot for a partition, we declare
      --  it in the scheduling plan.
      S := ATN.First_Node (Slots_Allocation);
      for I in Slots'Range loop

341
342
         Partition := ATE.Get_Referenced_Entity (S);

343
344
345
346
347
348
349
350
351
352
         --  Create the node that corresponds to the slot.

         Slot_Node := Make_XML_Node ("Slot");

         --  Associate a fixed identifier to the slot.

         Set_Str_To_Name_Buffer ("id");
         P := Make_Defining_Identifier (Name_Find);
         Q := Make_Literal (XV.New_Numeric_Value (Slot_Identifier, 0, 10));

353
354
355
356
357
358
359
360
361
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Slot_Node));

         --  Associate a fixed identifier to the slot.

         Set_Str_To_Name_Buffer ("partitionId");
         P := Make_Defining_Identifier (Name_Find);
         Q := Copy_Node (Backend_Node (Identifier (Partition)));

362
363
364
365
366
367
368
369
370
371
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Slot_Node));

         --  Define the duration attribute of the <slot/> element.
         Set_Str_To_Name_Buffer ("duration");
         P := Make_Defining_Identifier (Name_Find);
         Set_Str_To_Name_Buffer
            (Unsigned_Long_Long'Image
               (To_Milliseconds (Slots (I))));
         Add_Str_To_Name_Buffer ("ms");
372
         Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
373
374
375
376
377
378
379
380
381
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Slot_Node));

         --  Define the start attribute of the <slot/> element.
         Set_Str_To_Name_Buffer ("start");
         P := Make_Defining_Identifier (Name_Find);
         Set_Str_To_Name_Buffer
            (Unsigned_Long_Long'Image (Start_Time));
         Add_Str_To_Name_Buffer ("ms");
382
         Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
383
384
385
386
387
388
389
390
391
392
393
         Append_Node_To_List
            (Make_Assignement (P, Q), XTN.Items (Slot_Node));

         Append_Node_To_List (Slot_Node, XTN.Subitems (Plan_Node));

         Slot_Identifier := Slot_Identifier + 1;

         Start_Time := Start_Time + To_Milliseconds (Slots (I));

         S := ATN.Next_Node (S);
      end loop;
394
395
396
397
398
399
400
401
402
403
404

      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
         --  Visit the component instance corresponding to the
         --  subcomponent S.

            Visit (Corresponding_Instance (S));
            S := Next_Node (S);
         end loop;
      end if;
405
406
407
408

      Processor_Identifier := Processor_Identifier + 1;

      Append_Node_To_List (Processor_Node, XTN.Subitems (Current_XML_Node));
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
   end Visit_Processor_Instance;

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

   procedure Visit_Virtual_Processor_Instance (E : Node_Id) is
      S           : Node_Id;
   begin
      if not AINU.Is_Empty (Subcomponents (E)) then
         S := First_Node (Subcomponents (E));
         while Present (S) loop
         --  Visit the component instance corresponding to the
         --  subcomponent S.

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

430
431
432
433
434
   ---------------------------
   -- Visit_Memory_Instance --
   ---------------------------

   procedure Visit_Memory_Instance (E : Node_Id) is
435
436
437
438
439
      P                    : Node_Id;
      Q                    : Node_Id;
      Memory_Node          : Node_Id;
      Base_Address_Value   : Unsigned_Long_Long;
      Byte_Count_Value     : Unsigned_Long_Long;
440
441
442
443
   begin
      Memory_Node := Make_XML_Node ("Region");

      --  Add the start attribute of the region node.
444
      Base_Address_Value := Get_Integer_Property (E, "base_address");
445
446
447
448
449
450
451
452
453
454
455
      Byte_Count_Value := Get_Integer_Property (E, "byte_count");

      if Base_Address_Value = 0 or else Byte_Count_Value = 0 then
         Display_Located_Error
            (Loc (E),
             "Memory does not specify the byte_count " &
             "or base_address properties",
             Fatal => False);
         return;
      end if;

456
457
      Set_Str_To_Name_Buffer ("start");
      P := Make_Defining_Identifier (Name_Find);
458
459
460
461
462
      Set_Str_To_Name_Buffer ("0x");
      Add_Str_To_Name_Buffer
         (Unsigned_Long_Long'Image (Base_Address_Value));

      Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
463
464
465
466
467
468
469

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

      --  Add the size attribute of the region node.
      Set_Str_To_Name_Buffer ("size");
      P := Make_Defining_Identifier (Name_Find);
470
471
472
473
      Set_Str_To_Name_Buffer
         (Unsigned_Long_Long'Image (Byte_Count_Value));
      Add_Str_To_Name_Buffer ("B");
      Q := Make_Defining_Identifier (Remove_Char (Name_Find, ' '));
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489

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

      --  Add the type attribute of the region node.
      Set_Str_To_Name_Buffer ("type");
      P := Make_Defining_Identifier (Name_Find);
      Set_Str_To_Name_Buffer ("stram");
      Q := Make_Defining_Identifier (Name_Find);

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

      Append_Node_To_List (Memory_Node, XTN.Subitems (Current_XML_Node));
   end Visit_Memory_Instance;

490
end Ocarina.Backends.Xtratum_Conf.Hardware_Description;