Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
b5578985814f46930250632414427ace43f83b14
[simgrid.git] / doc / doxygen / install.doc
1 /*! 
2 @page install Installing Simgrid
3
4 @tableofcontents
5
6 The easiest way to install SimGrid is to go for a binary package.
7 Under Debian or Ubuntu, this is very easy as SimGrid is directly
8 integrated to the official repositories. Under Windows, SimGrid can be
9 installed in a few clicks once you downloaded the installer from
10 gforge. If you just want to use Java, simply copy the jar file on your
11 disk and you're set. 
12
13 Recompiling an official archive is not much more complex, actually.
14 SimGrid has very few dependencies and rely only on very standard
15 tools.  First, download the *@SimGridRelease.tar.gz* archive
16 from [the download page](https://gforge.inria.fr/frs/?group_id=12).
17 Then, recompiling the archive should be done in a few lines:
18
19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
20 tar xf @SimGridRelease.tar.gz
21 cd @SimGridRelease
22 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
23 make
24 make install
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
27 If you want to stay on the bleeding edge, you should get the latest
28 git version, and recompile it as you would do for an official archive.
29 Depending on the files you change in the source tree, some extra
30 tools may be needed.
31
32 @section install_binary Installing a binary package 
33
34 @subsection install_binary_linux Binary packages for linux
35
36 Most of the developers use a Debian or Ubuntu system, and some of us
37 happen to be Debian Maintainers, so the packages for these systems are
38 well integrated with these systems and very uptodate. To install them,
39 simply type:
40
41 @verbatim
42 apt-get install simgrid
43 @endverbatim
44
45 On other Linux variants, you probably want to go for a source install.
46 Please contact us if you want to contribute the build scripts for your
47 prefered distribution.
48
49 @subsection install_binary_win Installation wizard for Windows
50
51 Before starting the installation, make sure that you have the following dependencies:
52   @li cmake 2.8 <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
53   @li MinGW <a href="http://sourceforge.net/projects/mingw/files/MinGW/">(download page)</a>
54   @li perl <a href="http://www.activestate.com/activeperl/downloads">(download page)</a>
55   @li git <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">(download page)</a>
56
57 Then download the package <a href="https://gforge.inria.fr/frs/?group_id=12">SimGrid Installer</a>,
58 execute it and follow instructions.
59
60 @image html win_install_01.png Step 1: Accept the license.
61 @image html win_install_02.png Step 2: Select packets to install.
62 @image html win_install_03.png Step 3: Choice where to install packets previously selected. Please don't use spaces in path.
63 @image html win_install_04.png Step 4: Add CLASSPATH to environment variables.
64 @image html win_install_05.png Step 5: Add PATH to environment variables.
65 @image html win_install_06.png Step 6: Restart your computer to take in consideration environment variables.
66
67 @subsection install_binary_java Using the binary jar file
68
69 The easiest way to install the Java bindings of SimGrid is to grab the
70 jar file from the 
71 <a href="https://gforge.inria.fr/frs/?group_id=12">Download page</a>,
72 and copy it in your classpath (typically, in the same directory than
73 your source code). If you go for that version, there is no need to
74 install the C library as it is bundled within the jar file. Actually,
75 only a bunch of architectures are supported this way to keep the
76 jarfile size under control and because we don't have access to every
77 exotic architectures ourselves. 
78
79 If the jarfile fails on you, complaining that your architecture is not
80 supported, drop us an email: we may extend the jarfile for you, if we
81 have access to your architecture to build SimGrid on it.
82
83 @section install_src Installing from source
84
85 @subsection install_src_deps Resolving the dependencies
86
87 SimGrid only uses very standard tools: 
88   @li C compiler, C++ compiler, make and friends.
89   @li perl (but you may try to go without it)
90   @li We use cmake to configure our compilation 
91       (<a href="http://www.cmake.org/cmake/resources/software.html">download page</a>).
92       You need cmake version 2.8 or higher. You may want to use ccmake
93       for a graphical interface over cmake. 
94
95 On MacOSX, it is advised to use the clang compiler (version 3.0 or
96 higher), from either MacPort or XCode. If you insist on using gcc on
97 this system, you still need a recent version of this compiler, so you
98 need an unofficial gcc47 from MacPort because the version provided by
99 Apple is ways to ancient to suffice. See also @ref install_cmake_mac.
100
101 On Windows, it is strongly advised to use the 
102 <a href="http://sourceforge.net/projects/mingw/files/MinGW/">MinGW
103 environment</a> to build SimGrid. Any other compilers are not tests
104 (and thus probably broken). We usually use the 
105 <a href="http://www.activestate.com/activeperl/downloads">activestate</a>
106 version of Perl, and the 
107 <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">msys</a>
108 version of git on this architecture, but YMMV. See also @ref install_cmake_win.
109
110 @subsection install_src_fetch Retrieving the source
111
112 If you just want to use SimGrid, you should probably grab the latest
113 stable version available from the 
114 <a href="https://gforge.inria.fr/frs/?group_id=12">download page</a>.
115 We do our best to release soon and release often, but sometimes you
116 need to install the developer version of SimGrid, directly from the
117 git repository. Avoid the git version if you are not sure, as it may
118 break on you, or even worse.
119
120 @verbatim
121 git clone git://scm.gforge.inria.fr/simgrid/simgrid.git simgrid
122 @endverbatim
123
124 @subsection install_src_config Configuring the build
125
126 Note that compile-time options are very different from @ref options
127 "run-time options".
128
129 \subsubsection install_cmake_howto Setting compilation options
130
131 The default configuration should be ok for most usages, but if you
132 need to change something, there is several ways to do so. First, you
133 can use environment variables. For example, you can change the used
134 compilers by issuing these commands before launching cmake:
135
136 @verbatim
137 export CC=gcc-4.4 
138 export CXX=g++-4.4
139 @endverbatim
140
141 Note that other variables are available, such as CFLAGS and CXXFLAGS to add
142 options for respectively the C compiler and the C++ compiler.
143
144 Another way to do so is to use the -D argument of cmake as follows.
145 Note that the terminating dot is mandatory (see @ref
146 install_cmake_outsrc to understand its meaning).
147
148 @verbatim
149 cmake -DCC=clang -DCXX=clang++ .
150 @endverbatim
151
152 Finally, you can use a graphical interface such as ccmake to change
153 these settings. Simply follow the instructions after starting the
154 interface.
155
156 @verbatim
157 ccmake .
158 @endverbatim
159
160 \subsubsection install_cmake_list SimGrid compilation options
161
162 In addition to the classical cmake configuration variables, SimGrid
163 accepts several options, as listed below.
164
165   @li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid 
166       (e.g. /usr/local or /opt).
167
168   @li <b>enable_compile_optimizations</b> (ON/OFF): request the
169       compiler to produce efficient code. You want to activate it,
170       unless you want to debug SimGrid itself (as efficient code may
171       be appear mangled to the debugers).
172
173   @li <b>enable_debug</b> (ON/OFF): disable this if simulation speed
174       really matters to you. All log messages of gravity debug or
175       below will be discarded at compilation time. Since there is
176       quite a bunch of such log messages in SimGrid itself, this can
177       reveal faster than discarding them at runtime as usually. But of
178       course, it is then impossible to get any debug message from
179       SimGrid if something goes wrong.
180
181   @li <b>enable_msg_deprecated</b> (ON/OFF): enable this option if
182       your code used a feature of Simgrid that was droped or modified
183       in recent releases of SimGrid. You should update your code if
184       possible, but with this option, SimGrid will try to emulate its
185       old behavior.
186
187   @li <b>enable_model-checking</b> (ON/OFF): Only enable this if you
188       actually plan to use the model-checking aspect of SimGrid. This
189       mode of execution is still under heavy work, but it should be
190       rather usable now. Be <b>warned</b> that this option will hinder
191       your simulation speed even if you simulate without activating
192       the model-checker. We are working on improving this situation.
193
194   @li <b>enable_compile_warnings</b> (ON/OFF): request the compiler to
195       issue error message whenever the source code is not perfectly
196       clean. If you develop SimGrid itself, you must activate it to
197       ensure the code quality, but as a user, that option will only
198       bring you issues.
199       
200   @li <b>enable_lib_static</b> (ON/OFF): enable this if you want to
201       compile the static library (but you should consider enjoying
202       this new century instead).
203       
204   @li <b>enable_maintainer_mode</b> (ON/OFF): you only need to set
205       this option if you modify very specific parts of SimGrid itself
206       (the XML parsers and other related elements). Adds an extra
207       dependency on flex and flexml.
208      
209   @li <b>enable_tracing</b> (ON/OFF): disable this if you have issues
210       with the tracing module. But this module is now very stable and
211       you really should try to enjoy this beauty.
212
213   @li <b>enable_smpi</b> (ON/OFF): disable this if you have issues
214       with the module allowing to run MPI code on top of SimGrid. This
215       module very stable, but if you really don't need it, you can
216       disable it.
217       
218   @li <b>enable_mallocators</b> (ON/OFF): disable this when tracking
219       memory issues within SimGrid, or the caching mechanism used
220       internally will fool the debugers.
221
222   @li <b>enable_jedule</b> (ON/OFF): enable this to get SimDag
223       producing traces that can then be vizualized with the Jedule
224       external tool.
225
226   @li <b>enable_lua</b> (ON/OFF): enable this if you want to enjoy the
227       lua bindings of SimGrid. Adds an extra dependency on lua library
228       and developper header files.
229
230
231   @li <b>enable_gtnets</b> (ON/OFF): whether you want to use gtnets.
232       See section @ref pls_simgrid_configuration_gtnets.
233   @li <b>gtnets_path</b> (path): GTNetS installation directory 
234       (eg /usr or /opt).
235   @li <b>enable_ns3</b> (ON/OFF): whether you want to use ns3.
236       See section @ref pls_simgrid_configuration_ns3.
237   @li <b>ns3_path</b> (path): NS3 installation directory (eg /usr or /opt).
238   @li <b>enable_latency_bound_tracking</b> (ON/OFF): enable it if you
239       want to be warned when communications are limited by round trip
240       time while doing packet-level simulation. 
241
242 \subsubsection install_cmake_reset Resetting the compilation configuration
243
244 If you need to empty the cache of values saved by cmake (either
245 because you added a new library or because something seriously went
246 wrong), you can simply delete the file CMakeCache.txt that is created
247 at the root of the source tree. You may also want to edit this file
248 directly in some circumstances.
249
250 \subsubsection install_cmake_outsrc Compiling into a separate directory
251
252 By default, the files produced during the compilation are placed in
253 the source directory. As the compilation generates a lot of files, it
254 is advised to to put them all in a separate directory. It is then
255 easier to cleanup, and this allows to compile several configurations
256 out of the same source tree. For that, simply enter the directory
257 where you want the produced files to land, and invoke cmake (or
258 ccmake) with the full path to the simgrid source as last argument.
259 This approach is called "compilation out of source tree".
260
261 @verbatim
262 mkdir build
263 cd build
264 cmake [options] ..
265 make
266 @endverbatim
267
268 \subsubsection install_cmake_win Cmake on Windows (with MinGW)
269
270 Cmake can produce several kind of of makefiles. Under Windows, it has
271 no way of determining what kind you want to use, so you have to hint it:
272
273 @verbatim
274 cmake -G"MinGW Makefiles" (other options) .
275 mingw32-make
276 @endverbatim
277
278 \subsubsection install_cmake_mac Cmake on Mac OSX
279
280 SimGrid compiles like a charm with clang on Mac OSX:
281
282 @verbatim
283 cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
284 make
285 @endverbatim
286
287 With the XCode version of clang 4.1, you may get the following error message:
288 @verbatim
289 CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
290 @endverbatim
291
292 In that case, edit the CMakeCache.txt file directly, so that the
293 CMAKE_OSX_SYSROOT is similar to the following. Don't worry about the
294 warning that the "-pthread" argument is not used, if it appears.
295 @verbatim
296 CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer
297 @endverbatim
298
299 \subsection install_src_compil Compiling SimGrid
300
301 In most cases, compiling and installing simgrid is enough:
302
303 @verbatim
304 make
305 make install # try "sudo make install" if you don't have the permission to write
306 @endverbatim
307
308 In addition, several compilation targets are provided in SimGrid. If
309 your system is well configured, the full list of targets is available
310 for completion when using the Tab key. Note that some of the existing
311 targets are not really for publc consumption so don't worry if some
312 stuff don't work for you.
313
314 @verbatim
315 make simgrid                    Builds only the simgrid library and not any example
316 make masterslave                Builds only this example (and its dependencies)
317 make clean                      Clean the results of a previous compilation
318 make install                    Install the project (doc/ bin/ lib/ include/)
319 make uninstall                  Uninstall the project (doc/ bin/ lib/ include/)
320 make dist                       Cuild a distribution archive (tgz)
321 make distcheck                  Check the dist (make + make dist + tests on the distribution)
322 make simgrid_documentation      Create simgrid documentation
323 @endverbatim
324
325 If you want to see what is really happening, try adding VERBOSE=1 to
326 your compilation requests:
327
328 @verbatim
329 make VERBOSE=1  
330 @endverbatim
331
332 @subsection install_src_test Testing SimGrid 
333
334 Once everything is built, you may want to test the result. SimGrid
335 comes with an extensive set of regression tests (see @ref
336 inside_cmake_addtest "that page of the insider manual" for more
337 details). Running the tests is done using the ctest binary that comes
338 with cmake. These tests are run every night and the result is publicly
339 <a href="http://cdash.inria.fr/CDash/index.php?project=Simgrid">available</a>.
340
341 \verbatim
342 ctest                     # Launch all tests
343 ctest -D Experimental     # Launch all tests and report the result to
344                           # http://cdash.inria.fr/CDash/index.php?project=SimGrid
345 ctest -R msg              # Launch only the tests which name match the string "msg"
346 ctest -j4                 # Launch all tests in parallel, at most 4 at the same time
347 ctest --verbose           # Display all details on what's going on
348 ctest --output-on-failure # Only get verbose for the tests that fail
349
350 ctest -R msg- -j5 --output-on-failure # You changed MSG and want to check that you didn't break anything, huh?
351                                       # That's fine, I do so all the time myself.
352 \endverbatim
353
354 \section install_setting_own Setting up your own code
355
356 \subsection install_setting_MSG MSG code on Unix (Linux or Mac OSX)
357
358 Do not build your simulator by modifying the SimGrid examples.  Go
359 outside the SimGrid source tree and create your own working directory
360 (say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
361
362 Suppose your simulation has the following structure (remember it is
363 just an example to illustrate a possible way to compile everything;
364 feel free to organize it as you want).
365
366 \li <tt>sched.h</tt>: a description of the core of the
367     scheduler (i.e. which functions are can be used by the
368     agents). For example we could find the following functions
369     (master, forwarder, slave).
370 \li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
371     implementing the core of the scheduler. Most of these
372     functions use the MSG functions defined in section \ref
373     msg_task_usage.
374 \li <tt>masterslave.c</tt>: a C file with the main function, i.e.
375     the MSG initialization (MSG_init()), the platform
376     creation (e.g. with MSG_create_environment()), the
377     deployment phase (e.g. with MSG_function_register() and
378     MSG_launch_application()) and the call to MSG_main()).
379
380 To compile such a program, we suggest to use the following
381 Makefile. It is a generic Makefile that we have used many times with
382 our students when we teach the C language.
383
384 \verbatim
385 all: masterslave
386 masterslave: masterslave.o sched.o
387
388 INSTALL_PATH = $$HOME
389 CC = gcc
390 PEDANTIC_PARANOID_FREAK =       -O0 -Wshadow -Wcast-align \
391                                 -Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
392                                 -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
393                                 -Wmissing-noreturn -Wredundant-decls -Wnested-externs \
394                                 -Wpointer-arith -Wwrite-strings -finline-functions
395 REASONABLY_CAREFUL_DUDE =       -Wall
396 NO_PRAYER_FOR_THE_WICKED =      -w -O2
397 WARNINGS =                      $(REASONABLY_CAREFUL_DUDE)
398 CFLAGS = -g $(WARNINGS)
399
400 INCLUDES = -I$(INSTALL_PATH)/include
401 DEFS = -L$(INSTALL_PATH)/lib/
402 LDADD = -lm -lsimgrid
403 LIBS =
404
405 %: %.o
406         $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@
407
408 %.o: %.c
409         $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
410
411 clean:
412         rm -f $(BIN_FILES) *.o *~
413 .SUFFIXES:
414 .PHONY: clean
415
416 \endverbatim
417
418 The first two lines indicates what should be build when typing make
419 (<tt>masterslave</tt>) and of which files it is to be made of
420 (<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
421 that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
422 (look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
423 the static version, remove the <tt>-lsimgrid</tt> and add a
424 <tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
425 after the <tt>LIBS = </tt>.
426
427 More generally, if you have never written a Makefile by yourself, type
428 in a terminal: <tt>info make</tt> and read the introduction. The
429 previous example should be enough for a first try but you may want to
430 perform some more complex compilations...
431
432
433 \subsection install_setting_win_provided Compile the "HelloWorld" project on Windows
434
435 In the SimGrid install directory you should have an HelloWorld project to explain you how to start
436 compiling a source file. There are:
437 \verbatim
438 - HelloWorld.c          The example source file.
439 - CMakeLists.txt        It allows to configure the project.
440 - README                This explaination.
441 \endverbatim
442
443 Now let's compile this example:
444 \li Run windows shell "cmd".
445 \li Open HelloWorld Directory ('cd' command line).
446 \li Create a build directory and change directory. (optional)
447 \li Type 'cmake -G"MinGW Makefiles" \<path_to_HelloWorld_project\>'
448 \li Run mingw32-make
449 \li You should obtain a runnable example ("HelloWorld.exe").
450
451 For compiling your own code you can simply copy the HelloWorld project and rename source name. It will
452 create a target with the same name of the source.
453
454
455 \subsection install_setting_win_new Adding and Compiling a new example on Windows
456
457 \li Put your source file into the helloWord directory.
458 \li Edit CMakeLists.txt by removing the Find Targets section and add those two lines into this section
459 \verbatim
460 ################
461 # FIND TARGETS #
462 ################
463 #It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES'
464 add_executable(TARGET_NAME SOURCES)
465 #Links TARGET_NAME with simgrid
466 target_link_libraries(TARGET_NAME simgrid)
467 \endverbatim
468 \li To initialize and build your project, you'll need to run
469 \verbatim
470 cmake -G"MinGW Makefiles" <path_to_HelloWorld_project>
471 \endverbatim
472 \li Run "mingw32-make"
473 \li You should obtain "TARGET_NAME.exe".
474
475 \subsection install_Win_ruby Setup a virtualbox to use SimGrid-Ruby on windows
476
477 Allan Espinosa made these set of Vagrant rules available so that you
478 can use the SimGrid Ruby bindings in a virtual machine using
479 VirtualBox. Thanks to him for that. You can find his project here:
480 https://github.com/aespinosa/simgrid-vagrant
481
482
483
484 */