ocarina-backends-vxworks653_conf-hm.adb 18.5 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
------------------------------------------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--  O C A R I N A . B A C K E N D S . V X W O R K S 6 5 3 _ C O N F . H M   --
--                                                                          --
--                                 B o d y                                  --
--                                                                          --
--                     Copyright (C) 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/>.                                          --
--                                                                          --
--                 Ocarina is maintained by the TASTE project               --
--                      (taste-users@lists.tuxfamily.org)                   --
--                                                                          --
------------------------------------------------------------------------------

32
with Ocarina.Namet; use Ocarina.Namet;
33 34 35 36 37 38 39 40 41 42 43

--  with Locations;

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;

--  with Ocarina.Backends.Properties;
with Ocarina.Backends.XML_Tree.Nodes;
with Ocarina.Backends.XML_Tree.Nutils;
44
with Ocarina.Backends.Vxworks653_Conf.Mapping;
45 46 47 48 49 50 51 52 53

package body Ocarina.Backends.Vxworks653_Conf.Hm is

--   use Locations;
   use Ocarina.ME_AADL;
   use Ocarina.ME_AADL.AADL_Instances.Nodes;
   use Ocarina.ME_AADL.AADL_Instances.Entities;
   use Ocarina.Backends.XML_Tree.Nutils;
--   use Ocarina.Backends.Properties;
54
   use Ocarina.Backends.Vxworks653_Conf.Mapping;
55 56 57 58 59 60

   package AINU renames Ocarina.ME_AADL.AADL_Instances.Nutils;
   package XTN renames Ocarina.Backends.XML_Tree.Nodes;
   package XTU renames Ocarina.Backends.XML_Tree.Nutils;

   Root_Node : Node_Id := No_Node;
yoogx's avatar
yoogx committed
61
   HM_Node   : Node_Id := No_Node;
62 63 64 65 66 67 68 69 70

   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_Processor_Instance (E : Node_Id);
   procedure Visit_Bus_Instance (E : Node_Id);
   procedure Visit_Virtual_Processor_Instance (E : Node_Id);

yoogx's avatar
yoogx committed
71 72 73 74
   procedure Add_System_Error
     (XML_Node    : Node_Id;
      Identifier  : String;
      Description : String);
75

yoogx's avatar
yoogx committed
76 77 78 79
   procedure Add_Error_Action
     (XML_Node   : Node_Id;
      Identifier : String;
      Action     : String);
80 81 82 83

   pragma Unreferenced (Add_System_Error);

   function Generate_Partition_HM_Table
yoogx's avatar
yoogx committed
84
     (Virtual_Processor : Node_Id) return Node_Id;
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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
   -----------
   -- 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
      Root_Node := Root_System (E);
      Visit (Root_Node);
   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);

         when CC_Bus =>
            Visit_Bus_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
      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_Process_Instance;

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

   procedure Visit_System_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.
            if AINU.Is_Processor (Corresponding_Instance (S)) then
               Visit (Corresponding_Instance (S));
            end if;
            S := Next_Node (S);
         end loop;
      end if;
   end Visit_System_Instance;

   ------------------------
   -- Visit_Bus_Instance --
   ------------------------

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

   ------------------------
   --  Add_System_Error  --
   ------------------------

yoogx's avatar
yoogx committed
195 196 197 198 199
   procedure Add_System_Error
     (XML_Node    : Node_Id;
      Identifier  : String;
      Description : String)
   is
200 201 202 203 204
      Intermediate : Node_Id;
   begin
      Intermediate := Make_XML_Node ("SystemError");
      XTU.Add_Attribute ("ErrorIdentifier", Identifier, Intermediate);
      XTU.Add_Attribute ("Description", Description, Intermediate);
yoogx's avatar
yoogx committed
205
      Append_Node_To_List (Intermediate, XTN.Subitems (XML_Node));
206 207 208 209 210 211
   end Add_System_Error;

   ------------------------
   --  Add_Error_Action  --
   ------------------------

yoogx's avatar
yoogx committed
212 213 214 215 216
   procedure Add_Error_Action
     (XML_Node   : Node_Id;
      Identifier : String;
      Action     : String)
   is
217 218
      Intermediate : Node_Id;
   begin
219 220 221
      Intermediate := Make_XML_Node ("ErrorIDAction");
      XTU.Add_Attribute ("ErrorIdentifier", Identifier, Intermediate);
      XTU.Add_Attribute ("ErrorAction", Action, Intermediate);
