Merged with mainline at revision 128810.
[official-gcc.git] / gcc / ada / s-tassta.adb
bloba50b3795871f4166a57867ae0ed16f75ba964745
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 ------------------------------------------------------------------------------
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.
38 with Ada.Exceptions;
39 -- Used for Raise_Exception
41 with System.Tasking.Debug;
42 -- Used for enabling tasking facilities with gdb
44 with System.Address_Image;
45 -- Used for the function itself
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
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.
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
72 pragma Elaborate_All (System.Tasking.Initialization);
73 -- This insures that tasking is initialized if any tasks are created
75 with System.Tasking.Utilities;
76 -- Used for Make_Passive
77 -- Abort_One_Task
78 -- Abort_Tasks
80 with System.Tasking.Queuing;
81 -- Used for Dequeue_Head
83 with System.Tasking.Rendezvous;
84 -- Used for Call_Simple
86 with System.OS_Primitives;
87 -- Used for Delay_Modes
89 with System.Secondary_Stack;
90 -- Used for SS_Init
92 with System.Storage_Elements;
93 -- Used for Storage_Array
95 with System.Restrictions;
96 -- Used for Abort_Allowed
98 with System.Standard_Library;
99 -- Used for Exception_Trace
101 with System.Traces.Tasking;
102 -- Used for Send_Trace_Info
104 with Ada.Unchecked_Deallocation;
105 -- To recover from failure of ATCB initialization
107 with System.Stack_Usage;
109 package body System.Tasking.Stages is
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;
116 use Ada.Exceptions;
118 use Parameters;
119 use Task_Primitives;
120 use Task_Primitives.Operations;
121 use Task_Info;
123 use System.Traces;
124 use System.Traces.Tasking;
126 -----------------------
127 -- Local Subprograms --
128 -----------------------
130 procedure Free is new
131 Ada.Unchecked_Deallocation (Ada_Task_Control_Block, Task_Id);
133 procedure Trace_Unhandled_Exception_In_Task (Self_Id : Task_Id);
134 -- This procedure outputs the task specific message for exception
135 -- tracing purposes.
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.
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.
151 -- "Vulnerable_..." in the procedure names below means they must be called
152 -- with abort deferred.
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).
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.
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.
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.
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.
178 -- For tasks created by an allocator that fails, due to an exception,
179 -- it is called from Expunge_Unactivated_Tasks.
181 -- It is also called from Ada.Unchecked_Deallocation, for objects that
182 -- are or contain tasks.
184 -- Different code is used at master completion, in Terminate_Dependents,
185 -- due to a need for tighter synchronization with the master.
187 ----------------------
188 -- Abort_Dependents --
189 ----------------------
191 procedure Abort_Dependents (Self_ID : Task_Id) is
192 C : Task_Id;
193 P : Task_Id;
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
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.
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;
211 exit;
212 end if;
214 P := P.Common.Parent;
215 end loop;
217 C := C.Common.All_Tasks_Link;
218 end loop;
220 Self_ID.Dependents_Aborted := True;
221 end Abort_Dependents;
223 -----------------
224 -- Abort_Tasks --
225 -----------------
227 procedure Abort_Tasks (Tasks : Task_List) is
228 begin
229 Utilities.Abort_Tasks (Tasks);
230 end Abort_Tasks;
232 --------------------
233 -- Activate_Tasks --
234 --------------------
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.
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.
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.
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.
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;
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.
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;
279 pragma Debug
280 (Debug.Trace (Self_ID, "Activate_Tasks", 'C'));
282 Initialization.Defer_Abort_Nestable (Self_ID);
284 pragma Assert (Self_ID.Common.Wait_Count = 0);
286 -- Lock RTS_Lock, to prevent activated tasks from racing ahead before
287 -- we finish activating the chain.
289 Lock_RTS;
291 -- Check that all task bodies have been elaborated
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;
302 -- Reverse the activation chain so that tasks are
303 -- activated in the same order they're declared.
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;
311 Chain_Access.T_ID := Last_C;
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;
320 -- Activate all the tasks in the chain. Creation of the thread of
321 -- control was deferred until activation. So create it now.
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);
328 P := C.Common.Parent;
329 Write_Lock (P);
330 Write_Lock (C);
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;
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);
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.
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;
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;
363 Unlock (C);
364 Unlock (P);
366 else
367 -- No need to set Awake_Count, State, etc. here since the loop
368 -- below will do that for any Unactivated tasks.
370 Unlock (C);
371 Unlock (P);
372 Self_ID.Common.Activation_Failed := True;
373 end if;
374 end if;
376 C := C.Common.Activation_Link;
377 end loop;
379 if not Single_Lock then
380 Unlock_RTS;
381 end if;
383 -- Close the entries of any tasks that failed thread creation,
384 -- and count those that have not finished activation.
386 Write_Lock (Self_ID);
387 Self_ID.Common.State := Activator_Sleep;
389 C := Chain_Access.T_ID;
390 while C /= null loop
391 Write_Lock (C);
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);
399 elsif C.Common.Activator /= null then
400 Self_ID.Common.Wait_Count := Self_ID.Common.Wait_Count + 1;
401 end if;
403 Unlock (C);
404 P := C.Common.Activation_Link;
405 C.Common.Activation_Link := null;
406 C := P;
407 end loop;
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.
412 loop
413 exit when Self_ID.Common.Wait_Count = 0;
414 Sleep (Self_ID, Activator_Sleep);
415 end loop;
417 Self_ID.Common.State := Runnable;
418 Unlock (Self_ID);
420 if Single_Lock then
421 Unlock_RTS;
422 end if;
424 -- Remove the tasks from the chain
426 Chain_Access.T_ID := null;
427 Initialization.Undefer_Abort_Nestable (Self_ID);
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;
436 -------------------------
437 -- Complete_Activation --
438 -------------------------
440 procedure Complete_Activation is
441 Self_ID : constant Task_Id := STPO.Self;
443 begin
444 Initialization.Defer_Abort_Nestable (Self_ID);
446 if Single_Lock then
447 Lock_RTS;
448 end if;
450 Vulnerable_Complete_Activation (Self_ID);
452 if Single_Lock then
453 Unlock_RTS;
454 end if;
456 Initialization.Undefer_Abort_Nestable (Self_ID);
458 -- ???
459 -- Why do we need to allow for nested deferral here?
461 if Runtime_Traces then
462 Send_Trace_Info (T_Activate);
463 end if;
464 end Complete_Activation;
466 ---------------------
467 -- Complete_Master --
468 ---------------------
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;
479 -------------------
480 -- Complete_Task --
481 -------------------
483 -- See comments on Vulnerable_Complete_Task for details
485 procedure Complete_Task is
486 Self_ID : constant Task_Id := STPO.Self;
488 begin
489 pragma Assert
490 (Self_ID.Deferral_Level > 0
491 or else not System.Restrictions.Abort_Allowed);
493 Vulnerable_Complete_Task (Self_ID);
495 -- All of our dependents have terminated. Never undefer abort again!
497 end Complete_Task;
499 -----------------
500 -- Create_Task --
501 -----------------
503 -- Compiler interface only. Do not call from within the RTS.
504 -- This must be called to create a new task.
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)
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;
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.
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;
537 -- If pragma Detect_Blocking is active must be checked whether
538 -- this potentially blocking operation is called from a
539 -- protected action.
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;
548 pragma Debug
549 (Debug.Trace (Self_ID, "Create_Task", 'C'));
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;
557 -- Find parent P of new Task, via master level number
559 P := Self_ID;
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;
568 Initialization.Defer_Abort_Nestable (Self_ID);
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;
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.
582 Lock_RTS;
583 Write_Lock (Self_ID);
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.
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);
595 Unlock (Self_ID);
596 Unlock_RTS;
597 Initialization.Undefer_Abort_Nestable (Self_ID);
599 -- ??? Should never get here
601 pragma Assert (False);
602 raise Standard'Abort_Signal;
603 end if;
605 Initialize_ATCB (Self_ID, State, Discriminants, P, Elaborated,
606 Base_Priority, Task_Info, Size, T, Success);
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;
617 T.Master_of_Task := Master;
618 T.Master_Within := T.Master_of_Task + 1;
620 for L in T.Entry_Calls'Range loop
621 T.Entry_Calls (L).Self := T;
622 T.Entry_Calls (L).Level := L;
623 end loop;
625 if Task_Image'Length = 0 then
626 T.Common.Task_Image_Len := 0;
627 else
628 Len := 1;
629 T.Common.Task_Image (1) := Task_Image (Task_Image'First);
631 -- Remove unwanted blank space generated by 'Image
633 for J in Task_Image'First + 1 .. Task_Image'Last loop
634 if Task_Image (J) /= ' '
635 or else Task_Image (J - 1) /= '('
636 then
637 Len := Len + 1;
638 T.Common.Task_Image (Len) := Task_Image (J);
639 exit when Len = T.Common.Task_Image'Last;
640 end if;
641 end loop;
643 T.Common.Task_Image_Len := Len;
644 end if;
646 Unlock (Self_ID);
647 Unlock_RTS;
649 -- Create TSD as early as possible in the creation of a task, since it
650 -- may be used by the operation of Ada code within the task.
652 SSL.Create_TSD (T.Common.Compiler_Data);
653 T.Common.Activation_Link := Chain.T_ID;
654 Chain.T_ID := T;
655 Initialization.Initialize_Attributes_Link.all (T);
656 Created_Task := T;
657 Initialization.Undefer_Abort_Nestable (Self_ID);
659 if Runtime_Traces then
660 Send_Trace_Info (T_Create, T);
661 end if;
662 end Create_Task;
664 --------------------
665 -- Current_Master --
666 --------------------
668 function Current_Master return Master_Level is
669 begin
670 return STPO.Self.Master_Within;
671 end Current_Master;
673 ------------------
674 -- Enter_Master --
675 ------------------
677 procedure Enter_Master is
678 Self_ID : constant Task_Id := STPO.Self;
679 begin
680 Self_ID.Master_Within := Self_ID.Master_Within + 1;
681 end Enter_Master;
683 -------------------------------
684 -- Expunge_Unactivated_Tasks --
685 -------------------------------
687 -- See procedure Close_Entries for the general case
689 procedure Expunge_Unactivated_Tasks (Chain : in out Activation_Chain) is
690 Self_ID : constant Task_Id := STPO.Self;
691 C : Task_Id;
692 Call : Entry_Call_Link;
693 Temp : Task_Id;
695 begin
696 pragma Debug
697 (Debug.Trace (Self_ID, "Expunge_Unactivated_Tasks", 'C'));
699 Initialization.Defer_Abort_Nestable (Self_ID);
701 -- ???
702 -- Experimentation has shown that abort is sometimes (but not
703 -- always) already deferred when this is called.
705 -- That may indicate an error. Find out what is going on
707 C := Chain.T_ID;
708 while C /= null loop
709 pragma Assert (C.Common.State = Unactivated);
711 Temp := C.Common.Activation_Link;
713 if C.Common.State = Unactivated then
714 Lock_RTS;
715 Write_Lock (C);
717 for J in 1 .. C.Entry_Num loop
718 Queuing.Dequeue_Head (C.Entry_Queues (J), Call);
719 pragma Assert (Call = null);
720 end loop;
722 Unlock (C);
724 Initialization.Remove_From_All_Tasks_List (C);
725 Unlock_RTS;
727 Vulnerable_Free_Task (C);
728 C := Temp;
729 end if;
730 end loop;
732 Chain.T_ID := null;
733 Initialization.Undefer_Abort_Nestable (Self_ID);
734 end Expunge_Unactivated_Tasks;
736 ---------------------------
737 -- Finalize_Global_Tasks --
738 ---------------------------
740 -- ???
741 -- We have a potential problem here if finalization of global
742 -- objects does anything with signals or the timer server, since
743 -- by that time those servers have terminated.
745 -- It is hard to see how that would occur
747 -- However, a better solution might be to do all this finalization
748 -- using the global finalization chain.
750 procedure Finalize_Global_Tasks is
751 Self_ID : constant Task_Id := STPO.Self;
752 Ignore : Boolean;
754 begin
755 if Self_ID.Deferral_Level = 0 then
756 -- ???
757 -- In principle, we should be able to predict whether
758 -- abort is already deferred here (and it should not be deferred
759 -- yet but in practice it seems Finalize_Global_Tasks is being
760 -- called sometimes, from RTS code for exceptions, with abort already
761 -- deferred.
763 Initialization.Defer_Abort_Nestable (Self_ID);
765 -- Never undefer again!!!
766 end if;
768 -- This code is only executed by the environment task
770 pragma Assert (Self_ID = Environment_Task);
772 -- Set Environment_Task'Callable to false to notify library-level tasks
773 -- that it is waiting for them.
775 Self_ID.Callable := False;
777 -- Exit level 2 master, for normal tasks in library-level packages
779 Complete_Master;
781 -- Force termination of "independent" library-level server tasks
783 Lock_RTS;
785 Abort_Dependents (Self_ID);
787 if not Single_Lock then
788 Unlock_RTS;
789 end if;
791 -- We need to explicitely wait for the task to be terminated here
792 -- because on true concurrent system, we may end this procedure
793 -- before the tasks are really terminated.
795 Write_Lock (Self_ID);
797 loop
798 exit when Utilities.Independent_Task_Count = 0;
800 -- We used to yield here, but this did not take into account
801 -- low priority tasks that would cause dead lock in some cases
802 -- (true FIFO scheduling).
804 Timed_Sleep
805 (Self_ID, 0.01, System.OS_Primitives.Relative,
806 Self_ID.Common.State, Ignore, Ignore);
807 end loop;
809 -- ??? On multi-processor environments, it seems that the above loop
810 -- isn't sufficient, so we need to add an additional delay.
812 Timed_Sleep
813 (Self_ID, 0.01, System.OS_Primitives.Relative,
814 Self_ID.Common.State, Ignore, Ignore);
816 Unlock (Self_ID);
818 if Single_Lock then
819 Unlock_RTS;
820 end if;
822 -- Complete the environment task
824 Vulnerable_Complete_Task (Self_ID);
826 -- Handle normal task termination by the environment task, but only
827 -- for the normal task termination. In the case of Abnormal and
828 -- Unhandled_Exception they must have been handled before, and the
829 -- task termination soft link must have been changed so the task
830 -- termination routine is not executed twice.
832 SSL.Task_Termination_Handler.all (Ada.Exceptions.Null_Occurrence);
834 -- Finalize the global list for controlled objects if needed
836 SSL.Finalize_Global_List.all;
838 -- Reset the soft links to non-tasking
840 SSL.Abort_Defer := SSL.Abort_Defer_NT'Access;
841 SSL.Abort_Undefer := SSL.Abort_Undefer_NT'Access;
842 SSL.Lock_Task := SSL.Task_Lock_NT'Access;
843 SSL.Unlock_Task := SSL.Task_Unlock_NT'Access;
844 SSL.Get_Jmpbuf_Address := SSL.Get_Jmpbuf_Address_NT'Access;
845 SSL.Set_Jmpbuf_Address := SSL.Set_Jmpbuf_Address_NT'Access;
846 SSL.Get_Sec_Stack_Addr := SSL.Get_Sec_Stack_Addr_NT'Access;
847 SSL.Set_Sec_Stack_Addr := SSL.Set_Sec_Stack_Addr_NT'Access;
848 SSL.Check_Abort_Status := SSL.Check_Abort_Status_NT'Access;
849 SSL.Get_Stack_Info := SSL.Get_Stack_Info_NT'Access;
851 -- Don't bother trying to finalize Initialization.Global_Task_Lock
852 -- and System.Task_Primitives.RTS_Lock.
854 end Finalize_Global_Tasks;
856 ---------------
857 -- Free_Task --
858 ---------------
860 procedure Free_Task (T : Task_Id) is
861 Self_Id : constant Task_Id := Self;
863 begin
864 if T.Common.State = Terminated then
866 -- It is not safe to call Abort_Defer or Write_Lock at this stage
868 Initialization.Task_Lock (Self_Id);
870 Lock_RTS;
871 Initialization.Remove_From_All_Tasks_List (T);
872 Unlock_RTS;
874 Initialization.Task_Unlock (Self_Id);
876 System.Task_Primitives.Operations.Finalize_TCB (T);
878 -- If the task is not terminated, then we simply ignore the call. This
879 -- happens when a user program attempts an unchecked deallocation on
880 -- a non-terminated task.
882 else
883 null;
884 end if;
885 end Free_Task;
887 ---------------------------
888 -- Move_Activation_Chain --
889 ---------------------------
891 procedure Move_Activation_Chain
892 (From, To : Activation_Chain_Access;
893 New_Master : Master_ID)
895 Self_ID : constant Task_Id := STPO.Self;
896 C : Task_Id;
898 begin
899 pragma Debug
900 (Debug.Trace (Self_ID, "Move_Activation_Chain", 'C'));
902 -- Nothing to do if From is empty, and we can check that without
903 -- deferring aborts.
905 C := From.all.T_ID;
907 if C = null then
908 return;
909 end if;
911 Initialization.Defer_Abort (Self_ID);
913 -- Loop through the From chain, changing their Master_of_Task
914 -- fields, and to find the end of the chain.
916 loop
917 C.Master_of_Task := New_Master;
918 exit when C.Common.Activation_Link = null;
919 C := C.Common.Activation_Link;
920 end loop;
922 -- Hook From in at the start of To
924 C.Common.Activation_Link := To.all.T_ID;
925 To.all.T_ID := From.all.T_ID;
927 -- Set From to empty
929 From.all.T_ID := null;
931 Initialization.Undefer_Abort (Self_ID);
932 end Move_Activation_Chain;
934 ------------------
935 -- Task_Wrapper --
936 ------------------
938 -- The task wrapper is a procedure that is called first for each task
939 -- task body, and which in turn calls the compiler-generated task body
940 -- procedure. The wrapper's main job is to do initialization for the task.
941 -- It also has some locally declared objects that server as per-task local
942 -- data. Task finalization is done by Complete_Task, which is called from
943 -- an at-end handler that the compiler generates.
945 procedure Task_Wrapper (Self_ID : Task_Id) is
946 use type SSE.Storage_Offset;
947 use System.Standard_Library;
948 use System.Stack_Usage;
950 Bottom_Of_Stack : aliased Integer;
952 Secondary_Stack_Size :
953 constant SSE.Storage_Offset :=
954 Self_ID.Common.Compiler_Data.Pri_Stack_Info.Size *
955 SSE.Storage_Offset (Parameters.Sec_Stack_Ratio) / 100;
957 Secondary_Stack : aliased SSE.Storage_Array (1 .. Secondary_Stack_Size);
959 pragma Warnings (Off);
960 -- Why are warnings being turned off here???
962 Secondary_Stack_Address : System.Address := Secondary_Stack'Address;
964 Small_Overflow_Guard : constant := 12 * 1024;
965 -- Note: this used to be 4K, but was changed to 12K, since smaller
966 -- values resulted in segmentation faults from dynamic stack analysis.
968 Big_Overflow_Guard : constant := 16 * 1024;
969 Small_Stack_Limit : constant := 64 * 1024;
970 -- ??? These three values are experimental, and seems to work on most
971 -- platforms. They still need to be analyzed further. They also need
972 -- documentation, what are they???
974 Size : Natural :=
975 Natural (Self_ID.Common.Compiler_Data.Pri_Stack_Info.Size);
977 Overflow_Guard : Natural;
978 -- Size of the overflow guard, used by dynamic stack usage analysis
980 pragma Warnings (On);
981 -- Address of secondary stack. In the fixed secondary stack case, this
982 -- value is not modified, causing a warning, hence the bracketing with
983 -- Warnings (Off/On). But why is so much *more* bracketed ???
985 SEH_Table : aliased SSE.Storage_Array (1 .. 8);
986 -- Structured Exception Registration table (2 words)
988 procedure Install_SEH_Handler (Addr : System.Address);
989 pragma Import (C, Install_SEH_Handler, "__gnat_install_SEH_handler");
990 -- Install the SEH (Structured Exception Handling) handler
992 Cause : Cause_Of_Termination := Normal;
993 -- Indicates the reason why this task terminates. Normal corresponds to
994 -- a task terminating due to completing the last statement of its body,
995 -- or as a result of waiting on a terminate alternative. If the task
996 -- terminates because it is being aborted then Cause will be set to
997 -- Abnormal. If the task terminates because of an exception raised by
998 -- the execution of its task body, then Cause is set to
999 -- Unhandled_Exception.
1001 EO : Exception_Occurrence;
1002 -- If the task terminates because of an exception raised by the
1003 -- execution of its task body, then EO will contain the associated
1004 -- exception occurrence. Otherwise, it will contain Null_Occurrence.
1006 TH : Termination_Handler := null;
1007 -- Pointer to the protected procedure to be executed upon task
1008 -- termination.
1010 procedure Search_Fall_Back_Handler (ID : Task_Id);
1011 -- Procedure that searches recursively a fall-back handler through the
1012 -- master relationship. If the handler is found, its pointer is stored
1013 -- in TH.
1015 ------------------------------
1016 -- Search_Fall_Back_Handler --
1017 ------------------------------
1019 procedure Search_Fall_Back_Handler (ID : Task_Id) is
1020 begin
1021 -- If there is a fall back handler, store its pointer for later
1022 -- execution.
1024 if ID.Common.Fall_Back_Handler /= null then
1025 TH := ID.Common.Fall_Back_Handler;
1027 -- Otherwise look for a fall back handler in the parent
1029 elsif ID.Common.Parent /= null then
1030 Search_Fall_Back_Handler (ID.Common.Parent);
1032 -- Otherwise, do nothing
1034 else
1035 return;
1036 end if;
1037 end Search_Fall_Back_Handler;
1039 begin
1040 pragma Assert (Self_ID.Deferral_Level = 1);
1042 -- Assume a size of the stack taken at this stage
1044 if Size < Small_Stack_Limit then
1045 Overflow_Guard := Small_Overflow_Guard;
1046 else
1047 Overflow_Guard := Big_Overflow_Guard;
1048 end if;
1050 Size := Size - Overflow_Guard;
1052 if not Parameters.Sec_Stack_Dynamic then
1053 Self_ID.Common.Compiler_Data.Sec_Stack_Addr :=
1054 Secondary_Stack'Address;
1055 SST.SS_Init (Secondary_Stack_Address, Integer (Secondary_Stack'Last));
1056 Size := Size - Natural (Secondary_Stack_Size);
1057 end if;
1059 if System.Stack_Usage.Is_Enabled then
1060 STPO.Lock_RTS;
1061 Initialize_Analyzer (Self_ID.Common.Analyzer,
1062 Self_ID.Common.Task_Image
1063 (1 .. Self_ID.Common.Task_Image_Len),
1064 Size,
1065 Overflow_Guard,
1066 SSE.To_Integer (Bottom_Of_Stack'Address));
1067 STPO.Unlock_RTS;
1068 Fill_Stack (Self_ID.Common.Analyzer);
1069 end if;
1071 -- Set the guard page at the bottom of the stack. The call to unprotect
1072 -- the page is done in Terminate_Task
1074 Stack_Guard (Self_ID, True);
1076 -- Initialize low-level TCB components, that cannot be initialized
1077 -- by the creator. Enter_Task sets Self_ID.Known_Tasks_Index and
1078 -- also Self_ID.LL.Thread
1080 Enter_Task (Self_ID);
1082 -- We setup the SEH (Structured Exception Handling) handler if supported
1083 -- on the target.
1085 Install_SEH_Handler (SEH_Table'Address);
1087 -- Initialize exception occurrence
1089 Save_Occurrence (EO, Ada.Exceptions.Null_Occurrence);
1091 -- We lock RTS_Lock to wait for activator to finish activating the rest
1092 -- of the chain, so that everyone in the chain comes out in priority
1093 -- order.
1095 -- This also protects the value of
1096 -- Self_ID.Common.Activator.Common.Wait_Count.
1098 Lock_RTS;
1099 Unlock_RTS;
1101 if not System.Restrictions.Abort_Allowed then
1103 -- If Abort is not allowed, reset the deferral level since it will
1104 -- not get changed by the generated code. Keeping a default value
1105 -- of one would prevent some operations (e.g. select or delay) to
1106 -- proceed successfully.
1108 Self_ID.Deferral_Level := 0;
1109 end if;
1111 begin
1112 -- We are separating the following portion of the code in order to
1113 -- place the exception handlers in a different block. In this way,
1114 -- we do not call Set_Jmpbuf_Address (which needs Self) before we
1115 -- set Self in Enter_Task
1117 -- Call the task body procedure
1119 -- The task body is called with abort still deferred. That
1120 -- eliminates a dangerous window, for which we had to patch-up in
1121 -- Terminate_Task.
1123 -- During the expansion of the task body, we insert an RTS-call
1124 -- to Abort_Undefer, at the first point where abort should be
1125 -- allowed.
1127 Self_ID.Common.Task_Entry_Point (Self_ID.Common.Task_Arg);
1128 Initialization.Defer_Abort_Nestable (Self_ID);
1130 exception
1131 -- We can't call Terminate_Task in the exception handlers below,
1132 -- since there may be (e.g. in the case of GCC exception handling)
1133 -- clean ups associated with the exception handler that need to
1134 -- access task specific data.
1136 -- Defer abort so that this task can't be aborted while exiting
1138 when Standard'Abort_Signal =>
1139 Initialization.Defer_Abort_Nestable (Self_ID);
1141 -- Update the cause that motivated the task termination so that
1142 -- the appropriate information is passed to the task termination
1143 -- procedure. Task termination as a result of waiting on a
1144 -- terminate alternative is a normal termination, although it is
1145 -- implemented using the abort mechanisms.
1147 if Self_ID.Terminate_Alternative then
1148 Cause := Normal;
1149 else
1150 Cause := Abnormal;
1151 end if;
1152 when others =>
1153 -- ??? Using an E : others here causes CD2C11A to fail on Tru64.
1155 Initialization.Defer_Abort_Nestable (Self_ID);
1157 -- Perform the task specific exception tracing duty. We handle
1158 -- these outputs here and not in the common notification routine
1159 -- because we need access to tasking related data and we don't
1160 -- want to drag dependencies against tasking related units in the
1161 -- the common notification units. Additionally, no trace is ever
1162 -- triggered from the common routine for the Unhandled_Raise case
1163 -- in tasks, since an exception never appears unhandled in this
1164 -- context because of this handler.
1166 if Exception_Trace = Unhandled_Raise then
1167 Trace_Unhandled_Exception_In_Task (Self_ID);
1168 end if;
1170 -- Update the cause that motivated the task termination so that
1171 -- the appropriate information is passed to the task termination
1172 -- procedure, as well as the associated Exception_Occurrence.
1174 Cause := Unhandled_Exception;
1175 Save_Occurrence (EO, SSL.Get_Current_Excep.all.all);
1176 end;
1178 -- Look for a task termination handler. This code is for all tasks but
1179 -- the environment task. The task termination code for the environment
1180 -- task is executed by SSL.Task_Termination_Handler.
1182 if Single_Lock then
1183 Lock_RTS;
1184 end if;
1186 Write_Lock (Self_ID);
1188 if Self_ID.Common.Specific_Handler /= null then
1189 TH := Self_ID.Common.Specific_Handler;
1190 else
1191 -- Look for a fall-back handler following the master relationship
1192 -- for the task.
1194 Search_Fall_Back_Handler (Self_ID);
1195 end if;
1197 Unlock (Self_ID);
1199 if Single_Lock then
1200 Unlock_RTS;
1201 end if;
1203 -- Execute the task termination handler if we found it
1205 if TH /= null then
1206 TH.all (Cause, Self_ID, EO);
1207 end if;
1209 if System.Stack_Usage.Is_Enabled then
1210 Compute_Result (Self_ID.Common.Analyzer);
1211 Report_Result (Self_ID.Common.Analyzer);
1212 end if;
1214 Terminate_Task (Self_ID);
1215 end Task_Wrapper;
1217 --------------------
1218 -- Terminate_Task --
1219 --------------------
1221 -- Before we allow the thread to exit, we must clean up. This is a
1222 -- a delicate job. We must wake up the task's master, who may immediately
1223 -- try to deallocate the ATCB out from under the current task WHILE IT IS
1224 -- STILL EXECUTING.
1226 -- To avoid this, the parent task must be blocked up to the latest
1227 -- statement executed. The trouble is that we have another step that we
1228 -- also want to postpone to the very end, i.e., calling SSL.Destroy_TSD.
1229 -- We have to postpone that until the end because compiler-generated code
1230 -- is likely to try to access that data at just about any point.
1232 -- We can't call Destroy_TSD while we are holding any other locks, because
1233 -- it locks Global_Task_Lock, and our deadlock prevention rules require
1234 -- that to be the outermost lock. Our first "solution" was to just lock
1235 -- Global_Task_Lock in addition to the other locks, and force the parent to
1236 -- also lock this lock between its wakeup and its freeing of the ATCB. See
1237 -- Complete_Task for the parent-side of the code that has the matching
1238 -- calls to Task_Lock and Task_Unlock. That was not really a solution,
1239 -- since the operation Task_Unlock continued to access the ATCB after
1240 -- unlocking, after which the parent was observed to race ahead, deallocate
1241 -- the ATCB, and then reallocate it to another task. The call to
1242 -- Undefer_Abort in Task_Unlock by the "terminated" task was overwriting
1243 -- the data of the new task that reused the ATCB! To solve this problem, we
1244 -- introduced the new operation Final_Task_Unlock.
1246 procedure Terminate_Task (Self_ID : Task_Id) is
1247 Environment_Task : constant Task_Id := STPO.Environment_Task;
1248 Master_of_Task : Integer;
1250 begin
1251 Debug.Task_Termination_Hook;
1253 if Runtime_Traces then
1254 Send_Trace_Info (T_Terminate);
1255 end if;
1257 -- Since GCC cannot allocate stack chunks efficiently without reordering
1258 -- some of the allocations, we have to handle this unexpected situation
1259 -- here. We should normally never have to call Vulnerable_Complete_Task
1260 -- here.
1262 if Self_ID.Common.Activator /= null then
1263 Vulnerable_Complete_Task (Self_ID);
1264 end if;
1266 Initialization.Task_Lock (Self_ID);
1268 if Single_Lock then
1269 Lock_RTS;
1270 end if;
1272 Master_of_Task := Self_ID.Master_of_Task;
1274 -- Check if the current task is an independent task If so, decrement
1275 -- the Independent_Task_Count value.
1277 if Master_of_Task = 2 then
1278 if Single_Lock then
1279 Utilities.Independent_Task_Count :=
1280 Utilities.Independent_Task_Count - 1;
1281 else
1282 Write_Lock (Environment_Task);
1283 Utilities.Independent_Task_Count :=
1284 Utilities.Independent_Task_Count - 1;
1285 Unlock (Environment_Task);
1286 end if;
1287 end if;
1289 -- Unprotect the guard page if needed
1291 Stack_Guard (Self_ID, False);
1293 Utilities.Make_Passive (Self_ID, Task_Completed => True);
1295 if Single_Lock then
1296 Unlock_RTS;
1297 end if;
1299 pragma Assert (Check_Exit (Self_ID));
1301 SSL.Destroy_TSD (Self_ID.Common.Compiler_Data);
1302 Initialization.Final_Task_Unlock (Self_ID);
1304 -- WARNING: past this point, this thread must assume that the ATCB
1305 -- has been deallocated. It should not be accessed again.
1307 if Master_of_Task > 0 then
1308 STPO.Exit_Task;
1309 end if;
1310 end Terminate_Task;
1312 ----------------
1313 -- Terminated --
1314 ----------------
1316 function Terminated (T : Task_Id) return Boolean is
1317 Self_ID : constant Task_Id := STPO.Self;
1318 Result : Boolean;
1320 begin
1321 Initialization.Defer_Abort_Nestable (Self_ID);
1323 if Single_Lock then
1324 Lock_RTS;
1325 end if;
1327 Write_Lock (T);
1328 Result := T.Common.State = Terminated;
1329 Unlock (T);
1331 if Single_Lock then
1332 Unlock_RTS;
1333 end if;
1335 Initialization.Undefer_Abort_Nestable (Self_ID);
1336 return Result;
1337 end Terminated;
1339 ----------------------------------------
1340 -- Trace_Unhandled_Exception_In_Task --
1341 ----------------------------------------
1343 procedure Trace_Unhandled_Exception_In_Task (Self_Id : Task_Id) is
1344 procedure To_Stderr (S : String);
1345 pragma Import (Ada, To_Stderr, "__gnat_to_stderr");
1347 use System.Soft_Links;
1348 use System.Standard_Library;
1350 function To_Address is new
1351 Ada.Unchecked_Conversion (Task_Id, System.Address);
1353 function Tailored_Exception_Information
1354 (E : Exception_Occurrence) return String;
1355 pragma Import
1356 (Ada, Tailored_Exception_Information,
1357 "__gnat_tailored_exception_information");
1359 Excep : constant Exception_Occurrence_Access :=
1360 SSL.Get_Current_Excep.all;
1362 begin
1363 -- This procedure is called by the task outermost handler in
1364 -- Task_Wrapper below, so only once the task stack has been fully
1365 -- unwound. The common notification routine has been called at the
1366 -- raise point already.
1368 To_Stderr ("task ");
1370 if Self_Id.Common.Task_Image_Len /= 0 then
1371 To_Stderr
1372 (Self_Id.Common.Task_Image (1 .. Self_Id.Common.Task_Image_Len));
1373 To_Stderr ("_");
1374 end if;
1376 To_Stderr (System.Address_Image (To_Address (Self_Id)));
1377 To_Stderr (" terminated by unhandled exception");
1378 To_Stderr ((1 => ASCII.LF));
1379 To_Stderr (Tailored_Exception_Information (Excep.all));
1380 end Trace_Unhandled_Exception_In_Task;
1382 ------------------------------------
1383 -- Vulnerable_Complete_Activation --
1384 ------------------------------------
1386 -- As in several other places, the locks of the activator and activated
1387 -- task are both locked here. This follows our deadlock prevention lock
1388 -- ordering policy, since the activated task must be created after the
1389 -- activator.
1391 procedure Vulnerable_Complete_Activation (Self_ID : Task_Id) is
1392 Activator : constant Task_Id := Self_ID.Common.Activator;
1394 begin
1395 pragma Debug (Debug.Trace (Self_ID, "V_Complete_Activation", 'C'));
1397 Write_Lock (Activator);
1398 Write_Lock (Self_ID);
1400 pragma Assert (Self_ID.Common.Activator /= null);
1402 -- Remove dangling reference to Activator, since a task may
1403 -- outlive its activator.
1405 Self_ID.Common.Activator := null;
1407 -- Wake up the activator, if it is waiting for a chain of tasks to
1408 -- activate, and we are the last in the chain to complete activation.
1410 if Activator.Common.State = Activator_Sleep then
1411 Activator.Common.Wait_Count := Activator.Common.Wait_Count - 1;
1413 if Activator.Common.Wait_Count = 0 then
1414 Wakeup (Activator, Activator_Sleep);
1415 end if;
1416 end if;
1418 -- The activator raises a Tasking_Error if any task it is activating
1419 -- is completed before the activation is done. However, if the reason
1420 -- for the task completion is an abort, we do not raise an exception.
1421 -- See RM 9.2(5).
1423 if not Self_ID.Callable and then Self_ID.Pending_ATC_Level /= 0 then
1424 Activator.Common.Activation_Failed := True;
1425 end if;
1427 Unlock (Self_ID);
1428 Unlock (Activator);
1430 -- After the activation, active priority should be the same
1431 -- as base priority. We must unlock the Activator first,
1432 -- though, since it should not wait if we have lower priority.
1434 if Get_Priority (Self_ID) /= Self_ID.Common.Base_Priority then
1435 Write_Lock (Self_ID);
1436 Set_Priority (Self_ID, Self_ID.Common.Base_Priority);
1437 Unlock (Self_ID);
1438 end if;
1439 end Vulnerable_Complete_Activation;
1441 --------------------------------
1442 -- Vulnerable_Complete_Master --
1443 --------------------------------
1445 procedure Vulnerable_Complete_Master (Self_ID : Task_Id) is
1446 C : Task_Id;
1447 P : Task_Id;
1448 CM : constant Master_Level := Self_ID.Master_Within;
1449 T : aliased Task_Id;
1451 To_Be_Freed : Task_Id;
1452 -- This is a list of ATCBs to be freed, after we have released
1453 -- all RTS locks. This is necessary because of the locking order
1454 -- rules, since the storage manager uses Global_Task_Lock.
1456 pragma Warnings (Off);
1457 function Check_Unactivated_Tasks return Boolean;
1458 pragma Warnings (On);
1459 -- Temporary error-checking code below. This is part of the checks
1460 -- added in the new run time. Call it only inside a pragma Assert.
1462 -----------------------------
1463 -- Check_Unactivated_Tasks --
1464 -----------------------------
1466 function Check_Unactivated_Tasks return Boolean is
1467 begin
1468 if not Single_Lock then
1469 Lock_RTS;
1470 end if;
1472 Write_Lock (Self_ID);
1474 C := All_Tasks_List;
1475 while C /= null loop
1476 if C.Common.Activator = Self_ID and then C.Master_of_Task = CM then
1477 return False;
1478 end if;
1480 if C.Common.Parent = Self_ID and then C.Master_of_Task = CM then
1481 Write_Lock (C);
1483 if C.Common.State = Unactivated then
1484 return False;
1485 end if;
1487 Unlock (C);
1488 end if;
1490 C := C.Common.All_Tasks_Link;
1491 end loop;
1493 Unlock (Self_ID);
1495 if not Single_Lock then
1496 Unlock_RTS;
1497 end if;
1499 return True;
1500 end Check_Unactivated_Tasks;
1502 -- Start of processing for Vulnerable_Complete_Master
1504 begin
1505 pragma Debug
1506 (Debug.Trace (Self_ID, "V_Complete_Master", 'C'));
1508 pragma Assert (Self_ID.Common.Wait_Count = 0);
1509 pragma Assert
1510 (Self_ID.Deferral_Level > 0
1511 or else not System.Restrictions.Abort_Allowed);
1513 -- Count how many active dependent tasks this master currently
1514 -- has, and record this in Wait_Count.
1516 -- This count should start at zero, since it is initialized to
1517 -- zero for new tasks, and the task should not exit the
1518 -- sleep-loops that use this count until the count reaches zero.
1520 -- While we're counting, if we run across any unactivated tasks that
1521 -- belong to this master, we summarily terminate them as required by
1522 -- RM-9.2(6).
1524 Lock_RTS;
1525 Write_Lock (Self_ID);
1527 C := All_Tasks_List;
1528 while C /= null loop
1530 -- Terminate unactivated (never-to-be activated) tasks
1532 if C.Common.Activator = Self_ID and then C.Master_of_Task = CM then
1533 pragma Assert (C.Common.State = Unactivated);
1534 -- Usually, C.Common.Activator = Self_ID implies C.Master_of_Task
1535 -- = CM. The only case where C is pending activation by this
1536 -- task, but the master of C is not CM is in Ada 2005, when C is
1537 -- part of a return object of a build-in-place function.
1539 Write_Lock (C);
1540 C.Common.Activator := null;
1541 C.Common.State := Terminated;
1542 C.Callable := False;
1543 Utilities.Cancel_Queued_Entry_Calls (C);
1544 Unlock (C);
1545 end if;
1547 -- Count it if dependent on this master
1549 if C.Common.Parent = Self_ID and then C.Master_of_Task = CM then
1550 Write_Lock (C);
1552 if C.Awake_Count /= 0 then
1553 Self_ID.Common.Wait_Count := Self_ID.Common.Wait_Count + 1;
1554 end if;
1556 Unlock (C);
1557 end if;
1559 C := C.Common.All_Tasks_Link;
1560 end loop;
1562 Self_ID.Common.State := Master_Completion_Sleep;
1563 Unlock (Self_ID);
1565 if not Single_Lock then
1566 Unlock_RTS;
1567 end if;
1569 -- Wait until dependent tasks are all terminated or ready to terminate.
1570 -- While waiting, the task may be awakened if the task's priority needs
1571 -- changing, or this master is aborted. In the latter case, we want
1572 -- to abort the dependents, and resume waiting until Wait_Count goes
1573 -- to zero.
1575 Write_Lock (Self_ID);
1577 loop
1578 exit when Self_ID.Common.Wait_Count = 0;
1580 -- Here is a difference as compared to Complete_Master
1582 if Self_ID.Pending_ATC_Level < Self_ID.ATC_Nesting_Level
1583 and then not Self_ID.Dependents_Aborted
1584 then
1585 if Single_Lock then
1586 Abort_Dependents (Self_ID);
1587 else
1588 Unlock (Self_ID);
1589 Lock_RTS;
1590 Abort_Dependents (Self_ID);
1591 Unlock_RTS;
1592 Write_Lock (Self_ID);
1593 end if;
1594 else
1595 Sleep (Self_ID, Master_Completion_Sleep);
1596 end if;
1597 end loop;
1599 Self_ID.Common.State := Runnable;
1600 Unlock (Self_ID);
1602 -- Dependents are all terminated or on terminate alternatives.
1603 -- Now, force those on terminate alternatives to terminate, by
1604 -- aborting them.
1606 pragma Assert (Check_Unactivated_Tasks);
1608 if Self_ID.Alive_Count > 1 then
1609 -- ???
1610 -- Consider finding a way to skip the following extra steps if there
1611 -- are no dependents with terminate alternatives. This could be done
1612 -- by adding another count to the ATCB, similar to Awake_Count, but
1613 -- keeping track of tasks that are on terminate alternatives.
1615 pragma Assert (Self_ID.Common.Wait_Count = 0);
1617 -- Force any remaining dependents to terminate by aborting them
1619 if not Single_Lock then
1620 Lock_RTS;
1621 end if;
1623 Abort_Dependents (Self_ID);
1625 -- Above, when we "abort" the dependents we are simply using this
1626 -- operation for convenience. We are not required to support the full
1627 -- abort-statement semantics; in particular, we are not required to
1628 -- immediately cancel any queued or in-service entry calls. That is
1629 -- good, because if we tried to cancel a call we would need to lock
1630 -- the caller, in order to wake the caller up. Our anti-deadlock
1631 -- rules prevent us from doing that without releasing the locks on C
1632 -- and Self_ID. Releasing and retaking those locks would be wasteful
1633 -- at best, and should not be considered further without more
1634 -- detailed analysis of potential concurrent accesses to the
1635 -- ATCBs of C and Self_ID.
1637 -- Count how many "alive" dependent tasks this master currently
1638 -- has, and record this in Wait_Count. This count should start at
1639 -- zero, since it is initialized to zero for new tasks, and the
1640 -- task should not exit the sleep-loops that use this count until
1641 -- the count reaches zero.
1643 pragma Assert (Self_ID.Common.Wait_Count = 0);
1645 Write_Lock (Self_ID);
1647 C := All_Tasks_List;
1648 while C /= null loop
1649 if C.Common.Parent = Self_ID and then C.Master_of_Task = CM then
1650 Write_Lock (C);
1652 pragma Assert (C.Awake_Count = 0);
1654 if C.Alive_Count > 0 then
1655 pragma Assert (C.Terminate_Alternative);
1656 Self_ID.Common.Wait_Count := Self_ID.Common.Wait_Count + 1;
1657 end if;
1659 Unlock (C);
1660 end if;
1662 C := C.Common.All_Tasks_Link;
1663 end loop;
1665 Self_ID.Common.State := Master_Phase_2_Sleep;
1666 Unlock (Self_ID);
1668 if not Single_Lock then
1669 Unlock_RTS;
1670 end if;
1672 -- Wait for all counted tasks to finish terminating themselves
1674 Write_Lock (Self_ID);
1676 loop
1677 exit when Self_ID.Common.Wait_Count = 0;
1678 Sleep (Self_ID, Master_Phase_2_Sleep);
1679 end loop;
1681 Self_ID.Common.State := Runnable;
1682 Unlock (Self_ID);
1683 end if;
1685 -- We don't wake up for abort here. We are already terminating just as
1686 -- fast as we can, so there is no point.
1688 -- Remove terminated tasks from the list of Self_ID's dependents, but
1689 -- don't free their ATCBs yet, because of lock order restrictions,
1690 -- which don't allow us to call "free" or "malloc" while holding any
1691 -- other locks. Instead, we put those ATCBs to be freed onto a
1692 -- temporary list, called To_Be_Freed.
1694 if not Single_Lock then
1695 Lock_RTS;
1696 end if;
1698 C := All_Tasks_List;
1699 P := null;
1700 while C /= null loop
1701 if C.Common.Parent = Self_ID and then C.Master_of_Task >= CM then
1702 if P /= null then
1703 P.Common.All_Tasks_Link := C.Common.All_Tasks_Link;
1704 else
1705 All_Tasks_List := C.Common.All_Tasks_Link;
1706 end if;
1708 T := C.Common.All_Tasks_Link;
1709 C.Common.All_Tasks_Link := To_Be_Freed;
1710 To_Be_Freed := C;
1711 C := T;
1713 else
1714 P := C;
1715 C := C.Common.All_Tasks_Link;
1716 end if;
1717 end loop;
1719 Unlock_RTS;
1721 -- Free all the ATCBs on the list To_Be_Freed
1723 -- The ATCBs in the list are no longer in All_Tasks_List, and after
1724 -- any interrupt entries are detached from them they should no longer
1725 -- be referenced.
1727 -- Global_Task_Lock (Task_Lock/Unlock) is locked in the loop below to
1728 -- avoid a race between a terminating task and its parent. The parent
1729 -- might try to deallocate the ACTB out from underneath the exiting
1730 -- task. Note that Free will also lock Global_Task_Lock, but that is
1731 -- OK, since this is the *one* lock for which we have a mechanism to
1732 -- support nested locking. See Task_Wrapper and its finalizer for more
1733 -- explanation.
1735 -- ???
1736 -- The check "T.Common.Parent /= null ..." below is to prevent dangling
1737 -- references to terminated library-level tasks, which could
1738 -- otherwise occur during finalization of library-level objects.
1739 -- A better solution might be to hook task objects into the
1740 -- finalization chain and deallocate the ATCB when the task
1741 -- object is deallocated. However, this change is not likely
1742 -- to gain anything significant, since all this storage should
1743 -- be recovered en-masse when the process exits.
1745 while To_Be_Freed /= null loop
1746 T := To_Be_Freed;
1747 To_Be_Freed := T.Common.All_Tasks_Link;
1749 -- ??? On SGI there is currently no Interrupt_Manager, that's
1750 -- why we need to check if the Interrupt_Manager_ID is null
1752 if T.Interrupt_Entry and Interrupt_Manager_ID /= null then
1753 declare
1754 Detach_Interrupt_Entries_Index : constant Task_Entry_Index := 1;
1755 -- Corresponds to the entry index of System.Interrupts.
1756 -- Interrupt_Manager.Detach_Interrupt_Entries.
1757 -- Be sure to update this value when changing
1758 -- Interrupt_Manager specs.
1760 type Param_Type is access all Task_Id;
1762 Param : aliased Param_Type := T'Access;
1764 begin
1765 System.Tasking.Rendezvous.Call_Simple
1766 (Interrupt_Manager_ID, Detach_Interrupt_Entries_Index,
1767 Param'Address);
1768 end;
1769 end if;
1771 if (T.Common.Parent /= null
1772 and then T.Common.Parent.Common.Parent /= null)
1773 or else T.Master_of_Task > 3
1774 then
1775 Initialization.Task_Lock (Self_ID);
1777 -- If Sec_Stack_Addr is not null, it means that Destroy_TSD
1778 -- has not been called yet (case of an unactivated task).
1780 if T.Common.Compiler_Data.Sec_Stack_Addr /= Null_Address then
1781 SSL.Destroy_TSD (T.Common.Compiler_Data);
1782 end if;
1784 Vulnerable_Free_Task (T);
1785 Initialization.Task_Unlock (Self_ID);
1786 end if;
1787 end loop;
1789 -- It might seem nice to let the terminated task deallocate its own
1790 -- ATCB. That would not cover the case of unactivated tasks. It also
1791 -- would force us to keep the underlying thread around past termination,
1792 -- since references to the ATCB are possible past termination.
1793 -- Currently, we get rid of the thread as soon as the task terminates,
1794 -- and let the parent recover the ATCB later.
1796 -- Some day, if we want to recover the ATCB earlier, at task
1797 -- termination, we could consider using "fat task IDs", that include the
1798 -- serial number with the ATCB pointer, to catch references to tasks
1799 -- that no longer have ATCBs. It is not clear how much this would gain,
1800 -- since the user-level task object would still be occupying storage.
1802 -- Make next master level up active.
1803 -- We don't need to lock the ATCB, since the value is only updated by
1804 -- each task for itself.
1806 Self_ID.Master_Within := CM - 1;
1807 end Vulnerable_Complete_Master;
1809 ------------------------------
1810 -- Vulnerable_Complete_Task --
1811 ------------------------------
1813 -- Complete the calling task
1815 -- This procedure must be called with abort deferred. It should only be
1816 -- called by Complete_Task and Finalize_Global_Tasks (for the environment
1817 -- task).
1819 -- The effect is similar to that of Complete_Master. Differences include
1820 -- the closing of entries here, and computation of the number of active
1821 -- dependent tasks in Complete_Master.
1823 -- We don't lock Self_ID before the call to Vulnerable_Complete_Activation,
1824 -- because that does its own locking, and because we do not need the lock
1825 -- to test Self_ID.Common.Activator. That value should only be read and
1826 -- modified by Self.
1828 procedure Vulnerable_Complete_Task (Self_ID : Task_Id) is
1829 begin
1830 pragma Assert
1831 (Self_ID.Deferral_Level > 0
1832 or else not System.Restrictions.Abort_Allowed);
1833 pragma Assert (Self_ID = Self);
1834 pragma Assert (Self_ID.Master_Within = Self_ID.Master_of_Task + 1
1835 or else
1836 Self_ID.Master_Within = Self_ID.Master_of_Task + 2);
1837 pragma Assert (Self_ID.Common.Wait_Count = 0);
1838 pragma Assert (Self_ID.Open_Accepts = null);
1839 pragma Assert (Self_ID.ATC_Nesting_Level = 1);
1841 pragma Debug (Debug.Trace (Self_ID, "V_Complete_Task", 'C'));
1843 if Single_Lock then
1844 Lock_RTS;
1845 end if;
1847 Write_Lock (Self_ID);
1848 Self_ID.Callable := False;
1850 -- In theory, Self should have no pending entry calls left on its
1851 -- call-stack. Each async. select statement should clean its own call,
1852 -- and blocking entry calls should defer abort until the calls are
1853 -- cancelled, then clean up.
1855 Utilities.Cancel_Queued_Entry_Calls (Self_ID);
1856 Unlock (Self_ID);
1858 if Self_ID.Common.Activator /= null then
1859 Vulnerable_Complete_Activation (Self_ID);
1860 end if;
1862 if Single_Lock then
1863 Unlock_RTS;
1864 end if;
1866 -- If Self_ID.Master_Within = Self_ID.Master_of_Task + 2
1867 -- we may have dependent tasks for which we need to wait.
1868 -- Otherwise, we can just exit.
1870 if Self_ID.Master_Within = Self_ID.Master_of_Task + 2 then
1871 Vulnerable_Complete_Master (Self_ID);
1872 end if;
1873 end Vulnerable_Complete_Task;
1875 --------------------------
1876 -- Vulnerable_Free_Task --
1877 --------------------------
1879 -- Recover all runtime system storage associated with the task T.
1880 -- This should only be called after T has terminated and will no
1881 -- longer be referenced.
1883 -- For tasks created by an allocator that fails, due to an exception,
1884 -- it is called from Expunge_Unactivated_Tasks.
1886 -- For tasks created by elaboration of task object declarations it
1887 -- is called from the finalization code of the Task_Wrapper procedure.
1888 -- It is also called from Ada.Unchecked_Deallocation, for objects that
1889 -- are or contain tasks.
1891 procedure Vulnerable_Free_Task (T : Task_Id) is
1892 begin
1893 pragma Debug (Debug.Trace (Self, "Vulnerable_Free_Task", 'C', T));
1895 if Single_Lock then
1896 Lock_RTS;
1897 end if;
1899 Write_Lock (T);
1900 Initialization.Finalize_Attributes_Link.all (T);
1901 Unlock (T);
1903 if Single_Lock then
1904 Unlock_RTS;
1905 end if;
1907 System.Task_Primitives.Operations.Finalize_TCB (T);
1908 end Vulnerable_Free_Task;
1910 -- Package elaboration code
1912 begin
1913 -- Establish the Adafinal softlink
1915 -- This is not done inside the central RTS initialization routine
1916 -- to avoid with-ing this package from System.Tasking.Initialization.
1918 SSL.Adafinal := Finalize_Global_Tasks'Access;
1920 -- Establish soft links for subprograms that manipulate master_id's.
1921 -- This cannot be done when the RTS is initialized, because of various
1922 -- elaboration constraints.
1924 SSL.Current_Master := Stages.Current_Master'Access;
1925 SSL.Enter_Master := Stages.Enter_Master'Access;
1926 SSL.Complete_Master := Stages.Complete_Master'Access;
1927 end System.Tasking.Stages;