]> git.ipfire.org Git - thirdparty/gcc.git/blob - gcc/ada/exp_ch6.adb
gcc/ada/
[thirdparty/gcc.git] / gcc / ada / exp_ch6.adb
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- E X P _ C H 6 --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2017, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT 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 3, or (at your option) any later ver- --
14 -- sion. GNAT 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 GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
25
26 with Atree; use Atree;
27 with Checks; use Checks;
28 with Contracts; use Contracts;
29 with Debug; use Debug;
30 with Einfo; use Einfo;
31 with Errout; use Errout;
32 with Elists; use Elists;
33 with Expander; use Expander;
34 with Exp_Aggr; use Exp_Aggr;
35 with Exp_Atag; use Exp_Atag;
36 with Exp_Ch2; use Exp_Ch2;
37 with Exp_Ch3; use Exp_Ch3;
38 with Exp_Ch7; use Exp_Ch7;
39 with Exp_Ch9; use Exp_Ch9;
40 with Exp_Dbug; use Exp_Dbug;
41 with Exp_Disp; use Exp_Disp;
42 with Exp_Dist; use Exp_Dist;
43 with Exp_Intr; use Exp_Intr;
44 with Exp_Pakd; use Exp_Pakd;
45 with Exp_Tss; use Exp_Tss;
46 with Exp_Util; use Exp_Util;
47 with Freeze; use Freeze;
48 with Inline; use Inline;
49 with Itypes; use Itypes;
50 with Lib; use Lib;
51 with Namet; use Namet;
52 with Nlists; use Nlists;
53 with Nmake; use Nmake;
54 with Opt; use Opt;
55 with Restrict; use Restrict;
56 with Rident; use Rident;
57 with Rtsfind; use Rtsfind;
58 with Sem; use Sem;
59 with Sem_Aux; use Sem_Aux;
60 with Sem_Ch6; use Sem_Ch6;
61 with Sem_Ch8; use Sem_Ch8;
62 with Sem_Ch12; use Sem_Ch12;
63 with Sem_Ch13; use Sem_Ch13;
64 with Sem_Dim; use Sem_Dim;
65 with Sem_Disp; use Sem_Disp;
66 with Sem_Dist; use Sem_Dist;
67 with Sem_Eval; use Sem_Eval;
68 with Sem_Mech; use Sem_Mech;
69 with Sem_Res; use Sem_Res;
70 with Sem_SCIL; use Sem_SCIL;
71 with Sem_Util; use Sem_Util;
72 with Sinfo; use Sinfo;
73 with Snames; use Snames;
74 with Stand; use Stand;
75 with Tbuild; use Tbuild;
76 with Uintp; use Uintp;
77 with Validsw; use Validsw;
78
79 package body Exp_Ch6 is
80
81 -----------------------
82 -- Local Subprograms --
83 -----------------------
84
85 procedure Add_Access_Actual_To_Build_In_Place_Call
86 (Function_Call : Node_Id;
87 Function_Id : Entity_Id;
88 Return_Object : Node_Id;
89 Is_Access : Boolean := False);
90 -- Ada 2005 (AI-318-02): Apply the Unrestricted_Access attribute to the
91 -- object name given by Return_Object and add the attribute to the end of
92 -- the actual parameter list associated with the build-in-place function
93 -- call denoted by Function_Call. However, if Is_Access is True, then
94 -- Return_Object is already an access expression, in which case it's passed
95 -- along directly to the build-in-place function. Finally, if Return_Object
96 -- is empty, then pass a null literal as the actual.
97
98 procedure Add_Unconstrained_Actuals_To_Build_In_Place_Call
99 (Function_Call : Node_Id;
100 Function_Id : Entity_Id;
101 Alloc_Form : BIP_Allocation_Form := Unspecified;
102 Alloc_Form_Exp : Node_Id := Empty;
103 Pool_Actual : Node_Id := Make_Null (No_Location));
104 -- Ada 2005 (AI-318-02): Add the actuals needed for a build-in-place
105 -- function call that returns a caller-unknown-size result (BIP_Alloc_Form
106 -- and BIP_Storage_Pool). If Alloc_Form_Exp is present, then use it,
107 -- otherwise pass a literal corresponding to the Alloc_Form parameter
108 -- (which must not be Unspecified in that case). Pool_Actual is the
109 -- parameter to pass to BIP_Storage_Pool.
110
111 procedure Add_Finalization_Master_Actual_To_Build_In_Place_Call
112 (Func_Call : Node_Id;
113 Func_Id : Entity_Id;
114 Ptr_Typ : Entity_Id := Empty;
115 Master_Exp : Node_Id := Empty);
116 -- Ada 2005 (AI-318-02): If the result type of a build-in-place call needs
117 -- finalization actions, add an actual parameter which is a pointer to the
118 -- finalization master of the caller. If Master_Exp is not Empty, then that
119 -- will be passed as the actual. Otherwise, if Ptr_Typ is left Empty, this
120 -- will result in an automatic "null" value for the actual.
121
122 procedure Add_Task_Actuals_To_Build_In_Place_Call
123 (Function_Call : Node_Id;
124 Function_Id : Entity_Id;
125 Master_Actual : Node_Id;
126 Chain : Node_Id := Empty);
127 -- Ada 2005 (AI-318-02): For a build-in-place call, if the result type
128 -- contains tasks, add two actual parameters: the master, and a pointer to
129 -- the caller's activation chain. Master_Actual is the actual parameter
130 -- expression to pass for the master. In most cases, this is the current
131 -- master (_master). The two exceptions are: If the function call is the
132 -- initialization expression for an allocator, we pass the master of the
133 -- access type. If the function call is the initialization expression for a
134 -- return object, we pass along the master passed in by the caller. In most
135 -- contexts, the activation chain to pass is the local one, which is
136 -- indicated by No (Chain). However, in an allocator, the caller passes in
137 -- the activation Chain. Note: Master_Actual can be Empty, but only if
138 -- there are no tasks.
139
140 function Caller_Known_Size
141 (Func_Call : Node_Id;
142 Result_Subt : Entity_Id) return Boolean;
143 -- True if result subtype is definite, or has a size that does not require
144 -- secondary stack usage (i.e. no variant part or components whose type
145 -- depends on discriminants). In particular, untagged types with only
146 -- access discriminants do not require secondary stack use. Note we must
147 -- always use the secondary stack for dispatching-on-result calls.
148
149 procedure Check_Overriding_Operation (Subp : Entity_Id);
150 -- Subp is a dispatching operation. Check whether it may override an
151 -- inherited private operation, in which case its DT entry is that of
152 -- the hidden operation, not the one it may have received earlier.
153 -- This must be done before emitting the code to set the corresponding
154 -- DT to the address of the subprogram. The actual placement of Subp in
155 -- the proper place in the list of primitive operations is done in
156 -- Declare_Inherited_Private_Subprograms, which also has to deal with
157 -- implicit operations. This duplication is unavoidable for now???
158
159 procedure Detect_Infinite_Recursion (N : Node_Id; Spec : Entity_Id);
160 -- This procedure is called only if the subprogram body N, whose spec
161 -- has the given entity Spec, contains a parameterless recursive call.
162 -- It attempts to generate runtime code to detect if this a case of
163 -- infinite recursion.
164 --
165 -- The body is scanned to determine dependencies. If the only external
166 -- dependencies are on a small set of scalar variables, then the values
167 -- of these variables are captured on entry to the subprogram, and if
168 -- the values are not changed for the call, we know immediately that
169 -- we have an infinite recursion.
170
171 procedure Expand_Actuals
172 (N : Node_Id;
173 Subp : Entity_Id;
174 Post_Call : out List_Id);
175 -- Return a list of actions to take place after the call in Post_Call. The
176 -- call will later be rewritten as an Expression_With_Actions, with the
177 -- Post_Call actions inserted, and the call inside.
178 --
179 -- For each actual of an in-out or out parameter which is a numeric (view)
180 -- conversion of the form T (A), where A denotes a variable, we insert the
181 -- declaration:
182 --
183 -- Temp : T[ := T (A)];
184 --
185 -- prior to the call. Then we replace the actual with a reference to Temp,
186 -- and append the assignment:
187 --
188 -- A := TypeA (Temp);
189 --
190 -- after the call. Here TypeA is the actual type of variable A. For out
191 -- parameters, the initial declaration has no expression. If A is not an
192 -- entity name, we generate instead:
193 --
194 -- Var : TypeA renames A;
195 -- Temp : T := Var; -- omitting expression for out parameter.
196 -- ...
197 -- Var := TypeA (Temp);
198 --
199 -- For other in-out parameters, we emit the required constraint checks
200 -- before and/or after the call.
201 --
202 -- For all parameter modes, actuals that denote components and slices of
203 -- packed arrays are expanded into suitable temporaries.
204 --
205 -- For non-scalar objects that are possibly unaligned, add call by copy
206 -- code (copy in for IN and IN OUT, copy out for OUT and IN OUT).
207 --
208 -- For OUT and IN OUT parameters, add predicate checks after the call
209 -- based on the predicates of the actual type.
210
211 procedure Expand_Call_Helper (N : Node_Id; Post_Call : out List_Id);
212 -- Does the main work of Expand_Call. Post_Call is as for Expand_Actuals.
213
214 procedure Expand_Ctrl_Function_Call (N : Node_Id);
215 -- N is a function call which returns a controlled object. Transform the
216 -- call into a temporary which retrieves the returned object from the
217 -- secondary stack using 'reference.
218
219 procedure Expand_Non_Function_Return (N : Node_Id);
220 -- Expand a simple return statement found in a procedure body, entry body,
221 -- accept statement, or an extended return statement. Note that all non-
222 -- function returns are simple return statements.
223
224 function Expand_Protected_Object_Reference
225 (N : Node_Id;
226 Scop : Entity_Id) return Node_Id;
227
228 procedure Expand_Protected_Subprogram_Call
229 (N : Node_Id;
230 Subp : Entity_Id;
231 Scop : Entity_Id);
232 -- A call to a protected subprogram within the protected object may appear
233 -- as a regular call. The list of actuals must be expanded to contain a
234 -- reference to the object itself, and the call becomes a call to the
235 -- corresponding protected subprogram.
236
237 procedure Expand_Simple_Function_Return (N : Node_Id);
238 -- Expand simple return from function. In the case where we are returning
239 -- from a function body this is called by Expand_N_Simple_Return_Statement.
240
241 function Has_Unconstrained_Access_Discriminants
242 (Subtyp : Entity_Id) return Boolean;
243 -- Returns True if the given subtype is unconstrained and has one or more
244 -- access discriminants.
245
246 procedure Insert_Post_Call_Actions (N : Node_Id; Post_Call : List_Id);
247 -- Insert the Post_Call list previously produced by routine Expand_Actuals
248 -- or Expand_Call_Helper into the tree.
249
250 procedure Replace_Renaming_Declaration_Id
251 (New_Decl : Node_Id;
252 Orig_Decl : Node_Id);
253 -- Replace the internal identifier of the new renaming declaration New_Decl
254 -- with the identifier of its original declaration Orig_Decl exchanging the
255 -- entities containing their defining identifiers to ensure the correct
256 -- replacement of the object declaration by the object renaming declaration
257 -- to avoid homograph conflicts (since the object declaration's defining
258 -- identifier was already entered in the current scope). The Next_Entity
259 -- links of the two entities are also swapped since the entities are part
260 -- of the return scope's entity list and the list structure would otherwise
261 -- be corrupted. The homonym chain is preserved as well.
262
263 procedure Rewrite_Function_Call_For_C (N : Node_Id);
264 -- When generating C code, replace a call to a function that returns an
265 -- array into the generated procedure with an additional out parameter.
266
267 procedure Set_Enclosing_Sec_Stack_Return (N : Node_Id);
268 -- N is a return statement for a function that returns its result on the
269 -- secondary stack. This sets the Sec_Stack_Needed_For_Return flag on the
270 -- function and all blocks and loops that the return statement is jumping
271 -- out of. This ensures that the secondary stack is not released; otherwise
272 -- the function result would be reclaimed before returning to the caller.
273
274 ----------------------------------------------
275 -- Add_Access_Actual_To_Build_In_Place_Call --
276 ----------------------------------------------
277
278 procedure Add_Access_Actual_To_Build_In_Place_Call
279 (Function_Call : Node_Id;
280 Function_Id : Entity_Id;
281 Return_Object : Node_Id;
282 Is_Access : Boolean := False)
283 is
284 Loc : constant Source_Ptr := Sloc (Function_Call);
285 Obj_Address : Node_Id;
286 Obj_Acc_Formal : Entity_Id;
287
288 begin
289 -- Locate the implicit access parameter in the called function
290
291 Obj_Acc_Formal := Build_In_Place_Formal (Function_Id, BIP_Object_Access);
292
293 -- If no return object is provided, then pass null
294
295 if not Present (Return_Object) then
296 Obj_Address := Make_Null (Loc);
297 Set_Parent (Obj_Address, Function_Call);
298
299 -- If Return_Object is already an expression of an access type, then use
300 -- it directly, since it must be an access value denoting the return
301 -- object, and couldn't possibly be the return object itself.
302
303 elsif Is_Access then
304 Obj_Address := Return_Object;
305 Set_Parent (Obj_Address, Function_Call);
306
307 -- Apply Unrestricted_Access to caller's return object
308
309 else
310 Obj_Address :=
311 Make_Attribute_Reference (Loc,
312 Prefix => Return_Object,
313 Attribute_Name => Name_Unrestricted_Access);
314
315 Set_Parent (Return_Object, Obj_Address);
316 Set_Parent (Obj_Address, Function_Call);
317 end if;
318
319 Analyze_And_Resolve (Obj_Address, Etype (Obj_Acc_Formal));
320
321 -- Build the parameter association for the new actual and add it to the
322 -- end of the function's actuals.
323
324 Add_Extra_Actual_To_Call (Function_Call, Obj_Acc_Formal, Obj_Address);
325 end Add_Access_Actual_To_Build_In_Place_Call;
326
327 ------------------------------------------------------
328 -- Add_Unconstrained_Actuals_To_Build_In_Place_Call --
329 ------------------------------------------------------
330
331 procedure Add_Unconstrained_Actuals_To_Build_In_Place_Call
332 (Function_Call : Node_Id;
333 Function_Id : Entity_Id;
334 Alloc_Form : BIP_Allocation_Form := Unspecified;
335 Alloc_Form_Exp : Node_Id := Empty;
336 Pool_Actual : Node_Id := Make_Null (No_Location))
337 is
338 Loc : constant Source_Ptr := Sloc (Function_Call);
339 Alloc_Form_Actual : Node_Id;
340 Alloc_Form_Formal : Node_Id;
341 Pool_Formal : Node_Id;
342
343 begin
344 -- The allocation form generally doesn't need to be passed in the case
345 -- of a constrained result subtype, since normally the caller performs
346 -- the allocation in that case. However this formal is still needed in
347 -- the case where the function has a tagged result, because generally
348 -- such functions can be called in a dispatching context and such calls
349 -- must be handled like calls to class-wide functions.
350
351 if Is_Constrained (Underlying_Type (Etype (Function_Id)))
352 and then not Is_Tagged_Type (Underlying_Type (Etype (Function_Id)))
353 then
354 return;
355 end if;
356
357 -- Locate the implicit allocation form parameter in the called function.
358 -- Maybe it would be better for each implicit formal of a build-in-place
359 -- function to have a flag or a Uint attribute to identify it. ???
360
361 Alloc_Form_Formal := Build_In_Place_Formal (Function_Id, BIP_Alloc_Form);
362
363 if Present (Alloc_Form_Exp) then
364 pragma Assert (Alloc_Form = Unspecified);
365
366 Alloc_Form_Actual := Alloc_Form_Exp;
367
368 else
369 pragma Assert (Alloc_Form /= Unspecified);
370
371 Alloc_Form_Actual :=
372 Make_Integer_Literal (Loc,
373 Intval => UI_From_Int (BIP_Allocation_Form'Pos (Alloc_Form)));
374 end if;
375
376 Analyze_And_Resolve (Alloc_Form_Actual, Etype (Alloc_Form_Formal));
377
378 -- Build the parameter association for the new actual and add it to the
379 -- end of the function's actuals.
380
381 Add_Extra_Actual_To_Call
382 (Function_Call, Alloc_Form_Formal, Alloc_Form_Actual);
383
384 -- Pass the Storage_Pool parameter. This parameter is omitted on
385 -- ZFP as those targets do not support pools.
386
387 if RTE_Available (RE_Root_Storage_Pool_Ptr) then
388 Pool_Formal := Build_In_Place_Formal (Function_Id, BIP_Storage_Pool);
389 Analyze_And_Resolve (Pool_Actual, Etype (Pool_Formal));
390 Add_Extra_Actual_To_Call
391 (Function_Call, Pool_Formal, Pool_Actual);
392 end if;
393 end Add_Unconstrained_Actuals_To_Build_In_Place_Call;
394
395 -----------------------------------------------------------
396 -- Add_Finalization_Master_Actual_To_Build_In_Place_Call --
397 -----------------------------------------------------------
398
399 procedure Add_Finalization_Master_Actual_To_Build_In_Place_Call
400 (Func_Call : Node_Id;
401 Func_Id : Entity_Id;
402 Ptr_Typ : Entity_Id := Empty;
403 Master_Exp : Node_Id := Empty)
404 is
405 begin
406 if not Needs_BIP_Finalization_Master (Func_Id) then
407 return;
408 end if;
409
410 declare
411 Formal : constant Entity_Id :=
412 Build_In_Place_Formal (Func_Id, BIP_Finalization_Master);
413 Loc : constant Source_Ptr := Sloc (Func_Call);
414
415 Actual : Node_Id;
416 Desig_Typ : Entity_Id;
417
418 begin
419 -- If there is a finalization master actual, such as the implicit
420 -- finalization master of an enclosing build-in-place function,
421 -- then this must be added as an extra actual of the call.
422
423 if Present (Master_Exp) then
424 Actual := Master_Exp;
425
426 -- Case where the context does not require an actual master
427
428 elsif No (Ptr_Typ) then
429 Actual := Make_Null (Loc);
430
431 else
432 Desig_Typ := Directly_Designated_Type (Ptr_Typ);
433
434 -- Check for a library-level access type whose designated type has
435 -- suppressed finalization or the access type is subject to pragma
436 -- No_Heap_Finalization. Such an access type lacks a master. Pass
437 -- a null actual to callee in order to signal a missing master.
438
439 if Is_Library_Level_Entity (Ptr_Typ)
440 and then (Finalize_Storage_Only (Desig_Typ)
441 or else No_Heap_Finalization (Ptr_Typ))
442 then
443 Actual := Make_Null (Loc);
444
445 -- Types in need of finalization actions
446
447 elsif Needs_Finalization (Desig_Typ) then
448
449 -- The general mechanism of creating finalization masters for
450 -- anonymous access types is disabled by default, otherwise
451 -- finalization masters will pop all over the place. Such types
452 -- use context-specific masters.
453
454 if Ekind (Ptr_Typ) = E_Anonymous_Access_Type
455 and then No (Finalization_Master (Ptr_Typ))
456 then
457 Build_Anonymous_Master (Ptr_Typ);
458 end if;
459
460 -- Access-to-controlled types should always have a master
461
462 pragma Assert (Present (Finalization_Master (Ptr_Typ)));
463
464 Actual :=
465 Make_Attribute_Reference (Loc,
466 Prefix =>
467 New_Occurrence_Of (Finalization_Master (Ptr_Typ), Loc),
468 Attribute_Name => Name_Unrestricted_Access);
469
470 -- Tagged types
471
472 else
473 Actual := Make_Null (Loc);
474 end if;
475 end if;
476
477 Analyze_And_Resolve (Actual, Etype (Formal));
478
479 -- Build the parameter association for the new actual and add it to
480 -- the end of the function's actuals.
481
482 Add_Extra_Actual_To_Call (Func_Call, Formal, Actual);
483 end;
484 end Add_Finalization_Master_Actual_To_Build_In_Place_Call;
485
486 ------------------------------
487 -- Add_Extra_Actual_To_Call --
488 ------------------------------
489
490 procedure Add_Extra_Actual_To_Call
491 (Subprogram_Call : Node_Id;
492 Extra_Formal : Entity_Id;
493 Extra_Actual : Node_Id)
494 is
495 Loc : constant Source_Ptr := Sloc (Subprogram_Call);
496 Param_Assoc : Node_Id;
497
498 begin
499 Param_Assoc :=
500 Make_Parameter_Association (Loc,
501 Selector_Name => New_Occurrence_Of (Extra_Formal, Loc),
502 Explicit_Actual_Parameter => Extra_Actual);
503
504 Set_Parent (Param_Assoc, Subprogram_Call);
505 Set_Parent (Extra_Actual, Param_Assoc);
506
507 if Present (Parameter_Associations (Subprogram_Call)) then
508 if Nkind (Last (Parameter_Associations (Subprogram_Call))) =
509 N_Parameter_Association
510 then
511
512 -- Find last named actual, and append
513
514 declare
515 L : Node_Id;
516 begin
517 L := First_Actual (Subprogram_Call);
518 while Present (L) loop
519 if No (Next_Actual (L)) then
520 Set_Next_Named_Actual (Parent (L), Extra_Actual);
521 exit;
522 end if;
523 Next_Actual (L);
524 end loop;
525 end;
526
527 else
528 Set_First_Named_Actual (Subprogram_Call, Extra_Actual);
529 end if;
530
531 Append (Param_Assoc, To => Parameter_Associations (Subprogram_Call));
532
533 else
534 Set_Parameter_Associations (Subprogram_Call, New_List (Param_Assoc));
535 Set_First_Named_Actual (Subprogram_Call, Extra_Actual);
536 end if;
537 end Add_Extra_Actual_To_Call;
538
539 ---------------------------------------------
540 -- Add_Task_Actuals_To_Build_In_Place_Call --
541 ---------------------------------------------
542
543 procedure Add_Task_Actuals_To_Build_In_Place_Call
544 (Function_Call : Node_Id;
545 Function_Id : Entity_Id;
546 Master_Actual : Node_Id;
547 Chain : Node_Id := Empty)
548 is
549 Loc : constant Source_Ptr := Sloc (Function_Call);
550 Result_Subt : constant Entity_Id :=
551 Available_View (Etype (Function_Id));
552 Actual : Node_Id;
553 Chain_Actual : Node_Id;
554 Chain_Formal : Node_Id;
555 Master_Formal : Node_Id;
556
557 begin
558 -- No such extra parameters are needed if there are no tasks
559
560 if not Has_Task (Result_Subt) then
561 return;
562 end if;
563
564 Actual := Master_Actual;
565
566 -- Use a dummy _master actual in case of No_Task_Hierarchy
567
568 if Restriction_Active (No_Task_Hierarchy) then
569 Actual := New_Occurrence_Of (RTE (RE_Library_Task_Level), Loc);
570
571 -- In the case where we use the master associated with an access type,
572 -- the actual is an entity and requires an explicit reference.
573
574 elsif Nkind (Actual) = N_Defining_Identifier then
575 Actual := New_Occurrence_Of (Actual, Loc);
576 end if;
577
578 -- Locate the implicit master parameter in the called function
579
580 Master_Formal := Build_In_Place_Formal (Function_Id, BIP_Task_Master);
581 Analyze_And_Resolve (Actual, Etype (Master_Formal));
582
583 -- Build the parameter association for the new actual and add it to the
584 -- end of the function's actuals.
585
586 Add_Extra_Actual_To_Call (Function_Call, Master_Formal, Actual);
587
588 -- Locate the implicit activation chain parameter in the called function
589
590 Chain_Formal :=
591 Build_In_Place_Formal (Function_Id, BIP_Activation_Chain);
592
593 -- Create the actual which is a pointer to the current activation chain
594
595 if No (Chain) then
596 Chain_Actual :=
597 Make_Attribute_Reference (Loc,
598 Prefix => Make_Identifier (Loc, Name_uChain),
599 Attribute_Name => Name_Unrestricted_Access);
600
601 -- Allocator case; make a reference to the Chain passed in by the caller
602
603 else
604 Chain_Actual :=
605 Make_Attribute_Reference (Loc,
606 Prefix => New_Occurrence_Of (Chain, Loc),
607 Attribute_Name => Name_Unrestricted_Access);
608 end if;
609
610 Analyze_And_Resolve (Chain_Actual, Etype (Chain_Formal));
611
612 -- Build the parameter association for the new actual and add it to the
613 -- end of the function's actuals.
614
615 Add_Extra_Actual_To_Call (Function_Call, Chain_Formal, Chain_Actual);
616 end Add_Task_Actuals_To_Build_In_Place_Call;
617
618 -----------------------
619 -- BIP_Formal_Suffix --
620 -----------------------
621
622 function BIP_Formal_Suffix (Kind : BIP_Formal_Kind) return String is
623 begin
624 case Kind is
625 when BIP_Alloc_Form =>
626 return "BIPalloc";
627
628 when BIP_Storage_Pool =>
629 return "BIPstoragepool";
630
631 when BIP_Finalization_Master =>
632 return "BIPfinalizationmaster";
633
634 when BIP_Task_Master =>
635 return "BIPtaskmaster";
636
637 when BIP_Activation_Chain =>
638 return "BIPactivationchain";
639
640 when BIP_Object_Access =>
641 return "BIPaccess";
642 end case;
643 end BIP_Formal_Suffix;
644
645 ---------------------------
646 -- Build_In_Place_Formal --
647 ---------------------------
648
649 function Build_In_Place_Formal
650 (Func : Entity_Id;
651 Kind : BIP_Formal_Kind) return Entity_Id
652 is
653 Formal_Suffix : constant String := BIP_Formal_Suffix (Kind);
654 Extra_Formal : Entity_Id := Extra_Formals (Func);
655
656 begin
657 -- Maybe it would be better for each implicit formal of a build-in-place
658 -- function to have a flag or a Uint attribute to identify it. ???
659
660 -- The return type in the function declaration may have been a limited
661 -- view, and the extra formals for the function were not generated at
662 -- that point. At the point of call the full view must be available and
663 -- the extra formals can be created.
664
665 if No (Extra_Formal) then
666 Create_Extra_Formals (Func);
667 Extra_Formal := Extra_Formals (Func);
668 end if;
669
670 -- We search for a formal with a matching suffix. We can't search
671 -- for the full name, because of the code at the end of Sem_Ch6.-
672 -- Create_Extra_Formals, which copies the Extra_Formals over to
673 -- the Alias of an instance, which will cause the formals to have
674 -- "incorrect" names.
675
676 loop
677 pragma Assert (Present (Extra_Formal));
678 declare
679 Name : constant String := Get_Name_String (Chars (Extra_Formal));
680 begin
681 exit when Name'Length >= Formal_Suffix'Length
682 and then Formal_Suffix =
683 Name (Name'Last - Formal_Suffix'Length + 1 .. Name'Last);
684 end;
685
686 Next_Formal_With_Extras (Extra_Formal);
687 end loop;
688
689 return Extra_Formal;
690 end Build_In_Place_Formal;
691
692 -------------------------------
693 -- Build_Procedure_Body_Form --
694 -------------------------------
695
696 function Build_Procedure_Body_Form
697 (Func_Id : Entity_Id;
698 Func_Body : Node_Id) return Node_Id
699 is
700 Loc : constant Source_Ptr := Sloc (Func_Body);
701
702 Proc_Decl : constant Node_Id :=
703 Next (Unit_Declaration_Node (Func_Id));
704 -- It is assumed that the next node following the declaration of the
705 -- corresponding subprogram spec is the declaration of the procedure
706 -- form.
707
708 Proc_Id : constant Entity_Id := Defining_Entity (Proc_Decl);
709
710 procedure Replace_Returns (Param_Id : Entity_Id; Stmts : List_Id);
711 -- Replace each return statement found in the list Stmts with an
712 -- assignment of the return expression to parameter Param_Id.
713
714 ---------------------
715 -- Replace_Returns --
716 ---------------------
717
718 procedure Replace_Returns (Param_Id : Entity_Id; Stmts : List_Id) is
719 Stmt : Node_Id;
720
721 begin
722 Stmt := First (Stmts);
723 while Present (Stmt) loop
724 if Nkind (Stmt) = N_Block_Statement then
725 Replace_Returns (Param_Id,
726 Statements (Handled_Statement_Sequence (Stmt)));
727
728 elsif Nkind (Stmt) = N_Case_Statement then
729 declare
730 Alt : Node_Id;
731 begin
732 Alt := First (Alternatives (Stmt));
733 while Present (Alt) loop
734 Replace_Returns (Param_Id, Statements (Alt));
735 Next (Alt);
736 end loop;
737 end;
738
739 elsif Nkind (Stmt) = N_Extended_Return_Statement then
740 declare
741 Ret_Obj : constant Entity_Id :=
742 Defining_Entity
743 (First (Return_Object_Declarations (Stmt)));
744 Assign : constant Node_Id :=
745 Make_Assignment_Statement (Sloc (Stmt),
746 Name =>
747 New_Occurrence_Of (Param_Id, Loc),
748 Expression =>
749 New_Occurrence_Of (Ret_Obj, Sloc (Stmt)));
750 Stmts : List_Id;
751
752 begin
753 -- The extended return may just contain the declaration
754
755 if Present (Handled_Statement_Sequence (Stmt)) then
756 Stmts := Statements (Handled_Statement_Sequence (Stmt));
757 else
758 Stmts := New_List;
759 end if;
760
761 Set_Assignment_OK (Name (Assign));
762
763 Rewrite (Stmt,
764 Make_Block_Statement (Sloc (Stmt),
765 Declarations =>
766 Return_Object_Declarations (Stmt),
767 Handled_Statement_Sequence =>
768 Make_Handled_Sequence_Of_Statements (Loc,
769 Statements => Stmts)));
770
771 Replace_Returns (Param_Id, Stmts);
772
773 Append_To (Stmts, Assign);
774 Append_To (Stmts, Make_Simple_Return_Statement (Loc));
775 end;
776
777 elsif Nkind (Stmt) = N_If_Statement then
778 Replace_Returns (Param_Id, Then_Statements (Stmt));
779 Replace_Returns (Param_Id, Else_Statements (Stmt));
780
781 declare
782 Part : Node_Id;
783 begin
784 Part := First (Elsif_Parts (Stmt));
785 while Present (Part) loop
786 Replace_Returns (Param_Id, Then_Statements (Part));
787 Next (Part);
788 end loop;
789 end;
790
791 elsif Nkind (Stmt) = N_Loop_Statement then
792 Replace_Returns (Param_Id, Statements (Stmt));
793
794 elsif Nkind (Stmt) = N_Simple_Return_Statement then
795
796 -- Generate:
797 -- Param := Expr;
798 -- return;
799
800 Rewrite (Stmt,
801 Make_Assignment_Statement (Sloc (Stmt),
802 Name => New_Occurrence_Of (Param_Id, Loc),
803 Expression => Relocate_Node (Expression (Stmt))));
804
805 Insert_After (Stmt, Make_Simple_Return_Statement (Loc));
806
807 -- Skip the added return
808
809 Next (Stmt);
810 end if;
811
812 Next (Stmt);
813 end loop;
814 end Replace_Returns;
815
816 -- Local variables
817
818 Stmts : List_Id;
819 New_Body : Node_Id;
820
821 -- Start of processing for Build_Procedure_Body_Form
822
823 begin
824 -- This routine replaces the original function body:
825
826 -- function F (...) return Array_Typ is
827 -- begin
828 -- ...
829 -- return Something;
830 -- end F;
831
832 -- with the following:
833
834 -- procedure P (..., Result : out Array_Typ) is
835 -- begin
836 -- ...
837 -- Result := Something;
838 -- end P;
839
840 Stmts :=
841 Statements (Handled_Statement_Sequence (Func_Body));
842 Replace_Returns (Last_Entity (Proc_Id), Stmts);
843
844 New_Body :=
845 Make_Subprogram_Body (Loc,
846 Specification =>
847 Copy_Subprogram_Spec (Specification (Proc_Decl)),
848 Declarations => Declarations (Func_Body),
849 Handled_Statement_Sequence =>
850 Make_Handled_Sequence_Of_Statements (Loc,
851 Statements => Stmts));
852
853 -- If the function is a generic instance, so is the new procedure.
854 -- Set flag accordingly so that the proper renaming declarations are
855 -- generated.
856
857 Set_Is_Generic_Instance (Proc_Id, Is_Generic_Instance (Func_Id));
858 return New_Body;
859 end Build_Procedure_Body_Form;
860
861 -----------------------
862 -- Caller_Known_Size --
863 -----------------------
864
865 function Caller_Known_Size
866 (Func_Call : Node_Id;
867 Result_Subt : Entity_Id) return Boolean
868 is
869 begin
870 return
871 (Is_Definite_Subtype (Underlying_Type (Result_Subt))
872 and then No (Controlling_Argument (Func_Call)))
873 or else not Requires_Transient_Scope (Underlying_Type (Result_Subt));
874 end Caller_Known_Size;
875
876 --------------------------------
877 -- Check_Overriding_Operation --
878 --------------------------------
879
880 procedure Check_Overriding_Operation (Subp : Entity_Id) is
881 Typ : constant Entity_Id := Find_Dispatching_Type (Subp);
882 Op_List : constant Elist_Id := Primitive_Operations (Typ);
883 Op_Elmt : Elmt_Id;
884 Prim_Op : Entity_Id;
885 Par_Op : Entity_Id;
886
887 begin
888 if Is_Derived_Type (Typ)
889 and then not Is_Private_Type (Typ)
890 and then In_Open_Scopes (Scope (Etype (Typ)))
891 and then Is_Base_Type (Typ)
892 then
893 -- Subp overrides an inherited private operation if there is an
894 -- inherited operation with a different name than Subp (see
895 -- Derive_Subprogram) whose Alias is a hidden subprogram with the
896 -- same name as Subp.
897
898 Op_Elmt := First_Elmt (Op_List);
899 while Present (Op_Elmt) loop
900 Prim_Op := Node (Op_Elmt);
901 Par_Op := Alias (Prim_Op);
902
903 if Present (Par_Op)
904 and then not Comes_From_Source (Prim_Op)
905 and then Chars (Prim_Op) /= Chars (Par_Op)
906 and then Chars (Par_Op) = Chars (Subp)
907 and then Is_Hidden (Par_Op)
908 and then Type_Conformant (Prim_Op, Subp)
909 then
910 Set_DT_Position_Value (Subp, DT_Position (Prim_Op));
911 end if;
912
913 Next_Elmt (Op_Elmt);
914 end loop;
915 end if;
916 end Check_Overriding_Operation;
917
918 -------------------------------
919 -- Detect_Infinite_Recursion --
920 -------------------------------
921
922 procedure Detect_Infinite_Recursion (N : Node_Id; Spec : Entity_Id) is
923 Loc : constant Source_Ptr := Sloc (N);
924
925 Var_List : constant Elist_Id := New_Elmt_List;
926 -- List of globals referenced by body of procedure
927
928 Call_List : constant Elist_Id := New_Elmt_List;
929 -- List of recursive calls in body of procedure
930
931 Shad_List : constant Elist_Id := New_Elmt_List;
932 -- List of entity id's for entities created to capture the value of
933 -- referenced globals on entry to the procedure.
934
935 Scop : constant Uint := Scope_Depth (Spec);
936 -- This is used to record the scope depth of the current procedure, so
937 -- that we can identify global references.
938
939 Max_Vars : constant := 4;
940 -- Do not test more than four global variables
941
942 Count_Vars : Natural := 0;
943 -- Count variables found so far
944
945 Var : Entity_Id;
946 Elm : Elmt_Id;
947 Ent : Entity_Id;
948 Call : Elmt_Id;
949 Decl : Node_Id;
950 Test : Node_Id;
951 Elm1 : Elmt_Id;
952 Elm2 : Elmt_Id;
953 Last : Node_Id;
954
955 function Process (Nod : Node_Id) return Traverse_Result;
956 -- Function to traverse the subprogram body (using Traverse_Func)
957
958 -------------
959 -- Process --
960 -------------
961
962 function Process (Nod : Node_Id) return Traverse_Result is
963 begin
964 -- Procedure call
965
966 if Nkind (Nod) = N_Procedure_Call_Statement then
967
968 -- Case of one of the detected recursive calls
969
970 if Is_Entity_Name (Name (Nod))
971 and then Has_Recursive_Call (Entity (Name (Nod)))
972 and then Entity (Name (Nod)) = Spec
973 then
974 Append_Elmt (Nod, Call_List);
975 return Skip;
976
977 -- Any other procedure call may have side effects
978
979 else
980 return Abandon;
981 end if;
982
983 -- A call to a pure function can always be ignored
984
985 elsif Nkind (Nod) = N_Function_Call
986 and then Is_Entity_Name (Name (Nod))
987 and then Is_Pure (Entity (Name (Nod)))
988 then
989 return Skip;
990
991 -- Case of an identifier reference
992
993 elsif Nkind (Nod) = N_Identifier then
994 Ent := Entity (Nod);
995
996 -- If no entity, then ignore the reference
997
998 -- Not clear why this can happen. To investigate, remove this
999 -- test and look at the crash that occurs here in 3401-004 ???
1000
1001 if No (Ent) then
1002 return Skip;
1003
1004 -- Ignore entities with no Scope, again not clear how this
1005 -- can happen, to investigate, look at 4108-008 ???
1006
1007 elsif No (Scope (Ent)) then
1008 return Skip;
1009
1010 -- Ignore the reference if not to a more global object
1011
1012 elsif Scope_Depth (Scope (Ent)) >= Scop then
1013 return Skip;
1014
1015 -- References to types, exceptions and constants are always OK
1016
1017 elsif Is_Type (Ent)
1018 or else Ekind (Ent) = E_Exception
1019 or else Ekind (Ent) = E_Constant
1020 then
1021 return Skip;
1022
1023 -- If other than a non-volatile scalar variable, we have some
1024 -- kind of global reference (e.g. to a function) that we cannot
1025 -- deal with so we forget the attempt.
1026
1027 elsif Ekind (Ent) /= E_Variable
1028 or else not Is_Scalar_Type (Etype (Ent))
1029 or else Treat_As_Volatile (Ent)
1030 then
1031 return Abandon;
1032
1033 -- Otherwise we have a reference to a global scalar
1034
1035 else
1036 -- Loop through global entities already detected
1037
1038 Elm := First_Elmt (Var_List);
1039 loop
1040 -- If not detected before, record this new global reference
1041
1042 if No (Elm) then
1043 Count_Vars := Count_Vars + 1;
1044
1045 if Count_Vars <= Max_Vars then
1046 Append_Elmt (Entity (Nod), Var_List);
1047 else
1048 return Abandon;
1049 end if;
1050
1051 exit;
1052
1053 -- If recorded before, ignore
1054
1055 elsif Node (Elm) = Entity (Nod) then
1056 return Skip;
1057
1058 -- Otherwise keep looking
1059
1060 else
1061 Next_Elmt (Elm);
1062 end if;
1063 end loop;
1064
1065 return Skip;
1066 end if;
1067
1068 -- For all other node kinds, recursively visit syntactic children
1069
1070 else
1071 return OK;
1072 end if;
1073 end Process;
1074
1075 function Traverse_Body is new Traverse_Func (Process);
1076
1077 -- Start of processing for Detect_Infinite_Recursion
1078
1079 begin
1080 -- Do not attempt detection in No_Implicit_Conditional mode, since we
1081 -- won't be able to generate the code to handle the recursion in any
1082 -- case.
1083
1084 if Restriction_Active (No_Implicit_Conditionals) then
1085 return;
1086 end if;
1087
1088 -- Otherwise do traversal and quit if we get abandon signal
1089
1090 if Traverse_Body (N) = Abandon then
1091 return;
1092
1093 -- We must have a call, since Has_Recursive_Call was set. If not just
1094 -- ignore (this is only an error check, so if we have a funny situation,
1095 -- due to bugs or errors, we do not want to bomb).
1096
1097 elsif Is_Empty_Elmt_List (Call_List) then
1098 return;
1099 end if;
1100
1101 -- Here is the case where we detect recursion at compile time
1102
1103 -- Push our current scope for analyzing the declarations and code that
1104 -- we will insert for the checking.
1105
1106 Push_Scope (Spec);
1107
1108 -- This loop builds temporary variables for each of the referenced
1109 -- globals, so that at the end of the loop the list Shad_List contains
1110 -- these temporaries in one-to-one correspondence with the elements in
1111 -- Var_List.
1112
1113 Last := Empty;
1114 Elm := First_Elmt (Var_List);
1115 while Present (Elm) loop
1116 Var := Node (Elm);
1117 Ent := Make_Temporary (Loc, 'S');
1118 Append_Elmt (Ent, Shad_List);
1119
1120 -- Insert a declaration for this temporary at the start of the
1121 -- declarations for the procedure. The temporaries are declared as
1122 -- constant objects initialized to the current values of the
1123 -- corresponding temporaries.
1124
1125 Decl :=
1126 Make_Object_Declaration (Loc,
1127 Defining_Identifier => Ent,
1128 Object_Definition => New_Occurrence_Of (Etype (Var), Loc),
1129 Constant_Present => True,
1130 Expression => New_Occurrence_Of (Var, Loc));
1131
1132 if No (Last) then
1133 Prepend (Decl, Declarations (N));
1134 else
1135 Insert_After (Last, Decl);
1136 end if;
1137
1138 Last := Decl;
1139 Analyze (Decl);
1140 Next_Elmt (Elm);
1141 end loop;
1142
1143 -- Loop through calls
1144
1145 Call := First_Elmt (Call_List);
1146 while Present (Call) loop
1147
1148 -- Build a predicate expression of the form
1149
1150 -- True
1151 -- and then global1 = temp1
1152 -- and then global2 = temp2
1153 -- ...
1154
1155 -- This predicate determines if any of the global values
1156 -- referenced by the procedure have changed since the
1157 -- current call, if not an infinite recursion is assured.
1158
1159 Test := New_Occurrence_Of (Standard_True, Loc);
1160
1161 Elm1 := First_Elmt (Var_List);
1162 Elm2 := First_Elmt (Shad_List);
1163 while Present (Elm1) loop
1164 Test :=
1165 Make_And_Then (Loc,
1166 Left_Opnd => Test,
1167 Right_Opnd =>
1168 Make_Op_Eq (Loc,
1169 Left_Opnd => New_Occurrence_Of (Node (Elm1), Loc),
1170 Right_Opnd => New_Occurrence_Of (Node (Elm2), Loc)));
1171
1172 Next_Elmt (Elm1);
1173 Next_Elmt (Elm2);
1174 end loop;
1175
1176 -- Now we replace the call with the sequence
1177
1178 -- if no-changes (see above) then
1179 -- raise Storage_Error;
1180 -- else
1181 -- original-call
1182 -- end if;
1183
1184 Rewrite (Node (Call),
1185 Make_If_Statement (Loc,
1186 Condition => Test,
1187 Then_Statements => New_List (
1188 Make_Raise_Storage_Error (Loc,
1189 Reason => SE_Infinite_Recursion)),
1190
1191 Else_Statements => New_List (
1192 Relocate_Node (Node (Call)))));
1193
1194 Analyze (Node (Call));
1195
1196 Next_Elmt (Call);
1197 end loop;
1198
1199 -- Remove temporary scope stack entry used for analysis
1200
1201 Pop_Scope;
1202 end Detect_Infinite_Recursion;
1203
1204 --------------------
1205 -- Expand_Actuals --
1206 --------------------
1207
1208 procedure Expand_Actuals
1209 (N : Node_Id;
1210 Subp : Entity_Id;
1211 Post_Call : out List_Id)
1212 is
1213 Loc : constant Source_Ptr := Sloc (N);
1214 Actual : Node_Id;
1215 Formal : Entity_Id;
1216 N_Node : Node_Id;
1217 E_Actual : Entity_Id;
1218 E_Formal : Entity_Id;
1219
1220 procedure Add_Call_By_Copy_Code;
1221 -- For cases where the parameter must be passed by copy, this routine
1222 -- generates a temporary variable into which the actual is copied and
1223 -- then passes this as the parameter. For an OUT or IN OUT parameter,
1224 -- an assignment is also generated to copy the result back. The call
1225 -- also takes care of any constraint checks required for the type
1226 -- conversion case (on both the way in and the way out).
1227
1228 procedure Add_Simple_Call_By_Copy_Code;
1229 -- This is similar to the above, but is used in cases where we know
1230 -- that all that is needed is to simply create a temporary and copy
1231 -- the value in and out of the temporary.
1232
1233 procedure Add_Validation_Call_By_Copy_Code (Act : Node_Id);
1234 -- Perform copy-back for actual parameter Act which denotes a validation
1235 -- variable.
1236
1237 procedure Check_Fortran_Logical;
1238 -- A value of type Logical that is passed through a formal parameter
1239 -- must be normalized because .TRUE. usually does not have the same
1240 -- representation as True. We assume that .FALSE. = False = 0.
1241 -- What about functions that return a logical type ???
1242
1243 function Is_Legal_Copy return Boolean;
1244 -- Check that an actual can be copied before generating the temporary
1245 -- to be used in the call. If the actual is of a by_reference type then
1246 -- the program is illegal (this can only happen in the presence of
1247 -- rep. clauses that force an incorrect alignment). If the formal is
1248 -- a by_reference parameter imposed by a DEC pragma, emit a warning to
1249 -- the effect that this might lead to unaligned arguments.
1250
1251 function Make_Var (Actual : Node_Id) return Entity_Id;
1252 -- Returns an entity that refers to the given actual parameter, Actual
1253 -- (not including any type conversion). If Actual is an entity name,
1254 -- then this entity is returned unchanged, otherwise a renaming is
1255 -- created to provide an entity for the actual.
1256
1257 procedure Reset_Packed_Prefix;
1258 -- The expansion of a packed array component reference is delayed in
1259 -- the context of a call. Now we need to complete the expansion, so we
1260 -- unmark the analyzed bits in all prefixes.
1261
1262 ---------------------------
1263 -- Add_Call_By_Copy_Code --
1264 ---------------------------
1265
1266 procedure Add_Call_By_Copy_Code is
1267 Crep : Boolean;
1268 Expr : Node_Id;
1269 F_Typ : Entity_Id := Etype (Formal);
1270 Indic : Node_Id;
1271 Init : Node_Id;
1272 Temp : Entity_Id;
1273 V_Typ : Entity_Id;
1274 Var : Entity_Id;
1275
1276 begin
1277 if not Is_Legal_Copy then
1278 return;
1279 end if;
1280
1281 Temp := Make_Temporary (Loc, 'T', Actual);
1282
1283 -- Handle formals whose type comes from the limited view
1284
1285 if From_Limited_With (F_Typ)
1286 and then Has_Non_Limited_View (F_Typ)
1287 then
1288 F_Typ := Non_Limited_View (F_Typ);
1289 end if;
1290
1291 -- Use formal type for temp, unless formal type is an unconstrained
1292 -- array, in which case we don't have to worry about bounds checks,
1293 -- and we use the actual type, since that has appropriate bounds.
1294
1295 if Is_Array_Type (F_Typ) and then not Is_Constrained (F_Typ) then
1296 Indic := New_Occurrence_Of (Etype (Actual), Loc);
1297 else
1298 Indic := New_Occurrence_Of (F_Typ, Loc);
1299 end if;
1300
1301 if Nkind (Actual) = N_Type_Conversion then
1302 V_Typ := Etype (Expression (Actual));
1303
1304 -- If the formal is an (in-)out parameter, capture the name
1305 -- of the variable in order to build the post-call assignment.
1306
1307 Var := Make_Var (Expression (Actual));
1308
1309 Crep := not Same_Representation
1310 (F_Typ, Etype (Expression (Actual)));
1311
1312 else
1313 V_Typ := Etype (Actual);
1314 Var := Make_Var (Actual);
1315 Crep := False;
1316 end if;
1317
1318 -- Setup initialization for case of in out parameter, or an out
1319 -- parameter where the formal is an unconstrained array (in the
1320 -- latter case, we have to pass in an object with bounds).
1321
1322 -- If this is an out parameter, the initial copy is wasteful, so as
1323 -- an optimization for the one-dimensional case we extract the
1324 -- bounds of the actual and build an uninitialized temporary of the
1325 -- right size.
1326
1327 if Ekind (Formal) = E_In_Out_Parameter
1328 or else (Is_Array_Type (F_Typ) and then not Is_Constrained (F_Typ))
1329 then
1330 if Nkind (Actual) = N_Type_Conversion then
1331 if Conversion_OK (Actual) then
1332 Init := OK_Convert_To (F_Typ, New_Occurrence_Of (Var, Loc));
1333 else
1334 Init := Convert_To (F_Typ, New_Occurrence_Of (Var, Loc));
1335 end if;
1336
1337 elsif Ekind (Formal) = E_Out_Parameter
1338 and then Is_Array_Type (F_Typ)
1339 and then Number_Dimensions (F_Typ) = 1
1340 and then not Has_Non_Null_Base_Init_Proc (F_Typ)
1341 then
1342 -- Actual is a one-dimensional array or slice, and the type
1343 -- requires no initialization. Create a temporary of the
1344 -- right size, but do not copy actual into it (optimization).
1345
1346 Init := Empty;
1347 Indic :=
1348 Make_Subtype_Indication (Loc,
1349 Subtype_Mark => New_Occurrence_Of (F_Typ, Loc),
1350 Constraint =>
1351 Make_Index_Or_Discriminant_Constraint (Loc,
1352 Constraints => New_List (
1353 Make_Range (Loc,
1354 Low_Bound =>
1355 Make_Attribute_Reference (Loc,
1356 Prefix => New_Occurrence_Of (Var, Loc),
1357 Attribute_Name => Name_First),
1358 High_Bound =>
1359 Make_Attribute_Reference (Loc,
1360 Prefix => New_Occurrence_Of (Var, Loc),
1361 Attribute_Name => Name_Last)))));
1362
1363 else
1364 Init := New_Occurrence_Of (Var, Loc);
1365 end if;
1366
1367 -- An initialization is created for packed conversions as
1368 -- actuals for out parameters to enable Make_Object_Declaration
1369 -- to determine the proper subtype for N_Node. Note that this
1370 -- is wasteful because the extra copying on the call side is
1371 -- not required for such out parameters. ???
1372
1373 elsif Ekind (Formal) = E_Out_Parameter
1374 and then Nkind (Actual) = N_Type_Conversion
1375 and then (Is_Bit_Packed_Array (F_Typ)
1376 or else
1377 Is_Bit_Packed_Array (Etype (Expression (Actual))))
1378 then
1379 if Conversion_OK (Actual) then
1380 Init := OK_Convert_To (F_Typ, New_Occurrence_Of (Var, Loc));
1381 else
1382 Init := Convert_To (F_Typ, New_Occurrence_Of (Var, Loc));
1383 end if;
1384
1385 elsif Ekind (Formal) = E_In_Parameter then
1386
1387 -- Handle the case in which the actual is a type conversion
1388
1389 if Nkind (Actual) = N_Type_Conversion then
1390 if Conversion_OK (Actual) then
1391 Init := OK_Convert_To (F_Typ, New_Occurrence_Of (Var, Loc));
1392 else
1393 Init := Convert_To (F_Typ, New_Occurrence_Of (Var, Loc));
1394 end if;
1395 else
1396 Init := New_Occurrence_Of (Var, Loc);
1397 end if;
1398
1399 else
1400 Init := Empty;
1401 end if;
1402
1403 N_Node :=
1404 Make_Object_Declaration (Loc,
1405 Defining_Identifier => Temp,
1406 Object_Definition => Indic,
1407 Expression => Init);
1408 Set_Assignment_OK (N_Node);
1409 Insert_Action (N, N_Node);
1410
1411 -- Now, normally the deal here is that we use the defining
1412 -- identifier created by that object declaration. There is
1413 -- one exception to this. In the change of representation case
1414 -- the above declaration will end up looking like:
1415
1416 -- temp : type := identifier;
1417
1418 -- And in this case we might as well use the identifier directly
1419 -- and eliminate the temporary. Note that the analysis of the
1420 -- declaration was not a waste of time in that case, since it is
1421 -- what generated the necessary change of representation code. If
1422 -- the change of representation introduced additional code, as in
1423 -- a fixed-integer conversion, the expression is not an identifier
1424 -- and must be kept.
1425
1426 if Crep
1427 and then Present (Expression (N_Node))
1428 and then Is_Entity_Name (Expression (N_Node))
1429 then
1430 Temp := Entity (Expression (N_Node));
1431 Rewrite (N_Node, Make_Null_Statement (Loc));
1432 end if;
1433
1434 -- For IN parameter, all we do is to replace the actual
1435
1436 if Ekind (Formal) = E_In_Parameter then
1437 Rewrite (Actual, New_Occurrence_Of (Temp, Loc));
1438 Analyze (Actual);
1439
1440 -- Processing for OUT or IN OUT parameter
1441
1442 else
1443 -- Kill current value indications for the temporary variable we
1444 -- created, since we just passed it as an OUT parameter.
1445
1446 Kill_Current_Values (Temp);
1447 Set_Is_Known_Valid (Temp, False);
1448
1449 -- If type conversion, use reverse conversion on exit
1450
1451 if Nkind (Actual) = N_Type_Conversion then
1452 if Conversion_OK (Actual) then
1453 Expr := OK_Convert_To (V_Typ, New_Occurrence_Of (Temp, Loc));
1454 else
1455 Expr := Convert_To (V_Typ, New_Occurrence_Of (Temp, Loc));
1456 end if;
1457 else
1458 Expr := New_Occurrence_Of (Temp, Loc);
1459 end if;
1460
1461 Rewrite (Actual, New_Occurrence_Of (Temp, Loc));
1462 Analyze (Actual);
1463
1464 -- If the actual is a conversion of a packed reference, it may
1465 -- already have been expanded by Remove_Side_Effects, and the
1466 -- resulting variable is a temporary which does not designate
1467 -- the proper out-parameter, which may not be addressable. In
1468 -- that case, generate an assignment to the original expression
1469 -- (before expansion of the packed reference) so that the proper
1470 -- expansion of assignment to a packed component can take place.
1471
1472 declare
1473 Obj : Node_Id;
1474 Lhs : Node_Id;
1475
1476 begin
1477 if Is_Renaming_Of_Object (Var)
1478 and then Nkind (Renamed_Object (Var)) = N_Selected_Component
1479 and then Nkind (Original_Node (Prefix (Renamed_Object (Var))))
1480 = N_Indexed_Component
1481 and then
1482 Has_Non_Standard_Rep (Etype (Prefix (Renamed_Object (Var))))
1483 then
1484 Obj := Renamed_Object (Var);
1485 Lhs :=
1486 Make_Selected_Component (Loc,
1487 Prefix =>
1488 New_Copy_Tree (Original_Node (Prefix (Obj))),
1489 Selector_Name => New_Copy (Selector_Name (Obj)));
1490 Reset_Analyzed_Flags (Lhs);
1491
1492 else
1493 Lhs := New_Occurrence_Of (Var, Loc);
1494 end if;
1495
1496 Set_Assignment_OK (Lhs);
1497
1498 if Is_Access_Type (E_Formal)
1499 and then Is_Entity_Name (Lhs)
1500 and then
1501 Present (Effective_Extra_Accessibility (Entity (Lhs)))
1502 then
1503 -- Copyback target is an Ada 2012 stand-alone object of an
1504 -- anonymous access type.
1505
1506 pragma Assert (Ada_Version >= Ada_2012);
1507
1508 if Type_Access_Level (E_Formal) >
1509 Object_Access_Level (Lhs)
1510 then
1511 Append_To (Post_Call,
1512 Make_Raise_Program_Error (Loc,
1513 Reason => PE_Accessibility_Check_Failed));
1514 end if;
1515
1516 Append_To (Post_Call,
1517 Make_Assignment_Statement (Loc,
1518 Name => Lhs,
1519 Expression => Expr));
1520
1521 -- We would like to somehow suppress generation of the
1522 -- extra_accessibility assignment generated by the expansion
1523 -- of the above assignment statement. It's not a correctness
1524 -- issue because the following assignment renders it dead,
1525 -- but generating back-to-back assignments to the same
1526 -- target is undesirable. ???
1527
1528 Append_To (Post_Call,
1529 Make_Assignment_Statement (Loc,
1530 Name => New_Occurrence_Of (
1531 Effective_Extra_Accessibility (Entity (Lhs)), Loc),
1532 Expression => Make_Integer_Literal (Loc,
1533 Type_Access_Level (E_Formal))));
1534
1535 else
1536 Append_To (Post_Call,
1537 Make_Assignment_Statement (Loc,
1538 Name => Lhs,
1539 Expression => Expr));
1540 end if;
1541 end;
1542 end if;
1543 end Add_Call_By_Copy_Code;
1544
1545 ----------------------------------
1546 -- Add_Simple_Call_By_Copy_Code --
1547 ----------------------------------
1548
1549 procedure Add_Simple_Call_By_Copy_Code is
1550 Decl : Node_Id;
1551 F_Typ : Entity_Id := Etype (Formal);
1552 Incod : Node_Id;
1553 Indic : Node_Id;
1554 Lhs : Node_Id;
1555 Outcod : Node_Id;
1556 Rhs : Node_Id;
1557 Temp : Entity_Id;
1558
1559 begin
1560 if not Is_Legal_Copy then
1561 return;
1562 end if;
1563
1564 -- Handle formals whose type comes from the limited view
1565
1566 if From_Limited_With (F_Typ)
1567 and then Has_Non_Limited_View (F_Typ)
1568 then
1569 F_Typ := Non_Limited_View (F_Typ);
1570 end if;
1571
1572 -- Use formal type for temp, unless formal type is an unconstrained
1573 -- array, in which case we don't have to worry about bounds checks,
1574 -- and we use the actual type, since that has appropriate bounds.
1575
1576 if Is_Array_Type (F_Typ) and then not Is_Constrained (F_Typ) then
1577 Indic := New_Occurrence_Of (Etype (Actual), Loc);
1578 else
1579 Indic := New_Occurrence_Of (F_Typ, Loc);
1580 end if;
1581
1582 -- Prepare to generate code
1583
1584 Reset_Packed_Prefix;
1585
1586 Temp := Make_Temporary (Loc, 'T', Actual);
1587 Incod := Relocate_Node (Actual);
1588 Outcod := New_Copy_Tree (Incod);
1589
1590 -- Generate declaration of temporary variable, initializing it
1591 -- with the input parameter unless we have an OUT formal or
1592 -- this is an initialization call.
1593
1594 -- If the formal is an out parameter with discriminants, the
1595 -- discriminants must be captured even if the rest of the object
1596 -- is in principle uninitialized, because the discriminants may
1597 -- be read by the called subprogram.
1598
1599 if Ekind (Formal) = E_Out_Parameter then
1600 Incod := Empty;
1601
1602 if Has_Discriminants (F_Typ) then
1603 Indic := New_Occurrence_Of (Etype (Actual), Loc);
1604 end if;
1605
1606 elsif Inside_Init_Proc then
1607
1608 -- Could use a comment here to match comment below ???
1609
1610 if Nkind (Actual) /= N_Selected_Component
1611 or else
1612 not Has_Discriminant_Dependent_Constraint
1613 (Entity (Selector_Name (Actual)))
1614 then
1615 Incod := Empty;
1616
1617 -- Otherwise, keep the component in order to generate the proper
1618 -- actual subtype, that depends on enclosing discriminants.
1619
1620 else
1621 null;
1622 end if;
1623 end if;
1624
1625 Decl :=
1626 Make_Object_Declaration (Loc,
1627 Defining_Identifier => Temp,
1628 Object_Definition => Indic,
1629 Expression => Incod);
1630
1631 if Inside_Init_Proc
1632 and then No (Incod)
1633 then
1634 -- If the call is to initialize a component of a composite type,
1635 -- and the component does not depend on discriminants, use the
1636 -- actual type of the component. This is required in case the
1637 -- component is constrained, because in general the formal of the
1638 -- initialization procedure will be unconstrained. Note that if
1639 -- the component being initialized is constrained by an enclosing
1640 -- discriminant, the presence of the initialization in the
1641 -- declaration will generate an expression for the actual subtype.
1642
1643 Set_No_Initialization (Decl);
1644 Set_Object_Definition (Decl,
1645 New_Occurrence_Of (Etype (Actual), Loc));
1646 end if;
1647
1648 Insert_Action (N, Decl);
1649
1650 -- The actual is simply a reference to the temporary
1651
1652 Rewrite (Actual, New_Occurrence_Of (Temp, Loc));
1653
1654 -- Generate copy out if OUT or IN OUT parameter
1655
1656 if Ekind (Formal) /= E_In_Parameter then
1657 Lhs := Outcod;
1658 Rhs := New_Occurrence_Of (Temp, Loc);
1659
1660 -- Deal with conversion
1661
1662 if Nkind (Lhs) = N_Type_Conversion then
1663 Lhs := Expression (Lhs);
1664 Rhs := Convert_To (Etype (Actual), Rhs);
1665 end if;
1666
1667 Append_To (Post_Call,
1668 Make_Assignment_Statement (Loc,
1669 Name => Lhs,
1670 Expression => Rhs));
1671 Set_Assignment_OK (Name (Last (Post_Call)));
1672 end if;
1673 end Add_Simple_Call_By_Copy_Code;
1674
1675 --------------------------------------
1676 -- Add_Validation_Call_By_Copy_Code --
1677 --------------------------------------
1678
1679 procedure Add_Validation_Call_By_Copy_Code (Act : Node_Id) is
1680 Expr : Node_Id;
1681 Obj : Node_Id;
1682 Obj_Typ : Entity_Id;
1683 Var : constant Node_Id := Unqual_Conv (Act);
1684 Var_Id : Entity_Id;
1685
1686 begin
1687 -- Copy the value of the validation variable back into the object
1688 -- being validated.
1689
1690 if Is_Entity_Name (Var) then
1691 Var_Id := Entity (Var);
1692 Obj := Validated_Object (Var_Id);
1693 Obj_Typ := Etype (Obj);
1694
1695 Expr := New_Occurrence_Of (Var_Id, Loc);
1696
1697 -- A type conversion is needed when the validation variable and
1698 -- the validated object carry different types. This case occurs
1699 -- when the actual is qualified in some fashion.
1700
1701 -- Common:
1702 -- subtype Int is Integer range ...;
1703 -- procedure Call (Val : in out Integer);
1704
1705 -- Original:
1706 -- Object : Int;
1707 -- Call (Integer (Object));
1708
1709 -- Expanded:
1710 -- Object : Int;
1711 -- Var : Integer := Object; -- conversion to base type
1712 -- if not Var'Valid then -- validity check
1713 -- Call (Var); -- modify Var
1714 -- Object := Int (Var); -- conversion to subtype
1715
1716 if Etype (Var_Id) /= Obj_Typ then
1717 Expr :=
1718 Make_Type_Conversion (Loc,
1719 Subtype_Mark => New_Occurrence_Of (Obj_Typ, Loc),
1720 Expression => Expr);
1721 end if;
1722
1723 -- Generate:
1724 -- Object := Var;
1725 -- <or>
1726 -- Object := Object_Type (Var);
1727
1728 Append_To (Post_Call,
1729 Make_Assignment_Statement (Loc,
1730 Name => Obj,
1731 Expression => Expr));
1732
1733 -- If the flow reaches this point, then this routine was invoked with
1734 -- an actual which does not denote a validation variable.
1735
1736 else
1737 pragma Assert (False);
1738 null;
1739 end if;
1740 end Add_Validation_Call_By_Copy_Code;
1741
1742 ---------------------------
1743 -- Check_Fortran_Logical --
1744 ---------------------------
1745
1746 procedure Check_Fortran_Logical is
1747 Logical : constant Entity_Id := Etype (Formal);
1748 Var : Entity_Id;
1749
1750 -- Note: this is very incomplete, e.g. it does not handle arrays
1751 -- of logical values. This is really not the right approach at all???)
1752
1753 begin
1754 if Convention (Subp) = Convention_Fortran
1755 and then Root_Type (Etype (Formal)) = Standard_Boolean
1756 and then Ekind (Formal) /= E_In_Parameter
1757 then
1758 Var := Make_Var (Actual);
1759 Append_To (Post_Call,
1760 Make_Assignment_Statement (Loc,
1761 Name => New_Occurrence_Of (Var, Loc),
1762 Expression =>
1763 Unchecked_Convert_To (
1764 Logical,
1765 Make_Op_Ne (Loc,
1766 Left_Opnd => New_Occurrence_Of (Var, Loc),
1767 Right_Opnd =>
1768 Unchecked_Convert_To (
1769 Logical,
1770 New_Occurrence_Of (Standard_False, Loc))))));
1771 end if;
1772 end Check_Fortran_Logical;
1773
1774 -------------------
1775 -- Is_Legal_Copy --
1776 -------------------
1777
1778 function Is_Legal_Copy return Boolean is
1779 begin
1780 -- An attempt to copy a value of such a type can only occur if
1781 -- representation clauses give the actual a misaligned address.
1782
1783 if Is_By_Reference_Type (Etype (Formal)) then
1784
1785 -- The actual may in fact be properly aligned but there is not
1786 -- enough front-end information to determine this. In that case
1787 -- gigi will emit an error if a copy is not legal, or generate
1788 -- the proper code.
1789
1790 return False;
1791
1792 -- For users of Starlet, we assume that the specification of by-
1793 -- reference mechanism is mandatory. This may lead to unaligned
1794 -- objects but at least for DEC legacy code it is known to work.
1795 -- The warning will alert users of this code that a problem may
1796 -- be lurking.
1797
1798 elsif Mechanism (Formal) = By_Reference
1799 and then Is_Valued_Procedure (Scope (Formal))
1800 then
1801 Error_Msg_N
1802 ("by_reference actual may be misaligned??", Actual);
1803 return False;
1804
1805 else
1806 return True;
1807 end if;
1808 end Is_Legal_Copy;
1809
1810 --------------
1811 -- Make_Var --
1812 --------------
1813
1814 function Make_Var (Actual : Node_Id) return Entity_Id is
1815 Var : Entity_Id;
1816
1817 begin
1818 if Is_Entity_Name (Actual) then
1819 return Entity (Actual);
1820
1821 else
1822 Var := Make_Temporary (Loc, 'T', Actual);
1823
1824 N_Node :=
1825 Make_Object_Renaming_Declaration (Loc,
1826 Defining_Identifier => Var,
1827 Subtype_Mark =>
1828 New_Occurrence_Of (Etype (Actual), Loc),
1829 Name => Relocate_Node (Actual));
1830
1831 Insert_Action (N, N_Node);
1832 return Var;
1833 end if;
1834 end Make_Var;
1835
1836 -------------------------
1837 -- Reset_Packed_Prefix --
1838 -------------------------
1839
1840 procedure Reset_Packed_Prefix is
1841 Pfx : Node_Id := Actual;
1842 begin
1843 loop
1844 Set_Analyzed (Pfx, False);
1845 exit when
1846 not Nkind_In (Pfx, N_Selected_Component, N_Indexed_Component);
1847 Pfx := Prefix (Pfx);
1848 end loop;
1849 end Reset_Packed_Prefix;
1850
1851 -- Start of processing for Expand_Actuals
1852
1853 begin
1854 Post_Call := New_List;
1855
1856 Formal := First_Formal (Subp);
1857 Actual := First_Actual (N);
1858 while Present (Formal) loop
1859 E_Formal := Etype (Formal);
1860 E_Actual := Etype (Actual);
1861
1862 -- Handle formals whose type comes from the limited view
1863
1864 if From_Limited_With (E_Formal)
1865 and then Has_Non_Limited_View (E_Formal)
1866 then
1867 E_Formal := Non_Limited_View (E_Formal);
1868 end if;
1869
1870 if Is_Scalar_Type (E_Formal)
1871 or else Nkind (Actual) = N_Slice
1872 then
1873 Check_Fortran_Logical;
1874
1875 -- RM 6.4.1 (11)
1876
1877 elsif Ekind (Formal) /= E_Out_Parameter then
1878
1879 -- The unusual case of the current instance of a protected type
1880 -- requires special handling. This can only occur in the context
1881 -- of a call within the body of a protected operation.
1882
1883 if Is_Entity_Name (Actual)
1884 and then Ekind (Entity (Actual)) = E_Protected_Type
1885 and then In_Open_Scopes (Entity (Actual))
1886 then
1887 if Scope (Subp) /= Entity (Actual) then
1888 Error_Msg_N
1889 ("operation outside protected type may not "
1890 & "call back its protected operations??", Actual);
1891 end if;
1892
1893 Rewrite (Actual,
1894 Expand_Protected_Object_Reference (N, Entity (Actual)));
1895 end if;
1896
1897 -- Ada 2005 (AI-318-02): If the actual parameter is a call to a
1898 -- build-in-place function, then a temporary return object needs
1899 -- to be created and access to it must be passed to the function.
1900 -- Currently we limit such functions to those with inherently
1901 -- limited result subtypes, but eventually we plan to expand the
1902 -- functions that are treated as build-in-place to include other
1903 -- composite result types.
1904
1905 if Is_Build_In_Place_Function_Call (Actual) then
1906 Make_Build_In_Place_Call_In_Anonymous_Context (Actual);
1907
1908 -- Ada 2005 (AI-318-02): Specialization of the previous case for
1909 -- actuals containing build-in-place function calls whose returned
1910 -- object covers interface types.
1911
1912 elsif Present (Unqual_BIP_Iface_Function_Call (Actual)) then
1913 Make_Build_In_Place_Iface_Call_In_Anonymous_Context (Actual);
1914 end if;
1915
1916 Apply_Constraint_Check (Actual, E_Formal);
1917
1918 -- Out parameter case. No constraint checks on access type
1919 -- RM 6.4.1 (13)
1920
1921 elsif Is_Access_Type (E_Formal) then
1922 null;
1923
1924 -- RM 6.4.1 (14)
1925
1926 elsif Has_Discriminants (Base_Type (E_Formal))
1927 or else Has_Non_Null_Base_Init_Proc (E_Formal)
1928 then
1929 Apply_Constraint_Check (Actual, E_Formal);
1930
1931 -- RM 6.4.1 (15)
1932
1933 else
1934 Apply_Constraint_Check (Actual, Base_Type (E_Formal));
1935 end if;
1936
1937 -- Processing for IN-OUT and OUT parameters
1938
1939 if Ekind (Formal) /= E_In_Parameter then
1940
1941 -- For type conversions of arrays, apply length/range checks
1942
1943 if Is_Array_Type (E_Formal)
1944 and then Nkind (Actual) = N_Type_Conversion
1945 then
1946 if Is_Constrained (E_Formal) then
1947 Apply_Length_Check (Expression (Actual), E_Formal);
1948 else
1949 Apply_Range_Check (Expression (Actual), E_Formal);
1950 end if;
1951 end if;
1952
1953 -- The actual denotes a variable which captures the value of an
1954 -- object for validation purposes. Add a copy-back to reflect any
1955 -- potential changes in value back into the original object.
1956
1957 -- Var : ... := Object;
1958 -- if not Var'Valid then -- validity check
1959 -- Call (Var); -- modify var
1960 -- Object := Var; -- update Object
1961
1962 -- This case is given higher priority because the subsequent check
1963 -- for type conversion may add an extra copy of the variable and
1964 -- prevent proper value propagation back in the original object.
1965
1966 if Is_Validation_Variable_Reference (Actual) then
1967 Add_Validation_Call_By_Copy_Code (Actual);
1968
1969 -- If argument is a type conversion for a type that is passed by
1970 -- copy, then we must pass the parameter by copy.
1971
1972 elsif Nkind (Actual) = N_Type_Conversion
1973 and then
1974 (Is_Numeric_Type (E_Formal)
1975 or else Is_Access_Type (E_Formal)
1976 or else Is_Enumeration_Type (E_Formal)
1977 or else Is_Bit_Packed_Array (Etype (Formal))
1978 or else Is_Bit_Packed_Array (Etype (Expression (Actual)))
1979
1980 -- Also pass by copy if change of representation
1981
1982 or else not Same_Representation
1983 (Etype (Formal),
1984 Etype (Expression (Actual))))
1985 then
1986 Add_Call_By_Copy_Code;
1987
1988 -- References to components of bit-packed arrays are expanded
1989 -- at this point, rather than at the point of analysis of the
1990 -- actuals, to handle the expansion of the assignment to
1991 -- [in] out parameters.
1992
1993 elsif Is_Ref_To_Bit_Packed_Array (Actual) then
1994 Add_Simple_Call_By_Copy_Code;
1995
1996 -- If a non-scalar actual is possibly bit-aligned, we need a copy
1997 -- because the back-end cannot cope with such objects. In other
1998 -- cases where alignment forces a copy, the back-end generates
1999 -- it properly. It should not be generated unconditionally in the
2000 -- front-end because it does not know precisely the alignment
2001 -- requirements of the target, and makes too conservative an
2002 -- estimate, leading to superfluous copies or spurious errors
2003 -- on by-reference parameters.
2004
2005 elsif Nkind (Actual) = N_Selected_Component
2006 and then
2007 Component_May_Be_Bit_Aligned (Entity (Selector_Name (Actual)))
2008 and then not Represented_As_Scalar (Etype (Formal))
2009 then
2010 Add_Simple_Call_By_Copy_Code;
2011
2012 -- References to slices of bit-packed arrays are expanded
2013
2014 elsif Is_Ref_To_Bit_Packed_Slice (Actual) then
2015 Add_Call_By_Copy_Code;
2016
2017 -- References to possibly unaligned slices of arrays are expanded
2018
2019 elsif Is_Possibly_Unaligned_Slice (Actual) then
2020 Add_Call_By_Copy_Code;
2021
2022 -- Deal with access types where the actual subtype and the
2023 -- formal subtype are not the same, requiring a check.
2024
2025 -- It is necessary to exclude tagged types because of "downward
2026 -- conversion" errors.
2027
2028 elsif Is_Access_Type (E_Formal)
2029 and then not Same_Type (E_Formal, E_Actual)
2030 and then not Is_Tagged_Type (Designated_Type (E_Formal))
2031 then
2032 Add_Call_By_Copy_Code;
2033
2034 -- If the actual is not a scalar and is marked for volatile
2035 -- treatment, whereas the formal is not volatile, then pass
2036 -- by copy unless it is a by-reference type.
2037
2038 -- Note: we use Is_Volatile here rather than Treat_As_Volatile,
2039 -- because this is the enforcement of a language rule that applies
2040 -- only to "real" volatile variables, not e.g. to the address
2041 -- clause overlay case.
2042
2043 elsif Is_Entity_Name (Actual)
2044 and then Is_Volatile (Entity (Actual))
2045 and then not Is_By_Reference_Type (E_Actual)
2046 and then not Is_Scalar_Type (Etype (Entity (Actual)))
2047 and then not Is_Volatile (E_Formal)
2048 then
2049 Add_Call_By_Copy_Code;
2050
2051 elsif Nkind (Actual) = N_Indexed_Component
2052 and then Is_Entity_Name (Prefix (Actual))
2053 and then Has_Volatile_Components (Entity (Prefix (Actual)))
2054 then
2055 Add_Call_By_Copy_Code;
2056
2057 -- Add call-by-copy code for the case of scalar out parameters
2058 -- when it is not known at compile time that the subtype of the
2059 -- formal is a subrange of the subtype of the actual (or vice
2060 -- versa for in out parameters), in order to get range checks
2061 -- on such actuals. (Maybe this case should be handled earlier
2062 -- in the if statement???)
2063
2064 elsif Is_Scalar_Type (E_Formal)
2065 and then
2066 (not In_Subrange_Of (E_Formal, E_Actual)
2067 or else
2068 (Ekind (Formal) = E_In_Out_Parameter
2069 and then not In_Subrange_Of (E_Actual, E_Formal)))
2070 then
2071 -- Perhaps the setting back to False should be done within
2072 -- Add_Call_By_Copy_Code, since it could get set on other
2073 -- cases occurring above???
2074
2075 if Do_Range_Check (Actual) then
2076 Set_Do_Range_Check (Actual, False);
2077 end if;
2078
2079 Add_Call_By_Copy_Code;
2080 end if;
2081
2082 -- RM 3.2.4 (23/3): A predicate is checked on in-out and out
2083 -- by-reference parameters on exit from the call. If the actual
2084 -- is a derived type and the operation is inherited, the body
2085 -- of the operation will not contain a call to the predicate
2086 -- function, so it must be done explicitly after the call. Ditto
2087 -- if the actual is an entity of a predicated subtype.
2088
2089 -- The rule refers to by-reference types, but a check is needed
2090 -- for by-copy types as well. That check is subsumed by the rule
2091 -- for subtype conversion on assignment, but we can generate the
2092 -- required check now.
2093
2094 -- Note also that Subp may be either a subprogram entity for
2095 -- direct calls, or a type entity for indirect calls, which must
2096 -- be handled separately because the name does not denote an
2097 -- overloadable entity.
2098
2099 By_Ref_Predicate_Check : declare
2100 Aund : constant Entity_Id := Underlying_Type (E_Actual);
2101 Atyp : Entity_Id;
2102
2103 function Is_Public_Subp return Boolean;
2104 -- Check whether the subprogram being called is a visible
2105 -- operation of the type of the actual. Used to determine
2106 -- whether an invariant check must be generated on the
2107 -- caller side.
2108
2109 ---------------------
2110 -- Is_Public_Subp --
2111 ---------------------
2112
2113 function Is_Public_Subp return Boolean is
2114 Pack : constant Entity_Id := Scope (Subp);
2115 Subp_Decl : Node_Id;
2116
2117 begin
2118 if not Is_Subprogram (Subp) then
2119 return False;
2120
2121 -- The operation may be inherited, or a primitive of the
2122 -- root type.
2123
2124 elsif
2125 Nkind_In (Parent (Subp), N_Private_Extension_Declaration,
2126 N_Full_Type_Declaration)
2127 then
2128 Subp_Decl := Parent (Subp);
2129
2130 else
2131 Subp_Decl := Unit_Declaration_Node (Subp);
2132 end if;
2133
2134 return Ekind (Pack) = E_Package
2135 and then
2136 List_Containing (Subp_Decl) =
2137 Visible_Declarations
2138 (Specification (Unit_Declaration_Node (Pack)));
2139 end Is_Public_Subp;
2140
2141 -- Start of processing for By_Ref_Predicate_Check
2142
2143 begin
2144 if No (Aund) then
2145 Atyp := E_Actual;
2146 else
2147 Atyp := Aund;
2148 end if;
2149
2150 if Has_Predicates (Atyp)
2151 and then Present (Predicate_Function (Atyp))
2152
2153 -- Skip predicate checks for special cases
2154
2155 and then Predicate_Tests_On_Arguments (Subp)
2156 then
2157 Append_To (Post_Call,
2158 Make_Predicate_Check (Atyp, Actual));
2159 end if;
2160
2161 -- We generated caller-side invariant checks in two cases:
2162
2163 -- a) when calling an inherited operation, where there is an
2164 -- implicit view conversion of the actual to the parent type.
2165
2166 -- b) When the conversion is explicit
2167
2168 -- We treat these cases separately because the required
2169 -- conversion for a) is added later when expanding the call.
2170
2171 if Has_Invariants (Etype (Actual))
2172 and then
2173 Nkind (Parent (Subp)) = N_Private_Extension_Declaration
2174 then
2175 if Comes_From_Source (N) and then Is_Public_Subp then
2176 Append_To (Post_Call, Make_Invariant_Call (Actual));
2177 end if;
2178
2179 elsif Nkind (Actual) = N_Type_Conversion
2180 and then Has_Invariants (Etype (Expression (Actual)))
2181 then
2182 if Comes_From_Source (N) and then Is_Public_Subp then
2183 Append_To (Post_Call,
2184 Make_Invariant_Call (Expression (Actual)));
2185 end if;
2186 end if;
2187 end By_Ref_Predicate_Check;
2188
2189 -- Processing for IN parameters
2190
2191 else
2192 -- For IN parameters in the bit-packed array case, we expand an
2193 -- indexed component (the circuit in Exp_Ch4 deliberately left
2194 -- indexed components appearing as actuals untouched, so that
2195 -- the special processing above for the OUT and IN OUT cases
2196 -- could be performed. We could make the test in Exp_Ch4 more
2197 -- complex and have it detect the parameter mode, but it is
2198 -- easier simply to handle all cases here.)
2199
2200 if Nkind (Actual) = N_Indexed_Component
2201 and then Is_Bit_Packed_Array (Etype (Prefix (Actual)))
2202 then
2203 Reset_Packed_Prefix;
2204 Expand_Packed_Element_Reference (Actual);
2205
2206 -- If we have a reference to a bit-packed array, we copy it, since
2207 -- the actual must be byte aligned.
2208
2209 -- Is this really necessary in all cases???
2210
2211 elsif Is_Ref_To_Bit_Packed_Array (Actual) then
2212 Add_Simple_Call_By_Copy_Code;
2213
2214 -- If a non-scalar actual is possibly unaligned, we need a copy
2215
2216 elsif Is_Possibly_Unaligned_Object (Actual)
2217 and then not Represented_As_Scalar (Etype (Formal))
2218 then
2219 Add_Simple_Call_By_Copy_Code;
2220
2221 -- Similarly, we have to expand slices of packed arrays here
2222 -- because the result must be byte aligned.
2223
2224 elsif Is_Ref_To_Bit_Packed_Slice (Actual) then
2225 Add_Call_By_Copy_Code;
2226
2227 -- Only processing remaining is to pass by copy if this is a
2228 -- reference to a possibly unaligned slice, since the caller
2229 -- expects an appropriately aligned argument.
2230
2231 elsif Is_Possibly_Unaligned_Slice (Actual) then
2232 Add_Call_By_Copy_Code;
2233
2234 -- An unusual case: a current instance of an enclosing task can be
2235 -- an actual, and must be replaced by a reference to self.
2236
2237 elsif Is_Entity_Name (Actual)
2238 and then Is_Task_Type (Entity (Actual))
2239 then
2240 if In_Open_Scopes (Entity (Actual)) then
2241 Rewrite (Actual,
2242 (Make_Function_Call (Loc,
2243 Name => New_Occurrence_Of (RTE (RE_Self), Loc))));
2244 Analyze (Actual);
2245
2246 -- A task type cannot otherwise appear as an actual
2247
2248 else
2249 raise Program_Error;
2250 end if;
2251 end if;
2252 end if;
2253
2254 Next_Formal (Formal);
2255 Next_Actual (Actual);
2256 end loop;
2257 end Expand_Actuals;
2258
2259 -----------------
2260 -- Expand_Call --
2261 -----------------
2262
2263 procedure Expand_Call (N : Node_Id) is
2264 Post_Call : List_Id;
2265
2266 begin
2267 pragma Assert (Nkind_In (N, N_Entry_Call_Statement,
2268 N_Function_Call,
2269 N_Procedure_Call_Statement));
2270
2271 Expand_Call_Helper (N, Post_Call);
2272 Insert_Post_Call_Actions (N, Post_Call);
2273 end Expand_Call;
2274
2275 ------------------------
2276 -- Expand_Call_Helper --
2277 ------------------------
2278
2279 -- This procedure handles expansion of function calls and procedure call
2280 -- statements (i.e. it serves as the body for Expand_N_Function_Call and
2281 -- Expand_N_Procedure_Call_Statement). Processing for calls includes:
2282
2283 -- Replace call to Raise_Exception by Raise_Exception_Always if possible
2284 -- Provide values of actuals for all formals in Extra_Formals list
2285 -- Replace "call" to enumeration literal function by literal itself
2286 -- Rewrite call to predefined operator as operator
2287 -- Replace actuals to in-out parameters that are numeric conversions,
2288 -- with explicit assignment to temporaries before and after the call.
2289
2290 -- Note that the list of actuals has been filled with default expressions
2291 -- during semantic analysis of the call. Only the extra actuals required
2292 -- for the 'Constrained attribute and for accessibility checks are added
2293 -- at this point.
2294
2295 procedure Expand_Call_Helper (N : Node_Id; Post_Call : out List_Id) is
2296 Loc : constant Source_Ptr := Sloc (N);
2297 Call_Node : Node_Id := N;
2298 Extra_Actuals : List_Id := No_List;
2299 Prev : Node_Id := Empty;
2300
2301 procedure Add_Actual_Parameter (Insert_Param : Node_Id);
2302 -- Adds one entry to the end of the actual parameter list. Used for
2303 -- default parameters and for extra actuals (for Extra_Formals). The
2304 -- argument is an N_Parameter_Association node.
2305
2306 procedure Add_Extra_Actual (Expr : Node_Id; EF : Entity_Id);
2307 -- Adds an extra actual to the list of extra actuals. Expr is the
2308 -- expression for the value of the actual, EF is the entity for the
2309 -- extra formal.
2310
2311 procedure Add_View_Conversion_Invariants
2312 (Formal : Entity_Id;
2313 Actual : Node_Id);
2314 -- Adds invariant checks for every intermediate type between the range
2315 -- of a view converted argument to its ancestor (from parent to child).
2316
2317 function Inherited_From_Formal (S : Entity_Id) return Entity_Id;
2318 -- Within an instance, a type derived from an untagged formal derived
2319 -- type inherits from the original parent, not from the actual. The
2320 -- current derivation mechanism has the derived type inherit from the
2321 -- actual, which is only correct outside of the instance. If the
2322 -- subprogram is inherited, we test for this particular case through a
2323 -- convoluted tree traversal before setting the proper subprogram to be
2324 -- called.
2325
2326 function In_Unfrozen_Instance (E : Entity_Id) return Boolean;
2327 -- Return true if E comes from an instance that is not yet frozen
2328
2329 function Is_Direct_Deep_Call (Subp : Entity_Id) return Boolean;
2330 -- Determine if Subp denotes a non-dispatching call to a Deep routine
2331
2332 function New_Value (From : Node_Id) return Node_Id;
2333 -- From is the original Expression. New_Value is equivalent to a call
2334 -- to Duplicate_Subexpr with an explicit dereference when From is an
2335 -- access parameter.
2336
2337 --------------------------
2338 -- Add_Actual_Parameter --
2339 --------------------------
2340
2341 procedure Add_Actual_Parameter (Insert_Param : Node_Id) is
2342 Actual_Expr : constant Node_Id :=
2343 Explicit_Actual_Parameter (Insert_Param);
2344
2345 begin
2346 -- Case of insertion is first named actual
2347
2348 if No (Prev) or else
2349 Nkind (Parent (Prev)) /= N_Parameter_Association
2350 then
2351 Set_Next_Named_Actual
2352 (Insert_Param, First_Named_Actual (Call_Node));
2353 Set_First_Named_Actual (Call_Node, Actual_Expr);
2354
2355 if No (Prev) then
2356 if No (Parameter_Associations (Call_Node)) then
2357 Set_Parameter_Associations (Call_Node, New_List);
2358 end if;
2359
2360 Append (Insert_Param, Parameter_Associations (Call_Node));
2361
2362 else
2363 Insert_After (Prev, Insert_Param);
2364 end if;
2365
2366 -- Case of insertion is not first named actual
2367
2368 else
2369 Set_Next_Named_Actual
2370 (Insert_Param, Next_Named_Actual (Parent (Prev)));
2371 Set_Next_Named_Actual (Parent (Prev), Actual_Expr);
2372 Append (Insert_Param, Parameter_Associations (Call_Node));
2373 end if;
2374
2375 Prev := Actual_Expr;
2376 end Add_Actual_Parameter;
2377
2378 ----------------------
2379 -- Add_Extra_Actual --
2380 ----------------------
2381
2382 procedure Add_Extra_Actual (Expr : Node_Id; EF : Entity_Id) is
2383 Loc : constant Source_Ptr := Sloc (Expr);
2384
2385 begin
2386 if Extra_Actuals = No_List then
2387 Extra_Actuals := New_List;
2388 Set_Parent (Extra_Actuals, Call_Node);
2389 end if;
2390
2391 Append_To (Extra_Actuals,
2392 Make_Parameter_Association (Loc,
2393 Selector_Name => New_Occurrence_Of (EF, Loc),
2394 Explicit_Actual_Parameter => Expr));
2395
2396 Analyze_And_Resolve (Expr, Etype (EF));
2397
2398 if Nkind (Call_Node) = N_Function_Call then
2399 Set_Is_Accessibility_Actual (Parent (Expr));
2400 end if;
2401 end Add_Extra_Actual;
2402
2403 ------------------------------------
2404 -- Add_View_Conversion_Invariants --
2405 ------------------------------------
2406
2407 procedure Add_View_Conversion_Invariants
2408 (Formal : Entity_Id;
2409 Actual : Node_Id)
2410 is
2411 Arg : Entity_Id;
2412 Curr_Typ : Entity_Id;
2413 Inv_Checks : List_Id;
2414 Par_Typ : Entity_Id;
2415
2416 begin
2417 Inv_Checks := No_List;
2418
2419 -- Extract the argument from a potentially nested set of view
2420 -- conversions.
2421
2422 Arg := Actual;
2423 while Nkind (Arg) = N_Type_Conversion loop
2424 Arg := Expression (Arg);
2425 end loop;
2426
2427 -- Move up the derivation chain starting with the type of the formal
2428 -- parameter down to the type of the actual object.
2429
2430 Curr_Typ := Empty;
2431 Par_Typ := Etype (Arg);
2432 while Par_Typ /= Etype (Formal) and Par_Typ /= Curr_Typ loop
2433 Curr_Typ := Par_Typ;
2434
2435 if Has_Invariants (Curr_Typ)
2436 and then Present (Invariant_Procedure (Curr_Typ))
2437 then
2438 -- Verify the invariate of the current type. Generate:
2439
2440 -- <Curr_Typ>Invariant (Curr_Typ (Arg));
2441
2442 Prepend_New_To (Inv_Checks,
2443 Make_Procedure_Call_Statement (Loc,
2444 Name =>
2445 New_Occurrence_Of
2446 (Invariant_Procedure (Curr_Typ), Loc),
2447 Parameter_Associations => New_List (
2448 Make_Type_Conversion (Loc,
2449 Subtype_Mark => New_Occurrence_Of (Curr_Typ, Loc),
2450 Expression => New_Copy_Tree (Arg)))));
2451 end if;
2452
2453 Par_Typ := Base_Type (Etype (Curr_Typ));
2454 end loop;
2455
2456 if not Is_Empty_List (Inv_Checks) then
2457 Insert_Actions_After (N, Inv_Checks);
2458 end if;
2459 end Add_View_Conversion_Invariants;
2460
2461 ---------------------------
2462 -- Inherited_From_Formal --
2463 ---------------------------
2464
2465 function Inherited_From_Formal (S : Entity_Id) return Entity_Id is
2466 Par : Entity_Id;
2467 Gen_Par : Entity_Id;
2468 Gen_Prim : Elist_Id;
2469 Elmt : Elmt_Id;
2470 Indic : Node_Id;
2471
2472 begin
2473 -- If the operation is inherited, it is attached to the corresponding
2474 -- type derivation. If the parent in the derivation is a generic
2475 -- actual, it is a subtype of the actual, and we have to recover the
2476 -- original derived type declaration to find the proper parent.
2477
2478 if Nkind (Parent (S)) /= N_Full_Type_Declaration
2479 or else not Is_Derived_Type (Defining_Identifier (Parent (S)))
2480 or else Nkind (Type_Definition (Original_Node (Parent (S)))) /=
2481 N_Derived_Type_Definition
2482 or else not In_Instance
2483 then
2484 return Empty;
2485
2486 else
2487 Indic :=
2488 Subtype_Indication
2489 (Type_Definition (Original_Node (Parent (S))));
2490
2491 if Nkind (Indic) = N_Subtype_Indication then
2492 Par := Entity (Subtype_Mark (Indic));
2493 else
2494 Par := Entity (Indic);
2495 end if;
2496 end if;
2497
2498 if not Is_Generic_Actual_Type (Par)
2499 or else Is_Tagged_Type (Par)
2500 or else Nkind (Parent (Par)) /= N_Subtype_Declaration
2501 or else not In_Open_Scopes (Scope (Par))
2502 then
2503 return Empty;
2504 else
2505 Gen_Par := Generic_Parent_Type (Parent (Par));
2506 end if;
2507
2508 -- If the actual has no generic parent type, the formal is not
2509 -- a formal derived type, so nothing to inherit.
2510
2511 if No (Gen_Par) then
2512 return Empty;
2513 end if;
2514
2515 -- If the generic parent type is still the generic type, this is a
2516 -- private formal, not a derived formal, and there are no operations
2517 -- inherited from the formal.
2518
2519 if Nkind (Parent (Gen_Par)) = N_Formal_Type_Declaration then
2520 return Empty;
2521 end if;
2522
2523 Gen_Prim := Collect_Primitive_Operations (Gen_Par);
2524
2525 Elmt := First_Elmt (Gen_Prim);
2526 while Present (Elmt) loop
2527 if Chars (Node (Elmt)) = Chars (S) then
2528 declare
2529 F1 : Entity_Id;
2530 F2 : Entity_Id;
2531
2532 begin
2533 F1 := First_Formal (S);
2534 F2 := First_Formal (Node (Elmt));
2535 while Present (F1)
2536 and then Present (F2)
2537 loop
2538 if Etype (F1) = Etype (F2)
2539 or else Etype (F2) = Gen_Par
2540 then
2541 Next_Formal (F1);
2542 Next_Formal (F2);
2543 else
2544 Next_Elmt (Elmt);
2545 exit; -- not the right subprogram
2546 end if;
2547
2548 return Node (Elmt);
2549 end loop;
2550 end;
2551
2552 else
2553 Next_Elmt (Elmt);
2554 end if;
2555 end loop;
2556
2557 raise Program_Error;
2558 end Inherited_From_Formal;
2559
2560 --------------------------
2561 -- In_Unfrozen_Instance --
2562 --------------------------
2563
2564 function In_Unfrozen_Instance (E : Entity_Id) return Boolean is
2565 S : Entity_Id;
2566
2567 begin
2568 S := E;
2569 while Present (S) and then S /= Standard_Standard loop
2570 if Is_Generic_Instance (S)
2571 and then Present (Freeze_Node (S))
2572 and then not Analyzed (Freeze_Node (S))
2573 then
2574 return True;
2575 end if;
2576
2577 S := Scope (S);
2578 end loop;
2579
2580 return False;
2581 end In_Unfrozen_Instance;
2582
2583 -------------------------
2584 -- Is_Direct_Deep_Call --
2585 -------------------------
2586
2587 function Is_Direct_Deep_Call (Subp : Entity_Id) return Boolean is
2588 begin
2589 if Is_TSS (Subp, TSS_Deep_Adjust)
2590 or else Is_TSS (Subp, TSS_Deep_Finalize)
2591 or else Is_TSS (Subp, TSS_Deep_Initialize)
2592 then
2593 declare
2594 Actual : Node_Id;
2595 Formal : Node_Id;
2596
2597 begin
2598 Actual := First (Parameter_Associations (N));
2599 Formal := First_Formal (Subp);
2600 while Present (Actual)
2601 and then Present (Formal)
2602 loop
2603 if Nkind (Actual) = N_Identifier
2604 and then Is_Controlling_Actual (Actual)
2605 and then Etype (Actual) = Etype (Formal)
2606 then
2607 return True;
2608 end if;
2609
2610 Next (Actual);
2611 Next_Formal (Formal);
2612 end loop;
2613 end;
2614 end if;
2615
2616 return False;
2617 end Is_Direct_Deep_Call;
2618
2619 ---------------
2620 -- New_Value --
2621 ---------------
2622
2623 function New_Value (From : Node_Id) return Node_Id is
2624 Res : constant Node_Id := Duplicate_Subexpr (From);
2625 begin
2626 if Is_Access_Type (Etype (From)) then
2627 return Make_Explicit_Dereference (Sloc (From), Prefix => Res);
2628 else
2629 return Res;
2630 end if;
2631 end New_Value;
2632
2633 -- Local variables
2634
2635 Remote : constant Boolean := Is_Remote_Call (Call_Node);
2636 Actual : Node_Id;
2637 Formal : Entity_Id;
2638 Orig_Subp : Entity_Id := Empty;
2639 Param_Count : Natural := 0;
2640 Parent_Formal : Entity_Id;
2641 Parent_Subp : Entity_Id;
2642 Pref_Entity : Entity_Id;
2643 Scop : Entity_Id;
2644 Subp : Entity_Id;
2645
2646 Prev_Orig : Node_Id;
2647 -- Original node for an actual, which may have been rewritten. If the
2648 -- actual is a function call that has been transformed from a selected
2649 -- component, the original node is unanalyzed. Otherwise, it carries
2650 -- semantic information used to generate additional actuals.
2651
2652 CW_Interface_Formals_Present : Boolean := False;
2653
2654 -- Start of processing for Expand_Call_Helper
2655
2656 begin
2657 Post_Call := New_List;
2658
2659 -- Expand the function or procedure call if the first actual has a
2660 -- declared dimension aspect, and the subprogram is declared in one
2661 -- of the dimension I/O packages.
2662
2663 if Ada_Version >= Ada_2012
2664 and then
2665 Nkind_In (Call_Node, N_Procedure_Call_Statement, N_Function_Call)
2666 and then Present (Parameter_Associations (Call_Node))
2667 then
2668 Expand_Put_Call_With_Symbol (Call_Node);
2669 end if;
2670
2671 -- Ignore if previous error
2672
2673 if Nkind (Call_Node) in N_Has_Etype
2674 and then Etype (Call_Node) = Any_Type
2675 then
2676 return;
2677 end if;
2678
2679 -- Call using access to subprogram with explicit dereference
2680
2681 if Nkind (Name (Call_Node)) = N_Explicit_Dereference then
2682 Subp := Etype (Name (Call_Node));
2683 Parent_Subp := Empty;
2684
2685 -- Case of call to simple entry, where the Name is a selected component
2686 -- whose prefix is the task, and whose selector name is the entry name
2687
2688 elsif Nkind (Name (Call_Node)) = N_Selected_Component then
2689 Subp := Entity (Selector_Name (Name (Call_Node)));
2690 Parent_Subp := Empty;
2691
2692 -- Case of call to member of entry family, where Name is an indexed
2693 -- component, with the prefix being a selected component giving the
2694 -- task and entry family name, and the index being the entry index.
2695
2696 elsif Nkind (Name (Call_Node)) = N_Indexed_Component then
2697 Subp := Entity (Selector_Name (Prefix (Name (Call_Node))));
2698 Parent_Subp := Empty;
2699
2700 -- Normal case
2701
2702 else
2703 Subp := Entity (Name (Call_Node));
2704 Parent_Subp := Alias (Subp);
2705
2706 -- Replace call to Raise_Exception by call to Raise_Exception_Always
2707 -- if we can tell that the first parameter cannot possibly be null.
2708 -- This improves efficiency by avoiding a run-time test.
2709
2710 -- We do not do this if Raise_Exception_Always does not exist, which
2711 -- can happen in configurable run time profiles which provide only a
2712 -- Raise_Exception.
2713
2714 if Is_RTE (Subp, RE_Raise_Exception)
2715 and then RTE_Available (RE_Raise_Exception_Always)
2716 then
2717 declare
2718 FA : constant Node_Id :=
2719 Original_Node (First_Actual (Call_Node));
2720
2721 begin
2722 -- The case we catch is where the first argument is obtained
2723 -- using the Identity attribute (which must always be
2724 -- non-null).
2725
2726 if Nkind (FA) = N_Attribute_Reference
2727 and then Attribute_Name (FA) = Name_Identity
2728 then
2729 Subp := RTE (RE_Raise_Exception_Always);
2730 Set_Name (Call_Node, New_Occurrence_Of (Subp, Loc));
2731 end if;
2732 end;
2733 end if;
2734
2735 if Ekind (Subp) = E_Entry then
2736 Parent_Subp := Empty;
2737 end if;
2738 end if;
2739
2740 -- Ada 2005 (AI-345): We have a procedure call as a triggering
2741 -- alternative in an asynchronous select or as an entry call in
2742 -- a conditional or timed select. Check whether the procedure call
2743 -- is a renaming of an entry and rewrite it as an entry call.
2744
2745 if Ada_Version >= Ada_2005
2746 and then Nkind (Call_Node) = N_Procedure_Call_Statement
2747 and then
2748 ((Nkind (Parent (Call_Node)) = N_Triggering_Alternative
2749 and then Triggering_Statement (Parent (Call_Node)) = Call_Node)
2750 or else
2751 (Nkind (Parent (Call_Node)) = N_Entry_Call_Alternative
2752 and then Entry_Call_Statement (Parent (Call_Node)) = Call_Node))
2753 then
2754 declare
2755 Ren_Decl : Node_Id;
2756 Ren_Root : Entity_Id := Subp;
2757
2758 begin
2759 -- This may be a chain of renamings, find the root
2760
2761 if Present (Alias (Ren_Root)) then
2762 Ren_Root := Alias (Ren_Root);
2763 end if;
2764
2765 if Present (Original_Node (Parent (Parent (Ren_Root)))) then
2766 Ren_Decl := Original_Node (Parent (Parent (Ren_Root)));
2767
2768 if Nkind (Ren_Decl) = N_Subprogram_Renaming_Declaration then
2769 Rewrite (Call_Node,
2770 Make_Entry_Call_Statement (Loc,
2771 Name =>
2772 New_Copy_Tree (Name (Ren_Decl)),
2773 Parameter_Associations =>
2774 New_Copy_List_Tree
2775 (Parameter_Associations (Call_Node))));
2776
2777 return;
2778 end if;
2779 end if;
2780 end;
2781 end if;
2782
2783 if Modify_Tree_For_C
2784 and then Nkind (Call_Node) = N_Function_Call
2785 and then Is_Entity_Name (Name (Call_Node))
2786 then
2787 declare
2788 Func_Id : constant Entity_Id :=
2789 Ultimate_Alias (Entity (Name (Call_Node)));
2790 begin
2791 -- When generating C code, transform a function call that returns
2792 -- a constrained array type into procedure form.
2793
2794 if Rewritten_For_C (Func_Id) then
2795
2796 -- For internally generated calls ensure that they reference
2797 -- the entity of the spec of the called function (needed since
2798 -- the expander may generate calls using the entity of their
2799 -- body). See for example Expand_Boolean_Operator().
2800
2801 if not (Comes_From_Source (Call_Node))
2802 and then Nkind (Unit_Declaration_Node (Func_Id)) =
2803 N_Subprogram_Body
2804 then
2805 Set_Entity (Name (Call_Node),
2806 Corresponding_Function
2807 (Corresponding_Procedure (Func_Id)));
2808 end if;
2809
2810 Rewrite_Function_Call_For_C (Call_Node);
2811 return;
2812
2813 -- Also introduce a temporary for functions that return a record
2814 -- called within another procedure or function call, since records
2815 -- are passed by pointer in the generated C code, and we cannot
2816 -- take a pointer from a subprogram call.
2817
2818 elsif Nkind (Parent (Call_Node)) in N_Subprogram_Call
2819 and then Is_Record_Type (Etype (Func_Id))
2820 then
2821 declare
2822 Temp_Id : constant Entity_Id := Make_Temporary (Loc, 'T');
2823 Decl : Node_Id;
2824
2825 begin
2826 -- Generate:
2827 -- Temp : ... := Func_Call (...);
2828
2829 Decl :=
2830 Make_Object_Declaration (Loc,
2831 Defining_Identifier => Temp_Id,
2832 Object_Definition =>
2833 New_Occurrence_Of (Etype (Func_Id), Loc),
2834 Expression =>
2835 Make_Function_Call (Loc,
2836 Name =>
2837 New_Occurrence_Of (Func_Id, Loc),
2838 Parameter_Associations =>
2839 Parameter_Associations (Call_Node)));
2840
2841 Insert_Action (Parent (Call_Node), Decl);
2842 Rewrite (Call_Node, New_Occurrence_Of (Temp_Id, Loc));
2843 return;
2844 end;
2845 end if;
2846 end;
2847 end if;
2848
2849 -- First step, compute extra actuals, corresponding to any Extra_Formals
2850 -- present. Note that we do not access Extra_Formals directly, instead
2851 -- we simply note the presence of the extra formals as we process the
2852 -- regular formals collecting corresponding actuals in Extra_Actuals.
2853
2854 -- We also generate any required range checks for actuals for in formals
2855 -- as we go through the loop, since this is a convenient place to do it.
2856 -- (Though it seems that this would be better done in Expand_Actuals???)
2857
2858 -- Special case: Thunks must not compute the extra actuals; they must
2859 -- just propagate to the target primitive their extra actuals.
2860
2861 if Is_Thunk (Current_Scope)
2862 and then Thunk_Entity (Current_Scope) = Subp
2863 and then Present (Extra_Formals (Subp))
2864 then
2865 pragma Assert (Present (Extra_Formals (Current_Scope)));
2866
2867 declare
2868 Target_Formal : Entity_Id;
2869 Thunk_Formal : Entity_Id;
2870
2871 begin
2872 Target_Formal := Extra_Formals (Subp);
2873 Thunk_Formal := Extra_Formals (Current_Scope);
2874 while Present (Target_Formal) loop
2875 Add_Extra_Actual
2876 (Expr => New_Occurrence_Of (Thunk_Formal, Loc),
2877 EF => Thunk_Formal);
2878
2879 Target_Formal := Extra_Formal (Target_Formal);
2880 Thunk_Formal := Extra_Formal (Thunk_Formal);
2881 end loop;
2882
2883 while Is_Non_Empty_List (Extra_Actuals) loop
2884 Add_Actual_Parameter (Remove_Head (Extra_Actuals));
2885 end loop;
2886
2887 Expand_Actuals (Call_Node, Subp, Post_Call);
2888 pragma Assert (Is_Empty_List (Post_Call));
2889 return;
2890 end;
2891 end if;
2892
2893 Formal := First_Formal (Subp);
2894 Actual := First_Actual (Call_Node);
2895 Param_Count := 1;
2896 while Present (Formal) loop
2897
2898 -- Generate range check if required
2899
2900 if Do_Range_Check (Actual)
2901 and then Ekind (Formal) = E_In_Parameter
2902 then
2903 Generate_Range_Check
2904 (Actual, Etype (Formal), CE_Range_Check_Failed);
2905 end if;
2906
2907 -- Prepare to examine current entry
2908
2909 Prev := Actual;
2910 Prev_Orig := Original_Node (Prev);
2911
2912 -- Ada 2005 (AI-251): Check if any formal is a class-wide interface
2913 -- to expand it in a further round.
2914
2915 CW_Interface_Formals_Present :=
2916 CW_Interface_Formals_Present
2917 or else
2918 (Is_Class_Wide_Type (Etype (Formal))
2919 and then Is_Interface (Etype (Etype (Formal))))
2920 or else
2921 (Ekind (Etype (Formal)) = E_Anonymous_Access_Type
2922 and then Is_Class_Wide_Type (Directly_Designated_Type
2923 (Etype (Etype (Formal))))
2924 and then Is_Interface (Directly_Designated_Type
2925 (Etype (Etype (Formal)))));
2926
2927 -- Create possible extra actual for constrained case. Usually, the
2928 -- extra actual is of the form actual'constrained, but since this
2929 -- attribute is only available for unconstrained records, TRUE is
2930 -- expanded if the type of the formal happens to be constrained (for
2931 -- instance when this procedure is inherited from an unconstrained
2932 -- record to a constrained one) or if the actual has no discriminant
2933 -- (its type is constrained). An exception to this is the case of a
2934 -- private type without discriminants. In this case we pass FALSE
2935 -- because the object has underlying discriminants with defaults.
2936
2937 if Present (Extra_Constrained (Formal)) then
2938 if Ekind (Etype (Prev)) in Private_Kind
2939 and then not Has_Discriminants (Base_Type (Etype (Prev)))
2940 then
2941 Add_Extra_Actual
2942 (Expr => New_Occurrence_Of (Standard_False, Loc),
2943 EF => Extra_Constrained (Formal));
2944
2945 elsif Is_Constrained (Etype (Formal))
2946 or else not Has_Discriminants (Etype (Prev))
2947 then
2948 Add_Extra_Actual
2949 (Expr => New_Occurrence_Of (Standard_True, Loc),
2950 EF => Extra_Constrained (Formal));
2951
2952 -- Do not produce extra actuals for Unchecked_Union parameters.
2953 -- Jump directly to the end of the loop.
2954
2955 elsif Is_Unchecked_Union (Base_Type (Etype (Actual))) then
2956 goto Skip_Extra_Actual_Generation;
2957
2958 else
2959 -- If the actual is a type conversion, then the constrained
2960 -- test applies to the actual, not the target type.
2961
2962 declare
2963 Act_Prev : Node_Id;
2964
2965 begin
2966 -- Test for unchecked conversions as well, which can occur
2967 -- as out parameter actuals on calls to stream procedures.
2968
2969 Act_Prev := Prev;
2970 while Nkind_In (Act_Prev, N_Type_Conversion,
2971 N_Unchecked_Type_Conversion)
2972 loop
2973 Act_Prev := Expression (Act_Prev);
2974 end loop;
2975
2976 -- If the expression is a conversion of a dereference, this
2977 -- is internally generated code that manipulates addresses,
2978 -- e.g. when building interface tables. No check should
2979 -- occur in this case, and the discriminated object is not
2980 -- directly a hand.
2981
2982 if not Comes_From_Source (Actual)
2983 and then Nkind (Actual) = N_Unchecked_Type_Conversion
2984 and then Nkind (Act_Prev) = N_Explicit_Dereference
2985 then
2986 Add_Extra_Actual
2987 (Expr => New_Occurrence_Of (Standard_False, Loc),
2988 EF => Extra_Constrained (Formal));
2989
2990 else
2991 Add_Extra_Actual
2992 (Expr =>
2993 Make_Attribute_Reference (Sloc (Prev),
2994 Prefix =>
2995 Duplicate_Subexpr_No_Checks
2996 (Act_Prev, Name_Req => True),
2997 Attribute_Name => Name_Constrained),
2998 EF => Extra_Constrained (Formal));
2999 end if;
3000 end;
3001 end if;
3002 end if;
3003
3004 -- Create possible extra actual for accessibility level
3005
3006 if Present (Extra_Accessibility (Formal)) then
3007
3008 -- Ada 2005 (AI-252): If the actual was rewritten as an Access
3009 -- attribute, then the original actual may be an aliased object
3010 -- occurring as the prefix in a call using "Object.Operation"
3011 -- notation. In that case we must pass the level of the object,
3012 -- so Prev_Orig is reset to Prev and the attribute will be
3013 -- processed by the code for Access attributes further below.
3014
3015 if Prev_Orig /= Prev
3016 and then Nkind (Prev) = N_Attribute_Reference
3017 and then Get_Attribute_Id (Attribute_Name (Prev)) =
3018 Attribute_Access
3019 and then Is_Aliased_View (Prev_Orig)
3020 then
3021 Prev_Orig := Prev;
3022
3023 -- A class-wide precondition generates a test in which formals of
3024 -- the subprogram are replaced by actuals that came from source.
3025 -- In that case as well, the accessiblity comes from the actual.
3026 -- This is the one case in which there are references to formals
3027 -- outside of their subprogram.
3028
3029 elsif Prev_Orig /= Prev
3030 and then Is_Entity_Name (Prev_Orig)
3031 and then Present (Entity (Prev_Orig))
3032 and then Is_Formal (Entity (Prev_Orig))
3033 and then not In_Open_Scopes (Scope (Entity (Prev_Orig)))
3034 then
3035 Prev_Orig := Prev;
3036
3037 -- If the actual is a formal of an enclosing subprogram it is
3038 -- the right entity, even if it is a rewriting. This happens
3039 -- when the call is within an inherited condition or predicate.
3040
3041 elsif Is_Entity_Name (Actual)
3042 and then Is_Formal (Entity (Actual))
3043 and then In_Open_Scopes (Scope (Entity (Actual)))
3044 then
3045 Prev_Orig := Prev;
3046
3047 elsif Nkind (Prev_Orig) = N_Type_Conversion then
3048 Prev_Orig := Expression (Prev_Orig);
3049 end if;
3050
3051 -- Ada 2005 (AI-251): Thunks must propagate the extra actuals of
3052 -- accessibility levels.
3053
3054 if Is_Thunk (Current_Scope) then
3055 declare
3056 Parm_Ent : Entity_Id;
3057
3058 begin
3059 if Is_Controlling_Actual (Actual) then
3060
3061 -- Find the corresponding actual of the thunk
3062
3063 Parm_Ent := First_Entity (Current_Scope);
3064 for J in 2 .. Param_Count loop
3065 Next_Entity (Parm_Ent);
3066 end loop;
3067
3068 -- Handle unchecked conversion of access types generated
3069 -- in thunks (cf. Expand_Interface_Thunk).
3070
3071 elsif Is_Access_Type (Etype (Actual))
3072 and then Nkind (Actual) = N_Unchecked_Type_Conversion
3073 then
3074 Parm_Ent := Entity (Expression (Actual));
3075
3076 else pragma Assert (Is_Entity_Name (Actual));
3077 Parm_Ent := Entity (Actual);
3078 end if;
3079
3080 Add_Extra_Actual
3081 (Expr =>
3082 New_Occurrence_Of (Extra_Accessibility (Parm_Ent), Loc),
3083 EF => Extra_Accessibility (Formal));
3084 end;
3085
3086 elsif Is_Entity_Name (Prev_Orig) then
3087
3088 -- When passing an access parameter, or a renaming of an access
3089 -- parameter, as the actual to another access parameter we need
3090 -- to pass along the actual's own access level parameter. This
3091 -- is done if we are within the scope of the formal access
3092 -- parameter (if this is an inlined body the extra formal is
3093 -- irrelevant).
3094
3095 if (Is_Formal (Entity (Prev_Orig))
3096 or else
3097 (Present (Renamed_Object (Entity (Prev_Orig)))
3098 and then
3099 Is_Entity_Name (Renamed_Object (Entity (Prev_Orig)))
3100 and then
3101 Is_Formal
3102 (Entity (Renamed_Object (Entity (Prev_Orig))))))
3103 and then Ekind (Etype (Prev_Orig)) = E_Anonymous_Access_Type
3104 and then In_Open_Scopes (Scope (Entity (Prev_Orig)))
3105 then
3106 declare
3107 Parm_Ent : constant Entity_Id := Param_Entity (Prev_Orig);
3108
3109 begin
3110 pragma Assert (Present (Parm_Ent));
3111
3112 if Present (Extra_Accessibility (Parm_Ent)) then
3113 Add_Extra_Actual
3114 (Expr =>
3115 New_Occurrence_Of
3116 (Extra_Accessibility (Parm_Ent), Loc),
3117 EF => Extra_Accessibility (Formal));
3118
3119 -- If the actual access parameter does not have an
3120 -- associated extra formal providing its scope level,
3121 -- then treat the actual as having library-level
3122 -- accessibility.
3123
3124 else
3125 Add_Extra_Actual
3126 (Expr =>
3127 Make_Integer_Literal (Loc,
3128 Intval => Scope_Depth (Standard_Standard)),
3129 EF => Extra_Accessibility (Formal));
3130 end if;
3131 end;
3132
3133 -- The actual is a normal access value, so just pass the level
3134 -- of the actual's access type.
3135
3136 else
3137 Add_Extra_Actual
3138 (Expr => Dynamic_Accessibility_Level (Prev_Orig),
3139 EF => Extra_Accessibility (Formal));
3140 end if;
3141
3142 -- If the actual is an access discriminant, then pass the level
3143 -- of the enclosing object (RM05-3.10.2(12.4/2)).
3144
3145 elsif Nkind (Prev_Orig) = N_Selected_Component
3146 and then Ekind (Entity (Selector_Name (Prev_Orig))) =
3147 E_Discriminant
3148 and then Ekind (Etype (Entity (Selector_Name (Prev_Orig)))) =
3149 E_Anonymous_Access_Type
3150 then
3151 Add_Extra_Actual
3152 (Expr =>
3153 Make_Integer_Literal (Loc,
3154 Intval => Object_Access_Level (Prefix (Prev_Orig))),
3155 EF => Extra_Accessibility (Formal));
3156
3157 -- All other cases
3158
3159 else
3160 case Nkind (Prev_Orig) is
3161 when N_Attribute_Reference =>
3162 case Get_Attribute_Id (Attribute_Name (Prev_Orig)) is
3163
3164 -- For X'Access, pass on the level of the prefix X
3165
3166 when Attribute_Access =>
3167
3168 -- Accessibility level of S'Access is that of A
3169
3170 Prev_Orig := Prefix (Prev_Orig);
3171
3172 -- If the expression is a view conversion, the
3173 -- accessibility level is that of the expression.
3174
3175 if Nkind (Original_Node (Prev_Orig)) =
3176 N_Type_Conversion
3177 and then
3178 Nkind (Expression (Original_Node (Prev_Orig))) =
3179 N_Explicit_Dereference
3180 then
3181 Prev_Orig :=
3182 Expression (Original_Node (Prev_Orig));
3183 end if;
3184
3185 -- If this is an Access attribute applied to the
3186 -- the current instance object passed to a type
3187 -- initialization procedure, then use the level
3188 -- of the type itself. This is not really correct,
3189 -- as there should be an extra level parameter
3190 -- passed in with _init formals (only in the case
3191 -- where the type is immutably limited), but we
3192 -- don't have an easy way currently to create such
3193 -- an extra formal (init procs aren't ever frozen).
3194 -- For now we just use the level of the type,
3195 -- which may be too shallow, but that works better
3196 -- than passing Object_Access_Level of the type,
3197 -- which can be one level too deep in some cases.
3198 -- ???
3199
3200 -- A further case that requires special handling
3201 -- is the common idiom E.all'access. If E is a
3202 -- formal of the enclosing subprogram, the
3203 -- accessibility of the expression is that of E.
3204
3205 if Is_Entity_Name (Prev_Orig) then
3206 Pref_Entity := Entity (Prev_Orig);
3207
3208 elsif Nkind (Prev_Orig) = N_Explicit_Dereference
3209 and then Is_Entity_Name (Prefix (Prev_Orig))
3210 then
3211 Pref_Entity := Entity (Prefix ((Prev_Orig)));
3212
3213 else
3214 Pref_Entity := Empty;
3215 end if;
3216
3217 if Is_Entity_Name (Prev_Orig)
3218 and then Is_Type (Entity (Prev_Orig))
3219 then
3220 Add_Extra_Actual
3221 (Expr =>
3222 Make_Integer_Literal (Loc,
3223 Intval =>
3224 Type_Access_Level (Pref_Entity)),
3225 EF => Extra_Accessibility (Formal));
3226
3227 elsif Nkind (Prev_Orig) = N_Explicit_Dereference
3228 and then Present (Pref_Entity)
3229 and then Is_Formal (Pref_Entity)
3230 and then Present
3231 (Extra_Accessibility (Pref_Entity))
3232 then
3233 Add_Extra_Actual
3234 (Expr =>
3235 New_Occurrence_Of
3236 (Extra_Accessibility (Pref_Entity), Loc),
3237 EF => Extra_Accessibility (Formal));
3238
3239 else
3240 Add_Extra_Actual
3241 (Expr =>
3242 Make_Integer_Literal (Loc,
3243 Intval =>
3244 Object_Access_Level (Prev_Orig)),
3245 EF => Extra_Accessibility (Formal));
3246 end if;
3247
3248 -- Treat the unchecked attributes as library-level
3249
3250 when Attribute_Unchecked_Access
3251 | Attribute_Unrestricted_Access
3252 =>
3253 Add_Extra_Actual
3254 (Expr =>
3255 Make_Integer_Literal (Loc,
3256 Intval => Scope_Depth (Standard_Standard)),
3257 EF => Extra_Accessibility (Formal));
3258
3259 -- No other cases of attributes returning access
3260 -- values that can be passed to access parameters.
3261
3262 when others =>
3263 raise Program_Error;
3264
3265 end case;
3266
3267 -- For allocators we pass the level of the execution of the
3268 -- called subprogram, which is one greater than the current
3269 -- scope level.
3270
3271 when N_Allocator =>
3272 Add_Extra_Actual
3273 (Expr =>
3274 Make_Integer_Literal (Loc,
3275 Intval => Scope_Depth (Current_Scope) + 1),
3276 EF => Extra_Accessibility (Formal));
3277
3278 -- For most other cases we simply pass the level of the
3279 -- actual's access type. The type is retrieved from
3280 -- Prev rather than Prev_Orig, because in some cases
3281 -- Prev_Orig denotes an original expression that has
3282 -- not been analyzed.
3283
3284 when others =>
3285 Add_Extra_Actual
3286 (Expr => Dynamic_Accessibility_Level (Prev),
3287 EF => Extra_Accessibility (Formal));
3288 end case;
3289 end if;
3290 end if;
3291
3292 -- Perform the check of 4.6(49) that prevents a null value from being
3293 -- passed as an actual to an access parameter. Note that the check
3294 -- is elided in the common cases of passing an access attribute or
3295 -- access parameter as an actual. Also, we currently don't enforce
3296 -- this check for expander-generated actuals and when -gnatdj is set.
3297
3298 if Ada_Version >= Ada_2005 then
3299
3300 -- Ada 2005 (AI-231): Check null-excluding access types. Note that
3301 -- the intent of 6.4.1(13) is that null-exclusion checks should
3302 -- not be done for 'out' parameters, even though it refers only
3303 -- to constraint checks, and a null_exclusion is not a constraint.
3304 -- Note that AI05-0196-1 corrects this mistake in the RM.
3305
3306 if Is_Access_Type (Etype (Formal))
3307 and then Can_Never_Be_Null (Etype (Formal))
3308 and then Ekind (Formal) /= E_Out_Parameter
3309 and then Nkind (Prev) /= N_Raise_Constraint_Error
3310 and then (Known_Null (Prev)
3311 or else not Can_Never_Be_Null (Etype (Prev)))
3312 then
3313 Install_Null_Excluding_Check (Prev);
3314 end if;
3315
3316 -- Ada_Version < Ada_2005
3317
3318 else
3319 if Ekind (Etype (Formal)) /= E_Anonymous_Access_Type
3320 or else Access_Checks_Suppressed (Subp)
3321 then
3322 null;
3323
3324 elsif Debug_Flag_J then
3325 null;
3326
3327 elsif not Comes_From_Source (Prev) then
3328 null;
3329
3330 elsif Is_Entity_Name (Prev)
3331 and then Ekind (Etype (Prev)) = E_Anonymous_Access_Type
3332 then
3333 null;
3334
3335 elsif Nkind_In (Prev, N_Allocator, N_Attribute_Reference) then
3336 null;
3337
3338 else
3339 Install_Null_Excluding_Check (Prev);
3340 end if;
3341 end if;
3342
3343 -- Perform appropriate validity checks on parameters that
3344 -- are entities.
3345
3346 if Validity_Checks_On then
3347 if (Ekind (Formal) = E_In_Parameter
3348 and then Validity_Check_In_Params)
3349 or else
3350 (Ekind (Formal) = E_In_Out_Parameter
3351 and then Validity_Check_In_Out_Params)
3352 then
3353 -- If the actual is an indexed component of a packed type (or
3354 -- is an indexed or selected component whose prefix recursively
3355 -- meets this condition), it has not been expanded yet. It will
3356 -- be copied in the validity code that follows, and has to be
3357 -- expanded appropriately, so reanalyze it.
3358
3359 -- What we do is just to unset analyzed bits on prefixes till
3360 -- we reach something that does not have a prefix.
3361
3362 declare
3363 Nod : Node_Id;
3364
3365 begin
3366 Nod := Actual;
3367 while Nkind_In (Nod, N_Indexed_Component,
3368 N_Selected_Component)
3369 loop
3370 Set_Analyzed (Nod, False);
3371 Nod := Prefix (Nod);
3372 end loop;
3373 end;
3374
3375 Ensure_Valid (Actual);
3376 end if;
3377 end if;
3378
3379 -- For IN OUT and OUT parameters, ensure that subscripts are valid
3380 -- since this is a left side reference. We only do this for calls
3381 -- from the source program since we assume that compiler generated
3382 -- calls explicitly generate any required checks. We also need it
3383 -- only if we are doing standard validity checks, since clearly it is
3384 -- not needed if validity checks are off, and in subscript validity
3385 -- checking mode, all indexed components are checked with a call
3386 -- directly from Expand_N_Indexed_Component.
3387
3388 if Comes_From_Source (Call_Node)
3389 and then Ekind (Formal) /= E_In_Parameter
3390 and then Validity_Checks_On
3391 and then Validity_Check_Default
3392 and then not Validity_Check_Subscripts
3393 then
3394 Check_Valid_Lvalue_Subscripts (Actual);
3395 end if;
3396
3397 -- Mark any scalar OUT parameter that is a simple variable as no
3398 -- longer known to be valid (unless the type is always valid). This
3399 -- reflects the fact that if an OUT parameter is never set in a
3400 -- procedure, then it can become invalid on the procedure return.
3401
3402 if Ekind (Formal) = E_Out_Parameter
3403 and then Is_Entity_Name (Actual)
3404 and then Ekind (Entity (Actual)) = E_Variable
3405 and then not Is_Known_Valid (Etype (Actual))
3406 then
3407 Set_Is_Known_Valid (Entity (Actual), False);
3408 end if;
3409
3410 -- For an OUT or IN OUT parameter, if the actual is an entity, then
3411 -- clear current values, since they can be clobbered. We are probably
3412 -- doing this in more places than we need to, but better safe than
3413 -- sorry when it comes to retaining bad current values.
3414
3415 if Ekind (Formal) /= E_In_Parameter
3416 and then Is_Entity_Name (Actual)
3417 and then Present (Entity (Actual))
3418 then
3419 declare
3420 Ent : constant Entity_Id := Entity (Actual);
3421 Sav : Node_Id;
3422
3423 begin
3424 -- For an OUT or IN OUT parameter that is an assignable entity,
3425 -- we do not want to clobber the Last_Assignment field, since
3426 -- if it is set, it was precisely because it is indeed an OUT
3427 -- or IN OUT parameter. We do reset the Is_Known_Valid flag
3428 -- since the subprogram could have returned in invalid value.
3429
3430 if Ekind_In (Formal, E_Out_Parameter, E_In_Out_Parameter)
3431 and then Is_Assignable (Ent)
3432 then
3433 Sav := Last_Assignment (Ent);
3434 Kill_Current_Values (Ent);
3435 Set_Last_Assignment (Ent, Sav);
3436 Set_Is_Known_Valid (Ent, False);
3437
3438 -- For all other cases, just kill the current values
3439
3440 else
3441 Kill_Current_Values (Ent);
3442 end if;
3443 end;
3444 end if;
3445
3446 -- If the formal is class wide and the actual is an aggregate, force
3447 -- evaluation so that the back end who does not know about class-wide
3448 -- type, does not generate a temporary of the wrong size.
3449
3450 if not Is_Class_Wide_Type (Etype (Formal)) then
3451 null;
3452
3453 elsif Nkind (Actual) = N_Aggregate
3454 or else (Nkind (Actual) = N_Qualified_Expression
3455 and then Nkind (Expression (Actual)) = N_Aggregate)
3456 then
3457 Force_Evaluation (Actual);
3458 end if;
3459
3460 -- In a remote call, if the formal is of a class-wide type, check
3461 -- that the actual meets the requirements described in E.4(18).
3462
3463 if Remote and then Is_Class_Wide_Type (Etype (Formal)) then
3464 Insert_Action (Actual,
3465 Make_Transportable_Check (Loc,
3466 Duplicate_Subexpr_Move_Checks (Actual)));
3467 end if;
3468
3469 -- Perform invariant checks for all intermediate types in a view
3470 -- conversion after successful return from a call that passes the
3471 -- view conversion as an IN OUT or OUT parameter (RM 7.3.2 (12/3,
3472 -- 13/3, 14/3)). Consider only source conversion in order to avoid
3473 -- generating spurious checks on complex expansion such as object
3474 -- initialization through an extension aggregate.
3475
3476 if Comes_From_Source (N)
3477 and then Ekind (Formal) /= E_In_Parameter
3478 and then Nkind (Actual) = N_Type_Conversion
3479 then
3480 Add_View_Conversion_Invariants (Formal, Actual);
3481 end if;
3482
3483 -- Generating C the initialization of an allocator is performed by
3484 -- means of individual statements, and hence it must be done before
3485 -- the call.
3486
3487 if Modify_Tree_For_C
3488 and then Nkind (Actual) = N_Allocator
3489 and then Nkind (Expression (Actual)) = N_Qualified_Expression
3490 then
3491 Remove_Side_Effects (Actual);
3492 end if;
3493
3494 -- This label is required when skipping extra actual generation for
3495 -- Unchecked_Union parameters.
3496
3497 <<Skip_Extra_Actual_Generation>>
3498
3499 Param_Count := Param_Count + 1;
3500 Next_Actual (Actual);
3501 Next_Formal (Formal);
3502 end loop;
3503
3504 -- If we are calling an Ada 2012 function which needs to have the
3505 -- "accessibility level determined by the point of call" (AI05-0234)
3506 -- passed in to it, then pass it in.
3507
3508 if Ekind_In (Subp, E_Function, E_Operator, E_Subprogram_Type)
3509 and then
3510 Present (Extra_Accessibility_Of_Result (Ultimate_Alias (Subp)))
3511 then
3512 declare
3513 Ancestor : Node_Id := Parent (Call_Node);
3514 Level : Node_Id := Empty;
3515 Defer : Boolean := False;
3516
3517 begin
3518 -- Unimplemented: if Subp returns an anonymous access type, then
3519
3520 -- a) if the call is the operand of an explict conversion, then
3521 -- the target type of the conversion (a named access type)
3522 -- determines the accessibility level pass in;
3523
3524 -- b) if the call defines an access discriminant of an object
3525 -- (e.g., the discriminant of an object being created by an
3526 -- allocator, or the discriminant of a function result),
3527 -- then the accessibility level to pass in is that of the
3528 -- discriminated object being initialized).
3529
3530 -- ???
3531
3532 while Nkind (Ancestor) = N_Qualified_Expression
3533 loop
3534 Ancestor := Parent (Ancestor);
3535 end loop;
3536
3537 case Nkind (Ancestor) is
3538 when N_Allocator =>
3539
3540 -- At this point, we'd like to assign
3541
3542 -- Level := Dynamic_Accessibility_Level (Ancestor);
3543
3544 -- but Etype of Ancestor may not have been set yet,
3545 -- so that doesn't work.
3546
3547 -- Handle this later in Expand_Allocator_Expression.
3548
3549 Defer := True;
3550
3551 when N_Object_Declaration
3552 | N_Object_Renaming_Declaration
3553 =>
3554 declare
3555 Def_Id : constant Entity_Id :=
3556 Defining_Identifier (Ancestor);
3557
3558 begin
3559 if Is_Return_Object (Def_Id) then
3560 if Present (Extra_Accessibility_Of_Result
3561 (Return_Applies_To (Scope (Def_Id))))
3562 then
3563 -- Pass along value that was passed in if the
3564 -- routine we are returning from also has an
3565 -- Accessibility_Of_Result formal.
3566
3567 Level :=
3568 New_Occurrence_Of
3569 (Extra_Accessibility_Of_Result
3570 (Return_Applies_To (Scope (Def_Id))), Loc);
3571 end if;
3572 else
3573 Level :=
3574 Make_Integer_Literal (Loc,
3575 Intval => Object_Access_Level (Def_Id));
3576 end if;
3577 end;
3578
3579 when N_Simple_Return_Statement =>
3580 if Present (Extra_Accessibility_Of_Result
3581 (Return_Applies_To
3582 (Return_Statement_Entity (Ancestor))))
3583 then
3584 -- Pass along value that was passed in if the returned
3585 -- routine also has an Accessibility_Of_Result formal.
3586
3587 Level :=
3588 New_Occurrence_Of
3589 (Extra_Accessibility_Of_Result
3590 (Return_Applies_To
3591 (Return_Statement_Entity (Ancestor))), Loc);
3592 end if;
3593
3594 when others =>
3595 null;
3596 end case;
3597
3598 if not Defer then
3599 if not Present (Level) then
3600
3601 -- The "innermost master that evaluates the function call".
3602
3603 -- ??? - Should we use Integer'Last here instead in order
3604 -- to deal with (some of) the problems associated with
3605 -- calls to subps whose enclosing scope is unknown (e.g.,
3606 -- Anon_Access_To_Subp_Param.all)?
3607
3608 Level :=
3609 Make_Integer_Literal (Loc,
3610 Intval => Scope_Depth (Current_Scope) + 1);
3611 end if;
3612
3613 Add_Extra_Actual
3614 (Expr => Level,
3615 EF =>
3616 Extra_Accessibility_Of_Result (Ultimate_Alias (Subp)));
3617 end if;
3618 end;
3619 end if;
3620
3621 -- If we are expanding the RHS of an assignment we need to check if tag
3622 -- propagation is needed. You might expect this processing to be in
3623 -- Analyze_Assignment but has to be done earlier (bottom-up) because the
3624 -- assignment might be transformed to a declaration for an unconstrained
3625 -- value if the expression is classwide.
3626
3627 if Nkind (Call_Node) = N_Function_Call
3628 and then Is_Tag_Indeterminate (Call_Node)
3629 and then Is_Entity_Name (Name (Call_Node))
3630 then
3631 declare
3632 Ass : Node_Id := Empty;
3633
3634 begin
3635 if Nkind (Parent (Call_Node)) = N_Assignment_Statement then
3636 Ass := Parent (Call_Node);
3637
3638 elsif Nkind (Parent (Call_Node)) = N_Qualified_Expression
3639 and then Nkind (Parent (Parent (Call_Node))) =
3640 N_Assignment_Statement
3641 then
3642 Ass := Parent (Parent (Call_Node));
3643
3644 elsif Nkind (Parent (Call_Node)) = N_Explicit_Dereference
3645 and then Nkind (Parent (Parent (Call_Node))) =
3646 N_Assignment_Statement
3647 then
3648 Ass := Parent (Parent (Call_Node));
3649 end if;
3650
3651 if Present (Ass)
3652 and then Is_Class_Wide_Type (Etype (Name (Ass)))
3653 then
3654 if Is_Access_Type (Etype (Call_Node)) then
3655 if Designated_Type (Etype (Call_Node)) /=
3656 Root_Type (Etype (Name (Ass)))
3657 then
3658 Error_Msg_NE
3659 ("tag-indeterminate expression must have designated "
3660 & "type& (RM 5.2 (6))",
3661 Call_Node, Root_Type (Etype (Name (Ass))));
3662 else
3663 Propagate_Tag (Name (Ass), Call_Node);
3664 end if;
3665
3666 elsif Etype (Call_Node) /= Root_Type (Etype (Name (Ass))) then
3667 Error_Msg_NE
3668 ("tag-indeterminate expression must have type & "
3669 & "(RM 5.2 (6))",
3670 Call_Node, Root_Type (Etype (Name (Ass))));
3671
3672 else
3673 Propagate_Tag (Name (Ass), Call_Node);
3674 end if;
3675
3676 -- The call will be rewritten as a dispatching call, and
3677 -- expanded as such.
3678
3679 return;
3680 end if;
3681 end;
3682 end if;
3683
3684 -- Ada 2005 (AI-251): If some formal is a class-wide interface, expand
3685 -- it to point to the correct secondary virtual table
3686
3687 if Nkind (Call_Node) in N_Subprogram_Call
3688 and then CW_Interface_Formals_Present
3689 then
3690 Expand_Interface_Actuals (Call_Node);
3691 end if;
3692
3693 -- Deals with Dispatch_Call if we still have a call, before expanding
3694 -- extra actuals since this will be done on the re-analysis of the
3695 -- dispatching call. Note that we do not try to shorten the actual list
3696 -- for a dispatching call, it would not make sense to do so. Expansion
3697 -- of dispatching calls is suppressed for VM targets, because the VM
3698 -- back-ends directly handle the generation of dispatching calls and
3699 -- would have to undo any expansion to an indirect call.
3700
3701 if Nkind (Call_Node) in N_Subprogram_Call
3702 and then Present (Controlling_Argument (Call_Node))
3703 then
3704 declare
3705 Call_Typ : constant Entity_Id := Etype (Call_Node);
3706 Typ : constant Entity_Id := Find_Dispatching_Type (Subp);
3707 Eq_Prim_Op : Entity_Id := Empty;
3708 New_Call : Node_Id;
3709 Param : Node_Id;
3710 Prev_Call : Node_Id;
3711
3712 begin
3713 if not Is_Limited_Type (Typ) then
3714 Eq_Prim_Op := Find_Prim_Op (Typ, Name_Op_Eq);
3715 end if;
3716
3717 if Tagged_Type_Expansion then
3718 Expand_Dispatching_Call (Call_Node);
3719
3720 -- The following return is worrisome. Is it really OK to skip
3721 -- all remaining processing in this procedure ???
3722
3723 return;
3724
3725 -- VM targets
3726
3727 else
3728 Apply_Tag_Checks (Call_Node);
3729
3730 -- If this is a dispatching "=", we must first compare the
3731 -- tags so we generate: x.tag = y.tag and then x = y
3732
3733 if Subp = Eq_Prim_Op then
3734
3735 -- Mark the node as analyzed to avoid reanalyzing this
3736 -- dispatching call (which would cause a never-ending loop)
3737
3738 Prev_Call := Relocate_Node (Call_Node);
3739 Set_Analyzed (Prev_Call);
3740
3741 Param := First_Actual (Call_Node);
3742 New_Call :=
3743 Make_And_Then (Loc,
3744 Left_Opnd =>
3745 Make_Op_Eq (Loc,
3746 Left_Opnd =>
3747 Make_Selected_Component (Loc,
3748 Prefix => New_Value (Param),
3749 Selector_Name =>
3750 New_Occurrence_Of
3751 (First_Tag_Component (Typ), Loc)),
3752
3753 Right_Opnd =>
3754 Make_Selected_Component (Loc,
3755 Prefix =>
3756 Unchecked_Convert_To (Typ,
3757 New_Value (Next_Actual (Param))),
3758 Selector_Name =>
3759 New_Occurrence_Of
3760 (First_Tag_Component (Typ), Loc))),
3761 Right_Opnd => Prev_Call);
3762
3763 Rewrite (Call_Node, New_Call);
3764
3765 Analyze_And_Resolve
3766 (Call_Node, Call_Typ, Suppress => All_Checks);
3767 end if;
3768
3769 -- Expansion of a dispatching call results in an indirect call,
3770 -- which in turn causes current values to be killed (see
3771 -- Resolve_Call), so on VM targets we do the call here to
3772 -- ensure consistent warnings between VM and non-VM targets.
3773
3774 Kill_Current_Values;
3775 end if;
3776
3777 -- If this is a dispatching "=" then we must update the reference
3778 -- to the call node because we generated:
3779 -- x.tag = y.tag and then x = y
3780
3781 if Subp = Eq_Prim_Op then
3782 Call_Node := Right_Opnd (Call_Node);
3783 end if;
3784 end;
3785 end if;
3786
3787 -- Similarly, expand calls to RCI subprograms on which pragma
3788 -- All_Calls_Remote applies. The rewriting will be reanalyzed
3789 -- later. Do this only when the call comes from source since we
3790 -- do not want such a rewriting to occur in expanded code.
3791
3792 if Is_All_Remote_Call (Call_Node) then
3793 Expand_All_Calls_Remote_Subprogram_Call (Call_Node);
3794
3795 -- Similarly, do not add extra actuals for an entry call whose entity
3796 -- is a protected procedure, or for an internal protected subprogram
3797 -- call, because it will be rewritten as a protected subprogram call
3798 -- and reanalyzed (see Expand_Protected_Subprogram_Call).
3799
3800 elsif Is_Protected_Type (Scope (Subp))
3801 and then (Ekind (Subp) = E_Procedure
3802 or else Ekind (Subp) = E_Function)
3803 then
3804 null;
3805
3806 -- During that loop we gathered the extra actuals (the ones that
3807 -- correspond to Extra_Formals), so now they can be appended.
3808
3809 else
3810 while Is_Non_Empty_List (Extra_Actuals) loop
3811 Add_Actual_Parameter (Remove_Head (Extra_Actuals));
3812 end loop;
3813 end if;
3814
3815 -- At this point we have all the actuals, so this is the point at which
3816 -- the various expansion activities for actuals is carried out.
3817
3818 Expand_Actuals (Call_Node, Subp, Post_Call);
3819
3820 -- Verify that the actuals do not share storage. This check must be done
3821 -- on the caller side rather that inside the subprogram to avoid issues
3822 -- of parameter passing.
3823
3824 if Check_Aliasing_Of_Parameters then
3825 Apply_Parameter_Aliasing_Checks (Call_Node, Subp);
3826 end if;
3827
3828 -- If the subprogram is a renaming, or if it is inherited, replace it in
3829 -- the call with the name of the actual subprogram being called. If this
3830 -- is a dispatching call, the run-time decides what to call. The Alias
3831 -- attribute does not apply to entries.
3832
3833 if Nkind (Call_Node) /= N_Entry_Call_Statement
3834 and then No (Controlling_Argument (Call_Node))
3835 and then Present (Parent_Subp)
3836 and then not Is_Direct_Deep_Call (Subp)
3837 then
3838 if Present (Inherited_From_Formal (Subp)) then
3839 Parent_Subp := Inherited_From_Formal (Subp);
3840 else
3841 Parent_Subp := Ultimate_Alias (Parent_Subp);
3842 end if;
3843
3844 -- The below setting of Entity is suspect, see F109-018 discussion???
3845
3846 Set_Entity (Name (Call_Node), Parent_Subp);
3847
3848 if Is_Abstract_Subprogram (Parent_Subp)
3849 and then not In_Instance
3850 then
3851 Error_Msg_NE
3852 ("cannot call abstract subprogram &!",
3853 Name (Call_Node), Parent_Subp);
3854 end if;
3855
3856 -- Inspect all formals of derived subprogram Subp. Compare parameter
3857 -- types with the parent subprogram and check whether an actual may
3858 -- need a type conversion to the corresponding formal of the parent
3859 -- subprogram.
3860
3861 -- Not clear whether intrinsic subprograms need such conversions. ???
3862
3863 if not Is_Intrinsic_Subprogram (Parent_Subp)
3864 or else Is_Generic_Instance (Parent_Subp)
3865 then
3866 declare
3867 procedure Convert (Act : Node_Id; Typ : Entity_Id);
3868 -- Rewrite node Act as a type conversion of Act to Typ. Analyze
3869 -- and resolve the newly generated construct.
3870
3871 -------------
3872 -- Convert --
3873 -------------
3874
3875 procedure Convert (Act : Node_Id; Typ : Entity_Id) is
3876 begin
3877 Rewrite (Act, OK_Convert_To (Typ, Relocate_Node (Act)));
3878 Analyze (Act);
3879 Resolve (Act, Typ);
3880 end Convert;
3881
3882 -- Local variables
3883
3884 Actual_Typ : Entity_Id;
3885 Formal_Typ : Entity_Id;
3886 Parent_Typ : Entity_Id;
3887
3888 begin
3889 Actual := First_Actual (Call_Node);
3890 Formal := First_Formal (Subp);
3891 Parent_Formal := First_Formal (Parent_Subp);
3892 while Present (Formal) loop
3893 Actual_Typ := Etype (Actual);
3894 Formal_Typ := Etype (Formal);
3895 Parent_Typ := Etype (Parent_Formal);
3896
3897 -- For an IN parameter of a scalar type, the parent formal
3898 -- type and derived formal type differ or the parent formal
3899 -- type and actual type do not match statically.
3900
3901 if Is_Scalar_Type (Formal_Typ)
3902 and then Ekind (Formal) = E_In_Parameter
3903 and then Formal_Typ /= Parent_Typ
3904 and then
3905 not Subtypes_Statically_Match (Parent_Typ, Actual_Typ)
3906 and then not Raises_Constraint_Error (Actual)
3907 then
3908 Convert (Actual, Parent_Typ);
3909 Enable_Range_Check (Actual);
3910
3911 -- If the actual has been marked as requiring a range
3912 -- check, then generate it here.
3913
3914 if Do_Range_Check (Actual) then
3915 Generate_Range_Check
3916 (Actual, Etype (Formal), CE_Range_Check_Failed);
3917 end if;
3918
3919 -- For access types, the parent formal type and actual type
3920 -- differ.
3921
3922 elsif Is_Access_Type (Formal_Typ)
3923 and then Base_Type (Parent_Typ) /= Base_Type (Actual_Typ)
3924 then
3925 if Ekind (Formal) /= E_In_Parameter then
3926 Convert (Actual, Parent_Typ);
3927
3928 elsif Ekind (Parent_Typ) = E_Anonymous_Access_Type
3929 and then Designated_Type (Parent_Typ) /=
3930 Designated_Type (Actual_Typ)
3931 and then not Is_Controlling_Formal (Formal)
3932 then
3933 -- This unchecked conversion is not necessary unless
3934 -- inlining is enabled, because in that case the type
3935 -- mismatch may become visible in the body about to be
3936 -- inlined.
3937
3938 Rewrite (Actual,
3939 Unchecked_Convert_To (Parent_Typ,
3940 Relocate_Node (Actual)));
3941 Analyze (Actual);
3942 Resolve (Actual, Parent_Typ);
3943 end if;
3944
3945 -- If there is a change of representation, then generate a
3946 -- warning, and do the change of representation.
3947
3948 elsif not Same_Representation (Formal_Typ, Parent_Typ) then
3949 Error_Msg_N
3950 ("??change of representation required", Actual);
3951 Convert (Actual, Parent_Typ);
3952
3953 -- For array and record types, the parent formal type and
3954 -- derived formal type have different sizes or pragma Pack
3955 -- status.
3956
3957 elsif ((Is_Array_Type (Formal_Typ)
3958 and then Is_Array_Type (Parent_Typ))
3959 or else
3960 (Is_Record_Type (Formal_Typ)
3961 and then Is_Record_Type (Parent_Typ)))
3962 and then
3963 (Esize (Formal_Typ) /= Esize (Parent_Typ)
3964 or else Has_Pragma_Pack (Formal_Typ) /=
3965 Has_Pragma_Pack (Parent_Typ))
3966 then
3967 Convert (Actual, Parent_Typ);
3968 end if;
3969
3970 Next_Actual (Actual);
3971 Next_Formal (Formal);
3972 Next_Formal (Parent_Formal);
3973 end loop;
3974 end;
3975 end if;
3976
3977 Orig_Subp := Subp;
3978 Subp := Parent_Subp;
3979 end if;
3980
3981 -- Deal with case where call is an explicit dereference
3982
3983 if Nkind (Name (Call_Node)) = N_Explicit_Dereference then
3984
3985 -- Handle case of access to protected subprogram type
3986
3987 if Is_Access_Protected_Subprogram_Type
3988 (Base_Type (Etype (Prefix (Name (Call_Node)))))
3989 then
3990 -- If this is a call through an access to protected operation, the
3991 -- prefix has the form (object'address, operation'access). Rewrite
3992 -- as a for other protected calls: the object is the 1st parameter
3993 -- of the list of actuals.
3994
3995 declare
3996 Call : Node_Id;
3997 Parm : List_Id;
3998 Nam : Node_Id;
3999 Obj : Node_Id;
4000 Ptr : constant Node_Id := Prefix (Name (Call_Node));
4001
4002 T : constant Entity_Id :=
4003 Equivalent_Type (Base_Type (Etype (Ptr)));
4004
4005 D_T : constant Entity_Id :=
4006 Designated_Type (Base_Type (Etype (Ptr)));
4007
4008 begin
4009 Obj :=
4010 Make_Selected_Component (Loc,
4011 Prefix => Unchecked_Convert_To (T, Ptr),
4012 Selector_Name =>
4013 New_Occurrence_Of (First_Entity (T), Loc));
4014
4015 Nam :=
4016 Make_Selected_Component (Loc,
4017 Prefix => Unchecked_Convert_To (T, Ptr),
4018 Selector_Name =>
4019 New_Occurrence_Of (Next_Entity (First_Entity (T)), Loc));
4020
4021 Nam :=
4022 Make_Explicit_Dereference (Loc,
4023 Prefix => Nam);
4024
4025 if Present (Parameter_Associations (Call_Node)) then
4026 Parm := Parameter_Associations (Call_Node);
4027 else
4028 Parm := New_List;
4029 end if;
4030
4031 Prepend (Obj, Parm);
4032
4033 if Etype (D_T) = Standard_Void_Type then
4034 Call :=
4035 Make_Procedure_Call_Statement (Loc,
4036 Name => Nam,
4037 Parameter_Associations => Parm);
4038 else
4039 Call :=
4040 Make_Function_Call (Loc,
4041 Name => Nam,
4042 Parameter_Associations => Parm);
4043 end if;
4044
4045 Set_First_Named_Actual (Call, First_Named_Actual (Call_Node));
4046 Set_Etype (Call, Etype (D_T));
4047
4048 -- We do not re-analyze the call to avoid infinite recursion.
4049 -- We analyze separately the prefix and the object, and set
4050 -- the checks on the prefix that would otherwise be emitted
4051 -- when resolving a call.
4052
4053 Rewrite (Call_Node, Call);
4054 Analyze (Nam);
4055 Apply_Access_Check (Nam);
4056 Analyze (Obj);
4057 return;
4058 end;
4059 end if;
4060 end if;
4061
4062 -- If this is a call to an intrinsic subprogram, then perform the
4063 -- appropriate expansion to the corresponding tree node and we
4064 -- are all done (since after that the call is gone).
4065
4066 -- In the case where the intrinsic is to be processed by the back end,
4067 -- the call to Expand_Intrinsic_Call will do nothing, which is fine,
4068 -- since the idea in this case is to pass the call unchanged. If the
4069 -- intrinsic is an inherited unchecked conversion, and the derived type
4070 -- is the target type of the conversion, we must retain it as the return
4071 -- type of the expression. Otherwise the expansion below, which uses the
4072 -- parent operation, will yield the wrong type.
4073
4074 if Is_Intrinsic_Subprogram (Subp) then
4075 Expand_Intrinsic_Call (Call_Node, Subp);
4076
4077 if Nkind (Call_Node) = N_Unchecked_Type_Conversion
4078 and then Parent_Subp /= Orig_Subp
4079 and then Etype (Parent_Subp) /= Etype (Orig_Subp)
4080 then
4081 Set_Etype (Call_Node, Etype (Orig_Subp));
4082 end if;
4083
4084 return;
4085 end if;
4086
4087 if Ekind_In (Subp, E_Function, E_Procedure) then
4088
4089 -- We perform a simple optimization on calls for To_Address by
4090 -- replacing them with an unchecked conversion. Not only is this
4091 -- efficient, but it also avoids order of elaboration problems when
4092 -- address clauses are inlined (address expression elaborated at the
4093 -- wrong point).
4094
4095 -- We perform this optimization regardless of whether we are in the
4096 -- main unit or in a unit in the context of the main unit, to ensure
4097 -- that the generated tree is the same in both cases, for CodePeer
4098 -- use.
4099
4100 if Is_RTE (Subp, RE_To_Address) then
4101 Rewrite (Call_Node,
4102 Unchecked_Convert_To
4103 (RTE (RE_Address), Relocate_Node (First_Actual (Call_Node))));
4104 return;
4105
4106 -- A call to a null procedure is replaced by a null statement, but we
4107 -- are not allowed to ignore possible side effects of the call, so we
4108 -- make sure that actuals are evaluated.
4109 -- We also suppress this optimization for GNATCoverage.
4110
4111 elsif Is_Null_Procedure (Subp)
4112 and then not Opt.Suppress_Control_Flow_Optimizations
4113 then
4114 Actual := First_Actual (Call_Node);
4115 while Present (Actual) loop
4116 Remove_Side_Effects (Actual);
4117 Next_Actual (Actual);
4118 end loop;
4119
4120 Rewrite (Call_Node, Make_Null_Statement (Loc));
4121 return;
4122 end if;
4123
4124 -- Handle inlining. No action needed if the subprogram is not inlined
4125
4126 if not Is_Inlined (Subp) then
4127 null;
4128
4129 -- Frontend inlining of expression functions (performed also when
4130 -- backend inlining is enabled).
4131
4132 elsif Is_Inlinable_Expression_Function (Subp) then
4133 Rewrite (N, New_Copy (Expression_Of_Expression_Function (Subp)));
4134 Analyze (N);
4135 return;
4136
4137 -- Handle frontend inlining
4138
4139 elsif not Back_End_Inlining then
4140 Inlined_Subprogram : declare
4141 Bod : Node_Id;
4142 Must_Inline : Boolean := False;
4143 Spec : constant Node_Id := Unit_Declaration_Node (Subp);
4144
4145 begin
4146 -- Verify that the body to inline has already been seen, and
4147 -- that if the body is in the current unit the inlining does
4148 -- not occur earlier. This avoids order-of-elaboration problems
4149 -- in the back end.
4150
4151 -- This should be documented in sinfo/einfo ???
4152
4153 if No (Spec)
4154 or else Nkind (Spec) /= N_Subprogram_Declaration
4155 or else No (Body_To_Inline (Spec))
4156 then
4157 Must_Inline := False;
4158
4159 -- If this an inherited function that returns a private type,
4160 -- do not inline if the full view is an unconstrained array,
4161 -- because such calls cannot be inlined.
4162
4163 elsif Present (Orig_Subp)
4164 and then Is_Array_Type (Etype (Orig_Subp))
4165 and then not Is_Constrained (Etype (Orig_Subp))
4166 then
4167 Must_Inline := False;
4168
4169 elsif In_Unfrozen_Instance (Scope (Subp)) then
4170 Must_Inline := False;
4171
4172 else
4173 Bod := Body_To_Inline (Spec);
4174
4175 if (In_Extended_Main_Code_Unit (Call_Node)
4176 or else In_Extended_Main_Code_Unit (Parent (Call_Node))
4177 or else Has_Pragma_Inline_Always (Subp))
4178 and then (not In_Same_Extended_Unit (Sloc (Bod), Loc)
4179 or else
4180 Earlier_In_Extended_Unit (Sloc (Bod), Loc))
4181 then
4182 Must_Inline := True;
4183
4184 -- If we are compiling a package body that is not the main
4185 -- unit, it must be for inlining/instantiation purposes,
4186 -- in which case we inline the call to insure that the same
4187 -- temporaries are generated when compiling the body by
4188 -- itself. Otherwise link errors can occur.
4189
4190 -- If the function being called is itself in the main unit,
4191 -- we cannot inline, because there is a risk of double
4192 -- elaboration and/or circularity: the inlining can make
4193 -- visible a private entity in the body of the main unit,
4194 -- that gigi will see before its sees its proper definition.
4195
4196 elsif not (In_Extended_Main_Code_Unit (Call_Node))
4197 and then In_Package_Body
4198 then
4199 Must_Inline := not In_Extended_Main_Source_Unit (Subp);
4200
4201 -- Inline calls to _postconditions when generating C code
4202
4203 elsif Modify_Tree_For_C
4204 and then In_Same_Extended_Unit (Sloc (Bod), Loc)
4205 and then Chars (Name (N)) = Name_uPostconditions
4206 then
4207 Must_Inline := True;
4208 end if;
4209 end if;
4210
4211 if Must_Inline then
4212 Expand_Inlined_Call (Call_Node, Subp, Orig_Subp);
4213
4214 else
4215 -- Let the back end handle it
4216
4217 Add_Inlined_Body (Subp, Call_Node);
4218
4219 if Front_End_Inlining
4220 and then Nkind (Spec) = N_Subprogram_Declaration
4221 and then (In_Extended_Main_Code_Unit (Call_Node))
4222 and then No (Body_To_Inline (Spec))
4223 and then not Has_Completion (Subp)
4224 and then In_Same_Extended_Unit (Sloc (Spec), Loc)
4225 then
4226 Cannot_Inline
4227 ("cannot inline& (body not seen yet)?",
4228 Call_Node, Subp);
4229 end if;
4230 end if;
4231 end Inlined_Subprogram;
4232
4233 -- Back end inlining: let the back end handle it
4234
4235 elsif No (Unit_Declaration_Node (Subp))
4236 or else Nkind (Unit_Declaration_Node (Subp)) /=
4237 N_Subprogram_Declaration
4238 or else No (Body_To_Inline (Unit_Declaration_Node (Subp)))
4239 or else Nkind (Body_To_Inline (Unit_Declaration_Node (Subp))) in
4240 N_Entity
4241 then
4242 Add_Inlined_Body (Subp, Call_Node);
4243
4244 -- If the inlined call appears within an instantiation and some
4245 -- level of optimization is required, ensure that the enclosing
4246 -- instance body is available so that the back-end can actually
4247 -- perform the inlining.
4248
4249 if In_Instance
4250 and then Comes_From_Source (Subp)
4251 and then Optimization_Level > 0
4252 then
4253 declare
4254 Decl : Node_Id;
4255 Inst : Entity_Id;
4256 Inst_Node : Node_Id;
4257
4258 begin
4259 Inst := Scope (Subp);
4260
4261 -- Find enclosing instance
4262
4263 while Present (Inst) and then Inst /= Standard_Standard loop
4264 exit when Is_Generic_Instance (Inst);
4265 Inst := Scope (Inst);
4266 end loop;
4267
4268 if Present (Inst)
4269 and then Is_Generic_Instance (Inst)
4270 and then not Is_Inlined (Inst)
4271 then
4272 Set_Is_Inlined (Inst);
4273 Decl := Unit_Declaration_Node (Inst);
4274
4275 -- Do not add a pending instantiation if the body exits
4276 -- already, or if the instance is a compilation unit, or
4277 -- the instance node is missing.
4278
4279 if Present (Corresponding_Body (Decl))
4280 or else Nkind (Parent (Decl)) = N_Compilation_Unit
4281 or else No (Next (Decl))
4282 then
4283 null;
4284
4285 else
4286 -- The instantiation node usually follows the package
4287 -- declaration for the instance. If the generic unit
4288 -- has aspect specifications, they are transformed
4289 -- into pragmas in the instance, and the instance node
4290 -- appears after them.
4291
4292 Inst_Node := Next (Decl);
4293
4294 while Nkind (Inst_Node) /= N_Package_Instantiation loop
4295 Inst_Node := Next (Inst_Node);
4296 end loop;
4297
4298 Add_Pending_Instantiation (Inst_Node, Decl);
4299 end if;
4300 end if;
4301 end;
4302 end if;
4303
4304 -- Front end expansion of simple functions returning unconstrained
4305 -- types (see Check_And_Split_Unconstrained_Function). Note that the
4306 -- case of a simple renaming (Body_To_Inline in N_Entity above, see
4307 -- also Build_Renamed_Body) cannot be expanded here because this may
4308 -- give rise to order-of-elaboration issues for the types of the
4309 -- parameters of the subprogram, if any.
4310
4311 else
4312 Expand_Inlined_Call (Call_Node, Subp, Orig_Subp);
4313 end if;
4314 end if;
4315
4316 -- Check for protected subprogram. This is either an intra-object call,
4317 -- or a protected function call. Protected procedure calls are rewritten
4318 -- as entry calls and handled accordingly.
4319
4320 -- In Ada 2005, this may be an indirect call to an access parameter that
4321 -- is an access_to_subprogram. In that case the anonymous type has a
4322 -- scope that is a protected operation, but the call is a regular one.
4323 -- In either case do not expand call if subprogram is eliminated.
4324
4325 Scop := Scope (Subp);
4326
4327 if Nkind (Call_Node) /= N_Entry_Call_Statement
4328 and then Is_Protected_Type (Scop)
4329 and then Ekind (Subp) /= E_Subprogram_Type
4330 and then not Is_Eliminated (Subp)
4331 then
4332 -- If the call is an internal one, it is rewritten as a call to the
4333 -- corresponding unprotected subprogram.
4334
4335 Expand_Protected_Subprogram_Call (Call_Node, Subp, Scop);
4336 end if;
4337
4338 -- Functions returning controlled objects need special attention. If
4339 -- the return type is limited, then the context is initialization and
4340 -- different processing applies. If the call is to a protected function,
4341 -- the expansion above will call Expand_Call recursively. Otherwise the
4342 -- function call is transformed into a temporary which obtains the
4343 -- result from the secondary stack.
4344
4345 if Needs_Finalization (Etype (Subp)) then
4346 if not Is_Build_In_Place_Function_Call (Call_Node)
4347 and then
4348 (No (First_Formal (Subp))
4349 or else
4350 not Is_Concurrent_Record_Type (Etype (First_Formal (Subp))))
4351 then
4352 Expand_Ctrl_Function_Call (Call_Node);
4353
4354 -- Build-in-place function calls which appear in anonymous contexts
4355 -- need a transient scope to ensure the proper finalization of the
4356 -- intermediate result after its use.
4357
4358 elsif Is_Build_In_Place_Function_Call (Call_Node)
4359 and then Nkind_In (Parent (Unqual_Conv (Call_Node)),
4360 N_Attribute_Reference,
4361 N_Function_Call,
4362 N_Indexed_Component,
4363 N_Object_Renaming_Declaration,
4364 N_Procedure_Call_Statement,
4365 N_Selected_Component,
4366 N_Slice)
4367 and then
4368 (Ekind (Current_Scope) /= E_Loop
4369 or else Nkind (Parent (N)) /= N_Function_Call
4370 or else not Is_Build_In_Place_Function_Call (Parent (N)))
4371 then
4372 Establish_Transient_Scope (Call_Node, Sec_Stack => True);
4373 end if;
4374 end if;
4375 end Expand_Call_Helper;
4376
4377 -------------------------------
4378 -- Expand_Ctrl_Function_Call --
4379 -------------------------------
4380
4381 procedure Expand_Ctrl_Function_Call (N : Node_Id) is
4382 function Is_Element_Reference (N : Node_Id) return Boolean;
4383 -- Determine whether node N denotes a reference to an Ada 2012 container
4384 -- element.
4385
4386 --------------------------
4387 -- Is_Element_Reference --
4388 --------------------------
4389
4390 function Is_Element_Reference (N : Node_Id) return Boolean is
4391 Ref : constant Node_Id := Original_Node (N);
4392
4393 begin
4394 -- Analysis marks an element reference by setting the generalized
4395 -- indexing attribute of an indexed component before the component
4396 -- is rewritten into a function call.
4397
4398 return
4399 Nkind (Ref) = N_Indexed_Component
4400 and then Present (Generalized_Indexing (Ref));
4401 end Is_Element_Reference;
4402
4403 -- Start of processing for Expand_Ctrl_Function_Call
4404
4405 begin
4406 -- Optimization, if the returned value (which is on the sec-stack) is
4407 -- returned again, no need to copy/readjust/finalize, we can just pass
4408 -- the value thru (see Expand_N_Simple_Return_Statement), and thus no
4409 -- attachment is needed
4410
4411 if Nkind (Parent (N)) = N_Simple_Return_Statement then
4412 return;
4413 end if;
4414
4415 -- Resolution is now finished, make sure we don't start analysis again
4416 -- because of the duplication.
4417
4418 Set_Analyzed (N);
4419
4420 -- A function which returns a controlled object uses the secondary
4421 -- stack. Rewrite the call into a temporary which obtains the result of
4422 -- the function using 'reference.
4423
4424 Remove_Side_Effects (N);
4425
4426 -- The side effect removal of the function call produced a temporary.
4427 -- When the context is a case expression, if expression, or expression
4428 -- with actions, the lifetime of the temporary must be extended to match
4429 -- that of the context. Otherwise the function result will be finalized
4430 -- too early and affect the result of the expression. To prevent this
4431 -- unwanted effect, the temporary should not be considered for clean up
4432 -- actions by the general finalization machinery.
4433
4434 -- Exception to this rule are references to Ada 2012 container elements.
4435 -- Such references must be finalized at the end of each iteration of the
4436 -- related quantified expression, otherwise the container will remain
4437 -- busy.
4438
4439 if Nkind (N) = N_Explicit_Dereference
4440 and then Within_Case_Or_If_Expression (N)
4441 and then not Is_Element_Reference (N)
4442 then
4443 Set_Is_Ignored_Transient (Entity (Prefix (N)));
4444 end if;
4445 end Expand_Ctrl_Function_Call;
4446
4447 ----------------------------------------
4448 -- Expand_N_Extended_Return_Statement --
4449 ----------------------------------------
4450
4451 -- If there is a Handled_Statement_Sequence, we rewrite this:
4452
4453 -- return Result : T := <expression> do
4454 -- <handled_seq_of_stms>
4455 -- end return;
4456
4457 -- to be:
4458
4459 -- declare
4460 -- Result : T := <expression>;
4461 -- begin
4462 -- <handled_seq_of_stms>
4463 -- return Result;
4464 -- end;
4465
4466 -- Otherwise (no Handled_Statement_Sequence), we rewrite this:
4467
4468 -- return Result : T := <expression>;
4469
4470 -- to be:
4471
4472 -- return <expression>;
4473
4474 -- unless it's build-in-place or there's no <expression>, in which case
4475 -- we generate:
4476
4477 -- declare
4478 -- Result : T := <expression>;
4479 -- begin
4480 -- return Result;
4481 -- end;
4482
4483 -- Note that this case could have been written by the user as an extended
4484 -- return statement, or could have been transformed to this from a simple
4485 -- return statement.
4486
4487 -- That is, we need to have a reified return object if there are statements
4488 -- (which might refer to it) or if we're doing build-in-place (so we can
4489 -- set its address to the final resting place or if there is no expression
4490 -- (in which case default initial values might need to be set).
4491
4492 procedure Expand_N_Extended_Return_Statement (N : Node_Id) is
4493 Loc : constant Source_Ptr := Sloc (N);
4494
4495 function Build_Heap_Allocator
4496 (Temp_Id : Entity_Id;
4497 Temp_Typ : Entity_Id;
4498 Func_Id : Entity_Id;
4499 Ret_Typ : Entity_Id;
4500 Alloc_Expr : Node_Id) return Node_Id;
4501 -- Create the statements necessary to allocate a return object on the
4502 -- caller's master. The master is available through implicit parameter
4503 -- BIPfinalizationmaster.
4504 --
4505 -- if BIPfinalizationmaster /= null then
4506 -- declare
4507 -- type Ptr_Typ is access Ret_Typ;
4508 -- for Ptr_Typ'Storage_Pool use
4509 -- Base_Pool (BIPfinalizationmaster.all).all;
4510 -- Local : Ptr_Typ;
4511 --
4512 -- begin
4513 -- procedure Allocate (...) is
4514 -- begin
4515 -- System.Storage_Pools.Subpools.Allocate_Any (...);
4516 -- end Allocate;
4517 --
4518 -- Local := <Alloc_Expr>;
4519 -- Temp_Id := Temp_Typ (Local);
4520 -- end;
4521 -- end if;
4522 --
4523 -- Temp_Id is the temporary which is used to reference the internally
4524 -- created object in all allocation forms. Temp_Typ is the type of the
4525 -- temporary. Func_Id is the enclosing function. Ret_Typ is the return
4526 -- type of Func_Id. Alloc_Expr is the actual allocator.
4527
4528 function Move_Activation_Chain (Func_Id : Entity_Id) return Node_Id;
4529 -- Construct a call to System.Tasking.Stages.Move_Activation_Chain
4530 -- with parameters:
4531 -- From current activation chain
4532 -- To activation chain passed in by the caller
4533 -- New_Master master passed in by the caller
4534 --
4535 -- Func_Id is the entity of the function where the extended return
4536 -- statement appears.
4537
4538 --------------------------
4539 -- Build_Heap_Allocator --
4540 --------------------------
4541
4542 function Build_Heap_Allocator
4543 (Temp_Id : Entity_Id;
4544 Temp_Typ : Entity_Id;
4545 Func_Id : Entity_Id;
4546 Ret_Typ : Entity_Id;
4547 Alloc_Expr : Node_Id) return Node_Id
4548 is
4549 begin
4550 pragma Assert (Is_Build_In_Place_Function (Func_Id));
4551
4552 -- Processing for build-in-place object allocation.
4553
4554 if Needs_Finalization (Ret_Typ) then
4555 declare
4556 Decls : constant List_Id := New_List;
4557 Fin_Mas_Id : constant Entity_Id :=
4558 Build_In_Place_Formal
4559 (Func_Id, BIP_Finalization_Master);
4560 Stmts : constant List_Id := New_List;
4561 Desig_Typ : Entity_Id;
4562 Local_Id : Entity_Id;
4563 Pool_Id : Entity_Id;
4564 Ptr_Typ : Entity_Id;
4565
4566 begin
4567 -- Generate:
4568 -- Pool_Id renames Base_Pool (BIPfinalizationmaster.all).all;
4569
4570 Pool_Id := Make_Temporary (Loc, 'P');
4571
4572 Append_To (Decls,
4573 Make_Object_Renaming_Declaration (Loc,
4574 Defining_Identifier => Pool_Id,
4575 Subtype_Mark =>
4576 New_Occurrence_Of (RTE (RE_Root_Storage_Pool), Loc),
4577 Name =>
4578 Make_Explicit_Dereference (Loc,
4579 Prefix =>
4580 Make_Function_Call (Loc,
4581 Name =>
4582 New_Occurrence_Of (RTE (RE_Base_Pool), Loc),
4583 Parameter_Associations => New_List (
4584 Make_Explicit_Dereference (Loc,
4585 Prefix =>
4586 New_Occurrence_Of (Fin_Mas_Id, Loc)))))));
4587
4588 -- Create an access type which uses the storage pool of the
4589 -- caller's master. This additional type is necessary because
4590 -- the finalization master cannot be associated with the type
4591 -- of the temporary. Otherwise the secondary stack allocation
4592 -- will fail.
4593
4594 Desig_Typ := Ret_Typ;
4595
4596 -- Ensure that the build-in-place machinery uses a fat pointer
4597 -- when allocating an unconstrained array on the heap. In this
4598 -- case the result object type is a constrained array type even
4599 -- though the function type is unconstrained.
4600
4601 if Ekind (Desig_Typ) = E_Array_Subtype then
4602 Desig_Typ := Base_Type (Desig_Typ);
4603 end if;
4604
4605 -- Generate:
4606 -- type Ptr_Typ is access Desig_Typ;
4607
4608 Ptr_Typ := Make_Temporary (Loc, 'P');
4609
4610 Append_To (Decls,
4611 Make_Full_Type_Declaration (Loc,
4612 Defining_Identifier => Ptr_Typ,
4613 Type_Definition =>
4614 Make_Access_To_Object_Definition (Loc,
4615 Subtype_Indication =>
4616 New_Occurrence_Of (Desig_Typ, Loc))));
4617
4618 -- Perform minor decoration in order to set the master and the
4619 -- storage pool attributes.
4620
4621 Set_Ekind (Ptr_Typ, E_Access_Type);
4622 Set_Finalization_Master (Ptr_Typ, Fin_Mas_Id);
4623 Set_Associated_Storage_Pool (Ptr_Typ, Pool_Id);
4624
4625 -- Create the temporary, generate:
4626 -- Local_Id : Ptr_Typ;
4627
4628 Local_Id := Make_Temporary (Loc, 'T');
4629
4630 Append_To (Decls,
4631 Make_Object_Declaration (Loc,
4632 Defining_Identifier => Local_Id,
4633 Object_Definition =>
4634 New_Occurrence_Of (Ptr_Typ, Loc)));
4635
4636 -- Allocate the object, generate:
4637 -- Local_Id := <Alloc_Expr>;
4638
4639 Append_To (Stmts,
4640 Make_Assignment_Statement (Loc,
4641 Name => New_Occurrence_Of (Local_Id, Loc),
4642 Expression => Alloc_Expr));
4643
4644 -- Generate:
4645 -- Temp_Id := Temp_Typ (Local_Id);
4646
4647 Append_To (Stmts,
4648 Make_Assignment_Statement (Loc,
4649 Name => New_Occurrence_Of (Temp_Id, Loc),
4650 Expression =>
4651 Unchecked_Convert_To (Temp_Typ,
4652 New_Occurrence_Of (Local_Id, Loc))));
4653
4654 -- Wrap the allocation in a block. This is further conditioned
4655 -- by checking the caller finalization master at runtime. A
4656 -- null value indicates a non-existent master, most likely due
4657 -- to a Finalize_Storage_Only allocation.
4658
4659 -- Generate:
4660 -- if BIPfinalizationmaster /= null then
4661 -- declare
4662 -- <Decls>
4663 -- begin
4664 -- <Stmts>
4665 -- end;
4666 -- end if;
4667
4668 return
4669 Make_If_Statement (Loc,
4670 Condition =>
4671 Make_Op_Ne (Loc,
4672 Left_Opnd => New_Occurrence_Of (Fin_Mas_Id, Loc),
4673 Right_Opnd => Make_Null (Loc)),
4674
4675 Then_Statements => New_List (
4676 Make_Block_Statement (Loc,
4677 Declarations => Decls,
4678 Handled_Statement_Sequence =>
4679 Make_Handled_Sequence_Of_Statements (Loc,
4680 Statements => Stmts))));
4681 end;
4682
4683 -- For all other cases, generate:
4684 -- Temp_Id := <Alloc_Expr>;
4685
4686 else
4687 return
4688 Make_Assignment_Statement (Loc,
4689 Name => New_Occurrence_Of (Temp_Id, Loc),
4690 Expression => Alloc_Expr);
4691 end if;
4692 end Build_Heap_Allocator;
4693
4694 ---------------------------
4695 -- Move_Activation_Chain --
4696 ---------------------------
4697
4698 function Move_Activation_Chain (Func_Id : Entity_Id) return Node_Id is
4699 begin
4700 return
4701 Make_Procedure_Call_Statement (Loc,
4702 Name =>
4703 New_Occurrence_Of (RTE (RE_Move_Activation_Chain), Loc),
4704
4705 Parameter_Associations => New_List (
4706
4707 -- Source chain
4708
4709 Make_Attribute_Reference (Loc,
4710 Prefix => Make_Identifier (Loc, Name_uChain),
4711 Attribute_Name => Name_Unrestricted_Access),
4712
4713 -- Destination chain
4714
4715 New_Occurrence_Of
4716 (Build_In_Place_Formal (Func_Id, BIP_Activation_Chain), Loc),
4717
4718 -- New master
4719
4720 New_Occurrence_Of
4721 (Build_In_Place_Formal (Func_Id, BIP_Task_Master), Loc)));
4722 end Move_Activation_Chain;
4723
4724 -- Local variables
4725
4726 Func_Id : constant Entity_Id :=
4727 Return_Applies_To (Return_Statement_Entity (N));
4728 Is_BIP_Func : constant Boolean :=
4729 Is_Build_In_Place_Function (Func_Id);
4730 Ret_Obj_Id : constant Entity_Id :=
4731 First_Entity (Return_Statement_Entity (N));
4732 Ret_Obj_Decl : constant Node_Id := Parent (Ret_Obj_Id);
4733 Ret_Typ : constant Entity_Id := Etype (Func_Id);
4734
4735 Exp : Node_Id;
4736 HSS : Node_Id;
4737 Result : Node_Id;
4738 Stmts : List_Id;
4739
4740 Return_Stmt : Node_Id := Empty;
4741 -- Force initialization to facilitate static analysis
4742
4743 -- Start of processing for Expand_N_Extended_Return_Statement
4744
4745 begin
4746 -- Given that functionality of interface thunks is simple (just displace
4747 -- the pointer to the object) they are always handled by means of
4748 -- simple return statements.
4749
4750 pragma Assert (not Is_Thunk (Current_Scope));
4751
4752 if Nkind (Ret_Obj_Decl) = N_Object_Declaration then
4753 Exp := Expression (Ret_Obj_Decl);
4754
4755 -- Assert that if F says "return R : T := G(...) do..."
4756 -- then F and G are both b-i-p, or neither b-i-p.
4757
4758 if Nkind (Exp) = N_Function_Call then
4759 pragma Assert (Ekind (Current_Scope) = E_Function);
4760 pragma Assert
4761 (Is_Build_In_Place_Function (Current_Scope) =
4762 Is_Build_In_Place_Function_Call (Exp));
4763 null;
4764 end if;
4765 else
4766 Exp := Empty;
4767 end if;
4768
4769 HSS := Handled_Statement_Sequence (N);
4770
4771 -- If the returned object needs finalization actions, the function must
4772 -- perform the appropriate cleanup should it fail to return. The state
4773 -- of the function itself is tracked through a flag which is coupled
4774 -- with the scope finalizer. There is one flag per each return object
4775 -- in case of multiple returns.
4776
4777 if Is_BIP_Func and then Needs_Finalization (Etype (Ret_Obj_Id)) then
4778 declare
4779 Flag_Decl : Node_Id;
4780 Flag_Id : Entity_Id;
4781 Func_Bod : Node_Id;
4782
4783 begin
4784 -- Recover the function body
4785
4786 Func_Bod := Unit_Declaration_Node (Func_Id);
4787
4788 if Nkind (Func_Bod) = N_Subprogram_Declaration then
4789 Func_Bod := Parent (Parent (Corresponding_Body (Func_Bod)));
4790 end if;
4791
4792 if Nkind (Func_Bod) = N_Function_Specification then
4793 Func_Bod := Parent (Func_Bod); -- one more level for child units
4794 end if;
4795
4796 pragma Assert (Nkind (Func_Bod) = N_Subprogram_Body);
4797
4798 -- Create a flag to track the function state
4799
4800 Flag_Id := Make_Temporary (Loc, 'F');
4801 Set_Status_Flag_Or_Transient_Decl (Ret_Obj_Id, Flag_Id);
4802
4803 -- Insert the flag at the beginning of the function declarations,
4804 -- generate:
4805 -- Fnn : Boolean := False;
4806
4807 Flag_Decl :=
4808 Make_Object_Declaration (Loc,
4809 Defining_Identifier => Flag_Id,
4810 Object_Definition =>
4811 New_Occurrence_Of (Standard_Boolean, Loc),
4812 Expression =>
4813 New_Occurrence_Of (Standard_False, Loc));
4814
4815 Prepend_To (Declarations (Func_Bod), Flag_Decl);
4816 Analyze (Flag_Decl);
4817 end;
4818 end if;
4819
4820 -- Build a simple_return_statement that returns the return object when
4821 -- there is a statement sequence, or no expression, or the result will
4822 -- be built in place. Note however that we currently do this for all
4823 -- composite cases, even though not all are built in place.
4824
4825 if Present (HSS)
4826 or else Is_Composite_Type (Ret_Typ)
4827 or else No (Exp)
4828 then
4829 if No (HSS) then
4830 Stmts := New_List;
4831
4832 -- If the extended return has a handled statement sequence, then wrap
4833 -- it in a block and use the block as the first statement.
4834
4835 else
4836 Stmts := New_List (
4837 Make_Block_Statement (Loc,
4838 Declarations => New_List,
4839 Handled_Statement_Sequence => HSS));
4840 end if;
4841
4842 -- If the result type contains tasks, we call Move_Activation_Chain.
4843 -- Later, the cleanup code will call Complete_Master, which will
4844 -- terminate any unactivated tasks belonging to the return statement
4845 -- master. But Move_Activation_Chain updates their master to be that
4846 -- of the caller, so they will not be terminated unless the return
4847 -- statement completes unsuccessfully due to exception, abort, goto,
4848 -- or exit. As a formality, we test whether the function requires the
4849 -- result to be built in place, though that's necessarily true for
4850 -- the case of result types with task parts.
4851
4852 if Is_BIP_Func and then Has_Task (Ret_Typ) then
4853
4854 -- The return expression is an aggregate for a complex type which
4855 -- contains tasks. This particular case is left unexpanded since
4856 -- the regular expansion would insert all temporaries and
4857 -- initialization code in the wrong block.
4858
4859 if Nkind (Exp) = N_Aggregate then
4860 Expand_N_Aggregate (Exp);
4861 end if;
4862
4863 -- Do not move the activation chain if the return object does not
4864 -- contain tasks.
4865
4866 if Has_Task (Etype (Ret_Obj_Id)) then
4867 Append_To (Stmts, Move_Activation_Chain (Func_Id));
4868 end if;
4869 end if;
4870
4871 -- Update the state of the function right before the object is
4872 -- returned.
4873
4874 if Is_BIP_Func and then Needs_Finalization (Etype (Ret_Obj_Id)) then
4875 declare
4876 Flag_Id : constant Entity_Id :=
4877 Status_Flag_Or_Transient_Decl (Ret_Obj_Id);
4878
4879 begin
4880 -- Generate:
4881 -- Fnn := True;
4882
4883 Append_To (Stmts,
4884 Make_Assignment_Statement (Loc,
4885 Name => New_Occurrence_Of (Flag_Id, Loc),
4886 Expression => New_Occurrence_Of (Standard_True, Loc)));
4887 end;
4888 end if;
4889
4890 -- Build a simple_return_statement that returns the return object
4891
4892 Return_Stmt :=
4893 Make_Simple_Return_Statement (Loc,
4894 Expression => New_Occurrence_Of (Ret_Obj_Id, Loc));
4895 Append_To (Stmts, Return_Stmt);
4896
4897 HSS := Make_Handled_Sequence_Of_Statements (Loc, Stmts);
4898 end if;
4899
4900 -- Case where we build a return statement block
4901
4902 if Present (HSS) then
4903 Result :=
4904 Make_Block_Statement (Loc,
4905 Declarations => Return_Object_Declarations (N),
4906 Handled_Statement_Sequence => HSS);
4907
4908 -- We set the entity of the new block statement to be that of the
4909 -- return statement. This is necessary so that various fields, such
4910 -- as Finalization_Chain_Entity carry over from the return statement
4911 -- to the block. Note that this block is unusual, in that its entity
4912 -- is an E_Return_Statement rather than an E_Block.
4913
4914 Set_Identifier
4915 (Result, New_Occurrence_Of (Return_Statement_Entity (N), Loc));
4916
4917 -- If the object decl was already rewritten as a renaming, then we
4918 -- don't want to do the object allocation and transformation of
4919 -- the return object declaration to a renaming. This case occurs
4920 -- when the return object is initialized by a call to another
4921 -- build-in-place function, and that function is responsible for
4922 -- the allocation of the return object.
4923
4924 if Is_BIP_Func
4925 and then Nkind (Ret_Obj_Decl) = N_Object_Renaming_Declaration
4926 then
4927 pragma Assert
4928 (Nkind (Original_Node (Ret_Obj_Decl)) = N_Object_Declaration
4929 and then
4930
4931 -- It is a regular BIP object declaration
4932
4933 (Is_Build_In_Place_Function_Call
4934 (Expression (Original_Node (Ret_Obj_Decl)))
4935
4936 -- It is a BIP object declaration that displaces the pointer
4937 -- to the object to reference a convered interface type.
4938
4939 or else
4940 Present (Unqual_BIP_Iface_Function_Call
4941 (Expression (Original_Node (Ret_Obj_Decl))))));
4942
4943 -- Return the build-in-place result by reference
4944
4945 Set_By_Ref (Return_Stmt);
4946
4947 elsif Is_BIP_Func then
4948
4949 -- Locate the implicit access parameter associated with the
4950 -- caller-supplied return object and convert the return
4951 -- statement's return object declaration to a renaming of a
4952 -- dereference of the access parameter. If the return object's
4953 -- declaration includes an expression that has not already been
4954 -- expanded as separate assignments, then add an assignment
4955 -- statement to ensure the return object gets initialized.
4956
4957 -- declare
4958 -- Result : T [:= <expression>];
4959 -- begin
4960 -- ...
4961
4962 -- is converted to
4963
4964 -- declare
4965 -- Result : T renames FuncRA.all;
4966 -- [Result := <expression;]
4967 -- begin
4968 -- ...
4969
4970 declare
4971 Ret_Obj_Expr : constant Node_Id := Expression (Ret_Obj_Decl);
4972 Ret_Obj_Typ : constant Entity_Id := Etype (Ret_Obj_Id);
4973
4974 Init_Assignment : Node_Id := Empty;
4975 Obj_Acc_Formal : Entity_Id;
4976 Obj_Acc_Deref : Node_Id;
4977 Obj_Alloc_Formal : Entity_Id;
4978
4979 begin
4980 -- Build-in-place results must be returned by reference
4981
4982 Set_By_Ref (Return_Stmt);
4983
4984 -- Retrieve the implicit access parameter passed by the caller
4985
4986 Obj_Acc_Formal :=
4987 Build_In_Place_Formal (Func_Id, BIP_Object_Access);
4988
4989 -- If the return object's declaration includes an expression
4990 -- and the declaration isn't marked as No_Initialization, then
4991 -- we need to generate an assignment to the object and insert
4992 -- it after the declaration before rewriting it as a renaming
4993 -- (otherwise we'll lose the initialization). The case where
4994 -- the result type is an interface (or class-wide interface)
4995 -- is also excluded because the context of the function call
4996 -- must be unconstrained, so the initialization will always
4997 -- be done as part of an allocator evaluation (storage pool
4998 -- or secondary stack), never to a constrained target object
4999 -- passed in by the caller. Besides the assignment being
5000 -- unneeded in this case, it avoids problems with trying to
5001 -- generate a dispatching assignment when the return expression
5002 -- is a nonlimited descendant of a limited interface (the
5003 -- interface has no assignment operation).
5004
5005 if Present (Ret_Obj_Expr)
5006 and then not No_Initialization (Ret_Obj_Decl)
5007 and then not Is_Interface (Ret_Obj_Typ)
5008 then
5009 Init_Assignment :=
5010 Make_Assignment_Statement (Loc,
5011 Name => New_Occurrence_Of (Ret_Obj_Id, Loc),
5012 Expression => New_Copy_Tree (Ret_Obj_Expr));
5013
5014 Set_Etype (Name (Init_Assignment), Etype (Ret_Obj_Id));
5015 Set_Assignment_OK (Name (Init_Assignment));
5016 Set_No_Ctrl_Actions (Init_Assignment);
5017
5018 Set_Parent (Name (Init_Assignment), Init_Assignment);
5019 Set_Parent (Expression (Init_Assignment), Init_Assignment);
5020
5021 Set_Expression (Ret_Obj_Decl, Empty);
5022
5023 if Is_Class_Wide_Type (Etype (Ret_Obj_Id))
5024 and then not Is_Class_Wide_Type
5025 (Etype (Expression (Init_Assignment)))
5026 then
5027 Rewrite (Expression (Init_Assignment),
5028 Make_Type_Conversion (Loc,
5029 Subtype_Mark =>
5030 New_Occurrence_Of (Etype (Ret_Obj_Id), Loc),
5031 Expression =>
5032 Relocate_Node (Expression (Init_Assignment))));
5033 end if;
5034
5035 -- In the case of functions where the calling context can
5036 -- determine the form of allocation needed, initialization
5037 -- is done with each part of the if statement that handles
5038 -- the different forms of allocation (this is true for
5039 -- unconstrained and tagged result subtypes).
5040
5041 if Is_Constrained (Ret_Typ)
5042 and then not Is_Tagged_Type (Underlying_Type (Ret_Typ))
5043 then
5044 Insert_After (Ret_Obj_Decl, Init_Assignment);
5045 end if;
5046 end if;
5047
5048 -- When the function's subtype is unconstrained, a run-time
5049 -- test is needed to determine the form of allocation to use
5050 -- for the return object. The function has an implicit formal
5051 -- parameter indicating this. If the BIP_Alloc_Form formal has
5052 -- the value one, then the caller has passed access to an
5053 -- existing object for use as the return object. If the value
5054 -- is two, then the return object must be allocated on the
5055 -- secondary stack. Otherwise, the object must be allocated in
5056 -- a storage pool. We generate an if statement to test the
5057 -- implicit allocation formal and initialize a local access
5058 -- value appropriately, creating allocators in the secondary
5059 -- stack and global heap cases. The special formal also exists
5060 -- and must be tested when the function has a tagged result,
5061 -- even when the result subtype is constrained, because in
5062 -- general such functions can be called in dispatching contexts
5063 -- and must be handled similarly to functions with a class-wide
5064 -- result.
5065
5066 if not Is_Constrained (Ret_Typ)
5067 or else Is_Tagged_Type (Underlying_Type (Ret_Typ))
5068 then
5069 Obj_Alloc_Formal :=
5070 Build_In_Place_Formal (Func_Id, BIP_Alloc_Form);
5071
5072 declare
5073 Pool_Id : constant Entity_Id :=
5074 Make_Temporary (Loc, 'P');
5075 Alloc_Obj_Id : Entity_Id;
5076 Alloc_Obj_Decl : Node_Id;
5077 Alloc_If_Stmt : Node_Id;
5078 Heap_Allocator : Node_Id;
5079 Pool_Decl : Node_Id;
5080 Pool_Allocator : Node_Id;
5081 Ptr_Type_Decl : Node_Id;
5082 Ref_Type : Entity_Id;
5083 SS_Allocator : Node_Id;
5084
5085 begin
5086 -- Reuse the itype created for the function's implicit
5087 -- access formal. This avoids the need to create a new
5088 -- access type here, plus it allows assigning the access
5089 -- formal directly without applying a conversion.
5090
5091 -- Ref_Type := Etype (Object_Access);
5092
5093 -- Create an access type designating the function's
5094 -- result subtype.
5095
5096 Ref_Type := Make_Temporary (Loc, 'A');
5097
5098 Ptr_Type_Decl :=
5099 Make_Full_Type_Declaration (Loc,
5100 Defining_Identifier => Ref_Type,
5101 Type_Definition =>
5102 Make_Access_To_Object_Definition (Loc,
5103 All_Present => True,
5104 Subtype_Indication =>
5105 New_Occurrence_Of (Ret_Obj_Typ, Loc)));
5106
5107 Insert_Before (Ret_Obj_Decl, Ptr_Type_Decl);
5108
5109 -- Create an access object that will be initialized to an
5110 -- access value denoting the return object, either coming
5111 -- from an implicit access value passed in by the caller
5112 -- or from the result of an allocator.
5113
5114 Alloc_Obj_Id := Make_Temporary (Loc, 'R');
5115 Set_Etype (Alloc_Obj_Id, Ref_Type);
5116
5117 Alloc_Obj_Decl :=
5118 Make_Object_Declaration (Loc,
5119 Defining_Identifier => Alloc_Obj_Id,
5120 Object_Definition =>
5121 New_Occurrence_Of (Ref_Type, Loc));
5122
5123 Insert_Before (Ret_Obj_Decl, Alloc_Obj_Decl);
5124
5125 -- Create allocators for both the secondary stack and
5126 -- global heap. If there's an initialization expression,
5127 -- then create these as initialized allocators.
5128
5129 if Present (Ret_Obj_Expr)
5130 and then not No_Initialization (Ret_Obj_Decl)
5131 then
5132 -- Always use the type of the expression for the
5133 -- qualified expression, rather than the result type.
5134 -- In general we cannot always use the result type
5135 -- for the allocator, because the expression might be
5136 -- of a specific type, such as in the case of an
5137 -- aggregate or even a nonlimited object when the
5138 -- result type is a limited class-wide interface type.
5139
5140 Heap_Allocator :=
5141 Make_Allocator (Loc,
5142 Expression =>
5143 Make_Qualified_Expression (Loc,
5144 Subtype_Mark =>
5145 New_Occurrence_Of
5146 (Etype (Ret_Obj_Expr), Loc),
5147 Expression => New_Copy_Tree (Ret_Obj_Expr)));
5148
5149 else
5150 -- If the function returns a class-wide type we cannot
5151 -- use the return type for the allocator. Instead we
5152 -- use the type of the expression, which must be an
5153 -- aggregate of a definite type.
5154
5155 if Is_Class_Wide_Type (Ret_Obj_Typ) then
5156 Heap_Allocator :=
5157 Make_Allocator (Loc,
5158 Expression =>
5159 New_Occurrence_Of
5160 (Etype (Ret_Obj_Expr), Loc));
5161 else
5162 Heap_Allocator :=
5163 Make_Allocator (Loc,
5164 Expression =>
5165 New_Occurrence_Of (Ret_Obj_Typ, Loc));
5166 end if;
5167
5168 -- If the object requires default initialization then
5169 -- that will happen later following the elaboration of
5170 -- the object renaming. If we don't turn it off here
5171 -- then the object will be default initialized twice.
5172
5173 Set_No_Initialization (Heap_Allocator);
5174 end if;
5175
5176 -- Set the flag indicating that the allocator came from
5177 -- a build-in-place return statement, so we can avoid
5178 -- adjusting the allocated object. Note that this flag
5179 -- will be inherited by the copies made below.
5180
5181 Set_Alloc_For_BIP_Return (Heap_Allocator);
5182
5183 -- The Pool_Allocator is just like the Heap_Allocator,
5184 -- except we set Storage_Pool and Procedure_To_Call so
5185 -- it will use the user-defined storage pool.
5186
5187 Pool_Allocator := New_Copy_Tree (Heap_Allocator);
5188 pragma Assert (Alloc_For_BIP_Return (Pool_Allocator));
5189
5190 -- Do not generate the renaming of the build-in-place
5191 -- pool parameter on ZFP because the parameter is not
5192 -- created in the first place.
5193
5194 if RTE_Available (RE_Root_Storage_Pool_Ptr) then
5195 Pool_Decl :=
5196 Make_Object_Renaming_Declaration (Loc,
5197 Defining_Identifier => Pool_Id,
5198 Subtype_Mark =>
5199 New_Occurrence_Of
5200 (RTE (RE_Root_Storage_Pool), Loc),
5201 Name =>
5202 Make_Explicit_Dereference (Loc,
5203 New_Occurrence_Of
5204 (Build_In_Place_Formal
5205 (Func_Id, BIP_Storage_Pool), Loc)));
5206 Set_Storage_Pool (Pool_Allocator, Pool_Id);
5207 Set_Procedure_To_Call
5208 (Pool_Allocator, RTE (RE_Allocate_Any));
5209 else
5210 Pool_Decl := Make_Null_Statement (Loc);
5211 end if;
5212
5213 -- If the No_Allocators restriction is active, then only
5214 -- an allocator for secondary stack allocation is needed.
5215 -- It's OK for such allocators to have Comes_From_Source
5216 -- set to False, because gigi knows not to flag them as
5217 -- being a violation of No_Implicit_Heap_Allocations.
5218
5219 if Restriction_Active (No_Allocators) then
5220 SS_Allocator := Heap_Allocator;
5221 Heap_Allocator := Make_Null (Loc);
5222 Pool_Allocator := Make_Null (Loc);
5223
5224 -- Otherwise the heap and pool allocators may be needed,
5225 -- so we make another allocator for secondary stack
5226 -- allocation.
5227
5228 else
5229 SS_Allocator := New_Copy_Tree (Heap_Allocator);
5230 pragma Assert (Alloc_For_BIP_Return (SS_Allocator));
5231
5232 -- The heap and pool allocators are marked as
5233 -- Comes_From_Source since they correspond to an
5234 -- explicit user-written allocator (that is, it will
5235 -- only be executed on behalf of callers that call the
5236 -- function as initialization for such an allocator).
5237 -- Prevents errors when No_Implicit_Heap_Allocations
5238 -- is in force.
5239
5240 Set_Comes_From_Source (Heap_Allocator, True);
5241 Set_Comes_From_Source (Pool_Allocator, True);
5242 end if;
5243
5244 -- The allocator is returned on the secondary stack.
5245
5246 Set_Storage_Pool (SS_Allocator, RTE (RE_SS_Pool));
5247 Set_Procedure_To_Call
5248 (SS_Allocator, RTE (RE_SS_Allocate));
5249
5250 -- The allocator is returned on the secondary stack,
5251 -- so indicate that the function return, as well as
5252 -- all blocks that encloses the allocator, must not
5253 -- release it. The flags must be set now because
5254 -- the decision to use the secondary stack is done
5255 -- very late in the course of expanding the return
5256 -- statement, past the point where these flags are
5257 -- normally set.
5258
5259 Set_Uses_Sec_Stack (Func_Id);
5260 Set_Uses_Sec_Stack (Return_Statement_Entity (N));
5261 Set_Sec_Stack_Needed_For_Return
5262 (Return_Statement_Entity (N));
5263 Set_Enclosing_Sec_Stack_Return (N);
5264
5265 -- Create an if statement to test the BIP_Alloc_Form
5266 -- formal and initialize the access object to either the
5267 -- BIP_Object_Access formal (BIP_Alloc_Form =
5268 -- Caller_Allocation), the result of allocating the
5269 -- object in the secondary stack (BIP_Alloc_Form =
5270 -- Secondary_Stack), or else an allocator to create the
5271 -- return object in the heap or user-defined pool
5272 -- (BIP_Alloc_Form = Global_Heap or User_Storage_Pool).
5273
5274 -- ??? An unchecked type conversion must be made in the
5275 -- case of assigning the access object formal to the
5276 -- local access object, because a normal conversion would
5277 -- be illegal in some cases (such as converting access-
5278 -- to-unconstrained to access-to-constrained), but the
5279 -- the unchecked conversion will presumably fail to work
5280 -- right in just such cases. It's not clear at all how to
5281 -- handle this. ???
5282
5283 Alloc_If_Stmt :=
5284 Make_If_Statement (Loc,
5285 Condition =>
5286 Make_Op_Eq (Loc,
5287 Left_Opnd =>
5288 New_Occurrence_Of (Obj_Alloc_Formal, Loc),
5289 Right_Opnd =>
5290 Make_Integer_Literal (Loc,
5291 UI_From_Int (BIP_Allocation_Form'Pos
5292 (Caller_Allocation)))),
5293
5294 Then_Statements => New_List (
5295 Make_Assignment_Statement (Loc,
5296 Name =>
5297 New_Occurrence_Of (Alloc_Obj_Id, Loc),
5298 Expression =>
5299 Make_Unchecked_Type_Conversion (Loc,
5300 Subtype_Mark =>
5301 New_Occurrence_Of (Ref_Type, Loc),
5302 Expression =>
5303 New_Occurrence_Of (Obj_Acc_Formal, Loc)))),
5304
5305 Elsif_Parts => New_List (
5306 Make_Elsif_Part (Loc,
5307 Condition =>
5308 Make_Op_Eq (Loc,
5309 Left_Opnd =>
5310 New_Occurrence_Of (Obj_Alloc_Formal, Loc),
5311 Right_Opnd =>
5312 Make_Integer_Literal (Loc,
5313 UI_From_Int (BIP_Allocation_Form'Pos
5314 (Secondary_Stack)))),
5315
5316 Then_Statements => New_List (
5317 Make_Assignment_Statement (Loc,
5318 Name =>
5319 New_Occurrence_Of (Alloc_Obj_Id, Loc),
5320 Expression => SS_Allocator))),
5321
5322 Make_Elsif_Part (Loc,
5323 Condition =>
5324 Make_Op_Eq (Loc,
5325 Left_Opnd =>
5326 New_Occurrence_Of (Obj_Alloc_Formal, Loc),
5327 Right_Opnd =>
5328 Make_Integer_Literal (Loc,
5329 UI_From_Int (BIP_Allocation_Form'Pos
5330 (Global_Heap)))),
5331
5332 Then_Statements => New_List (
5333 Build_Heap_Allocator
5334 (Temp_Id => Alloc_Obj_Id,
5335 Temp_Typ => Ref_Type,
5336 Func_Id => Func_Id,
5337 Ret_Typ => Ret_Obj_Typ,
5338 Alloc_Expr => Heap_Allocator))),
5339
5340 -- ???If all is well, we can put the following
5341 -- 'elsif' in the 'else', but this is a useful
5342 -- self-check in case caller and callee don't agree
5343 -- on whether BIPAlloc and so on should be passed.
5344
5345 Make_Elsif_Part (Loc,
5346 Condition =>
5347 Make_Op_Eq (Loc,
5348 Left_Opnd =>
5349 New_Occurrence_Of (Obj_Alloc_Formal, Loc),
5350 Right_Opnd =>
5351 Make_Integer_Literal (Loc,
5352 UI_From_Int (BIP_Allocation_Form'Pos
5353 (User_Storage_Pool)))),
5354
5355 Then_Statements => New_List (
5356 Pool_Decl,
5357 Build_Heap_Allocator
5358 (Temp_Id => Alloc_Obj_Id,
5359 Temp_Typ => Ref_Type,
5360 Func_Id => Func_Id,
5361 Ret_Typ => Ret_Obj_Typ,
5362 Alloc_Expr => Pool_Allocator)))),
5363
5364 -- Raise Program_Error if it's none of the above;
5365 -- this is a compiler bug. ???PE_All_Guards_Closed
5366 -- is bogus; we should have a new code.
5367
5368 Else_Statements => New_List (
5369 Make_Raise_Program_Error (Loc,
5370 Reason => PE_All_Guards_Closed)));
5371
5372 -- If a separate initialization assignment was created
5373 -- earlier, append that following the assignment of the
5374 -- implicit access formal to the access object, to ensure
5375 -- that the return object is initialized in that case. In
5376 -- this situation, the target of the assignment must be
5377 -- rewritten to denote a dereference of the access to the
5378 -- return object passed in by the caller.
5379
5380 if Present (Init_Assignment) then
5381 Rewrite (Name (Init_Assignment),
5382 Make_Explicit_Dereference (Loc,
5383 Prefix => New_Occurrence_Of (Alloc_Obj_Id, Loc)));
5384 pragma Assert
5385 (Assignment_OK
5386 (Original_Node (Name (Init_Assignment))));
5387 Set_Assignment_OK (Name (Init_Assignment));
5388
5389 Set_Etype (Name (Init_Assignment), Etype (Ret_Obj_Id));
5390
5391 Append_To
5392 (Then_Statements (Alloc_If_Stmt), Init_Assignment);
5393 end if;
5394
5395 Insert_Before (Ret_Obj_Decl, Alloc_If_Stmt);
5396
5397 -- Remember the local access object for use in the
5398 -- dereference of the renaming created below.
5399
5400 Obj_Acc_Formal := Alloc_Obj_Id;
5401 end;
5402 end if;
5403
5404 -- Replace the return object declaration with a renaming of a
5405 -- dereference of the access value designating the return
5406 -- object.
5407
5408 Obj_Acc_Deref :=
5409 Make_Explicit_Dereference (Loc,
5410 Prefix => New_Occurrence_Of (Obj_Acc_Formal, Loc));
5411
5412 Rewrite (Ret_Obj_Decl,
5413 Make_Object_Renaming_Declaration (Loc,
5414 Defining_Identifier => Ret_Obj_Id,
5415 Access_Definition => Empty,
5416 Subtype_Mark => New_Occurrence_Of (Ret_Obj_Typ, Loc),
5417 Name => Obj_Acc_Deref));
5418
5419 Set_Renamed_Object (Ret_Obj_Id, Obj_Acc_Deref);
5420 end;
5421 end if;
5422
5423 -- Case where we do not build a block
5424
5425 else
5426 -- We're about to drop Return_Object_Declarations on the floor, so
5427 -- we need to insert it, in case it got expanded into useful code.
5428 -- Remove side effects from expression, which may be duplicated in
5429 -- subsequent checks (see Expand_Simple_Function_Return).
5430
5431 Insert_List_Before (N, Return_Object_Declarations (N));
5432 Remove_Side_Effects (Exp);
5433
5434 -- Build simple_return_statement that returns the expression directly
5435
5436 Return_Stmt := Make_Simple_Return_Statement (Loc, Expression => Exp);
5437 Result := Return_Stmt;
5438 end if;
5439
5440 -- Set the flag to prevent infinite recursion
5441
5442 Set_Comes_From_Extended_Return_Statement (Return_Stmt);
5443
5444 Rewrite (N, Result);
5445 Analyze (N);
5446 end Expand_N_Extended_Return_Statement;
5447
5448 ----------------------------
5449 -- Expand_N_Function_Call --
5450 ----------------------------
5451
5452 procedure Expand_N_Function_Call (N : Node_Id) is
5453 begin
5454 Expand_Call (N);
5455 end Expand_N_Function_Call;
5456
5457 ---------------------------------------
5458 -- Expand_N_Procedure_Call_Statement --
5459 ---------------------------------------
5460
5461 procedure Expand_N_Procedure_Call_Statement (N : Node_Id) is
5462 begin
5463 Expand_Call (N);
5464 end Expand_N_Procedure_Call_Statement;
5465
5466 --------------------------------------
5467 -- Expand_N_Simple_Return_Statement --
5468 --------------------------------------
5469
5470 procedure Expand_N_Simple_Return_Statement (N : Node_Id) is
5471 begin
5472 -- Defend against previous errors (i.e. the return statement calls a
5473 -- function that is not available in configurable runtime).
5474
5475 if Present (Expression (N))
5476 and then Nkind (Expression (N)) = N_Empty
5477 then
5478 Check_Error_Detected;
5479 return;
5480 end if;
5481
5482 -- Distinguish the function and non-function cases:
5483
5484 case Ekind (Return_Applies_To (Return_Statement_Entity (N))) is
5485 when E_Function
5486 | E_Generic_Function
5487 =>
5488 Expand_Simple_Function_Return (N);
5489
5490 when E_Entry
5491 | E_Entry_Family
5492 | E_Generic_Procedure
5493 | E_Procedure
5494 | E_Return_Statement
5495 =>
5496 Expand_Non_Function_Return (N);
5497
5498 when others =>
5499 raise Program_Error;
5500 end case;
5501
5502 exception
5503 when RE_Not_Available =>
5504 return;
5505 end Expand_N_Simple_Return_Statement;
5506
5507 ------------------------------
5508 -- Expand_N_Subprogram_Body --
5509 ------------------------------
5510
5511 -- Add poll call if ATC polling is enabled, unless the body will be inlined
5512 -- by the back-end.
5513
5514 -- Add dummy push/pop label nodes at start and end to clear any local
5515 -- exception indications if local-exception-to-goto optimization is active.
5516
5517 -- Add return statement if last statement in body is not a return statement
5518 -- (this makes things easier on Gigi which does not want to have to handle
5519 -- a missing return).
5520
5521 -- Add call to Activate_Tasks if body is a task activator
5522
5523 -- Deal with possible detection of infinite recursion
5524
5525 -- Eliminate body completely if convention stubbed
5526
5527 -- Encode entity names within body, since we will not need to reference
5528 -- these entities any longer in the front end.
5529
5530 -- Initialize scalar out parameters if Initialize/Normalize_Scalars
5531
5532 -- Reset Pure indication if any parameter has root type System.Address
5533 -- or has any parameters of limited types, where limited means that the
5534 -- run-time view is limited (i.e. the full type is limited).
5535
5536 -- Wrap thread body
5537
5538 procedure Expand_N_Subprogram_Body (N : Node_Id) is
5539 Body_Id : constant Entity_Id := Defining_Entity (N);
5540 HSS : constant Node_Id := Handled_Statement_Sequence (N);
5541 Loc : constant Source_Ptr := Sloc (N);
5542
5543 procedure Add_Return (Spec_Id : Entity_Id; Stmts : List_Id);
5544 -- Append a return statement to the statement sequence Stmts if the last
5545 -- statement is not already a return or a goto statement. Note that the
5546 -- latter test is not critical, it does not matter if we add a few extra
5547 -- returns, since they get eliminated anyway later on. Spec_Id denotes
5548 -- the corresponding spec of the subprogram body.
5549
5550 ----------------
5551 -- Add_Return --
5552 ----------------
5553
5554 procedure Add_Return (Spec_Id : Entity_Id; Stmts : List_Id) is
5555 Last_Stmt : Node_Id;
5556 Loc : Source_Ptr;
5557 Stmt : Node_Id;
5558
5559 begin
5560 -- Get last statement, ignoring any Pop_xxx_Label nodes, which are
5561 -- not relevant in this context since they are not executable.
5562
5563 Last_Stmt := Last (Stmts);
5564 while Nkind (Last_Stmt) in N_Pop_xxx_Label loop
5565 Prev (Last_Stmt);
5566 end loop;
5567
5568 -- Now insert return unless last statement is a transfer
5569
5570 if not Is_Transfer (Last_Stmt) then
5571
5572 -- The source location for the return is the end label of the
5573 -- procedure if present. Otherwise use the sloc of the last
5574 -- statement in the list. If the list comes from a generated
5575 -- exception handler and we are not debugging generated code,
5576 -- all the statements within the handler are made invisible
5577 -- to the debugger.
5578
5579 if Nkind (Parent (Stmts)) = N_Exception_Handler
5580 and then not Comes_From_Source (Parent (Stmts))
5581 then
5582 Loc := Sloc (Last_Stmt);
5583 elsif Present (End_Label (HSS)) then
5584 Loc := Sloc (End_Label (HSS));
5585 else
5586 Loc := Sloc (Last_Stmt);
5587 end if;
5588
5589 -- Append return statement, and set analyzed manually. We can't
5590 -- call Analyze on this return since the scope is wrong.
5591
5592 -- Note: it almost works to push the scope and then do the Analyze
5593 -- call, but something goes wrong in some weird cases and it is
5594 -- not worth worrying about ???
5595
5596 Stmt := Make_Simple_Return_Statement (Loc);
5597
5598 -- The return statement is handled properly, and the call to the
5599 -- postcondition, inserted below, does not require information
5600 -- from the body either. However, that call is analyzed in the
5601 -- enclosing scope, and an elaboration check might improperly be
5602 -- added to it. A guard in Sem_Elab is needed to prevent that
5603 -- spurious check, see Check_Elab_Call.
5604
5605 Append_To (Stmts, Stmt);
5606 Set_Analyzed (Stmt);
5607
5608 -- Call the _Postconditions procedure if the related subprogram
5609 -- has contract assertions that need to be verified on exit.
5610
5611 if Ekind (Spec_Id) = E_Procedure
5612 and then Present (Postconditions_Proc (Spec_Id))
5613 then
5614 Insert_Action (Stmt,
5615 Make_Procedure_Call_Statement (Loc,
5616 Name =>
5617 New_Occurrence_Of (Postconditions_Proc (Spec_Id), Loc)));
5618 end if;
5619 end if;
5620 end Add_Return;
5621
5622 -- Local variables
5623
5624 Except_H : Node_Id;
5625 L : List_Id;
5626 Spec_Id : Entity_Id;
5627
5628 -- Start of processing for Expand_N_Subprogram_Body
5629
5630 begin
5631 if Present (Corresponding_Spec (N)) then
5632 Spec_Id := Corresponding_Spec (N);
5633 else
5634 Spec_Id := Body_Id;
5635 end if;
5636
5637 -- If this is a Pure function which has any parameters whose root type
5638 -- is System.Address, reset the Pure indication.
5639 -- This check is also performed when the subprogram is frozen, but we
5640 -- repeat it on the body so that the indication is consistent, and so
5641 -- it applies as well to bodies without separate specifications.
5642
5643 if Is_Pure (Spec_Id)
5644 and then Is_Subprogram (Spec_Id)
5645 and then not Has_Pragma_Pure_Function (Spec_Id)
5646 then
5647 Check_Function_With_Address_Parameter (Spec_Id);
5648
5649 if Spec_Id /= Body_Id then
5650 Set_Is_Pure (Body_Id, Is_Pure (Spec_Id));
5651 end if;
5652 end if;
5653
5654 -- Set L to either the list of declarations if present, or to the list
5655 -- of statements if no declarations are present. This is used to insert
5656 -- new stuff at the start.
5657
5658 if Is_Non_Empty_List (Declarations (N)) then
5659 L := Declarations (N);
5660 else
5661 L := Statements (HSS);
5662 end if;
5663
5664 -- If local-exception-to-goto optimization active, insert dummy push
5665 -- statements at start, and dummy pop statements at end, but inhibit
5666 -- this if we have No_Exception_Handlers, since they are useless and
5667 -- intefere with analysis, e.g. by codepeer.
5668
5669 if (Debug_Flag_Dot_G
5670 or else Restriction_Active (No_Exception_Propagation))
5671 and then not Restriction_Active (No_Exception_Handlers)
5672 and then not CodePeer_Mode
5673 and then Is_Non_Empty_List (L)
5674 then
5675 declare
5676 FS : constant Node_Id := First (L);
5677 FL : constant Source_Ptr := Sloc (FS);
5678 LS : Node_Id;
5679 LL : Source_Ptr;
5680
5681 begin
5682 -- LS points to either last statement, if statements are present
5683 -- or to the last declaration if there are no statements present.
5684 -- It is the node after which the pop's are generated.
5685
5686 if Is_Non_Empty_List (Statements (HSS)) then
5687 LS := Last (Statements (HSS));
5688 else
5689 LS := Last (L);
5690 end if;
5691
5692 LL := Sloc (LS);
5693
5694 Insert_List_Before_And_Analyze (FS, New_List (
5695 Make_Push_Constraint_Error_Label (FL),
5696 Make_Push_Program_Error_Label (FL),
5697 Make_Push_Storage_Error_Label (FL)));
5698
5699 Insert_List_After_And_Analyze (LS, New_List (
5700 Make_Pop_Constraint_Error_Label (LL),
5701 Make_Pop_Program_Error_Label (LL),
5702 Make_Pop_Storage_Error_Label (LL)));
5703 end;
5704 end if;
5705
5706 -- Need poll on entry to subprogram if polling enabled. We only do this
5707 -- for non-empty subprograms, since it does not seem necessary to poll
5708 -- for a dummy null subprogram.
5709
5710 if Is_Non_Empty_List (L) then
5711
5712 -- Do not add a polling call if the subprogram is to be inlined by
5713 -- the back-end, to avoid repeated calls with multiple inlinings.
5714
5715 if Is_Inlined (Spec_Id)
5716 and then Front_End_Inlining
5717 and then Optimization_Level > 1
5718 then
5719 null;
5720 else
5721 Generate_Poll_Call (First (L));
5722 end if;
5723 end if;
5724
5725 -- Initialize any scalar OUT args if Initialize/Normalize_Scalars
5726
5727 if Init_Or_Norm_Scalars and then Is_Subprogram (Spec_Id) then
5728 declare
5729 F : Entity_Id;
5730 A : Node_Id;
5731
5732 begin
5733 -- Loop through formals
5734
5735 F := First_Formal (Spec_Id);
5736 while Present (F) loop
5737 if Is_Scalar_Type (Etype (F))
5738 and then Ekind (F) = E_Out_Parameter
5739 then
5740 Check_Restriction (No_Default_Initialization, F);
5741
5742 -- Insert the initialization. We turn off validity checks
5743 -- for this assignment, since we do not want any check on
5744 -- the initial value itself (which may well be invalid).
5745 -- Predicate checks are disabled as well (RM 6.4.1 (13/3))
5746
5747 A :=
5748 Make_Assignment_Statement (Loc,
5749 Name => New_Occurrence_Of (F, Loc),
5750 Expression => Get_Simple_Init_Val (Etype (F), N));
5751 Set_Suppress_Assignment_Checks (A);
5752
5753 Insert_Before_And_Analyze (First (L),
5754 A, Suppress => Validity_Check);
5755 end if;
5756
5757 Next_Formal (F);
5758 end loop;
5759 end;
5760 end if;
5761
5762 -- Clear out statement list for stubbed procedure
5763
5764 if Present (Corresponding_Spec (N)) then
5765 Set_Elaboration_Flag (N, Spec_Id);
5766
5767 if Convention (Spec_Id) = Convention_Stubbed
5768 or else Is_Eliminated (Spec_Id)
5769 then
5770 Set_Declarations (N, Empty_List);
5771 Set_Handled_Statement_Sequence (N,
5772 Make_Handled_Sequence_Of_Statements (Loc,
5773 Statements => New_List (Make_Null_Statement (Loc))));
5774
5775 return;
5776 end if;
5777 end if;
5778
5779 -- Create a set of discriminals for the next protected subprogram body
5780
5781 if Is_List_Member (N)
5782 and then Present (Parent (List_Containing (N)))
5783 and then Nkind (Parent (List_Containing (N))) = N_Protected_Body
5784 and then Present (Next_Protected_Operation (N))
5785 then
5786 Set_Discriminals (Parent (Base_Type (Scope (Spec_Id))));
5787 end if;
5788
5789 -- Returns_By_Ref flag is normally set when the subprogram is frozen but
5790 -- subprograms with no specs are not frozen.
5791
5792 declare
5793 Typ : constant Entity_Id := Etype (Spec_Id);
5794 Utyp : constant Entity_Id := Underlying_Type (Typ);
5795
5796 begin
5797 if Is_Limited_View (Typ) then
5798 Set_Returns_By_Ref (Spec_Id);
5799
5800 elsif Present (Utyp) and then CW_Or_Has_Controlled_Part (Utyp) then
5801 Set_Returns_By_Ref (Spec_Id);
5802 end if;
5803 end;
5804
5805 -- For a procedure, we add a return for all possible syntactic ends of
5806 -- the subprogram.
5807
5808 if Ekind_In (Spec_Id, E_Procedure, E_Generic_Procedure) then
5809 Add_Return (Spec_Id, Statements (HSS));
5810
5811 if Present (Exception_Handlers (HSS)) then
5812 Except_H := First_Non_Pragma (Exception_Handlers (HSS));
5813 while Present (Except_H) loop
5814 Add_Return (Spec_Id, Statements (Except_H));
5815 Next_Non_Pragma (Except_H);
5816 end loop;
5817 end if;
5818
5819 -- For a function, we must deal with the case where there is at least
5820 -- one missing return. What we do is to wrap the entire body of the
5821 -- function in a block:
5822
5823 -- begin
5824 -- ...
5825 -- end;
5826
5827 -- becomes
5828
5829 -- begin
5830 -- begin
5831 -- ...
5832 -- end;
5833
5834 -- raise Program_Error;
5835 -- end;
5836
5837 -- This approach is necessary because the raise must be signalled to the
5838 -- caller, not handled by any local handler (RM 6.4(11)).
5839
5840 -- Note: we do not need to analyze the constructed sequence here, since
5841 -- it has no handler, and an attempt to analyze the handled statement
5842 -- sequence twice is risky in various ways (e.g. the issue of expanding
5843 -- cleanup actions twice).
5844
5845 elsif Has_Missing_Return (Spec_Id) then
5846 declare
5847 Hloc : constant Source_Ptr := Sloc (HSS);
5848 Blok : constant Node_Id :=
5849 Make_Block_Statement (Hloc,
5850 Handled_Statement_Sequence => HSS);
5851 Rais : constant Node_Id :=
5852 Make_Raise_Program_Error (Hloc,
5853 Reason => PE_Missing_Return);
5854
5855 begin
5856 Set_Handled_Statement_Sequence (N,
5857 Make_Handled_Sequence_Of_Statements (Hloc,
5858 Statements => New_List (Blok, Rais)));
5859
5860 Push_Scope (Spec_Id);
5861 Analyze (Blok);
5862 Analyze (Rais);
5863 Pop_Scope;
5864 end;
5865 end if;
5866
5867 -- If subprogram contains a parameterless recursive call, then we may
5868 -- have an infinite recursion, so see if we can generate code to check
5869 -- for this possibility if storage checks are not suppressed.
5870
5871 if Ekind (Spec_Id) = E_Procedure
5872 and then Has_Recursive_Call (Spec_Id)
5873 and then not Storage_Checks_Suppressed (Spec_Id)
5874 then
5875 Detect_Infinite_Recursion (N, Spec_Id);
5876 end if;
5877
5878 -- Set to encode entity names in package body before gigi is called
5879
5880 Qualify_Entity_Names (N);
5881
5882 -- If the body belongs to a nonabstract library-level source primitive
5883 -- of a tagged type, install an elaboration check which ensures that a
5884 -- dispatching call targeting the primitive will not execute the body
5885 -- without it being previously elaborated.
5886
5887 Install_Primitive_Elaboration_Check (N);
5888 end Expand_N_Subprogram_Body;
5889
5890 -----------------------------------
5891 -- Expand_N_Subprogram_Body_Stub --
5892 -----------------------------------
5893
5894 procedure Expand_N_Subprogram_Body_Stub (N : Node_Id) is
5895 Bod : Node_Id;
5896
5897 begin
5898 if Present (Corresponding_Body (N)) then
5899 Bod := Unit_Declaration_Node (Corresponding_Body (N));
5900
5901 -- The body may have been expanded already when it is analyzed
5902 -- through the subunit node. Do no expand again: it interferes
5903 -- with the construction of unnesting tables when generating C.
5904
5905 if not Analyzed (Bod) then
5906 Expand_N_Subprogram_Body (Bod);
5907 end if;
5908
5909 -- Add full qualification to entities that may be created late
5910 -- during unnesting.
5911
5912 Qualify_Entity_Names (N);
5913 end if;
5914 end Expand_N_Subprogram_Body_Stub;
5915
5916 -------------------------------------
5917 -- Expand_N_Subprogram_Declaration --
5918 -------------------------------------
5919
5920 -- If the declaration appears within a protected body, it is a private
5921 -- operation of the protected type. We must create the corresponding
5922 -- protected subprogram an associated formals. For a normal protected
5923 -- operation, this is done when expanding the protected type declaration.
5924
5925 -- If the declaration is for a null procedure, emit null body
5926
5927 procedure Expand_N_Subprogram_Declaration (N : Node_Id) is
5928 Loc : constant Source_Ptr := Sloc (N);
5929 Subp : constant Entity_Id := Defining_Entity (N);
5930
5931 -- Local variables
5932
5933 Scop : constant Entity_Id := Scope (Subp);
5934 Prot_Bod : Node_Id;
5935 Prot_Decl : Node_Id;
5936 Prot_Id : Entity_Id;
5937
5938 -- Start of processing for Expand_N_Subprogram_Declaration
5939
5940 begin
5941 -- In SPARK, subprogram declarations are only allowed in package
5942 -- specifications.
5943
5944 if Nkind (Parent (N)) /= N_Package_Specification then
5945 if Nkind (Parent (N)) = N_Compilation_Unit then
5946 Check_SPARK_05_Restriction
5947 ("subprogram declaration is not a library item", N);
5948
5949 elsif Present (Next (N))
5950 and then Nkind (Next (N)) = N_Pragma
5951 and then Get_Pragma_Id (Next (N)) = Pragma_Import
5952 then
5953 -- In SPARK, subprogram declarations are also permitted in
5954 -- declarative parts when immediately followed by a corresponding
5955 -- pragma Import. We only check here that there is some pragma
5956 -- Import.
5957
5958 null;
5959 else
5960 Check_SPARK_05_Restriction
5961 ("subprogram declaration is not allowed here", N);
5962 end if;
5963 end if;
5964
5965 -- Deal with case of protected subprogram. Do not generate protected
5966 -- operation if operation is flagged as eliminated.
5967
5968 if Is_List_Member (N)
5969 and then Present (Parent (List_Containing (N)))
5970 and then Nkind (Parent (List_Containing (N))) = N_Protected_Body
5971 and then Is_Protected_Type (Scop)
5972 then
5973 if No (Protected_Body_Subprogram (Subp))
5974 and then not Is_Eliminated (Subp)
5975 then
5976 Prot_Decl :=
5977 Make_Subprogram_Declaration (Loc,
5978 Specification =>
5979 Build_Protected_Sub_Specification
5980 (N, Scop, Unprotected_Mode));
5981
5982 -- The protected subprogram is declared outside of the protected
5983 -- body. Given that the body has frozen all entities so far, we
5984 -- analyze the subprogram and perform freezing actions explicitly.
5985 -- including the generation of an explicit freeze node, to ensure
5986 -- that gigi has the proper order of elaboration.
5987 -- If the body is a subunit, the insertion point is before the
5988 -- stub in the parent.
5989
5990 Prot_Bod := Parent (List_Containing (N));
5991
5992 if Nkind (Parent (Prot_Bod)) = N_Subunit then
5993 Prot_Bod := Corresponding_Stub (Parent (Prot_Bod));
5994 end if;
5995
5996 Insert_Before (Prot_Bod, Prot_Decl);
5997 Prot_Id := Defining_Unit_Name (Specification (Prot_Decl));
5998 Set_Has_Delayed_Freeze (Prot_Id);
5999
6000 Push_Scope (Scope (Scop));
6001 Analyze (Prot_Decl);
6002 Freeze_Before (N, Prot_Id);
6003 Set_Protected_Body_Subprogram (Subp, Prot_Id);
6004
6005 -- Create protected operation as well. Even though the operation
6006 -- is only accessible within the body, it is possible to make it
6007 -- available outside of the protected object by using 'Access to
6008 -- provide a callback, so build protected version in all cases.
6009
6010 Prot_Decl :=
6011 Make_Subprogram_Declaration (Loc,
6012 Specification =>
6013 Build_Protected_Sub_Specification (N, Scop, Protected_Mode));
6014 Insert_Before (Prot_Bod, Prot_Decl);
6015 Analyze (Prot_Decl);
6016
6017 Pop_Scope;
6018 end if;
6019
6020 -- Ada 2005 (AI-348): Generate body for a null procedure. In most
6021 -- cases this is superfluous because calls to it will be automatically
6022 -- inlined, but we definitely need the body if preconditions for the
6023 -- procedure are present, or if performing coverage analysis.
6024
6025 elsif Nkind (Specification (N)) = N_Procedure_Specification
6026 and then Null_Present (Specification (N))
6027 then
6028 declare
6029 Bod : constant Node_Id := Body_To_Inline (N);
6030
6031 begin
6032 Set_Has_Completion (Subp, False);
6033 Append_Freeze_Action (Subp, Bod);
6034
6035 -- The body now contains raise statements, so calls to it will
6036 -- not be inlined.
6037
6038 Set_Is_Inlined (Subp, False);
6039 end;
6040 end if;
6041
6042 -- When generating C code, transform a function that returns a
6043 -- constrained array type into a procedure with an out parameter
6044 -- that carries the return value.
6045
6046 -- We skip this transformation for unchecked conversions, since they
6047 -- are not needed by the C generator (and this also produces cleaner
6048 -- output).
6049
6050 if Modify_Tree_For_C
6051 and then Nkind (Specification (N)) = N_Function_Specification
6052 and then Is_Array_Type (Etype (Subp))
6053 and then Is_Constrained (Etype (Subp))
6054 and then not Is_Unchecked_Conversion_Instance (Subp)
6055 then
6056 Build_Procedure_Form (N);
6057 end if;
6058 end Expand_N_Subprogram_Declaration;
6059
6060 --------------------------------
6061 -- Expand_Non_Function_Return --
6062 --------------------------------
6063
6064 procedure Expand_Non_Function_Return (N : Node_Id) is
6065 pragma Assert (No (Expression (N)));
6066
6067 Loc : constant Source_Ptr := Sloc (N);
6068 Scope_Id : Entity_Id := Return_Applies_To (Return_Statement_Entity (N));
6069 Kind : constant Entity_Kind := Ekind (Scope_Id);
6070 Call : Node_Id;
6071 Acc_Stat : Node_Id;
6072 Goto_Stat : Node_Id;
6073 Lab_Node : Node_Id;
6074
6075 begin
6076 -- Call the _Postconditions procedure if the related subprogram has
6077 -- contract assertions that need to be verified on exit.
6078
6079 if Ekind_In (Scope_Id, E_Entry, E_Entry_Family, E_Procedure)
6080 and then Present (Postconditions_Proc (Scope_Id))
6081 then
6082 Insert_Action (N,
6083 Make_Procedure_Call_Statement (Loc,
6084 Name => New_Occurrence_Of (Postconditions_Proc (Scope_Id), Loc)));
6085 end if;
6086
6087 -- If it is a return from a procedure do no extra steps
6088
6089 if Kind = E_Procedure or else Kind = E_Generic_Procedure then
6090 return;
6091
6092 -- If it is a nested return within an extended one, replace it with a
6093 -- return of the previously declared return object.
6094
6095 elsif Kind = E_Return_Statement then
6096 Rewrite (N,
6097 Make_Simple_Return_Statement (Loc,
6098 Expression =>
6099 New_Occurrence_Of (First_Entity (Scope_Id), Loc)));
6100 Set_Comes_From_Extended_Return_Statement (N);
6101 Set_Return_Statement_Entity (N, Scope_Id);
6102 Expand_Simple_Function_Return (N);
6103 return;
6104 end if;
6105
6106 pragma Assert (Is_Entry (Scope_Id));
6107
6108 -- Look at the enclosing block to see whether the return is from an
6109 -- accept statement or an entry body.
6110
6111 for J in reverse 0 .. Scope_Stack.Last loop
6112 Scope_Id := Scope_Stack.Table (J).Entity;
6113 exit when Is_Concurrent_Type (Scope_Id);
6114 end loop;
6115
6116 -- If it is a return from accept statement it is expanded as call to
6117 -- RTS Complete_Rendezvous and a goto to the end of the accept body.
6118
6119 -- (cf : Expand_N_Accept_Statement, Expand_N_Selective_Accept,
6120 -- Expand_N_Accept_Alternative in exp_ch9.adb)
6121
6122 if Is_Task_Type (Scope_Id) then
6123
6124 Call :=
6125 Make_Procedure_Call_Statement (Loc,
6126 Name => New_Occurrence_Of (RTE (RE_Complete_Rendezvous), Loc));
6127 Insert_Before (N, Call);
6128 -- why not insert actions here???
6129 Analyze (Call);
6130
6131 Acc_Stat := Parent (N);
6132 while Nkind (Acc_Stat) /= N_Accept_Statement loop
6133 Acc_Stat := Parent (Acc_Stat);
6134 end loop;
6135
6136 Lab_Node := Last (Statements
6137 (Handled_Statement_Sequence (Acc_Stat)));
6138
6139 Goto_Stat := Make_Goto_Statement (Loc,
6140 Name => New_Occurrence_Of
6141 (Entity (Identifier (Lab_Node)), Loc));
6142
6143 Set_Analyzed (Goto_Stat);
6144
6145 Rewrite (N, Goto_Stat);
6146 Analyze (N);
6147
6148 -- If it is a return from an entry body, put a Complete_Entry_Body call
6149 -- in front of the return.
6150
6151 elsif Is_Protected_Type (Scope_Id) then
6152 Call :=
6153 Make_Procedure_Call_Statement (Loc,
6154 Name =>
6155 New_Occurrence_Of (RTE (RE_Complete_Entry_Body), Loc),
6156 Parameter_Associations => New_List (
6157 Make_Attribute_Reference (Loc,
6158 Prefix =>
6159 New_Occurrence_Of
6160 (Find_Protection_Object (Current_Scope), Loc),
6161 Attribute_Name => Name_Unchecked_Access)));
6162
6163 Insert_Before (N, Call);
6164 Analyze (Call);
6165 end if;
6166 end Expand_Non_Function_Return;
6167
6168 ---------------------------------------
6169 -- Expand_Protected_Object_Reference --
6170 ---------------------------------------
6171
6172 function Expand_Protected_Object_Reference
6173 (N : Node_Id;
6174 Scop : Entity_Id) return Node_Id
6175 is
6176 Loc : constant Source_Ptr := Sloc (N);
6177 Corr : Entity_Id;
6178 Rec : Node_Id;
6179 Param : Entity_Id;
6180 Proc : Entity_Id;
6181
6182 begin
6183 Rec := Make_Identifier (Loc, Name_uObject);
6184 Set_Etype (Rec, Corresponding_Record_Type (Scop));
6185
6186 -- Find enclosing protected operation, and retrieve its first parameter,
6187 -- which denotes the enclosing protected object. If the enclosing
6188 -- operation is an entry, we are immediately within the protected body,
6189 -- and we can retrieve the object from the service entries procedure. A
6190 -- barrier function has the same signature as an entry. A barrier
6191 -- function is compiled within the protected object, but unlike
6192 -- protected operations its never needs locks, so that its protected
6193 -- body subprogram points to itself.
6194
6195 Proc := Current_Scope;
6196 while Present (Proc)
6197 and then Scope (Proc) /= Scop
6198 loop
6199 Proc := Scope (Proc);
6200 end loop;
6201
6202 Corr := Protected_Body_Subprogram (Proc);
6203
6204 if No (Corr) then
6205
6206 -- Previous error left expansion incomplete.
6207 -- Nothing to do on this call.
6208
6209 return Empty;
6210 end if;
6211
6212 Param :=
6213 Defining_Identifier
6214 (First (Parameter_Specifications (Parent (Corr))));
6215
6216 if Is_Subprogram (Proc) and then Proc /= Corr then
6217
6218 -- Protected function or procedure
6219
6220 Set_Entity (Rec, Param);
6221
6222 -- Rec is a reference to an entity which will not be in scope when
6223 -- the call is reanalyzed, and needs no further analysis.
6224
6225 Set_Analyzed (Rec);
6226
6227 else
6228 -- Entry or barrier function for entry body. The first parameter of
6229 -- the entry body procedure is pointer to the object. We create a
6230 -- local variable of the proper type, duplicating what is done to
6231 -- define _object later on.
6232
6233 declare
6234 Decls : List_Id;
6235 Obj_Ptr : constant Entity_Id := Make_Temporary (Loc, 'T');
6236
6237 begin
6238 Decls := New_List (
6239 Make_Full_Type_Declaration (Loc,
6240 Defining_Identifier => Obj_Ptr,
6241 Type_Definition =>
6242 Make_Access_To_Object_Definition (Loc,
6243 Subtype_Indication =>
6244 New_Occurrence_Of
6245 (Corresponding_Record_Type (Scop), Loc))));
6246
6247 Insert_Actions (N, Decls);
6248 Freeze_Before (N, Obj_Ptr);
6249
6250 Rec :=
6251 Make_Explicit_Dereference (Loc,
6252 Prefix =>
6253 Unchecked_Convert_To (Obj_Ptr,
6254 New_Occurrence_Of (Param, Loc)));
6255
6256 -- Analyze new actual. Other actuals in calls are already analyzed
6257 -- and the list of actuals is not reanalyzed after rewriting.
6258
6259 Set_Parent (Rec, N);
6260 Analyze (Rec);
6261 end;
6262 end if;
6263
6264 return Rec;
6265 end Expand_Protected_Object_Reference;
6266
6267 --------------------------------------
6268 -- Expand_Protected_Subprogram_Call --
6269 --------------------------------------
6270
6271 procedure Expand_Protected_Subprogram_Call
6272 (N : Node_Id;
6273 Subp : Entity_Id;
6274 Scop : Entity_Id)
6275 is
6276 Rec : Node_Id;
6277
6278 procedure Expand_Internal_Init_Call;
6279 -- A call to an operation of the type may occur in the initialization
6280 -- of a private component. In that case the prefix of the call is an
6281 -- entity name and the call is treated as internal even though it
6282 -- appears in code outside of the protected type.
6283
6284 procedure Freeze_Called_Function;
6285 -- If it is a function call it can appear in elaboration code and
6286 -- the called entity must be frozen before the call. This must be
6287 -- done before the call is expanded, as the expansion may rewrite it
6288 -- to something other than a call (e.g. a temporary initialized in a
6289 -- transient block).
6290
6291 -------------------------------
6292 -- Expand_Internal_Init_Call --
6293 -------------------------------
6294
6295 procedure Expand_Internal_Init_Call is
6296 begin
6297 -- If the context is a protected object (rather than a protected
6298 -- type) the call itself is bound to raise program_error because
6299 -- the protected body will not have been elaborated yet. This is
6300 -- diagnosed subsequently in Sem_Elab.
6301
6302 Freeze_Called_Function;
6303
6304 -- The target of the internal call is the first formal of the
6305 -- enclosing initialization procedure.
6306
6307 Rec := New_Occurrence_Of (First_Formal (Current_Scope), Sloc (N));
6308 Build_Protected_Subprogram_Call (N,
6309 Name => Name (N),
6310 Rec => Rec,
6311 External => False);
6312 Analyze (N);
6313 Resolve (N, Etype (Subp));
6314 end Expand_Internal_Init_Call;
6315
6316 ----------------------------
6317 -- Freeze_Called_Function --
6318 ----------------------------
6319
6320 procedure Freeze_Called_Function is
6321 begin
6322 if Ekind (Subp) = E_Function then
6323 Freeze_Expression (Name (N));
6324 end if;
6325 end Freeze_Called_Function;
6326
6327 -- Start of processing for Expand_Protected_Subprogram_Call
6328
6329 begin
6330 -- If the protected object is not an enclosing scope, this is an inter-
6331 -- object function call. Inter-object procedure calls are expanded by
6332 -- Exp_Ch9.Build_Simple_Entry_Call. The call is intra-object only if the
6333 -- subprogram being called is in the protected body being compiled, and
6334 -- if the protected object in the call is statically the enclosing type.
6335 -- The object may be a component of some other data structure, in which
6336 -- case this must be handled as an inter-object call.
6337
6338 if not In_Open_Scopes (Scop)
6339 or else Is_Entry_Wrapper (Current_Scope)
6340 or else not Is_Entity_Name (Name (N))
6341 then
6342 if Nkind (Name (N)) = N_Selected_Component then
6343 Rec := Prefix (Name (N));
6344
6345 elsif Nkind (Name (N)) = N_Indexed_Component then
6346 Rec := Prefix (Prefix (Name (N)));
6347
6348 -- If this is a call within an entry wrapper, it appears within a
6349 -- precondition that calls another primitive of the synchronized
6350 -- type. The target object of the call is the first actual on the
6351 -- wrapper. Note that this is an external call, because the wrapper
6352 -- is called outside of the synchronized object. This means that
6353 -- an entry call to an entry with preconditions involves two
6354 -- synchronized operations.
6355
6356 elsif Ekind (Current_Scope) = E_Procedure
6357 and then Is_Entry_Wrapper (Current_Scope)
6358 then
6359 Rec := New_Occurrence_Of (First_Entity (Current_Scope), Sloc (N));
6360
6361 else
6362 -- If the context is the initialization procedure for a protected
6363 -- type, the call is legal because the called entity must be a
6364 -- function of that enclosing type, and this is treated as an
6365 -- internal call.
6366
6367 pragma Assert
6368 (Is_Entity_Name (Name (N)) and then Inside_Init_Proc);
6369
6370 Expand_Internal_Init_Call;
6371 return;
6372 end if;
6373
6374 Freeze_Called_Function;
6375 Build_Protected_Subprogram_Call (N,
6376 Name => New_Occurrence_Of (Subp, Sloc (N)),
6377 Rec => Convert_Concurrent (Rec, Etype (Rec)),
6378 External => True);
6379
6380 else
6381 Rec := Expand_Protected_Object_Reference (N, Scop);
6382
6383 if No (Rec) then
6384 return;
6385 end if;
6386
6387 Freeze_Called_Function;
6388 Build_Protected_Subprogram_Call (N,
6389 Name => Name (N),
6390 Rec => Rec,
6391 External => False);
6392 end if;
6393
6394 -- Analyze and resolve the new call. The actuals have already been
6395 -- resolved, but expansion of a function call will add extra actuals
6396 -- if needed. Analysis of a procedure call already includes resolution.
6397
6398 Analyze (N);
6399
6400 if Ekind (Subp) = E_Function then
6401 Resolve (N, Etype (Subp));
6402 end if;
6403 end Expand_Protected_Subprogram_Call;
6404
6405 -----------------------------------
6406 -- Expand_Simple_Function_Return --
6407 -----------------------------------
6408
6409 -- The "simple" comes from the syntax rule simple_return_statement. The
6410 -- semantics are not at all simple.
6411
6412 procedure Expand_Simple_Function_Return (N : Node_Id) is
6413 Loc : constant Source_Ptr := Sloc (N);
6414
6415 Scope_Id : constant Entity_Id :=
6416 Return_Applies_To (Return_Statement_Entity (N));
6417 -- The function we are returning from
6418
6419 R_Type : constant Entity_Id := Etype (Scope_Id);
6420 -- The result type of the function
6421
6422 Utyp : constant Entity_Id := Underlying_Type (R_Type);
6423
6424 Exp : Node_Id := Expression (N);
6425 pragma Assert (Present (Exp));
6426
6427 Exptyp : constant Entity_Id := Etype (Exp);
6428 -- The type of the expression (not necessarily the same as R_Type)
6429
6430 Subtype_Ind : Node_Id;
6431 -- If the result type of the function is class-wide and the expression
6432 -- has a specific type, then we use the expression's type as the type of
6433 -- the return object. In cases where the expression is an aggregate that
6434 -- is built in place, this avoids the need for an expensive conversion
6435 -- of the return object to the specific type on assignments to the
6436 -- individual components.
6437
6438 begin
6439 if Is_Class_Wide_Type (R_Type)
6440 and then not Is_Class_Wide_Type (Exptyp)
6441 and then Nkind (Exp) /= N_Type_Conversion
6442 then
6443 Subtype_Ind := New_Occurrence_Of (Exptyp, Loc);
6444 else
6445 Subtype_Ind := New_Occurrence_Of (R_Type, Loc);
6446
6447 -- If the result type is class-wide and the expression is a view
6448 -- conversion, the conversion plays no role in the expansion because
6449 -- it does not modify the tag of the object. Remove the conversion
6450 -- altogether to prevent tag overwriting.
6451
6452 if Is_Class_Wide_Type (R_Type)
6453 and then not Is_Class_Wide_Type (Exptyp)
6454 and then Nkind (Exp) = N_Type_Conversion
6455 then
6456 Exp := Expression (Exp);
6457 end if;
6458 end if;
6459
6460 -- Assert that if F says "return G(...);"
6461 -- then F and G are both b-i-p, or neither b-i-p.
6462
6463 if Nkind (Exp) = N_Function_Call then
6464 pragma Assert (Ekind (Scope_Id) = E_Function);
6465 pragma Assert
6466 (Is_Build_In_Place_Function (Scope_Id) =
6467 Is_Build_In_Place_Function_Call (Exp));
6468 null;
6469 end if;
6470
6471 -- For the case of a simple return that does not come from an
6472 -- extended return, in the case of build-in-place, we rewrite
6473 -- "return <expression>;" to be:
6474
6475 -- return _anon_ : <return_subtype> := <expression>
6476
6477 -- The expansion produced by Expand_N_Extended_Return_Statement will
6478 -- contain simple return statements (for example, a block containing
6479 -- simple return of the return object), which brings us back here with
6480 -- Comes_From_Extended_Return_Statement set. The reason for the barrier
6481 -- checking for a simple return that does not come from an extended
6482 -- return is to avoid this infinite recursion.
6483
6484 -- The reason for this design is that for Ada 2005 limited returns, we
6485 -- need to reify the return object, so we can build it "in place", and
6486 -- we need a block statement to hang finalization and tasking stuff.
6487
6488 -- ??? In order to avoid disruption, we avoid translating to extended
6489 -- return except in the cases where we really need to (Ada 2005 for
6490 -- inherently limited). We might prefer to do this translation in all
6491 -- cases (except perhaps for the case of Ada 95 inherently limited),
6492 -- in order to fully exercise the Expand_N_Extended_Return_Statement
6493 -- code. This would also allow us to do the build-in-place optimization
6494 -- for efficiency even in cases where it is semantically not required.
6495
6496 -- As before, we check the type of the return expression rather than the
6497 -- return type of the function, because the latter may be a limited
6498 -- class-wide interface type, which is not a limited type, even though
6499 -- the type of the expression may be.
6500
6501 pragma Assert
6502 (Comes_From_Extended_Return_Statement (N)
6503 or else not Is_Build_In_Place_Function_Call (Exp)
6504 or else Is_Build_In_Place_Function (Scope_Id));
6505
6506 if not Comes_From_Extended_Return_Statement (N)
6507 and then Is_Build_In_Place_Function (Scope_Id)
6508 and then not Debug_Flag_Dot_L
6509
6510 -- The functionality of interface thunks is simple and it is always
6511 -- handled by means of simple return statements. This leaves their
6512 -- expansion simple and clean.
6513
6514 and then not Is_Thunk (Current_Scope)
6515 then
6516 declare
6517 Return_Object_Entity : constant Entity_Id :=
6518 Make_Temporary (Loc, 'R', Exp);
6519
6520 Obj_Decl : constant Node_Id :=
6521 Make_Object_Declaration (Loc,
6522 Defining_Identifier => Return_Object_Entity,
6523 Object_Definition => Subtype_Ind,
6524 Expression => Exp);
6525
6526 Ext : constant Node_Id :=
6527 Make_Extended_Return_Statement (Loc,
6528 Return_Object_Declarations => New_List (Obj_Decl));
6529 -- Do not perform this high-level optimization if the result type
6530 -- is an interface because the "this" pointer must be displaced.
6531
6532 begin
6533 Rewrite (N, Ext);
6534 Analyze (N);
6535 return;
6536 end;
6537 end if;
6538
6539 -- Here we have a simple return statement that is part of the expansion
6540 -- of an extended return statement (either written by the user, or
6541 -- generated by the above code).
6542
6543 -- Always normalize C/Fortran boolean result. This is not always needed,
6544 -- but it seems a good idea to minimize the passing around of non-
6545 -- normalized values, and in any case this handles the processing of
6546 -- barrier functions for protected types, which turn the condition into
6547 -- a return statement.
6548
6549 if Is_Boolean_Type (Exptyp)
6550 and then Nonzero_Is_True (Exptyp)
6551 then
6552 Adjust_Condition (Exp);
6553 Adjust_Result_Type (Exp, Exptyp);
6554 end if;
6555
6556 -- Do validity check if enabled for returns
6557
6558 if Validity_Checks_On
6559 and then Validity_Check_Returns
6560 then
6561 Ensure_Valid (Exp);
6562 end if;
6563
6564 -- Check the result expression of a scalar function against the subtype
6565 -- of the function by inserting a conversion. This conversion must
6566 -- eventually be performed for other classes of types, but for now it's
6567 -- only done for scalars.
6568 -- ???
6569
6570 if Is_Scalar_Type (Exptyp) then
6571 Rewrite (Exp, Convert_To (R_Type, Exp));
6572
6573 -- The expression is resolved to ensure that the conversion gets
6574 -- expanded to generate a possible constraint check.
6575
6576 Analyze_And_Resolve (Exp, R_Type);
6577 end if;
6578
6579 -- Deal with returning variable length objects and controlled types
6580
6581 -- Nothing to do if we are returning by reference, or this is not a
6582 -- type that requires special processing (indicated by the fact that
6583 -- it requires a cleanup scope for the secondary stack case).
6584
6585 if Is_Build_In_Place_Function (Scope_Id)
6586 or else Is_Limited_Interface (Exptyp)
6587 then
6588 null;
6589
6590 -- No copy needed for thunks returning interface type objects since
6591 -- the object is returned by reference and the maximum functionality
6592 -- required is just to displace the pointer.
6593
6594 elsif Is_Thunk (Current_Scope) and then Is_Interface (Exptyp) then
6595 null;
6596
6597 -- If the call is within a thunk and the type is a limited view, the
6598 -- backend will eventually see the non-limited view of the type.
6599
6600 elsif Is_Thunk (Current_Scope) and then Is_Incomplete_Type (Exptyp) then
6601 return;
6602
6603 elsif not Requires_Transient_Scope (R_Type) then
6604
6605 -- Mutable records with variable-length components are not returned
6606 -- on the sec-stack, so we need to make sure that the back end will
6607 -- only copy back the size of the actual value, and not the maximum
6608 -- size. We create an actual subtype for this purpose. However we
6609 -- need not do it if the expression is a function call since this
6610 -- will be done in the called function and doing it here too would
6611 -- cause a temporary with maximum size to be created.
6612
6613 declare
6614 Ubt : constant Entity_Id := Underlying_Type (Base_Type (Exptyp));
6615 Decl : Node_Id;
6616 Ent : Entity_Id;
6617 begin
6618 if Nkind (Exp) /= N_Function_Call
6619 and then Has_Discriminants (Ubt)
6620 and then not Is_Constrained (Ubt)
6621 and then not Has_Unchecked_Union (Ubt)
6622 then
6623 Decl := Build_Actual_Subtype (Ubt, Exp);
6624 Ent := Defining_Identifier (Decl);
6625 Insert_Action (Exp, Decl);
6626 Rewrite (Exp, Unchecked_Convert_To (Ent, Exp));
6627 Analyze_And_Resolve (Exp);
6628 end if;
6629 end;
6630
6631 -- Here if secondary stack is used
6632
6633 else
6634 -- Prevent the reclamation of the secondary stack by all enclosing
6635 -- blocks and loops as well as the related function; otherwise the
6636 -- result would be reclaimed too early.
6637
6638 Set_Enclosing_Sec_Stack_Return (N);
6639
6640 -- Optimize the case where the result is a function call. In this
6641 -- case either the result is already on the secondary stack, or is
6642 -- already being returned with the stack pointer depressed and no
6643 -- further processing is required except to set the By_Ref flag
6644 -- to ensure that gigi does not attempt an extra unnecessary copy.
6645 -- (actually not just unnecessary but harmfully wrong in the case
6646 -- of a controlled type, where gigi does not know how to do a copy).
6647 -- To make up for a gcc 2.8.1 deficiency (???), we perform the copy
6648 -- for array types if the constrained status of the target type is
6649 -- different from that of the expression.
6650
6651 if Requires_Transient_Scope (Exptyp)
6652 and then
6653 (not Is_Array_Type (Exptyp)
6654 or else Is_Constrained (Exptyp) = Is_Constrained (R_Type)
6655 or else CW_Or_Has_Controlled_Part (Utyp))
6656 and then Nkind (Exp) = N_Function_Call
6657 then
6658 Set_By_Ref (N);
6659
6660 -- Remove side effects from the expression now so that other parts
6661 -- of the expander do not have to reanalyze this node without this
6662 -- optimization
6663
6664 Rewrite (Exp, Duplicate_Subexpr_No_Checks (Exp));
6665
6666 -- Ada 2005 (AI-251): If the type of the returned object is
6667 -- an interface then add an implicit type conversion to force
6668 -- displacement of the "this" pointer.
6669
6670 if Is_Interface (R_Type) then
6671 Rewrite (Exp, Convert_To (R_Type, Relocate_Node (Exp)));
6672 end if;
6673
6674 Analyze_And_Resolve (Exp, R_Type);
6675
6676 -- For controlled types, do the allocation on the secondary stack
6677 -- manually in order to call adjust at the right time:
6678
6679 -- type Anon1 is access R_Type;
6680 -- for Anon1'Storage_pool use ss_pool;
6681 -- Anon2 : anon1 := new R_Type'(expr);
6682 -- return Anon2.all;
6683
6684 -- We do the same for classwide types that are not potentially
6685 -- controlled (by the virtue of restriction No_Finalization) because
6686 -- gigi is not able to properly allocate class-wide types.
6687
6688 elsif CW_Or_Has_Controlled_Part (Utyp) then
6689 declare
6690 Loc : constant Source_Ptr := Sloc (N);
6691 Acc_Typ : constant Entity_Id := Make_Temporary (Loc, 'A');
6692 Alloc_Node : Node_Id;
6693 Temp : Entity_Id;
6694
6695 begin
6696 Set_Ekind (Acc_Typ, E_Access_Type);
6697
6698 Set_Associated_Storage_Pool (Acc_Typ, RTE (RE_SS_Pool));
6699
6700 -- This is an allocator for the secondary stack, and it's fine
6701 -- to have Comes_From_Source set False on it, as gigi knows not
6702 -- to flag it as a violation of No_Implicit_Heap_Allocations.
6703
6704 Alloc_Node :=
6705 Make_Allocator (Loc,
6706 Expression =>
6707 Make_Qualified_Expression (Loc,
6708 Subtype_Mark => New_Occurrence_Of (Etype (Exp), Loc),
6709 Expression => Relocate_Node (Exp)));
6710
6711 -- We do not want discriminant checks on the declaration,
6712 -- given that it gets its value from the allocator.
6713
6714 Set_No_Initialization (Alloc_Node);
6715
6716 Temp := Make_Temporary (Loc, 'R', Alloc_Node);
6717
6718 Insert_List_Before_And_Analyze (N, New_List (
6719 Make_Full_Type_Declaration (Loc,
6720 Defining_Identifier => Acc_Typ,
6721 Type_Definition =>
6722 Make_Access_To_Object_Definition (Loc,
6723 Subtype_Indication => Subtype_Ind)),
6724
6725 Make_Object_Declaration (Loc,
6726 Defining_Identifier => Temp,
6727 Object_Definition => New_Occurrence_Of (Acc_Typ, Loc),
6728 Expression => Alloc_Node)));
6729
6730 Rewrite (Exp,
6731 Make_Explicit_Dereference (Loc,
6732 Prefix => New_Occurrence_Of (Temp, Loc)));
6733
6734 -- Ada 2005 (AI-251): If the type of the returned object is
6735 -- an interface then add an implicit type conversion to force
6736 -- displacement of the "this" pointer.
6737
6738 if Is_Interface (R_Type) then
6739 Rewrite (Exp, Convert_To (R_Type, Relocate_Node (Exp)));
6740 end if;
6741
6742 Analyze_And_Resolve (Exp, R_Type);
6743 end;
6744
6745 -- Otherwise use the gigi mechanism to allocate result on the
6746 -- secondary stack.
6747
6748 else
6749 Check_Restriction (No_Secondary_Stack, N);
6750 Set_Storage_Pool (N, RTE (RE_SS_Pool));
6751 Set_Procedure_To_Call (N, RTE (RE_SS_Allocate));
6752 end if;
6753 end if;
6754
6755 -- Implement the rules of 6.5(8-10), which require a tag check in
6756 -- the case of a limited tagged return type, and tag reassignment for
6757 -- nonlimited tagged results. These actions are needed when the return
6758 -- type is a specific tagged type and the result expression is a
6759 -- conversion or a formal parameter, because in that case the tag of
6760 -- the expression might differ from the tag of the specific result type.
6761
6762 if Is_Tagged_Type (Utyp)
6763 and then not Is_Class_Wide_Type (Utyp)
6764 and then (Nkind_In (Exp, N_Type_Conversion,
6765 N_Unchecked_Type_Conversion)
6766 or else (Is_Entity_Name (Exp)
6767 and then Ekind (Entity (Exp)) in Formal_Kind))
6768 then
6769 -- When the return type is limited, perform a check that the tag of
6770 -- the result is the same as the tag of the return type.
6771
6772 if Is_Limited_Type (R_Type) then
6773 Insert_Action (Exp,
6774 Make_Raise_Constraint_Error (Loc,
6775 Condition =>
6776 Make_Op_Ne (Loc,
6777 Left_Opnd =>
6778 Make_Selected_Component (Loc,
6779 Prefix => Duplicate_Subexpr (Exp),
6780 Selector_Name => Make_Identifier (Loc, Name_uTag)),
6781 Right_Opnd =>
6782 Make_Attribute_Reference (Loc,
6783 Prefix =>
6784 New_Occurrence_Of (Base_Type (Utyp), Loc),
6785 Attribute_Name => Name_Tag)),
6786 Reason => CE_Tag_Check_Failed));
6787
6788 -- If the result type is a specific nonlimited tagged type, then we
6789 -- have to ensure that the tag of the result is that of the result
6790 -- type. This is handled by making a copy of the expression in
6791 -- the case where it might have a different tag, namely when the
6792 -- expression is a conversion or a formal parameter. We create a new
6793 -- object of the result type and initialize it from the expression,
6794 -- which will implicitly force the tag to be set appropriately.
6795
6796 else
6797 declare
6798 ExpR : constant Node_Id := Relocate_Node (Exp);
6799 Result_Id : constant Entity_Id :=
6800 Make_Temporary (Loc, 'R', ExpR);
6801 Result_Exp : constant Node_Id :=
6802 New_Occurrence_Of (Result_Id, Loc);
6803 Result_Obj : constant Node_Id :=
6804 Make_Object_Declaration (Loc,
6805 Defining_Identifier => Result_Id,
6806 Object_Definition =>
6807 New_Occurrence_Of (R_Type, Loc),
6808 Constant_Present => True,
6809 Expression => ExpR);
6810
6811 begin
6812 Set_Assignment_OK (Result_Obj);
6813 Insert_Action (Exp, Result_Obj);
6814
6815 Rewrite (Exp, Result_Exp);
6816 Analyze_And_Resolve (Exp, R_Type);
6817 end;
6818 end if;
6819
6820 -- Ada 2005 (AI-344): If the result type is class-wide, then insert
6821 -- a check that the level of the return expression's underlying type
6822 -- is not deeper than the level of the master enclosing the function.
6823 -- Always generate the check when the type of the return expression
6824 -- is class-wide, when it's a type conversion, or when it's a formal
6825 -- parameter. Otherwise, suppress the check in the case where the
6826 -- return expression has a specific type whose level is known not to
6827 -- be statically deeper than the function's result type.
6828
6829 -- No runtime check needed in interface thunks since it is performed
6830 -- by the target primitive associated with the thunk.
6831
6832 -- Note: accessibility check is skipped in the VM case, since there
6833 -- does not seem to be any practical way to implement this check.
6834
6835 elsif Ada_Version >= Ada_2005
6836 and then Tagged_Type_Expansion
6837 and then Is_Class_Wide_Type (R_Type)
6838 and then not Is_Thunk (Current_Scope)
6839 and then not Scope_Suppress.Suppress (Accessibility_Check)
6840 and then
6841 (Is_Class_Wide_Type (Etype (Exp))
6842 or else Nkind_In (Exp, N_Type_Conversion,
6843 N_Unchecked_Type_Conversion)
6844 or else (Is_Entity_Name (Exp)
6845 and then Ekind (Entity (Exp)) in Formal_Kind)
6846 or else Scope_Depth (Enclosing_Dynamic_Scope (Etype (Exp))) >
6847 Scope_Depth (Enclosing_Dynamic_Scope (Scope_Id)))
6848 then
6849 declare
6850 Tag_Node : Node_Id;
6851
6852 begin
6853 -- Ada 2005 (AI-251): In class-wide interface objects we displace
6854 -- "this" to reference the base of the object. This is required to
6855 -- get access to the TSD of the object.
6856
6857 if Is_Class_Wide_Type (Etype (Exp))
6858 and then Is_Interface (Etype (Exp))
6859 then
6860 -- If the expression is an explicit dereference then we can
6861 -- directly displace the pointer to reference the base of
6862 -- the object.
6863
6864 if Nkind (Exp) = N_Explicit_Dereference then
6865 Tag_Node :=
6866 Make_Explicit_Dereference (Loc,
6867 Prefix =>
6868 Unchecked_Convert_To (RTE (RE_Tag_Ptr),
6869 Make_Function_Call (Loc,
6870 Name =>
6871 New_Occurrence_Of (RTE (RE_Base_Address), Loc),
6872 Parameter_Associations => New_List (
6873 Unchecked_Convert_To (RTE (RE_Address),
6874 Duplicate_Subexpr (Prefix (Exp)))))));
6875
6876 -- Similar case to the previous one but the expression is a
6877 -- renaming of an explicit dereference.
6878
6879 elsif Nkind (Exp) = N_Identifier
6880 and then Present (Renamed_Object (Entity (Exp)))
6881 and then Nkind (Renamed_Object (Entity (Exp)))
6882 = N_Explicit_Dereference
6883 then
6884 Tag_Node :=
6885 Make_Explicit_Dereference (Loc,
6886 Prefix =>
6887 Unchecked_Convert_To (RTE (RE_Tag_Ptr),
6888 Make_Function_Call (Loc,
6889 Name =>
6890 New_Occurrence_Of (RTE (RE_Base_Address), Loc),
6891 Parameter_Associations => New_List (
6892 Unchecked_Convert_To (RTE (RE_Address),
6893 Duplicate_Subexpr
6894 (Prefix
6895 (Renamed_Object (Entity (Exp)))))))));
6896
6897 -- Common case: obtain the address of the actual object and
6898 -- displace the pointer to reference the base of the object.
6899
6900 else
6901 Tag_Node :=
6902 Make_Explicit_Dereference (Loc,
6903 Prefix =>
6904 Unchecked_Convert_To (RTE (RE_Tag_Ptr),
6905 Make_Function_Call (Loc,
6906 Name =>
6907 New_Occurrence_Of (RTE (RE_Base_Address), Loc),
6908 Parameter_Associations => New_List (
6909 Make_Attribute_Reference (Loc,
6910 Prefix => Duplicate_Subexpr (Exp),
6911 Attribute_Name => Name_Address)))));
6912 end if;
6913 else
6914 Tag_Node :=
6915 Make_Attribute_Reference (Loc,
6916 Prefix => Duplicate_Subexpr (Exp),
6917 Attribute_Name => Name_Tag);
6918 end if;
6919
6920 -- CodePeer does not do anything useful with
6921 -- Ada.Tags.Type_Specific_Data components.
6922
6923 if not CodePeer_Mode then
6924 Insert_Action (Exp,
6925 Make_Raise_Program_Error (Loc,
6926 Condition =>
6927 Make_Op_Gt (Loc,
6928 Left_Opnd => Build_Get_Access_Level (Loc, Tag_Node),
6929 Right_Opnd =>
6930 Make_Integer_Literal (Loc,
6931 Scope_Depth (Enclosing_Dynamic_Scope (Scope_Id)))),
6932 Reason => PE_Accessibility_Check_Failed));
6933 end if;
6934 end;
6935
6936 -- AI05-0073: If function has a controlling access result, check that
6937 -- the tag of the return value, if it is not null, matches designated
6938 -- type of return type.
6939
6940 -- The return expression is referenced twice in the code below, so it
6941 -- must be made free of side effects. Given that different compilers
6942 -- may evaluate these parameters in different order, both occurrences
6943 -- perform a copy.
6944
6945 elsif Ekind (R_Type) = E_Anonymous_Access_Type
6946 and then Has_Controlling_Result (Scope_Id)
6947 then
6948 Insert_Action (N,
6949 Make_Raise_Constraint_Error (Loc,
6950 Condition =>
6951 Make_And_Then (Loc,
6952 Left_Opnd =>
6953 Make_Op_Ne (Loc,
6954 Left_Opnd => Duplicate_Subexpr (Exp),
6955 Right_Opnd => Make_Null (Loc)),
6956
6957 Right_Opnd => Make_Op_Ne (Loc,
6958 Left_Opnd =>
6959 Make_Selected_Component (Loc,
6960 Prefix => Duplicate_Subexpr (Exp),
6961 Selector_Name => Make_Identifier (Loc, Name_uTag)),
6962
6963 Right_Opnd =>
6964 Make_Attribute_Reference (Loc,
6965 Prefix =>
6966 New_Occurrence_Of (Designated_Type (R_Type), Loc),
6967 Attribute_Name => Name_Tag))),
6968
6969 Reason => CE_Tag_Check_Failed),
6970 Suppress => All_Checks);
6971 end if;
6972
6973 -- AI05-0234: RM 6.5(21/3). Check access discriminants to
6974 -- ensure that the function result does not outlive an
6975 -- object designated by one of it discriminants.
6976
6977 if Present (Extra_Accessibility_Of_Result (Scope_Id))
6978 and then Has_Unconstrained_Access_Discriminants (R_Type)
6979 then
6980 declare
6981 Discrim_Source : Node_Id;
6982
6983 procedure Check_Against_Result_Level (Level : Node_Id);
6984 -- Check the given accessibility level against the level
6985 -- determined by the point of call. (AI05-0234).
6986
6987 --------------------------------
6988 -- Check_Against_Result_Level --
6989 --------------------------------
6990
6991 procedure Check_Against_Result_Level (Level : Node_Id) is
6992 begin
6993 Insert_Action (N,
6994 Make_Raise_Program_Error (Loc,
6995 Condition =>
6996 Make_Op_Gt (Loc,
6997 Left_Opnd => Level,
6998 Right_Opnd =>
6999 New_Occurrence_Of
7000 (Extra_Accessibility_Of_Result (Scope_Id), Loc)),
7001 Reason => PE_Accessibility_Check_Failed));
7002 end Check_Against_Result_Level;
7003
7004 begin
7005 Discrim_Source := Exp;
7006 while Nkind (Discrim_Source) = N_Qualified_Expression loop
7007 Discrim_Source := Expression (Discrim_Source);
7008 end loop;
7009
7010 if Nkind (Discrim_Source) = N_Identifier
7011 and then Is_Return_Object (Entity (Discrim_Source))
7012 then
7013 Discrim_Source := Entity (Discrim_Source);
7014
7015 if Is_Constrained (Etype (Discrim_Source)) then
7016 Discrim_Source := Etype (Discrim_Source);
7017 else
7018 Discrim_Source := Expression (Parent (Discrim_Source));
7019 end if;
7020
7021 elsif Nkind (Discrim_Source) = N_Identifier
7022 and then Nkind_In (Original_Node (Discrim_Source),
7023 N_Aggregate, N_Extension_Aggregate)
7024 then
7025 Discrim_Source := Original_Node (Discrim_Source);
7026
7027 elsif Nkind (Discrim_Source) = N_Explicit_Dereference and then
7028 Nkind (Original_Node (Discrim_Source)) = N_Function_Call
7029 then
7030 Discrim_Source := Original_Node (Discrim_Source);
7031 end if;
7032
7033 Discrim_Source := Unqual_Conv (Discrim_Source);
7034
7035 case Nkind (Discrim_Source) is
7036 when N_Defining_Identifier =>
7037 pragma Assert (Is_Composite_Type (Discrim_Source)
7038 and then Has_Discriminants (Discrim_Source)
7039 and then Is_Constrained (Discrim_Source));
7040
7041 declare
7042 Discrim : Entity_Id :=
7043 First_Discriminant (Base_Type (R_Type));
7044 Disc_Elmt : Elmt_Id :=
7045 First_Elmt (Discriminant_Constraint
7046 (Discrim_Source));
7047 begin
7048 loop
7049 if Ekind (Etype (Discrim)) =
7050 E_Anonymous_Access_Type
7051 then
7052 Check_Against_Result_Level
7053 (Dynamic_Accessibility_Level (Node (Disc_Elmt)));
7054 end if;
7055
7056 Next_Elmt (Disc_Elmt);
7057 Next_Discriminant (Discrim);
7058 exit when not Present (Discrim);
7059 end loop;
7060 end;
7061
7062 when N_Aggregate
7063 | N_Extension_Aggregate
7064 =>
7065 -- Unimplemented: extension aggregate case where discrims
7066 -- come from ancestor part, not extension part.
7067
7068 declare
7069 Discrim : Entity_Id :=
7070 First_Discriminant (Base_Type (R_Type));
7071
7072 Disc_Exp : Node_Id := Empty;
7073
7074 Positionals_Exhausted
7075 : Boolean := not Present (Expressions
7076 (Discrim_Source));
7077
7078 function Associated_Expr
7079 (Comp_Id : Entity_Id;
7080 Associations : List_Id) return Node_Id;
7081
7082 -- Given a component and a component associations list,
7083 -- locate the expression for that component; returns
7084 -- Empty if no such expression is found.
7085
7086 ---------------------
7087 -- Associated_Expr --
7088 ---------------------
7089
7090 function Associated_Expr
7091 (Comp_Id : Entity_Id;
7092 Associations : List_Id) return Node_Id
7093 is
7094 Assoc : Node_Id;
7095 Choice : Node_Id;
7096
7097 begin
7098 -- Simple linear search seems ok here
7099
7100 Assoc := First (Associations);
7101 while Present (Assoc) loop
7102 Choice := First (Choices (Assoc));
7103 while Present (Choice) loop
7104 if (Nkind (Choice) = N_Identifier
7105 and then Chars (Choice) = Chars (Comp_Id))
7106 or else (Nkind (Choice) = N_Others_Choice)
7107 then
7108 return Expression (Assoc);
7109 end if;
7110
7111 Next (Choice);
7112 end loop;
7113
7114 Next (Assoc);
7115 end loop;
7116
7117 return Empty;
7118 end Associated_Expr;
7119
7120 begin
7121 if not Positionals_Exhausted then
7122 Disc_Exp := First (Expressions (Discrim_Source));
7123 end if;
7124
7125 loop
7126 if Positionals_Exhausted then
7127 Disc_Exp :=
7128 Associated_Expr
7129 (Discrim,
7130 Component_Associations (Discrim_Source));
7131 end if;
7132
7133 if Ekind (Etype (Discrim)) =
7134 E_Anonymous_Access_Type
7135 then
7136 Check_Against_Result_Level
7137 (Dynamic_Accessibility_Level (Disc_Exp));
7138 end if;
7139
7140 Next_Discriminant (Discrim);
7141 exit when not Present (Discrim);
7142
7143 if not Positionals_Exhausted then
7144 Next (Disc_Exp);
7145 Positionals_Exhausted := not Present (Disc_Exp);
7146 end if;
7147 end loop;
7148 end;
7149
7150 when N_Function_Call =>
7151
7152 -- No check needed (check performed by callee)
7153
7154 null;
7155
7156 when others =>
7157 declare
7158 Level : constant Node_Id :=
7159 Make_Integer_Literal (Loc,
7160 Object_Access_Level (Discrim_Source));
7161
7162 begin
7163 -- Unimplemented: check for name prefix that includes
7164 -- a dereference of an access value with a dynamic
7165 -- accessibility level (e.g., an access param or a
7166 -- saooaaat) and use dynamic level in that case. For
7167 -- example:
7168 -- return Access_Param.all(Some_Index).Some_Component;
7169 -- ???
7170
7171 Set_Etype (Level, Standard_Natural);
7172 Check_Against_Result_Level (Level);
7173 end;
7174 end case;
7175 end;
7176 end if;
7177
7178 -- If we are returning an object that may not be bit-aligned, then copy
7179 -- the value into a temporary first. This copy may need to expand to a
7180 -- loop of component operations.
7181
7182 if Is_Possibly_Unaligned_Slice (Exp)
7183 or else Is_Possibly_Unaligned_Object (Exp)
7184 then
7185 declare
7186 ExpR : constant Node_Id := Relocate_Node (Exp);
7187 Tnn : constant Entity_Id := Make_Temporary (Loc, 'T', ExpR);
7188 begin
7189 Insert_Action (Exp,
7190 Make_Object_Declaration (Loc,
7191 Defining_Identifier => Tnn,
7192 Constant_Present => True,
7193 Object_Definition => New_Occurrence_Of (R_Type, Loc),
7194 Expression => ExpR),
7195 Suppress => All_Checks);
7196 Rewrite (Exp, New_Occurrence_Of (Tnn, Loc));
7197 end;
7198 end if;
7199
7200 -- Call the _Postconditions procedure if the related function has
7201 -- contract assertions that need to be verified on exit.
7202
7203 if Ekind (Scope_Id) = E_Function
7204 and then Present (Postconditions_Proc (Scope_Id))
7205 then
7206 -- In the case of discriminated objects, we have created a
7207 -- constrained subtype above, and used the underlying type. This
7208 -- transformation is post-analysis and harmless, except that now the
7209 -- call to the post-condition will be analyzed and the type kinds
7210 -- have to match.
7211
7212 if Nkind (Exp) = N_Unchecked_Type_Conversion
7213 and then Is_Private_Type (R_Type) /= Is_Private_Type (Etype (Exp))
7214 then
7215 Rewrite (Exp, Expression (Relocate_Node (Exp)));
7216 end if;
7217
7218 -- We are going to reference the returned value twice in this case,
7219 -- once in the call to _Postconditions, and once in the actual return
7220 -- statement, but we can't have side effects happening twice.
7221
7222 Force_Evaluation (Exp, Mode => Strict);
7223
7224 -- Generate call to _Postconditions
7225
7226 Insert_Action (Exp,
7227 Make_Procedure_Call_Statement (Loc,
7228 Name =>
7229 New_Occurrence_Of (Postconditions_Proc (Scope_Id), Loc),
7230 Parameter_Associations => New_List (New_Copy_Tree (Exp))));
7231 end if;
7232
7233 -- Ada 2005 (AI-251): If this return statement corresponds with an
7234 -- simple return statement associated with an extended return statement
7235 -- and the type of the returned object is an interface then generate an
7236 -- implicit conversion to force displacement of the "this" pointer.
7237
7238 if Ada_Version >= Ada_2005
7239 and then Comes_From_Extended_Return_Statement (N)
7240 and then Nkind (Expression (N)) = N_Identifier
7241 and then Is_Interface (Utyp)
7242 and then Utyp /= Underlying_Type (Exptyp)
7243 then
7244 Rewrite (Exp, Convert_To (Utyp, Relocate_Node (Exp)));
7245 Analyze_And_Resolve (Exp);
7246 end if;
7247 end Expand_Simple_Function_Return;
7248
7249 --------------------------------------------
7250 -- Has_Unconstrained_Access_Discriminants --
7251 --------------------------------------------
7252
7253 function Has_Unconstrained_Access_Discriminants
7254 (Subtyp : Entity_Id) return Boolean
7255 is
7256 Discr : Entity_Id;
7257
7258 begin
7259 if Has_Discriminants (Subtyp)
7260 and then not Is_Constrained (Subtyp)
7261 then
7262 Discr := First_Discriminant (Subtyp);
7263 while Present (Discr) loop
7264 if Ekind (Etype (Discr)) = E_Anonymous_Access_Type then
7265 return True;
7266 end if;
7267
7268 Next_Discriminant (Discr);
7269 end loop;
7270 end if;
7271
7272 return False;
7273 end Has_Unconstrained_Access_Discriminants;
7274
7275 -----------------------------------
7276 -- Is_Build_In_Place_Result_Type --
7277 -----------------------------------
7278
7279 function Is_Build_In_Place_Result_Type (Typ : Entity_Id) return Boolean is
7280 begin
7281 if not Expander_Active then
7282 return False;
7283 end if;
7284
7285 -- In Ada 2005 all functions with an inherently limited return type
7286 -- must be handled using a build-in-place profile, including the case
7287 -- of a function with a limited interface result, where the function
7288 -- may return objects of nonlimited descendants.
7289
7290 if Is_Limited_View (Typ) then
7291 return Ada_Version >= Ada_2005 and then not Debug_Flag_Dot_L;
7292
7293 else
7294 if Debug_Flag_Dot_9 then
7295 return False;
7296 end if;
7297
7298 if Has_Interfaces (Typ) then
7299 return False;
7300 end if;
7301
7302 declare
7303 T : Entity_Id := Typ;
7304 begin
7305 -- For T'Class, return True if it's True for T. This is necessary
7306 -- because a class-wide function might say "return F (...)", where
7307 -- F returns the corresponding specific type. We need a loop in
7308 -- case T is a subtype of a class-wide type.
7309
7310 while Is_Class_Wide_Type (T) loop
7311 T := Etype (T);
7312 end loop;
7313
7314 -- If this is a generic formal type in an instance, return True if
7315 -- it's True for the generic actual type.
7316
7317 if Nkind (Parent (T)) = N_Subtype_Declaration
7318 and then Present (Generic_Parent_Type (Parent (T)))
7319 then
7320 T := Entity (Subtype_Indication (Parent (T)));
7321
7322 if Present (Full_View (T)) then
7323 T := Full_View (T);
7324 end if;
7325 end if;
7326
7327 if Present (Underlying_Type (T)) then
7328 T := Underlying_Type (T);
7329 end if;
7330
7331 declare
7332 Result : Boolean;
7333 -- So we can stop here in the debugger
7334 begin
7335 -- ???For now, enable build-in-place for a very narrow set of
7336 -- controlled types. Change "if True" to "if False" to
7337 -- experiment with more controlled types. Eventually, we might
7338 -- like to enable build-in-place for all tagged types, all
7339 -- types that need finalization, and all caller-unknown-size
7340 -- types.
7341
7342 if True then
7343 Result := Is_Controlled (T)
7344 and then Present (Enclosing_Subprogram (T))
7345 and then not Is_Compilation_Unit (Enclosing_Subprogram (T))
7346 and then Ekind (Enclosing_Subprogram (T)) = E_Procedure;
7347 else
7348 Result := Is_Controlled (T);
7349 end if;
7350
7351 return Result;
7352 end;
7353 end;
7354 end if;
7355 end Is_Build_In_Place_Result_Type;
7356
7357 --------------------------------
7358 -- Is_Build_In_Place_Function --
7359 --------------------------------
7360
7361 function Is_Build_In_Place_Function (E : Entity_Id) return Boolean is
7362 begin
7363 -- This function is called from Expand_Subtype_From_Expr during
7364 -- semantic analysis, even when expansion is off. In those cases
7365 -- the build_in_place expansion will not take place.
7366
7367 if not Expander_Active then
7368 return False;
7369 end if;
7370
7371 -- For now we test whether E denotes a function or access-to-function
7372 -- type whose result subtype is inherently limited. Later this test
7373 -- may be revised to allow composite nonlimited types. Functions with
7374 -- a foreign convention or whose result type has a foreign convention
7375 -- never qualify.
7376
7377 if Ekind_In (E, E_Function, E_Generic_Function)
7378 or else (Ekind (E) = E_Subprogram_Type
7379 and then Etype (E) /= Standard_Void_Type)
7380 then
7381 -- Note: If the function has a foreign convention, it cannot build
7382 -- its result in place, so you're on your own. On the other hand,
7383 -- if only the return type has a foreign convention, its layout is
7384 -- intended to be compatible with the other language, but the build-
7385 -- in place machinery can ensure that the object is not copied.
7386
7387 return Is_Build_In_Place_Result_Type (Etype (E))
7388 and then not Has_Foreign_Convention (E)
7389 and then not Debug_Flag_Dot_L;
7390
7391 else
7392 return False;
7393 end if;
7394 end Is_Build_In_Place_Function;
7395
7396 -------------------------------------
7397 -- Is_Build_In_Place_Function_Call --
7398 -------------------------------------
7399
7400 function Is_Build_In_Place_Function_Call (N : Node_Id) return Boolean is
7401 Exp_Node : constant Node_Id := Unqual_Conv (N);
7402 Function_Id : Entity_Id;
7403
7404 begin
7405 -- Return False if the expander is currently inactive, since awareness
7406 -- of build-in-place treatment is only relevant during expansion. Note
7407 -- that Is_Build_In_Place_Function, which is called as part of this
7408 -- function, is also conditioned this way, but we need to check here as
7409 -- well to avoid blowing up on processing protected calls when expansion
7410 -- is disabled (such as with -gnatc) since those would trip over the
7411 -- raise of Program_Error below.
7412
7413 -- In SPARK mode, build-in-place calls are not expanded, so that we
7414 -- may end up with a call that is neither resolved to an entity, nor
7415 -- an indirect call.
7416
7417 if not Expander_Active or else Nkind (Exp_Node) /= N_Function_Call then
7418 return False;
7419 end if;
7420
7421 if Is_Entity_Name (Name (Exp_Node)) then
7422 Function_Id := Entity (Name (Exp_Node));
7423
7424 -- In the case of an explicitly dereferenced call, use the subprogram
7425 -- type generated for the dereference.
7426
7427 elsif Nkind (Name (Exp_Node)) = N_Explicit_Dereference then
7428 Function_Id := Etype (Name (Exp_Node));
7429
7430 -- This may be a call to a protected function.
7431
7432 elsif Nkind (Name (Exp_Node)) = N_Selected_Component then
7433 Function_Id := Etype (Entity (Selector_Name (Name (Exp_Node))));
7434
7435 else
7436 raise Program_Error;
7437 end if;
7438
7439 declare
7440 Result : constant Boolean := Is_Build_In_Place_Function (Function_Id);
7441 -- So we can stop here in the debugger
7442 begin
7443 return Result;
7444 end;
7445 end Is_Build_In_Place_Function_Call;
7446
7447 -----------------------
7448 -- Freeze_Subprogram --
7449 -----------------------
7450
7451 procedure Freeze_Subprogram (N : Node_Id) is
7452 Loc : constant Source_Ptr := Sloc (N);
7453
7454 procedure Register_Predefined_DT_Entry (Prim : Entity_Id);
7455 -- (Ada 2005): Register a predefined primitive in all the secondary
7456 -- dispatch tables of its primitive type.
7457
7458 ----------------------------------
7459 -- Register_Predefined_DT_Entry --
7460 ----------------------------------
7461
7462 procedure Register_Predefined_DT_Entry (Prim : Entity_Id) is
7463 Iface_DT_Ptr : Elmt_Id;
7464 Tagged_Typ : Entity_Id;
7465 Thunk_Id : Entity_Id;
7466 Thunk_Code : Node_Id;
7467
7468 begin
7469 Tagged_Typ := Find_Dispatching_Type (Prim);
7470
7471 if No (Access_Disp_Table (Tagged_Typ))
7472 or else not Has_Interfaces (Tagged_Typ)
7473 or else not RTE_Available (RE_Interface_Tag)
7474 or else Restriction_Active (No_Dispatching_Calls)
7475 then
7476 return;
7477 end if;
7478
7479 -- Skip the first two access-to-dispatch-table pointers since they
7480 -- leads to the primary dispatch table (predefined DT and user
7481 -- defined DT). We are only concerned with the secondary dispatch
7482 -- table pointers. Note that the access-to- dispatch-table pointer
7483 -- corresponds to the first implemented interface retrieved below.
7484
7485 Iface_DT_Ptr :=
7486 Next_Elmt (Next_Elmt (First_Elmt (Access_Disp_Table (Tagged_Typ))));
7487
7488 while Present (Iface_DT_Ptr)
7489 and then Ekind (Node (Iface_DT_Ptr)) = E_Constant
7490 loop
7491 pragma Assert (Has_Thunks (Node (Iface_DT_Ptr)));
7492 Expand_Interface_Thunk (Prim, Thunk_Id, Thunk_Code);
7493
7494 if Present (Thunk_Code) then
7495 Insert_Actions_After (N, New_List (
7496 Thunk_Code,
7497
7498 Build_Set_Predefined_Prim_Op_Address (Loc,
7499 Tag_Node =>
7500 New_Occurrence_Of (Node (Next_Elmt (Iface_DT_Ptr)), Loc),
7501 Position => DT_Position (Prim),
7502 Address_Node =>
7503 Unchecked_Convert_To (RTE (RE_Prim_Ptr),
7504 Make_Attribute_Reference (Loc,
7505 Prefix => New_Occurrence_Of (Thunk_Id, Loc),
7506 Attribute_Name => Name_Unrestricted_Access))),
7507
7508 Build_Set_Predefined_Prim_Op_Address (Loc,
7509 Tag_Node =>
7510 New_Occurrence_Of
7511 (Node (Next_Elmt (Next_Elmt (Next_Elmt (Iface_DT_Ptr)))),
7512 Loc),
7513 Position => DT_Position (Prim),
7514 Address_Node =>
7515 Unchecked_Convert_To (RTE (RE_Prim_Ptr),
7516 Make_Attribute_Reference (Loc,
7517 Prefix => New_Occurrence_Of (Prim, Loc),
7518 Attribute_Name => Name_Unrestricted_Access)))));
7519 end if;
7520
7521 -- Skip the tag of the predefined primitives dispatch table
7522
7523 Next_Elmt (Iface_DT_Ptr);
7524 pragma Assert (Has_Thunks (Node (Iface_DT_Ptr)));
7525
7526 -- Skip tag of the no-thunks dispatch table
7527
7528 Next_Elmt (Iface_DT_Ptr);
7529 pragma Assert (not Has_Thunks (Node (Iface_DT_Ptr)));
7530
7531 -- Skip tag of predefined primitives no-thunks dispatch table
7532
7533 Next_Elmt (Iface_DT_Ptr);
7534 pragma Assert (not Has_Thunks (Node (Iface_DT_Ptr)));
7535
7536 Next_Elmt (Iface_DT_Ptr);
7537 end loop;
7538 end Register_Predefined_DT_Entry;
7539
7540 -- Local variables
7541
7542 Subp : constant Entity_Id := Entity (N);
7543
7544 -- Start of processing for Freeze_Subprogram
7545
7546 begin
7547 -- We suppress the initialization of the dispatch table entry when
7548 -- not Tagged_Type_Expansion because the dispatching mechanism is
7549 -- handled internally by the target.
7550
7551 if Is_Dispatching_Operation (Subp)
7552 and then not Is_Abstract_Subprogram (Subp)
7553 and then Present (DTC_Entity (Subp))
7554 and then Present (Scope (DTC_Entity (Subp)))
7555 and then Tagged_Type_Expansion
7556 and then not Restriction_Active (No_Dispatching_Calls)
7557 and then RTE_Available (RE_Tag)
7558 then
7559 declare
7560 Typ : constant Entity_Id := Scope (DTC_Entity (Subp));
7561
7562 begin
7563 -- Handle private overridden primitives
7564
7565 if not Is_CPP_Class (Typ) then
7566 Check_Overriding_Operation (Subp);
7567 end if;
7568
7569 -- We assume that imported CPP primitives correspond with objects
7570 -- whose constructor is in the CPP side; therefore we don't need
7571 -- to generate code to register them in the dispatch table.
7572
7573 if Is_CPP_Class (Typ) then
7574 null;
7575
7576 -- Handle CPP primitives found in derivations of CPP_Class types.
7577 -- These primitives must have been inherited from some parent, and
7578 -- there is no need to register them in the dispatch table because
7579 -- Build_Inherit_Prims takes care of initializing these slots.
7580
7581 elsif Is_Imported (Subp)
7582 and then (Convention (Subp) = Convention_CPP
7583 or else Convention (Subp) = Convention_C)
7584 then
7585 null;
7586
7587 -- Generate code to register the primitive in non statically
7588 -- allocated dispatch tables
7589
7590 elsif not Building_Static_DT (Scope (DTC_Entity (Subp))) then
7591
7592 -- When a primitive is frozen, enter its name in its dispatch
7593 -- table slot.
7594
7595 if not Is_Interface (Typ)
7596 or else Present (Interface_Alias (Subp))
7597 then
7598 if Is_Predefined_Dispatching_Operation (Subp) then
7599 Register_Predefined_DT_Entry (Subp);
7600 end if;
7601
7602 Insert_Actions_After (N,
7603 Register_Primitive (Loc, Prim => Subp));
7604 end if;
7605 end if;
7606 end;
7607 end if;
7608
7609 -- Mark functions that return by reference. Note that it cannot be part
7610 -- of the normal semantic analysis of the spec since the underlying
7611 -- returned type may not be known yet (for private types).
7612
7613 declare
7614 Typ : constant Entity_Id := Etype (Subp);
7615 Utyp : constant Entity_Id := Underlying_Type (Typ);
7616
7617 begin
7618 if Is_Limited_View (Typ) then
7619 Set_Returns_By_Ref (Subp);
7620
7621 elsif Present (Utyp) and then CW_Or_Has_Controlled_Part (Utyp) then
7622 Set_Returns_By_Ref (Subp);
7623 end if;
7624 end;
7625
7626 -- Wnen freezing a null procedure, analyze its delayed aspects now
7627 -- because we may not have reached the end of the declarative list when
7628 -- delayed aspects are normally analyzed. This ensures that dispatching
7629 -- calls are properly rewritten when the generated _Postcondition
7630 -- procedure is analyzed in the null procedure body.
7631
7632 if Nkind (Parent (Subp)) = N_Procedure_Specification
7633 and then Null_Present (Parent (Subp))
7634 then
7635 Analyze_Entry_Or_Subprogram_Contract (Subp);
7636 end if;
7637 end Freeze_Subprogram;
7638
7639 ------------------------------
7640 -- Insert_Post_Call_Actions --
7641 ------------------------------
7642
7643 procedure Insert_Post_Call_Actions (N : Node_Id; Post_Call : List_Id) is
7644 Context : constant Node_Id := Parent (N);
7645
7646 begin
7647 if Is_Empty_List (Post_Call) then
7648 return;
7649 end if;
7650
7651 -- Cases where the call is not a member of a statement list. This
7652 -- includes the case where the call is an actual in another function
7653 -- call or indexing, i.e. an expression context as well.
7654
7655 if not Is_List_Member (N)
7656 or else Nkind_In (Context, N_Function_Call, N_Indexed_Component)
7657 then
7658 -- In Ada 2012 the call may be a function call in an expression
7659 -- (since OUT and IN OUT parameters are now allowed for such calls).
7660 -- The write-back of (in)-out parameters is handled by the back-end,
7661 -- but the constraint checks generated when subtypes of formal and
7662 -- actual don't match must be inserted in the form of assignments.
7663
7664 if Nkind (Original_Node (N)) = N_Function_Call then
7665 pragma Assert (Ada_Version >= Ada_2012);
7666 -- Functions with '[in] out' parameters are only allowed in Ada
7667 -- 2012.
7668
7669 -- We used to handle this by climbing up parents to a
7670 -- non-statement/declaration and then simply making a call to
7671 -- Insert_Actions_After (P, Post_Call), but that doesn't work
7672 -- for Ada 2012. If we are in the middle of an expression, e.g.
7673 -- the condition of an IF, this call would insert after the IF
7674 -- statement, which is much too late to be doing the write back.
7675 -- For example:
7676
7677 -- if Clobber (X) then
7678 -- Put_Line (X'Img);
7679 -- else
7680 -- goto Junk
7681 -- end if;
7682
7683 -- Now assume Clobber changes X, if we put the write back after
7684 -- the IF, the Put_Line gets the wrong value and the goto causes
7685 -- the write back to be skipped completely.
7686
7687 -- To deal with this, we replace the call by
7688
7689 -- do
7690 -- Tnnn : constant function-result-type := function-call;
7691 -- Post_Call actions
7692 -- in
7693 -- Tnnn;
7694 -- end;
7695
7696 declare
7697 Loc : constant Source_Ptr := Sloc (N);
7698 Tnnn : constant Entity_Id := Make_Temporary (Loc, 'T');
7699 FRTyp : constant Entity_Id := Etype (N);
7700 Name : constant Node_Id := Relocate_Node (N);
7701
7702 begin
7703 Prepend_To (Post_Call,
7704 Make_Object_Declaration (Loc,
7705 Defining_Identifier => Tnnn,
7706 Object_Definition => New_Occurrence_Of (FRTyp, Loc),
7707 Constant_Present => True,
7708 Expression => Name));
7709
7710 Rewrite (N,
7711 Make_Expression_With_Actions (Loc,
7712 Actions => Post_Call,
7713 Expression => New_Occurrence_Of (Tnnn, Loc)));
7714
7715 -- We don't want to just blindly call Analyze_And_Resolve
7716 -- because that would cause unwanted recursion on the call.
7717 -- So for a moment set the call as analyzed to prevent that
7718 -- recursion, and get the rest analyzed properly, then reset
7719 -- the analyzed flag, so our caller can continue.
7720
7721 Set_Analyzed (Name, True);
7722 Analyze_And_Resolve (N, FRTyp);
7723 Set_Analyzed (Name, False);
7724 end;
7725
7726 -- If not the special Ada 2012 case of a function call, then we must
7727 -- have the triggering statement of a triggering alternative or an
7728 -- entry call alternative, and we can add the post call stuff to the
7729 -- corresponding statement list.
7730
7731 else
7732 pragma Assert (Nkind_In (Context, N_Entry_Call_Alternative,
7733 N_Triggering_Alternative));
7734
7735 if Is_Non_Empty_List (Statements (Context)) then
7736 Insert_List_Before_And_Analyze
7737 (First (Statements (Context)), Post_Call);
7738 else
7739 Set_Statements (Context, Post_Call);
7740 end if;
7741 end if;
7742
7743 -- A procedure call is always part of a declarative or statement list,
7744 -- however a function call may appear nested within a construct. Most
7745 -- cases of function call nesting are handled in the special case above.
7746 -- The only exception is when the function call acts as an actual in a
7747 -- procedure call. In this case the function call is in a list, but the
7748 -- post-call actions must be inserted after the procedure call.
7749
7750 elsif Nkind (Context) = N_Procedure_Call_Statement then
7751 Insert_Actions_After (Context, Post_Call);
7752
7753 -- Otherwise, normal case where N is in a statement sequence, just put
7754 -- the post-call stuff after the call statement.
7755
7756 else
7757 Insert_Actions_After (N, Post_Call);
7758 end if;
7759 end Insert_Post_Call_Actions;
7760
7761 -----------------------
7762 -- Is_Null_Procedure --
7763 -----------------------
7764
7765 function Is_Null_Procedure (Subp : Entity_Id) return Boolean is
7766 Decl : constant Node_Id := Unit_Declaration_Node (Subp);
7767
7768 begin
7769 if Ekind (Subp) /= E_Procedure then
7770 return False;
7771
7772 -- Check if this is a declared null procedure
7773
7774 elsif Nkind (Decl) = N_Subprogram_Declaration then
7775 if not Null_Present (Specification (Decl)) then
7776 return False;
7777
7778 elsif No (Body_To_Inline (Decl)) then
7779 return False;
7780
7781 -- Check if the body contains only a null statement, followed by
7782 -- the return statement added during expansion.
7783
7784 else
7785 declare
7786 Orig_Bod : constant Node_Id := Body_To_Inline (Decl);
7787
7788 Stat : Node_Id;
7789 Stat2 : Node_Id;
7790
7791 begin
7792 if Nkind (Orig_Bod) /= N_Subprogram_Body then
7793 return False;
7794 else
7795 -- We must skip SCIL nodes because they are currently
7796 -- implemented as special N_Null_Statement nodes.
7797
7798 Stat :=
7799 First_Non_SCIL_Node
7800 (Statements (Handled_Statement_Sequence (Orig_Bod)));
7801 Stat2 := Next_Non_SCIL_Node (Stat);
7802
7803 return
7804 Is_Empty_List (Declarations (Orig_Bod))
7805 and then Nkind (Stat) = N_Null_Statement
7806 and then
7807 (No (Stat2)
7808 or else
7809 (Nkind (Stat2) = N_Simple_Return_Statement
7810 and then No (Next (Stat2))));
7811 end if;
7812 end;
7813 end if;
7814
7815 else
7816 return False;
7817 end if;
7818 end Is_Null_Procedure;
7819
7820 -------------------------------------------
7821 -- Make_Build_In_Place_Call_In_Allocator --
7822 -------------------------------------------
7823
7824 procedure Make_Build_In_Place_Call_In_Allocator
7825 (Allocator : Node_Id;
7826 Function_Call : Node_Id)
7827 is
7828 Acc_Type : constant Entity_Id := Etype (Allocator);
7829 Loc : constant Source_Ptr := Sloc (Function_Call);
7830 Func_Call : Node_Id := Function_Call;
7831 Ref_Func_Call : Node_Id;
7832 Function_Id : Entity_Id;
7833 Result_Subt : Entity_Id;
7834 New_Allocator : Node_Id;
7835 Return_Obj_Access : Entity_Id; -- temp for function result
7836 Temp_Init : Node_Id; -- initial value of Return_Obj_Access
7837 Alloc_Form : BIP_Allocation_Form;
7838 Pool : Node_Id; -- nonnull if Alloc_Form = User_Storage_Pool
7839 Return_Obj_Actual : Node_Id; -- the temp.all, in caller-allocates case
7840 Chain : Entity_Id; -- activation chain, in case of tasks
7841
7842 begin
7843 -- Step past qualification or unchecked conversion (the latter can occur
7844 -- in cases of calls to 'Input).
7845
7846 if Nkind_In (Func_Call,
7847 N_Qualified_Expression,
7848 N_Type_Conversion,
7849 N_Unchecked_Type_Conversion)
7850 then
7851 Func_Call := Expression (Func_Call);
7852 end if;
7853
7854 -- Mark the call as processed as a build-in-place call
7855
7856 pragma Assert (not Is_Expanded_Build_In_Place_Call (Func_Call));
7857 Set_Is_Expanded_Build_In_Place_Call (Func_Call);
7858
7859 if Is_Entity_Name (Name (Func_Call)) then
7860 Function_Id := Entity (Name (Func_Call));
7861
7862 elsif Nkind (Name (Func_Call)) = N_Explicit_Dereference then
7863 Function_Id := Etype (Name (Func_Call));
7864
7865 else
7866 raise Program_Error;
7867 end if;
7868
7869 Result_Subt := Available_View (Etype (Function_Id));
7870
7871 -- Create a temp for the function result. In the caller-allocates case,
7872 -- this will be initialized to the result of a new uninitialized
7873 -- allocator. Note: we do not use Allocator as the Related_Node of
7874 -- Return_Obj_Access in call to Make_Temporary below as this would
7875 -- create a sort of infinite "recursion".
7876
7877 Return_Obj_Access := Make_Temporary (Loc, 'R');
7878 Set_Etype (Return_Obj_Access, Acc_Type);
7879 Set_Can_Never_Be_Null (Acc_Type, False);
7880 -- It gets initialized to null, so we can't have that
7881
7882 -- When the result subtype is constrained, the return object is
7883 -- allocated on the caller side, and access to it is passed to the
7884 -- function.
7885
7886 -- Here and in related routines, we must examine the full view of the
7887 -- type, because the view at the point of call may differ from that
7888 -- that in the function body, and the expansion mechanism depends on
7889 -- the characteristics of the full view.
7890
7891 if Is_Constrained (Underlying_Type (Result_Subt)) then
7892 -- Replace the initialized allocator of form "new T'(Func (...))"
7893 -- with an uninitialized allocator of form "new T", where T is the
7894 -- result subtype of the called function. The call to the function
7895 -- is handled separately further below.
7896
7897 New_Allocator :=
7898 Make_Allocator (Loc,
7899 Expression => New_Occurrence_Of (Result_Subt, Loc));
7900 Set_No_Initialization (New_Allocator);
7901
7902 -- Copy attributes to new allocator. Note that the new allocator
7903 -- logically comes from source if the original one did, so copy the
7904 -- relevant flag. This ensures proper treatment of the restriction
7905 -- No_Implicit_Heap_Allocations in this case.
7906
7907 Set_Storage_Pool (New_Allocator, Storage_Pool (Allocator));
7908 Set_Procedure_To_Call (New_Allocator, Procedure_To_Call (Allocator));
7909 Set_Comes_From_Source (New_Allocator, Comes_From_Source (Allocator));
7910
7911 Rewrite (Allocator, New_Allocator);
7912
7913 -- Initial value of the temp is the result of the uninitialized
7914 -- allocator. Unchecked_Convert is needed for T'Input where T is
7915 -- derived from a controlled type.
7916
7917 Temp_Init := Relocate_Node (Allocator);
7918
7919 if Nkind_In
7920 (Function_Call, N_Type_Conversion, N_Unchecked_Type_Conversion)
7921 then
7922 Temp_Init := Unchecked_Convert_To (Acc_Type, Temp_Init);
7923 end if;
7924
7925 -- Indicate that caller allocates, and pass in the return object
7926
7927 Alloc_Form := Caller_Allocation;
7928 Pool := Make_Null (No_Location);
7929 Return_Obj_Actual :=
7930 Make_Unchecked_Type_Conversion (Loc,
7931 Subtype_Mark => New_Occurrence_Of (Result_Subt, Loc),
7932 Expression =>
7933 Make_Explicit_Dereference (Loc,
7934 Prefix => New_Occurrence_Of (Return_Obj_Access, Loc)));
7935
7936 -- When the result subtype is unconstrained, the function itself must
7937 -- perform the allocation of the return object, so we pass parameters
7938 -- indicating that.
7939
7940 else
7941 Temp_Init := Empty;
7942
7943 -- Case of a user-defined storage pool. Pass an allocation parameter
7944 -- indicating that the function should allocate its result in the
7945 -- pool, and pass the pool. Use 'Unrestricted_Access because the
7946 -- pool may not be aliased.
7947
7948 if Present (Associated_Storage_Pool (Acc_Type)) then
7949 Alloc_Form := User_Storage_Pool;
7950 Pool :=
7951 Make_Attribute_Reference (Loc,
7952 Prefix =>
7953 New_Occurrence_Of
7954 (Associated_Storage_Pool (Acc_Type), Loc),
7955 Attribute_Name => Name_Unrestricted_Access);
7956
7957 -- No user-defined pool; pass an allocation parameter indicating that
7958 -- the function should allocate its result on the heap.
7959
7960 else
7961 Alloc_Form := Global_Heap;
7962 Pool := Make_Null (No_Location);
7963 end if;
7964
7965 -- The caller does not provide the return object in this case, so we
7966 -- have to pass null for the object access actual.
7967
7968 Return_Obj_Actual := Empty;
7969 end if;
7970
7971 -- Declare the temp object
7972
7973 Insert_Action (Allocator,
7974 Make_Object_Declaration (Loc,
7975 Defining_Identifier => Return_Obj_Access,
7976 Object_Definition => New_Occurrence_Of (Acc_Type, Loc),
7977 Expression => Temp_Init));
7978
7979 Ref_Func_Call := Make_Reference (Loc, Func_Call);
7980
7981 -- Ada 2005 (AI-251): If the type of the allocator is an interface
7982 -- then generate an implicit conversion to force displacement of the
7983 -- "this" pointer.
7984
7985 if Is_Interface (Designated_Type (Acc_Type)) then
7986 Rewrite
7987 (Ref_Func_Call,
7988 OK_Convert_To (Acc_Type, Ref_Func_Call));
7989
7990 -- If the types are incompatible, we need an unchecked conversion. Note
7991 -- that the full types will be compatible, but the types not visibly
7992 -- compatible.
7993
7994 elsif Nkind_In
7995 (Function_Call, N_Type_Conversion, N_Unchecked_Type_Conversion)
7996 then
7997 Ref_Func_Call := Unchecked_Convert_To (Acc_Type, Ref_Func_Call);
7998 end if;
7999
8000 declare
8001 Assign : constant Node_Id :=
8002 Make_Assignment_Statement (Loc,
8003 Name => New_Occurrence_Of (Return_Obj_Access, Loc),
8004 Expression => Ref_Func_Call);
8005 -- Assign the result of the function call into the temp. In the
8006 -- caller-allocates case, this is overwriting the temp with its
8007 -- initial value, which has no effect. In the callee-allocates case,
8008 -- this is setting the temp to point to the object allocated by the
8009 -- callee. Unchecked_Convert is needed for T'Input where T is derived
8010 -- from a controlled type.
8011
8012 Actions : List_Id;
8013 -- Actions to be inserted. If there are no tasks, this is just the
8014 -- assignment statement. If the allocated object has tasks, we need
8015 -- to wrap the assignment in a block that activates them. The
8016 -- activation chain of that block must be passed to the function,
8017 -- rather than some outer chain.
8018 begin
8019 if Has_Task (Result_Subt) then
8020 Actions := New_List;
8021 Build_Task_Allocate_Block_With_Init_Stmts
8022 (Actions, Allocator, Init_Stmts => New_List (Assign));
8023 Chain := Activation_Chain_Entity (Last (Actions));
8024 else
8025 Actions := New_List (Assign);
8026 Chain := Empty;
8027 end if;
8028
8029 Insert_Actions (Allocator, Actions);
8030 end;
8031
8032 -- When the function has a controlling result, an allocation-form
8033 -- parameter must be passed indicating that the caller is allocating
8034 -- the result object. This is needed because such a function can be
8035 -- called as a dispatching operation and must be treated similarly
8036 -- to functions with unconstrained result subtypes.
8037
8038 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8039 (Func_Call, Function_Id, Alloc_Form, Pool_Actual => Pool);
8040
8041 Add_Finalization_Master_Actual_To_Build_In_Place_Call
8042 (Func_Call, Function_Id, Acc_Type);
8043
8044 Add_Task_Actuals_To_Build_In_Place_Call
8045 (Func_Call, Function_Id, Master_Actual => Master_Id (Acc_Type),
8046 Chain => Chain);
8047
8048 -- Add an implicit actual to the function call that provides access
8049 -- to the allocated object. An unchecked conversion to the (specific)
8050 -- result subtype of the function is inserted to handle cases where
8051 -- the access type of the allocator has a class-wide designated type.
8052
8053 Add_Access_Actual_To_Build_In_Place_Call
8054 (Func_Call, Function_Id, Return_Obj_Actual);
8055
8056 -- Finally, replace the allocator node with a reference to the temp
8057
8058 Rewrite (Allocator, New_Occurrence_Of (Return_Obj_Access, Loc));
8059
8060 Analyze_And_Resolve (Allocator, Acc_Type);
8061 end Make_Build_In_Place_Call_In_Allocator;
8062
8063 ---------------------------------------------------
8064 -- Make_Build_In_Place_Call_In_Anonymous_Context --
8065 ---------------------------------------------------
8066
8067 procedure Make_Build_In_Place_Call_In_Anonymous_Context
8068 (Function_Call : Node_Id)
8069 is
8070 Loc : constant Source_Ptr := Sloc (Function_Call);
8071 Func_Call : constant Node_Id := Unqual_Conv (Function_Call);
8072 Function_Id : Entity_Id;
8073 Result_Subt : Entity_Id;
8074 Return_Obj_Id : Entity_Id;
8075 Return_Obj_Decl : Entity_Id;
8076
8077 begin
8078 -- If the call has already been processed to add build-in-place actuals
8079 -- then return. One place this can occur is for calls to build-in-place
8080 -- functions that occur within a call to a protected operation, where
8081 -- due to rewriting and expansion of the protected call there can be
8082 -- more than one call to Expand_Actuals for the same set of actuals.
8083
8084 if Is_Expanded_Build_In_Place_Call (Func_Call) then
8085 return;
8086 end if;
8087
8088 -- Mark the call as processed as a build-in-place call
8089
8090 Set_Is_Expanded_Build_In_Place_Call (Func_Call);
8091
8092 if Is_Entity_Name (Name (Func_Call)) then
8093 Function_Id := Entity (Name (Func_Call));
8094
8095 elsif Nkind (Name (Func_Call)) = N_Explicit_Dereference then
8096 Function_Id := Etype (Name (Func_Call));
8097
8098 else
8099 raise Program_Error;
8100 end if;
8101
8102 Result_Subt := Etype (Function_Id);
8103
8104 -- If the build-in-place function returns a controlled object, then the
8105 -- object needs to be finalized immediately after the context. Since
8106 -- this case produces a transient scope, the servicing finalizer needs
8107 -- to name the returned object. Create a temporary which is initialized
8108 -- with the function call:
8109 --
8110 -- Temp_Id : Func_Type := BIP_Func_Call;
8111 --
8112 -- The initialization expression of the temporary will be rewritten by
8113 -- the expander using the appropriate mechanism in Make_Build_In_Place_
8114 -- Call_In_Object_Declaration.
8115
8116 if Needs_Finalization (Result_Subt) then
8117 declare
8118 Temp_Id : constant Entity_Id := Make_Temporary (Loc, 'R');
8119 Temp_Decl : Node_Id;
8120
8121 begin
8122 -- Reset the guard on the function call since the following does
8123 -- not perform actual call expansion.
8124
8125 Set_Is_Expanded_Build_In_Place_Call (Func_Call, False);
8126
8127 Temp_Decl :=
8128 Make_Object_Declaration (Loc,
8129 Defining_Identifier => Temp_Id,
8130 Object_Definition =>
8131 New_Occurrence_Of (Result_Subt, Loc),
8132 Expression =>
8133 New_Copy_Tree (Function_Call));
8134
8135 Insert_Action (Function_Call, Temp_Decl);
8136
8137 Rewrite (Function_Call, New_Occurrence_Of (Temp_Id, Loc));
8138 Analyze (Function_Call);
8139 end;
8140
8141 -- When the result subtype is definite, an object of the subtype is
8142 -- declared and an access value designating it is passed as an actual.
8143
8144 elsif Caller_Known_Size (Func_Call, Result_Subt) then
8145
8146 -- Create a temporary object to hold the function result
8147
8148 Return_Obj_Id := Make_Temporary (Loc, 'R');
8149 Set_Etype (Return_Obj_Id, Result_Subt);
8150
8151 Return_Obj_Decl :=
8152 Make_Object_Declaration (Loc,
8153 Defining_Identifier => Return_Obj_Id,
8154 Aliased_Present => True,
8155 Object_Definition => New_Occurrence_Of (Result_Subt, Loc));
8156
8157 Set_No_Initialization (Return_Obj_Decl);
8158
8159 Insert_Action (Func_Call, Return_Obj_Decl);
8160
8161 -- When the function has a controlling result, an allocation-form
8162 -- parameter must be passed indicating that the caller is allocating
8163 -- the result object. This is needed because such a function can be
8164 -- called as a dispatching operation and must be treated similarly
8165 -- to functions with unconstrained result subtypes.
8166
8167 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8168 (Func_Call, Function_Id, Alloc_Form => Caller_Allocation);
8169
8170 Add_Finalization_Master_Actual_To_Build_In_Place_Call
8171 (Func_Call, Function_Id);
8172
8173 Add_Task_Actuals_To_Build_In_Place_Call
8174 (Func_Call, Function_Id, Make_Identifier (Loc, Name_uMaster));
8175
8176 -- Add an implicit actual to the function call that provides access
8177 -- to the caller's return object.
8178
8179 Add_Access_Actual_To_Build_In_Place_Call
8180 (Func_Call, Function_Id, New_Occurrence_Of (Return_Obj_Id, Loc));
8181
8182 -- When the result subtype is unconstrained, the function must allocate
8183 -- the return object in the secondary stack, so appropriate implicit
8184 -- parameters are added to the call to indicate that. A transient
8185 -- scope is established to ensure eventual cleanup of the result.
8186
8187 else
8188 -- Pass an allocation parameter indicating that the function should
8189 -- allocate its result on the secondary stack.
8190
8191 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8192 (Func_Call, Function_Id, Alloc_Form => Secondary_Stack);
8193
8194 Add_Finalization_Master_Actual_To_Build_In_Place_Call
8195 (Func_Call, Function_Id);
8196
8197 Add_Task_Actuals_To_Build_In_Place_Call
8198 (Func_Call, Function_Id, Make_Identifier (Loc, Name_uMaster));
8199
8200 -- Pass a null value to the function since no return object is
8201 -- available on the caller side.
8202
8203 Add_Access_Actual_To_Build_In_Place_Call
8204 (Func_Call, Function_Id, Empty);
8205 end if;
8206 end Make_Build_In_Place_Call_In_Anonymous_Context;
8207
8208 --------------------------------------------
8209 -- Make_Build_In_Place_Call_In_Assignment --
8210 --------------------------------------------
8211
8212 procedure Make_Build_In_Place_Call_In_Assignment
8213 (Assign : Node_Id;
8214 Function_Call : Node_Id)
8215 is
8216 Func_Call : constant Node_Id := Unqual_Conv (Function_Call);
8217 Lhs : constant Node_Id := Name (Assign);
8218 Loc : constant Source_Ptr := Sloc (Function_Call);
8219 Func_Id : Entity_Id;
8220 Obj_Decl : Node_Id;
8221 Obj_Id : Entity_Id;
8222 Ptr_Typ : Entity_Id;
8223 Ptr_Typ_Decl : Node_Id;
8224 New_Expr : Node_Id;
8225 Result_Subt : Entity_Id;
8226
8227 begin
8228 -- Mark the call as processed as a build-in-place call
8229
8230 pragma Assert (not Is_Expanded_Build_In_Place_Call (Func_Call));
8231 Set_Is_Expanded_Build_In_Place_Call (Func_Call);
8232
8233 if Is_Entity_Name (Name (Func_Call)) then
8234 Func_Id := Entity (Name (Func_Call));
8235
8236 elsif Nkind (Name (Func_Call)) = N_Explicit_Dereference then
8237 Func_Id := Etype (Name (Func_Call));
8238
8239 else
8240 raise Program_Error;
8241 end if;
8242
8243 Result_Subt := Etype (Func_Id);
8244
8245 -- When the result subtype is unconstrained, an additional actual must
8246 -- be passed to indicate that the caller is providing the return object.
8247 -- This parameter must also be passed when the called function has a
8248 -- controlling result, because dispatching calls to the function needs
8249 -- to be treated effectively the same as calls to class-wide functions.
8250
8251 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8252 (Func_Call, Func_Id, Alloc_Form => Caller_Allocation);
8253
8254 Add_Finalization_Master_Actual_To_Build_In_Place_Call
8255 (Func_Call, Func_Id);
8256
8257 Add_Task_Actuals_To_Build_In_Place_Call
8258 (Func_Call, Func_Id, Make_Identifier (Loc, Name_uMaster));
8259
8260 -- Add an implicit actual to the function call that provides access to
8261 -- the caller's return object.
8262
8263 Add_Access_Actual_To_Build_In_Place_Call
8264 (Func_Call,
8265 Func_Id,
8266 Make_Unchecked_Type_Conversion (Loc,
8267 Subtype_Mark => New_Occurrence_Of (Result_Subt, Loc),
8268 Expression => Relocate_Node (Lhs)));
8269
8270 -- Create an access type designating the function's result subtype
8271
8272 Ptr_Typ := Make_Temporary (Loc, 'A');
8273
8274 Ptr_Typ_Decl :=
8275 Make_Full_Type_Declaration (Loc,
8276 Defining_Identifier => Ptr_Typ,
8277 Type_Definition =>
8278 Make_Access_To_Object_Definition (Loc,
8279 All_Present => True,
8280 Subtype_Indication =>
8281 New_Occurrence_Of (Result_Subt, Loc)));
8282 Insert_After_And_Analyze (Assign, Ptr_Typ_Decl);
8283
8284 -- Finally, create an access object initialized to a reference to the
8285 -- function call. We know this access value is non-null, so mark the
8286 -- entity accordingly to suppress junk access checks.
8287
8288 New_Expr := Make_Reference (Loc, Relocate_Node (Func_Call));
8289
8290 -- Add a conversion if it's the wrong type
8291
8292 if Etype (New_Expr) /= Ptr_Typ then
8293 New_Expr :=
8294 Make_Unchecked_Type_Conversion (Loc,
8295 New_Occurrence_Of (Ptr_Typ, Loc), New_Expr);
8296 end if;
8297
8298 Obj_Id := Make_Temporary (Loc, 'R', New_Expr);
8299 Set_Etype (Obj_Id, Ptr_Typ);
8300 Set_Is_Known_Non_Null (Obj_Id);
8301
8302 Obj_Decl :=
8303 Make_Object_Declaration (Loc,
8304 Defining_Identifier => Obj_Id,
8305 Object_Definition => New_Occurrence_Of (Ptr_Typ, Loc),
8306 Expression => New_Expr);
8307 Insert_After_And_Analyze (Ptr_Typ_Decl, Obj_Decl);
8308
8309 Rewrite (Assign, Make_Null_Statement (Loc));
8310 end Make_Build_In_Place_Call_In_Assignment;
8311
8312 ----------------------------------------------------
8313 -- Make_Build_In_Place_Call_In_Object_Declaration --
8314 ----------------------------------------------------
8315
8316 procedure Make_Build_In_Place_Call_In_Object_Declaration
8317 (Obj_Decl : Node_Id;
8318 Function_Call : Node_Id)
8319 is
8320 function Get_Function_Id (Func_Call : Node_Id) return Entity_Id;
8321 -- Get the value of Function_Id, below
8322
8323 ---------------------
8324 -- Get_Function_Id --
8325 ---------------------
8326
8327 function Get_Function_Id (Func_Call : Node_Id) return Entity_Id is
8328 begin
8329 if Is_Entity_Name (Name (Func_Call)) then
8330 return Entity (Name (Func_Call));
8331
8332 elsif Nkind (Name (Func_Call)) = N_Explicit_Dereference then
8333 return Etype (Name (Func_Call));
8334
8335 else
8336 raise Program_Error;
8337 end if;
8338 end Get_Function_Id;
8339
8340 -- Local variables
8341
8342 Func_Call : constant Node_Id := Unqual_Conv (Function_Call);
8343 Function_Id : constant Entity_Id := Get_Function_Id (Func_Call);
8344 Loc : constant Source_Ptr := Sloc (Function_Call);
8345 Obj_Loc : constant Source_Ptr := Sloc (Obj_Decl);
8346 Obj_Def_Id : constant Entity_Id := Defining_Identifier (Obj_Decl);
8347 Obj_Typ : constant Entity_Id := Etype (Obj_Def_Id);
8348 Encl_Func : constant Entity_Id := Enclosing_Subprogram (Obj_Def_Id);
8349 Result_Subt : constant Entity_Id := Etype (Function_Id);
8350
8351 Call_Deref : Node_Id;
8352 Caller_Object : Node_Id;
8353 Def_Id : Entity_Id;
8354 Designated_Type : Entity_Id;
8355 Fmaster_Actual : Node_Id := Empty;
8356 Pool_Actual : Node_Id;
8357 Ptr_Typ : Entity_Id;
8358 Ptr_Typ_Decl : Node_Id;
8359 Pass_Caller_Acc : Boolean := False;
8360 Res_Decl : Node_Id;
8361
8362 Definite : constant Boolean :=
8363 Caller_Known_Size (Func_Call, Result_Subt)
8364 and then not Is_Class_Wide_Type (Obj_Typ);
8365 -- In the case of "X : T'Class := F(...);", where F returns a
8366 -- Caller_Known_Size (specific) tagged type, we treat it as
8367 -- indefinite, because the code for the Definite case below sets the
8368 -- initialization expression of the object to Empty, which would be
8369 -- illegal Ada, and would cause gigi to misallocate X.
8370
8371 -- Start of processing for Make_Build_In_Place_Call_In_Object_Declaration
8372
8373 begin
8374 -- If the call has already been processed to add build-in-place actuals
8375 -- then return.
8376
8377 if Is_Expanded_Build_In_Place_Call (Func_Call) then
8378 return;
8379 end if;
8380
8381 -- Mark the call as processed as a build-in-place call
8382
8383 Set_Is_Expanded_Build_In_Place_Call (Func_Call);
8384
8385 -- Create an access type designating the function's result subtype.
8386 -- We use the type of the original call because it may be a call to an
8387 -- inherited operation, which the expansion has replaced with the parent
8388 -- operation that yields the parent type. Note that this access type
8389 -- must be declared before we establish a transient scope, so that it
8390 -- receives the proper accessibility level.
8391
8392 if Is_Class_Wide_Type (Obj_Typ)
8393 and then not Is_Interface (Obj_Typ)
8394 and then not Is_Class_Wide_Type (Etype (Function_Call))
8395 then
8396 Designated_Type := Obj_Typ;
8397 else
8398 Designated_Type := Etype (Function_Call);
8399 end if;
8400
8401 Ptr_Typ := Make_Temporary (Loc, 'A');
8402 Ptr_Typ_Decl :=
8403 Make_Full_Type_Declaration (Loc,
8404 Defining_Identifier => Ptr_Typ,
8405 Type_Definition =>
8406 Make_Access_To_Object_Definition (Loc,
8407 All_Present => True,
8408 Subtype_Indication =>
8409 New_Occurrence_Of (Designated_Type, Loc)));
8410
8411 -- The access type and its accompanying object must be inserted after
8412 -- the object declaration in the constrained case, so that the function
8413 -- call can be passed access to the object. In the indefinite case, or
8414 -- if the object declaration is for a return object, the access type and
8415 -- object must be inserted before the object, since the object
8416 -- declaration is rewritten to be a renaming of a dereference of the
8417 -- access object. Note: we need to freeze Ptr_Typ explicitly, because
8418 -- the result object is in a different (transient) scope, so won't cause
8419 -- freezing.
8420
8421 if Definite and then not Is_Return_Object (Obj_Def_Id) then
8422 Insert_After_And_Analyze (Obj_Decl, Ptr_Typ_Decl);
8423 else
8424 Insert_Action (Obj_Decl, Ptr_Typ_Decl);
8425 end if;
8426
8427 -- Force immediate freezing of Ptr_Typ because Res_Decl will be
8428 -- elaborated in an inner (transient) scope and thus won't cause
8429 -- freezing by itself. It's not an itype, but it needs to be frozen
8430 -- inside the current subprogram (see Freeze_Outside in freeze.adb).
8431
8432 Freeze_Itype (Ptr_Typ, Ptr_Typ_Decl);
8433
8434 -- If the object is a return object of an enclosing build-in-place
8435 -- function, then the implicit build-in-place parameters of the
8436 -- enclosing function are simply passed along to the called function.
8437 -- (Unfortunately, this won't cover the case of extension aggregates
8438 -- where the ancestor part is a build-in-place indefinite function
8439 -- call that should be passed along the caller's parameters.
8440 -- Currently those get mishandled by reassigning the result of the
8441 -- call to the aggregate return object, when the call result should
8442 -- really be directly built in place in the aggregate and not in a
8443 -- temporary. ???)
8444
8445 if Is_Return_Object (Obj_Def_Id) then
8446 Pass_Caller_Acc := True;
8447
8448 -- When the enclosing function has a BIP_Alloc_Form formal then we
8449 -- pass it along to the callee (such as when the enclosing function
8450 -- has an unconstrained or tagged result type).
8451
8452 if Needs_BIP_Alloc_Form (Encl_Func) then
8453 if RTE_Available (RE_Root_Storage_Pool_Ptr) then
8454 Pool_Actual :=
8455 New_Occurrence_Of
8456 (Build_In_Place_Formal
8457 (Encl_Func, BIP_Storage_Pool), Loc);
8458
8459 -- The build-in-place pool formal is not built on e.g. ZFP
8460
8461 else
8462 Pool_Actual := Empty;
8463 end if;
8464
8465 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8466 (Function_Call => Func_Call,
8467 Function_Id => Function_Id,
8468 Alloc_Form_Exp =>
8469 New_Occurrence_Of
8470 (Build_In_Place_Formal (Encl_Func, BIP_Alloc_Form), Loc),
8471 Pool_Actual => Pool_Actual);
8472
8473 -- Otherwise, if enclosing function has a definite result subtype,
8474 -- then caller allocation will be used.
8475
8476 else
8477 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8478 (Func_Call, Function_Id, Alloc_Form => Caller_Allocation);
8479 end if;
8480
8481 if Needs_BIP_Finalization_Master (Encl_Func) then
8482 Fmaster_Actual :=
8483 New_Occurrence_Of
8484 (Build_In_Place_Formal
8485 (Encl_Func, BIP_Finalization_Master), Loc);
8486 end if;
8487
8488 -- Retrieve the BIPacc formal from the enclosing function and convert
8489 -- it to the access type of the callee's BIP_Object_Access formal.
8490
8491 Caller_Object :=
8492 Make_Unchecked_Type_Conversion (Loc,
8493 Subtype_Mark =>
8494 New_Occurrence_Of
8495 (Etype (Build_In_Place_Formal
8496 (Function_Id, BIP_Object_Access)),
8497 Loc),
8498 Expression =>
8499 New_Occurrence_Of
8500 (Build_In_Place_Formal (Encl_Func, BIP_Object_Access),
8501 Loc));
8502
8503 -- In the definite case, add an implicit actual to the function call
8504 -- that provides access to the declared object. An unchecked conversion
8505 -- to the (specific) result type of the function is inserted to handle
8506 -- the case where the object is declared with a class-wide type.
8507
8508 elsif Definite then
8509 Caller_Object :=
8510 Make_Unchecked_Type_Conversion (Loc,
8511 Subtype_Mark => New_Occurrence_Of (Result_Subt, Loc),
8512 Expression => New_Occurrence_Of (Obj_Def_Id, Loc));
8513
8514 -- When the function has a controlling result, an allocation-form
8515 -- parameter must be passed indicating that the caller is allocating
8516 -- the result object. This is needed because such a function can be
8517 -- called as a dispatching operation and must be treated similarly to
8518 -- functions with indefinite result subtypes.
8519
8520 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8521 (Func_Call, Function_Id, Alloc_Form => Caller_Allocation);
8522
8523 -- The allocation for indefinite library-level objects occurs on the
8524 -- heap as opposed to the secondary stack. This accommodates DLLs where
8525 -- the secondary stack is destroyed after each library unload. This is a
8526 -- hybrid mechanism where a stack-allocated object lives on the heap.
8527
8528 elsif Is_Library_Level_Entity (Obj_Def_Id)
8529 and then not Restriction_Active (No_Implicit_Heap_Allocations)
8530 then
8531 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8532 (Func_Call, Function_Id, Alloc_Form => Global_Heap);
8533 Caller_Object := Empty;
8534
8535 -- Create a finalization master for the access result type to ensure
8536 -- that the heap allocation can properly chain the object and later
8537 -- finalize it when the library unit goes out of scope.
8538
8539 if Needs_Finalization (Etype (Func_Call)) then
8540 Build_Finalization_Master
8541 (Typ => Ptr_Typ,
8542 For_Lib_Level => True,
8543 Insertion_Node => Ptr_Typ_Decl);
8544
8545 Fmaster_Actual :=
8546 Make_Attribute_Reference (Loc,
8547 Prefix =>
8548 New_Occurrence_Of (Finalization_Master (Ptr_Typ), Loc),
8549 Attribute_Name => Name_Unrestricted_Access);
8550 end if;
8551
8552 -- In other indefinite cases, pass an indication to do the allocation on
8553 -- the secondary stack and set Caller_Object to Empty so that a null
8554 -- value will be passed for the caller's object address. A transient
8555 -- scope is established to ensure eventual cleanup of the result.
8556
8557 else
8558 Add_Unconstrained_Actuals_To_Build_In_Place_Call
8559 (Func_Call, Function_Id, Alloc_Form => Secondary_Stack);
8560 Caller_Object := Empty;
8561
8562 Establish_Transient_Scope (Obj_Decl, Sec_Stack => True);
8563 end if;
8564
8565 -- Pass along any finalization master actual, which is needed in the
8566 -- case where the called function initializes a return object of an
8567 -- enclosing build-in-place function.
8568
8569 Add_Finalization_Master_Actual_To_Build_In_Place_Call
8570 (Func_Call => Func_Call,
8571 Func_Id => Function_Id,
8572 Master_Exp => Fmaster_Actual);
8573
8574 if Nkind (Parent (Obj_Decl)) = N_Extended_Return_Statement
8575 and then Has_Task (Result_Subt)
8576 then
8577 -- Here we're passing along the master that was passed in to this
8578 -- function.
8579
8580 Add_Task_Actuals_To_Build_In_Place_Call
8581 (Func_Call, Function_Id,
8582 Master_Actual =>
8583 New_Occurrence_Of
8584 (Build_In_Place_Formal (Encl_Func, BIP_Task_Master), Loc));
8585
8586 else
8587 Add_Task_Actuals_To_Build_In_Place_Call
8588 (Func_Call, Function_Id, Make_Identifier (Loc, Name_uMaster));
8589 end if;
8590
8591 Add_Access_Actual_To_Build_In_Place_Call
8592 (Func_Call,
8593 Function_Id,
8594 Caller_Object,
8595 Is_Access => Pass_Caller_Acc);
8596
8597 -- Finally, create an access object initialized to a reference to the
8598 -- function call. We know this access value cannot be null, so mark the
8599 -- entity accordingly to suppress the access check.
8600
8601 Def_Id := Make_Temporary (Loc, 'R', Func_Call);
8602 Set_Etype (Def_Id, Ptr_Typ);
8603 Set_Is_Known_Non_Null (Def_Id);
8604
8605 if Nkind_In (Function_Call, N_Type_Conversion,
8606 N_Unchecked_Type_Conversion)
8607 then
8608 Res_Decl :=
8609 Make_Object_Declaration (Loc,
8610 Defining_Identifier => Def_Id,
8611 Constant_Present => True,
8612 Object_Definition => New_Occurrence_Of (Ptr_Typ, Loc),
8613 Expression =>
8614 Make_Unchecked_Type_Conversion (Loc,
8615 New_Occurrence_Of (Ptr_Typ, Loc),
8616 Make_Reference (Loc, Relocate_Node (Func_Call))));
8617 else
8618 Res_Decl :=
8619 Make_Object_Declaration (Loc,
8620 Defining_Identifier => Def_Id,
8621 Constant_Present => True,
8622 Object_Definition => New_Occurrence_Of (Ptr_Typ, Loc),
8623 Expression =>
8624 Make_Reference (Loc, Relocate_Node (Func_Call)));
8625 end if;
8626
8627 Insert_After_And_Analyze (Ptr_Typ_Decl, Res_Decl);
8628
8629 -- If the result subtype of the called function is definite and is not
8630 -- itself the return expression of an enclosing BIP function, then mark
8631 -- the object as having no initialization.
8632
8633 if Definite and then not Is_Return_Object (Obj_Def_Id) then
8634
8635 -- The related object declaration is encased in a transient block
8636 -- because the build-in-place function call contains at least one
8637 -- nested function call that produces a controlled transient
8638 -- temporary:
8639
8640 -- Obj : ... := BIP_Func_Call (Ctrl_Func_Call);
8641
8642 -- Since the build-in-place expansion decouples the call from the
8643 -- object declaration, the finalization machinery lacks the context
8644 -- which prompted the generation of the transient block. To resolve
8645 -- this scenario, store the build-in-place call.
8646
8647 if Scope_Is_Transient and then Node_To_Be_Wrapped = Obj_Decl then
8648 Set_BIP_Initialization_Call (Obj_Def_Id, Res_Decl);
8649 end if;
8650
8651 Set_Expression (Obj_Decl, Empty);
8652 Set_No_Initialization (Obj_Decl);
8653
8654 -- In case of an indefinite result subtype, or if the call is the
8655 -- return expression of an enclosing BIP function, rewrite the object
8656 -- declaration as an object renaming where the renamed object is a
8657 -- dereference of <function_Call>'reference:
8658 --
8659 -- Obj : Subt renames <function_call>'Ref.all;
8660
8661 else
8662 Call_Deref :=
8663 Make_Explicit_Dereference (Obj_Loc,
8664 Prefix => New_Occurrence_Of (Def_Id, Obj_Loc));
8665
8666 Rewrite (Obj_Decl,
8667 Make_Object_Renaming_Declaration (Obj_Loc,
8668 Defining_Identifier => Make_Temporary (Obj_Loc, 'D'),
8669 Subtype_Mark =>
8670 New_Occurrence_Of (Designated_Type, Obj_Loc),
8671 Name => Call_Deref));
8672
8673 -- At this point, Defining_Identifier (Obj_Decl) is no longer equal
8674 -- to Obj_Def_Id.
8675
8676 Set_Renamed_Object (Defining_Identifier (Obj_Decl), Call_Deref);
8677
8678 -- If the original entity comes from source, then mark the new
8679 -- entity as needing debug information, even though it's defined
8680 -- by a generated renaming that does not come from source, so that
8681 -- the Materialize_Entity flag will be set on the entity when
8682 -- Debug_Renaming_Declaration is called during analysis.
8683
8684 if Comes_From_Source (Obj_Def_Id) then
8685 Set_Debug_Info_Needed (Defining_Identifier (Obj_Decl));
8686 end if;
8687
8688 Analyze (Obj_Decl);
8689 Replace_Renaming_Declaration_Id
8690 (Obj_Decl, Original_Node (Obj_Decl));
8691 end if;
8692 end Make_Build_In_Place_Call_In_Object_Declaration;
8693
8694 -------------------------------------------------
8695 -- Make_Build_In_Place_Iface_Call_In_Allocator --
8696 -------------------------------------------------
8697
8698 procedure Make_Build_In_Place_Iface_Call_In_Allocator
8699 (Allocator : Node_Id;
8700 Function_Call : Node_Id)
8701 is
8702 BIP_Func_Call : constant Node_Id :=
8703 Unqual_BIP_Iface_Function_Call (Function_Call);
8704 Loc : constant Source_Ptr := Sloc (Function_Call);
8705
8706 Anon_Type : Entity_Id;
8707 Tmp_Decl : Node_Id;
8708 Tmp_Id : Entity_Id;
8709
8710 begin
8711 -- No action of the call has already been processed
8712
8713 if Is_Expanded_Build_In_Place_Call (BIP_Func_Call) then
8714 return;
8715 end if;
8716
8717 Tmp_Id := Make_Temporary (Loc, 'D');
8718
8719 -- Insert a temporary before N initialized with the BIP function call
8720 -- without its enclosing type conversions and analyze it without its
8721 -- expansion. This temporary facilitates us reusing the BIP machinery,
8722 -- which takes care of adding the extra build-in-place actuals and
8723 -- transforms this object declaration into an object renaming
8724 -- declaration.
8725
8726 Anon_Type := Create_Itype (E_Anonymous_Access_Type, Function_Call);
8727 Set_Directly_Designated_Type (Anon_Type, Etype (BIP_Func_Call));
8728 Set_Etype (Anon_Type, Anon_Type);
8729
8730 Tmp_Decl :=
8731 Make_Object_Declaration (Loc,
8732 Defining_Identifier => Tmp_Id,
8733 Object_Definition => New_Occurrence_Of (Anon_Type, Loc),
8734 Expression =>
8735 Make_Allocator (Loc,
8736 Expression =>
8737 Make_Qualified_Expression (Loc,
8738 Subtype_Mark =>
8739 New_Occurrence_Of (Etype (BIP_Func_Call), Loc),
8740 Expression => New_Copy_Tree (BIP_Func_Call))));
8741
8742 Expander_Mode_Save_And_Set (False);
8743 Insert_Action (Allocator, Tmp_Decl);
8744 Expander_Mode_Restore;
8745
8746 Make_Build_In_Place_Call_In_Allocator
8747 (Allocator => Expression (Tmp_Decl),
8748 Function_Call => Expression (Expression (Tmp_Decl)));
8749
8750 Rewrite (Allocator, New_Occurrence_Of (Tmp_Id, Loc));
8751 end Make_Build_In_Place_Iface_Call_In_Allocator;
8752
8753 ---------------------------------------------------------
8754 -- Make_Build_In_Place_Iface_Call_In_Anonymous_Context --
8755 ---------------------------------------------------------
8756
8757 procedure Make_Build_In_Place_Iface_Call_In_Anonymous_Context
8758 (Function_Call : Node_Id)
8759 is
8760 BIP_Func_Call : constant Node_Id :=
8761 Unqual_BIP_Iface_Function_Call (Function_Call);
8762 Loc : constant Source_Ptr := Sloc (Function_Call);
8763
8764 Tmp_Decl : Node_Id;
8765 Tmp_Id : Entity_Id;
8766
8767 begin
8768 -- No action of the call has already been processed
8769
8770 if Is_Expanded_Build_In_Place_Call (BIP_Func_Call) then
8771 return;
8772 end if;
8773
8774 pragma Assert (Needs_Finalization (Etype (BIP_Func_Call)));
8775
8776 -- Insert a temporary before the call initialized with function call to
8777 -- reuse the BIP machinery which takes care of adding the extra build-in
8778 -- place actuals and transforms this object declaration into an object
8779 -- renaming declaration.
8780
8781 Tmp_Id := Make_Temporary (Loc, 'D');
8782
8783 Tmp_Decl :=
8784 Make_Object_Declaration (Loc,
8785 Defining_Identifier => Tmp_Id,
8786 Object_Definition =>
8787 New_Occurrence_Of (Etype (Function_Call), Loc),
8788 Expression => Relocate_Node (Function_Call));
8789
8790 Expander_Mode_Save_And_Set (False);
8791 Insert_Action (Function_Call, Tmp_Decl);
8792 Expander_Mode_Restore;
8793
8794 Make_Build_In_Place_Iface_Call_In_Object_Declaration
8795 (Obj_Decl => Tmp_Decl,
8796 Function_Call => Expression (Tmp_Decl));
8797 end Make_Build_In_Place_Iface_Call_In_Anonymous_Context;
8798
8799 ----------------------------------------------------------
8800 -- Make_Build_In_Place_Iface_Call_In_Object_Declaration --
8801 ----------------------------------------------------------
8802
8803 procedure Make_Build_In_Place_Iface_Call_In_Object_Declaration
8804 (Obj_Decl : Node_Id;
8805 Function_Call : Node_Id)
8806 is
8807 BIP_Func_Call : constant Node_Id :=
8808 Unqual_BIP_Iface_Function_Call (Function_Call);
8809 Loc : constant Source_Ptr := Sloc (Function_Call);
8810 Obj_Id : constant Entity_Id := Defining_Entity (Obj_Decl);
8811
8812 Tmp_Decl : Node_Id;
8813 Tmp_Id : Entity_Id;
8814
8815 begin
8816 -- No action of the call has already been processed
8817
8818 if Is_Expanded_Build_In_Place_Call (BIP_Func_Call) then
8819 return;
8820 end if;
8821
8822 Tmp_Id := Make_Temporary (Loc, 'D');
8823
8824 -- Insert a temporary before N initialized with the BIP function call
8825 -- without its enclosing type conversions and analyze it without its
8826 -- expansion. This temporary facilitates us reusing the BIP machinery,
8827 -- which takes care of adding the extra build-in-place actuals and
8828 -- transforms this object declaration into an object renaming
8829 -- declaration.
8830
8831 Tmp_Decl :=
8832 Make_Object_Declaration (Loc,
8833 Defining_Identifier => Tmp_Id,
8834 Object_Definition =>
8835 New_Occurrence_Of (Etype (BIP_Func_Call), Loc),
8836 Expression => New_Copy_Tree (BIP_Func_Call));
8837
8838 Expander_Mode_Save_And_Set (False);
8839 Insert_Action (Obj_Decl, Tmp_Decl);
8840 Expander_Mode_Restore;
8841
8842 Make_Build_In_Place_Call_In_Object_Declaration
8843 (Obj_Decl => Tmp_Decl,
8844 Function_Call => Expression (Tmp_Decl));
8845
8846 pragma Assert (Nkind (Tmp_Decl) = N_Object_Renaming_Declaration);
8847
8848 -- Replace the original build-in-place function call by a reference to
8849 -- the resulting temporary object renaming declaration. In this way,
8850 -- all the interface conversions performed in the original Function_Call
8851 -- on the build-in-place object are preserved.
8852
8853 Rewrite (BIP_Func_Call, New_Occurrence_Of (Tmp_Id, Loc));
8854
8855 -- Replace the original object declaration by an internal object
8856 -- renaming declaration. This leaves the generated code more clean (the
8857 -- build-in-place function call in an object renaming declaration and
8858 -- displacements of the pointer to the build-in-place object in another
8859 -- renaming declaration) and allows us to invoke the routine that takes
8860 -- care of replacing the identifier of the renaming declaration (routine
8861 -- originally developed for the regular build-in-place management).
8862
8863 Rewrite (Obj_Decl,
8864 Make_Object_Renaming_Declaration (Loc,
8865 Defining_Identifier => Make_Temporary (Loc, 'D'),
8866 Subtype_Mark => New_Occurrence_Of (Etype (Obj_Id), Loc),
8867 Name => Function_Call));
8868 Analyze (Obj_Decl);
8869
8870 Replace_Renaming_Declaration_Id (Obj_Decl, Original_Node (Obj_Decl));
8871 end Make_Build_In_Place_Iface_Call_In_Object_Declaration;
8872
8873 --------------------------------------------
8874 -- Make_CPP_Constructor_Call_In_Allocator --
8875 --------------------------------------------
8876
8877 procedure Make_CPP_Constructor_Call_In_Allocator
8878 (Allocator : Node_Id;
8879 Function_Call : Node_Id)
8880 is
8881 Loc : constant Source_Ptr := Sloc (Function_Call);
8882 Acc_Type : constant Entity_Id := Etype (Allocator);
8883 Function_Id : constant Entity_Id := Entity (Name (Function_Call));
8884 Result_Subt : constant Entity_Id := Available_View (Etype (Function_Id));
8885
8886 New_Allocator : Node_Id;
8887 Return_Obj_Access : Entity_Id;
8888 Tmp_Obj : Node_Id;
8889
8890 begin
8891 pragma Assert (Nkind (Allocator) = N_Allocator
8892 and then Nkind (Function_Call) = N_Function_Call);
8893 pragma Assert (Convention (Function_Id) = Convention_CPP
8894 and then Is_Constructor (Function_Id));
8895 pragma Assert (Is_Constrained (Underlying_Type (Result_Subt)));
8896
8897 -- Replace the initialized allocator of form "new T'(Func (...))" with
8898 -- an uninitialized allocator of form "new T", where T is the result
8899 -- subtype of the called function. The call to the function is handled
8900 -- separately further below.
8901
8902 New_Allocator :=
8903 Make_Allocator (Loc,
8904 Expression => New_Occurrence_Of (Result_Subt, Loc));
8905 Set_No_Initialization (New_Allocator);
8906
8907 -- Copy attributes to new allocator. Note that the new allocator
8908 -- logically comes from source if the original one did, so copy the
8909 -- relevant flag. This ensures proper treatment of the restriction
8910 -- No_Implicit_Heap_Allocations in this case.
8911
8912 Set_Storage_Pool (New_Allocator, Storage_Pool (Allocator));
8913 Set_Procedure_To_Call (New_Allocator, Procedure_To_Call (Allocator));
8914 Set_Comes_From_Source (New_Allocator, Comes_From_Source (Allocator));
8915
8916 Rewrite (Allocator, New_Allocator);
8917
8918 -- Create a new access object and initialize it to the result of the
8919 -- new uninitialized allocator. Note: we do not use Allocator as the
8920 -- Related_Node of Return_Obj_Access in call to Make_Temporary below
8921 -- as this would create a sort of infinite "recursion".
8922
8923 Return_Obj_Access := Make_Temporary (Loc, 'R');
8924 Set_Etype (Return_Obj_Access, Acc_Type);
8925
8926 -- Generate:
8927 -- Rnnn : constant ptr_T := new (T);
8928 -- Init (Rnn.all,...);
8929
8930 Tmp_Obj :=
8931 Make_Object_Declaration (Loc,
8932 Defining_Identifier => Return_Obj_Access,
8933 Constant_Present => True,
8934 Object_Definition => New_Occurrence_Of (Acc_Type, Loc),
8935 Expression => Relocate_Node (Allocator));
8936 Insert_Action (Allocator, Tmp_Obj);
8937
8938 Insert_List_After_And_Analyze (Tmp_Obj,
8939 Build_Initialization_Call (Loc,
8940 Id_Ref =>
8941 Make_Explicit_Dereference (Loc,
8942 Prefix => New_Occurrence_Of (Return_Obj_Access, Loc)),
8943 Typ => Etype (Function_Id),
8944 Constructor_Ref => Function_Call));
8945
8946 -- Finally, replace the allocator node with a reference to the result of
8947 -- the function call itself (which will effectively be an access to the
8948 -- object created by the allocator).
8949
8950 Rewrite (Allocator, New_Occurrence_Of (Return_Obj_Access, Loc));
8951
8952 -- Ada 2005 (AI-251): If the type of the allocator is an interface then
8953 -- generate an implicit conversion to force displacement of the "this"
8954 -- pointer.
8955
8956 if Is_Interface (Designated_Type (Acc_Type)) then
8957 Rewrite (Allocator, Convert_To (Acc_Type, Relocate_Node (Allocator)));
8958 end if;
8959
8960 Analyze_And_Resolve (Allocator, Acc_Type);
8961 end Make_CPP_Constructor_Call_In_Allocator;
8962
8963 -----------------------------------
8964 -- Needs_BIP_Finalization_Master --
8965 -----------------------------------
8966
8967 function Needs_BIP_Finalization_Master
8968 (Func_Id : Entity_Id) return Boolean
8969 is
8970 pragma Assert (Is_Build_In_Place_Function (Func_Id));
8971 Func_Typ : constant Entity_Id := Underlying_Type (Etype (Func_Id));
8972 begin
8973 -- A formal giving the finalization master is needed for build-in-place
8974 -- functions whose result type needs finalization or is a tagged type.
8975 -- Tagged primitive build-in-place functions need such a formal because
8976 -- they can be called by a dispatching call, and extensions may require
8977 -- finalization even if the root type doesn't. This means they're also
8978 -- needed for tagged nonprimitive build-in-place functions with tagged
8979 -- results, since such functions can be called via access-to-function
8980 -- types, and those can be used to call primitives, so masters have to
8981 -- be passed to all such build-in-place functions, primitive or not.
8982
8983 return
8984 not Restriction_Active (No_Finalization)
8985 and then (Needs_Finalization (Func_Typ)
8986 or else Is_Tagged_Type (Func_Typ));
8987 end Needs_BIP_Finalization_Master;
8988
8989 --------------------------
8990 -- Needs_BIP_Alloc_Form --
8991 --------------------------
8992
8993 function Needs_BIP_Alloc_Form (Func_Id : Entity_Id) return Boolean is
8994 pragma Assert (Is_Build_In_Place_Function (Func_Id));
8995 Func_Typ : constant Entity_Id := Underlying_Type (Etype (Func_Id));
8996 begin
8997 return not Is_Constrained (Func_Typ) or else Is_Tagged_Type (Func_Typ);
8998 end Needs_BIP_Alloc_Form;
8999
9000 --------------------------------------
9001 -- Needs_Result_Accessibility_Level --
9002 --------------------------------------
9003
9004 function Needs_Result_Accessibility_Level
9005 (Func_Id : Entity_Id) return Boolean
9006 is
9007 Func_Typ : constant Entity_Id := Underlying_Type (Etype (Func_Id));
9008
9009 function Has_Unconstrained_Access_Discriminant_Component
9010 (Comp_Typ : Entity_Id) return Boolean;
9011 -- Returns True if any component of the type has an unconstrained access
9012 -- discriminant.
9013
9014 -----------------------------------------------------
9015 -- Has_Unconstrained_Access_Discriminant_Component --
9016 -----------------------------------------------------
9017
9018 function Has_Unconstrained_Access_Discriminant_Component
9019 (Comp_Typ : Entity_Id) return Boolean
9020 is
9021 begin
9022 if not Is_Limited_Type (Comp_Typ) then
9023 return False;
9024
9025 -- Only limited types can have access discriminants with
9026 -- defaults.
9027
9028 elsif Has_Unconstrained_Access_Discriminants (Comp_Typ) then
9029 return True;
9030
9031 elsif Is_Array_Type (Comp_Typ) then
9032 return Has_Unconstrained_Access_Discriminant_Component
9033 (Underlying_Type (Component_Type (Comp_Typ)));
9034
9035 elsif Is_Record_Type (Comp_Typ) then
9036 declare
9037 Comp : Entity_Id;
9038
9039 begin
9040 Comp := First_Component (Comp_Typ);
9041 while Present (Comp) loop
9042 if Has_Unconstrained_Access_Discriminant_Component
9043 (Underlying_Type (Etype (Comp)))
9044 then
9045 return True;
9046 end if;
9047
9048 Next_Component (Comp);
9049 end loop;
9050 end;
9051 end if;
9052
9053 return False;
9054 end Has_Unconstrained_Access_Discriminant_Component;
9055
9056 Feature_Disabled : constant Boolean := True;
9057 -- Temporary
9058
9059 -- Start of processing for Needs_Result_Accessibility_Level
9060
9061 begin
9062 -- False if completion unavailable (how does this happen???)
9063
9064 if not Present (Func_Typ) then
9065 return False;
9066
9067 elsif Feature_Disabled then
9068 return False;
9069
9070 -- False if not a function, also handle enum-lit renames case
9071
9072 elsif Func_Typ = Standard_Void_Type
9073 or else Is_Scalar_Type (Func_Typ)
9074 then
9075 return False;
9076
9077 -- Handle a corner case, a cross-dialect subp renaming. For example,
9078 -- an Ada 2012 renaming of an Ada 2005 subprogram. This can occur when
9079 -- an Ada 2005 (or earlier) unit references predefined run-time units.
9080
9081 elsif Present (Alias (Func_Id)) then
9082
9083 -- Unimplemented: a cross-dialect subp renaming which does not set
9084 -- the Alias attribute (e.g., a rename of a dereference of an access
9085 -- to subprogram value). ???
9086
9087 return Present (Extra_Accessibility_Of_Result (Alias (Func_Id)));
9088
9089 -- Remaining cases require Ada 2012 mode
9090
9091 elsif Ada_Version < Ada_2012 then
9092 return False;
9093
9094 elsif Ekind (Func_Typ) = E_Anonymous_Access_Type
9095 or else Is_Tagged_Type (Func_Typ)
9096 then
9097 -- In the case of, say, a null tagged record result type, the need
9098 -- for this extra parameter might not be obvious. This function
9099 -- returns True for all tagged types for compatibility reasons.
9100 -- A function with, say, a tagged null controlling result type might
9101 -- be overridden by a primitive of an extension having an access
9102 -- discriminant and the overrider and overridden must have compatible
9103 -- calling conventions (including implicitly declared parameters).
9104 -- Similarly, values of one access-to-subprogram type might designate
9105 -- both a primitive subprogram of a given type and a function
9106 -- which is, for example, not a primitive subprogram of any type.
9107 -- Again, this requires calling convention compatibility.
9108 -- It might be possible to solve these issues by introducing
9109 -- wrappers, but that is not the approach that was chosen.
9110
9111 return True;
9112
9113 elsif Has_Unconstrained_Access_Discriminants (Func_Typ) then
9114 return True;
9115
9116 elsif Has_Unconstrained_Access_Discriminant_Component (Func_Typ) then
9117 return True;
9118
9119 -- False for all other cases
9120
9121 else
9122 return False;
9123 end if;
9124 end Needs_Result_Accessibility_Level;
9125
9126 -------------------------------------
9127 -- Replace_Renaming_Declaration_Id --
9128 -------------------------------------
9129
9130 procedure Replace_Renaming_Declaration_Id
9131 (New_Decl : Node_Id;
9132 Orig_Decl : Node_Id)
9133 is
9134 New_Id : constant Entity_Id := Defining_Entity (New_Decl);
9135 Orig_Id : constant Entity_Id := Defining_Entity (Orig_Decl);
9136
9137 begin
9138 Set_Chars (New_Id, Chars (Orig_Id));
9139
9140 -- Swap next entity links in preparation for exchanging entities
9141
9142 declare
9143 Next_Id : constant Entity_Id := Next_Entity (New_Id);
9144 begin
9145 Set_Next_Entity (New_Id, Next_Entity (Orig_Id));
9146 Set_Next_Entity (Orig_Id, Next_Id);
9147 end;
9148
9149 Set_Homonym (New_Id, Homonym (Orig_Id));
9150 Exchange_Entities (New_Id, Orig_Id);
9151
9152 -- Preserve source indication of original declaration, so that xref
9153 -- information is properly generated for the right entity.
9154
9155 Preserve_Comes_From_Source (New_Decl, Orig_Decl);
9156 Preserve_Comes_From_Source (Orig_Id, Orig_Decl);
9157
9158 Set_Comes_From_Source (New_Id, False);
9159 end Replace_Renaming_Declaration_Id;
9160
9161 ---------------------------------
9162 -- Rewrite_Function_Call_For_C --
9163 ---------------------------------
9164
9165 procedure Rewrite_Function_Call_For_C (N : Node_Id) is
9166 Orig_Func : constant Entity_Id := Entity (Name (N));
9167 Func_Id : constant Entity_Id := Ultimate_Alias (Orig_Func);
9168 Par : constant Node_Id := Parent (N);
9169 Proc_Id : constant Entity_Id := Corresponding_Procedure (Func_Id);
9170 Loc : constant Source_Ptr := Sloc (Par);
9171 Actuals : List_Id;
9172 Last_Actual : Node_Id;
9173 Last_Formal : Entity_Id;
9174
9175 -- Start of processing for Rewrite_Function_Call_For_C
9176
9177 begin
9178 -- The actuals may be given by named associations, so the added actual
9179 -- that is the target of the return value of the call must be a named
9180 -- association as well, so we retrieve the name of the generated
9181 -- out_formal.
9182
9183 Last_Formal := First_Formal (Proc_Id);
9184 while Present (Next_Formal (Last_Formal)) loop
9185 Last_Formal := Next_Formal (Last_Formal);
9186 end loop;
9187
9188 Actuals := Parameter_Associations (N);
9189
9190 -- The original function may lack parameters
9191
9192 if No (Actuals) then
9193 Actuals := New_List;
9194 end if;
9195
9196 -- If the function call is the expression of an assignment statement,
9197 -- transform the assignment into a procedure call. Generate:
9198
9199 -- LHS := Func_Call (...);
9200
9201 -- Proc_Call (..., LHS);
9202
9203 -- If function is inherited, a conversion may be necessary.
9204
9205 if Nkind (Par) = N_Assignment_Statement then
9206 Last_Actual := Name (Par);
9207
9208 if not Comes_From_Source (Orig_Func)
9209 and then Etype (Orig_Func) /= Etype (Func_Id)
9210 then
9211 Last_Actual :=
9212 Make_Type_Conversion (Loc,
9213 New_Occurrence_Of (Etype (Func_Id), Loc),
9214 Last_Actual);
9215 end if;
9216
9217 Append_To (Actuals,
9218 Make_Parameter_Association (Loc,
9219 Selector_Name =>
9220 Make_Identifier (Loc, Chars (Last_Formal)),
9221 Explicit_Actual_Parameter => Last_Actual));
9222
9223 Rewrite (Par,
9224 Make_Procedure_Call_Statement (Loc,
9225 Name => New_Occurrence_Of (Proc_Id, Loc),
9226 Parameter_Associations => Actuals));
9227 Analyze (Par);
9228
9229 -- Otherwise the context is an expression. Generate a temporary and a
9230 -- procedure call to obtain the function result. Generate:
9231
9232 -- ... Func_Call (...) ...
9233
9234 -- Temp : ...;
9235 -- Proc_Call (..., Temp);
9236 -- ... Temp ...
9237
9238 else
9239 declare
9240 Temp_Id : constant Entity_Id := Make_Temporary (Loc, 'T');
9241 Call : Node_Id;
9242 Decl : Node_Id;
9243
9244 begin
9245 -- Generate:
9246 -- Temp : ...;
9247
9248 Decl :=
9249 Make_Object_Declaration (Loc,
9250 Defining_Identifier => Temp_Id,
9251 Object_Definition =>
9252 New_Occurrence_Of (Etype (Func_Id), Loc));
9253
9254 -- Generate:
9255 -- Proc_Call (..., Temp);
9256
9257 Append_To (Actuals,
9258 Make_Parameter_Association (Loc,
9259 Selector_Name =>
9260 Make_Identifier (Loc, Chars (Last_Formal)),
9261 Explicit_Actual_Parameter =>
9262 New_Occurrence_Of (Temp_Id, Loc)));
9263
9264 Call :=
9265 Make_Procedure_Call_Statement (Loc,
9266 Name => New_Occurrence_Of (Proc_Id, Loc),
9267 Parameter_Associations => Actuals);
9268
9269 Insert_Actions (Par, New_List (Decl, Call));
9270 Rewrite (N, New_Occurrence_Of (Temp_Id, Loc));
9271 end;
9272 end if;
9273 end Rewrite_Function_Call_For_C;
9274
9275 ------------------------------------
9276 -- Set_Enclosing_Sec_Stack_Return --
9277 ------------------------------------
9278
9279 procedure Set_Enclosing_Sec_Stack_Return (N : Node_Id) is
9280 P : Node_Id := N;
9281
9282 begin
9283 -- Due to a possible mix of internally generated blocks, source blocks
9284 -- and loops, the scope stack may not be contiguous as all labels are
9285 -- inserted at the top level within the related function. Instead,
9286 -- perform a parent-based traversal and mark all appropriate constructs.
9287
9288 while Present (P) loop
9289
9290 -- Mark the label of a source or internally generated block or
9291 -- loop.
9292
9293 if Nkind_In (P, N_Block_Statement, N_Loop_Statement) then
9294 Set_Sec_Stack_Needed_For_Return (Entity (Identifier (P)));
9295
9296 -- Mark the enclosing function
9297
9298 elsif Nkind (P) = N_Subprogram_Body then
9299 if Present (Corresponding_Spec (P)) then
9300 Set_Sec_Stack_Needed_For_Return (Corresponding_Spec (P));
9301 else
9302 Set_Sec_Stack_Needed_For_Return (Defining_Entity (P));
9303 end if;
9304
9305 -- Do not go beyond the enclosing function
9306
9307 exit;
9308 end if;
9309
9310 P := Parent (P);
9311 end loop;
9312 end Set_Enclosing_Sec_Stack_Return;
9313
9314 ------------------------------------
9315 -- Unqual_BIP_Iface_Function_Call --
9316 ------------------------------------
9317
9318 function Unqual_BIP_Iface_Function_Call (Expr : Node_Id) return Node_Id is
9319 Has_Pointer_Displacement : Boolean := False;
9320 On_Object_Declaration : Boolean := False;
9321 -- Remember if processing the renaming expressions on recursion we have
9322 -- traversed an object declaration, since we can traverse many object
9323 -- declaration renamings but just one regular object declaration.
9324
9325 function Unqual_BIP_Function_Call (Expr : Node_Id) return Node_Id;
9326 -- Search for a build-in-place function call skipping any qualification
9327 -- including qualified expressions, type conversions, references, calls
9328 -- to displace the pointer to the object, and renamings. Return Empty if
9329 -- no build-in-place function call is found.
9330
9331 ------------------------------
9332 -- Unqual_BIP_Function_Call --
9333 ------------------------------
9334
9335 function Unqual_BIP_Function_Call (Expr : Node_Id) return Node_Id is
9336 begin
9337 -- Recurse to handle case of multiple levels of qualification and/or
9338 -- conversion.
9339
9340 if Nkind_In (Expr, N_Qualified_Expression,
9341 N_Type_Conversion,
9342 N_Unchecked_Type_Conversion)
9343 then
9344 return Unqual_BIP_Function_Call (Expression (Expr));
9345
9346 -- Recurse to handle case of multiple levels of references and
9347 -- explicit dereferences.
9348
9349 elsif Nkind_In (Expr, N_Attribute_Reference,
9350 N_Explicit_Dereference,
9351 N_Reference)
9352 then
9353 return Unqual_BIP_Function_Call (Prefix (Expr));
9354
9355 -- Recurse on object renamings
9356
9357 elsif Nkind (Expr) = N_Identifier
9358 and then Present (Entity (Expr))
9359 and then Ekind_In (Entity (Expr), E_Constant, E_Variable)
9360 and then Nkind (Parent (Entity (Expr))) =
9361 N_Object_Renaming_Declaration
9362 and then Present (Renamed_Object (Entity (Expr)))
9363 then
9364 return Unqual_BIP_Function_Call (Renamed_Object (Entity (Expr)));
9365
9366 -- Recurse on the initializing expression of the first reference of
9367 -- an object declaration.
9368
9369 elsif not On_Object_Declaration
9370 and then Nkind (Expr) = N_Identifier
9371 and then Present (Entity (Expr))
9372 and then Ekind_In (Entity (Expr), E_Constant, E_Variable)
9373 and then Nkind (Parent (Entity (Expr))) = N_Object_Declaration
9374 and then Present (Expression (Parent (Entity (Expr))))
9375 then
9376 On_Object_Declaration := True;
9377 return
9378 Unqual_BIP_Function_Call (Expression (Parent (Entity (Expr))));
9379
9380 -- Recurse to handle calls to displace the pointer to the object to
9381 -- reference a secondary dispatch table.
9382
9383 elsif Nkind (Expr) = N_Function_Call
9384 and then Nkind (Name (Expr)) in N_Has_Entity
9385 and then Present (Entity (Name (Expr)))
9386 and then RTU_Loaded (Ada_Tags)
9387 and then RTE_Available (RE_Displace)
9388 and then Is_RTE (Entity (Name (Expr)), RE_Displace)
9389 then
9390 Has_Pointer_Displacement := True;
9391 return
9392 Unqual_BIP_Function_Call (First (Parameter_Associations (Expr)));
9393
9394 -- Normal case: check if the inner expression is a BIP function call
9395 -- and the pointer to the object is displaced.
9396
9397 elsif Has_Pointer_Displacement
9398 and then Is_Build_In_Place_Function_Call (Expr)
9399 then
9400 return Expr;
9401
9402 else
9403 return Empty;
9404 end if;
9405 end Unqual_BIP_Function_Call;
9406
9407 -- Start of processing for Unqual_BIP_Iface_Function_Call
9408
9409 begin
9410 if Nkind (Expr) = N_Identifier and then No (Entity (Expr)) then
9411
9412 -- Can happen for X'Elab_Spec in the binder-generated file
9413
9414 return Empty;
9415 end if;
9416
9417 return Unqual_BIP_Function_Call (Expr);
9418 end Unqual_BIP_Iface_Function_Call;
9419
9420 end Exp_Ch6;