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-2015, 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 GNU/Linux (GNU/LinuxThreads) version of this package
35 -- This package encapsulates all direct interfaces to OS services
36 -- that are 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;
44 with System.OS_Constants;
46 package System.OS_Interface is
49 pragma Linker_Options ("-lpthread");
50 pragma Linker_Options ("-lrt");
51 -- Needed for clock_getres with glibc versions prior to 2.17
53 subtype int is Interfaces.C.int;
54 subtype char is Interfaces.C.char;
55 subtype short is Interfaces.C.short;
56 subtype long is Interfaces.C.long;
57 subtype unsigned is Interfaces.C.unsigned;
58 subtype unsigned_short is Interfaces.C.unsigned_short;
59 subtype unsigned_long is Interfaces.C.unsigned_long;
60 subtype unsigned_char is Interfaces.C.unsigned_char;
61 subtype plain_char is Interfaces.C.plain_char;
62 subtype size_t is Interfaces.C.size_t;
68 function errno return int;
69 pragma Import (C, errno, "__get_errno");
71 EAGAIN : constant := System.Linux.EAGAIN;
72 EINTR : constant := System.Linux.EINTR;
73 EINVAL : constant := System.Linux.EINVAL;
74 ENOMEM : constant := System.Linux.ENOMEM;
75 EPERM : constant := System.Linux.EPERM;
76 ETIMEDOUT : constant := System.Linux.ETIMEDOUT;
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 := System.Linux.SIGHUP;
87 SIGINT : constant := System.Linux.SIGINT;
88 SIGQUIT : constant := System.Linux.SIGQUIT;
89 SIGILL : constant := System.Linux.SIGILL;
90 SIGTRAP : constant := System.Linux.SIGTRAP;
91 SIGIOT : constant := System.Linux.SIGIOT;
92 SIGABRT : constant := System.Linux.SIGABRT;
93 SIGFPE : constant := System.Linux.SIGFPE;
94 SIGKILL : constant := System.Linux.SIGKILL;
95 SIGBUS : constant := System.Linux.SIGBUS;
96 SIGSEGV : constant := System.Linux.SIGSEGV;
97 SIGPIPE : constant := System.Linux.SIGPIPE;
98 SIGALRM : constant := System.Linux.SIGALRM;
99 SIGTERM : constant := System.Linux.SIGTERM;
100 SIGUSR1 : constant := System.Linux.SIGUSR1;
101 SIGUSR2 : constant := System.Linux.SIGUSR2;
102 SIGCLD : constant := System.Linux.SIGCLD;
103 SIGCHLD : constant := System.Linux.SIGCHLD;
104 SIGPWR : constant := System.Linux.SIGPWR;
105 SIGWINCH : constant := System.Linux.SIGWINCH;
106 SIGURG : constant := System.Linux.SIGURG;
107 SIGPOLL : constant := System.Linux.SIGPOLL;
108 SIGIO : constant := System.Linux.SIGIO;
109 SIGLOST : constant := System.Linux.SIGLOST;
110 SIGSTOP : constant := System.Linux.SIGSTOP;
111 SIGTSTP : constant := System.Linux.SIGTSTP;
112 SIGCONT : constant := System.Linux.SIGCONT;
113 SIGTTIN : constant := System.Linux.SIGTTIN;
114 SIGTTOU : constant := System.Linux.SIGTTOU;
115 SIGVTALRM : constant := System.Linux.SIGVTALRM;
116 SIGPROF : constant := System.Linux.SIGPROF;
117 SIGXCPU : constant := System.Linux.SIGXCPU;
118 SIGXFSZ : constant := System.Linux.SIGXFSZ;
119 SIGUNUSED : constant := System.Linux.SIGUNUSED;
120 SIGSTKFLT : constant := System.Linux.SIGSTKFLT;
121 SIGLTHRRES : constant := System.Linux.SIGLTHRRES;
122 SIGLTHRCAN : constant := System.Linux.SIGLTHRCAN;
123 SIGLTHRDBG : constant := System.Linux.SIGLTHRDBG;
125 SIGADAABORT : constant := SIGABRT;
126 -- Change this to use another signal for task abort. SIGTERM might be a
129 type Signal_Set is array (Natural range <>) of Signal;
131 Unmasked : constant Signal_Set := (
133 -- To enable debugging on multithreaded applications, mark SIGTRAP to
138 SIGTTIN, SIGTTOU, SIGTSTP,
139 -- Keep these three signals unmasked so that background processes and IO
140 -- behaves as normal "C" applications
143 -- To avoid confusing the profiler
146 -- These two signals actually can't be masked (POSIX won't allow it)
148 SIGLTHRRES, SIGLTHRCAN, SIGLTHRDBG);
149 -- These three signals are used by GNU/LinuxThreads starting from glibc
152 Reserved : constant Signal_Set := (SIGVTALRM, SIGUNUSED);
153 -- Not clear why these two signals are reserved. Perhaps they are not
154 -- supported by this version of GNU/Linux ???
156 type sigset_t is private;
158 function sigaddset (set : access sigset_t; sig : Signal) return int;
159 pragma Import (C, sigaddset, "sigaddset");
161 function sigdelset (set : access sigset_t; sig : Signal) return int;
162 pragma Import (C, sigdelset, "sigdelset");
164 function sigfillset (set : access sigset_t) return int;
165 pragma Import (C, sigfillset, "sigfillset");
167 function sigismember (set : access sigset_t; sig : Signal) return int;
168 pragma Import (C, sigismember, "sigismember");
170 function sigemptyset (set : access sigset_t) return int;
171 pragma Import (C, sigemptyset, "sigemptyset");
173 type union_type_3 is new String (1 .. 116);
174 type siginfo_t is record
178 X_data : union_type_3;
180 pragma Convention (C, siginfo_t);
182 type struct_sigaction is record
183 sa_handler : System.Address;
185 sa_flags : Interfaces.C.unsigned_long;
186 sa_restorer : System.Address;
188 pragma Convention (C, struct_sigaction);
190 type struct_sigaction_ptr is access all struct_sigaction;
192 type Machine_State is record
200 type Machine_State_Ptr is access all Machine_State;
202 SA_SIGINFO : constant := System.Linux.SA_SIGINFO;
203 SA_ONSTACK : constant := System.Linux.SA_ONSTACK;
205 SIG_BLOCK : constant := 0;
206 SIG_UNBLOCK : constant := 1;
207 SIG_SETMASK : constant := 2;
209 SIG_DFL : constant := 0;
210 SIG_IGN : constant := 1;
214 act : struct_sigaction_ptr;
215 oact : struct_sigaction_ptr) return int;
216 pragma Import (C, sigaction, "sigaction");
222 subtype time_t is System.Linux.time_t;
223 subtype timespec is System.Linux.timespec;
224 subtype timeval is System.Linux.timeval;
225 subtype clockid_t is System.Linux.clockid_t;
227 function clock_gettime
228 (clock_id : clockid_t; tp : access timespec) return int;
229 pragma Import (C, clock_gettime, "clock_gettime");
231 function clock_getres
232 (clock_id : clockid_t;
233 res : access timespec) return int;
234 pragma Import (C, clock_getres, "clock_getres");
236 function To_Duration (TS : timespec) return Duration;
237 pragma Inline (To_Duration);
239 function To_Timespec (D : Duration) return timespec;
240 pragma Inline (To_Timespec);
242 function sysconf (name : int) return long;
243 pragma Import (C, sysconf);
245 SC_CLK_TCK : constant := 2;
246 SC_NPROCESSORS_ONLN : constant := 84;
248 -------------------------
249 -- Priority Scheduling --
250 -------------------------
252 SCHED_OTHER : constant := 0;
253 SCHED_FIFO : constant := 1;
254 SCHED_RR : constant := 2;
256 function To_Target_Priority
257 (Prio : System.Any_Priority) return Interfaces.C.int;
258 -- Maps System.Any_Priority to a POSIX priority
264 type pid_t is private;
266 function kill (pid : pid_t; sig : Signal) return int;
267 pragma Import (C, kill, "kill");
269 function getpid return pid_t;
270 pragma Import (C, getpid, "getpid");
272 PR_SET_NAME : constant := 15;
276 arg2, arg3, arg4, arg5 : unsigned_long := 0) return int;
277 pragma Import (C, prctl);
283 type Thread_Body is access
284 function (arg : System.Address) return System.Address;
285 pragma Convention (C, Thread_Body);
287 function Thread_Body_Access is new
288 Ada.Unchecked_Conversion (System.Address, Thread_Body);
290 type pthread_t is new unsigned_long;
291 subtype Thread_Id is pthread_t;
293 function To_pthread_t is
294 new Ada.Unchecked_Conversion (unsigned_long, pthread_t);
296 type pthread_mutex_t is limited private;
297 type pthread_rwlock_t is limited private;
298 type pthread_cond_t is limited private;
299 type pthread_attr_t is limited private;
300 type pthread_mutexattr_t is limited private;
301 type pthread_rwlockattr_t is limited private;
302 type pthread_condattr_t is limited private;
303 type pthread_key_t is private;
305 PTHREAD_CREATE_DETACHED : constant := 1;
311 type stack_t is record
312 ss_sp : System.Address;
316 pragma Convention (C, stack_t);
319 (ss : not null access stack_t;
320 oss : access stack_t) return int;
321 pragma Import (C, sigaltstack, "sigaltstack");
323 Alternate_Stack : aliased System.Address;
324 pragma Import (C, Alternate_Stack, "__gnat_alternate_stack");
325 -- The alternate signal stack for stack overflows
327 Alternate_Stack_Size : constant := 16 * 1024;
328 -- This must be in keeping with init.c:__gnat_alternate_stack
330 function Get_Stack_Base (thread : pthread_t) return Address;
331 pragma Inline (Get_Stack_Base);
332 -- This is a dummy procedure to share some GNULLI files
334 ---------------------------------------
335 -- Nonstandard Thread Initialization --
336 ---------------------------------------
338 procedure pthread_init;
339 pragma Inline (pthread_init);
340 -- This is a dummy procedure to share some GNULLI files
342 -------------------------
343 -- POSIX.1c Section 3 --
344 -------------------------
346 function sigwait (set : access sigset_t; sig : access Signal) return int;
347 pragma Import (C, sigwait, "sigwait");
349 function pthread_kill (thread : pthread_t; sig : Signal) return int;
350 pragma Import (C, pthread_kill, "pthread_kill");
352 function pthread_sigmask
354 set : access sigset_t;
355 oset : access sigset_t) return int;
356 pragma Import (C, pthread_sigmask, "pthread_sigmask");
358 --------------------------
359 -- POSIX.1c Section 11 --
360 --------------------------
362 function pthread_mutexattr_init
363 (attr : access pthread_mutexattr_t) return int;
364 pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
366 function pthread_mutexattr_destroy
367 (attr : access pthread_mutexattr_t) return int;
368 pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
370 function pthread_mutex_init
371 (mutex : access pthread_mutex_t;
372 attr : access pthread_mutexattr_t) return int;
373 pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
375 function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
376 pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
378 function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
379 pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
381 function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
382 pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
384 function pthread_rwlockattr_init
385 (attr : access pthread_rwlockattr_t) return int;
386 pragma Import (C, pthread_rwlockattr_init, "pthread_rwlockattr_init");
388 function pthread_rwlockattr_destroy
389 (attr : access pthread_rwlockattr_t) return int;
390 pragma Import (C, pthread_rwlockattr_destroy, "pthread_rwlockattr_destroy");
392 PTHREAD_RWLOCK_PREFER_READER_NP : constant := 0;
393 PTHREAD_RWLOCK_PREFER_WRITER_NP : constant := 1;
394 PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP : constant := 2;
396 function pthread_rwlockattr_setkind_np
397 (attr : access pthread_rwlockattr_t;
398 pref : int) return int;
400 (C, pthread_rwlockattr_setkind_np, "pthread_rwlockattr_setkind_np");
402 function pthread_rwlock_init
403 (mutex : access pthread_rwlock_t;
404 attr : access pthread_rwlockattr_t) return int;
405 pragma Import (C, pthread_rwlock_init, "pthread_rwlock_init");
407 function pthread_rwlock_destroy
408 (mutex : access pthread_rwlock_t) return int;
409 pragma Import (C, pthread_rwlock_destroy, "pthread_rwlock_destroy");
411 function pthread_rwlock_rdlock (mutex : access pthread_rwlock_t) return int;
412 pragma Import (C, pthread_rwlock_rdlock, "pthread_rwlock_rdlock");
414 function pthread_rwlock_wrlock (mutex : access pthread_rwlock_t) return int;
415 pragma Import (C, pthread_rwlock_wrlock, "pthread_rwlock_wrlock");
417 function pthread_rwlock_unlock (mutex : access pthread_rwlock_t) return int;
418 pragma Import (C, pthread_rwlock_unlock, "pthread_rwlock_unlock");
420 function pthread_condattr_init
421 (attr : access pthread_condattr_t) return int;
422 pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
424 function pthread_condattr_destroy
425 (attr : access pthread_condattr_t) return int;
426 pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
428 function pthread_cond_init
429 (cond : access pthread_cond_t;
430 attr : access pthread_condattr_t) return int;
431 pragma Import (C, pthread_cond_init, "pthread_cond_init");
433 function pthread_cond_destroy (cond : access pthread_cond_t) return int;
434 pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
436 function pthread_cond_signal (cond : access pthread_cond_t) return int;
437 pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
439 function pthread_cond_wait
440 (cond : access pthread_cond_t;
441 mutex : access pthread_mutex_t) return int;
442 pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
444 function pthread_cond_timedwait
445 (cond : access pthread_cond_t;
446 mutex : access pthread_mutex_t;
447 abstime : access timespec) return int;
448 pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
450 --------------------------
451 -- POSIX.1c Section 13 --
452 --------------------------
454 type struct_sched_param is record
455 sched_priority : int; -- scheduling priority
457 pragma Convention (C, struct_sched_param);
459 function pthread_setschedparam
462 param : access struct_sched_param) return int;
463 pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
465 function pthread_attr_setschedpolicy
466 (attr : access pthread_attr_t;
467 policy : int) return int;
469 (C, pthread_attr_setschedpolicy, "pthread_attr_setschedpolicy");
471 function sched_yield return int;
472 pragma Import (C, sched_yield, "sched_yield");
474 ---------------------------
475 -- P1003.1c - Section 16 --
476 ---------------------------
478 function pthread_attr_init
479 (attributes : access pthread_attr_t) return int;
480 pragma Import (C, pthread_attr_init, "pthread_attr_init");
482 function pthread_attr_destroy
483 (attributes : access pthread_attr_t) return int;
484 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
486 function pthread_attr_setdetachstate
487 (attr : access pthread_attr_t;
488 detachstate : int) return int;
490 (C, pthread_attr_setdetachstate, "pthread_attr_setdetachstate");
492 function pthread_attr_setstacksize
493 (attr : access pthread_attr_t;
494 stacksize : size_t) return int;
495 pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
497 function pthread_create
498 (thread : access pthread_t;
499 attributes : access pthread_attr_t;
500 start_routine : Thread_Body;
501 arg : System.Address) return int;
502 pragma Import (C, pthread_create, "pthread_create");
504 procedure pthread_exit (status : System.Address);
505 pragma Import (C, pthread_exit, "pthread_exit");
507 function pthread_self return pthread_t;
508 pragma Import (C, pthread_self, "pthread_self");
510 function lwp_self return System.Address;
511 pragma Import (C, lwp_self, "__gnat_lwp_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");
537 CPU_SETSIZE : constant := 1_024;
538 -- Size of the cpu_set_t mask on most linux systems (SUSE 11 uses 4_096).
539 -- This is kept for backward compatibility (System.Task_Info uses it), but
540 -- the run-time library does no longer rely on static masks, using
541 -- dynamically allocated masks instead.
543 type bit_field is array (1 .. CPU_SETSIZE) of Boolean;
544 for bit_field'Size use CPU_SETSIZE;
545 pragma Pack (bit_field);
546 pragma Convention (C, bit_field);
548 type cpu_set_t is record
551 pragma Convention (C, cpu_set_t);
553 type cpu_set_t_ptr is access all cpu_set_t;
554 -- In the run-time library we use this pointer because the size of type
555 -- cpu_set_t varies depending on the glibc version. Hence, objects of type
556 -- cpu_set_t are allocated dynamically using the number of processors
557 -- available in the target machine (value obtained at execution time).
559 function CPU_ALLOC (count : size_t) return cpu_set_t_ptr;
560 pragma Import (C, CPU_ALLOC, "__gnat_cpu_alloc");
561 -- Wrapper around the CPU_ALLOC C macro
563 function CPU_ALLOC_SIZE (count : size_t) return size_t;
564 pragma Import (C, CPU_ALLOC_SIZE, "__gnat_cpu_alloc_size");
565 -- Wrapper around the CPU_ALLOC_SIZE C macro
567 procedure CPU_FREE (cpuset : cpu_set_t_ptr);
568 pragma Import (C, CPU_FREE, "__gnat_cpu_free");
569 -- Wrapper around the CPU_FREE C macro
571 procedure CPU_ZERO (count : size_t; cpuset : cpu_set_t_ptr);
572 pragma Import (C, CPU_ZERO, "__gnat_cpu_zero");
573 -- Wrapper around the CPU_ZERO_S C macro
575 procedure CPU_SET (cpu : int; count : size_t; cpuset : cpu_set_t_ptr);
576 pragma Import (C, CPU_SET, "__gnat_cpu_set");
577 -- Wrapper around the CPU_SET_S C macro
579 function pthread_setaffinity_np
582 cpuset : cpu_set_t_ptr) return int;
583 pragma Import (C, pthread_setaffinity_np, "pthread_setaffinity_np");
584 pragma Weak_External (pthread_setaffinity_np);
585 -- Use a weak symbol because this function may be available or not,
586 -- depending on the version of the system.
588 function pthread_attr_setaffinity_np
589 (attr : access pthread_attr_t;
591 cpuset : cpu_set_t_ptr) return int;
592 pragma Import (C, pthread_attr_setaffinity_np,
593 "pthread_attr_setaffinity_np");
594 pragma Weak_External (pthread_attr_setaffinity_np);
595 -- Use a weak symbol because this function may be available or not,
596 -- depending on the version of the system.
601 array (0 .. OS_Constants.SIZEOF_sigset - 1) of unsigned_char;
602 pragma Convention (C, sigset_t);
603 for sigset_t'Alignment use Interfaces.C.unsigned_long'Alignment;
605 pragma Warnings (Off);
606 for struct_sigaction use record
607 sa_handler at Linux.sa_handler_pos range 0 .. Standard'Address_Size - 1;
608 sa_mask at Linux.sa_mask_pos range 0 .. 1023;
609 sa_flags at Linux.sa_flags_pos
610 range 0 .. Interfaces.C.unsigned_long'Size - 1;
612 -- We intentionally leave sa_restorer unspecified and let the compiler
613 -- append it after the last field, so disable corresponding warning.
614 pragma Warnings (On);
616 type pid_t is new int;
618 subtype char_array is Interfaces.C.char_array;
620 type pthread_attr_t is record
621 Data : char_array (1 .. OS_Constants.PTHREAD_ATTR_SIZE);
623 pragma Convention (C, pthread_attr_t);
624 for pthread_attr_t'Alignment use Interfaces.C.unsigned_long'Alignment;
626 type pthread_condattr_t is record
627 Data : char_array (1 .. OS_Constants.PTHREAD_CONDATTR_SIZE);
629 pragma Convention (C, pthread_condattr_t);
630 for pthread_condattr_t'Alignment use Interfaces.C.int'Alignment;
632 type pthread_mutexattr_t is record
633 Data : char_array (1 .. OS_Constants.PTHREAD_MUTEXATTR_SIZE);
635 pragma Convention (C, pthread_mutexattr_t);
636 for pthread_mutexattr_t'Alignment use Interfaces.C.int'Alignment;
638 type pthread_mutex_t is record
639 Data : char_array (1 .. OS_Constants.PTHREAD_MUTEX_SIZE);
641 pragma Convention (C, pthread_mutex_t);
642 for pthread_mutex_t'Alignment use Interfaces.C.unsigned_long'Alignment;
644 type pthread_rwlockattr_t is record
645 Data : char_array (1 .. OS_Constants.PTHREAD_RWLOCKATTR_SIZE);
647 pragma Convention (C, pthread_rwlockattr_t);
648 for pthread_rwlockattr_t'Alignment use Interfaces.C.unsigned_long'Alignment;
650 type pthread_rwlock_t is record
651 Data : char_array (1 .. OS_Constants.PTHREAD_RWLOCK_SIZE);
653 pragma Convention (C, pthread_rwlock_t);
654 for pthread_rwlock_t'Alignment use Interfaces.C.unsigned_long'Alignment;
656 type pthread_cond_t is record
657 Data : char_array (1 .. OS_Constants.PTHREAD_COND_SIZE);
659 pragma Convention (C, pthread_cond_t);
660 for pthread_cond_t'Alignment use Interfaces.Unsigned_64'Alignment;
662 type pthread_key_t is new unsigned;
664 end System.OS_Interface;