380_offline_performance_tools.doxy 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  1. /* StarPU --- Runtime system for heterogeneous multicore architectures.
  2. *
  3. * Copyright (C) 2011,2012,2015-2017 Inria
  4. * Copyright (C) 2010-2019 CNRS
  5. * Copyright (C) 2009-2011,2014-2017,2019 Université de Bordeaux
  6. *
  7. * StarPU is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU Lesser General Public License as published by
  9. * the Free Software Foundation; either version 2.1 of the License, or (at
  10. * your option) any later version.
  11. *
  12. * StarPU is distributed in the hope that it will be useful, but
  13. * WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  15. *
  16. * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  17. */
  18. /*! \page OfflinePerformanceTools Offline Performance Tools
  19. To get an idea of what is happening, a lot of performance feedback is available,
  20. detailed in this chapter. The various informations should be checked for.
  21. <ul>
  22. <li>
  23. What does the Gantt diagram look like? (see \ref CreatingAGanttDiagram)
  24. <ul>
  25. <li> If it's mostly green (tasks running in the initial context) or context specific
  26. color prevailing, then the machine is properly
  27. utilized, and perhaps the codelets are just slow. Check their performance, see
  28. \ref PerformanceOfCodelets.
  29. </li>
  30. <li> If it's mostly purple (FetchingInput), tasks keep waiting for data
  31. transfers, do you perhaps have far more communication than computation? Did
  32. you properly use CUDA streams to make sure communication can be
  33. overlapped? Did you use data-locality aware schedulers to avoid transfers as
  34. much as possible?
  35. </li>
  36. <li> If it's mostly red (Blocked), tasks keep waiting for dependencies,
  37. do you have enough parallelism? It might be a good idea to check what the DAG
  38. looks like (see \ref CreatingADAGWithGraphviz).
  39. </li>
  40. <li> If only some workers are completely red (Blocked), for some reason the
  41. scheduler didn't assign tasks to them. Perhaps the performance model is bogus,
  42. check it (see \ref PerformanceOfCodelets). Do all your codelets have a
  43. performance model? When some of them don't, the schedulers switches to a
  44. greedy algorithm which thus performs badly.
  45. </li>
  46. </ul>
  47. </li>
  48. </ul>
  49. You can also use the Temanejo task debugger (see \ref UsingTheTemanejoTaskDebugger) to
  50. visualize the task graph more easily.
  51. \section Off-linePerformanceFeedback Off-line Performance Feedback
  52. \subsection GeneratingTracesWithFxT Generating Traces With FxT
  53. StarPU can use the FxT library (see
  54. https://savannah.nongnu.org/projects/fkt/) to generate traces
  55. with a limited runtime overhead.
  56. You can get a tarball from http://download.savannah.gnu.org/releases/fkt/
  57. Compiling and installing the FxT library in the <c>$FXTDIR</c> path is
  58. done following the standard procedure:
  59. \verbatim
  60. $ ./configure --prefix=$FXTDIR
  61. $ make
  62. $ make install
  63. \endverbatim
  64. In order to have StarPU to generate traces, StarPU should be configured with
  65. the option \ref with-fxt "--with-fxt" :
  66. \verbatim
  67. $ ./configure --with-fxt=$FXTDIR
  68. \endverbatim
  69. Or you can simply point the <c>PKG_CONFIG_PATH</c> to
  70. <c>$FXTDIR/lib/pkgconfig</c> and pass
  71. \ref with-fxt "--with-fxt" to <c>configure</c>
  72. When FxT is enabled, a trace is generated when StarPU is terminated by calling
  73. starpu_shutdown(). The trace is a binary file whose name has the form
  74. <c>prof_file_XXX_YYY</c> where <c>XXX</c> is the user name, and
  75. <c>YYY</c> is the pid of the process that used StarPU. This file is saved in the
  76. <c>/tmp/</c> directory by default, or by the directory specified by
  77. the environment variable \ref STARPU_FXT_PREFIX.
  78. The additional \c configure option \ref enable-fxt-lock "--enable-fxt-lock" can
  79. be used to generate trace events which describes the locks behaviour during
  80. the execution. It is however very heavy and should not be used unless debugging
  81. StarPU's internal locking.
  82. The environment variable \ref STARPU_FXT_TRACE can be set to 0 to disable the
  83. generation of the <c>prof_file_XXX_YYY</c> file.
  84. When the FxT trace file <c>prof_file_something</c> has been generated,
  85. it is possible to generate different trace formats by calling:
  86. \verbatim
  87. $ starpu_fxt_tool -i /tmp/prof_file_something
  88. \endverbatim
  89. Or alternatively, setting the environment variable \ref STARPU_GENERATE_TRACE
  90. to <c>1</c> before application execution will make StarPU do it automatically at
  91. application shutdown.
  92. One can also set the environment variable \ref
  93. STARPU_GENERATE_TRACE_OPTIONS to specify options, see
  94. <c>starpu_fxt_tool --help</c>, for example:
  95. \verbatim
  96. $ export STARPU_GENERATE_TRACE=1
  97. $ export STARPU_GENERATE_TRACE_OPTIONS="-no-acquire"
  98. \endverbatim
  99. When running a MPI application, \ref STARPU_GENERATE_TRACE will not
  100. work as expected (each node will try to generate trace files, thus
  101. mixing outputs...), you have to collect the trace files from the MPI
  102. nodes, and specify them all on the command <c>starpu_fxt_tool</c>, for
  103. instance:
  104. \verbatim
  105. $ starpu_fxt_tool -i /tmp/prof_file_something*
  106. \endverbatim
  107. By default, the generated trace contains all informations. To reduce
  108. the trace size, various <c>-no-foo</c> options can be passed to
  109. <c>starpu_fxt_tool</c>, see <c>starpu_fxt_tool --help</c> .
  110. \subsubsection CreatingAGanttDiagram Creating a Gantt Diagram
  111. One of the generated files is a trace in the Paje format. The file,
  112. located in the current directory, is named <c>paje.trace</c>. It can
  113. be viewed with ViTE (http://vite.gforge.inria.fr/) a trace
  114. visualizing open-source tool. To open the file <c>paje.trace</c> with
  115. ViTE, use the following command:
  116. \verbatim
  117. $ vite paje.trace
  118. \endverbatim
  119. Tasks can be assigned a name (instead of the default \c unknown) by
  120. filling the optional starpu_codelet::name, or assigning them a
  121. performance model. The name can also be set with the field
  122. starpu_task::name or by using \ref STARPU_NAME when calling
  123. starpu_task_insert().
  124. Tasks are assigned default colors based on the worker which executed
  125. them (green for CPUs, yellow/orange/red for CUDAs, blue for OpenCLs,
  126. red for MICs, ...). To use a different color for every type of task,
  127. one can specify the option <c>-c</c> to <c>starpu_fxt_tool</c> or in
  128. \ref STARPU_GENERATE_TRACE_OPTIONS. Tasks can also be given a specific
  129. color by setting the field starpu_codelet::color or the
  130. starpu_task::color. Colors are expressed with the following format
  131. \c 0xRRGGBB (e.g \c 0xFF0000 for red). See
  132. <c>basic_examples/task_insert_color</c> for examples on how to assign
  133. colors.
  134. To identify tasks precisely, the application can also set the field
  135. starpu_task::tag_id or setting \ref STARPU_TAG_ONLY when calling
  136. starpu_task_insert(). The value of the tag will then show up in the
  137. trace.
  138. One can also introduce user-defined events in the diagram thanks to the
  139. starpu_fxt_trace_user_event_string() function.
  140. One can also set the iteration number, by just calling starpu_iteration_push()
  141. at the beginning of submission loops and starpu_iteration_pop() at the end of
  142. submission loops. These iteration numbers will show up in traces for all tasks
  143. submitted from there.
  144. Coordinates can also be given to data with the starpu_data_set_coordinates() or
  145. starpu_data_set_coordinates_array() function. In the trace, tasks will then be
  146. assigned the coordinates of the first data they write to.
  147. Traces can also be inspected by hand by using the tool <c>fxt_print</c>, for instance:
  148. \verbatim
  149. $ fxt_print -o -f /tmp/prof_file_something
  150. \endverbatim
  151. Timings are in nanoseconds (while timings as seen in ViTE are in milliseconds).
  152. \subsubsection CreatingADAGWithGraphviz Creating a DAG With Graphviz
  153. Another generated trace file is a task graph described using the DOT
  154. language. The file, created in the current directory, is named
  155. <c>dag.dot</c> file in the current directory.
  156. It is possible to get a graphical output of the graph by using the
  157. <c>graphviz</c> library:
  158. \verbatim
  159. $ dot -Tpdf dag.dot -o output.pdf
  160. \endverbatim
  161. \subsubsection TraceTaskDetails Getting Task Details
  162. Another generated trace file gives details on the executed tasks. The
  163. file, created in the current directory, is named <c>tasks.rec</c>. This file
  164. is in the recutils format, i.e. <c>Field: value</c> lines, and empty lines to
  165. separate each task. This can be used as a convenient input for various ad-hoc
  166. analysis tools. By default it only contains information about the actual
  167. execution. Performance models can be obtained by running
  168. <c>starpu_tasks_rec_complete</c> on it:
  169. \verbatim
  170. $ starpu_tasks_rec_complete tasks.rec tasks2.rec
  171. \endverbatim
  172. which will add <c>EstimatedTime</c> lines which contain the performance
  173. model-estimated time (in µs) for each worker starting from 0. Since it needs
  174. the performance models, it needs to be run the same way as the application
  175. execution, or at least with <c>STARPU_HOSTNAME</c> set to the hostname of the
  176. machine used for execution, to get the performance models of that machine.
  177. Another possibility is to obtain the performance models as an auxiliary <c>perfmodel.rec</c> file, by using the <c>starpu_perfmodel_recdump</c> utility:
  178. \verbatim
  179. $ starpu_perfmodel_recdump tasks.rec -o perfmodel.rec
  180. \endverbatim
  181. \subsubsection MonitoringActivity Monitoring Activity
  182. Another generated trace file is an activity trace. The file, created
  183. in the current directory, is named <c>activity.data</c>. A profile of
  184. the application showing the activity of StarPU during the execution of
  185. the program can be generated:
  186. \verbatim
  187. $ starpu_workers_activity activity.data
  188. \endverbatim
  189. This will create a file named <c>activity.eps</c> in the current directory.
  190. This picture is composed of two parts.
  191. The first part shows the activity of the different workers. The green sections
  192. indicate which proportion of the time was spent executed kernels on the
  193. processing unit. The red sections indicate the proportion of time spent in
  194. StartPU: an important overhead may indicate that the granularity may be too
  195. low, and that bigger tasks may be appropriate to use the processing unit more
  196. efficiently. The black sections indicate that the processing unit was blocked
  197. because there was no task to process: this may indicate a lack of parallelism
  198. which may be alleviated by creating more tasks when it is possible.
  199. The second part of the picture <c>activity.eps</c> is a graph showing the
  200. evolution of the number of tasks available in the system during the execution.
  201. Ready tasks are shown in black, and tasks that are submitted but not
  202. schedulable yet are shown in grey.
  203. \subsubsection Animation Getting Modular Schedular Animation
  204. When using modular schedulers (i.e. schedulers which use a modular architecture,
  205. and whose name start with "modular-"), the call to
  206. <c>starpu_fxt_tool</c> will also produce a <c>trace.html</c> file
  207. which can be viewed in a javascript-enabled web browser. It shows the
  208. flow of tasks between the components of the modular scheduler.
  209. \subsection LimitingScopeTrace Limiting The Scope Of The Trace
  210. For computing statistics, it is useful to limit the trace to a given portion of
  211. the time of the whole execution. This can be achieved by calling
  212. \code{.c}
  213. starpu_fxt_autostart_profiling(0)
  214. \endcode
  215. before calling starpu_init(), to
  216. prevent tracing from starting immediately. Then
  217. \code{.c}
  218. starpu_fxt_start_profiling();
  219. \endcode
  220. and
  221. \code{.c}
  222. starpu_fxt_stop_profiling();
  223. \endcode
  224. can be used around the portion of code to be traced. This will show up as marks
  225. in the trace, and states of workers will only show up for that portion.
  226. \section PerformanceOfCodelets Performance Of Codelets
  227. The performance model of codelets (see \ref PerformanceModelExample)
  228. can be examined by using the tool <c>starpu_perfmodel_display</c>:
  229. \verbatim
  230. $ starpu_perfmodel_display -l
  231. file: <malloc_pinned.hannibal>
  232. file: <starpu_slu_lu_model_21.hannibal>
  233. file: <starpu_slu_lu_model_11.hannibal>
  234. file: <starpu_slu_lu_model_22.hannibal>
  235. file: <starpu_slu_lu_model_12.hannibal>
  236. \endverbatim
  237. Here, the codelets of the example <c>lu</c> are available. We can examine the
  238. performance of the kernel <c>22</c> (in micro-seconds), which is history-based:
  239. \verbatim
  240. $ starpu_perfmodel_display -s starpu_slu_lu_model_22
  241. performance model for cpu
  242. # hash size mean dev n
  243. 57618ab0 19660800 2.851069e+05 1.829369e+04 109
  244. performance model for cuda_0
  245. # hash size mean dev n
  246. 57618ab0 19660800 1.164144e+04 1.556094e+01 315
  247. performance model for cuda_1
  248. # hash size mean dev n
  249. 57618ab0 19660800 1.164271e+04 1.330628e+01 360
  250. performance model for cuda_2
  251. # hash size mean dev n
  252. 57618ab0 19660800 1.166730e+04 3.390395e+02 456
  253. \endverbatim
  254. We can see that for the given size, over a sample of a few hundreds of
  255. execution, the GPUs are about 20 times faster than the CPUs (numbers are in
  256. us). The standard deviation is extremely low for the GPUs, and less than 10% for
  257. CPUs.
  258. This tool can also be used for regression-based performance models. It will then
  259. display the regression formula, and in the case of non-linear regression, the
  260. same performance log as for history-based performance models:
  261. \verbatim
  262. $ starpu_perfmodel_display -s non_linear_memset_regression_based
  263. performance model for cpu_impl_0
  264. Regression : #sample = 1400
  265. Linear: y = alpha size ^ beta
  266. alpha = 1.335973e-03
  267. beta = 8.024020e-01
  268. Non-Linear: y = a size ^b + c
  269. a = 5.429195e-04
  270. b = 8.654899e-01
  271. c = 9.009313e-01
  272. # hash size mean stddev n
  273. a3d3725e 4096 4.763200e+00 7.650928e-01 100
  274. 870a30aa 8192 1.827970e+00 2.037181e-01 100
  275. 48e988e9 16384 2.652800e+00 1.876459e-01 100
  276. 961e65d2 32768 4.255530e+00 3.518025e-01 100
  277. ...
  278. \endverbatim
  279. The same can also be achieved by using StarPU's library API, see
  280. \ref API_Performance_Model and notably the function
  281. starpu_perfmodel_load_symbol(). The source code of the tool
  282. <c>starpu_perfmodel_display</c> can be a useful example.
  283. An XML output can also be printed by using the <c>-x</c> option:
  284. \verbatim
  285. tools/starpu_perfmodel_display -x -s non_linear_memset_regression_based
  286. <?xml version="1.0" encoding="UTF-8"?>
  287. <!DOCTYPE StarPUPerfmodel SYSTEM "starpu-perfmodel.dtd">
  288. <!-- symbol non_linear_memset_regression_based -->
  289. <!-- All times in us -->
  290. <perfmodel version="45">
  291. <combination>
  292. <device type="CPU" id="0" ncores="1"/>
  293. <implementation id="0">
  294. <!-- cpu0_impl0 (Comb0) -->
  295. <!-- time = a size ^b + c -->
  296. <nl_regression a="5.429195e-04" b="8.654899e-01" c="9.009313e-01"/>
  297. <entry footprint="a3d3725e" size="4096" flops="0.000000e+00" mean="4.763200e+00" deviation="7.650928e-01" nsample="100"/>
  298. <entry footprint="870a30aa" size="8192" flops="0.000000e+00" mean="1.827970e+00" deviation="2.037181e-01" nsample="100"/>
  299. <entry footprint="48e988e9" size="16384" flops="0.000000e+00" mean="2.652800e+00" deviation="1.876459e-01" nsample="100"/>
  300. <entry footprint="961e65d2" size="32768" flops="0.000000e+00" mean="4.255530e+00" deviation="3.518025e-01" nsample="100"/>
  301. </implementation>
  302. </combination>
  303. </perfmodel>
  304. \endverbatim
  305. The tool <c>starpu_perfmodel_plot</c> can be used to draw performance
  306. models. It writes a <c>.gp</c> file in the current directory, to be
  307. run with the tool <c>gnuplot</c>, which shows the corresponding curve.
  308. \image html starpu_non_linear_memset_regression_based.png
  309. \image latex starpu_non_linear_memset_regression_based.eps "" width=\textwidth
  310. When the field starpu_task::flops is set (or \ref STARPU_FLOPS is passed to
  311. starpu_task_insert()), <c>starpu_perfmodel_plot</c> can directly draw a GFlops
  312. curve, by simply adding the <c>-f</c> option:
  313. \verbatim
  314. $ starpu_perfmodel_plot -f -s chol_model_11
  315. \endverbatim
  316. This will however disable displaying the regression model, for which we can not
  317. compute GFlops.
  318. \image html starpu_chol_model_11_type.png
  319. \image latex starpu_chol_model_11_type.eps "" width=\textwidth
  320. When the FxT trace file <c>prof_file_something</c> has been generated, it is possible to
  321. get a profiling of each codelet by calling:
  322. \verbatim
  323. $ starpu_fxt_tool -i /tmp/prof_file_something
  324. $ starpu_codelet_profile distrib.data codelet_name
  325. \endverbatim
  326. This will create profiling data files, and a <c>distrib.data.gp</c> file in the current
  327. directory, which draws the distribution of codelet time over the application
  328. execution, according to data input size.
  329. \image html distrib_data.png
  330. \image latex distrib_data.eps "" width=\textwidth
  331. This is also available in the tool <c>starpu_perfmodel_plot</c>, by passing it
  332. the fxt trace:
  333. \verbatim
  334. $ starpu_perfmodel_plot -s non_linear_memset_regression_based -i /tmp/prof_file_foo_0
  335. \endverbatim
  336. It will produce a <c>.gp</c> file which contains both the performance model
  337. curves, and the profiling measurements.
  338. \image html starpu_non_linear_memset_regression_based_2.png
  339. \image latex starpu_non_linear_memset_regression_based_2.eps "" width=\textwidth
  340. If you have the statistical tool <c>R</c> installed, you can additionally use
  341. \verbatim
  342. $ starpu_codelet_histo_profile distrib.data
  343. \endverbatim
  344. Which will create one <c>.pdf</c> file per codelet and per input size, showing a
  345. histogram of the codelet execution time distribution.
  346. \image html distrib_data_histo.png
  347. \image latex distrib_data_histo.eps "" width=\textwidth
  348. \section TraceStatistics Trace Statistics
  349. More than just codelet performance, it is interesting to get statistics over all
  350. kinds of StarPU states (allocations, data transfers, etc.). This is particularly
  351. useful to check what may have gone wrong in the accurracy of the simgrid
  352. simulation.
  353. This requires the <c>R</c> statistical tool, with the <c>plyr</c>,
  354. <c>ggplot2</c> and <c>data.table</c> packages. If your system
  355. distribution does not have packages for these, one can fetch them from
  356. <c>CRAN</c>:
  357. \verbatim
  358. $ R
  359. > install.packages("plyr")
  360. > install.packages("ggplot2")
  361. > install.packages("data.table")
  362. > install.packages("knitr")
  363. \endverbatim
  364. The <c>pj_dump</c> tool from <c>pajeng</c> is also needed (see
  365. https://github.com/schnorr/pajeng)
  366. One can then get textual or <c>.csv</c> statistics over the trace states:
  367. \verbatim
  368. $ starpu_paje_state_stats -v native.trace simgrid.trace
  369. "Value" "Events_native.csv" "Duration_native.csv" "Events_simgrid.csv" "Duration_simgrid.csv"
  370. "Callback" 220 0.075978 220 0
  371. "chol_model_11" 10 565.176 10 572.8695
  372. "chol_model_21" 45 9184.828 45 9170.719
  373. "chol_model_22" 165 64712.07 165 64299.203
  374. $ starpu_paje_state_stats native.trace simgrid.trace
  375. \endverbatim
  376. An other way to get statistics of StarPU states (without installing <c>R</c> and
  377. <c>pj_dump</c>) is to use the <c>starpu_trace_state_stats.py</c> script which parses the
  378. generated <c>trace.rec</c> file instead of the <c>paje.trace</c> file. The output is similar
  379. to the previous script but it doesn't need any dependencies.
  380. The different prefixes used in <c>trace.rec</c> are:
  381. \verbatim
  382. E: Event type
  383. N: Event name
  384. C: Event category
  385. W: Worker ID
  386. T: Thread ID
  387. S: Start time
  388. \endverbatim
  389. Here's an example on how to use it:
  390. \verbatim
  391. $ python starpu_trace_state_stats.py trace.rec | column -t -s ","
  392. "Name" "Count" "Type" "Duration"
  393. "Callback" 220 Runtime 0.075978
  394. "chol_model_11" 10 Task 565.176
  395. "chol_model_21" 45 Task 9184.828
  396. "chol_model_22" 165 Task 64712.07
  397. \endverbatim
  398. <c>starpu_trace_state_stats.py</c> can also be used to compute the different
  399. efficiencies. Refer to the usage description to show some examples.
  400. And one can plot histograms of execution times, of several states for instance:
  401. \verbatim
  402. $ starpu_paje_draw_histogram -n chol_model_11,chol_model_21,chol_model_22 native.trace simgrid.trace
  403. \endverbatim
  404. and see the resulting pdf file:
  405. \image html paje_draw_histogram.png
  406. \image latex paje_draw_histogram.eps "" width=\textwidth
  407. A quick statistical report can be generated by using:
  408. \verbatim
  409. $ starpu_paje_summary native.trace simgrid.trace
  410. \endverbatim
  411. it includes gantt charts, execution summaries, as well as state duration charts
  412. and time distribution histograms.
  413. Other external Paje analysis tools can be used on these traces, one just needs
  414. to sort the traces by timestamp order (which not guaranteed to make recording
  415. more efficient):
  416. \verbatim
  417. $ starpu_paje_sort paje.trace
  418. \endverbatim
  419. \section TheoreticalLowerBoundOnExecutionTime Theoretical Lower Bound On Execution Time
  420. StarPU can record a trace of what tasks are needed to complete the
  421. application, and then, by using a linear system, provide a theoretical lower
  422. bound of the execution time (i.e. with an ideal scheduling).
  423. The computed bound is not really correct when not taking into account
  424. dependencies, but for an application which have enough parallelism, it is very
  425. near to the bound computed with dependencies enabled (which takes a huge lot
  426. more time to compute), and thus provides a good-enough estimation of the ideal
  427. execution time.
  428. \ref TheoreticalLowerBoundOnExecutionTimeExample provides an example on how to
  429. use this.
  430. \section TheoreticalLowerBoundOnExecutionTimeExample Theoretical Lower Bound On Execution Time Example
  431. For kernels with history-based performance models (and provided that
  432. they are completely calibrated), StarPU can very easily provide a
  433. theoretical lower bound for the execution time of a whole set of
  434. tasks. See for instance <c>examples/lu/lu_example.c</c>: before
  435. submitting tasks, call the function starpu_bound_start(), and after
  436. complete execution, call starpu_bound_stop().
  437. starpu_bound_print_lp() or starpu_bound_print_mps() can then be used
  438. to output a Linear Programming problem corresponding to the schedule
  439. of your tasks. Run it through <c>lp_solve</c> or any other linear
  440. programming solver, and that will give you a lower bound for the total
  441. execution time of your tasks. If StarPU was compiled with the library
  442. <c>glpk</c> installed, starpu_bound_compute() can be used to solve it
  443. immediately and get the optimized minimum, in ms. Its parameter
  444. <c>integer</c> allows to decide whether integer resolution should be
  445. computed and returned
  446. The <c>deps</c> parameter tells StarPU whether to take tasks, implicit
  447. data, and tag dependencies into account. Tags released in a callback
  448. or similar are not taken into account, only tags associated with a task are.
  449. It must be understood that the linear programming
  450. problem size is quadratic with the number of tasks and thus the time to solve it
  451. will be very long, it could be minutes for just a few dozen tasks. You should
  452. probably use <c>lp_solve -timeout 1 test.pl -wmps test.mps</c> to convert the
  453. problem to MPS format and then use a better solver, <c>glpsol</c> might be
  454. better than <c>lp_solve</c> for instance (the <c>--pcost</c> option may be
  455. useful), but sometimes doesn't manage to converge. <c>cbc</c> might look
  456. slower, but it is parallel. For <c>lp_solve</c>, be sure to try at least all the
  457. <c>-B</c> options. For instance, we often just use <c>lp_solve -cc -B1 -Bb
  458. -Bg -Bp -Bf -Br -BG -Bd -Bs -BB -Bo -Bc -Bi</c> , and the <c>-gr</c> option can
  459. also be quite useful. The resulting schedule can be observed by using
  460. the tool <c>starpu_lp2paje</c>, which converts it into the Paje
  461. format.
  462. Data transfer time can only be taken into account when <c>deps</c> is set. Only
  463. data transfers inferred from implicit data dependencies between tasks are taken
  464. into account. Other data transfers are assumed to be completely overlapped.
  465. Setting <c>deps</c> to 0 will only take into account the actual computations
  466. on processing units. It however still properly takes into account the varying
  467. performances of kernels and processing units, which is quite more accurate than
  468. just comparing StarPU performances with the fastest of the kernels being used.
  469. The <c>prio</c> parameter tells StarPU whether to simulate taking into account
  470. the priorities as the StarPU scheduler would, i.e. schedule prioritized
  471. tasks before less prioritized tasks, to check to which extend this results
  472. to a less optimal solution. This increases even more computation time.
  473. \section MemoryFeedback Memory Feedback
  474. It is possible to enable memory statistics. To do so, you need to pass
  475. the option \ref enable-memory-stats "--enable-memory-stats" when running <c>configure</c>. It is then
  476. possible to call the function starpu_data_display_memory_stats() to
  477. display statistics about the current data handles registered within StarPU.
  478. Moreover, statistics will be displayed at the end of the execution on
  479. data handles which have not been cleared out. This can be disabled by
  480. setting the environment variable \ref STARPU_MEMORY_STATS to <c>0</c>.
  481. For example, if you do not unregister data at the end of the complex
  482. example, you will get something similar to:
  483. \verbatim
  484. $ STARPU_MEMORY_STATS=0 ./examples/interface/complex
  485. Complex[0] = 45.00 + 12.00 i
  486. Complex[0] = 78.00 + 78.00 i
  487. Complex[0] = 45.00 + 12.00 i
  488. Complex[0] = 45.00 + 12.00 i
  489. \endverbatim
  490. \verbatim
  491. $ STARPU_MEMORY_STATS=1 ./examples/interface/complex
  492. Complex[0] = 45.00 + 12.00 i
  493. Complex[0] = 78.00 + 78.00 i
  494. Complex[0] = 45.00 + 12.00 i
  495. Complex[0] = 45.00 + 12.00 i
  496. #---------------------
  497. Memory stats:
  498. #-------
  499. Data on Node #3
  500. #-----
  501. Data : 0x553ff40
  502. Size : 16
  503. #--
  504. Data access stats
  505. /!\ Work Underway
  506. Node #0
  507. Direct access : 4
  508. Loaded (Owner) : 0
  509. Loaded (Shared) : 0
  510. Invalidated (was Owner) : 0
  511. Node #3
  512. Direct access : 0
  513. Loaded (Owner) : 0
  514. Loaded (Shared) : 1
  515. Invalidated (was Owner) : 0
  516. #-----
  517. Data : 0x5544710
  518. Size : 16
  519. #--
  520. Data access stats
  521. /!\ Work Underway
  522. Node #0
  523. Direct access : 2
  524. Loaded (Owner) : 0
  525. Loaded (Shared) : 1
  526. Invalidated (was Owner) : 1
  527. Node #3
  528. Direct access : 0
  529. Loaded (Owner) : 1
  530. Loaded (Shared) : 0
  531. Invalidated (was Owner) : 0
  532. \endverbatim
  533. \section DataStatistics Data Statistics
  534. Different data statistics can be displayed at the end of the execution
  535. of the application. To enable them, you need to define the environment
  536. variable \ref STARPU_ENABLE_STATS. When calling
  537. starpu_shutdown() various statistics will be displayed,
  538. execution, MSI cache statistics, allocation cache statistics, and data
  539. transfer statistics. The display can be disabled by setting the
  540. environment variable \ref STARPU_STATS to <c>0</c>.
  541. \verbatim
  542. $ ./examples/cholesky/cholesky_tag
  543. Computation took (in ms)
  544. 518.16
  545. Synthetic GFlops : 44.21
  546. #---------------------
  547. MSI cache stats :
  548. TOTAL MSI stats hit 1622 (66.23 %) miss 827 (33.77 %)
  549. ...
  550. \endverbatim
  551. \verbatim
  552. $ STARPU_STATS=0 ./examples/cholesky/cholesky_tag
  553. Computation took (in ms)
  554. 518.16
  555. Synthetic GFlops : 44.21
  556. \endverbatim
  557. // TODO: data transfer stats are similar to the ones displayed when
  558. // setting STARPU_BUS_STATS
  559. */