gcc/ada/s-osinte-aix-fsu.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                GNU ADA 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-2004, 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,  59 Temple Place - Suite 330,  Boston, --
  21 -- MA 02111-1307, 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 (FSU THREADS) version of this package
  36
  37 --  This package encapsulates all direct interfaces to OS services
  38 --  that are 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 Unchecked_Conversion;
  45
  46 package System.OS_Interface is
  47    pragma Preelaborate;
  48    --  pragma Elaborate_Body;
  49
  50    pragma Linker_Options ("-lgthreads");
  51    pragma Linker_Options ("-lmalloc");
  52
  53    subtype int            is Interfaces.C.int;
  54    subtype short          is Interfaces.C.short;
  55    subtype long           is Interfaces.C.long;
  56    subtype unsigned       is Interfaces.C.unsigned;
  57    subtype unsigned_short is Interfaces.C.unsigned_short;
  58    subtype unsigned_long  is Interfaces.C.unsigned_long;
  59    subtype unsigned_char  is Interfaces.C.unsigned_char;
  60    subtype plain_char     is Interfaces.C.plain_char;
  61    subtype size_t         is Interfaces.C.size_t;
  62
  63    -----------
  64    -- Errno --
  65    -----------
  66
  67    function errno return int;
  68    pragma Import (C, errno, "__get_errno");
  69
  70    EAGAIN    : constant := 11;
  71    EINTR     : constant := 4;
  72    EINVAL    : constant := 22;
  73    ENOMEM    : constant := 12;
  74    ETIMEDOUT : constant := 78;
  75
  76    -------------
  77    -- Signals --
  78    -------------
  79
  80    Max_Interrupt : constant := 63;
  81    type Signal is new int range 0 .. Max_Interrupt;
  82    for Signal'Size use int'Size;
  83
  84    SIGHUP      : constant := 1; --  hangup
  85    SIGINT      : constant := 2; --  interrupt (rubout)
  86    SIGQUIT     : constant := 3; --  quit (ASCD FS)
  87    SIGILL      : constant := 4; --  illegal instruction (not reset)
  88    SIGTRAP     : constant := 5; --  trace trap (not reset)
  89    SIGIOT      : constant := 6; --  IOT instruction
  90    SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
  91    SIGEMT      : constant := 7; --  EMT instruction
  92    SIGFPE      : constant := 8; --  floating point exception
  93    SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
  94    SIGBUS      : constant := 10; --  bus error
  95    SIGSEGV     : constant := 11; --  segmentation violation
  96    SIGSYS      : constant := 12; --  bad argument to system call
  97    SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
  98    SIGALRM     : constant := 14; --  alarm clock
  99    SIGTERM     : constant := 15; --  software termination signal from kill
 100    SIGUSR1     : constant := 30; --  user defined signal 1
 101    SIGUSR2     : constant := 31; --  user defined signal 2
 102    SIGCLD      : constant := 20; --  alias for SIGCHLD
 103    SIGCHLD     : constant := 20; --  child status change
 104    SIGPWR      : constant := 29; --  power-fail restart
 105    SIGWINCH    : constant := 28; --  window size change
 106    SIGURG      : constant := 16; --  urgent condition on IO channel
 107    SIGPOLL     : constant := 23; --  pollable event occurred
 108    SIGIO       : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
 109    SIGSTOP     : constant := 17; --  stop (cannot be caught or ignored)
 110    SIGTSTP     : constant := 18; --  user stop requested from tty
 111    SIGCONT     : constant := 19; --  stopped process has been continued
 112    SIGTTIN     : constant := 21; --  background tty read attempted
 113    SIGTTOU     : constant := 22; --  background tty write attempted
 114    SIGVTALRM   : constant := 34; --  virtual timer expired
 115    SIGPROF     : constant := 32; --  profiling timer expired
 116    SIGXCPU     : constant := 24; --  CPU time limit exceeded
 117    SIGXFSZ     : constant := 25; --  filesize limit exceeded
 118    SIGWAITING  : constant := 39; --  m:n scheduling
 119
 120    --  the following signals are AIX specific
 121    SIGMSG      : constant := 27; -- input data is in the ring buffer
 122    SIGDANGER   : constant := 33; -- system crash imminent
 123    SIGMIGRATE  : constant := 35; -- migrate process
 124    SIGPRE      : constant := 36; -- programming exception
 125    SIGVIRT     : constant := 37; -- AIX virtual time alarm
 126    SIGALRM1    : constant := 38; -- m:n condition variables
 127    SIGKAP      : constant := 60; -- keep alive poll from native keyboard
 128    SIGGRANT    : constant := SIGKAP; -- monitor mode granted
 129    SIGRETRACT  : constant := 61; -- monitor mode should be relinguished
 130    SIGSOUND    : constant := 62; -- sound control has completed
 131    SIGSAK      : constant := 63; -- secure attention key
 132
 133    SIGADAABORT : constant := SIGABRT;
 134
 135    type Signal_Set is array (Natural range <>) of Signal;
 136
 137    Unmasked    : constant Signal_Set :=
 138      (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
 139    Reserved    : constant Signal_Set :=
 140      (SIGKILL, SIGSTOP, SIGALRM, SIGWAITING);
 141
 142    type sigset_t is private;
 143
 144    function sigaddset (set : access sigset_t; sig : Signal) return int;
 145    pragma Import (C, sigaddset, "sigaddset");
 146
 147    function sigdelset (set : access sigset_t; sig : Signal) return int;
 148    pragma Import (C, sigdelset, "sigdelset");
 149
 150    function sigfillset (set : access sigset_t) return int;
 151    pragma Import (C, sigfillset, "sigfillset");
 152
 153    function sigismember (set : access sigset_t; sig : Signal) return int;
 154    pragma Import (C, sigismember, "sigismember");
 155
 156    function sigemptyset (set : access sigset_t) return int;
 157    pragma Import (C, sigemptyset, "sigemptyset");
 158
 159    type struct_sigaction is record
 160       sa_handler : System.Address;
 161       sa_mask    : sigset_t;
 162       sa_flags   : int;
 163    end record;
 164    pragma Convention (C, struct_sigaction);
 165    type struct_sigaction_ptr is access all struct_sigaction;
 166
 167    SA_SIGINFO  : constant := 16#0100#;
 168
 169    SIG_BLOCK   : constant := 0;
 170    SIG_UNBLOCK : constant := 1;
 171    SIG_SETMASK : constant := 2;
 172
 173    SIG_DFL : constant := 0;
 174    SIG_IGN : constant := 1;
 175
 176    function sigaction
 177      (sig  : Signal;
 178       act  : struct_sigaction_ptr;
 179       oact : struct_sigaction_ptr) return int;
 180    pragma Import (C, sigaction, "_internal_sigaction");
 181
 182    ----------
 183    -- Time --
 184    ----------
 185
 186    Time_Slice_Supported : constant Boolean := True;
 187    --  Indicates wether time slicing is supported (i.e FSU threads have been
 188    --  compiled with DEF_RR)
 189
 190    type timespec is private;
 191
 192    type clockid_t is private;
 193
 194    CLOCK_REALTIME : constant clockid_t;
 195
 196    function clock_gettime
 197      (clock_id : clockid_t;
 198       tp       : access timespec) return int;
 199    pragma Import (C, clock_gettime, "clock_gettime");
 200
 201    function To_Duration (TS : timespec) return Duration;
 202    pragma Inline (To_Duration);
 203
 204    function To_Timespec (D : Duration) return timespec;
 205    pragma Inline (To_Timespec);
 206
 207    type struct_timeval is private;
 208
 209    function To_Duration (TV : struct_timeval) return Duration;
 210    pragma Inline (To_Duration);
 211
 212    function To_Timeval (D : Duration) return struct_timeval;
 213    pragma Inline (To_Timeval);
 214
 215    -------------------------
 216    -- Priority Scheduling --
 217    -------------------------
 218
 219    SCHED_FIFO  : constant := 0;
 220    SCHED_RR    : constant := 1;
 221    SCHED_OTHER : constant := 2;
 222
 223    -------------
 224    -- Process --
 225    -------------
 226
 227    type pid_t is private;
 228
 229    function kill (pid : pid_t; sig : Signal) return int;
 230    pragma Import (C, kill, "kill");
 231
 232    function getpid return pid_t;
 233    pragma Import (C, getpid, "getpid");
 234
 235    ---------
 236    -- LWP --
 237    ---------
 238
 239    function lwp_self return System.Address;
 240    --  lwp_self does not exist on this thread library, revert to pthread_self
 241    --  which is the closest approximation (with getpid). This function is
 242    --  needed to share 7staprop.adb across POSIX-like targets.
 243    pragma Import (C, lwp_self, "pthread_self");
 244
 245    -------------
 246    -- Threads --
 247    -------------
 248
 249    type Thread_Body is access
 250      function (arg : System.Address) return System.Address;
 251
 252    function Thread_Body_Access is new
 253      Unchecked_Conversion (System.Address, Thread_Body);
 254
 255    type pthread_t           is private;
 256    subtype Thread_Id        is pthread_t;
 257
 258    type pthread_mutex_t     is limited private;
 259    type pthread_cond_t      is limited private;
 260    type pthread_attr_t      is limited private;
 261    type pthread_mutexattr_t is limited private;
 262    type pthread_condattr_t  is limited private;
 263    type pthread_key_t       is private;
 264
 265    PTHREAD_CREATE_DETACHED : constant := 1;
 266
 267    -----------
 268    -- Stack --
 269    -----------
 270
 271    Stack_Base_Available : constant Boolean := True;
 272    --  Indicates wether the stack base is available on this target.
 273    --  This allows us to share s-osinte.adb between all the FSU run time.
 274    --  Note that this value can only be true if pthread_t has a complete
 275    --  definition that corresponds exactly to the C header files.
 276
 277    function Get_Stack_Base (thread : pthread_t) return Address;
 278    pragma Inline (Get_Stack_Base);
 279    --  returns the stack base of the specified thread.
 280    --  Only call this function when Stack_Base_Available is True.
 281
 282    function Get_Page_Size return size_t;
 283    function Get_Page_Size return Address;
 284    pragma Import (C, Get_Page_Size, "getpagesize");
 285    --  returns the size of a page, or 0 if this is not relevant on this
 286    --  target
 287
 288    PROT_NONE  : constant := 0;
 289    PROT_READ  : constant := 1;
 290    PROT_WRITE : constant := 2;
 291    PROT_EXEC  : constant := 4;
 292    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
 293
 294    PROT_ON    : constant := PROT_READ;
 295    PROT_OFF   : constant := PROT_ALL;
 296
 297    function mprotect (addr : Address; len : size_t; prot : int) return int;
 298    pragma Import (C, mprotect);
 299
 300    ---------------------------------------
 301    -- Nonstandard Thread Initialization --
 302    ---------------------------------------
 303
 304    procedure pthread_init;
 305    --  FSU_THREADS requires pthread_init, which is nonstandard
 306    --  and this should be invoked during the elaboration of s-taprop.adb
 307    pragma Import (C, pthread_init, "pthread_init");
 308
 309    -------------------------
 310    -- POSIX.1c  Section 3 --
 311    -------------------------
 312
 313    function sigwait
 314      (set : access sigset_t;
 315       sig : access Signal) return int;
 316    --  FSU_THREADS has a nonstandard sigwait
 317
 318    function pthread_kill
 319      (thread : pthread_t;
 320       sig    : Signal) return int;
 321    pragma Import (C, pthread_kill, "pthread_kill");
 322
 323    --  FSU threads does not have pthread_sigmask. Instead, it redefines
 324    --  sigprocmask and then uses a special syscall API to call the system
 325    --  version. Doing syscalls on AiX is very difficult, so we rename the
 326    --  pthread version instead.
 327
 328    type sigset_t_ptr is access all sigset_t;
 329
 330    function pthread_sigmask
 331      (how  : int;
 332       set  : sigset_t_ptr;
 333       oset : sigset_t_ptr) return int;
 334    pragma Import (C, pthread_sigmask, "_internal_sigprocmask");
 335
 336    --------------------------
 337    -- POSIX.1c  Section 11 --
 338    --------------------------
 339
 340    function pthread_mutexattr_init
 341      (attr : access pthread_mutexattr_t) return int;
 342    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 343
 344    function pthread_mutexattr_destroy
 345      (attr : access pthread_mutexattr_t) return int;
 346    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 347
 348    function pthread_mutex_init
 349      (mutex : access pthread_mutex_t;
 350       attr  : access pthread_mutexattr_t) return int;
 351    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 352
 353    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 354    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 355
 356    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 357    --  FSU_THREADS has nonstandard pthread_mutex_lock
 358
 359    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 360    --  FSU_THREADS has nonstandard pthread_mutex_lock
 361
 362    function pthread_condattr_init
 363      (attr : access pthread_condattr_t) return int;
 364    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 365
 366    function pthread_condattr_destroy
 367      (attr : access pthread_condattr_t) return int;
 368    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 369
 370    function pthread_cond_init
 371      (cond : access pthread_cond_t;
 372       attr : access pthread_condattr_t) return int;
 373    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 374
 375    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 376    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 377
 378    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 379    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 380
 381    function pthread_cond_wait
 382      (cond  : access pthread_cond_t;
 383       mutex : access pthread_mutex_t) return int;
 384    --  FSU_THREADS has a nonstandard pthread_cond_wait
 385
 386    function pthread_cond_timedwait
 387      (cond    : access pthread_cond_t;
 388       mutex   : access pthread_mutex_t;
 389       abstime : access timespec) return int;
 390    --  FSU_THREADS has a nonstandard pthread_cond_timedwait
 391
 392    Relative_Timed_Wait : constant Boolean := False;
 393    --  pthread_cond_timedwait requires an absolute delay time
 394
 395    --------------------------
 396    -- POSIX.1c  Section 13 --
 397    --------------------------
 398
 399    PTHREAD_PRIO_NONE    : constant := 0;
 400    PTHREAD_PRIO_PROTECT : constant := 2;
 401    PTHREAD_PRIO_INHERIT : constant := 1;
 402
 403    function pthread_mutexattr_setprotocol
 404      (attr     : access pthread_mutexattr_t;
 405       protocol : int) return int;
 406    pragma Import (C, pthread_mutexattr_setprotocol);
 407
 408    function pthread_mutexattr_setprioceiling
 409      (attr        : access pthread_mutexattr_t;
 410       prioceiling : int) return int;
 411    pragma Import
 412      (C, pthread_mutexattr_setprioceiling,
 413          "pthread_mutexattr_setprio_ceiling");
 414
 415    type struct_sched_param is record
 416       sched_priority : int;  --  scheduling priority
 417    end record;
 418
 419    function pthread_setschedparam
 420      (thread : pthread_t;
 421       policy : int;
 422       param  : access struct_sched_param) return int;
 423    --  FSU_THREADS does not have pthread_setschedparam
 424
 425    function pthread_attr_setscope
 426      (attr            : access pthread_attr_t;
 427       contentionscope : int) return int;
 428    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 429
 430    function pthread_attr_setinheritsched
 431      (attr         : access pthread_attr_t;
 432       inheritsched : int) return int;
 433    pragma Import (C, pthread_attr_setinheritsched);
 434
 435    function pthread_attr_setschedpolicy
 436      (attr   : access pthread_attr_t;
 437       policy : int) return int;
 438    pragma Import (C, pthread_attr_setschedpolicy, "pthread_attr_setsched");
 439
 440    function sched_yield return int;
 441    --  FSU_THREADS does not have sched_yield;
 442
 443    ---------------------------
 444    -- P1003.1c - Section 16 --
 445    ---------------------------
 446
 447    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 448    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 449
 450    function pthread_attr_destroy
 451      (attributes : access pthread_attr_t) return int;
 452    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 453
 454    function pthread_attr_setdetachstate
 455      (attr        : access pthread_attr_t;
 456       detachstate : int) return int;
 457    --  FSU_THREADS has a nonstandard pthread_attr_setdetachstate
 458
 459    function pthread_attr_setstacksize
 460      (attr      : access pthread_attr_t;
 461       stacksize : size_t) return int;
 462    pragma Import (C, pthread_attr_setstacksize);
 463
 464    function pthread_create
 465      (thread        : access pthread_t;
 466       attributes    : access pthread_attr_t;
 467       start_routine : Thread_Body;
 468       arg           : System.Address) return int;
 469    pragma Import (C, pthread_create, "pthread_create");
 470
 471    procedure pthread_exit (status : System.Address);
 472    pragma Import (C, pthread_exit, "pthread_exit");
 473
 474    function pthread_self return pthread_t;
 475    pragma Import (C, pthread_self, "pthread_self");
 476
 477    --------------------------
 478    -- POSIX.1c  Section 17 --
 479    --------------------------
 480
 481    function pthread_setspecific
 482      (key   : pthread_key_t;
 483       value : System.Address) return int;
 484    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 485
 486    function pthread_getspecific (key : pthread_key_t) return System.Address;
 487    --  FSU_THREADS has a nonstandard pthread_getspecific
 488
 489    type destructor_pointer is access procedure (arg : System.Address);
 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 sigset_t is record
 499       losigs : unsigned_long;
 500       hisigs : unsigned_long;
 501    end record;
 502    pragma Convention (C_Pass_By_Copy, sigset_t);
 503
 504    type pid_t is new int;
 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 struct_timeval is record
 518       tv_sec  : long;
 519       tv_usec : long;
 520    end record;
 521    pragma Convention (C, struct_timeval);
 522
 523    type pthread_attr_t is record
 524       flags           : int;
 525       stacksize       : int;
 526       contentionscope : int;
 527       inheritsched    : int;
 528       detachstate     : int;
 529       sched           : int;
 530       prio            : int;
 531       starttime       : timespec;
 532       deadline        : timespec;
 533       period          : timespec;
 534    end record;
 535    pragma Convention (C_Pass_By_Copy, pthread_attr_t);
 536
 537    type pthread_condattr_t is record
 538       flags : int;
 539    end record;
 540    pragma Convention (C, pthread_condattr_t);
 541
 542    type pthread_mutexattr_t is record
 543       flags        : int;
 544       prio_ceiling : int;
 545       protocol     : int;
 546    end record;
 547    pragma Convention (C, pthread_mutexattr_t);
 548
 549    type sigjmp_buf is array (Integer range 0 .. 63) of int;
 550
 551    type pthread_t_struct is record
 552       context    : sigjmp_buf;
 553       pbody      : sigjmp_buf;
 554       errno      : int;
 555       ret        : int;
 556       stack_base : System.Address;
 557    end record;
 558    pragma Convention (C, pthread_t_struct);
 559
 560    type pthread_t is access all pthread_t_struct;
 561
 562    type queue_t is record
 563       head : System.Address;
 564       tail : System.Address;
 565    end record;
 566    pragma Convention (C, queue_t);
 567
 568    type pthread_mutex_t is record
 569       queue        : queue_t;
 570       lock         : plain_char;
 571       owner        : System.Address;
 572       flags        : int;
 573       prio_ceiling : int;
 574       protocol     : int;
 575       prev_max_ceiling_prio  : int;
 576    end record;
 577    pragma Convention (C, pthread_mutex_t);
 578
 579    type pthread_cond_t is record
 580       queue   : queue_t;
 581       flags   : int;
 582       waiters : int;
 583       mutex   : System.Address;
 584    end record;
 585    pragma Convention (C, pthread_cond_t);
 586
 587    type pthread_key_t is new int;
 588
 589 end System.OS_Interface;