doc/doxygen/module-msg.doc

   1 /**
   2 @defgroup MSG_API  MSG: Legacy handling of CSP algorithms
   3 @brief Simple programming environment
   4
   5
   6 MSG is a simple API to write algorithms organized with Concurrent
   7 Sequential Processes (CSP) that interact by exchanging messages. It
   8 constitutes a convenient simplification of the reality of distributed
   9 systems. It can be used to build rather realistic simulations, but
  10 remains simple to use: most unpleasant technical elements can be
  11 abstracted away rather easily.
  12
  13 @warning MSG used to be the main API of SimGrid 3, but we are
  14          currently in the process of releasing SimGrid 4. The
  15          tentative release date is Summer 2018. So MSG is frozen and
  16          will probably never evolve. If you are starting a new
  17          project, you should consider S4U instead. Note that the
  18          support for MSG will not be removed from SimGrid before 2020
  19          at least.
  20
  21 @section MSG_funct Offered functionalities
  22    - @ref msg_simulation
  23    - @ref m_process_management
  24    - @ref m_host_management
  25    - @ref m_task_management
  26    - @ref msg_mailbox_management
  27    - @ref msg_file
  28    - @ref msg_task_usage
  29    - @ref msg_VMs
  30    - @ref msg_synchro
  31    - @ref msg_examples
  32
  33 */
  34
  35 /**
  36 @defgroup msg_simulation   Main MSG simulation Functions
  37 @ingroup MSG_API
  38 @brief How to setup and control your simulation.
  39
  40 The basic workflow is the following (check the @ref msg_examples for
  41 details).
  42
  43  -# Initialize the library with #MSG_init
  44  -# Create a platform (usually by parsing a file with
  45     #MSG_create_environment)
  46  -# Register the functions that your processes are supposed to run with
  47     #MSG_function_register (and maybe #MSG_function_register_default)
  48  -# Launch your processes from a deployment file with #MSG_launch_application
  49  -# Run the simulation with #MSG_main
  50 */
  51
  52 /** @defgroup m_process_management Process Management Functions
  53  *  @ingroup MSG_API
  54  *  @brief This section describes the process structure of MSG
  55  *         (#msg_process_t) and the functions for managing it.
  56  */
  57
  58 /** @defgroup m_host_management Host Management Functions
  59  *  @ingroup MSG_API
  60  *  @brief Host structure of MSG
  61  */
  62
  63 /** @defgroup m_task_management Task Management Functions
  64  *  @ingroup MSG_API
  65  *  @brief Task structure of MSG (#msg_task_t) and associated functions. See
  66  *         @ref msg_task_usage to see how to put the tasks in action.
  67  */
  68
  69 /** @defgroup msg_mailbox_management Mailbox Management Functions
  70  *  @ingroup MSG_API
  71  *  @brief Functions associated to mailboxes.
  72  */
  73
  74 /** @defgroup msg_task_usage Task Actions
  75  *  @ingroup MSG_API
  76  *  @brief This section describes the functions that can be used
  77  *         by a process to execute, communicate or otherwise handle some task.
  78  */
  79
  80 /** @defgroup msg_synchro Explicit Synchronization Functions
  81  *  @ingroup MSG_API
  82  *  @brief Explicit synchronization mechanisms: semaphores (#msg_sem_t) and friends.
  83  *
  84  * In some situations, these things are very helpful to synchronize processes without message exchanges.
  85  */
  86
  87 /** @defgroup msg_VMs VMs
  88  *  @ingroup MSG_API
  89  *  @brief Interface created to mimic IaaS clouds.
  90  *
  91  *  With it, you can create virtual machines to put your processes
  92  *  into, and interact directly with the VMs to manage groups of
  93  *  processes.
  94  *
  95  */
  96
  97 /** @defgroup msg_storage_management Storage Management Functions
  98  *  @ingroup MSG_API
  99  *  @brief Storage structure of MSG (#msg_storage_t) and associated functions, inspired from POSIX.
 100  */
 101
 102 /** @defgroup msg_file File Management Functions
 103     @ingroup MSG_API
 104     @brief MSG files (#msg_file_t) and associated functions, inspired from POSIX.
 105 */