1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2007 FRESCOR consortium partners:
4 // Universidad de Cantabria, SPAIN
5 // University of York, UK
6 // Scuola Superiore Sant'Anna, ITALY
7 // Kaiserslautern University, GERMANY
8 // Univ. Politecnica Valencia, SPAIN
9 // Czech Technical University in Prague, CZECH REPUBLIC
11 // Thales Communication S.A. FRANCE
12 // Visual Tools S.A. SPAIN
13 // Rapita Systems Ltd UK
16 // See http://www.frescor.org for a link to partners' websites
18 // FRESCOR project (FP6/2005/IST/5-034026) is funded
19 // in part by the European Union Sixth Framework Programme
20 // The European Union is not liable of any use that may be
23 // This file is part of the FRSH implementation
25 // FRSH is free software; you can redistribute it and/or modify
26 // it under the terms of the GNU General Public License as published by
27 // the Free Software Foundation; either version 2, or (at your option)
30 // FRSH is distributed in the hope that it will be useful, but
31 // WITHOUT ANY WARRANTY; without even the implied warranty of
32 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
33 // General Public License for more details.
35 // You should have received a copy of the GNU General Public License
36 // distributed with FRSH; see file COPYING. If not, write to the
37 // Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
40 // As a special exception, if you include this header file into source
41 // files to be compiled, this header file does not by itself cause
42 // the resulting executable to be covered by the GNU General Public
43 // License. This exception does not however invalidate any other
44 // reasons why the executable file might be covered by the GNU General
46 // -----------------------------------------------------------------------
47 //fosa_clocks_and_timers.h
48 //==============================================
49 // ******** ****** ******** **********
50 // **///// /** ** **////// /** /**
51 // ** /** ** /** /** /**
52 // ******* /** ** /********* /**********
53 // **//// /** ** ////////** /**//////**
54 // ** /** ** /** /** /**
55 // ** /** ** ******** /** /**
56 // // /******/ //////// // //
58 // FOSA(Frescor Operating System Adaptation layer)
59 //================================================
62 #ifndef FOSA_CLOCKS_AND_TIMERS_H_
63 #define FOSA_CLOCKS_AND_TIMERS_H_
66 * @defgroup clocksandtimers Clocks and Timers
69 * This module defines the types and functions to abstract clocks and
70 * timers for the FRSH implementation.
77 /*************************
79 *************************/
84 * Get the time from a clock
86 * This function sets the variable pointed to by current_time to the
87 * current value of the clock specified by clockid, which may be the
88 * FOSA_CLOCK_REALTIME constant or a value obtained with
89 * fosa_get_cputime_clock()
91 * Returns 0 if successful; otherwise it returns an error code:
92 * EINVAL: the value of clockid is invalid
94 * Alternatively, in case of error the implementation is allowed to
95 * notify it to the system console and then terminate the FRSH
96 * implementation and dependant applications
98 int fosa_clock_get_time(fosa_clock_id_t clockid, struct timespec *current_time);
102 * fosa_get_cputime_clock()
104 * Get the identifier of a cpu-time clock
106 * This function stores in the variable pointed to by clockid the
107 * identifier of a cpu-time clock for the thread specified by tid.
109 * Returns 0 if successful; otherwise it returns an error code:
110 * EINVAL: the value of tid is invalid
112 * Alternatively, in case of error the implementation is allowed to
113 * notify it to the system console and then terminate the FRSH
114 * implementation and dependant applications
116 int fosa_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid);
119 /*************************
121 *************************/
124 * fosa_timer_create()
126 * Create a one-shot timer
128 * This function creates a timer based on the clock specified by clock,
129 * and associates to this timer a notification mechanism consisting of
130 * a signal and associated information. Initially, the timer is in the
131 * disarmed state, i.e., not counting time. It can be armed to start
132 * counting time with fosa_timer_arm().
134 * The function stores the identifier of the newly created timer in the
135 * variable pointed to by timerid.
137 * When the timer expires, the signal number specified by signal will be
138 * sent together with the information specified by info, to the thread
139 * that armed the timer (@see fosa_timer_arm()).
141 * In those implementations that do not support queueing a
142 * signal with information to a thread (such as POSIX), the signal may
143 * be sent to any thread that is waiting for this signal via
144 * fosa_signal_wait(). Portability can be ensured by having the receiver
145 * thread be the one who is waiting for the signal.
147 * Returns 0 if successful; otherwise it returns an error code:
148 * EINVAL: the value of clockid or signal is invalid
150 * EAGAIN: the system lacks enough resources to create the timer
152 * Alternatively, in case of error the implementation is allowed to
153 * notify it to the system console and then terminate the FRSH
154 * implementation and dependant applications
156 int fosa_timer_create
157 (fosa_clock_id_t clockid, frsh_signal_t signal, frsh_signal_info_t info,
158 fosa_timer_id_t *timerid);
161 * fosa_timer_delete()
165 * The function deletes the timer specified by timerid, which becomes
166 * unusable. If the timer was armed, it is automatically disarmed before
169 * Returns 0 if successful; otherwise it returns an error code:
170 * EINVAL: the value of timerid is not valid
172 * Alternatively, in case of error the implementation is allowed to
173 * notify it to the system console and then terminate the FRSH
174 * implementation and dependant applications
176 int fosa_timer_delete(fosa_timer_id_t timerid);
183 * The timer specified by timer is armed and starts counting time.
185 * If abstime is true, the value pointed to by value is the absolute
186 * time at which the timer will expire. If value specifies a time instant
187 * in the past, the timer expires immediately.
189 * If abstime is false, the value pointed to by value is the relative interval
190 * that must elapse for the timer to expire.
192 * In both cases, absolute or relative, the time is measured with the clock
193 * associated with the timer when it was created.
195 * If the timer was already armed, the previous time or interval is discarded
196 * and the timer is rearmed with the new value.
198 * When the timer expires, it is disarmed.
200 * Returns 0 if successful; otherwise it returns an error code:
201 * EINVAL: the value of timerid or value is invalid
203 * Alternatively, in case of error the implementation is allowed to
204 * notify it to the system console and then terminate the FRSH
205 * implementation and dependant applications
208 (fosa_timer_id_t timerid, bool abstime,
209 const struct timespec *value);
212 * fosa_timer_get_remaining_time()
214 * Get the remaining time for timer expiration
216 * Returns the relative remaining time for timer expiration. If the
217 * clock is a CPU clock it returns the time as if the thread was
218 * executing constantly.
220 * If the timer is disarmed it returns 0.
222 * Returns 0 if successful; otherwise it returns an error code:
223 * EINVAL: the value of timerid or value is invalid
225 * Alternatively, in case of error the implementation is allowed to
226 * notify it to the system console and then terminate the FRSH
227 * implementation and dependant applications
229 int fosa_timer_get_remaining_time
230 (fosa_timer_id_t timerid, struct timespec *remaining_time);
236 * fosa_timer_disarm()
238 * Disarm a timer and optionally obtain remaining time before expiration
240 * The timer specified by timer is disarmed, and will not expire unless
241 * it is rearmed. If the timer was already disramed, the function has
244 * If the pointer remaining_time is != NULL, the remaining time before
245 * expiration will be returned in that pointer. If the timer was
246 * disarmed a 0 value will be set.
248 * Returns 0 if successful; otherwise it returns an error code:
249 * EINVAL: the value of timerid or value is invalid
251 * Alternatively, in case of error the implementation is allowed to
252 * notify it to the system console and then terminate the FRSH
253 * implementation and dependant applications
255 int fosa_timer_disarm(fosa_timer_id_t timerid, struct timespec
262 #endif /* !FOSA_CLOCKS_AND_TIMERS_H_ */