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-2007, Free Software Foundation, Inc. --
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, 51 Franklin Street, Fifth Floor, --
21 -- Boston, MA 02110-1301, USA. --
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. --
30 -- GNARL was developed by the GNARL team at Florida State University. It is --
31 -- now maintained by Ada Core Technologies Inc. in cooperation with Florida --
32 -- State University (http://www.gnat.com). --
34 ------------------------------------------------------------------------------
36 -- This is the FreeBSD PTHREADS version of this package
38 -- This package encapsulates all direct interfaces to OS services
39 -- that are needed by children of System.
41 -- PLEASE DO NOT add any with-clauses to this package or remove the pragma
42 -- Preelaborate. This package is designed to be a bottom-level (leaf) package.
45 with Ada.Unchecked_Conversion;
47 package System.OS_Interface is
50 pragma Linker_Options ("-pthread");
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;
66 function Errno return int;
67 pragma Inline (Errno);
69 EAGAIN : constant := 35;
70 EINTR : constant := 4;
71 EINVAL : constant := 22;
72 ENOMEM : constant := 12;
73 ETIMEDOUT : constant := 60;
79 Max_Interrupt : constant := 31;
80 type Signal is new int range 0 .. Max_Interrupt;
81 for Signal'Size use int'Size;
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 SIGURG : constant := 16; -- urgent condition on IO channel
100 SIGSTOP : constant := 17; -- stop (cannot be caught or ignored)
101 SIGTSTP : constant := 18; -- user stop requested from tty
102 SIGCONT : constant := 19; -- stopped process has been continued
103 SIGCLD : constant := 20; -- alias for SIGCHLD
104 SIGCHLD : constant := 20; -- child status change
105 SIGTTIN : constant := 21; -- background tty read attempted
106 SIGTTOU : constant := 22; -- background tty write attempted
107 SIGIO : constant := 23; -- I/O possible (Solaris SIGPOLL alias)
108 SIGXCPU : constant := 24; -- CPU time limit exceeded
109 SIGXFSZ : constant := 25; -- filesize limit exceeded
110 SIGVTALRM : constant := 26; -- virtual timer expired
111 SIGPROF : constant := 27; -- profiling timer expired
112 SIGWINCH : constant := 28; -- window size change
113 SIGINFO : constant := 29; -- information request (NetBSD/FreeBSD)
114 SIGUSR1 : constant := 30; -- user defined signal 1
115 SIGUSR2 : constant := 31; -- user defined signal 2
117 SIGADAABORT : constant := SIGABRT;
118 -- Change this if you want to use another signal for task abort.
119 -- SIGTERM might be a good one.
121 type Signal_Set is array (Natural range <>) of Signal;
123 -- Interrupts that must be unmasked at all times. FreeBSD
124 -- pthreads will not allow an application to mask out any
125 -- interrupt needed by the threads library.
126 Unmasked : constant Signal_Set :=
127 (SIGTRAP, SIGBUS, SIGTTIN, SIGTTOU, SIGTSTP);
129 -- FreeBSD will uses SIGPROF for timing. Do not allow a
130 -- handler to attach to this signal.
131 Reserved : constant Signal_Set := (0 .. 0 => SIGPROF);
133 type sigset_t is private;
136 (set : access sigset_t;
137 sig : Signal) return int;
138 pragma Import (C, sigaddset, "sigaddset");
141 (set : access sigset_t;
142 sig : Signal) return int;
143 pragma Import (C, sigdelset, "sigdelset");
145 function sigfillset (set : access sigset_t) return int;
146 pragma Import (C, sigfillset, "sigfillset");
149 (set : access sigset_t;
150 sig : Signal) return int;
151 pragma Import (C, sigismember, "sigismember");
153 function sigemptyset (set : access sigset_t) return int;
154 pragma Import (C, sigemptyset, "sigemptyset");
156 -- sigcontext is architecture dependent, so define it private
157 type struct_sigcontext is private;
159 type old_struct_sigaction is record
160 sa_handler : System.Address;
164 pragma Convention (C, old_struct_sigaction);
166 type new_struct_sigaction is record
167 sa_handler : System.Address;
171 pragma Convention (C, new_struct_sigaction);
173 subtype struct_sigaction is new_struct_sigaction;
174 type struct_sigaction_ptr is access all struct_sigaction;
176 SIG_BLOCK : constant := 1;
177 SIG_UNBLOCK : constant := 2;
178 SIG_SETMASK : constant := 3;
180 SIG_DFL : constant := 0;
181 SIG_IGN : constant := 1;
183 SA_SIGINFO : constant := 16#0040#;
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 wether time slicing is supported (i.e SCHED_RR is supported)
198 type timespec is private;
200 function nanosleep (rqtp, rmtp : access timespec) return int;
201 pragma Import (C, nanosleep, "nanosleep");
203 type clockid_t is private;
205 CLOCK_REALTIME : constant clockid_t;
207 function clock_gettime
208 (clock_id : clockid_t;
209 tp : access timespec)
211 pragma Import (C, clock_gettime, "clock_gettime");
213 function To_Duration (TS : timespec) return Duration;
214 pragma Inline (To_Duration);
216 function To_Timespec (D : Duration) return timespec;
217 pragma Inline (To_Timespec);
219 type struct_timezone is record
220 tz_minuteswest : int;
223 pragma Convention (C, struct_timezone);
225 procedure usleep (useconds : unsigned_long);
226 pragma Import (C, usleep, "usleep");
228 -------------------------
229 -- Priority Scheduling --
230 -------------------------
232 SCHED_FIFO : constant := 1;
233 SCHED_OTHER : constant := 2;
234 SCHED_RR : constant := 3;
236 function To_Target_Priority
237 (Prio : System.Any_Priority) return Interfaces.C.int;
238 -- Maps System.Any_Priority to a POSIX priority
244 type pid_t is private;
246 Self_PID : constant pid_t;
248 function kill (pid : pid_t; sig : Signal) return int;
249 pragma Import (C, kill, "kill");
251 function getpid return pid_t;
252 pragma Import (C, getpid, "getpid");
258 function lwp_self return System.Address;
259 -- lwp_self does not exist on this thread library, revert to pthread_self
260 -- which is the closest approximation (with getpid). This function is
261 -- needed to share 7staprop.adb across POSIX-like targets.
262 pragma Import (C, lwp_self, "pthread_self");
268 type Thread_Body is access
269 function (arg : System.Address) return System.Address;
271 function Thread_Body_Access is new
272 Ada.Unchecked_Conversion (System.Address, Thread_Body);
274 type pthread_t is private;
275 subtype Thread_Id is pthread_t;
277 type pthread_mutex_t is limited private;
278 type pthread_cond_t is limited private;
279 type pthread_attr_t is limited private;
280 type pthread_mutexattr_t is limited private;
281 type pthread_condattr_t is limited private;
282 type pthread_key_t is private;
284 PTHREAD_CREATE_DETACHED : constant := 1;
285 PTHREAD_CREATE_JOINABLE : constant := 0;
287 PTHREAD_SCOPE_PROCESS : constant := 0;
288 PTHREAD_SCOPE_SYSTEM : constant := 2;
294 Stack_Base_Available : constant Boolean := False;
295 -- Indicates wether the stack base is available on this target.
296 -- This allows us to share s-osinte.adb between all the FSU run time.
297 -- Note that this value can only be true if pthread_t has a complete
298 -- definition that corresponds exactly to the C header files.
300 function Get_Stack_Base (thread : pthread_t) return Address;
301 pragma Inline (Get_Stack_Base);
302 -- returns the stack base of the specified thread.
303 -- Only call this function when Stack_Base_Available is True.
305 function Get_Page_Size return size_t;
306 function Get_Page_Size return Address;
307 pragma Import (C, Get_Page_Size, "getpagesize");
308 -- returns the size of a page, or 0 if this is not relevant on this
311 PROT_NONE : constant := 0;
312 PROT_READ : constant := 1;
313 PROT_WRITE : constant := 2;
314 PROT_EXEC : constant := 4;
315 PROT_ALL : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
317 PROT_ON : constant := PROT_NONE;
318 PROT_OFF : constant := PROT_ALL;
321 (addr : Address; len : size_t; prot : int) return int;
322 pragma Import (C, mprotect);
324 ---------------------------------------
325 -- Nonstandard Thread Initialization --
326 ---------------------------------------
328 -- FSU_THREADS requires pthread_init, which is nonstandard and
329 -- this should be invoked during the elaboration of s-taprop.adb
331 -- FreeBSD does not require this so we provide an empty Ada body
333 procedure pthread_init;
335 -------------------------
336 -- POSIX.1c Section 3 --
337 -------------------------
340 (set : access sigset_t;
341 sig : access Signal) return int;
342 pragma Import (C, sigwait, "sigwait");
344 function pthread_kill
346 sig : Signal) return int;
347 pragma Import (C, pthread_kill, "pthread_kill");
349 function pthread_sigmask
351 set : access sigset_t;
352 oset : access sigset_t) return int;
353 pragma Import (C, pthread_sigmask, "pthread_sigmask");
355 --------------------------
356 -- POSIX.1c Section 11 --
357 --------------------------
359 function pthread_mutexattr_init
360 (attr : access pthread_mutexattr_t) return int;
361 pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
363 function pthread_mutexattr_destroy
364 (attr : access pthread_mutexattr_t) return int;
365 pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
367 function pthread_mutex_init
368 (mutex : access pthread_mutex_t;
369 attr : access pthread_mutexattr_t) return int;
370 pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
372 function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
373 pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
375 function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
376 pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
378 function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
379 pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
381 function pthread_condattr_init
382 (attr : access pthread_condattr_t) return int;
383 pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
385 function pthread_condattr_destroy
386 (attr : access pthread_condattr_t) return int;
387 pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
389 function pthread_cond_init
390 (cond : access pthread_cond_t;
391 attr : access pthread_condattr_t) return int;
392 pragma Import (C, pthread_cond_init, "pthread_cond_init");
394 function pthread_cond_destroy (cond : access pthread_cond_t) return int;
395 pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
397 function pthread_cond_signal (cond : access pthread_cond_t) return int;
398 pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
400 function pthread_cond_wait
401 (cond : access pthread_cond_t;
402 mutex : access pthread_mutex_t) return int;
403 pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
405 function pthread_cond_timedwait
406 (cond : access pthread_cond_t;
407 mutex : access pthread_mutex_t;
408 abstime : access timespec) return int;
409 pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
411 Relative_Timed_Wait : constant Boolean := False;
412 -- pthread_cond_timedwait requires an absolute delay time
414 --------------------------
415 -- POSIX.1c Section 13 --
416 --------------------------
418 PTHREAD_PRIO_NONE : constant := 0;
419 PTHREAD_PRIO_PROTECT : constant := 2;
420 PTHREAD_PRIO_INHERIT : constant := 1;
422 function pthread_mutexattr_setprotocol
423 (attr : access pthread_mutexattr_t;
424 protocol : int) return int;
426 (C, pthread_mutexattr_setprotocol, "pthread_mutexattr_setprotocol");
428 function pthread_mutexattr_getprotocol
429 (attr : access pthread_mutexattr_t;
430 protocol : access int) return int;
432 (C, pthread_mutexattr_getprotocol, "pthread_mutexattr_getprotocol");
434 function pthread_mutexattr_setprioceiling
435 (attr : access pthread_mutexattr_t;
436 prioceiling : int) return int;
438 (C, pthread_mutexattr_setprioceiling,
439 "pthread_mutexattr_setprioceiling");
441 function pthread_mutexattr_getprioceiling
442 (attr : access pthread_mutexattr_t;
443 prioceiling : access int) return int;
445 (C, pthread_mutexattr_getprioceiling,
446 "pthread_mutexattr_getprioceiling");
448 type struct_sched_param is record
449 sched_priority : int;
451 pragma Convention (C, struct_sched_param);
453 function pthread_getschedparam
456 param : access struct_sched_param) return int;
457 pragma Import (C, pthread_getschedparam, "pthread_getschedparam");
459 function pthread_setschedparam
462 param : access struct_sched_param) return int;
463 pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
465 function pthread_attr_setscope
466 (attr : access pthread_attr_t;
467 contentionscope : int) return int;
468 pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
470 function pthread_attr_getscope
471 (attr : access pthread_attr_t;
472 contentionscope : access int) return int;
473 pragma Import (C, pthread_attr_getscope, "pthread_attr_getscope");
475 function pthread_attr_setinheritsched
476 (attr : access pthread_attr_t;
477 inheritsched : int) return int;
479 (C, pthread_attr_setinheritsched, "pthread_attr_setinheritsched");
481 function pthread_attr_getinheritsched
482 (attr : access pthread_attr_t;
483 inheritsched : access int) return int;
485 (C, pthread_attr_getinheritsched, "pthread_attr_getinheritsched");
487 function pthread_attr_setschedpolicy
488 (attr : access pthread_attr_t;
489 policy : int) return int;
490 pragma Import (C, pthread_attr_setschedpolicy,
491 "pthread_attr_setschedpolicy");
493 function pthread_attr_getschedpolicy
494 (attr : access pthread_attr_t;
495 policy : access int) return int;
496 pragma Import (C, pthread_attr_getschedpolicy,
497 "pthread_attr_getschedpolicy");
499 function pthread_attr_setschedparam
500 (attr : access pthread_attr_t;
501 sched_param : int) return int;
502 pragma Import (C, pthread_attr_setschedparam, "pthread_attr_setschedparam");
504 function pthread_attr_getschedparam
505 (attr : access pthread_attr_t;
506 sched_param : access int) return int;
507 pragma Import (C, pthread_attr_getschedparam, "pthread_attr_getschedparam");
509 function sched_yield return int;
510 pragma Import (C, sched_yield, "pthread_yield");
512 --------------------------
513 -- P1003.1c Section 16 --
514 --------------------------
516 function pthread_attr_init (attributes : access pthread_attr_t) return int;
517 pragma Import (C, pthread_attr_init, "pthread_attr_init");
519 function pthread_attr_destroy
520 (attributes : access pthread_attr_t) return int;
521 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
523 function pthread_attr_setdetachstate
524 (attr : access pthread_attr_t;
525 detachstate : int) return int;
527 (C, pthread_attr_setdetachstate, "pthread_attr_setdetachstate");
529 function pthread_attr_getdetachstate
530 (attr : access pthread_attr_t;
531 detachstate : access int) return int;
533 (C, pthread_attr_getdetachstate, "pthread_attr_getdetachstate");
535 function pthread_attr_getstacksize
536 (attr : access pthread_attr_t;
537 stacksize : access size_t) return int;
539 (C, pthread_attr_getstacksize, "pthread_attr_getstacksize");
541 function pthread_attr_setstacksize
542 (attr : access pthread_attr_t;
543 stacksize : size_t) return int;
545 (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
547 function pthread_create
548 (thread : access pthread_t;
549 attributes : access pthread_attr_t;
550 start_routine : Thread_Body;
551 arg : System.Address) return int;
552 pragma Import (C, pthread_create, "pthread_create");
554 function pthread_detach (thread : pthread_t) return int;
555 pragma Import (C, pthread_detach, "pthread_detach");
557 procedure pthread_exit (status : System.Address);
558 pragma Import (C, pthread_exit, "pthread_exit");
560 function pthread_self return pthread_t;
561 pragma Import (C, pthread_self, "pthread_self");
563 --------------------------
564 -- POSIX.1c Section 17 --
565 --------------------------
567 function pthread_setspecific
568 (key : pthread_key_t;
569 value : System.Address) return int;
570 pragma Import (C, pthread_setspecific, "pthread_setspecific");
572 function pthread_getspecific (key : pthread_key_t) return System.Address;
573 pragma Import (C, pthread_getspecific, "pthread_getspecific");
575 type destructor_pointer is access
576 procedure (arg : System.Address);
578 function pthread_key_create
579 (key : access pthread_key_t;
580 destructor : destructor_pointer) return int;
581 pragma Import (C, pthread_key_create, "pthread_key_create");
583 ------------------------------------
584 -- Non-portable Pthread Functions --
585 ------------------------------------
587 function pthread_set_name_np
589 name : System.Address) return int;
590 pragma Import (C, pthread_set_name_np, "pthread_set_name_np");
594 type sigset_t is array (1 .. 4) of unsigned;
596 -- In FreeBSD the component sa_handler turns out to
597 -- be one a union type, and the selector is a macro:
598 -- #define sa_handler __sigaction_u._handler
599 -- #define sa_sigaction __sigaction_u._sigaction
601 -- Should we add a signal_context type here ???
602 -- How could it be done independent of the CPU architecture ???
603 -- sigcontext type is opaque, so it is architecturally neutral.
604 -- It is always passed as an access type, so define it as an empty record
605 -- since the contents are not used anywhere.
607 type struct_sigcontext is null record;
608 pragma Convention (C, struct_sigcontext);
610 type pid_t is new int;
611 Self_PID : constant pid_t := 0;
613 type time_t is new long;
615 type timespec is record
619 pragma Convention (C, timespec);
621 type clockid_t is new int;
622 CLOCK_REALTIME : constant clockid_t := 0;
624 type pthread_t is new System.Address;
625 type pthread_attr_t is new System.Address;
626 type pthread_mutex_t is new System.Address;
627 type pthread_mutexattr_t is new System.Address;
628 type pthread_cond_t is new System.Address;
629 type pthread_condattr_t is new System.Address;
630 type pthread_key_t is new int;
632 end System.OS_Interface;