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. --
31 -- Extensive contributions were provided by Ada Core Technologies, Inc. --
33 ------------------------------------------------------------------------------
35 -- This is the DEC Unix 4.0/5.1 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 Ada
.Unchecked_Conversion
;
46 package System
.OS_Interface
is
49 pragma Linker_Options
("-lpthread");
50 pragma Linker_Options
("-lmach");
51 pragma Linker_Options
("-lexc");
52 pragma Linker_Options
("-lrt");
54 subtype int
is Interfaces
.C
.int
;
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
;
63 subtype char_array
is Interfaces
.C
.char_array
;
69 function errno
return int
;
70 pragma Import
(C
, errno
, "_Geterrno");
72 EAGAIN
: constant := 35;
73 EINTR
: constant := 4;
74 EINVAL
: constant := 22;
75 ENOMEM
: constant := 12;
76 ETIMEDOUT
: constant := 60;
82 Max_Interrupt
: constant := 48;
83 type Signal
is new int
range 0 .. Max_Interrupt
;
84 for Signal
'Size use int
'Size;
86 SIGHUP
: constant := 1; -- hangup
87 SIGINT
: constant := 2; -- interrupt (rubout)
88 SIGQUIT
: constant := 3; -- quit (ASCD FS)
89 SIGILL
: constant := 4; -- illegal instruction (not reset)
90 SIGTRAP
: constant := 5; -- trace trap (not reset)
91 SIGABRT
: constant := 6; -- used by abort, replace SIGIOT in the future
92 SIGIOT
: constant := 6; -- abort (terminate) process
93 SIGLOST
: constant := 6; -- old BSD signal ??
94 SIGEMT
: constant := 7; -- EMT instruction
95 SIGFPE
: constant := 8; -- floating point exception
96 SIGKILL
: constant := 9; -- kill (cannot be caught or ignored)
97 SIGBUS
: constant := 10; -- bus error
98 SIGSEGV
: constant := 11; -- segmentation violation
99 SIGSYS
: constant := 12; -- bad argument to system call
100 SIGPIPE
: constant := 13; -- write on a pipe with no one to read it
101 SIGALRM
: constant := 14; -- alarm clock
102 SIGTERM
: constant := 15; -- software termination signal from kill
103 SIGURG
: constant := 16; -- urgent condition on IO channel
104 SIGIOINT
: constant := 16; -- printer to backend error signal
105 SIGSTOP
: constant := 17; -- stop (cannot be caught or ignored)
106 SIGTSTP
: constant := 18; -- user stop requested from tty
107 SIGCONT
: constant := 19; -- stopped process has been continued
108 SIGCHLD
: constant := 20; -- child status change
109 SIGTTIN
: constant := 21; -- background tty read attempted
110 SIGTTOU
: constant := 22; -- background tty write attempted
111 SIGPOLL
: constant := 23; -- I/O possible, or completed
112 SIGIO
: constant := 23; -- STREAMS version of SIGPOLL
113 SIGAIO
: constant := 23; -- base lan i/o
114 SIGPTY
: constant := 23; -- pty i/o
115 SIGXCPU
: constant := 24; -- CPU time limit exceeded
116 SIGXFSZ
: constant := 25; -- filesize limit exceeded
117 SIGVTALRM
: constant := 26; -- virtual timer expired
118 SIGPROF
: constant := 27; -- profiling timer expired
119 SIGWINCH
: constant := 28; -- window size change
120 SIGINFO
: constant := 29; -- information request
121 SIGPWR
: constant := 29; -- Power Fail/Restart -- SVID3/SVR4
122 SIGUSR1
: constant := 30; -- user defined signal 1
123 SIGUSR2
: constant := 31; -- user defined signal 2
124 SIGRESV
: constant := 32; -- reserved by Digital for future use
126 SIGADAABORT
: constant := SIGABRT
;
128 type Signal_Set
is array (Natural range <>) of Signal
;
130 Unmasked
: constant Signal_Set
:= (0 .. 0 => SIGTRAP
);
131 Reserved
: constant Signal_Set
:= (SIGALRM
, SIGABRT
, SIGKILL
, SIGSTOP
);
133 type sigset_t
is private;
135 function sigaddset
(set
: access sigset_t
; sig
: Signal
) return int
;
136 pragma Import
(C
, sigaddset
);
138 function sigdelset
(set
: access sigset_t
; sig
: Signal
) return int
;
139 pragma Import
(C
, sigdelset
);
141 function sigfillset
(set
: access sigset_t
) return int
;
142 pragma Import
(C
, sigfillset
);
144 function sigismember
(set
: access sigset_t
; sig
: Signal
) return int
;
145 pragma Import
(C
, sigismember
);
147 function sigemptyset
(set
: access sigset_t
) return int
;
148 pragma Import
(C
, sigemptyset
);
150 type union_type_3
is new String (1 .. 116);
151 type siginfo_t
is record
155 X_data
: union_type_3
;
157 for siginfo_t
'Size use 8 * 128;
158 pragma Convention
(C
, siginfo_t
);
160 type struct_sigaction
is record
161 sa_handler
: System
.Address
;
166 pragma Convention
(C
, struct_sigaction
);
167 type struct_sigaction_ptr
is access all struct_sigaction
;
169 SIG_BLOCK
: constant := 1;
170 SIG_UNBLOCK
: constant := 2;
171 SIG_SETMASK
: constant := 3;
173 SIG_DFL
: constant := 0;
174 SIG_IGN
: constant := 1;
176 SA_NODEFER
: constant := 8;
177 SA_SIGINFO
: constant := 16#
40#
;
181 act
: struct_sigaction_ptr
;
182 oact
: struct_sigaction_ptr
) return int
;
183 pragma Import
(C
, sigaction
);
189 type timespec
is private;
191 function nanosleep
(rqtp
, rmtp
: access timespec
) return int
;
192 pragma Import
(C
, nanosleep
);
194 type clockid_t
is private;
196 CLOCK_REALTIME
: constant clockid_t
;
198 function clock_gettime
199 (clock_id
: clockid_t
;
200 tp
: access timespec
) return int
;
201 pragma Import
(C
, clock_gettime
);
203 function To_Duration
(TS
: timespec
) return Duration;
204 pragma Inline
(To_Duration
);
206 function To_Timespec
(D
: Duration) return timespec
;
207 pragma Inline
(To_Timespec
);
209 type struct_timezone
is record
210 tz_minuteswest
: int
;
213 pragma Convention
(C
, struct_timezone
);
215 -------------------------
216 -- Priority Scheduling --
217 -------------------------
219 SCHED_FIFO
: constant := 1;
220 SCHED_RR
: constant := 2;
221 SCHED_OTHER
: constant := 3;
222 SCHED_LFI
: constant := 5;
228 type pid_t
is private;
230 function kill
(pid
: pid_t
; sig
: Signal
) return int
;
231 pragma Import
(C
, kill
);
233 function getpid
return pid_t
;
234 pragma Import
(C
, getpid
);
236 BIND_NO_INHERIT
: constant := 1;
240 cpu_mask
: unsigned_long
;
241 flag
: unsigned_long
:= BIND_NO_INHERIT
) return int
;
242 pragma Import
(C
, bind_to_cpu
);
248 type Thread_Body
is access
249 function (arg
: System
.Address
) return System
.Address
;
250 pragma Convention
(C
, Thread_Body
);
252 function Thread_Body_Access
is new
253 Ada
.Unchecked_Conversion
(System
.Address
, Thread_Body
);
255 type pthread_t
is private;
256 subtype Thread_Id
is pthread_t
;
258 type pthread_mutex_t
is limited private;
259 type pthread_cond_t
is limited private;
260 type pthread_attr_t
is limited private;
261 type pthread_mutexattr_t
is limited private;
262 type pthread_condattr_t
is limited private;
263 type pthread_key_t
is private;
265 PTHREAD_CREATE_DETACHED
: constant := 1;
267 PTHREAD_SCOPE_PROCESS
: constant := 0;
268 PTHREAD_SCOPE_SYSTEM
: constant := 1;
270 PTHREAD_EXPLICIT_SCHED
: constant := 1;
276 Stack_Base_Available
: constant Boolean := False;
277 -- Indicates if the stack base is available on this target
279 function Get_Stack_Base
(thread
: pthread_t
) return Address
;
280 pragma Inline
(Get_Stack_Base
);
281 -- Returns the stack base of the specified thread. Only call this function
282 -- when Stack_Base_Available is True.
284 function Get_Page_Size
return size_t
;
285 function Get_Page_Size
return Address
;
286 pragma Import
(C
, Get_Page_Size
, "getpagesize");
287 -- Returns the size of a page, or 0 if this is not relevant on this target
289 PROT_NONE
: constant := 0;
290 PROT_READ
: constant := 1;
291 PROT_WRITE
: constant := 2;
292 PROT_EXEC
: constant := 4;
293 PROT_ALL
: constant := PROT_READ
+ PROT_WRITE
+ PROT_EXEC
;
295 PROT_ON
: constant := PROT_READ
;
296 PROT_OFF
: constant := PROT_ALL
;
298 function mprotect
(addr
: Address
; len
: size_t
; prot
: int
) return int
;
299 pragma Import
(C
, mprotect
);
301 procedure Hide_Unhide_Yellow_Zone
(Hide
: Boolean);
302 -- Every thread except the initial one features an overflow warning area
303 -- (called the Yellow Zone) which is just above the overflow guard area
304 -- on the stack (called the Red Zone). During task execution, we want
305 -- signals from the Red Zone, so we need to hide the Yellow Zone. This
306 -- procedure is called at the start of task execution (with Hide set True)
307 -- to hide the Yellow Zone, and at the end of task execution (with Hide
308 -- set False) to unhide the Yellow Zone.
310 ---------------------------------------
311 -- Nonstandard Thread Initialization --
312 ---------------------------------------
314 procedure pthread_init
;
315 pragma Inline
(pthread_init
);
316 -- This is a dummy procedure to share some GNULLI files
318 -------------------------
319 -- POSIX.1c Section 3 --
320 -------------------------
323 (set
: access sigset_t
;
324 sig
: access Signal
) return int
;
325 pragma Import
(C
, sigwait
, "__sigwaitd10");
327 function pthread_kill
329 sig
: Signal
) return int
;
330 pragma Import
(C
, pthread_kill
);
332 function pthread_sigmask
334 set
: access sigset_t
;
335 oset
: access sigset_t
) return int
;
336 pragma Import
(C
, pthread_sigmask
);
338 --------------------------
339 -- POSIX.1c Section 11 --
340 --------------------------
342 function pthread_mutexattr_init
(attr
: access pthread_mutexattr_t
)
344 pragma Import
(C
, pthread_mutexattr_init
);
346 function pthread_mutexattr_destroy
347 (attr
: access pthread_mutexattr_t
) return int
;
348 pragma Import
(C
, pthread_mutexattr_destroy
);
350 function pthread_mutex_init
351 (mutex
: access pthread_mutex_t
;
352 attr
: access pthread_mutexattr_t
) return int
;
353 pragma Import
(C
, pthread_mutex_init
, "__pthread_mutex_init");
355 function pthread_mutex_destroy
(mutex
: access pthread_mutex_t
) return int
;
356 pragma Import
(C
, pthread_mutex_destroy
, "__pthread_mutex_destroy");
358 function pthread_mutex_lock
(mutex
: access pthread_mutex_t
) return int
;
359 pragma Import
(C
, pthread_mutex_lock
, "__pthread_mutex_lock");
361 function pthread_mutex_unlock
(mutex
: access pthread_mutex_t
) return int
;
362 pragma Import
(C
, pthread_mutex_unlock
, "__pthread_mutex_unlock");
364 function pthread_condattr_init
365 (attr
: access pthread_condattr_t
) return int
;
366 pragma Import
(C
, pthread_condattr_init
);
368 function pthread_condattr_destroy
369 (attr
: access pthread_condattr_t
) return int
;
370 pragma Import
(C
, pthread_condattr_destroy
);
372 function pthread_cond_init
373 (cond
: access pthread_cond_t
;
374 attr
: access pthread_condattr_t
) return int
;
375 pragma Import
(C
, pthread_cond_init
, "__pthread_cond_init");
377 function pthread_cond_destroy
(cond
: access pthread_cond_t
) return int
;
378 pragma Import
(C
, pthread_cond_destroy
, "__pthread_cond_destroy");
380 function pthread_cond_signal
(cond
: access pthread_cond_t
) return int
;
381 pragma Import
(C
, pthread_cond_signal
, "__pthread_cond_signal");
383 function pthread_cond_wait
384 (cond
: access pthread_cond_t
;
385 mutex
: access pthread_mutex_t
) return int
;
386 pragma Import
(C
, pthread_cond_wait
, "__pthread_cond_wait");
388 function pthread_cond_timedwait
389 (cond
: access pthread_cond_t
;
390 mutex
: access pthread_mutex_t
;
391 abstime
: access timespec
) return int
;
392 pragma Import
(C
, pthread_cond_timedwait
, "__pthread_cond_timedwait");
394 --------------------------
395 -- POSIX.1c Section 13 --
396 --------------------------
398 function pthread_mutexattr_setprotocol
399 (attr
: access pthread_mutexattr_t
;
400 protocol
: int
) return int
;
401 pragma Import
(C
, pthread_mutexattr_setprotocol
);
403 function pthread_mutexattr_setprioceiling
404 (attr
: access pthread_mutexattr_t
;
405 prioceiling
: int
) return int
;
406 pragma Import
(C
, pthread_mutexattr_setprioceiling
);
408 type struct_sched_param
is record
409 sched_priority
: int
; -- scheduling priority
412 function pthread_setschedparam
415 param
: access struct_sched_param
) return int
;
416 pragma Import
(C
, pthread_setschedparam
);
418 function pthread_attr_setscope
419 (attr
: access pthread_attr_t
;
420 contentionscope
: int
) return int
;
421 pragma Import
(C
, pthread_attr_setscope
);
423 function pthread_attr_setinheritsched
424 (attr
: access pthread_attr_t
;
425 inheritsched
: int
) return int
;
426 pragma Import
(C
, pthread_attr_setinheritsched
,
427 "__pthread_attr_setinheritsched");
429 function pthread_attr_setschedpolicy
430 (attr
: access pthread_attr_t
; policy
: int
) return int
;
431 pragma Import
(C
, pthread_attr_setschedpolicy
);
433 function pthread_attr_setschedparam
434 (attr
: access pthread_attr_t
;
435 sched_param
: access struct_sched_param
) return int
;
436 pragma Import
(C
, pthread_attr_setschedparam
);
438 function sched_yield
return int
;
439 pragma Import
(C
, sched_yield
);
441 --------------------------
442 -- P1003.1c Section 16 --
443 --------------------------
445 function pthread_attr_init
(attributes
: access pthread_attr_t
)
447 pragma Import
(C
, pthread_attr_init
);
449 function pthread_attr_destroy
(attributes
: access pthread_attr_t
)
451 pragma Import
(C
, pthread_attr_destroy
);
453 function pthread_attr_setdetachstate
454 (attr
: access pthread_attr_t
;
455 detachstate
: int
) return int
;
456 pragma Import
(C
, pthread_attr_setdetachstate
);
458 function pthread_attr_setstacksize
459 (attr
: access pthread_attr_t
;
460 stacksize
: size_t
) return int
;
461 pragma Import
(C
, pthread_attr_setstacksize
, "__pthread_attr_setstacksize");
463 function pthread_create
464 (thread
: access pthread_t
;
465 attributes
: access pthread_attr_t
;
466 start_routine
: Thread_Body
;
467 arg
: System
.Address
) return int
;
468 pragma Import
(C
, pthread_create
, "__pthread_create");
470 procedure pthread_exit
(status
: System
.Address
);
471 pragma Import
(C
, pthread_exit
, "__pthread_exit");
473 function pthread_self
return pthread_t
;
474 pragma Inline
(pthread_self
);
476 --------------------------
477 -- POSIX.1c Section 17 --
478 --------------------------
480 function pthread_setspecific
481 (key
: pthread_key_t
; value
: System
.Address
) return int
;
482 pragma Import
(C
, pthread_setspecific
, "__pthread_setspecific");
484 function pthread_getspecific
(key
: pthread_key_t
) return System
.Address
;
485 pragma Import
(C
, pthread_getspecific
, "__pthread_getspecific");
487 type destructor_pointer
is access procedure (arg
: System
.Address
);
488 pragma Convention
(C
, destructor_pointer
);
490 function pthread_key_create
491 (key
: access pthread_key_t
;
492 destructor
: destructor_pointer
) return int
;
493 pragma Import
(C
, pthread_key_create
);
497 type sigset_t
is new unsigned_long
;
499 type pid_t
is new int
;
501 type time_t
is new int
;
503 type timespec
is record
507 pragma Convention
(C
, timespec
);
509 type clockid_t
is new int
;
510 CLOCK_REALTIME
: constant clockid_t
:= 1;
512 type unsigned_long_array
is array (Natural range <>) of unsigned_long
;
514 type pthread_t
is new System
.Address
;
516 type pthread_teb_t
is record
517 reserved1
: System
.Address
;
518 reserved2
: System
.Address
;
519 size
: unsigned_short
;
520 version
: unsigned_char
;
521 reserved3
: unsigned_char
;
522 external
: unsigned_char
;
523 reserved4
: char_array
(0 .. 1);
524 creator
: unsigned_char
;
525 sequence
: unsigned_long
;
526 reserved5
: unsigned_long_array
(0 .. 1);
527 per_kt_area
: System
.Address
;
528 stack_base
: System
.Address
;
529 stack_reserve
: System
.Address
;
530 stack_yellow
: System
.Address
;
531 stack_guard
: System
.Address
;
532 stack_size
: unsigned_long
;
533 tsd_values
: System
.Address
;
534 tsd_count
: unsigned_long
;
535 reserved6
: unsigned
;
536 reserved7
: unsigned
;
537 thread_flags
: unsigned
;
539 stack_hiwater
: System
.Address
;
540 home_rad
: unsigned_long
;
542 pragma Convention
(C
, pthread_teb_t
);
544 type pthread_cond_t
is record
547 name
: System
.Address
;
549 reserved1
: unsigned
;
550 sequence
: unsigned_long
;
551 block
: System
.Address
;
553 pragma Convention
(C
, pthread_cond_t
);
555 type pthread_attr_t
is record
557 name
: System
.Address
;
559 reserved
: unsigned_long_array
(0 .. 18);
561 pragma Convention
(C
, pthread_attr_t
);
563 type pthread_mutex_t
is record
566 name
: System
.Address
;
569 sequence
: unsigned_long
;
570 owner
: unsigned_long
;
571 block
: System
.Address
;
573 for pthread_mutex_t
'Size use 8 * 48;
574 pragma Convention
(C
, pthread_mutex_t
);
576 type pthread_mutexattr_t
is record
578 reserved
: unsigned_long_array
(0 .. 14);
580 pragma Convention
(C
, pthread_mutexattr_t
);
582 type pthread_condattr_t
is record
584 reserved
: unsigned_long_array
(0 .. 12);
586 pragma Convention
(C
, pthread_condattr_t
);
588 type pthread_key_t
is new unsigned
;
590 end System
.OS_Interface
;