OSDN Git Service

* s-tassta.adb (Create_Task): Take into account tasks created by
[pf3gnuchains/gcc-fork.git] / gcc / ada / s-tassta.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                 GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                 --
4 --                                                                          --
5 --                 S Y S T E M . T A S K I N G . S T A G E S                --
6 --                                                                          --
7 --                                  B o d y                                 --
8 --                                                                          --
9 --         Copyright (C) 1992-2007, Free Software Foundation, Inc.          --
10 --                                                                          --
11 -- GNARL is free software; you can  redistribute it  and/or modify it under --
12 -- terms of the  GNU General Public License as published  by the Free Soft- --
13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
14 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17 -- for  more details.  You should have  received  a copy of the GNU General --
18 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
20 -- Boston, MA 02110-1301, USA.                                              --
21 --                                                                          --
22 -- As a special exception,  if other files  instantiate  generics from this --
23 -- unit, or you link  this unit with other files  to produce an executable, --
24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
25 -- covered  by the  GNU  General  Public  License.  This exception does not --
26 -- however invalidate  any other reasons why  the executable file  might be --
27 -- covered by the  GNU Public License.                                      --
28 --                                                                          --
29 -- GNARL was developed by the GNARL team at Florida State University.       --
30 -- Extensive contributions were provided by Ada Core Technologies, Inc.     --
31 --                                                                          --
32 ------------------------------------------------------------------------------
33
34 pragma Polling (Off);
35 --  Turn off polling, we do not want ATC polling to take place during
36 --  tasking operations. It causes infinite loops and other problems.
37
38 with Ada.Exceptions;
39 --  Used for Raise_Exception
40
41 with System.Tasking.Debug;
42 --  Used for enabling tasking facilities with gdb
43
44 with System.Address_Image;
45 --  Used for the function itself
46
47 with System.Task_Primitives.Operations;
48 --  Used for Finalize_Lock
49 --           Enter_Task
50 --           Write_Lock
51 --           Unlock
52 --           Sleep
53 --           Wakeup
54 --           Get_Priority
55 --           Lock/Unlock_RTS
56 --           New_ATCB
57
58 with System.Soft_Links;
59 --  These are procedure pointers to non-tasking routines that use task
60 --  specific data. In the absence of tasking, these routines refer to global
61 --  data. In the presense of tasking, they must be replaced with pointers to
62 --  task-specific versions. Also used for Create_TSD, Destroy_TSD,
63 --  Get_Current_Excep, Finalize_Global_List, Task_Termination, Handler.
64
65 with System.Tasking.Initialization;
66 --  Used for Remove_From_All_Tasks_List
67 --           Defer_Abort
68 --           Undefer_Abort
69 --           Finalize_Attributes_Link
70 --           Initialize_Attributes_Link
71
72 pragma Elaborate_All (System.Tasking.Initialization);
73 --  This insures that tasking is initialized if any tasks are created
74
75 with System.Tasking.Utilities;
76 --  Used for Make_Passive
77 --           Abort_One_Task
78 --           Abort_Tasks
79
80 with System.Tasking.Queuing;
81 --  Used for Dequeue_Head
82
83 with System.Tasking.Rendezvous;
84 --  Used for Call_Simple
85
86 with System.OS_Primitives;
87 --  Used for Delay_Modes
88
89 with System.Secondary_Stack;
90 --  Used for SS_Init
91
92 with System.Storage_Elements;
93 --  Used for Storage_Array
94
95 with System.Restrictions;
96 --  Used for Abort_Allowed
97
98 with System.Standard_Library;
99 --  Used for Exception_Trace
100
101 with System.Traces.Tasking;
102 --  Used for Send_Trace_Info
103
104 with Ada.Unchecked_Deallocation;
105 --  To recover from failure of ATCB initialization
106
107 with System.Stack_Usage;
108
109 package body System.Tasking.Stages is
110
111    package STPO renames System.Task_Primitives.Operations;
112    package SSL  renames System.Soft_Links;
113    package SSE  renames System.Storage_Elements;
114    package SST  renames System.Secondary_Stack;
115
116    use Ada.Exceptions;
117
118    use Parameters;
119    use Task_Primitives;
120    use Task_Primitives.Operations;
121    use Task_Info;
122
123    use System.Traces;
124    use System.Traces.Tasking;
125
126    -----------------------
127    -- Local Subprograms --
128    -----------------------
129
130    procedure Free is new
131      Ada.Unchecked_Deallocation (Ada_Task_Control_Block, Task_Id);
132
133    procedure Trace_Unhandled_Exception_In_Task (Self_Id : Task_Id);
134    --  This procedure outputs the task specific message for exception
135    --  tracing purposes.
136
137    procedure Task_Wrapper (Self_ID : Task_Id);
138    pragma Convention (C, Task_Wrapper);
139    --  This is the procedure that is called by the GNULL from the new context
140    --  when a task is created. It waits for activation and then calls the task
141    --  body procedure. When the task body procedure completes, it terminates
142    --  the task.
143    --
144    --  The Task_Wrapper's address will be provided to the underlying threads
145    --  library as the task entry point. Convention C is what makes most sense
146    --  for that purpose (Export C would make the function globally visible,
147    --  and affect the link name on which GDB depends). This will in addition
148    --  trigger an automatic stack alignment suitable for GCC's assumptions if
149    --  need be.
150
151    --  "Vulnerable_..." in the procedure names below means they must be called
152    --  with abort deferred.
153
154    procedure Vulnerable_Complete_Task (Self_ID : Task_Id);
155    --  Complete the calling task. This procedure must be called with
156    --  abort deferred. It should only be called by Complete_Task and
157    --  Finalizate_Global_Tasks (for the environment task).
158
159    procedure Vulnerable_Complete_Master (Self_ID : Task_Id);
160    --  Complete the current master of the calling task. This procedure
161    --  must be called with abort deferred. It should only be called by
162    --  Vulnerable_Complete_Task and Complete_Master.
163
164    procedure Vulnerable_Complete_Activation (Self_ID : Task_Id);
165    --  Signal to Self_ID's activator that Self_ID has completed activation.
166    --  This procedure must be called with abort deferred.
167
168    procedure Abort_Dependents (Self_ID : Task_Id);
169    --  Abort all the direct dependents of Self at its current master
170    --  nesting level, plus all of their dependents, transitively.
171    --  RTS_Lock should be locked by the caller.
172
173    procedure Vulnerable_Free_Task (T : Task_Id);
174    --  Recover all runtime system storage associated with the task T.
175    --  This should only be called after T has terminated and will no
176    --  longer be referenced.
177    --
178    --  For tasks created by an allocator that fails, due to an exception,
179    --  it is called from Expunge_Unactivated_Tasks.
180    --
181    --  It is also called from Ada.Unchecked_Deallocation, for objects that
182    --  are or contain tasks.
183    --
184    --  Different code is used at master completion, in Terminate_Dependents,
185    --  due to a need for tighter synchronization with the master.
186
187    ----------------------
188    -- Abort_Dependents --
189    ----------------------
190
191    procedure Abort_Dependents (Self_ID : Task_Id) is
192       C : Task_Id;
193       P : Task_Id;
194
195    begin
196       C := All_Tasks_List;
197       while C /= null loop
198          P := C.Common.Parent;
199          while P /= null loop
200             if P = Self_ID then
201
202                --  ??? C is supposed to take care of its own dependents, so
203                --  there should be no need to worry about them. Need to double
204                --  check this.
205
206                if C.Master_of_Task = Self_ID.Master_Within then
207                   Utilities.Abort_One_Task (Self_ID, C);
208                   C.Dependents_Aborted := True;
209                end if;
210
211                exit;
212             end if;
213
214             P := P.Common.Parent;
215          end loop;
216
217          C := C.Common.All_Tasks_Link;
218       end loop;
219
220       Self_ID.Dependents_Aborted := True;
221    end Abort_Dependents;
222
223    -----------------
224    -- Abort_Tasks --
225    -----------------
226
227    procedure Abort_Tasks (Tasks : Task_List) is
228    begin
229       Utilities.Abort_Tasks (Tasks);
230    end Abort_Tasks;
231
232    --------------------
233    -- Activate_Tasks --
234    --------------------
235
236    --  Note that locks of activator and activated task are both locked
237    --  here. This is necessary because C.Common.State and
238    --  Self.Common.Wait_Count have to be synchronized. This is safe from
239    --  deadlock because the activator is always created before the activated
240    --  task. That satisfies our in-order-of-creation ATCB locking policy.
241
242    --  At one point, we may also lock the parent, if the parent is
243    --  different from the activator. That is also consistent with the
244    --  lock ordering policy, since the activator cannot be created
245    --  before the parent.
246
247    --  Since we are holding both the activator's lock, and Task_Wrapper
248    --  locks that before it does anything more than initialize the
249    --  low-level ATCB components, it should be safe to wait to update
250    --  the counts until we see that the thread creation is successful.
251
252    --  If the thread creation fails, we do need to close the entries
253    --  of the task. The first phase, of dequeuing calls, only requires
254    --  locking the acceptor's ATCB, but the waking up of the callers
255    --  requires locking the caller's ATCB. We cannot safely do this
256    --  while we are holding other locks. Therefore, the queue-clearing
257    --  operation is done in a separate pass over the activation chain.
258
259    procedure Activate_Tasks (Chain_Access : Activation_Chain_Access) is
260       Self_ID        : constant Task_Id := STPO.Self;
261       P              : Task_Id;
262       C              : Task_Id;
263       Next_C, Last_C : Task_Id;
264       Activate_Prio  : System.Any_Priority;
265       Success        : Boolean;
266       All_Elaborated : Boolean := True;
267
268    begin
269       --  If pragma Detect_Blocking is active, then we must check whether this
270       --  potentially blocking operation is called from a protected action.
271
272       if System.Tasking.Detect_Blocking
273         and then Self_ID.Common.Protected_Action_Nesting > 0
274       then
275          Ada.Exceptions.Raise_Exception
276            (Program_Error'Identity, "potentially blocking operation");
277       end if;
278
279       pragma Debug
280         (Debug.Trace (Self_ID, "Activate_Tasks", 'C'));
281
282       Initialization.Defer_Abort_Nestable (Self_ID);
283
284       pragma Assert (Self_ID.Common.Wait_Count = 0);
285
286       --  Lock RTS_Lock, to prevent activated tasks from racing ahead before
287       --  we finish activating the chain.
288
289       Lock_RTS;
290
291       --  Check that all task bodies have been elaborated
292
293       C := Chain_Access.T_ID;
294       Last_C := null;
295       while C /= null loop
296          if C.Common.Elaborated /= null
297            and then not C.Common.Elaborated.all
298          then
299             All_Elaborated := False;
300          end if;
301
302          --  Reverse the activation chain so that tasks are
303          --  activated in the same order they're declared.
304
305          Next_C := C.Common.Activation_Link;
306          C.Common.Activation_Link := Last_C;
307          Last_C := C;
308          C := Next_C;
309       end loop;
310
311       Chain_Access.T_ID := Last_C;
312
313       if not All_Elaborated then
314          Unlock_RTS;
315          Initialization.Undefer_Abort_Nestable (Self_ID);
316          Raise_Exception
317            (Program_Error'Identity, "Some tasks have not been elaborated");
318       end if;
319
320       --  Activate all the tasks in the chain. Creation of the thread of
321       --  control was deferred until activation. So create it now.
322
323       C := Chain_Access.T_ID;
324       while C /= null loop
325          if C.Common.State /= Terminated then
326             pragma Assert (C.Common.State = Unactivated);
327
328             P := C.Common.Parent;
329             Write_Lock (P);
330             Write_Lock (C);
331
332             if C.Common.Base_Priority < Get_Priority (Self_ID) then
333                Activate_Prio := Get_Priority (Self_ID);
334             else
335                Activate_Prio := C.Common.Base_Priority;
336             end if;
337
338             System.Task_Primitives.Operations.Create_Task
339               (C, Task_Wrapper'Address,
340                Parameters.Size_Type
341                  (C.Common.Compiler_Data.Pri_Stack_Info.Size),
342                Activate_Prio, Success);
343
344             --  There would be a race between the created task and the
345             --  creator to do the following initialization, if we did not
346             --  have a Lock/Unlock_RTS pair in the task wrapper to prevent
347             --  it from racing ahead.
348
349             if Success then
350                C.Common.State := Runnable;
351                C.Awake_Count := 1;
352                C.Alive_Count := 1;
353                P.Awake_Count := P.Awake_Count + 1;
354                P.Alive_Count := P.Alive_Count + 1;
355
356                if P.Common.State = Master_Completion_Sleep and then
357                  C.Master_of_Task = P.Master_Within
358                then
359                   pragma Assert (Self_ID /= P);
360                   P.Common.Wait_Count := P.Common.Wait_Count + 1;
361                end if;
362
363                Unlock (C);
364                Unlock (P);
365
366             else
367                --  No need to set Awake_Count, State, etc. here since the loop
368                --  below will do that for any Unactivated tasks.
369
370                Unlock (C);
371                Unlock (P);
372                Self_ID.Common.Activation_Failed := True;
373             end if;
374          end if;
375
376          C := C.Common.Activation_Link;
377       end loop;
378
379       if not Single_Lock then
380          Unlock_RTS;
381       end if;
382
383       --  Close the entries of any tasks that failed thread creation,
384       --  and count those that have not finished activation.
385
386       Write_Lock (Self_ID);
387       Self_ID.Common.State := Activator_Sleep;
388
389       C := Chain_Access.T_ID;
390       while C /= null loop
391          Write_Lock (C);
392
393          if C.Common.State = Unactivated then
394             C.Common.Activator := null;
395             C.Common.State := Terminated;
396             C.Callable := False;
397             Utilities.Cancel_Queued_Entry_Calls (C);
398
399          elsif C.Common.Activator /= null then
400             Self_ID.Common.Wait_Count := Self_ID.Common.Wait_Count + 1;
401          end if;
402
403          Unlock (C);
404          P := C.Common.Activation_Link;
405          C.Common.Activation_Link := null;
406          C := P;
407       end loop;
408
409       --  Wait for the activated tasks to complete activation. It is
410       --  unsafe to abort any of these tasks until the count goes to zero.
411
412       loop
413          exit when Self_ID.Common.Wait_Count = 0;
414          Sleep (Self_ID, Activator_Sleep);
415       end loop;
416
417       Self_ID.Common.State := Runnable;
418       Unlock (Self_ID);
419
420       if Single_Lock then
421          Unlock_RTS;
422       end if;
423
424       --  Remove the tasks from the chain
425
426       Chain_Access.T_ID := null;
427       Initialization.Undefer_Abort_Nestable (Self_ID);
428
429       if Self_ID.Common.Activation_Failed then
430          Self_ID.Common.Activation_Failed := False;
431          Raise_Exception (Tasking_Error'Identity,
432            "Failure during activation");
433       end if;
434    end Activate_Tasks;
435
436    -------------------------
437    -- Complete_Activation --
438    -------------------------
439
440    procedure Complete_Activation is
441       Self_ID : constant Task_Id := STPO.Self;
442
443    begin
444       Initialization.Defer_Abort_Nestable (Self_ID);
445
446       if Single_Lock then
447          Lock_RTS;
448       end if;
449
450       Vulnerable_Complete_Activation (Self_ID);
451
452       if Single_Lock then
453          Unlock_RTS;
454       end if;
455
456       Initialization.Undefer_Abort_Nestable (Self_ID);
457
458       --  ???
459       --  Why do we need to allow for nested deferral here?
460
461       if Runtime_Traces then
462          Send_Trace_Info (T_Activate);
463       end if;
464    end Complete_Activation;
465
466    ---------------------
467    -- Complete_Master --
468    ---------------------
469
470    procedure Complete_Master is
471       Self_ID : constant Task_Id := STPO.Self;
472    begin
473       pragma Assert
474         (Self_ID.Deferral_Level > 0
475           or else not System.Restrictions.Abort_Allowed);
476       Vulnerable_Complete_Master (Self_ID);
477    end Complete_Master;
478
479    -------------------
480    -- Complete_Task --
481    -------------------
482
483    --  See comments on Vulnerable_Complete_Task for details
484
485    procedure Complete_Task is
486       Self_ID  : constant Task_Id := STPO.Self;
487
488    begin
489       pragma Assert
490         (Self_ID.Deferral_Level > 0
491           or else not System.Restrictions.Abort_Allowed);
492
493       Vulnerable_Complete_Task (Self_ID);
494
495       --  All of our dependents have terminated. Never undefer abort again!
496
497    end Complete_Task;
498
499    -----------------
500    -- Create_Task --
501    -----------------
502
503    --  Compiler interface only. Do not call from within the RTS.
504    --  This must be called to create a new task.
505
506    procedure Create_Task
507      (Priority      : Integer;
508       Size          : System.Parameters.Size_Type;
509       Task_Info     : System.Task_Info.Task_Info_Type;
510       Num_Entries   : Task_Entry_Index;
511       Master        : Master_Level;
512       State         : Task_Procedure_Access;
513       Discriminants : System.Address;
514       Elaborated    : Access_Boolean;
515       Chain         : in out Activation_Chain;
516       Task_Image    : String;
517       Created_Task  : out Task_Id)
518    is
519       T, P          : Task_Id;
520       Self_ID       : constant Task_Id := STPO.Self;
521       Success       : Boolean;
522       Base_Priority : System.Any_Priority;
523       Len           : Natural;
524
525    begin
526       --  If Master is greater than the current master, it means that Master
527       --  has already awaited its dependent tasks. This raises Program_Error,
528       --  by 4.8(10.3/2). See AI-280. Ignore this check for foreign threads.
529
530       if Self_ID.Master_of_Task /= Foreign_Task_Level
531         and then Master > Self_ID.Master_Within
532       then
533          raise Program_Error with
534            "create task after awaiting termination";
535       end if;
536
537       --  If pragma Detect_Blocking is active must be checked whether
538       --  this potentially blocking operation is called from a
539       --  protected action.
540
541       if System.Tasking.Detect_Blocking
542         and then Self_ID.Common.Protected_Action_Nesting > 0
543       then
544          Ada.Exceptions.Raise_Exception
545            (Program_Error'Identity, "potentially blocking operation");
546       end if;
547
548       pragma Debug
549         (Debug.Trace (Self_ID, "Create_Task", 'C'));
550
551       if Priority = Unspecified_Priority then
552          Base_Priority := Self_ID.Common.Base_Priority;
553       else
554          Base_Priority := System.Any_Priority (Priority);
555       end if;
556
557       --  Find parent P of new Task, via master level number
558
559       P := Self_ID;
560
561       if P /= null then
562          while P.Master_of_Task >= Master loop
563             P := P.Common.Parent;
564             exit when P = null;
565          end loop;
566       end if;
567
568       Initialization.Defer_Abort_Nestable (Self_ID);
569
570       begin
571          T := New_ATCB (Num_Entries);
572       exception
573          when others =>
574             Initialization.Undefer_Abort_Nestable (Self_ID);
575             Raise_Exception (Storage_Error'Identity, "Cannot allocate task");
576       end;
577
578       --  RTS_Lock is used by Abort_Dependents and Abort_Tasks.
579       --  Up to this point, it is possible that we may be part of
580       --  a family of tasks that is being aborted.
581
582       Lock_RTS;
583       Write_Lock (Self_ID);
584
585       --  Now, we must check that we have not been aborted.
586       --  If so, we should give up on creating this task,
587       --  and simply return.
588
589       if not Self_ID.Callable then
590          pragma Assert (Self_ID.Pending_ATC_Level = 0);
591          pragma Assert (Self_ID.Pending_Action);
592          pragma Assert
593            (Chain.T_ID = null or else Chain.T_ID.Common.State = Unactivated);
594
595          Unlock (Self_ID);
596          Unlock_RTS;
597          Initialization.Undefer_Abort_Nestable (Self_ID);
598
599          --  ??? Should never get here
600
601          pragma Assert (False);
602          raise Standard'Abort_Signal;
603       end if;
604
605       Initialize_ATCB (Self_ID, State, Discriminants, P, Elaborated,
606         Base_Priority, Task_Info, Size, T, Success);
607
608       if not Success then
609          Free (T);
610          Unlock (Self_ID);
611          Unlock_RTS;
612          Initialization.Undefer_Abort_Nestable (Self_ID);
613          Raise_Exception
614            (Storage_Error'Identity, "Failed to initialize task");
615       end if;
616
617       if Master = Foreign_Task_Level + 2 then
618
619          --  This should not happen, except when a foreign task creates non
620          --  library-level Ada tasks. In this case, we pretend the master is
621          --  a regular library level task, otherwise the run-time will get
622          --  confused when waiting for these tasks to terminate.
623
624          T.Master_of_Task := Library_Task_Level;
625       else
626          T.Master_of_Task := Master;
627       end if;
628
629       T.Master_Within := T.Master_of_Task + 1;
630
631       for L in T.Entry_Calls'Range loop
632          T.Entry_Calls (L).Self := T;
633          T.Entry_Calls (L).Level := L;
634       end loop;
635
636       if Task_Image'Length = 0 then
637          T.Common.Task_Image_Len := 0;
638       else
639          Len := 1;
640          T.Common.Task_Image (1) := Task_Image (Task_Image'First);
641
642          --  Remove unwanted blank space generated by 'Image
643
644          for J in Task_Image'First + 1 .. Task_Image'Last loop
645             if Task_Image (J) /= ' '
646               or else Task_Image (J - 1) /= '('
647             then
648                Len := Len + 1;
649                T.Common.Task_Image (Len) := Task_Image (J);
650                exit when Len = T.Common.Task_Image'Last;
651             end if;
652          end loop;
653
654          T.Common.Task_Image_Len := Len;
655       end if;
656
657       Unlock (Self_ID);
658       Unlock_RTS;
659
660       --  Create TSD as early as possible in the creation of a task, since it
661       --  may be used by the operation of Ada code within the task.
662
663       SSL.Create_TSD (T.Common.Compiler_Data);
664       T.Common.Activation_Link := Chain.T_ID;
665       Chain.T_ID := T;
666       Initialization.Initialize_Attributes_Link.all (T);
667       Created_Task := T;
668       Initialization.Undefer_Abort_Nestable (Self_ID);
669
670       if Runtime_Traces then
671          Send_Trace_Info (T_Create, T);
672       end if;
673    end Create_Task;
674
675    --------------------
676    -- Current_Master --
677    --------------------
678
679    function Current_Master return Master_Level is
680    begin
681       return STPO.Self.Master_Within;
682    end Current_Master;
683
684    ------------------
685    -- Enter_Master --
686    ------------------
687
688    procedure Enter_Master is
689       Self_ID : constant Task_Id := STPO.Self;
690    begin
691       Self_ID.Master_Within := Self_ID.Master_Within + 1;
692    end Enter_Master;
693
694    -------------------------------
695    -- Expunge_Unactivated_Tasks --
696    -------------------------------
697
698    --  See procedure Close_Entries for the general case
699
700    procedure Expunge_Unactivated_Tasks (Chain : in out Activation_Chain) is
701       Self_ID : constant Task_Id := STPO.Self;
702       C       : Task_Id;
703       Call    : Entry_Call_Link;
704       Temp    : Task_Id;
705
706    begin
707       pragma Debug
708         (Debug.Trace (Self_ID, "Expunge_Unactivated_Tasks", 'C'));
709
710       Initialization.Defer_Abort_Nestable (Self_ID);
711
712       --  ???
713       --  Experimentation has shown that abort is sometimes (but not
714       --  always) already deferred when this is called.
715
716       --  That may indicate an error. Find out what is going on
717
718       C := Chain.T_ID;
719       while C /= null loop
720          pragma Assert (C.Common.State = Unactivated);
721
722          Temp := C.Common.Activation_Link;
723
724          if C.Common.State = Unactivated then
725             Lock_RTS;
726             Write_Lock (C);
727
728             for J in 1 .. C.Entry_Num loop
729                Queuing.Dequeue_Head (C.Entry_Queues (J), Call);
730                pragma Assert (Call = null);
731             end loop;
732
733             Unlock (C);
734
735             Initialization.Remove_From_All_Tasks_List (C);
736             Unlock_RTS;
737
738             Vulnerable_Free_Task (C);
739             C := Temp;
740          end if;
741       end loop;
742
743       Chain.T_ID := null;
744       Initialization.Undefer_Abort_Nestable (Self_ID);
745    end Expunge_Unactivated_Tasks;
746
747    ---------------------------
748    -- Finalize_Global_Tasks --
749    ---------------------------
750
751    --  ???
752    --  We have a potential problem here if finalization of global
753    --  objects does anything with signals or the timer server, since
754    --  by that time those servers have terminated.
755
756    --  It is hard to see how that would occur
757
758    --  However, a better solution might be to do all this finalization
759    --  using the global finalization chain.
760
761    procedure Finalize_Global_Tasks is
762       Self_ID : constant Task_Id := STPO.Self;
763
764       Ignore  : Boolean;
765       pragma Unreferenced (Ignore);
766
767    begin
768       if Self_ID.Deferral_Level = 0 then
769          --  ???
770          --  In principle, we should be able to predict whether
771          --  abort is already deferred here (and it should not be deferred
772          --  yet but in practice it seems Finalize_Global_Tasks is being
773          --  called sometimes, from RTS code for exceptions, with abort already
774          --  deferred.
775
776          Initialization.Defer_Abort_Nestable (Self_ID);
777
778          --  Never undefer again!!!
779       end if;
780
781       --  This code is only executed by the environment task
782
783       pragma Assert (Self_ID = Environment_Task);
784
785       --  Set Environment_Task'Callable to false to notify library-level tasks
786       --  that it is waiting for them.
787
788       Self_ID.Callable := False;
789
790       --  Exit level 2 master, for normal tasks in library-level packages
791
792       Complete_Master;
793
794       --  Force termination of "independent" library-level server tasks
795
796       Lock_RTS;
797
798       Abort_Dependents (Self_ID);
799
800       if not Single_Lock then
801          Unlock_RTS;
802       end if;
803
804       --  We need to explicitely wait for the task to be terminated here
805       --  because on true concurrent system, we may end this procedure
806       --  before the tasks are really terminated.
807
808       Write_Lock (Self_ID);
809
810       loop
811          exit when Utilities.Independent_Task_Count = 0;
812
813          --  We used to yield here, but this did not take into account
814          --  low priority tasks that would cause dead lock in some cases
815          --  (true FIFO scheduling).
816
817          Timed_Sleep
818            (Self_ID, 0.01, System.OS_Primitives.Relative,
819             Self_ID.Common.State, Ignore, Ignore);
820       end loop;
821
822       --  ??? On multi-processor environments, it seems that the above loop
823       --  isn't sufficient, so we need to add an additional delay.
824
825       Timed_Sleep
826         (Self_ID, 0.01, System.OS_Primitives.Relative,
827          Self_ID.Common.State, Ignore, Ignore);
828
829       Unlock (Self_ID);
830
831       if Single_Lock then
832          Unlock_RTS;
833       end if;
834
835       --  Complete the environment task
836
837       Vulnerable_Complete_Task (Self_ID);
838
839       --  Handle normal task termination by the environment task, but only
840       --  for the normal task termination. In the case of Abnormal and
841       --  Unhandled_Exception they must have been handled before, and the
842       --  task termination soft link must have been changed so the task
843       --  termination routine is not executed twice.
844
845       SSL.Task_Termination_Handler.all (Ada.Exceptions.Null_Occurrence);
846
847       --  Finalize the global list for controlled objects if needed
848
849       SSL.Finalize_Global_List.all;
850
851       --  Reset the soft links to non-tasking
852
853       SSL.Abort_Defer        := SSL.Abort_Defer_NT'Access;
854       SSL.Abort_Undefer      := SSL.Abort_Undefer_NT'Access;
855       SSL.Lock_Task          := SSL.Task_Lock_NT'Access;
856       SSL.Unlock_Task        := SSL.Task_Unlock_NT'Access;
857       SSL.Get_Jmpbuf_Address := SSL.Get_Jmpbuf_Address_NT'Access;
858       SSL.Set_Jmpbuf_Address := SSL.Set_Jmpbuf_Address_NT'Access;
859       SSL.Get_Sec_Stack_Addr := SSL.Get_Sec_Stack_Addr_NT'Access;
860       SSL.Set_Sec_Stack_Addr := SSL.Set_Sec_Stack_Addr_NT'Access;
861       SSL.Check_Abort_Status := SSL.Check_Abort_Status_NT'Access;
862       SSL.Get_Stack_Info     := SSL.Get_Stack_Info_NT'Access;
863
864       --  Don't bother trying to finalize Initialization.Global_Task_Lock
865       --  and System.Task_Primitives.RTS_Lock.
866
867    end Finalize_Global_Tasks;
868
869    ---------------
870    -- Free_Task --
871    ---------------
872
873    procedure Free_Task (T : Task_Id) is
874       Self_Id : constant Task_Id := Self;
875
876    begin
877       if T.Common.State = Terminated then
878
879          --  It is not safe to call Abort_Defer or Write_Lock at this stage
880
881          Initialization.Task_Lock (Self_Id);
882
883          Lock_RTS;
884          Initialization.Remove_From_All_Tasks_List (T);
885          Unlock_RTS;
886
887          Initialization.Task_Unlock (Self_Id);
888
889          System.Task_Primitives.Operations.Finalize_TCB (T);
890
891       --  If the task is not terminated, then we simply ignore the call. This
892       --  happens when a user program attempts an unchecked deallocation on
893       --  a non-terminated task.
894
895       else
896          null;
897       end if;
898    end Free_Task;
899
900    ---------------------------
901    -- Move_Activation_Chain --
902    ---------------------------
903
904    procedure Move_Activation_Chain
905      (From, To   : Activation_Chain_Access;
906       New_Master : Master_ID)
907    is
908       Self_ID : constant Task_Id := STPO.Self;
909       C       : Task_Id;
910
911    begin
912       pragma Debug
913         (Debug.Trace (Self_ID, "Move_Activation_Chain", 'C'));
914
915       --  Nothing to do if From is empty, and we can check that without
916       --  deferring aborts.
917
918       C := From.all.T_ID;
919
920       if C = null then
921          return;
922       end if;
923
924       Initialization.Defer_Abort (Self_ID);
925
926       --  Loop through the From chain, changing their Master_of_Task
927       --  fields, and to find the end of the chain.
928
929       loop
930          C.Master_of_Task := New_Master;
931          exit when C.Common.Activation_Link = null;
932          C := C.Common.Activation_Link;
933       end loop;
934
935       --  Hook From in at the start of To
936
937       C.Common.Activation_Link := To.all.T_ID;
938       To.all.T_ID := From.all.T_ID;
939
940       --  Set From to empty
941
942       From.all.T_ID := null;
943
944       Initialization.Undefer_Abort (Self_ID);
945    end Move_Activation_Chain;
946
947    ------------------
948    -- Task_Wrapper --
949    ------------------
950
951    --  The task wrapper is a procedure that is called first for each task
952    --  task body, and which in turn calls the compiler-generated task body
953    --  procedure. The wrapper's main job is to do initialization for the task.
954    --  It also has some locally declared objects that server as per-task local
955    --  data. Task finalization is done by Complete_Task, which is called from
956    --  an at-end handler that the compiler generates.
957
958    procedure Task_Wrapper (Self_ID : Task_Id) is
959       use type SSE.Storage_Offset;
960       use System.Standard_Library;
961       use System.Stack_Usage;
962
963       Bottom_Of_Stack : aliased Integer;
964
965       Secondary_Stack_Size :
966         constant SSE.Storage_Offset :=
967           Self_ID.Common.Compiler_Data.Pri_Stack_Info.Size *
968           SSE.Storage_Offset (Parameters.Sec_Stack_Ratio) / 100;
969
970       Secondary_Stack : aliased SSE.Storage_Array (1 .. Secondary_Stack_Size);
971
972       pragma Warnings (Off);
973       --  Why are warnings being turned off here???
974
975       Secondary_Stack_Address : System.Address := Secondary_Stack'Address;
976
977       Small_Overflow_Guard : constant := 12 * 1024;
978       --  Note: this used to be 4K, but was changed to 12K, since smaller
979       --  values resulted in segmentation faults from dynamic stack analysis.
980
981       Big_Overflow_Guard   : constant := 16 * 1024;
982       Small_Stack_Limit    : constant := 64 * 1024;
983       --  ??? These three values are experimental, and seems to work on most
984       --  platforms. They still need to be analyzed further. They also need
985       --  documentation, what are they???
986
987       Size : Natural :=
988                Natural (Self_ID.Common.Compiler_Data.Pri_Stack_Info.Size);
989
990       Overflow_Guard : Natural;
991       --  Size of the overflow guard, used by dynamic stack usage analysis
992
993       pragma Warnings (On);
994       --  Address of secondary stack. In the fixed secondary stack case, this
995       --  value is not modified, causing a warning, hence the bracketing with
996       --  Warnings (Off/On). But why is so much *more* bracketed ???
997
998       SEH_Table : aliased SSE.Storage_Array (1 .. 8);
999       --  Structured Exception Registration table (2 words)
1000
1001       procedure Install_SEH_Handler (Addr : System.Address);
1002       pragma Import (C, Install_SEH_Handler, "__gnat_install_SEH_handler");
1003       --  Install the SEH (Structured Exception Handling) handler
1004
1005       Cause : Cause_Of_Termination := Normal;
1006       --  Indicates the reason why this task terminates. Normal corresponds to
1007       --  a task terminating due to completing the last statement of its body,
1008       --  or as a result of waiting on a terminate alternative. If the task
1009       --  terminates because it is being aborted then Cause will be set to
1010       --  Abnormal. If the task terminates because of an exception raised by
1011       --  the execution of its task body, then Cause is set to
1012       --  Unhandled_Exception.
1013
1014       EO : Exception_Occurrence;
1015       --  If the task terminates because of an exception raised by the
1016       --  execution of its task body, then EO will contain the associated
1017       --  exception occurrence. Otherwise, it will contain Null_Occurrence.
1018
1019       TH : Termination_Handler := null;
1020       --  Pointer to the protected procedure to be executed upon task
1021       --  termination.
1022
1023       procedure Search_Fall_Back_Handler (ID : Task_Id);
1024       --  Procedure that searches recursively a fall-back handler through the
1025       --  master relationship. If the handler is found, its pointer is stored
1026       --  in TH.
1027
1028       ------------------------------
1029       -- Search_Fall_Back_Handler --
1030       ------------------------------
1031
1032       procedure Search_Fall_Back_Handler (ID : Task_Id) is
1033       begin
1034          --  If there is a fall back handler, store its pointer for later
1035          --  execution.
1036
1037          if ID.Common.Fall_Back_Handler /= null then
1038             TH := ID.Common.Fall_Back_Handler;
1039
1040          --  Otherwise look for a fall back handler in the parent
1041
1042          elsif ID.Common.Parent /= null then
1043             Search_Fall_Back_Handler (ID.Common.Parent);
1044
1045          --  Otherwise, do nothing
1046
1047          else
1048             return;
1049          end if;
1050       end Search_Fall_Back_Handler;
1051
1052    begin
1053       pragma Assert (Self_ID.Deferral_Level = 1);
1054
1055       --  Assume a size of the stack taken at this stage
1056
1057       if Size < Small_Stack_Limit then
1058          Overflow_Guard := Small_Overflow_Guard;
1059       else
1060          Overflow_Guard := Big_Overflow_Guard;
1061       end if;
1062
1063       Size := Size - Overflow_Guard;
1064
1065       if not Parameters.Sec_Stack_Dynamic then
1066          Self_ID.Common.Compiler_Data.Sec_Stack_Addr :=
1067            Secondary_Stack'Address;
1068          SST.SS_Init (Secondary_Stack_Address, Integer (Secondary_Stack'Last));
1069          Size := Size - Natural (Secondary_Stack_Size);
1070       end if;
1071
1072       if System.Stack_Usage.Is_Enabled then
1073          STPO.Lock_RTS;
1074          Initialize_Analyzer (Self_ID.Common.Analyzer,
1075                               Self_ID.Common.Task_Image
1076                                 (1 .. Self_ID.Common.Task_Image_Len),
1077                               Size,
1078                               Overflow_Guard,
1079                               SSE.To_Integer (Bottom_Of_Stack'Address));
1080          STPO.Unlock_RTS;
1081          Fill_Stack (Self_ID.Common.Analyzer);
1082       end if;
1083
1084       --  Set the guard page at the bottom of the stack. The call to unprotect
1085       --  the page is done in Terminate_Task
1086
1087       Stack_Guard (Self_ID, True);
1088
1089       --  Initialize low-level TCB components, that cannot be initialized
1090       --  by the creator. Enter_Task sets Self_ID.Known_Tasks_Index and
1091       --  also Self_ID.LL.Thread
1092
1093       Enter_Task (Self_ID);
1094
1095       --  We setup the SEH (Structured Exception Handling) handler if supported
1096       --  on the target.
1097
1098       Install_SEH_Handler (SEH_Table'Address);
1099
1100       --  Initialize exception occurrence
1101
1102       Save_Occurrence (EO, Ada.Exceptions.Null_Occurrence);
1103
1104       --  We lock RTS_Lock to wait for activator to finish activating the rest
1105       --  of the chain, so that everyone in the chain comes out in priority
1106       --  order.
1107
1108       --  This also protects the value of
1109       --    Self_ID.Common.Activator.Common.Wait_Count.
1110
1111       Lock_RTS;
1112       Unlock_RTS;
1113
1114       if not System.Restrictions.Abort_Allowed then
1115
1116          --  If Abort is not allowed, reset the deferral level since it will
1117          --  not get changed by the generated code. Keeping a default value
1118          --  of one would prevent some operations (e.g. select or delay) to
1119          --  proceed successfully.
1120
1121          Self_ID.Deferral_Level := 0;
1122       end if;
1123
1124       begin
1125          --  We are separating the following portion of the code in order to
1126          --  place the exception handlers in a different block. In this way,
1127          --  we do not call Set_Jmpbuf_Address (which needs Self) before we
1128          --  set Self in Enter_Task
1129
1130          --  Call the task body procedure
1131
1132          --  The task body is called with abort still deferred. That
1133          --  eliminates a dangerous window, for which we had to patch-up in
1134          --  Terminate_Task.
1135
1136          --  During the expansion of the task body, we insert an RTS-call
1137          --  to Abort_Undefer, at the first point where abort should be
1138          --  allowed.
1139
1140          Self_ID.Common.Task_Entry_Point (Self_ID.Common.Task_Arg);
1141          Initialization.Defer_Abort_Nestable (Self_ID);
1142
1143       exception
1144          --  We can't call Terminate_Task in the exception handlers below,
1145          --  since there may be (e.g. in the case of GCC exception handling)
1146          --  clean ups associated with the exception handler that need to
1147          --  access task specific data.
1148
1149          --  Defer abort so that this task can't be aborted while exiting
1150
1151          when Standard'Abort_Signal =>
1152             Initialization.Defer_Abort_Nestable (Self_ID);
1153
1154             --  Update the cause that motivated the task termination so that
1155             --  the appropriate information is passed to the task termination
1156             --  procedure. Task termination as a result of waiting on a
1157             --  terminate alternative is a normal termination, although it is
1158             --  implemented using the abort mechanisms.
1159
1160             if Self_ID.Terminate_Alternative then
1161                Cause := Normal;
1162             else
1163                Cause := Abnormal;
1164             end if;
1165          when others =>
1166             --  ??? Using an E : others here causes CD2C11A to fail on Tru64.
1167
1168             Initialization.Defer_Abort_Nestable (Self_ID);
1169
1170             --  Perform the task specific exception tracing duty.  We handle
1171             --  these outputs here and not in the common notification routine
1172             --  because we need access to tasking related data and we don't
1173             --  want to drag dependencies against tasking related units in the
1174             --  the common notification units. Additionally, no trace is ever
1175             --  triggered from the common routine for the Unhandled_Raise case
1176             --  in tasks, since an exception never appears unhandled in this
1177             --  context because of this handler.
1178
1179             if Exception_Trace = Unhandled_Raise then
1180                Trace_Unhandled_Exception_In_Task (Self_ID);
1181             end if;
1182
1183             --  Update the cause that motivated the task termination so that
1184             --  the appropriate information is passed to the task termination
1185             --  procedure, as well as the associated Exception_Occurrence.
1186
1187             Cause := Unhandled_Exception;
1188             Save_Occurrence (EO, SSL.Get_Current_Excep.all.all);
1189       end;
1190
1191       --  Look for a task termination handler. This code is for all tasks but
1192       --  the environment task. The task termination code for the environment
1193       --  task is executed by SSL.Task_Termination_Handler.
1194
1195       if Single_Lock then
1196          Lock_RTS;
1197       end if;
1198
1199       Write_Lock (Self_ID);
1200
1201       if Self_ID.Common.Specific_Handler /= null then
1202          TH := Self_ID.Common.Specific_Handler;
1203       else
1204          --  Look for a fall-back handler following the master relationship
1205          --  for the task.
1206
1207          Search_Fall_Back_Handler (Self_ID);
1208       end if;
1209
1210       Unlock (Self_ID);
1211
1212       if Single_Lock then
1213          Unlock_RTS;
1214       end if;
1215
1216       --  Execute the task termination handler if we found it
1217
1218       if TH /= null then
1219          TH.all (Cause, Self_ID, EO);
1220       end if;
1221
1222       if System.Stack_Usage.Is_Enabled then
1223          Compute_Result (Self_ID.Common.Analyzer);
1224          Report_Result (Self_ID.Common.Analyzer);
1225       end if;
1226
1227       Terminate_Task (Self_ID);
1228    end Task_Wrapper;
1229
1230    --------------------
1231    -- Terminate_Task --
1232    --------------------
1233
1234    --  Before we allow the thread to exit, we must clean up. This is a
1235    --  a delicate job. We must wake up the task's master, who may immediately
1236    --  try to deallocate the ATCB out from under the current task WHILE IT IS
1237    --  STILL EXECUTING.
1238
1239    --  To avoid this, the parent task must be blocked up to the latest
1240    --  statement executed. The trouble is that we have another step that we
1241    --  also want to postpone to the very end, i.e., calling SSL.Destroy_TSD.
1242    --  We have to postpone that until the end because compiler-generated code
1243    --  is likely to try to access that data at just about any point.
1244
1245    --  We can't call Destroy_TSD while we are holding any other locks, because
1246    --  it locks Global_Task_Lock, and our deadlock prevention rules require
1247    --  that to be the outermost lock. Our first "solution" was to just lock
1248    --  Global_Task_Lock in addition to the other locks, and force the parent to
1249    --  also lock this lock between its wakeup and its freeing of the ATCB. See
1250    --  Complete_Task for the parent-side of the code that has the matching
1251    --  calls to Task_Lock and Task_Unlock. That was not really a solution,
1252    --  since the operation Task_Unlock continued to access the ATCB after
1253    --  unlocking, after which the parent was observed to race ahead, deallocate
1254    --  the ATCB, and then reallocate it to another task. The call to
1255    --  Undefer_Abort in Task_Unlock by the "terminated" task was overwriting
1256    --  the data of the new task that reused the ATCB! To solve this problem, we
1257    --  introduced the new operation Final_Task_Unlock.
1258
1259    procedure Terminate_Task (Self_ID : Task_Id) is
1260       Environment_Task : constant Task_Id := STPO.Environment_Task;
1261       Master_of_Task   : Integer;
1262
1263    begin
1264       Debug.Task_Termination_Hook;
1265
1266       if Runtime_Traces then
1267          Send_Trace_Info (T_Terminate);
1268       end if;
1269
1270       --  Since GCC cannot allocate stack chunks efficiently without reordering
1271       --  some of the allocations, we have to handle this unexpected situation
1272       --  here. We should normally never have to call Vulnerable_Complete_Task
1273       --  here.
1274
1275       if Self_ID.Common.Activator /= null then
1276          Vulnerable_Complete_Task (Self_ID);
1277       end if;
1278
1279       Initialization.Task_Lock (Self_ID);
1280
1281       if Single_Lock then
1282          Lock_RTS;
1283       end if;
1284
1285       Master_of_Task := Self_ID.Master_of_Task;
1286
1287       --  Check if the current task is an independent task If so, decrement
1288       --  the Independent_Task_Count value.
1289
1290       if Master_of_Task = Independent_Task_Level then
1291          if Single_Lock then
1292             Utilities.Independent_Task_Count :=
1293               Utilities.Independent_Task_Count - 1;
1294          else
1295             Write_Lock (Environment_Task);
1296             Utilities.Independent_Task_Count :=
1297               Utilities.Independent_Task_Count - 1;
1298             Unlock (Environment_Task);
1299          end if;
1300       end if;
1301
1302       --  Unprotect the guard page if needed
1303
1304       Stack_Guard (Self_ID, False);
1305
1306       Utilities.Make_Passive (Self_ID, Task_Completed => True);
1307
1308       if Single_Lock then
1309          Unlock_RTS;
1310       end if;
1311
1312       pragma Assert (Check_Exit (Self_ID));
1313
1314       SSL.Destroy_TSD (Self_ID.Common.Compiler_Data);
1315       Initialization.Final_Task_Unlock (Self_ID);
1316
1317       --  WARNING: past this point, this thread must assume that the ATCB
1318       --  has been deallocated. It should not be accessed again.
1319
1320       if Master_of_Task > 0 then
1321          STPO.Exit_Task;
1322       end if;
1323    end Terminate_Task;
1324
1325    ----------------
1326    -- Terminated --
1327    ----------------
1328
1329    function Terminated (T : Task_Id) return Boolean is
1330       Self_ID : constant Task_Id := STPO.Self;
1331       Result  : Boolean;
1332
1333    begin
1334       Initialization.Defer_Abort_Nestable (Self_ID);
1335
1336       if Single_Lock then
1337          Lock_RTS;
1338       end if;
1339
1340       Write_Lock (T);
1341       Result := T.Common.State = Terminated;
1342       Unlock (T);
1343
1344       if Single_Lock then
1345          Unlock_RTS;
1346       end if;
1347
1348       Initialization.Undefer_Abort_Nestable (Self_ID);
1349       return Result;
1350    end Terminated;
1351
1352    ----------------------------------------
1353    -- Trace_Unhandled_Exception_In_Task --
1354    ----------------------------------------
1355
1356    procedure Trace_Unhandled_Exception_In_Task (Self_Id : Task_Id) is
1357       procedure To_Stderr (S : String);
1358       pragma Import (Ada, To_Stderr, "__gnat_to_stderr");
1359
1360       use System.Soft_Links;
1361       use System.Standard_Library;
1362
1363       function To_Address is new
1364         Ada.Unchecked_Conversion (Task_Id, System.Address);
1365
1366       function Tailored_Exception_Information
1367         (E : Exception_Occurrence) return String;
1368       pragma Import
1369         (Ada, Tailored_Exception_Information,
1370          "__gnat_tailored_exception_information");
1371
1372       Excep : constant Exception_Occurrence_Access :=
1373                 SSL.Get_Current_Excep.all;
1374
1375    begin
1376       --  This procedure is called by the task outermost handler in
1377       --  Task_Wrapper below, so only once the task stack has been fully
1378       --  unwound. The common notification routine has been called at the
1379       --  raise point already.
1380
1381       To_Stderr ("task ");
1382
1383       if Self_Id.Common.Task_Image_Len /= 0 then
1384          To_Stderr
1385            (Self_Id.Common.Task_Image (1 .. Self_Id.Common.Task_Image_Len));
1386          To_Stderr ("_");
1387       end if;
1388
1389       To_Stderr (System.Address_Image (To_Address (Self_Id)));
1390       To_Stderr (" terminated by unhandled exception");
1391       To_Stderr ((1 => ASCII.LF));
1392       To_Stderr (Tailored_Exception_Information (Excep.all));
1393    end Trace_Unhandled_Exception_In_Task;
1394
1395    ------------------------------------
1396    -- Vulnerable_Complete_Activation --
1397    ------------------------------------
1398
1399    --  As in several other places, the locks of the activator and activated
1400    --  task are both locked here. This follows our deadlock prevention lock
1401    --  ordering policy, since the activated task must be created after the
1402    --  activator.
1403
1404    procedure Vulnerable_Complete_Activation (Self_ID : Task_Id) is
1405       Activator : constant Task_Id := Self_ID.Common.Activator;
1406
1407    begin
1408       pragma Debug (Debug.Trace (Self_ID, "V_Complete_Activation", 'C'));
1409
1410       Write_Lock (Activator);
1411       Write_Lock (Self_ID);
1412
1413       pragma Assert (Self_ID.Common.Activator /= null);
1414
1415       --  Remove dangling reference to Activator, since a task may
1416       --  outlive its activator.
1417
1418       Self_ID.Common.Activator := null;
1419
1420       --  Wake up the activator, if it is waiting for a chain of tasks to
1421       --  activate, and we are the last in the chain to complete activation.
1422
1423       if Activator.Common.State = Activator_Sleep then
1424          Activator.Common.Wait_Count := Activator.Common.Wait_Count - 1;
1425
1426          if Activator.Common.Wait_Count = 0 then
1427             Wakeup (Activator, Activator_Sleep);
1428          end if;
1429       end if;
1430
1431       --  The activator raises a Tasking_Error if any task it is activating
1432       --  is completed before the activation is done. However, if the reason
1433       --  for the task completion is an abort, we do not raise an exception.
1434       --  See RM 9.2(5).
1435
1436       if not Self_ID.Callable and then Self_ID.Pending_ATC_Level /= 0 then
1437          Activator.Common.Activation_Failed := True;
1438       end if;
1439
1440       Unlock (Self_ID);
1441       Unlock (Activator);
1442
1443       --  After the activation, active priority should be the same
1444       --  as base priority. We must unlock the Activator first,
1445       --  though, since it should not wait if we have lower priority.
1446
1447       if Get_Priority (Self_ID) /= Self_ID.Common.Base_Priority then
1448          Write_Lock (Self_ID);
1449          Set_Priority (Self_ID, Self_ID.Common.Base_Priority);
1450          Unlock (Self_ID);
1451       end if;
1452    end Vulnerable_Complete_Activation;
1453
1454    --------------------------------
1455    -- Vulnerable_Complete_Master --
1456    --------------------------------
1457
1458    procedure Vulnerable_Complete_Master (Self_ID : Task_Id) is
1459       C      : Task_Id;
1460       P      : Task_Id;
1461       CM     : constant Master_Level := Self_ID.Master_Within;
1462       T      : aliased Task_Id;
1463
1464       To_Be_Freed : Task_Id;
1465       --  This is a list of ATCBs to be freed, after we have released
1466       --  all RTS locks. This is necessary because of the locking order
1467       --  rules, since the storage manager uses Global_Task_Lock.
1468
1469       pragma Warnings (Off);
1470       function Check_Unactivated_Tasks return Boolean;
1471       pragma Warnings (On);
1472       --  Temporary error-checking code below. This is part of the checks
1473       --  added in the new run time. Call it only inside a pragma Assert.
1474
1475       -----------------------------
1476       -- Check_Unactivated_Tasks --
1477       -----------------------------
1478
1479       function Check_Unactivated_Tasks return Boolean is
1480       begin
1481          if not Single_Lock then
1482             Lock_RTS;
1483          end if;
1484
1485          Write_Lock (Self_ID);
1486
1487          C := All_Tasks_List;
1488          while C /= null loop
1489             if C.Common.Activator = Self_ID and then C.Master_of_Task = CM then
1490                return False;
1491             end if;
1492
1493             if C.Common.Parent = Self_ID and then C.Master_of_Task = CM then
1494                Write_Lock (C);
1495
1496                if C.Common.State = Unactivated then
1497                   return False;
1498                end if;
1499
1500                Unlock (C);
1501             end if;
1502
1503             C := C.Common.All_Tasks_Link;
1504          end loop;
1505
1506          Unlock (Self_ID);
1507
1508          if not Single_Lock then
1509             Unlock_RTS;
1510          end if;
1511
1512          return True;
1513       end Check_Unactivated_Tasks;
1514
1515    --  Start of processing for Vulnerable_Complete_Master
1516
1517    begin
1518       pragma Debug
1519         (Debug.Trace (Self_ID, "V_Complete_Master", 'C'));
1520
1521       pragma Assert (Self_ID.Common.Wait_Count = 0);
1522       pragma Assert
1523         (Self_ID.Deferral_Level > 0
1524           or else not System.Restrictions.Abort_Allowed);
1525
1526       --  Count how many active dependent tasks this master currently
1527       --  has, and record this in Wait_Count.
1528
1529       --  This count should start at zero, since it is initialized to
1530       --  zero for new tasks, and the task should not exit the
1531       --  sleep-loops that use this count until the count reaches zero.
1532
1533       --  While we're counting, if we run across any unactivated tasks that
1534       --  belong to this master, we summarily terminate them as required by
1535       --  RM-9.2(6).
1536
1537       Lock_RTS;
1538       Write_Lock (Self_ID);
1539
1540       C := All_Tasks_List;
1541       while C /= null loop
1542
1543          --  Terminate unactivated (never-to-be activated) tasks
1544
1545          if C.Common.Activator = Self_ID and then C.Master_of_Task = CM then
1546             pragma Assert (C.Common.State = Unactivated);
1547             --  Usually, C.Common.Activator = Self_ID implies C.Master_of_Task
1548             --  = CM. The only case where C is pending activation by this
1549             --  task, but the master of C is not CM is in Ada 2005, when C is
1550             --  part of a return object of a build-in-place function.
1551
1552             Write_Lock (C);
1553             C.Common.Activator := null;
1554             C.Common.State := Terminated;
1555             C.Callable := False;
1556             Utilities.Cancel_Queued_Entry_Calls (C);
1557             Unlock (C);
1558          end if;
1559
1560          --  Count it if dependent on this master
1561
1562          if C.Common.Parent = Self_ID and then C.Master_of_Task = CM then
1563             Write_Lock (C);
1564
1565             if C.Awake_Count /= 0 then
1566                Self_ID.Common.Wait_Count := Self_ID.Common.Wait_Count + 1;
1567             end if;
1568
1569             Unlock (C);
1570          end if;
1571
1572          C := C.Common.All_Tasks_Link;
1573       end loop;
1574
1575       Self_ID.Common.State := Master_Completion_Sleep;
1576       Unlock (Self_ID);
1577
1578       if not Single_Lock then
1579          Unlock_RTS;
1580       end if;
1581
1582       --  Wait until dependent tasks are all terminated or ready to terminate.
1583       --  While waiting, the task may be awakened if the task's priority needs
1584       --  changing, or this master is aborted. In the latter case, we want
1585       --  to abort the dependents, and resume waiting until Wait_Count goes
1586       --  to zero.
1587
1588       Write_Lock (Self_ID);
1589
1590       loop
1591          exit when Self_ID.Common.Wait_Count = 0;
1592
1593          --  Here is a difference as compared to Complete_Master
1594
1595          if Self_ID.Pending_ATC_Level < Self_ID.ATC_Nesting_Level
1596            and then not Self_ID.Dependents_Aborted
1597          then
1598             if Single_Lock then
1599                Abort_Dependents (Self_ID);
1600             else
1601                Unlock (Self_ID);
1602                Lock_RTS;
1603                Abort_Dependents (Self_ID);
1604                Unlock_RTS;
1605                Write_Lock (Self_ID);
1606             end if;
1607          else
1608             Sleep (Self_ID, Master_Completion_Sleep);
1609          end if;
1610       end loop;
1611
1612       Self_ID.Common.State := Runnable;
1613       Unlock (Self_ID);
1614
1615       --  Dependents are all terminated or on terminate alternatives.
1616       --  Now, force those on terminate alternatives to terminate, by
1617       --  aborting them.
1618
1619       pragma Assert (Check_Unactivated_Tasks);
1620
1621       if Self_ID.Alive_Count > 1 then
1622          --  ???
1623          --  Consider finding a way to skip the following extra steps if there
1624          --  are no dependents with terminate alternatives. This could be done
1625          --  by adding another count to the ATCB, similar to Awake_Count, but
1626          --  keeping track of tasks that are on terminate alternatives.
1627
1628          pragma Assert (Self_ID.Common.Wait_Count = 0);
1629
1630          --  Force any remaining dependents to terminate by aborting them
1631
1632          if not Single_Lock then
1633             Lock_RTS;
1634          end if;
1635
1636          Abort_Dependents (Self_ID);
1637
1638          --  Above, when we "abort" the dependents we are simply using this
1639          --  operation for convenience. We are not required to support the full
1640          --  abort-statement semantics; in particular, we are not required to
1641          --  immediately cancel any queued or in-service entry calls. That is
1642          --  good, because if we tried to cancel a call we would need to lock
1643          --  the caller, in order to wake the caller up. Our anti-deadlock
1644          --  rules prevent us from doing that without releasing the locks on C
1645          --  and Self_ID. Releasing and retaking those locks would be wasteful
1646          --  at best, and should not be considered further without more
1647          --  detailed analysis of potential concurrent accesses to the
1648          --  ATCBs of C and Self_ID.
1649
1650          --  Count how many "alive" dependent tasks this master currently
1651          --  has, and record this in Wait_Count. This count should start at
1652          --  zero, since it is initialized to zero for new tasks, and the
1653          --  task should not exit the sleep-loops that use this count until
1654          --  the count reaches zero.
1655
1656          pragma Assert (Self_ID.Common.Wait_Count = 0);
1657
1658          Write_Lock (Self_ID);
1659
1660          C := All_Tasks_List;
1661          while C /= null loop
1662             if C.Common.Parent = Self_ID and then C.Master_of_Task = CM then
1663                Write_Lock (C);
1664
1665                pragma Assert (C.Awake_Count = 0);
1666
1667                if C.Alive_Count > 0 then
1668                   pragma Assert (C.Terminate_Alternative);
1669                   Self_ID.Common.Wait_Count := Self_ID.Common.Wait_Count + 1;
1670                end if;
1671
1672                Unlock (C);
1673             end if;
1674
1675             C := C.Common.All_Tasks_Link;
1676          end loop;
1677
1678          Self_ID.Common.State := Master_Phase_2_Sleep;
1679          Unlock (Self_ID);
1680
1681          if not Single_Lock then
1682             Unlock_RTS;
1683          end if;
1684
1685          --  Wait for all counted tasks to finish terminating themselves
1686
1687          Write_Lock (Self_ID);
1688
1689          loop
1690             exit when Self_ID.Common.Wait_Count = 0;
1691             Sleep (Self_ID, Master_Phase_2_Sleep);
1692          end loop;
1693
1694          Self_ID.Common.State := Runnable;
1695          Unlock (Self_ID);
1696       end if;
1697
1698       --  We don't wake up for abort here. We are already terminating just as
1699       --  fast as we can, so there is no point.
1700
1701       --  Remove terminated tasks from the list of Self_ID's dependents, but
1702       --  don't free their ATCBs yet, because of lock order restrictions,
1703       --  which don't allow us to call "free" or "malloc" while holding any
1704       --  other locks. Instead, we put those ATCBs to be freed onto a
1705       --  temporary list, called To_Be_Freed.
1706
1707       if not Single_Lock then
1708          Lock_RTS;
1709       end if;
1710
1711       C := All_Tasks_List;
1712       P := null;
1713       while C /= null loop
1714          if C.Common.Parent = Self_ID and then C.Master_of_Task >= CM then
1715             if P /= null then
1716                P.Common.All_Tasks_Link := C.Common.All_Tasks_Link;
1717             else
1718                All_Tasks_List := C.Common.All_Tasks_Link;
1719             end if;
1720
1721             T := C.Common.All_Tasks_Link;
1722             C.Common.All_Tasks_Link := To_Be_Freed;
1723             To_Be_Freed := C;
1724             C := T;
1725
1726          else
1727             P := C;
1728             C := C.Common.All_Tasks_Link;
1729          end if;
1730       end loop;
1731
1732       Unlock_RTS;
1733
1734       --  Free all the ATCBs on the list To_Be_Freed
1735
1736       --  The ATCBs in the list are no longer in All_Tasks_List, and after
1737       --  any interrupt entries are detached from them they should no longer
1738       --  be referenced.
1739
1740       --  Global_Task_Lock (Task_Lock/Unlock) is locked in the loop below to
1741       --  avoid a race between a terminating task and its parent. The parent
1742       --  might try to deallocate the ACTB out from underneath the exiting
1743       --  task. Note that Free will also lock Global_Task_Lock, but that is
1744       --  OK, since this is the *one* lock for which we have a mechanism to
1745       --  support nested locking. See Task_Wrapper and its finalizer for more
1746       --  explanation.
1747
1748       --  ???
1749       --  The check "T.Common.Parent /= null ..." below is to prevent dangling
1750       --  references to terminated library-level tasks, which could
1751       --  otherwise occur during finalization of library-level objects.
1752       --  A better solution might be to hook task objects into the
1753       --  finalization chain and deallocate the ATCB when the task
1754       --  object is deallocated. However, this change is not likely
1755       --  to gain anything significant, since all this storage should
1756       --  be recovered en-masse when the process exits.
1757
1758       while To_Be_Freed /= null loop
1759          T := To_Be_Freed;
1760          To_Be_Freed := T.Common.All_Tasks_Link;
1761
1762          --  ??? On SGI there is currently no Interrupt_Manager, that's
1763          --  why we need to check if the Interrupt_Manager_ID is null
1764
1765          if T.Interrupt_Entry and Interrupt_Manager_ID /= null then
1766             declare
1767                Detach_Interrupt_Entries_Index : constant Task_Entry_Index := 1;
1768                --  Corresponds to the entry index of System.Interrupts.
1769                --  Interrupt_Manager.Detach_Interrupt_Entries.
1770                --  Be sure to update this value when changing
1771                --  Interrupt_Manager specs.
1772
1773                type Param_Type is access all Task_Id;
1774
1775                Param : aliased Param_Type := T'Access;
1776
1777             begin
1778                System.Tasking.Rendezvous.Call_Simple
1779                  (Interrupt_Manager_ID, Detach_Interrupt_Entries_Index,
1780                   Param'Address);
1781             end;
1782          end if;
1783
1784          if (T.Common.Parent /= null
1785               and then T.Common.Parent.Common.Parent /= null)
1786            or else T.Master_of_Task > Library_Task_Level
1787          then
1788             Initialization.Task_Lock (Self_ID);
1789
1790             --  If Sec_Stack_Addr is not null, it means that Destroy_TSD
1791             --  has not been called yet (case of an unactivated task).
1792
1793             if T.Common.Compiler_Data.Sec_Stack_Addr /= Null_Address then
1794                SSL.Destroy_TSD (T.Common.Compiler_Data);
1795             end if;
1796
1797             Vulnerable_Free_Task (T);
1798             Initialization.Task_Unlock (Self_ID);
1799          end if;
1800       end loop;
1801
1802       --  It might seem nice to let the terminated task deallocate its own
1803       --  ATCB. That would not cover the case of unactivated tasks. It also
1804       --  would force us to keep the underlying thread around past termination,
1805       --  since references to the ATCB are possible past termination.
1806       --  Currently, we get rid of the thread as soon as the task terminates,
1807       --  and let the parent recover the ATCB later.
1808
1809       --  Some day, if we want to recover the ATCB earlier, at task
1810       --  termination, we could consider using "fat task IDs", that include the
1811       --  serial number with the ATCB pointer, to catch references to tasks
1812       --  that no longer have ATCBs. It is not clear how much this would gain,
1813       --  since the user-level task object would still be occupying storage.
1814
1815       --  Make next master level up active.
1816       --  We don't need to lock the ATCB, since the value is only updated by
1817       --  each task for itself.
1818
1819       Self_ID.Master_Within := CM - 1;
1820    end Vulnerable_Complete_Master;
1821
1822    ------------------------------
1823    -- Vulnerable_Complete_Task --
1824    ------------------------------
1825
1826    --  Complete the calling task
1827
1828    --  This procedure must be called with abort deferred. It should only be
1829    --  called by Complete_Task and Finalize_Global_Tasks (for the environment
1830    --  task).
1831
1832    --  The effect is similar to that of Complete_Master. Differences include
1833    --  the closing of entries here, and computation of the number of active
1834    --  dependent tasks in Complete_Master.
1835
1836    --  We don't lock Self_ID before the call to Vulnerable_Complete_Activation,
1837    --  because that does its own locking, and because we do not need the lock
1838    --  to test Self_ID.Common.Activator. That value should only be read and
1839    --  modified by Self.
1840
1841    procedure Vulnerable_Complete_Task (Self_ID : Task_Id) is
1842    begin
1843       pragma Assert
1844         (Self_ID.Deferral_Level > 0
1845           or else not System.Restrictions.Abort_Allowed);
1846       pragma Assert (Self_ID = Self);
1847       pragma Assert (Self_ID.Master_Within = Self_ID.Master_of_Task + 1
1848                        or else
1849                      Self_ID.Master_Within = Self_ID.Master_of_Task + 2);
1850       pragma Assert (Self_ID.Common.Wait_Count = 0);
1851       pragma Assert (Self_ID.Open_Accepts = null);
1852       pragma Assert (Self_ID.ATC_Nesting_Level = 1);
1853
1854       pragma Debug (Debug.Trace (Self_ID, "V_Complete_Task", 'C'));
1855
1856       if Single_Lock then
1857          Lock_RTS;
1858       end if;
1859
1860       Write_Lock (Self_ID);
1861       Self_ID.Callable := False;
1862
1863       --  In theory, Self should have no pending entry calls left on its
1864       --  call-stack. Each async. select statement should clean its own call,
1865       --  and blocking entry calls should defer abort until the calls are
1866       --  cancelled, then clean up.
1867
1868       Utilities.Cancel_Queued_Entry_Calls (Self_ID);
1869       Unlock (Self_ID);
1870
1871       if Self_ID.Common.Activator /= null then
1872          Vulnerable_Complete_Activation (Self_ID);
1873       end if;
1874
1875       if Single_Lock then
1876          Unlock_RTS;
1877       end if;
1878
1879       --  If Self_ID.Master_Within = Self_ID.Master_of_Task + 2
1880       --  we may have dependent tasks for which we need to wait.
1881       --  Otherwise, we can just exit.
1882
1883       if Self_ID.Master_Within = Self_ID.Master_of_Task + 2 then
1884          Vulnerable_Complete_Master (Self_ID);
1885       end if;
1886    end Vulnerable_Complete_Task;
1887
1888    --------------------------
1889    -- Vulnerable_Free_Task --
1890    --------------------------
1891
1892    --  Recover all runtime system storage associated with the task T.
1893    --  This should only be called after T has terminated and will no
1894    --  longer be referenced.
1895
1896    --  For tasks created by an allocator that fails, due to an exception,
1897    --  it is called from Expunge_Unactivated_Tasks.
1898
1899    --  For tasks created by elaboration of task object declarations it
1900    --  is called from the finalization code of the Task_Wrapper procedure.
1901    --  It is also called from Ada.Unchecked_Deallocation, for objects that
1902    --  are or contain tasks.
1903
1904    procedure Vulnerable_Free_Task (T : Task_Id) is
1905    begin
1906       pragma Debug (Debug.Trace (Self, "Vulnerable_Free_Task", 'C', T));
1907
1908       if Single_Lock then
1909          Lock_RTS;
1910       end if;
1911
1912       Write_Lock (T);
1913       Initialization.Finalize_Attributes_Link.all (T);
1914       Unlock (T);
1915
1916       if Single_Lock then
1917          Unlock_RTS;
1918       end if;
1919
1920       System.Task_Primitives.Operations.Finalize_TCB (T);
1921    end Vulnerable_Free_Task;
1922
1923 --  Package elaboration code
1924
1925 begin
1926    --  Establish the Adafinal softlink
1927
1928    --  This is not done inside the central RTS initialization routine
1929    --  to avoid with-ing this package from System.Tasking.Initialization.
1930
1931    SSL.Adafinal := Finalize_Global_Tasks'Access;
1932
1933    --  Establish soft links for subprograms that manipulate master_id's.
1934    --  This cannot be done when the RTS is initialized, because of various
1935    --  elaboration constraints.
1936
1937    SSL.Current_Master  := Stages.Current_Master'Access;
1938    SSL.Enter_Master    := Stages.Enter_Master'Access;
1939    SSL.Complete_Master := Stages.Complete_Master'Access;
1940 end System.Tasking.Stages;