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 Darwin pthreads version of this package
35 -- This package includes all direct interfaces to OS services that are needed
36 -- by the tasking run-time (libgnarl).
38 -- PLEASE DO NOT add any with-clauses to this package or remove the pragma
39 -- Elaborate_Body. It is designed to be a bottom-level (leaf) package.
42 with System.OS_Constants;
44 package System.OS_Interface is
47 subtype int is Interfaces.C.int;
48 subtype short is Interfaces.C.short;
49 subtype long is Interfaces.C.long;
50 subtype unsigned is Interfaces.C.unsigned;
51 subtype unsigned_short is Interfaces.C.unsigned_short;
52 subtype unsigned_long is Interfaces.C.unsigned_long;
53 subtype unsigned_char is Interfaces.C.unsigned_char;
54 subtype plain_char is Interfaces.C.plain_char;
55 subtype size_t is Interfaces.C.size_t;
61 function errno return int;
62 pragma Import (C, errno, "__get_errno");
64 EINTR : constant := 4;
65 ENOMEM : constant := 12;
66 EINVAL : constant := 22;
67 EAGAIN : constant := 35;
68 ETIMEDOUT : constant := 60;
74 Max_Interrupt : constant := 31;
75 type Signal is new int range 0 .. Max_Interrupt;
76 for Signal'Size use int'Size;
78 SIGHUP : constant := 1; -- hangup
79 SIGINT : constant := 2; -- interrupt (rubout)
80 SIGQUIT : constant := 3; -- quit (ASCD FS)
81 SIGILL : constant := 4; -- illegal instruction (not reset)
82 SIGTRAP : constant := 5; -- trace trap (not reset)
83 SIGIOT : constant := 6; -- IOT instruction
84 SIGABRT : constant := 6; -- used by abort, replace SIGIOT in the future
85 SIGEMT : constant := 7; -- EMT instruction
86 SIGFPE : constant := 8; -- floating point exception
87 SIGKILL : constant := 9; -- kill (cannot be caught or ignored)
88 SIGBUS : constant := 10; -- bus error
89 SIGSEGV : constant := 11; -- segmentation violation
90 SIGSYS : constant := 12; -- bad argument to system call
91 SIGPIPE : constant := 13; -- write on a pipe with no one to read it
92 SIGALRM : constant := 14; -- alarm clock
93 SIGTERM : constant := 15; -- software termination signal from kill
94 SIGURG : constant := 16; -- urgent condition on IO channel
95 SIGSTOP : constant := 17; -- stop (cannot be caught or ignored)
96 SIGTSTP : constant := 18; -- user stop requested from tty
97 SIGCONT : constant := 19; -- stopped process has been continued
98 SIGCHLD : constant := 20; -- child status change
99 SIGTTIN : constant := 21; -- background tty read attempted
100 SIGTTOU : constant := 22; -- background tty write attempted
101 SIGIO : constant := 23; -- I/O possible (Solaris SIGPOLL alias)
102 SIGXCPU : constant := 24; -- CPU time limit exceeded
103 SIGXFSZ : constant := 25; -- filesize limit exceeded
104 SIGVTALRM : constant := 26; -- virtual timer expired
105 SIGPROF : constant := 27; -- profiling timer expired
106 SIGWINCH : constant := 28; -- window size change
107 SIGINFO : constant := 29; -- information request
108 SIGUSR1 : constant := 30; -- user defined signal 1
109 SIGUSR2 : constant := 31; -- user defined signal 2
111 SIGADAABORT : constant := SIGTERM;
112 -- Change this if you want to use another signal for task abort.
113 -- SIGTERM might be a good one.
115 type Signal_Set is array (Natural range <>) of Signal;
117 Unmasked : constant Signal_Set :=
118 (SIGTTIN, SIGTTOU, SIGSTOP, SIGTSTP);
120 Reserved : constant Signal_Set :=
123 Exception_Signals : constant Signal_Set :=
124 (SIGFPE, SIGILL, SIGSEGV, SIGBUS);
125 -- These signals (when runtime or system) will be caught and converted
126 -- into an Ada exception.
128 type sigset_t is private;
130 function sigaddset (set : access sigset_t; sig : Signal) return int;
131 pragma Import (C, sigaddset, "sigaddset");
133 function sigdelset (set : access sigset_t; sig : Signal) return int;
134 pragma Import (C, sigdelset, "sigdelset");
136 function sigfillset (set : access sigset_t) return int;
137 pragma Import (C, sigfillset, "sigfillset");
139 function sigismember (set : access sigset_t; sig : Signal) return int;
140 pragma Import (C, sigismember, "sigismember");
142 function sigemptyset (set : access sigset_t) return int;
143 pragma Import (C, sigemptyset, "sigemptyset");
145 type siginfo_t is private;
146 type ucontext_t is private;
148 type Signal_Handler is access procedure
150 info : access siginfo_t;
151 context : access ucontext_t);
153 type struct_sigaction is record
154 sa_handler : System.Address;
158 pragma Convention (C, struct_sigaction);
159 type struct_sigaction_ptr is access all struct_sigaction;
161 SIG_BLOCK : constant := 1;
162 SIG_UNBLOCK : constant := 2;
163 SIG_SETMASK : constant := 3;
165 SIG_DFL : constant := 0;
166 SIG_IGN : constant := 1;
168 SA_SIGINFO : constant := 16#0040#;
169 SA_ONSTACK : constant := 16#0001#;
173 act : struct_sigaction_ptr;
174 oact : struct_sigaction_ptr) return int;
175 pragma Import (C, sigaction, "sigaction");
181 Time_Slice_Supported : constant Boolean := True;
182 -- Indicates whether time slicing is supported
184 type timespec is private;
186 type clockid_t is private;
188 CLOCK_REALTIME : constant clockid_t;
189 CLOCK_MONOTONIC : constant clockid_t;
191 function clock_gettime
192 (clock_id : clockid_t;
193 tp : access timespec) return int;
195 function To_Duration (TS : timespec) return Duration;
196 pragma Inline (To_Duration);
198 function To_Timespec (D : Duration) return timespec;
199 pragma Inline (To_Timespec);
201 -------------------------
202 -- Priority Scheduling --
203 -------------------------
205 SCHED_OTHER : constant := 1;
206 SCHED_RR : constant := 2;
207 SCHED_FIFO : constant := 4;
209 function To_Target_Priority
210 (Prio : System.Any_Priority) return Interfaces.C.int;
211 -- Maps System.Any_Priority to a POSIX priority
217 type pid_t is private;
219 function kill (pid : pid_t; sig : Signal) return int;
220 pragma Import (C, kill, "kill");
222 function getpid return pid_t;
223 pragma Import (C, getpid, "getpid");
229 function lwp_self return System.Address;
230 -- Return the mach thread bound to the current thread. The value is not
231 -- used by the run-time library but made available to debuggers.
237 type Thread_Body is access
238 function (arg : System.Address) return System.Address;
239 pragma Convention (C, Thread_Body);
241 type pthread_t is private;
242 subtype Thread_Id is pthread_t;
244 type pthread_mutex_t is limited private;
245 type pthread_cond_t is limited private;
246 type pthread_attr_t is limited private;
247 type pthread_mutexattr_t is limited private;
248 type pthread_condattr_t is limited private;
249 type pthread_key_t is private;
251 type pthread_mutex_ptr is access all pthread_mutex_t;
252 type pthread_cond_ptr is access all pthread_cond_t;
254 PTHREAD_CREATE_DETACHED : constant := 2;
256 PTHREAD_SCOPE_PROCESS : constant := 2;
257 PTHREAD_SCOPE_SYSTEM : constant := 1;
263 type stack_t is record
264 ss_sp : System.Address;
268 pragma Convention (C, stack_t);
271 (ss : not null access stack_t;
272 oss : access stack_t) return int;
273 pragma Import (C, sigaltstack, "sigaltstack");
275 Alternate_Stack : aliased System.Address;
276 pragma Import (C, Alternate_Stack, "__gnat_alternate_stack");
277 -- The alternate signal stack for stack overflows
279 Alternate_Stack_Size : constant := 32 * 1024;
280 -- This must be in keeping with init.c:__gnat_alternate_stack
282 Stack_Base_Available : constant Boolean := False;
283 -- Indicates whether the stack base is available on this target. This
284 -- allows us to share s-osinte.adb between all the FSU run time. Note that
285 -- this value can only be true if pthread_t has a complete definition that
286 -- corresponds exactly to the C header files.
288 function Get_Stack_Base (thread : pthread_t) return System.Address;
289 pragma Inline (Get_Stack_Base);
290 -- returns the stack base of the specified thread. Only call this function
291 -- when Stack_Base_Available is True.
293 function Get_Page_Size return size_t;
294 function Get_Page_Size return System.Address;
295 pragma Import (C, Get_Page_Size, "getpagesize");
296 -- Returns the size of a page
298 PROT_NONE : constant := 0;
299 PROT_READ : constant := 1;
300 PROT_WRITE : constant := 2;
301 PROT_EXEC : constant := 4;
302 PROT_ALL : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
304 PROT_ON : constant := PROT_NONE;
305 PROT_OFF : constant := PROT_ALL;
308 (addr : System.Address;
310 prot : int) return int;
311 pragma Import (C, mprotect);
313 ---------------------------------------
314 -- Nonstandard Thread Initialization --
315 ---------------------------------------
317 procedure pthread_init;
319 -------------------------
320 -- POSIX.1c Section 3 --
321 -------------------------
323 function sigwait (set : access sigset_t; sig : access Signal) return int;
324 pragma Import (C, sigwait, "sigwait");
326 function pthread_kill (thread : pthread_t; sig : Signal) return int;
327 pragma Import (C, pthread_kill, "pthread_kill");
329 function pthread_sigmask
331 set : access sigset_t;
332 oset : access sigset_t) return int;
333 pragma Import (C, pthread_sigmask, "pthread_sigmask");
335 --------------------------
336 -- POSIX.1c Section 11 --
337 --------------------------
339 function pthread_mutexattr_init
340 (attr : access pthread_mutexattr_t) return int;
341 pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
343 function pthread_mutexattr_destroy
344 (attr : access pthread_mutexattr_t) return int;
345 pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
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");
352 function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
353 pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
355 function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
356 pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
358 function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
359 pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
361 function pthread_condattr_init
362 (attr : access pthread_condattr_t) return int;
363 pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
365 function pthread_condattr_destroy
366 (attr : access pthread_condattr_t) return int;
367 pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
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");
374 function pthread_cond_destroy (cond : access pthread_cond_t) return int;
375 pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
377 function pthread_cond_signal (cond : access pthread_cond_t) return int;
378 pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
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");
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");
391 Relative_Timed_Wait : constant Boolean := False;
392 -- pthread_cond_timedwait requires an absolute delay time
394 --------------------------
395 -- POSIX.1c Section 13 --
396 --------------------------
398 PTHREAD_PRIO_NONE : constant := 0;
399 PTHREAD_PRIO_INHERIT : constant := 1;
400 PTHREAD_PRIO_PROTECT : constant := 2;
402 function pthread_mutexattr_setprotocol
403 (attr : access pthread_mutexattr_t;
404 protocol : int) return int;
406 (C, pthread_mutexattr_setprotocol, "pthread_mutexattr_setprotocol");
408 function pthread_mutexattr_setprioceiling
409 (attr : access pthread_mutexattr_t;
410 prioceiling : int) return int;
412 (C, pthread_mutexattr_setprioceiling,
413 "pthread_mutexattr_setprioceiling");
415 type padding is array (int range <>) of Interfaces.C.char;
417 type struct_sched_param is record
418 sched_priority : int; -- scheduling priority
419 opaque : padding (1 .. 4);
421 pragma Convention (C, struct_sched_param);
423 function pthread_setschedparam
426 param : access struct_sched_param) return int;
427 pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
429 function pthread_attr_setscope
430 (attr : access pthread_attr_t;
431 contentionscope : int) return int;
432 pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
434 function pthread_attr_setinheritsched
435 (attr : access pthread_attr_t;
436 inheritsched : int) return int;
438 (C, pthread_attr_setinheritsched, "pthread_attr_setinheritsched");
440 function pthread_attr_setschedpolicy
441 (attr : access pthread_attr_t;
442 policy : int) return int;
443 pragma Import (C, pthread_attr_setschedpolicy, "pthread_attr_setsched");
445 function sched_yield return int;
447 ---------------------------
448 -- P1003.1c - Section 16 --
449 ---------------------------
451 function pthread_attr_init (attributes : access pthread_attr_t) return int;
452 pragma Import (C, pthread_attr_init, "pthread_attr_init");
454 function pthread_attr_destroy
455 (attributes : access pthread_attr_t) return int;
456 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
458 function pthread_attr_setdetachstate
459 (attr : access pthread_attr_t;
460 detachstate : int) return int;
462 (C, pthread_attr_setdetachstate, "pthread_attr_setdetachstate");
464 function pthread_attr_setstacksize
465 (attr : access pthread_attr_t;
466 stacksize : size_t) return int;
468 (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
470 function pthread_create
471 (thread : access pthread_t;
472 attributes : access pthread_attr_t;
473 start_routine : Thread_Body;
474 arg : System.Address) return int;
475 pragma Import (C, pthread_create, "pthread_create");
477 procedure pthread_exit (status : System.Address);
478 pragma Import (C, pthread_exit, "pthread_exit");
480 function pthread_self return pthread_t;
481 pragma Import (C, pthread_self, "pthread_self");
483 --------------------------
484 -- POSIX.1c Section 17 --
485 --------------------------
487 function pthread_setspecific
488 (key : pthread_key_t;
489 value : System.Address) return int;
490 pragma Import (C, pthread_setspecific, "pthread_setspecific");
492 function pthread_getspecific (key : pthread_key_t) return System.Address;
493 pragma Import (C, pthread_getspecific, "pthread_getspecific");
495 type destructor_pointer is access procedure (arg : System.Address);
496 pragma Convention (C, destructor_pointer);
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");
505 type sigset_t is new unsigned;
507 type int32_t is new int;
509 type pid_t is new int32_t;
511 type time_t is new long;
513 type timespec is record
517 pragma Convention (C, timespec);
519 type clockid_t is new int;
520 CLOCK_REALTIME : constant clockid_t := 0;
521 CLOCK_MONOTONIC : constant clockid_t := CLOCK_REALTIME;
524 -- Darwin specific signal implementation
526 type Pad_Type is array (1 .. 7) of unsigned_long;
527 type siginfo_t is record
528 si_signo : int; -- signal number
529 si_errno : int; -- errno association
530 si_code : int; -- signal code
531 si_pid : int; -- sending process
532 si_uid : unsigned; -- sender's ruid
533 si_status : int; -- exit value
534 si_addr : System.Address; -- faulting instruction
535 si_value : System.Address; -- signal value
536 si_band : long; -- band event for SIGPOLL
537 pad : Pad_Type; -- RFU
539 pragma Convention (C, siginfo_t);
541 type mcontext_t is new System.Address;
543 type ucontext_t is record
545 uc_sigmask : sigset_t; -- Signal Mask Used By This Context
546 uc_stack : stack_t; -- Stack Used By This Context
547 uc_link : System.Address; -- Pointer To Resuming Context
548 uc_mcsize : size_t; -- Size of The Machine Context
549 uc_mcontext : mcontext_t; -- Machine Specific Context
551 pragma Convention (C, ucontext_t);
554 -- Darwin specific pthread implementation
556 type pthread_t is new System.Address;
558 type pthread_attr_t is record
560 opaque : padding (1 .. System.OS_Constants.PTHREAD_ATTR_SIZE);
562 pragma Convention (C, pthread_attr_t);
564 type pthread_mutexattr_t is record
566 opaque : padding (1 .. System.OS_Constants.PTHREAD_MUTEXATTR_SIZE);
568 pragma Convention (C, pthread_mutexattr_t);
570 type pthread_mutex_t is record
572 opaque : padding (1 .. System.OS_Constants.PTHREAD_MUTEX_SIZE);
574 pragma Convention (C, pthread_mutex_t);
576 type pthread_condattr_t is record
578 opaque : padding (1 .. System.OS_Constants.PTHREAD_CONDATTR_SIZE);
580 pragma Convention (C, pthread_condattr_t);
582 type pthread_cond_t is record
584 opaque : padding (1 .. System.OS_Constants.PTHREAD_COND_SIZE);
586 pragma Convention (C, pthread_cond_t);
588 type pthread_once_t is record
590 opaque : padding (1 .. System.OS_Constants.PTHREAD_ONCE_SIZE);
592 pragma Convention (C, pthread_once_t);
594 type pthread_key_t is new unsigned_long;
596 end System.OS_Interface;