X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9cf597c8b21744f11128f1d93fd0cf8272106e27..7f4f03348bd07609e258eb3b545bdafc2c881847:/doc/doxygen/inside_extending.doc diff --git a/doc/doxygen/inside_extending.doc b/doc/doxygen/inside_extending.doc index cf71bb1066..7d00215a3b 100644 --- a/doc/doxygen/inside_extending.doc +++ b/doc/doxygen/inside_extending.doc @@ -1,80 +1,167 @@ -/*! -\page inside_extending Extending SimGrid +/*! +\page inside_extending Extending SimGrid -We start to put TAGS in simgrid source code for having tutorials to see where is the important parts ans steps to create: -\li \ref simgrid_dev_guide_api -\li \ref simgrid_dev_guide_model -\li \ref simgrid_dev_guide_tag - -\section simgrid_dev_guide_api How to add a new MSG function? -Search for expression \"TUTORIAL: New API\". -\verbatim -user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New API" - 0 msg/msg_new_api.c 15 /* TUTORIAL: New API*/ - 1 simix/smx_smurf.c 582 /* TUTORIAL: New API*/ - 2 simix/smx_smurf.c 616 /* TUTORIAL: New API*/ - 3 simix/smx_smurf_private.h 102 /* TUTORIAL: New API*/ - 4 simix/smx_smurf_private.h 629 /* TUTORIAL: New API*/ - 5 simix/smx_private.h 28 /* TUTORIAL: New API*/ - 6 simix/smx_private.h 101 /* TUTORIAL: New API*/ - 7 simix/smx_private.h 182 /* TUTORIAL: New API*/ - 8 simix/smx_global.c 454 /* TUTORIAL: New API*/ - 9 simix/smx_new_api.c 8 /* TUTORIAL: New API*/ -10 simix/smx_user.c 1684 /* TUTORIAL: New API*/ -11 simix/smx_new_api_private.h 8 /* TUTORIAL: New API*/ -12 simix/smx_process.c 338 /* TUTORIAL: New API*/ -\endverbatim +\tableofcontents \section simgrid_dev_guide_model How to add a new model in surf? +The figure below shows the architecture of the SURF layer. This layer is composed +of different kinds of models representing the different systems we want to +model (i.e., cpu, network, storage, workstation, virtual machine). + A model in simgrid is composed of three classes: Model, Resource and Action -(surf_interface.hpp). +(\ref SURF_interface "surf_interface.hpp"). + +\image html surf++.png +\image latex surf++.pdf "surf++" width=\textwidth Actually there are five kind of models: CpuModel, NetworkModel, WorkstationModel, WorkstationVMModel and StorageModel. For each kind of model, there is an -interface (e.g.: cpu_interface.hpp) and some implementations (e.g.: cpu_cas01.hpp, -cpu_ti.hpp). +interface (e.g.: \ref SURF_cpu_interface "cpu_interface.hpp") and some implementations (e.g.: cpu_cas01.hpp, +cpu_ti.hpp). + +The CPU model Cas01, for instance, is initialized by the function + void surf_cpu_model_init_Cas01() + +The different network models that are offered by simgrid are stored in the array +that is defined as follows: + +s_surf_model_description_t surf_network_model_description[] = { + +\subsection simgrid_dev_guide_model_implem How to add a new model implementation in surf? If you want to create a new implementation of a kind of model you must extend -the classes of the corresponding interface. +the classes of the corresponding interfaces. + +For instance, if you want to add a new cup model called `Plop`, create two files +cpu_plop.hpp and cpu_plop_cpp which contains classes CpuPlopModel, CpuPlop and +CpuPlopAction implementating respectively the interfaces CpuModel, Cpu and +CpuAction. You also need to define a initializing function like this: + +~~~~ +void surf_cpu_model_init_plop() +{ + xbt_assert(!surf_cpu_model_pm); + + surf_cpu_model_pm = new CpuPlopModel(); + + sg_platf_postparse_add_cb(cpu_add_traces); + + xbt_dynar_push(model_list, &surf_cpu_model_pm); +} +~~~~ + +and add an entry in the corresponding array in surf_interface.cpp + +~~~~ +s_surf_model_description_t surf_cpu_model_description[] = { + {"Cas01", + "Simplistic CPU model (time=size/power).", + surf_cpu_model_init_Cas01}, + {"Plop", + "The new plop CPU model.", + surf_cpu_model_init_plop}, + {NULL, NULL, NULL} // this array must be NULL terminated +}; +~~~~ + +\subsection simgrid_dev_guide_model_kind How to add a new kind of model in surf? If you want to create a new kind of model, you must create a new interface - where you extend the classes Model, Resource and Action, and then create an - implementation of this interface. +where you extend the classes Model, Resource and Action, and then create an +implementation of this interface. + + +\section simgrid_dev_guide_surf_callbacks How to use surf callbacks? + +Adding features to surf could also be handle by using surf callbacks (instead +of adding new implementation model). The list of available callbacks is +accessible there \ref SURF_callbacks. An example of using surf callbacks is the +energy plugin. If you want to add a plugin you need to define callback function +and to connect them to callbacks handler in an initialization function. + +~~~~ +static void MyNetworkLinkCreatedCallback(NetworkLinkPtr cpu){ + // your code +} + +static void MyNetworkLinkDestructedCallback(NetworkLinkPtr cpu){ + // your code +} + +static void MyNetworkCommunicationCallback(NetworkActionPtr cpu, + RoutingEdgePtr src, + RoutingEdgePtr dst){ + // your code +} + +void sg_my_network_plugin_init() { + surf_callback_connect(networkLinkCreatedCallbacks, + MyNetworkLinkCreatedCallback); + surf_callback_connect(networkLinkDestructedCallbacks, + MyNetworkLinkDestructedCallback); + surf_callback_connect(networkCommunicationCallbacks, + MyNetworkCommunicationCallback); +} +~~~~ + +Then you need to add an entry in surf_interface.cpp refering to your +initialization function. + +~~~~ +s_surf_model_description_t surf_plugin_description[] = { + {"Energy", + "Cpu energy consumption.", + sg_energy_plugin_init}, + {"MyNetworkPlugin", + "My network plugin.", + sg_my_network_plugin_init}, + {NULL, NULL, NULL} // this array must be NULL terminated +}; +~~~~ \section simgrid_dev_guide_simcall How to add a new simcall? -A simcall is used to go from user mode to kernel mode. The workflow of -a simcall is the following: + +A simcall is used to go from user mode to kernel mode. There is some +sort of popping dance involved, as we want to isolate the user +contextes from their environment (so that they can run in parallel). + +The workflow of a simcall is the following: - ` simcall_()` - `simcall_BODY_()` - - create the simcall - - `SIMIX_process_yield` if not maestro + - Initializes the simcall (store the arguments in position) + - If maestro, executes the simcall directly (and return) + - If not, call `SIMIX_process_yield` to give back the control to maestro - ========== KERNEL MODE ========== - - `SIMIX_simcall_pre` - - `SIMIX_pre_(simcall, )` - - `SIMIX_simcall_answer(simcall)` - -To simplify the simcall creation, we have made a python script that -generate most of the code and give helpers for the remaining stuff. -The script generating the simcalls (src/simix/simcalls.in) take in input -the src/simix/simcalls.in file where the simcalls are defined and generate -the following files: - -- simcall_generated_args_getter_setter.h: - functions to get and set simcall arguments -- simcall_generated_res_getter_setter.h: - functions to get and set simcall result -- simcall_generated_body.c: - the BODY function of the simcall -- simcall_generated_case.c: - the case of the SIMIX_simcall_pre function -- simcall_generated_enum.h: - the enum of simcalls -- simcall_generated_string.c: - string corresponding to the enum to debug - -Furthermode if the simcall_ or the SIMIX_pre_ function are missing, -a warning will show up with a prototype of the corresponding fonction to fill. + - `SIMIX_simcall_handle` large switch (on simcall) doing for each: + - `simcall_HANDLER_(simcall, )` (the manual code handling the simcall) + - If the simcall is not marked as "blocking" in its definition, + call `SIMIX_simcall_answer(simcall)` that adds back the issuer + process to the list of processes to run in the next scheduling round. + It is thus the responsability of the blocking simcalls to call + `SIMIX_simcall_answer(simcall)` themselves in their handler. + +Note that empty HANDLERs can be omitted. These functions usually do +some parameter checking, or retrieve some information about the +simcall issuer, but when there no need for such things, the handler +can be omited. In that case, we directly call the function +`simcall_()`. + +To simplify the simcall creation, a python script generates most of +the code and give helpers for the remaining stuff. That script reads +the simcall definitions from src/simix/simcalls.in, checks that both +`simcall_()` and `simcall_HANDLER()` are defined somewhere, and +generates the following files: + +- smx_popping_accessors.h: + Helper functions to get and set simcall arguments and results +- smx_popping_bodies.cpp: + The BODY function of each simcall +- smx_popping_enum.c: + Definition of type `enum e_smx_simcall_t` (one value per existing simcall) +- smx_popping_generated.cpp: + Definitions of `simcall_names[]` (debug name of each simcall), and + SIMIX_simcall_enter() that deals with the simcall from within the kernel The simcall.in file list all the simcalls in sections. A line starting by "##" define a new section which will be replace by a "ifdef" in the generated code.