gcc/ada/s-osinte-hpux.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-2009, Free Software Foundation, Inc.       --
  11 --                                                                          --
  12 -- GNARL is free software; you can  redistribute it  and/or modify it under --
  13 -- terms of the  GNU General Public License as published  by the Free Soft- --
  14 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  15 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
  16 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  17 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  18 -- for  more details.  You should have  received  a copy of the GNU General --
  19 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
  20 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  21 -- Boston, MA 02110-1301, USA.                                              --
  22 --                                                                          --
  23 -- As a special exception,  if other files  instantiate  generics from this --
  24 -- unit, or you link  this unit with other files  to produce an executable, --
  25 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  26 -- covered  by the  GNU  General  Public  License.  This exception does not --
  27 -- however invalidate  any other reasons why  the executable file  might be --
  28 -- covered by the  GNU Public License.                                      --
  29 --                                                                          --
  30 -- GNARL was developed by the GNARL team at Florida State University.       --
  31 -- Extensive contributions were provided by Ada Core Technologies, Inc.     --
  32 --                                                                          --
  33 ------------------------------------------------------------------------------
  34
  35 --  This is a HPUX 11.0 (Native THREADS) version of this package
  36
  37 --  This package encapsulates all direct interfaces to OS services that are
  38 --  needed by the tasking run-time (libgnarl).
  39
  40 --  PLEASE DO NOT add any with-clauses to this package or remove the pragma
  41 --  Preelaborate. This package is designed to be a bottom-level (leaf) package.
  42
  43 with Ada.Unchecked_Conversion;
  44
  45 with Interfaces.C;
  46
  47 package System.OS_Interface is
  48    pragma Preelaborate;
  49
  50    pragma Linker_Options ("-lpthread");
  51
  52    subtype int            is Interfaces.C.int;
  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 := 238;
  74
  75    -------------
  76    -- Signals --
  77    -------------
  78
  79    Max_Interrupt : constant := 44;
  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    SIGVTALRM  : constant := 20; --  virtual timer alarm
 105    SIGPROF    : constant := 21; --  profiling timer alarm
 106    SIGIO      : constant := 22; --  asynchronous I/O
 107    SIGPOLL    : constant := 22; --  pollable event occurred
 108    SIGWINCH   : constant := 23; --  window size change
 109    SIGSTOP    : constant := 24; --  stop (cannot be caught or ignored)
 110    SIGTSTP    : constant := 25; --  user stop requested from tty
 111    SIGCONT    : constant := 26; --  stopped process has been continued
 112    SIGTTIN    : constant := 27; --  background tty read attempted
 113    SIGTTOU    : constant := 28; --  background tty write attempted
 114    SIGURG     : constant := 29; --  urgent condition on IO channel
 115    SIGLOST    : constant := 30; --  remote lock lost  (NFS)
 116    SIGDIL     : constant := 32; --  DIL signal
 117    SIGXCPU    : constant := 33; --  CPU time limit exceeded (setrlimit)
 118    SIGXFSZ    : constant := 34; --  file size limit exceeded (setrlimit)
 119    SIGCANCEL  : constant := 35; --  used for pthread cancellation.
 120    SIGGFAULT  : constant := 36; --  Graphics framebuffer fault
 121
 122    SIGADAABORT : constant := SIGABRT;
 123    --  Note: on other targets, we usually use SIGABRT, but on HPUX, it
 124    --  appears that SIGABRT can't be used in sigwait(), so we use SIGTERM.
 125    --  Do we use SIGTERM or SIGABRT???
 126
 127    type Signal_Set is array (Natural range <>) of Signal;
 128
 129    Unmasked    : constant Signal_Set :=
 130      (SIGABRT, SIGPIPE, SIGBUS, SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF,
 131       SIGALRM, SIGVTALRM, SIGIO, SIGCHLD);
 132
 133    Reserved    : constant Signal_Set := (SIGKILL, SIGSTOP);
 134
 135    type sigset_t is private;
 136
 137    function sigaddset (set : access sigset_t; sig : Signal) return int;
 138    pragma Import (C, sigaddset, "sigaddset");
 139
 140    function sigdelset (set : access sigset_t; sig : Signal) return int;
 141    pragma Import (C, sigdelset, "sigdelset");
 142
 143    function sigfillset (set : access sigset_t) return int;
 144    pragma Import (C, sigfillset, "sigfillset");
 145
 146    function sigismember (set : access sigset_t; sig : Signal) return int;
 147    pragma Import (C, sigismember, "sigismember");
 148
 149    function sigemptyset (set : access sigset_t) return int;
 150    pragma Import (C, sigemptyset, "sigemptyset");
 151
 152    type struct_sigaction is record
 153       sa_handler : System.Address;
 154       sa_mask    : sigset_t;
 155       sa_flags   : int;
 156    end record;
 157    pragma Convention (C, struct_sigaction);
 158    type struct_sigaction_ptr is access all struct_sigaction;
 159
 160    SA_SIGINFO : constant := 16#10#;
 161    SA_ONSTACK : constant := 16#01#;
 162
 163    SIG_BLOCK   : constant := 0;
 164    SIG_UNBLOCK : constant := 1;
 165    SIG_SETMASK : constant := 2;
 166
 167    SIG_DFL : constant := 0;
 168    SIG_IGN : constant := 1;
 169
 170    function sigaction
 171      (sig  : Signal;
 172       act  : struct_sigaction_ptr;
 173       oact : struct_sigaction_ptr) return int;
 174    pragma Import (C, sigaction, "sigaction");
 175
 176    ----------
 177    -- Time --
 178    ----------
 179
 180    Time_Slice_Supported : constant Boolean := True;
 181    --  Indicates whether time slicing is supported
 182
 183    type timespec is private;
 184
 185    type clockid_t is private;
 186
 187    CLOCK_REALTIME : constant clockid_t;
 188
 189    function clock_gettime
 190      (clock_id : clockid_t;
 191       tp       : access timespec) return int;
 192    pragma Import (C, clock_gettime, "clock_gettime");
 193
 194    function clock_getres
 195      (clock_id : clockid_t;
 196       res      : access timespec) return int;
 197    pragma Import (C, clock_getres, "clock_getres");
 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_timezone is record
 206       tz_minuteswest : int;
 207       tz_dsttime     : int;
 208    end record;
 209    pragma Convention (C, struct_timezone);
 210    type struct_timezone_ptr is access all struct_timezone;
 211
 212    -------------------------
 213    -- Priority Scheduling --
 214    -------------------------
 215
 216    SCHED_FIFO  : constant := 0;
 217    SCHED_RR    : constant := 1;
 218    SCHED_OTHER : constant := 2;
 219
 220    function To_Target_Priority
 221      (Prio : System.Any_Priority) return Interfaces.C.int;
 222    --  Maps System.Any_Priority to a POSIX priority
 223
 224    -------------
 225    -- Process --
 226    -------------
 227
 228    type pid_t is private;
 229
 230    function kill (pid : pid_t; sig : Signal) return int;
 231    pragma Import (C, kill, "kill");
 232
 233    function getpid return pid_t;
 234    pragma Import (C, getpid, "getpid");
 235
 236    ---------
 237    -- LWP --
 238    ---------
 239
 240    function lwp_self return System.Address;
 241    pragma Import (C, lwp_self, "_lwp_self");
 242
 243    -------------
 244    -- Threads --
 245    -------------
 246
 247    type Thread_Body is access
 248      function (arg : System.Address) return System.Address;
 249    pragma Convention (C, Thread_Body);
 250
 251    function Thread_Body_Access is new
 252      Ada.Unchecked_Conversion (System.Address, Thread_Body);
 253
 254    type pthread_t           is private;
 255    subtype Thread_Id        is pthread_t;
 256
 257    type pthread_mutex_t     is limited private;
 258    type pthread_cond_t      is limited private;
 259    type pthread_attr_t      is limited private;
 260    type pthread_mutexattr_t is limited private;
 261    type pthread_condattr_t  is limited private;
 262    type pthread_key_t       is private;
 263
 264    PTHREAD_CREATE_DETACHED : constant := 16#de#;
 265
 266    PTHREAD_SCOPE_PROCESS : constant := 2;
 267    PTHREAD_SCOPE_SYSTEM  : constant := 1;
 268
 269    -----------
 270    -- Stack --
 271    -----------
 272
 273    type stack_t is record
 274       ss_sp    : System.Address;
 275       ss_flags : int;
 276       ss_size  : size_t;
 277    end record;
 278    pragma Convention (C, stack_t);
 279
 280    function sigaltstack
 281      (ss  : not null access stack_t;
 282       oss : access stack_t) return int;
 283    pragma Import (C, sigaltstack, "sigaltstack");
 284
 285    Alternate_Stack : aliased System.Address;
 286    pragma Import (C, Alternate_Stack, "__gnat_alternate_stack");
 287    --  The alternate signal stack for stack overflows
 288
 289    Alternate_Stack_Size : constant := 16 * 1024;
 290    --  This must be in keeping with init.c:__gnat_alternate_stack
 291
 292    Stack_Base_Available : constant Boolean := False;
 293    --  Indicates whether the stack base is available on this target
 294
 295    function Get_Stack_Base (thread : pthread_t) return Address;
 296    pragma Inline (Get_Stack_Base);
 297    --  Returns the stack base of the specified thread. Only call this function
 298    --  when Stack_Base_Available is True.
 299
 300    function Get_Page_Size return size_t;
 301    function Get_Page_Size return Address;
 302    pragma Import (C, Get_Page_Size, "getpagesize");
 303    --  Returns the size of a page
 304
 305    PROT_NONE  : constant := 0;
 306    PROT_READ  : constant := 1;
 307    PROT_WRITE : constant := 2;
 308    PROT_EXEC  : constant := 4;
 309    PROT_ALL   : constant := PROT_READ + PROT_WRITE + PROT_EXEC;
 310    PROT_ON    : constant := PROT_READ;
 311    PROT_OFF   : constant := PROT_ALL;
 312
 313    function mprotect (addr : Address; len : size_t; prot : int) return int;
 314    pragma Import (C, mprotect);
 315
 316    ---------------------------------------
 317    -- Nonstandard Thread Initialization --
 318    ---------------------------------------
 319
 320    procedure pthread_init;
 321    pragma Inline (pthread_init);
 322    --  This is a dummy procedure to share some GNULLI files
 323
 324    -------------------------
 325    -- POSIX.1c  Section 3 --
 326    -------------------------
 327
 328    function sigwait
 329      (set : access sigset_t;
 330       sig : access Signal) return int;
 331    pragma Import (C, sigwait, "sigwait");
 332
 333    function pthread_kill
 334      (thread : pthread_t;
 335       sig    : Signal) return int;
 336    pragma Import (C, pthread_kill, "pthread_kill");
 337
 338    function pthread_sigmask
 339      (how  : int;
 340       set  : access sigset_t;
 341       oset : access sigset_t) return int;
 342    pragma Import (C, pthread_sigmask, "pthread_sigmask");
 343
 344    --------------------------
 345    -- POSIX.1c  Section 11 --
 346    --------------------------
 347
 348    function pthread_mutexattr_init
 349      (attr : access pthread_mutexattr_t) return int;
 350    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 351
 352    function pthread_mutexattr_destroy
 353      (attr : access pthread_mutexattr_t) return int;
 354    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 355
 356    function pthread_mutex_init
 357      (mutex : access pthread_mutex_t;
 358       attr  : access pthread_mutexattr_t) return int;
 359    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 360
 361    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 362    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 363
 364    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 365    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 366
 367    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 368    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 369
 370    function pthread_condattr_init
 371      (attr : access pthread_condattr_t) return int;
 372    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 373
 374    function pthread_condattr_destroy
 375      (attr : access pthread_condattr_t) return int;
 376    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 377
 378    function pthread_cond_init
 379      (cond : access pthread_cond_t;
 380       attr : access pthread_condattr_t) return int;
 381    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 382
 383    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 384    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 385
 386    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 387    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 388
 389    function pthread_cond_wait
 390      (cond  : access pthread_cond_t;
 391       mutex : access pthread_mutex_t) return int;
 392    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 393
 394    function pthread_cond_timedwait
 395      (cond    : access pthread_cond_t;
 396       mutex   : access pthread_mutex_t;
 397       abstime : access timespec) return int;
 398    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 399
 400    Relative_Timed_Wait : constant Boolean := False;
 401    --  pthread_cond_timedwait requires an absolute delay time
 402
 403    --------------------------
 404    -- POSIX.1c  Section 13 --
 405    --------------------------
 406
 407    PTHREAD_PRIO_NONE    : constant := 16#100#;
 408    PTHREAD_PRIO_PROTECT : constant := 16#200#;
 409    PTHREAD_PRIO_INHERIT : constant := 16#400#;
 410
 411    function pthread_mutexattr_setprotocol
 412      (attr     : access pthread_mutexattr_t;
 413       protocol : int) return int;
 414    pragma Import (C, pthread_mutexattr_setprotocol);
 415
 416    function pthread_mutexattr_setprioceiling
 417      (attr     : access pthread_mutexattr_t;
 418       prioceiling : int) return int;
 419    pragma Import (C, pthread_mutexattr_setprioceiling);
 420
 421    type Array_7_Int is array (0 .. 6) of int;
 422    type struct_sched_param is record
 423       sched_priority : int;
 424       sched_reserved : Array_7_Int;
 425    end record;
 426
 427    function pthread_setschedparam
 428      (thread : pthread_t;
 429       policy : int;
 430       param  : access struct_sched_param)
 431      return int;
 432    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 433
 434    function pthread_attr_setscope
 435      (attr            : access pthread_attr_t;
 436       contentionscope : int) return int;
 437    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 438
 439    function pthread_attr_setinheritsched
 440      (attr         : access pthread_attr_t;
 441       inheritsched : int) return int;
 442    pragma Import (C, pthread_attr_setinheritsched);
 443
 444    function pthread_attr_setschedpolicy
 445      (attr   : access pthread_attr_t;
 446       policy : int) return int;
 447    pragma Import (C, pthread_attr_setschedpolicy);
 448
 449    function sched_yield return int;
 450    pragma Import (C, sched_yield, "sched_yield");
 451
 452    --------------------------
 453    -- P1003.1c  Section 16 --
 454    --------------------------
 455
 456    function pthread_attr_init
 457      (attributes : access pthread_attr_t) return int;
 458    pragma Import (C, pthread_attr_init, "__pthread_attr_init_system");
 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 (C, pthread_attr_setdetachstate);
 468
 469    function pthread_attr_setstacksize
 470      (attr      : access pthread_attr_t;
 471       stacksize : size_t) return int;
 472    pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
 473
 474    function pthread_create
 475      (thread        : access pthread_t;
 476       attributes    : access pthread_attr_t;
 477       start_routine : Thread_Body;
 478       arg           : System.Address) return int;
 479    pragma Import (C, pthread_create, "__pthread_create_system");
 480
 481    procedure pthread_exit (status : System.Address);
 482    pragma Import (C, pthread_exit, "pthread_exit");
 483
 484    function pthread_self return pthread_t;
 485    pragma Import (C, pthread_self, "pthread_self");
 486
 487    --------------------------
 488    -- POSIX.1c  Section 17 --
 489    --------------------------
 490
 491    function pthread_setspecific
 492      (key   : pthread_key_t;
 493       value : System.Address) return int;
 494    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 495
 496    function pthread_getspecific (key : pthread_key_t) return System.Address;
 497    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 498
 499    type destructor_pointer is access procedure (arg : System.Address);
 500    pragma Convention (C, destructor_pointer);
 501
 502    function pthread_key_create
 503      (key        : access pthread_key_t;
 504       destructor : destructor_pointer) return int;
 505    pragma Import (C, pthread_key_create, "pthread_key_create");
 506
 507 private
 508
 509    type unsigned_int_array_8 is array (0 .. 7) of unsigned;
 510    type sigset_t is record
 511       sigset : unsigned_int_array_8;
 512    end record;
 513    pragma Convention (C_Pass_By_Copy, sigset_t);
 514
 515    type pid_t is new int;
 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 := 1;
 527
 528    type pthread_attr_t is new int;
 529    type pthread_condattr_t is new int;
 530    type pthread_mutexattr_t is new int;
 531    type pthread_t is new int;
 532
 533    type short_array is array (Natural range <>) of short;
 534    type int_array is array (Natural range <>) of int;
 535
 536    type pthread_mutex_t is record
 537       m_short : short_array (0 .. 1);
 538       m_int   : int;
 539       m_int1  : int_array (0 .. 3);
 540       m_pad   : int;
 541
 542       m_ptr : int;
 543       --  actually m_ptr is a void*, and on 32 bit ABI, m_pad is added so that
 544       --  this field takes 64 bits. On 64 bit ABI, m_pad is gone, and m_ptr is
 545       --  a 64 bit void*. Assume int'Size = 32.
 546
 547       m_int2   : int_array (0 .. 1);
 548       m_int3   : int_array (0 .. 3);
 549       m_short2 : short_array (0 .. 1);
 550       m_int4   : int_array (0 .. 4);
 551       m_int5   : int_array (0 .. 1);
 552    end record;
 553    for pthread_mutex_t'Alignment use System.Address'Alignment;
 554    pragma Convention (C, pthread_mutex_t);
 555
 556    type pthread_cond_t is record
 557       c_short : short_array (0 .. 1);
 558       c_int   : int;
 559       c_int1  : int_array (0 .. 3);
 560       m_pad   : int;
 561       m_ptr   : int;  --  see comment in pthread_mutex_t
 562       c_int2  : int_array (0 .. 1);
 563       c_int3  : int_array (0 .. 1);
 564       c_int4  : int_array (0 .. 1);
 565    end record;
 566    for pthread_cond_t'Alignment use System.Address'Alignment;
 567    pragma Convention (C, pthread_cond_t);
 568
 569    type pthread_key_t is new int;
 570
 571 end System.OS_Interface;