From 9cf597c8b21744f11128f1d93fd0cf8272106e27 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Paul=20B=C3=A9daride?= Date: Mon, 17 Feb 2014 11:47:25 +0100 Subject: [PATCH] Add doc for new models and simcall --- doc/doxygen/inside_extending.doc | 102 +++++++++++++++++-------------- 1 file changed, 56 insertions(+), 46 deletions(-) diff --git a/doc/doxygen/inside_extending.doc b/doc/doxygen/inside_extending.doc index f7c796b6f9..cf71bb1066 100644 --- a/doc/doxygen/inside_extending.doc +++ b/doc/doxygen/inside_extending.doc @@ -26,60 +26,70 @@ 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 +A model in simgrid is composed of three classes: Model, Resource and Action +(surf_interface.hpp). -\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. +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). -~~~~{.c} -tret simcall_(targ1 arg1, targ2 arg2, targ3 arg3){ - return simcall_BODY_(arg1, arg2, arg3); -} -~~~~ +If you want to create a new implementation of a kind of model you must extend +the classes of the corresponding interface. -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. +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. -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: +\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: -~~~~{.c} -ACTION(SIMCALL_, , WITH_ANSWER, TSPEC(result, tret), TSPEC(arg1, targ1), TSPEC(arg2, targ2), TSPEC(arg3, targ3)) sep \ -~~~~ +- ` 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: -Finaly you have to define the kernel code in a `SIMIX_pre_` in the -corresponding src/simix/smx_*.c file: +- 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 -~~~~{.c} -tret SIMIX_pre_(smx_simcall_t simcall, targ1 arg1, targ2 arg2, targ3 arg3) { - SIMIX_(arg1, arg2, arg3); -} +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. -tret SIMIX_(targ1 arg1, targ2 arg2, targ3 arg3) { - // Your code in kernel mode -} +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? -- 2.20.1