ocarina-backends-asn1-deployment.adb 13.4 KB
Newer Older
1
2
3
4
5
6
7
8
------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--     O C A R I N A . B A C K E N D S . A S N 1 . D E P L O Y M E N T      --
--                                                                          --
--                                 B o d y                                  --
--                                                                          --
9
--            Copyright (C) 2010, European Space Agency (ESA).              --
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
--                                                                          --
-- 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)                     --
--                                                                          --
------------------------------------------------------------------------------

julien.delange's avatar
julien.delange committed
34
with Namet; use Namet;
35
with Utils; use Utils;
36
37
38
39
40
with Ocarina.ME_AADL;
with Ocarina.ME_AADL.AADL_Instances.Nodes;
with Ocarina.ME_AADL.AADL_Instances.Nutils;
with Ocarina.ME_AADL.AADL_Instances.Entities;

41
with Ocarina.Backends.Utils;
julien.delange's avatar
julien.delange committed
42
with Ocarina.Backends.ASN1_Tree.Nutils;
43
with Ocarina.Backends.ASN1_Tree.Nodes;
julien.delange's avatar
julien.delange committed
44

45
46
47
48
49
50
package body Ocarina.Backends.ASN1.Deployment is

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

51
   use Ocarina.Backends.Utils;
julien.delange's avatar
julien.delange committed
52
53
   use Ocarina.Backends.ASN1_Tree.Nutils;

54
   package ASN1N renames Ocarina.Backends.ASN1_Tree.Nodes;
55
   package ASN1U renames Ocarina.Backends.ASN1_Tree.Nutils;
56
57
58
59
60
61
62
63
64
65
   package AAU renames Ocarina.ME_AADL.AADL_Instances.Nutils;

   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_Device_Instance (E : Node_Id);
   procedure Visit_Thread_Instance (E : Node_Id);
   procedure Visit_Subprogram_Instance (E : Node_Id);

66
   Thread_Enumeration : List_Id;
julien.delange's avatar
julien.delange committed
67
68
69
70
   --   The Thread_Enumeration list contains the identifiers
   --   and the associated identifier value for each thread
   --   within the distributed system.

71
   Thread_Id : Unsigned_Long_Long := 0;
julien.delange's avatar
julien.delange committed
72
73
74
   --  The thread identifier, unique for each thread in the
   --  DISTRIBUTED system.

75
   Port_Enumeration : List_Id;
julien.delange's avatar
julien.delange committed
76
77
78
79
   --  The Port_Enumeration list contains the enumeration of all
   --  ports used in the distributed system. In fact, we add each
   --  port in an enumeration and associate a value to them.

80
81
82
83
84
85
   Packet_Type : Node_Id;
   --  The Packet_Type node contains the definition of a packet
   --  sent by a node. It consists of a sender-thread/port id, the
   --  receiver thread/port id, and a message that is expressed
   --  using an ASN1 CHOICE.

86
   Port_Id : Unsigned_Long_Long := 0;
julien.delange's avatar
julien.delange committed
87
88
   --  The port identifier. This is unique for each port.

89
90
   Msg_Choices : List_Id;

91
92
   Module_Node : Node_Id;

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
   -----------
   -- 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
julien.delange's avatar
julien.delange committed
117
118
119
      ASN1_Root := Make_ASN1_File
         (Make_Defining_Identifier
            (Get_String_Name ("deployment")));
120
121
      ASN1N.Set_Name
         (ASN1N.Module_Node (ASN1_Root),
122
123
124
         Get_String_Name ("POHIC-DEPLOYMENT"));
      Module_Node := ASN1N.Module_Node (ASN1_Root);

125
126
127
      Thread_Enumeration   := New_List (ASN1N.K_Enumerated_Value_List);
      Port_Enumeration     := New_List (ASN1N.K_Enumerated_Value_List);
      Msg_Choices          := New_List (ASN1N.K_Enumerated_Value_List);
128

129
      Visit (Root_System (E));
130
131
132
133

      if Length (Thread_Enumeration) > 0 then
         Append_Node_To_List
         (Make_Type_Definition
134
            (Get_String_Name ("THREAD-ID"),
135
136
137
138
139
140
141
            Make_Enumerated (Thread_Enumeration)),
         ASN1N.Definitions (Module_Node));
      end if;

      if Length (Thread_Enumeration) > 0 then
         Append_Node_To_List
         (Make_Type_Definition
142
            (Get_String_Name ("PORT-ID"),
143
144
145
146
            Make_Enumerated (Port_Enumeration)),
         ASN1N.Definitions (Module_Node));
      end if;

