include/fosa_threads_and_signals.h

   1 //----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 by the FRESCOR consortium:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politecnica  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
  17 //
  18 //        The 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 // This file is part of FOSA (Frsh Operating System Abstraction)
  32 //
  33 // FOSA is free software; you can redistribute it and/or modify it
  34 // under terms of the GNU General Public License as published by the
  35 // Free Software Foundation; either version 2, or (at your option) any
  36 // later version.  FOSA is distributed in the hope that it will be
  37 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  38 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  39 // General Public License for more details. You should have received a
  40 // copy of the GNU General Public License along with FOSA; see file
  41 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  42 // Cambridge, MA 02139, USA.
  43 //
  44 // As a special exception, including FOSA header files in a file,
  45 // instantiating FOSA generics or templates, or linking other files
  46 // with FOSA objects to produce an executable application, does not
  47 // by itself cause the resulting executable application to be covered
  48 // by the GNU General Public License. This exception does not
  49 // however invalidate any other reasons why the executable file might be
  50 // covered by the GNU Public License.
  51 // -----------------------------------------------------------------------
  52 //fosa_thread_and_signals.h
  53 //==============================================
  54 //  ********  ******    ********  **********
  55 //  **///// /**    **  **//////  /**     /**
  56 //  **      /**    ** /**        /**     /**
  57 //  ******* /**    ** /********* /**********
  58 //  **////  /**    ** ////////** /**//////**
  59 //  **      /**    **        /** /**     /**
  60 //  **      /**    **  ********  /**     /**
  61 //  //       /******/  ////////   //      //
  62 //
  63 // FOSA(Frescor Operating System Adaptation layer)
  64 //================================================
  65
  66
  67 #ifndef         FOSA_THREAD_AND_SIGNALS_H_
  68 #define         FOSA_THREAD_AND_SIGNALS_H_
  69
  70 #include "fosa_types.h"
  71
  72 /**
  73  * @defgroup threadandsignals Thread and Signals
  74  * @ingroup fosa
  75  *
  76  * This module defines the functions that manipulate frsh_threads and
  77  * frsh_signals inside FRSH implementation.
  78  *
  79  * Applications can refer to FRSH threads but they cannot create them
  80  * directly, instead they must use frsh_thread_create*() which in turn
  81  * use fosa_thread_create().
  82  *
  83  * For signals, we assume that the OS provides a direct mapping
  84  * for frsh_signal_t and frsh_signal_info_t in the native interface.
  85  *
  86  * @{
  87  **/
  88
  89
  90
  91 /*************************
  92  * Thread identification
  93  *************************/
  94
  95 /**
  96  * fosa_thread_equal()
  97  *
  98  * Compare two thread identifiers to determine if they refer to the
  99  * same thread
 100  **/
 101 bool fosa_thread_equal(frsh_thread_id_t t1, frsh_thread_id_t t2);
 102
 103
 104 /**
 105  * fosa_thread_self()
 106  *
 107  * Return the thread id of the calling thread
 108  **/
 109 frsh_thread_id_t fosa_thread_self();
 110
 111
 112 /*************************
 113  * Thread creation and termination
 114  *************************/
 115
 116 /**
 117  * fosa_thread_create()
 118  *
 119  * This function creates a new thread using the attributes specified
 120  * in attr. If attr is NULL, default attributes are used. The new
 121  * thread starts running immediately, executing the function specified
 122  * by code, with an argument equal to arg. Upon successful return, the
 123  * variable pointed to by tid will contain the identifier of the newly
 124  * created thread. The set of signals that may be synchronously
 125  * accepted is inherited from the parent thread.
 126  *
 127  * Returns 0 if successful; otherwise it returs a code error:
 128  *
 129  *     FOSA_EAGAIN: the system lacks the necessary resources to create a
 130  *             new thread or the maximum number of threads has been
 131  *             reached
 132  *
 133  *     FOSA_EINVAL: the value specified by attr is invalid (for instance,
 134  *              it has not been correctly initialized)
 135  *
 136  *     FOSA_EREJECT: the cretion of the thread was rejected by the frsh scheduler
 137  *               possibly because of incorrect attributes, or because the
 138  *               requested minimum capacity cannot be guaranteed
 139  *
 140  **/
 141  int fosa_thread_create
 142     (frsh_thread_id_t *tid, const frsh_thread_attr_t *attr,
 143      frsh_thread_code_t code, void * arg);
 144
 145
 146 /**
 147  * Note: no thread termination primitive is provided. The termination
 148  * of a thread will be notified by the system to the FRSH scheduler
 149  * through the scheduler API
 150  **/
 151
 152
 153 /**************************************************
 154  * Thread-specific data
 155  *  (extended with access from a different thread)
 156  *
 157  * Several data items (pointers) may be associated with each thread
 158  * Each item is identified through a key, an integer value between 0
 159  * and FOSA_MAX_KEYS-1. The caller is responsible of allocating and
 160  * deallocating the memory area pointed to by the pointer
 161  **************************************************/
 162
 163 /**
 164  * fosa_key_create()
 165  *
 166  * Create a new key for thread specific data.
 167  *
 168  * Prior to setting data in a key, we need ask the system to create
 169  * one for us.
 170  *
 171  * @return 0 if successful \n
 172  *   FOSA_EINVAL If we already have reached the FOSA_MAX_KEYS limit.
 173  *   FOSA_ENOMEM If there are no enough memory resources to
 174  *               create the key.
 175  **/
 176 int fosa_key_create(int *key);
 177
 178 /**
 179  * fosa_key_destroy()
 180  *
 181  * Destroy a key
 182  *
 183  * This destroys the key and isables its use in the system
 184  *
 185  * @return 0 if successful \n
 186  *   FOSA_EINVAL The key is not initialised or is not in FOSA key range.
 187  **/
 188 int fosa_key_destroy(int key);
 189
 190
 191 /**
 192  * fosa_thread_set_specific_data()
 193  *
 194  * Set thread-specific data
 195  *
 196  * For the thread identified by tid, the thread-specifid data field
 197  * identified by key will be set to the value specified by value
 198  *
 199  * Returns 0 if successful; otherwise, an error code is returned
 200  *     FOSA_EINVAL: the value of key is not between 0 and FOSA_MAX_KEYS-1
 201  *
 202  * Alternatively, in case of error the implementation is allowed to
 203  * notify it to the system console and then terminate the FRSH
 204  * implementation and dependant applications
 205  **/
 206  int fosa_thread_set_specific_data
 207        (int key, frsh_thread_id_t tid, const void * value);
 208
 209 /**
 210  * fosa_thread_get_specific_data()
 211  *
 212  * Get thread-specific data
 213  *
 214  * For the thread identified by tid, the thread-specifid data field
 215  * identified by key will be copied to the variable pointed to by value
 216  *
 217  * Returns 0 if successful; otherwise, an error code is returned
 218  *     FOSA_EINVAL: the value of key is not between 0 and FOSA_MAX_KEYS-1
 219  *
 220  * Alternatively, in case of error the implementation is allowed to
 221  * notify it to the system console and then terminate the FRSH
 222  * implementation and dependant applications
 223  **/
 224 int fosa_thread_get_specific_data(int key, frsh_thread_id_t tid,
 225                                   void ** value);
 226
 227
 228 /******************************************************************
 229  * Thread scheduling
 230  *
 231  * This implementation of FRSH assumes an underlying fixed priority
 232  * scheduler with priorities in a range, with a minimum and a
 233  * maximumm, a number of priority levels with at least 31
 234  * priorities. A larger number implies a larger priority. In systems
 235  * in which the underlying scheduler uses the opposite convention, a
 236  * mapping is automatically provided by the OS adaptation layer.
 237  *******************************************************************/
 238
 239 /**
 240  * fosa_get_priority_max()
 241  *
 242  * Return the maximum priority value used in this implementation
 243  **/
 244 int fosa_get_priority_max();
 245
 246 /**
 247  * fosa_get_priority_min()
 248  *
 249  * Return the minimum priority value used in this implementation
 250  **/
 251 int fosa_get_priority_min();
 252
 253 /**
 254  * fosa_thread_attr_set_prio()
 255  *
 256  * Change the priority of a thread attributes object
 257  *
 258  * The priority of the thread attriutes object specified by attr is
 259  * set to the value specified by prio. This function has no runtime
 260  * effect on the priority, except when the attributes object is used
 261  * to create a thread, when it will be created with the specified
 262  * priority
 263  *
 264  * Returns 0 if successful, or the following error code:
 265  *    FOSA_EINVAL: the specified priority value is not between the
 266  *            minimum and the maximum priorities defined in this
 267  *            FRSH implementation
 268  * Alternatively, in case of error the implementation is allowed to
 269  * notify it to the system console and then terminate the FRSH
 270  * implementation and dependant applications
 271  **/
 272 int fosa_thread_attr_set_prio(frsh_thread_attr_t *attr, int prio);
 273
 274 /**
 275  * fosa_thread_attr_get_prio()
 276  *
 277  * Get the priority from a thread attributes object
 278  *
 279  * This function sets the variable pointed to by prio to the
 280  * priority stored in the thread attributes object attr.
 281  *
 282  * Returns 0
 283  **/
 284  int fosa_thread_attr_get_prio
 285           (const frsh_thread_attr_t *attr, int *prio);
 286
 287 /**
 288  * fosa_thread_set_prio()
 289  *
 290  * Dynamically change the priority of a thread
 291  *
 292  * The priority of the thread identified by tid is
 293  * set to the value specified by prio.
 294  *
 295  * Returns 0 if successful, or the following error code:
 296  *    FOSA_EINVAL: the specified priority value is not between the
 297  *            minimum and the maximum priorities defined in this
 298  *            FRSH implementation
 299  * Alternatively, in case of error the implementation is allowed to
 300  * notify it to the system console and then terminate the FRSH
 301  * implementation and dependant applications
 302  **/
 303 int fosa_thread_set_prio(frsh_thread_id_t tid, int prio);
 304
 305 /**
 306  * fosa_thread_get_prio()
 307  *
 308  * Dynamically get the priority of a thread
 309  *
 310  * This function sets the variable pointed to by prio to the
 311  * priority of the thread identified by tid
 312  *
 313  * Returns 0
 314  **/
 315 int fosa_thread_get_prio (frsh_thread_id_t tid, int *prio);
 316
 317
 318
 319 /*******************************************************************
 320  * Signals
 321  *
 322  * Signals represent events that may be notified by the system, or
 323  * sent explicitly by the application, and for which a thread may
 324  * synchronously wait. Signals carry an associated piece of
 325  * information (an integer or a pointer) and are queued until they are
 326  * accepted.  Signals are identified by an integer signal number (of
 327  * the type frsh_signal_t) in the range FOSA_SIGNAL_MIN,
 328  * FOSA_SIGNAL_MAX.  This range is required to have at least <tbd>
 329  * values.
 330  *******************************************************************/
 331
 332 /**
 333  * fosa_set_accepted_signals()
 334  *
 335  * Establish the set of signals that may be synchronously accepted
 336  * by the calling thread
 337  *
 338  * The function uses the array of signal numbers specified by set,
 339  * which must be of size equal to size
 340  *
 341  * Returns 0 if successful; otherwise it returns an error code:
 342  *     FOSA_EINVAL: the array contains one or more values which are not
 343  *             between FOSA_SIGNAL_MIN and FOSA_SIGNAL_MAX, or size
 344  *             is less than 0
 345  *
 346  * Alternatively, in case of error the implementation is allowed to
 347  * notify it to the system console and then terminate the FRSH
 348  * implementation and dependant applications
 349  **/
 350 int fosa_set_accepted_signals(frsh_signal_t set[], int size);
 351
 352 /**
 353  * fosa_signal_queue()
 354  *
 355  * Queue a signal
 356  *
 357  * This function is used to explicitly send a signal with a specified
 358  * value
 359  *
 360  * The signal number specified by signal is sent together with the
 361  * information specified by info, to the thread identified by
 362  * receiver. In those implementations that do not support queueing a
 363  * signal with information to a thread (such as POSIX), the signal may
 364  * be sent to any thread that is waiting for this signal via
 365  * fosa_signal_wait(). Portability can be ensured by having the receiver
 366  * thread be the one who is waiting for the signal.
 367  *
 368  * Returns 0 if successful; otherwise it returns an error code:
 369  *     FOSA_EINVAL: the signal specified by signal is not
 370  *              between FOSA_SIGNAL_MIN and FOSA_SIGNAL_MAX
 371  *
 372  *     FOSA_EAGAIN: no resources are available to queue the signal; the
 373  *             maximum number of queued signals has been reached, or a
 374  *             systemwide resource limit has been exceeded
 375  *
 376  * Alternatively, in case of error the implementation is allowed to
 377  * notify it to the system console and then terminate the FRSH
 378  * implementation and dependant applications
 379  **/
 380 int fosa_signal_queue
 381        (frsh_signal_t signal, frsh_signal_info_t info,
 382         frsh_thread_id_t receiver);
 383
 384
 385
 386
 387 /**
 388  * fosa_signal_wait()
 389  *
 390  * Wait for a signal
 391  *
 392  * The function waits for the arrival of one of the signals in the
 393  * array of signal numbers specified by set, which must be of size
 394  * equal to size. If there is a signal already queued, the function
 395  * returns immediately. If there is no signal of the specified set
 396  * queued, the calling thread is suspended until a signal from that
 397  * set arrives. Upon return, if signal_received is not NULL the number
 398  * of the signal received is stored in the variable pointed to by
 399  * signal_received; and if info is not NULL the associated information
 400  * is stored in the variable pointed to by info.
 401  *
 402  * Returns 0 if successful; otherwise it returns an error code:
 403  *     FOSA_EINVAL: the array contains one or more values which are not
 404  *             between FOSA_SIGNAL_MIN and FOSA_SIGNAL_MAX, or size
 405  *             is less than 0
 406  *
 407  * Alternatively, in case of error the implementation is allowed to
 408  * notify it to the system console and then terminate the FRSH
 409  * implementation and dependant applications
 410  **/
 411  int fosa_signal_wait
 412       (frsh_signal_t set[], int size, frsh_signal_t *signal_received,
 413        frsh_signal_info_t *info);
 414
 415 /**
 416  * fosa_signal_timedwait()
 417  *
 418  * Timed wait for a signal
 419  *
 420  * This function behaves the same as fosa_signal_wait(), except that
 421  * the suspension time is limited to the time interval specified in
 422  * the timespec structure referenced by timeout.
 423  *
 424  * Returns 0 if successful; otherwise it returns an error code:
 425  *     FOSA_EINVAL: the array contains one or more values which are not
 426  *             between FOSA_SIGNAL_MIN and FOSA_SIGNAL_MAX, or size
 427  *             is less than 0, or timeout is invalid
 428  *     FOSA_EAGAIN: The timeout expired
 429  *
 430  * Alternatively, in case of the FOSA_EINVAL error the implementation is
 431  * allowed to notify it to the system console and then terminate the
 432  * FRSH implementation and dependant applications
 433  **/
 434  int fosa_signal_timedwait
 435       (frsh_signal_t set[], int size, frsh_signal_t *signal_received,
 436        frsh_signal_info_t *info, const struct timespec *timeout);
 437
 438 /*}*/
 439
 440
 441 #endif      /* !FOSA_THREAD_AND_SIGNALS_H_ */