doc/doxygen/inside.doc

   1 /*! @page inside Coding Standard and Project Architecture
   2
   3 TBD: Coding Standard
   4
   5 There is two main things you want to know about the internals of
   6 SimGrid. First, you need to understand the component organization, as
   7 SimGrid is heavily layered, with each level being rather highly
   8 specialized and optimized toward a task. For that, please keep reading
   9 this page. If you work actively on the SimGrid project, the second
  10 point you need to understand is about the infrastructure of the
  11 SimGrid project, ie how to extend the framework in any way, how the
  12 automatic tests are run, and so on. These informations are split on
  13 several pages, as follows:
  14
  15  - @subpage inside_tests
  16  - @subpage inside_doxygen
  17  - @subpage inside_extending
  18  - @subpage inside_cmake
  19  - @subpage inside_release
  20
  21
  22 \htmlonly
  23 <center>
  24 \endhtmlonly
  25 \htmlinclude simgrid_modules.map
  26 \htmlonly
  27 <br><b>SimGrid Components (click to jump to API)</b>
  28 </center>
  29 \endhtmlonly
  30
  31
  32 \section ug_overview Overview of the toolkit components
  33
  34
  35 \subsection ug_overview_envs Programmation environments layer
  36
  37 SimGrid provides several programmation environments built on top of a unique
  38 simulation kernel. Each environment targets a specific audiance and
  39 constitutes a different paradigm. To choose which of them you want to use,
  40 you have to think about what you want to do and what would be the result of
  41 your work.
  42
  43  - If you want to study a theoritical problem and compare several
  44    heuristics, you probably want to try <b>\ref MSG_API</b> (yet another
  45    historical name). It was designed exactly to that extend and should allow
  46    you to build easily rather realistic multi-agents simulation. Yet,
  47    realism is not the main goal of this environment and the most annoying
  48    technical issues of real platforms are masked here. Check the \ref
  49    MSG_API section for more information.
  50
  51  - If you want to study the behaviour of a MPI application using emulation
  52    technics, you should have a look at the <b>\ref SMPI_API</b> (Simulated
  53    MPI) programming environment. Unfortunately, this work is still underway.
  54    Check the \ref SMPI_API section for more information.
  55
  56 If your favorite programming environment/model is not there (BSP,
  57 components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may
  58 consider adding it. You should contact us first on the
  59 <a href=http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel>SimGrid
  60 developers mailing list</a>, though.
  61
  62 \subsection ug_overview_kernel Simulation kernel layer
  63
  64 The core functionnalities to simulate a virtual platform are provided by a
  65 module called <b>\ref SURF_API</b>.  It is
  66 very low-level and is not intended to be used as such by end-users. Instead,
  67 it serve as a basis for the higher level layer.
  68
  69 SURF main features are a fast max-min linear solver and the ability to
  70 change transparently the model used to describe the platform. This greatly
  71 eases the comparison of the several models existing in the litterature.
  72
  73 See the \ref SURF_API section for more details.
  74
  75 \subsection ug_overview_fondation Base layer
  76
  77 The base of the whole toolkit is constituted by the <b>\ref XBT_API
  78 (eXtended Bundle of Tools)</b>.
  79
  80 It is a portable library providing some grounding features such as \ref
  81 XBT_log, \ref XBT_ex and \ref XBT_config. XBT also encompass
  82 the following convenient datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref
  83 XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag.
  84
  85 See the \ref XBT_API section for more details.
  86
  87
  88 \subsection ug_lucas_layer Tracing simulation
  89 Finally, a transversal module allows you to trace your simulation. More documentation in the section \ref TRACE_doc
  90
  91 */