1 /** @addtogroup MSG_API
3 \section MSG_funct Offered functionnalities
4 - \ref m_process_management
5 - \ref m_datatypes_management
6 - \ref m_host_management
7 - \ref m_task_management
8 - \ref msg_gos_functions
9 - \ref m_channel_management
10 - \ref msg_easier_life
13 \section MSG_examples Examples of MSG
15 - \ref MSG_ex_master_slave
18 /** @defgroup m_datatypes_management MSG Data Types
20 @brief This section describes the different datatypes provided by MSG.
21 \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Data types" --> \endhtmlonly
23 /** \addtogroup m_process_management
25 /** \addtogroup m_host_management
27 /** \addtogroup m_task_management
29 /** \addtogroup msg_gos_functions
31 /** \addtogroup m_channel_management
33 /** \addtogroup msg_easier_life
35 /** \addtogroup msg_simulation
38 /** \page MSG_ex_master_slave Master/slave application
40 <center>[\ref MSG_API]</center>
42 Simulation of a master-slave application using a realistic platform and
43 an external description of the deployment.
45 \section MSG_ex_ms_TOC Table of contents:
47 - \ref MSG_ext_ms_code
48 - \ref MSG_ext_ms_preliminary
49 - \ref MSG_ext_ms_master
50 - \ref MSG_ext_ms_slave
51 - \ref MSG_ext_ms_forwarder
52 - \ref MSG_ext_ms_core
53 - \ref MSG_ext_ms_main
54 - \ref MSG_ext_ms_helping
55 - \ref MSG_ext_ms_application
56 - \ref MSG_ext_ms_platform
60 \dontinclude msg/msg_test.c
62 \section MSG_ext_ms_code Code of the application
64 \subsection MSG_ext_ms_preliminary Preliminary declarations
70 \subsection MSG_ext_ms_master Master code
72 This function has to be assigned to a m_process_t that will behave as the master.
73 It should not be called directly but either given as a parameter to
74 #MSG_process_create() or registered as a public function through
75 #MSG_function_register() and then automatically assigned to a process through
76 #MSG_launch_application().
78 C style arguments (argc/argv) are interpreted as:
79 - the number of tasks to distribute
80 - the computation size of each task
81 - the size of the files associated to each task
82 - a list of host that will accept those tasks.
84 Tasks are dumbly sent in a round-robin style.
88 \subsection MSG_ext_ms_slave Slave code
90 This function has to be assigned to a #m_process_t that has to behave as a slave.
91 Just like the master fuction (described in \ref MSG_ext_ms_master), it should not be called directly.
93 This function keeps waiting for tasks and executes them as it receives them.
97 \subsection MSG_ext_ms_forwarder Forwarder code
99 This function has to be assigned to a #m_process_t that has to behave as a forwarder.
100 Just like the master fuction (described in \ref MSG_ext_ms_master), it should not be called directly.
102 C style arguments (argc/argv) are interpreted as a list of host
103 that will accept those tasks.
105 This function keeps waiting for tasks and dispathes them to its slaves.
107 \until end_of_forwarder
109 \subsection MSG_ext_ms_core Simulation core
111 This function is the core of the simulation and is divided only into 3 parts
112 thanks to MSG_create_environment() and MSG_launch_application().
113 -# Simulation settings : MSG_create_environment() creates a realistic
115 -# Application deployment : create the agents on the right locations with
116 MSG_launch_application()
117 -# The simulation is run with #MSG_main()
120 - <i>platform_file</i>: the name of a file containing an valid surfxml platform description.
121 - <i>application_file</i>: the name of a file containing a valid surfxml application description
123 \until end_of_test_all
125 \subsection MSG_ext_ms_main Main() function
127 This initializes MSG, runs a simulation, and free all data-structures created by MSG.
131 \section MSG_ext_ms_helping Helping files
133 \subsection MSG_ext_ms_application Example of application file
135 \include msg/small_deployment.xml
137 \subsection MSG_ext_ms_platform Example of platform file
139 \include msg/small_platform.xml