gcc/ada/s-osinte-aix.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-2011, 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 AIX (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 ("-pthread");
  49    --  This implies -lpthreads + other things depending on the GCC
  50    --  configuration, such as the selection of a proper libgcc variant
  51    --  for table-based exception handling when it is available.
  52
  53    pragma Linker_Options ("-lc_r");
  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 := 78;
  77
  78    -------------
  79    -- Signals --
  80    -------------
  81
  82    Max_Interrupt : constant := 63;
  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 := 30; --  user defined signal 1
 103    SIGUSR2     : constant := 31; --  user defined signal 2
 104    SIGCLD      : constant := 20; --  alias for SIGCHLD
 105    SIGCHLD     : constant := 20; --  child status change
 106    SIGPWR      : constant := 29; --  power-fail restart
 107    SIGWINCH    : constant := 28; --  window size change
 108    SIGURG      : constant := 16; --  urgent condition on IO channel
 109    SIGPOLL     : constant := 23; --  pollable event occurred
 110    SIGIO       : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
 111    SIGSTOP     : constant := 17; --  stop (cannot be caught or ignored)
 112    SIGTSTP     : constant := 18; --  user stop requested from tty
 113    SIGCONT     : constant := 19; --  stopped process has been continued
 114    SIGTTIN     : constant := 21; --  background tty read attempted
 115    SIGTTOU     : constant := 22; --  background tty write attempted
 116    SIGVTALRM   : constant := 34; --  virtual timer expired
 117    SIGPROF     : constant := 32; --  profiling timer expired
 118    SIGXCPU     : constant := 24; --  CPU time limit exceeded
 119    SIGXFSZ     : constant := 25; --  filesize limit exceeded
 120    SIGWAITING  : constant := 39; --  m:n scheduling
 121
 122    --  The following signals are AIX specific
 123
 124    SIGMSG      : constant := 27; -- input data is in the ring buffer
 125    SIGDANGER   : constant := 33; -- system crash imminent
 126    SIGMIGRATE  : constant := 35; -- migrate process
 127    SIGPRE      : constant := 36; -- programming exception
 128    SIGVIRT     : constant := 37; -- AIX virtual time alarm
 129    SIGALRM1    : constant := 38; -- m:n condition variables
 130    SIGCPUFAIL  : constant := 59; -- Predictive De-configuration of Processors
 131    SIGKAP      : constant := 60; -- keep alive poll from native keyboard
 132    SIGGRANT    : constant := SIGKAP; -- monitor mode granted
 133    SIGRETRACT  : constant := 61; -- monitor mode should be relinquished
 134    SIGSOUND    : constant := 62; -- sound control has completed
 135    SIGSAK      : constant := 63; -- secure attention key
 136
 137    SIGADAABORT : constant := SIGEMT;
 138    --  Note: on other targets, we usually use SIGABRT, but on AIX, it appears
 139    --  that SIGABRT can't be used in sigwait(), so we use SIGEMT.
 140    --  SIGEMT is "Emulator Trap Instruction" from the PDP-11, and does not
 141    --  have a standardized usage.
 142
 143    type Signal_Set is array (Natural range <>) of Signal;
 144
 145    Unmasked : constant Signal_Set :=
 146                 (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
 147    Reserved : constant Signal_Set :=
 148                 (SIGABRT, SIGKILL, SIGSTOP, SIGALRM1, SIGWAITING, SIGCPUFAIL);
 149
 150    type sigset_t is private;
 151
 152    function sigaddset (set : access sigset_t; sig : Signal) return int;
 153    pragma Import (C, sigaddset, "sigaddset");
 154
 155    function sigdelset (set : access sigset_t; sig : Signal) return int;
 156    pragma Import (C, sigdelset, "sigdelset");
 157
 158    function sigfillset (set : access sigset_t) return int;
 159    pragma Import (C, sigfillset, "sigfillset");
 160
 161    function sigismember (set : access sigset_t; sig : Signal) return int;
 162    pragma Import (C, sigismember, "sigismember");
 163
 164    function sigemptyset (set : access sigset_t) return int;
 165    pragma Import (C, sigemptyset, "sigemptyset");
 166
 167    type struct_sigaction is record
 168       sa_handler : System.Address;
 169       sa_mask    : sigset_t;
 170       sa_flags   : int;
 171    end record;
 172    pragma Convention (C, struct_sigaction);
 173    type struct_sigaction_ptr is access all struct_sigaction;
 174
 175    SA_SIGINFO : constant := 16#0100#;
 176    SA_ONSTACK : constant := 16#0001#;
 177
 178    SIG_BLOCK   : constant := 0;
 179    SIG_UNBLOCK : constant := 1;
 180    SIG_SETMASK : constant := 2;
 181
 182    SIG_DFL : constant := 0;
 183    SIG_IGN : constant := 1;
 184
 185    function sigaction
 186      (sig  : Signal;
 187       act  : struct_sigaction_ptr;
 188       oact : struct_sigaction_ptr) return int;
 189    pragma Import (C, sigaction, "sigaction");
 190
 191    ----------
 192    -- Time --
 193    ----------
 194
 195    Time_Slice_Supported : constant Boolean := True;
 196    --  Indicates whether time slicing is supported
 197
 198    type timespec is private;
 199
 200    type clockid_t is private;
 201
 202    CLOCK_REALTIME  : constant clockid_t;
 203    CLOCK_MONOTONIC : constant clockid_t;
 204
 205    function clock_gettime
 206      (clock_id : clockid_t;
 207       tp       : access timespec) return int;
 208
 209    function To_Duration (TS : timespec) return Duration;
 210    pragma Inline (To_Duration);
 211
 212    function To_Timespec (D : Duration) return timespec;
 213    pragma Inline (To_Timespec);
 214
 215    type struct_timezone is record
 216       tz_minuteswest : int;
 217       tz_dsttime     : int;
 218    end record;
 219    pragma Convention (C, struct_timezone);
 220    type struct_timezone_ptr is access all struct_timezone;
 221
 222    -------------------------
 223    -- Priority Scheduling --
 224    -------------------------
 225
 226    SCHED_FIFO  : constant := 1;
 227    SCHED_RR    : constant := 2;
 228    SCHED_OTHER : constant := 0;
 229
 230    function To_Target_Priority
 231      (Prio : System.Any_Priority) return Interfaces.C.int;
 232    --  Maps System.Any_Priority to a POSIX priority
 233
 234    -------------
 235    -- Process --
 236    -------------
 237
 238    type pid_t is private;
 239
 240    function kill (pid : pid_t; sig : Signal) return int;
 241    pragma Import (C, kill, "kill");
 242
 243    function getpid return pid_t;
 244    pragma Import (C, getpid, "getpid");
 245
 246    ---------
 247    -- LWP --
 248    ---------
 249
 250    function lwp_self return System.Address;
 251    pragma Import (C, lwp_self, "thread_self");
 252
 253    -------------
 254    -- Threads --
 255    -------------
 256
 257    type Thread_Body is access
 258      function (arg : System.Address) return System.Address;
 259    pragma Convention (C, Thread_Body);
 260
 261    function Thread_Body_Access is new
 262      Ada.Unchecked_Conversion (System.Address, Thread_Body);
 263
 264    type pthread_t           is private;
 265    subtype Thread_Id        is pthread_t;
 266
 267    type pthread_mutex_t     is limited private;
 268    type pthread_cond_t      is limited private;
 269    type pthread_attr_t      is limited private;
 270    type pthread_mutexattr_t is limited private;
 271    type pthread_condattr_t  is limited private;
 272    type pthread_key_t       is private;
 273
 274    PTHREAD_CREATE_DETACHED : constant := 1;
 275
 276    PTHREAD_SCOPE_PROCESS : constant := 1;
 277    PTHREAD_SCOPE_SYSTEM  : constant := 0;
 278
 279    -----------
 280    -- Stack --
 281    -----------
 282
 283    type stack_t is record
 284       ss_sp    : System.Address;
 285       ss_size  : size_t;
 286       ss_flags : int;
 287    end record;
 288    pragma Convention (C, stack_t);
 289
 290    function sigaltstack
 291      (ss  : not null access stack_t;
 292       oss : access stack_t) return int;
 293    pragma Import (C, sigaltstack, "sigaltstack");
 294
 295    Alternate_Stack : aliased System.Address;
 296    --  This is a dummy definition, never used (Alternate_Stack_Size is null)
 297
 298    Alternate_Stack_Size : constant := 0;
 299    --  No alternate signal stack is used on this platform
 300
 301    Stack_Base_Available : constant Boolean := False;
 302    --  Indicates whether the stack base is available on this target
 303
 304    function Get_Stack_Base (thread : pthread_t) return Address;
 305    pragma Inline (Get_Stack_Base);
 306    --  Returns the stack base of the specified thread. Only call this function
 307    --  when Stack_Base_Available is True.
 308
 309    function Get_Page_Size return size_t;
 310    function Get_Page_Size return Address;
 311    pragma Import (C, Get_Page_Size, "getpagesize");
 312    --  Returns the size of a page
 313
 314    PROT_NONE  : constant := 0;
 315    PROT_READ  : constant := 1;
 316    PROT_WRITE : constant := 2;
 317    PROT_EXEC  : constant := 4;
 318    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
 319    PROT_ON    : constant := PROT_READ;
 320    PROT_OFF   : constant := PROT_ALL;
 321
 322    function mprotect (addr : Address; len : size_t; prot : int) return int;
 323    pragma Import (C, mprotect);
 324
 325    ---------------------------------------
 326    -- Nonstandard Thread Initialization --
 327    ---------------------------------------
 328
 329    --  Though not documented, pthread_init *must* be called before any other
 330    --  pthread call.
 331
 332    procedure pthread_init;
 333    pragma Import (C, pthread_init, "pthread_init");
 334
 335    -------------------------
 336    -- POSIX.1c  Section 3 --
 337    -------------------------
 338
 339    function sigwait
 340      (set : access sigset_t;
 341       sig : access Signal) return int;
 342    pragma Import (C, sigwait, "sigwait");
 343
 344    function pthread_kill
 345      (thread : pthread_t;
 346       sig    : Signal) return int;
 347    pragma Import (C, pthread_kill, "pthread_kill");
 348
 349    function pthread_sigmask
 350      (how  : int;
 351       set  : access sigset_t;
 352       oset : access sigset_t) return int;
 353    pragma Import (C, pthread_sigmask, "sigthreadmask");
 354
 355    --------------------------
 356    -- POSIX.1c  Section 11 --
 357    --------------------------
 358
 359    function pthread_mutexattr_init
 360      (attr : access pthread_mutexattr_t) return int;
 361    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 362
 363    function pthread_mutexattr_destroy
 364      (attr : access pthread_mutexattr_t) return int;
 365    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 366
 367    function pthread_mutex_init
 368      (mutex : access pthread_mutex_t;
 369       attr  : access pthread_mutexattr_t) return int;
 370    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 371
 372    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 373    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 374
 375    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 376    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 377
 378    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 379    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 380
 381    function pthread_condattr_init
 382      (attr : access pthread_condattr_t) return int;
 383    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 384
 385    function pthread_condattr_destroy
 386      (attr : access pthread_condattr_t) return int;
 387    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 388
 389    function pthread_cond_init
 390      (cond : access pthread_cond_t;
 391       attr : access pthread_condattr_t) return int;
 392    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 393
 394    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 395    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 396
 397    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 398    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 399
 400    function pthread_cond_wait
 401      (cond  : access pthread_cond_t;
 402       mutex : access pthread_mutex_t) return int;
 403    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 404
 405    function pthread_cond_timedwait
 406      (cond    : access pthread_cond_t;
 407       mutex   : access pthread_mutex_t;
 408       abstime : access timespec) return int;
 409    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 410
 411    Relative_Timed_Wait : constant Boolean := False;
 412    --  pthread_cond_timedwait requires an absolute delay time
 413
 414    --------------------------
 415    -- POSIX.1c  Section 13 --
 416    --------------------------
 417
 418    PTHREAD_PRIO_PROTECT : constant := 2;
 419
 420    function PTHREAD_PRIO_INHERIT return int;
 421    --  Return value of C macro PTHREAD_PRIO_INHERIT. This function is needed
 422    --  since the value is different between AIX versions.
 423
 424    function pthread_mutexattr_setprotocol
 425      (attr     : access pthread_mutexattr_t;
 426       protocol : int) return int;
 427    pragma Import (C, pthread_mutexattr_setprotocol);
 428
 429    function pthread_mutexattr_setprioceiling
 430      (attr        : access pthread_mutexattr_t;
 431       prioceiling : int) return int;
 432    pragma Import (C, pthread_mutexattr_setprioceiling);
 433
 434    type Array_5_Int is array (0 .. 5) of int;
 435    type struct_sched_param is record
 436       sched_priority : int;
 437       sched_policy   : int;
 438       sched_reserved : Array_5_Int;
 439    end record;
 440
 441    function pthread_setschedparam
 442      (thread : pthread_t;
 443       policy : int;
 444       param  : access struct_sched_param) return int;
 445    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 446
 447    function pthread_attr_setscope
 448      (attr            : access pthread_attr_t;
 449       contentionscope : int) return int;
 450    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 451
 452    function pthread_attr_setinheritsched
 453      (attr            : access pthread_attr_t;
 454       inheritsched : int) return int;
 455    pragma Import (C, pthread_attr_setinheritsched);
 456
 457    function pthread_attr_setschedpolicy
 458      (attr   : access pthread_attr_t;
 459       policy : int) return int;
 460    pragma Import (C, pthread_attr_setschedpolicy);
 461
 462    function pthread_attr_setschedparam
 463      (attr        : access pthread_attr_t;
 464       sched_param : int) return int;
 465    pragma Import (C, pthread_attr_setschedparam);
 466
 467    function sched_yield return int;
 468    --  AIX have a nonstandard sched_yield
 469
 470    --------------------------
 471    -- P1003.1c  Section 16 --
 472    --------------------------
 473
 474    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 475    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 476
 477    function pthread_attr_destroy
 478      (attributes : access pthread_attr_t) return int;
 479    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 480
 481    function pthread_attr_setdetachstate
 482      (attr        : access pthread_attr_t;
 483       detachstate : int) return int;
 484    pragma Import (C, pthread_attr_setdetachstate);
 485
 486    function pthread_attr_setstacksize
 487      (attr      : access pthread_attr_t;
 488       stacksize : size_t) return int;
 489    pragma Import (C, pthread_attr_setstacksize);
 490
 491    function pthread_create
 492      (thread        : access pthread_t;
 493       attributes    : access pthread_attr_t;
 494       start_routine : Thread_Body;
 495       arg           : System.Address)
 496      return int;
 497    pragma Import (C, pthread_create, "pthread_create");
 498
 499    procedure pthread_exit (status : System.Address);
 500    pragma Import (C, pthread_exit, "pthread_exit");
 501
 502    function pthread_self return pthread_t;
 503    pragma Import (C, pthread_self, "pthread_self");
 504
 505    --------------------------
 506    -- POSIX.1c  Section 17 --
 507    --------------------------
 508
 509    function pthread_setspecific
 510      (key   : pthread_key_t;
 511       value : System.Address) return int;
 512    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 513
 514    function pthread_getspecific (key : pthread_key_t) return System.Address;
 515    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 516
 517    type destructor_pointer is access procedure (arg : System.Address);
 518    pragma Convention (C, destructor_pointer);
 519
 520    function pthread_key_create
 521      (key        : access pthread_key_t;
 522       destructor : destructor_pointer) return int;
 523    pragma Import (C, pthread_key_create, "pthread_key_create");
 524
 525 private
 526    type sigset_t is record
 527       losigs : unsigned_long;
 528       hisigs : unsigned_long;
 529    end record;
 530    pragma Convention (C_Pass_By_Copy, sigset_t);
 531
 532    type pid_t is new int;
 533
 534    type time_t is new long;
 535
 536    type timespec is record
 537       tv_sec  : time_t;
 538       tv_nsec : long;
 539    end record;
 540    pragma Convention (C, timespec);
 541
 542    type clockid_t is new int;
 543    CLOCK_REALTIME  : constant clockid_t := 9;
 544    CLOCK_MONOTONIC : constant clockid_t := 10;
 545
 546    type pthread_attr_t is new System.Address;
 547    pragma Convention (C, pthread_attr_t);
 548    --  typedef struct __pt_attr        *pthread_attr_t;
 549
 550    type pthread_condattr_t is new System.Address;
 551    pragma Convention (C, pthread_condattr_t);
 552    --  typedef struct __pt_attr        *pthread_condattr_t;
 553
 554    type pthread_mutexattr_t is new System.Address;
 555    pragma Convention (C, pthread_mutexattr_t);
 556    --  typedef struct __pt_attr        *pthread_mutexattr_t;
 557
 558    type pthread_t is new System.Address;
 559    pragma Convention (C, pthread_t);
 560    --  typedef void    *pthread_t;
 561
 562    type ptq_queue;
 563    type ptq_queue_ptr is access all ptq_queue;
 564
 565    type ptq_queue is record
 566       ptq_next : ptq_queue_ptr;
 567       ptq_prev : ptq_queue_ptr;
 568    end record;
 569
 570    type Array_3_Int is array (0 .. 3) of int;
 571    type pthread_mutex_t is record
 572         link        : ptq_queue;
 573         ptmtx_lock  : int;
 574         ptmtx_flags : long;
 575         protocol    : int;
 576         prioceiling : int;
 577         ptmtx_owner : pthread_t;
 578         mtx_id      : int;
 579         attr        : pthread_attr_t;
 580         mtx_kind    : int;
 581         lock_cpt    : int;
 582         reserved    : Array_3_Int;
 583    end record;
 584    pragma Convention (C, pthread_mutex_t);
 585    type pthread_mutex_t_ptr is access pthread_mutex_t;
 586
 587    type pthread_cond_t is record
 588       link         : ptq_queue;
 589       ptcv_lock    : int;
 590       ptcv_flags   : long;
 591       ptcv_waiters : ptq_queue;
 592       cv_id        : int;
 593       attr         : pthread_attr_t;
 594       mutex        : pthread_mutex_t_ptr;
 595       cptwait      : int;
 596       reserved     : int;
 597    end record;
 598    pragma Convention (C, pthread_cond_t);
 599
 600    type pthread_key_t is new unsigned;
 601
 602 end System.OS_Interface;