gcc/ada/s-osinte-darwin.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-2007, 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 Darwin pthreads version of this package
  36
  37 --  This package includes all direct interfaces to OS services that are needed
  38 --  by children of System.
  39
  40 --  PLEASE DO NOT add any with-clauses to this package or remove the pragma
  41 --  Elaborate_Body. 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    subtype int            is Interfaces.C.int;
  48    subtype short          is Interfaces.C.short;
  49    subtype long           is Interfaces.C.long;
  50    subtype unsigned       is Interfaces.C.unsigned;
  51    subtype unsigned_short is Interfaces.C.unsigned_short;
  52    subtype unsigned_long  is Interfaces.C.unsigned_long;
  53    subtype unsigned_char  is Interfaces.C.unsigned_char;
  54    subtype plain_char     is Interfaces.C.plain_char;
  55    subtype size_t         is Interfaces.C.size_t;
  56
  57    -----------
  58    -- Errno --
  59    -----------
  60
  61    function errno return int;
  62    pragma Import (C, errno, "__get_errno");
  63
  64    EINTR     : constant := 4;
  65    ENOMEM    : constant := 12;
  66    EINVAL    : constant := 22;
  67    EAGAIN    : constant := 35;
  68    ETIMEDOUT : constant := 60;
  69
  70    -------------
  71    -- Signals --
  72    -------------
  73
  74    Max_Interrupt : constant := 31;
  75    type Signal is new int range 0 .. Max_Interrupt;
  76    for Signal'Size use int'Size;
  77
  78    SIGHUP     : constant := 1; --  hangup
  79    SIGINT     : constant := 2; --  interrupt (rubout)
  80    SIGQUIT    : constant := 3; --  quit (ASCD FS)
  81    SIGILL     : constant := 4; --  illegal instruction (not reset)
  82    SIGTRAP    : constant := 5; --  trace trap (not reset)
  83    SIGIOT     : constant := 6; --  IOT instruction
  84    SIGABRT    : constant := 6; --  used by abort, replace SIGIOT in the  future
  85    SIGEMT     : constant := 7; --  EMT instruction
  86    SIGFPE     : constant := 8; --  floating point exception
  87    SIGKILL    : constant := 9; --  kill (cannot be caught or ignored)
  88    SIGBUS     : constant := 10; --  bus error
  89    SIGSEGV    : constant := 11; --  segmentation violation
  90    SIGSYS     : constant := 12; --  bad argument to system call
  91    SIGPIPE    : constant := 13; --  write on a pipe with no one to read it
  92    SIGALRM    : constant := 14; --  alarm clock
  93    SIGTERM    : constant := 15; --  software termination signal from kill
  94    SIGURG     : constant := 16; --  urgent condition on IO channel
  95    SIGSTOP    : constant := 17; --  stop (cannot be caught or ignored)
  96    SIGTSTP    : constant := 18; --  user stop requested from tty
  97    SIGCONT    : constant := 19; --  stopped process has been continued
  98    SIGCHLD    : constant := 20; --  child status change
  99    SIGTTIN    : constant := 21; --  background tty read attempted
 100    SIGTTOU    : constant := 22; --  background tty write attempted
 101    SIGIO      : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
 102    SIGXCPU    : constant := 24; --  CPU time limit exceeded
 103    SIGXFSZ    : constant := 25; --  filesize limit exceeded
 104    SIGVTALRM  : constant := 26; --  virtual timer expired
 105    SIGPROF    : constant := 27; --  profiling timer expired
 106    SIGWINCH   : constant := 28; --  window size change
 107    SIGINFO    : constant := 29; --  information request
 108    SIGUSR1    : constant := 30; --  user defined signal 1
 109    SIGUSR2    : constant := 31; --  user defined signal 2
 110
 111    SIGADAABORT : constant := SIGTERM;
 112    --  Change this if you want to use another signal for task abort.
 113    --  SIGTERM might be a good one.
 114
 115    type Signal_Set is array (Natural range <>) of Signal;
 116
 117    Unmasked : constant Signal_Set :=
 118      (SIGTTIN, SIGTTOU, SIGSTOP, SIGTSTP);
 119
 120    Reserved : constant Signal_Set :=
 121      (SIGKILL, SIGSTOP);
 122
 123    type sigset_t is private;
 124
 125    function sigaddset (set : access sigset_t; sig : Signal) return int;
 126    pragma Import (C, sigaddset, "sigaddset");
 127
 128    function sigdelset (set : access sigset_t; sig : Signal) return int;
 129    pragma Import (C, sigdelset, "sigdelset");
 130
 131    function sigfillset (set : access sigset_t) return int;
 132    pragma Import (C, sigfillset, "sigfillset");
 133
 134    function sigismember (set : access sigset_t; sig : Signal) return int;
 135    pragma Import (C, sigismember, "sigismember");
 136
 137    function sigemptyset (set : access sigset_t) return int;
 138    pragma Import (C, sigemptyset, "sigemptyset");
 139
 140    type siginfo_t is private;
 141    type ucontext_t is private;
 142
 143    type Signal_Handler is access procedure
 144      (signo   : Signal;
 145       info    : access siginfo_t;
 146       context : access ucontext_t);
 147
 148    type struct_sigaction is record
 149       sa_handler : System.Address;
 150       sa_mask    : sigset_t;
 151       sa_flags   : int;
 152    end record;
 153    pragma Convention (C, struct_sigaction);
 154    type struct_sigaction_ptr is access all struct_sigaction;
 155
 156    SIG_BLOCK   : constant := 1;
 157    SIG_UNBLOCK : constant := 2;
 158    SIG_SETMASK : constant := 3;
 159
 160    SIG_DFL : constant := 0;
 161    SIG_IGN : constant := 1;
 162
 163    SA_SIGINFO : constant := 16#0040#;
 164
 165    function sigaction
 166      (sig  : Signal;
 167       act  : struct_sigaction_ptr;
 168       oact : struct_sigaction_ptr) return int;
 169    pragma Import (C, sigaction, "sigaction");
 170
 171    ----------
 172    -- Time --
 173    ----------
 174
 175    Time_Slice_Supported : constant Boolean := True;
 176    --  Indicates wether time slicing is supported
 177
 178    type timespec is private;
 179
 180    type clockid_t is private;
 181
 182    CLOCK_REALTIME : constant clockid_t;
 183
 184    function clock_gettime
 185      (clock_id : clockid_t;
 186       tp       : access timespec) return int;
 187
 188    function To_Duration (TS : timespec) return Duration;
 189    pragma Inline (To_Duration);
 190
 191    function To_Timespec (D : Duration) return timespec;
 192    pragma Inline (To_Timespec);
 193
 194    type struct_timeval is private;
 195
 196    function To_Duration (TV : struct_timeval) return Duration;
 197    pragma Inline (To_Duration);
 198
 199    function To_Timeval (D : Duration) return struct_timeval;
 200    pragma Inline (To_Timeval);
 201
 202    -------------------------
 203    -- Priority Scheduling --
 204    -------------------------
 205
 206    SCHED_OTHER : constant := 1;
 207    SCHED_RR    : constant := 2;
 208    SCHED_FIFO  : constant := 4;
 209
 210    function To_Target_Priority
 211      (Prio : System.Any_Priority) return Interfaces.C.int;
 212    --  Maps System.Any_Priority to a POSIX priority
 213
 214    -------------
 215    -- Process --
 216    -------------
 217
 218    type pid_t is private;
 219
 220    function kill (pid : pid_t; sig : Signal) return int;
 221    pragma Import (C, kill, "kill");
 222
 223    function getpid return pid_t;
 224    pragma Import (C, getpid, "getpid");
 225
 226    ---------
 227    -- LWP --
 228    ---------
 229
 230    function lwp_self return System.Address;
 231    --  lwp_self does not exist on this thread library, revert to pthread_self
 232    --  which is the closest approximation (with getpid). This function is
 233    --  needed to share 7staprop.adb across POSIX-like targets.
 234    pragma Import (C, lwp_self, "pthread_self");
 235
 236    -------------
 237    -- Threads --
 238    -------------
 239
 240    type Thread_Body is access
 241      function (arg : System.Address) return System.Address;
 242    pragma Convention (C, Thread_Body);
 243
 244    type pthread_t           is private;
 245    subtype Thread_Id        is pthread_t;
 246
 247    type pthread_mutex_t     is limited private;
 248    type pthread_cond_t      is limited private;
 249    type pthread_attr_t      is limited private;
 250    type pthread_mutexattr_t is limited private;
 251    type pthread_condattr_t  is limited private;
 252    type pthread_key_t       is private;
 253
 254    type pthread_mutex_ptr is access all pthread_mutex_t;
 255    type pthread_cond_ptr is access all pthread_cond_t;
 256
 257    PTHREAD_CREATE_DETACHED : constant := 2;
 258
 259    PTHREAD_SCOPE_PROCESS : constant := 2;
 260    PTHREAD_SCOPE_SYSTEM  : constant := 1;
 261
 262    -----------
 263    -- Stack --
 264    -----------
 265
 266    Stack_Base_Available : constant Boolean := False;
 267    --  Indicates wether the stack base is available on this target.
 268    --  This allows us to share s-osinte.adb between all the FSU run time.
 269    --  Note that this value can only be true if pthread_t has a complete
 270    --  definition that corresponds exactly to the C header files.
 271
 272    function Get_Stack_Base (thread : pthread_t) return System.Address;
 273    pragma Inline (Get_Stack_Base);
 274    --  returns the stack base of the specified thread.
 275    --  Only call this function when Stack_Base_Available is True.
 276
 277    function Get_Page_Size return size_t;
 278    function Get_Page_Size return System.Address;
 279    pragma Import (C, Get_Page_Size, "getpagesize");
 280    --  returns the size of a page, or 0 if this is not relevant on this
 281    --  target
 282
 283    PROT_NONE  : constant := 0;
 284    PROT_READ  : constant := 1;
 285    PROT_WRITE : constant := 2;
 286    PROT_EXEC  : constant := 4;
 287    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
 288
 289    PROT_ON    : constant := PROT_NONE;
 290    PROT_OFF   : constant := PROT_ALL;
 291
 292    function mprotect (addr : System.Address;
 293                       len : size_t;
 294                       prot : int) return int;
 295    pragma Import (C, mprotect);
 296
 297    ---------------------------------------
 298    -- Nonstandard Thread Initialization --
 299    ---------------------------------------
 300
 301    procedure pthread_init;
 302
 303    -------------------------
 304    -- POSIX.1c  Section 3 --
 305    -------------------------
 306
 307    function sigwait (set : access sigset_t; sig : access Signal) return int;
 308    pragma Import (C, sigwait, "sigwait");
 309
 310    function pthread_kill (thread : pthread_t; sig : Signal) return int;
 311    pragma Import (C, pthread_kill, "pthread_kill");
 312
 313    function pthread_sigmask
 314      (how  : int;
 315       set  : access sigset_t;
 316       oset : access sigset_t) return int;
 317    pragma Import (C, pthread_sigmask, "pthread_sigmask");
 318
 319    --------------------------
 320    -- POSIX.1c  Section 11 --
 321    --------------------------
 322
 323    function pthread_mutexattr_init
 324      (attr : access pthread_mutexattr_t) return int;
 325    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 326
 327    function pthread_mutexattr_destroy
 328      (attr : access pthread_mutexattr_t) return int;
 329    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 330
 331    function pthread_mutex_init
 332      (mutex : access pthread_mutex_t;
 333       attr  : access pthread_mutexattr_t) return int;
 334    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 335
 336    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 337    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 338
 339    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 340    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 341
 342    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 343    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 344
 345    function pthread_condattr_init
 346      (attr : access pthread_condattr_t) return int;
 347    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 348
 349    function pthread_condattr_destroy
 350      (attr : access pthread_condattr_t) return int;
 351    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 352
 353    function pthread_cond_init
 354      (cond : access pthread_cond_t;
 355       attr : access pthread_condattr_t) return int;
 356    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 357
 358    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 359    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 360
 361    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 362    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 363
 364    function pthread_cond_wait
 365      (cond  : access pthread_cond_t;
 366       mutex : access pthread_mutex_t) return int;
 367    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 368
 369    function pthread_cond_timedwait
 370      (cond    : access pthread_cond_t;
 371       mutex   : access pthread_mutex_t;
 372       abstime : access timespec) return int;
 373    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 374
 375    Relative_Timed_Wait : constant Boolean := False;
 376    --  pthread_cond_timedwait requires an absolute delay time
 377
 378    --------------------------
 379    -- POSIX.1c  Section 13 --
 380    --------------------------
 381
 382    PTHREAD_PRIO_NONE    : constant := 0;
 383    PTHREAD_PRIO_INHERIT : constant := 1;
 384    PTHREAD_PRIO_PROTECT : constant := 2;
 385
 386    function pthread_mutexattr_setprotocol
 387      (attr     : access pthread_mutexattr_t;
 388       protocol : int) return int;
 389    pragma Import
 390      (C, pthread_mutexattr_setprotocol, "pthread_mutexattr_setprotocol");
 391
 392    function pthread_mutexattr_setprioceiling
 393      (attr     : access pthread_mutexattr_t;
 394       prioceiling : int) return int;
 395    pragma Import
 396      (C, pthread_mutexattr_setprioceiling,
 397       "pthread_mutexattr_setprioceiling");
 398
 399    type padding is array (int range <>) of Interfaces.C.char;
 400
 401    type struct_sched_param is record
 402       sched_priority : int;  --  scheduling priority
 403       opaque         : padding (1 .. 4);
 404    end record;
 405    pragma Convention (C, struct_sched_param);
 406
 407    function pthread_setschedparam
 408      (thread : pthread_t;
 409       policy : int;
 410       param  : access struct_sched_param) return int;
 411    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 412
 413    function pthread_attr_setscope
 414      (attr            : access pthread_attr_t;
 415       contentionscope : int) return int;
 416    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 417
 418    function pthread_attr_setinheritsched
 419      (attr            : access pthread_attr_t;
 420       inheritsched : int) return int;
 421    pragma Import
 422      (C, pthread_attr_setinheritsched, "pthread_attr_setinheritsched");
 423
 424    function pthread_attr_setschedpolicy
 425      (attr   : access pthread_attr_t;
 426       policy : int) return int;
 427    pragma Import (C, pthread_attr_setschedpolicy, "pthread_attr_setsched");
 428
 429    function sched_yield return int;
 430
 431    ---------------------------
 432    -- P1003.1c - Section 16 --
 433    ---------------------------
 434
 435    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 436    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 437
 438    function pthread_attr_destroy
 439      (attributes : access pthread_attr_t) return int;
 440    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 441
 442    function pthread_attr_setdetachstate
 443      (attr        : access pthread_attr_t;
 444       detachstate : int) return int;
 445    pragma Import
 446      (C, pthread_attr_setdetachstate, "pthread_attr_setdetachstate");
 447
 448    function pthread_attr_setstacksize
 449      (attr      : access pthread_attr_t;
 450       stacksize : size_t) return int;
 451    pragma Import
 452      (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
 453
 454    function pthread_create
 455      (thread        : access pthread_t;
 456       attributes    : access pthread_attr_t;
 457       start_routine : Thread_Body;
 458       arg           : System.Address) return int;
 459    pragma Import (C, pthread_create, "pthread_create");
 460
 461    procedure pthread_exit (status : System.Address);
 462    pragma Import (C, pthread_exit, "pthread_exit");
 463
 464    function pthread_self return pthread_t;
 465    pragma Import (C, pthread_self, "pthread_self");
 466
 467    --------------------------
 468    -- POSIX.1c  Section 17 --
 469    --------------------------
 470
 471    function pthread_setspecific
 472      (key   : pthread_key_t;
 473       value : System.Address) return int;
 474    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 475
 476    function pthread_getspecific (key : pthread_key_t) return System.Address;
 477    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 478
 479    type destructor_pointer is access procedure (arg : System.Address);
 480    pragma Convention (C, destructor_pointer);
 481
 482    function pthread_key_create
 483      (key        : access pthread_key_t;
 484       destructor : destructor_pointer) return int;
 485    pragma Import (C, pthread_key_create, "pthread_key_create");
 486
 487 private
 488
 489    type sigset_t is new unsigned;
 490
 491    type int32_t is new int;
 492
 493    type pid_t is new int32_t;
 494
 495    type time_t is new long;
 496
 497    type timespec is record
 498       tv_sec  : time_t;
 499       tv_nsec : int32_t;
 500    end record;
 501    pragma Convention (C, timespec);
 502
 503    type clockid_t is new int;
 504    CLOCK_REALTIME : constant clockid_t := 0;
 505
 506    type struct_timeval is record
 507       tv_sec  : int32_t;
 508       tv_usec : int32_t;
 509    end record;
 510    pragma Convention (C, struct_timeval);
 511
 512    --
 513    --  Darwin specific signal implementation
 514    --
 515    type Pad_Type is array (1 .. 7) of unsigned;
 516    type siginfo_t is record
 517       si_signo  : int;               --  signal number
 518       si_errno  : int;               --  errno association
 519       si_code   : int;               --  signal code
 520       si_pid    : int;               --  sending process
 521       si_uid    : unsigned;          --  sender's ruid
 522       si_status : int;               --  exit value
 523       si_addr   : System.Address;    --  faulting instruction
 524       si_value  : System.Address;    --  signal value
 525       si_band   : long;              --  band event for SIGPOLL
 526       pad       : Pad_Type;          --  RFU
 527    end record;
 528    pragma Convention (C, siginfo_t);
 529
 530    type stack_t is record
 531       ss_sp    : System.Address;
 532       ss_size  : int;
 533       ss_flags : int;
 534    end record;
 535    pragma Convention (C, stack_t);
 536
 537    type mcontext_t is new System.Address;
 538
 539    type ucontext_t is record
 540       uc_onstack  : int;
 541       uc_sigmask  : sigset_t;         --  Signal Mask Used By This Context
 542       uc_stack    : stack_t;          --  Stack Used By This Context
 543       uc_link     : System.Address;   --  Pointer To Resuming Context
 544       uc_mcsize   : size_t;           --  Size of The Machine Context
 545       uc_mcontext : mcontext_t;       --  Machine Specific Context
 546    end record;
 547    pragma Convention (C, ucontext_t);
 548
 549    --
 550    --  Darwin specific pthread implementation
 551    --
 552    type pthread_t is new System.Address;
 553
 554    type pthread_lock_t is new long;
 555
 556    type pthread_attr_t is record
 557       sig    : long;
 558       opaque : padding (1 .. 36);
 559    end record;
 560    pragma Convention (C, pthread_attr_t);
 561
 562    type pthread_mutexattr_t is record
 563       sig    : long;
 564       opaque : padding (1 .. 8);
 565    end record;
 566    pragma Convention (C, pthread_mutexattr_t);
 567
 568    type pthread_mutex_t is record
 569       sig    : long;
 570       opaque : padding (1 .. 40);
 571    end record;
 572    pragma Convention (C, pthread_mutex_t);
 573
 574    type pthread_condattr_t is record
 575       sig    : long;
 576       opaque : padding (1 .. 4);
 577    end record;
 578    pragma Convention (C, pthread_condattr_t);
 579
 580    type pthread_cond_t is record
 581       sig    : long;
 582       opaque : padding (1 .. 24);
 583    end record;
 584    pragma Convention (C, pthread_cond_t);
 585
 586    type pthread_once_t is record
 587       sig    : long;
 588       opaque : padding (1 .. 4);
 589    end record;
 590    pragma Convention (C, pthread_once_t);
 591
 592    type pthread_key_t is new unsigned_long;
 593
 594 end System.OS_Interface;