← Back to branch summary

~ubuntu-branches/ubuntu/quantal/simgrid/quantal

« back to all changes in this revision

Viewing changes to doc/html/group__msg__simulation.html

  • Committer: Package Import Robot
  • Author(s): Lucas Nussbaum, Martin Quinson, Lucas Nussbaum
  • Date: 2012-06-09 16:24:44 UTC
  • mfrom: (10.1.4 sid)
  • Revision ID: package-import@ubuntu.com-20120609162444-xook34f3d6qy5ixj
Tags: 3.7.1-1
[ Martin Quinson ]
* debian/copyright: update FSF address (thanks lintian for noticing)

[ Lucas Nussbaum ]
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/group__msg__simulation.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
5
<title>SimGrid: Main MSG simulation Functions</title>
7
 
 
8
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
 
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
 
 
11
 
 
12
 
 
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
13
8
<link href="simgrid.css" rel="stylesheet" type="text/css">
14
9
</head>
15
10
<body>
16
 
<div id="top"><!-- do not remove this div! -->
17
 
 
18
 
 
 
11
<!-- Generated by Doxygen 1.7.4 -->
 
12
<div id="top">
19
13
<div id="titlearea">
20
14
<table cellspacing="0" cellpadding="0">
21
15
 <tbody>
22
16
 <tr style="height: 56px;">
23
 
  
24
 
  
25
17
  <td style="padding-left: 0.5em;">
26
 
   <div id="projectname">SimGrid
27
 
   &#160;<span id="projectnumber">3.7</span>
28
 
   </div>
 
18
   <div id="projectname">SimGrid&#160;<span id="projectnumber">3.7.1</span></div>
29
19
   <div id="projectbrief">Scalable simulation of distributed systems</div>
30
20
  </td>
31
 
  
32
 
  
33
 
  
34
21
 </tr>
35
22
 </tbody>
36
23
</table>
37
24
</div>
38
 
 
39
 
<!-- Generated by Doxygen 1.7.6.1 -->
40
25
  <div id="navrow1" class="tabs">
41
26
    <ul class="tablist">
42
27
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
65
50
  <li> <a href="group__API__index.html"><span>Full Index</span></a></li>
66
51
  <li> <a href="group__XBT__API.html"><span>XBT</span></a></li>
67
52
  <li class="current"> <a href="group__MSG__API.html"><span>MSG</span></a></li>
 
53
  <li> <a href="group__SIMIX__API.html"><span>SIMIX</span></a></li>
68
54
  <li> <a href="group__GRAS__API.html"><span>GRAS</span></a></li>
69
55
  <li> <a href="group__AMOK__API.html"><span>AMOK</span></a></li>
70
56
  <li> <a href="group__SMPI__API.html"><span>SMPI</span></a></li>
96
82
<a href="#func-members">Functions</a>  </div>
97
83
  <div class="headertitle">
98
84
<div class="title">Main MSG simulation Functions</div>  </div>
99
 
<div class="ingroups"><a class="el" href="group__MSG__API.html">MSG</a></div></div><!--header-->
 
85
<div class="ingroups"><a class="el" href="group__MSG__API.html">MSG</a></div></div>
100
86
<div class="contents">
101
87
 
102
88
<p>Describes how to setup and control your simulation.  
194
180
<div class="memproto">
195
181
      <table class="memname">
196
182
        <tr>
197
 
          <td class="memname">void <a class="el" href="group__msg__simulation.html#ga012d470de7974da7262d0020e00117e9">MSG_launch_application</a> </td>
 
183
          <td class="memname">void MSG_launch_application </td>
198
184
          <td>(</td>
199
185
          <td class="paramtype">const char *&#160;</td>
200
186
          <td class="paramname"><em>file</em></td><td>)</td>
206
192
 
207
193
<p>An application deployer. </p>
208
194
<p>Creates the process described in <em>file</em>. </p>
209
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
195
<dl><dt><b>Parameters:</b></dt><dd>
210
196
  <table class="params">
211
197
    <tr><td class="paramname">file</td><td>a filename of a xml description of the application. This file follows this DTD :</td></tr>
212
198
  </table>
340
326
 
341
327
&lt;!ELEMENT process ((argument|prop)*)&gt;
342
328
&lt;!ATTLIST process host CDATA #REQUIRED&gt;
343
 
&lt;!ATTLIST process <span class="keyword">function</span> CDATA #REQUIRED&gt;
 
329
&lt;!ATTLIST process function CDATA #REQUIRED&gt;
344
330
&lt;!ATTLIST process start_time CDATA <span class="stringliteral">&quot;-1.0&quot;</span>&gt;
345
331
&lt;!ATTLIST process kill_time CDATA <span class="stringliteral">&quot;-1.0&quot;</span>&gt;
346
332
 
