File : s-osinte-hpux.ads
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-1994, Florida State University --
10 -- Copyright (C) 1995-2015, 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 -- --
20 -- --
21 -- --
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. --
29 -- Extensive contributions were provided by Ada Core Technologies, Inc. --
30 -- --
31 ------------------------------------------------------------------------------
32
33 -- This is a HPUX 11.0 (Native THREADS) version of this package
34
35 -- This package encapsulates all direct interfaces to OS services that are
36 -- needed by the tasking run-time (libgnarl).
37
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.
40
41 with Ada.Unchecked_Conversion;
42
43 with Interfaces.C;
44
45 package System.OS_Interface is
46 pragma Preelaborate;
47
48 pragma Linker_Options ("-lpthread");
49
50 subtype int is Interfaces.C.int;
51 subtype short is Interfaces.C.short;
52 subtype long is Interfaces.C.long;
53 subtype unsigned is Interfaces.C.unsigned;
54 subtype unsigned_short is Interfaces.C.unsigned_short;
55 subtype unsigned_long is Interfaces.C.unsigned_long;
56 subtype unsigned_char is Interfaces.C.unsigned_char;
57 subtype plain_char is Interfaces.C.plain_char;
58 subtype size_t is Interfaces.C.size_t;
59
60 -----------
61 -- Errno --
62 -----------
63
64 function errno return int;
65 pragma Import (C, errno, "__get_errno");
66
67 EAGAIN : constant := 11;
68 EINTR : constant := 4;
69 EINVAL : constant := 22;
70 ENOMEM : constant := 12;
71 ETIMEDOUT : constant := 238;
72
73 -------------
74 -- Signals --
75 -------------
76
77 Max_Interrupt : constant := 44;
78 type Signal is new int range 0 .. Max_Interrupt;
79 for Signal'Size use int'Size;
80
81 SIGHUP : constant := 1; -- hangup
82 SIGINT : constant := 2; -- interrupt (rubout)
83 SIGQUIT : constant := 3; -- quit (ASCD FS)
84 SIGILL : constant := 4; -- illegal instruction (not reset)
85 SIGTRAP : constant := 5; -- trace trap (not reset)
86 SIGIOT : constant := 6; -- IOT instruction
87 SIGABRT : constant := 6; -- used by abort, replace SIGIOT in the future
88 SIGEMT : constant := 7; -- EMT instruction
89 SIGFPE : constant := 8; -- floating point exception
90 SIGKILL : constant := 9; -- kill (cannot be caught or ignored)
91 SIGBUS : constant := 10; -- bus error
92 SIGSEGV : constant := 11; -- segmentation violation
93 SIGSYS : constant := 12; -- bad argument to system call
94 SIGPIPE : constant := 13; -- write on a pipe with no one to read it
95 SIGALRM : constant := 14; -- alarm clock
96 SIGTERM : constant := 15; -- software termination signal from kill
97 SIGUSR1 : constant := 16; -- user defined signal 1
98 SIGUSR2 : constant := 17; -- user defined signal 2
99 SIGCLD : constant := 18; -- alias for SIGCHLD
100 SIGCHLD : constant := 18; -- child status change
101 SIGPWR : constant := 19; -- power-fail restart
102 SIGVTALRM : constant := 20; -- virtual timer alarm
103 SIGPROF : constant := 21; -- profiling timer alarm
104 SIGIO : constant := 22; -- asynchronous I/O
105 SIGPOLL : constant := 22; -- pollable event occurred
106 SIGWINCH : constant := 23; -- window size change
107 SIGSTOP : constant := 24; -- stop (cannot be caught or ignored)
108 SIGTSTP : constant := 25; -- user stop requested from tty
109 SIGCONT : constant := 26; -- stopped process has been continued
110 SIGTTIN : constant := 27; -- background tty read attempted
111 SIGTTOU : constant := 28; -- background tty write attempted
112 SIGURG : constant := 29; -- urgent condition on IO channel
113 SIGLOST : constant := 30; -- remote lock lost (NFS)
114 SIGDIL : constant := 32; -- DIL signal
115 SIGXCPU : constant := 33; -- CPU time limit exceeded (setrlimit)
116 SIGXFSZ : constant := 34; -- file size limit exceeded (setrlimit)
117 SIGCANCEL : constant := 35; -- used for pthread cancellation.
118 SIGGFAULT : constant := 36; -- Graphics framebuffer fault
119
120 SIGADAABORT : constant := SIGABRT;
121 -- Note: on other targets, we usually use SIGABRT, but on HPUX, it
122 -- appears that SIGABRT can't be used in sigwait(), so we use SIGTERM.
123 -- Do we use SIGTERM or SIGABRT???
124
125 type Signal_Set is array (Natural range <>) of Signal;
126
127 Unmasked : constant Signal_Set :=
128 (SIGABRT, SIGPIPE, SIGBUS, SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF,
129 SIGALRM, SIGVTALRM, SIGIO, SIGCHLD);
130
131 Reserved : constant Signal_Set := (SIGKILL, SIGSTOP);
132
133 type sigset_t is private;
134
135 function sigaddset (set : access sigset_t; sig : Signal) return int;
136 pragma Import (C, sigaddset, "sigaddset");
137
138 function sigdelset (set : access sigset_t; sig : Signal) return int;
139 pragma Import (C, sigdelset, "sigdelset");
140
141 function sigfillset (set : access sigset_t) return int;
142 pragma Import (C, sigfillset, "sigfillset");
143
144 function sigismember (set : access sigset_t; sig : Signal) return int;
145 pragma Import (C, sigismember, "sigismember");
146
147 function sigemptyset (set : access sigset_t) return int;
148 pragma Import (C, sigemptyset, "sigemptyset");
149
150 type struct_sigaction is record
151 sa_handler : System.Address;
152 sa_mask : sigset_t;
153 sa_flags : int;
154 end record;
155 pragma Convention (C, struct_sigaction);
156 type struct_sigaction_ptr is access all struct_sigaction;
157
158 SA_SIGINFO : constant := 16#10#;
159 SA_ONSTACK : constant := 16#01#;
160
161 SIG_BLOCK : constant := 0;
162 SIG_UNBLOCK : constant := 1;
163 SIG_SETMASK : constant := 2;
164
165 SIG_DFL : constant := 0;
166 SIG_IGN : constant := 1;
167
168 function sigaction
169 (sig : Signal;
170 act : struct_sigaction_ptr;
171 oact : struct_sigaction_ptr) return int;
172 pragma Import (C, sigaction, "sigaction");
173
174 ----------
175 -- Time --
176 ----------
177
178 Time_Slice_Supported : constant Boolean := True;
179 -- Indicates whether time slicing is supported
180
181 type timespec is private;
182
183 type clockid_t is new int;
184
185 function clock_gettime
186 (clock_id : clockid_t;
187 tp : access timespec) return int;
188 pragma Import (C, clock_gettime, "clock_gettime");
189
190 function clock_getres
191 (clock_id : clockid_t;
192 res : access timespec) return int;
193 pragma Import (C, clock_getres, "clock_getres");
194
195 function To_Duration (TS : timespec) return Duration;
196 pragma Inline (To_Duration);
197
198 function To_Timespec (D : Duration) return timespec;
199 pragma Inline (To_Timespec);
200
201 type struct_timezone is record
202 tz_minuteswest : int;
203 tz_dsttime : int;
204 end record;
205 pragma Convention (C, struct_timezone);
206 type struct_timezone_ptr is access all struct_timezone;
207
208 -------------------------
209 -- Priority Scheduling --
210 -------------------------
211
212 SCHED_FIFO : constant := 0;
213 SCHED_RR : constant := 1;
214 SCHED_OTHER : constant := 2;
215
216 function To_Target_Priority
217 (Prio : System.Any_Priority) return Interfaces.C.int;
218 -- Maps System.Any_Priority to a POSIX priority
219
220 -------------
221 -- Process --
222 -------------
223
224 type pid_t is private;
225
226 function kill (pid : pid_t; sig : Signal) return int;
227 pragma Import (C, kill, "kill");
228
229 function getpid return pid_t;
230 pragma Import (C, getpid, "getpid");
231
232 ---------
233 -- LWP --
234 ---------
235
236 function lwp_self return System.Address;
237 pragma Import (C, lwp_self, "_lwp_self");
238
239 -------------
240 -- Threads --
241 -------------
242
243 type Thread_Body is access
244 function (arg : System.Address) return System.Address;
245 pragma Convention (C, Thread_Body);
246
247 function Thread_Body_Access is new
248 Ada.Unchecked_Conversion (System.Address, Thread_Body);
249
250 type pthread_t is private;
251 subtype Thread_Id is pthread_t;
252
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;
259
260 PTHREAD_CREATE_DETACHED : constant := 16#de#;
261
262 PTHREAD_SCOPE_PROCESS : constant := 2;
263 PTHREAD_SCOPE_SYSTEM : constant := 1;
264
265 -- Read/Write lock not supported on HPUX. To add support both types
266 -- pthread_rwlock_t and pthread_rwlockattr_t must properly be defined
267 -- with the associated routines pthread_rwlock_[init/destroy] and
268 -- pthread_rwlock_[rdlock/wrlock/unlock].
269
270 subtype pthread_rwlock_t is pthread_mutex_t;
271 subtype pthread_rwlockattr_t is pthread_mutexattr_t;
272
273 -----------
274 -- Stack --
275 -----------
276
277 type stack_t is record
278 ss_sp : System.Address;
279 ss_flags : int;
280 ss_size : size_t;
281 end record;
282 pragma Convention (C, stack_t);
283
284 function sigaltstack
285 (ss : not null access stack_t;
286 oss : access stack_t) return int;
287 pragma Import (C, sigaltstack, "sigaltstack");
288
289 Alternate_Stack : aliased System.Address;
290 pragma Import (C, Alternate_Stack, "__gnat_alternate_stack");
291 -- The alternate signal stack for stack overflows
292
293 Alternate_Stack_Size : constant := 128 * 1024;
294 -- This must be in keeping with init.c:__gnat_alternate_stack
295
296 Stack_Base_Available : constant Boolean := False;
297 -- Indicates whether the stack base is available on this target
298
299 function Get_Stack_Base (thread : pthread_t) return Address;
300 pragma Inline (Get_Stack_Base);
301 -- Returns the stack base of the specified thread. Only call this function
302 -- when Stack_Base_Available is True.
303
304 function Get_Page_Size return int;
305 pragma Import (C, Get_Page_Size, "getpagesize");
306 -- Returns the size of a page
307
308 PROT_NONE : constant := 0;
309 PROT_READ : constant := 1;
310 PROT_WRITE : constant := 2;
311 PROT_EXEC : constant := 4;
312 PROT_ALL : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
313 PROT_ON : constant := PROT_READ;
314 PROT_OFF : constant := PROT_ALL;
315
316 function mprotect (addr : Address; len : size_t; prot : int) return int;
317 pragma Import (C, mprotect);
318
319 ---------------------------------------
320 -- Nonstandard Thread Initialization --
321 ---------------------------------------
322
323 procedure pthread_init;
324 pragma Inline (pthread_init);
325 -- This is a dummy procedure to share some GNULLI files
326
327 -------------------------
328 -- POSIX.1c Section 3 --
329 -------------------------
330
331 function sigwait
332 (set : access sigset_t;
333 sig : access Signal) return int;
334 pragma Import (C, sigwait, "sigwait");
335
336 function pthread_kill
337 (thread : pthread_t;
338 sig : Signal) return int;
339 pragma Import (C, pthread_kill, "pthread_kill");
340
341 function pthread_sigmask
342 (how : int;
343 set : access sigset_t;
344 oset : access sigset_t) return int;
345 pragma Import (C, pthread_sigmask, "pthread_sigmask");
346
347 --------------------------
348 -- POSIX.1c Section 11 --
349 --------------------------
350
351 function pthread_mutexattr_init
352 (attr : access pthread_mutexattr_t) return int;
353 pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
354
355 function pthread_mutexattr_destroy
356 (attr : access pthread_mutexattr_t) return int;
357 pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
358
359 function pthread_mutex_init
360 (mutex : access pthread_mutex_t;
361 attr : access pthread_mutexattr_t) return int;
362 pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
363
364 function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
365 pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
366
367 function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
368 pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
369
370 function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
371 pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
372
373 function pthread_condattr_init
374 (attr : access pthread_condattr_t) return int;
375 pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
376
377 function pthread_condattr_destroy
378 (attr : access pthread_condattr_t) return int;
379 pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
380
381 function pthread_cond_init
382 (cond : access pthread_cond_t;
383 attr : access pthread_condattr_t) return int;
384 pragma Import (C, pthread_cond_init, "pthread_cond_init");
385
386 function pthread_cond_destroy (cond : access pthread_cond_t) return int;
387 pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
388
389 function pthread_cond_signal (cond : access pthread_cond_t) return int;
390 pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
391
392 function pthread_cond_wait
393 (cond : access pthread_cond_t;
394 mutex : access pthread_mutex_t) return int;
395 pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
396
397 function pthread_cond_timedwait
398 (cond : access pthread_cond_t;
399 mutex : access pthread_mutex_t;
400 abstime : access timespec) return int;
401 pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
402
403 Relative_Timed_Wait : constant Boolean := False;
404 -- pthread_cond_timedwait requires an absolute delay time
405
406 --------------------------
407 -- POSIX.1c Section 13 --
408 --------------------------
409
410 PTHREAD_PRIO_NONE : constant := 16#100#;
411 PTHREAD_PRIO_PROTECT : constant := 16#200#;
412 PTHREAD_PRIO_INHERIT : constant := 16#400#;
413
414 function pthread_mutexattr_setprotocol
415 (attr : access pthread_mutexattr_t;
416 protocol : int) return int;
417 pragma Import (C, pthread_mutexattr_setprotocol);
418
419 function pthread_mutexattr_setprioceiling
420 (attr : access pthread_mutexattr_t;
421 prioceiling : int) return int;
422 pragma Import (C, pthread_mutexattr_setprioceiling);
423
424 type Array_7_Int is array (0 .. 6) of int;
425 type struct_sched_param is record
426 sched_priority : int;
427 sched_reserved : Array_7_Int;
428 end record;
429
430 function pthread_setschedparam
431 (thread : pthread_t;
432 policy : int;
433 param : access struct_sched_param)
434 return int;
435 pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
436
437 function pthread_attr_setscope
438 (attr : access pthread_attr_t;
439 contentionscope : int) return int;
440 pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
441
442 function pthread_attr_setinheritsched
443 (attr : access pthread_attr_t;
444 inheritsched : int) return int;
445 pragma Import (C, pthread_attr_setinheritsched);
446
447 function pthread_attr_setschedpolicy
448 (attr : access pthread_attr_t;
449 policy : int) return int;
450 pragma Import (C, pthread_attr_setschedpolicy);
451
452 function sched_yield return int;
453 pragma Import (C, sched_yield, "sched_yield");
454
455 --------------------------
456 -- P1003.1c Section 16 --
457 --------------------------
458
459 function pthread_attr_init
460 (attributes : access pthread_attr_t) return int;
461 pragma Import (C, pthread_attr_init, "__pthread_attr_init_system");
462
463 function pthread_attr_destroy
464 (attributes : access pthread_attr_t) return int;
465 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
466
467 function pthread_attr_setdetachstate
468 (attr : access pthread_attr_t;
469 detachstate : int) return int;
470 pragma Import (C, pthread_attr_setdetachstate);
471
472 function pthread_attr_setstacksize
473 (attr : access pthread_attr_t;
474 stacksize : size_t) return int;
475 pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
476
477 function pthread_create
478 (thread : access pthread_t;
479 attributes : access pthread_attr_t;
480 start_routine : Thread_Body;
481 arg : System.Address) return int;
482 pragma Import (C, pthread_create, "__pthread_create_system");
483
484 procedure pthread_exit (status : System.Address);
485 pragma Import (C, pthread_exit, "pthread_exit");
486
487 function pthread_self return pthread_t;
488 pragma Import (C, pthread_self, "pthread_self");
489
490 --------------------------
491 -- POSIX.1c Section 17 --
492 --------------------------
493
494 function pthread_setspecific
495 (key : pthread_key_t;
496 value : System.Address) return int;
497 pragma Import (C, pthread_setspecific, "pthread_setspecific");
498
499 function pthread_getspecific (key : pthread_key_t) return System.Address;
500 pragma Import (C, pthread_getspecific, "pthread_getspecific");
501
502 type destructor_pointer is access procedure (arg : System.Address);
503 pragma Convention (C, destructor_pointer);
504
505 function pthread_key_create
506 (key : access pthread_key_t;
507 destructor : destructor_pointer) return int;
508 pragma Import (C, pthread_key_create, "pthread_key_create");
509
510 private
511
512 type unsigned_int_array_8 is array (0 .. 7) of unsigned;
513 type sigset_t is record
514 sigset : unsigned_int_array_8;
515 end record;
516 pragma Convention (C_Pass_By_Copy, sigset_t);
517
518 type pid_t is new int;
519
520 type time_t is new long;
521
522 type timespec is record
523 tv_sec : time_t;
524 tv_nsec : long;
525 end record;
526 pragma Convention (C, timespec);
527
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;
532
533 type short_array is array (Natural range <>) of short;
534 type int_array is array (Natural range <>) of int;
535
536 type pthread_mutex_t is record
537 m_short : short_array (0 .. 1);
538 m_int : int;
539 m_int1 : int_array (0 .. 3);
540 m_pad : int;
541
542 m_ptr : int;
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.
546
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);
552 end record;
553 for pthread_mutex_t'Alignment use System.Address'Alignment;
554 pragma Convention (C, pthread_mutex_t);
555
556 type pthread_cond_t is record
557 c_short : short_array (0 .. 1);
558 c_int : int;
559 c_int1 : int_array (0 .. 3);
560 m_pad : int;
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);
565 end record;
566 for pthread_cond_t'Alignment use System.Address'Alignment;
567 pragma Convention (C, pthread_cond_t);
568
569 type pthread_key_t is new int;
570
571 end System.OS_Interface;