1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- S Y S T E M . P A R T I T I O N _ I N T E R F A C E --
9 -- Copyright (C) 1995-2004 Free Software Foundation, Inc. --
11 -- GNARL is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNARL; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 -- This unit may be used directly from an application program by providing
35 -- an appropriate WITH, and the interface can be expected to remain stable.
42 package System
.Partition_Interface
is
44 pragma Elaborate_Body
;
46 type DSA_Implementation_Name
is (No_DSA
, GARLIC_DSA
, PolyORB_DSA
);
47 DSA_Implementation
: constant DSA_Implementation_Name
:= No_DSA
;
49 -- RCI receiving stubs contain a table of descriptors for
50 -- all user subprograms exported by the unit.
52 type Subprogram_Id
is new Natural;
53 First_RCI_Subprogram_Id
: constant := 2;
55 type RCI_Subp_Info
is record
56 Addr
: System
.Address
;
57 -- Local address of the proxy object
60 type RCI_Subp_Info_Access
is access all RCI_Subp_Info
;
61 type RCI_Subp_Info_Array
is array (Integer range <>) of
62 aliased RCI_Subp_Info
;
64 subtype Unit_Name
is String;
67 type Main_Subprogram_Type
is access procedure;
69 type RACW_Stub_Type
is tagged record
70 Origin
: RPC
.Partition_ID
;
71 Receiver
: Interfaces
.Unsigned_64
;
72 Addr
: Interfaces
.Unsigned_64
;
73 Asynchronous
: Boolean;
76 type RACW_Stub_Type_Access
is access RACW_Stub_Type
;
77 -- This type is used by the expansion to implement distributed objects.
78 -- Do not change its definition or its layout without updating
81 type RAS_Proxy_Type
is tagged limited record
82 All_Calls_Remote
: Boolean;
83 Receiver
: System
.Address
;
84 Subp_Id
: Subprogram_Id
;
87 type RAS_Proxy_Type_Access
is access RAS_Proxy_Type
;
88 pragma No_Strict_Aliasing
(RAS_Proxy_Type_Access
);
89 -- This type is used by the expansion to implement distributed objects.
90 -- Do not change its definition or its layout without updating
91 -- Exp_Dist.Build_Remote_Supbrogram_Proxy_Type.
93 -- The Request_Access type is used for communication between the PCS
94 -- and the RPC receiver generated by the compiler: it contains all the
95 -- necessary information for the receiver to process an incoming call.
97 type RST_Access
is access all Ada
.Streams
.Root_Stream_Type
'Class;
98 type Request_Access
is record
100 -- A stream describing the called subprogram and its parameters
103 -- A stream where the result, raised exception, or out values,
110 RCI
: Boolean := True);
111 -- Use by the main subprogram to check that a remote receiver
112 -- unit has has the same version than the caller's one.
114 function Same_Partition
115 (Left
: access RACW_Stub_Type
;
116 Right
: access RACW_Stub_Type
) return Boolean;
117 -- Determine whether Left and Right correspond to objects instantiated
118 -- on the same partition, for enforcement of E.4(19).
120 function Get_Active_Partition_ID
(Name
: Unit_Name
) return RPC
.Partition_ID
;
121 -- Similar in some respects to RCI_Locator.Get_Active_Partition_ID
123 function Get_Active_Version
(Name
: Unit_Name
) return String;
124 -- Similar in some respects to Get_Active_Partition_ID
126 function Get_Local_Partition_ID
return RPC
.Partition_ID
;
127 -- Return the Partition_ID of the current partition
129 function Get_Passive_Partition_ID
130 (Name
: Unit_Name
) return RPC
.Partition_ID
;
131 -- Return the Partition_ID of the given shared passive partition
133 function Get_Passive_Version
(Name
: Unit_Name
) return String;
134 -- Return the version corresponding to a shared passive unit
136 function Get_RCI_Package_Receiver
137 (Name
: Unit_Name
) return Interfaces
.Unsigned_64
;
138 -- Similar in some respects to RCI_Locator.Get_RCI_Package_Receiver
140 procedure Get_Unique_Remote_Pointer
141 (Handler
: in out RACW_Stub_Type_Access
);
142 -- Get a unique pointer on a remote object
144 procedure Raise_Program_Error_Unknown_Tag
145 (E
: Ada
.Exceptions
.Exception_Occurrence
);
146 pragma No_Return
(Raise_Program_Error_Unknown_Tag
);
147 -- Raise Program_Error with the same message as E one
149 type RPC_Receiver
is access procedure (R
: Request_Access
);
150 procedure Register_Receiving_Stub
152 Receiver
: RPC_Receiver
;
153 Version
: String := "";
154 Subp_Info
: System
.Address
;
155 Subp_Info_Len
: Integer);
156 -- Register the fact that the Name receiving stub is now elaborated.
157 -- Register the access value to the package RPC_Receiver procedure.
159 procedure Get_RAS_Info
161 Subp_Id
: Subprogram_Id
;
162 Proxy_Address
: out Interfaces
.Unsigned_64
);
163 -- Look up the address of the proxy object for the given subprogram
164 -- in the named unit, or Null_Address if not present on the local
167 procedure Register_Passive_Package
169 Version
: String := "");
170 -- Register a passive package
174 package RCI_Locator
is
175 function Get_RCI_Package_Receiver
return Interfaces
.Unsigned_64
;
176 function Get_Active_Partition_ID
return RPC
.Partition_ID
;
178 -- RCI package information caching
180 procedure Run
(Main
: Main_Subprogram_Type
:= null);
181 -- Run the main subprogram
183 end System
.Partition_Interface
;