358
344
&lt;!DOCTYPE platform SYSTEM <span class="stringliteral">&quot;http://simgrid.gforge.inria.fr/simgrid.dtd&quot;</span>&gt;
359
345
&lt;platform version=<span class="stringliteral">&quot;3&quot;</span>&gt;
360
346
  &lt;!-- The master process (with some arguments) --&gt;
361
 
  &lt;process host=<span class="stringliteral">&quot;Tremblay&quot;</span> <span class="keyword">function</span>=<span class="stringliteral">&quot;master&quot;</span>&gt;
 
347
  &lt;process host=<span class="stringliteral">&quot;Tremblay&quot;</span> function=<span class="stringliteral">&quot;master&quot;</span>&gt;
362
348
     &lt;argument value=<span class="stringliteral">&quot;20&quot;</span>/&gt;       &lt;!-- Number of tasks --&gt;
363
349
     &lt;argument value=<span class="stringliteral">&quot;50000000&quot;</span>/&gt;  &lt;!-- Computation size of tasks --&gt;
364
350
     &lt;argument value=<span class="stringliteral">&quot;1000000&quot;</span>/&gt;   &lt;!-- Communication size of tasks --&gt;
369
355
     &lt;argument value=<span class="stringliteral">&quot;Tremblay&quot;</span>/&gt; &lt;!-- Me! I can work too! --&gt;
370
356
  &lt;/process&gt;
371
357
  &lt;!-- The slave process (with no argument) --&gt;
372
 
  &lt;process host=<span class="stringliteral">&quot;Tremblay&quot;</span> <span class="keyword">function</span>=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
373
 
  &lt;process host=<span class="stringliteral">&quot;Jupiter&quot;</span> <span class="keyword">function</span>=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
374
 
  &lt;process host=<span class="stringliteral">&quot;Fafard&quot;</span> <span class="keyword">function</span>=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
375
 
  &lt;process host=<span class="stringliteral">&quot;Ginette&quot;</span> <span class="keyword">function</span>=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
376
 
  &lt;process host=<span class="stringliteral">&quot;Bourassa&quot;</span> <span class="keyword">function</span>=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
 
358
  &lt;process host=<span class="stringliteral">&quot;Tremblay&quot;</span> function=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
 
359
  &lt;process host=<span class="stringliteral">&quot;Jupiter&quot;</span> function=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
 
360
  &lt;process host=<span class="stringliteral">&quot;Fafard&quot;</span> function=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
 
361
  &lt;process host=<span class="stringliteral">&quot;Ginette&quot;</span> function=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
 
362
  &lt;process host=<span class="stringliteral">&quot;Bourassa&quot;</span> function=<span class="stringliteral">&quot;slave&quot;</span>/&gt;
377
363
&lt;/platform&gt;
378
364
</pre></div><p>Have a look in the directory examples/msg/ to have a bigger example. </p>
379
365
 
384
370
<div class="memproto">
385
371
      <table class="memname">
386
372
        <tr>
387
 
          <td class="memname">void <a class="el" href="group__msg__simulation.html#ga21e94a4e7b26dea140b0c71a2a4f4352">MSG_function_register</a> </td>
 
373
          <td class="memname">void MSG_function_register </td>
