1 ------------------------------------------------------------------------------
3 -- GNU ADA RUN-TIME LIBRARY (GNARL) COMPONENTS --
5 -- S Y S T E M . O S _ I N T E R F A C E --
10 -- Copyright (C) 1997-2001 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, 59 Temple Place - Suite 330, Boston, --
21 -- MA 02111-1307, 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 version of this package.
37 -- VxWorks does not directly support the needed POSIX routines, but it
38 -- does have other routines that make it possible to code equivalent
39 -- POSIX compliant routines. The approach taken is to provide an
40 -- FSU threads compliant interface.
42 -- This package encapsulates all direct interfaces to OS services
43 -- that are needed by children of System.
45 -- PLEASE DO NOT add any with-clauses to this package
46 -- or remove the pragma Elaborate_Body.
47 -- It is designed to be a bottom-level (leaf) package.
52 package System
.OS_Interface
is
55 subtype int
is Interfaces
.C
.int
;
56 subtype short
is Short_Integer;
57 type long
is new Long_Integer;
58 type unsigned_long
is mod 2 ** long
'Size;
59 type size_t
is mod 2 ** Standard
'Address_Size;
65 function errno
return int
;
66 pragma Import
(C
, errno
, "errnoGet");
68 EINTR
: constant := 4;
69 EAGAIN
: constant := 35;
70 ENOMEM
: constant := 12;
71 EINVAL
: constant := 22;
72 ETIMEDOUT
: constant := 60;
74 FUNC_ERR
: constant := -1;
76 ----------------------------
77 -- Signals and Interrupts --
78 ----------------------------
80 NSIG
: constant := 32;
81 -- Number of signals on the target OS
82 type Signal
is new int
range 0 .. Interfaces
.C
."-" (NSIG
, 1);
84 Max_HW_Interrupt
: constant := System
.VxWorks
.Num_HW_Interrupts
- 1;
85 type HW_Interrupt
is new int
range 0 .. Max_HW_Interrupt
;
87 Max_Interrupt
: constant := Max_HW_Interrupt
;
89 SIGILL
: constant := 4; -- illegal instruction (not reset)
90 SIGABRT
: constant := 6; -- used by abort, replace SIGIOT in the future
91 SIGFPE
: constant := 8; -- floating point exception
92 SIGBUS
: constant := 10; -- bus error
93 SIGSEGV
: constant := 11; -- segmentation violation
95 -----------------------------------
96 -- Signal processing definitions --
97 -----------------------------------
99 -- The how in sigprocmask().
100 SIG_BLOCK
: constant := 1;
101 SIG_UNBLOCK
: constant := 2;
102 SIG_SETMASK
: constant := 3;
104 -- The sa_flags in struct sigaction.
105 SA_SIGINFO
: constant := 16#
0002#
;
106 SA_ONSTACK
: constant := 16#
0004#
;
108 SIG_DFL
: constant := 0;
109 SIG_IGN
: constant := 1;
111 type sigset_t
is private;
113 type struct_sigaction
is record
114 sa_handler
: System
.Address
;
118 pragma Convention
(C
, struct_sigaction
);
119 type struct_sigaction_ptr
is access all struct_sigaction
;
121 function sigaddset
(set
: access sigset_t
; sig
: Signal
) return int
;
122 pragma Import
(C
, sigaddset
, "sigaddset");
124 function sigdelset
(set
: access sigset_t
; sig
: Signal
) return int
;
125 pragma Import
(C
, sigdelset
, "sigdelset");
127 function sigfillset
(set
: access sigset_t
) return int
;
128 pragma Import
(C
, sigfillset
, "sigfillset");
130 function sigismember
(set
: access sigset_t
; sig
: Signal
) return int
;
131 pragma Import
(C
, sigismember
, "sigismember");
133 function sigemptyset
(set
: access sigset_t
) return int
;
134 pragma Import
(C
, sigemptyset
, "sigemptyset");
138 act
: struct_sigaction_ptr
;
139 oact
: struct_sigaction_ptr
) return int
;
140 pragma Import
(C
, sigaction
, "sigaction");
142 type isr_address
is access procedure (sig
: int
);
144 function c_signal
(sig
: Signal
; handler
: isr_address
) return isr_address
;
145 pragma Import
(C
, c_signal
, "signal");
147 function sigwait
(set
: access sigset_t
; sig
: access Signal
) return int
;
148 pragma Inline
(sigwait
);
150 type sigset_t_ptr
is access all sigset_t
;
152 function pthread_sigmask
155 oset
: sigset_t_ptr
) return int
;
156 pragma Import
(C
, pthread_sigmask
, "sigprocmask");
158 type t_id
is new long
;
159 subtype Thread_Id
is t_id
;
161 function kill
(pid
: t_id
; sig
: Signal
) return int
;
162 pragma Import
(C
, kill
, "kill");
164 -- VxWorks doesn't have getpid; taskIdSelf is the equivalent
166 function getpid
return t_id
;
167 pragma Import
(C
, getpid
, "taskIdSelf");
173 type time_t
is new unsigned_long
;
175 type timespec
is record
179 pragma Convention
(C
, timespec
);
181 type clockid_t
is private;
183 CLOCK_REALTIME
: constant clockid_t
; -- System wide realtime clock
185 function To_Duration
(TS
: timespec
) return Duration;
186 pragma Inline
(To_Duration
);
188 function To_Timespec
(D
: Duration) return timespec
;
189 pragma Inline
(To_Timespec
);
191 function To_Clock_Ticks
(D
: Duration) return int
;
192 -- Convert a duration value (in seconds) into clock ticks.
194 function clock_gettime
195 (clock_id
: clockid_t
; tp
: access timespec
) return int
;
196 pragma Import
(C
, clock_gettime
, "clock_gettime");
198 type ULONG
is new unsigned_long
;
200 procedure tickSet
(ticks
: ULONG
);
201 pragma Import
(C
, tickSet
, "tickSet");
203 function tickGet
return ULONG
;
204 pragma Import
(C
, tickGet
, "tickGet");
206 -----------------------------------------------------
207 -- Convenience routine to convert between VxWorks --
208 -- priority and Ada priority. --
209 -----------------------------------------------------
211 function To_VxWorks_Priority
(Priority
: in int
) return int
;
212 pragma Inline
(To_VxWorks_Priority
);
214 --------------------------
215 -- VxWorks specific API --
216 --------------------------
218 function taskIdSelf
return t_id
;
219 pragma Import
(C
, taskIdSelf
, "taskIdSelf");
221 function taskSuspend
(tid
: t_id
) return int
;
222 pragma Import
(C
, taskSuspend
, "taskSuspend");
224 function taskResume
(tid
: t_id
) return int
;
225 pragma Import
(C
, taskResume
, "taskResume");
227 function taskIsSuspended
(tid
: t_id
) return int
;
228 pragma Import
(C
, taskIsSuspended
, "taskIsSuspended");
231 (tid
: t_id
; pVar
: System
.Address
) return int
;
232 pragma Import
(C
, taskVarAdd
, "taskVarAdd");
234 function taskVarDelete
235 (tid
: t_id
; pVar
: access System
.Address
) return int
;
236 pragma Import
(C
, taskVarDelete
, "taskVarDelete");
240 pVar
: access System
.Address
;
241 value
: System
.Address
) return int
;
242 pragma Import
(C
, taskVarSet
, "taskVarSet");
246 pVar
: access System
.Address
) return int
;
247 pragma Import
(C
, taskVarGet
, "taskVarGet");
249 function taskDelay
(ticks
: int
) return int
;
250 procedure taskDelay
(ticks
: int
);
251 pragma Import
(C
, taskDelay
, "taskDelay");
253 function sysClkRateGet
return int
;
254 pragma Import
(C
, sysClkRateGet
, "sysClkRateGet");
256 -- Option flags for taskSpawn
258 VX_UNBREAKABLE
: constant := 16#
0002#
;
259 VX_FP_TASK
: constant := 16#
0008#
;
260 VX_FP_PRIVATE_ENV
: constant := 16#
0080#
;
261 VX_NO_STACK_FILL
: constant := 16#
0100#
;
264 (name
: System
.Address
; -- Pointer to task name
268 start_routine
: System
.Address
;
269 arg1
: System
.Address
;
278 arg10
: int
:= 0) return t_id
;
279 pragma Import
(C
, taskSpawn
, "taskSpawn");
281 procedure taskDelete
(tid
: t_id
);
282 pragma Import
(C
, taskDelete
, "taskDelete");
284 function kernelTimeSlice
(ticks
: int
) return int
;
285 pragma Import
(C
, kernelTimeSlice
, "kernelTimeSlice");
287 function taskPrioritySet
288 (tid
: t_id
; newPriority
: int
) return int
;
289 pragma Import
(C
, taskPrioritySet
, "taskPrioritySet");
291 subtype STATUS
is int
;
292 -- Equivalent of the C type STATUS
294 OK
: constant STATUS
:= 0;
295 ERROR
: constant STATUS
:= Interfaces
.C
.int
(-1);
297 -- Semaphore creation flags.
299 SEM_Q_FIFO
: constant := 0;
300 SEM_Q_PRIORITY
: constant := 1;
301 SEM_DELETE_SAFE
: constant := 4; -- only valid for binary semaphore
302 SEM_INVERSION_SAFE
: constant := 8; -- only valid for binary semaphore
304 -- Semaphore initial state flags
306 SEM_EMPTY
: constant := 0;
307 SEM_FULL
: constant := 1;
309 -- Semaphore take (semTake) time constants.
311 WAIT_FOREVER
: constant := -1;
312 NO_WAIT
: constant := 0;
314 -- Error codes (errno). The lower level 16 bits are the
315 -- error code, with the upper 16 bits representing the
316 -- module number in which the error occurred. By convention,
317 -- the module number is 0 for UNIX errors. VxWorks reserves
318 -- module numbers 1-500, with the remaining module numbers
319 -- being available for user applications.
321 M_objLib
: constant := 61 * 2**16;
322 -- semTake() failure with ticks = NO_WAIT
323 S_objLib_OBJ_UNAVAILABLE
: constant := M_objLib
+ 2;
324 -- semTake() timeout with ticks > NO_WAIT
325 S_objLib_OBJ_TIMEOUT
: constant := M_objLib
+ 4;
327 type SEM_ID
is new System
.Address
;
328 -- typedef struct semaphore *SEM_ID;
330 -- We use two different kinds of VxWorks semaphores: mutex
331 -- and binary semaphores. A null ID is returned when
332 -- a semaphore cannot be created.
334 function semBCreate
(options
: int
; initial_state
: int
) return SEM_ID
;
335 -- Create a binary semaphore. Return ID, or 0 if memory could not
337 pragma Import
(C
, semBCreate
, "semBCreate");
339 function semMCreate
(options
: int
) return SEM_ID
;
340 pragma Import
(C
, semMCreate
, "semMCreate");
342 function semDelete
(Sem
: SEM_ID
) return int
;
343 -- Delete a semaphore
344 pragma Import
(C
, semDelete
, "semDelete");
346 function semGive
(Sem
: SEM_ID
) return int
;
347 pragma Import
(C
, semGive
, "semGive");
349 function semTake
(Sem
: SEM_ID
; timeout
: int
) return int
;
350 -- Attempt to take binary semaphore. Error is returned if operation
352 pragma Import
(C
, semTake
, "semTake");
354 function semFlush
(SemID
: SEM_ID
) return STATUS
;
355 -- Release all threads blocked on the semaphore
356 pragma Import
(C
, semFlush
, "semFlush");
358 function taskLock
return int
;
359 pragma Import
(C
, taskLock
, "taskLock");
361 function taskUnlock
return int
;
362 pragma Import
(C
, taskUnlock
, "taskUnlock");
365 type sigset_t
is new long
;
367 type pid_t
is new int
;
369 ERROR_PID
: constant pid_t
:= -1;
371 type clockid_t
is new int
;
372 CLOCK_REALTIME
: constant clockid_t
:= 0;
374 end System
.OS_Interface
;