X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/12c0f182635ed71b370d608b5b9a614153765cd4..7223c1e880eeb35be5191bc4432e0f51271e36a9:/doc/doxygen/inside_extending.doc diff --git a/doc/doxygen/inside_extending.doc b/doc/doxygen/inside_extending.doc index f7c796b6f9..ea7cc55ce3 100644 --- a/doc/doxygen/inside_extending.doc +++ b/doc/doxygen/inside_extending.doc @@ -1,5 +1,5 @@ -/*! -\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 @@ -26,62 +26,169 @@ user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New API" \endverbatim \section simgrid_dev_guide_model How to add a new model in surf? -Search for expression \"TUTORIAL: New model\". -\verbatim -user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New model" -0 surf/new_model_private.h 2 /* TUTORIAL: New model -1 surf/surf.c 213 /* TUTORIAL: New model*/ -2 surf/surf_config.c 380 /* TUTORIAL: New model*/ -3 surf/surf_config.c 746 /* TUTORIAL: New model*/ -4 surf/new_model.c 8 /* TUTORIAL: New model*/ -5 include/surf/surf.h 157 /* TUTORIAL: New model*/ -6 include/surf/surf.h 345 /* TUTORIAL: New model*/ -7 include/surf/surf.h 661 /* TUTORIAL: New model*/ -\endverbatim +The figure below show the architecture of the SURF layer. This layer is composed +of different kind of models representing the differents systems we want to +modelize (i.e.cpu, network, storage, workstation, virtual machine). -\section simgrid_dev_guide_simcall How to add a new simcall? -To add a simcall called `` with three arguments `arg1`, `arg2` and `arg3` -of type `targ1`, `targ2`, `targ3` respectively and which return a value of -type `tret` you must first define the simcall function in the the -`include/simgrid/simix.h` and make it call the automatically generated `BODY` -function which will do all the bad stuff. - -~~~~{.c} -tret simcall_(targ1 arg1, targ2 arg2, targ3 arg3){ - return simcall_BODY_(arg1, arg2, arg3); +A model in simgrid is composed of three classes: Model, Resource and Action +(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). + +init function: +void surf_cpu_model_init_Cas01() +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 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_host_add_cb(cpu_parse_init); + sg_platf_postparse_add_cb(cpu_add_traces); + + xbt_dynar_push(model_list, &surf_cpu_model_pm); } ~~~~ -Then you must add an new line in the list `SIMCALL_LIST1` of simcall actions in -`src/simix/smx_smurf_private.h`. The arguments of the `ACTION` are: -- the simcall enum name, -- the `` of the simcall, -- if the result must be automatically saved in the simcall - (`WITH_ANSWER`/`WITHOUT_ANSWER`) -- the return type, -- the arguments. - -The return type and the arguments must be define by using `TSPEC(name, type)`, -or one of the predefined type (e.g., `TSTRING(n)`, `TINT(n)`, `TVOID(n)`, -`TPTR(n)`, …). You must get something like this: - -~~~~{.c} -ACTION(SIMCALL_, , WITH_ANSWER, TSPEC(result, tret), TSPEC(arg1, targ1), TSPEC(arg2, targ2), TSPEC(arg3, targ3)) sep \ +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. + + +\section simgrid_dev_guide_surf_callbacks How to use surf callbacks? -Finaly you have to define the kernel code in a `SIMIX_pre_` in the -corresponding src/simix/smx_*.c file: +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. -~~~~{.c} -tret SIMIX_pre_(smx_simcall_t simcall, targ1 arg1, targ2 arg2, targ3 arg3) { - SIMIX_(arg1, arg2, arg3); +~~~~ +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 } -tret SIMIX_(targ1 arg1, targ2 arg2, targ3 arg3) { - // Your code in kernel mode +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: + +- ` simcall_()` + - `simcall_BODY_()` + - create the simcall + - `SIMIX_process_yield` if not 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. + +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. +There is a simcall by line which follow this format: + +~~~~ +Simcall -> Name HasAnswer Res Args +Name -> [a-z0-9_]+ +Has_Answer -> "True" | "False" +Res -> "(" Type MaybeCast ")" +Args -> Args Arg | Arg +Arg -> "(" Name "," Type MaybeCast ")" +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*" +MaybeCast -> "," Cast | "" +Cast -> [a-z0-9_* ]+ +~~~~ + \section simgrid_dev_guide_tag What is How to add a new tag for xml files? Search for expression \"TUTORIAL: New TAG\". \verbatim