1 /*! \addtogroup SimGrid_install
2 \page install Installing Simgrid
4 \section install_cmake Installing the SimGrid library
6 \subsection install_intro Some generality
8 \subsubsection install_intro1 What is Cmake?
10 CMake is a family of tools designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files. CMake generates native makefiles and workspaces that can be used in the compiler environment of your choice. For more information see official web site <a href="http://www.cmake.org/">here</a>.
12 \subsubsection install_intro2 Why cmake?
14 CMake permits to developers to compil projects on different plateforms. Then many tools are embedded like ctest for making test, a link to cdash for vizualise results but also test coverage and bug reports.
16 \subsubsection install_intro3 What cmake need?
18 CMake needs some prerequists like :
23 \li c and c++ compiler
24 \li ccmake for graphical used of CMake
25 \li cmake <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
27 On MacOSX some users reported that it is still possible to build with clang, provided that you
28 use at least clang3.0 installed with macport or with xcode. If it fails on you, try to
31 port install clang-3.0
36 \li cmake 2.8 <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
37 \li MinGW <a href="http://sourceforge.net/projects/mingw/files/MinGW/">(download page)</a>
38 \li perl <a href="http://www.activestate.com/activeperl/downloads">(download page)</a>
39 \li git <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">(download page)</a>
41 Note that if you want change the compiler, you can simply specify the environment variables CC and CXX.
49 \subsubsection install_cmakeoption1 Liste of options
52 "cmake -D[name]=[value] ... ./"
54 [name] enable_gtnets [value] ON/OFF or TRUE/FALSE or 1/0
55 enable_ns3 ON/OFF or TRUE/FALSE or 1/0
56 enable_lua ON/OFF or TRUE/FALSE or 1/0
57 enable_compile_optimizations ON/OFF or TRUE/FALSE or 1/0
58 enable_compile_warnings ON/OFF or TRUE/FALSE or 1/0
59 enable_smpi ON/OFF or TRUE/FALSE or 1/0
60 enable_maintainer_mode ON/OFF or TRUE/FALSE or 1/0
61 enable_tracing ON/OFF or TRUE/FALSE or 1/0
62 enable_coverage ON/OFF or TRUE/FALSE or 1/0
63 enable_memcheck ON/OFF or TRUE/FALSE or 1/0
64 enable_model-checking ON/OFF or TRUE/FALSE or 1/0
65 enable_debug ON/OFF or TRUE/FALSE or 1/0
66 enable_jedule ON/OFF or TRUE/FALSE or 1/0
67 enable_latency_bound_tracking ON/OFF or TRUE/FALSE or 1/0
68 enable_lib_static ON/OFF or TRUE/FALSE or 1/0
69 enable_supernovae ON/OFF or TRUE/FALSE or 1/0
70 enable_msg_deprecated ON/OFF or TRUE/FALSE or 1/0
71 enable_print_message ON/OFF or TRUE/FALSE or 1/0
72 gtnets_path <path_to_gtnets_directory>
73 ns3_path <path_to_ns3_directory>
74 CMAKE_INSTALL_PREFIX <path_to_install_directory>
75 pipol_user <pipol_username>
78 \subsubsection install_cmakeoption2 Options explaination
80 \li enable_gtnets : set to true implie that user wants to use gtnets.
82 \li enable_ns3 : set to true implie that user wants to use ns3.
84 \li enable_lua : set to true implie that user wants to add lua langage into simgrid compilation.
86 \li enable_compile_optimizations : add flags "-O3 -finline-functions -funroll-loops -fno-strict-aliasing"
88 \li enable_compile_warnings : add flags "-Wall -Wunused -Wmissing-prototypes -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing -Wno-format-nonliteral -Werror"
90 \li enable_smpi : Set to true if you want to use smpi lib. Actually on simgrid v3.4.1 Mac doesn't support lib smpi.
92 \li enable_maintainer_mode : set to true it remakes some files.
94 \li enable_tracing : To enable the generation of simulation traces for visualization.
96 \li enable_coverage : When set to true this option enable code coverage by setting -fprofile-arcs -ftest-coverage flags.
98 \li enable_memcheck : When set to true this option enable tests for memcheck.
100 \li enable_model-checking : Enable the model checking when set to true.
102 \li enable_debug : If enable_debug is set to 'off' Simgrid compil flag has '-DNDEBUG' option.
104 \li enable_jedule : To enable jedule mode, which creates visualizations of task schedules with Simdag.
106 \li enable_latency_bound_tracking : Set to on if you want to be warned when communications are limited by round trip time.
108 \li enable_lib_static : Enable generated Simgrid and smpi static libraries.
110 \li enable_supernovae : Set to true make one file for each lib and compile with those generated files.
112 \li enable_msg_deprecated : Simgrid is compiled with msg deprecated functions.
114 \li enable_print_message : When set to true configuration print more debug output.
116 \li gtnets_path : Path to gtnets install directory (ex /usr)
118 \li ns3_path : Path to ns3 install directory (ex /usr)
120 \li CMAKE_INSTALL_PREFIX : Path where are installed lib/ doc/ and include/ directories (ex /usr/local)
122 \li pipol_user : specify your pipol username if you want to use the pipol-remote command.
124 \subsubsection install_cmakeoption3 Initialisation
126 Those options are initialized the first time you launch "cmake ." whithout specified option.
133 enable_compile_optimizations on
135 enable_compile_warnings off
136 enable_maintainer_mode off
139 enable_model-checking off
141 enable_latency_bound_tracking off
142 enable_lib_static off
143 CMAKE_INSTALL_PREFIX /usr/local
148 \subsubsection install_cmakeoption4 Option's cache and how to reset?
150 When options have been set they are keep into a cache file named "CMakeCache.txt". So if you want
151 reset values you just delete this file located to the project directory.
153 \subsection install_cmakecompilation Cmake compilation
155 \subsubsection install_cmakecompilation1 With command line.
157 On Unix or Mac platform:
160 cmake -D[name]=[value] ... ./
167 cmake -G"MinGW Makefiles" -D[name]=[value] ... ./
171 \subsubsection install_cmakecompilation2 With ccmake tool.
176 Then follow instructions.
178 \subsubsection install_cmakecompilation2bis Build out of source.
180 As cmake generate many files used for compilation, we recommand to make a build directory.
181 For examples you can make :
184 "navarrop@caraja:~/Developments$ cd simgrid/"
185 "navarrop@caraja:~/Developments/simgrid$ mkdir build_directory"
186 "navarrop@caraja:~/Developments/simgrid$ cd build_directory/"
187 "navarrop@caraja:~/Developments/simgrid/build_directory$ cmake ../"
188 "navarrop@caraja:~/Developments/simgrid/build_directory$ make"
191 Or complety out of sources :
194 "navarrop@caraja:~/Developments$ mkdir build_dir"
195 "navarrop@caraja:~/Developments$ cd build_dir/"
196 "navarrop@caraja:~/Developments/build_dir$ cmake ../simgrid/"
197 "navarrop@caraja:~/Developments/build_dir$ make"
200 Those two kind of compilation permit to delete files created by compilation easier.
202 \subsubsection install_cmakecompilation3 Resume of command line
206 cmake <path> configure the project for Unix and Mac
207 cmake -G"MinGW Makefiles" <path> configure the project for Windows
208 make build all targets for Unix and Mac
209 ming32-make buill all targets for windows
210 (g)make VERBOSE=1 build all targets and print build command lines
211 make check test all targets and summarize
212 make dist make the distrib
213 make distcheck check the dist (make + make dist + make check)
214 (g)make install install the project (doc/ bin/ lib/ include/)
215 (g)make uninstall uninstall the project (doc/ bin/ lib/ include/)
216 (g)make clean clean all targets
217 make simgrid_documentation Create simgrid documentation
220 When the project have been succesfully compiling and build you can make tests.
224 ctest launch only tests
226 ctest -D Continuous(Start|Update|Configure|Build)
227 ctest -D Continuous(Test|Coverage|MemCheck|Submit)
228 ctest -D Experimental
229 ctest -D Experimental(Start|Update|Configure|Build)
230 ctest -D Experimental(Test|Coverage|MemCheck|Submit)
232 ctest -D Nightly(Start|Update|Configure|Build)
233 ctest -D Nightly(Test|Coverage|MemCheck|Submit)
234 ctest -D NightlyMemoryCheck
237 If you want to test before make a commit you can simply make "ctest -D Experimental" and then you can visualize results submitted into Cdash. <a href="http://cdash.inria.fr/CDash/index.php?project=Simgrid">(Go to Cdash site)</a>.
239 \subsection install_cmakeinstall How to install with cmake?
241 \subsubsection install_cmakeinstall1 From Git.
244 git clone git://scm.gforge.inria.fr/simgrid/simgrid.git simgrid
246 cmake -Denable_maintainer_mode=on -DCMAKE_INSTALL_PREFIX=/home/navarrop/Bureau/install_simgrid ./
251 \subsubsection install_cmakeinstall2 From a distrib
254 wget https://gforge.inria.fr/frs/download.php/28674/simgrid-3.6.1.tar.gz
255 tar xf simgrid-3.6.1.tar.gz
257 cmake -DCMAKE_INSTALL_PREFIX=/home/navarrop/Bureau/install_simgrid ./
263 \subsection install_cmakehowto How to modified sources files for developers
265 \subsubsection install_cmakehowto1 Add an executable or examples.
267 If you want make an executable you have to create a CMakeList.txt to the src directory.
268 You must specified where to create the executable, source list, dependencies and the name of the binary.
271 cmake_minimum_required(VERSION 2.6)
273 set(EXECUTABLE_OUTPUT_PATH "./")
274 set(LIBRARY_OUTPUT_PATH "${CMAKE_HOME_DIRECTORY}/lib")
276 add_executable(get_sender get_sender.c) #add_executable(<name_of_target> <src list>)
278 ### Add definitions for compile
279 target_link_libraries(get_sender simgrid m pthread) #target_link_libraries(<name_of_targe> <dependencies>)
282 Then you have to modified <project/directory>/buildtools/Cmake/MakeExeLib.cmake and add
285 add_subdirectory(${CMAKE_HOME_DIRECTORY}/<path_where_is_CMakeList.txt>)
288 \subsubsection install_cmakehowto2 Delete/add sources to lib.
290 If you want modified, add or delete source files from a library you have to edit <project/directory>/buildtools/Cmake/DefinePackages.cmake
294 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/MsgException.java
295 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/JniException.java
296 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/NativeException.java
297 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/HostNotFoundException.java
298 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/ProcessNotFoundException.java
299 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Msg.java
300 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Process.java
301 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Host.java
302 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Task.java
303 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/MsgNative.java
304 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/ApplicationHandler.java
305 ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Sem.java
309 \section install_Win Installing the SimGrid framework on Windows
311 \subsection install_Win_install Installing SimGrid with the automatic installer
313 Before start the installation, you need to be sure to have the following dependencies:
314 \li cmake 2.8 <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
315 \li MinGW <a href="http://sourceforge.net/projects/mingw/files/MinGW/">(download page)</a>
316 \li perl <a href="http://www.activestate.com/activeperl/downloads">(download page)</a>
317 \li git <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">(download page)</a>
319 Then download the package <a href="https://gforge.inria.fr/frs/?group_id=12">SimGrid Installer</a>,
320 execute it and follow instructions.
323 <a href="win_install_01.png" border=0><img src="win_install_01.png" border=0></a>
326 Step 1: Accept the license.
329 <a href="win_install_02.png" border=0><img src="win_install_02.png" border=0></a>
332 Step 2: Select packets to install.
335 <a href="win_install_03.png" border=0><img src="win_install_03.png" border=0></a>
338 Step 3: Choice where to install packets previously selected. Please don't use spaces in path.
341 <a href="win_install_04.png" border=0><img src="win_install_04.png" border=0></a>
344 Step 4: Add CLASSPATH to environment variables.
347 <a href="win_install_05.png" border=0><img src="win_install_05.png" border=0></a>
350 Step 5: Add PATH to environment variables.
353 <a href="win_install_06.png" border=0><img src="win_install_06.png" border=0></a>
356 Step 6: Restart your computer to take in consideration environment variables.
358 \subsection install_Win_compile1 Compile a project "HelloWorld"
360 In the SimGrid install directroy you should have an HelloWorld project to explain you how to start
361 compiling a source file. There are:
363 - HelloWorld.c The example source file.
364 - CMakeLists.txt It allows to configure the project.
365 - FindPCRE.cmake This finds and links to the pcre library (Normally included into Simgrid directory "GnuWin32").
366 - README This explaination.
369 Now let's compil this example:
370 \li Run windows shell "cmd".
371 \li Open HelloWorld Directory ('cd' command line).
372 \li Create a build directory and change directory. (optional)
373 \li Type 'cmake -G"MinGW Makefiles" \<path_to_HelloWorld_project\>'
375 \li You should obtain a runnable example ("HelloWorld.exe").
377 For compiling your own code you can simply copy the HelloWorld project and rename source name. It will
378 create a target with the same name of the source.
380 \subsection install_Win_compile2 How to add and compile a new example
382 \li Put your source file into the helloWord directory.
383 \li Edit CMakeLists.txt by removing the Find Targets section and add those two lines into this section
388 add_executable(TARGET_NAME SOURCES) #It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES'
389 target_link_libraries(TARGET_NAME simgrid pcre) #Links TARGET_NAME with simgrid and pcre
391 \li To initialize and build your project, you'll need to run
393 cmake -G"MinGW Makefiles" \<path_to_HelloWorld_project\>
395 \li Run "mingw32-make"
396 \li You should obtain "TARGET_NAME.exe".
398 \subsection install_Win_ruby Setup a virtualbox to use SimGrid-Ruby on windows
400 Allan Espinosa made these set of Vagrant rules available so that you
401 can use the SimGrid Ruby bindings in a virtual machine using
402 VirtualBox. Thanks to him for that. You can find his project here:
403 https://github.com/aespinosa/simgrid-vagrant
405 \section install_mac Installing the SimGrid framework on Mac OS X
407 The Mac OS X system is part of the UNIX familly, but it exibits some
408 specificities that complicate a bit the build of SimGrid. Current
409 versions of SimGrid (3.7.x) can only be build with the GCC Compiler,
410 but recent OS X version provide only an ancient version of that tool
411 in the hope to see the users switch to the LLVM compiler family. The
412 problem is that SimGrid uses internal libraries of GCC, for stack
413 manipulation for example. We are working on removing this dependency
414 onto gcc to ease the build process, but this is still ongoing.
416 For the time being, you need to get a recent version of GCC on your
417 system to build SimGrid. Version 3.7.1 was successfully built on Mac
418 Lion 10.7.4 using a GCC compiler retrieved from macport. The package
419 used were gcc47, and the binary in the package were gcc-mp-4.7.
421 \section install_setting_MSG Setting up your own MSG code
423 Do not build your simulator by modifying the SimGrid examples. Go
424 outside the SimGrid source tree and create your own working directory
425 (say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
427 Suppose your simulation has the following structure (remember it is
428 just an example to illustrate a possible way to compile everything;
429 feel free to organize it as you want).
431 \li <tt>sched.h</tt>: a description of the core of the
432 scheduler (i.e. which functions are can be used by the
433 agents). For example we could find the following functions
434 (master, forwarder, slave).
436 \li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
437 implementing the core of the scheduler. Most of these
438 functions use the MSG functions defined in section \ref
441 \li <tt>masterslave.c</tt>: a C file with the main function, i.e.
442 the MSG initialization (MSG_init()), the platform
443 creation (e.g. with MSG_create_environment()), the
444 deployment phase (e.g. with MSG_function_register() and
445 MSG_launch_application()) and the call to
448 To compile such a program, we suggest to use the following
449 Makefile. It is a generic Makefile that we have used many times with
450 our students when we teach the C language.
454 masterslave: masterslave.o sched.o
456 INSTALL_PATH = $$HOME
458 PEDANTIC_PARANOID_FREAK = -O0 -Wshadow -Wcast-align \
459 -Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
460 -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
461 -Wmissing-noreturn -Wredundant-decls -Wnested-externs \
462 -Wpointer-arith -Wwrite-strings -finline-functions
463 REASONABLY_CAREFUL_DUDE = -Wall
464 NO_PRAYER_FOR_THE_WICKED = -w -O2
465 WARNINGS = $(REASONABLY_CAREFUL_DUDE)
466 CFLAGS = -g $(WARNINGS)
468 INCLUDES = -I$(INSTALL_PATH)/include
469 DEFS = -L$(INSTALL_PATH)/lib/
470 LDADD = -lm -lsimgrid
474 $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@
477 $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
480 rm -f $(BIN_FILES) *.o *~
486 The first two lines indicates what should be build when typing make
487 (<tt>masterslave</tt>) and of which files it is to be made of
488 (<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
489 that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
490 (look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
491 the static version, remove the <tt>-lsimgrid</tt> and add a
492 <tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
493 after the <tt>LIBS = </tt>.
495 More generally, if you have never written a Makefile by yourself, type
496 in a terminal : <tt>info make</tt> and read the introduction. The
497 previous example should be enough for a first try but you may want to
498 perform some more complex compilations...