3 /* gras/emul.h - public interface to emulation support */
4 /* (specific parts for SG or RL) */
6 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
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. */
14 #include "xbt/misc.h" /* SG_BEGIN_DECL */
17 /** @addtogroup GRAS_emul
18 * @brief Code execution "emulation" and "virtualization".
20 * Emulation and virtualization words have a lot of different meanings in
21 * computer science. Here is what we mean, and what this module allows you
22 * to do (if it does not match your personal belives, I'm sorry):
24 * - Virtualization: Having some specific code for the simulation or for the reality
25 * - Emulation: Report within the simulator the execution time of your code
27 * \section GRAS_emul_virtualization Virtualization
29 * The whole idea of GRAS is to share the same code between the simulator
30 * and the real implementation. But it is sometimes impossible, such as
31 * when you want to deal with the OS. As an example, you may want to add
32 * some extra delay before initiating a communication in RL to ensure that
33 * the receiver is listening. This is usually useless in SG since you have
34 * a much better control on process launch time.
36 * This would be done with the following snipet:
37 * \verbatim if (gras_if_RL())
38 gras_os_sleep(1);\endverbatim
40 * Please note that those are real functions and not pre-processor
41 * defines. This is to ensure that the same object code can be linked
42 * against the SG library or the RL one without recompilation.
47 /** \brief Returns true only if the program runs on real life */
48 XBT_PUBLIC(int) gras_if_RL(void);
50 /** \brief Returns true only if the program runs within the simulator */
51 XBT_PUBLIC(int) gras_if_SG(void);
55 XBT_PUBLIC(int) gras_bench_always_begin(const char *location, int line);
56 XBT_PUBLIC(int) gras_bench_always_end(void);
57 XBT_PUBLIC(int) gras_bench_once_begin(const char *location, int line);
58 XBT_PUBLIC(int) gras_bench_once_end(void);
60 /** @addtogroup GRAS_emul
61 * \section GRAS_emul_timing Emulation
63 * For simulation accuracy, it is mandatory to report the execution time
64 * of your code into the simulator. For example, if your application is a
65 * parallel matrix multiplication, you naturally have to slow down the
66 * simulated hosts actually doing the computation.
68 * If you know beforehands how long each task will last, simply add a call
69 * to the gras_bench_fixed function described below. If not, you can have
70 * GRAS benchmarking your code automatically. Simply enclose the code to
71 * time between a macro GRAS_BENCH_*_BEGIN and GRAS_BENCH_*_END, and
72 * you're done. There is three pair of such macros, whose characteristics
73 * are summarized in the following table.
77 * <td><b>Name</b></td>
78 * <td><b>Run on host machine?</b></td>
79 * <td><b>Benchmarked?</b></td>
80 * <td><b>Corresponding time reported to simulation?</b></td>
83 * <td>GRAS_BENCH_ALWAYS_BEGIN()<br>
84 * GRAS_BENCH_ALWAYS_END()</td>
90 * <td>GRAS_BENCH_ONCE_RUN_ONCE_BEGIN()<br>
91 * GRAS_BENCH_ONCE_RUN_ONCE_END()</td>
92 * <td>Only first time</td>
93 * <td>Only first time</td>
94 * <td>Each time (with stored value)</td>
97 * <td>GRAS_BENCH_ONCE_RUN_ALWAYS_BEGIN()<br>
98 * GRAS_BENCH_ONCE_RUN_ALWAYS_END()</td>
100 * <td>Only first time</td>
101 * <td>Each time (with stored value)</td>
105 * As you can see, whatever macro pair you use, the corresponding value is
106 * repported to the simulator. After all, that's what those macro are
109 * The GRAS_BENCH_ALWAYS_* macros are the simplest ones. Each time the
110 * corresponding block is encountered, the corresponding code is executed
111 * and timed. Then, the simulated host is given the corresponding amount
114 * The GRAS_BENCH_ONCE_RUN_ONCE_* macros are good for cases where you know
115 * that your execution time is constant and where you don't care about the
116 * result in simulation mode. In our example, each sub-block
117 * multiplication takes exactly the same amount of work (time depends only
118 * on size, not on content), and the operation result can safely be
119 * ignored for algorithm result. Doing so allows you to considerably
120 * reduce the amount of computation needed when running on simulator.
122 * The GRAS_BENCH_ONCE_RUN_ALWAYS_* macros are good for cases where you
123 * know that each block will induce the same amount of work (you thus
124 * don't want to bench it each time), but you actually need the result (so
125 * you have to run it each time). You may ask why you don't use
126 * GRAS_BENCH_ONCE_RUN_ONCE_* macros in this case (why you save the
127 * benchmarking time). The timing operation is not very intrusive by
128 * itself, but it has to be done in an exclusive way between the several
129 * GRAS threads (protected by mutex). So, the day where there will be
130 * threads in GRAS, this will do a big difference. Ok, I agree. For now,
131 * it makes no difference.
135 * - Blocks are automatically differenciated using the filename and line
136 * position at which the *_BEGIN part was called. Don't put two of them
139 * - You cannot nest blocks. It would make no sense, either.
141 * - By the way, GRAS is not exactly designed for parallel algorithm such
142 * as parallel matrix multiplication but for distributed ones, you weirdo.
143 * But it's just an example ;)
147 /** \brief Start benchmarking this code block
149 #define GRAS_BENCH_ALWAYS_BEGIN() gras_bench_always_begin(__FILE__, __LINE__)
150 /** \brief Stop benchmarking this code block
152 #define GRAS_BENCH_ALWAYS_END() gras_bench_always_end()
154 /** \brief Start benchmarking this code block if it has never been benchmarked, run it in any case
155 * \hideinitializer */
156 #define GRAS_BENCH_ONCE_RUN_ALWAYS_BEGIN() gras_bench_once_begin(__FILE__, __LINE__)
157 /** \brief Stop benchmarking this part of the code
159 #define GRAS_BENCH_ONCE_RUN_ALWAYS_END() gras_bench_once_end()
161 /** \brief Start benchmarking this code block if it has never been benchmarked, ignore it if it was
163 #define GRAS_BENCH_ONCE_RUN_ONCE_BEGIN() if (gras_bench_once_begin(__FILE__, __LINE__)) {
164 /** \brief Stop benchmarking this part of the code
166 #define GRAS_BENCH_ONCE_RUN_ONCE_END() } gras_bench_once_end()
171 #endif /* GRAS_COND_H */