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-2013, Free Software Foundation, Inc. -- 11-- -- 12-- GNAT 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 3, or (at your option) any later ver- -- 15-- sion. GNAT 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. -- 18-- -- 19-- As a special exception under Section 7 of GPL version 3, you are granted -- 20-- additional permissions described in the GCC Runtime Library Exception, -- 21-- version 3.1, as published by the Free Software Foundation. -- 22-- -- 23-- You should have received a copy of the GNU General Public License and -- 24-- a copy of the GCC Runtime Library Exception along with this program; -- 25-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see -- 26-- <http://www.gnu.org/licenses/>. -- 27-- -- 28-- GNARL was developed by the GNARL team at Florida State University. -- 29-- Extensive contributions were provided by Ada Core Technologies, Inc. -- 30-- -- 31------------------------------------------------------------------------------ 32 33-- This is a AIX (Native THREADS) version of this package 34 35-- This package encapsulates all direct interfaces to OS services that are 36-- needed by the tasking run-time (libgnarl). 37 38-- PLEASE DO NOT add any with-clauses to this package or remove the pragma 39-- Preelaborate. This package is designed to be a bottom-level (leaf) package. 40 41with Ada.Unchecked_Conversion; 42 43with Interfaces.C; 44with Interfaces.C.Extensions; 45 46package System.OS_Interface is 47 pragma Preelaborate; 48 49 pragma Linker_Options ("-pthread"); 50 -- This implies -lpthreads + other things depending on the GCC 51 -- configuration, such as the selection of a proper libgcc variant 52 -- for table-based exception handling when it is available. 53 54 pragma Linker_Options ("-lc_r"); 55 56 subtype int is Interfaces.C.int; 57 subtype short is Interfaces.C.short; 58 subtype long is Interfaces.C.long; 59 subtype long_long is Interfaces.C.Extensions.long_long; 60 subtype unsigned is Interfaces.C.unsigned; 61 subtype unsigned_short is Interfaces.C.unsigned_short; 62 subtype unsigned_long is Interfaces.C.unsigned_long; 63 subtype unsigned_char is Interfaces.C.unsigned_char; 64 subtype plain_char is Interfaces.C.plain_char; 65 subtype size_t is Interfaces.C.size_t; 66 67 ----------- 68 -- Errno -- 69 ----------- 70 71 function errno return int; 72 pragma Import (C, errno, "__get_errno"); 73 74 EAGAIN : constant := 11; 75 EINTR : constant := 4; 76 EINVAL : constant := 22; 77 ENOMEM : constant := 12; 78 ETIMEDOUT : constant := 78; 79 80 ------------- 81 -- Signals -- 82 ------------- 83 84 Max_Interrupt : constant := 63; 85 type Signal is new int range 0 .. Max_Interrupt; 86 for Signal'Size use int'Size; 87 88 SIGHUP : constant := 1; -- hangup 89 SIGINT : constant := 2; -- interrupt (rubout) 90 SIGQUIT : constant := 3; -- quit (ASCD FS) 91 SIGILL : constant := 4; -- illegal instruction (not reset) 92 SIGTRAP : constant := 5; -- trace trap (not reset) 93 SIGIOT : constant := 6; -- IOT instruction 94 SIGABRT : constant := 6; -- used by abort, replace SIGIOT in the future 95 SIGEMT : constant := 7; -- EMT instruction 96 SIGFPE : constant := 8; -- floating point exception 97 SIGKILL : constant := 9; -- kill (cannot be caught or ignored) 98 SIGBUS : constant := 10; -- bus error 99 SIGSEGV : constant := 11; -- segmentation violation 100 SIGSYS : constant := 12; -- bad argument to system call 101 SIGPIPE : constant := 13; -- write on a pipe with no one to read it 102 SIGALRM : constant := 14; -- alarm clock 103 SIGTERM : constant := 15; -- software termination signal from kill 104 SIGUSR1 : constant := 30; -- user defined signal 1 105 SIGUSR2 : constant := 31; -- user defined signal 2 106 SIGCLD : constant := 20; -- alias for SIGCHLD 107 SIGCHLD : constant := 20; -- child status change 108 SIGPWR : constant := 29; -- power-fail restart 109 SIGWINCH : constant := 28; -- window size change 110 SIGURG : constant := 16; -- urgent condition on IO channel 111 SIGPOLL : constant := 23; -- pollable event occurred 112 SIGIO : constant := 23; -- I/O possible (Solaris SIGPOLL alias) 113 SIGSTOP : constant := 17; -- stop (cannot be caught or ignored) 114 SIGTSTP : constant := 18; -- user stop requested from tty 115 SIGCONT : constant := 19; -- stopped process has been continued 116 SIGTTIN : constant := 21; -- background tty read attempted 117 SIGTTOU : constant := 22; -- background tty write attempted 118 SIGVTALRM : constant := 34; -- virtual timer expired 119 SIGPROF : constant := 32; -- profiling timer expired 120 SIGXCPU : constant := 24; -- CPU time limit exceeded 121 SIGXFSZ : constant := 25; -- filesize limit exceeded 122 SIGWAITING : constant := 39; -- m:n scheduling 123 124 -- The following signals are AIX specific 125 126 SIGMSG : constant := 27; -- input data is in the ring buffer 127 SIGDANGER : constant := 33; -- system crash imminent 128 SIGMIGRATE : constant := 35; -- migrate process 129 SIGPRE : constant := 36; -- programming exception 130 SIGVIRT : constant := 37; -- AIX virtual time alarm 131 SIGALRM1 : constant := 38; -- m:n condition variables 132 SIGCPUFAIL : constant := 59; -- Predictive De-configuration of Processors 133 SIGKAP : constant := 60; -- keep alive poll from native keyboard 134 SIGGRANT : constant := SIGKAP; -- monitor mode granted 135 SIGRETRACT : constant := 61; -- monitor mode should be relinquished 136 SIGSOUND : constant := 62; -- sound control has completed 137 SIGSAK : constant := 63; -- secure attention key 138 139 SIGADAABORT : constant := SIGEMT; 140 -- Note: on other targets, we usually use SIGABRT, but on AIX, it appears 141 -- that SIGABRT can't be used in sigwait(), so we use SIGEMT. 142 -- SIGEMT is "Emulator Trap Instruction" from the PDP-11, and does not 143 -- have a standardized usage. 144 145 type Signal_Set is array (Natural range <>) of Signal; 146 147 Unmasked : constant Signal_Set := 148 (SIGTRAP, SIGTTIN, SIGTTOU, SIGTSTP, SIGPROF); 149 Reserved : constant Signal_Set := 150 (SIGABRT, SIGKILL, SIGSTOP, SIGALRM1, SIGWAITING, SIGCPUFAIL); 151 152 type sigset_t is private; 153 154 function sigaddset (set : access sigset_t; sig : Signal) return int; 155 pragma Import (C, sigaddset, "sigaddset"); 156 157 function sigdelset (set : access sigset_t; sig : Signal) return int; 158 pragma Import (C, sigdelset, "sigdelset"); 159 160 function sigfillset (set : access sigset_t) return int; 161 pragma Import (C, sigfillset, "sigfillset"); 162 163 function sigismember (set : access sigset_t; sig : Signal) return int; 164 pragma Import (C, sigismember, "sigismember"); 165 166 function sigemptyset (set : access sigset_t) return int; 167 pragma Import (C, sigemptyset, "sigemptyset"); 168 169 type struct_sigaction is record 170 sa_handler : System.Address; 171 sa_mask : sigset_t; 172 sa_flags : int; 173 end record; 174 pragma Convention (C, struct_sigaction); 175 type struct_sigaction_ptr is access all struct_sigaction; 176 177 SA_SIGINFO : constant := 16#0100#; 178 SA_ONSTACK : constant := 16#0001#; 179 180 SIG_BLOCK : constant := 0; 181 SIG_UNBLOCK : constant := 1; 182 SIG_SETMASK : constant := 2; 183 184 SIG_DFL : constant := 0; 185 SIG_IGN : constant := 1; 186 187 function sigaction 188 (sig : Signal; 189 act : struct_sigaction_ptr; 190 oact : struct_sigaction_ptr) return int; 191 pragma Import (C, sigaction, "sigaction"); 192 193 ---------- 194 -- Time -- 195 ---------- 196 197 Time_Slice_Supported : constant Boolean := True; 198 -- Indicates whether time slicing is supported 199 200 type timespec is private; 201 202 type clockid_t is new long_long; 203 204 function clock_gettime 205 (clock_id : clockid_t; 206 tp : access timespec) return int; 207 pragma Import (C, clock_gettime, "clock_gettime"); 208 209 function To_Duration (TS : timespec) return Duration; 210 pragma Inline (To_Duration); 211 212 function To_Timespec (D : Duration) return timespec; 213 pragma Inline (To_Timespec); 214 215 type struct_timezone is record 216 tz_minuteswest : int; 217 tz_dsttime : int; 218 end record; 219 pragma Convention (C, struct_timezone); 220 type struct_timezone_ptr is access all struct_timezone; 221 222 ------------------------- 223 -- Priority Scheduling -- 224 ------------------------- 225 226 SCHED_FIFO : constant := 1; 227 SCHED_RR : constant := 2; 228 SCHED_OTHER : constant := 0; 229 230 function To_Target_Priority 231 (Prio : System.Any_Priority) return Interfaces.C.int; 232 -- Maps System.Any_Priority to a POSIX priority 233 234 ------------- 235 -- Process -- 236 ------------- 237 238 type pid_t is private; 239 240 function kill (pid : pid_t; sig : Signal) return int; 241 pragma Import (C, kill, "kill"); 242 243 function getpid return pid_t; 244 pragma Import (C, getpid, "getpid"); 245 246 --------- 247 -- LWP -- 248 --------- 249 250 function lwp_self return System.Address; 251 pragma Import (C, lwp_self, "thread_self"); 252 253 ------------- 254 -- Threads -- 255 ------------- 256 257 type Thread_Body is access 258 function (arg : System.Address) return System.Address; 259 pragma Convention (C, Thread_Body); 260 261 function Thread_Body_Access is new 262 Ada.Unchecked_Conversion (System.Address, Thread_Body); 263 264 type pthread_t is private; 265 subtype Thread_Id is pthread_t; 266 267 type pthread_mutex_t is limited private; 268 type pthread_cond_t is limited private; 269 type pthread_attr_t is limited private; 270 type pthread_mutexattr_t is limited private; 271 type pthread_condattr_t is limited private; 272 type pthread_key_t is private; 273 274 PTHREAD_CREATE_DETACHED : constant := 1; 275 276 PTHREAD_SCOPE_PROCESS : constant := 1; 277 PTHREAD_SCOPE_SYSTEM : constant := 0; 278 279 -- Read/Write lock not supported on AIX. To add support both types 280 -- pthread_rwlock_t and pthread_rwlockattr_t must properly be defined 281 -- with the associated routines pthread_rwlock_[init/destroy] and 282 -- pthread_rwlock_[rdlock/wrlock/unlock]. 283 284 subtype pthread_rwlock_t is pthread_mutex_t; 285 subtype pthread_rwlockattr_t is pthread_mutexattr_t; 286 287 ----------- 288 -- Stack -- 289 ----------- 290 291 type stack_t is record 292 ss_sp : System.Address; 293 ss_size : size_t; 294 ss_flags : int; 295 end record; 296 pragma Convention (C, stack_t); 297 298 function sigaltstack 299 (ss : not null access stack_t; 300 oss : access stack_t) return int; 301 pragma Import (C, sigaltstack, "sigaltstack"); 302 303 Alternate_Stack : aliased System.Address; 304 -- This is a dummy definition, never used (Alternate_Stack_Size is null) 305 306 Alternate_Stack_Size : constant := 0; 307 -- No alternate signal stack is used on this platform 308 309 Stack_Base_Available : constant Boolean := False; 310 -- Indicates whether the stack base is available on this target 311 312 function Get_Stack_Base (thread : pthread_t) return Address; 313 pragma Inline (Get_Stack_Base); 314 -- Returns the stack base of the specified thread. Only call this function 315 -- when Stack_Base_Available is True. 316 317 function Get_Page_Size return size_t; 318 function Get_Page_Size return Address; 319 pragma Import (C, Get_Page_Size, "getpagesize"); 320 -- Returns the size of a page 321 322 PROT_NONE : constant := 0; 323 PROT_READ : constant := 1; 324 PROT_WRITE : constant := 2; 325 PROT_EXEC : constant := 4; 326 PROT_ALL : constant := PROT_READ + PROT_WRITE + PROT_EXEC; 327 PROT_ON : constant := PROT_READ; 328 PROT_OFF : constant := PROT_ALL; 329 330 function mprotect (addr : Address; len : size_t; prot : int) return int; 331 pragma Import (C, mprotect); 332 333 --------------------------------------- 334 -- Nonstandard Thread Initialization -- 335 --------------------------------------- 336 337 -- Though not documented, pthread_init *must* be called before any other 338 -- pthread call. 339 340 procedure pthread_init; 341 pragma Import (C, pthread_init, "pthread_init"); 342 343 ------------------------- 344 -- POSIX.1c Section 3 -- 345 ------------------------- 346 347 function sigwait 348 (set : access sigset_t; 349 sig : access Signal) return int; 350 pragma Import (C, sigwait, "sigwait"); 351 352 function pthread_kill 353 (thread : pthread_t; 354 sig : Signal) return int; 355 pragma Import (C, pthread_kill, "pthread_kill"); 356 357 function pthread_sigmask 358 (how : int; 359 set : access sigset_t; 360 oset : access sigset_t) return int; 361 pragma Import (C, pthread_sigmask, "sigthreadmask"); 362 363 -------------------------- 364 -- POSIX.1c Section 11 -- 365 -------------------------- 366 367 function pthread_mutexattr_init 368 (attr : access pthread_mutexattr_t) return int; 369 pragma Import (C, pthread_mutexattr_init, "pthread_mutexattr_init"); 370 371 function pthread_mutexattr_destroy 372 (attr : access pthread_mutexattr_t) return int; 373 pragma Import (C, pthread_mutexattr_destroy, "pthread_mutexattr_destroy"); 374 375 function pthread_mutex_init 376 (mutex : access pthread_mutex_t; 377 attr : access pthread_mutexattr_t) return int; 378 pragma Import (C, pthread_mutex_init, "pthread_mutex_init"); 379 380 function pthread_mutex_destroy (mutex : access pthread_mutex_t) return int; 381 pragma Import (C, pthread_mutex_destroy, "pthread_mutex_destroy"); 382 383 function pthread_mutex_lock (mutex : access pthread_mutex_t) return int; 384 pragma Import (C, pthread_mutex_lock, "pthread_mutex_lock"); 385 386 function pthread_mutex_unlock (mutex : access pthread_mutex_t) return int; 387 pragma Import (C, pthread_mutex_unlock, "pthread_mutex_unlock"); 388 389 function pthread_condattr_init 390 (attr : access pthread_condattr_t) return int; 391 pragma Import (C, pthread_condattr_init, "pthread_condattr_init"); 392 393 function pthread_condattr_destroy 394 (attr : access pthread_condattr_t) return int; 395 pragma Import (C, pthread_condattr_destroy, "pthread_condattr_destroy"); 396 397 function pthread_cond_init 398 (cond : access pthread_cond_t; 399 attr : access pthread_condattr_t) return int; 400 pragma Import (C, pthread_cond_init, "pthread_cond_init"); 401 402 function pthread_cond_destroy (cond : access pthread_cond_t) return int; 403 pragma Import (C, pthread_cond_destroy, "pthread_cond_destroy"); 404 405 function pthread_cond_signal (cond : access pthread_cond_t) return int; 406 pragma Import (C, pthread_cond_signal, "pthread_cond_signal"); 407 408 function pthread_cond_wait 409 (cond : access pthread_cond_t; 410 mutex : access pthread_mutex_t) return int; 411 pragma Import (C, pthread_cond_wait, "pthread_cond_wait"); 412 413 function pthread_cond_timedwait 414 (cond : access pthread_cond_t; 415 mutex : access pthread_mutex_t; 416 abstime : access timespec) return int; 417 pragma Import (C, pthread_cond_timedwait, "pthread_cond_timedwait"); 418 419 Relative_Timed_Wait : constant Boolean := False; 420 -- pthread_cond_timedwait requires an absolute delay time 421 422 -------------------------- 423 -- POSIX.1c Section 13 -- 424 -------------------------- 425 426 PTHREAD_PRIO_PROTECT : constant := 2; 427 428 function PTHREAD_PRIO_INHERIT return int; 429 -- Return value of C macro PTHREAD_PRIO_INHERIT. This function is needed 430 -- since the value is different between AIX versions. 431 432 function pthread_mutexattr_setprotocol 433 (attr : access pthread_mutexattr_t; 434 protocol : int) return int; 435 pragma Import (C, pthread_mutexattr_setprotocol); 436 437 function pthread_mutexattr_setprioceiling 438 (attr : access pthread_mutexattr_t; 439 prioceiling : int) return int; 440 pragma Import (C, pthread_mutexattr_setprioceiling); 441 442 type Array_5_Int is array (0 .. 5) of int; 443 type struct_sched_param is record 444 sched_priority : int; 445 sched_policy : int; 446 sched_reserved : Array_5_Int; 447 end record; 448 449 function pthread_setschedparam 450 (thread : pthread_t; 451 policy : int; 452 param : access struct_sched_param) return int; 453 pragma Import (C, pthread_setschedparam, "pthread_setschedparam"); 454 455 function pthread_attr_setscope 456 (attr : access pthread_attr_t; 457 contentionscope : int) return int; 458 pragma Import (C, pthread_attr_setscope, "pthread_attr_setscope"); 459 460 function pthread_attr_setinheritsched 461 (attr : access pthread_attr_t; 462 inheritsched : int) return int; 463 pragma Import (C, pthread_attr_setinheritsched); 464 465 function pthread_attr_setschedpolicy 466 (attr : access pthread_attr_t; 467 policy : int) return int; 468 pragma Import (C, pthread_attr_setschedpolicy); 469 470 function pthread_attr_setschedparam 471 (attr : access pthread_attr_t; 472 sched_param : int) return int; 473 pragma Import (C, pthread_attr_setschedparam); 474 475 function sched_yield return int; 476 -- AIX have a nonstandard sched_yield 477 478 -------------------------- 479 -- P1003.1c Section 16 -- 480 -------------------------- 481 482 function pthread_attr_init (attributes : access pthread_attr_t) return int; 483 pragma Import (C, pthread_attr_init, "pthread_attr_init"); 484 485 function pthread_attr_destroy 486 (attributes : access pthread_attr_t) return int; 487 pragma Import (C, pthread_attr_destroy, "pthread_attr_destroy"); 488 489 function pthread_attr_setdetachstate 490 (attr : access pthread_attr_t; 491 detachstate : int) return int; 492 pragma Import (C, pthread_attr_setdetachstate); 493 494 function pthread_attr_setstacksize 495 (attr : access pthread_attr_t; 496 stacksize : size_t) return int; 497 pragma Import (C, pthread_attr_setstacksize); 498 499 function pthread_create 500 (thread : access pthread_t; 501 attributes : access pthread_attr_t; 502 start_routine : Thread_Body; 503 arg : System.Address) 504 return int; 505 pragma Import (C, pthread_create, "pthread_create"); 506 507 procedure pthread_exit (status : System.Address); 508 pragma Import (C, pthread_exit, "pthread_exit"); 509 510 function pthread_self return pthread_t; 511 pragma Import (C, pthread_self, "pthread_self"); 512 513 -------------------------- 514 -- POSIX.1c Section 17 -- 515 -------------------------- 516 517 function pthread_setspecific 518 (key : pthread_key_t; 519 value : System.Address) return int; 520 pragma Import (C, pthread_setspecific, "pthread_setspecific"); 521 522 function pthread_getspecific (key : pthread_key_t) return System.Address; 523 pragma Import (C, pthread_getspecific, "pthread_getspecific"); 524 525 type destructor_pointer is access procedure (arg : System.Address); 526 pragma Convention (C, destructor_pointer); 527 528 function pthread_key_create 529 (key : access pthread_key_t; 530 destructor : destructor_pointer) return int; 531 pragma Import (C, pthread_key_create, "pthread_key_create"); 532 533private 534 type sigset_t is record 535 losigs : unsigned_long; 536 hisigs : unsigned_long; 537 end record; 538 pragma Convention (C_Pass_By_Copy, sigset_t); 539 540 type pid_t is new int; 541 542 type time_t is new long; 543 544 type timespec is record 545 tv_sec : time_t; 546 tv_nsec : long; 547 end record; 548 pragma Convention (C, timespec); 549 550 type pthread_attr_t is new System.Address; 551 pragma Convention (C, pthread_attr_t); 552 -- typedef struct __pt_attr *pthread_attr_t; 553 554 type pthread_condattr_t is new System.Address; 555 pragma Convention (C, pthread_condattr_t); 556 -- typedef struct __pt_attr *pthread_condattr_t; 557 558 type pthread_mutexattr_t is new System.Address; 559 pragma Convention (C, pthread_mutexattr_t); 560 -- typedef struct __pt_attr *pthread_mutexattr_t; 561 562 type pthread_t is new System.Address; 563 pragma Convention (C, pthread_t); 564 -- typedef void *pthread_t; 565 566 type ptq_queue; 567 type ptq_queue_ptr is access all ptq_queue; 568 569 type ptq_queue is record 570 ptq_next : ptq_queue_ptr; 571 ptq_prev : ptq_queue_ptr; 572 end record; 573 574 type Array_3_Int is array (0 .. 3) of int; 575 type pthread_mutex_t is record 576 link : ptq_queue; 577 ptmtx_lock : int; 578 ptmtx_flags : long; 579 protocol : int; 580 prioceiling : int; 581 ptmtx_owner : pthread_t; 582 mtx_id : int; 583 attr : pthread_attr_t; 584 mtx_kind : int; 585 lock_cpt : int; 586 reserved : Array_3_Int; 587 end record; 588 pragma Convention (C, pthread_mutex_t); 589 type pthread_mutex_t_ptr is access pthread_mutex_t; 590 591 type pthread_cond_t is record 592 link : ptq_queue; 593 ptcv_lock : int; 594 ptcv_flags : long; 595 ptcv_waiters : ptq_queue; 596 cv_id : int; 597 attr : pthread_attr_t; 598 mutex : pthread_mutex_t_ptr; 599 cptwait : int; 600 reserved : int; 601 end record; 602 pragma Convention (C, pthread_cond_t); 603 604 type pthread_key_t is new unsigned; 605 606end System.OS_Interface; 607