src_marte/frsh_fosa.c

   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 //frsh_fosa.c
  53 //==============================================
  54 //  ********  ******    ********  **********
  55 //  **///// /**    **  **//////  /**     /**
  56 //  **      /**    ** /**        /**     /**
  57 //  ******* /**    ** /********* /**********
  58 //  **////  /**    ** ////////** /**//////**
  59 //  **      /**    **        /** /**     /**
  60 //  **      /**    **  ********  /**     /**
  61 //  //       /******/  ////////   //      //
  62 //
  63 // FOSA(Frescor Operating System Adaptation layer)
  64 //================================================
  65
  66 #include "frsh_fosa.h"
  67 #include <pthread.h>
  68 #include <stdio.h>
  69 #include <time.h>
  70
  71 #include <timespec_operations.h> /* for incr_timespec */
  72
  73 #include <misc/error_checks.h>
  74
  75 /*************************
  76  * Thread attributes
  77  *************************/
  78
  79 /**
  80  * frsh_thread_attr_init()
  81  *
  82  * Initialize a thread attributes object
  83  *
  84  * This function initializes the object pointed to by attr to all
  85  * the default values defined by FRSH
  86  *
  87  * @return 0 if successful; otherwise it returns \n
  88  *   FOSA_ENOMEM: insufficient memory exists to initialize the thread
  89  *           attributes object
  90  **/
  91 int frsh_thread_attr_init(frsh_thread_attr_t *attr)
  92 {
  93   int ret_value;
  94
  95   ret_value=pthread_attr_init(attr);
  96   if (ret_value==0) {
  97     // set the default values
  98
  99     // detachstate = detached thread (no join operation allowed)
 100     CHK(pthread_attr_setdetachstate(attr,PTHREAD_CREATE_DETACHED));
 101
 102     // inheritsched = explicit, so that we can explicitly set the attributes
 103     CHK(pthread_attr_setinheritsched(attr,PTHREAD_EXPLICIT_SCHED));
 104
 105     // schedpolicy = fixed priorities
 106     CHK(pthread_attr_setschedpolicy(attr,SCHED_FIFO));
 107
 108     // detachstate = detached thread (no join operation allowed)
 109     CHK(pthread_attr_setdetachstate(attr,PTHREAD_CREATE_DETACHED));
 110
 111   }
 112   return ret_value;
 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 int frsh_thread_attr_destroy(frsh_thread_attr_t *attr)
 126 {
 127   return pthread_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 int frsh_thread_attr_set_stacksize
 146      (frsh_thread_attr_t *attr, size_t stacksize)
 147 {
 148   return pthread_attr_setstacksize(attr,stacksize);
 149 }
 150
 151 /**
 152  * frsh_thread_attr_get_stacksize()
 153  *
 154  * Get the thread minimum stack size from a thread attributes object
 155  *
 156  * This function sets the variable pointed to by stacksize to the
 157  * minimum stack size stored in the thread attributes object attr.
 158  *
 159  * @return 0
 160  */
 161 int frsh_thread_attr_get_stacksize
 162       (const frsh_thread_attr_t *attr, size_t *stacksize)
 163 {
 164   return pthread_attr_getstacksize(attr,stacksize);
 165 }
 166
 167
 168 /**
 169  * frsh_eat()
 170  *
 171  * Eat some time using system clock facilities
 172  **/
 173 #ifdef VIRTUAL_TIME
 174     #include <fosa_vt.h>
 175 #endif
 176
 177 void inline frsh_eat(const struct timespec *cpu_time)
 178 {
 179 #ifdef VIRTUAL_TIME
 180     vt_time_t vt_clock;
 181     timespec_2_vtime(cpu_time, vt_clock);
 182     vt_use_time((unsigned long long)vt_clock);
 183 #else
 184     int err;
 185     clockid_t clock_id;
 186     struct timespec current_time, time_to_go;
 187
 188     // NOTE: there should be a constant for the cpu_clock_id of the caller
 189     // to avoid calling 'fosa_thread_get_cputime_clock'
 190     err = pthread_getcpuclockid(pthread_self(), &clock_id);
 191
 192     err = clock_gettime(clock_id, &current_time);
 193     add_timespec(&time_to_go, &current_time, cpu_time);
 194
 195     while (smaller_timespec(&current_time, &time_to_go)) {
 196         err = clock_gettime(clock_id, &current_time);
 197     }
 198 #endif
 199 }