yoogx's avatar
yoogx committed
222
      Append_Node_To_List (Intermediate, XTN.Subitems (XML_Node));
223 224 225 226 227 228 229 230 231 232
   end Add_Error_Action;

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

   procedure Visit_Processor_Instance (E : Node_Id) is
      S                    : Node_Id;
      U                    : Node_Id;
      P                    : Node_Id;
233 234 235 236 237
      System_HM_Table_Node : Node_Id;
      Module_HM_Table_Node : Node_Id;
      System_State_Node    : Node_Id;
      Error_Id_Level_Node  : Node_Id;
      Settings_Node        : Node_Id;
238 239 240 241 242 243 244 245 246 247 248 249 250
   begin
      U := XTN.Unit (Backend_Node (Identifier (E)));
      P := XTN.Node (Backend_Node (Identifier (E)));

      Push_Entity (P);
      Push_Entity (U);

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

      --
      --  For now, just generate the default HM policy.
      --

251 252 253 254 255 256 257 258 259 260
      HM_Node := Make_XML_Node ("HealthMonitor");
      Append_Node_To_List (HM_Node, XTN.Subitems (Current_XML_Node));

      --  Building the SystemHMTable first.

      System_HM_Table_Node := Make_XML_Node ("SystemHMTable");
      XTU.Add_Attribute ("Name", "systemHm", System_HM_Table_Node);
      Append_Node_To_List (System_HM_Table_Node, XTN.Subitems (HM_Node));

      System_State_Node := Make_XML_Node ("SystemState");
yoogx's avatar
yoogx committed
261 262 263 264 265 266 267
      XTU.Add_Attribute
        ("SystemState",
         "HM_PARTITION_MODE",
         System_State_Node);
      Append_Node_To_List
        (System_State_Node,
         XTN.Subitems (System_HM_Table_Node));
268 269

      Error_Id_Level_Node := Make_XML_Node ("ErrorIDLevel");
yoogx's avatar
yoogx committed
270 271 272 273 274 275 276 277
      XTU.Add_Attribute
        ("ErrorIdentifier",
         "HME_DEFAULT",
         Error_Id_Level_Node);
      XTU.Add_Attribute
        ("ErrorLevel",
         "HM_PARTITION_LVL",
         Error_Id_Level_Node);
278

yoogx's avatar
yoogx committed
279 280 281
      Append_Node_To_List
        (Error_Id_Level_Node,
         XTN.Subitems (System_State_Node));
282 283

      System_State_Node := Make_XML_Node ("SystemState");
yoogx's avatar
yoogx committed
284 285 286 287
      XTU.Add_Attribute ("SystemState", "HM_MODULE_MODE", System_State_Node);
      Append_Node_To_List
        (System_State_Node,
         XTN.Subitems (System_HM_Table_Node));
288 289

      Error_Id_Level_Node := Make_XML_Node ("ErrorIDLevel");
yoogx's avatar
yoogx committed
290 291 292 293 294 295 296 297
      XTU.Add_Attribute
        ("ErrorIdentifier",
         "HME_DEFAULT",
         Error_Id_Level_Node);
      XTU.Add_Attribute ("ErrorLevel", "HM_MODULE_LVL", Error_Id_Level_Node);
      Append_Node_To_List
        (Error_Id_Level_Node,
         XTN.Subitems (System_State_Node));
298 299

      System_State_Node := Make_XML_Node ("SystemState");
yoogx's avatar
yoogx committed
300 301 302 303
      XTU.Add_Attribute ("SystemState", "HM_PROCESS_MODE", System_State_Node);
      Append_Node_To_List
        (System_State_Node,
         XTN.Subitems (System_HM_Table_Node));
304 305

      Error_Id_Level_Node := Make_XML_Node ("ErrorIDLevel");
yoogx's avatar
yoogx committed
306 307 308 309 310 311 312 313
      XTU.Add_Attribute
        ("ErrorIdentifier",
         "HME_DEFAULT",
         Error_Id_Level_Node);
      XTU.Add_Attribute ("ErrorLevel", "HM_PROCESS_LVL", Error_Id_Level_Node);
      Append_Node_To_List
        (Error_Id_Level_Node,
         XTN.Subitems (System_State_Node));