388
374
          <td>(</td>
389
375
          <td class="paramtype">const char *&#160;</td>
390
376
          <td class="paramname"><em>name</em>, </td>
406
392
 
407
393
<p>Registers the main function of a process in a global table. </p>
408
394
<p>Registers a code function in a global table. This table is then used by <a class="el" href="group__msg__simulation.html#ga012d470de7974da7262d0020e00117e9" title="An application deployer.">MSG_launch_application</a>. </p>
409
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
395
<dl><dt><b>Parameters:</b></dt><dd>
410
396
  <table class="params">
411
397
    <tr><td class="paramname">name</td><td>the reference name of the function. </td></tr>
412
398
    <tr><td class="paramname">code</td><td>the function (must have the same prototype than the main function of any C program: int ..(int argc, char *argv[])) </td></tr>
421
407
<div class="memproto">
422
408
      <table class="memname">
423
409
        <tr>
424
 
          <td class="memname">void <a class="el" href="group__msg__simulation.html#ga698d00aec4b3d7f8cf90c4d1a4595c9c">MSG_function_register_default</a> </td>
 
410
          <td class="memname">void MSG_function_register_default </td>
425
411
          <td>(</td>
426
412
          <td class="paramtype">xbt_main_func_t&#160;</td>
427
413
          <td class="paramname"><em>code</em></td><td>)</td>
433
419
 
434
420
<p>Registers a function as the default main function of processes. </p>
435
421
<p>Registers a code function as being the default value. This function will get used by <a class="el" href="group__msg__simulation.html#ga012d470de7974da7262d0020e00117e9" title="An application deployer.">MSG_launch_application()</a> when there is no registered function of the requested name in. </p>
436
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
422
<dl><dt><b>Parameters:</b></dt><dd>
437
423
  <table class="params">
438
424
    <tr><td class="paramname">code</td><td>the function (must have the same prototype than the main function of any C program: int ..(int argc, char *argv[])) </td></tr>
439
425
  </table>
447
433
<div class="memproto">
448
434
      <table class="memname">
449
435
        <tr>
450
 
          <td class="memname">xbt_main_func_t <a class="el" href="group__msg__simulation.html#ga61b2e271c59ff50d38de7a0f9858b4b1">MSG_get_registered_function</a> </td>
 
436
          <td class="memname">xbt_main_func_t MSG_get_registered_function </td>
451
437
          <td>(</td>
452
438
          <td class="paramtype">const char *&#160;</td>
453
439
          <td class="paramname"><em>name</em></td><td>)</td>
459
445
 
460
446
<p>Retrieves a registered main function. </p>
461
447
<p>Registers a code function in a global table. This table is then used by <a class="el" href="group__msg__simulation.html#ga012d470de7974da7262d0020e00117e9" title="An application deployer.">MSG_launch_application</a>. </p>
462
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
448
<dl><dt><b>Parameters:</b></dt><dd>
463
449
  <table class="params">
464
450
    <tr><td class="paramname">name</td><td>the reference name of the function. </td></tr>
465
451
  </table>
473
459
<div class="memproto">
474
460
      <table class="memname">
475
461
        <tr>
476
 
          <td class="memname">void <a class="el" href="group__msg__simulation.html#gae08e089d52a2928680e0957e7152d79d">MSG_create_environment</a> </td>
 
462
          <td class="memname">void MSG_create_environment </td>
477
463
          <td>(</td>
478
464
          <td class="paramtype">const char *&#160;</td>
479
465
          <td class="paramname"><em>file</em></td><td>)</td>
485
471
 
486
472
<p>A platform constructor. </p>
487
473
<p>Creates a new platform, including hosts, links and the routing_table. </p>
488
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
474
<dl><dt><b>Parameters:</b></dt><dd>
489
475
  <table class="params">
490
476
    <tr><td class="paramname">file</td><td>a filename of a xml description of a platform. This file follows this DTD :</td></tr>
491
477
  </table>
619
605
 
620
606
&lt;!ELEMENT process ((argument|prop)*)&gt;
621
607
&lt;!ATTLIST process host CDATA #REQUIRED&gt;
622
 
&lt;!ATTLIST process <span class="keyword">function</span> CDATA #REQUIRED&gt;
 
608
&lt;!ATTLIST process function CDATA #REQUIRED&gt;
623
609
&lt;!ATTLIST process start_time CDATA <span class="stringliteral">&quot;-1.0&quot;</span>&gt;
624
610
&lt;!ATTLIST process kill_time CDATA <span class="stringliteral">&quot;-1.0&quot;</span>&gt;
625
611
 
703
689
<div class="memproto">
704
690
      <table class="memname">
705
691
        <tr>
706
 
          <td class="memname">int <a class="el" href="group__msg__simulation.html#ga0dedd7962cd7d916406ef45c471f6134">MSG_process_killall</a> </td>
 
692
          <td class="memname">int MSG_process_killall </td>
707
693
          <td>(</td>
708
694
          <td class="paramtype">int&#160;</td>
709
695
          <td class="paramname"><em>reset_PIDs</em></td><td>)</td>
714
700
<div class="memdoc">
715
701
 
716
702
<p>Kill all running process. </p>
717
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
703
<dl><dt><b>Parameters:</b></dt><dd>
718
704
  <table class="params">
719
705
    <tr><td class="paramname">reset_PIDs</td><td>should we reset the PID numbers. A negative number means no reset and a positive number will be used to set the PID of the next newly created process. </td></tr>
720
706
  </table>
723
709
 
724
710
</div>
725
711
</div>
726
 
</div><!-- contents -->
 
712
</div>
727
713
<p>
728
714
<hr>
729
715
 
734
720
Back to the main Simgrid Documentation page</b></a>
735
721
</td>
736
722
<td align=middle>
737
 
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.<br/>
 
723
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.1.<br/>
738
724
Documentation of other versions can be found in their respective
739
725
archive files (directory doc/html).
740
726
</td>