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-2017, Florida State University --
10 -- Copyright (C) 1995-2023, 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 HPUX 11.0 (Native THREADS) version of this package
35 -- This package encapsulates all direct interfaces to OS services that are
36 -- 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
;
45 with System
.Parameters
;
47 package System
.OS_Interface
is
50 pragma Linker_Options
("-lpthread");
52 subtype int
is Interfaces
.C
.int
;
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 ETIMEDOUT
: constant := 238;
79 Max_Interrupt
: constant := 44;
80 type Signal
is new int
range 0 .. Max_Interrupt
;
81 for Signal
'Size use int
'Size;
83 SIGHUP
: constant := 1; -- hangup
84 SIGINT
: constant := 2; -- interrupt (rubout)
85 SIGQUIT
: constant := 3; -- quit (ASCD FS)
86 SIGILL
: constant := 4; -- illegal instruction (not reset)
87 SIGTRAP
: constant := 5; -- trace trap (not reset)
88 SIGIOT
: constant := 6; -- IOT instruction
89 SIGABRT
: constant := 6; -- used by abort, replace SIGIOT in the future
90 SIGEMT
: constant := 7; -- EMT instruction
91 SIGFPE
: constant := 8; -- floating point exception
92 SIGKILL
: constant := 9; -- kill (cannot be caught or ignored)
93 SIGBUS
: constant := 10; -- bus error
94 SIGSEGV
: constant := 11; -- segmentation violation
95 SIGSYS
: constant := 12; -- bad argument to system call
96 SIGPIPE
: constant := 13; -- write on a pipe with no one to read it
97 SIGALRM
: constant := 14; -- alarm clock
98 SIGTERM
: constant := 15; -- software termination signal from kill
99 SIGUSR1
: constant := 16; -- user defined signal 1
100 SIGUSR2
: constant := 17; -- user defined signal 2
101 SIGCLD
: constant := 18; -- alias for SIGCHLD
102 SIGCHLD
: constant := 18; -- child status change
103 SIGPWR
: constant := 19; -- power-fail restart
104 SIGVTALRM
: constant := 20; -- virtual timer alarm
105 SIGPROF
: constant := 21; -- profiling timer alarm
106 SIGIO
: constant := 22; -- asynchronous I/O
107 SIGPOLL
: constant := 22; -- pollable event occurred
108 SIGWINCH
: constant := 23; -- window size change
109 SIGSTOP
: constant := 24; -- stop (cannot be caught or ignored)
110 SIGTSTP
: constant := 25; -- user stop requested from tty
111 SIGCONT
: constant := 26; -- stopped process has been continued
112 SIGTTIN
: constant := 27; -- background tty read attempted
113 SIGTTOU
: constant := 28; -- background tty write attempted
114 SIGURG
: constant := 29; -- urgent condition on IO channel
115 SIGLOST
: constant := 30; -- remote lock lost (NFS)
116 SIGDIL
: constant := 32; -- DIL signal
117 SIGXCPU
: constant := 33; -- CPU time limit exceeded (setrlimit)
118 SIGXFSZ
: constant := 34; -- file size limit exceeded (setrlimit)
119 SIGCANCEL
: constant := 35; -- used for pthread cancellation.
120 SIGGFAULT
: constant := 36; -- Graphics framebuffer fault
122 SIGADAABORT
: constant := SIGABRT
;
123 -- Note: on other targets, we usually use SIGABRT, but on HPUX, it
124 -- appears that SIGABRT can't be used in sigwait(), so we use SIGTERM.
125 -- Do we use SIGTERM or SIGABRT???
127 type Signal_Set
is array (Natural range <>) of Signal
;
129 Unmasked
: constant Signal_Set
:=
130 (SIGABRT
, SIGPIPE
, SIGBUS
, SIGTRAP
, SIGTTIN
, SIGTTOU
, SIGTSTP
, SIGPROF
,
131 SIGALRM
, SIGVTALRM
, SIGIO
, SIGCHLD
);
133 Reserved
: constant Signal_Set
:= (SIGKILL
, SIGSTOP
);
135 type sigset_t
is private;
137 function sigaddset
(set
: access sigset_t
; sig
: Signal
) return int
;
138 pragma Import
(C
, sigaddset
, "sigaddset");
140 function sigdelset
(set
: access sigset_t
; sig
: Signal
) return int
;
141 pragma Import
(C
, sigdelset
, "sigdelset");
143 function sigfillset
(set
: access sigset_t
) return int
;
144 pragma Import
(C
, sigfillset
, "sigfillset");
146 function sigismember
(set
: access sigset_t
; sig
: Signal
) return int
;
147 pragma Import
(C
, sigismember
, "sigismember");
149 function sigemptyset
(set
: access sigset_t
) return int
;
150 pragma Import
(C
, sigemptyset
, "sigemptyset");
152 type struct_sigaction
is record
153 sa_handler
: System
.Address
;
157 pragma Convention
(C
, struct_sigaction
);
158 type struct_sigaction_ptr
is access all struct_sigaction
;
160 SA_SIGINFO
: constant := 16#
10#
;
161 SA_ONSTACK
: constant := 16#
01#
;
163 SIG_BLOCK
: constant := 0;
164 SIG_UNBLOCK
: constant := 1;
165 SIG_SETMASK
: constant := 2;
167 SIG_DFL
: constant := 0;
168 SIG_IGN
: constant := 1;
172 act
: struct_sigaction_ptr
;
173 oact
: struct_sigaction_ptr
) return int
;
174 pragma Import
(C
, sigaction
, "sigaction");
180 Time_Slice_Supported
: constant Boolean := True;
181 -- Indicates whether time slicing is supported
183 type timespec
is private;
185 type clockid_t
is new int
;
187 function clock_gettime
188 (clock_id
: clockid_t
;
189 tp
: access timespec
) return int
;
190 pragma Import
(C
, clock_gettime
, "clock_gettime");
192 function clock_getres
193 (clock_id
: clockid_t
;
194 res
: access timespec
) return int
;
195 pragma Import
(C
, clock_getres
, "clock_getres");
197 function To_Duration
(TS
: timespec
) return Duration;
198 pragma Inline
(To_Duration
);
200 function To_Timespec
(D
: Duration) return timespec
;
201 pragma Inline
(To_Timespec
);
203 type struct_timezone
is record
204 tz_minuteswest
: int
;
207 pragma Convention
(C
, struct_timezone
);
208 type struct_timezone_ptr
is access all struct_timezone
;
210 -------------------------
211 -- Priority Scheduling --
212 -------------------------
214 SCHED_FIFO
: constant := 0;
215 SCHED_RR
: constant := 1;
216 SCHED_OTHER
: constant := 2;
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 pragma Import
(C
, lwp_self
, "_lwp_self");
245 type Thread_Body
is access
246 function (arg
: System
.Address
) return System
.Address
;
247 pragma Convention
(C
, Thread_Body
);
249 function Thread_Body_Access
is new
250 Ada
.Unchecked_Conversion
(System
.Address
, Thread_Body
);
252 type pthread_t
is private;
253 subtype Thread_Id
is pthread_t
;
255 type pthread_mutex_t
is limited private;
256 type pthread_cond_t
is limited private;
257 type pthread_attr_t
is limited private;
258 type pthread_mutexattr_t
is limited private;
259 type pthread_condattr_t
is limited private;
260 type pthread_key_t
is private;
262 PTHREAD_CREATE_DETACHED
: constant := 16#de#
;
264 PTHREAD_SCOPE_PROCESS
: constant := 2;
265 PTHREAD_SCOPE_SYSTEM
: constant := 1;
267 -- Read/Write lock not supported on HPUX. To add support both types
268 -- pthread_rwlock_t and pthread_rwlockattr_t must properly be defined
269 -- with the associated routines pthread_rwlock_[init/destroy] and
270 -- pthread_rwlock_[rdlock/wrlock/unlock].
272 subtype pthread_rwlock_t
is pthread_mutex_t
;
273 subtype pthread_rwlockattr_t
is pthread_mutexattr_t
;
279 type stack_t
is record
280 ss_sp
: System
.Address
;
284 pragma Convention
(C
, stack_t
);
287 (ss
: not null access stack_t
;
288 oss
: access stack_t
) return int
;
289 pragma Import
(C
, sigaltstack
, "sigaltstack");
291 Alternate_Stack
: aliased System
.Address
;
292 pragma Import
(C
, Alternate_Stack
, "__gnat_alternate_stack");
293 -- The alternate signal stack for stack overflows
295 Alternate_Stack_Size
: constant := 128 * 1024;
296 -- This must be in keeping with init.c:__gnat_alternate_stack
298 Stack_Base_Available
: constant Boolean := False;
299 -- Indicates whether the stack base is available on this target
301 function Get_Stack_Base
(thread
: pthread_t
) return Address
;
302 pragma Inline
(Get_Stack_Base
);
303 -- Returns the stack base of the specified thread. Only call this function
304 -- when Stack_Base_Available is True.
306 function Get_Page_Size
return int
;
307 pragma Import
(C
, Get_Page_Size
, "getpagesize");
308 -- Returns the size of a page
310 PROT_NONE
: constant := 0;
311 PROT_READ
: constant := 1;
312 PROT_WRITE
: constant := 2;
313 PROT_EXEC
: constant := 4;
314 PROT_ALL
: constant := PROT_READ
+ PROT_WRITE
+ PROT_EXEC
;
315 PROT_ON
: constant := PROT_READ
;
316 PROT_OFF
: constant := PROT_ALL
;
318 function mprotect
(addr
: Address
; len
: size_t
; prot
: int
) return int
;
319 pragma Import
(C
, mprotect
);
321 ---------------------------------------
322 -- Nonstandard Thread Initialization --
323 ---------------------------------------
325 procedure pthread_init
;
326 pragma Inline
(pthread_init
);
327 -- This is a dummy procedure to share some GNULLI files
329 -------------------------
330 -- POSIX.1c Section 3 --
331 -------------------------
334 (set
: access sigset_t
;
335 sig
: access Signal
) return int
;
336 pragma Import
(C
, sigwait
, "sigwait");
338 function pthread_kill
340 sig
: Signal
) return int
;
341 pragma Import
(C
, pthread_kill
, "pthread_kill");
343 function pthread_sigmask
345 set
: access sigset_t
;
346 oset
: access sigset_t
) return int
;
347 pragma Import
(C
, pthread_sigmask
, "pthread_sigmask");
349 --------------------------
350 -- POSIX.1c Section 11 --
351 --------------------------
353 function pthread_mutexattr_init
354 (attr
: access pthread_mutexattr_t
) return int
;
355 pragma Import
(C
, pthread_mutexattr_init
, "pthread_mutexattr_init");
357 function pthread_mutexattr_destroy
358 (attr
: access pthread_mutexattr_t
) return int
;
359 pragma Import
(C
, pthread_mutexattr_destroy
, "pthread_mutexattr_destroy");
361 function pthread_mutex_init
362 (mutex
: access pthread_mutex_t
;
363 attr
: access pthread_mutexattr_t
) return int
;
364 pragma Import
(C
, pthread_mutex_init
, "pthread_mutex_init");
366 function pthread_mutex_destroy
(mutex
: access pthread_mutex_t
) return int
;
367 pragma Import
(C
, pthread_mutex_destroy
, "pthread_mutex_destroy");
369 function pthread_mutex_lock
(mutex
: access pthread_mutex_t
) return int
;
370 pragma Import
(C
, pthread_mutex_lock
, "pthread_mutex_lock");
372 function pthread_mutex_unlock
(mutex
: access pthread_mutex_t
) return int
;
373 pragma Import
(C
, pthread_mutex_unlock
, "pthread_mutex_unlock");
375 function pthread_condattr_init
376 (attr
: access pthread_condattr_t
) return int
;
377 pragma Import
(C
, pthread_condattr_init
, "pthread_condattr_init");
379 function pthread_condattr_destroy
380 (attr
: access pthread_condattr_t
) return int
;
381 pragma Import
(C
, pthread_condattr_destroy
, "pthread_condattr_destroy");
383 function pthread_cond_init
384 (cond
: access pthread_cond_t
;
385 attr
: access pthread_condattr_t
) return int
;
386 pragma Import
(C
, pthread_cond_init
, "pthread_cond_init");
388 function pthread_cond_destroy
(cond
: access pthread_cond_t
) return int
;
389 pragma Import
(C
, pthread_cond_destroy
, "pthread_cond_destroy");
391 function pthread_cond_signal
(cond
: access pthread_cond_t
) return int
;
392 pragma Import
(C
, pthread_cond_signal
, "pthread_cond_signal");
394 function pthread_cond_wait
395 (cond
: access pthread_cond_t
;
396 mutex
: access pthread_mutex_t
) return int
;
397 pragma Import
(C
, pthread_cond_wait
, "pthread_cond_wait");
399 function pthread_cond_timedwait
400 (cond
: access pthread_cond_t
;
401 mutex
: access pthread_mutex_t
;
402 abstime
: access timespec
) return int
;
403 pragma Import
(C
, pthread_cond_timedwait
, "pthread_cond_timedwait");
405 --------------------------
406 -- POSIX.1c Section 13 --
407 --------------------------
409 PTHREAD_PRIO_NONE
: constant := 16#
100#
;
410 PTHREAD_PRIO_PROTECT
: constant := 16#
200#
;
411 PTHREAD_PRIO_INHERIT
: constant := 16#
400#
;
413 function pthread_mutexattr_setprotocol
414 (attr
: access pthread_mutexattr_t
;
415 protocol
: int
) return int
;
416 pragma Import
(C
, pthread_mutexattr_setprotocol
);
418 function pthread_mutexattr_setprioceiling
419 (attr
: access pthread_mutexattr_t
;
420 prioceiling
: int
) return int
;
421 pragma Import
(C
, pthread_mutexattr_setprioceiling
);
423 type Array_7_Int
is array (0 .. 6) of int
;
424 type struct_sched_param
is record
425 sched_priority
: int
;
426 sched_reserved
: Array_7_Int
;
429 function pthread_setschedparam
432 param
: access struct_sched_param
)
434 pragma Import
(C
, pthread_setschedparam
, "pthread_setschedparam");
436 function pthread_attr_setscope
437 (attr
: access pthread_attr_t
;
438 contentionscope
: int
) return int
;
439 pragma Import
(C
, pthread_attr_setscope
, "pthread_attr_setscope");
441 function pthread_attr_setinheritsched
442 (attr
: access pthread_attr_t
;
443 inheritsched
: int
) return int
;
444 pragma Import
(C
, pthread_attr_setinheritsched
);
446 function pthread_attr_setschedpolicy
447 (attr
: access pthread_attr_t
;
448 policy
: int
) return int
;
449 pragma Import
(C
, pthread_attr_setschedpolicy
);
451 function sched_yield
return int
;
452 pragma Import
(C
, sched_yield
, "sched_yield");
454 --------------------------
455 -- P1003.1c Section 16 --
456 --------------------------
458 function pthread_attr_init
459 (attributes
: access pthread_attr_t
) return int
;
460 pragma Import
(C
, pthread_attr_init
, "__pthread_attr_init_system");
462 function pthread_attr_destroy
463 (attributes
: access pthread_attr_t
) return int
;
464 pragma Import
(C
, pthread_attr_destroy
, "pthread_attr_destroy");
466 function pthread_attr_setdetachstate
467 (attr
: access pthread_attr_t
;
468 detachstate
: int
) return int
;
469 pragma Import
(C
, pthread_attr_setdetachstate
);
471 function pthread_attr_setstacksize
472 (attr
: access pthread_attr_t
;
473 stacksize
: size_t
) return int
;
474 pragma Import
(C
, pthread_attr_setstacksize
, "pthread_attr_setstacksize");
476 function pthread_create
477 (thread
: access pthread_t
;
478 attributes
: access pthread_attr_t
;
479 start_routine
: Thread_Body
;
480 arg
: System
.Address
) return int
;
481 pragma Import
(C
, pthread_create
, "__pthread_create_system");
483 procedure pthread_exit
(status
: System
.Address
);
484 pragma Import
(C
, pthread_exit
, "pthread_exit");
486 function pthread_self
return pthread_t
;
487 pragma Import
(C
, pthread_self
, "pthread_self");
489 --------------------------
490 -- POSIX.1c Section 17 --
491 --------------------------
493 function pthread_setspecific
494 (key
: pthread_key_t
;
495 value
: System
.Address
) return int
;
496 pragma Import
(C
, pthread_setspecific
, "pthread_setspecific");
498 function pthread_getspecific
(key
: pthread_key_t
) return System
.Address
;
499 pragma Import
(C
, pthread_getspecific
, "pthread_getspecific");
501 type destructor_pointer
is access procedure (arg
: System
.Address
);
502 pragma Convention
(C
, destructor_pointer
);
504 function pthread_key_create
505 (key
: access pthread_key_t
;
506 destructor
: destructor_pointer
) return int
;
507 pragma Import
(C
, pthread_key_create
, "pthread_key_create");
511 type unsigned_int_array_8
is array (0 .. 7) of unsigned
;
512 type sigset_t
is record
513 sigset
: unsigned_int_array_8
;
515 pragma Convention
(C_Pass_By_Copy
, sigset_t
);
517 type pid_t
is new int
;
519 type time_t
is range -2 ** (System
.Parameters
.time_t_bits
- 1)
520 .. 2 ** (System
.Parameters
.time_t_bits
- 1) - 1;
522 type timespec
is record
526 pragma Convention
(C
, timespec
);
528 type pthread_attr_t
is new int
;
529 type pthread_condattr_t
is new int
;
530 type pthread_mutexattr_t
is new int
;
531 type pthread_t
is new int
;
533 type short_array
is array (Natural range <>) of short
;
534 type int_array
is array (Natural range <>) of int
;
536 type pthread_mutex_t
is record
537 m_short
: short_array
(0 .. 1);
539 m_int1
: int_array
(0 .. 3);
543 -- actually m_ptr is a void*, and on 32 bit ABI, m_pad is added so that
544 -- this field takes 64 bits. On 64 bit ABI, m_pad is gone, and m_ptr is
545 -- a 64 bit void*. Assume int'Size = 32.
547 m_int2
: int_array
(0 .. 1);
548 m_int3
: int_array
(0 .. 3);
549 m_short2
: short_array
(0 .. 1);
550 m_int4
: int_array
(0 .. 4);
551 m_int5
: int_array
(0 .. 1);
553 for pthread_mutex_t
'Alignment use System
.Address
'Alignment;
554 pragma Convention
(C
, pthread_mutex_t
);
556 type pthread_cond_t
is record
557 c_short
: short_array
(0 .. 1);
559 c_int1
: int_array
(0 .. 3);
561 m_ptr
: int
; -- see comment in pthread_mutex_t
562 c_int2
: int_array
(0 .. 1);
563 c_int3
: int_array
(0 .. 1);
564 c_int4
: int_array
(0 .. 1);
566 for pthread_cond_t
'Alignment use System
.Address
'Alignment;
567 pragma Convention
(C
, pthread_cond_t
);
569 type pthread_key_t
is new int
;
571 end System
.OS_Interface
;