1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2008 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 // -----------------------------------------------------------------------
55 //fosa_thread_groups.c
56 //==============================================
57 // ******** ****** ******** **********
58 // **///// /** ** **////// /** /**
59 // ** /** ** /** /** /**
60 // ******* /** ** /********* /**********
61 // **//// /** ** ////////** /**//////**
62 // ** /** ** /** /** /**
63 // ** /** ** ******** /** /**
64 // // /******/ //////// // //
66 // FOSA(Frescor Operating System Adaptation layer)
67 //================================================
70 #include <thread_sets.h>
72 #include "fosa_thread_groups.h"
75 * fosa_thread_group_create()
77 * Create an empty thread group and return an identifier
79 * This function stores in the variable pointed to by group the
80 * identifier of a thread group that is created by the function.
82 * Returns 0 if successful; otherwise it returns an error code:
83 * FOSA_EAGAIN: no resources are currently available to create the
86 * Alternatively, in case of error the implementation is allowed to
87 * notify it to the system console and then terminate the FRSH
88 * implementation and dependant applications
91 int fosa_thread_group_create(fosa_thread_group_id_t *group)
95 error = marte_threadset_create( (marte_thread_set_t *) group);
102 * fosa_thread_group_destroy()
104 * Destroy a thread group
106 * This function destroys the thread group identified by group. The
107 * threads that were in the group are detached from the group. It is
108 * an error to use the identifier after this call. The effects of
109 * using a CPU-time clock associated with the destroyed thread are
112 * Returns 0 if successful; otherwise it returns an error code:
113 * FOSA_EINVAL: group is invalid
115 * Alternatively, in case of error the implementation is allowed to
116 * notify it to the system console and then terminate the FRSH
117 * implementation and dependant applications
119 int fosa_thread_group_destroy(fosa_thread_group_id_t group)
123 error = marte_threadset_destroy(group);
129 * fosa_thread_group_add()
131 * Add a thread to a thread group
133 * This function adds the thread identified with thread_id to the
134 * thread group identified by group.
136 * Returns 0 if successful; otherwise it returns an error code:
137 * FOSA_EINVAL: group is invalid
138 * FOSA_ENOTSUP: thread already a member of some other group
139 * FOSA_EAGAIN: no resources available to add the new thread
140 * FOSA_ESRCH: thread_id doesn't identify a valid thread
142 * Alternatively, in case of error the implementation is allowed to
143 * notify it to the system console and then terminate the FRSH
144 * implementation and dependant applications
147 int fosa_thread_group_add(fosa_thread_group_id_t group,
148 fosa_thread_id_t thread_id)
152 error = marte_threadset_add(group, thread_id);
160 * fosa_thread_group_del()
162 * Delete a thread from a thread group
164 * This function deletes the thread identified with thread_id from
165 * the thread group identified by group.
167 * Returns 0 if successful; otherwise it returns an error code:
168 * FOSA_EINVAL: group is invalid
169 * FOSA_EINVAL: thread is not a member of the group
170 * FOSA_ESRCH: thread_id doesn't identify a valid thread
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_thread_group_del(fosa_thread_group_id_t group,
177 fosa_thread_id_t thread_id)
181 error = marte_threadset_del(group, thread_id);
188 * fosa_get_groupcpu_clock()
190 * Get the identifier of a cpu-time clock associated to a thread
193 * This function stores in the variable pointed to by clockid the
194 * identifier of a cpu-time clock for the thread group specified
197 * Returns 0 if successful; otherwise it returns an error code:
198 * FOSA_EINVAL: the group is invalid
199 * FOSA_EINVAL: clock_id is a null pointer
201 * Alternatively, in case of error the implementation is allowed to
202 * notify it to the system console and then terminate the FRSH
203 * implementation and dependant applications
205 int fosa_get_groupcpu_clock(const fosa_thread_group_id_t group,
206 fosa_clock_id_t *clock_id)
210 error = marte_getgroupcpuclockid(group, clock_id);