1 /*! @page install Installing Simgrid
5 SimGrid should work out of the box on Linux, Mac OSX, FreeBSD, and Windows (under windows, only the Java interfaces are
6 available at the moment).
8 The easiest way to install SimGrid is to go for a @ref install_binary "binary package". Under Debian or Ubuntu, this is
9 very easy as SimGrid is directly integrated to the official repositories. For other Linux variants, you probably want
10 to go for a @ref install_src "source install". Please contact us if you want to contribute the build scripts for your
11 preferred distribution. If you just want to use @ref install_binary_java "Java", simply copy the jar file on your disk
14 @section install_binary Pre-compiled Packages
16 @subsection install_binary_linux Binaries for Linux
18 Most of us use a Debian or Ubuntu system, so the packages for these
19 systems are well integrated and up-to-date. To get these packages, simply type:
22 apt-get install simgrid
25 @subsection install_binary_java Stable Java Package
27 For the SimGrid Java bindings, grab the jar file from the [download
28 page](https://gforge.inria.fr/frs/?group_id=12) and copy it in your
29 classpath (typically, your source code root directory). This
30 self-contained version even includes the SimGrid native components for
31 the following architectures: Linux (Amd64, x86, Arm), Mac OS X 64
32 bits, Windows 64 bits, FreeBSD (64 bits).
34 @subsection install_binary_java_builder Nightly built Java Package
36 For Windows, head to [AppVeyor](https://ci.appveyor.com/project/simgrid/simgrid).
37 Click on the artefact link on the right, and grab your file. If the latest build failed, there will be no artefact. Then
38 you will need to first click on "History" on the top and search for the last successful build.
40 For non-Windows systems (Linux, Mac or FreeBSD), head to [Jenkins](https://ci.inria.fr/simgrid/job/SimGrid-Multi).
41 In the build history, pick the last green (or at least yellow) build that is not blinking (i.e., not currently under
42 build). In the list, pick a system that is close to yours, and click on the ball in the Debug row. The build artefact
43 will appear on the top of the resulting page.
45 @subsection install_binary_java_troubleshooting Binary Java Troubleshooting
47 - **Your architecture is not supported by this jarfile**. \n
48 If your system is in the list of the supported architectures (see
49 @ref install_binary_java "above"), then this is probably a bug that
50 @ref contributing_bugs "you should report".\n
51 If your system is actually not supported, you should compile your
52 own jarfile @ref install_src "by compiling SimGrid" on your
53 machine. If you feel so, @ref community_contact "contact us" so that we add
54 your architecture to the list.
56 - **Library not found: boost-context**.\n
57 You should obviously install the @c boost-context library on your
58 machine, for example with @c apt-get.
60 @section install_src Source Installs
62 @subsection install_src_deps Getting the Dependencies
64 Recompiling an official archive is not much more complex. SimGrid only uses very standard tools:
65 - C compiler, C++ compiler, make and friends. SimGrid is rather
66 demanding on the compiler. We use the C++11 standard, and older
67 compilers tend to fail on us. It seems that g++ 5.0 or higher is
68 required nowadays (because of boost).
69 - perl (but you may try to go without it)
70 - We use cmake to configure our compilation
71 ([download page](http://www.cmake.org/cmake/resources/software.html)).
72 You need cmake version 2.8.8 or higher. You may want to use ccmake
73 for a graphical interface over cmake.
75 - Max OS X: with [fink](http://www.finkproject.org/): `fink install boost1.53.nopython`,
76 or with homebrew: `brew install boost`
77 - Debian / Ubuntu: `apt-get install libboost-dev libboost-context-dev`
78 - Java (if you want to build the Java bindings):
79 - Mac OS X or Windows: Grab a [full JDK](http://www.oracle.com/technetwork/java/javase/downloads)
80 - Debian / Ubuntu: `apt-get install default-jdk`
82 For platform-specific details, please see @ref install_cmake_mac,
83 @ref install_cmake_windows, @ref install_java and @ref install_src_32bits
85 @subsection install_src_fetch Getting the Sources
87 You can download the *@SimGridRelease.tar.gz* archive from the
88 [download page](https://gforge.inria.fr/frs/?group_id=12).
89 Then, recompiling the archive should be done in a few lines:
91 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
92 tar xf @SimGridRelease.tar.gz
94 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99 If you want to stay on the bleeding edge, you should get the latest git version, and recompile it as you would do for
100 an official archive. Depending on the files you change in the source tree, some extra tools may be needed.
103 git clone git://scm.gforge.inria.fr/simgrid/simgrid.git simgrid
106 @subsection install_src_config Build Configuration
108 Note that compile-time options are very different from @ref options "run-time options".
110 @subsubsection install_cmake_howto Compilation Options
112 The default configuration should be fine for most usages, but if you need to change something, there are several ways
113 to do so. First, you can use environment variables. For example, you can change the compilers used by issuing these
114 commands before launching cmake:
121 Note that other variables are available, such as CFLAGS and CXXFLAGS to add options respectively for the C and C++
124 Another way to do so is to use the -D argument of cmake as follows.
125 Note that the ending dot is mandatory (see @ref install_cmake_outsrc).
128 cmake -DCC=clang -DCXX=clang++ .
131 Finally, you can use the ccmake graphical interface to change these settings.
137 @subsubsection install_cmake_list SimGrid compilation options
139 In addition to the classical cmake configuration variables, SimGrid accepts several options, as listed below.
141 @li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid (/opt/simgrid, /usr/local, or elsewhere).
143 @li <b>enable_compile_optimizations</b> (ON/OFF) to request the compiler to produce efficient code. You want to
144 activate it, unless you plan to debug SimGrid itself. Indeed, efficient code may be appear mangled to debuggers.
146 @li <b>enable_compile_warnings</b> (ON/OFF) to request the compiler to issue error messages whenever the source code
147 is not perfectly clean. If you are a SimGrid developer, you have to activate this option to enforce the code
148 quality. As a regular user, this option will bring you nothing.
150 @li <b>enable_debug</b> (ON/OFF). Disable this option toto discard
151 all log messages of gravity debug or below at compile time (see
152 @ref XBT_log). The resulting code is faster than if you
153 discarding these messages at runtime. However, it obviously
154 becomes impossible to get any debug info from SimGrid if
155 something goes wrong.
157 @li <b>enable_documentation</b> (ON/OFF) to generate the documentation pages.
159 @li <b>enable_java</b> (ON/OFF) to enjoy the java bindings of SimGrid.
161 @li <b>enable_jedule</b> (ON/OFF) to get SimDag producing execution traces that can then be visualized with the
162 Jedule external tool.
164 @li <b>enable_lua</b> (ON/OFF) to enjoy the lua bindings to the
167 @li <b>enable_lib_in_jar</b> (ON/OFF) to make sure that the native
168 java bindings are bundled in the jar file.
170 @li <b>enable_lto</b> (ON/OFF) to enable the Link Time Optimization
171 of the C compiler. This feature really speeds up the produced
172 code, but it is fragile with some versions of GCC.
174 @li <b>enable_maintainer_mode</b> (ON/OFF) is only needed if you plan to modify very specific parts of SimGrid
175 (e.g., the XML parsers and other related elements). Moreover, this adds an extra dependency on flex and flexml.
177 @li <b>enable_mallocators</b> (ON/OFF) has to be disabled when tracking memory issues within SimGrid,
178 or our internal memory caching mechanism will fool the debuggers.
180 @li <b>enable_model-checking</b> (ON/OFF) This execution gear
181 is very usable now, but enabling this option at compile time
182 will **hinder simulation speed** even when the model-checker is
183 not activated at run time.
185 @li <b>enable_ns3</b> (ON/OFF) if you want to use ns-3. See section @ref pls_ns3.
187 @li <b>enable_smpi</b> (ON/OFF) to run MPI code on top of SimGrid.
189 @li <b>enable_smpi_ISP_testsuite</b> (ON/OFF) to add many extra
190 tests for the model-checker module.
192 @li <b>enable_smpi_MPICH3_testsuite</b> (ON/OFF) to add many extra
193 tests for the MPI module.
195 @subsubsection install_cmake_reset Reset the build configuration
197 To empty the cmake cache (either when you add a new library or when
198 things go seriously wrong), simply delete your @c CMakeCache.txt. You
199 may also want to directly edit this file in some circumstances.
201 @subsubsection install_cmake_outsrc Out of Tree Compilation
203 By default, the files produced during the compilation are placed in
204 the source directory. It is however often better to put them all in a
205 separate directory: cleaning the tree becomes as easy as removing this
206 directory, and you can have several such directories to test several
207 parameter sets or architectures.
209 For that, go to the directory where the files should be produced, and
210 invoke cmake (or ccmake) with the full path to the SimGrid source as
220 @subsubsection install_cmake_mac Mac OS X Builds
222 SimGrid compiles like a charm with clang (version 3.0 or higher) on Mac OS X:
225 cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
229 With the XCode version of clang 4.1, you may get the following error message:
231 CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
234 In that case, edit the CMakeCache.txt file directly, so that the
235 CMAKE_OSX_SYSROOT is similar to the following. Don't worry about the
236 warning that the "-pthread" argument is not used, if it appears.
238 CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer
241 In the El Capitan version of Max OS X, Apple decided that users don't
242 need no /usr/include directory anymore. If you are hit by this pure
243 madness, just run the following command to restore that classical
244 UNIX directory: `xcode-select -install`
246 @subsubsection install_cmake_windows Windows Builds
248 Building SimGrid on Windows may be something of an adventure:
249 We only manage to do so ourselves with MinGW-64, <a
250 href="http://www.activestate.com/activeperl/downloads">ActiveState</a>
251 Perl and <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">msys</a>
252 git). Have a look at out configuration scripts in @c appveyor.yml, but
253 don't expect too much from us: we are really not fluent with Windows.
254 Actually your help is welcome.
256 The drawback of MinGW-64 is that the produced DLL are not compatible
257 with MS Visual C. <a href="http://clang.llvm.org/docs/MSVCCompatibility.html">clang-cl</a>
258 sounds promising to fix this. If you get something working, please
259 @ref community_contact "tell us".
261 @subsubsection install_java Build the Java bindings
263 Once you have the [full JDK](http://www.oracle.com/technetwork/java/javase/downloads) installed
264 (on Debian/Ubuntu, grab the package ```default-jdk``` for that), things should be as simple as:
267 cmake -Denable_java=ON .
271 After the compilation, the file ```simgrid.jar``` is produced in the
272 root directory. If you only want to build the jarfile and its
273 dependencies, type ```make simgrid-java_jar```. It will save you the
274 time of building every C examples and other things that you don't need
277 ** **Error: jni could not be found**. Sometimes, the build system fails
278 to find the JNI headers. In this case, you need to first locate them as follows:
282 /usr/lib/jvm/java-7-openjdk-amd64/include/jni.h
283 /usr/lib/jvm/java-8-openjdk-amd64/include/jni.h
286 Then, set the JAVA_INCLUDE_PATH environment variable to the right
287 path, and relaunch cmake. If you have several version of jni installed
288 (as above), use the right one (check the java version you use with
289 ```javac -version```).
292 export JAVA_INCLUDE_PATH=/usr/lib/jvm/java-8-openjdk-amd64/include/
293 cmake -Denable_java=ON .
297 Note that the filename ```jni.h``` was removed from the path.
299 @subsubsection install_src_32bits 32 bits Builds on Multi-arch Linux
301 On a multiarch x86_64 Linux, it should be possible to compile a 32 bit
302 version of SimGrid with something like:
307 PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig/ \
309 -DCMAKE_SYSTEM_PROCESSOR=i386 \
310 -DCMAKE_Fortran_COMPILER=/some/path/to/i686-linux-gnu-gfortran \
311 -DGFORTRAN_EXE=/some/path/to/i686-linux-gnu-gfortran \
312 -DCMAKE_Fortran_FLAGS=-m32
315 If needed, implement @c i686-linux-gnu-gfortran as a script:
319 exec gfortran -m32 "$@"
322 @subsection install_src_compil Existing Compilation Targets
324 In most cases, compiling and installing SimGrid is enough:
328 make install # try "sudo make install" if you don't have the permission to write
331 In addition, several compilation targets are provided in SimGrid. If
332 your system is well configured, the full list of targets is available
333 for completion when using the Tab key. Note that some of the existing
334 targets are not really for public consumption so don't worry if some
335 stuff doesn't work for you.
338 make simgrid Build only the SimGrid library and not any example
339 make app-masterworker Build only this example (works for any example)
340 make clean Clean the results of a previous compilation
341 make install Install the project (doc/ bin/ lib/ include/)
342 make uninstall Uninstall the project (doc/ bin/ lib/ include/)
343 make dist Build a distribution archive (tgz)
344 make distcheck Check the dist (make + make dist + tests on the distribution)
345 make documentation Create SimGrid documentation
348 If you want to see what is really happening, try adding VERBOSE=1 to
349 your compilation requests:
355 @subsection install_src_test Testing your build
357 Once everything is built, you may want to test the result. SimGrid
358 comes with an extensive set of regression tests (as described in the
359 @ref inside_tests "insider manual"). The tests are run with @c ctest, that comes with CMake.
360 We run them every commit and the results are on [our
361 Jenkins](https://ci.inria.fr/simgrid/).
364 ctest # Launch all tests
365 ctest -R msg # Launch only the tests which name match the string "msg"
366 ctest -j4 # Launch all tests in parallel, at most 4 at the same time
367 ctest --verbose # Display all details on what's going on
368 ctest --output-on-failure # Only get verbose for the tests that fail
370 ctest -R msg- -j5 --output-on-failure # You changed MSG and want to check that you didn't break anything, huh?
371 # That's fine, I do so all the time myself.