\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 <a href="http://www.cmake.org/cmake/resources/software.html">(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>
+
\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_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_memcheck ON/OFF or TRUE/FALSE or 1/0
enable_model-checking ON/OFF or TRUE/FALSE or 1/0
- enable_doc ON/OFF or TRUE/FALSE or 1/0
+ enable_debug ON/OFF or TRUE/FALSE or 1/0
+ enable_jedule ON/OFF or TRUE/FALSE or 1/0
+ enable_latency_bound_tracking ON/OFF or TRUE/FALSE or 1/0
+ enable_lib_static ON/OFF or TRUE/FALSE or 1/0
+ enable_pcre ON/OFF or TRUE/FALSE or 1/0
+ custom_flags <flags>
gtnets_path <path_to_gtnets_directory>
- prefix <path_to_install_directory>
- BIBTEX2HTML <path_to_bibtex2html>
- with_context auto/ucontext/pthread/window
- pipol_user <pipol_username>
+ 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_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_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 enable_debug : If enable_debug is set to 'off' Simgrid compil flag has '-DNDEBUG' option.
+
+ \li enable_jedule : To enable jedule mode, which creates visualizations of task schedules with Simdag.
+
+ \li enable_latency_bound_tracking : Set to on if you want to be warned when communications are limited by round trip time.
- \li enable_doc : Generate the documentation for simgrid with make command. (You can also make the doc manually with command : make html)
+ \li enable_lib_static : Enable generated Simgrid and smpi static libraries.
+
+ \li enable_pcre : Use or not the pcre lib for memory optimization.
+
+ \li custom_flags : If user wants to use a specific flag during compilation, give here.
\li gtnets_path : Path to gtnets install directory (ex /usr)
- \li prefix : Path where are installed lib/ doc/ and include/ directories (ex /usr/local)
-
- \li BIBTEX2HTML : Path where is installed bibtex2html.
-
- \li with context : specify which context the user wants to use.
+ \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.
\verbatim
enable_gtnets on
enable_lua on
-enable_ruby on
-enable_java off
-enable_compile_optimizations off
-enable_compile_warnings off
enable_smpi on
+enable_supernovae on
+enable_tracing on
+enable_compile_optimizations on
+enable_debug on
+enable_pcre on
+enable_compile_warnings off
enable_maintainer_mode off
-enable_supernovae off
-enable_tracing off
enable_coverage off
enable_memcheck off
enable_model-checking off
-enable_doc off
-
+enable_jedule off
+enable_latency_bound_tracking off
+enable_lib_static off
+CMAKE_INSTALL_PREFIX /usr/local
+custom_flags null
gtnets_path null
-prefix null
-BIBTEX2HTML null
-with_context auto
pipol_user null
\endverbatim
make
\endverbatim
+On Windows
+
+\verbatim
+cmake -G"Unix Makefiles" -D[name]=[value] ... ./
+gmake
+\endverbatim
+
\subsubsection faq_cmakecompilation2 With ccmake tool.
\verbatim
\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/ lib/ include/)
-make uninstall uninstall the project (doc/ lib/ include/)
-make clean clean all targets
-make java-clean clean files created by java option
-make doc-clean clean files created for making doc
-make supernovae-clean clean supernovae files
-make maintainer-clean clean maintainer files
-make all-clean execute the 5 upper clean command
-make html Create simgrid documentation
+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.
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>.
-\subsubsection faq_cmakecompilation5 Examples for different mode.
-
-\li Mode maintainer
-
-cmake -Denable_maintainer_mode=on ./
-\verbatim
--- lookign for config.h
-with_context auto change to ucontext
-GIT_DATE : 2010-05-04~09-59-15
-GIT_VERSION : 53ec816
-GIT_SVN_VERSION : 7669
-
-Configuration of package `simgrid' (revision 7669) on arch (=4):
- BUILDNAME : UCONTEXT
- SITE : Linux_2.6.31-21-generic_x86_64
- Release : simgrid-3.4~rev7669
-
- Compiler: c++ : /usr/bin/c++
- version: c++ (Ubuntu 4.4.1-4ubuntu9) 4.4.1
- Compiler: c : /usr/bin/gcc
- version: gcc (Ubuntu 4.4.1-4ubuntu9) 4.4.1
-
- CFlags : -I/usr/lib/ruby/1.8/x86_64-linux -I/usr/include/lua5.1 -g3
- CPPFlags:
- LDFlags : -L/usr/lib/
-
- Context backend: ucontext
- Compile Gtnets : 0
- Gtnets path :
- Compile Java : 0
- Compile Lua : 1
- Compile Ruby : 1
-
- Compile Smpi : ON
- Maintainer mode: ON
- Supernovae mode: OFF
- Tracing mode : OFF
-
- Simgrid dependencies: -lm -lruby1.8 -module -ldl -llua5.1 -lrt
- Gras dependencies : -lm -lpthread -lrt
- Smpi dependencies :
-
- INSTALL_PREFIX: /usr/local
-
--- Configuring done
--- Generating done
--- Build files have been written to: /home/navarrop/Developments/simgrid
-\endverbatim
-
-\li Mode supernovae
-
-cmake -Dsupernovae=on ./
-\verbatim
--- lookign for config.h
-with_context auto change to ucontext
-GIT_DATE : 2010-05-04~09-59-15
-GIT_VERSION : 53ec816
-GIT_SVN_VERSION : 7669
-
-Configuration of package `simgrid' (revision 7669) on arch (=4):
- BUILDNAME : SUPERNOVAE
- SITE : Linux_2.6.31-21-generic_x86_64
- Release : simgrid-3.4~rev7669
-
- Compiler: c++ : /usr/bin/c++
- version: c++ (Ubuntu 4.4.1-4ubuntu9) 4.4.1
- Compiler: c : /usr/bin/gcc
- version: gcc (Ubuntu 4.4.1-4ubuntu9) 4.4.1
-
- 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 -I/usr/lib/ruby/1.8/x86_64-linux -I/usr/include/lua5.1 -g3
- CPPFlags:
- LDFlags : -L/usr/lib/
-
- Context backend: ucontext
- Compile Gtnets : 0
- Gtnets path :
- Compile Java : 0
- Compile Lua : 1
- Compile Ruby : 1
-
- Compile Smpi : ON
- Maintainer mode: OFF
- Supernovae mode: OFF
- Tracing mode : OFF
-
- Simgrid dependencies: -lm -lruby1.8 -module -ldl -llua5.1 -lrt
- Gras dependencies : -lm -lpthread -lrt
- Smpi dependencies :
-
- INSTALL_PREFIX: /usr/local
-
--- Configuring done
--- Generating done
--- Build files have been written to: /home/navarrop/Developments/simgrid
-
-\endverbatim
-
-\li Mode GTnetS
-
-cmake -Dgtnets_path=/home/navarrop/Bureau/usr/ ./
-\verbatim
--- lookign for config.h
-with_context auto change to ucontext
-GIT_DATE : 2010-05-04~09-59-15
-GIT_VERSION : 53ec816
-GIT_SVN_VERSION : 7669
-
-Configuration of package `simgrid' (revision 7669) on arch (=4):
- BUILDNAME : GTNETS
- SITE : Linux_2.6.31-21-generic_x86_64
- Release : simgrid-3.4~rev7669
-
- Compiler: c++ : /usr/bin/c++
- version: c++ (Ubuntu 4.4.1-4ubuntu9) 4.4.1
- Compiler: c : /usr/bin/gcc
- version: gcc (Ubuntu 4.4.1-4ubuntu9) 4.4.1
-
- 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 -I/usr/lib/ruby/1.8/x86_64-linux -L/usr/lib -I/usr/include/gtnets -I/usr/include/lua5.1 -g3
- CPPFlags: -L/usr/lib -I/usr/include/gtnets
- LDFlags : -L/usr/lib/
-
- Context backend: ucontext
- Compile Gtnets : 1
- Gtnets path : /usr
- Compile Java : 0
- Compile Lua : 1
- Compile Ruby : 1
-
- Compile Smpi : ON
- Maintainer mode: OFF
- Supernovae mode: OFF
- Tracing mode : OFF
-
- Simgrid dependencies: -lm -lruby1.8 -module -ldl -llua5.1 -lgtnets -lrt
- Gras dependencies : -lm -lpthread -lrt
- Smpi dependencies :
-
- INSTALL_PREFIX: /usr/local
-
--- Configuring done
--- Generating done
--- Build files have been written to: /home/navarrop/Developments/simgrid
-
-\endverbatim
-
\subsection faq_cmakeinstall How to install with cmake?
\subsubsection faq_cmakeinstall1 From svn.
+For Unix and MacOS:
\verbatim
-cmake -Denable_maintainer_mode=on -Dprefix=/home/navarrop/Bureau/install_simgrid ./
+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 ./
+gmake
+gmake install
+\endverbatim
+
\subsubsection faq_cmakeinstall2 From a distrib
\verbatim
make
make install-simgrid
Since version 3.5
- cmake -Dprefix=/home/navarrop/Bureau/install_simgrid ./
+ 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.
bob@caraja:~/Developments/simgrid/tmp_build$ make pipol_test_list_images
\endverbatim
-\subsection faq_cmakeExplain Explaination of sources files for cmake
-
-\li CMakeLists.txt
-
-Those files are the "main parts". One located at the project directory call all the cmake sources files. The others
-are little projects called by the first for make examples.
-
-\li CompleteInFiles.cmake
-
-Complete all .in files and define Variables for h files
-
-\li GenerateDoc.cmake
-
-This file make the html documentation.
-
-\li MakeExeLib.cmake
-
-Here are callled all "CMakeLists.txt" for make executables and libraries.
-
-\li PrintArgs.cmake
-
-This file is called at the end of the build for summarize environment variables.
-
-\li DefinePackages.cmake
-
-Here is defined sources packages for compiling libs.
-
-\li Flags.cmake
-
-Defined flags which are used for compiling sources.
-
-\li Supernovae.cmake
-
-Here are made files for the supernovae mode.
-
-\li Distrib.cmake
-
-Here is defined packages for install simgrid and make a distribution.
-
-\li MaintainerMode.cmake
-
-Part where are generated source files for maintainer mode.
-
-\li Option.cmake
-
-Here are defined options and initialized values.
-
-\li AddTests.cmake
-
-All tests are listed.
-
-\li CTestConfig.cmake
-
-Properties which link tests with dashboard.
-
-\subsection faq_cmakeList List of files added for cmake
-
-Here is a list of files involved into cmake build (relative to project directory path) :
-\verbatim
-
-Cmake sources:
- ./doc/CMakeLists.txt
- ./buildtools/Cmake/AddTests.cmake
- ./buildtools/Cmake/CompleteInFiles.cmake
- ./buildtools/Cmake/CTestConfig.cmake
- ./buildtools/Cmake/DefinePackages.cmake
- ./buildtools/Cmake/Distrib.cmake
- ./buildtools/Cmake/Flags.cmake
- ./buildtools/Cmake/GenerateDocs.cmake
- ./buildtools/Cmake/MaintainerMode.cmake
- ./buildtools/Cmake/MakeExeLib.cmake
- ./buildtools/Cmake/MakeExeLibWin.cmake
- ./buildtools/Cmake/MakeJava.cmake
- ./buildtools/Cmake/Option.cmake
- ./buildtools/Cmake/PrintArgs.cmake
- ./buildtools/Cmake/Supernovae.cmake
-
-CMakeLists for each binaries or examples:
- ./CMakeLists.txt
- ./src/CMakeLists.txt
- ./teshsuite/gras/empty_main/CMakeLists.txt
- ./teshsuite/gras/small_sleep/CMakeLists.txt
- ./teshsuite/gras/datadesc/CMakeLists.txt
- ./teshsuite/gras/msg_handle/CMakeLists.txt
- ./teshsuite/simdag/CMakeLists.txt
- ./teshsuite/simdag/partask/CMakeLists.txt
- ./teshsuite/simdag/platforms/CMakeLists.txt
- ./teshsuite/simdag/network/CMakeLists.txt
- ./teshsuite/simdag/network/mxn/CMakeLists.txt
- ./teshsuite/simdag/network/p2p/CMakeLists.txt
- ./teshsuite/xbt/CMakeLists.txt
- ./teshsuite/msg/CMakeLists.txt
- ./tools/gras/CMakeLists.txt
- ./tools/tesh/CMakeLists.txt
- ./testsuite/simdag/CMakeLists.txt
- ./testsuite/xbt/CMakeLists.txt
- ./testsuite/surf/CMakeLists.txt
- ./examples/gras/properties/CMakeLists.txt
- ./examples/gras/ping/CMakeLists.txt
- ./examples/gras/pmm/CMakeLists.txt
- ./examples/gras/mmrpc/CMakeLists.txt
- ./examples/gras/synchro/CMakeLists.txt
- ./examples/gras/timer/CMakeLists.txt
- ./examples/gras/mutual_exclusion/simple_token/CMakeLists.txt
- ./examples/gras/spawn/CMakeLists.txt
- ./examples/gras/chrono/CMakeLists.txt
- ./examples/gras/rpc/CMakeLists.txt
- ./examples/gras/all2all/CMakeLists.txt
- ./examples/simdag/properties/CMakeLists.txt
- ./examples/simdag/CMakeLists.txt
- ./examples/simdag/metaxml/CMakeLists.txt
- ./examples/simdag/dax/CMakeLists.txt
- ./examples/smpi/CMakeLists.txt
- ./examples/amok/bandwidth/CMakeLists.txt
- ./examples/amok/saturate/CMakeLists.txt
- ./examples/msg/priority/CMakeLists.txt
- ./examples/msg/properties/CMakeLists.txt
- ./examples/msg/migration/CMakeLists.txt
- ./examples/msg/gtnets/CMakeLists.txt
- ./examples/msg/parallel_task/CMakeLists.txt
- ./examples/msg/trace/CMakeLists.txt
- ./examples/msg/suspend/CMakeLists.txt
- ./examples/msg/masterslave/CMakeLists.txt
- ./examples/msg/actions/CMakeLists.txt
- ./examples/msg/sendrecv/CMakeLists.txt
-\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
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)
two-step fashion: the user instruments the application and the traces are
analyzed after the end of the execution. The visualization itself can highlights
unexpected behaviors, bottlenecks and sometimes can be used to correct
-distributed algorithms. The SimGrid team is currently instrumenting the library
+distributed algorithms. The SimGrid team has instrumented the library
in order to let users trace their simulations and analyze them. This part of the
user manual explains how the tracing-related features can be enabled and used
during the development of simulators using the SimGrid library.
\subsubsection faq_tracing_howitworks How it works
For now, the SimGrid library is instrumented so users can trace the <b>platform
-utilization</b> using the MSG interface. This means that the tracing will
+utilization</b> using the MSG, SimDAG and SMPI interface. This means that the tracing will
register how much power is used for each host and how much bandwidth is used for
each link of the platform. The idea with this type of tracing is to observe the
overall view of resources utilization in the first place, especially the
identification of bottlenecks, load-balancing among hosts, and so on.
-The idea of the instrumentation is to classify the MSG tasks by category,
-and trace
-the platform utilization (hosts and links) for each of the categories. For that,
+The idea of the tracing facilities is to give SimGrid users to possibility to
+classify MSG and SimDAG tasks by category, tracing the platform utilization
+(hosts and links) for each of the categories. For that,
the tracing interface enables the declaration of categories and a function to
mark a task with a previously declared category. <em>The tasks that are not
-classified according to a category are not traced</em>.
+classified according to a category are not traced</em>. Even if the user
+does not specify any category, the simulations can still be traced in terms
+of resource utilization by using a special parameter that is detailed below.
\subsubsection faq_tracing_enabling Enabling using CMake
With the sources of SimGrid, it is possible to enable the tracing
-using the parameter <b>-Dtracing=on</b> when the cmake is executed.
+using the parameter <b>-Denable_tracing=ON</b> when the cmake is executed.
The section \ref faq_tracing_functions describes all the functions available
when this Cmake options is activated. These functions will have no effect
if SimGrid is configured without this option (they are wiped-out by the
C-preprocessor).
\verbatim
-$ cmake -Dtracing=on .
+$ cmake -Denable_tracing=ON .
$ make
\endverbatim
\subsubsection faq_tracing_functions Tracing Functions
-\subsubsubsection Mandatory Functions
-
-\li <b>\c TRACE_start ()</b>: This is the first function to
-be called. It returns 0 if everything was properly initialized, 1 otherwise.
-All trace functions called before TRACE_start do nothing.
-
\li <b>\c TRACE_category (const char *category)</b>: This function should be used
to define a user category. The category can be used to differentiate the tasks
that are created during the simulation (for example, tasks from server1,
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 task, to define the
+This function should be called after the creation of a MSG task, to define the
category of that task. The first parameter \c task must contain a task that was
created with the function \c MSG_task_create. The second parameter
\c category must contain a category that was previously defined by the function
\c TRACE_category.
-\li <b>\c TRACE_end ()</b>: This is the last function to be called. It closes
-the trace file and stops the tracing of the simulation. All tracing will be
-completely disabled after the calling this function. Although we recommend
-the use of this function somewhere in the end of program, it can be used
-anywhere in the code. This function returns 0 if everything is ok, 1 otherwise.
-
-\subsubsubsection Optional Functions
+\li <b>\c TRACE_sd_set_task_category (SD_task_t task, const char *category)</b>:
+This function should be called after the creation of a SimDAG task, to define the
+category of that task. The first parameter \c task must contain a task that was
+created with the function \c MSG_task_create. The second parameter
+\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
These are the options accepted by the tracing system of SimGrid:
-\li <b>\c tracing/filename</b>: use this to specify the name of the trace file
-that will be created during the simulation. For example, after the binary
-of your simulator, you can pass as parameter this:
-\verbatim
---cfg=tracing/filename:mytracefile.trace
-\endverbatim
-in order to trace the behavior of the simulation in a file with the name
-mytracefile.trace.
-
-\li <b>\c tracing/platform</b>: use this to activate the tracing of the
-platform. For example, you can pass as parameter to your simulator:
-\verbatim
---cfg=tracing/platform:1
-\endverbatim
-to trace the platform utilization by the categories you declared in your
-simulator. By default, this options is set to 0.
+\li <b>\c
+tracing
+</b>:
+ 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
+</b>:
+ It activates the categorized resource utilization tracing. It should
+ be enabled if tracing categories are used by this simulator.
+
+\li <b>\c
+tracing/uncategorized
+</b>:
+ It activates the uncategorized resource utilization tracing. Use it if
+ this simulator do not use tracing categories and resource use have to be
+ traced.
+
+\li <b>\c
+tracing/filename
+</b>:
+ A file with this name will be created to register the simulation. The file
+ is in the Paje format and can be analyzed using Triva or Paje visualization
+ tools. More information can be found in these webpages:
+ <a href="http://triva.gforge.inria.fr/">http://triva.gforge.inria.fr/</a>
+ <a href="http://paje.sourceforge.net/">http://paje.sourceforge.net/</a>
+
+\li <b>\c
+tracing/smpi
+</b>:
+ This option only has effect if this simulator is SMPI-based. Traces the MPI
+ interface and generates a trace that can be analyzed using Gantt-like
+ visualizations. Every MPI function (implemented by SMPI) is transformed in a
+ state, and point-to-point communications can be analyzed with arrows.
+
+\li <b>\c
+tracing/smpi/group
+</b>:
+ This option only has effect if this simulator is SMPI-based. The processes
+ are grouped by the hosts where they were executed.
+
+\li <b>\c
+tracing/msg/task
+</b>:
+ This option only has effect if this simulator is MSG-based. It traces the
+ behavior of all categorized MSG tasks, grouping them by hosts.
+
+\li <b>\c
+tracing/msg/process
+</b>:
+ This option only has effect if this simulator is MSG-based. It traces the
+ 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
+triva/categorized:graph_categorized.plist
+</b>:
+ 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
- TRACE_start ();
- TRACE_category ("request");
- TRACE_category ("computation");
- TRACE_category ("finalize");
-
//(... 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");
+
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);
//(...)
MSG_clean();
-
- TRACE_end();
return 0;
}
\endverbatim
- <b>Installing Triva</b>: the tool is available in the INRIAGforge,
at <a href="http://triva.gforge.inria.fr">http://triva.gforge.inria.fr</a>.
Use the following command to get the sources, and then check the file
-<i>INSTALL.simplified</i>. This file contains instructions to install
-the tool's dependencies in a Ubuntu/Debian Linux.
+<i>INSTALL</i>. This file contains instructions to install
+the tool's dependencies in a Ubuntu/Debian Linux. The tool can also
+be compiled in MacOSes natively, check <i>INSTALL.mac</i> file.
\verbatim
$ svn checkout svn://scm.gforge.inria.fr/svn/triva
$ cd triva
-$ cat INSTALL.simplified
+$ cat INSTALL
\endverbatim
- <b>Executing Triva</b>: a binary called <i>Triva</i> is available after the
installation (you can execute it passing <em>--help</em> to check its
options). If the triva binary is not available after following the
installation instructions, you may want to execute the following command to
-initialize the GNUstep environment variables (note that the location of the
-<i>GNUstep.sh</i> file may vary depending on your GNUstep installation - the
-command is known to work in Ubuntu and Debian Linux):
+initialize the GNUstep environment variables. We strongly recommend that you
+use the latest GNUstep packages, and not the packages available through apt-get
+in Ubuntu/Debian packaging systems. If you install GNUstep using the latest
+available packages, you can execute this command:
\verbatim
-$ source /usr/share/GNUstep/Makefiles/GNUstep.sh
+$ source /usr/GNUstep/System/Library/Makefiles/GNUstep.sh
\endverbatim
You should be able to see this output after the installation of triva:
\verbatim
$ ./Triva.app/Triva --help
-Usage: Triva [OPTION...] TRACEFILE
+Usage: Triva [OPTIONS...] TRACE0 [TRACE1]
Trace Analysis through Visualization
- You need to use one of the following options:
- -g, --graph Graph Analysis
- -t, --treemap Treemap Analysis
-
- Other auxiliary options to check the trace file:
- -c, --check Check the integrity of trace file
- -h, --hierarchy Export the trace type hierarchy
- -l, --list List entity types
-
- -?, --help Give this help list
- --usage Give a short usage message
+TimeInterval
+ --ti_frequency {double} Animation: frequency of updates
+ --ti_hide Hide the TimeInterval window
+ --ti_forward {double} Animation: value to move time-slice
+ --ti_apply Apply the configuration
+ --ti_update Update on slider change
+ --ti_animate Start animation
+ --ti_start {double} Start of time slice
+ --ti_size {double} Size of time slice
+Triva
+ --comparison Compare Trace Files (Experimental)
+ --graph Configurable Graph
+ --list Print Trace Type Hierarchy
+ --hierarchy Export Trace Type Hierarchy (dot)
+ --stat Trace Statistics and Memory Utilization
+ --instances List All Trace Entities
+ --linkview Link View (Experimental)
+ --treemap Squarified Treemap
+ --merge Merge Trace Files (Experimental)
+ --check Check Trace File Integrity
+GraphConfiguration
+ --gc_conf {file} Graph Configuration in Property List Format
+ --gc_apply Apply the configuration
+ --gc_hide Hide the GraphConfiguration window
\endverbatim
Triva expects that the user choose one of the available options
(currently <em>--graph</em> or <em>--treemap</em> for a visualization analysis)
- loading the platforme/deployment XML file that describe the environment of simulation
- and … Running the Simulation.
-\dontinclude lua/master_slave.lua
+\dontinclude lua/masterslave/master.lua
\subsubsection faq_binding_lua_example_master_slave Master/Slave Example
\li Master Code
then simgrid.Task.send(task,alias) to send it.
we use also simgrid.Task.name(task), to get the task's name.
+\dontinclude lua/masterslave/slave.lua
\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.
+\dontinclude lua/masterslave/master_slave.lua
\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,
+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.
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.
\endverbatim
\li Master code
-\until end_of_master
+\verbatim
+class Master < MSG::Process
+ # main : that function that will be executed when running simulation
+
+ def main(args) # args is an array containing arguments for function master
+ size = args.size
+ for i in 0..size-1
+ MSG::info("args["+String(i)+"]="+args[i])
+ end
+
+ raise "Master needs 3 arguments" if size < 3
+ numberOfTask = Integer(args[0])
+ taskComputeSize = Float(args[1])
+ taskCommunicationSize = Float(args[2])
+ slaveCount = Integer(args[3])
+
+ # Creates and sends the tasks
+ for i in 0..numberOfTask-1
+ task = Task.new("Task_"+ i.to_s, taskComputeSize , taskCommunicationSize);
+ mailbox = "slave " + (i%slaveCount).to_s
+ MSG::info("Master Sending "+ task.name + " to " + mailbox + " with Comput Size " +
+ task.compSize.to_s)
+ task.send(mailbox)
+ MSG::info("Master Done Sending " + task.name + " to " + mailbox)
+ end
+
+ # Sending Finalize MSG::Tasks
+ MSG::info("Master: All tasks have been dispatched. Let's tell everybody the computation is over.")
+ for i in 0..slaveCount-1
+ mailbox = "slave " + i.to_s
+ finalize_task = Task.new("finalize",0,0)
+ finalize_task.send(mailbox)
+ end
+ MSG::info("Master : Everything's Done")
+ end
+end
+\endverbatim
+
the class MSG::Task contains methods that allows the management of the native MSG tasks.
in master ruby code we used :
- <i>MSG::Task.name</i> : to get the task's name.
\li Slave code
-\until end_of_slave
+\verbatim
+class Slave < MSG::Process
+
+ def main(args)
+ mailbox = "slave " + args[0]
+ for i in 0..args.size-1
+ MSG::debug("args["+String(i)+"]="+args[i])
+ end
+
+ while true
+ MSG::info("Slave '"+ mailbox +"' waiting for new task");
+ task = Task.receive(mailbox)
+ if (task.name == "finalize")
+ break
+ end
+ task.execute
+ MSG::info("Slave '" + mailbox + "' done executing task "+ task.name + ".")
+ end
+ MSG::info("I'm done, see you")
+ end
+end
+\enverbatim
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
+
+\verbatim
+require 'simgrid'
+include MSG
+(...)
+
+if (ARGV.length == 2)
+ MSG.createEnvironment(ARGV[0])
+ MSG.deployApplication(ARGV[1])
+
+else
+
+ MSG.createEnvironment("platform.xml")
+ MSG.deployApplication("deploy.xml")
+end
+MSG.run
+puts "Simulation time : " + MSG.getClock.to_s
+MSG.exit
+\endverbatim
- <i>MSG.createEnvironment(platform_file)</i> : set up the environment
- <i>MSG.deployApplication(deployment_file)</i> : load the deployment file description.
\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
+\li MSG::Task.join & MSG::Task.data <br/>
the MSG::Task class contains 2 methods that allows a data exchange between 2 process.
\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
