/usr/share/doc/simgrid/html/classAsClusterFatTree.html is in simgrid-doc 3.11.1-10ubuntu1.
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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | <!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: AsClusterFatTree Class Reference</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11</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.9.1 -->
<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('classAsClusterFatTree.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)">
</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="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">AsClusterFatTree Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Fat tree representation and routing.
<a href="classAsClusterFatTree.html#details">More...</a></p>
<p><code>#include <surf_routing_cluster_fat_tree.hpp></code></p>
<p>Inherits AsCluster.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aec47a71bc731179fc765b782d1b28aad"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsClusterFatTree.html#aec47a71bc731179fc765b782d1b28aad">getRouteAndLatency</a> (<a class="el" href="structRoutingEdge.html">RoutingEdgePtr</a> src, <a class="el" href="structRoutingEdge.html">RoutingEdgePtr</a> dst, sg_platf_route_cbarg_t into, double *latency)</td></tr>
<tr class="memdesc:aec47a71bc731179fc765b782d1b28aad"><td class="mdescLeft"> </td><td class="mdescRight">Get the route and latency between two RoutingEdgs. <a href="#aec47a71bc731179fc765b782d1b28aad">More...</a><br /></td></tr>
<tr class="separator:aec47a71bc731179fc765b782d1b28aad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adac347db34fd966ee66627e91cf7bdee"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsClusterFatTree.html#adac347db34fd966ee66627e91cf7bdee">create_links</a> ()</td></tr>
<tr class="memdesc:adac347db34fd966ee66627e91cf7bdee"><td class="mdescLeft"> </td><td class="mdescRight">Generate the fat tree. <a href="#adac347db34fd966ee66627e91cf7bdee">More...</a><br /></td></tr>
<tr class="separator:adac347db34fd966ee66627e91cf7bdee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a431850eb2b72de6a935a430233aa3016"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsClusterFatTree.html#a431850eb2b72de6a935a430233aa3016">parse_specific_arguments</a> (sg_platf_cluster_cbarg_t cluster)</td></tr>
<tr class="memdesc:a431850eb2b72de6a935a430233aa3016"><td class="mdescLeft"> </td><td class="mdescRight">Read the parameters in topo_parameters field. <a href="#a431850eb2b72de6a935a430233aa3016">More...</a><br /></td></tr>
<tr class="separator:a431850eb2b72de6a935a430233aa3016"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad06f5353991187aab0898c8b8c3e462d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad06f5353991187aab0898c8b8c3e462d"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsClusterFatTree.html#ad06f5353991187aab0898c8b8c3e462d">addProcessingNode</a> (int id)</td></tr>
<tr class="memdesc:ad06f5353991187aab0898c8b8c3e462d"><td class="mdescLeft"> </td><td class="mdescRight">Add a processing node. <br /></td></tr>
<tr class="separator:ad06f5353991187aab0898c8b8c3e462d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Fat tree representation and routing. </p>
<p>Generate fat trees according to the topology asked for. Almost everything is based on the work of Eitan Zahavi in "D-Mod-K Routing Providing
Non-Blocking Traffic for Shift Permutations on Real Life Fat Trees" (2010).</p>
<p>The exact topology is described in the mandatory topo_parameters field, and follow the "h ; m_h, ..., m_1 ; w_h, ..., w_1 ; p_h, ..., p_1" format. h stands for the switches levels number, i.e. the fat tree is of height h, without the processing nodes. m_i stands for the number of lower level nodes connected to a node in level i. w_i stands for the number of upper levels nodes connected to a node in level i-1. p_i stands for the number of parallel links connecting two nodes between level i and i - 1. Level h is the topmost switch level, level 1 is the lowest switch level, and level 0 represents the processing nodes. The number of provided nodes must be exactly the number of processing nodes required to fit the topology, which is the product of the m_i's.</p>
<p>Routing is made using a destination-mod-k scheme. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aec47a71bc731179fc765b782d1b28aad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AsClusterFatTree::getRouteAndLatency </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRoutingEdge.html">RoutingEdgePtr</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structRoutingEdge.html">RoutingEdgePtr</a> </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">sg_platf_route_cbarg_t </td>
<td class="paramname"><em>into</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"><em>latency</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the route and latency between two RoutingEdgs. </p>
<p>[long description]</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>[description] </td></tr>
<tr><td class="paramname">dst</td><td>[description] </td></tr>
<tr><td class="paramname">into</td><td>[description] </td></tr>
<tr><td class="paramname">latency</td><td>[description] </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="structAs.html#a95edeabb4e1a56be6ba4d9b63bd20e89">As</a>.</p>
</div>
</div>
<a class="anchor" id="adac347db34fd966ee66627e91cf7bdee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AsClusterFatTree::create_links </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate the fat tree. </p>
<p>Once all processing nodes have been added, this will make sure the fat tree is generated by calling generateLabels(), generateSwitches() and then connection all nodes between them, using their label. </p>
</div>
</div>
<a class="anchor" id="a431850eb2b72de6a935a430233aa3016"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AsClusterFatTree::parse_specific_arguments </td>
<td>(</td>
<td class="paramtype">sg_platf_cluster_cbarg_t </td>
<td class="paramname"><em>cluster</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the parameters in topo_parameters field. </p>
<p>It will also store the cluster for future use. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/surf/surf_routing_cluster_fat_tree.hpp</li>
<li>src/surf/<a class="el" href="surf__routing__cluster__fat__tree_8cpp.html">surf_routing_cluster_fat_tree.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classAsClusterFatTree.html">AsClusterFatTree</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
|