OSDN Git Service

2005-06-14 Pascal Obry <obry@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / s-osinte-aix.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                 GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                 --
4 --                                                                          --
5 --                   S Y S T E M . O S _ I N T E R F A C E                  --
6 --                                                                          --
7 --                                  S p e c                                 --
8 --                                                                          --
9 --             Copyright (C) 1991-1994, Florida State University            --
10 --             Copyright (C) 1995-2005, Free Software Foundation, Inc.      --
11 --                                                                          --
12 -- GNARL is free software; you can  redistribute it  and/or modify it under --
13 -- terms of the  GNU General Public License as published  by the Free Soft- --
14 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
15 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
16 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
17 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
18 -- for  more details.  You should have  received  a copy of the GNU General --
19 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
20 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
21 -- MA 02111-1307, USA.                                                      --
22 --                                                                          --
23 -- As a special exception,  if other files  instantiate  generics from this --
24 -- unit, or you link  this unit with other files  to produce an executable, --
25 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
26 -- covered  by the  GNU  General  Public  License.  This exception does not --
27 -- however invalidate  any other reasons why  the executable file  might be --
28 -- covered by the  GNU Public License.                                      --
29 --                                                                          --
30 -- GNARL was developed by the GNARL team at Florida State University.       --
31 -- Extensive contributions were provided by Ada Core Technologies, Inc.     --
32 --                                                                          --
33 ------------------------------------------------------------------------------
34
35 --  This is a AIX (Native THREADS) version of this package
36
37 --  This package encapsulates all direct interfaces to OS services
38 --  that are needed by children of System.
39
40 --  PLEASE DO NOT add any with-clauses to this package or remove the pragma
41 --  Preelaborate. This package is designed to be a bottom-level (leaf) package.
42
43 with Interfaces.C;
44 with Unchecked_Conversion;
45
46 package System.OS_Interface is
47    pragma Preelaborate;
48
49    pragma Linker_Options ("-lpthreads");
50    pragma Linker_Options ("-lc_r");
51
52    subtype int            is Interfaces.C.int;
53    subtype short          is Interfaces.C.short;
54    subtype long           is Interfaces.C.long;
55    subtype unsigned       is Interfaces.C.unsigned;
56    subtype unsigned_short is Interfaces.C.unsigned_short;
57    subtype unsigned_long  is Interfaces.C.unsigned_long;
58    subtype unsigned_char  is Interfaces.C.unsigned_char;
59    subtype plain_char     is Interfaces.C.plain_char;
60    subtype size_t         is Interfaces.C.size_t;
61
62    -----------
63    -- Errno --
64    -----------
65
66    function errno return int;
67    pragma Import (C, errno, "__get_errno");
68
69    EAGAIN    : constant := 11;
70    EINTR     : constant := 4;
71    EINVAL    : constant := 22;
72    ENOMEM    : constant := 12;
73    ETIMEDOUT : constant := 78;
74
75    -------------
76    -- Signals --
77    -------------
78
79    Max_Interrupt : constant := 63;
80    type Signal is new int range 0 .. Max_Interrupt;
81    for Signal'Size use int'Size;
82
83    SIGHUP      : constant := 1; --  hangup
84    SIGINT      : constant := 2; --  interrupt (rubout)
85    SIGQUIT     : constant := 3; --  quit (ASCD FS)
86    SIGILL      : constant := 4; --  illegal instruction (not reset)
87    SIGTRAP     : constant := 5; --  trace trap (not reset)
88    SIGIOT      : constant := 6; --  IOT instruction
89    SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
90    SIGEMT      : constant := 7; --  EMT instruction
91    SIGFPE      : constant := 8; --  floating point exception
92    SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
93    SIGBUS      : constant := 10; --  bus error
94    SIGSEGV     : constant := 11; --  segmentation violation
95    SIGSYS      : constant := 12; --  bad argument to system call
96    SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
97    SIGALRM     : constant := 14; --  alarm clock
98    SIGTERM     : constant := 15; --  software termination signal from kill
99    SIGUSR1     : constant := 30; --  user defined signal 1
100    SIGUSR2     : constant := 31; --  user defined signal 2
101    SIGCLD      : constant := 20; --  alias for SIGCHLD
102    SIGCHLD     : constant := 20; --  child status change
103    SIGPWR      : constant := 29; --  power-fail restart
104    SIGWINCH    : constant := 28; --  window size change
105    SIGURG      : constant := 16; --  urgent condition on IO channel
106    SIGPOLL     : constant := 23; --  pollable event occurred
107    SIGIO       : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
108    SIGSTOP     : constant := 17; --  stop (cannot be caught or ignored)
109    SIGTSTP     : constant := 18; --  user stop requested from tty
110    SIGCONT     : constant := 19; --  stopped process has been continued
111    SIGTTIN     : constant := 21; --  background tty read attempted
112    SIGTTOU     : constant := 22; --  background tty write attempted
113    SIGVTALRM   : constant := 34; --  virtual timer expired
114    SIGPROF     : constant := 32; --  profiling timer expired
115    SIGXCPU     : constant := 24; --  CPU time limit exceeded
116    SIGXFSZ     : constant := 25; --  filesize limit exceeded
117    SIGWAITING  : constant := 39; --  m:n scheduling
118
119    --  the following signals are AIX specific
120    SIGMSG      : constant := 27; -- input data is in the ring buffer
121    SIGDANGER   : constant := 33; -- system crash imminent
122    SIGMIGRATE  : constant := 35; -- migrate process
123    SIGPRE      : constant := 36; -- programming exception
124    SIGVIRT     : constant := 37; -- AIX virtual time alarm
125    SIGALRM1    : constant := 38; -- m:n condition variables
126    SIGKAP      : constant := 60; -- keep alive poll from native keyboard
127    SIGGRANT    : constant := SIGKAP; -- monitor mode granted
128    SIGRETRACT  : constant := 61; -- monitor mode should be relinguished
129    SIGSOUND    : constant := 62; -- sound control has completed
130    SIGSAK      : constant := 63; -- secure attention key
131
132    SIGADAABORT : constant := SIGTERM;
133    --  Note: on other targets, we usually use SIGABRT, but on AiX, it
134    --  appears that SIGABRT can't be used in sigwait(), so we use SIGTERM.
135
136    type Signal_Set is array (Natural range <>) of Signal;
137
138    Unmasked    : constant Signal_Set :=
139      (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
140    Reserved    : constant Signal_Set := (SIGABRT, SIGKILL, SIGSTOP);
141
142    type sigset_t is private;
143
144    function sigaddset (set : access sigset_t; sig : Signal) return int;
145    pragma Import (C, sigaddset, "sigaddset");
146
147    function sigdelset (set : access sigset_t; sig : Signal) return int;
148    pragma Import (C, sigdelset, "sigdelset");
149
150    function sigfillset (set : access sigset_t) return int;
151    pragma Import (C, sigfillset, "sigfillset");
152
153    function sigismember (set : access sigset_t; sig : Signal) return int;
154    pragma Import (C, sigismember, "sigismember");
155
156    function sigemptyset (set : access sigset_t) return int;
157    pragma Import (C, sigemptyset, "sigemptyset");
158
159    type struct_sigaction is record
160       sa_handler : System.Address;
161       sa_mask    : sigset_t;
162       sa_flags   : int;
163    end record;
164    pragma Convention (C, struct_sigaction);
165    type struct_sigaction_ptr is access all struct_sigaction;
166
167    SA_SIGINFO  : constant := 16#0100#;
168
169    SIG_BLOCK   : constant := 0;
170    SIG_UNBLOCK : constant := 1;
171    SIG_SETMASK : constant := 2;
172
173    SIG_DFL : constant := 0;
174    SIG_IGN : constant := 1;
175
176    function sigaction
177      (sig  : Signal;
178       act  : struct_sigaction_ptr;
179       oact : struct_sigaction_ptr) return int;
180    pragma Import (C, sigaction, "sigaction");
181
182    ----------
183    -- Time --
184    ----------
185
186    Time_Slice_Supported : constant Boolean := False;
187    --  Indicates wether time slicing is supported
188
189    type timespec is private;
190
191    type clockid_t is private;
192
193    CLOCK_REALTIME : constant clockid_t;
194
195    function clock_gettime
196      (clock_id : clockid_t;
197       tp       : access timespec) return int;
198    --  AiX threads don't have clock_gettime
199    --  We instead use gettimeofday()
200
201    function To_Duration (TS : timespec) return Duration;
202    pragma Inline (To_Duration);
203
204    function To_Timespec (D : Duration) return timespec;
205    pragma Inline (To_Timespec);
206
207    type struct_timezone is record
208       tz_minuteswest : int;
209       tz_dsttime     : int;
210    end record;
211    pragma Convention (C, struct_timezone);
212    type struct_timezone_ptr is access all struct_timezone;
213
214    type struct_timeval is private;
215    --  This is needed on systems that do not have clock_gettime()
216    --  but do have gettimeofday().
217
218    function To_Duration (TV : struct_timeval) return Duration;
219    pragma Inline (To_Duration);
220
221    function To_Timeval (D : Duration) return struct_timeval;
222    pragma Inline (To_Timeval);
223
224    -------------------------
225    -- Priority Scheduling --
226    -------------------------
227
228    SCHED_FIFO  : constant := 1;
229    SCHED_RR    : constant := 2;
230    SCHED_OTHER : constant := 0;
231
232    -------------
233    -- Process --
234    -------------
235
236    type pid_t is private;
237
238    function kill (pid : pid_t; sig : Signal) return int;
239    pragma Import (C, kill, "kill");
240
241    function getpid return pid_t;
242    pragma Import (C, getpid, "getpid");
243
244    ---------
245    -- LWP --
246    ---------
247
248    function lwp_self return System.Address;
249    pragma Import (C, lwp_self, "thread_self");
250
251    -------------
252    -- Threads --
253    -------------
254
255    type Thread_Body is access
256      function (arg : System.Address) return System.Address;
257
258    function Thread_Body_Access is new
259      Unchecked_Conversion (System.Address, Thread_Body);
260
261    type pthread_t           is private;
262    subtype Thread_Id        is pthread_t;
263
264    type pthread_mutex_t     is limited private;
265    type pthread_cond_t      is limited private;
266    type pthread_attr_t      is limited private;
267    type pthread_mutexattr_t is limited private;
268    type pthread_condattr_t  is limited private;
269    type pthread_key_t       is private;
270
271    PTHREAD_CREATE_DETACHED : constant := 1;
272
273    -----------
274    -- Stack --
275    -----------
276
277    Stack_Base_Available : constant Boolean := False;
278    --  Indicates wether the stack base is available on this target.
279
280    function Get_Stack_Base (thread : pthread_t) return Address;
281    pragma Inline (Get_Stack_Base);
282    --  returns the stack base of the specified thread.
283    --  Only call this function when Stack_Base_Available is True.
284
285    function Get_Page_Size return size_t;
286    function Get_Page_Size return Address;
287    pragma Import (C, Get_Page_Size, "getpagesize");
288    --  returns the size of a page, or 0 if this is not relevant on this
289    --  target
290
291    PROT_NONE  : constant := 0;
292    PROT_READ  : constant := 1;
293    PROT_WRITE : constant := 2;
294    PROT_EXEC  : constant := 4;
295    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
296
297    PROT_ON    : constant := PROT_READ;
298    PROT_OFF   : constant := PROT_ALL;
299
300    function mprotect (addr : Address; len : size_t; prot : int) return int;
301    pragma Import (C, mprotect);
302
303    ---------------------------------------
304    -- Nonstandard Thread Initialization --
305    ---------------------------------------
306
307    --  Though not documented, pthread_init *must* be called before any other
308    --  pthread call
309
310    procedure pthread_init;
311    pragma Import (C, pthread_init, "pthread_init");
312
313    -------------------------
314    -- POSIX.1c  Section 3 --
315    -------------------------
316
317    function sigwait
318      (set : access sigset_t;
319       sig : access Signal) return int;
320    pragma Import (C, sigwait, "sigwait");
321
322    function pthread_kill
323      (thread : pthread_t;
324       sig    : Signal) return int;
325    pragma Import (C, pthread_kill, "pthread_kill");
326
327    type sigset_t_ptr is access all sigset_t;
328
329    function pthread_sigmask
330      (how  : int;
331       set  : sigset_t_ptr;
332       oset : sigset_t_ptr) return int;
333    pragma Import (C, pthread_sigmask, "sigthreadmask");
334
335    --------------------------
336    -- POSIX.1c  Section 11 --
337    --------------------------
338
339    function pthread_mutexattr_init
340      (attr : access pthread_mutexattr_t) return int;
341    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
342
343    function pthread_mutexattr_destroy
344      (attr : access pthread_mutexattr_t) return int;
345    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
346
347    function pthread_mutex_init
348      (mutex : access pthread_mutex_t;
349       attr  : access pthread_mutexattr_t) return int;
350    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
351
352    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
353    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
354
355    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
356    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
357
358    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
359    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
360
361    function pthread_condattr_init
362      (attr : access pthread_condattr_t) return int;
363    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
364
365    function pthread_condattr_destroy
366      (attr : access pthread_condattr_t) return int;
367    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
368
369    function pthread_cond_init
370      (cond : access pthread_cond_t;
371       attr : access pthread_condattr_t) return int;
372    pragma Import (C, pthread_cond_init, "pthread_cond_init");
373
374    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
375    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
376
377    function pthread_cond_signal (cond : access pthread_cond_t) return int;
378    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
379
380    function pthread_cond_wait
381      (cond  : access pthread_cond_t;
382       mutex : access pthread_mutex_t) return int;
383    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
384
385    function pthread_cond_timedwait
386      (cond    : access pthread_cond_t;
387       mutex   : access pthread_mutex_t;
388       abstime : access timespec) return int;
389    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
390
391    Relative_Timed_Wait : constant Boolean := False;
392    --  pthread_cond_timedwait requires an absolute delay time
393
394    --------------------------
395    -- POSIX.1c  Section 13 --
396    --------------------------
397
398    PTHREAD_PRIO_NONE    : constant := 0;
399    PTHREAD_PRIO_PROTECT : constant := 0;
400    PTHREAD_PRIO_INHERIT : constant := 0;
401
402    function pthread_mutexattr_setprotocol
403      (attr     : access pthread_mutexattr_t;
404       protocol : int) return int;
405    pragma Import (C, pthread_mutexattr_setprotocol);
406
407    function pthread_mutexattr_setprioceiling
408      (attr        : access pthread_mutexattr_t;
409       prioceiling : int) return int;
410    pragma Import (C, pthread_mutexattr_setprioceiling);
411
412    type Array_5_Int is array (0 .. 5) of int;
413    type struct_sched_param is record
414       sched_priority : int;
415       sched_policy   : int;
416       sched_reserved : Array_5_Int;
417    end record;
418
419    function pthread_setschedparam
420      (thread : pthread_t;
421       policy : int;
422       param  : access struct_sched_param) return int;
423    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
424
425    function pthread_attr_setscope
426      (attr            : access pthread_attr_t;
427       contentionscope : int) return int;
428    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
429
430    function pthread_attr_setinheritsched
431      (attr            : access pthread_attr_t;
432       inheritsched : int) return int;
433    pragma Import (C, pthread_attr_setinheritsched);
434
435    function pthread_attr_setschedpolicy
436      (attr   : access pthread_attr_t;
437       policy : int) return int;
438    pragma Import (C, pthread_attr_setschedpolicy);
439
440    function pthread_attr_setschedparam
441      (attr        : access pthread_attr_t;
442       sched_param : int) return int;
443    pragma Import (C, pthread_attr_setschedparam);
444
445    function sched_yield return int;
446    --  AiX have a nonstandard sched_yield.
447
448    --------------------------
449    -- P1003.1c  Section 16 --
450    --------------------------
451
452    function pthread_attr_init (attributes : access pthread_attr_t) return int;
453    pragma Import (C, pthread_attr_init, "pthread_attr_init");
454
455    function pthread_attr_destroy
456      (attributes : access pthread_attr_t) return int;
457    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
458
459    function pthread_attr_setdetachstate
460      (attr        : access pthread_attr_t;
461       detachstate : int) return int;
462    pragma Import (C, pthread_attr_setdetachstate);
463
464    function pthread_attr_setstacksize
465      (attr      : access pthread_attr_t;
466       stacksize : size_t) return int;
467    pragma Import (C, pthread_attr_setstacksize);
468
469    function pthread_create
470      (thread        : access pthread_t;
471       attributes    : access pthread_attr_t;
472       start_routine : Thread_Body;
473       arg           : System.Address)
474      return int;
475    pragma Import (C, pthread_create, "pthread_create");
476
477    procedure pthread_exit (status : System.Address);
478    pragma Import (C, pthread_exit, "pthread_exit");
479
480    function pthread_self return pthread_t;
481    pragma Import (C, pthread_self, "pthread_self");
482
483    --------------------------
484    -- POSIX.1c  Section 17 --
485    --------------------------
486
487    function pthread_setspecific
488      (key   : pthread_key_t;
489       value : System.Address) return int;
490    pragma Import (C, pthread_setspecific, "pthread_setspecific");
491
492    function pthread_getspecific (key : pthread_key_t) return System.Address;
493    pragma Import (C, pthread_getspecific, "pthread_getspecific");
494
495    type destructor_pointer is access
496       procedure (arg : System.Address);
497
498    function pthread_key_create
499      (key        : access pthread_key_t;
500       destructor : destructor_pointer) return int;
501    pragma Import (C, pthread_key_create, "pthread_key_create");
502
503 private
504
505    type sigset_t is record
506       losigs : unsigned_long;
507       hisigs : unsigned_long;
508    end record;
509    pragma Convention (C_Pass_By_Copy, sigset_t);
510
511    type pid_t is new int;
512
513    type time_t is new long;
514
515    type timespec is record
516       tv_sec  : time_t;
517       tv_nsec : long;
518    end record;
519    pragma Convention (C, timespec);
520
521    type clockid_t is new int;
522    CLOCK_REALTIME : constant clockid_t := 0;
523
524    type struct_timeval is record
525       tv_sec  : long;
526       tv_usec : long;
527    end record;
528    pragma Convention (C, struct_timeval);
529
530    type pthread_attr_t is new System.Address;
531    pragma Convention (C, pthread_attr_t);
532    --  typedef struct __pt_attr        *pthread_attr_t;
533
534    type pthread_condattr_t is new System.Address;
535    pragma Convention (C, pthread_condattr_t);
536    --  typedef struct __pt_attr        *pthread_condattr_t;
537
538    type pthread_mutexattr_t is new System.Address;
539    pragma Convention (C, pthread_mutexattr_t);
540    --  typedef struct __pt_attr        *pthread_mutexattr_t;
541
542    type pthread_t is new System.Address;
543    pragma Convention (C, pthread_t);
544    --  typedef void    *pthread_t;
545
546    type ptq_queue;
547    type ptq_queue_ptr is access all ptq_queue;
548
549    type ptq_queue is record
550       ptq_next : ptq_queue_ptr;
551       ptq_prev : ptq_queue_ptr;
552    end record;
553
554    type Array_3_Int is array (0 .. 3) of int;
555    type pthread_mutex_t is record
556         link        : ptq_queue;
557         ptmtx_lock  : int;
558         ptmtx_flags : long;
559         protocol    : int;
560         prioceiling : int;
561         ptmtx_owner : pthread_t;
562         mtx_id      : int;
563         attr        : pthread_attr_t;
564         mtx_kind    : int;
565         lock_cpt    : int;
566         reserved    : Array_3_Int;
567    end record;
568    pragma Convention (C, pthread_mutex_t);
569    type pthread_mutex_t_ptr is access pthread_mutex_t;
570
571    type pthread_cond_t is record
572       link         : ptq_queue;
573       ptcv_lock    : int;
574       ptcv_flags   : long;
575       ptcv_waiters : ptq_queue;
576       cv_id        : int;
577       attr         : pthread_attr_t;
578       mutex        : pthread_mutex_t_ptr;
579       cptwait      : int;
580       reserved     : int;
581    end record;
582    pragma Convention (C, pthread_cond_t);
583
584    type pthread_key_t is new unsigned;
585
586 end System.OS_Interface;