gcc/ada/s-osinte-rtems.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) 1997-2008 Free Software Foundation, Inc.          --
  10 --                                                                          --
  11 -- GNARL is free software; you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNARL; see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNARL was developed by the GNARL team at Florida State University.       --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 -- The GNARL files that were developed for RTEMS are maintained by  On-Line --
  33 -- Applications Research Corporation (http://www.oarcorp.com)  in  coopera- --
  34 -- tion with Ada Core Technologies Inc. and Florida State University.       --
  35 --                                                                          --
  36 ------------------------------------------------------------------------------
  37
  38 --  This is the RTEMS version of this package
  39
  40 --  These are guesses based on what I think the GNARL team will want to
  41 --  call the rtems configurations.  We use CPU-rtems for the rtems
  42 --  configurations.
  43
  44 --  This package encapsulates all direct interfaces to OS services
  45 --  that are needed by children of System.
  46
  47 --  PLEASE DO NOT add any with-clauses to this package
  48 --  or remove the pragma Elaborate_Body.
  49 --  It is designed to be a bottom-level (leaf) package.
  50
  51 with Interfaces.C;
  52 package System.OS_Interface is
  53    pragma Preelaborate;
  54
  55    --  This interface assumes that "unsigned" is a 32-bit entity.  This
  56    --  will correspond to RTEMS object ids.
  57
  58    subtype rtems_id       is Interfaces.C.unsigned;
  59
  60    subtype int            is Interfaces.C.int;
  61    subtype short          is Interfaces.C.short;
  62    subtype long           is Interfaces.C.long;
  63    subtype unsigned       is Interfaces.C.unsigned;
  64    subtype unsigned_short is Interfaces.C.unsigned_short;
  65    subtype unsigned_long  is Interfaces.C.unsigned_long;
  66    subtype unsigned_char  is Interfaces.C.unsigned_char;
  67    subtype plain_char     is Interfaces.C.plain_char;
  68    subtype size_t         is Interfaces.C.size_t;
  69
  70    -----------
  71    -- Errno --
  72    -----------
  73
  74    function errno return int;
  75    pragma Import (C, errno, "__get_errno");
  76
  77    EAGAIN    : constant := 11;
  78    EINTR     : constant := 4;
  79    EINVAL    : constant := 22;
  80    ENOMEM    : constant := 12;
  81    ETIMEDOUT : constant := 116;
  82
  83    -------------
  84    -- Signals --
  85    -------------
  86
  87    Max_Interrupt : constant := 31;
  88    type Signal is new int range 0 .. Max_Interrupt;
  89
  90    SIGXCPU     : constant := 0; --  XCPU
  91    SIGHUP      : constant := 1; --  hangup
  92    SIGINT      : constant := 2; --  interrupt (rubout)
  93    SIGQUIT     : constant := 3; --  quit (ASCD FS)
  94    SIGILL      : constant := 4; --  illegal instruction (not reset)
  95    SIGTRAP     : constant := 5; --  trace trap (not reset)
  96    SIGIOT      : constant := 6; --  IOT instruction
  97    SIGABRT     : constant := 6; --  used by abort, replace SIGIOT in the future
  98    SIGEMT      : constant := 7; --  EMT instruction
  99    SIGFPE      : constant := 8; --  floating point exception
 100    SIGKILL     : constant := 9; --  kill (cannot be caught or ignored)
 101    SIGBUS      : constant := 10; --  bus error
 102    SIGSEGV     : constant := 11; --  segmentation violation
 103    SIGSYS      : constant := 12; --  bad argument to system call
 104    SIGPIPE     : constant := 13; --  write on a pipe with no one to read it
 105    SIGALRM     : constant := 14; --  alarm clock
 106    SIGTERM     : constant := 15; --  software termination signal from kill
 107    SIGUSR1     : constant := 16; --  user defined signal 1
 108    SIGUSR2     : constant := 17; --  user defined signal 2
 109
 110    SIGADAABORT : constant := SIGABRT;
 111
 112    type Signal_Set is array (Natural range <>) of Signal;
 113
 114    Unmasked    : constant Signal_Set := (SIGTRAP, SIGALRM, SIGEMT);
 115    Reserved    : constant Signal_Set := (1 .. 1 => SIGKILL);
 116
 117    type sigset_t is private;
 118
 119    function sigaddset (set : access sigset_t; sig : Signal) return int;
 120    pragma Import (C, sigaddset, "sigaddset");
 121
 122    function sigdelset (set : access sigset_t; sig : Signal) return int;
 123    pragma Import (C, sigdelset, "sigdelset");
 124
 125    function sigfillset (set : access sigset_t) return int;
 126    pragma Import (C, sigfillset, "sigfillset");
 127
 128    function sigismember (set : access sigset_t; sig : Signal) return int;
 129    pragma Import (C, sigismember, "sigismember");
 130
 131    function sigemptyset (set : access sigset_t) return int;
 132    pragma Import (C, sigemptyset, "sigemptyset");
 133
 134    type struct_sigaction is record
 135       sa_flags   : int;
 136       sa_mask    : sigset_t;
 137       sa_handler : System.Address;
 138    end record;
 139    pragma Convention (C, struct_sigaction);
 140    type struct_sigaction_ptr is access all struct_sigaction;
 141
 142    SA_SIGINFO  : constant := 16#02#;
 143
 144    SIG_BLOCK   : constant := 1;
 145    SIG_UNBLOCK : constant := 2;
 146    SIG_SETMASK : constant := 3;
 147
 148    SIG_DFL : constant := 0;
 149    SIG_IGN : constant := 1;
 150
 151    function sigaction
 152      (sig  : Signal;
 153       act  : struct_sigaction_ptr;
 154       oact : struct_sigaction_ptr) return int;
 155    pragma Import (C, sigaction, "sigaction");
 156
 157    ----------
 158    -- Time --
 159    ----------
 160
 161    Time_Slice_Supported : constant Boolean := True;
 162    --  Indicates whether time slicing is supported (i.e SCHED_RR is supported)
 163
 164    type timespec is private;
 165
 166    type clockid_t is private;
 167
 168    CLOCK_REALTIME : constant clockid_t;
 169
 170    function clock_gettime
 171      (clock_id : clockid_t;
 172       tp       : access timespec) return int;
 173    pragma Import (C, clock_gettime, "clock_gettime");
 174
 175    function To_Duration (TS : timespec) return Duration;
 176    pragma Inline (To_Duration);
 177
 178    function To_Timespec (D : Duration) return timespec;
 179    pragma Inline (To_Timespec);
 180
 181    type struct_timeval is private;
 182
 183    function To_Duration (TV : struct_timeval) return Duration;
 184    pragma Inline (To_Duration);
 185
 186    function To_Timeval (D : Duration) return struct_timeval;
 187    pragma Inline (To_Timeval);
 188
 189    -------------------------
 190    -- Priority Scheduling --
 191    -------------------------
 192
 193    SCHED_FIFO  : constant := 1;
 194    SCHED_RR    : constant := 2;
 195    SCHED_OTHER : constant := 0;
 196
 197    function To_Target_Priority
 198      (Prio : System.Any_Priority) return Interfaces.C.int;
 199    --  Maps System.Any_Priority to a POSIX priority
 200
 201    -------------
 202    -- Process --
 203    -------------
 204
 205    type pid_t is private;
 206
 207    function kill (pid : pid_t; sig : Signal) return int;
 208    pragma Import (C, kill, "kill");
 209
 210    function getpid return pid_t;
 211    pragma Import (C, getpid, "getpid");
 212
 213    ---------
 214    -- LWP --
 215    ---------
 216
 217    function lwp_self return System.Address;
 218    --  lwp_self does not exist on this thread library, revert to pthread_self
 219    --  which is the closest approximation (with getpid). This function is
 220    --  needed to share 7staprop.adb across POSIX-like targets.
 221    pragma Import (C, lwp_self, "pthread_self");
 222
 223    -------------
 224    -- Threads --
 225    -------------
 226
 227    type Thread_Body is access
 228      function (arg : System.Address) return System.Address;
 229    pragma Convention (C, Thread_Body);
 230
 231    type pthread_t           is private;
 232    subtype Thread_Id        is pthread_t;
 233
 234    type pthread_mutex_t     is limited private;
 235    type pthread_cond_t      is limited private;
 236    type pthread_attr_t      is limited private;
 237    type pthread_mutexattr_t is limited private;
 238    type pthread_condattr_t  is limited private;
 239    type pthread_key_t       is private;
 240
 241    No_Key : constant pthread_key_t;
 242
 243    PTHREAD_CREATE_DETACHED : constant := 0;
 244
 245    PTHREAD_SCOPE_PROCESS : constant := 0;
 246    PTHREAD_SCOPE_SYSTEM  : constant := 1;
 247
 248    -----------
 249    -- Stack --
 250    -----------
 251
 252    Stack_Base_Available : constant Boolean := False;
 253    --  Indicates whether the stack base is available on this target.
 254    --  This allows us to share s-osinte.adb between all the FSU/RTEMS
 255    --  run time.
 256    --  Note that this value can only be true if pthread_t has a complete
 257    --  definition that corresponds exactly to the C header files.
 258
 259    function Get_Stack_Base (thread : pthread_t) return Address;
 260    pragma Inline (Get_Stack_Base);
 261    --  returns the stack base of the specified thread.
 262    --  Only call this function when Stack_Base_Available is True.
 263
 264    --  These two functions are only needed to share s-taprop.adb with
 265    --  FSU threads.
 266
 267    function Get_Page_Size return size_t;
 268    function Get_Page_Size return Address;
 269    --  returns the size of a page, or 0 if this is not relevant on this
 270    --  target (which is the case for RTEMS)
 271
 272    PROT_ON  : constant := 0;
 273    PROT_OFF : constant := 0;
 274
 275    function mprotect (addr : Address; len : size_t; prot : int) return int;
 276    pragma Import (C, mprotect);
 277
 278    -----------------------------------------
 279    --  Nonstandard Thread Initialization  --
 280    -----------------------------------------
 281
 282    procedure pthread_init;
 283    --  FSU_THREADS requires pthread_init, which is nonstandard
 284    --  and this should be invoked during the elaboration of s-taprop.adb
 285    --
 286    --  RTEMS does not require this so we provide an empty Ada body.
 287
 288    -------------------------
 289    -- POSIX.1c  Section 3 --
 290    -------------------------
 291
 292    function sigwait
 293      (set : access sigset_t;
 294       sig : access Signal) return int;
 295    pragma Import (C, sigwait, "sigwait");
 296
 297    function pthread_kill
 298      (thread : pthread_t;
 299       sig    : Signal) return int;
 300    pragma Import (C, pthread_kill, "pthread_kill");
 301
 302    function pthread_sigmask
 303      (how  : int;
 304       set  : access sigset_t;
 305       oset : access sigset_t) return int;
 306    pragma Import (C, pthread_sigmask, "pthread_sigmask");
 307
 308    ----------------------------
 309    --  POSIX.1c  Section 11  --
 310    ----------------------------
 311
 312    function pthread_mutexattr_init
 313      (attr : access pthread_mutexattr_t) return int;
 314    pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init");
 315
 316    function pthread_mutexattr_destroy
 317      (attr : access pthread_mutexattr_t) return int;
 318    pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy");
 319
 320    function pthread_mutex_init
 321      (mutex : access pthread_mutex_t;
 322       attr  : access pthread_mutexattr_t) return int;
 323    pragma Import (C, pthread_mutex_init, "pthread_mutex_init");
 324
 325    function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int;
 326    pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy");
 327
 328    function pthread_mutex_lock (mutex : access pthread_mutex_t) return int;
 329    pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock");
 330
 331    function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int;
 332    pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock");
 333
 334    function pthread_condattr_init
 335      (attr : access pthread_condattr_t) return int;
 336    pragma Import (C, pthread_condattr_init, "pthread_condattr_init");
 337
 338    function pthread_condattr_destroy
 339      (attr : access pthread_condattr_t) return int;
 340    pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy");
 341
 342    function pthread_cond_init
 343      (cond : access pthread_cond_t;
 344       attr : access pthread_condattr_t) return int;
 345    pragma Import (C, pthread_cond_init, "pthread_cond_init");
 346
 347    function pthread_cond_destroy (cond : access pthread_cond_t) return int;
 348    pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy");
 349
 350    function pthread_cond_signal (cond : access pthread_cond_t) return int;
 351    pragma Import (C, pthread_cond_signal, "pthread_cond_signal");
 352
 353    function pthread_cond_wait
 354      (cond  : access pthread_cond_t;
 355       mutex : access pthread_mutex_t) return int;
 356    pragma Import (C, pthread_cond_wait, "pthread_cond_wait");
 357
 358    function pthread_cond_timedwait
 359      (cond    : access pthread_cond_t;
 360       mutex   : access pthread_mutex_t;
 361       abstime : access timespec) return int;
 362    pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait");
 363
 364    Relative_Timed_Wait : constant Boolean := False;
 365    --  pthread_cond_timedwait requires an absolute delay time
 366
 367    --------------------------
 368    -- POSIX.1c  Section 13 --
 369    --------------------------
 370
 371    PTHREAD_PRIO_NONE    : constant := 0;
 372    PTHREAD_PRIO_PROTECT : constant := 2;
 373    PTHREAD_PRIO_INHERIT : constant := 1;
 374
 375    function pthread_mutexattr_setprotocol
 376      (attr     : access pthread_mutexattr_t;
 377       protocol : int) return int;
 378    pragma Import (C, pthread_mutexattr_setprotocol);
 379
 380    function pthread_mutexattr_setprioceiling
 381      (attr     : access pthread_mutexattr_t;
 382       prioceiling : int) return int;
 383    pragma Import
 384      (C, pthread_mutexattr_setprioceiling,
 385       "pthread_mutexattr_setprioceiling");
 386
 387    type struct_sched_param is record
 388       sched_priority      : int;
 389       ss_low_priority     : timespec;
 390       ss_replenish_period : timespec;
 391       ss_initial_budget   : timespec;
 392    end record;
 393    pragma Convention (C, struct_sched_param);
 394
 395    function pthread_setschedparam
 396      (thread : pthread_t;
 397       policy : int;
 398       param  : access struct_sched_param) return int;
 399    pragma Import (C, pthread_setschedparam, "pthread_setschedparam");
 400
 401    function pthread_attr_setscope
 402      (attr            : access pthread_attr_t;
 403       contentionscope : int) return int;
 404    pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope");
 405
 406    function pthread_attr_setinheritsched
 407      (attr         : access pthread_attr_t;
 408       inheritsched : int) return int;
 409    pragma Import (C, pthread_attr_setinheritsched);
 410
 411    function pthread_attr_setschedpolicy
 412      (attr   : access pthread_attr_t;
 413       policy : int) return int;
 414    pragma Import (C, pthread_attr_setschedpolicy);
 415
 416    function pthread_attr_setschedparam
 417      (attr        : access pthread_attr_t;
 418       sched_param : int) return int;
 419    pragma Import (C, pthread_attr_setschedparam);
 420
 421    function sched_yield return int;
 422    pragma Import (C, sched_yield, "sched_yield");
 423
 424    ---------------------------
 425    -- P1003.1c - Section 16 --
 426    ---------------------------
 427
 428    function pthread_attr_init (attributes : access pthread_attr_t) return int;
 429    pragma Import (C, pthread_attr_init, "pthread_attr_init");
 430
 431    function pthread_attr_destroy
 432      (attributes : access pthread_attr_t) return int;
 433    pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy");
 434
 435    function pthread_attr_setdetachstate
 436      (attr        : access pthread_attr_t;
 437       detachstate : int) return int;
 438    pragma Import (C, pthread_attr_setdetachstate);
 439
 440    function pthread_attr_setstacksize
 441      (attr      : access pthread_attr_t;
 442       stacksize : size_t) return int;
 443    pragma Import (C, pthread_attr_setstacksize, "pthread_attr_setstacksize");
 444
 445    function pthread_create
 446      (thread        : access pthread_t;
 447       attributes    : access pthread_attr_t;
 448       start_routine : Thread_Body;
 449       arg           : System.Address) return int;
 450    pragma Import (C, pthread_create, "pthread_create");
 451
 452    procedure pthread_exit (status : System.Address);
 453    pragma Import (C, pthread_exit, "pthread_exit");
 454
 455    function pthread_self return pthread_t;
 456    pragma Import (C, pthread_self, "pthread_self");
 457
 458    --------------------------
 459    -- POSIX.1c  Section 17 --
 460    --------------------------
 461
 462    function pthread_setspecific
 463      (key   : pthread_key_t;
 464       value : System.Address) return int;
 465    pragma Import (C, pthread_setspecific, "pthread_setspecific");
 466
 467    function pthread_getspecific (key : pthread_key_t) return System.Address;
 468    pragma Import (C, pthread_getspecific, "pthread_getspecific");
 469
 470    type destructor_pointer is access procedure (arg : System.Address);
 471    pragma Convention (C, destructor_pointer);
 472
 473    function pthread_key_create
 474      (key        : access pthread_key_t;
 475       destructor : destructor_pointer) return int;
 476    pragma Import (C, pthread_key_create, "pthread_key_create");
 477
 478 private
 479
 480    type sigset_t is new int;
 481
 482    type pid_t is new int;
 483
 484    type time_t is new long;
 485
 486    type timespec is record
 487       tv_sec  : time_t;
 488       tv_nsec : long;
 489    end record;
 490    pragma Convention (C, timespec);
 491
 492    type clockid_t is new rtems_id;
 493    CLOCK_REALTIME : constant clockid_t := 1;
 494
 495    type struct_timeval is record
 496       tv_sec  : int;
 497       tv_usec : int;
 498    end record;
 499    pragma Convention (C, struct_timeval);
 500
 501    type pthread_attr_t is record
 502       is_initialized  : int;
 503       stackaddr       : System.Address;
 504       stacksize       : int;
 505       contentionscope : int;
 506       inheritsched    : int;
 507       schedpolicy     : int;
 508       schedparam      : struct_sched_param;
 509       cputime_clocked_allowed : int;
 510       deatchstate     : int;
 511    end record;
 512    pragma Convention (C, pthread_attr_t);
 513
 514    type pthread_condattr_t is record
 515       flags        : int;
 516    end record;
 517    pragma Convention (C, pthread_condattr_t);
 518
 519    type pthread_mutexattr_t is record
 520       is_initialized  : int;
 521       process_shared  : int;
 522       prio_ceiling    : int;
 523       protocol        : int;
 524       recursive       : int;
 525    end record;
 526    pragma Convention (C, pthread_mutexattr_t);
 527
 528    type pthread_t is new rtems_id;
 529
 530    type pthread_mutex_t is new rtems_id;
 531
 532    type pthread_cond_t is new rtems_id;
 533
 534    type pthread_key_t is new rtems_id;
 535
 536    No_Key : constant pthread_key_t := 0;
 537
 538 end System.OS_Interface;