314 315 316 317 318 319 320 321

      --  Building the ModuleHMTable then.

      Module_HM_Table_Node := Make_XML_Node ("ModuleHMTable");
      XTU.Add_Attribute ("Name", "moduleHm", Module_HM_Table_Node);
      Append_Node_To_List (Module_HM_Table_Node, XTN.Subitems (HM_Node));

      System_State_Node := Make_XML_Node ("SystemState");
yoogx's avatar
yoogx committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
      Append_Node_To_List
        (System_State_Node,
         XTN.Subitems (Module_HM_Table_Node));
      Add_Error_Action (System_State_Node, "HME_UNKNOWN", "hmDefaultHandler");
      Add_Error_Action (System_State_Node, "HME_NUMERIC_ERROR", "");
      Add_Error_Action
        (System_State_Node,
         "HME_POWER_FAIL",
         "hmDH_HME_POWER_FAIL");
      Add_Error_Action (System_State_Node, "HME_KERNEL", "hmDH_HME_KERNEL");
      Add_Error_Action
        (System_State_Node,
         "HME_CONFIG_ERROR",
         "hmDH_EventLog");
      Add_Error_Action
        (System_State_Node,
         "HME_INIT_ERROR",
         "hmDH_HME_INIT_ERROR");
      Add_Error_Action
        (System_State_Node,
         "HME_PARTITION_OVERFLOW",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_PARTITION_MODE_SET",
         "hmDH_HME_PARTITION_MODE_SET");
      Add_Error_Action
        (System_State_Node,
         "HME_APEX_INTERNAL_ERROR",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_HM_INTERNAL_ERROR",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_PORT_INTERNAL_ERROR",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_LOST_TICKS",
         "hmDH_HME_LOST_TICKS");
      Add_Error_Action (System_State_Node, "HME_HM_ERROR", "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_HMQ_OVERFLOW",
         "hmDefaultHandler");
      Add_Error_Action (System_State_Node, "HME_DATA_LOSS", "");
      Add_Error_Action
        (System_State_Node,
         "HME_HM_DEADLINE_MISSED",
         "hmDefaultHandler");
      Add_Error_Action (System_State_Node, "HM_MSG", "hmDH_EventLog");
      Add_Error_Action (System_State_Node, "HME_DEFAULT", "hmDefaultHandler");
376 377 378 379 380 381 382 383 384

      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_Virtual_Processor (Corresponding_Instance (S)) then
               Append_Node_To_List
yoogx's avatar
yoogx committed
385
                 (Generate_Partition_HM_Table (Corresponding_Instance (S)),
386 387 388 389 390 391
                  XTN.Subitems (HM_Node));
            end if;
            S := Next_Node (S);
         end loop;
      end if;

392 393 394 395 396 397 398 399 400 401 402 403 404 405
      Settings_Node := Make_XML_Node ("Settings");
      XTU.Add_Attribute ("maxQueueDepth", "34", Settings_Node);
      XTU.Add_Attribute ("queueThreshold", "32", Settings_Node);
      XTU.Add_Attribute ("stackSize", "16384", Settings_Node);
      XTU.Add_Attribute ("maxLogEntries", "100", Settings_Node);
      XTU.Add_Attribute ("logEntriesThreshold", "98", Settings_Node);
      XTU.Add_Attribute ("attributeMask", "0x00000001", Settings_Node);
      XTU.Add_Attribute ("notificationHandler", "", Settings_Node);
      XTU.Add_Attribute ("notifMaxQueueDepth", "0", Settings_Node);
      XTU.Add_Attribute ("eventFilterMask", "0x00000000", Settings_Node);
      XTU.Add_Attribute ("maxErrorHandlerQueueDepth", "0", Settings_Node);
      XTU.Add_Attribute ("errorHandlerQueueThreshold", "0", Settings_Node);
      Append_Node_To_List (Settings_Node, XTN.Subitems (Module_HM_Table_Node));

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
      Pop_Entity;
      Pop_Entity;
   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 (Corresponding_Instance (S));
            S := Next_Node (S);
         end loop;
      end if;
   end Visit_Virtual_Processor_Instance;

427 428 429 430 431
   ---------------------------------
   -- Generate_Partition_HM_Table --
   ---------------------------------

   function Generate_Partition_HM_Table
yoogx's avatar
yoogx committed
432 433
     (Virtual_Processor : Node_Id) return Node_Id
   is
434
      Partition_HM_Table_Node : Node_Id;
