gcc/ada/s-osinte-lynxos-3.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-2006, 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 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    function To_Target_Priority
 223      (Prio : System.Any_Priority) return Interfaces.C.int;
 224    --  Maps System.Any_Priority to a POSIX priority.
 225
 226    -------------
 227    -- Process --
 228    -------------
 229
 230    type pid_t is private;
 231
 232    function kill (pid : pid_t; sig : Signal) return int;
 233    pragma Import (C, kill, "kill");
 234
 235    function getpid return pid_t;
 236    pragma Import (C, getpid, "getpid");
 237
 238    ---------
 239    -- LWP --
 240    ---------
 241
 242    function lwp_self return System.Address;
 243    --  lwp_self does not exist on this thread library, revert to pthread_self
 244    --  which is the closest approximation (with getpid). This function is
 245    --  needed to share 7staprop.adb across POSIX-like targets.
 246    pragma Import (C, lwp_self, "pthread_self");
 247
 248    -------------
 249    -- Threads --
 250    -------------
 251
 252    type Thread_Body is access
 253      function (arg : System.Address) return System.Address;
 254
 255    function Thread_Body_Access is new
 256      Unchecked_Conversion (System.Address, Thread_Body);
 257
 258    type pthread_t           is private;
 259    subtype Thread_Id        is pthread_t;
 260
 261    type pthread_mutex_t     is limited private;
 262    type pthread_cond_t      is limited private;
 263    type st_t                is limited private;
 264    type pthread_attr_t      is limited private;
 265    type pthread_mutexattr_t is limited private;
 266    type pthread_condattr_t  is limited private;
 267    type pthread_key_t       is private;
 268
 269    PTHREAD_CREATE_DETACHED : constant := 0;
 270
 271    -----------
 272    -- Stack --
 273    -----------
 274
 275    Stack_Base_Available : constant Boolean := False;
 276    --  Indicates wether the stack base is available on this target.
 277
 278    function Get_Stack_Base (thread : pthread_t) return Address;
 279    pragma Inline (Get_Stack_Base);
 280    --  returns the stack base of the specified thread.
 281    --  Only call this function when Stack_Base_Available is True.
 282
 283    function Get_Page_Size return size_t;
 284    function Get_Page_Size return Address;
 285    pragma Import (C, Get_Page_Size, "getpagesize");
 286    --  returns the size of a page, or 0 if this is not relevant on this
 287    --  target
 288
 289    PROT_NONE  : constant := 0;
 290    PROT_READ  : constant := 1;
 291    PROT_WRITE : constant := 2;
 292    PROT_EXEC  : constant := 4;
 293    PROT_USER  : constant := 8;
 294    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC + PROT_USER;
 295
 296    PROT_ON    : constant := PROT_READ;
 297    PROT_OFF   : constant := PROT_ALL;
 298
 299    function mprotect (addr : Address; len : size_t; prot : int) return int;
 300    pragma Import (C, mprotect);
 301
 302    -------------------------
 303    -- POSIX.1c  Section 3 --
 304    -------------------------
 305
 306    function sigwait
 307      (set : access sigset_t;
 308       sig : access Signal) return int;
 309    pragma Inline (sigwait);
 310    --  LynxOS has non standard sigwait
 311
 312    function pthread_kill (thread : pthread_t; sig : Signal) return int;
 313    pragma Import (C, pthread_kill, "pthread_kill");
 314
 315    function pthread_sigmask
 316      (how  : int;
 317       set  : access sigset_t;
 318       oset : access sigset_t) return int;
 319    pragma Import (C, pthread_sigmask, "sigprocmask");
 320
 321    --------------------------
 322    -- POSIX.1c  Section 11 --
 323    --------------------------
 324
 325    function pthread_mutexattr_init
 326      (attr : access pthread_mutexattr_t) return int;
 327    pragma Inline (pthread_mutexattr_init);
 328    --  LynxOS has a nonstandard pthread_mutexattr_init
 329
 330    function pthread_mutexattr_destroy
 331      (attr : access pthread_mutexattr_t) return int;
 332    pragma Inline (pthread_mutexattr_destroy);
 333    --  Lynxos has a nonstandard pthread_mutexattr_destroy
 334
 335    function pthread_mutex_init
 336      (mutex : access pthread_mutex_t;
 337       attr  : access pthread_mutexattr_t) return int;
 338    pragma Inline (pthread_mutex_init);
 339    --  LynxOS has a nonstandard pthread_mutex_init
 340
 341    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 342    pragma Inline (pthread_mutex_destroy);
 343    --  LynxOS has a nonstandard pthread_mutex_destroy
 344
 345    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 346    pragma Inline (pthread_mutex_lock);
 347    --  LynxOS has a nonstandard pthread_mutex_lock
 348
 349    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 350    pragma Inline (pthread_mutex_unlock);
 351    --  LynxOS has a nonstandard pthread_mutex_unlock
 352
 353    function pthread_condattr_init
 354      (attr : access pthread_condattr_t) return int;
 355    pragma Inline (pthread_condattr_init);
 356    --  LynxOS has a nonstandard pthread_condattr_init
 357
 358    function pthread_condattr_destroy
 359      (attr : access pthread_condattr_t) return int;
 360    pragma Inline (pthread_condattr_destroy);
 361    --  LynxOS has a nonstandard pthread_condattr_destroy
 362
 363    function pthread_cond_init
 364      (cond : access pthread_cond_t;
 365       attr : access pthread_condattr_t) return int;
 366    pragma Inline (pthread_cond_init);
 367    --  LynxOS has a non standard pthread_cond_init
 368
 369    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 370    pragma Inline (pthread_cond_destroy);
 371    --  LynxOS has a nonstandard pthread_cond_destroy
 372
 373    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 374    pragma Inline (pthread_cond_signal);
 375    --  LynxOS has a nonstandard pthread_cond_signal
 376
 377    function pthread_cond_wait
 378      (cond  : access pthread_cond_t;
 379       mutex : access pthread_mutex_t) return int;
 380    pragma Inline (pthread_cond_wait);
 381    --  LynxOS has a nonstandard pthread_cond_wait
 382
 383    function pthread_cond_timedwait
 384      (cond    : access pthread_cond_t;
 385       mutex   : access pthread_mutex_t;
 386       reltime : access timespec) return int;
 387    pragma Inline (pthread_cond_timedwait);
 388    --  LynxOS has a nonstandard pthrad_cond_timedwait
 389
 390    Relative_Timed_Wait : constant Boolean := True;
 391    --  pthread_cond_timedwait requires a relative delay time
 392
 393    --------------------------
 394    -- POSIX.1c  Section 13 --
 395    --------------------------
 396
 397    PTHREAD_PRIO_NONE    : constant := 0;
 398    PTHREAD_PRIO_INHERIT : constant := 0;
 399    PTHREAD_PRIO_PROTECT : constant := 0;
 400
 401    type struct_sched_param is record
 402       sched_priority : int;  --  scheduling priority
 403    end record;
 404
 405    function pthread_setschedparam
 406      (thread : pthread_t;
 407       policy : int;
 408       param  : access struct_sched_param) return int;
 409    pragma Inline (pthread_setschedparam);
 410    --  LynxOS doesn't have pthread_setschedparam.
 411    --  Instead, use pthread_setscheduler
 412
 413    function pthread_mutexattr_setprotocol
 414      (attr     : access pthread_mutexattr_t;
 415       protocol : int) return int;
 416    pragma Inline (pthread_mutexattr_setprotocol);
 417    --  LynxOS doesn't have pthread_mutexattr_setprotocol
 418
 419    function pthread_mutexattr_setprioceiling
 420      (attr     : access pthread_mutexattr_t;
 421       prioceiling : int) return int;
 422    pragma Inline (pthread_mutexattr_setprioceiling);
 423    --  LynxOS doesn't have pthread_mutexattr_setprioceiling
 424
 425    function pthread_attr_setscope
 426      (attr            : access pthread_attr_t;
 427       contentionscope : int) return int;
 428    --  LynxOS doesn't have pthread_attr_setscope: all threads have system scope
 429    pragma Inline (pthread_attr_setscope);
 430
 431    function pthread_attr_setschedpolicy
 432      (attr   : access pthread_attr_t;
 433       policy : int) return int;
 434    pragma Import (C, pthread_attr_setschedpolicy, "pthread_attr_setsched");
 435
 436    function sched_yield return int;
 437    --   pragma Import (C, sched_yield, "sched_yield");
 438    pragma Inline (sched_yield);
 439
 440    ---------------------------
 441    -- P1003.1c - Section 16 --
 442    ---------------------------
 443
 444    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 445    pragma Import (C, pthread_attr_init, "pthread_attr_create");
 446
 447    function pthread_attr_destroy
 448      (attributes : access pthread_attr_t) return int;
 449    pragma Import (C, pthread_attr_destroy, "pthread_attr_delete");
 450
 451    function pthread_attr_setdetachstate
 452      (attr        : access pthread_attr_t;
 453       detachstate : int) return int;
 454    pragma Inline (pthread_attr_setdetachstate);
 455    --  LynxOS doesn't have pthread_attr_setdetachstate
 456
 457    function pthread_attr_setstacksize
 458      (attr      : access pthread_attr_t;
 459       stacksize : size_t) return int;
 460    pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
 461
 462    function pthread_create
 463      (thread        : access pthread_t;
 464       attributes    : access pthread_attr_t;
 465       start_routine : Thread_Body;
 466       arg           : System.Address) return int;
 467    pragma Inline (pthread_create);
 468    --  LynxOS has a non standard pthread_create
 469
 470    function pthread_detach (thread : pthread_t) return int;
 471    pragma Inline (pthread_detach);
 472
 473    procedure pthread_exit (status : System.Address);
 474    pragma Import (C, pthread_exit, "pthread_exit");
 475
 476    function pthread_self return pthread_t;
 477    pragma Import (C, pthread_self, "pthread_self");
 478
 479    --------------------------
 480    -- POSIX.1c  Section 17 --
 481    --------------------------
 482
 483    function pthread_setspecific
 484      (key   : pthread_key_t;
 485       value : System.Address) return int;
 486    pragma Inline (pthread_setspecific);
 487    --  LynxOS has a non standard pthread_setspecific
 488
 489    function pthread_getspecific (key : pthread_key_t) return System.Address;
 490    pragma Inline (pthread_getspecific);
 491    --  LynxOS has a non standard pthread_getspecific
 492
 493    type destructor_pointer is access procedure (arg : System.Address);
 494
 495    function pthread_key_create
 496      (key        : access pthread_key_t;
 497       destructor : destructor_pointer) return int;
 498    pragma Inline (pthread_key_create);
 499    --  LynxOS has a non standard pthread_keycreate
 500
 501    procedure pthread_init;
 502    --  This is a dummy procedure to share some GNULLI files
 503
 504 private
 505
 506    type sigbit_array is array (1 .. 2) of long;
 507    type sigset_t is record
 508       sa_sigbits : sigbit_array;
 509    end record;
 510    pragma Convention (C_Pass_By_Copy, sigset_t);
 511
 512    type pid_t is new long;
 513
 514    type time_t is new long;
 515
 516    type timespec is record
 517       tv_sec  : time_t;
 518       tv_nsec : long;
 519    end record;
 520    pragma Convention (C, timespec);
 521
 522    type clockid_t is new unsigned_char;
 523    CLOCK_REALTIME : constant clockid_t := 0;
 524
 525    type struct_timeval is record
 526       tv_sec  : time_t;
 527       tv_usec : time_t;
 528    end record;
 529    pragma Convention (C, struct_timeval);
 530
 531    type st_t is record
 532       stksize      : int;
 533       prio         : int;
 534       inheritsched : int;
 535       state        : int;
 536       sched        : int;
 537    end record;
 538    pragma Convention (C, st_t);
 539
 540    type pthread_attr_t is record
 541       st                 : st_t;
 542       pthread_attr_scope : int;  --  ignored
 543    end record;
 544    pragma Convention (C, pthread_attr_t);
 545
 546    type pthread_condattr_t is new int;
 547
 548    type pthread_mutexattr_t is new int;
 549
 550    type tid_t is new short;
 551    type pthread_t is new tid_t;
 552
 553    type synch_ptr is access all pthread_mutex_t;
 554    type pthread_mutex_t is record
 555       w_count   : int;
 556       mut_owner : int;
 557       id        : unsigned;
 558       next      : synch_ptr;
 559    end record;
 560    pragma Convention (C, pthread_mutex_t);
 561
 562    type pthread_cond_t is new pthread_mutex_t;
 563
 564    type pthread_key_t is new int;
 565
 566 end System.OS_Interface;