doc/ref_guide/doxygen/module-msg.doc

   1 /** \addtogroup MSG_API
   2
   3       MSG was the first distributed programming environment provided within
   4       SimGrid. While almost realistic, it remains quite simple (simplistic?).
   5       This describes the native to MSG.
   6
   7       \section jMSG_who Who should use this (and who shouldn't)
   8
   9       You should use MSG if you want to study some heuristics for a
  10       given problem you don't really want to implement. If you want to
  11       use the C programming language, your are in the right
  12       section. To use the Java or Ruby programming interfaces, please refer to
  13       the documentation provided in the relevant packages.
  14
  15   \section MSG_funct Offered functionnalities
  16    - \ref msg_simulation
  17    - \ref m_process_management
  18    - \ref m_host_management
  19    - \ref m_task_management
  20    - \ref msg_file_management
  21    - \ref msg_task_usage
  22    - \ref msg_VMs
  23    - \ref msg_trace_driven
  24    - \ref msg_deprecated_functions
  25
  26
  27   Also make sure to visit the page @ref MSG_examples.
  28 */
  29
  30
  31
  32 /**
  33 @defgroup msg_simulation   Main MSG simulation Functions
  34 @ingroup MSG_API
  35 @brief Describes how to setup and control your simulation.
  36
  37 The basic workflow is the following (check the \ref MSG_examples for
  38 details).
  39
  40  -# Initialize the library with #MSG_init
  41  -# Create a platform (usually by parsing a file with
  42     #MSG_create_environment)
  43  -# Register the functions that your processes are supposed to run with
  44     #MSG_function_register (and maybe #MSG_function_register_default)
  45  -# Launch your processes from a deployment file with #MSG_launch_application
  46  -# Run the simulation with #MSG_main
  47  -# Cleanup the library with #MSG_clean before ending your program
  48     (optional).
  49
  50 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation Control" --> @endhtmlonly
  51 */
  52
  53 /** @defgroup m_process_management Process Management Functions
  54  *  @ingroup MSG_API
  55  *  @brief This section describes the process structure of MSG
  56  *         (#msg_process_t) and the functions for managing it.
  57  */
  58
  59 /** @defgroup m_host_management Host Management Functions
  60  *  @ingroup MSG_API
  61  *  @brief This section describes the host structure of MSG
  62  */
  63
  64 /** @defgroup m_task_management Task Management Functions
  65  *  @ingroup MSG_API
  66  *  @brief This section describes the task structure of MSG
  67  *         (#msg_task_t) and the functions for managing it. See
  68  *         \ref msg_task_usage to see how to put the tasks in action.
  69  *
  70  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
  71  */
  72
  73 /** @defgroup msg_task_usage Task Actions
  74  *  @ingroup MSG_API
  75  *  @brief This section describes the functions that can be used
  76  *         by a process to execute, communicate or otherwise handle some task.
  77  */
  78
  79 /** @defgroup msg_VMs VMs
  80  *  @ingroup MSG_API
  81  *  @brief This section describes the interface created to mimick IaaS clouds.
  82  *
  83  *  With it, you can create virtual machines to put your processes
  84  *  into, and interact directly with the VMs to manage groups of
  85  *  processes.
  86  *
  87  *  This interface is highly experimental at this point. Testing is
  88  *  welcomed, but do not expect too much of it right now. Even the
  89  *  interfaces may be changed in future releases of SimGrid (although
  90  *  things are expected to stabilize nicely before SimGrid v3.8).
  91  *  There is no guaranty on the rest of SimGrid, and there is less
  92  *  than that on this part.
  93  *
  94  */
  95
  96 /** @defgroup msg_file_management File Management Functions
  97  *  @ingroup MSG_API
  98  *  @brief This section describes the file structure of MSG
  99  *         (#msg_file_t) and the functions for managing it. It
 100  *   is based on POSIX functions.
 101  */
 102
 103
 104 /**
 105 @defgroup msg_trace_driven Trace-driven simulations
 106 @ingroup MSG_API
 107 @brief This section describes the functions allowing to build trace-driven simulations.
 108
 109 \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Trace-Driven" --> \endhtmlonly
 110
 111 This is very handy when you want to test an algorithm or protocol that
 112 does nothing unless it receives some events from outside. For example,
 113 a P2P protocol reacts to requests from the user, but does nothing if
 114 there is no such event.
 115
 116 In such situations, SimGrid allows to write your protocol in your C
 117 file, and the events to react to in a separate text file. Declare a
 118 function handling each of the events that you want to accept in your
 119 trace files, register them using #xbt_replay_action_register in your main,
 120 and then use #MSG_action_trace_run to launch the simulation. You can
 121 either have one trace file containing all your events, or a file per
 122 simulated process.
 123
 124 Check the examples in <b>examples/msg/actions/actions.c</b> for details.
 125
 126  */
 127
 128
 129
 130 /**
 131 @defgroup MSG_LUA      Lua bindings
 132 @ingroup MSG_API
 133 @brief Lua bindings to MSG (\ref MSG_API)
 134
 135 @htmlonly <!--  DOXYGEN_NAVBAR_LABEL="LUA bindings" --> @endhtmlonly
 136
 137 This is the lua bindings of the \ref MSG_API interface.
 138
 139 \section lMSG_who Who should use this (and who shouldn't)
 140
 141 If you want to use MSG to study your algorithm, but you don't want to
 142 use the C language (using \ref MSG_API), then you should use some
 143 bindings such as this one. The advantage of the lua bindings is that
 144 they are distributed directly with the main archive (in contrary to
 145 Java and Ruby bindings, for example, that are distributed separately).
 146 Another advantage of lua is that there is almost no performance loss
 147 with regard to the C version (at least there shouln't be any -- it is
 148 still to be precisely assessed).
 149
 150 \section MSG_Lua_funct  Lua offered functionnalities in MSG
 151
 152 Almost all important features of the MSG interface are available from
 153 the lua bindings. Unfortunately, since doxygen does not support the
 154 lua modules implemented directly in C as we are using, there is no
 155 ready to use reference documentation for this module. Even more than
 156 for the other modules, you will have to dig into the source code of
 157 the examples to learn how to use it.
 158
 159 \section Lua_examples Examples of lua MSG
 160
 161   - \ref MSG_ex_master_slave_lua
 162   - \ref MSG_ex_master_slave_lua_bypass
 163   - Also, the lua version of the Chord example (in the source tree)
 164     is a working non-trivial example of use of the lua bindings
 165 */
 166
 167 /**
 168 @defgroup msg_deprecated_functions MSG Deprecated
 169 @ingroup MSG_API
 170 @brief This section describes the deprecated functions. PLEASE STOP USING THEM.
 171
 172 We don't remove them because the ability to run old scientific
 173 code is something important to us. But these functionalities are
 174 not actively supported anymore.
 175
 176 To access these functions, you should define the relevant option
 177 at configuration time in ccmake.
 178  */
 179
 180
 181
 182
 183
 184