1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS --
5 -- S Y S T E M . O S _ I N T E R F A C E --
9 -- Copyright (C) 1991-1994, Florida State University --
10 -- Copyright (C) 1995-2007, Free Software Foundation, Inc. --
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. --
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. --
30 -- GNARL was developed by the GNARL team at Florida State University. --
31 -- Extensive contributions were provided by Ada Core Technologies, Inc. --
33 ------------------------------------------------------------------------------
35 -- This is the VxWorks 6.x version of this package
37 -- This package encapsulates all direct interfaces to OS services
38 -- that are needed by children of System.
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.
46 package System.OS_Interface is
49 subtype int is Interfaces.C.int;
50 subtype short is Short_Integer;
51 type unsigned_int is mod 2 ** int'Size;
52 type long is new Long_Integer;
53 type unsigned_long is mod 2 ** long'Size;
54 type long_long is new Long_Long_Integer;
55 type unsigned_long_long is mod 2 ** long_long'Size;
56 type size_t is mod 2 ** Standard'Address_Size;
62 function errno return int;
63 pragma Import (C, errno, "errnoGet");
65 EINTR : constant := 4;
66 EAGAIN : constant := 35;
67 ENOMEM : constant := 12;
68 EINVAL : constant := 22;
69 ETIMEDOUT : constant := 60;
71 FUNC_ERR : constant := -1;
73 ----------------------------
74 -- Signals and Interrupts --
75 ----------------------------
77 NSIG : constant := 64;
78 -- Number of signals on the target OS
79 type Signal is new int range 0 .. Interfaces.C."-" (NSIG, 1);
81 Max_HW_Interrupt : constant := System.VxWorks.Num_HW_Interrupts - 1;
82 type HW_Interrupt is new int range 0 .. Max_HW_Interrupt;
84 Max_Interrupt : constant := Max_HW_Interrupt;
86 SIGHUP : constant := 1; -- hangup
87 SIGINT : constant := 2; -- interrupt
88 SIGQUIT : constant := 3; -- quit
89 SIGILL : constant := 4; -- illegal instruction (not reset when caught)
90 SIGTRAP : constant := 5; -- trace trap (not reset when caught)
91 SIGABRT : constant := 6; -- used by abort, replace SIGIOT in the future
92 SIGEMT : constant := 7; -- EMT instruction
93 SIGFPE : constant := 8; -- floating point exception
94 SIGKILL : constant := 9; -- kill
95 SIGBUS : constant := 10; -- bus error
96 SIGSEGV : constant := 11; -- segmentation violation
97 SIGFMT : constant := 12; -- STACK FORMAT ERROR (not posix)
98 SIGPIPE : constant := 13; -- write on a pipe with no one to read it
99 SIGALRM : constant := 14; -- alarm clock
100 SIGTERM : constant := 15; -- software termination signal from kill
101 SIGCNCL : constant := 16; -- pthreads cancellation signal
102 SIGSTOP : constant := 17; -- sendable stop signal not from tty
103 SIGTSTP : constant := 18; -- stop signal from tty
104 SIGCONT : constant := 19; -- continue a stopped process
105 SIGCHLD : constant := 20; -- to parent on child stop or exit
106 SIGTTIN : constant := 21; -- to readers pgrp upon background tty read
107 SIGTTOU : constant := 22; -- like TTIN for output
109 SIGRES1 : constant := 23; -- reserved signal number (Not POSIX)
110 SIGRES2 : constant := 24; -- reserved signal number (Not POSIX)
111 SIGRES3 : constant := 25; -- reserved signal number (Not POSIX)
112 SIGRES4 : constant := 26; -- reserved signal number (Not POSIX)
113 SIGRES5 : constant := 27; -- reserved signal number (Not POSIX)
114 SIGRES6 : constant := 28; -- reserved signal number (Not POSIX)
115 SIGRES7 : constant := 29; -- reserved signal number (Not POSIX)
117 SIGUSR1 : constant := 30; -- user defined signal 1
118 SIGUSR2 : constant := 31; -- user defined signal 2
120 SIGPOLL : constant := 32; -- pollable event
121 SIGPROF : constant := 33; -- profiling timer expired
122 SIGSYS : constant := 34; -- bad system call
123 SIGURG : constant := 35; -- high bandwidth data is available at socket
124 SIGVTALRM : constant := 36; -- virtual timer expired
125 SIGXCPU : constant := 37; -- CPU time limit exceeded
126 SIGXFSZ : constant := 38; -- file size time limit exceeded
128 SIGEVTS : constant := 39; -- signal event thread send
129 SIGEVTD : constant := 40; -- signal event thread delete
131 SIGRTMIN : constant := 48; -- Realtime signal min
132 SIGRTMAX : constant := 63; -- Realtime signal max
134 -----------------------------------
135 -- Signal processing definitions --
136 -----------------------------------
138 -- The how in sigprocmask().
139 SIG_BLOCK : constant := 1;
140 SIG_UNBLOCK : constant := 2;
141 SIG_SETMASK : constant := 3;
143 -- The sa_flags in struct sigaction.
144 SA_SIGINFO : constant := 16#0002#;
145 SA_ONSTACK : constant := 16#0004#;
147 SIG_DFL : constant := 0;
148 SIG_IGN : constant := 1;
150 type sigset_t is private;
152 type struct_sigaction is record
153 sa_handler : System.Address;
157 pragma Convention (C, struct_sigaction);
158 type struct_sigaction_ptr is access all struct_sigaction;
160 function sigaddset (set : access sigset_t; sig : Signal) return int;
161 pragma Import (C, sigaddset, "sigaddset");
163 function sigdelset (set : access sigset_t; sig : Signal) return int;
164 pragma Import (C, sigdelset, "sigdelset");
166 function sigfillset (set : access sigset_t) return int;
167 pragma Import (C, sigfillset, "sigfillset");
169 function sigismember (set : access sigset_t; sig : Signal) return int;
170 pragma Import (C, sigismember, "sigismember");
172 function sigemptyset (set : access sigset_t) return int;
173 pragma Import (C, sigemptyset, "sigemptyset");
177 act : struct_sigaction_ptr;
178 oact : struct_sigaction_ptr) return int;
179 pragma Import (C, sigaction, "sigaction");
181 type isr_address is access procedure (sig : int);
183 function c_signal (sig : Signal; handler : isr_address) return isr_address;
184 pragma Import (C, c_signal, "signal");
186 function sigwait (set : access sigset_t; sig : access Signal) return int;
187 pragma Inline (sigwait);
189 function pthread_sigmask
191 set : access sigset_t;
192 oset : access sigset_t) return int;
193 pragma Import (C, pthread_sigmask, "sigprocmask");
195 type t_id is new long;
196 subtype Thread_Id is t_id;
198 function kill (pid : t_id; sig : Signal) return int;
199 pragma Inline (kill);
201 function getpid return t_id;
202 pragma Inline (getpid);
208 type time_t is new unsigned_long;
210 type timespec is record
214 pragma Convention (C, timespec);
216 type clockid_t is private;
218 CLOCK_REALTIME : constant clockid_t; -- System wide realtime clock
220 function To_Duration (TS : timespec) return Duration;
221 pragma Inline (To_Duration);
223 function To_Timespec (D : Duration) return timespec;
224 pragma Inline (To_Timespec);
226 function To_Clock_Ticks (D : Duration) return int;
227 -- Convert a duration value (in seconds) into clock ticks
229 function clock_gettime
230 (clock_id : clockid_t; tp : access timespec) return int;
231 pragma Import (C, clock_gettime, "clock_gettime");
233 type ULONG is new unsigned_long;
235 procedure tickSet (ticks : ULONG);
236 pragma Import (C, tickSet, "tickSet");
238 function tickGet return ULONG;
239 pragma Import (C, tickGet, "tickGet");
241 ----------------------
242 -- Utility Routines --
243 ----------------------
245 function To_VxWorks_Priority (Priority : int) return int;
246 pragma Inline (To_VxWorks_Priority);
247 -- Convenience routine to convert between VxWorks priority and Ada priority
249 --------------------------
250 -- VxWorks specific API --
251 --------------------------
253 subtype STATUS is int;
254 -- Equivalent of the C type STATUS
256 OK : constant STATUS := 0;
257 ERROR : constant STATUS := Interfaces.C.int (-1);
259 function taskIdVerify (tid : t_id) return STATUS;
260 pragma Import (C, taskIdVerify, "taskIdVerify");
262 function taskIdSelf return t_id;
263 pragma Import (C, taskIdSelf, "taskIdSelf");
265 function taskOptionsGet (tid : t_id; pOptions : access int) return int;
266 pragma Import (C, taskOptionsGet, "taskOptionsGet");
268 function taskSuspend (tid : t_id) return int;
269 pragma Import (C, taskSuspend, "taskSuspend");
271 function taskResume (tid : t_id) return int;
272 pragma Import (C, taskResume, "taskResume");
274 function taskIsSuspended (tid : t_id) return int;
275 pragma Import (C, taskIsSuspended, "taskIsSuspended");
277 function taskDelay (ticks : int) return int;
278 procedure taskDelay (ticks : int);
279 pragma Import (C, taskDelay, "taskDelay");
281 function sysClkRateGet return int;
282 pragma Import (C, sysClkRateGet, "sysClkRateGet");
284 -- VxWorks 5.x specific functions
287 (tid : t_id; pVar : access System.Address) return int;
288 pragma Import (C, taskVarAdd, "taskVarAdd");
290 function taskVarDelete
291 (tid : t_id; pVar : access System.Address) return int;
292 pragma Import (C, taskVarDelete, "taskVarDelete");
296 pVar : access System.Address;
297 value : System.Address) return int;
298 pragma Import (C, taskVarSet, "taskVarSet");
302 pVar : access System.Address) return int;
303 pragma Import (C, taskVarGet, "taskVarGet");
305 -- VxWorks 6.x specific functions
307 function tlsKeyCreate return int;
308 pragma Import (C, tlsKeyCreate, "tlsKeyCreate");
310 function tlsValueGet (key : int) return System.Address;
311 pragma Import (C, tlsValueGet, "tlsValueGet");
313 function tlsValueSet (key : int; value : System.Address) return STATUS;
314 pragma Import (C, tlsValueSet, "tlsValueSet");
316 -- Option flags for taskSpawn
318 VX_UNBREAKABLE : constant := 16#0002#;
319 VX_FP_PRIVATE_ENV : constant := 16#0080#;
320 VX_NO_STACK_FILL : constant := 16#0100#;
323 (name : System.Address; -- Pointer to task name
327 start_routine : System.Address;
328 arg1 : System.Address;
337 arg10 : int := 0) return t_id;
338 pragma Import (C, taskSpawn, "taskSpawn");
340 procedure taskDelete (tid : t_id);
341 pragma Import (C, taskDelete, "taskDelete");
343 function Set_Time_Slice (ticks : int) return int;
344 pragma Inline (Set_Time_Slice);
345 -- Calls kernelTimeSlice under VxWorks 5.x
346 -- Do nothing under VxWorks 6.x
348 function taskPriorityGet (tid : t_id; pPriority : access int) return int;
349 pragma Import (C, taskPriorityGet, "taskPriorityGet");
351 function taskPrioritySet (tid : t_id; newPriority : int) return int;
352 pragma Import (C, taskPrioritySet, "taskPrioritySet");
354 -- Semaphore creation flags
356 SEM_Q_FIFO : constant := 0;
357 SEM_Q_PRIORITY : constant := 1;
358 SEM_DELETE_SAFE : constant := 4; -- only valid for binary semaphore
359 SEM_INVERSION_SAFE : constant := 8; -- only valid for binary semaphore
361 -- Semaphore initial state flags
363 SEM_EMPTY : constant := 0;
364 SEM_FULL : constant := 1;
366 -- Semaphore take (semTake) time constants
368 WAIT_FOREVER : constant := -1;
369 NO_WAIT : constant := 0;
371 -- Error codes (errno). The lower level 16 bits are the error code, with
372 -- the upper 16 bits representing the module number in which the error
373 -- occurred. By convention, the module number is 0 for UNIX errors. VxWorks
374 -- reserves module numbers 1-500, with the remaining module numbers being
375 -- available for user applications.
377 M_objLib : constant := 61 * 2**16;
378 -- semTake() failure with ticks = NO_WAIT
379 S_objLib_OBJ_UNAVAILABLE : constant := M_objLib + 2;
380 -- semTake() timeout with ticks > NO_WAIT
381 S_objLib_OBJ_TIMEOUT : constant := M_objLib + 4;
383 type SEM_ID is new System.Address;
384 -- typedef struct semaphore *SEM_ID;
386 -- We use two different kinds of VxWorks semaphores: mutex and binary
387 -- semaphores. A null ID is returned when a semaphore cannot be created.
389 function semBCreate (options : int; initial_state : int) return SEM_ID;
390 pragma Import (C, semBCreate, "semBCreate");
391 -- Create a binary semaphore. Return ID, or 0 if memory could not
394 function semMCreate (options : int) return SEM_ID;
395 pragma Import (C, semMCreate, "semMCreate");
397 function semDelete (Sem : SEM_ID) return int;
398 pragma Import (C, semDelete, "semDelete");
399 -- Delete a semaphore
401 function semGive (Sem : SEM_ID) return int;
402 pragma Import (C, semGive, "semGive");
404 function semTake (Sem : SEM_ID; timeout : int) return int;
405 pragma Import (C, semTake, "semTake");
406 -- Attempt to take binary semaphore. Error is returned if operation
409 function semFlush (SemID : SEM_ID) return STATUS;
410 pragma Import (C, semFlush, "semFlush");
411 -- Release all threads blocked on the semaphore
414 type sigset_t is new unsigned_long_long;
416 type pid_t is new int;
418 ERROR_PID : constant pid_t := -1;
420 type clockid_t is new int;
421 CLOCK_REALTIME : constant clockid_t := 0;
423 end System.OS_Interface;