X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a31c4367d8a34c77bbb5f8598260c5afb95897bd..2738cbeaa7d9227b472a16fe30ef72b0a0e88a01:/doc/FAQ.doc diff --git a/doc/FAQ.doc b/doc/FAQ.doc index 2953a568ea..dd73b3f466 100644 --- a/doc/FAQ.doc +++ b/doc/FAQ.doc @@ -112,7 +112,7 @@ For Unix and MacOS: \li cmake (download page) For Windows : - \li cmake 2.8.3 (download page) + \li cmake 2.8 (download page) \li perl strawberry (download page) \li pcre-7.0 (download page) @@ -120,11 +120,9 @@ For Windows : \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 @@ -132,23 +130,25 @@ For Windows : 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_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 gtnets_path CMAKE_INSTALL_PREFIX - pipol_user + pipol_user \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" @@ -159,7 +159,7 @@ For Windows : \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. @@ -167,6 +167,18 @@ For Windows : \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_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 CMAKE_INSTALL_PREFIX : Path where are installed lib/ doc/ and include/ directories (ex /usr/local) @@ -180,18 +192,22 @@ Those options are initialized the first time you launch "cmake ." whithout speci \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_debug on +enable_pcre on enable_compile_warnings off enable_maintainer_mode off enable_coverage off enable_memcheck off enable_model-checking off +enable_jedule off +enable_latency_bound_tracking off +enable_lib_static off CMAKE_INSTALL_PREFIX /usr/local +custom_flags null gtnets_path null pipol_user null \endverbatim @@ -298,8 +314,8 @@ For Windows: \verbatim cmake -G"Unix Makefiles" -DCMAKE_INSTALL_PREFIX=C:\simgrid_install ./ -make -make install +gmake +gmake install \endverbatim \subsubsection faq_cmakeinstall2 From a distrib @@ -2114,7 +2130,7 @@ Actually, the use of lua in Simgrid is quite simple, you have just to follow the - 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 @@ -2123,16 +2139,18 @@ we mainly use simgrid.Task.new(task_name,computation_size,communication_size) 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. @@ -2240,7 +2258,6 @@ the full example is distributed in the file examples/lua/master_slave_bypass.lua Since v3.4, the use of ruby 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 MSG::Process ruby class, with a 'main' function that describe the behaviour of the process during the simulation. @@ -2251,7 +2268,44 @@ include MSG \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 : @@ -2260,11 +2314,50 @@ in master ruby code we used : - MSG::Task.name : 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 MSG::Task.receive(mailbox) 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 - MSG.createEnvironment(platform_file) : set up the environment - MSG.deployApplication(deployment_file) : load the deployment file description. @@ -2272,7 +2365,7 @@ to receive a task, we use the method MSG::Task.receive(mailbox) that retu \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
the MSG::Task class contains 2 methods that allows a data exchange between 2 process.