ocarina-backends-asn1-deployment.adb 14.2 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
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
--                   Copyright (C) 2010-2015 ESA & ISAE.                    --
--                                                                          --
-- 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
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;

39
with Ocarina.Backends.Utils;
40
41
with Ocarina.Backends.Properties;
with Ocarina.Backends.ASN1_Values;
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;
52
   use Ocarina.Backends.Properties;
julien.delange's avatar
julien.delange committed
53
54
   use Ocarina.Backends.ASN1_Tree.Nutils;

55
   package ASN1V renames Ocarina.Backends.ASN1_Values;
56
   package ASN1N renames Ocarina.Backends.ASN1_Tree.Nodes;
57
   package ASN1U renames Ocarina.Backends.ASN1_Tree.Nutils;
58
59
60
61
62
63
64
65
66
67
   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);

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

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

77
   Port_Enumeration : List_Id;
julien.delange's avatar
julien.delange committed
78
79
80
81
   --  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.

82
83
84
85
86
87
   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.

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

91
92
   Msg_Choices : List_Id;

93
94
   Module_Node : Node_Id;

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

127
128
129
      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);
130

131
      Visit (Root_System (E));
132
133
134

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

      if Length (Thread_Enumeration) > 0 then
         Append_Node_To_List
143
144
145
146
           (Make_Type_Definition
              (Get_String_Name ("Port-id"),
               Make_Enumerated (Port_Enumeration)),
            ASN1N.Definitions (Module_Node));
147
148
      end if;

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

         Append_Node_To_List
159
160
161
162
           (Make_Sequence_Member
              (Get_String_Name ("sender-port"),
               Make_Defining_Identifier (Get_String_Name ("Port-id"))),
            Pkt_Contents);
163
164

         Append_Node_To_List
165
166
167
168
           (Make_Sequence_Member
              (Get_String_Name ("receiver-thread"),
               Make_Defining_Identifier (Get_String_Name ("Thread-id"))),
            Pkt_Contents);
169
170

         Append_Node_To_List
171
172
173
174
           (Make_Sequence_Member
              (Get_String_Name ("receiver-port"),
               Make_Defining_Identifier (Get_String_Name ("Port-id"))),
            Pkt_Contents);
175
176

         Append_Node_To_List
177
178
           (Make_Sequence_Member
              (Get_String_Name ("msg"),
179
               Make_Choice (Msg_Choices)),
180
            Pkt_Contents);
181
182

         Packet_Type :=
183
184
185
186
           Make_Type_Definition
             (Get_String_Name ("Pkt"),
              Make_Sequence (Pkt_Contents));
         Append_Node_To_List (Packet_Type, ASN1N.Definitions (Module_Node));
187
188
      end;

189
190
191
192
193
194
195
   end Visit_Architecture_Instance;

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

   procedure Visit_Component_Instance (E : Node_Id) is
196
      Category : constant Component_Category := Get_Category_Of_Component (E);
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
   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
224
      S : Node_Id;
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
   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
264
265
266
267
268
269
270
      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;
julien.delange's avatar
julien.delange committed
271
      --  Name of the containing process.
272
273
      Msg_Choice      : Node_Id;
      Msg_Name        : Name_Id;
274
      Msg_Constraints : Node_Id;
275
   begin
276
277

      Set_Str_To_Name_Buffer ("thread-");
278
279
280
281
282
      Parent_Name :=
        Display_Name
          (Identifier
             (Parent_Subcomponent
                (Parent_Component (Parent_Subcomponent (E)))));
283
284
285
      Get_Name_String_And_Append (Parent_Name);
      Add_Str_To_Name_Buffer ("-");
      Get_Name_String_And_Append
286
        (Display_Name (Identifier (Parent_Subcomponent (E))));
287
288
      Thread_Name := Name_Find;

289
      Thread_Name := To_Lower (Thread_Name);
290

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

295
      Append_Node_To_List
296
        (Make_Enumerated_Value (Thread_Name, Thread_Id),
297
298
299
300
         Thread_Enumeration);

      Thread_Id := Thread_Id + 1;

julien.delange's avatar
julien.delange committed
301
302
303
304
305
306
      --  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.

307
308
309
310
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
      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;

339
340
341
342
      if Has_Ports (E) then
         F := First_Node (Features (E));

         while Present (F) loop
343
            if Kind (F) = K_Port_Spec_Instance and then Is_Data (F) then
344
345
346
               Set_Str_To_Name_Buffer ("port-");
               Get_Name_String_And_Append (Thread_Name);
               Add_Str_To_Name_Buffer ("-");
347
               Get_Name_String_And_Append (Display_Name (Identifier (F)));
348
               Port_Name := Name_Find;
349
               Port_Name := To_Lower (Port_Name);
350

351
               Port_Name := Replace_Char (Port_Name, '_', '-');
julien.delange's avatar
julien.delange committed
352
353
               --  We replace _ by - because ASN1 does not allow
               --  character _.
354

355
               Append_Node_To_List
356
357
                 (Make_Enumerated_Value (Port_Name, Port_Id),
                  Port_Enumeration);
358
359

               Port_Id := Port_Id + 1;
julien.delange's avatar
julien.delange committed
360
361
362
363
               --  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.
364

365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
               Msg_Name        := Port_Name;
               Msg_Constraints :=
                 Make_Type_Constraints
                   (Size_Down => ASN1V.New_Int_Value (0, 1, 10),
                    Size_Up   =>
                      ASN1V.New_Int_Value
                        (To_Bytes (Get_Data_Size (Corresponding_Instance (F))),
                         1,
                         10));
               Msg_Choice :=
                 Make_Choice_Member
                   (Msg_Name,
                    Make_Type_Designator
                      (Type_Name =>
                         Make_Defining_Identifier
380
                           (Get_String_Name ("OCTET STRING")),
381
                       Type_Constraints => Msg_Constraints));
382
383
384

               Append_Node_To_List (Msg_Choice, Msg_Choices);

385
386
387
388
            end if;
            F := Next_Node (F);
         end loop;
      end if;
389
390
391
392
393
394
395
396
397
398
399
400
   end Visit_Thread_Instance;

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

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

401
402
403
   ---------------------------
   -- Visit_Device_Instance --
   ---------------------------
404
405
406
407
408
409
410
411

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

end Ocarina.Backends.ASN1.Deployment;