// however invalidate any other reasons why the executable file might be
// covered by the GNU Public License.
// -----------------------------------------------------------------------
-//fosa_thread_groups.h
+//fosa_group_clocks.h
//==============================================
// ******** ****** ******** **********
// **///// /** ** **////// /** /**
// FOSA(Frescor Operating System Adaptation layer)
//================================================
-#ifndef _FOSA_THREAD_GROUPS_H
-#define _FOSA_THREAD_GROUPS_H
+#ifndef _FOSA_GROUP_CLOCKS_H
+#define _FOSA_GROUP_CLOCKS_H
#include "fosa_types.h"
#include "fosa_configuration_parameters.h"
FOSA_CPP_BEGIN_DECLS
/**
- * @defgroup threadgroups Thread Groups
+ * @defgroup groupclockss Group Clocks
* @ingroup fosa
*
- * This module defines the types and functions to manage thread groups
+ * This module defines the types and functions to manage thread sets
* and execution clocks attached to them. These functions are used
* for the hierarchical scheduling module of FRSH
*
/**
- * fosa_thread_group_create()
+ * fosa_thread_set_create()
*
- * Create an empty thread group and return an identifier
+ * Create an empty thread set and return an identifier
*
- * This function stores in the variable pointed to by group the
- * identifier of a thread group that is created by the function.
+ * This function stores in the variable pointed to by set the
+ * identifier of a thread set that is created by the function.
*
* Returns 0 if successful; otherwise it returns an error code:
* FOSA_EAGAIN: no resources are currently available to create the
- * thread group
+ * thread set
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-
-int fosa_thread_group_create(fosa_thread_group_id_t *group);
+int fosa_thread_set_create(fosa_thread_set_id_t *set);
/**
- * fosa_thread_group_destroy()
+ * fosa_thread_set_destroy()
*
- * Destroy a thread group
+ * Destroy a thread set
*
- * This function destroys the thread group identified by group. The
- * threads that were in the group are detached from the group. It is
+ * This function destroys the thread set identified by set. The
+ * threads that were in the set are detached from the set. It is
* an error to use the identifier after this call. The effects of
* using a CPU-time clock associated with the destroyed thread are
* undefined.
*
* Returns 0 if successful; otherwise it returns an error code:
- * FOSA_EINVAL: group is invalid
+ * FOSA_EINVAL: set is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-
-int fosa_thread_group_destroy(fosa_thread_group_id_t group);
+int fosa_thread_set_destroy(fosa_thread_set_id_t set);
/**
- * fosa_thread_group_add()
+ * fosa_thread_set_add()
*
- * Add a thread to a thread group
+ * Add a thread to a thread set
*
* This function adds the thread identified with thread_id to the
- * thread group identified by group.
+ * thread set identified by set.
*
* Returns 0 if successful; otherwise it returns an error code:
- * FOSA_EINVAL: group is invalid
- * FOSA_ENOTSUP: thread already a member of some other group
+ * FOSA_EINVAL: set is invalid
+ * FOSA_ENOTSUP: thread already a member of some other set
* FOSA_EAGAIN: no resources available to add the new thread
* FOSA_ESRCH: thread_id doesn't identify a valid thread
*
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-
-int fosa_thread_group_add(fosa_thread_group_id_t group,
+int fosa_thread_set_add(fosa_thread_set_id_t set,
fosa_thread_id_t thread_id);
/**
- * fosa_thread_group_del()
+ * fosa_thread_set_del()
*
- * Delete a thread from a thread group
+ * Delete a thread from a thread set
*
* This function deletes the thread identified with thread_id from
- * the thread group identified by group.
+ * the thread set identified by set.
*
* Returns 0 if successful; otherwise it returns an error code:
- * FOSA_EINVAL: group is invalid
- * FOSA_EINVAL: thread is not a member of the group
+ * FOSA_EINVAL: set is invalid
+ * FOSA_EINVAL: thread is not a member of the set
* FOSA_ESRCH: thread_id doesn't identify a valid thread
*
* Alternatively, in case of error the implementation is allowed to
* implementation and dependant applications
**/
-int fosa_thread_group_del(fosa_thread_group_id_t group,
+int fosa_thread_set_del(fosa_thread_set_id_t set,
fosa_thread_id_t thread_id);
/**
- * fosa_get_groupcpu_clock()
+ * fosa_get_setcpu_clock()
*
* Get the identifier of a cpu-time clock associated to a thread
- * group
+ * set
*
* This function stores in the variable pointed to by clockid the
- * identifier of a cpu-time clock for the thread group specified
- * by group.
+ * identifier of a cpu-time clock for the thread set specified
+ * by set.
*
* Returns 0 if successful; otherwise it returns an error code:
- * FOSA_EINVAL: the group is invalid
+ * FOSA_EINVAL: the set is invalid
* FOSA_EINVAL: clock_id is a null pointer
*
* Alternatively, in case of error the implementation is allowed to
* implementation and dependant applications
**/
-int fosa_get_groupcpu_clock(const fosa_thread_group_id_t group,
+int fosa_get_groupcpu_clock(const fosa_thread_set_id_t set,
fosa_clock_id_t *clock_id);
projects / frescor / fosa.git / commitdiff