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