/usr/share/doc/simgrid/html/internals.html is in simgrid-doc 3.10-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SimGrid: SimGrid internals</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SimGrid
 <span id="projectnumber">3.10</span>
</div>
<div id="projectbrief">Versatile Simulation of Distributed Systems</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="http://simgrid.gforge.inria.fr/"><span>Home page</span></a></li>
<li><a href="http://simgrid.gforge.inria.fr/documentation.html"><span>Online documentation</span></a></li>
<li><a href="https://gforge.inria.fr/projects/simgrid"><span>Dev's Corner</span></a></li>
<li> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('internals.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">SimGrid internals </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This page does not exist yet, sorry. We are currently refurbishing the user documentation – the internal documentation will follow (FIXME).</p>
<p>There is two main things you want to know about the internals of SimGrid. First, you need to understand the component organization, as SimGrid is heavily layered, with each level being rather highly specialized and optimized toward a task. For that, please keep reading this page. If you work actively on the SimGrid project, the second point you need to understand is about the infrastructure of the SimGrid project, ie how to extend the framework in any way, how the automatic tests are run, and so on. These informations are split on several pages, as follows:</p>
<ul>
<li><a class="el" href="inside_doxygen.html">Documenting SimGrid</a></li>
<li><a class="el" href="inside_extending.html">Extending SimGrid</a></li>
<li><a class="el" href="inside_cmake.html">Modifying the cmake files</a></li>
<li><a class="el" href="inside_release.html">SimGrid Developer Guide - Releasing</a></li>
<li><a class="el" href="inside_autotests.html">Automatic Testing Infrastructure</a></li>
</ul>
<center>
<IMG style=border:0px SRC="simgrid_modules.png" USEMAP="#simgrid_modules">
<MAP NAME="simgrid_modules">
<AREA COORDS="536,64,574,281" href="group__TRACE__API.html" ALT="TRACE">
<AREA COORDS="294,7,496,42" href="/contrib.html" ALT="Contrib">
<AREA COORDS="10,70,171,152" href="group__MSG__API.html" ALT="MSG">
<AREA COORDS="10,161,517,221" href="group__SURF__API.html" ALT="SMPI">
<AREA COORDS="354,70,517,152" href="group__SD__API.html" ALT="SimDag">
<AREA COORDS="180,70,344,152" href="group__SMPI__API.html" ALT="SMPI">
<AREA SHAPE="poly" COORDS="1,64,1,281,527,281,527,64" href="group__XBT__API.html" ALT="XBT">
</MAP>
<br><b>SimGrid Components (click to jump to API)</b>
</center>
<h1><a class="anchor" id="ug_overview"></a>
Overview of the toolkit components</h1>
<h2><a class="anchor" id="ug_overview_envs"></a>
Programmation environments layer</h2>
<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>
<ul>
<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>
</ul>
<ul>
<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>
</ul>
<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>
<h2><a class="anchor" id="ug_overview_kernel"></a>
Simulation kernel layer</h2>
<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>
<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>
<p>See the <a class="el" href="group__SURF__API.html">SURF</a> section for more details.</p>
<h2><a class="anchor" id="ug_overview_fondation"></a>
Base layer</h2>
<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>
<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>
<p>See the <a class="el" href="group__XBT__API.html">XBT</a> section for more details.</p>
<h2><a class="anchor" id="ug_lucas_layer"></a>
Tracing simulation</h2>
<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>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sun Nov 17 2013 21:34:47 for SimGrid by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
</ul>
</div>
</body>
</html>
|