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-- 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.       --
29-- Extensive contributions were provided by Ada Core Technologies, Inc.     --
30--                                                                          --
31------------------------------------------------------------------------------
32
33--  This is a Solaris (POSIX Threads) version of this package
34
35--  This package encapsulates all direct interfaces to OS services
36--  that are 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
41with Interfaces.C;
42
43with Ada.Unchecked_Conversion;
44
45package System.OS_Interface is
46   pragma Preelaborate;
47
48   pragma Linker_Options ("-lposix4");
49   pragma Linker_Options ("-lpthread");
50
51   --  The following is needed to allow --enable-threads=solaris
52
53   pragma Linker_Options ("-lthread");
54
55   subtype int            is Interfaces.C.int;
56   subtype short          is Interfaces.C.short;
57   subtype long           is Interfaces.C.long;
58   subtype unsigned       is Interfaces.C.unsigned;
59   subtype unsigned_short is Interfaces.C.unsigned_short;
60   subtype unsigned_long  is Interfaces.C.unsigned_long;
61   subtype unsigned_char  is Interfaces.C.unsigned_char;
62   subtype plain_char     is Interfaces.C.plain_char;
63   subtype size_t         is Interfaces.C.size_t;
64
65   -----------
66   -- Errno --
67   -----------
68
69   function errno return int;
70   pragma Import (C, errno, "__get_errno");
71
72   EAGAIN    : constant := 11;
73   EINTR     : constant := 4;
74   EINVAL    : constant := 22;
75   ENOMEM    : constant := 12;
76   ETIMEDOUT : constant := 145;
77
78   -------------
79   -- Signals --
80   -------------
81
82   Max_Interrupt : constant := 45;
83   type Signal is new int range 0 .. Max_Interrupt;
84   for Signal'Size use int'Size;
85
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   SIGIOT      : constant := 6; --  IOT instruction
92   SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
93   SIGEMT      : constant := 7; --  EMT instruction
94   SIGFPE      : constant := 8; --  floating point exception
95   SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
96   SIGBUS      : constant := 10; --  bus error
97   SIGSEGV     : constant := 11; --  segmentation violation
98   SIGSYS      : constant := 12; --  bad argument to system call
99   SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
100   SIGALRM     : constant := 14; --  alarm clock
101   SIGTERM     : constant := 15; --  software termination signal from kill
102   SIGUSR1     : constant := 16; --  user defined signal 1
103   SIGUSR2     : constant := 17; --  user defined signal 2
104   SIGCLD      : constant := 18; --  alias for SIGCHLD
105   SIGCHLD     : constant := 18; --  child status change
106   SIGPWR      : constant := 19; --  power-fail restart
107   SIGWINCH    : constant := 20; --  window size change
108   SIGURG      : constant := 21; --  urgent condition on IO channel
109   SIGPOLL     : constant := 22; --  pollable event occurred
110   SIGIO       : constant := 22; --  I/O possible (Solaris SIGPOLL alias)
111   SIGSTOP     : constant := 23; --  stop (cannot be caught or ignored)
112   SIGTSTP     : constant := 24; --  user stop requested from tty
113   SIGCONT     : constant := 25; --  stopped process has been continued
114   SIGTTIN     : constant := 26; --  background tty read attempted
115   SIGTTOU     : constant := 27; --  background tty write attempted
116   SIGVTALRM   : constant := 28; --  virtual timer expired
117   SIGPROF     : constant := 29; --  profiling timer expired
118   SIGXCPU     : constant := 30; --  CPU time limit exceeded
119   SIGXFSZ     : constant := 31; --  filesize limit exceeded
120   SIGWAITING  : constant := 32; --  process's lwps blocked (Solaris)
121   SIGLWP      : constant := 33; --  used by thread library (Solaris)
122   SIGFREEZE   : constant := 34; --  used by CPR (Solaris)
123   SIGTHAW     : constant := 35; --  used by CPR (Solaris)
124   SIGCANCEL   : constant := 36; --  thread cancellation signal (libthread)
125
126   SIGADAABORT : constant := SIGABRT;
127
128   type Signal_Set is array (Natural range <>) of Signal;
129
130   Unmasked    : constant Signal_Set := (SIGTRAP, SIGLWP, SIGPROF);
131
132   --  Following signals should not be disturbed.
133   --  See c-posix-signals.c in FLORIST
134
135   Reserved    : constant Signal_Set :=
136     (SIGKILL, SIGSTOP, SIGWAITING, SIGCANCEL);
137
138   type sigset_t is private;
139
140   function sigaddset (set : access sigset_t; sig : Signal) return int;
141   pragma Import (C, sigaddset, "sigaddset");
142
143   function sigdelset (set : access sigset_t; sig : Signal) return int;
144   pragma Import (C, sigdelset, "sigdelset");
145
146   function sigfillset (set : access sigset_t) return int;
147   pragma Import (C, sigfillset, "sigfillset");
148
149   function sigismember (set : access sigset_t; sig : Signal) return int;
150   pragma Import (C, sigismember, "sigismember");
151
152   function sigemptyset (set : access sigset_t) return int;
153   pragma Import (C, sigemptyset, "sigemptyset");
154
155   type struct_sigaction is record
156      sa_flags   : int;
157      sa_handler : System.Address;
158      sa_mask    : sigset_t;
159      sa_resv1   : int;
160      sa_resv2   : int;
161   end record;
162   pragma Convention (C, struct_sigaction);
163   type struct_sigaction_ptr is access all struct_sigaction;
164
165   SA_SIGINFO : constant := 16#0008#;
166   SA_ONSTACK : constant := 16#0001#;
167
168   SIG_BLOCK   : constant := 1;
169   SIG_UNBLOCK : constant := 2;
170   SIG_SETMASK : constant := 3;
171
172   SIG_DFL : constant := 0;
173   SIG_IGN : constant := 1;
174
175   function sigaction
176     (sig  : Signal;
177      act  : struct_sigaction_ptr;
178      oact : struct_sigaction_ptr) return int;
179   pragma Import (C, sigaction, "sigaction");
180
181   ----------
182   -- Time --
183   ----------
184
185   Time_Slice_Supported : constant Boolean := True;
186   --  Indicates whether time slicing is supported
187
188   type timespec is private;
189
190   type clockid_t is new int;
191
192   function clock_getres
193     (clock_id : clockid_t;
194      res      : access timespec) return int;
195   pragma Import (C, clock_getres, "clock_getres");
196
197   function clock_gettime
198     (clock_id : clockid_t;
199      tp       : access timespec) return int;
200   pragma Import (C, clock_gettime, "clock_gettime");
201
202   function To_Duration (TS : timespec) return Duration;
203   pragma Inline (To_Duration);
204
205   function To_Timespec (D : Duration) return timespec;
206   pragma Inline (To_Timespec);
207
208   -------------------------
209   -- Priority Scheduling --
210   -------------------------
211
212   SCHED_FIFO  : constant := 1;
213   SCHED_RR    : constant := 2;
214   SCHED_OTHER : constant := 0;
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   --  Read/Write lock not supported on Solaris. To add support both types
261   --  pthread_rwlock_t and pthread_rwlockattr_t must properly be defined
262   --  with the associated routines pthread_rwlock_[init/destroy] and
263   --  pthread_rwlock_[rdlock/wrlock/unlock].
264
265   subtype pthread_rwlock_t     is pthread_mutex_t;
266   subtype pthread_rwlockattr_t is pthread_mutexattr_t;
267
268   PTHREAD_CREATE_DETACHED : constant := 16#40#;
269
270   PTHREAD_SCOPE_PROCESS : constant := 0;
271   PTHREAD_SCOPE_SYSTEM  : constant := 1;
272
273   -----------
274   -- Stack --
275   -----------
276
277   type stack_t is record
278      ss_sp    : System.Address;
279      ss_size  : size_t;
280      ss_flags : int;
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   --  This is a dummy definition, never used (Alternate_Stack_Size is null)
291
292   Alternate_Stack_Size : constant := 0;
293   --  No alternate signal stack is used on this platform
294
295   Stack_Base_Available : constant Boolean := False;
296   --  Indicates whether the stack base is available on this target
297
298   function Get_Stack_Base (thread : pthread_t) return Address;
299   pragma Inline (Get_Stack_Base);
300   --  Returns the stack base of the specified thread. Only call this function
301   --  when Stack_Base_Available is True.
302
303   function Get_Page_Size return int;
304   pragma Import (C, Get_Page_Size, "getpagesize");
305   --  Returns the size of a page
306
307   PROT_NONE  : constant := 0;
308   PROT_READ  : constant := 1;
309   PROT_WRITE : constant := 2;
310   PROT_EXEC  : constant := 4;
311   PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
312   PROT_ON    : constant := PROT_READ;
313   PROT_OFF   : constant := PROT_ALL;
314
315   function mprotect (addr : Address; len : size_t; prot : int) return int;
316   pragma Import (C, mprotect);
317
318   ---------------------------------------
319   -- Nonstandard Thread Initialization --
320   ---------------------------------------
321
322   procedure pthread_init;
323   --  This is a dummy procedure to share some GNULLI files
324
325   -------------------------
326   -- POSIX.1c  Section 3 --
327   -------------------------
328
329   function sigwait
330     (set : access sigset_t;
331      sig : access Signal) return int;
332   pragma Import (C, sigwait, "__posix_sigwait");
333
334   function pthread_kill
335     (thread : pthread_t;
336      sig    : Signal) return int;
337   pragma Import (C, pthread_kill, "pthread_kill");
338
339   function pthread_sigmask
340     (how  : int;
341      set  : access sigset_t;
342      oset : access sigset_t) return int;
343   pragma Import (C, pthread_sigmask, "pthread_sigmask");
344
345   --------------------------
346   -- POSIX.1c  Section 11 --
347   --------------------------
348
349   function pthread_mutexattr_init
350     (attr : access pthread_mutexattr_t) return int;
351   pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
352
353   function pthread_mutexattr_destroy
354     (attr : access pthread_mutexattr_t) return int;
355   pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
356
357   function pthread_mutex_init
358     (mutex : access pthread_mutex_t;
359      attr  : access pthread_mutexattr_t) return int;
360   pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
361
362   function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
363   pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
364
365   function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
366   pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
367
368   function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
369   pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
370
371   function pthread_condattr_init
372     (attr : access pthread_condattr_t) return int;
373   pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
374
375   function pthread_condattr_destroy
376     (attr : access pthread_condattr_t) return int;
377   pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
378
379   function pthread_cond_init
380     (cond : access pthread_cond_t;
381      attr : access pthread_condattr_t) return int;
382   pragma Import (C, pthread_cond_init, "pthread_cond_init");
383
384   function pthread_cond_destroy (cond : access pthread_cond_t) return int;
385   pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
386
387   function pthread_cond_signal (cond : access pthread_cond_t) return int;
388   pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
389
390   function pthread_cond_wait
391     (cond  : access pthread_cond_t;
392      mutex : access pthread_mutex_t) return int;
393   pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
394
395   function pthread_cond_timedwait
396     (cond    : access pthread_cond_t;
397      mutex   : access pthread_mutex_t;
398      abstime : access timespec) return int;
399   pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
400
401   Relative_Timed_Wait : constant Boolean := False;
402   --  pthread_cond_timedwait requires an absolute delay time
403
404   --------------------------
405   -- POSIX.1c  Section 13 --
406   --------------------------
407
408   PTHREAD_PRIO_NONE    : constant := 0;
409   PTHREAD_PRIO_INHERIT : constant := 16#10#;
410   PTHREAD_PRIO_PROTECT : constant := 16#20#;
411
412   function pthread_mutexattr_setprotocol
413     (attr     : access pthread_mutexattr_t;
414      protocol : int) return int;
415   pragma Import (C, pthread_mutexattr_setprotocol);
416
417   function pthread_mutexattr_setprioceiling
418     (attr        : access pthread_mutexattr_t;
419      prioceiling : int) return int;
420   pragma Import (C, pthread_mutexattr_setprioceiling);
421
422   type Array_8_Int is array (0 .. 7) of int;
423   type struct_sched_param is record
424      sched_priority : int;
425      sched_pad      : Array_8_Int;
426   end record;
427
428   function pthread_setschedparam
429     (thread : pthread_t;
430      policy : int;
431      param  : access struct_sched_param) return int;
432   pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
433
434   function pthread_attr_setscope
435     (attr            : access pthread_attr_t;
436      contentionscope : int) return int;
437   pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
438
439   function pthread_attr_setinheritsched
440     (attr         : access pthread_attr_t;
441      inheritsched : int) return int;
442   pragma Import (C, pthread_attr_setinheritsched);
443
444   function pthread_attr_setschedpolicy
445     (attr   : access pthread_attr_t;
446      policy : int) return int;
447   pragma Import (C, pthread_attr_setschedpolicy);
448
449   function sched_yield return int;
450   pragma Import (C, sched_yield, "sched_yield");
451
452   ---------------------------
453   -- P1003.1c - Section 16 --
454   ---------------------------
455
456   function pthread_attr_init (attributes : access pthread_attr_t) return int;
457   pragma Import (C, pthread_attr_init, "pthread_attr_init");
458
459   function pthread_attr_destroy
460     (attributes : access pthread_attr_t) return int;
461   pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
462
463   function pthread_attr_setdetachstate
464     (attr        : access pthread_attr_t;
465      detachstate : int) return int;
466   pragma Import (C, pthread_attr_setdetachstate);
467
468   function pthread_attr_setstacksize
469     (attr      : access pthread_attr_t;
470      stacksize : size_t) return int;
471   pragma Import (C, pthread_attr_setstacksize);
472
473   function pthread_create
474     (thread        : access pthread_t;
475      attributes    : access pthread_attr_t;
476      start_routine : Thread_Body;
477      arg           : System.Address) return int;
478   pragma Import (C, pthread_create, "pthread_create");
479
480   procedure pthread_exit (status : System.Address);
481   pragma Import (C, pthread_exit, "pthread_exit");
482
483   function pthread_self return pthread_t;
484   pragma Import (C, pthread_self, "pthread_self");
485
486   --------------------------
487   -- POSIX.1c  Section 17 --
488   --------------------------
489
490   function pthread_setspecific
491     (key   : pthread_key_t;
492      value : System.Address) return int;
493   pragma Import (C, pthread_setspecific, "pthread_setspecific");
494
495   function pthread_getspecific (key : pthread_key_t) return System.Address;
496   pragma Import (C, pthread_getspecific, "pthread_getspecific");
497
498   type destructor_pointer is access procedure (arg : System.Address);
499   pragma Convention (C, destructor_pointer);
500
501   function pthread_key_create
502     (key        : access pthread_key_t;
503      destructor : destructor_pointer) return int;
504   pragma Import (C, pthread_key_create, "pthread_key_create");
505
506private
507
508   type array_type_1 is array (Integer range 0 .. 3) of unsigned_long;
509   type sigset_t is record
510      X_X_sigbits  : array_type_1;
511   end record;
512   pragma Convention (C, sigset_t);
513
514   type pid_t is new long;
515
516   type time_t is new long;
517
518   type timespec is record
519      tv_sec  : time_t;
520      tv_nsec : long;
521   end record;
522   pragma Convention (C, timespec);
523
524   type pthread_attr_t is record
525      pthread_attrp : System.Address;
526   end record;
527   pragma Convention (C, pthread_attr_t);
528
529   type pthread_condattr_t is record
530      pthread_condattrp : System.Address;
531   end record;
532   pragma Convention (C, pthread_condattr_t);
533
534   type pthread_mutexattr_t is record
535      pthread_mutexattrp : System.Address;
536   end record;
537   pragma Convention (C, pthread_mutexattr_t);
538
539   type pthread_t is new unsigned;
540
541   type uint64_t is mod 2 ** 64;
542
543   type pthread_mutex_t is record
544      pthread_mutex_flags   : uint64_t;
545      pthread_mutex_owner64 : uint64_t;
546      pthread_mutex_data    : uint64_t;
547   end record;
548   pragma Convention (C, pthread_mutex_t);
549   type pthread_mutex_t_ptr is access pthread_mutex_t;
550
551   type pthread_cond_t is record
552      pthread_cond_flags : uint64_t;
553      pthread_cond_data  : uint64_t;
554   end record;
555   pragma Convention (C, pthread_cond_t);
556
557   type pthread_key_t is new unsigned;
558
559end System.OS_Interface;
560