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-2006, 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 Darwin pthreads version of this package.
37 -- This package includes 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
41 -- or remove the pragma Elaborate_Body.
42 -- It is designed to be a bottom-level (leaf) package.
45 package System
.OS_Interface
is
48 subtype int
is Interfaces
.C
.int
;
49 subtype short
is Interfaces
.C
.short
;
50 subtype long
is Interfaces
.C
.long
;
51 subtype unsigned
is Interfaces
.C
.unsigned
;
52 subtype unsigned_short
is Interfaces
.C
.unsigned_short
;
53 subtype unsigned_long
is Interfaces
.C
.unsigned_long
;
54 subtype unsigned_char
is Interfaces
.C
.unsigned_char
;
55 subtype plain_char
is Interfaces
.C
.plain_char
;
56 subtype size_t
is Interfaces
.C
.size_t
;
62 function errno
return int
;
63 pragma Import
(C
, errno
, "__get_errno");
65 EINTR
: constant := 4;
66 ENOMEM
: constant := 12;
67 EINVAL
: constant := 22;
68 EAGAIN
: constant := 35;
69 ETIMEDOUT
: constant := 60;
75 Max_Interrupt
: constant := 31;
76 type Signal
is new int
range 0 .. Max_Interrupt
;
77 for Signal
'Size use int
'Size;
79 SIGHUP
: constant := 1; -- hangup
80 SIGINT
: constant := 2; -- interrupt (rubout)
81 SIGQUIT
: constant := 3; -- quit (ASCD FS)
82 SIGILL
: constant := 4; -- illegal instruction (not reset)
83 SIGTRAP
: constant := 5; -- trace trap (not reset)
84 SIGIOT
: constant := 6; -- IOT instruction
85 SIGABRT
: constant := 6; -- used by abort, replace SIGIOT in the future
86 SIGEMT
: constant := 7; -- EMT instruction
87 SIGFPE
: constant := 8; -- floating point exception
88 SIGKILL
: constant := 9; -- kill (cannot be caught or ignored)
89 SIGBUS
: constant := 10; -- bus error
90 SIGSEGV
: constant := 11; -- segmentation violation
91 SIGSYS
: constant := 12; -- bad argument to system call
92 SIGPIPE
: constant := 13; -- write on a pipe with no one to read it
93 SIGALRM
: constant := 14; -- alarm clock
94 SIGTERM
: constant := 15; -- software termination signal from kill
95 SIGURG
: constant := 16; -- urgent condition on IO channel
96 SIGSTOP
: constant := 17; -- stop (cannot be caught or ignored)
97 SIGTSTP
: constant := 18; -- user stop requested from tty
98 SIGCONT
: constant := 19; -- stopped process has been continued
99 SIGCHLD
: constant := 20; -- child status change
100 SIGTTIN
: constant := 21; -- background tty read attempted
101 SIGTTOU
: constant := 22; -- background tty write attempted
102 SIGIO
: constant := 23; -- I/O possible (Solaris SIGPOLL alias)
103 SIGXCPU
: constant := 24; -- CPU time limit exceeded
104 SIGXFSZ
: constant := 25; -- filesize limit exceeded
105 SIGVTALRM
: constant := 26; -- virtual timer expired
106 SIGPROF
: constant := 27; -- profiling timer expired
107 SIGWINCH
: constant := 28; -- window size change
108 SIGINFO
: constant := 29; -- information request
109 SIGUSR1
: constant := 30; -- user defined signal 1
110 SIGUSR2
: constant := 31; -- user defined signal 2
112 SIGADAABORT
: constant := SIGTERM
;
113 -- Change this if you want to use another signal for task abort.
114 -- SIGTERM might be a good one.
116 type Signal_Set
is array (Natural range <>) of Signal
;
118 Unmasked
: constant Signal_Set
:=
119 (SIGTTIN
, SIGTTOU
, SIGSTOP
, SIGTSTP
);
121 Reserved
: constant Signal_Set
:=
124 type sigset_t
is private;
126 function sigaddset
(set
: access sigset_t
; sig
: Signal
) return int
;
127 pragma Import
(C
, sigaddset
, "sigaddset");
129 function sigdelset
(set
: access sigset_t
; sig
: Signal
) return int
;
130 pragma Import
(C
, sigdelset
, "sigdelset");
132 function sigfillset
(set
: access sigset_t
) return int
;
133 pragma Import
(C
, sigfillset
, "sigfillset");
135 function sigismember
(set
: access sigset_t
; sig
: Signal
) return int
;
136 pragma Import
(C
, sigismember
, "sigismember");
138 function sigemptyset
(set
: access sigset_t
) return int
;
139 pragma Import
(C
, sigemptyset
, "sigemptyset");
141 type siginfo_t
is private;
142 type ucontext_t
is private;
144 type Signal_Handler
is access procedure
146 info
: access siginfo_t
;
147 context
: access ucontext_t
);
149 type struct_sigaction
is record
150 sa_handler
: System
.Address
;
154 pragma Convention
(C
, struct_sigaction
);
155 type struct_sigaction_ptr
is access all struct_sigaction
;
157 SIG_BLOCK
: constant := 1;
158 SIG_UNBLOCK
: constant := 2;
159 SIG_SETMASK
: constant := 3;
161 SIG_DFL
: constant := 0;
162 SIG_IGN
: constant := 1;
164 SA_SIGINFO
: constant := 16#
0040#
;
168 act
: struct_sigaction_ptr
;
169 oact
: struct_sigaction_ptr
) return int
;
170 pragma Import
(C
, sigaction
, "sigaction");
176 Time_Slice_Supported
: constant Boolean := True;
177 -- Indicates wether time slicing is supported.
179 type timespec
is private;
181 type clockid_t
is private;
183 CLOCK_REALTIME
: constant clockid_t
;
185 function clock_gettime
186 (clock_id
: clockid_t
;
187 tp
: access timespec
) return int
;
189 function To_Duration
(TS
: timespec
) return Duration;
190 pragma Inline
(To_Duration
);
192 function To_Timespec
(D
: Duration) return timespec
;
193 pragma Inline
(To_Timespec
);
195 type struct_timeval
is private;
197 function To_Duration
(TV
: struct_timeval
) return Duration;
198 pragma Inline
(To_Duration
);
200 function To_Timeval
(D
: Duration) return struct_timeval
;
201 pragma Inline
(To_Timeval
);
203 -------------------------
204 -- Priority Scheduling --
205 -------------------------
207 SCHED_OTHER
: constant := 1;
208 SCHED_RR
: constant := 2;
209 SCHED_FIFO
: constant := 4;
211 function To_Target_Priority
212 (Prio
: System
.Any_Priority
) return Interfaces
.C
.int
;
213 -- Maps System.Any_Priority to a POSIX priority.
219 type pid_t
is private;
221 function kill
(pid
: pid_t
; sig
: Signal
) return int
;
222 pragma Import
(C
, kill
, "kill");
224 function getpid
return pid_t
;
225 pragma Import
(C
, getpid
, "getpid");
231 function lwp_self
return System
.Address
;
232 -- lwp_self does not exist on this thread library, revert to pthread_self
233 -- which is the closest approximation (with getpid). This function is
234 -- needed to share 7staprop.adb across POSIX-like targets.
235 pragma Import
(C
, lwp_self
, "pthread_self");
241 type Thread_Body
is access
242 function (arg
: System
.Address
) return System
.Address
;
243 type pthread_t
is private;
244 subtype Thread_Id
is pthread_t
;
246 type pthread_mutex_t
is limited private;
247 type pthread_cond_t
is limited private;
248 type pthread_attr_t
is limited private;
249 type pthread_mutexattr_t
is limited private;
250 type pthread_condattr_t
is limited private;
251 type pthread_key_t
is private;
253 type pthread_mutex_ptr
is access all pthread_mutex_t
;
254 type pthread_cond_ptr
is access all pthread_cond_t
;
256 PTHREAD_CREATE_DETACHED
: constant := 2;
262 Stack_Base_Available
: constant Boolean := False;
263 -- Indicates wether the stack base is available on this target.
264 -- This allows us to share s-osinte.adb between all the FSU run time.
265 -- Note that this value can only be true if pthread_t has a complete
266 -- definition that corresponds exactly to the C header files.
268 function Get_Stack_Base
(thread
: pthread_t
) return System
.Address
;
269 pragma Inline
(Get_Stack_Base
);
270 -- returns the stack base of the specified thread.
271 -- Only call this function when Stack_Base_Available is True.
273 function Get_Page_Size
return size_t
;
274 function Get_Page_Size
return System
.Address
;
275 pragma Import
(C
, Get_Page_Size
, "getpagesize");
276 -- returns the size of a page, or 0 if this is not relevant on this
279 PROT_NONE
: constant := 0;
280 PROT_READ
: constant := 1;
281 PROT_WRITE
: constant := 2;
282 PROT_EXEC
: constant := 4;
283 PROT_ALL
: constant := PROT_READ
+ PROT_WRITE
+ PROT_EXEC
;
285 PROT_ON
: constant := PROT_NONE
;
286 PROT_OFF
: constant := PROT_ALL
;
288 function mprotect
(addr
: System
.Address
;
290 prot
: int
) return int
;
291 pragma Import
(C
, mprotect
);
293 ---------------------------------------
294 -- Nonstandard Thread Initialization --
295 ---------------------------------------
297 procedure pthread_init
;
299 -------------------------
300 -- POSIX.1c Section 3 --
301 -------------------------
303 function sigwait
(set
: access sigset_t
; sig
: access Signal
) return int
;
304 pragma Import
(C
, sigwait
, "sigwait");
306 function pthread_kill
(thread
: pthread_t
; sig
: Signal
) return int
;
307 pragma Import
(C
, pthread_kill
, "pthread_kill");
309 function pthread_sigmask
311 set
: access sigset_t
;
312 oset
: access sigset_t
) return int
;
313 pragma Import
(C
, pthread_sigmask
, "pthread_sigmask");
315 --------------------------
316 -- POSIX.1c Section 11 --
317 --------------------------
319 function pthread_mutexattr_init
320 (attr
: access pthread_mutexattr_t
) return int
;
321 pragma Import
(C
, pthread_mutexattr_init
, "pthread_mutexattr_init");
323 function pthread_mutexattr_destroy
324 (attr
: access pthread_mutexattr_t
) return int
;
325 pragma Import
(C
, pthread_mutexattr_destroy
, "pthread_mutexattr_destroy");
327 function pthread_mutex_init
328 (mutex
: access pthread_mutex_t
;
329 attr
: access pthread_mutexattr_t
) return int
;
330 pragma Import
(C
, pthread_mutex_init
, "pthread_mutex_init");
332 function pthread_mutex_destroy
(mutex
: access pthread_mutex_t
) return int
;
333 pragma Import
(C
, pthread_mutex_destroy
, "pthread_mutex_destroy");
335 function pthread_mutex_lock
(mutex
: access pthread_mutex_t
) return int
;
336 pragma Import
(C
, pthread_mutex_lock
, "pthread_mutex_lock");
338 function pthread_mutex_unlock
(mutex
: access pthread_mutex_t
) return int
;
339 pragma Import
(C
, pthread_mutex_unlock
, "pthread_mutex_unlock");
341 function pthread_condattr_init
342 (attr
: access pthread_condattr_t
) return int
;
343 pragma Import
(C
, pthread_condattr_init
, "pthread_condattr_init");
345 function pthread_condattr_destroy
346 (attr
: access pthread_condattr_t
) return int
;
347 pragma Import
(C
, pthread_condattr_destroy
, "pthread_condattr_destroy");
349 function pthread_cond_init
350 (cond
: access pthread_cond_t
;
351 attr
: access pthread_condattr_t
) return int
;
352 pragma Import
(C
, pthread_cond_init
, "pthread_cond_init");
354 function pthread_cond_destroy
(cond
: access pthread_cond_t
) return int
;
355 pragma Import
(C
, pthread_cond_destroy
, "pthread_cond_destroy");
357 function pthread_cond_signal
(cond
: access pthread_cond_t
) return int
;
358 pragma Import
(C
, pthread_cond_signal
, "pthread_cond_signal");
360 function pthread_cond_wait
361 (cond
: access pthread_cond_t
;
362 mutex
: access pthread_mutex_t
) return int
;
363 pragma Import
(C
, pthread_cond_wait
, "pthread_cond_wait");
365 function pthread_cond_timedwait
366 (cond
: access pthread_cond_t
;
367 mutex
: access pthread_mutex_t
;
368 abstime
: access timespec
) return int
;
369 pragma Import
(C
, pthread_cond_timedwait
, "pthread_cond_timedwait");
371 Relative_Timed_Wait
: constant Boolean := False;
372 -- pthread_cond_timedwait requires an absolute delay time
374 --------------------------
375 -- POSIX.1c Section 13 --
376 --------------------------
378 PTHREAD_PRIO_NONE
: constant := 0;
379 PTHREAD_PRIO_INHERIT
: constant := 1;
380 PTHREAD_PRIO_PROTECT
: constant := 2;
382 function pthread_mutexattr_setprotocol
383 (attr
: access pthread_mutexattr_t
;
384 protocol
: int
) return int
;
386 (C
, pthread_mutexattr_setprotocol
, "pthread_mutexattr_setprotocol");
388 function pthread_mutexattr_setprioceiling
389 (attr
: access pthread_mutexattr_t
;
390 prioceiling
: int
) return int
;
392 (C
, pthread_mutexattr_setprioceiling
,
393 "pthread_mutexattr_setprioceiling");
395 type padding
is array (int
range <>) of Interfaces
.C
.char
;
397 type struct_sched_param
is record
398 sched_priority
: int
; -- scheduling priority
399 opaque
: padding
(1 .. 4);
401 pragma Convention
(C
, struct_sched_param
);
403 function pthread_setschedparam
406 param
: access struct_sched_param
) return int
;
407 pragma Import
(C
, pthread_setschedparam
, "pthread_setschedparam");
409 function pthread_attr_setscope
410 (attr
: access pthread_attr_t
;
411 contentionscope
: int
) return int
;
412 pragma Import
(C
, pthread_attr_setscope
, "pthread_attr_setscope");
414 function pthread_attr_setinheritsched
415 (attr
: access pthread_attr_t
;
416 inheritsched
: int
) return int
;
418 (C
, pthread_attr_setinheritsched
, "pthread_attr_setinheritsched");
420 function pthread_attr_setschedpolicy
421 (attr
: access pthread_attr_t
;
422 policy
: int
) return int
;
423 pragma Import
(C
, pthread_attr_setschedpolicy
, "pthread_attr_setsched");
425 function sched_yield
return int
;
427 ---------------------------
428 -- P1003.1c - Section 16 --
429 ---------------------------
431 function pthread_attr_init
(attributes
: access pthread_attr_t
) return int
;
432 pragma Import
(C
, pthread_attr_init
, "pthread_attr_init");
434 function pthread_attr_destroy
435 (attributes
: access pthread_attr_t
) return int
;
436 pragma Import
(C
, pthread_attr_destroy
, "pthread_attr_destroy");
438 function pthread_attr_setdetachstate
439 (attr
: access pthread_attr_t
;
440 detachstate
: int
) return int
;
442 (C
, pthread_attr_setdetachstate
, "pthread_attr_setdetachstate");
444 function pthread_attr_setstacksize
445 (attr
: access pthread_attr_t
;
446 stacksize
: size_t
) return int
;
448 (C
, pthread_attr_setstacksize
, "pthread_attr_setstacksize");
450 function pthread_create
451 (thread
: access pthread_t
;
452 attributes
: access pthread_attr_t
;
453 start_routine
: Thread_Body
;
454 arg
: System
.Address
) return int
;
455 pragma Import
(C
, pthread_create
, "pthread_create");
457 procedure pthread_exit
(status
: System
.Address
);
458 pragma Import
(C
, pthread_exit
, "pthread_exit");
460 function pthread_self
return pthread_t
;
461 pragma Import
(C
, pthread_self
, "pthread_self");
463 --------------------------
464 -- POSIX.1c Section 17 --
465 --------------------------
467 function pthread_setspecific
468 (key
: pthread_key_t
;
469 value
: System
.Address
) return int
;
470 pragma Import
(C
, pthread_setspecific
, "pthread_setspecific");
472 function pthread_getspecific
(key
: pthread_key_t
) return System
.Address
;
473 pragma Import
(C
, pthread_getspecific
, "pthread_getspecific");
475 type destructor_pointer
is access procedure (arg
: System
.Address
);
477 function pthread_key_create
478 (key
: access pthread_key_t
;
479 destructor
: destructor_pointer
) return int
;
480 pragma Import
(C
, pthread_key_create
, "pthread_key_create");
484 type sigset_t
is new unsigned
;
486 type int32_t
is new int
;
488 type pid_t
is new int32_t
;
490 type time_t
is new long
;
492 type timespec
is record
496 pragma Convention
(C
, timespec
);
498 type clockid_t
is new int
;
499 CLOCK_REALTIME
: constant clockid_t
:= 0;
501 type struct_timeval
is record
505 pragma Convention
(C
, struct_timeval
);
508 -- Darwin specific signal implementation
510 type Pad_Type
is array (1 .. 7) of unsigned
;
511 type siginfo_t
is record
512 si_signo
: int
; -- signal number
513 si_errno
: int
; -- errno association
514 si_code
: int
; -- signal code
515 si_pid
: int
; -- sending process
516 si_uid
: unsigned
; -- sender's ruid
517 si_status
: int
; -- exit value
518 si_addr
: System
.Address
; -- faulting instruction
519 si_value
: System
.Address
; -- signal value
520 si_band
: long
; -- band event for SIGPOLL
521 pad
: Pad_Type
; -- RFU
523 pragma Convention
(C
, siginfo_t
);
525 type stack_t
is record
526 ss_sp
: System
.Address
;
530 pragma Convention
(C
, stack_t
);
532 type mcontext_t
is new System
.Address
;
534 type ucontext_t
is record
536 uc_sigmask
: sigset_t
; -- Signal Mask Used By This Context
537 uc_stack
: stack_t
; -- Stack Used By This Context
538 uc_link
: System
.Address
; -- Pointer To Resuming Context
539 uc_mcsize
: size_t
; -- Size of The Machine Context
540 uc_mcontext
: mcontext_t
; -- Machine Specific Context
542 pragma Convention
(C
, ucontext_t
);
545 -- Darwin specific pthread implementation
547 type pthread_t
is new System
.Address
;
549 type pthread_lock_t
is new long
;
551 type pthread_attr_t
is record
553 opaque
: padding
(1 .. 36);
555 pragma Convention
(C
, pthread_attr_t
);
557 type pthread_mutexattr_t
is record
559 opaque
: padding
(1 .. 8);
561 pragma Convention
(C
, pthread_mutexattr_t
);
563 type pthread_mutex_t
is record
565 opaque
: padding
(1 .. 40);
567 pragma Convention
(C
, pthread_mutex_t
);
569 type pthread_condattr_t
is record
571 opaque
: padding
(1 .. 4);
573 pragma Convention
(C
, pthread_condattr_t
);
575 type pthread_cond_t
is record
577 opaque
: padding
(1 .. 24);
579 pragma Convention
(C
, pthread_cond_t
);
581 type pthread_once_t
is record
583 opaque
: padding
(1 .. 4);
585 pragma Convention
(C
, pthread_once_t
);
587 type pthread_key_t
is new unsigned_long
;
589 end System
.OS_Interface
;