include/fosa_thread_groups.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2008 FRESCOR consortium partners:
   3 //
   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
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  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
  21 //        made of this code.
  22 //
  23 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //   This file is part of FOSA (Frsh Operating System Adaption)
  35 //
  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.
  46 //
  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.h
  56 //==============================================
  57 //  ********  ******    ********  **********
  58 //  **///// /**    **  **//////  /**     /**
  59 //  **      /**    ** /**        /**     /**
  60 //  ******* /**    ** /********* /**********
  61 //  **////  /**    ** ////////** /**//////**
  62 //  **      /**    **        /** /**     /**
  63 //  **      /**    **  ********  /**     /**
  64 //  //       /******/  ////////   //      //
  65 //
  66 // FOSA(Frescor Operating System Adaptation layer)
  67 //================================================
  68
  69 #ifndef _FOSA_THREAD_GROUPS_H
  70 #define _FOSA_THREAD_GROUPS_H
  71
  72 #include "fosa_types.h"
  73 #include "fosa_configuration_parameters.h"
  74
  75 FOSA_CPP_BEGIN_DECLS
  76
  77 /**
  78  * @defgroup threadgroups Thread Groups
  79  * @ingroup fosa
  80  *
  81  * This module defines the types and functions to manage thread groups
  82  * and execution clocks attached to them.  These functions are used
  83  * for the hierarchical scheduling module of FRSH
  84  *
  85  * @{
  86  **/
  87
  88
  89
  90 /**
  91  * fosa_thread_group_create()
  92  *
  93  * Create an empty thread group and return an identifier
  94  *
  95  * This function stores in the variable pointed to by group the
  96  * identifier of a thread group that is created by the function.
  97  *
  98  * Returns 0 if successful; otherwise it returns an error code:
  99  *    FOSA_EAGAIN: no resources are currently available to create the
 100  *    thread group
 101  *
 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
 105  **/
 106
 107 int fosa_thread_group_create(fosa_thread_group_id_t *group);
 108
 109
 110 /**
 111  * fosa_thread_group_destroy()
 112  *
 113  * Destroy a thread group
 114  *
 115  * This function destroys the thread group identified by group. The
 116  * threads that were in the group are detached from the group.  It is
 117  * an error to use the identifier after this call. The effects of
 118  * using a CPU-time clock associated with the destroyed thread are
 119  * undefined.
 120  *
 121  * Returns 0 if successful; otherwise it returns an error code:
 122  *    FOSA_EINVAL: group is invalid
 123  *
 124  * Alternatively, in case of error the implementation is allowed to
 125  * notify it to the system console and then terminate the FRSH
 126  * implementation and dependant applications
 127  **/
 128
 129 int fosa_thread_group_destroy(fosa_thread_group_id_t group);
 130
 131
 132 /**
 133  * fosa_thread_group_add()
 134  *
 135  * Add a thread to a thread group
 136  *
 137  * This function adds the thread identified with thread_id to the
 138  * thread group identified by group.
 139  *
 140  * Returns 0 if successful; otherwise it returns an error code:
 141  *    FOSA_EINVAL: group is invalid
 142  *    FOSA_ENOTSUP: thread already a member of some other group
 143  *    FOSA_EAGAIN: no resources available to add the new thread
 144  *    FOSA_ESRCH: thread_id doesn't identify a valid thread
 145  *
 146  * Alternatively, in case of error the implementation is allowed to
 147  * notify it to the system console and then terminate the FRSH
 148  * implementation and dependant applications
 149  **/
 150
 151 int fosa_thread_group_add(fosa_thread_group_id_t group,
 152                           fosa_thread_id_t thread_id);
 153
 154
 155 /**
 156  * fosa_thread_group_del()
 157  *
 158  * Delete a thread from a thread group
 159  *
 160  * This function deletes the thread identified with thread_id from
 161  *  the thread group identified by group.
 162  *
 163  * Returns 0 if successful; otherwise it returns an error code:
 164  *    FOSA_EINVAL: group is invalid
 165  *    FOSA_EINVAL: thread is not a member of the group
 166  *    FOSA_ESRCH: thread_id doesn't identify a valid thread
 167  *
 168  * Alternatively, in case of error the implementation is allowed to
 169  * notify it to the system console and then terminate the FRSH
 170  * implementation and dependant applications
 171  **/
 172
 173 int fosa_thread_group_del(fosa_thread_group_id_t group,
 174                           fosa_thread_id_t thread_id);
 175
 176
 177 /**
 178  * fosa_get_groupcpu_clock()
 179  *
 180  * Get the identifier of a cpu-time clock associated to a thread
 181  * group
 182  *
 183  * This function stores in the variable pointed to by clockid the
 184  * identifier of a cpu-time clock for the thread group specified
 185  * by group.
 186  *
 187  * Returns 0 if successful; otherwise it returns an error code:
 188  *    FOSA_EINVAL: the group is invalid
 189  *    FOSA_EINVAL: clock_id is a null pointer
 190  *
 191  * Alternatively, in case of error the implementation is allowed to
 192  * notify it to the system console and then terminate the FRSH
 193  * implementation and dependant applications
 194  **/
 195
 196 int fosa_get_groupcpu_clock(const fosa_thread_group_id_t group,
 197                             fosa_clock_id_t *clock_id);
 198
 199
 200
 201 /*@}*/
 202
 203 FOSA_CPP_END_DECLS
 204
 205
 206
 207 #endif
 208