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