147
148
149
150
151
152
      declare
         Pkt_Contents : constant List_Id := ASN1U.New_List (ASN1N.K_List_Id);
      begin
         Append_Node_To_List
            (Make_Sequence_Member
               (Get_String_Name ("sender-thread"),
153
154
               Make_Defining_Identifier
                (Get_String_Name ("THREAD-ID"))),
155
156
157
158
159
             Pkt_Contents);

         Append_Node_To_List
            (Make_Sequence_Member
               (Get_String_Name ("sender-port"),
160
161
                Make_Defining_Identifier
                  (Get_String_Name ("PORT-ID"))),
162
163
164
165
166
             Pkt_Contents);

         Append_Node_To_List
            (Make_Sequence_Member
               (Get_String_Name ("receiver-thread"),
167
168
                Make_Defining_Identifier
                  (Get_String_Name ("THREAD-ID"))),
169
170
171
172
173
             Pkt_Contents);

         Append_Node_To_List
            (Make_Sequence_Member
               (Get_String_Name ("receiver-port"),
174
175
176
177
178
179
180
181
                Make_Defining_Identifier
                  (Get_String_Name ("PORT-ID"))),
             Pkt_Contents);

         Append_Node_To_List
            (Make_Sequence_Member
               (Get_String_Name ("msg"),
               Make_Choice (Msg_Choices)),
182
183
184
185
186
187
188
189
190
191
             Pkt_Contents);

         Packet_Type :=
            Make_Type_Definition
               (Get_String_Name ("PKT"),
               Make_Sequence (Pkt_Contents));
         Append_Node_To_List
            (Packet_Type, ASN1N.Definitions (Module_Node));
      end;

192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
   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_Thread =>
            Visit_Thread_Instance (E);

         when CC_Device =>
            Visit_Device_Instance (E);

         when CC_Subprogram =>
            Visit_Subprogram_Instance (E);

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

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

   procedure Visit_Process_Instance (E : Node_Id) is
      S               : Node_Id;
   begin
      if not AAU.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_Process_Instance;

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

   procedure Visit_System_Instance (E : Node_Id) is
      S : Node_Id;
   begin
      --  Visit all the subcomponents of the system

      if not AAU.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_System_Instance;

   ---------------------------
   -- Visit_Thread_Instance --
   ---------------------------

   procedure Visit_Thread_Instance (E : Node_Id) is
julien.delange's avatar
julien.delange committed
268
269
270
271
272
273
274
275
      S              : Node_Id;
      F              : Node_Id;
      Call_Seq       : Node_Id;
      Spg_Call       : Node_Id;
      Thread_Name    : Name_Id;
      Port_Name      : Name_Id;
      Parent_Name    : Name_Id;
      --  Name of the containing process.
276
   begin
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

      Set_Str_To_Name_Buffer ("thread-");
      Parent_Name := Display_Name
         (Identifier
          (Parent_Subcomponent
           (Parent_Component
            (Parent_Subcomponent (E)))));
      Get_Name_String_And_Append (Parent_Name);
      Add_Str_To_Name_Buffer ("-");
      Get_Name_String_And_Append
         (Display_Name
           (Identifier
            (Parent_Subcomponent (E))));
      Thread_Name := Name_Find;

      Thread_Name := To_Upper (Thread_Name);

julien.delange's avatar
julien.delange committed
294
295
296
297
      Thread_Name := Replace_Char (Thread_Name, '_', '-');
      --  We replace _ by - because ASN1 does not allow
      --  character _.

298
299
300
301
302
303
304
      Append_Node_To_List
         (Make_Enumerated_Value
            (Thread_Name, Thread_Id),
         Thread_Enumeration);

      Thread_Id := Thread_Id + 1;

julien.delange's avatar
julien.delange committed
305
306
307
308
309
310
      --  Here, we build the ASN1 name of the thread and add it to the
      --  Thread_Enumeration list that contains all threads of the
      --  distributed system. When we discover a thread, we increment
      --  the thread identifier so that we have a unique identifier
      --  for each thread.

311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
      if not AAU.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;

      if not AAU.Is_Empty (Calls (E)) then
         Call_Seq := First_Node (Calls (E));

         while Present (Call_Seq) loop
            --  For each call sequence visit all the called
            --  subprograms.

            if not AAU.Is_Empty (Subprogram_Calls (Call_Seq)) then
               Spg_Call := First_Node (Subprogram_Calls (Call_Seq));

               while Present (Spg_Call) loop
                  Visit (Corresponding_Instance (Spg_Call));

                  Spg_Call := Next_Node (Spg_Call);
               end loop;
            end if;

            Call_Seq := Next_Node (Call_Seq);
         end loop;
      end if;

343
344
345
346
347
348
349
350
351
352
353
354
355
      if Has_Ports (E) then
         F := First_Node (Features (E));

         while Present (F) loop
            if Kind (F) = K_Port_Spec_Instance then
               Set_Str_To_Name_Buffer ("port-");
               Get_Name_String_And_Append (Thread_Name);
               Add_Str_To_Name_Buffer ("-");
               Get_Name_String_And_Append
                  (Display_Name (Identifier (F)));
               Port_Name := Name_Find;
               Port_Name := To_Upper (Port_Name);

356
               Port_Name := Replace_Char (Port_Name, '_', '-');
julien.delange's avatar
julien.delange committed
357
358
               --  We replace _ by - because ASN1 does not allow
               --  character _.
359

360
361
362
363
364
365
               Append_Node_To_List
               (Make_Enumerated_Value
                (Port_Name, Port_Id),
                Port_Enumeration);

               Port_Id := Port_Id + 1;
julien.delange's avatar
julien.delange committed
366
367
368
369
               --  Here, we build the port identifier (we increment it)
               --  each time a port is discovered in a thread and add
               --  it to the Port_Enumeration list that contains all
               --  port identifiers.
370
371
372
373
374

            end if;
            F := Next_Node (F);
         end loop;
      end if;
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
   end Visit_Thread_Instance;

   -------------------------------
   -- Visit_Subprogram_Instance --
   -------------------------------

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

      ---------------------------
      -- Visit_Device_Instance --
      ---------------------------

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

end Ocarina.Backends.ASN1.Deployment;