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-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. It is --
29 -- now maintained by Ada Core Technologies Inc. in cooperation with Florida --
30 -- State University (http://www.gnat.com). --
32 ------------------------------------------------------------------------------
34 -- This is the DragonFly BSD PTHREADS version of this package
36 -- This package encapsulates all direct interfaces to OS services
37 -- that are needed by the tasking run-time (libgnarl).
39 -- PLEASE DO NOT add any with-clauses to this package or remove the pragma
40 -- Preelaborate. This package is designed to be a bottom-level (leaf) package.
42 with Ada
.Unchecked_Conversion
;
46 with System
.Parameters
;
48 package System
.OS_Interface
is
51 pragma Linker_Options
("-pthread");
53 subtype int
is Interfaces
.C
.int
;
54 subtype short
is Interfaces
.C
.short
;
55 subtype long
is Interfaces
.C
.long
;
56 subtype unsigned
is Interfaces
.C
.unsigned
;
57 subtype unsigned_short
is Interfaces
.C
.unsigned_short
;
58 subtype unsigned_long
is Interfaces
.C
.unsigned_long
;
59 subtype unsigned_char
is Interfaces
.C
.unsigned_char
;
60 subtype plain_char
is Interfaces
.C
.plain_char
;
61 subtype size_t
is Interfaces
.C
.size_t
;
67 function Errno
return int
;
68 pragma Inline
(Errno
);
70 EAGAIN
: constant := 35;
71 EINTR
: constant := 4;
72 EINVAL
: constant := 22;
73 ENOMEM
: constant := 12;
74 ETIMEDOUT
: constant := 60;
80 Max_Interrupt
: constant := 31;
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 SIGEMT
: constant := 7; -- EMT instruction
92 SIGFPE
: constant := 8; -- floating point exception
93 SIGKILL
: constant := 9; -- kill (cannot be caught or ignored)
94 SIGBUS
: constant := 10; -- bus error
95 SIGSEGV
: constant := 11; -- segmentation violation
96 SIGSYS
: constant := 12; -- bad argument to system call
97 SIGPIPE
: constant := 13; -- write on a pipe with no one to read it
98 SIGALRM
: constant := 14; -- alarm clock
99 SIGTERM
: constant := 15; -- software termination signal from kill
100 SIGURG
: constant := 16; -- urgent condition on IO channel
101 SIGSTOP
: constant := 17; -- stop (cannot be caught or ignored)
102 SIGTSTP
: constant := 18; -- user stop requested from tty
103 SIGCONT
: constant := 19; -- stopped process has been continued
104 SIGCLD
: constant := 20; -- alias for SIGCHLD
105 SIGCHLD
: constant := 20; -- child status change
106 SIGTTIN
: constant := 21; -- background tty read attempted
107 SIGTTOU
: constant := 22; -- background tty write attempted
108 SIGIO
: constant := 23; -- I/O possible (Solaris SIGPOLL alias)
109 SIGXCPU
: constant := 24; -- CPU time limit exceeded
110 SIGXFSZ
: constant := 25; -- filesize limit exceeded
111 SIGVTALRM
: constant := 26; -- virtual timer expired
112 SIGPROF
: constant := 27; -- profiling timer expired
113 SIGWINCH
: constant := 28; -- window size change
114 SIGINFO
: constant := 29; -- information request (BSD)
115 SIGUSR1
: constant := 30; -- user defined signal 1
116 SIGUSR2
: constant := 31; -- user defined signal 2
118 SIGADAABORT
: constant := SIGABRT
;
119 -- Change this if you want to use another signal for task abort.
120 -- SIGTERM might be a good one.
122 type Signal_Set
is array (Natural range <>) of Signal
;
124 -- Interrupts that must be unmasked at all times. DragonFlyBSD
125 -- pthreads will not allow an application to mask out any
126 -- interrupt needed by the threads library.
127 Unmasked
: constant Signal_Set
:=
128 (SIGTRAP
, SIGBUS
, SIGTTIN
, SIGTTOU
, SIGTSTP
);
130 -- DragonFlyBSD will uses SIGPROF for timing. Do not allow a
131 -- handler to attach to this signal.
132 Reserved
: constant Signal_Set
:= (0 .. 0 => SIGPROF
);
134 type sigset_t
is private;
137 (set
: access sigset_t
;
138 sig
: Signal
) return int
;
139 pragma Import
(C
, sigaddset
, "sigaddset");
142 (set
: access sigset_t
;
143 sig
: Signal
) return int
;
144 pragma Import
(C
, sigdelset
, "sigdelset");
146 function sigfillset
(set
: access sigset_t
) return int
;
147 pragma Import
(C
, sigfillset
, "sigfillset");
150 (set
: access sigset_t
;
151 sig
: Signal
) return int
;
152 pragma Import
(C
, sigismember
, "sigismember");
154 function sigemptyset
(set
: access sigset_t
) return int
;
155 pragma Import
(C
, sigemptyset
, "sigemptyset");
157 -- sigcontext is architecture dependent, so define it private
158 type struct_sigcontext
is private;
160 type old_struct_sigaction
is record
161 sa_handler
: System
.Address
;
165 pragma Convention
(C
, old_struct_sigaction
);
167 type new_struct_sigaction
is record
168 sa_handler
: System
.Address
;
172 pragma Convention
(C
, new_struct_sigaction
);
174 subtype struct_sigaction
is new_struct_sigaction
;
175 type struct_sigaction_ptr
is access all struct_sigaction
;
177 SIG_BLOCK
: constant := 1;
178 SIG_UNBLOCK
: constant := 2;
179 SIG_SETMASK
: constant := 3;
181 SIG_DFL
: constant := 0;
182 SIG_IGN
: constant := 1;
184 SA_SIGINFO
: constant := 16#
0040#
;
185 SA_ONSTACK
: constant := 16#
0001#
;
189 act
: struct_sigaction_ptr
;
190 oact
: struct_sigaction_ptr
) return int
;
191 pragma Import
(C
, sigaction
, "sigaction");
197 Time_Slice_Supported
: constant Boolean := True;
198 -- Indicates whether time slicing is supported (i.e SCHED_RR is supported)
200 type timespec
is private;
202 function nanosleep
(rqtp
, rmtp
: access timespec
) return int
;
203 pragma Import
(C
, nanosleep
, "nanosleep");
205 type clockid_t
is new unsigned_long
;
207 function clock_getres
208 (clock_id
: clockid_t
;
209 res
: access timespec
) return int
;
210 pragma Import
(C
, clock_getres
, "clock_getres");
212 function clock_gettime
213 (clock_id
: clockid_t
;
214 tp
: access timespec
)
216 pragma Import
(C
, clock_gettime
, "clock_gettime");
218 function To_Duration
(TS
: timespec
) return Duration;
219 pragma Inline
(To_Duration
);
221 function To_Timespec
(D
: Duration) return timespec
;
222 pragma Inline
(To_Timespec
);
224 type struct_timezone
is record
225 tz_minuteswest
: int
;
228 pragma Convention
(C
, struct_timezone
);
230 procedure usleep
(useconds
: unsigned_long
);
231 pragma Import
(C
, usleep
, "usleep");
233 -------------------------
234 -- Priority Scheduling --
235 -------------------------
237 SCHED_FIFO
: constant := 1;
238 SCHED_OTHER
: constant := 2;
239 SCHED_RR
: constant := 3;
241 function To_Target_Priority
242 (Prio
: System
.Any_Priority
) return Interfaces
.C
.int
;
243 -- Maps System.Any_Priority to a POSIX priority
249 type pid_t
is private;
251 function kill
(pid
: pid_t
; sig
: Signal
) return int
;
252 pragma Import
(C
, kill
, "kill");
254 function getpid
return pid_t
;
255 pragma Import
(C
, getpid
, "getpid");
261 function lwp_self
return System
.Address
;
262 -- lwp_self does not exist on this thread library, revert to pthread_self
263 -- which is the closest approximation (with getpid). This function is
264 -- needed to share 7staprop.adb across POSIX-like targets.
265 pragma Import
(C
, lwp_self
, "pthread_self");
271 type Thread_Body
is access
272 function (arg
: System
.Address
) return System
.Address
;
273 pragma Convention
(C
, Thread_Body
);
275 function Thread_Body_Access
is new
276 Ada
.Unchecked_Conversion
(System
.Address
, Thread_Body
);
278 type pthread_t
is private;
279 subtype Thread_Id
is pthread_t
;
281 type pthread_mutex_t
is limited private;
282 type pthread_cond_t
is limited private;
283 type pthread_attr_t
is limited private;
284 type pthread_mutexattr_t
is limited private;
285 type pthread_condattr_t
is limited private;
286 type pthread_key_t
is private;
288 PTHREAD_CREATE_DETACHED
: constant := 1;
289 PTHREAD_CREATE_JOINABLE
: constant := 0;
291 PTHREAD_SCOPE_PROCESS
: constant := 0;
292 PTHREAD_SCOPE_SYSTEM
: constant := 2;
294 -- Read/Write lock not supported on DragonFly. To add support both types
295 -- pthread_rwlock_t and pthread_rwlockattr_t must properly be defined
296 -- with the associated routines pthread_rwlock_[init/destroy] and
297 -- pthread_rwlock_[rdlock/wrlock/unlock].
299 subtype pthread_rwlock_t
is pthread_mutex_t
;
300 subtype pthread_rwlockattr_t
is pthread_mutexattr_t
;
306 type stack_t
is record
307 ss_sp
: System
.Address
;
311 pragma Convention
(C
, stack_t
);
314 (ss
: not null access stack_t
;
315 oss
: access stack_t
) return int
;
316 pragma Import
(C
, sigaltstack
, "sigaltstack");
318 Alternate_Stack
: aliased System
.Address
;
319 -- This is a dummy definition, never used (Alternate_Stack_Size is null)
321 Alternate_Stack_Size
: constant := 0;
322 -- No alternate signal stack is used on this platform
324 Stack_Base_Available
: constant Boolean := False;
325 -- Indicates whether the stack base is available on this target. This
326 -- allows us to share s-osinte.adb between all the FSU run time. Note that
327 -- this value can only be true if pthread_t has a complete definition that
328 -- corresponds exactly to the C header files.
330 function Get_Stack_Base
(thread
: pthread_t
) return Address
;
331 pragma Inline
(Get_Stack_Base
);
332 -- returns the stack base of the specified thread. Only call this function
333 -- when Stack_Base_Available is True.
335 function Get_Page_Size
return int
;
336 pragma Import
(C
, Get_Page_Size
, "getpagesize");
337 -- Returns the size of a page
339 PROT_NONE
: constant := 0;
340 PROT_READ
: constant := 1;
341 PROT_WRITE
: constant := 2;
342 PROT_EXEC
: constant := 4;
343 PROT_ALL
: constant := PROT_READ
+ PROT_WRITE
+ PROT_EXEC
;
344 PROT_ON
: constant := PROT_NONE
;
345 PROT_OFF
: constant := PROT_ALL
;
347 function mprotect
(addr
: Address
; len
: size_t
; prot
: int
) return int
;
348 pragma Import
(C
, mprotect
);
350 ---------------------------------------
351 -- Nonstandard Thread Initialization --
352 ---------------------------------------
354 -- FSU_THREADS requires pthread_init, which is nonstandard and this should
355 -- be invoked during the elaboration of s-taprop.adb.
357 -- DragonFlyBSD does not require this so we provide an empty Ada body
359 procedure pthread_init
;
361 -------------------------
362 -- POSIX.1c Section 3 --
363 -------------------------
366 (set
: access sigset_t
;
367 sig
: access Signal
) return int
;
368 pragma Import
(C
, sigwait
, "sigwait");
370 function pthread_kill
372 sig
: Signal
) return int
;
373 pragma Import
(C
, pthread_kill
, "pthread_kill");
375 function pthread_sigmask
377 set
: access sigset_t
;
378 oset
: access sigset_t
) return int
;
379 pragma Import
(C
, pthread_sigmask
, "pthread_sigmask");
381 --------------------------
382 -- POSIX.1c Section 11 --
383 --------------------------
385 function pthread_mutexattr_init
386 (attr
: access pthread_mutexattr_t
) return int
;
387 pragma Import
(C
, pthread_mutexattr_init
, "pthread_mutexattr_init");
389 function pthread_mutexattr_destroy
390 (attr
: access pthread_mutexattr_t
) return int
;
391 pragma Import
(C
, pthread_mutexattr_destroy
, "pthread_mutexattr_destroy");
393 function pthread_mutex_init
394 (mutex
: access pthread_mutex_t
;
395 attr
: access pthread_mutexattr_t
) return int
;
396 pragma Import
(C
, pthread_mutex_init
, "pthread_mutex_init");
398 function pthread_mutex_destroy
(mutex
: access pthread_mutex_t
) return int
;
399 pragma Import
(C
, pthread_mutex_destroy
, "pthread_mutex_destroy");
401 function pthread_mutex_lock
(mutex
: access pthread_mutex_t
) return int
;
402 pragma Import
(C
, pthread_mutex_lock
, "pthread_mutex_lock");
404 function pthread_mutex_unlock
(mutex
: access pthread_mutex_t
) return int
;
405 pragma Import
(C
, pthread_mutex_unlock
, "pthread_mutex_unlock");
407 function pthread_condattr_init
408 (attr
: access pthread_condattr_t
) return int
;
409 pragma Import
(C
, pthread_condattr_init
, "pthread_condattr_init");
411 function pthread_condattr_destroy
412 (attr
: access pthread_condattr_t
) return int
;
413 pragma Import
(C
, pthread_condattr_destroy
, "pthread_condattr_destroy");
415 function pthread_cond_init
416 (cond
: access pthread_cond_t
;
417 attr
: access pthread_condattr_t
) return int
;
418 pragma Import
(C
, pthread_cond_init
, "pthread_cond_init");
420 function pthread_cond_destroy
(cond
: access pthread_cond_t
) return int
;
421 pragma Import
(C
, pthread_cond_destroy
, "pthread_cond_destroy");
423 function pthread_cond_signal
(cond
: access pthread_cond_t
) return int
;
424 pragma Import
(C
, pthread_cond_signal
, "pthread_cond_signal");
426 function pthread_cond_wait
427 (cond
: access pthread_cond_t
;
428 mutex
: access pthread_mutex_t
) return int
;
429 pragma Import
(C
, pthread_cond_wait
, "pthread_cond_wait");
431 function pthread_cond_timedwait
432 (cond
: access pthread_cond_t
;
433 mutex
: access pthread_mutex_t
;
434 abstime
: access timespec
) return int
;
435 pragma Import
(C
, pthread_cond_timedwait
, "pthread_cond_timedwait");
437 Relative_Timed_Wait
: constant Boolean := False;
438 -- pthread_cond_timedwait requires an absolute delay time
440 --------------------------
441 -- POSIX.1c Section 13 --
442 --------------------------
444 PTHREAD_PRIO_NONE
: constant := 0;
445 PTHREAD_PRIO_PROTECT
: constant := 2;
446 PTHREAD_PRIO_INHERIT
: constant := 1;
448 function pthread_mutexattr_setprotocol
449 (attr
: access pthread_mutexattr_t
;
450 protocol
: int
) return int
;
452 (C
, pthread_mutexattr_setprotocol
, "pthread_mutexattr_setprotocol");
454 function pthread_mutexattr_getprotocol
455 (attr
: access pthread_mutexattr_t
;
456 protocol
: access int
) return int
;
458 (C
, pthread_mutexattr_getprotocol
, "pthread_mutexattr_getprotocol");
460 function pthread_mutexattr_setprioceiling
461 (attr
: access pthread_mutexattr_t
;
462 prioceiling
: int
) return int
;
464 (C
, pthread_mutexattr_setprioceiling
,
465 "pthread_mutexattr_setprioceiling");
467 function pthread_mutexattr_getprioceiling
468 (attr
: access pthread_mutexattr_t
;
469 prioceiling
: access int
) return int
;
471 (C
, pthread_mutexattr_getprioceiling
,
472 "pthread_mutexattr_getprioceiling");
474 type struct_sched_param
is record
475 sched_priority
: int
;
477 pragma Convention
(C
, struct_sched_param
);
479 function pthread_getschedparam
482 param
: access struct_sched_param
) return int
;
483 pragma Import
(C
, pthread_getschedparam
, "pthread_getschedparam");
485 function pthread_setschedparam
488 param
: access struct_sched_param
) return int
;
489 pragma Import
(C
, pthread_setschedparam
, "pthread_setschedparam");
491 function pthread_attr_setscope
492 (attr
: access pthread_attr_t
;
493 contentionscope
: int
) return int
;
494 pragma Import
(C
, pthread_attr_setscope
, "pthread_attr_setscope");
496 function pthread_attr_getscope
497 (attr
: access pthread_attr_t
;
498 contentionscope
: access int
) return int
;
499 pragma Import
(C
, pthread_attr_getscope
, "pthread_attr_getscope");
501 function pthread_attr_setinheritsched
502 (attr
: access pthread_attr_t
;
503 inheritsched
: int
) return int
;
505 (C
, pthread_attr_setinheritsched
, "pthread_attr_setinheritsched");
507 function pthread_attr_getinheritsched
508 (attr
: access pthread_attr_t
;
509 inheritsched
: access int
) return int
;
511 (C
, pthread_attr_getinheritsched
, "pthread_attr_getinheritsched");
513 function pthread_attr_setschedpolicy
514 (attr
: access pthread_attr_t
;
515 policy
: int
) return int
;
516 pragma Import
(C
, pthread_attr_setschedpolicy
,
517 "pthread_attr_setschedpolicy");
519 function pthread_attr_getschedpolicy
520 (attr
: access pthread_attr_t
;
521 policy
: access int
) return int
;
522 pragma Import
(C
, pthread_attr_getschedpolicy
,
523 "pthread_attr_getschedpolicy");
525 function pthread_attr_setschedparam
526 (attr
: access pthread_attr_t
;
527 sched_param
: int
) return int
;
528 pragma Import
(C
, pthread_attr_setschedparam
, "pthread_attr_setschedparam");
530 function pthread_attr_getschedparam
531 (attr
: access pthread_attr_t
;
532 sched_param
: access int
) return int
;
533 pragma Import
(C
, pthread_attr_getschedparam
, "pthread_attr_getschedparam");
535 function sched_yield
return int
;
536 pragma Import
(C
, sched_yield
, "pthread_yield");
538 --------------------------
539 -- P1003.1c Section 16 --
540 --------------------------
542 function pthread_attr_init
(attributes
: access pthread_attr_t
) return int
;
543 pragma Import
(C
, pthread_attr_init
, "pthread_attr_init");
545 function pthread_attr_destroy
546 (attributes
: access pthread_attr_t
) return int
;
547 pragma Import
(C
, pthread_attr_destroy
, "pthread_attr_destroy");
549 function pthread_attr_setdetachstate
550 (attr
: access pthread_attr_t
;
551 detachstate
: int
) return int
;
553 (C
, pthread_attr_setdetachstate
, "pthread_attr_setdetachstate");
555 function pthread_attr_getdetachstate
556 (attr
: access pthread_attr_t
;
557 detachstate
: access int
) return int
;
559 (C
, pthread_attr_getdetachstate
, "pthread_attr_getdetachstate");
561 function pthread_attr_getstacksize
562 (attr
: access pthread_attr_t
;
563 stacksize
: access size_t
) return int
;
565 (C
, pthread_attr_getstacksize
, "pthread_attr_getstacksize");
567 function pthread_attr_setstacksize
568 (attr
: access pthread_attr_t
;
569 stacksize
: size_t
) return int
;
571 (C
, pthread_attr_setstacksize
, "pthread_attr_setstacksize");
573 function pthread_create
574 (thread
: access pthread_t
;
575 attributes
: access pthread_attr_t
;
576 start_routine
: Thread_Body
;
577 arg
: System
.Address
) return int
;
578 pragma Import
(C
, pthread_create
, "pthread_create");
580 function pthread_detach
(thread
: pthread_t
) return int
;
581 pragma Import
(C
, pthread_detach
, "pthread_detach");
583 procedure pthread_exit
(status
: System
.Address
);
584 pragma Import
(C
, pthread_exit
, "pthread_exit");
586 function pthread_self
return pthread_t
;
587 pragma Import
(C
, pthread_self
, "pthread_self");
589 --------------------------
590 -- POSIX.1c Section 17 --
591 --------------------------
593 function pthread_setspecific
594 (key
: pthread_key_t
;
595 value
: System
.Address
) return int
;
596 pragma Import
(C
, pthread_setspecific
, "pthread_setspecific");
598 function pthread_getspecific
(key
: pthread_key_t
) return System
.Address
;
599 pragma Import
(C
, pthread_getspecific
, "pthread_getspecific");
601 type destructor_pointer
is access procedure (arg
: System
.Address
);
602 pragma Convention
(C
, destructor_pointer
);
604 function pthread_key_create
605 (key
: access pthread_key_t
;
606 destructor
: destructor_pointer
) return int
;
607 pragma Import
(C
, pthread_key_create
, "pthread_key_create");
609 ------------------------------------
610 -- Non-portable Pthread Functions --
611 ------------------------------------
613 function pthread_set_name_np
615 name
: System
.Address
) return int
;
616 pragma Import
(C
, pthread_set_name_np
, "pthread_set_name_np");
620 type sigset_t
is array (1 .. 4) of unsigned
;
622 -- In DragonFlyBSD the component sa_handler turns out to
623 -- be one a union type, and the selector is a macro:
624 -- #define sa_handler __sigaction_u._handler
625 -- #define sa_sigaction __sigaction_u._sigaction
627 -- Should we add a signal_context type here ???
628 -- How could it be done independent of the CPU architecture ???
629 -- sigcontext type is opaque, so it is architecturally neutral.
630 -- It is always passed as an access type, so define it as an empty record
631 -- since the contents are not used anywhere.
633 type struct_sigcontext
is null record;
634 pragma Convention
(C
, struct_sigcontext
);
636 type pid_t
is new int
;
638 type time_t
is range -2 ** (System
.Parameters
.time_t_bits
- 1)
639 .. 2 ** (System
.Parameters
.time_t_bits
- 1) - 1;
641 type timespec
is record
645 pragma Convention
(C
, timespec
);
647 type pthread_t
is new System
.Address
;
648 type pthread_attr_t
is new System
.Address
;
649 type pthread_mutex_t
is new System
.Address
;
650 type pthread_mutexattr_t
is new System
.Address
;
651 type pthread_cond_t
is new System
.Address
;
652 type pthread_condattr_t
is new System
.Address
;
653 type pthread_key_t
is new int
;
655 end System
.OS_Interface
;