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 use
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.
22 /** \addtogroup m_process_management
24 /** \addtogroup m_host_management
26 /** \addtogroup m_task_management
28 /** \addtogroup msg_gos_functions
30 /** \addtogroup m_channel_management
32 /** \addtogroup msg_easier_life
34 /** \addtogroup msg_simulation
37 /** \page MSG_ex_master_slave Master/slave application
39 <center>[\ref MSG_API]</center>
41 Simulation of a master-slave application using a realistic platform and
42 an external description of the deployment.
44 \section MSG_ex_ms_TOC Table of contents:
46 - \ref MSG_ext_ms_code
47 - \ref MSG_ext_ms_preliminary
48 - \ref MSG_ext_ms_master
49 - \ref MSG_ext_ms_slave
50 - \ref MSG_ext_ms_forwarder
51 - \ref MSG_ext_ms_core
52 - \ref MSG_ext_ms_main
53 - \ref MSG_ext_ms_helping
54 - \ref MSG_ext_ms_application
55 - \ref MSG_ext_ms_platform
59 \dontinclude msg/msg_test.c
61 \section MSG_ext_ms_code Code of the application
63 \subsection MSG_ext_ms_preliminary Preliminary declarations
69 \subsection MSG_ext_ms_master Master code
71 This function has to be assigned to a m_process_t that will behave as the master.
72 It should not be called directly but either given as a parameter to
73 #MSG_process_create() or registered as a public function through
74 #MSG_function_register() and then automatically assigned to a process through
75 #MSG_launch_application().
77 C style arguments (argc/argv) are interpreted as:
78 - the number of tasks to distribute
79 - the computation size of each task
80 - the size of the files associated to each task
81 - a list of host that will accept those tasks.
83 Tasks are dumbly sent in a round-robin style.
87 \subsection MSG_ext_ms_slave Slave code
89 This function has to be assigned to a #m_process_t that has to behave as a slave.
90 Just like the master fuction (described in \ref MSG_ext_ms_master), it should not be called directly.
92 This function keeps waiting for tasks and executes them as it receives them.
96 \subsection MSG_ext_ms_forwarder Forwarder code
98 This function has to be assigned to a #m_process_t that has to behave as a forwarder.
99 Just like the master fuction (described in \ref MSG_ext_ms_master), it should not be called directly.
101 C style arguments (argc/argv) are interpreted as a list of host
102 that will accept those tasks.
104 This function keeps waiting for tasks and dispathes them to its slaves.
106 \subsection MSG_ext_ms_core Simulation core
108 This function is the core of the simulation and is divided only into 3 parts
109 thanks to MSG_create_environment() and MSG_launch_application().
110 -# Simulation settings : MSG_create_environment() creates a realistic
112 -# Application deployment : create the agents on the right locations with
113 MSG_launch_application()
114 -# The simulation is run with #MSG_main()
117 - <i>platform_file</i>: the name of a file containing an valid surfxml platform description.
118 - <i>application_file</i>: the name of a file containing a valid surfxml application description
120 \until end_of_test_all
122 \subsection MSG_ext_ms_main Main() function
124 This initializes MSG, runs a simulation, and free all data-structures created by MSG.
128 \section MSG_ext_ms_helping Helping files
130 \subsection MSG_ext_ms_application Example of application file
132 \include msg/small_deployment.xml
134 \subsection MSG_ext_ms_platform Example of platform file
136 \include msg/small_platform.xml