1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS --
5 -- S Y S T E M . O S _ I N T E R F A C E --
9 -- Copyright (C) 1991-1994, Florida State University --
10 -- Copyright (C) 1995-2011, Free Software Foundation, Inc. --
12 -- GNAT 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 3, or (at your option) any later ver- --
15 -- sion. GNAT 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. --
19 -- As a special exception under Section 7 of GPL version 3, you are granted --
20 -- additional permissions described in the GCC Runtime Library Exception, --
21 -- version 3.1, as published by the Free Software Foundation. --
23 -- You should have received a copy of the GNU General Public License and --
24 -- a copy of the GCC Runtime Library Exception along with this program; --
25 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
26 -- <http://www.gnu.org/licenses/>. --
28 -- GNARL was developed by the GNARL team at Florida State University. --
29 -- Extensive contributions were provided by Ada Core Technologies, Inc. --
31 ------------------------------------------------------------------------------
33 -- This is a AIX (Native THREADS) version of this package
35 -- This package encapsulates all direct interfaces to OS services that are
36 -- needed by the tasking run-time (libgnarl).
38 -- PLEASE DO NOT add any with-clauses to this package or remove the pragma
39 -- Preelaborate. This package is designed to be a bottom-level (leaf) package.
41 with Ada.Unchecked_Conversion;
45 package System.OS_Interface is
48 pragma Linker_Options ("-pthread");
49 -- This implies -lpthreads + other things depending on the GCC
50 -- configuration, such as the selection of a proper libgcc variant
51 -- for table-based exception handling when it is available.
53 pragma Linker_Options ("-lc_r");
55 subtype int is Interfaces.C.int;
56 subtype short is Interfaces.C.short;
57 subtype long is Interfaces.C.long;
58 subtype unsigned is Interfaces.C.unsigned;
59 subtype unsigned_short is Interfaces.C.unsigned_short;
60 subtype unsigned_long is Interfaces.C.unsigned_long;
61 subtype unsigned_char is Interfaces.C.unsigned_char;
62 subtype plain_char is Interfaces.C.plain_char;
63 subtype size_t is Interfaces.C.size_t;
69 function errno return int;
70 pragma Import (C, errno, "__get_errno");
72 EAGAIN : constant := 11;
73 EINTR : constant := 4;
74 EINVAL : constant := 22;
75 ENOMEM : constant := 12;
76 ETIMEDOUT : constant := 78;
82 Max_Interrupt : constant := 63;
83 type Signal is new int range 0 .. Max_Interrupt;
84 for Signal'Size use int'Size;
86 SIGHUP : constant := 1; -- hangup
87 SIGINT : constant := 2; -- interrupt (rubout)
88 SIGQUIT : constant := 3; -- quit (ASCD FS)
89 SIGILL : constant := 4; -- illegal instruction (not reset)
90 SIGTRAP : constant := 5; -- trace trap (not reset)
91 SIGIOT : constant := 6; -- IOT instruction
92 SIGABRT : constant := 6; -- used by abort, replace SIGIOT in the future
93 SIGEMT : constant := 7; -- EMT instruction
94 SIGFPE : constant := 8; -- floating point exception
95 SIGKILL : constant := 9; -- kill (cannot be caught or ignored)
96 SIGBUS : constant := 10; -- bus error
97 SIGSEGV : constant := 11; -- segmentation violation
98 SIGSYS : constant := 12; -- bad argument to system call
99 SIGPIPE : constant := 13; -- write on a pipe with no one to read it
100 SIGALRM : constant := 14; -- alarm clock
101 SIGTERM : constant := 15; -- software termination signal from kill
102 SIGUSR1 : constant := 30; -- user defined signal 1
103 SIGUSR2 : constant := 31; -- user defined signal 2
104 SIGCLD : constant := 20; -- alias for SIGCHLD
105 SIGCHLD : constant := 20; -- child status change
106 SIGPWR : constant := 29; -- power-fail restart
107 SIGWINCH : constant := 28; -- window size change
108 SIGURG : constant := 16; -- urgent condition on IO channel
109 SIGPOLL : constant := 23; -- pollable event occurred
110 SIGIO : constant := 23; -- I/O possible (Solaris SIGPOLL alias)
111 SIGSTOP : constant := 17; -- stop (cannot be caught or ignored)
112 SIGTSTP : constant := 18; -- user stop requested from tty
113 SIGCONT : constant := 19; -- stopped process has been continued
114 SIGTTIN : constant := 21; -- background tty read attempted
115 SIGTTOU : constant := 22; -- background tty write attempted
116 SIGVTALRM : constant := 34; -- virtual timer expired
117 SIGPROF : constant := 32; -- profiling timer expired
118 SIGXCPU : constant := 24; -- CPU time limit exceeded
119 SIGXFSZ : constant := 25; -- filesize limit exceeded
120 SIGWAITING : constant := 39; -- m:n scheduling
122 -- The following signals are AIX specific
124 SIGMSG : constant := 27; -- input data is in the ring buffer
125 SIGDANGER : constant := 33; -- system crash imminent
126 SIGMIGRATE : constant := 35; -- migrate process
127 SIGPRE : constant := 36; -- programming exception
128 SIGVIRT : constant := 37; -- AIX virtual time alarm
129 SIGALRM1 : constant := 38; -- m:n condition variables
130 SIGCPUFAIL : constant := 59; -- Predictive De-configuration of Processors
131 SIGKAP : constant := 60; -- keep alive poll from native keyboard
132 SIGGRANT : constant := SIGKAP; -- monitor mode granted
133 SIGRETRACT : constant := 61; -- monitor mode should be relinquished
134 SIGSOUND : constant := 62; -- sound control has completed
135 SIGSAK : constant := 63; -- secure attention key
137 SIGADAABORT : constant := SIGEMT;
138 -- Note: on other targets, we usually use SIGABRT, but on AIX, it appears
139 -- that SIGABRT can't be used in sigwait(), so we use SIGEMT.
140 -- SIGEMT is "Emulator Trap Instruction" from the PDP-11, and does not
141 -- have a standardized usage.
143 type Signal_Set is array (Natural range <>) of Signal;
145 Unmasked : constant Signal_Set :=
146 (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
147 Reserved : constant Signal_Set :=
148 (SIGABRT, SIGKILL, SIGSTOP, SIGALRM1, SIGWAITING, SIGCPUFAIL);
150 type sigset_t is private;
152 function sigaddset (set : access sigset_t; sig : Signal) return int;
153 pragma Import (C, sigaddset, "sigaddset");
155 function sigdelset (set : access sigset_t; sig : Signal) return int;
156 pragma Import (C, sigdelset, "sigdelset");
158 function sigfillset (set : access sigset_t) return int;
159 pragma Import (C, sigfillset, "sigfillset");
161 function sigismember (set : access sigset_t; sig : Signal) return int;
162 pragma Import (C, sigismember, "sigismember");
164 function sigemptyset (set : access sigset_t) return int;
165 pragma Import (C, sigemptyset, "sigemptyset");
167 type struct_sigaction is record
168 sa_handler : System.Address;
172 pragma Convention (C, struct_sigaction);
173 type struct_sigaction_ptr is access all struct_sigaction;
175 SA_SIGINFO : constant := 16#0100#;
176 SA_ONSTACK : constant := 16#0001#;
178 SIG_BLOCK : constant := 0;
179 SIG_UNBLOCK : constant := 1;
180 SIG_SETMASK : constant := 2;
182 SIG_DFL : constant := 0;
183 SIG_IGN : constant := 1;
187 act : struct_sigaction_ptr;
188 oact : struct_sigaction_ptr) return int;
189 pragma Import (C, sigaction, "sigaction");
195 Time_Slice_Supported : constant Boolean := True;
196 -- Indicates whether time slicing is supported
198 type timespec is private;
200 type clockid_t is private;
202 CLOCK_REALTIME : constant clockid_t;
203 CLOCK_MONOTONIC : constant clockid_t;
205 function clock_gettime
206 (clock_id : clockid_t;
207 tp : access timespec) return int;
209 function To_Duration (TS : timespec) return Duration;
210 pragma Inline (To_Duration);
212 function To_Timespec (D : Duration) return timespec;
213 pragma Inline (To_Timespec);
215 type struct_timezone is record
216 tz_minuteswest : int;
219 pragma Convention (C, struct_timezone);
220 type struct_timezone_ptr is access all struct_timezone;
222 -------------------------
223 -- Priority Scheduling --
224 -------------------------
226 SCHED_FIFO : constant := 1;
227 SCHED_RR : constant := 2;
228 SCHED_OTHER : constant := 0;
230 function To_Target_Priority
231 (Prio : System.Any_Priority) return Interfaces.C.int;
232 -- Maps System.Any_Priority to a POSIX priority
238 type pid_t is private;
240 function kill (pid : pid_t; sig : Signal) return int;
241 pragma Import (C, kill, "kill");
243 function getpid return pid_t;
244 pragma Import (C, getpid, "getpid");
250 function lwp_self return System.Address;
251 pragma Import (C, lwp_self, "thread_self");
257 type Thread_Body is access
258 function (arg : System.Address) return System.Address;
259 pragma Convention (C, Thread_Body);
261 function Thread_Body_Access is new
262 Ada.Unchecked_Conversion (System.Address, Thread_Body);
264 type pthread_t is private;
265 subtype Thread_Id is pthread_t;
267 type pthread_mutex_t is limited private;
268 type pthread_cond_t is limited private;
269 type pthread_attr_t is limited private;
270 type pthread_mutexattr_t is limited private;
271 type pthread_condattr_t is limited private;
272 type pthread_key_t is private;
274 PTHREAD_CREATE_DETACHED : constant := 1;
276 PTHREAD_SCOPE_PROCESS : constant := 1;
277 PTHREAD_SCOPE_SYSTEM : constant := 0;
279 -- Read/Write lock not supported on AIX. To add support both types
280 -- pthread_rwlock_t and pthread_rwlockattr_t must properly be defined
281 -- with the associated routines pthread_rwlock_[init/destroy] and
282 -- pthread_rwlock_[rdlock/wrlock/unlock].
284 subtype pthread_rwlock_t is pthread_mutex_t;
285 subtype pthread_rwlockattr_t is pthread_mutexattr_t;
291 type stack_t is record
292 ss_sp : System.Address;
296 pragma Convention (C, stack_t);
299 (ss : not null access stack_t;
300 oss : access stack_t) return int;
301 pragma Import (C, sigaltstack, "sigaltstack");
303 Alternate_Stack : aliased System.Address;
304 -- This is a dummy definition, never used (Alternate_Stack_Size is null)
306 Alternate_Stack_Size : constant := 0;
307 -- No alternate signal stack is used on this platform
309 Stack_Base_Available : constant Boolean := False;
310 -- Indicates whether the stack base is available on this target
312 function Get_Stack_Base (thread : pthread_t) return Address;
313 pragma Inline (Get_Stack_Base);
314 -- Returns the stack base of the specified thread. Only call this function
315 -- when Stack_Base_Available is True.
317 function Get_Page_Size return size_t;
318 function Get_Page_Size return Address;
319 pragma Import (C, Get_Page_Size, "getpagesize");
320 -- Returns the size of a page
322 PROT_NONE : constant := 0;
323 PROT_READ : constant := 1;
324 PROT_WRITE : constant := 2;
325 PROT_EXEC : constant := 4;
326 PROT_ALL : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
327 PROT_ON : constant := PROT_READ;
328 PROT_OFF : constant := PROT_ALL;
330 function mprotect (addr : Address; len : size_t; prot : int) return int;
331 pragma Import (C, mprotect);
333 ---------------------------------------
334 -- Nonstandard Thread Initialization --
335 ---------------------------------------
337 -- Though not documented, pthread_init *must* be called before any other
340 procedure pthread_init;
341 pragma Import (C, pthread_init, "pthread_init");
343 -------------------------
344 -- POSIX.1c Section 3 --
345 -------------------------
348 (set : access sigset_t;
349 sig : access Signal) return int;
350 pragma Import (C, sigwait, "sigwait");
352 function pthread_kill
354 sig : Signal) return int;
355 pragma Import (C, pthread_kill, "pthread_kill");
357 function pthread_sigmask
359 set : access sigset_t;
360 oset : access sigset_t) return int;
361 pragma Import (C, pthread_sigmask, "sigthreadmask");
363 --------------------------
364 -- POSIX.1c Section 11 --
365 --------------------------
367 function pthread_mutexattr_init
368 (attr : access pthread_mutexattr_t) return int;
369 pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
371 function pthread_mutexattr_destroy
372 (attr : access pthread_mutexattr_t) return int;
373 pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
375 function pthread_mutex_init
376 (mutex : access pthread_mutex_t;
377 attr : access pthread_mutexattr_t) return int;
378 pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
380 function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
381 pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
383 function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
384 pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
386 function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
387 pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
389 function pthread_condattr_init
390 (attr : access pthread_condattr_t) return int;
391 pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
393 function pthread_condattr_destroy
394 (attr : access pthread_condattr_t) return int;
395 pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
397 function pthread_cond_init
398 (cond : access pthread_cond_t;
399 attr : access pthread_condattr_t) return int;
400 pragma Import (C, pthread_cond_init, "pthread_cond_init");
402 function pthread_cond_destroy (cond : access pthread_cond_t) return int;
403 pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
405 function pthread_cond_signal (cond : access pthread_cond_t) return int;
406 pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
408 function pthread_cond_wait
409 (cond : access pthread_cond_t;
410 mutex : access pthread_mutex_t) return int;
411 pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
413 function pthread_cond_timedwait
414 (cond : access pthread_cond_t;
415 mutex : access pthread_mutex_t;
416 abstime : access timespec) return int;
417 pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
419 Relative_Timed_Wait : constant Boolean := False;
420 -- pthread_cond_timedwait requires an absolute delay time
422 --------------------------
423 -- POSIX.1c Section 13 --
424 --------------------------
426 PTHREAD_PRIO_PROTECT : constant := 2;
428 function PTHREAD_PRIO_INHERIT return int;
429 -- Return value of C macro PTHREAD_PRIO_INHERIT. This function is needed
430 -- since the value is different between AIX versions.
432 function pthread_mutexattr_setprotocol
433 (attr : access pthread_mutexattr_t;
434 protocol : int) return int;
435 pragma Import (C, pthread_mutexattr_setprotocol);
437 function pthread_mutexattr_setprioceiling
438 (attr : access pthread_mutexattr_t;
439 prioceiling : int) return int;
440 pragma Import (C, pthread_mutexattr_setprioceiling);
442 type Array_5_Int is array (0 .. 5) of int;
443 type struct_sched_param is record
444 sched_priority : int;
446 sched_reserved : Array_5_Int;
449 function pthread_setschedparam
452 param : access struct_sched_param) return int;
453 pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
455 function pthread_attr_setscope
456 (attr : access pthread_attr_t;
457 contentionscope : int) return int;
458 pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
460 function pthread_attr_setinheritsched
461 (attr : access pthread_attr_t;
462 inheritsched : int) return int;
463 pragma Import (C, pthread_attr_setinheritsched);
465 function pthread_attr_setschedpolicy
466 (attr : access pthread_attr_t;
467 policy : int) return int;
468 pragma Import (C, pthread_attr_setschedpolicy);
470 function pthread_attr_setschedparam
471 (attr : access pthread_attr_t;
472 sched_param : int) return int;
473 pragma Import (C, pthread_attr_setschedparam);
475 function sched_yield return int;
476 -- AIX have a nonstandard sched_yield
478 --------------------------
479 -- P1003.1c Section 16 --
480 --------------------------
482 function pthread_attr_init (attributes : access pthread_attr_t) return int;
483 pragma Import (C, pthread_attr_init, "pthread_attr_init");
485 function pthread_attr_destroy
486 (attributes : access pthread_attr_t) return int;
487 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
489 function pthread_attr_setdetachstate
490 (attr : access pthread_attr_t;
491 detachstate : int) return int;
492 pragma Import (C, pthread_attr_setdetachstate);
494 function pthread_attr_setstacksize
495 (attr : access pthread_attr_t;
496 stacksize : size_t) return int;
497 pragma Import (C, pthread_attr_setstacksize);
499 function pthread_create
500 (thread : access pthread_t;
501 attributes : access pthread_attr_t;
502 start_routine : Thread_Body;
503 arg : System.Address)
505 pragma Import (C, pthread_create, "pthread_create");
507 procedure pthread_exit (status : System.Address);
508 pragma Import (C, pthread_exit, "pthread_exit");
510 function pthread_self return pthread_t;
511 pragma Import (C, pthread_self, "pthread_self");
513 --------------------------
514 -- POSIX.1c Section 17 --
515 --------------------------
517 function pthread_setspecific
518 (key : pthread_key_t;
519 value : System.Address) return int;
520 pragma Import (C, pthread_setspecific, "pthread_setspecific");
522 function pthread_getspecific (key : pthread_key_t) return System.Address;
523 pragma Import (C, pthread_getspecific, "pthread_getspecific");
525 type destructor_pointer is access procedure (arg : System.Address);
526 pragma Convention (C, destructor_pointer);
528 function pthread_key_create
529 (key : access pthread_key_t;
530 destructor : destructor_pointer) return int;
531 pragma Import (C, pthread_key_create, "pthread_key_create");
534 type sigset_t is record
535 losigs : unsigned_long;
536 hisigs : unsigned_long;
538 pragma Convention (C_Pass_By_Copy, sigset_t);
540 type pid_t is new int;
542 type time_t is new long;
544 type timespec is record
548 pragma Convention (C, timespec);
550 type clockid_t is new int;
551 CLOCK_REALTIME : constant clockid_t := 9;
552 CLOCK_MONOTONIC : constant clockid_t := 10;
554 type pthread_attr_t is new System.Address;
555 pragma Convention (C, pthread_attr_t);
556 -- typedef struct __pt_attr *pthread_attr_t;
558 type pthread_condattr_t is new System.Address;
559 pragma Convention (C, pthread_condattr_t);
560 -- typedef struct __pt_attr *pthread_condattr_t;
562 type pthread_mutexattr_t is new System.Address;
563 pragma Convention (C, pthread_mutexattr_t);
564 -- typedef struct __pt_attr *pthread_mutexattr_t;
566 type pthread_t is new System.Address;
567 pragma Convention (C, pthread_t);
568 -- typedef void *pthread_t;
571 type ptq_queue_ptr is access all ptq_queue;
573 type ptq_queue is record
574 ptq_next : ptq_queue_ptr;
575 ptq_prev : ptq_queue_ptr;
578 type Array_3_Int is array (0 .. 3) of int;
579 type pthread_mutex_t is record
585 ptmtx_owner : pthread_t;
587 attr : pthread_attr_t;
590 reserved : Array_3_Int;
592 pragma Convention (C, pthread_mutex_t);
593 type pthread_mutex_t_ptr is access pthread_mutex_t;
595 type pthread_cond_t is record
599 ptcv_waiters : ptq_queue;
601 attr : pthread_attr_t;
602 mutex : pthread_mutex_t_ptr;
606 pragma Convention (C, pthread_cond_t);
608 type pthread_key_t is new unsigned;
610 end System.OS_Interface;