doc/doxygen/module-surf.doc

   1 /** @addtogroup SURF_API
   2
   3   @section SURF_doc Surf documentation
   4    Surf is composed several components:
   5    - @ref SURF_simulation
   6    - @ref SURF_models
   7    - @ref SURF_build_api
   8    - @ref SURF_c_bindings
   9    - @ref SURF_interface
  10    - @ref SURF_cpu_interface
  11    - @ref SURF_network_interface
  12    - @ref SURF_storage_interface
  13    - @ref SURF_host_interface
  14    - @ref SURF_vm_interface
  15    - @ref SURF_lmm
  16    - @ref SURF_callbacks
  17    - @ref plugin_energy
  18
  19
  20 */
  21
  22 /** @defgroup SURF_models Simulation Models
  23     @ingroup SURF_API
  24     @brief Functions to declare the kind of models that you want to use
  25     */
  26
  27 /** @defgroup SURF_simulation Simulation
  28     @ingroup SURF_API
  29     @brief Functions for creating the environment and launching the simulation
  30
  31     This section describes the functions for initializing SURF, performing
  32     the simulation and exiting SURF.
  33 */
  34
  35 /** @defgroup SURF_build_api Create a new API
  36     @ingroup SURF_API
  37     @brief How to build a new API on top of SURF
  38
  39     SURF provides the functionalities to simulate the platform. There are two main data types in SURF:
  40     the actions and the resources. Several types of resources exist:
  41         - the host resource,
  42         - the network resource,
  43         - the CPU resource,
  44         - the timer resource.
  45
  46     FIXME[donassolo]: fix doc
  47     The implementation of these resources depends on the platform
  48     models you choose.  You can select your model by calling
  49     #surf_host_model_init_current_default() (which will give you a
  50     CLM03 model), or similar (see @ref SURF_models).
  51
  52     To initialize SURF, call #surf_init(). Then
  53     #surf_host_model_init_current_default() or #surf_host_model_init_ptask_L07()
  54     to create the platform.
  55
  56     Then you can access the hosts with the @ref simgrid::s4u::Engine::get_all_hosts.
  57     Some functions of the @ref SURF_host_interface and similar can give
  58     you some information about:
  59         - a host: get_speed(), get_available_speed();
  60         - a network link: get_link_name(), get_link_latency(), get_link_bandwidth();
  61         - a route: get_route(), get_route_size().
  62
  63     During the simulation, call @a surf_host_model->execute() to schedule a
  64     computation task on a host, or @a surf_host_model->communicate()
  65     to schedule a communication task between two hosts. You can also create parallel task
  66     with @a surf_host_model->extension_public->execute_parallel_task(). These functions return
  67     a new action that represents the task you have just created.
  68
  69     To execute the actions created with @a execute(), @a communicate() or @a execute_parallel_task(), call
  70     surf_solve(). The function surf_solve() is where the simulation takes place. It returns the
  71     time elapsed to execute the actions. You can know what actions have changed their state thanks
  72     to the states sets. For example, if your want to know what actions are finished,
  73     extract them from @a surf_host_model->common_public->states.done_action_set.
  74     Depending on these results, you can schedule other tasks and call surf_solve() again.
  75
  76     When the simulation is over, just call surf_exit() to clean the memory.
  77
  78     Have a look at the implementation of @ref MSG_API "MSG" and @ref SD_API "Simdag" to see how these module
  79     interact with SURF. But if you want to create a new API on top of SURF,
  80     we strongly recommend you to contact us before anyway.
  81
  82 */
  83
  84 /**
  85 @defgroup SURF_c_bindings   SURF C bindings
  86 @ingroup SURF_API
  87 @brief Describes the c bindings of SURF
  88 */
  89
  90 /**
  91 @defgroup SURF_interface   SURF Interface
  92 @ingroup SURF_API
  93 @brief Describes the general interface for all components (Cpu, Network, Storage, Host, VM)
  94 */
  95
  96 /**
  97 @defgroup SURF_cpu_interface   SURF Cpu Interface
  98 @ingroup SURF_API
  99 @brief Describes the general Cpu interface for all Cpu implementations
 100 */
 101
 102 /**
 103 @defgroup SURF_network_interface   SURF Network Interface
 104 @ingroup SURF_API
 105 @brief Describes the general Network interface for all Network implementations
 106 */
 107
 108 /**
 109 @defgroup SURF_storage_interface   SURF Storage Interface
 110 @ingroup SURF_API
 111 @brief Describes the general  interface for all Storage implementations
 112 */
 113
 114 /**
 115 @defgroup SURF_host_interface   SURF Host Interface
 116 @ingroup SURF_API
 117 @brief Describes the general  interface for all Host implementations
 118 */
 119
 120 /**
 121 @defgroup SURF_vm_interface   SURF VM Interface
 122 @ingroup SURF_API
 123 @brief Describes the general  interface for all VM implementations
 124 */
 125
 126 /**
 127 @defgroup SURF_lmm   SURF Linear MaxMin
 128 @ingroup SURF_API
 129 @brief Describes how the linear MaxMin system work
 130 */
 131
 132 /**
 133 @defgroup SURF_callbacks   SURF callbacks
 134 @ingroup SURF_API
 135 @brief Describes how to use the SURF callbacks
 136 */
 137
 138 /**
 139 @defgroup plugin_energy   Energy Plugin
 140 @ingroup SURF_API
 141 @brief Describes how to use the energy plugin.
 142 */