gcc/ada/52osinte.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 LynxOS (Native) 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
  49    pragma Linker_Options ("-mthreads");
  50
  51    subtype int            is Interfaces.C.int;
  52    subtype char           is Interfaces.C.char;
  53    subtype short          is Interfaces.C.short;
  54    subtype long           is Interfaces.C.long;
  55    subtype unsigned       is Interfaces.C.unsigned;
  56    subtype unsigned_short is Interfaces.C.unsigned_short;
  57    subtype unsigned_long  is Interfaces.C.unsigned_long;
  58    subtype unsigned_char  is Interfaces.C.unsigned_char;
  59    subtype plain_char     is Interfaces.C.plain_char;
  60    subtype size_t         is Interfaces.C.size_t;
  61
  62    -----------
  63    -- Errno --
  64    -----------
  65
  66    function errno return int;
  67    pragma Import (C, errno, "__get_errno");
  68
  69    EAGAIN    : constant := 11;
  70    EINTR     : constant := 4;
  71    EINVAL    : constant := 22;
  72    ENOMEM    : constant := 12;
  73    ETIMEDOUT : constant := 60;
  74
  75    -------------
  76    -- Signals --
  77    -------------
  78
  79    Max_Interrupt : constant := 63;
  80    type Signal is new int range 0 .. Max_Interrupt;
  81    for Signal'Size use int'Size;
  82
  83    SIGHUP      : constant := 1; --  hangup
  84    SIGINT      : constant := 2; --  interrupt (rubout)
  85    SIGQUIT     : constant := 3; --  quit (ASCD FS)
  86    SIGILL      : constant := 4; --  illegal instruction (not reset)
  87    SIGTRAP     : constant := 5; --  trace trap (not reset)
  88    SIGBRK      : constant := 6; --  break
  89    SIGIOT      : constant := 6; --  IOT instruction
  90    SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
  91    SIGCORE     : constant := 7; --  kill with core dump
  92    SIGEMT      : constant := 7; --  EMT instruction
  93    SIGFPE      : constant := 8; --  floating point exception
  94    SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
  95    SIGBUS      : constant := 10; --  bus error
  96    SIGSEGV     : constant := 11; --  segmentation violation
  97    SIGSYS      : constant := 12; --  bad argument to system call
  98    SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
  99    SIGALRM     : constant := 14; --  alarm clock
 100    SIGTERM     : constant := 15; --  software termination signal from kill
 101    SIGURG      : constant := 16; --  urgent condition on IO channel
 102    SIGSTOP     : constant := 17; --  stop (cannot be caught or ignored)
 103    SIGTSTP     : constant := 18; --  user stop requested from tty
 104    SIGCONT     : constant := 19; --  stopped process has been continued
 105    SIGCLD      : constant := 20; --  alias for SIGCHLD
 106    SIGCHLD     : constant := 20; --  child status change
 107    SIGTTIN     : constant := 21; --  background tty read attempted
 108    SIGTTOU     : constant := 22; --  background tty write attempted
 109    SIGIO       : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
 110    SIGPOLL     : constant := 23; --  pollable event occurred
 111    SIGXCPU     : constant := 24; --  CPU time limit exceeded
 112    SIGXFSZ     : constant := 25; --  filesize limit exceeded
 113    SIGVTALRM   : constant := 26; --  virtual timer expired
 114    SIGPROF     : constant := 27; --  profiling timer expired
 115    SIGWINCH    : constant := 28; --  window size change
 116    SIGLOST     : constant := 29; --  SUN 4.1 compatibility
 117    SIGUSR1     : constant := 30; --  user defined signal 1
 118    SIGUSR2     : constant := 31; --  user defined signal 2
 119    SIGPRIO     : constant := 32; --  sent to a process with its priority or
 120                                  --  group is changed
 121
 122    SIGADAABORT : constant := SIGABRT;
 123    --  Change this if you want to use another signal for task abort.
 124    --  SIGTERM might be a good one.
 125
 126    type Signal_Set is array (Natural range <>) of Signal;
 127
 128    Unmasked    : constant Signal_Set :=
 129      (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
 130    Reserved    : constant Signal_Set := (SIGABRT, SIGKILL, SIGSTOP, SIGPRIO);
 131
 132    type sigset_t is private;
 133
 134    function sigaddset (set : access sigset_t; sig : Signal) return int;
 135    pragma Import (C, sigaddset, "sigaddset");
 136
 137    function sigdelset (set : access sigset_t; sig : Signal) return int;
 138    pragma Import (C, sigdelset, "sigdelset");
 139
 140    function sigfillset (set : access sigset_t) return int;
 141    pragma Import (C, sigfillset, "sigfillset");
 142
 143    function sigismember (set : access sigset_t; sig : Signal) return int;
 144    pragma Import (C, sigismember, "sigismember");
 145
 146    function sigemptyset (set : access sigset_t) return int;
 147    pragma Import (C, sigemptyset, "sigemptyset");
 148
 149    type struct_sigaction is record
 150       sa_handler : System.Address;
 151       sa_mask    : sigset_t;
 152       sa_flags   : int;
 153    end record;
 154    pragma Convention (C, struct_sigaction);
 155    type struct_sigaction_ptr is access all struct_sigaction;
 156
 157    SA_SIGINFO  : constant := 16#80#;
 158
 159    SIG_BLOCK   : constant := 0;
 160    SIG_UNBLOCK : constant := 1;
 161    SIG_SETMASK : constant := 2;
 162
 163    SIG_DFL : constant := 0;
 164    SIG_IGN : constant := 1;
 165
 166    function sigaction
 167      (sig  : Signal;
 168       act  : struct_sigaction_ptr;
 169       oact : struct_sigaction_ptr) return int;
 170    pragma Import (C, sigaction, "sigaction");
 171
 172    ----------
 173    -- Time --
 174    ----------
 175
 176    Time_Slice_Supported : constant Boolean := True;
 177    --  Indicates wether time slicing is supported
 178
 179    type timespec is private;
 180
 181    type clockid_t is private;
 182
 183    CLOCK_REALTIME : constant clockid_t;
 184
 185    function clock_gettime
 186      (clock_id : clockid_t;
 187       tp       : access timespec) return int;
 188    pragma Inline (clock_gettime);
 189    --  LynxOS has non standard clock_gettime
 190
 191    function To_Duration (TS : timespec) return Duration;
 192    pragma Inline (To_Duration);
 193
 194    function To_Timespec (D : Duration) return timespec;
 195    pragma Inline (To_Timespec);
 196
 197    type struct_timezone is record
 198       tz_minuteswest : int;
 199       tz_dsttime     : int;
 200    end record;
 201    pragma Convention (C, struct_timezone);
 202    type struct_timezone_ptr is access all struct_timezone;
 203
 204    type struct_timeval is private;
 205    --  This is needed on systems that do not have clock_gettime()
 206    --  but do have gettimeofday().
 207
 208    function To_Duration (TV : struct_timeval) return Duration;
 209    pragma Inline (To_Duration);
 210
 211    function To_Timeval (D : Duration) return struct_timeval;
 212    pragma Inline (To_Timeval);
 213
 214    -------------------------
 215    -- Priority Scheduling --
 216    -------------------------
 217
 218    SCHED_FIFO  : constant := 16#00200000#;
 219    SCHED_RR    : constant := 16#00100000#;
 220    SCHED_OTHER : constant := 16#00400000#;
 221
 222    -------------
 223    -- Process --
 224    -------------
 225
 226    type pid_t is private;
 227
 228    function kill (pid : pid_t; sig : Signal) return int;
 229    pragma Import (C, kill, "kill");
 230
 231    function getpid return pid_t;
 232    pragma Import (C, getpid, "getpid");
 233
 234    ---------
 235    -- LWP --
 236    ---------
 237
 238    function lwp_self return System.Address;
 239    --  lwp_self does not exist on this thread library, revert to pthread_self
 240    --  which is the closest approximation (with getpid). This function is
 241    --  needed to share 7staprop.adb across POSIX-like targets.
 242    pragma Import (C, lwp_self, "pthread_self");
 243
 244    -------------
 245    -- Threads --
 246    -------------
 247
 248    type Thread_Body is access
 249      function (arg : System.Address) return System.Address;
 250
 251    function Thread_Body_Access is new
 252      Unchecked_Conversion (System.Address, Thread_Body);
 253
 254    type pthread_t           is private;
 255    subtype Thread_Id        is pthread_t;
 256
 257    type pthread_mutex_t     is limited private;
 258    type pthread_cond_t      is limited private;
 259    type st_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 := 0;
 266
 267    -----------
 268    -- Stack --
 269    -----------
 270
 271    Stack_Base_Available : constant Boolean := False;
 272    --  Indicates wether the stack base is available on this target.
 273
 274    function Get_Stack_Base (thread : pthread_t) return Address;
 275    pragma Inline (Get_Stack_Base);
 276    --  returns the stack base of the specified thread.
 277    --  Only call this function when Stack_Base_Available is True.
 278
 279    function Get_Page_Size return size_t;
 280    function Get_Page_Size return Address;
 281    pragma Import (C, Get_Page_Size, "getpagesize");
 282    --  returns the size of a page, or 0 if this is not relevant on this
 283    --  target
 284
 285    PROT_NONE  : constant := 0;
 286    PROT_READ  : constant := 1;
 287    PROT_WRITE : constant := 2;
 288    PROT_EXEC  : constant := 4;
 289    PROT_USER  : constant := 8;
 290    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC + PROT_USER;
 291
 292    PROT_ON    : constant := PROT_READ;
 293    PROT_OFF   : constant := PROT_ALL;
 294
 295    function mprotect (addr : Address; len : size_t; prot : int) return int;
 296    pragma Import (C, mprotect);
 297
 298    -------------------------
 299    -- POSIX.1c  Section 3 --
 300    -------------------------
 301
 302    function sigwait
 303      (set : access sigset_t;
 304       sig : access Signal) return int;
 305    pragma Inline (sigwait);
 306    --  LynxOS has non standard sigwait
 307
 308    function pthread_kill (thread : pthread_t; sig : Signal) return int;
 309    pragma Import (C, pthread_kill, "pthread_kill");
 310
 311    type sigset_t_ptr is access all sigset_t;
 312
 313    function pthread_sigmask
 314      (how  : int;
 315       set  : sigset_t_ptr;
 316       oset : sigset_t_ptr) return int;
 317    pragma Import (C, pthread_sigmask, "sigprocmask");
 318
 319    --------------------------
 320    -- POSIX.1c  Section 11 --
 321    --------------------------
 322
 323    function pthread_mutexattr_init
 324      (attr : access pthread_mutexattr_t) return int;
 325    pragma Inline (pthread_mutexattr_init);
 326    --  LynxOS has a nonstandard pthread_mutexattr_init
 327
 328    function pthread_mutexattr_destroy
 329      (attr : access pthread_mutexattr_t) return int;
 330    pragma Inline (pthread_mutexattr_destroy);
 331    --  Lynxos has a nonstandard pthread_mutexattr_destroy
 332
 333    function pthread_mutex_init
 334      (mutex : access pthread_mutex_t;
 335       attr  : access pthread_mutexattr_t) return int;
 336    pragma Inline (pthread_mutex_init);
 337    --  LynxOS has a nonstandard pthread_mutex_init
 338
 339    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 340    pragma Inline (pthread_mutex_destroy);
 341    --  LynxOS has a nonstandard pthread_mutex_destroy
 342
 343    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 344    pragma Inline (pthread_mutex_lock);
 345    --  LynxOS has a nonstandard pthread_mutex_lock
 346
 347    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 348    pragma Inline (pthread_mutex_unlock);
 349    --  LynxOS has a nonstandard pthread_mutex_unlock
 350
 351    function pthread_condattr_init
 352      (attr : access pthread_condattr_t) return int;
 353    pragma Inline (pthread_condattr_init);
 354    --  LynxOS has a nonstandard pthread_condattr_init
 355
 356    function pthread_condattr_destroy
 357      (attr : access pthread_condattr_t) return int;
 358    pragma Inline (pthread_condattr_destroy);
 359    --  LynxOS has a nonstandard pthread_condattr_destroy
 360
 361    function pthread_cond_init
 362      (cond : access pthread_cond_t;
 363       attr : access pthread_condattr_t) return int;
 364    pragma Inline (pthread_cond_init);
 365    --  LynxOS has a non standard pthread_cond_init
 366
 367    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 368    pragma Inline (pthread_cond_destroy);
 369    --  LynxOS has a nonstandard pthread_cond_destroy
 370
 371    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 372    pragma Inline (pthread_cond_signal);
 373    --  LynxOS has a nonstandard pthread_cond_signal
 374
 375    function pthread_cond_wait
 376      (cond  : access pthread_cond_t;
 377       mutex : access pthread_mutex_t) return int;
 378    pragma Inline (pthread_cond_wait);
 379    --  LynxOS has a nonstandard pthread_cond_wait
 380
 381    function pthread_cond_timedwait
 382      (cond    : access pthread_cond_t;
 383       mutex   : access pthread_mutex_t;
 384       reltime : access timespec) return int;
 385    pragma Inline (pthread_cond_timedwait);
 386    --  LynxOS has a nonstandard pthrad_cond_timedwait
 387
 388    Relative_Timed_Wait : constant Boolean := True;
 389    --  pthread_cond_timedwait requires a relative delay time
 390
 391    --------------------------
 392    -- POSIX.1c  Section 13 --
 393    --------------------------
 394
 395    PTHREAD_PRIO_NONE    : constant := 0;
 396    PTHREAD_PRIO_INHERIT : constant := 0;
 397    PTHREAD_PRIO_PROTECT : constant := 0;
 398
 399    type struct_sched_param is record
 400       sched_priority : int;  --  scheduling priority
 401    end record;
 402
 403    function pthread_setschedparam
 404      (thread : pthread_t;
 405       policy : int;
 406       param  : access struct_sched_param) return int;
 407    pragma Inline (pthread_setschedparam);
 408    --  LynxOS doesn't have pthread_setschedparam.
 409    --  Instead, use pthread_setscheduler
 410
 411    function pthread_mutexattr_setprotocol
 412      (attr     : access pthread_mutexattr_t;
 413       protocol : int) return int;
 414    pragma Inline (pthread_mutexattr_setprotocol);
 415    --  LynxOS doesn't have pthread_mutexattr_setprotocol
 416
 417    function pthread_mutexattr_setprioceiling
 418      (attr     : access pthread_mutexattr_t;
 419       prioceiling : int) return int;
 420    pragma Inline (pthread_mutexattr_setprioceiling);
 421    --  LynxOS doesn't have pthread_mutexattr_setprioceiling
 422
 423    function pthread_attr_setscope
 424      (attr            : access pthread_attr_t;
 425       contentionscope : int) return int;
 426    --  LynxOS doesn't have pthread_attr_setscope: all threads have system scope
 427    pragma Inline (pthread_attr_setscope);
 428
 429    function pthread_attr_setschedpolicy
 430      (attr   : access pthread_attr_t;
 431       policy : int) return int;
 432    pragma Import (C, pthread_attr_setschedpolicy, "pthread_attr_setsched");
 433
 434    function sched_yield return int;
 435    --   pragma Import (C, sched_yield, "sched_yield");
 436    pragma Inline (sched_yield);
 437
 438    ---------------------------
 439    -- P1003.1c - Section 16 --
 440    ---------------------------
 441
 442    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 443    pragma Import (C, pthread_attr_init, "pthread_attr_create");
 444
 445    function pthread_attr_destroy
 446      (attributes : access pthread_attr_t) return int;
 447    pragma Import (C, pthread_attr_destroy, "pthread_attr_delete");
 448
 449    function pthread_attr_setdetachstate
 450      (attr        : access pthread_attr_t;
 451       detachstate : int) return int;
 452    pragma Inline (pthread_attr_setdetachstate);
 453    --  LynxOS doesn't have pthread_attr_setdetachstate
 454
 455    function pthread_attr_setstacksize
 456      (attr      : access pthread_attr_t;
 457       stacksize : size_t) return int;
 458    pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
 459
 460    function pthread_create
 461      (thread        : access pthread_t;
 462       attributes    : access pthread_attr_t;
 463       start_routine : Thread_Body;
 464       arg           : System.Address) return int;
 465    pragma Inline (pthread_create);
 466    --  LynxOS has a non standard pthread_create
 467
 468    function pthread_detach (thread : pthread_t) return int;
 469    pragma Inline (pthread_detach);
 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 Inline (pthread_setspecific);
 485    --  LynxOS has a non standard pthread_setspecific
 486
 487    function pthread_getspecific (key : pthread_key_t) return System.Address;
 488    pragma Inline (pthread_getspecific);
 489    --  LynxOS has a non standard pthread_getspecific
 490
 491    type destructor_pointer is access procedure (arg : System.Address);
 492
 493    function pthread_key_create
 494      (key        : access pthread_key_t;
 495       destructor : destructor_pointer) return int;
 496    pragma Inline (pthread_key_create);
 497    --  LynxOS has a non standard pthread_keycreate
 498
 499    procedure pthread_init;
 500    --  This is a dummy procedure to share some GNULLI files
 501
 502 private
 503
 504    type sigbit_array is array (1 .. 2) of long;
 505    type sigset_t is record
 506       sa_sigbits : sigbit_array;
 507    end record;
 508    pragma Convention (C_Pass_By_Copy, sigset_t);
 509
 510    type pid_t is new long;
 511
 512    type time_t is new long;
 513
 514    type timespec is record
 515       tv_sec  : time_t;
 516       tv_nsec : long;
 517    end record;
 518    pragma Convention (C, timespec);
 519
 520    type clockid_t is new unsigned_char;
 521    CLOCK_REALTIME : constant clockid_t := 0;
 522
 523    type struct_timeval is record
 524       tv_sec  : time_t;
 525       tv_usec : time_t;
 526    end record;
 527    pragma Convention (C, struct_timeval);
 528
 529    type st_t is record
 530       stksize      : int;
 531       prio         : int;
 532       inheritsched : int;
 533       state        : int;
 534       sched        : int;
 535    end record;
 536    pragma Convention (C, st_t);
 537
 538    type pthread_attr_t is record
 539       st                 : st_t;
 540       pthread_attr_scope : int;  --  ignored
 541    end record;
 542    pragma Convention (C, pthread_attr_t);
 543
 544    type pthread_condattr_t is new int;
 545
 546    type pthread_mutexattr_t is new int;
 547
 548    type tid_t is new short;
 549    type pthread_t is new tid_t;
 550
 551    type synch_ptr is access all pthread_mutex_t;
 552    type pthread_mutex_t is record
 553       w_count   : int;
 554       mut_owner : int;
 555       id        : unsigned;
 556       next      : synch_ptr;
 557    end record;
 558    pragma Convention (C, pthread_mutex_t);
 559
 560    type pthread_cond_t is new pthread_mutex_t;
 561
 562    type pthread_key_t is new int;
 563
 564 end System.OS_Interface;