Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
d232f9ff943d15656c42a2e5ea0031457dfea491
[simgrid.git] / doc / doxygen / inside_extending.doc
1 /*!
2 \page inside_extending Extending SimGrid
3
4 \tableofcontents
5
6 \section simgrid_dev_guide_model How to add a new model in surf?
7 The figure below shows the architecture of the SURF layer. This layer is composed
8 of different kinds of models representing the different systems we want to
9 model (i.e., cpu, network, storage, workstation, virtual machine).
10
11 A model in simgrid is composed of three classes: Model, Resource and Action
12 (\ref SURF_interface "surf_interface.hpp").
13
14 \image html surf++.png
15 \image latex surf++.pdf "surf++" width=\textwidth
16
17 Actually there are five kind of models: CpuModel, NetworkModel, WorkstationModel,
18 WorkstationVMModel and StorageModel. For each kind of model, there is an
19 interface (e.g.: \ref SURF_cpu_interface "cpu_interface.hpp") and some implementations (e.g.: cpu_cas01.hpp,
20 cpu_ti.hpp).
21
22 The CPU model Cas01, for instance, is initialized by the function
23     void surf_cpu_model_init_Cas01()
24
25 The different network models that are offered by simgrid are stored in the array
26 that is defined as follows:
27
28 s_surf_model_description_t surf_network_model_description[] = {
29
30 \subsection simgrid_dev_guide_model_implem How to add a new model implementation in surf?
31
32 If you want to create a new implementation of a kind of model you must extend
33 the classes of the corresponding interfaces.
34
35 For instance, if you want to add a new cup model called `Plop`, create two files
36 cpu_plop.hpp and cpu_plop_cpp which contains classes CpuPlopModel, CpuPlop and
37 CpuPlopAction implementating respectively the interfaces CpuModel, Cpu and
38 CpuAction. You also need to define a initializing function like this:
39
40 ~~~~
41 void surf_cpu_model_init_plop()
42 {
43   xbt_assert(!surf_cpu_model_pm);
44
45   surf_cpu_model_pm = new CpuPlopModel();
46
47   sg_platf_postparse_add_cb(cpu_add_traces);
48
49   xbt_dynar_push(model_list, &surf_cpu_model_pm);
50 }
51 ~~~~
52
53 and add an entry in the corresponding array in surf_interface.cpp
54
55 ~~~~
56 s_surf_model_description_t surf_cpu_model_description[] = {
57   {"Cas01",
58    "Simplistic CPU model (time=size/power).",
59    surf_cpu_model_init_Cas01},
60   {"Plop",
61    "The new plop CPU model.",
62    surf_cpu_model_init_plop},
63   {NULL, NULL, NULL}      // this array must be NULL terminated
64 };
65 ~~~~
66
67 \subsection simgrid_dev_guide_model_kind How to add a new kind of model in surf?
68
69 If you want to create a new kind of model, you must create a new interface
70 where you extend the classes Model, Resource and Action, and then create an
71 implementation of this interface.
72
73
74 \section simgrid_dev_guide_surf_callbacks How to use surf callbacks?
75
76 Adding features to surf could also be handle by using surf callbacks (instead
77 of adding new implementation model). The list of available callbacks is
78 accessible there \ref SURF_callbacks. An example of using surf callbacks is the
79 energy plugin. If you want to add a plugin you need to define callback function
80 and to connect them to callbacks handler in an initialization function.
81
82 ~~~~
83 static void MyNetworkLinkCreatedCallback(NetworkLinkPtr cpu){
84   // your code
85 }
86
87 static void MyNetworkLinkDestructedCallback(NetworkLinkPtr cpu){
88   // your code
89 }
90
91 static void MyNetworkCommunicationCallback(NetworkActionPtr cpu,
92                                            RoutingEdgePtr src,
93                                            RoutingEdgePtr dst){
94   // your code
95 }
96
97 void sg_my_network_plugin_init() {
98   networkLinkCreatedCallbacks.connect(MyNetworkLinkCreatedCallback);
99   networkLinkDestructedCallbacks.connect(MyNetworkLinkDestructedCallback);
100   networkCommunicationCallbacks.connect(MyNetworkCommunicationCallback);
101 }
102 ~~~~
103
104 Then you need to add an entry in surf_interface.cpp refering to your
105 initialization function.
106
107 ~~~~
108 s_surf_model_description_t surf_plugin_description[] = {
109                   {"Energy",
110                    "Cpu energy consumption.",
111                    sg_energy_plugin_init},
112                   {"MyNetworkPlugin",
113                    "My network plugin.",
114                    sg_my_network_plugin_init},
115                   {NULL, NULL, NULL}      // this array must be NULL terminated
116 };
117 ~~~~
118
119 \section simgrid_dev_guide_simcall How to add a new simcall?
120
121 A simcall is used to go from user mode to kernel mode. There is some
122 sort of popping dance involved, as we want to isolate the user
123 contextes from their environment (so that they can run in parallel).
124
125 The workflow of a simcall is the following:
126
127 - `<ret> simcall_<name>(<args>)`
128  - `simcall_BODY_<name>(<args>)`
129   - Initializes the simcall (store the arguments in position)
130   - If maestro, executes the simcall directly (and return)
131   - If not, call `SIMIX_process_yield` to give back the control to maestro
132   - ========== KERNEL MODE ==========
133   - `SIMIX_simcall_handle` large switch (on simcall) doing for each:
134    - `simcall_HANDLER_<name>(simcall, <args>)` (the manual code handling the simcall)
135    - If the simcall is not marked as "blocking" in its definition,
136      call `SIMIX_simcall_answer(simcall)` that adds back the issuer
137      process to the list of processes to run in the next scheduling round.
138      It is thus the responsability of the blocking simcalls to call
139      `SIMIX_simcall_answer(simcall)` themselves in their handler.
140
141 Note that empty HANDLERs can be omitted. These functions usually do
142 some parameter checking, or retrieve some information about the
143 simcall issuer, but when there no need for such things, the handler
144 can be omited. In that case, we directly call the function
145 `simcall_<name>(<args>)`.
146
147 To simplify the simcall creation, a python script generates most of
148 the code and give helpers for the remaining stuff. That script reads
149 the simcall definitions from src/simix/simcalls.in, checks that both
150 `simcall_<name>()` and `simcall_HANDLER()` are defined somewhere, and
151 generates the following files:
152
153 - smx_popping_accessors.h:
154   Helper functions to get and set simcall arguments and results
155 - smx_popping_bodies.cpp:
156   The BODY function of each simcall
157 - smx_popping_enum.c:
158   Definition of type `enum e_smx_simcall_t` (one value per existing simcall)
159 - smx_popping_generated.cpp:
160   Definitions of `simcall_names[]` (debug name of each simcall), and
161   SIMIX_simcall_enter() that deals with the simcall from within the kernel
162
163 The simcall.in file list all the simcalls in sections. A line starting by "##"
164 define a new section which will be replace by a "ifdef" in the generated code.
165 There is a simcall by line which follow this format:
166
167 ~~~~
168 Simcall -> Name HasAnswer Res Args
169 Name -> [a-z0-9_]+
170 Has_Answer -> "True" | "False"
171 Res -> "(" Type MaybeCast ")"
172 Args -> Args Arg | Arg
173 Arg -> "(" Name "," Type MaybeCast ")"
174 Type -> "char" | "const char*" | "int" | "long" | "unsigned char" | "unsigned short" | "unsigned int" | "unsigned long" | "float" | "double" | "void*" | "FPtr" | "const void*" | "size_t" | "sg_size_t" | "void" | "void*"
175 MaybeCast -> "," Cast | ""
176 Cast -> [a-z0-9_* ]+
177 ~~~~
178
179 \section simgrid_dev_guide_tag What is How to add a new tag for xml files?
180 Search for expression \"TUTORIAL: New TAG\".
181 \verbatim
182 user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New TAG"
183 0 surf/sg_platf.c                    43 /* TUTORIAL: New TAG*/
184 1 surf/sg_platf.c                    89 /* TUTORIAL: New TAG*/
185 2 surf/sg_platf.c                   124 /* TUTORIAL: New TAG*/
186 3 surf/sg_platf.c                   337 /* TUTORIAL: New TAG*/
187 4 surf/surfxml_parse.c              769 /* TUTORIAL: New TAG*/
188 5 surf/surf_private.h               205 /* TUTORIAL: New TAG*/
189 6 surf/surfxml_parseplatf.c          64 /* TUTORIAL: New TAG*/
190 7 surf/surfxml_parseplatf.c          85 /* TUTORIAL: New TAG*/
191 8 include/simgrid/platf_interface.h  42 /* TUTORIAL: New TAG*/
192 \endverbatim
193 */