------------------------------------------------------------------------------
-- --
--- GNAT RUNTIME COMPONENTS --
+-- GNAT RUN-TIME COMPONENTS --
-- --
-- G N A T . T H R E A D S --
-- --
-- S p e c --
-- --
--- --
--- Copyright (C) 1998-2000 Ada Core Technologies, Inc. --
+-- Copyright (C) 1998-2010, AdaCore --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
--- ware Foundation; either version 2, or (at your option) any later ver- --
+-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
--- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
--- for more details. You should have received a copy of the GNU General --
--- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
--- MA 02111-1307, USA. --
+-- or FITNESS FOR A PARTICULAR PURPOSE. --
+-- --
+-- As a special exception under Section 7 of GPL version 3, you are granted --
+-- additional permissions described in the GCC Runtime Library Exception, --
+-- version 3.1, as published by the Free Software Foundation. --
-- --
--- As a special exception, if other files instantiate generics from this --
--- unit, or you link this unit with other files to produce an executable, --
--- this unit does not by itself cause the resulting executable to be --
--- covered by the GNU General Public License. This exception does not --
--- however invalidate any other reasons why the executable file might be --
--- covered by the GNU Public License. --
+-- You should have received a copy of the GNU General Public License and --
+-- a copy of the GCC Runtime Library Exception along with this program; --
+-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
+-- <http://www.gnu.org/licenses/>. --
-- --
--- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com). --
+-- GNAT was originally developed by the GNAT team at New York University. --
+-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
--- This package provides facilities for creation of foreign threads for
--- use as Ada tasks. In order to execute general Ada code, the run-time
--- system must know about all tasks. This package allows foreign code,
--- e.g. a C program, to create a thread that the Ada run-time knows about.
+-- This package provides facilities for creation or registration of foreign
+-- threads for use as Ada tasks. In order to execute general Ada code, the
+-- run-time system must know about all tasks. This package allows foreign
+-- code, e.g. a C program, to create a thread that the Ada run-time knows
+-- about, or to register the current thread.
+
+-- For some implementations of GNAT Pro, the registration of foreign threads
+-- is automatic. However, in such implementations, if the Ada program has no
+-- tasks at all and no tasking constructs other than delay, then by default
+-- the non-tasking version of the Ada run-time will be loaded. If foreign
+-- threads are present, it is important to ensure that the tasking version
+-- of the Ada run time is loaded. This may be achieved by adding "with
+-- GNAT.Threads" to any unit in the partition.
with System;
+with Ada.Task_Identification;
package GNAT.Threads is
-- extern void *__gnat_create_thread
-- (void (*code)(void *, void *), void *parm, int size, int prio);
+ function Register_Thread return System.Address;
+ pragma Export (C, Register_Thread, "__gnat_register_thread");
+ -- Create an Ada task Id for the current thread if needed.
+ -- If the thread could not be registered, System.Null_Address is returned.
+ --
+ -- This function returns the Ada Id of the current task that can then be
+ -- used as a parameter to the procedures below.
+ --
+ -- C declaration:
+ --
+ -- extern void *__gnat_register_thread ();
+ --
+ -- Here is a typical usage of the Register/Unregister_Thread procedures:
+ --
+ -- void thread_body ()
+ -- {
+ -- void *task_id = __gnat_register_thread ();
+ -- ... thread body ...
+ -- __gnat_unregister_thread ();
+ -- }
+
+ procedure Unregister_Thread;
+ pragma Export (C, Unregister_Thread, "__gnat_unregister_thread");
+ -- Unregister the current task from the GNAT run time and destroy the
+ -- memory allocated for its task id.
+ --
+ -- C declaration:
+ --
+ -- extern void __gnat_unregister_thread ();
+
+ procedure Unregister_Thread_Id (Thread : System.Address);
+ pragma Export (C, Unregister_Thread_Id, "__gnat_unregister_thread_id");
+ -- Unregister the task associated with Thread from the GNAT run time and
+ -- destroy the memory allocated for its task id.
+ -- If no task id is associated with Thread, do nothing.
+ --
+ -- C declaration:
+ --
+ -- extern void __gnat_unregister_thread_id (pthread_t *thread);
+
procedure Destroy_Thread (Id : System.Address);
pragma Export (C, Destroy_Thread, "__gnat_destroy_thread");
-- This procedure may be used to prematurely abort the created thread.
--
-- extern void __gnat_get_thread (void *id, pthread_t *thread);
+ function To_Task_Id
+ (Id : System.Address)
+ return Ada.Task_Identification.Task_Id;
+ -- Ada interface only.
+ -- Given a low level Id, as returned by Create_Thread, return a Task_Id,
+ -- so that operations in Ada.Task_Identification can be used.
+
end GNAT.Threads;
OSDN Git Service
