\section faq_simgrid I'm new to SimGrid. I have some questions. Where should I start?
You are at the right place... Having a look to these
-<a href="http://www.loria.fr/~quinson/articles/simgrid-tutorial.pdf">the tutorial slides</a>
-(or to these <a href="http://graal.ens-lyon.fr/~alegrand/articles/slides_g5k_simul.pdf">old slides</a>,
-or to these
+<a href="http://www.loria.fr/~quinson/blog/2010/06/28/Tutorial_at_HPCS/">the slides of the HPCS'10 tutorial</a>
+(or to these <a href="http://graal.ens-lyon.fr/~alegrand/articles/slides_g5k_simul.pdf">ancient
+slides</a>, or to these
<a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">"obsolete" slides</a>)
may give you some insights on what SimGrid can help you to do and what
are its limitations. Then you definitely should read the \ref
fast forward [2006/05/13]. More languages are evaluated, but for now,
we do not feel a real demand for any other language. Please speak up!
-\section faq_cmake Installing the SimGrid library with Cmake (since V3.4)
-
-\subsection faq_intro Some generalitty
-
-\subsubsection faq_intro1 What is Cmake?
-
-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>.
-
-\subsubsection faq_intro2 Why cmake?
-
-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.
-
-\subsubsection faq_intro3 What cmake need?
-
-CMake needs some prerequists like :
-
-For Unix and MacOS:
- \li make
- \li perl and libpcre
- \li c, c++ and java compiler regards to developers
- \li ccmake for graphical used of CMake
- \li cmake <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
-
-For Windows :
- \li cmake 2.8.3 <a href="http://www.cmake.org/files/v2.8/cmake-2.8.3-win32-x86.exe">(download page)</a>
- \li Dev-c++ <a href="http://sourceforge.net/projects/dev-cpp/files/Binaries/Dev-C%2B%2B%204.9.9.2/devcpp-4.9.9.2_nomingw_setup.exe/download">(download page)</a>
- \li perl strawberry <a href="http://www.strawberryperl.com/download/5.12.2.0/strawberry-perl-5.12.2.0.msi">(download page)</a>
- \li pcre-7.0 <a href="http://sourceforge.net/projects/gnuwin32/files/pcre/7.0/pcre-7.0.exe/download">(download page)</a>
-
- \li Set environment variables.
-
-\verbatim
-CC to C:\Dev-Cpp\bin\gcc
-CXX to C:\Dev-Cpp\bin\g++
-INCLUDE to C:\Dev-Cpp\include
-LIB to C:\Dev-Cpp\lib
-PCRE_LIBRARY_PATH to C:\
-PATH to C:\Dev-Cpp\bin
-\endverbatim
-
-\subsubsection faq_cmakeoption1 Liste of options
-
-\verbatim
-"cmake -D[name]=[value] ... ./"
-
-[name] enable_gtnets [value] ON/OFF or TRUE/FALSE or 1/0
- enable_java ON/OFF or TRUE/FALSE or 1/0
- enable_lua ON/OFF or TRUE/FALSE or 1/0
- enable_ruby ON/OFF or TRUE/FALSE or 1/0
- enable_compile_optimizations ON/OFF or TRUE/FALSE or 1/0
- enable_compile_warnings ON/OFF or TRUE/FALSE or 1/0
- enable_smpi ON/OFF or TRUE/FALSE or 1/0
- enable_maintainer_mode ON/OFF or TRUE/FALSE or 1/0
- enable_supernovae ON/OFF or TRUE/FALSE or 1/0
- enable_tracing ON/OFF or TRUE/FALSE or 1/0
- enable_coverage ON/OFF or TRUE/FALSE or 1/0
- enable_memcheck ON/OFF or TRUE/FALSE or 1/0
- enable_model-checking ON/OFF or TRUE/FALSE or 1/0
- gtnets_path <path_to_gtnets_directory>
- CMAKE_INSTALL_PREFIX <path_to_install_directory>
- pipol_user <pipol_username>
-\endverbatim
-
-\subsubsection faq_cmakeoption2 Options explaination
-
- \li enable_gtnets : set to true implie that user wants to use gtnets.
-
- \li enable_java : set to true implie that user wants to add java langage into simgrid compilation.
-
- \li enable_lua : set to true implie that user wants to add lua langage into simgrid compilation.
-
- \li enable_ruby : set to true implie that user wants to add ruby langage into simgrid compilation.
-
- \li enable_compile_optimizations : add flags "-O3 -finline-functions -funroll-loops -fno-strict-aliasing"
-
- \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"
-
- \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.
-
- \li enable_maintainer_mode : set to true it remakes some files.
-
- \li enable_supernovae : set to true make one file for each lib and compile with those generated files.
-
- \li enable_tracing : To enable the generation of simulation traces for visualization
-
- \li enable_coverage : When set to true this option enable code coverage by setting -fprofile-arcs -ftest-coverage flags.
-
- \li enable_memcheck : When set to true this option enable tests for memcheck.
-
- \li enable_model-checking : Enable the model checking when set to true.
-
- \li gtnets_path : Path to gtnets install directory (ex /usr)
-
- \li CMAKE_INSTALL_PREFIX : Path where are installed lib/ doc/ and include/ directories (ex /usr/local)
-
- \li pipol_user : specify your pipol username if you want to use the pipol-remote command.
-
-\subsubsection faq_cmakeoption3 Initialisation
-
-Those options are initialized the first time you launch "cmake ." whithout specified option.
-
-\verbatim
-enable_gtnets on
-enable_lua on
-enable_ruby on
-enable_java on
-enable_smpi on
-enable_supernovae on
-enable_tracing on
-enable_compile_optimizations on
-enable_compile_warnings off
-enable_maintainer_mode off
-enable_coverage off
-enable_memcheck off
-enable_model-checking off
-CMAKE_INSTALL_PREFIX /usr/local
-gtnets_path null
-pipol_user null
-\endverbatim
-
-\subsubsection faq_cmakeoption4 Option's cache and how to reset?
-
-When options have been set they are keep into a cache file named "CMakeCache.txt". So if you want
-reset values you just delete this file located to the project directory.
-
-\subsection faq_cmakecompilation Cmake compilation
-
-\subsubsection faq_cmakecompilation1 With command line.
-
-\verbatim
-cmake -D[name]=[value] ... ./
-make
-\endverbatim
-
-\subsubsection faq_cmakecompilation2 With ccmake tool.
-
-\verbatim
-"ccmake ./"
-\endverbatim
-Then follow instructions.
-
-\subsubsection faq_cmakecompilation2bis Build out of source.
-
-As cmake generate many files used for compilation, we recommand to make a build directory.
-For examples you can make :
-
-\verbatim
-"navarrop@caraja:~/Developments$ cd simgrid/"
-"navarrop@caraja:~/Developments/simgrid$ mkdir build_directory"
-"navarrop@caraja:~/Developments/simgrid$ cd build_directory/"
-"navarrop@caraja:~/Developments/simgrid/build_directory$ cmake ../"
-"navarrop@caraja:~/Developments/simgrid/build_directory$ make"
-\endverbatim
-
-Or complety out of sources :
-
-\verbatim
-"navarrop@caraja:~/Developments$ mkdir build_dir"
-"navarrop@caraja:~/Developments$ cd build_dir/"
-"navarrop@caraja:~/Developments/build_dir$ cmake ../simgrid/"
-"navarrop@caraja:~/Developments/build_dir$ make"
-\endverbatim
-
-Those two kind of compilation permit to delete files created by compilation easier.
-
-\subsubsection faq_cmakecompilation3 Resume of command line
-
- \li CMake
-\verbatim
-cmake <path> configure the project
-make build all targets
-make VERBOSE=1 build all targets and print build command lines
-make check test all targets and summarize
-make dist make the distrib
-make distcheck check the dist (make + make dist + make check)
-make install install the project (doc/ bin/ lib/ include/)
-make uninstall uninstall the project (doc/ bin/ lib/ include/)
-make clean clean all targets
-make simgrid_documentation Create simgrid documentation
-\endverbatim
-
-When the project have been succesfully compiling and build you can make tests.
-
- \li CTest
-\verbatim
-ctest launch only tests
-ctest -D Continuous
-ctest -D Continuous(Start|Update|Configure|Build)
-ctest -D Continuous(Test|Coverage|MemCheck|Submit)
-ctest -D Experimental
-ctest -D Experimental(Start|Update|Configure|Build)
-ctest -D Experimental(Test|Coverage|MemCheck|Submit)
-ctest -D Nightly
-ctest -D Nightly(Start|Update|Configure|Build)
-ctest -D Nightly(Test|Coverage|MemCheck|Submit)
-ctest -D NightlyMemoryCheck
-\endverbatim
-
-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>.
-
-\subsection faq_cmakeinstall How to install with cmake?
-
-\subsubsection faq_cmakeinstall1 From svn.
-
-For Unix and MacOS:
-\verbatim
-cmake -Denable_maintainer_mode=on -DCMAKE_INSTALL_PREFIX=/home/navarrop/Bureau/install_simgrid ./
-make
-make install
-\endverbatim
-
-For Windows:
-
-\verbatim
-cmake -G"Unix Makefiles" -DCMAKE_INSTALL_PREFIX=C:\simgrid_install ./
-make
-make install
-\endverbatim
-
-\subsubsection faq_cmakeinstall2 From a distrib
-
-\verbatim
-For version 3.4.1 and 3.4
- cmake -Dprefix=/home/navarrop/Bureau/install_simgrid ./
- make
- make install-simgrid
-Since version 3.5
- cmake -DCMAKE_INSTALL_PREFIX=/home/navarrop/Bureau/install_simgrid ./
- make
- make install
-\endverbatim
-
-\subsection faq_cmakeWHATisInstall What is installed by cmake?
-
-\subsubsection faq_cmakeWHATisInstallBIN CMAKE_INSTALL_PREFIX/bin
-\verbatim
-tesh
-graphicator
-gras_stub_generator
-simgrid_update_xml
-simgrid-colorizer
-smpicc
-smpiff
-smpif2c
-smpirun
-\endverbatim
-\subsubsection faq_cmakeWHATisInstallDOC CMAKE_INSTALL_PREFIX/doc
-\verbatim
-simgrid/examples/
-simgrid/html/
-\endverbatim
-\subsubsection faq_cmakeWHATisInstallINCLUDE CMAKE_INSTALL_PREFIX/include
-\verbatim
-amok/
-gras/
-instr/
-mc/
-msg/
-simdag/
-simix/
-smpi/
-surf/
-xbt/
-gras.h
-simgrid_config.h
-xbt.h
-\endverbatim
-\subsubsection faq_cmakeWHATisInstallLIB CMAKE_INSTALL_PREFIX/lib
-\verbatim
-libgras.so.3.5
-libsimgrid.so.3.5
-libsmpi.so.3.5
-libsimgrid.so -> libsimgrid.so.3.5
-libgras.so -> libgras.so.3.5
-libsmpi.so -> libsmpi.so.3.5
-lua/5.1/simgrid.so -> ../../libsimgrid.so
-ruby/1.9.0/x86_64-linux/libsimgrid.so -> ../../../libsimgrid.so
-ruby/1.9.0/x86_64-linux/simgrid.rb
-\endverbatim
-\subsection faq_cmakehowto How to modified sources files for developers
-
-\subsubsection faq_cmakehowto1 Add an executable or examples.
-
-If you want make an executable you have to create a CMakeList.txt to the src directory.
-You must specified where to create the executable, source list, dependencies and the name of the binary.
-
-\verbatim
-cmake_minimum_required(VERSION 2.6)
-
-set(EXECUTABLE_OUTPUT_PATH "./")
-set(LIBRARY_OUTPUT_PATH "${CMAKE_HOME_DIRECTORY}/lib")
-
-add_executable(get_sender get_sender.c) #add_executable(<name_of_target> <src list>)
-
-### Add definitions for compile
-target_link_libraries(get_sender simgrid m pthread) #target_link_libraries(<name_of_targe> <dependencies>)
-\endverbatim
-
-Then you have to modified <project/directory>/buildtools/Cmake/MakeExeLib.cmake and add
-this line :
-\verbatim
-add_subdirectory(${CMAKE_HOME_DIRECTORY}/<path_where_is_CMakeList.txt>)
-\endverbatim
-
-\subsubsection faq_cmakehowto2 Delete/add sources to lib.
-
-If you want modified, add or delete source files from a library you have to edit <project/directory>/buildtools/Cmake/DefinePackages.cmake
-
-\verbatim
-set(JMSG_JAVA_SRC
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/MsgException.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/JniException.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/NativeException.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/HostNotFoundException.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/ProcessNotFoundException.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Msg.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Process.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Host.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Task.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/MsgNative.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/ApplicationHandler.java
- ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Sem.java
-)
-\endverbatim
-
-\subsubsection faq_cmakehowto3 Add test
-
-If you want modified, add or delete tests you have to edit <project/directory>/buildtools/Cmake/AddTests.cmake
-with this function : ADD_TEST(<name> <bin> <ARGS>)
-
-\verbatim
-add_test(test-simdag-1 ${CMAKE_HOME_DIRECTORY}/testsuite/simdag/sd_test --cfg=path:${CMAKE_HOME_DIRECTORY}/testsuite/simdag small_platform_variable.xml)
-\endverbatim
-
-\subsection faq_PIPOL Pipol-remote
-
-Now we offer the possibility to test your local sources on pipol platforms before a commit. Of course you have to be user of pipol <a href="https://pipol.inria.fr/users/">(Account request)</a> cause you need to give your pipol_username to cmake. Here is a list of available systems :
-\verbatim
- amd64_kvm-linux-debian-lenny
- amd64_kvm-linux-debian-testing
- amd64_kvm-windows-7
- amd64-linux-centos-5.dd.gz
- amd64-linux-debian-etch.dd.gz
- amd64-linux-debian-lenny.dd.gz
- amd64-linux-debian-testing.dd.gz
- amd64-linux-fedora-core10.dd.gz
- amd64-linux-fedora-core11.dd.gz
- amd64-linux-fedora-core12.dd.gz
- amd64-linux-fedora-core13.dd.gz
- amd64-linux-fedora-core7.dd.gz
- amd64-linux-fedora-core8.dd.gz
- amd64-linux-fedora-core9.dd.gz
- amd64-linux-mandriva-2007_springs_powerpack.dd.gz
- amd64-linux-mandriva-2009_powerpack.dd.gz
- amd64-linux-opensuse-11.dd.gz
- amd64-linux-redhatEL-5.0.dd.gz
- amd64-linux-suse-LES10.dd.gz
- amd64-linux-ubuntu-feisty.dd.gz
- amd64-linux-ubuntu-hardy.dd.gz
- amd64-linux-ubuntu-intrepid.dd.gz
- amd64-linux-ubuntu-jaunty.dd.gz
- amd64-linux-ubuntu-karmic.dd.gz
- amd64-linux-ubuntu-lucid.dd.gz
- amd64-unix-freebsd-7.dd.gz
- amd64-windows-server-2003-64bits.dd.gz
- amd64-windows-server-2008-64bits.dd.gz
- i386_kvm-linux-debian-lenny
- i386_kvm-linux-debian-testing
- i386_kvm-linux-fedora-core13
- i386_kvm-windows-xp-pro-sp3
- i386-linux-centos-5.dd.gz
- i386-linux-debian-etch.dd.gz
- i386-linux-debian-lenny.dd.gz
- i386-linux-debian-testing.dd.gz
- i386-linux-fedora-core10.dd.gz
- i386-linux-fedora-core11.dd.gz
- i386-linux-fedora-core12.dd.gz
- i386-linux-fedora-core13.dd.gz
- i386-linux-fedora-core7.dd.gz
- i386-linux-fedora-core8.dd.gz
- i386-linux-fedora-core9.dd.gz
- i386-linux-mandriva-2007_springs_powerpack.dd.gz
- i386-linux-mandriva-2009_powerpack.dd.gz
- i386-linux-opensuse-11.dd.gz
- i386-linux-redhatEL-5.0.dd.gz
- i386-linux-suse-LES10.dd.gz
- i386-linux-ubuntu-feisty.dd.gz
- i386-linux-ubuntu-hardy.dd.gz
- i386-linux-ubuntu-intrepid.dd.gz
- i386-linux-ubuntu-jaunty.dd.gz
- i386-linux-ubuntu-karmic.dd.gz
- i386-linux-ubuntu-lucid.dd.gz
- i386_mac-mac-osx-server-leopard.dd.gz
- i386-unix-freebsd-7.dd.gz
- i386-unix-opensolaris-10.dd.gz
- i386-unix-opensolaris-11.dd.gz
- i386-unix-solaris-10.dd.gz
- ia64-linux-debian-lenny.dd
- ia64-linux-fedora-core9.dd
- ia64-linux-redhatEL-5.0.dd
- x86_64_mac-mac-osx-server-snow-leopard.dd.gz
- x86_mac-mac-osx-server-snow-leopard.dd.gz
-\endverbatim
-
-Two kind of uses are possible :
-\verbatim
-This command copy your source and execute a configure then a build and finish with tests.
- bob@caraja:~/Developments/simgrid/tmp_build$ make <name_of_image>
-
-This command copy your source and execute a \"ctest -D Experimental\" and submit the result to cdash.
- bob@caraja:~/Developments/simgrid/tmp_build$ make <name_of_image>_experimental
-\endverbatim
-All commands are resumed with :
-\verbatim
-bob@caraja:~/Developments/simgrid/tmp_build$ make pipol_experimental_list_images
-bob@caraja:~/Developments/simgrid/tmp_build$ make pipol_test_list_images
-\endverbatim
-
-\section faq_installation Installing the SimGrid library with Autotools (valid until V3.3.4)
-
-Many people have been asking me questions on how to use SimGrid. Quite
-often, the questions were not really about SimGrid but on the
-installation process. This section is intended to help people that are
-not familiar with compiling C files under UNIX. If you follow these
-instructions and still have some troubles, drop an e-mail to
-<simgrid-user@lists.gforge.inria.fr>.
-
-\subsection faq_compiling Compiling SimGrid from a stable archive
-
-First of all, you need to download the latest version of SimGrid from
-<a href="http://gforge.inria.fr/frs/?group_id=12">here</a>.
-Suppose you have uncompressed SimGrid in some temporary location of
-your home directory (say <tt>/home/joe/tmp/simgrid-3.0.1 </tt>). The
-simplest way to use SimGrid is to install it in your home
-directory. Change your directory to
-<tt>/home/joe/tmp/simgrid-3.0.1</tt> and type
-
-\verbatim
-./configure --prefix=$HOME
-make
-make install
-\endverbatim
-
-If at some point, something fails, check the section \ref faq_trouble_compil .
-If it does not help, you can report this problem to the
-list but, please, avoid sending a laconic mail like "There is a problem. Is it
-okay?". Send the config.log file which is automatically generated by
-configure. Try to capture both the standard output and the error output of the
-<tt>make</tt> command with <tt>script</tt>. There is no way for us to help you
-without the relevant bits of information.
-
-Now, the following directory should have been created :
-
- \li <tt>/home/joe/doc/simgrid/html/</tt>
- \li <tt>/home/joe/lib/</tt>
- \li <tt>/home/joe/include/</tt>
-
-SimGrid is not a binary, it is a library. Both a static and a dynamic
-version are available. Here is what you can find if you try a <tt>ls
-/home/joe/lib</tt>:
-
-\verbatim libsimgrid.a libsimgrid.la libsimgrid.so libsimgrid.so.0 libsimgrid.so.0.0.1
-\endverbatim
-
-Thus, there is two ways to link your program with SimGrid:
- \li Either you use the static version, e.g
-\verbatim gcc libsimgrid.a -o MainProgram MainProgram.c
-\endverbatim
- In this case, all the SimGrid functions are directly
- included in <tt>MainProgram</tt> (hence a bigger binary).
- \li Either you use the dynamic version (the preferred method)
-\verbatim gcc -lsimgrid -o MainProgram MainProgram.c
-\endverbatim
- In this case, the SimGrid functions are not included in
- <tt>MainProgram</tt> and you need to set your environment
- variable in such a way that <tt>libsimgrid.so</tt> will be
- found at runtime. This can be done by adding the following
- line in your .bashrc (if you use bash and if you have
- installed the SimGrid libraries in your home directory):
-\verbatim export LD_LIBRARY_PATH=$HOME/lib/:$LD_LIBRARY_PATH
-\endverbatim
-
-\subsection faq_compiling_java Java bindings don't get compiled
-
-The configure script detects automatically whether you have the
-softwares needed to use the Java bindings or not. At the end of the
-configure, you can see the configuration picked by the script, which
-should look similar to
-\verbatim Configuration of package simgrid' (version 3.3.4-svn) on
-little64 (=4):
-
- Compiler: gcc (version: )
-
- CFlags: -O3 -finline-functions -funroll-loops -fno-strict-aliasing -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 -g3
- CPPFlags:
- LDFlags:
-
- Context backend: ucontext
- Compile Java: no
-
- Maintainer mode: no
- Supernovae mode: yes
-\endverbatim
-
-In this example, Java backends won't be compiled.
-
-On Debian-like systems (which includes ubuntu), you need the following
-packages: sun-java6-jdk libgcj10-dev. If you cannot find the
-libgcj10-dev, try another version, like libgcj9-dev (on Ubuntu before
-9.10) or libgcj11-dev (not released yet, but certainly one day).
-Please note that you need to activate the contrib and non-free
-repositories in Debian, and the universe ones in Ubuntu. Java comes at
-this price...
-
-\subsection faq_compiling_snapshoot SimGrid development snapshots
-
-We have very high standards on software quality, and we are reluctant releasing
-a stable release as long as there is still some known bug in the code base. In
-addition, we added quite an extensive test base, making sure that we correctly
-test the most important parts of the tool.
-
-As an unfortunate conclusion, there may be some time between the stable
-releases. If you want to benefit from the most recent features we introduced,
-but don't want to take the risk of an untested version from the SVN, then
-development snapshots are done for you.
-
-These are pre-releases of SimGrid that still fail some tests about features
-that almost nobody use, or on platforms not being in our core target (which is
-Linux, Mac, other Unixes and Windows, from the most important to the less
-one). That means that using this development releases should be safe for most
-users.
-
-These archives can be found on
-<a href="http://www.loria.fr/~quinson/simgrid.html">this web page</a>. Once you
-got the lastest archive, you can compile it just like any archive (see above).
-
-\subsection faq_compiling_svn Compiling SimGrid from the SVN
-
-The project development takes place in the SVN, where all changes are
-committed when they happen. Then every once in a while, we make sure that the
-code quality meets our standard and release an archive from the code in the
-SVN. We afterward go back to the development in the SVN. So, if you need a
-recently added feature and can afford some little problem with the stability
-of the lastest features, you may want to use the SVN version instead of a
-released one.
-
-For that, you first need to get the "simgrid" module from
-<a href="http://gforge.inria.fr/scm/?group_id=12">here</a>.
-
-You won't find any <tt>configure</tt> and a few other things
-(<tt>Makefile.in</tt>'s, documentation, ...) will be missing as well. The
-reason for that is that all these files have to be regenerated using the
-latest versions of <tt>autoconf</tt>, <tt>libtool</tt>, <tt>automake</tt>
-(>1.9) and <tt>doxygen</tt> (>1.4). To generate the <tt>configure</tt> and
-the <tt>Makefile.in</tt>'s, you just have to launch the <tt>bootstrap</tt>
-command that resides in the top of the source tree. Then just follow the
-instructions of Section \ref faq_compiling.
-
-We insist on the fact that you really need the latest versions of
-autoconf, automake and libtool. Doing this step on exotic architectures/systems
-(i.e. anything different from a recent linux distribution) may be
-... uncertain. If you need to compile the SVN version on a machine where all these
-dependencies are not met, the easiest is to do <tt>make dist</tt> in the SVN
-directory of another machine where all dependencies are met. It will create an
-archive you may deploy on other sites just as a regular stable release.
-
-In summary, the following commands will checkout the SVN, regenerate the
-configure script and friends, configure SimGrid and build it.
-
-\verbatim svn checkout svn://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk simgrid
-cd simgrid
-./bootstrap
-./configure --enable-maintainer-mode --prefix=<where to install SimGrid>
-make \endverbatim
-
-Then, if you want to install SimGrid on the current box, just do:
-\verbatim make install \endverbatim
-
-If you want to build an snapshot of the SVN to deploy it on another box (for
-example because the other machine don't have the autotools), do:
-\verbatim make dist \endverbatim
-
-Moreover, you should never call the autotools manually since you must run
-them in a specific order with specific arguments. Most of the times, the
-makefiles will automatically call the tools for you. When it's not possible
-(such as the first time you checkout the SVN), use the ./bootstrap command
-to call them explicitly.
-
-
-\subsection faq_setting_MSG Setting up your own MSG code
-
-Do not build your simulator by modifying the SimGrid examples. Go
-outside the SimGrid source tree and create your own working directory
-(say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
-
-Suppose your simulation has the following structure (remember it is
-just an example to illustrate a possible way to compile everything;
-feel free to organize it as you want).
-
- \li <tt>sched.h</tt>: a description of the core of the
- scheduler (i.e. which functions are can be used by the
- agents). For example we could find the following functions
- (master, forwarder, slave).
-
- \li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
- implementing the core of the scheduler. Most of these
- functions use the MSG functions defined in section \ref
- msg_gos_functions.
-
- \li <tt>masterslave.c</tt>: a C file with the main function, i.e.
- the MSG initialization (MSG_global_init()), the platform
- creation (e.g. with MSG_create_environment()), the
- deployment phase (e.g. with MSG_function_register() and
- MSG_launch_application()) and the call to
- MSG_main()).
-
-To compile such a program, we suggest to use the following
-Makefile. It is a generic Makefile that we have used many times with
-our students when we teach the C language.
-
-\verbatim
-all: masterslave
-masterslave: masterslave.o sched.o
-
-INSTALL_PATH = $$HOME
-CC = gcc
-PEDANTIC_PARANOID_FREAK = -O0 -Wshadow -Wcast-align \
- -Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
- -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
- -Wmissing-noreturn -Wredundant-decls -Wnested-externs \
- -Wpointer-arith -Wwrite-strings -finline-functions
-REASONABLY_CAREFUL_DUDE = -Wall
-NO_PRAYER_FOR_THE_WICKED = -w -O2
-WARNINGS = $(REASONABLY_CAREFUL_DUDE)
-CFLAGS = -g $(WARNINGS)
-
-INCLUDES = -I$(INSTALL_PATH)/include
-DEFS = -L$(INSTALL_PATH)/lib/
-LDADD = -lm -lsimgrid
-LIBS =
-
-%: %.o
- $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@
-
-%.o: %.c
- $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
-
-clean:
- rm -f $(BIN_FILES) *.o *~
-.SUFFIXES:
-.PHONY : clean
-
-\endverbatim
-
-The first two lines indicates what should be build when typing make
-(<tt>masterslave</tt>) and of which files it is to be made of
-(<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
-that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
-(look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
-the static version, remove the <tt>-lsimgrid</tt> and add a
-<tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
-after the <tt>LIBS = </tt>.
-
-More generally, if you have never written a Makefile by yourself, type
-in a terminal : <tt>info make</tt> and read the introduction. The
-previous example should be enough for a first try but you may want to
-perform some more complex compilations...
-
-\subsection faq_setting_GRAS Setting up your own GRAS code
-
-If you use the GRAS interface instead of the MSG one, then previous section
-is not the better source of information. Instead, you should check the GRAS
-tutorial in general, and the \ref GRAS_tut_tour_setup in particular.
-
\section faq_howto Feature related questions
\subsection faq_MIA "Could you please add (your favorite feature here) to SimGrid?"
calloc(1,sizeof(double)));
*((double*) task->data) = MSG_get_clock();
MSG_task_put(task, slaves[i % slaves_count], PORT_22);
- INFO0("Send completed");
+ XBT_INFO("Send completed");
return 0;
}
int receiver()
time2 = MSG_get_clock();
if(time1<*((double *)task->data))
time1 = *((double *) task->data);
- INFO1("Communication time : \"%f\" ", time2-time1);
+ XBT_INFO("Communication time : \"%f\" ", time2-time1);
free(task->data);
MSG_task_destroy(task);
return 0;
/* Parse the file */
surf_parse_open(file);
- xbt_assert1((!surf_parse()), "Parse error in %s", file);
+ xbt_assert(!surf_parse(), "Parse error in %s", file);
surf_parse_close();
\endverbatim
- <b>Enable GTNetS support in SimGrid</b>
-In order to enable gtnets with simgrid you have to give where is gtnets. (path to <gtnets_path>/lib and <gtnets_path>/include)
+In order to enable gtnets with simgrid you have to give where is gtnets. (path to \<gtnets_path\>/lib and \<gtnets_path\>/include)
\verbatim
Since v3.4 (with cmake)
server2, or request tasks, computation tasks, communication tasks).
All resource utilization (host power and link bandwidth) will be
classified according to the task category. Tasks that do not belong to a
-category are not traced.
+category are not traced. The color for the category that is being declared
+is random (use next function to specify a color).
+
+\li <b>\c TRACE_category_with_color (const char *category, const char *color)</b>: Same
+as TRACE_category, but let user specify a color encoded as a RGB-like string with
+three floats from 0 to 1. So, to specify a red color, the user can pass "1 0 0" as
+color parameter. A light-gray color can be specified using "0.7 0.7 0.7" as color.
\li <b>\c TRACE_msg_set_task_category (m_task_t task, const char *category)</b>:
This function should be called after the creation of a MSG task, to define the
\c category must contain a category that was previously defined by the function
\c TRACE_category.
-\li <b>\c TRACE_host_variable_declare (const char *variable)</b>:
-Declare a user variable that will be associated to hosts. A variable can
+\li <b>\c TRACE_[host|link]_variable_declare (const char *variable)</b>:
+Declare a user variable that will be associated to host/link. A variable can
be used to trace user variables such as the number of tasks in a server,
-the number of clients in an application, and so on.
-
-\li <b>\c TRACE_host_variable_[set|add|sub] (const char *variable, double
-value)</b>:
-Set the value of a given user variable. It is important to remind that
-the value of this variable is always associated to the host. The host
-that will be used when these functions are called is the one returned by
-the function \c MSG_host_self().
+the number of clients in an application (for hosts), and so on.
+
+\li <b>\c TRACE_[host|link]_variable_[set|add|sub] (const char *[host|link], const char *variable, double value)</b>:
+Set the value of a given user variable for a given host/link. The value
+of this variable is always associated to the host/link. The host/link
+parameters should be its name as the one listed in the platform file.
+
+\li <b>\c TRACE_[host|link]_variable_[set|add|sub]_with_time (double time, const char *[host|link], const char *variable, double value)</b>:
+Same as TRACE_[host|link]_variable_[set|add|sub], but let user specify
+the time used to trace it. Users can specify a time that is not the
+simulated clock time as defined by the core simulator. This allows
+a fine-grain control of time definition, but should be used with
+caution since the trace can be inconsistent if resource utilization
+traces are also traced.
+
+\li <b>\c TRACE_link_srcdst_variable_[set|add|sub] (const char *src, const char *dst, const char *variable, double value)</b>:
+Same as TRACE_link_variable_[set|add|sub], but now users specify a source and
+destination hosts (as the names from the platform file). The tracing library
+will get the corresponding route that connects those two hosts (src and dst) and
+[set|add|sub] the value's variable for all the links of the route.
+
+\li <b>\c TRACE_link_srcdst_variable_[set|add|sub]_with_time (double time, const char *src, const char *dst, const char *variable, double value)</b>:
+Same as TRACE_link_srcdst_variable_[set|add|sub], but user specify a time different from the simulated time.
\subsubsection faq_tracing_options Tracing configuration Options
\li <b>\c
tracing
</b>:
- It activates the tracing system and register the simulation platform
- in the trace file. You have to enable this option to others take effect.
+ Safe switch. It activates (or deactivates) the tracing system.
+ No other tracing options take effect if this one is not activated.
+
+\li <b>\c
+tracing/platform
+</b>:
+ Register the simulation platform in the trace file.
+
+\li <b>\c
+tracing/onelink_only
+</b>:
+ By default, the tracing system uses all routes in the platform file
+ to re-create a "graph" of the platform and register it in the trace file.
+ This option let the user tell the tracing system to use only the routes
+ that are composed with just one link.
\li <b>\c
tracing/categorized
this simulator do not use tracing categories and resource use have to be
traced.
-\li <b>\c
-tracing/platform/method
-</b>:
- It changes the way resource utilization (categorized or not) is traced
- inside the simulation core. Method 'a' (default) traces all updates defined
- by the CPU/network model of a given resource. Depending on the interface used
- by this simulator (MSG, SMPI, SimDAG), the default method can generate large
- trace files. Method 'b' tries to make smaller tracefiles using clever updates,
- without losing details of resource utilization. Method 'c' generates even
- smaller files by doing time integration during the simulation, but it loses
- precision. If this last method is used, the smallest timeslice used in the
- tracefile analysis must be bigger than the smaller resource utilization. If
- unsure, do not change this option.
-
\li <b>\c
tracing/filename
</b>:
behavior of all categorized MSG processes, grouping them by hosts. This option
can be used to track process location if this simulator has process migration.
+
\li <b>\c
-tracing/msg/volume
+triva/categorized:graph_categorized.plist
</b>:
- This experimental option only has effect if this simulator is MSG-based.
- It traces the communication volume of MSG send/receive.
+ This option generates a graph configuration file for Triva considering
+ categorized resource utilization.
+
+\li <b>\c
+triva/uncategorized:graph_uncategorized.plist
+</b>:
+ This option generates a graph configuration file for Triva considering
+ uncategorized resource utilization.
\subsubsection faq_tracing_example Example of Instrumentation
{
MSG_global_init (&argc, &argv);
- //note that TRACE_start must be called after MSG_global_init
+ //(... after deployment ...)
+
+ //note that category declaration must be called after MSG_create_environment
TRACE_category_with_color ("request", "1 0 0");
TRACE_category_with_color ("computation", "0.3 1 0.4");
TRACE_category ("finalize");
- //(... after deployment ...)
-
m_task_t req1 = MSG_task_create("1st_request_task", 10, 10, NULL);
m_task_t req2 = MSG_task_create("2nd_request_task", 10, 10, NULL);
m_task_t req3 = MSG_task_create("3rd_request_task", 10, 10, NULL);
void MC_assert(int prop);
\endverbatim
-\subsection faq_binding_lua Lua Binding
-Most of Simgrid modules require a good level in C programming, since simgrid is used to be as standard C library.
- Sometime users prefer using some kind of « easy scripts » or a language easier to code with, for their works,
- which avoid dealing with C errors, and sometime an important gain of time.
-Besides Java Binding, Lua and Ruby bindings are available since version 3.4 of Simgrid
-for MSG Module, and we are currenlty working on bindings for other modules.
-
-
-\subsubsection faq_binding_lua_about What is lua ?
-Lua is a lightweight, reflective, imperative and functional programming language,
- designed as a scripting language with extensible semantics as a primary goal (see official web site <a href="http://www.lua.org">here</a>).
-\subsubsection faq_binding_lua_why Why lua ?
-Lua is a fast, portable and powerful script language, quite simple to use for developpers.
-it combines procedural features with powerful data description facilities,
- by using a simple, yet powerful, mechanism of tables.
-Lua has a relatively simple C API compared to other scripting languages,
-and accordingly it provides a robust, easy to use it.
-\subsubsection faq_binding_lua_simgrid How to use lua in Simgrid ?
-Actually, the use of lua in Simgrid is quite simple, you have just to follow the same steps as coding with C in Simgird :
- - Coding functions coresponding to each process
- - loading the platforme/deployment XML file that describe the environment of simulation
- - and … Running the Simulation.
-
-\dontinclude lua/master_slave.lua
-\subsubsection faq_binding_lua_example_master_slave Master/Slave Example
-
- \li Master Code
- \until end_of_master
-we mainly use simgrid.Task.new(task_name,computation_size,communication_size) to create our MSG Task,
- then simgrid.Task.send(task,alias) to send it.
-we use also simgrid.Task.name(task), to get the task's name.
-
-\li Slave Code
-\until end_of_slave
-Here, we see the use of simgrid.Task.recv(alias) to receive a task with a specific alias,
-this function return directly the task recevied.
-
-\li Set Environmenet and run application
-\until simgrid.clean()
-
-\subsubsection faq_binding_lua_example_data Exchanging Data
-You can also exchange data between Process using lua. for that, you have to deal with lua task as a table,
-since lua is based itself on a mechanism of tables,
-so you can exchange any kind of data (tables, matrix, strings,…) between process via tasks.
-
-\li Sender process
-\verbatim
- task = simgrid.Task.new("data_task",task_comp,task_comm);
- task['matrix'] = my_matrix;
- task['table'] = my_table;
- task['message'] = "Hello from (Lua || Simgrid ) !! "
- …
- simgrid.Task.send(task,alias)
-\endverbatim
- After creating task, we associate to it various kind of data with a specific key (string in this case)
- to distinguish between data variables. The receiver will use this key to access easily to datas.
-
-
-\li Receiver processe
-\verbatim
- task = simgrid.Task.recv(alias);
- sender_matrix = task['matrix'];
- sender_table = task['table'];
- sender_message = task['message']
- ...
-\endverbatim
- Note that in lua, both sender and receiver share the same lua task.
- So that the receiver could joint data directly on the received task without sending it back.
- You can find a complet example (matrix multiplication case) in the file example/lua/mult_matrix.lua.
-
-
-\subsubsection faq_binding_lua_example_bypass Bypass XML
- maybe you wonder if there is a way to bypass the XML files,
- and describe your platform directly from the code, with lua bindings it's Possible !! how ?
- We provide some additional (tricky?) functions in lua that allows you to set up your own platform without using the XML files
- ( this can be useful for large platforms, so a simple for loop will avoid you to deal with an annoying XML File ;) )
-
-
-\li set Routing mode
-\verbatim
- simgrid.AS.new{id="AS0",mode="Full"};
-\endverbatim
-
-\li set Hosts
-\verbatim
- simgrid.Host.new{id="Tremblay",power=98095000};
- simgrid.Host.new{id="Jupiter",power=76296000};
- simgrid.Host.new{id="Fafard",power=76296000};
- simgrid.Host.new{id="Ginette",power=48492000};
- simgrid.Host.new{id="Bourassa",power=48492000};
-\endverbatim
- we use simgrid.Host.new{id=id_host,power=power_host} to instanciate our hosts.
-
-\li set Links
-\verbatim
- for i=0,11 do
- simgrid.Link.new{id=i,bandwidth=252750+ i*768,latency=0.000270544+i*0.087}; -- some crazy values ;)
- end
-\endverbatim
- we used simgrid.Link.new{id=link_id,bandwidth=bw,latency=lat} with a simple for loop to create all links we need (much easier than XML hein ?)
-
-\li set Routes
-\verbatim
--- simgrid.Route.new(src_id,des_id,links_nb,links_list)
- simgrid.Route.new("Tremblay","Jupiter",1,{"1"});
- simgrid.Route.new("Tremblay","Fafard",6,{"0","1","2","3","4","8"});
- simgrid.Route.new("Tremblay","Ginette",3,{"3","4","5"});
- simgrid.Route.new("Tremblay","Bourassa",7,{"0","1","3","2","4","6","7"});
-
- simgrid.Route.new("Jupiter","Tremblay",1,{"1"});
- simgrid.Route.new("Jupiter","Fafard",7,{"0","1","2","3","4","8","9"});
- simgrid.Route.new("Jupiter","Ginette",4,{"3","4","5","9"});
- simgrid.Route.new("Jupiter","Bourassa",8,{"0","1","2","3","4","6","7","9"});
- ...
-\endverbatim
- for each host you have to specify which route to choose to access to the rest of hosts connected in the grid.
-
-\li Save platform
-\verbatim
- simgrid.register_platform();
-\endverbatim
-Don't forget to register your platform, that SURF callbacks starts their work ;)
-
-\li set application
-\verbatim
- simgrid.Host.setFunction("Tremblay","Master",4,{"20","550000000","1000000","4"});
- simgrid.Host.setFunction("Bourassa","Slave",1,{"0"});
- simgrid.Host.setFunction("Jupiter","Slave",1,{"1"});
- simgrid.Host.setFunction("Fafard","Slave",1,{"2"});
- simgrid.Host.setFunction("Ginette","Slave",1,{"3"});
-\endverbatim
- you don't need to use a deployment XML file, thanks to simgrid.Host.setFunction(host_id,function,args_number,args_list)
- you can associate functions for each host with arguments if needed .
-
-\li
-\verbatim
- simgrid.register_application();
-\endverbatim
-Yes, Here too you have to resgiter your application before running the simulation.
-
-the full example is distributed in the file examples/lua/master_slave_bypass.lua
-
-\subsection faq_binding_ruby Ruby Binding
-
-
-\subsubsection faq_binding_ruby_simgrid Use Ruby in Simgrid
-Since v3.4, the use of <a href="http://ruby-lang.org">ruby</a> in simgrid is available for the MSG Module.
-you can find almost all MSG functionalities in Ruby code, that allows you to set up your environment, manage tasks between hosts and run the simulation.
-
-\dontinclude ruby/MasterSlave.rb
-\subsubsection faq_binding_ruby_example Master/Slave Ruby Application
-for each process method(master and slave in this example), you have to associate a ruby class, that should inherit from <i>MSG::Process</i> ruby class,
- with a 'main' function that describe the behaviour of the process during the simulation.
-\li required stuff
-\verbatim
-require 'simgrid'
-include MSG
-\endverbatim
-
-\li Master code
-\until end_of_master
-
-the class MSG::Task contains methods that allows the management of the native MSG tasks.
-in master ruby code we used :
- - <i>MSG::Task.new(task_name,compute_size,communication_size)</i> : to instanciate a new task.
- - <i>MSG::Task.send(mailbox)</i> : to send the task via a mailbox alias.
- - <i>MSG::Task.name</i> : to get the task's name.
-
-\li Slave code
-\until end_of_slave
-to receive a task, we use the method <i>MSG::Task.receive(mailbox)</i> that return a MSG:Task object (received task).
-
-\li Main chunk
-\until MSG.exit
-
-- <i>MSG.createEnvironment(platform_file)</i> : set up the environment
-- <i>MSG.deployApplication(deployment_file)</i> : load the deployment file description.
-- <i>MSG.run</i> : run the simulation
-
-\subsubsection faq_binding_ruby_data Exchanging data
-ruby bindings provides two ways to exchange data between ruby processes.
-\li MSG::Task.join & MSG::Task.data \br
-
- the MSG::Task class contains 2 methods that allows a data exchange between 2 process.
-
- -<i>MSG::Task.join</i> : makes possible to join any kind of ruby data within a task.
- \verbatim
- ...
- myTable = Array.new
- myTable <<1<<-2<<45<<67<<87<<76<<89<<56<<78<<3<<-4<<99
- # Creates and send Task With the Table inside
- task = MSG::Task.new("quicksort_task",taskComputeSize, taskCommunicationSize);
- task.join(myTable);
- ...
- task.send(mailbox);
- \endverbatim
- -<i>MSG::Task.data</i> : to access to the data contained into the task.
- \verbatim
- ...
- task = MSG::Task.receive(recv_mailbox.to_s)
- table = task.data
- quicksort(table,0,table.size-1)
- ...
- \endverbatim
-you can find a complet example illustrating the use of those methods in file /example/ruby/Quicksort.rb
-
-\li inheritence
-
- another 'object-oriented' way to do it, is to make your own 'task' class that inherit from MSG::Task ,
- and contains data you want to deal with, the only 'tricky' thing is that "the initializer" method has no effect !
-
- the use of some getter/setter methods would be the simple way to manage your data :)
- \verbatim
-class PingPongTask < MSG::Task
- # The initialize method has no effect
- @time
- def setTime(t)
- @time = t
- end
- def getTime()
- return @time
- end
-end
- \endverbatim
- you can find an example of use in file example/ruby/PingPong.rb
-
\section faq_troubleshooting Troubleshooting
\subsection faq_trouble_lib_compil SimGrid compilation and installation problems
-\subsubsection faq_trouble_lib_config ./configure fails!
+\subsubsection faq_trouble_lib_config cmake fails!
We know only one reason for the configure to fail:
- <b>You are using a broken build environment</b>\n
- If symptom is that configure complains about gcc not being able to build
+ If symptom is that the configury magic complains about gcc not being able to build
executables, you are probably missing the libc6-dev package. Damn Ubuntu.
If you experience other kind of issue, please get in touch with us. We are
always interested in improving our portability to new systems.
-\subsubsection faq_trouble_distcheck Dude! "make check" fails on my machine!
+\subsubsection faq_trouble_distcheck Dude! "ctest" fails on my machine!
Don't assume we never run this target, because we do. Check
-http://bob.loria.fr:8010 if you don't believe us.
-
-There is several reasons which may cause the make check to fail on your
-machine:
-
- - <b>You are using a broken libc (probably concerning the contextes)</b>.\n
- The symptom is that the "make check" fails within the examples/msg directory.\n
- By default, SimGrid uses something called ucontexts. This is part of the
- libc, but it's quite undertested. For example, some (old) versions of the
- glibc on alpha do not implement these functions, but provide the stubs
- (which return ENOSYS: not implemented). It may fool our detection mechanism
- and leads to segfaults. There is not much we can do to fix the bug.
- A workaround is to compile with --with-context=pthread to avoid
- ucontext completely. You'll be a bit more limited in the number
- of simulated processes you can start concurrently, but 5000
- processes is still enough for most purposes, isn't it?\n
- This limitation is the reason why we insist on using this piece of ...
- software even if it's so troublesome.\n
- <b>=> use --with-pthread on AMD64 architecture that do not have an
- ultra-recent libc.</b>
-
- - <b>There is a bug in SimGrid we aren't aware of</b>.\n
- If none of the above apply, please drop us a mail on the mailing list so
- that we can check it out. Make sure to read \ref faq_bugrepport
- before you do so.
+http://cdash.inria.fr/CDash/index.php?project=Simgrid (click on
+previous if there is no result for today: results are produced only by
+11am, French time) and
+https://buildd.debian.org/status/logs.php?pkg=simgrid if you don't believe us.
+
+If it's failing on your machine in a way not experienced by the
+autobuilders above, please drop us a mail on the mailing list so that
+we can check it out. Make sure to read \ref faq_bugrepport before you
+do so.
\subsection faq_trouble_compil User code compilation problems
