gcc/ada/s-osinte-solaris-posix.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-2010, 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
  41 with Interfaces.C;
  42
  43 with Ada.Unchecked_Conversion;
  44
  45 package 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 private;
 191
 192    CLOCK_REALTIME : constant clockid_t;
 193
 194    function clock_gettime
 195      (clock_id : clockid_t;
 196       tp       : access timespec) return int;
 197    pragma Import (C, clock_gettime, "clock_gettime");
 198
 199    function To_Duration (TS : timespec) return Duration;
 200    pragma Inline (To_Duration);
 201
 202    function To_Timespec (D : Duration) return timespec;
 203    pragma Inline (To_Timespec);
 204
 205    -------------------------
 206    -- Priority Scheduling --
 207    -------------------------
 208
 209    SCHED_FIFO  : constant := 1;
 210    SCHED_RR    : constant := 2;
 211    SCHED_OTHER : constant := 0;
 212
 213    function To_Target_Priority
 214      (Prio : System.Any_Priority) return Interfaces.C.int;
 215    --  Maps System.Any_Priority to a POSIX priority
 216
 217    -------------
 218    -- Process --
 219    -------------
 220
 221    type pid_t is private;
 222
 223    function kill (pid : pid_t; sig : Signal) return int;
 224    pragma Import (C, kill, "kill");
 225
 226    function getpid return pid_t;
 227    pragma Import (C, getpid, "getpid");
 228
 229    ---------
 230    -- LWP --
 231    ---------
 232
 233    function lwp_self return System.Address;
 234    pragma Import (C, lwp_self, "_lwp_self");
 235
 236    -------------
 237    -- Threads --
 238    -------------
 239
 240    type Thread_Body is access
 241      function (arg : System.Address) return System.Address;
 242    pragma Convention (C, Thread_Body);
 243
 244    function Thread_Body_Access is new
 245      Ada.Unchecked_Conversion (System.Address, Thread_Body);
 246
 247    type pthread_t           is private;
 248    subtype Thread_Id        is pthread_t;
 249
 250    type pthread_mutex_t     is limited private;
 251    type pthread_cond_t      is limited private;
 252    type pthread_attr_t      is limited private;
 253    type pthread_mutexattr_t is limited private;
 254    type pthread_condattr_t  is limited private;
 255    type pthread_key_t       is private;
 256
 257    PTHREAD_CREATE_DETACHED : constant := 16#40#;
 258
 259    PTHREAD_SCOPE_PROCESS : constant := 0;
 260    PTHREAD_SCOPE_SYSTEM  : constant := 1;
 261
 262    -----------
 263    -- Stack --
 264    -----------
 265
 266    type stack_t is record
 267       ss_sp    : System.Address;
 268       ss_size  : size_t;
 269       ss_flags : int;
 270    end record;
 271    pragma Convention (C, stack_t);
 272
 273    function sigaltstack
 274      (ss  : not null access stack_t;
 275       oss : access stack_t) return int;
 276    pragma Import (C, sigaltstack, "sigaltstack");
 277
 278    Alternate_Stack : aliased System.Address;
 279    --  This is a dummy definition, never used (Alternate_Stack_Size is null)
 280
 281    Alternate_Stack_Size : constant := 0;
 282    --  No alternate signal stack is used on this platform
 283
 284    Stack_Base_Available : constant Boolean := False;
 285    --  Indicates whether the stack base is available on this target
 286
 287    function Get_Stack_Base (thread : pthread_t) return Address;
 288    pragma Inline (Get_Stack_Base);
 289    --  Returns the stack base of the specified thread. Only call this function
 290    --  when Stack_Base_Available is True.
 291
 292    function Get_Page_Size return size_t;
 293    function Get_Page_Size return Address;
 294    pragma Import (C, Get_Page_Size, "getpagesize");
 295    --  Returns the size of a page
 296
 297    PROT_NONE  : constant := 0;
 298    PROT_READ  : constant := 1;
 299    PROT_WRITE : constant := 2;
 300    PROT_EXEC  : constant := 4;
 301    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
 302    PROT_ON    : constant := PROT_READ;
 303    PROT_OFF   : constant := PROT_ALL;
 304
 305    function mprotect (addr : Address; len : size_t; prot : int) return int;
 306    pragma Import (C, mprotect);
 307
 308    ---------------------------------------
 309    -- Nonstandard Thread Initialization --
 310    ---------------------------------------
 311
 312    procedure pthread_init;
 313    --  This is a dummy procedure to share some GNULLI files
 314
 315    -------------------------
 316    -- POSIX.1c  Section 3 --
 317    -------------------------
 318
 319    function sigwait
 320      (set : access sigset_t;
 321       sig : access Signal) return int;
 322    pragma Import (C, sigwait, "__posix_sigwait");
 323
 324    function pthread_kill
 325      (thread : pthread_t;
 326       sig    : Signal) return int;
 327    pragma Import (C, pthread_kill, "pthread_kill");
 328
 329    function pthread_sigmask
 330      (how  : int;
 331       set  : access sigset_t;
 332       oset : access sigset_t) return int;
 333    pragma Import (C, pthread_sigmask, "pthread_sigmask");
 334
 335    --------------------------
 336    -- POSIX.1c  Section 11 --
 337    --------------------------
 338
 339    function pthread_mutexattr_init
 340      (attr : access pthread_mutexattr_t) return int;
 341    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 342
 343    function pthread_mutexattr_destroy
 344      (attr : access pthread_mutexattr_t) return int;
 345    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 346
 347    function pthread_mutex_init
 348      (mutex : access pthread_mutex_t;
 349       attr  : access pthread_mutexattr_t) return int;
 350    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 351
 352    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 353    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 354
 355    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 356    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 357
 358    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 359    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 360
 361    function pthread_condattr_init
 362      (attr : access pthread_condattr_t) return int;
 363    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 364
 365    function pthread_condattr_destroy
 366      (attr : access pthread_condattr_t) return int;
 367    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 368
 369    function pthread_cond_init
 370      (cond : access pthread_cond_t;
 371       attr : access pthread_condattr_t) return int;
 372    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 373
 374    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 375    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 376
 377    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 378    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 379
 380    function pthread_cond_wait
 381      (cond  : access pthread_cond_t;
 382       mutex : access pthread_mutex_t) return int;
 383    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 384
 385    function pthread_cond_timedwait
 386      (cond    : access pthread_cond_t;
 387       mutex   : access pthread_mutex_t;
 388       abstime : access timespec) return int;
 389    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 390
 391    Relative_Timed_Wait : constant Boolean := False;
 392    --  pthread_cond_timedwait requires an absolute delay time
 393
 394    --------------------------
 395    -- POSIX.1c  Section 13 --
 396    --------------------------
 397
 398    PTHREAD_PRIO_NONE    : constant := 0;
 399    PTHREAD_PRIO_INHERIT : constant := 16#10#;
 400    PTHREAD_PRIO_PROTECT : constant := 16#20#;
 401
 402    function pthread_mutexattr_setprotocol
 403      (attr     : access pthread_mutexattr_t;
 404       protocol : int) return int;
 405    pragma Import (C, pthread_mutexattr_setprotocol);
 406
 407    function pthread_mutexattr_setprioceiling
 408      (attr        : access pthread_mutexattr_t;
 409       prioceiling : int) return int;
 410    pragma Import (C, pthread_mutexattr_setprioceiling);
 411
 412    type Array_8_Int is array (0 .. 7) of int;
 413    type struct_sched_param is record
 414       sched_priority : int;
 415       sched_pad      : Array_8_Int;
 416    end record;
 417
 418    function pthread_setschedparam
 419      (thread : pthread_t;
 420       policy : int;
 421       param  : access struct_sched_param) return int;
 422    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 423
 424    function pthread_attr_setscope
 425      (attr            : access pthread_attr_t;
 426       contentionscope : int) return int;
 427    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 428
 429    function pthread_attr_setinheritsched
 430      (attr         : access pthread_attr_t;
 431       inheritsched : int) return int;
 432    pragma Import (C, pthread_attr_setinheritsched);
 433
 434    function pthread_attr_setschedpolicy
 435      (attr   : access pthread_attr_t;
 436       policy : int) return int;
 437    pragma Import (C, pthread_attr_setschedpolicy);
 438
 439    function sched_yield return int;
 440    pragma Import (C, sched_yield, "sched_yield");
 441
 442    ---------------------------
 443    -- P1003.1c - Section 16 --
 444    ---------------------------
 445
 446    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 447    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 448
 449    function pthread_attr_destroy
 450      (attributes : access pthread_attr_t) return int;
 451    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 452
 453    function pthread_attr_setdetachstate
 454      (attr        : access pthread_attr_t;
 455       detachstate : int) return int;
 456    pragma Import (C, pthread_attr_setdetachstate);
 457
 458    function pthread_attr_setstacksize
 459      (attr      : access pthread_attr_t;
 460       stacksize : size_t) return int;
 461    pragma Import (C, pthread_attr_setstacksize);
 462
 463    function pthread_create
 464      (thread        : access pthread_t;
 465       attributes    : access pthread_attr_t;
 466       start_routine : Thread_Body;
 467       arg           : System.Address) return int;
 468    pragma Import (C, pthread_create, "pthread_create");
 469
 470    procedure pthread_exit (status : System.Address);
 471    pragma Import (C, pthread_exit, "pthread_exit");
 472
 473    function pthread_self return pthread_t;
 474    pragma Import (C, pthread_self, "pthread_self");
 475
 476    --------------------------
 477    -- POSIX.1c  Section 17 --
 478    --------------------------
 479
 480    function pthread_setspecific
 481      (key   : pthread_key_t;
 482       value : System.Address) return int;
 483    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 484
 485    function pthread_getspecific (key : pthread_key_t) return System.Address;
 486    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 487
 488    type destructor_pointer is access procedure (arg : System.Address);
 489    pragma Convention (C, destructor_pointer);
 490
 491    function pthread_key_create
 492      (key        : access pthread_key_t;
 493       destructor : destructor_pointer) return int;
 494    pragma Import (C, pthread_key_create, "pthread_key_create");
 495
 496 private
 497
 498    type array_type_1 is array (Integer range 0 .. 3) of unsigned_long;
 499    type sigset_t is record
 500       X_X_sigbits  : array_type_1;
 501    end record;
 502    pragma Convention (C, sigset_t);
 503
 504    type pid_t is new long;
 505
 506    type time_t is new long;
 507
 508    type timespec is record
 509       tv_sec  : time_t;
 510       tv_nsec : long;
 511    end record;
 512    pragma Convention (C, timespec);
 513
 514    type clockid_t is new int;
 515    CLOCK_REALTIME : constant clockid_t := 0;
 516
 517    type pthread_attr_t is record
 518       pthread_attrp : System.Address;
 519    end record;
 520    pragma Convention (C, pthread_attr_t);
 521
 522    type pthread_condattr_t is record
 523       pthread_condattrp : System.Address;
 524    end record;
 525    pragma Convention (C, pthread_condattr_t);
 526
 527    type pthread_mutexattr_t is record
 528       pthread_mutexattrp : System.Address;
 529    end record;
 530    pragma Convention (C, pthread_mutexattr_t);
 531
 532    type pthread_t is new unsigned;
 533
 534    type uint64_t is mod 2 ** 64;
 535
 536    type pthread_mutex_t is record
 537       pthread_mutex_flags   : uint64_t;
 538       pthread_mutex_owner64 : uint64_t;
 539       pthread_mutex_data    : uint64_t;
 540    end record;
 541    pragma Convention (C, pthread_mutex_t);
 542    type pthread_mutex_t_ptr is access pthread_mutex_t;
 543
 544    type pthread_cond_t is record
 545       pthread_cond_flags : uint64_t;
 546       pthread_cond_data  : uint64_t;
 547    end record;
 548    pragma Convention (C, pthread_cond_t);
 549
 550    type pthread_key_t is new unsigned;
 551
 552 end System.OS_Interface;