1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2009 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 FRSH (FRescor ScHeduler)
36 // FRSH 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. FRSH 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 FRSH; 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 FRSH header files in a file,
48 // instantiating FRSH generics or templates, or linking other files
49 // with FRSH 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 // -----------------------------------------------------------------------
56 //==============================================
57 // ******** ******* ******** ** **
58 // **///// /**////** **////// /** /**
59 // ** /** /** /** /** /**
60 // ******* /******* /********* /**********
61 // **//// /**///** ////////** /**//////**
62 // ** /** //** /** /** /**
63 // ** /** //** ******** /** /**
64 // // // // //////// // //
66 // FRSH(FRescor ScHeduler), pronounced "fresh"
67 //==============================================
68 #ifndef _FRSH_THREADS_H_
69 #define _FRSH_THREADS_H_
71 #include "frsh_core_types.h"
72 #include "frsh_core.h"
77 * @file frsh_thread_attrs.h
81 * @defgroup threadfunc FRSH thread functions.
84 * These functions are used to manage frsh_thread_t and
85 * frsh_thread_attr_t used in the public API of FRSH.
91 /*************************
93 *************************/
96 * frsh_thread_attr_init()
98 * Initialize a thread attributes object
100 * This function initializes the object pointed to by attr to all
101 * the default values defined by FRSH
103 * @return 0 if successful; otherwise it returns \n
104 * FOSA_ENOMEM: insufficient memory exists to initialize the thread
107 static inline int frsh_thread_attr_init(frsh_thread_attr_t *attr)
109 return fosa_thread_attr_init(attr);
113 * frsh_thread_attr_destroy()
115 * Destroy a thread attributes object
117 * This function is used to destroy the thread attributes object,
118 * pointed to by attr, and deallocate any system resources allocated for it
122 static inline int frsh_thread_attr_destroy(frsh_thread_attr_t *attr)
124 return fosa_thread_attr_destroy(attr);
128 * frsh_thread_attr_set_stacksize()
130 * Set the thread minimum stack size in a thread attributes object
132 * This function sets the minimum stack size of the thread attributes
133 * object attr to the value given by stacksize, in bytes. This
134 * function has no runtime effect on the stack size, except when the
135 * attributes object is used to create a thread, when it will be
136 * created with the specified minimum stack size
138 * @return 0 if successful, or the following error code:
139 * FOSA_EINVAL: the specified stacksize value is not supported in
140 * this implementation
142 static inline int frsh_thread_attr_set_stacksize(frsh_thread_attr_t *attr, size_t stacksize)
144 return fosa_thread_attr_set_stacksize(attr, stacksize);
148 * frsh_thread_attr_get_stacksize()
150 * Get the thread minimum stack size from a thread attributes object
152 * This function sets the variable pointed to by stacksize to the
153 * minimum stack size stored in the thread attributes object attr.
157 static inline int frsh_thread_attr_get_stacksize
158 (const frsh_thread_attr_t *attr, size_t *stacksize)
160 return fosa_thread_attr_get_stacksize(attr, stacksize);