1 /*! @page internals SimGrid internals
3 This page does not exist yet, sorry. We are currently refurbishing the
4 user documentation -- the internal documentation will follow (FIXME).
10 \htmlinclude simgrid_modules.map
12 <br><b>SimGrid Components (click to jump to API)</b>
17 \section ug_overview Overview of the toolkit components
20 \subsection ug_overview_envs Programmation environments layer
22 SimGrid provides several programmation environments built on top of a unique
23 simulation kernel. Each environment targets a specific audiance and
24 constitutes a different paradigm. To choose which of them you want to use,
25 you have to think about what you want to do and what would be the result of
28 - If you want to study a theoritical problem and compare several
29 heuristics, you probably want to try <b>\ref MSG_API</b> (yet another
30 historical name). It was designed exactly to that extend and should allow
31 you to build easily rather realistic multi-agents simulation. Yet,
32 realism is not the main goal of this environment and the most annoying
33 technical issues of real platforms are masked here. Check the \ref
34 MSG_API section for more information.
36 - If you want to study the behaviour of a MPI application using emulation
37 technics, you should have a look at the <b>\ref SMPI_API</b> (Simulated
38 MPI) programming environment. Unfortunately, this work is still underway.
39 Check the \ref SMPI_API section for more information.
41 If your favorite programming environment/model is not there (BSP,
42 components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may
43 consider adding it. You should contact us first on the
44 <a href=http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel>SimGrid
45 developers mailing list</a>, though.
47 \subsection ug_overview_kernel Simulation kernel layer
49 The core functionnalities to simulate a virtual platform are provided by a
50 module called <b>\ref SURF_API</b>. It is
51 very low-level and is not intended to be used as such by end-users. Instead,
52 it serve as a basis for the higher level layer.
54 SURF main features are a fast max-min linear solver and the ability to
55 change transparently the model used to describe the platform. This greatly
56 eases the comparison of the several models existing in the litterature.
58 See the \ref SURF_API section for more details.
60 \subsection ug_overview_fondation Base layer
62 The base of the whole toolkit is constituted by the <b>\ref XBT_API
63 (eXtended Bundle of Tools)</b>.
65 It is a portable library providing some grounding features such as \ref
66 XBT_log, \ref XBT_ex and \ref XBT_config. XBT also encompass
67 the following convenient datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref
68 XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag.
70 See the \ref XBT_API section for more details.
73 \subsection ug_lucas_layer Tracing simulation
74 Finally, a transversal module allows you to trace your simulation. More documentation in the section \ref TRACE_doc