src_marte_os/fosa_group_clocks.c

   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_group_clocks.c
  56 //==============================================
  57 //  ********  ******    ********  **********
  58 //  **///// /**    **  **//////  /**     /**
  59 //  **      /**    ** /**        /**     /**
  60 //  ******* /**    ** /********* /**********
  61 //  **////  /**    ** ////////** /**//////**
  62 //  **      /**    **        /** /**     /**
  63 //  **      /**    **  ********  /**     /**
  64 //  //       /******/  ////////   //      //
  65 //
  66 // FOSA(Frescor Operating System Adaptation layer)
  67 //================================================
  68
  69
  70 #include <thread_sets.h>
  71
  72 #include "fosa_group_clocks.h"
  73
  74 /**
  75  * fosa_thread_set_create()
  76  *
  77  * Create an empty thread set and return an identifier
  78  *
  79  * This function stores in the variable pointed to by set the
  80  * identifier of a thread set that is created by the function.
  81  *
  82  * Returns 0 if successful; otherwise it returns an error code:
  83  *    FOSA_EAGAIN: no resources are currently available to create the
  84  *    thread set
  85  *
  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
  89  **/
  90 int fosa_thread_set_create(fosa_thread_set_id_t *set)
  91 {
  92     int error;
  93
  94     error = marte_threadset_create( (marte_thread_set_t *) set);
  95
  96     return error;
  97 }
  98
  99
 100 /**
 101  * fosa_thread_set_destroy()
 102  *
 103  * Destroy a thread set
 104  *
 105  * This function destroys the thread set identified by set. The
 106  * threads that were in the set are detached from the set.  It is
 107  * an error to use the identifier after this call. The effects of
 108  * using a CPU-time clock associated with the destroyed thread are
 109  * undefined.
 110  *
 111  * Returns 0 if successful; otherwise it returns an error code:
 112  *    FOSA_EINVAL: set is invalid
 113  *
 114  * Alternatively, in case of error the implementation is allowed to
 115  * notify it to the system console and then terminate the FRSH
 116  * implementation and dependant applications
 117  **/
 118 int fosa_thread_set_destroy(fosa_thread_set_id_t set)
 119 {
 120     int error;
 121
 122     error = marte_threadset_destroy(set);
 123
 124     return error;
 125 }
 126
 127
 128 /**
 129  * fosa_thread_set_add()
 130  *
 131  * Add a thread to a thread set
 132  *
 133  * This function adds the thread identified with thread_id to the
 134  * thread set identified by set.
 135  *
 136  * Returns 0 if successful; otherwise it returns an error code:
 137  *    FOSA_EINVAL: set is invalid
 138  *    FOSA_ENOTSUP: thread already a member of some other set
 139  *    FOSA_EAGAIN: no resources available to add the new thread
 140  *    FOSA_ESRCH: thread_id doesn't identify a valid thread
 141  *
 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
 145  **/
 146 int fosa_thread_set_add(fosa_thread_set_id_t set,
 147                           fosa_thread_id_t thread_id)
 148 {
 149     int error;
 150
 151     error = marte_threadset_add(set, thread_id);
 152
 153     return error;
 154 }
 155
 156
 157 /**
 158  * fosa_thread_set_del()
 159  *
 160  * Delete a thread from a thread set
 161  *
 162  * This function deletes the thread identified with thread_id from
 163  *  the thread set identified by set.
 164  *
 165  * Returns 0 if successful; otherwise it returns an error code:
 166  *    FOSA_EINVAL: set is invalid
 167  *    FOSA_EINVAL: thread is not a member of the set
 168  *    FOSA_ESRCH: thread_id doesn't identify a valid thread
 169  *
 170  * Alternatively, in case of error the implementation is allowed to
 171  * notify it to the system console and then terminate the FRSH
 172  * implementation and dependant applications
 173  **/
 174
 175 int fosa_thread_set_del(fosa_thread_set_id_t set,
 176                           fosa_thread_id_t thread_id)
 177 {
 178     int error;
 179
 180     error = marte_threadset_del(set, thread_id);
 181
 182     return error;
 183 }
 184
 185
 186 /**
 187  * fosa_get_groupcpu_clock()
 188  *
 189  * Get the identifier of a cpu-time clock associated to a thread
 190  * set
 191  *
 192  * This function stores in the variable pointed to by clockid the
 193  * identifier of a cpu-time clock for the thread set specified
 194  * by set.
 195  *
 196  * Returns 0 if successful; otherwise it returns an error code:
 197  *    FOSA_EINVAL: the set is invalid
 198  *    FOSA_EINVAL: clock_id is a null pointer
 199  *
 200  * Alternatively, in case of error the implementation is allowed to
 201  * notify it to the system console and then terminate the FRSH
 202  * implementation and dependant applications
 203  **/
 204 int fosa_get_groupcpu_clock(const fosa_thread_set_id_t set,
 205                             fosa_clock_id_t *clock_id)
 206 {
 207     int error;
 208
 209     error = marte_getgroupcpuclockid(set, clock_id);
 210     return error;
 211 }
 212
 213
 214
 215