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-2009, 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 that are needed
38 -- by the tasking run-time (libgnarl).
40 -- PLEASE DO NOT add any with-clauses to this package or remove the pragma
41 -- Elaborate_Body. It is designed to be a bottom-level (leaf) package.
44 with System
.OS_Constants
;
46 package System
.OS_Interface
is
49 subtype int
is Interfaces
.C
.int
;
50 subtype short
is Interfaces
.C
.short
;
51 subtype long
is Interfaces
.C
.long
;
52 subtype unsigned
is Interfaces
.C
.unsigned
;
53 subtype unsigned_short
is Interfaces
.C
.unsigned_short
;
54 subtype unsigned_long
is Interfaces
.C
.unsigned_long
;
55 subtype unsigned_char
is Interfaces
.C
.unsigned_char
;
56 subtype plain_char
is Interfaces
.C
.plain_char
;
57 subtype size_t
is Interfaces
.C
.size_t
;
63 function errno
return int
;
64 pragma Import
(C
, errno
, "__get_errno");
66 EINTR
: constant := 4;
67 ENOMEM
: constant := 12;
68 EINVAL
: constant := 22;
69 EAGAIN
: constant := 35;
70 ETIMEDOUT
: constant := 60;
76 Max_Interrupt
: constant := 31;
77 type Signal
is new int
range 0 .. Max_Interrupt
;
78 for Signal
'Size use int
'Size;
80 SIGHUP
: constant := 1; -- hangup
81 SIGINT
: constant := 2; -- interrupt (rubout)
82 SIGQUIT
: constant := 3; -- quit (ASCD FS)
83 SIGILL
: constant := 4; -- illegal instruction (not reset)
84 SIGTRAP
: constant := 5; -- trace trap (not reset)
85 SIGIOT
: constant := 6; -- IOT instruction
86 SIGABRT
: constant := 6; -- used by abort, replace SIGIOT in the future
87 SIGEMT
: constant := 7; -- EMT instruction
88 SIGFPE
: constant := 8; -- floating point exception
89 SIGKILL
: constant := 9; -- kill (cannot be caught or ignored)
90 SIGBUS
: constant := 10; -- bus error
91 SIGSEGV
: constant := 11; -- segmentation violation
92 SIGSYS
: constant := 12; -- bad argument to system call
93 SIGPIPE
: constant := 13; -- write on a pipe with no one to read it
94 SIGALRM
: constant := 14; -- alarm clock
95 SIGTERM
: constant := 15; -- software termination signal from kill
96 SIGURG
: constant := 16; -- urgent condition on IO channel
97 SIGSTOP
: constant := 17; -- stop (cannot be caught or ignored)
98 SIGTSTP
: constant := 18; -- user stop requested from tty
99 SIGCONT
: constant := 19; -- stopped process has been continued
100 SIGCHLD
: constant := 20; -- child status change
101 SIGTTIN
: constant := 21; -- background tty read attempted
102 SIGTTOU
: constant := 22; -- background tty write attempted
103 SIGIO
: constant := 23; -- I/O possible (Solaris SIGPOLL alias)
104 SIGXCPU
: constant := 24; -- CPU time limit exceeded
105 SIGXFSZ
: constant := 25; -- filesize limit exceeded
106 SIGVTALRM
: constant := 26; -- virtual timer expired
107 SIGPROF
: constant := 27; -- profiling timer expired
108 SIGWINCH
: constant := 28; -- window size change
109 SIGINFO
: constant := 29; -- information request
110 SIGUSR1
: constant := 30; -- user defined signal 1
111 SIGUSR2
: constant := 31; -- user defined signal 2
113 SIGADAABORT
: constant := SIGTERM
;
114 -- Change this if you want to use another signal for task abort.
115 -- SIGTERM might be a good one.
117 type Signal_Set
is array (Natural range <>) of Signal
;
119 Unmasked
: constant Signal_Set
:=
120 (SIGTTIN
, SIGTTOU
, SIGSTOP
, SIGTSTP
);
122 Reserved
: constant Signal_Set
:=
125 Exception_Signals
: constant Signal_Set
:=
126 (SIGFPE
, SIGILL
, SIGSEGV
, SIGBUS
);
127 -- These signals (when runtime or system) will be caught and converted
128 -- into an Ada exception.
130 type sigset_t
is private;
132 function sigaddset
(set
: access sigset_t
; sig
: Signal
) return int
;
133 pragma Import
(C
, sigaddset
, "sigaddset");
135 function sigdelset
(set
: access sigset_t
; sig
: Signal
) return int
;
136 pragma Import
(C
, sigdelset
, "sigdelset");
138 function sigfillset
(set
: access sigset_t
) return int
;
139 pragma Import
(C
, sigfillset
, "sigfillset");
141 function sigismember
(set
: access sigset_t
; sig
: Signal
) return int
;
142 pragma Import
(C
, sigismember
, "sigismember");
144 function sigemptyset
(set
: access sigset_t
) return int
;
145 pragma Import
(C
, sigemptyset
, "sigemptyset");
147 type siginfo_t
is private;
148 type ucontext_t
is private;
150 type Signal_Handler
is access procedure
152 info
: access siginfo_t
;
153 context
: access ucontext_t
);
155 type struct_sigaction
is record
156 sa_handler
: System
.Address
;
160 pragma Convention
(C
, struct_sigaction
);
161 type struct_sigaction_ptr
is access all struct_sigaction
;
163 SIG_BLOCK
: constant := 1;
164 SIG_UNBLOCK
: constant := 2;
165 SIG_SETMASK
: constant := 3;
167 SIG_DFL
: constant := 0;
168 SIG_IGN
: constant := 1;
170 SA_SIGINFO
: constant := 16#
0040#
;
171 SA_ONSTACK
: constant := 16#
0001#
;
175 act
: struct_sigaction_ptr
;
176 oact
: struct_sigaction_ptr
) return int
;
177 pragma Import
(C
, sigaction
, "sigaction");
183 Time_Slice_Supported
: constant Boolean := True;
184 -- Indicates whether time slicing is supported
186 type timespec
is private;
188 type clockid_t
is private;
190 CLOCK_REALTIME
: constant clockid_t
;
192 function clock_gettime
193 (clock_id
: clockid_t
;
194 tp
: access timespec
) return int
;
196 function To_Duration
(TS
: timespec
) return Duration;
197 pragma Inline
(To_Duration
);
199 function To_Timespec
(D
: Duration) return timespec
;
200 pragma Inline
(To_Timespec
);
202 type struct_timeval
is private;
204 function To_Duration
(TV
: struct_timeval
) return Duration;
205 pragma Inline
(To_Duration
);
207 function To_Timeval
(D
: Duration) return struct_timeval
;
208 pragma Inline
(To_Timeval
);
210 -------------------------
211 -- Priority Scheduling --
212 -------------------------
214 SCHED_OTHER
: constant := 1;
215 SCHED_RR
: constant := 2;
216 SCHED_FIFO
: constant := 4;
218 function To_Target_Priority
219 (Prio
: System
.Any_Priority
) return Interfaces
.C
.int
;
220 -- Maps System.Any_Priority to a POSIX priority
226 type pid_t
is private;
228 function kill
(pid
: pid_t
; sig
: Signal
) return int
;
229 pragma Import
(C
, kill
, "kill");
231 function getpid
return pid_t
;
232 pragma Import
(C
, getpid
, "getpid");
238 function lwp_self
return System
.Address
;
239 -- Return the mach thread bound to the current thread. The value is not
240 -- used by the run-time library but made available to debuggers.
246 type Thread_Body
is access
247 function (arg
: System
.Address
) return System
.Address
;
248 pragma Convention
(C
, Thread_Body
);
250 type pthread_t
is private;
251 subtype Thread_Id
is pthread_t
;
253 type pthread_mutex_t
is limited private;
254 type pthread_cond_t
is limited private;
255 type pthread_attr_t
is limited private;
256 type pthread_mutexattr_t
is limited private;
257 type pthread_condattr_t
is limited private;
258 type pthread_key_t
is private;
260 type pthread_mutex_ptr
is access all pthread_mutex_t
;
261 type pthread_cond_ptr
is access all pthread_cond_t
;
263 PTHREAD_CREATE_DETACHED
: constant := 2;
265 PTHREAD_SCOPE_PROCESS
: constant := 2;
266 PTHREAD_SCOPE_SYSTEM
: constant := 1;
272 type stack_t
is record
273 ss_sp
: System
.Address
;
277 pragma Convention
(C
, stack_t
);
280 (ss
: not null access stack_t
;
281 oss
: access stack_t
) return int
;
282 pragma Import
(C
, sigaltstack
, "sigaltstack");
284 Alternate_Stack
: aliased System
.Address
;
285 pragma Import
(C
, Alternate_Stack
, "__gnat_alternate_stack");
286 -- The alternate signal stack for stack overflows
288 Alternate_Stack_Size
: constant := 32 * 1024;
289 -- This must be in keeping with init.c:__gnat_alternate_stack
291 Stack_Base_Available
: constant Boolean := False;
292 -- Indicates whether the stack base is available on this target. This
293 -- allows us to share s-osinte.adb between all the FSU run time. Note that
294 -- this value can only be true if pthread_t has a complete definition that
295 -- corresponds exactly to the C header files.
297 function Get_Stack_Base
(thread
: pthread_t
) return System
.Address
;
298 pragma Inline
(Get_Stack_Base
);
299 -- returns the stack base of the specified thread. Only call this function
300 -- when Stack_Base_Available is True.
302 function Get_Page_Size
return size_t
;
303 function Get_Page_Size
return System
.Address
;
304 pragma Import
(C
, Get_Page_Size
, "getpagesize");
305 -- Returns the size of a page, or 0 if this is not relevant on this target
307 PROT_NONE
: constant := 0;
308 PROT_READ
: constant := 1;
309 PROT_WRITE
: constant := 2;
310 PROT_EXEC
: constant := 4;
311 PROT_ALL
: constant := PROT_READ
+ PROT_WRITE
+ PROT_EXEC
;
313 PROT_ON
: constant := PROT_NONE
;
314 PROT_OFF
: constant := PROT_ALL
;
317 (addr
: System
.Address
;
319 prot
: int
) return int
;
320 pragma Import
(C
, mprotect
);
322 ---------------------------------------
323 -- Nonstandard Thread Initialization --
324 ---------------------------------------
326 procedure pthread_init
;
328 -------------------------
329 -- POSIX.1c Section 3 --
330 -------------------------
332 function sigwait
(set
: access sigset_t
; sig
: access Signal
) return int
;
333 pragma Import
(C
, sigwait
, "sigwait");
335 function pthread_kill
(thread
: pthread_t
; sig
: Signal
) return int
;
336 pragma Import
(C
, pthread_kill
, "pthread_kill");
338 function pthread_sigmask
340 set
: access sigset_t
;
341 oset
: access sigset_t
) return int
;
342 pragma Import
(C
, pthread_sigmask
, "pthread_sigmask");
344 --------------------------
345 -- POSIX.1c Section 11 --
346 --------------------------
348 function pthread_mutexattr_init
349 (attr
: access pthread_mutexattr_t
) return int
;
350 pragma Import
(C
, pthread_mutexattr_init
, "pthread_mutexattr_init");
352 function pthread_mutexattr_destroy
353 (attr
: access pthread_mutexattr_t
) return int
;
354 pragma Import
(C
, pthread_mutexattr_destroy
, "pthread_mutexattr_destroy");
356 function pthread_mutex_init
357 (mutex
: access pthread_mutex_t
;
358 attr
: access pthread_mutexattr_t
) return int
;
359 pragma Import
(C
, pthread_mutex_init
, "pthread_mutex_init");
361 function pthread_mutex_destroy
(mutex
: access pthread_mutex_t
) return int
;
362 pragma Import
(C
, pthread_mutex_destroy
, "pthread_mutex_destroy");
364 function pthread_mutex_lock
(mutex
: access pthread_mutex_t
) return int
;
365 pragma Import
(C
, pthread_mutex_lock
, "pthread_mutex_lock");
367 function pthread_mutex_unlock
(mutex
: access pthread_mutex_t
) return int
;
368 pragma Import
(C
, pthread_mutex_unlock
, "pthread_mutex_unlock");
370 function pthread_condattr_init
371 (attr
: access pthread_condattr_t
) return int
;
372 pragma Import
(C
, pthread_condattr_init
, "pthread_condattr_init");
374 function pthread_condattr_destroy
375 (attr
: access pthread_condattr_t
) return int
;
376 pragma Import
(C
, pthread_condattr_destroy
, "pthread_condattr_destroy");
378 function pthread_cond_init
379 (cond
: access pthread_cond_t
;
380 attr
: access pthread_condattr_t
) return int
;
381 pragma Import
(C
, pthread_cond_init
, "pthread_cond_init");
383 function pthread_cond_destroy
(cond
: access pthread_cond_t
) return int
;
384 pragma Import
(C
, pthread_cond_destroy
, "pthread_cond_destroy");
386 function pthread_cond_signal
(cond
: access pthread_cond_t
) return int
;
387 pragma Import
(C
, pthread_cond_signal
, "pthread_cond_signal");
389 function pthread_cond_wait
390 (cond
: access pthread_cond_t
;
391 mutex
: access pthread_mutex_t
) return int
;
392 pragma Import
(C
, pthread_cond_wait
, "pthread_cond_wait");
394 function pthread_cond_timedwait
395 (cond
: access pthread_cond_t
;
396 mutex
: access pthread_mutex_t
;
397 abstime
: access timespec
) return int
;
398 pragma Import
(C
, pthread_cond_timedwait
, "pthread_cond_timedwait");
400 Relative_Timed_Wait
: constant Boolean := False;
401 -- pthread_cond_timedwait requires an absolute delay time
403 --------------------------
404 -- POSIX.1c Section 13 --
405 --------------------------
407 PTHREAD_PRIO_NONE
: constant := 0;
408 PTHREAD_PRIO_INHERIT
: constant := 1;
409 PTHREAD_PRIO_PROTECT
: constant := 2;
411 function pthread_mutexattr_setprotocol
412 (attr
: access pthread_mutexattr_t
;
413 protocol
: int
) return int
;
415 (C
, pthread_mutexattr_setprotocol
, "pthread_mutexattr_setprotocol");
417 function pthread_mutexattr_setprioceiling
418 (attr
: access pthread_mutexattr_t
;
419 prioceiling
: int
) return int
;
421 (C
, pthread_mutexattr_setprioceiling
,
422 "pthread_mutexattr_setprioceiling");
424 type padding
is array (int
range <>) of Interfaces
.C
.char
;
426 type struct_sched_param
is record
427 sched_priority
: int
; -- scheduling priority
428 opaque
: padding
(1 .. 4);
430 pragma Convention
(C
, struct_sched_param
);
432 function pthread_setschedparam
435 param
: access struct_sched_param
) return int
;
436 pragma Import
(C
, pthread_setschedparam
, "pthread_setschedparam");
438 function pthread_attr_setscope
439 (attr
: access pthread_attr_t
;
440 contentionscope
: int
) return int
;
441 pragma Import
(C
, pthread_attr_setscope
, "pthread_attr_setscope");
443 function pthread_attr_setinheritsched
444 (attr
: access pthread_attr_t
;
445 inheritsched
: int
) return int
;
447 (C
, pthread_attr_setinheritsched
, "pthread_attr_setinheritsched");
449 function pthread_attr_setschedpolicy
450 (attr
: access pthread_attr_t
;
451 policy
: int
) return int
;
452 pragma Import
(C
, pthread_attr_setschedpolicy
, "pthread_attr_setsched");
454 function sched_yield
return int
;
456 ---------------------------
457 -- P1003.1c - Section 16 --
458 ---------------------------
460 function pthread_attr_init
(attributes
: access pthread_attr_t
) return int
;
461 pragma Import
(C
, pthread_attr_init
, "pthread_attr_init");
463 function pthread_attr_destroy
464 (attributes
: access pthread_attr_t
) return int
;
465 pragma Import
(C
, pthread_attr_destroy
, "pthread_attr_destroy");
467 function pthread_attr_setdetachstate
468 (attr
: access pthread_attr_t
;
469 detachstate
: int
) return int
;
471 (C
, pthread_attr_setdetachstate
, "pthread_attr_setdetachstate");
473 function pthread_attr_setstacksize
474 (attr
: access pthread_attr_t
;
475 stacksize
: size_t
) return int
;
477 (C
, pthread_attr_setstacksize
, "pthread_attr_setstacksize");
479 function pthread_create
480 (thread
: access pthread_t
;
481 attributes
: access pthread_attr_t
;
482 start_routine
: Thread_Body
;
483 arg
: System
.Address
) return int
;
484 pragma Import
(C
, pthread_create
, "pthread_create");
486 procedure pthread_exit
(status
: System
.Address
);
487 pragma Import
(C
, pthread_exit
, "pthread_exit");
489 function pthread_self
return pthread_t
;
490 pragma Import
(C
, pthread_self
, "pthread_self");
492 --------------------------
493 -- POSIX.1c Section 17 --
494 --------------------------
496 function pthread_setspecific
497 (key
: pthread_key_t
;
498 value
: System
.Address
) return int
;
499 pragma Import
(C
, pthread_setspecific
, "pthread_setspecific");
501 function pthread_getspecific
(key
: pthread_key_t
) return System
.Address
;
502 pragma Import
(C
, pthread_getspecific
, "pthread_getspecific");
504 type destructor_pointer
is access procedure (arg
: System
.Address
);
505 pragma Convention
(C
, destructor_pointer
);
507 function pthread_key_create
508 (key
: access pthread_key_t
;
509 destructor
: destructor_pointer
) return int
;
510 pragma Import
(C
, pthread_key_create
, "pthread_key_create");
514 type sigset_t
is new unsigned
;
516 type int32_t
is new int
;
518 type pid_t
is new int32_t
;
520 type time_t
is new long
;
522 type timespec
is record
526 pragma Convention
(C
, timespec
);
528 type clockid_t
is new int
;
529 CLOCK_REALTIME
: constant clockid_t
:= 0;
531 type struct_timeval
is record
535 pragma Convention
(C
, struct_timeval
);
538 -- Darwin specific signal implementation
540 type Pad_Type
is array (1 .. 7) of unsigned_long
;
541 type siginfo_t
is record
542 si_signo
: int
; -- signal number
543 si_errno
: int
; -- errno association
544 si_code
: int
; -- signal code
545 si_pid
: int
; -- sending process
546 si_uid
: unsigned
; -- sender's ruid
547 si_status
: int
; -- exit value
548 si_addr
: System
.Address
; -- faulting instruction
549 si_value
: System
.Address
; -- signal value
550 si_band
: long
; -- band event for SIGPOLL
551 pad
: Pad_Type
; -- RFU
553 pragma Convention
(C
, siginfo_t
);
555 type mcontext_t
is new System
.Address
;
557 type ucontext_t
is record
559 uc_sigmask
: sigset_t
; -- Signal Mask Used By This Context
560 uc_stack
: stack_t
; -- Stack Used By This Context
561 uc_link
: System
.Address
; -- Pointer To Resuming Context
562 uc_mcsize
: size_t
; -- Size of The Machine Context
563 uc_mcontext
: mcontext_t
; -- Machine Specific Context
565 pragma Convention
(C
, ucontext_t
);
568 -- Darwin specific pthread implementation
570 type pthread_t
is new System
.Address
;
572 type pthread_attr_t
is record
574 opaque
: padding
(1 .. System
.OS_Constants
.PTHREAD_ATTR_SIZE
);
576 pragma Convention
(C
, pthread_attr_t
);
578 type pthread_mutexattr_t
is record
580 opaque
: padding
(1 .. System
.OS_Constants
.PTHREAD_MUTEXATTR_SIZE
);
582 pragma Convention
(C
, pthread_mutexattr_t
);
584 type pthread_mutex_t
is record
586 opaque
: padding
(1 .. System
.OS_Constants
.PTHREAD_MUTEX_SIZE
);
588 pragma Convention
(C
, pthread_mutex_t
);
590 type pthread_condattr_t
is record
592 opaque
: padding
(1 .. System
.OS_Constants
.PTHREAD_CONDATTR_SIZE
);
594 pragma Convention
(C
, pthread_condattr_t
);
596 type pthread_cond_t
is record
598 opaque
: padding
(1 .. System
.OS_Constants
.PTHREAD_COND_SIZE
);
600 pragma Convention
(C
, pthread_cond_t
);
602 type pthread_once_t
is record
604 opaque
: padding
(1 .. System
.OS_Constants
.PTHREAD_ONCE_SIZE
);
606 pragma Convention
(C
, pthread_once_t
);
608 type pthread_key_t
is new unsigned_long
;
610 end System
.OS_Interface
;