9 SimGrid should work out of the box on Linux, Mac OSX, FreeBSD, and Windows (under windows, only the Java interfaces are
10 available at the moment).
18 On Debian or Ubuntu, simply type:
24 If you build pre-compiled packages for other distributions, drop us an
30 The jar file can be retrieved from the `Release page
31 <https://framagit.org/simgrid/simgrid/tags>`_. This file is
32 self-contained, including the native components for Linux, Mac OSX and
33 Windows. Copy it to your project's classpath and you're set.
35 Nightly built Java Package
36 ^^^^^^^^^^^^^^^^^^^^^^^^^^
38 For non-Windows systems (Linux, Mac or FreeBSD), head to `Jenkins <https://ci.inria.fr/simgrid/job/SimGrid>`_.
39 In the build history, pick the last green (or at least yellow) build that is not blinking (i.e., not currently under
40 build). In the list, pick a system that is close to yours, and click on the ball in the Debug row. The build artefact
41 will appear on the top of the resulting page.
43 For Windows, head to `AppVeyor <https://ci.appveyor.com/project/simgrid/simgrid>`_.
44 Click on the artefact link on the right, and grab your file. If the latest build failed, there will be no artefact. Then
45 you will need to first click on "History" on the top and search for the last successful build.
47 Binary Java Troubleshooting
48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
50 Here are some error messages that you may get when trying to use the
53 Your architecture is not supported by this jarfile
54 If your system is not supported, you should compile your
55 own jarfile :ref:`by compiling SimGrid <install_src>` from the source.
56 Library not found: boost-context
57 You should obviously install the ``boost-context`` library on your
58 machine, for example with ``apt``.
62 Installing from the Source
63 --------------------------
65 Getting the Dependencies
66 ^^^^^^^^^^^^^^^^^^^^^^^^
68 C++ compiler (either g++, clang or icc).
69 We use the C++11 standard, and older compilers tend to fail on
70 us. It seems that g++ 5.0 or higher is required nowadays (because of
71 boost). SimGrid compiles well with `clang` or `icc` too.
73 SimGrid should build without Python, that is only needed by our regresion test suite.
75 ``ccmake`` provides a nicer graphical interface compared to ``cmake``.
76 Press ``t`` in ``ccmake`` if you need to see absolutely all
77 configuration options (e.g., if your python installation is not standard).
78 boost (at least v1.48, v1.59 recommended)
79 - On Debian / Ubuntu: ``apt install libboost-dev libboost-context-dev``
80 - On Max OS X with homebrew: ``brew install boost``
82 - Debian / Ubuntu: ``apt install default-jdk libgcj18-dev`` (or
83 any version of libgcj)
84 - Mac OS X or Windows: Grab a `full JDK <http://www.oracle.com/technetwork/java/javase/downloads>`_
85 Lua (optional -- must be v5.3)
86 - SimGrid won't work with any other version of Lua.
87 - Debian / Ubuntu: ``apt install liblua5.3-dev lua5.3``
88 - Windows: ``choco install lua53``
90 - You need to patch the sources to build dynamic libraries. First `download lua 5.3 <http://www.lua.org/download.html>`_
91 - Open the archive: ``tar xvfz lua-5.3.*.tar.gz``
92 - Enter the directory: ``cd lua-5.3*``
93 - Patch the sources: ``patch -p1 < /path/to/simgrid/...../tools/lualib.patch``
94 - Build and install lua: ``make linux && sudo make install``
96 For platform-specific details, please see below.
101 Grab the last **stable release** from `FramaGit
102 <https://framagit.org/simgrid/simgrid/tags>`_, and compile it as follows:
104 .. code-block:: shell
106 tar xf SimGrid-3-XX.tar.gz
108 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
112 If you want to stay on the **bleeding edge**, get the current git version,
113 and recompile it as with stable archives. You may need some extra
116 .. code-block:: shell
118 git clone git@framagit.org:simgrid/simgrid.git
120 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
127 This section is about **compile-time options**, that are very
128 different from @ref options "run-time options". Compile-time options
129 fall into two categories. *SimGrid-specific options* define which part
130 of the framework to compile while *Generic options* are provided by
133 Generic build-time options
134 """"""""""""""""""""""""""
136 These options specify for example the path to various system elements
137 (Python path, compiler to use, etc). In most case, cmake automatically
138 discovers the right value for these ones, but you can set them
139 manually on need. Notable such variables include ``CC`` and ``CXX``,
140 defining respectively the paths to the C and C++ compilers, ``CFLAGS``
141 and ``CXXFLAGS`` respectively specifying extra options to pass to the C
142 and C++ compilers, or ``PYTHON_EXECUTABLE`` specifying the path to the
145 The best way to discover the exact name of the option that you need to
146 change is to press ``t`` in the ``ccmake`` graphical interface, as all
147 options are shown (and documented) in the advanced mode.
149 Once you know their name, there is several ways to change the value of
150 build-time options. You can naturally use the ccmake graphical
151 interface for that, or you can use environment variables, or you can
152 prefer the ``-D`` flag of ``cmake``.
154 For example, you can change the compilers with environment variables
155 by issuing these commands before launching cmake:
157 .. code-block:: shell
162 The same can be done by passing ``-D`` parameters to cmake, as follows.
163 Note that the ending dot is mandatory (see :ref:`install_cmake_outsrc`).
165 .. code-block:: shell
167 cmake -DCC=clang -DCXX=clang++ .
169 SimGrid compilation options
170 """""""""""""""""""""""""""
172 Here is the list of all SimGrid-specific build-time options (the
173 default choice is in uppercase).
175 CMAKE_INSTALL_PREFIX (path)
176 Where to install SimGrid (/opt/simgrid, /usr/local, or elsewhere).
178 enable_compile_optimizations (ON/off)
179 Request the compiler to produce efficient code. You probably want to
180 activate this option, unless you plan modify SimGrid itself:
181 efficient code takes more time to compile, and appears mangled to debuggers.
183 enable_compile_warnings (on/OFF)
184 Request the compiler to issue error messages whenever the source
185 code is not perfectly clean. If you are a SimGrid developer, you
186 have to activate this option to enforce the code quality. As a
187 regular user, this option is of little use.
189 enable_debug (ON/off)
190 Disabling this option toto discards all log messages of gravity
191 debug or below at compile time (see @ref XBT_log). The resulting
192 code is faster than if you discarding these messages at
193 runtime. However, it obviously becomes impossible to get any debug
194 info from SimGrid if something goes wrong.
196 enable_documentation (ON/off)
197 Generates the documentation pages.
200 Generates the java bindings of SimGrid.
202 enable_jedule (on/OFF)
203 Produces execution traces from SimDag simulations, that can then be visualized with the
204 Jedule external tool.
207 Generate the lua bindings to the SimGrid internals (requires lua-5.3).
209 enable_lib_in_jar (ON/off)
210 Embeds the native java bindings into the produced jar file.
213 Enables the *Link Time Optimization* in the C++ compiler.
214 This feature really speeds up the produced code, but it is fragile
215 with older gcc versions.
217 enable_maintainer_mode (on/OFF)
218 (dev only) Regenerates the XML parsers when the dtd is modified (requires flex and flexml).
220 enable_mallocators (ON/off)
221 Activates our internal memory caching mechanism. This produces faster
222 code, but it may fool the debuggers.
224 enable_model-checking (on/OFF)
225 Activates the formal verification mode. This will **hinder
226 simulation speed** even when the model-checker is not activated at
230 Activates the ns-3 bindings. See section @ref pls_ns3.
233 Allows to run MPI code on top of SimGrid.
235 enable_smpi_ISP_testsuite (on/OFF)
236 Adds many extra tests for the model-checker module.
238 enable_smpi_MPICH3_testsuite (on/OFF)
239 Adds many extra tests for the MPI module.
241 Reset the build configuration
242 """""""""""""""""""""""""""""
244 To empty the cmake cache (either when you add a new library or when
245 things go seriously wrong), simply delete your ``CMakeCache.txt``. You
246 may also want to directly edit this file in some circumstances.
248 .. _install_cmake_outsrc:
250 Out of Tree Compilation
251 ^^^^^^^^^^^^^^^^^^^^^^^
253 By default, the files produced during the compilation are placed in
254 the source directory. It is however often better to put them all in a
255 separate directory: cleaning the tree becomes as easy as removing this
256 directory, and you can have several such directories to test several
257 parameter sets or architectures.
259 For that, go to the directory where the files should be produced, and
260 invoke cmake (or ccmake) with the full path to the SimGrid source as
263 .. code-block:: shell
270 Existing Compilation Targets
271 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
273 In most cases, compiling and installing SimGrid is enough:
275 .. code-block:: shell
278 make install # try "sudo make install" if you don't have the permission to write
280 In addition, several compilation targets are provided in SimGrid. If
281 your system is well configured, the full list of targets is available
282 for completion when using the ``Tab`` key. Note that some of the
283 existing targets are not really for public consumption so don't worry
284 if some stuff doesn't work for you.
286 - **make simgrid**: Build only the SimGrid library and not any example
287 - **make s4u-app-pingpong**: Build only this example (works for any example)
288 - **make java-all**: Build all Java examples and their dependencies
289 - **make clean**: Clean the results of a previous compilation
290 - **make install**: Install the project (doc/ bin/ lib/ include/)
291 - **make uninstall**: Uninstall the project (doc/ bin/ lib/ include/)
292 - **make dist**: Build a distribution archive (tar.gz)
293 - **make distcheck**: Check the dist (make + make dist + tests on the distribution)
294 - **make documentation**: Create SimGrid documentation
296 If you want to see what is really happening, try adding ``VERBOSE=1`` to
297 your compilation requests:
299 .. code-block:: shell
303 .. _install_src_test:
308 Once everything is built, you may want to test the result. SimGrid
309 comes with an extensive set of regression tests (as described in the
310 @ref inside_tests "insider manual"). The tests are run with ``ctest``,
311 that comes with CMake. We run them every commit and the results are
312 on `our Jenkins <https://ci.inria.fr/simgrid/>`_.
314 .. code-block:: shell
316 ctest # Launch all tests
317 ctest -R s4u # Launch only the tests which name match the string "s4u"
318 ctest -j4 # Launch all tests in parallel, at most 4 concurrent jobs
319 ctest --verbose # Display all details on what's going on
320 ctest --output-on-failure # Only get verbose for the tests that fail
322 ctest -R s4u -j4 --output-on-failure # You changed S4U and want to check that you didn't break anything, huh?
323 # That's fine, I do so all the time myself.
325 .. _install_cmake_mac:
330 SimGrid compiles like a charm with clang (version 3.0 or higher) on Mac OS X:
332 .. code-block:: shell
334 cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
338 Troubleshooting your Mac OS X build.
340 CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
341 This was reported with the XCode version of clang 4.1. The work
342 around is to edit the ``CMakeCache.txt`` file directly, to change
345 ``CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer``
347 You can safely ignore the warning about "-pthread" not being used, if it appears.
349 /usr/include does not seem to exist
350 This directory does not exist by default on modern Mac OSX versions,
351 and you may need to create it with ``xcode-select -install``
353 .. _install_cmake_windows:
358 The best solution to get SimGrid working on windows is to install the
359 Ubuntu subsystem of Windows 10. All of SimGrid (but the model-checker)
360 works in this setting.
362 Native builds not very well supported. Have a look to our `appveypor
364 <https://framagit.org/simgrid/simgrid/blob/master/.appveyor.yml>`_ to
365 see how we manage to use mingw-64 to build the DLL that the Java file
368 The drawback of MinGW-64 is that the produced DLL are not compatible
369 with MS Visual C. `clang-cl <http://clang.llvm.org/docs/MSVCCompatibility.html">`_
370 sounds promising to fix this. If you get something working or if you
371 have any other improvement, please @ref community_contact "tell us".
376 Once you have the `full JDK <http://www.oracle.com/technetwork/java/javase/downloads>`_ installed,
377 things should be as simple as:
379 .. code-block:: shell
381 cmake -Denable_java=ON .
382 make simgrid-java_jar # Only build the jarfile
384 After the compilation, the file ```simgrid.jar``` is produced in the
387 **Troubleshooting Java Builds**
389 Sometimes, the build system fails to find the JNI headers. First locate them as follows:
391 .. code-block:: shell
394 /usr/lib/jvm/java-8-openjdk-amd64/include/jni.h
395 /usr/lib/jvm/java-9-openjdk-amd64/include/jni.h
396 /usr/lib/jvm/java-10-openjdk-amd64/include/jni.h
399 Then, set the JAVA_INCLUDE_PATH environment variable to the right
400 path, and relaunch cmake. If you have several version of jni installed
401 (as above), pick the one corresponding to the report of
404 .. code-block:: shell
406 export JAVA_INCLUDE_PATH=/usr/lib/jvm/java-8-openjdk-amd64/include/
407 cmake -Denable_java=ON .
410 Note that the filename ```jni.h``` was removed from the path.
412 Linux Multi-Arch Specifics
413 ^^^^^^^^^^^^^^^^^^^^^^^^^^
415 On a multiarch x86_64 Linux, it should be possible to compile a 32 bit
416 version of SimGrid with something like:
418 .. code-block:: shell
422 PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig/ \
424 -DCMAKE_SYSTEM_PROCESSOR=i386 \
425 -DCMAKE_Fortran_COMPILER=/some/path/to/i686-linux-gnu-gfortran \
426 -DGFORTRAN_EXE=/some/path/to/i686-linux-gnu-gfortran \
427 -DCMAKE_Fortran_FLAGS=-m32
429 If needed, implement ``i686-linux-gnu-gfortran`` as a script:
431 .. code-block:: shell
434 exec gfortran -m32 "$@"