2
@page install Installing Simgrid
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
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. Recompiling the archive should be done in a few lines:
18
wget https://gforge.inria.fr/frs/download.php/28674/SimGrid-3.9.tar.gz
19
tar xf SimGrid-3.9.tar.gz
21
cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
26
If you want to stay on the blending edge, you should get the latest
27
git version, and recompile it as you would do for an official archive.
28
Depending on the files you change in the source tree, some extra
31
@section install_binary Installing a binary package
33
@subsection install_binary_linux Binary packages for linux
35
Most of the developers use a Debian or Ubuntu system, and some of us
36
happen to be Debian Maintainers, so the packages for these systems are
37
well integrated with these systems and very uptodate. To install them,
41
apt-get install simgrid
44
On other Linux variants, you probably want to go for a source install.
45
Please contact us if you want to contribute the build scripts for your
46
prefered distribution.
48
@subsection install_binary_win Installation wizard for Windows
50
Before starting the installation, make sure that you have the following dependencies:
51
@li cmake 2.8 <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
52
@li MinGW <a href="http://sourceforge.net/projects/mingw/files/MinGW/">(download page)</a>
53
@li perl <a href="http://www.activestate.com/activeperl/downloads">(download page)</a>
54
@li git <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">(download page)</a>
56
Then download the package <a href="https://gforge.inria.fr/frs/?group_id=12">SimGrid Installer</a>,
57
execute it and follow instructions.
59
@image html win_install_01.png Step 1: Accept the license.
60
@image html win_install_02.png Step 2: Select packets to install.
61
@image html win_install_03.png Step 3: Choice where to install packets previously selected. Please don't use spaces in path.
62
@image html win_install_04.png Step 4: Add CLASSPATH to environment variables.
63
@image html win_install_05.png Step 5: Add PATH to environment variables.
64
@image html win_install_06.png Step 6: Restart your computer to take in consideration environment variables.
66
@subsection install_binary_java Using the binary jar file
68
The easiest way to install the Java bindings of SimGrid is to grab the
70
<a href="https://gforge.inria.fr/frs/?group_id=12">Download page</a>,
71
and copy it in your classpath (typically, in the same directory than
72
your source code). If you go for that version, there is no need to
73
install the C library as it is bundled within the jar file. Actually,
74
only a bunch of architectures are supported this way to keep the
75
jarfile size under control and because we don't have access to every
76
exotic architectures ourselves.
78
If the jarfile fails on you, complaining that your architecture is not
79
supported, drop us an email: we may extend the jarfile for you, if we
80
have access to your architecture to build SimGrid on it.
82
@section install_src Installing from source
84
@subsection install_src_deps Resolving the dependencies
86
SimGrid only uses very standard tools:
87
@li C compiler, C++ compiler, make and friends.
88
@li perl (but you may try to go without it) and libpcre (but we are
89
working on removing this dependency)
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.
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.
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.
110
@subsection install_src_fetch Retrieving the source
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.
121
git clone git://scm.gforge.inria.fr/simgrid/simgrid.git simgrid
124
@subsection install_src_config Configuring the build
126
Note that compile-time options are very different from @ref options
129
\subsubsection install_cmake_howto Setting compilation options
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 variable. For example, you can change the used
134
compilers by issuing these commands before launching cmake:
141
Another way to do so is to use the -D argument of cmake as follows.
142
Note that the terminating dot is mandatory (see @ref
143
install_cmake_outsrc to understand its meaning).
146
cmake -DCC=clang -DCXX=clang++ .
149
Finally, you can use a graphical interface such as ccmake to change
150
these settings. Simply follow the instructions after starting the
157
\subsubsection install_cmake_list SimGrid compilation options
159
In addition to the classical cmake configuration variables, SimGrid
160
accepts several options, as listed below.
162
@li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid
163
(e.g. /usr/local or /opt).
165
@li <b>enable_compile_optimizations</b> (ON/OFF): request the
166
compiler to produce efficient code. You want to activate it,
167
unless you want to debug SimGrid itself (as efficient code may
168
be appear mangled to the debugers).
170
@li <b>enable_debug</b> (ON/OFF): disable this if simulation speed
171
really matters to you. All log messages of gravity debug or
172
below will be discarded at compilation time. Since there is
173
quite a bunch of such log messages in SimGrid itself, this can
174
reveal faster than discarding them at runtime as usually. But of
175
course, it is then impossible to get any debug message from
176
SimGrid if something goes wrong.
178
@li <b>enable_msg_deprecated</b> (ON/OFF): enable this option if
179
your code used a feature of Simgrid that was droped or modified
180
in recent releases of SimGrid. You should update your code if
181
possible, but with this option, SimGrid will try to emulate its
184
@li <b>enable_model-checking</b> (ON/OFF): Only enable this if you
185
actually plan to use the model-checking aspect of SimGrid. This
186
mode of execution is still under heavy work, but it should be
187
rather usable now. Be <b>warned</b> that this option will hinder
188
your simulation speed even if you simulate without activating
189
the model-checker. We are working on improving this situation.
191
@li <b>enable_supernovae</b> (ON/OFF): If you use an ancient
192
compiler (such as gcc prior to 4.6), you want to enable this
193
option to ensure that the whole SimGrid library is presented to
194
the compiler as a unique compilation unit to allow cross-units
195
optimizations. This is useless on modern compilers (and will
198
@li <b>enable_compile_warnings</b> (ON/OFF): request the compiler to
199
issue error message whenever the source code is not perfectly
200
clean. If you develop SimGrid itself, you must activate it to
201
ensure the code quality, but as a user, that option will only
204
@li <b>enable_lib_static</b> (ON/OFF): enable this if you want to
205
compile the static library (but you should consider enjoying
206
this new century instead).
208
@li <b>enable_maintainer_mode</b> (ON/OFF): you only need to set
209
this option if you modify very specific parts of SimGrid itself
210
(the XML parsers and other related elements). Adds an extra
211
dependency on flex and flexml.
213
@li <b>enable_tracing</b> (ON/OFF): disable this if you have issues
214
with the tracing module. But this module is now very stable and
215
you really should try to enjoy this beauty.
217
@li <b>enable_smpi</b> (ON/OFF): disable this if you have issues
218
with the module allowing to run MPI code on top of SimGrid. This
219
module very stable, but if you really don't need it, you can
222
@li <b>enable_mallocators</b> (ON/OFF): disable this when tracking
223
memory issues within SimGrid, or the caching mechanism used
224
internally will fool the debugers.
226
@li <b>enable_jedule</b> (ON/OFF): enable this to get SimDag
227
producing traces that can then be vizualized with the Jedule
230
@li <b>enable_lua</b> (ON/OFF): enable this if you want to enjoy the
231
lua bindings of SimGrid. Adds an extra dependency on lua library
232
and developper header files.
235
@li <b>enable_gtnets</b> (ON/OFF): whether you want to use gtnets.
236
See section @ref pls_simgrid_configuration_gtnets.
237
@li <b>gtnets_path</b> (path): GTNetS installation directory
239
@li <b>enable_ns3</b> (ON/OFF): whether you want to use ns3.
240
See section @ref pls_simgrid_configuration_ns3.
241
@li <b>ns3_path</b> (path): NS3 installation directory (eg /usr or /opt).
242
@li <b>enable_latency_bound_tracking</b> (ON/OFF): enable it if you
243
want to be warned when communications are limited by round trip
244
time while doing packet-level simulation.
246
\subsubsection install_cmake_reset Resetting the compilation configuration
248
If you need to empty the cache of values saved by cmake (either
249
because you added a new library or because something seriously went
250
wrong), you can simply delete the file CMakeCache.txt that is created
251
at the root of the source tree. You may also want to edit this file
252
directly in some circumstances.
254
\subsubsection install_cmake_outsrc Compiling into a separate directory
256
By default, the files produced during the compilation are placed in
257
the source directory. As the compilation generates a lot of files, it
258
is advised to to put them all in a separate directory. It is then
259
easier to cleanup, and this allows to compile several configurations
260
out of the same source tree. For that, simply enter the directory
261
where you want the produced files to land, and invoke cmake (or
262
ccmake) with the full path to the simgrid source as last argument.
263
This approach is called "compilation out of source tree".
272
\subsubsection install_cmake_win Cmake on Windows (with MinGW)
274
Cmake can produce several kind of of makefiles. Under Windows, it has
275
no way of determining what kind you want to use, so you have to hint it:
278
cmake -G"MinGW Makefiles" (other options) .
282
\subsubsection install_cmake_mac Cmake on Mac OSX
284
SimGrid compiles like a charm with clang on Mac OSX:
287
cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
291
With the XCode version of clang 4.1, you may get the following error message:
293
CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
296
In that case, edit the CMakeCache.txt file directly, so that the
297
CMAKE_OSX_SYSROOT is similar to the following. Don't worry about the
298
warning that the "-pthread" argument is not used, if it appears.
300
CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer
303
\subsection install_src_compil Compiling SimGrid
305
In most cases, compiling and installing simgrid is enough:
309
make install # try "sudo make install" if you don't have the permission to write
312
In addition, several compilation targets are provided in SimGrid. If
313
your system is well configured, the full list of targets is available
314
for completion when using the Tab key. Note that some of the existing
315
targets are not really for publc consumption so don't worry if some
316
stuff don't work for you.
319
make simgrid Builds only the simgrid library and not any example
320
make masterslave Builds only this example (and its dependencies)
321
make clean Clean the results of a previous compilation
322
make install Install the project (doc/ bin/ lib/ include/)
323
make uninstall Uninstall the project (doc/ bin/ lib/ include/)
324
make dist Cuild a distribution archive (tgz)
325
make distcheck Check the dist (make + make dist + tests on the distribution)
326
make simgrid_documentation Create simgrid documentation
329
If you want to see what is really happening, try adding VERBOSE=1 to
330
your compilation requests:
336
@subsection install_src_test Testing SimGrid
338
Once everything is built, you may want to test the result. SimGrid
339
comes with an extensive set of regression tests (see @ref
340
inside_cmake_addtest "that page of the insider manual" for more
341
details). Running the tests is done using the ctest binary that comes
342
with cmake. These tests are run every night and the result is publicly
343
<a href="http://cdash.inria.fr/CDash/index.php?project=Simgrid">available</a>.
346
ctest # Launch all tests
347
ctest -D Experimental # Launch all tests and report the result to
348
# http://cdash.inria.fr/CDash/index.php?project=SimGrid
349
ctest -R msg # Launch only the tests which name match the string "msg"
350
ctest -j4 # Launch all tests in parallel, at most 4 at the same time
351
ctest --verbose # Display all details on what's going on
352
ctest --output-on-failure # Only get verbose for the tests that fail
354
ctest -R msg- -j5 --output-on-failure # You changed MSG and want to check that you didn't break anything, huh?
355
# That's fine, I do so all the time myself.
358
\section install_setting_own Setting up your own code
360
\subsection install_setting_MSG MSG code on Unix (Linux or Mac OSX)
362
Do not build your simulator by modifying the SimGrid examples. Go
363
outside the SimGrid source tree and create your own working directory
364
(say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
366
Suppose your simulation has the following structure (remember it is
367
just an example to illustrate a possible way to compile everything;
368
feel free to organize it as you want).
370
\li <tt>sched.h</tt>: a description of the core of the
371
scheduler (i.e. which functions are can be used by the
372
agents). For example we could find the following functions
373
(master, forwarder, slave).
374
\li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
375
implementing the core of the scheduler. Most of these
376
functions use the MSG functions defined in section \ref
378
\li <tt>masterslave.c</tt>: a C file with the main function, i.e.
379
the MSG initialization (MSG_init()), the platform
380
creation (e.g. with MSG_create_environment()), the
381
deployment phase (e.g. with MSG_function_register() and
382
MSG_launch_application()) and the call to MSG_main()).
384
To compile such a program, we suggest to use the following
385
Makefile. It is a generic Makefile that we have used many times with
386
our students when we teach the C language.
390
masterslave: masterslave.o sched.o
392
INSTALL_PATH = $$HOME
394
PEDANTIC_PARANOID_FREAK = -O0 -Wshadow -Wcast-align \
395
-Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
396
-Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
397
-Wmissing-noreturn -Wredundant-decls -Wnested-externs \
398
-Wpointer-arith -Wwrite-strings -finline-functions
399
REASONABLY_CAREFUL_DUDE = -Wall
400
NO_PRAYER_FOR_THE_WICKED = -w -O2
401
WARNINGS = $(REASONABLY_CAREFUL_DUDE)
402
CFLAGS = -g $(WARNINGS)
404
INCLUDES = -I$(INSTALL_PATH)/include
405
DEFS = -L$(INSTALL_PATH)/lib/
406
LDADD = -lm -lsimgrid
410
$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@
413
$(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
416
rm -f $(BIN_FILES) *.o *~
422
The first two lines indicates what should be build when typing make
423
(<tt>masterslave</tt>) and of which files it is to be made of
424
(<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
425
that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
426
(look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
427
the static version, remove the <tt>-lsimgrid</tt> and add a
428
<tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
429
after the <tt>LIBS = </tt>.
431
More generally, if you have never written a Makefile by yourself, type
432
in a terminal: <tt>info make</tt> and read the introduction. The
433
previous example should be enough for a first try but you may want to
434
perform some more complex compilations...
437
\subsection install_setting_win_provided Compile the "HelloWorld" project on Windows
439
In the SimGrid install directory you should have an HelloWorld project to explain you how to start
440
compiling a source file. There are:
442
- HelloWorld.c The example source file.
443
- CMakeLists.txt It allows to configure the project.
444
- FindPCRE.cmake This finds and links to the pcre library (Normally included
445
into Simgrid directory "GnuWin32").
446
- README This explaination.
449
Now let's compile this example:
450
\li Run windows shell "cmd".
451
\li Open HelloWorld Directory ('cd' command line).
452
\li Create a build directory and change directory. (optional)
453
\li Type 'cmake -G"MinGW Makefiles" \<path_to_HelloWorld_project\>'
455
\li You should obtain a runnable example ("HelloWorld.exe").
457
For compiling your own code you can simply copy the HelloWorld project and rename source name. It will
458
create a target with the same name of the source.
461
\subsection install_setting_win_new Adding and Compiling a new example on Windows
463
\li Put your source file into the helloWord directory.
464
\li Edit CMakeLists.txt by removing the Find Targets section and add those two lines into this section
469
#It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES'
470
add_executable(TARGET_NAME SOURCES)
471
#Links TARGET_NAME with simgrid and pcre
472
target_link_libraries(TARGET_NAME simgrid pcre)
474
\li To initialize and build your project, you'll need to run
476
cmake -G"MinGW Makefiles" <path_to_HelloWorld_project>
478
\li Run "mingw32-make"
479
\li You should obtain "TARGET_NAME.exe".
481
\subsection install_Win_ruby Setup a virtualbox to use SimGrid-Ruby on windows
483
Allan Espinosa made these set of Vagrant rules available so that you
484
can use the SimGrid Ruby bindings in a virtual machine using
485
VirtualBox. Thanks to him for that. You can find his project here:
486
https://github.com/aespinosa/simgrid-vagrant
added
removed
doc/doxygen/install.doc
