Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fbe6b0e73b84782ec9feaba2c9711c601a4a3ecc
[simgrid.git] / doc / gtnets.doc
1 /*! \page gtnets SimGrid and GTNets
2
3 \section gtnets_simgrid_configuration_gtnets Using GTNetS
4
5 It is possible to use a packet-level network simulator
6 instead of the default flow-based simulation. You may want to use such
7 an approach if you have doubts about the validity of the default model
8 or if you want to perform some validation experiments. At the moment,
9 we support the GTNetS simulator (it is still rather experimental
10 though, so leave us a message if you play with it). 
11
12 <i>
13 To enable GTNetS model inside SimGrid it is needed to patch the GTNetS simulator source code 
14 and build/install it from scratch
15 </i>
16
17  - <b>Download and enter the recent downloaded GTNetS directory</b>
18
19  \verbatim
20  svn checkout svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/GTNetS/
21  cd GTNetS
22  \endverbatim
23
24
25  - <b>Use the following commands to unzip and patch GTNetS package to work within SimGrid.</b>
26
27  \verbatim
28  unzip gtnets-current.zip
29  tar zxvf gtnets-current-patch.tgz 
30  cd gtnets-current
31  cat ../00*.patch | patch -p1
32  \endverbatim
33
34   - <b>OPTIONALLY</b> you can use a patch for itanium 64bit processor family.
35
36   \verbatim
37   cat ../AMD64-FATAL-Removed-DUL_SIZE_DIFF-Added-fPIC-compillin.patch | patch -p1
38   \endverbatim
39
40  - <b>Compile GTNetS</b>
41
42    Due to portability issues it is possible that GTNetS does not compile in your architecture. The patches furnished in SimGrid SVN repository are intended for use in Linux architecture only. Unfortunately, we do not have the time, the money, neither the manpower to guarantee GTNetS portability. We advice you to use one of GTNetS communication channel to get more help in compiling GTNetS. 
43
44
45  \verbatim
46  ln -sf Makefile.linux Makefile
47  make depend
48  make debug
49  \endverbatim
50
51
52  - <b>NOTE</b> A lot of warnings are expected but the application should compile
53  just fine. If the makefile insists in compiling some QT libraries
54  please try a make clean before asking for help.
55
56
57  - <b>To compile optimized version</b>
58
59  \verbatim
60  make opt
61  \endverbatim
62
63
64  - <b>Installing GTNetS</b>
65
66  It is important to put the full path of your libgtsim-xxxx.so file when creating the symbolic link. Replace < userhome > by some path you have write access to.
67
68  \verbatim
69  ln -sf /<absolute_path>/gtnets_current/libgtsim-debug.so /<userhome>/usr/lib/libgtnets.so
70  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/<userhome>/usr/lib/libgtnets.so
71  mkdir /<userhome>/usr/include/gtnets
72  cp -fr SRC/*.h /<userhome>/usr/include/gtnets
73  \endverbatim
74
75
76  - <b>Enable GTNetS support in SimGrid</b>
77  
78 In order to enable gtnets with simgrid you have to give where is gtnets. (path to \<gtnets_path\>/lib and \<gtnets_path\>/include)
79
80    \verbatim
81    Since v3.4 (with cmake)
82    cmake . -Dgtnets_path=/<userhome>/usr
83    
84    Until v3.4 (with autotools)
85    ./configure --with-gtnets=/<userhome>/usr
86    \endverbatim
87
88  - <b>Once you have followed all the instructions for compiling and
89    installing successfully you can activate this feature at 
90    runntime with the following options:</b>
91
92    \verbatim
93    Since v3.4 (with cmake)
94    cd simgrid
95    make
96    ctest -R gtnets
97    
98    Until v3.4 (with autotools)
99    cd simgrid/example/msg/
100    make
101    make check
102    \endverbatim
103
104
105  - <b>Or try the GTNetS model dogbone example with</b>
106
107  \verbatim
108  gtnets/gtnets gtnets/onelink-p.xml gtnets/onelink-d.xml --cfg=network_model:GTNets
109  \endverbatim
110
111  
112  A long version of this <a href="http://gforge.inria.fr/docman/view.php/12/6283/GTNetS HowTo.html">HowTo</a>  it is available 
113
114
115  More about GTNetS simulator at <a href="http://www.ece.gatech.edu/research/labs/MANIACS/GTNetS/index.html">GTNetS Website</a>
116
117
118  - <b>DISCLAIMER</b>
119  The patches provided by us worked successfully with GTNetS found 
120  <a href="http://www.ece.gatech.edu/research/labs/MANIACS/GTNetS/software/gtnets-current.zip">here</a>, 
121  dated from 12th June 2008. Due to the discontinuing development of
122  GTNetS it is impossible to precise a version number. We STRONGLY recommend you
123  to download and install the GTNetS version found in SimGrid repository as explained above.
124  
125 */