]> AND Public Git Repository - simgrid.git/blobdiff - doc/doxygen/inside_extending.doc
Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Delete unused ctor.
[simgrid.git] / doc / doxygen / inside_extending.doc
index 10d38b63b7c1a650c9fc64da673f585324b58d3a..83c934e5926f0cc155e54992e03368d6572e27b9 100644 (file)
@@ -34,7 +34,7 @@ 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
+CpuPlopAction implementing respectively the interfaces CpuModel, Cpu and
 CpuAction. You also need to define a initializing function like this:
 
 ~~~~
@@ -55,7 +55,7 @@ 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).",
+   "Simplistic CPU model (time=size/speed).",
    surf_cpu_model_init_Cas01},
   {"Plop",
    "The new plop CPU model.",
@@ -101,7 +101,7 @@ void sg_my_network_plugin_init() {
 }
 ~~~~
 
-Then you need to add an entry in surf_interface.cpp refering to your
+Then you need to add an entry in surf_interface.cpp referring to your
 initialization function.
 
 ~~~~
@@ -138,20 +138,20 @@ The workflow of a simcall is the following:
  - `simcall_BODY_<name>(<args>)`
   - 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
+  - If not, call `ActorImpl::yield` to give back the control to maestro
   - ========== KERNEL MODE ==========
-  - `SIMIX_simcall_handle` large switch (on simcall) doing for each:
+  - `ActorImpl::simcall_handle` large switch (on simcall) doing for each:
    - `simcall_HANDLER_<name>(simcall, <args>)` (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
+     call `ActorImpl::simcall_answer()` 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.
+     It is thus the responsibility of the blocking simcalls to call
+     `ActorImpl::simcall_answer()` 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
+can be omitted. In that case, we directly call the function
 `simcall_<name>(<args>)`.
 
 To simplify the simcall creation, a python script generates most of
@@ -164,7 +164,7 @@ generates the following files:
   Helper functions to get and set simcall arguments and results
 - popping_bodies.cpp:
   The BODY function of each simcall
-- popping_enum.h:
+- popping_enum.hpp:
   Definition of type `enum e_smx_simcall_t` (one value per existing simcall)
 - popping_generated.cpp:
   Definitions of `simcall_names[]` (debug name of each simcall), and
@@ -204,7 +204,7 @@ in.
 For simcalls which might block, `kernel_sync()` can be used. It takes a
 C++ callback and executes it immediately in maestro. This C++ callback is
 expected to return a `simgrid::kernel::Future<T>` reprensenting the operation
-in the kernal. When the operations completes, the user process is waken up
+in the kernel. When the operations completes, the user process is waken up
 with the result:
 
 ~~~