include/gras/emul.h

   1 /* $Id$                     */
   2
   3 /* gras/emul.h - public interface to emulation support                      */
   4 /*                (specific parts for SG or RL)                             */
   5
   6 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef GRAS_COND_H
  12 #define GRAS_COND_H
  13
  14 #include "xbt/misc.h" /* BEGIN_DECL */
  15
  16 BEGIN_DECL()
  17
  18 /** @addtogroup GRAS_emul
  19  *  @brief Handling code specific to the simulation or to the reality (Virtualization).
  20  *
  21  *  Please note that those are real functions and not pre-processor defines. This is to ensure
  22  *  that the same object code can be linked against the SG library or the RL one without recompilation.
  23  *
  24  *  @{
  25  */
  26
  27 /** \brief Returns true only if the program runs on real life */
  28 int gras_if_RL(void);
  29
  30 /** \brief Returns true only if the program runs within the simulator */
  31 int gras_if_SG(void);
  32
  33 /** @} */
  34
  35 int gras_bench_always_begin(const char *location, int line);
  36 int gras_bench_always_end(void);
  37 int gras_bench_once_begin(const char *location, int line);
  38 int gras_bench_once_end(void);
  39
  40 /** \brief Start benchmark this part of the code
  41     \hideinitializer */
  42 #define GRAS_BENCH_ALWAYS_BEGIN()  do { if(gras_if_SG()) gras_bench_always_begin(__FILE__, __LINE__); } while(0)
  43 /** \brief Stop benchmark this part of the code
  44     \hideinitializer */
  45 #define GRAS_BENCH_ALWAYS_END() do { if(gras_if_SG()) gras_bench_always_end(); } while(0)
  46
  47 /** \brief Start benchmark this part of the code if it has never been benchmarked before
  48     \hideinitializer */
  49 #define GRAS_BENCH_ONCE_RUN_ALWAYS_BEGIN()  do { if(gras_if_SG()) gras_bench_once_begin(__FILE__, __LINE__); } while(0)
  50 /** \brief Stop benchmarking this part of the code
  51     \hideinitializer */
  52 #define GRAS_BENCH_ONCE_RUN_ALWAYS_END()    do { if(gras_if_SG()) gras_bench_once_end(); } while(0)
  53
  54 /** \brief Start benchmark this part of the code if it has never been benchmarked before
  55     \hideinitializer */
  56 #define GRAS_BENCH_ONCE_RUN_ONCE_BEGIN()  if((gras_if_SG()&&(gras_bench_once_begin(__FILE__, __LINE__)))||(gras_if_RL())) {
  57 /** \brief Stop benchmarking this part of the code
  58     \hideinitializer */
  59 #define GRAS_BENCH_ONCE_RUN_ONCE_END()    } GRAS_BENCH_ONCE_RUN_ALWAYS_END();
  60
  61 END_DECL()
  62
  63 #endif /* GRAS_COND_H */
  64