gcc/ada/51osinte.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 --                                                                          --
  10 --          Copyright (C) 1999-2001 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. It is --
  31 -- now maintained by Ada Core Technologies Inc. in cooperation with Florida --
  32 -- State University (http://www.gnat.com).                                  --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  This is a UnixWare (Native THREADS) version of this package.
  37
  38 --  This package encapsulates all direct interfaces to OS services
  39 --  that are needed by children of System.
  40
  41 --  PLEASE DO NOT add any with-clauses to this package
  42 --  or remove the pragma Elaborate_Body.
  43 --  It is designed to be a bottom-level (leaf) package.
  44
  45 with Interfaces.C;
  46 package System.OS_Interface is
  47    pragma Preelaborate;
  48
  49    pragma Linker_Options ("-lthread");
  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 := 145;
  74
  75    -------------
  76    -- Signals --
  77    -------------
  78
  79    Max_Interrupt : constant := 34;
  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    SIGIOT      : constant := 6; --  IOT instruction
  89    SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
  90    SIGEMT      : constant := 7; --  EMT instruction
  91    SIGFPE      : constant := 8; --  floating point exception
  92    SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
  93    SIGBUS      : constant := 10; --  bus error
  94    SIGSEGV     : constant := 11; --  segmentation violation
  95    SIGSYS      : constant := 12; --  bad argument to system call
  96    SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
  97    SIGALRM     : constant := 14; --  alarm clock
  98    SIGTERM     : constant := 15; --  software termination signal from kill
  99    SIGUSR1     : constant := 16; --  user defined signal 1
 100    SIGUSR2     : constant := 17; --  user defined signal 2
 101    SIGCLD      : constant := 18; --  alias for SIGCHLD
 102    SIGCHLD     : constant := 18; --  child status change
 103    SIGPWR      : constant := 19; --  power-fail restart
 104    SIGWINCH    : constant := 20; --  window size change
 105    SIGURG      : constant := 21; --  urgent condition on IO channel
 106    SIGPOLL     : constant := 22; --  pollable event occurred
 107    SIGIO       : constant := 22; --  I/O possible (Solaris SIGPOLL alias)
 108    SIGSTOP     : constant := 23; --  stop (cannot be caught or ignored)
 109    SIGTSTP     : constant := 24; --  user stop requested from tty
 110    SIGCONT     : constant := 25; --  stopped process has been continued
 111    SIGTTIN     : constant := 26; --  background tty read attempted
 112    SIGTTOU     : constant := 27; --  background tty write attempted
 113    SIGVTALRM   : constant := 28; --  virtual timer expired
 114    SIGPROF     : constant := 29; --  profiling timer expired
 115    SIGXCPU     : constant := 30; --  CPU time limit exceeded
 116    SIGXFSZ     : constant := 31; --  filesize limit exceeded
 117    SIGWAITING  : constant := 32; --  all LWPs blocked interruptibly notific.
 118    SIGLWP      : constant := 33; --  signal reserved for thread lib impl.
 119    SIGAIO      : constant := 34; --  Asynchronous I/O signal
 120
 121    SIGADAABORT : constant := SIGABRT;
 122    --  Change this if you want to use another signal for task abort.
 123    --  SIGTERM might be a good one.
 124
 125    type Signal_Set is array (Natural range <>) of Signal;
 126
 127    Unmasked    : constant Signal_Set :=
 128      (SIGTRAP, SIGLWP, SIGWAITING, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF);
 129    Reserved    : constant Signal_Set := (SIGABRT, SIGKILL, SIGSTOP);
 130
 131    type sigset_t is private;
 132
 133    function sigaddset (set : access sigset_t; sig : Signal) return int;
 134    pragma Import (C, sigaddset, "sigaddset");
 135
 136    function sigdelset (set : access sigset_t; sig : Signal) return int;
 137    pragma Import (C, sigdelset, "sigdelset");
 138
 139    function sigfillset (set : access sigset_t) return int;
 140    pragma Import (C, sigfillset, "sigfillset");
 141
 142    function sigismember (set : access sigset_t; sig : Signal) return int;
 143    pragma Import (C, sigismember, "sigismember");
 144
 145    function sigemptyset (set : access sigset_t) return int;
 146    pragma Import (C, sigemptyset, "sigemptyset");
 147
 148    type struct_sigaction is record
 149       sa_flags   : int;
 150       sa_handler : System.Address;
 151       sa_mask    : sigset_t;
 152       sa_resv1   : int;
 153       sa_resv2   : int;
 154    end record;
 155    pragma Convention (C, struct_sigaction);
 156    type struct_sigaction_ptr is access all struct_sigaction;
 157
 158    SIG_BLOCK   : constant := 1;
 159    SIG_UNBLOCK : constant := 2;
 160    SIG_SETMASK : constant := 3;
 161
 162    SIG_DFL : constant := 0;
 163    SIG_IGN : constant := 1;
 164    --  SIG_ERR : constant := -1;
 165    --  not used
 166
 167    function sigaction
 168      (sig  : Signal;
 169       act  : struct_sigaction_ptr;
 170       oact : struct_sigaction_ptr) return int;
 171    pragma Import (C, sigaction, "sigaction");
 172
 173    ----------
 174    -- Time --
 175    ----------
 176
 177    Time_Slice_Supported : constant Boolean := False;
 178    --  Indicates wether time slicing is supported
 179
 180    type timespec is private;
 181
 182    type clockid_t is private;
 183
 184    CLOCK_REALTIME : constant clockid_t;
 185
 186    function clock_gettime
 187      (clock_id : clockid_t;
 188       tp       : access timespec) return int;
 189    --  UnixWare threads don't have clock_gettime
 190    --  We instead use gettimeofday()
 191
 192    function To_Duration (TS : timespec) return Duration;
 193    pragma Inline (To_Duration);
 194
 195    function To_Timespec (D : Duration) return timespec;
 196    pragma Inline (To_Timespec);
 197
 198    type struct_timezone is record
 199       tz_minuteswest : int;
 200       tz_dsttime     : int;
 201    end record;
 202    pragma Convention (C, struct_timezone);
 203    type struct_timezone_ptr is access all struct_timezone;
 204
 205    type struct_timeval is private;
 206    --  This is needed on systems that do not have clock_gettime()
 207    --  but do have gettimeofday().
 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 := 2;
 220    SCHED_RR    : constant := 3;
 221    SCHED_OTHER : constant := 1;
 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    pragma Import (C, lwp_self, "_lwp_self");
 241
 242    -------------
 243    -- Threads --
 244    -------------
 245
 246    type Thread_Body is access
 247      function (arg : System.Address) return System.Address;
 248    type pthread_t           is private;
 249    subtype Thread_Id        is pthread_t;
 250
 251    type pthread_mutex_t     is limited private;
 252    type pthread_cond_t      is limited private;
 253    type pthread_attr_t      is limited private;
 254    type pthread_mutexattr_t is limited private;
 255    type pthread_condattr_t  is limited private;
 256    type pthread_key_t       is private;
 257
 258    PTHREAD_CREATE_DETACHED : constant := 0;
 259
 260    -----------
 261    -- Stack --
 262    -----------
 263
 264    Stack_Base_Available : constant Boolean := False;
 265    --  Indicates wether the stack base is available on this target.
 266
 267    function Get_Stack_Base (thread : pthread_t) return Address;
 268    pragma Inline (Get_Stack_Base);
 269    --  returns the stack base of the specified thread.
 270    --  Only call this function when Stack_Base_Available is True.
 271
 272    function Get_Page_Size return size_t;
 273    function Get_Page_Size return Address;
 274    pragma Import (C, Get_Page_Size, "getpagesize");
 275    --  returns the size of a page, or 0 if this is not relevant on this
 276    --  target
 277
 278    PROT_NONE  : constant := 0;
 279    PROT_READ  : constant := 1;
 280    PROT_WRITE : constant := 2;
 281    PROT_EXEC  : constant := 4;
 282    PROT_USER  : constant := 8;
 283    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC + PROT_USER;
 284
 285    PROT_ON    : constant := PROT_READ;
 286    PROT_OFF   : constant := PROT_ALL;
 287
 288    function mprotect (addr : Address; len : size_t; prot : int) return int;
 289    pragma Import (C, mprotect);
 290
 291    -------------------------
 292    -- POSIX.1c  Section 3 --
 293    -------------------------
 294
 295    function sigwait (set : access sigset_t; sig : access Signal) return int;
 296    pragma Inline (sigwait);
 297    --  UnixWare provides a non standard sigwait
 298
 299    function pthread_kill (thread : pthread_t; sig : Signal) return int;
 300    pragma Inline (pthread_kill);
 301    --  UnixWare provides a non standard pthread_kill
 302
 303    type sigset_t_ptr is access all sigset_t;
 304
 305    function pthread_sigmask
 306      (how  : int;
 307       set  : sigset_t_ptr;
 308       oset : sigset_t_ptr) return int;
 309    pragma Import (C, pthread_sigmask, "pthread_sigmask");
 310
 311    --------------------------
 312    -- POSIX.1c  Section 11 --
 313    --------------------------
 314
 315    function pthread_mutexattr_init
 316      (attr : access pthread_mutexattr_t) return int;
 317    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 318
 319    function pthread_mutexattr_destroy
 320      (attr : access pthread_mutexattr_t) return int;
 321    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 322
 323    function pthread_mutex_init
 324      (mutex : access pthread_mutex_t;
 325       attr  : access pthread_mutexattr_t) return int;
 326    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 327
 328    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 329    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 330
 331    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 332    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 333
 334    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 335    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 336
 337    function pthread_condattr_init
 338      (attr : access pthread_condattr_t) return int;
 339    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 340
 341    function pthread_condattr_destroy
 342      (attr : access pthread_condattr_t) return int;
 343    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 344
 345    function pthread_cond_init
 346      (cond : access pthread_cond_t;
 347       attr : access pthread_condattr_t) return int;
 348    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 349
 350    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 351    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 352
 353    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 354    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 355
 356    function pthread_cond_wait
 357      (cond  : access pthread_cond_t;
 358       mutex : access pthread_mutex_t) return int;
 359    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 360
 361    function pthread_cond_timedwait
 362      (cond    : access pthread_cond_t;
 363       mutex   : access pthread_mutex_t;
 364       abstime : access timespec) return int;
 365    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 366
 367    Relative_Timed_Wait : constant Boolean := False;
 368    --  pthread_cond_timedwait requires an absolute delay time
 369
 370    --------------------------
 371    -- POSIX.1c  Section 13 --
 372    --------------------------
 373
 374    PTHREAD_PRIO_NONE    : constant := 1;
 375    PTHREAD_PRIO_INHERIT : constant := 2;
 376    PTHREAD_PRIO_PROTECT : constant := 3;
 377
 378    function pthread_mutexattr_setprotocol
 379      (attr     : access pthread_mutexattr_t;
 380       protocol : int) return int;
 381    pragma Import (C, pthread_mutexattr_setprotocol);
 382
 383    function pthread_mutexattr_setprioceiling
 384      (attr     : access pthread_mutexattr_t;
 385       prioceiling : int) return int;
 386    pragma Import (C, pthread_mutexattr_setprioceiling);
 387
 388    type sched_union is record
 389       sched_fifo    : int;
 390       sched_fcfs    : int;
 391       sched_other   : int;
 392       sched_ts      : int;
 393       policy_params : long;
 394    end record;
 395
 396    type struct_sched_param is record
 397       sched_priority    : int;
 398       sched_other_stuff : sched_union;
 399    end record;
 400
 401    function pthread_setschedparam
 402      (thread : pthread_t;
 403       policy : int;
 404       param  : access struct_sched_param) return int;
 405    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 406
 407    function pthread_attr_setscope
 408      (attr            : access pthread_attr_t;
 409       contentionscope : int) return int;
 410    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 411
 412    function pthread_attr_setinheritsched
 413      (attr            : access pthread_attr_t;
 414       inheritsched : int) return int;
 415    pragma Import (C, pthread_attr_setinheritsched);
 416
 417    function pthread_attr_setschedpolicy
 418      (attr   : access pthread_attr_t;
 419       policy : int) return int;
 420    pragma Import (C, pthread_attr_setschedpolicy);
 421
 422    function sched_yield return int;
 423    pragma Import (C, sched_yield, "sched_yield");
 424
 425    ---------------------------
 426    -- P1003.1c - Section 16 --
 427    ---------------------------
 428
 429    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 430    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 431
 432    function pthread_attr_destroy
 433      (attributes : access pthread_attr_t) return int;
 434    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 435
 436    function pthread_attr_setdetachstate
 437      (attr        : access pthread_attr_t;
 438       detachstate : int) return int;
 439    pragma Import (C, pthread_attr_setdetachstate);
 440
 441    function pthread_attr_setstacksize
 442      (attr      : access pthread_attr_t;
 443       stacksize : size_t) return int;
 444    pragma Import (C, pthread_attr_setstacksize);
 445
 446    function pthread_create
 447      (thread        : access pthread_t;
 448       attributes    : access pthread_attr_t;
 449       start_routine : Thread_Body;
 450       arg           : System.Address) return int;
 451    pragma Import (C, pthread_create, "pthread_create");
 452
 453    procedure pthread_exit (status : System.Address);
 454    pragma Import (C, pthread_exit, "pthread_exit");
 455
 456    function pthread_self return pthread_t;
 457    pragma Import (C, pthread_self, "pthread_self");
 458
 459    --------------------------
 460    -- POSIX.1c  Section 17 --
 461    --------------------------
 462
 463    function pthread_setspecific
 464      (key   : pthread_key_t;
 465       value : System.Address) return int;
 466    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 467
 468    function pthread_getspecific (key : pthread_key_t) return System.Address;
 469    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 470
 471    type destructor_pointer is access procedure (arg : System.Address);
 472
 473    function pthread_key_create
 474      (key        : access pthread_key_t;
 475       destructor : destructor_pointer) return int;
 476    pragma Import (C, pthread_key_create, "pthread_key_create");
 477
 478    procedure pthread_init;
 479    --  This is a dummy procedure to share some GNULLI files
 480
 481 private
 482
 483    type sigbit_array is array (1 .. 4) of unsigned;
 484    type sigset_t is record
 485       sa_sigbits : sigbit_array;
 486    end record;
 487    pragma Convention (C_Pass_By_Copy, sigset_t);
 488
 489    type pid_t is new unsigned;
 490
 491    type time_t is new long;
 492
 493    type timespec is record
 494       tv_sec       : time_t;
 495       tv_nsec      : long;
 496    end record;
 497    pragma Convention (C, timespec);
 498
 499    type clockid_t is new int;
 500    CLOCK_REALTIME : constant clockid_t := 0;
 501
 502    type struct_timeval is record
 503       tv_sec       : long;
 504       tv_usec      : long;
 505    end record;
 506    pragma Convention (C, struct_timeval);
 507
 508    type pthread_attr_t is record
 509       pt_attr_status          : int;
 510       pt_attr_stacksize       : size_t;
 511       pt_attr_stackaddr       : System.Address;
 512       pt_attr_detachstate     : int;
 513       pt_attr_contentionscope : int;
 514       pt_attr_inheritsched    : int;
 515       pt_attr_schedpolicy     : int;
 516       pt_attr_sched_param     : struct_sched_param;
 517       pt_attr_tlflags         : int;
 518    end record;
 519    pragma Convention (C, pthread_attr_t);
 520
 521    type pthread_condattr_t is record
 522       pt_condattr_status  : int;
 523       pt_condattr_pshared : int;
 524    end record;
 525    pragma Convention (C, pthread_condattr_t);
 526
 527    type pthread_mutexattr_t is record
 528       pt_mutexattr_status  : int;
 529       pt_mutexattr_pshared : int;
 530       pt_mutexattr_type    : int;
 531    end record;
 532    pragma Convention (C, pthread_mutexattr_t);
 533
 534    type thread_t is new long;
 535    type pthread_t is new thread_t;
 536
 537    type thrq_elt_t;
 538    type thrq_elt_t_ptr is access all thrq_elt_t;
 539
 540    type thrq_elt_t is record
 541       thrq_next : thrq_elt_t_ptr;
 542       thrq_prev : thrq_elt_t_ptr;
 543    end record;
 544    pragma Convention (C, thrq_elt_t);
 545
 546    type lwp_mutex_t is record
 547       wanted : char;
 548       lock   : unsigned_char;
 549    end record;
 550    pragma Convention (C, lwp_mutex_t);
 551    pragma Volatile (lwp_mutex_t);
 552
 553    type mutex_t is record
 554       m_lmutex    : lwp_mutex_t;
 555       m_sync_lock : lwp_mutex_t;
 556       m_type      : int;
 557       m_sleepq    : thrq_elt_t;
 558       filler1     : int;
 559       filler2     : int;
 560    end record;
 561    pragma Convention (C, mutex_t);
 562    pragma Volatile (mutex_t);
 563
 564    type pthread_mutex_t is record
 565       pt_mutex_mutex : mutex_t;
 566       pt_mutex_pid   : pid_t;
 567       pt_mutex_owner : thread_t;
 568       pt_mutex_depth : int;
 569       pt_mutex_attr  : pthread_mutexattr_t;
 570    end record;
 571    pragma Convention (C, pthread_mutex_t);
 572
 573    type lwp_cond_t is record
 574       wanted : char;
 575    end record;
 576    pragma Convention (C, lwp_cond_t);
 577    pragma Volatile (lwp_cond_t);
 578
 579    type cond_t is record
 580       c_lcond     : lwp_cond_t;
 581       c_sync_lock : lwp_mutex_t;
 582       c_type      : int;
 583       c_syncq     : thrq_elt_t;
 584    end record;
 585    pragma Convention (C, cond_t);
 586    pragma Volatile (cond_t);
 587
 588    type pthread_cond_t is record
 589       pt_cond_cond : cond_t;
 590       pt_cond_attr : pthread_condattr_t;
 591    end record;
 592    pragma Convention (C, pthread_cond_t);
 593
 594    type pthread_key_t is new unsigned;
 595
 596 end System.OS_Interface;