frsh_thread_attrs.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 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 FRSH API
  35 //
  36 //  FRSH API is free software; you can  redistribute it and/or  modify
  37 //  it under the terms of  the GNU General Public License as published by
  38 //  the Free Software Foundation;  either  version 2, or (at  your option)
  39 //  any later version.
  40 //
  41 //  FRSH API  is distributed  in  the hope  that  it  will  be useful,  but
  42 //  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  43 //  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  44 //  General Public License for more details.
  45 //
  46 //  You should have  received a  copy of  the  GNU  General Public License
  47 //  distributed  with  FRSH API;  see file COPYING.   If not,  write to the
  48 //  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  49 //  02111-1307, USA.
  50 //
  51 //  As a special exception, if you include this header file into source
  52 //  files to be compiled, this header file does not by itself cause
  53 //  the resulting executable to be covered by the GNU General Public
  54 //  License.  This exception does not however invalidate any other
  55 //  reasons why the executable file might be covered by the GNU General
  56 //  Public License.
  57 // -----------------------------------------------------------------------
  58 //frsh_thread.h
  59 //==============================================
  60 //  ******** *******    ********  **      **
  61 //  **///// /**////**  **//////  /**     /**
  62 //  **      /**   /** /**        /**     /**
  63 //  ******* /*******  /********* /**********
  64 //  **////  /**///**  ////////** /**//////**
  65 //  **      /**  //**        /** /**     /**
  66 //  **      /**   //** ********  /**     /**
  67 //  //       //     // ////////   //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh"
  70 //==============================================
  71 #ifndef _FRSH_THREADS_H_
  72 #define _FRSH_THREADS_H_
  73
  74 #include "frsh_core_types.h"
  75 #include "frsh_core.h"
  76
  77 FRSH_CPP_BEGIN_DECLS
  78
  79 /**
  80  * @file frsh_thread_attrs.h
  81  **/
  82
  83 /**
  84  * @defgroup threadfunc FRSH thread functions.
  85  * @ingroup core
  86  *
  87  * These functions are used to manage frsh_thread_t and
  88  * frsh_thread_attr_t used in the public API of FRSH.
  89  *
  90  * @{
  91  **/
  92
  93
  94 /*************************
  95  * Thread attributes
  96  *************************/
  97
  98 /**
  99  * frsh_thread_attr_init()
 100  *
 101  * Initialize a thread attributes object
 102  *
 103  * This function initializes the object pointed to by attr to all
 104  * the default values defined by FRSH
 105  *
 106  * @return 0 if successful; otherwise it returns \n
 107  *   FOSA_ENOMEM: insufficient memory exists to initialize the thread
 108  *           attributes object
 109  **/
 110 static inline int frsh_thread_attr_init(frsh_thread_attr_t *attr)
 111 {
 112     return fosa_thread_attr_init(attr);
 113 }
 114
 115 /**
 116  * frsh_thread_attr_destroy()
 117  *
 118  * Destroy a thread attributes object
 119  *
 120  * This function is used to destroy the thread attributes object,
 121  * pointed to by attr, and deallocate any system resources allocated for it
 122  *
 123  * Returns 0
 124  */
 125 static inline int frsh_thread_attr_destroy(frsh_thread_attr_t *attr)
 126 {
 127     return fosa_thread_attr_destroy(attr);
 128 }
 129
 130 /**
 131  * frsh_thread_attr_set_stacksize()
 132  *
 133  * Set the thread minimum stack size in a thread attributes object
 134  *
 135  * This function sets the minimum stack size of the thread attributes
 136  * object attr to the value given by stacksize, in bytes. This
 137  * function has no runtime effect on the stack size, except when the
 138  * attributes object is used to create a thread, when it will be
 139  * created with the specified minimum stack size
 140  *
 141  * @return 0 if successful, or the following error code:
 142  *    FOSA_EINVAL: the specified stacksize  value is not supported in
 143  *            this implementation
 144  */
 145 static inline int frsh_thread_attr_set_stacksize(frsh_thread_attr_t *attr, size_t stacksize)
 146 {
 147     return fosa_thread_attr_set_stacksize(attr, stacksize);
 148 }
 149
 150 /**
 151  * frsh_thread_attr_get_stacksize()
 152  *
 153  * Get the thread minimum stack size from a thread attributes object
 154  *
 155  * This function sets the variable pointed to by stacksize to the
 156  * minimum stack size stored in the thread attributes object attr.
 157  *
 158  * @return 0
 159  */
 160 static inline int frsh_thread_attr_get_stacksize
 161       (const frsh_thread_attr_t *attr, size_t *stacksize)
 162 {
 163     return fosa_thread_attr_get_stacksize(attr, stacksize);
 164 }
 165
 166
 167 /*@}*/
 168
 169 FRSH_CPP_END_DECLS
 170
 171 #endif
 172