frsh_error.h

   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 FRSH (FRescor ScHeduler)
  35 //
  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.
  46 //
  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 // -----------------------------------------------------------------------
  55 //frsh_error.h
  56 //==============================================
  57 //  ******** *******    ********  **      **
  58 //  **///// /**////**  **//////  /**     /**
  59 //  **      /**   /** /**        /**     /**
  60 //  ******* /*******  /********* /**********
  61 //  **////  /**///**  ////////** /**//////**
  62 //  **      /**  //**        /** /**     /**
  63 //  **      /**   //** ********  /**     /**
  64 //  //       //     // ////////   //      //
  65 //
  66 // FRSH(FRescor ScHeduler), pronounced "fresh"
  67 //==============================================
  68
  69 #ifndef         FRSH_ERROR_H_
  70 #define         FRSH_ERROR_H_
  71
  72 /**
  73  * @file frsh_error.h
  74  **/
  75
  76 /**
  77  * addtogroup core
  78  *
  79  * @{
  80  **/
  81
  82 /* Error codes */
  83 #define FRSH_NO_ERROR                            0
  84
  85 #define FRSH_ERR_BASE_VALUE                      0x02004000
  86
  87 #define FRSH_ERR_TOO_MANY_TASKS                  0x02004001
  88 #define FRSH_ERR_BAD_ARGUMENT                    0x02004002
  89 #define FRSH_ERR_INVALID_SYNCH_OBJ_HANDLE        0x02004003
  90 #define FRSH_ERR_NO_RENEGOTIATION_REQUESTED      0x02004004
  91 #define FRSH_ERR_CONTRACT_REJECTED               0x02004005
  92 #define FRSH_ERR_NOT_SCHEDULED_CALLING_THREAD    0x02004006
  93 #define FRSH_ERR_NOT_BOUND                       0x02004007
  94 #define FRSH_ERR_UNKNOWN_SCHEDULED_THREAD        0x02004008
  95 #define FRSH_ERR_NOT_CONTRACTED_VRES             0x02004009
  96 #define FRSH_ERR_NOT_SCHEDULED_THREAD            0x0200400A
  97 #define FRSH_ERR_TOO_MANY_SERVICE_JOBS           0x0200400B
  98 #define FRSH_ERR_TOO_MANY_SYNCH_OBJS             0x0200400C
  99 #define FRSH_ERR_TOO_MANY_VRES_IN_SYNCH_OBJ      0x0200400D
 100 #define FRSH_ERR_TOO_MANY_EVENTS_IN_SYNCH_OBJ    0x0200400E
 101 #define FRSH_ERR_INTERNAL_ERROR                  0x0200400F
 102 #define FRSH_ERR_TOO_MANY_VRES                   0x02004010
 103 #define FRSH_ERR_INVALID_SCHEDULER_REPLY         0x02004011
 104 #define FRSH_ERR_TOO_MANY_PENDING_REPLENISHMENTS 0x02004012
 105 #define FRSH_ERR_SYSTEM_ALREADY_INITIALIZED      0x02004013
 106 #define FRSH_ERR_SHARED_OBJ_ALREADY_INITIALIZED  0x02004014
 107 #define FRSH_ERR_SHARED_OBJ_NOT_INITIALIZED      0x02004015
 108 #define FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE     0x02004016
 109 #define FRSH_ERR_VRES_WORKLOAD_NOT_COMPATIBLE    0x02004017
 110 #define FRSH_ERR_ALREADY_BOUND                   0x02004018
 111 #define FRSH_ERR_RESOURCE_ID_INVALID             0x02004019
 112 #define FRSH_ERR_TOO_LARGE                       0x0200401A
 113 #define FRSH_ERR_BUFFER_FULL                     0x0200401B
 114 #define FRSH_ERR_NO_SPACE                        0x0200401C
 115 #define FRSH_ERR_NO_MESSAGES                     0x0200401D
 116 #define FRSH_WRN_MODULE_NOT_SUPPORTED            0x0200401E
 117 #define FRSH_ERR_NOT_INITIALIZED                 0x0200401F
 118 #define FRSH_ERR_TOO_MANY_SHARED_OBJS            0x02004020
 119 #define FRSH_ERR_CONTRACT_LABEL_ALREADY_EXISTS   0x02004021
 120 #define FRSH_ERR_BUDGET_EXPIRED                  0x02004022
 121 #define FRSH_ERR_SHARED_OBJECT_NOT_PROTECTED     0x02004023
 122 #define FRSH_ERR_NOT_IMPLEMENTED                 0x02004024
 123 #define FRSH_ERR_CONTRACT_TYPE_NOT_COMPATIBLE    0x02004025
 124 #define FRSH_ERR_CAPACITY_NOT_DECREASING         0x02004026
 125 #define FRSH_ERR_CONTRACT_LABEL_UNKNOWN          0x02004027
 126 #define FRSH_ERR_OUT_OF_BUDGET                           0x02004028
 127 #define FRSH_ERR_ALREADY_IN_FRSH                         0x02004029
 128
 129 #define FRSH_ERR_LAST_VALUE                      0x02004030
 130
 131 #define ERROR(nn,ss) do {if(nn>FRSH_ERR_BASE_VALUE) my_frsh_strerror(nn, ss); else perror(ss); exit (nn);} while (0)
 132
 133
 134
 135
 136 int frsh_strerror (int error, char *message, size_t size);
 137 void my_frsh_strerror(int error, char *sss);
 138
 139
 140 /**
 141  * This str_helper is needed to ensure argument expansion,
 142  * see http://www.iar.com/p180591/p180591_eng.php
 143  **/
 144 #define STR_HELPER(x) #x
 145
 146 /**
 147  * PERROR_FRESCOR
 148  *
 149  * This macro checks the given error number and composes a messages accordingly.
 150  *
 151  * @param nn  Error number
 152  * @param ss  Error string (to be appended to FRSH or system error string)
 153  **/
 154 #define PERROR_FRESCOR(_nn_,_ss_) do {          \
 155  \
 156         char error_string[1024]; \
 157  \
 158         sprintf(error_string,  "File: %s, in function %s at line %d, error %d: %s\n", __FILE__, __FUNCTION__, __LINE__, (_nn_), _ss_); \
 159  \
 160                 if( (_nn_)>FRSH_ERR_BASE_VALUE ) {      \
 161                         my_frsh_strerror( (_nn_), error_string);        \
 162                 } else {                                \
 163                         perror(error_string);                   \
 164                 }                                       \
 165 } while(0)
 166
 167
 168
 169 /**
 170  * PERROR_AND_RETURN
 171  *
 172  * Macro that displays an error code and message and then returns from
 173  * the current function
 174  *
 175  * @param nn  Error number
 176  * @param ss  Error string (to be appended to FRSH or system error string)
 177  **/
 178 #define PERROR_AND_RETURN(nn,ss) do {                   \
 179         PERROR_FRESCOR(nn, ss); \
 180                 return (nn);                            \
 181         } while (0)
 182
 183
 184
 185
 186 /**
 187  * PERROR_AND_EXIT
 188  *
 189  * Macro that displays an error code and message and then aborts the
 190  * program.
 191  *
 192  * @param nn  Error number
 193  * @param ss  Error string (to be appended to FRSH or system error string)
 194  **/
 195 #define PERROR_AND_EXIT(nn,ss) do {     \
 196                 PERROR_FRESCOR(nn,ss);          \
 197                 exit(nn);               \
 198         } while (0)
 199
 200
 201 /**
 202  * PRW:  Perror and Return Wrapper
 203  *
 204  * Function that calls funccall and checks the result != 0.
 205  * In case of error it displays the error code with the function call
 206  * as extra error string and returns from the function.
 207  *
 208  * terror (int) needs to be visible in the point of call.
 209  *
 210  * @param funccall Code to execute that should return 0 in a non error
 211  *                 case.
 212  **/
 213 #define PRW(funccall)  do { \
 214   if ( (terror = funccall ) != 0) \
 215   { \
 216      PERROR_AND_RETURN( terror, STR_HELPER(funccall) ); \
 217   } \
 218 } while(0)
 219
 220
 221
 222 /**
 223  * PXW:  Perror and eXit Wrapper
 224  *
 225  * Function that calls funccall and checks the result != 0.
 226  * In case of error it displays the error code with the function call
 227  * as extra error string and ABORTS the program.
 228  *
 229  * terror (int) needs to be visible in the point of call.
 230  *
 231  * @param funccall Code to execute that should return 0 in a non error
 232  *                 case.
 233  **/
 234 #define PXW(funccall)  do { \
 235   if ( (terror = funccall ) != 0) \
 236   { \
 237      PERROR_AND_EXIT( terror, STR_HELPER(funccall) ); \
 238   } \
 239 } while(0)
 240
 241
 242
 243 /**
 244  * PERROR_KERN_AND_EXIT
 245  *
 246  * Function that displays an error code and message and then aborts the
 247  * program.
 248  *
 249  * @param nn  Error number
 250  * @param ss  Error string (to be appended to FRSH or system error string)
 251  **/
 252 #define PERROR_KERN_AND_EXIT(nn, ss) do {               \
 253                 errno = errno ? errno : (nn);           \
 254                 kern_printf(ss);                        \
 255                 exit(nn);                               \
 256         } while (0)
 257
 258
 259
 260
 261 /*}*/
 262
 263 #endif      /* !FRSH_ERROR_H_ */