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-2005, 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. --
31 -- Extensive contributions were provided by Ada Core Technologies, Inc. --
33 ------------------------------------------------------------------------------
35 -- This is a GNU/Linux (GNU/LinuxThreads) version of this package
37 -- This package encapsulates all direct interfaces to OS services
38 -- that are needed by children of System.
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.
44 with Unchecked_Conversion
;
46 package System
.OS_Interface
is
49 pragma Linker_Options
("-lpthread");
51 subtype int
is Interfaces
.C
.int
;
52 subtype char
is Interfaces
.C
.char
;
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 Import
(C
, errno
, "__get_errno");
69 EAGAIN
: constant := 11;
70 EINTR
: constant := 4;
71 EINVAL
: constant := 22;
72 ENOMEM
: constant := 12;
73 EPERM
: constant := 1;
74 ETIMEDOUT
: constant := 110;
80 Max_Interrupt
: constant := 63;
81 type Signal
is new int
range 0 .. Max_Interrupt
;
82 for Signal
'Size use int
'Size;
84 SIGHUP
: constant := 1; -- hangup
85 SIGINT
: constant := 2; -- interrupt (rubout)
86 SIGQUIT
: constant := 3; -- quit (ASCD FS)
87 SIGILL
: constant := 4; -- illegal instruction (not reset)
88 SIGTRAP
: constant := 5; -- trace trap (not reset)
89 SIGIOT
: constant := 6; -- IOT instruction
90 SIGABRT
: constant := 6; -- used by abort, replace SIGIOT in the future
91 SIGFPE
: constant := 8; -- floating point exception
92 SIGKILL
: constant := 9; -- kill (cannot be caught or ignored)
93 SIGBUS
: constant := 7; -- bus error
94 SIGSEGV
: constant := 11; -- segmentation violation
95 SIGPIPE
: constant := 13; -- write on a pipe with no one to read it
96 SIGALRM
: constant := 14; -- alarm clock
97 SIGTERM
: constant := 15; -- software termination signal from kill
98 SIGUSR1
: constant := 10; -- user defined signal 1
99 SIGUSR2
: constant := 12; -- user defined signal 2
100 SIGCLD
: constant := 17; -- alias for SIGCHLD
101 SIGCHLD
: constant := 17; -- child status change
102 SIGPWR
: constant := 30; -- power-fail restart
103 SIGWINCH
: constant := 28; -- window size change
104 SIGURG
: constant := 23; -- urgent condition on IO channel
105 SIGPOLL
: constant := 29; -- pollable event occurred
106 SIGIO
: constant := 29; -- I/O now possible (4.2 BSD)
107 SIGLOST
: constant := 29; -- File lock lost
108 SIGSTOP
: constant := 19; -- stop (cannot be caught or ignored)
109 SIGTSTP
: constant := 20; -- user stop requested from tty
110 SIGCONT
: constant := 18; -- stopped process has been continued
111 SIGTTIN
: constant := 21; -- background tty read attempted
112 SIGTTOU
: constant := 22; -- background tty write attempted
113 SIGVTALRM
: constant := 26; -- virtual timer expired
114 SIGPROF
: constant := 27; -- profiling timer expired
115 SIGXCPU
: constant := 24; -- CPU time limit exceeded
116 SIGXFSZ
: constant := 25; -- filesize limit exceeded
117 SIGUNUSED
: constant := 31; -- unused signal (GNU/Linux)
118 SIGSTKFLT
: constant := 16; -- coprocessor stack fault (Linux)
119 SIGLTHRRES
: constant := 32; -- GNU/LinuxThreads restart signal
120 SIGLTHRCAN
: constant := 33; -- GNU/LinuxThreads cancel signal
121 SIGLTHRDBG
: constant := 34; -- GNU/LinuxThreads debugger signal
123 SIGADAABORT
: constant := SIGABRT
;
124 -- Change this if you want to use another signal for task abort.
125 -- SIGTERM might be a good one.
127 type Signal_Set
is array (Natural range <>) of Signal
;
129 Unmasked
: constant Signal_Set
:= (
131 -- To enable debugging on multithreaded applications, mark SIGTRAP to
136 SIGTTIN
, SIGTTOU
, SIGTSTP
,
137 -- Keep these three signals unmasked so that background processes
138 -- and IO behaves as normal "C" applications
141 -- To avoid confusing the profiler
144 -- These two signals actually cannot be masked;
145 -- POSIX simply won't allow it.
147 SIGLTHRRES
, SIGLTHRCAN
, SIGLTHRDBG
);
148 -- These three signals are used by GNU/LinuxThreads starting from
149 -- glibc 2.1 (future 2.2).
151 Reserved
: constant Signal_Set
:=
152 -- I am not sure why the following two signals are reserved.
153 -- I guess they are not supported by this version of GNU/Linux.
154 (SIGVTALRM
, SIGUNUSED
);
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
: unsigned_long
;
186 sa_restorer
: System
.Address
;
188 pragma Convention
(C
, struct_sigaction
);
189 type struct_sigaction_ptr
is access all struct_sigaction
;
191 type Machine_State
is record
199 type Machine_State_Ptr
is access all Machine_State
;
201 SA_SIGINFO
: constant := 16#
04#
;
203 SIG_BLOCK
: constant := 0;
204 SIG_UNBLOCK
: constant := 1;
205 SIG_SETMASK
: constant := 2;
207 SIG_DFL
: constant := 0;
208 SIG_IGN
: constant := 1;
212 act
: struct_sigaction_ptr
;
213 oact
: struct_sigaction_ptr
) return int
;
214 pragma Import
(C
, sigaction
, "sigaction");
220 type timespec
is private;
222 function To_Duration
(TS
: timespec
) return Duration;
223 pragma Inline
(To_Duration
);
225 function To_Timespec
(D
: Duration) return timespec
;
226 pragma Inline
(To_Timespec
);
228 type struct_timeval
is private;
230 function To_Duration
(TV
: struct_timeval
) return Duration;
231 pragma Inline
(To_Duration
);
233 function To_Timeval
(D
: Duration) return struct_timeval
;
234 pragma Inline
(To_Timeval
);
236 function gettimeofday
237 (tv
: access struct_timeval
;
238 tz
: System
.Address
:= System
.Null_Address
) return int
;
239 pragma Import
(C
, gettimeofday
, "gettimeofday");
241 function sysconf
(name
: int
) return long
;
242 pragma Import
(C
, sysconf
);
244 SC_CLK_TCK
: constant := 2;
246 -------------------------
247 -- Priority Scheduling --
248 -------------------------
250 SCHED_OTHER
: constant := 0;
251 SCHED_FIFO
: constant := 1;
252 SCHED_RR
: constant := 2;
258 type pid_t
is private;
260 function kill
(pid
: pid_t
; sig
: Signal
) return int
;
261 pragma Import
(C
, kill
, "kill");
263 function getpid
return pid_t
;
264 pragma Import
(C
, getpid
, "getpid");
270 type Thread_Body
is access
271 function (arg
: System
.Address
) return System
.Address
;
273 function Thread_Body_Access
is new
274 Unchecked_Conversion
(System
.Address
, Thread_Body
);
276 type pthread_t
is new unsigned_long
;
277 subtype Thread_Id
is pthread_t
;
279 function To_pthread_t
is new Unchecked_Conversion
280 (unsigned_long
, pthread_t
);
282 type pthread_mutex_t
is limited private;
283 type pthread_cond_t
is limited private;
284 type pthread_attr_t
is limited private;
285 type pthread_mutexattr_t
is limited private;
286 type pthread_condattr_t
is limited private;
287 type pthread_key_t
is private;
289 PTHREAD_CREATE_DETACHED
: constant := 1;
295 function Get_Stack_Base
(thread
: pthread_t
) return Address
;
296 pragma Inline
(Get_Stack_Base
);
297 -- This is a dummy procedure to share some GNULLI files
299 ---------------------------------------
300 -- Nonstandard Thread Initialization --
301 ---------------------------------------
303 procedure pthread_init
;
304 pragma Inline
(pthread_init
);
305 -- This is a dummy procedure to share some GNULLI files
307 -------------------------
308 -- POSIX.1c Section 3 --
309 -------------------------
311 function sigwait
(set
: access sigset_t
; sig
: access Signal
) return int
;
312 pragma Import
(C
, sigwait
, "sigwait");
314 function pthread_kill
(thread
: pthread_t
; sig
: Signal
) return int
;
315 pragma Import
(C
, pthread_kill
, "pthread_kill");
317 type sigset_t_ptr
is access all sigset_t
;
319 function pthread_sigmask
322 oset
: sigset_t_ptr
) return int
;
323 pragma Import
(C
, pthread_sigmask
, "pthread_sigmask");
325 --------------------------
326 -- POSIX.1c Section 11 --
327 --------------------------
329 function pthread_mutexattr_init
330 (attr
: access pthread_mutexattr_t
) return int
;
331 pragma Import
(C
, pthread_mutexattr_init
, "pthread_mutexattr_init");
333 function pthread_mutexattr_destroy
334 (attr
: access pthread_mutexattr_t
) return int
;
335 pragma Import
(C
, pthread_mutexattr_destroy
, "pthread_mutexattr_destroy");
337 function pthread_mutex_init
338 (mutex
: access pthread_mutex_t
;
339 attr
: access pthread_mutexattr_t
) return int
;
340 pragma Import
(C
, pthread_mutex_init
, "pthread_mutex_init");
342 function pthread_mutex_destroy
(mutex
: access pthread_mutex_t
) return int
;
343 pragma Import
(C
, pthread_mutex_destroy
, "pthread_mutex_destroy");
345 function pthread_mutex_lock
(mutex
: access pthread_mutex_t
) return int
;
346 pragma Import
(C
, pthread_mutex_lock
, "pthread_mutex_lock");
348 function pthread_mutex_unlock
(mutex
: access pthread_mutex_t
) return int
;
349 pragma Import
(C
, pthread_mutex_unlock
, "pthread_mutex_unlock");
351 function pthread_condattr_init
352 (attr
: access pthread_condattr_t
) return int
;
353 pragma Import
(C
, pthread_condattr_init
, "pthread_condattr_init");
355 function pthread_condattr_destroy
356 (attr
: access pthread_condattr_t
) return int
;
357 pragma Import
(C
, pthread_condattr_destroy
, "pthread_condattr_destroy");
359 function pthread_cond_init
360 (cond
: access pthread_cond_t
;
361 attr
: access pthread_condattr_t
) return int
;
362 pragma Import
(C
, pthread_cond_init
, "pthread_cond_init");
364 function pthread_cond_destroy
(cond
: access pthread_cond_t
) return int
;
365 pragma Import
(C
, pthread_cond_destroy
, "pthread_cond_destroy");
367 function pthread_cond_signal
(cond
: access pthread_cond_t
) return int
;
368 pragma Import
(C
, pthread_cond_signal
, "pthread_cond_signal");
370 function pthread_cond_wait
371 (cond
: access pthread_cond_t
;
372 mutex
: access pthread_mutex_t
) return int
;
373 pragma Import
(C
, pthread_cond_wait
, "pthread_cond_wait");
375 function pthread_cond_timedwait
376 (cond
: access pthread_cond_t
;
377 mutex
: access pthread_mutex_t
;
378 abstime
: access timespec
) return int
;
379 pragma Import
(C
, pthread_cond_timedwait
, "pthread_cond_timedwait");
381 --------------------------
382 -- POSIX.1c Section 13 --
383 --------------------------
385 type struct_sched_param
is record
386 sched_priority
: int
; -- scheduling priority
388 pragma Convention
(C
, struct_sched_param
);
390 function pthread_setschedparam
393 param
: access struct_sched_param
) return int
;
394 pragma Import
(C
, pthread_setschedparam
, "pthread_setschedparam");
396 function pthread_attr_setschedpolicy
397 (attr
: access pthread_attr_t
;
398 policy
: int
) return int
;
400 (C
, pthread_attr_setschedpolicy
, "pthread_attr_setschedpolicy");
402 function sched_yield
return int
;
403 pragma Import
(C
, sched_yield
, "sched_yield");
405 ---------------------------
406 -- P1003.1c - Section 16 --
407 ---------------------------
409 function pthread_attr_init
410 (attributes
: access pthread_attr_t
) return int
;
411 pragma Import
(C
, pthread_attr_init
, "pthread_attr_init");
413 function pthread_attr_destroy
414 (attributes
: access pthread_attr_t
) return int
;
415 pragma Import
(C
, pthread_attr_destroy
, "pthread_attr_destroy");
417 function pthread_attr_setdetachstate
418 (attr
: access pthread_attr_t
;
419 detachstate
: int
) return int
;
421 (C
, pthread_attr_setdetachstate
, "pthread_attr_setdetachstate");
423 function pthread_attr_setstacksize
424 (attr
: access pthread_attr_t
;
425 stacksize
: size_t
) return int
;
426 pragma Import
(C
, pthread_attr_setstacksize
, "pthread_attr_setstacksize");
428 function pthread_create
429 (thread
: access pthread_t
;
430 attributes
: access pthread_attr_t
;
431 start_routine
: Thread_Body
;
432 arg
: System
.Address
) return int
;
433 pragma Import
(C
, pthread_create
, "pthread_create");
435 procedure pthread_exit
(status
: System
.Address
);
436 pragma Import
(C
, pthread_exit
, "pthread_exit");
438 function pthread_self
return pthread_t
;
439 pragma Import
(C
, pthread_self
, "pthread_self");
441 --------------------------
442 -- POSIX.1c Section 17 --
443 --------------------------
445 function pthread_setspecific
446 (key
: pthread_key_t
;
447 value
: System
.Address
) return int
;
448 pragma Import
(C
, pthread_setspecific
, "pthread_setspecific");
450 function pthread_getspecific
(key
: pthread_key_t
) return System
.Address
;
451 pragma Import
(C
, pthread_getspecific
, "pthread_getspecific");
453 type destructor_pointer
is access procedure (arg
: System
.Address
);
455 function pthread_key_create
456 (key
: access pthread_key_t
;
457 destructor
: destructor_pointer
) return int
;
458 pragma Import
(C
, pthread_key_create
, "pthread_key_create");
462 type sigset_t
is array (0 .. 127) of unsigned_char
;
463 pragma Convention
(C
, sigset_t
);
465 type pid_t
is new int
;
467 type time_t
is new long
;
469 type timespec
is record
473 pragma Convention
(C
, timespec
);
475 type struct_timeval
is record
479 pragma Convention
(C
, struct_timeval
);
481 type pthread_attr_t
is record
484 schedparam
: struct_sched_param
;
489 stackaddr
: System
.Address
;
492 pragma Convention
(C
, pthread_attr_t
);
494 type pthread_condattr_t
is record
497 pragma Convention
(C
, pthread_condattr_t
);
499 type pthread_mutexattr_t
is record
502 pragma Convention
(C
, pthread_mutexattr_t
);
504 type struct_pthread_fast_lock
is record
508 pragma Convention
(C
, struct_pthread_fast_lock
);
510 type pthread_mutex_t
is record
513 m_owner
: System
.Address
;
515 m_lock
: struct_pthread_fast_lock
;
517 pragma Convention
(C
, pthread_mutex_t
);
519 type pthread_cond_t
is array (0 .. 47) of unsigned_char
;
520 pragma Convention
(C
, pthread_cond_t
);
522 type pthread_key_t
is new unsigned
;
524 end System
.OS_Interface
;