Use move-aware auto_vec in map
[official-gcc.git] / gcc / ada / libgnarl / s-osinte__freebsd.ads
blobbda06b9c5feec3399776464950440bea9e1e202a
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS --
4 -- --
5 -- S Y S T E M . O S _ I N T E R F A C E --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1991-2017, Florida State University --
10 -- Copyright (C) 1995-2024, Free Software Foundation, Inc. --
11 -- --
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. --
18 -- --
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. --
22 -- --
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/>. --
27 -- --
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). --
31 -- --
32 ------------------------------------------------------------------------------
34 -- This is the FreeBSD (POSIX Threads) 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;
44 with Interfaces.C;
46 with System.OS_Locks;
47 with System.Parameters;
49 package System.OS_Interface is
50 pragma Preelaborate;
52 pragma Linker_Options ("-pthread");
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;
64 -----------
65 -- Errno --
66 -----------
68 function Errno return int;
69 pragma Inline (Errno);
71 EAGAIN : constant := 35;
72 EINTR : constant := 4;
73 EINVAL : constant := 22;
74 ENOMEM : constant := 12;
75 ETIMEDOUT : constant := 60;
77 -------------
78 -- Signals --
79 -------------
81 Max_Interrupt : constant := 31;
82 type Signal is new int range 0 .. Max_Interrupt;
83 for Signal'Size use int'Size;
85 SIGHUP : constant := 1; -- hangup
86 SIGINT : constant := 2; -- interrupt (rubout)
87 SIGQUIT : constant := 3; -- quit (ASCD FS)
88 SIGILL : constant := 4; -- illegal instruction (not reset)
89 SIGTRAP : constant := 5; -- trace trap (not reset)
90 SIGIOT : constant := 6; -- IOT instruction
91 SIGABRT : constant := 6; -- used by abort, replace SIGIOT in the future
92 SIGEMT : constant := 7; -- EMT instruction
93 SIGFPE : constant := 8; -- floating point exception
94 SIGKILL : constant := 9; -- kill (cannot be caught or ignored)
95 SIGBUS : constant := 10; -- bus error
96 SIGSEGV : constant := 11; -- segmentation violation
97 SIGSYS : constant := 12; -- bad argument to system call
98 SIGPIPE : constant := 13; -- write on a pipe with no one to read it
99 SIGALRM : constant := 14; -- alarm clock
100 SIGTERM : constant := 15; -- software termination signal from kill
101 SIGURG : constant := 16; -- urgent condition on IO channel
102 SIGSTOP : constant := 17; -- stop (cannot be caught or ignored)
103 SIGTSTP : constant := 18; -- user stop requested from tty
104 SIGCONT : constant := 19; -- stopped process has been continued
105 SIGCLD : constant := 20; -- alias for SIGCHLD
106 SIGCHLD : constant := 20; -- child status change
107 SIGTTIN : constant := 21; -- background tty read attempted
108 SIGTTOU : constant := 22; -- background tty write attempted
109 SIGIO : constant := 23; -- I/O possible (Solaris SIGPOLL alias)
110 SIGXCPU : constant := 24; -- CPU time limit exceeded
111 SIGXFSZ : constant := 25; -- filesize limit exceeded
112 SIGVTALRM : constant := 26; -- virtual timer expired
113 SIGPROF : constant := 27; -- profiling timer expired
114 SIGWINCH : constant := 28; -- window size change
115 SIGINFO : constant := 29; -- information request (NetBSD/FreeBSD)
116 SIGUSR1 : constant := 30; -- user defined signal 1
117 SIGUSR2 : constant := 31; -- user defined signal 2
119 SIGADAABORT : constant := SIGABRT;
120 -- Change this if you want to use another signal for task abort.
121 -- SIGTERM might be a good one.
123 type Signal_Set is array (Natural range <>) of Signal;
125 -- Interrupts that must be unmasked at all times. FreeBSD
126 -- pthreads will not allow an application to mask out any
127 -- interrupt needed by the threads library.
128 Unmasked : constant Signal_Set :=
129 (SIGTRAP, SIGBUS, SIGTTIN, SIGTTOU, SIGTSTP);
131 -- FreeBSD will uses SIGPROF for timing. Do not allow a
132 -- handler to attach to this signal.
133 Reserved : constant Signal_Set := (0 .. 0 => SIGPROF);
135 type sigset_t is private;
137 function sigaddset
138 (set : access sigset_t;
139 sig : Signal) return int;
140 pragma Import (C, sigaddset, "sigaddset");
142 function sigdelset
143 (set : access sigset_t;
144 sig : Signal) return int;
145 pragma Import (C, sigdelset, "sigdelset");
147 function sigfillset (set : access sigset_t) return int;
148 pragma Import (C, sigfillset, "sigfillset");
150 function sigismember
151 (set : access sigset_t;
152 sig : Signal) return int;
153 pragma Import (C, sigismember, "sigismember");
155 function sigemptyset (set : access sigset_t) return int;
156 pragma Import (C, sigemptyset, "sigemptyset");
158 -- sigcontext is architecture dependent, so define it private
159 type struct_sigcontext is private;
161 type old_struct_sigaction is record
162 sa_handler : System.Address;
163 sa_mask : sigset_t;
164 sa_flags : int;
165 end record;
166 pragma Convention (C, old_struct_sigaction);
168 type new_struct_sigaction is record
169 sa_handler : System.Address;
170 sa_flags : int;
171 sa_mask : sigset_t;
172 end record;
173 pragma Convention (C, new_struct_sigaction);
175 subtype struct_sigaction is new_struct_sigaction;
176 type struct_sigaction_ptr is access all struct_sigaction;
178 SIG_BLOCK : constant := 1;
179 SIG_UNBLOCK : constant := 2;
180 SIG_SETMASK : constant := 3;
182 SIG_DFL : constant := 0;
183 SIG_IGN : constant := 1;
185 SA_SIGINFO : constant := 16#0040#;
186 SA_ONSTACK : constant := 16#0001#;
188 function sigaction
189 (sig : Signal;
190 act : struct_sigaction_ptr;
191 oact : struct_sigaction_ptr) return int;
192 pragma Import (C, sigaction, "sigaction");
194 ----------
195 -- Time --
196 ----------
198 Time_Slice_Supported : constant Boolean := True;
199 -- Indicates whether time slicing is supported (i.e SCHED_RR is supported)
201 type timespec is private;
203 function nanosleep (rqtp, rmtp : access timespec) return int;
204 pragma Import (C, nanosleep, "nanosleep");
206 type clockid_t is new int;
208 function clock_getres
209 (clock_id : clockid_t;
210 res : access timespec) return int;
211 pragma Import (C, clock_getres, "clock_getres");
213 function clock_gettime
214 (clock_id : clockid_t;
215 tp : access timespec)
216 return int;
217 pragma Import (C, clock_gettime, "clock_gettime");
219 function To_Duration (TS : timespec) return Duration;
220 pragma Inline (To_Duration);
222 function To_Timespec (D : Duration) return timespec;
223 pragma Inline (To_Timespec);
225 type struct_timezone is record
226 tz_minuteswest : int;
227 tz_dsttime : int;
228 end record;
229 pragma Convention (C, struct_timezone);
231 procedure usleep (useconds : unsigned_long);
232 pragma Import (C, usleep, "usleep");
234 -------------------------
235 -- Priority Scheduling --
236 -------------------------
238 SCHED_FIFO : constant := 1;
239 SCHED_OTHER : constant := 2;
240 SCHED_RR : constant := 3;
242 function To_Target_Priority
243 (Prio : System.Any_Priority) return Interfaces.C.int;
244 -- Maps System.Any_Priority to a POSIX priority
246 -------------
247 -- Process --
248 -------------
250 type pid_t is private;
252 Self_PID : constant pid_t;
254 function kill (pid : pid_t; sig : Signal) return int;
255 pragma Import (C, kill, "kill");
257 function getpid return pid_t;
258 pragma Import (C, getpid, "getpid");
260 ---------
261 -- LWP --
262 ---------
264 function lwp_self return System.Address;
265 -- lwp_self does not exist on this thread library, revert to pthread_self
266 -- which is the closest approximation (with getpid). This function is
267 -- needed to share 7staprop.adb across POSIX-like targets.
268 pragma Import (C, lwp_self, "pthread_self");
270 -------------
271 -- Threads --
272 -------------
274 type Thread_Body is access
275 function (arg : System.Address) return System.Address;
276 pragma Convention (C, Thread_Body);
278 function Thread_Body_Access is new
279 Ada.Unchecked_Conversion (System.Address, Thread_Body);
281 type pthread_t is private;
282 subtype Thread_Id is pthread_t;
284 subtype pthread_mutex_t is System.OS_Locks.pthread_mutex_t;
285 type pthread_cond_t is limited private;
286 type pthread_attr_t is limited private;
287 type pthread_mutexattr_t is limited private;
288 type pthread_condattr_t is limited private;
289 type pthread_key_t is private;
291 PTHREAD_CREATE_DETACHED : constant := 1;
292 PTHREAD_CREATE_JOINABLE : constant := 0;
294 PTHREAD_SCOPE_PROCESS : constant := 0;
295 PTHREAD_SCOPE_SYSTEM : constant := 2;
297 -- Read/Write lock not supported on freebsd. To add support both types
298 -- pthread_rwlock_t and pthread_rwlockattr_t must properly be defined
299 -- with the associated routines pthread_rwlock_[init/destroy] and
300 -- pthread_rwlock_[rdlock/wrlock/unlock].
302 subtype pthread_rwlock_t is pthread_mutex_t;
303 subtype pthread_rwlockattr_t is pthread_mutexattr_t;
305 -----------
306 -- Stack --
307 -----------
309 type stack_t is record
310 ss_sp : System.Address;
311 ss_size : size_t;
312 ss_flags : int;
313 end record;
314 pragma Convention (C, stack_t);
316 function sigaltstack
317 (ss : not null access stack_t;
318 oss : access stack_t) return int;
319 pragma Import (C, sigaltstack, "sigaltstack");
321 Alternate_Stack : aliased System.Address;
322 -- This is a dummy definition, never used (Alternate_Stack_Size is null)
324 Alternate_Stack_Size : constant := 0;
325 -- No alternate signal stack is used on this platform
327 Stack_Base_Available : constant Boolean := False;
328 -- Indicates whether the stack base is available on this target
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 -- FreeBSD does not require this so we provide an empty Ada body
359 procedure pthread_init;
361 -------------------------
362 -- POSIX.1c Section 3 --
363 -------------------------
365 function sigwait
366 (set : access sigset_t;
367 sig : access Signal) return int;
368 pragma Import (C, sigwait, "sigwait");
370 function pthread_kill
371 (thread : pthread_t;
372 sig : Signal) return int;
373 pragma Import (C, pthread_kill, "pthread_kill");
375 function pthread_sigmask
376 (how : int;
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 --------------------------
438 -- POSIX.1c Section 13 --
439 --------------------------
441 PTHREAD_PRIO_NONE : constant := 0;
442 PTHREAD_PRIO_PROTECT : constant := 2;
443 PTHREAD_PRIO_INHERIT : constant := 1;
445 function pthread_mutexattr_setprotocol
446 (attr : access pthread_mutexattr_t;
447 protocol : int) return int;
448 pragma Import
449 (C, pthread_mutexattr_setprotocol, "pthread_mutexattr_setprotocol");
451 function pthread_mutexattr_getprotocol
452 (attr : access pthread_mutexattr_t;
453 protocol : access int) return int;
454 pragma Import
455 (C, pthread_mutexattr_getprotocol, "pthread_mutexattr_getprotocol");
457 function pthread_mutexattr_setprioceiling
458 (attr : access pthread_mutexattr_t;
459 prioceiling : int) return int;
460 pragma Import
461 (C, pthread_mutexattr_setprioceiling,
462 "pthread_mutexattr_setprioceiling");
464 function pthread_mutexattr_getprioceiling
465 (attr : access pthread_mutexattr_t;
466 prioceiling : access int) return int;
467 pragma Import
468 (C, pthread_mutexattr_getprioceiling,
469 "pthread_mutexattr_getprioceiling");
471 type struct_sched_param is record
472 sched_priority : int;
473 end record;
474 pragma Convention (C, struct_sched_param);
476 function pthread_getschedparam
477 (thread : pthread_t;
478 policy : access int;
479 param : access struct_sched_param) return int;
480 pragma Import (C, pthread_getschedparam, "pthread_getschedparam");
482 function pthread_setschedparam
483 (thread : pthread_t;
484 policy : int;
485 param : access struct_sched_param) return int;
486 pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
488 function pthread_attr_setscope
489 (attr : access pthread_attr_t;
490 contentionscope : int) return int;
491 pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
493 function pthread_attr_getscope
494 (attr : access pthread_attr_t;
495 contentionscope : access int) return int;
496 pragma Import (C, pthread_attr_getscope, "pthread_attr_getscope");
498 function pthread_attr_setinheritsched
499 (attr : access pthread_attr_t;
500 inheritsched : int) return int;
501 pragma Import
502 (C, pthread_attr_setinheritsched, "pthread_attr_setinheritsched");
504 function pthread_attr_getinheritsched
505 (attr : access pthread_attr_t;
506 inheritsched : access int) return int;
507 pragma Import
508 (C, pthread_attr_getinheritsched, "pthread_attr_getinheritsched");
510 function pthread_attr_setschedpolicy
511 (attr : access pthread_attr_t;
512 policy : int) return int;
513 pragma Import (C, pthread_attr_setschedpolicy,
514 "pthread_attr_setschedpolicy");
516 function pthread_attr_getschedpolicy
517 (attr : access pthread_attr_t;
518 policy : access int) return int;
519 pragma Import (C, pthread_attr_getschedpolicy,
520 "pthread_attr_getschedpolicy");
522 function pthread_attr_setschedparam
523 (attr : access pthread_attr_t;
524 sched_param : int) return int;
525 pragma Import (C, pthread_attr_setschedparam, "pthread_attr_setschedparam");
527 function pthread_attr_getschedparam
528 (attr : access pthread_attr_t;
529 sched_param : access int) return int;
530 pragma Import (C, pthread_attr_getschedparam, "pthread_attr_getschedparam");
532 function sched_yield return int;
533 pragma Import (C, sched_yield, "pthread_yield");
535 --------------------------
536 -- P1003.1c Section 16 --
537 --------------------------
539 function pthread_attr_init (attributes : access pthread_attr_t) return int;
540 pragma Import (C, pthread_attr_init, "pthread_attr_init");
542 function pthread_attr_destroy
543 (attributes : access pthread_attr_t) return int;
544 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
546 function pthread_attr_setdetachstate
547 (attr : access pthread_attr_t;
548 detachstate : int) return int;
549 pragma Import
550 (C, pthread_attr_setdetachstate, "pthread_attr_setdetachstate");
552 function pthread_attr_getdetachstate
553 (attr : access pthread_attr_t;
554 detachstate : access int) return int;
555 pragma Import
556 (C, pthread_attr_getdetachstate, "pthread_attr_getdetachstate");
558 function pthread_attr_getstacksize
559 (attr : access pthread_attr_t;
560 stacksize : access size_t) return int;
561 pragma Import
562 (C, pthread_attr_getstacksize, "pthread_attr_getstacksize");
564 function pthread_attr_setstacksize
565 (attr : access pthread_attr_t;
566 stacksize : size_t) return int;
567 pragma Import
568 (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
570 function pthread_create
571 (thread : access pthread_t;
572 attributes : access pthread_attr_t;
573 start_routine : Thread_Body;
574 arg : System.Address) return int;
575 pragma Import (C, pthread_create, "pthread_create");
577 function pthread_detach (thread : pthread_t) return int;
578 pragma Import (C, pthread_detach, "pthread_detach");
580 procedure pthread_exit (status : System.Address);
581 pragma Import (C, pthread_exit, "pthread_exit");
583 function pthread_self return pthread_t;
584 pragma Import (C, pthread_self, "pthread_self");
586 --------------------------
587 -- POSIX.1c Section 17 --
588 --------------------------
590 function pthread_setspecific
591 (key : pthread_key_t;
592 value : System.Address) return int;
593 pragma Import (C, pthread_setspecific, "pthread_setspecific");
595 function pthread_getspecific (key : pthread_key_t) return System.Address;
596 pragma Import (C, pthread_getspecific, "pthread_getspecific");
598 type destructor_pointer is access procedure (arg : System.Address);
599 pragma Convention (C, destructor_pointer);
601 function pthread_key_create
602 (key : access pthread_key_t;
603 destructor : destructor_pointer) return int;
604 pragma Import (C, pthread_key_create, "pthread_key_create");
606 ------------------------------------
607 -- Non-portable Pthread Functions --
608 ------------------------------------
610 function pthread_set_name_np
611 (thread : pthread_t;
612 name : System.Address) return int;
613 pragma Import (C, pthread_set_name_np, "pthread_set_name_np");
615 private
617 type sigset_t is array (1 .. 4) of unsigned;
619 -- In FreeBSD the component sa_handler turns out to
620 -- be one a union type, and the selector is a macro:
621 -- #define sa_handler __sigaction_u._handler
622 -- #define sa_sigaction __sigaction_u._sigaction
624 -- Should we add a signal_context type here ???
625 -- How could it be done independent of the CPU architecture ???
626 -- sigcontext type is opaque, so it is architecturally neutral.
627 -- It is always passed as an access type, so define it as an empty record
628 -- since the contents are not used anywhere.
630 type struct_sigcontext is null record;
631 pragma Convention (C, struct_sigcontext);
633 type pid_t is new int;
634 Self_PID : constant pid_t := 0;
636 type time_t is range -2 ** (System.Parameters.time_t_bits - 1)
637 .. 2 ** (System.Parameters.time_t_bits - 1) - 1;
639 type timespec is record
640 ts_sec : time_t;
641 ts_nsec : long;
642 end record;
643 pragma Convention (C, timespec);
645 type pthread_t is new System.Address;
646 type pthread_attr_t is new System.Address;
647 type pthread_mutexattr_t is new System.Address;
648 type pthread_cond_t is new System.Address;
649 type pthread_condattr_t is new System.Address;
650 type pthread_key_t is new int;
652 end System.OS_Interface;