gcc/ada/s-osinte-kfreebsd-gnu.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-1994, Florida State University            --
  10 --             Copyright (C) 1995-2005,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 the GNU/kFreeBSD (GNU/LinuxThreads) version of this package
  36
  37 --  This package encapsulates all direct interfaces to OS services
  38 --  that are needed by children of System.
  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 Interfaces.C;
  44 with Unchecked_Conversion;
  45
  46 package System.OS_Interface is
  47    pragma Preelaborate;
  48
  49    pragma Linker_Options ("-lpthread");
  50
  51    subtype int            is Interfaces.C.int;
  52    subtype char           is Interfaces.C.char;
  53    subtype short          is Interfaces.C.short;
  54    subtype long           is Interfaces.C.long;
  55    subtype unsigned       is Interfaces.C.unsigned;
  56    subtype unsigned_short is Interfaces.C.unsigned_short;
  57    subtype unsigned_long  is Interfaces.C.unsigned_long;
  58    subtype unsigned_char  is Interfaces.C.unsigned_char;
  59    subtype plain_char     is Interfaces.C.plain_char;
  60    subtype size_t         is Interfaces.C.size_t;
  61
  62    -----------
  63    -- Errno --
  64    -----------
  65
  66    function errno return int;
  67    pragma Import (C, errno, "__get_errno");
  68
  69    EAGAIN   : constant := 35;
  70    EINTR    : constant := 4;
  71    EINVAL   : constant := 22;
  72    ENOMEM   : constant := 12;
  73    EPERM    : constant := 1;
  74    ETIMEDOUT    : constant := 60;
  75
  76    -------------
  77    -- Signals --
  78    -------------
  79
  80    Max_Interrupt : constant := 128;
  81    type Signal is new int range 0 .. Max_Interrupt;
  82    for Signal'Size use int'Size;
  83
  84    SIGHUP     : constant := 1; --  hangup
  85    SIGINT     : constant := 2; --  interrupt (rubout)
  86    SIGQUIT    : constant := 3; --  quit (ASCD FS)
  87    SIGILL     : constant := 4; --  illegal instruction (not reset)
  88    SIGTRAP    : constant := 5; --  trace trap (not reset)
  89    SIGIOT     : constant := 6; --  IOT instruction
  90    SIGABRT    : constant := 6; --  used by abort, replace SIGIOT in the  future
  91    SIGEMT     : constant := 7; --  EMT instruction
  92    SIGFPE     : constant := 8; --  floating point exception
  93    SIGKILL    : constant := 9; --  kill (cannot be caught or ignored)
  94    SIGBUS     : constant := 10; --  bus error
  95    SIGSEGV    : constant := 11; --  segmentation violation
  96    SIGSYS     : constant := 12; --  bad argument to system call
  97    SIGPIPE    : constant := 13; --  write on a pipe with no one to read it
  98    SIGALRM    : constant := 14; --  alarm clock
  99    SIGTERM    : constant := 15; --  software termination signal from kill
 100    SIGURG     : constant := 16; --  urgent condition on IO channel
 101    SIGSTOP    : constant := 17; --  stop (cannot be caught or ignored)
 102    SIGTSTP    : constant := 18; --  user stop requested from tty
 103    SIGCONT    : constant := 19; --  stopped process has been continued
 104    SIGCLD     : constant := 20; --  alias for SIGCHLD
 105    SIGCHLD    : constant := 20; --  child status change
 106    SIGTTIN    : constant := 21; --  background tty read attempted
 107    SIGTTOU    : constant := 22; --  background tty write attempted
 108    SIGIO      : constant := 23; --  I/O possible (Solaris SIGPOLL alias)
 109    SIGXCPU    : constant := 24; --  CPU time limit exceeded
 110    SIGXFSZ    : constant := 25; --  filesize limit exceeded
 111    SIGVTALRM  : constant := 26; --  virtual timer expired
 112    SIGPROF    : constant := 27; --  profiling timer expired
 113    SIGWINCH   : constant := 28; --  window size change
 114    SIGINFO    : constant := 29; --  information request (NetBSD/FreeBSD)
 115    SIGUSR1    : constant := 30; --  user defined signal 1
 116    SIGUSR2    : constant := 31; --  user defined signal 2
 117    SIGLTHRRES : constant := 32; --  GNU/LinuxThreads restart signal
 118    SIGLTHRCAN : constant := 33; --  GNU/LinuxThreads cancel signal
 119    SIGLTHRDBG : constant := 34; --  GNU/LinuxThreads debugger signal
 120
 121    SIGADAABORT : constant := SIGABRT;
 122    --  Change this if you want to use another signal for task abort.
 123    --  SIGTERM might be a good one.
 124
 125    type Signal_Set is array (Natural range <>) of Signal;
 126
 127    Unmasked    : constant Signal_Set := (
 128       SIGTRAP,
 129       --  To enable debugging on multithreaded applications, mark SIGTRAP to
 130       --  be kept unmasked.
 131
 132       SIGBUS,
 133
 134       SIGTTIN, SIGTTOU, SIGTSTP,
 135       --  Keep these three signals unmasked so that background processes
 136       --  and IO behaves as normal "C" applications
 137
 138       SIGPROF,
 139       --  To avoid confusing the profiler
 140
 141       SIGKILL, SIGSTOP,
 142       --  These two signals actually cannot be masked;
 143       --  POSIX simply won't allow it.
 144
 145       SIGLTHRRES, SIGLTHRCAN, SIGLTHRDBG);
 146       --  These three signals are used by GNU/LinuxThreads starting from
 147       --  glibc 2.1 (future 2.2).
 148
 149    Reserved    : constant Signal_Set :=
 150    --  I am not sure why the following signal is reserved.
 151    --  I guess they are not supported by this version of GNU/kFreeBSD.
 152      (0 .. 0 => SIGVTALRM);
 153
 154    type sigset_t is private;
 155
 156    function sigaddset (set : access sigset_t; sig : Signal) return int;
 157    pragma Import (C, sigaddset, "sigaddset");
 158
 159    function sigdelset (set : access sigset_t; sig : Signal) return int;
 160    pragma Import (C, sigdelset, "sigdelset");
 161
 162    function sigfillset (set : access sigset_t) return int;
 163    pragma Import (C, sigfillset, "sigfillset");
 164
 165    function sigismember (set : access sigset_t; sig : Signal) return int;
 166    pragma Import (C, sigismember, "sigismember");
 167
 168    function sigemptyset (set : access sigset_t) return int;
 169    pragma Import (C, sigemptyset, "sigemptyset");
 170
 171    --  sigcontext is architecture dependent, so define it private
 172    type struct_sigcontext is private;
 173
 174    type struct_sigaction is record
 175       sa_handler : System.Address;
 176       sa_flags   : int;
 177       sa_mask    : sigset_t;
 178    end record;
 179    pragma Convention (C, struct_sigaction);
 180
 181    type struct_sigaction_ptr is access all struct_sigaction;
 182
 183    SIG_BLOCK   : constant := 1;
 184    SIG_UNBLOCK : constant := 2;
 185    SIG_SETMASK : constant := 3;
 186
 187    SIG_DFL : constant := 0;
 188    SIG_IGN : constant := 1;
 189
 190    SA_SIGINFO : constant := 16#0040#;
 191    SA_ONSTACK : constant := 16#0001#;
 192
 193    function sigaction
 194      (sig  : Signal;
 195       act  : struct_sigaction_ptr;
 196       oact : struct_sigaction_ptr) return int;
 197    pragma Import (C, sigaction, "sigaction");
 198
 199    ----------
 200    -- Time --
 201    ----------
 202
 203    type timespec is private;
 204
 205    function To_Duration (TS : timespec) return Duration;
 206    pragma Inline (To_Duration);
 207
 208    function To_Timespec (D : Duration) return timespec;
 209    pragma Inline (To_Timespec);
 210
 211    type struct_timeval is private;
 212
 213    function To_Duration (TV : struct_timeval) return Duration;
 214    pragma Inline (To_Duration);
 215
 216    function To_Timeval (D : Duration) return struct_timeval;
 217    pragma Inline (To_Timeval);
 218
 219    function gettimeofday
 220      (tv : access struct_timeval;
 221       tz : System.Address := System.Null_Address) return int;
 222    pragma Import (C, gettimeofday, "gettimeofday");
 223
 224    function sysconf (name : int) return long;
 225    pragma Import (C, sysconf);
 226
 227    SC_CLK_TCK          : constant := 2;
 228    SC_NPROCESSORS_ONLN : constant := 84;
 229
 230    -------------------------
 231    -- Priority Scheduling --
 232    -------------------------
 233
 234    SCHED_FIFO  : constant := 1;
 235    SCHED_OTHER : constant := 2;
 236    SCHED_RR    : constant := 3;
 237
 238    function To_Target_Priority
 239      (Prio : System.Any_Priority) return Interfaces.C.int;
 240    --  Maps System.Any_Priority to a POSIX priority.
 241
 242    -------------
 243    -- Process --
 244    -------------
 245
 246    type pid_t is private;
 247
 248    function kill (pid : pid_t; sig : Signal) return int;
 249    pragma Import (C, kill, "kill");
 250
 251    function getpid return pid_t;
 252    pragma Import (C, getpid, "getpid");
 253
 254    -------------
 255    -- Threads --
 256    -------------
 257
 258    type Thread_Body is access
 259      function (arg : System.Address) return System.Address;
 260    pragma Convention (C, Thread_Body);
 261
 262    function Thread_Body_Access is new
 263      Unchecked_Conversion (System.Address, Thread_Body);
 264
 265    type pthread_t is new unsigned_long;
 266    subtype Thread_Id        is pthread_t;
 267
 268    function To_pthread_t is new Unchecked_Conversion
 269      (unsigned_long, pthread_t);
 270
 271    type pthread_mutex_t     is limited private;
 272    type pthread_cond_t      is limited private;
 273    type pthread_attr_t      is limited private;
 274    type pthread_mutexattr_t is limited private;
 275    type pthread_condattr_t  is limited private;
 276    type pthread_key_t       is private;
 277
 278    PTHREAD_CREATE_DETACHED : constant := 1;
 279
 280    -----------
 281    -- Stack --
 282    -----------
 283
 284    type stack_t is record
 285       ss_sp    : System.Address;
 286       ss_size  : size_t;
 287       ss_flags : int;
 288    end record;
 289    pragma Convention (C, stack_t);
 290
 291    function sigaltstack
 292      (ss  : not null access stack_t;
 293       oss : access stack_t) return int;
 294    pragma Import (C, sigaltstack, "sigaltstack");
 295
 296    Alternate_Stack : aliased System.Address;
 297    --  This is a dummy definition, never used (Alternate_Stack_Size is null)
 298
 299    Alternate_Stack_Size : constant := 0;
 300    --  No alternate signal stack is used on this platform
 301
 302    function Get_Stack_Base (thread : pthread_t) return Address;
 303    pragma Inline (Get_Stack_Base);
 304    --  This is a dummy procedure to share some GNULLI files
 305
 306    ---------------------------------------
 307    -- Nonstandard Thread Initialization --
 308    ---------------------------------------
 309
 310    procedure pthread_init;
 311    pragma Inline (pthread_init);
 312    --  This is a dummy procedure to share some GNULLI files
 313
 314    -------------------------
 315    -- POSIX.1c  Section 3 --
 316    -------------------------
 317
 318    function sigwait (set : access sigset_t; sig : access Signal) return int;
 319    pragma Import (C, sigwait, "sigwait");
 320
 321    function pthread_kill (thread : pthread_t; sig : Signal) return int;
 322    pragma Import (C, pthread_kill, "pthread_kill");
 323
 324    function pthread_sigmask
 325      (how  : int;
 326       set  : access sigset_t;
 327       oset : access sigset_t) return int;
 328    pragma Import (C, pthread_sigmask, "pthread_sigmask");
 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 (mutex : access pthread_mutex_t) return int;
 348    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 349
 350    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 351    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 352
 353    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 354    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 355
 356    function pthread_condattr_init
 357      (attr : access pthread_condattr_t) return int;
 358    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 359
 360    function pthread_condattr_destroy
 361      (attr : access pthread_condattr_t) return int;
 362    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 363
 364    function pthread_cond_init
 365      (cond : access pthread_cond_t;
 366       attr : access pthread_condattr_t) return int;
 367    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 368
 369    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 370    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 371
 372    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 373    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 374
 375    function pthread_cond_wait
 376      (cond  : access pthread_cond_t;
 377       mutex : access pthread_mutex_t) return int;
 378    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 379
 380    function pthread_cond_timedwait
 381      (cond    : access pthread_cond_t;
 382       mutex   : access pthread_mutex_t;
 383       abstime : access timespec) return int;
 384    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 385
 386    Relative_Timed_Wait : constant Boolean := False;
 387    --  pthread_cond_timedwait requires an absolute delay time
 388
 389    --------------------------
 390    -- POSIX.1c  Section 13 --
 391    --------------------------
 392
 393    type struct_sched_param is record
 394       sched_priority : int;  --  scheduling priority
 395    end record;
 396    pragma Convention (C, struct_sched_param);
 397
 398    function pthread_setschedparam
 399      (thread : pthread_t;
 400       policy : int;
 401       param  : access struct_sched_param) return int;
 402    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 403
 404    function pthread_attr_setschedpolicy
 405      (attr   : access pthread_attr_t;
 406       policy : int) return int;
 407    pragma Import
 408      (C, pthread_attr_setschedpolicy, "pthread_attr_setschedpolicy");
 409
 410    function sched_yield return int;
 411    pragma Import (C, sched_yield, "sched_yield");
 412
 413    ---------------------------
 414    -- P1003.1c - Section 16 --
 415    ---------------------------
 416
 417    function pthread_attr_init
 418      (attributes : access pthread_attr_t) return int;
 419    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 420
 421    function pthread_attr_destroy
 422      (attributes : access pthread_attr_t) return int;
 423    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 424
 425    function pthread_attr_setdetachstate
 426      (attr        : access pthread_attr_t;
 427       detachstate : int) return int;
 428    pragma Import
 429      (C, pthread_attr_setdetachstate, "pthread_attr_setdetachstate");
 430
 431    function pthread_attr_setstacksize
 432      (attr      : access pthread_attr_t;
 433       stacksize : size_t) return int;
 434    pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
 435
 436    function pthread_create
 437      (thread        : access pthread_t;
 438       attributes    : access pthread_attr_t;
 439       start_routine : Thread_Body;
 440       arg           : System.Address) return int;
 441    pragma Import (C, pthread_create, "pthread_create");
 442
 443    procedure pthread_exit (status : System.Address);
 444    pragma Import (C, pthread_exit, "pthread_exit");
 445
 446    function pthread_self return pthread_t;
 447    pragma Import (C, pthread_self, "pthread_self");
 448
 449    --------------------------
 450    -- POSIX.1c  Section 17 --
 451    --------------------------
 452
 453    function pthread_setspecific
 454      (key   : pthread_key_t;
 455       value : System.Address) return int;
 456    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 457
 458    function pthread_getspecific (key : pthread_key_t) return System.Address;
 459    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 460
 461    type destructor_pointer is access procedure (arg : System.Address);
 462    pragma Convention (C, destructor_pointer);
 463
 464    function pthread_key_create
 465      (key        : access pthread_key_t;
 466       destructor : destructor_pointer) return int;
 467    pragma Import (C, pthread_key_create, "pthread_key_create");
 468
 469    CPU_SETSIZE : constant := 1_024;
 470
 471    type bit_field is array (1 .. CPU_SETSIZE) of Boolean;
 472    for bit_field'Size use CPU_SETSIZE;
 473    pragma Pack (bit_field);
 474    pragma Convention (C, bit_field);
 475
 476    type cpu_set_t is record
 477       bits : bit_field;
 478    end record;
 479    pragma Convention (C, cpu_set_t);
 480
 481    function pthread_setaffinity_np
 482      (thread     : pthread_t;
 483       cpusetsize : size_t;
 484       cpuset     : access cpu_set_t) return int;
 485    pragma Import (C, pthread_setaffinity_np, "__gnat_pthread_setaffinity_np");
 486
 487 private
 488
 489    type sigset_t is array (1 .. 4) of unsigned;
 490
 491    --  In FreeBSD the component sa_handler turns out to
 492    --  be one a union type, and the selector is a macro:
 493    --  #define sa_handler __sigaction_u._handler
 494    --  #define sa_sigaction __sigaction_u._sigaction
 495
 496    --  Should we add a signal_context type here ?
 497    --  How could it be done independent of the CPU architecture ?
 498    --  sigcontext type is opaque, so it is architecturally neutral.
 499    --  It is always passed as an access type, so define it as an empty record
 500    --  since the contents are not used anywhere.
 501    type struct_sigcontext is null record;
 502    pragma Convention (C, struct_sigcontext);
 503
 504    type pid_t is new int;
 505
 506    type time_t is new long;
 507
 508    type timespec is record
 509       tv_sec  : time_t;
 510       tv_nsec : long;
 511    end record;
 512    pragma Convention (C, timespec);
 513
 514    type struct_timeval is record
 515       tv_sec  : time_t;
 516       tv_usec : time_t;
 517    end record;
 518    pragma Convention (C, struct_timeval);
 519
 520    type pthread_attr_t is record
 521       detachstate   : int;
 522       schedpolicy   : int;
 523       schedparam    : struct_sched_param;
 524       inheritsched  : int;
 525       scope         : int;
 526       guardsize     : size_t;
 527       stackaddr_set : int;
 528       stackaddr     : System.Address;
 529       stacksize     : size_t;
 530    end record;
 531    pragma Convention (C, pthread_attr_t);
 532
 533    type pthread_condattr_t is record
 534       dummy : int;
 535    end record;
 536    pragma Convention (C, pthread_condattr_t);
 537
 538    type pthread_mutexattr_t is record
 539       mutexkind : int;
 540    end record;
 541    pragma Convention (C, pthread_mutexattr_t);
 542
 543    type struct_pthread_fast_lock is record
 544       status   : long;
 545       spinlock : int;
 546    end record;
 547    pragma Convention (C, struct_pthread_fast_lock);
 548
 549    type pthread_mutex_t is record
 550       m_reserved : int;
 551       m_count    : int;
 552       m_owner    : System.Address;
 553       m_kind     : int;
 554       m_lock     : struct_pthread_fast_lock;
 555    end record;
 556    pragma Convention (C, pthread_mutex_t);
 557
 558    type pthread_cond_t is array (0 .. 47) of unsigned_char;
 559    pragma Convention (C, pthread_cond_t);
 560
 561    type pthread_key_t is new unsigned;
 562
 563 end System.OS_Interface;