gcc/ada/a-tags.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                             A D A . T A G S                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2007, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  21 -- for  more details.  You should have  received  a copy of the GNU General --
  22 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  23 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  24 -- Boston, MA 02110-1301, USA.                                              --
  25 --                                                                          --
  26 -- As a special exception,  if other files  instantiate  generics from this --
  27 -- unit, or you link  this unit with other files  to produce an executable, --
  28 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  29 -- covered  by the  GNU  General  Public  License.  This exception does not --
  30 -- however invalidate  any other reasons why  the executable file  might be --
  31 -- covered by the  GNU Public License.                                      --
  32 --                                                                          --
  33 -- GNAT was originally developed  by the GNAT team at  New York University. --
  34 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  35 --                                                                          --
  36 ------------------------------------------------------------------------------
  37
  38 with System;
  39 with System.Storage_Elements;
  40
  41 package Ada.Tags is
  42    pragma Preelaborate_05;
  43    --  In accordance with Ada 2005 AI-362
  44
  45    type Tag is private;
  46    pragma Preelaborable_Initialization (Tag);
  47
  48    No_Tag : constant Tag;
  49
  50    function Expanded_Name (T : Tag) return String;
  51
  52    function Wide_Expanded_Name (T : Tag) return Wide_String;
  53    pragma Ada_05 (Wide_Expanded_Name);
  54
  55    function Wide_Wide_Expanded_Name (T : Tag) return Wide_Wide_String;
  56    pragma Ada_05 (Wide_Wide_Expanded_Name);
  57
  58    function External_Tag (T : Tag) return String;
  59
  60    function Internal_Tag (External : String) return Tag;
  61
  62    function Descendant_Tag
  63      (External : String;
  64       Ancestor : Tag) return Tag;
  65    pragma Ada_05 (Descendant_Tag);
  66
  67    function Is_Descendant_At_Same_Level
  68      (Descendant : Tag;
  69       Ancestor   : Tag) return Boolean;
  70    pragma Ada_05 (Is_Descendant_At_Same_Level);
  71
  72    function Parent_Tag (T : Tag) return Tag;
  73    pragma Ada_05 (Parent_Tag);
  74
  75    type Tag_Array is array (Positive range <>) of Tag;
  76
  77    function Interface_Ancestor_Tags (T : Tag) return Tag_Array;
  78    pragma Ada_05 (Interface_Ancestor_Tags);
  79
  80    Tag_Error : exception;
  81
  82 private
  83    --  Structure of the GNAT Primary Dispatch Table
  84
  85    --           +--------------------+
  86    --           |      Signature     |
  87    --           +--------------------+
  88    --           |     Tagged_Kind    |
  89    --           +--------------------+                            Predef Prims
  90    --           |    Predef_Prims -----------------------------> +------------+
  91    --           +--------------------+                           |  table of  |
  92    --           |    Offset_To_Top   |                           | predefined |
  93    --           +--------------------+                           | primitives |
  94    --           |Typeinfo_Ptr/TSD_Ptr---> Type Specific Data     +------------+
  95    --  Tag ---> +--------------------+   +-------------------+
  96    --           |      table of      |   | inheritance depth |
  97    --           :   primitive ops    :   +-------------------+
  98    --           |      pointers      |   |   access level    |
  99    --           +--------------------+   +-------------------+
 100    --                                    |   expanded name   |
 101    --                                    +-------------------+
 102    --                                    |   external tag    |
 103    --                                    +-------------------+
 104    --                                    |   hash table link |
 105    --                                    +-------------------+
 106    --                                    | remotely callable |
 107    --                                    +-------------------+
 108    --                                    | rec ctrler offset |
 109    --                                    +-------------------+
 110    --                                    |   Ifaces_Table   ---> Interface Data
 111    --                                    +-------------------+   +------------+
 112    --         Select Specific Data  <----        SSD         |   |  Nb_Ifaces |
 113    --         +------------------+       +-------------------+   +------------+
 114    --         |table of primitive|       | table of          |   |  table     |
 115    --         :   operation      :       :    ancestor       :   :    of      :
 116    --         |      kinds       |       |       tags        |   | interfaces |
 117    --         +------------------+       +-------------------+   +------------+
 118    --         |table of          |
 119    --         :   entry          :
 120    --         |      indices     |
 121    --         +------------------+
 122
 123    --  Structure of the GNAT Secondary Dispatch Table
 124
 125    --           +--------------------+
 126    --           |      Signature     |
 127    --           +--------------------+
 128    --           |     Tagged_Kind    |
 129    --           +--------------------+                            Predef Prims
 130    --           |    Predef_Prims -----------------------------> +------------+
 131    --           +--------------------+                           |  table of  |
 132    --           |    Offset_To_Top   |                           | predefined |
 133    --           +--------------------+                           | primitives |
 134    --           |       OSD_Ptr      |---> Object Specific Data  |   thunks   |
 135    --  Tag ---> +--------------------+      +---------------+    +------------+
 136    --           |      table of      |      | num prim ops  |
 137    --           :    primitive op    :      +---------------+
 138    --           |   thunk pointers   |      | table of      |
 139    --           +--------------------+      +   primitive   |
 140    --                                       |    op offsets |
 141    --                                       +---------------+
 142
 143    --  The runtime information kept for each tagged type is separated into two
 144    --  objects: the Dispatch Table and the Type Specific Data record.
 145
 146    package SSE renames System.Storage_Elements;
 147
 148    subtype Cstring is String (Positive);
 149    type Cstring_Ptr is access all Cstring;
 150    pragma No_Strict_Aliasing (Cstring_Ptr);
 151
 152    --  Declarations for the table of interfaces
 153
 154    type Offset_To_Top_Function_Ptr is
 155      access function (This : System.Address) return SSE.Storage_Offset;
 156    --  Type definition used to call the function that is generated by the
 157    --  expander in case of tagged types with discriminants that have secondary
 158    --  dispatch tables. This function provides the Offset_To_Top value in this
 159    --  specific case.
 160
 161    type Interface_Data_Element is record
 162       Iface_Tag            : Tag;
 163       Static_Offset_To_Top : Boolean;
 164       Offset_To_Top_Value  : SSE.Storage_Offset;
 165       Offset_To_Top_Func   : Offset_To_Top_Function_Ptr;
 166       Secondary_DT         : Tag;
 167    end record;
 168    --  If some ancestor of the tagged type has discriminants the field
 169    --  Static_Offset_To_Top is False and the field Offset_To_Top_Func
 170    --  is used to store the access to the function generated by the
 171    --  expander which provides this value; otherwise Static_Offset_To_Top
 172    --  is True and such value is stored in the Offset_To_Top_Value field.
 173    --  Secondary_DT references a secondary dispatch table whose contents
 174    --  are pointers to the primitives of the tagged type that cover the
 175    --  interface primitives. Secondary_DT gives support to dispatching
 176    --  calls through interface types associated with Generic Dispatching
 177    --  Constructors.
 178
 179    type Interfaces_Array is array (Natural range <>) of Interface_Data_Element;
 180
 181    type Interface_Data (Nb_Ifaces : Positive) is record
 182       Ifaces_Table : Interfaces_Array (1 .. Nb_Ifaces);
 183    end record;
 184
 185    type Interface_Data_Ptr is access all Interface_Data;
 186    --  Table of abstract interfaces used to give support to backward interface
 187    --  conversions and also to IW_Membership.
 188
 189    --  Primitive operation kinds. These values differentiate the kinds of
 190    --  callable entities stored in the dispatch table. Certain kinds may
 191    --  not be used, but are added for completeness.
 192
 193    type Prim_Op_Kind is
 194      (POK_Function,
 195       POK_Procedure,
 196       POK_Protected_Entry,
 197       POK_Protected_Function,
 198       POK_Protected_Procedure,
 199       POK_Task_Entry,
 200       POK_Task_Function,
 201       POK_Task_Procedure);
 202
 203    --  Select specific data types
 204
 205    type Select_Specific_Data_Element is record
 206       Index : Positive;
 207       Kind  : Prim_Op_Kind;
 208    end record;
 209
 210    type Select_Specific_Data_Array is
 211      array (Positive range <>) of Select_Specific_Data_Element;
 212
 213    type Select_Specific_Data (Nb_Prim : Positive) is record
 214       SSD_Table : Select_Specific_Data_Array (1 .. Nb_Prim);
 215       --  NOTE: Nb_Prim is the number of non-predefined primitive operations
 216    end record;
 217
 218    type Select_Specific_Data_Ptr is access all Select_Specific_Data;
 219    --  A table used to store the primitive operation kind and entry index of
 220    --  primitive subprograms of a type that implements a limited interface.
 221    --  The Select Specific Data table resides in the Type Specific Data of a
 222    --  type. This construct is used in the handling of dispatching triggers
 223    --  in select statements.
 224
 225    type Address_Array is array (Positive range <>) of System.Address;
 226
 227    subtype Dispatch_Table is Address_Array (1 .. 1);
 228    --  Used by GDB to identify the _tags and traverse the run-time structure
 229    --  associated with tagged types. For compatibility with older versions of
 230    --  gdb, its name must not be changed.
 231
 232    type Tag is access all Dispatch_Table;
 233    pragma No_Strict_Aliasing (Tag);
 234
 235    type Interface_Tag is access all Dispatch_Table;
 236
 237    No_Tag : constant Tag := null;
 238
 239    --  The expander ensures that Tag objects reference the Prims_Ptr component
 240    --  of the wrapper.
 241
 242    type Tag_Ptr is access all Tag;
 243    pragma No_Strict_Aliasing (Tag_Ptr);
 244
 245    type Tag_Table is array (Natural range <>) of Tag;
 246
 247    type Type_Specific_Data (Idepth : Natural) is record
 248    --  The discriminant Idepth is the Inheritance Depth Level: Used to
 249    --  implement the membership test associated with single inheritance of
 250    --  tagged types in constant-time. It also indicates the size of the
 251    --  Tags_Table component.
 252
 253       Access_Level : Natural;
 254       --  Accessibility level required to give support to Ada 2005 nested type
 255       --  extensions. This feature allows safe nested type extensions by
 256       --  shifting the accessibility checks to certain operations, rather than
 257       --  being enforced at the type declaration. In particular, by performing
 258       --  run-time accessibility checks on class-wide allocators, class-wide
 259       --  function return, and class-wide stream I/O, the danger of objects
 260       --  outliving their type declaration can be eliminated (Ada 2005: AI-344)
 261
 262       Expanded_Name : Cstring_Ptr;
 263       External_Tag  : Cstring_Ptr;
 264       HT_Link       : Tag_Ptr;
 265       --  Components used to support to the Ada.Tags subprograms in RM 3.9
 266
 267       --  Note: Expanded_Name is referenced by GDB to determine the actual name
 268       --  of the tagged type. Its requirements are: 1) it must have this exact
 269       --  name, and 2) its contents must point to a C-style Nul terminated
 270       --  string containing its expanded name. GDB has no requirement on a
 271       --  given position inside the record.
 272
 273       Transportable : Boolean;
 274       --  Used to check RM E.4(18), set for types that satisfy the requirements
 275       --  for being used in remote calls as actuals for classwide formals or as
 276       --  return values for classwide functions.
 277
 278       RC_Offset : SSE.Storage_Offset;
 279       --  Controller Offset: Used to give support to tagged controlled objects
 280       --  (see Get_Deep_Controller at s-finimp)
 281
 282       Interfaces_Table : Interface_Data_Ptr;
 283       --  Pointer to the table of interface tags. It is used to implement the
 284       --  membership test associated with interfaces and also for backward
 285       --  abstract interface type conversions (Ada 2005:AI-251)
 286
 287       SSD : Select_Specific_Data_Ptr;
 288       --  Pointer to a table of records used in dispatching selects. This
 289       --  field has a meaningful value for all tagged types that implement
 290       --  a limited, protected, synchronized or task interfaces and have
 291       --  non-predefined primitive operations.
 292
 293       Tags_Table : Tag_Table (0 .. Idepth);
 294       --  Table of ancestor tags. Its size actually depends on the inheritance
 295       --  depth level of the tagged type.
 296    end record;
 297
 298    type Type_Specific_Data_Ptr is access all Type_Specific_Data;
 299    pragma No_Strict_Aliasing (Type_Specific_Data_Ptr);
 300
 301    --  Declarations for the dispatch table record
 302
 303    type Signature_Kind is
 304       (Unknown,
 305        Primary_DT,
 306        Secondary_DT);
 307
 308    --  Tagged type kinds with respect to concurrency and limitedness
 309
 310    type Tagged_Kind is
 311      (TK_Abstract_Limited_Tagged,
 312       TK_Abstract_Tagged,
 313       TK_Limited_Tagged,
 314       TK_Protected,
 315       TK_Tagged,
 316       TK_Task);
 317
 318    type Dispatch_Table_Wrapper (Num_Prims : Natural) is record
 319       Signature     : Signature_Kind;
 320       Tag_Kind      : Tagged_Kind;
 321       Predef_Prims  : System.Address;
 322       --  Pointer to the dispatch table of predefined Ada primitives
 323
 324       --  According to the C++ ABI the components Offset_To_Top and TSD are
 325       --  stored just "before" the dispatch table, and they are referenced with
 326       --  negative offsets referring to the base of the dispatch table. The
 327       --   _Tag (or the VTable_Ptr in C++ terminology) must point to the base
 328       --  of the virtual table, just after these components, to point to the
 329       --  Prims_Ptr table.
 330
 331       Offset_To_Top : SSE.Storage_Offset;
 332       TSD           : System.Address;
 333
 334       Prims_Ptr : aliased Address_Array (1 .. Num_Prims);
 335       --  The size of the Prims_Ptr array actually depends on the tagged type
 336       --  to which it applies. For each tagged type, the expander computes the
 337       --  actual array size, allocates the Dispatch_Table record accordingly.
 338    end record;
 339
 340    type Dispatch_Table_Ptr is access all Dispatch_Table_Wrapper;
 341    pragma No_Strict_Aliasing (Dispatch_Table_Ptr);
 342
 343    --  The following type declaration is used by the compiler when the program
 344    --  is compiled with restriction No_Dispatching_Calls. It is also used with
 345    --  interface types to generate the tag and run-time information associated
 346    --  with them.
 347
 348    type No_Dispatch_Table_Wrapper is record
 349       NDT_TSD       : System.Address;
 350       NDT_Prims_Ptr : Natural;
 351    end record;
 352
 353    DT_Predef_Prims_Size : constant SSE.Storage_Count :=
 354                             SSE.Storage_Count
 355                               (1 * (Standard'Address_Size /
 356                                       System.Storage_Unit));
 357    --  Size of the Predef_Prims field of the Dispatch_Table
 358
 359    DT_Offset_To_Top_Size : constant SSE.Storage_Count :=
 360                              SSE.Storage_Count
 361                                (1 * (Standard'Address_Size /
 362                                        System.Storage_Unit));
 363    --  Size of the Offset_To_Top field of the Dispatch Table
 364
 365    DT_Typeinfo_Ptr_Size : constant SSE.Storage_Count :=
 366                             SSE.Storage_Count
 367                               (1 * (Standard'Address_Size /
 368                                       System.Storage_Unit));
 369    --  Size of the Typeinfo_Ptr field of the Dispatch Table
 370
 371    use type System.Storage_Elements.Storage_Offset;
 372
 373    DT_Predef_Prims_Offset : constant SSE.Storage_Count :=
 374                               DT_Typeinfo_Ptr_Size
 375                                 + DT_Offset_To_Top_Size
 376                                 + DT_Predef_Prims_Size;
 377    --  Offset from Prims_Ptr to Predef_Prims component
 378
 379    --  Object Specific Data record of secondary dispatch tables
 380
 381    type Object_Specific_Data_Array is array (Positive range <>) of Positive;
 382
 383    type Object_Specific_Data (OSD_Num_Prims : Positive) is record
 384       OSD_Table : Object_Specific_Data_Array (1 .. OSD_Num_Prims);
 385       --  Table used in secondary DT to reference their counterpart in the
 386       --  select specific data (in the TSD of the primary DT). This construct
 387       --  is used in the handling of dispatching triggers in select statements.
 388       --  Nb_Prim is the number of non-predefined primitive operations.
 389    end record;
 390
 391    type Object_Specific_Data_Ptr is access all Object_Specific_Data;
 392    pragma No_Strict_Aliasing (Object_Specific_Data_Ptr);
 393
 394    --  The following subprogram specifications are placed here instead of
 395    --  the package body to see them from the frontend through rtsfind.
 396
 397    function Base_Address (This : System.Address) return System.Address;
 398    --  Ada 2005 (AI-251): Displace "This" to point to the base address of
 399    --  the object (that is, the address of the primary tag of the object).
 400
 401    function Displace (This : System.Address; T : Tag) return System.Address;
 402    --  Ada 2005 (AI-251): Displace "This" to point to the secondary dispatch
 403    --  table of T.
 404
 405    function Secondary_Tag (T, Iface : Tag) return Tag;
 406    --  Ada 2005 (AI-251): Given a primary tag T associated with a tagged type
 407    --  Typ, search for the secondary tag of the interface type Iface covered
 408    --  by Typ.
 409
 410    function DT (T : Tag) return Dispatch_Table_Ptr;
 411    --  Return the pointer to the TSD record associated with T
 412
 413    function Get_Entry_Index (T : Tag; Position : Positive) return Positive;
 414    --  Ada 2005 (AI-251): Return a primitive operation's entry index (if entry)
 415    --  given a dispatch table T and a position of a primitive operation in T.
 416
 417    function Get_Offset_Index
 418      (T        : Tag;
 419       Position : Positive) return Positive;
 420    --  Ada 2005 (AI-251): Given a pointer to a secondary dispatch table (T) and
 421    --  a position of an operation in the DT, retrieve the corresponding
 422    --  operation's position in the primary dispatch table from the Offset
 423    --  Specific Data table of T.
 424
 425    function Get_Prim_Op_Kind
 426      (T        : Tag;
 427       Position : Positive) return Prim_Op_Kind;
 428    --  Ada 2005 (AI-251): Return a primitive operation's kind given a dispatch
 429    --  table T and a position of a primitive operation in T.
 430
 431    function Get_RC_Offset (T : Tag) return SSE.Storage_Offset;
 432    --  Return the Offset of the implicit record controller when the object
 433    --  has controlled components, returns zero if no controlled components.
 434
 435    pragma Export (Ada, Get_RC_Offset, "ada__tags__get_rc_offset");
 436    --  This procedure is used in s-finimp to compute the deep routines
 437    --  it is exported manually in order to avoid changing completely the
 438    --  organization of the run time.
 439
 440    function Get_Tagged_Kind (T : Tag) return Tagged_Kind;
 441    --  Ada 2005 (AI-345): Given a pointer to either a primary or a secondary
 442    --  dispatch table, return the tagged kind of a type in the context of
 443    --  concurrency and limitedness.
 444
 445    function IW_Membership (This : System.Address; T : Tag) return Boolean;
 446    --  Ada 2005 (AI-251): General routine that checks if a given object
 447    --  implements a tagged type. Its common usage is to check if Obj is in
 448    --  Iface'Class, but it is also used to check if a class-wide interface
 449    --  implements a given type (Iface_CW_Typ in T'Class). For example:
 450    --
 451    --      type I is interface;
 452    --      type T is tagged ...
 453    --
 454    --      function Test (O : I'Class) is
 455    --      begin
 456    --         return O in T'Class.
 457    --      end Test;
 458
 459    function Offset_To_Top
 460      (This : System.Address) return SSE.Storage_Offset;
 461    --  Ada 2005 (AI-251): Returns the current value of the offset_to_top
 462    --  component available in the prologue of the dispatch table. If the parent
 463    --  of the tagged type has discriminants this value is stored in a record
 464    --  component just immediately after the tag component.
 465
 466    function Parent_Size
 467      (Obj : System.Address;
 468       T   : Tag) return SSE.Storage_Count;
 469    --  Computes the size the ancestor part of a tagged extension object whose
 470    --  address is 'obj' by calling indirectly the ancestor _size function. The
 471    --  ancestor is the parent of the type represented by tag T. This function
 472    --  assumes that _size is always in slot one of the dispatch table.
 473
 474    pragma Export (Ada, Parent_Size, "ada__tags__parent_size");
 475    --  This procedure is used in s-finimp and is thus exported manually
 476
 477    procedure Register_Tag (T : Tag);
 478    --  Insert the Tag and its associated external_tag in a table for the
 479    --  sake of Internal_Tag
 480
 481    procedure Set_Entry_Index (T : Tag; Position : Positive; Value : Positive);
 482    --  Ada 2005 (AI-345): Set the entry index of a primitive operation in T's
 483    --  TSD table indexed by Position.
 484
 485    procedure Set_Offset_To_Top
 486      (This         : System.Address;
 487       Interface_T  : Tag;
 488       Is_Static    : Boolean;
 489       Offset_Value : SSE.Storage_Offset;
 490       Offset_Func  : Offset_To_Top_Function_Ptr);
 491    --  Ada 2005 (AI-251): Initialize the Offset_To_Top field in the prologue of
 492    --  the dispatch table. In primary dispatch tables the value of "This" is
 493    --  not required (and the compiler passes always the Null_Address value) and
 494    --  the Offset_Value is always cero; in secondary dispatch tables "This"
 495    --  points to the object, Interface_T is the interface for which the
 496    --  secondary dispatch table is being initialized, and Offset_Value is the
 497    --  distance from "This" to the object component containing the tag of the
 498    --  secondary dispatch table.
 499
 500    procedure Set_Prim_Op_Kind
 501      (T        : Tag;
 502       Position : Positive;
 503       Value    : Prim_Op_Kind);
 504    --  Ada 2005 (AI-251): Set the kind of a primitive operation in T's TSD
 505    --  table indexed by Position.
 506
 507    Max_Predef_Prims : constant Positive := 16;
 508    --  Number of reserved slots for the following predefined ada primitives:
 509    --
 510    --    1. Size
 511    --    2. Alignment,
 512    --    3. Read
 513    --    4. Write
 514    --    5. Input
 515    --    6. Output
 516    --    7. "="
 517    --    8. assignment
 518    --    9. deep adjust
 519    --   10. deep finalize
 520    --   11. async select
 521    --   12. conditional select
 522    --   13. prim_op kind
 523    --   14. task_id
 524    --   15. dispatching requeue
 525    --   16. timed select
 526    --
 527    --  The compiler checks that the value here is correct
 528
 529    subtype Predef_Prims_Table  is Address_Array (1 .. Max_Predef_Prims);
 530    type Predef_Prims_Table_Ptr is access Predef_Prims_Table;
 531    pragma No_Strict_Aliasing (Predef_Prims_Table_Ptr);
 532
 533    type Addr_Ptr is access System.Address;
 534    pragma No_Strict_Aliasing (Addr_Ptr);
 535    --  Why is this needed ???
 536 end Ada.Tags;