yoogx's avatar
yoogx committed
435 436 437
      System_State_Node       : Node_Id;
      Settings_Node           : Node_Id;
      Trusted_Partition_Node  : Node_Id;
438 439
   begin
      Partition_HM_Table_Node := Make_XML_Node ("PartitionHMTable");
yoogx's avatar
yoogx committed
440 441 442 443
      XTU.Add_Attribute
        ("Name",
         Get_Name_String (Map_Partition_Name (Virtual_Processor)) & "_hmtable",
         Partition_HM_Table_Node);
444 445

      System_State_Node := Make_XML_Node ("SystemState");
yoogx's avatar
yoogx committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
      Append_Node_To_List
        (System_State_Node,
         XTN.Subitems (Partition_HM_Table_Node));
      Add_Error_Action (System_State_Node, "HME_UNKNOWN", "hmDefaultHandler");
      Add_Error_Action (System_State_Node, "HME_NUMERIC_ERROR", "");
      Add_Error_Action
        (System_State_Node,
         "HME_POWER_FAIL",
         "hmDH_HME_POWER_FAIL");
      Add_Error_Action (System_State_Node, "HME_KERNEL", "hmDH_HME_KERNEL");
      Add_Error_Action
        (System_State_Node,
         "HME_CONFIG_ERROR",
         "hmDH_EventLog");
      Add_Error_Action
        (System_State_Node,
         "HME_INIT_ERROR",
         "hmDH_HME_INIT_ERROR");
      Add_Error_Action
        (System_State_Node,
         "HME_PARTITION_OVERFLOW",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_PARTITION_MODE_SET",
         "hmDH_HME_PARTITION_MODE_SET");
      Add_Error_Action
        (System_State_Node,
         "HME_APEX_INTERNAL_ERROR",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_HM_INTERNAL_ERROR",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_PORT_INTERNAL_ERROR",
         "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_LOST_TICKS",
         "hmDH_HME_LOST_TICKS");
      Add_Error_Action (System_State_Node, "HME_HM_ERROR", "hmDefaultHandler");
      Add_Error_Action
        (System_State_Node,
         "HME_HMQ_OVERFLOW",
         "hmDefaultHandler");
      Add_Error_Action (System_State_Node, "HME_DATA_LOSS", "");
      Add_Error_Action
        (System_State_Node,
         "HME_HM_DEADLINE_MISSED",
         "hmDefaultHandler");
      Add_Error_Action (System_State_Node, "HM_MSG", "hmDH_EventLog");
      Add_Error_Action (System_State_Node, "HME_DEFAULT", "hmDefaultHandler");
500 501 502 503 504 505 506 507 508 509 510 511 512

      Settings_Node := Make_XML_Node ("Settings");
      XTU.Add_Attribute ("maxQueueDepth", "34", Settings_Node);
      XTU.Add_Attribute ("queueThreshold", "32", Settings_Node);
      XTU.Add_Attribute ("stackSize", "16384", Settings_Node);
      XTU.Add_Attribute ("maxLogEntries", "100", Settings_Node);
      XTU.Add_Attribute ("logEntriesThreshold", "98", Settings_Node);
      XTU.Add_Attribute ("attributeMask", "0x00000001", Settings_Node);
      XTU.Add_Attribute ("notificationHandler", "", Settings_Node);
      XTU.Add_Attribute ("notifMaxQueueDepth", "0", Settings_Node);
      XTU.Add_Attribute ("eventFilterMask", "0xFFFFFFFF", Settings_Node);
      XTU.Add_Attribute ("maxErrorHandlerQueueDepth", "128", Settings_Node);
      XTU.Add_Attribute ("errorHandlerQueueThreshold", "126", Settings_Node);
yoogx's avatar
yoogx committed
513 514 515
      Append_Node_To_List
        (Settings_Node,
         XTN.Subitems (Partition_HM_Table_Node));
516 517

      Trusted_Partition_Node := Make_XML_Node ("TrustedPartition");
yoogx's avatar
yoogx committed
518 519 520 521 522 523 524
      XTU.Add_Attribute
        ("NameRef",
         Get_Name_String (Map_Partition_Name (Virtual_Processor)),
         Trusted_Partition_Node);
      Append_Node_To_List
        (Trusted_Partition_Node,
         XTN.Subitems (Settings_Node));
525

526 527 528
      return Partition_HM_Table_Node;
   end Generate_Partition_HM_Table;

529
end Ocarina.Backends.Vxworks653_Conf.Hm;