2
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>SimGrid: </title>
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
<title>SimGrid: SimGrid Documentation</title>
6
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
<link href="simgrid.css" rel="stylesheet" type="text/css">
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
10
<link href="navtree.css" rel="stylesheet" type="text/css"/>
11
<script type="text/javascript" src="resize.js"></script>
12
<script type="text/javascript" src="navtree.js"></script>
13
<script type="text/javascript">
14
$(document).ready(initResizable);
16
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17
<script type="text/javascript" src="search/search.js"></script>
18
<script type="text/javascript">
19
$(document).ready(function() { searchBox.OnSelectItem(0); });
21
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
11
<!-- Generated by Doxygen 1.7.4 -->
24
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
13
25
<div id="titlearea">
14
26
<table cellspacing="0" cellpadding="0">
16
28
<tr style="height: 56px;">
17
29
<td style="padding-left: 0.5em;">
18
<div id="projectname">SimGrid <span id="projectnumber">3.7.1</span></div>
19
<div id="projectbrief">Scalable simulation of distributed systems</div>
30
<div id="projectname">SimGrid
31
 <span id="projectnumber">3.9</span>
33
<div id="projectbrief">Versatile Simulation of Distributed Systems</div>
25
<div id="navrow1" class="tabs">
39
<div id="navrow1" class="tabs">
26
40
<ul class="tablist">
27
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
28
<li><a href="use.html"><span>Using SimGrid</span></a></li>
29
<li><a href="http://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
30
<li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>
31
<li><a href="pages.html"><span>Documentation index</span></a></li>
32
<li><a href="FAQ.html"><span>FAQ</span></a></li>
41
<li><a href="http://simgrid.gforge.inria.fr/"><span>Home page</span></a></li>
42
<li><a href="http://simgrid.gforge.inria.fr/documentation.html"><span>Online documentation</span></a></li>
43
<li><a href="https://gforge.inria.fr/projects/simgrid"><span>Dev's Corner</span></a></li>
44
<li> <div id="MSearchBox" class="MSearchBoxInactive">
46
<img id="MSearchSelect" src="search/mag_sel.png"
47
onmouseover="return searchBox.OnSearchSelectShow()"
48
onmouseout="return searchBox.OnSearchSelectHide()"
50
<input type="text" id="MSearchField" value="Search" accesskey="S"
51
onfocus="searchBox.OnSearchFieldFocus(true)"
52
onblur="searchBox.OnSearchFieldFocus(false)"
53
onkeyup="searchBox.OnSearchFieldChange(event)"/>
54
</span><span class="right">
55
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
61
<!-- end header part -->
62
<!-- Generated by Doxygen 1.8.1.2 -->
63
<script type="text/javascript">
64
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67
<div id="side-nav" class="ui-resizable side-nav-resizable">
69
<div id="nav-tree-contents">
70
<div id="nav-sync" class="sync"></div>
73
<div id="splitbar" style="-moz-user-select:none;"
74
class="ui-resizable-handle">
77
<script type="text/javascript">
78
$(document).ready(function(){initNavTree('index.html','');});
80
<div id="doc-content">
81
<!-- window showing the filter options -->
82
<div id="MSearchSelectWindow"
83
onmouseover="return searchBox.OnSearchSelectShow()"
84
onmouseout="return searchBox.OnSearchSelectHide()"
85
onkeydown="return searchBox.OnSearchSelectKey(event)">
86
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
88
<!-- iframe showing the search results (closed by default) -->
89
<div id="MSearchResultsWindow">
90
<iframe src="javascript:void(0)" frameborder="0"
91
name="MSearchResults" id="MSearchResults">
96
<div class="headertitle">
97
<div class="title">SimGrid Documentation </div> </div>
36
99
<div class="contents">
37
<div class="textblock"><center>
40
<td valign="middle" align="left">
41
<img src="simgrid_logo_2011.png" alt="SimGrid - Scalable simulation of distributed systems, ranging from grids to peer-to-peer systems" />
43
<td valign="middle" align="left">
44
<!-- Automatically generated table of contents --!>
46
<div class="tocTitle">Table of content</div>
48
<li> <a href="#overview">Overview of the toolkit components</a>
50
<li> <a href="#overview_envs">Programmation environments layer</a>
51
<li> <a href="#overview_kernel">Simulation kernel layer</a>
52
<li> <a href="#overview_fondation">Base layer</a>
53
<li> <a href="#lucas_layer">Tracing simulation</a>
57
<!-- End of automatically generated table of contents --!>
100
<div class="textblock"><div class="image">
101
<img src="simgrid_logo_2011.png" alt="simgrid_logo_2011.png"/>
102
<div class="caption">
103
Versatile Simulation of Distributed Systems, for Grids, Clouds, P2P and HPC systems</div></div>
62
</center><p>SimGrid is a toolkit that provides core functionalities for the simulation of distributed applications in heterogeneous distributed environments. <!-- ______BODY_BEGIN______ --!> The specific goal of the project is to facilitate research in the area of distributed and parallel application scheduling on distributed computing platforms ranging from simple network of workstations to Computational Grids. <!-- ______BODY_END______ --!> <ul>
63
<li>The official webpage is <a href="http://simgrid.gforge.inria.fr/">simgrid.gforge.inria.fr</a>.</li>
64
<li>The Frequently Asked Questions are <a href="http://simgrid.gforge.inria.fr/faq.html">here</a>.</li>
65
<li>The development webpage is <a href="https://gforge.inria.fr/projects/simgrid//">gforge.inria.fr/projects/simgrid</a>.</li>
66
<li>The user mailing list is <<a href="mailto:simgrid-user@lists.gforge.inria.fr">simgrid-user@lists.gforge.inria.fr</a>></li>
67
<li>The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.php">here</a>. <br/>
71
<h2><a class="anchor" id="overview"></a>
72
Overview of the toolkit components</h2>
73
<p>As depicted by the following diagram, the SimGrid toolkit is basically three-layered (click on the picture to jump to a specific component).</p>
74
<!-- ______BODY_BEGIN______ --!>
76
<IMG style=border:0px SRC="simgrid_modules.png" USEMAP="#simgrid_modules">
109
<li><a class="el" href="getting_started.html">SimGrid in 30mn</a></li>
110
<li><a class="el" href="introduction.html">Introduction to SimGrid</a></li>
111
<li><a class="el" href="install.html">Installing Simgrid</a></li>
112
<li><a class="el" href="use.html">Using SimGrid</a><ul>
113
<li><a class="el" href="platform.html">Platform Description</a></li>
114
<li><a class="el" href="deployment.html">Deployment Description</a></li>
115
<li><a class="el" href="tracing.html">Tracing Simulations for Visualization</a></li>
116
<li><a class="el" href="options.html">Simgrid options and configurations</a></li>
117
<li><a class="el" href="help.html">Getting help</a></li>
120
<li><a class="el" href="advanced.html">Advanced Topics</a><ul>
121
<li><a class="el" href="bindings.html">Bindings</a></li>
122
<li><a class="el" href="pls.html">Packet level simulation</a></li>
123
<li><a class="el" href="contributing.html">Contributing to SimGrid</a></li>
124
<li><a class="el" href="internals.html">SimGrid internals</a></li>
127
<li><a class="el" href="FAQ.html">Frequently Asked Questions</a></li>
130
</td><td width="50%" align="center">
131
<IMG style=border:0px SRC="simgrid_modules.png" USEMAP="#simgrid_modules">
77
132
<MAP NAME="simgrid_modules">
78
<AREA COORDS="706,67,744,281" href="group__TRACE__API.html" ALT="TRACE">
79
<AREA COORDS="438,7,640,42" href="/contrib.html" ALT="Contrib">
80
<AREA COORDS="527,70,691,152" href="group__SD__API.html" ALT="SimDag">
81
<AREA COORDS="354,70,517,152" href="group__SMPI__API.html" ALT="SMPI">
82
<AREA SHAPE="poly" COORDS="344,152,344,121,269,121,269,70,180,70,180,152" href="group__GRAS__API.html" ALT="GRAS">
133
<AREA COORDS="536,64,574,281" href="group__TRACE__API.html" ALT="TRACE">
134
<AREA COORDS="294,7,496,42" href="/contrib.html" ALT="Contrib">
83
135
<AREA COORDS="10,70,171,152" href="group__MSG__API.html" ALT="MSG">
84
<AREA COORDS="10,161,691,221" href="group__SURF__API.html" ALT="SMPI">
85
<AREA COORDS="273,70,343,114" href="group__AMOK__API.html" ALT="AMOK">
86
<AREA SHAPE="poly" COORDS="1,67,1,281,697,281,697,67" href="group__XBT__API.html" ALT="XBT">
136
<AREA COORDS="10,161,517,221" href="group__SURF__API.html" ALT="SMPI">
137
<AREA COORDS="354,70,517,152" href="group__SD__API.html" ALT="SimDag">
138
<AREA COORDS="180,70,344,152" href="group__SMPI__API.html" ALT="SMPI">
139
<AREA SHAPE="poly" COORDS="1,64,1,281,527,281,527,64" href="group__XBT__API.html" ALT="XBT">
89
<br><b>Relationships between the SimGrid components (click to jump to API)</b>
91
<!-- ______BODY_END______ --!> <h3><a class="anchor" id="overview_envs"></a>
92
Programmation environments layer</h3>
93
<p>SimGrid provides several programmation environments built on top of a unique simulation kernel. Each environment targets a specific audiance and constitutes a different paradigm. To choose which of them you want to use, you have to think about what you want to do and what would be the result of your work.</p>
95
<li>If you want to study a theoritical problem and compare several heuristics, you probably want to try <b><a class="el" href="group__MSG__API.html">MSG</a></b> (yet another historical name). It was designed exactly to that extend and should allow you to build easily rather realistic multi-agents simulation. Yet, realism is not the main goal of this environment and the most annoying technical issues of real platforms are masked here. Check the <a class="el" href="group__MSG__API.html">MSG</a> section for more information.</li>
98
<li>If you want to study the behaviour of a MPI application using emulation technics, you should have a look at the <b><a class="el" href="group__SMPI__API.html">SMPI</a></b> (Simulated MPI) programming environment. Unfortunately, this work is still underway. Check the <a class="el" href="group__SMPI__API.html">SMPI</a> section for more information.</li>
101
<li>If you want to develop a real distributed application, then you may find <b><a class="el" href="group__GRAS__API.html">GRAS</a></b> (Grid Reality And Simulation) useful. This is an API for the realization of distributed applications. <br/>
103
Moreover, there is two implementations of this API: one on top of the SURF (allowing to develop and test your application within the comfort of the simulator) and another suited for deployment on real platforms (allowing the resulting application to be highly portable and extremely efficient). <br/>
105
Even if you do not plan to run your code for real, you may want to switch to GRAS if you intend to use MSG in a very intensive way (e.g. for simulating a peer-to-peer environment). <br/>
107
See the <a class="el" href="group__GRAS__API.html">GRAS</a> section for more details.</li>
109
<p>If your favorite programming environment/model is not there (BSP, components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may consider adding it. You should contact us first on the <a href="http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel">SimGrid developers mailing list</a>, though.</p>
110
<h3><a class="anchor" id="overview_kernel"></a>
111
Simulation kernel layer</h3>
112
<p>The core functionnalities to simulate a virtual platform are provided by a module called <b><a class="el" href="group__SURF__API.html">SURF</a></b>. It is very low-level and is not intended to be used as such by end-users. Instead, it serve as a basis for the higher level layer.</p>
113
<p>SURF main features are a fast max-min linear solver and the ability to change transparently the model used to describe the platform. This greatly eases the comparison of the several models existing in the litterature.</p>
114
<p>See the <a class="el" href="group__SURF__API.html">SURF</a> section for more details.</p>
115
<h3><a class="anchor" id="overview_fondation"></a>
117
<p>The base of the whole toolkit is constituted by the <b><a class="el" href="group__XBT__API.html">XBT</a> (eXtended Bundle of Tools)</b>.</p>
118
<p>It is a portable library providing some grounding features such as <a class="el" href="group__XBT__log.html">Logging support</a>, <a class="el" href="group__XBT__ex.html">Exception support</a> and <a class="el" href="group__XBT__config.html">Configuration support</a>. XBT also encompass the following convenient datastructures: <a class="el" href="group__XBT__dynar.html">Dynar: generic dynamic array</a>, <a class="el" href="group__XBT__fifo.html">Fifo: generic workqueue</a>, <a class="el" href="group__XBT__dict.html">Dict: generic dictionnary</a>, <a class="el" href="group__XBT__heap.html">Heap: generic heap data structure</a>, <a class="el" href="group__XBT__set.html">Set: generic set datatype</a> and <a class="el" href="group__XBT__swag.html">Swag: O(1) set datatype</a>.</p>
119
<p>See the <a class="el" href="group__XBT__API.html">XBT</a> section for more details.</p>
120
<h3><a class="anchor" id="lucas_layer"></a>
121
Tracing simulation</h3>
122
<p>Finally, a transversal module allows you to trace your simulation. More documentation in the section <a class="el" href="group__TRACE__API.html#TRACE_doc">TRACE documentation</a></p>
123
<!-- ______BODY_BEGIN______ --!> <br/>
124
The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.php">here</a>.<br/>
126
<p>If you are interested in the history of SimGrid and in current and planned development, you can find out more <a href="http://simgrid.gforge.inria.fr/history.html">here</a>.</p>
127
<p>Any question, remark or suggestion are welcome on the <a href="http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user">SimGrid users mailing list</a>.</p>
128
<!-- ______BODY_END______ --!> <hr/>
131
<a href="http://creativecommons.org/licenses/LGPL/2.1/"><img alt="CC-GNU LGPL" border="0" src="http://creativecommons.org/images/public/cc-LGPL-a.png" /></a>
140
<a href="index.html"><b>
141
Back to the main Simgrid Documentation page</b></a>
144
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.1.<br/>
145
Documentation of other versions can be found in their respective
146
archive files (directory doc/html).
149
<small>Generated by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a> </small>
142
<b>SimGrid Components (click to jump to API)</b></p>
145
</div></div><!-- contents -->
146
</div><!-- doc-content -->
147
<!-- start footer part -->
148
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
150
<li class="footer">Generated on Wed Jan 30 2013 17:21:58 for SimGrid by
151
<a href="http://www.doxygen.org/index.html">
152
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
added
removed
doc/html/index.html
