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-2007, Free Software Foundation, Inc.         --
  11 --                                                                          --
  12 -- GNARL 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 2,  or (at your option) any later ver- --
  15 -- sion. GNARL 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.  See the GNU General Public License --
  18 -- for  more details.  You should have  received  a copy of the GNU General --
  19 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
  20 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  21 -- Boston, MA 02110-1301, USA.                                              --
  22 --                                                                          --
  23 -- As a special exception,  if other files  instantiate  generics from this --
  24 -- unit, or you link  this unit with other files  to produce an executable, --
  25 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  26 -- covered  by the  GNU  General  Public  License.  This exception does not --
  27 -- however invalidate  any other reasons why  the executable file  might be --
  28 -- covered by the  GNU Public License.                                      --
  29 --                                                                          --
  30 -- GNARL was developed by the GNARL team at Florida State University.       --
  31 -- Extensive contributions were provided by Ada Core Technologies, Inc.     --
  32 --                                                                          --
  33 ------------------------------------------------------------------------------
  34
  35 --  This is a AIX (Native THREADS) version of this package
  36
  37 --  This package encapsulates all direct interfaces to OS services that are
  38 --  needed by children of System.
  39
  40 --  PLEASE DO NOT add any with-clauses to this package or remove the pragma
  41 --  Preelaborate. This package is designed to be a bottom-level (leaf) package.
  42
  43 with Interfaces.C;
  44 with Ada.Unchecked_Conversion;
  45
  46 package System.OS_Interface is
  47    pragma Preelaborate;
  48
  49    pragma Linker_Options ("-pthread");
  50    --  This implies -lpthreads + other things depending on the GCC
  51    --  configuration, such as the selection of a proper libgcc variant
  52    --  for table-based exception handling when it is available.
  53
  54    pragma Linker_Options ("-lc_r");
  55
  56    subtype int            is Interfaces.C.int;
  57    subtype short          is Interfaces.C.short;
  58    subtype long           is Interfaces.C.long;
  59    subtype unsigned       is Interfaces.C.unsigned;
  60    subtype unsigned_short is Interfaces.C.unsigned_short;
  61    subtype unsigned_long  is Interfaces.C.unsigned_long;
  62    subtype unsigned_char  is Interfaces.C.unsigned_char;
  63    subtype plain_char     is Interfaces.C.plain_char;
  64    subtype size_t         is Interfaces.C.size_t;
  65
  66    -----------
  67    -- Errno --
  68    -----------
  69
  70    function errno return int;
  71    pragma Import (C, errno, "__get_errno");
  72
  73    EAGAIN    : constant := 11;
  74    EINTR     : constant := 4;
  75    EINVAL    : constant := 22;
  76    ENOMEM    : constant := 12;
  77    ETIMEDOUT : constant := 78;
  78
  79    -------------
  80    -- Signals --
  81    -------------
  82
  83    Max_Interrupt : constant := 63;
  84    type Signal is new int range 0 .. Max_Interrupt;
  85    for Signal'Size use int'Size;
  86
  87    SIGHUP      : constant := 1; --  hangup
  88    SIGINT      : constant := 2; --  interrupt (rubout)
  89    SIGQUIT     : constant := 3; --  quit (ASCD FS)
  90    SIGILL      : constant := 4; --  illegal instruction (not reset)
  91    SIGTRAP     : constant := 5; --  trace trap (not reset)
  92    SIGIOT      : constant := 6; --  IOT instruction
  93    SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
  94    SIGEMT      : constant := 7; --  EMT instruction
  95    SIGFPE      : constant := 8; --  floating point exception
  96    SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
  97    SIGBUS      : constant := 10; --  bus error
  98    SIGSEGV     : constant := 11; --  segmentation violation
  99    SIGSYS      : constant := 12; --  bad argument to system call
 100    SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
 101    SIGALRM     : constant := 14; --  alarm clock
 102    SIGTERM     : constant := 15; --  software termination signal from kill
 103    SIGUSR1     : constant := 30; --  user defined signal 1
 104    SIGUSR2     : constant := 31; --  user defined signal 2
 105    SIGCLD      : constant := 20; --  alias for SIGCHLD
 106    SIGCHLD     : constant := 20; --  child status change
 107    SIGPWR      : constant := 29; --  power-fail restart
 108    SIGWINCH    : constant := 28; --  window size change
 109    SIGURG      : constant := 16; --  urgent condition on IO channel
 110    SIGPOLL     : constant := 23; --  pollable event occurred
 111    SIGIO       : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
 112    SIGSTOP     : constant := 17; --  stop (cannot be caught or ignored)
 113    SIGTSTP     : constant := 18; --  user stop requested from tty
 114    SIGCONT     : constant := 19; --  stopped process has been continued
 115    SIGTTIN     : constant := 21; --  background tty read attempted
 116    SIGTTOU     : constant := 22; --  background tty write attempted
 117    SIGVTALRM   : constant := 34; --  virtual timer expired
 118    SIGPROF     : constant := 32; --  profiling timer expired
 119    SIGXCPU     : constant := 24; --  CPU time limit exceeded
 120    SIGXFSZ     : constant := 25; --  filesize limit exceeded
 121    SIGWAITING  : constant := 39; --  m:n scheduling
 122
 123    --  The following signals are AIX specific
 124
 125    SIGMSG      : constant := 27; -- input data is in the ring buffer
 126    SIGDANGER   : constant := 33; -- system crash imminent
 127    SIGMIGRATE  : constant := 35; -- migrate process
 128    SIGPRE      : constant := 36; -- programming exception
 129    SIGVIRT     : constant := 37; -- AIX virtual time alarm
 130    SIGALRM1    : constant := 38; -- m:n condition variables
 131    SIGCPUFAIL  : constant := 59; -- Predictive De-configuration of Processors
 132    SIGKAP      : constant := 60; -- keep alive poll from native keyboard
 133    SIGGRANT    : constant := SIGKAP; -- monitor mode granted
 134    SIGRETRACT  : constant := 61; -- monitor mode should be relinguished
 135    SIGSOUND    : constant := 62; -- sound control has completed
 136    SIGSAK      : constant := 63; -- secure attention key
 137
 138    SIGADAABORT : constant := SIGEMT;
 139    --  Note: on other targets, we usually use SIGABRT, but on AIX, it appears
 140    --  that SIGABRT can't be used in sigwait(), so we use SIGEMT.
 141    --  SIGEMT is "Emulator Trap Instruction" from the PDP-11, and does not
 142    --  have a standardized usage.
 143
 144    type Signal_Set is array (Natural range <>) of Signal;
 145
 146    Unmasked : constant Signal_Set :=
 147                 (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
 148    Reserved : constant Signal_Set :=
 149                 (SIGABRT, SIGKILL, SIGSTOP, SIGALRM1, SIGWAITING, SIGCPUFAIL);
 150
 151    type sigset_t is private;
 152
 153    function sigaddset (set : access sigset_t; sig : Signal) return int;
 154    pragma Import (C, sigaddset, "sigaddset");
 155
 156    function sigdelset (set : access sigset_t; sig : Signal) return int;
 157    pragma Import (C, sigdelset, "sigdelset");
 158
 159    function sigfillset (set : access sigset_t) return int;
 160    pragma Import (C, sigfillset, "sigfillset");
 161
 162    function sigismember (set : access sigset_t; sig : Signal) return int;
 163    pragma Import (C, sigismember, "sigismember");
 164
 165    function sigemptyset (set : access sigset_t) return int;
 166    pragma Import (C, sigemptyset, "sigemptyset");
 167
 168    type struct_sigaction is record
 169       sa_handler : System.Address;
 170       sa_mask    : sigset_t;
 171       sa_flags   : int;
 172    end record;
 173    pragma Convention (C, struct_sigaction);
 174    type struct_sigaction_ptr is access all struct_sigaction;
 175
 176    SA_SIGINFO  : constant := 16#0100#;
 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
 204    function clock_gettime
 205      (clock_id : clockid_t;
 206       tp       : access timespec) return int;
 207    --  AIX threads don't have clock_gettime, so use gettimeofday() instead
 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    type struct_timeval is private;
 223    --  This is needed on systems that do not have clock_gettime() but do have
 224    --  gettimeofday().
 225
 226    function To_Duration (TV : struct_timeval) return Duration;
 227    pragma Inline (To_Duration);
 228
 229    function To_Timeval (D : Duration) return struct_timeval;
 230    pragma Inline (To_Timeval);
 231
 232    -------------------------
 233    -- Priority Scheduling --
 234    -------------------------
 235
 236    SCHED_FIFO  : constant := 1;
 237    SCHED_RR    : constant := 2;
 238    SCHED_OTHER : constant := 0;
 239
 240    function To_Target_Priority
 241      (Prio : System.Any_Priority) return Interfaces.C.int;
 242    --  Maps System.Any_Priority to a POSIX priority
 243
 244    -------------
 245    -- Process --
 246    -------------
 247
 248    type pid_t is private;
 249
 250    function kill (pid : pid_t; sig : Signal) return int;
 251    pragma Import (C, kill, "kill");
 252
 253    function getpid return pid_t;
 254    pragma Import (C, getpid, "getpid");
 255
 256    ---------
 257    -- LWP --
 258    ---------
 259
 260    function lwp_self return System.Address;
 261    pragma Import (C, lwp_self, "thread_self");
 262
 263    -------------
 264    -- Threads --
 265    -------------
 266
 267    type Thread_Body is access
 268      function (arg : System.Address) return System.Address;
 269
 270    function Thread_Body_Access is new
 271      Ada.Unchecked_Conversion (System.Address, Thread_Body);
 272
 273    type pthread_t           is private;
 274    subtype Thread_Id        is pthread_t;
 275
 276    type pthread_mutex_t     is limited private;
 277    type pthread_cond_t      is limited private;
 278    type pthread_attr_t      is limited private;
 279    type pthread_mutexattr_t is limited private;
 280    type pthread_condattr_t  is limited private;
 281    type pthread_key_t       is private;
 282
 283    PTHREAD_CREATE_DETACHED : constant := 1;
 284
 285    PTHREAD_SCOPE_PROCESS : constant := 1;
 286    PTHREAD_SCOPE_SYSTEM  : constant := 0;
 287
 288    -----------
 289    -- Stack --
 290    -----------
 291
 292    Stack_Base_Available : constant Boolean := False;
 293    --  Indicates wether the stack base is available on this target
 294
 295    function Get_Stack_Base (thread : pthread_t) return Address;
 296    pragma Inline (Get_Stack_Base);
 297    --  Returns the stack base of the specified thread. Only call this function
 298    --  when Stack_Base_Available is True.
 299
 300    function Get_Page_Size return size_t;
 301    function Get_Page_Size return Address;
 302    pragma Import (C, Get_Page_Size, "getpagesize");
 303    --  Returns the size of a page, or 0 if this is not relevant on this target
 304
 305    PROT_NONE  : constant := 0;
 306    PROT_READ  : constant := 1;
 307    PROT_WRITE : constant := 2;
 308    PROT_EXEC  : constant := 4;
 309    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
 310
 311    PROT_ON    : constant := PROT_READ;
 312    PROT_OFF   : constant := PROT_ALL;
 313
 314    function mprotect (addr : Address; len : size_t; prot : int) return int;
 315    pragma Import (C, mprotect);
 316
 317    ---------------------------------------
 318    -- Nonstandard Thread Initialization --
 319    ---------------------------------------
 320
 321    --  Though not documented, pthread_init *must* be called before any other
 322    --  pthread call.
 323
 324    procedure pthread_init;
 325    pragma Import (C, pthread_init, "pthread_init");
 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, "sigthreadmask");
 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_PROTECT : constant := 2;
 411
 412    function PTHREAD_PRIO_INHERIT return int;
 413    --  Return value of C macro PTHREAD_PRIO_INHERIT. This function is needed
 414    --  since the value is different between AIX versions.
 415
 416    function pthread_mutexattr_setprotocol
 417      (attr     : access pthread_mutexattr_t;
 418       protocol : int) return int;
 419    pragma Import (C, pthread_mutexattr_setprotocol);
 420
 421    function pthread_mutexattr_setprioceiling
 422      (attr        : access pthread_mutexattr_t;
 423       prioceiling : int) return int;
 424    pragma Import (C, pthread_mutexattr_setprioceiling);
 425
 426    type Array_5_Int is array (0 .. 5) of int;
 427    type struct_sched_param is record
 428       sched_priority : int;
 429       sched_policy   : int;
 430       sched_reserved : Array_5_Int;
 431    end record;
 432
 433    function pthread_setschedparam
 434      (thread : pthread_t;
 435       policy : int;
 436       param  : access struct_sched_param) return int;
 437    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 438
 439    function pthread_attr_setscope
 440      (attr            : access pthread_attr_t;
 441       contentionscope : int) return int;
 442    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 443
 444    function pthread_attr_setinheritsched
 445      (attr            : access pthread_attr_t;
 446       inheritsched : int) return int;
 447    pragma Import (C, pthread_attr_setinheritsched);
 448
 449    function pthread_attr_setschedpolicy
 450      (attr   : access pthread_attr_t;
 451       policy : int) return int;
 452    pragma Import (C, pthread_attr_setschedpolicy);
 453
 454    function pthread_attr_setschedparam
 455      (attr        : access pthread_attr_t;
 456       sched_param : int) return int;
 457    pragma Import (C, pthread_attr_setschedparam);
 458
 459    function sched_yield return int;
 460    --  AIX have a nonstandard sched_yield
 461
 462    --------------------------
 463    -- P1003.1c  Section 16 --
 464    --------------------------
 465
 466    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 467    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 468
 469    function pthread_attr_destroy
 470      (attributes : access pthread_attr_t) return int;
 471    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 472
 473    function pthread_attr_setdetachstate
 474      (attr        : access pthread_attr_t;
 475       detachstate : int) return int;
 476    pragma Import (C, pthread_attr_setdetachstate);
 477
 478    function pthread_attr_setstacksize
 479      (attr      : access pthread_attr_t;
 480       stacksize : size_t) return int;
 481    pragma Import (C, pthread_attr_setstacksize);
 482
 483    function pthread_create
 484      (thread        : access pthread_t;
 485       attributes    : access pthread_attr_t;
 486       start_routine : Thread_Body;
 487       arg           : System.Address)
 488      return int;
 489    pragma Import (C, pthread_create, "pthread_create");
 490
 491    procedure pthread_exit (status : System.Address);
 492    pragma Import (C, pthread_exit, "pthread_exit");
 493
 494    function pthread_self return pthread_t;
 495    pragma Import (C, pthread_self, "pthread_self");
 496
 497    --------------------------
 498    -- POSIX.1c  Section 17 --
 499    --------------------------
 500
 501    function pthread_setspecific
 502      (key   : pthread_key_t;
 503       value : System.Address) return int;
 504    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 505
 506    function pthread_getspecific (key : pthread_key_t) return System.Address;
 507    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 508
 509    type destructor_pointer is access
 510       procedure (arg : System.Address);
 511
 512    function pthread_key_create
 513      (key        : access pthread_key_t;
 514       destructor : destructor_pointer) return int;
 515    pragma Import (C, pthread_key_create, "pthread_key_create");
 516
 517 private
 518    type sigset_t is record
 519       losigs : unsigned_long;
 520       hisigs : unsigned_long;
 521    end record;
 522    pragma Convention (C_Pass_By_Copy, sigset_t);
 523
 524    type pid_t is new int;
 525
 526    type time_t is new long;
 527
 528    type timespec is record
 529       tv_sec  : time_t;
 530       tv_nsec : long;
 531    end record;
 532    pragma Convention (C, timespec);
 533
 534    type clockid_t is new int;
 535    CLOCK_REALTIME : constant clockid_t := 0;
 536
 537    type struct_timeval is record
 538       tv_sec  : long;
 539       tv_usec : long;
 540    end record;
 541    pragma Convention (C, struct_timeval);
 542
 543    type pthread_attr_t is new System.Address;
 544    pragma Convention (C, pthread_attr_t);
 545    --  typedef struct __pt_attr        *pthread_attr_t;
 546
 547    type pthread_condattr_t is new System.Address;
 548    pragma Convention (C, pthread_condattr_t);
 549    --  typedef struct __pt_attr        *pthread_condattr_t;
 550
 551    type pthread_mutexattr_t is new System.Address;
 552    pragma Convention (C, pthread_mutexattr_t);
 553    --  typedef struct __pt_attr        *pthread_mutexattr_t;
 554
 555    type pthread_t is new System.Address;
 556    pragma Convention (C, pthread_t);
 557    --  typedef void    *pthread_t;
 558
 559    type ptq_queue;
 560    type ptq_queue_ptr is access all ptq_queue;
 561
 562    type ptq_queue is record
 563       ptq_next : ptq_queue_ptr;
 564       ptq_prev : ptq_queue_ptr;
 565    end record;
 566
 567    type Array_3_Int is array (0 .. 3) of int;
 568    type pthread_mutex_t is record
 569         link        : ptq_queue;
 570         ptmtx_lock  : int;
 571         ptmtx_flags : long;
 572         protocol    : int;
 573         prioceiling : int;
 574         ptmtx_owner : pthread_t;
 575         mtx_id      : int;
 576         attr        : pthread_attr_t;
 577         mtx_kind    : int;
 578         lock_cpt    : int;
 579         reserved    : Array_3_Int;
 580    end record;
 581    pragma Convention (C, pthread_mutex_t);
 582    type pthread_mutex_t_ptr is access pthread_mutex_t;
 583
 584    type pthread_cond_t is record
 585       link         : ptq_queue;
 586       ptcv_lock    : int;
 587       ptcv_flags   : long;
 588       ptcv_waiters : ptq_queue;
 589       cv_id        : int;
 590       attr         : pthread_attr_t;
 591       mutex        : pthread_mutex_t_ptr;
 592       cptwait      : int;
 593       reserved     : int;
 594    end record;
 595    pragma Convention (C, pthread_cond_t);
 596
 597    type pthread_key_t is new unsigned;
 598
 599 end System.OS_Interface;