1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2009 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. Politécnica 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
24 // based on previous work (FSF) done in the FIRST project
26 // Copyright (C) 2005 Mälardalen University, SWEDEN
27 // Scuola Superiore S.Anna, ITALY
28 // Universidad de Cantabria, SPAIN
29 // University of York, UK
31 // FSF API web pages: http://marte.unican.es/fsf/docs
32 // http://shark.sssup.it/contrib/first/docs/
34 // This file is part of FOSA (Frsh Operating System Adaption)
36 // FOSA is free software; you can redistribute it and/or modify it
37 // under terms of the GNU General Public License as published by the
38 // Free Software Foundation; either version 2, or (at your option) any
39 // later version. FOSA is distributed in the hope that it will be
40 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
41 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 // General Public License for more details. You should have received a
43 // copy of the GNU General Public License along with FOSA; see file
44 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
45 // Cambridge, MA 02139, USA.
47 // As a special exception, including FOSA header files in a file,
48 // instantiating FOSA generics or templates, or linking other files
49 // with FOSA objects to produce an executable application, does not
50 // by itself cause the resulting executable application to be covered
51 // by the GNU General Public License. This exception does not
52 // however invalidate any other reasons why the executable file might be
53 // covered by the GNU Public License.
54 // -----------------------------------------------------------------------
56 //==============================================
57 // ******** ****** ******** **********
58 // **///// /** ** **////// /** /**
59 // ** /** ** /** /** /**
60 // ******* /** ** /********* /**********
61 // **//// /** ** ////////** /**//////**
62 // ** /** ** /** /** /**
63 // ** /** ** ******** /** /**
64 // // /******/ //////// // //
66 // FOSA(Frescor Operating System Adaptation layer)
67 //================================================
69 #ifndef _FOSA_GROUP_CLOCKS_H
70 #define _FOSA_GROUP_CLOCKS_H
72 #include "fosa_types.h"
73 #include "fosa_configuration_parameters.h"
78 * @defgroup groupclockss Group Clocks
81 * This module defines the types and functions to manage thread sets
82 * and execution clocks attached to them. These functions are used
83 * for the hierarchical scheduling module of FRSH
91 * fosa_thread_set_create()
93 * Create an empty thread set and return an identifier
95 * This function stores in the variable pointed to by set the
96 * identifier of a thread set that is created by the function.
98 * Returns 0 if successful; otherwise it returns an error code:
99 * FOSA_EAGAIN: no resources are currently available to create the
102 * Alternatively, in case of error the implementation is allowed to
103 * notify it to the system console and then terminate the FRSH
104 * implementation and dependant applications
106 int fosa_thread_set_create(fosa_thread_set_id_t *set);
110 * fosa_thread_set_destroy()
112 * Destroy a thread set
114 * This function destroys the thread set identified by set. The
115 * threads that were in the set are detached from the set. It is
116 * an error to use the identifier after this call. The effects of
117 * using a CPU-time clock associated with the destroyed thread are
120 * Returns 0 if successful; otherwise it returns an error code:
121 * FOSA_EINVAL: set is invalid
123 * Alternatively, in case of error the implementation is allowed to
124 * notify it to the system console and then terminate the FRSH
125 * implementation and dependant applications
127 int fosa_thread_set_destroy(fosa_thread_set_id_t set);
131 * fosa_thread_set_add()
133 * Add a thread to a thread set
135 * This function adds the thread identified with thread_id to the
136 * thread set identified by set.
138 * Returns 0 if successful; otherwise it returns an error code:
139 * FOSA_EINVAL: set is invalid
140 * FOSA_ENOTSUP: thread already a member of some other set
141 * FOSA_EAGAIN: no resources available to add the new thread
142 * FOSA_ESRCH: thread_id doesn't identify a valid thread
144 * Alternatively, in case of error the implementation is allowed to
145 * notify it to the system console and then terminate the FRSH
146 * implementation and dependant applications
148 int fosa_thread_set_add(fosa_thread_set_id_t set,
149 fosa_thread_id_t thread_id);
153 * fosa_thread_set_del()
155 * Delete a thread from a thread set
157 * This function deletes the thread identified with thread_id from
158 * the thread set identified by set.
160 * Returns 0 if successful; otherwise it returns an error code:
161 * FOSA_EINVAL: set is invalid
162 * FOSA_EINVAL: thread is not a member of the set
163 * FOSA_ESRCH: thread_id doesn't identify a valid thread
165 * Alternatively, in case of error the implementation is allowed to
166 * notify it to the system console and then terminate the FRSH
167 * implementation and dependant applications
169 int fosa_thread_set_del(fosa_thread_set_id_t set,
170 fosa_thread_id_t thread_id);
174 * fosa_get_groupcpu_clock()
176 * Get the identifier of a cpu-time clock associated to a thread
179 * This function stores in the variable pointed to by clockid the
180 * identifier of a cpu-time clock for the thread set specified
183 * Returns 0 if successful; otherwise it returns an error code:
184 * FOSA_EINVAL: the set is invalid
185 * FOSA_EINVAL: clock_id is a null pointer
187 * Alternatively, in case of error the implementation is allowed to
188 * notify it to the system console and then terminate the FRSH
189 * implementation and dependant applications
191 int fosa_get_groupcpu_clock(const fosa_thread_set_id_t set,
192 fosa_clock_id_t *clock_id);