configuration.texi 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  1. @c -*-texinfo-*-
  2. @c This file is part of the StarPU Handbook.
  3. @c Copyright (C) 2009--2011 Universit@'e de Bordeaux 1
  4. @c Copyright (C) 2010, 2011, 2012, 2013 Centre National de la Recherche Scientifique
  5. @c Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  6. @c See the file starpu.texi for copying conditions.
  7. @menu
  8. * Compilation configuration::
  9. * Execution configuration through environment variables::
  10. @end menu
  11. @node Compilation configuration
  12. @section Compilation configuration
  13. The following arguments can be given to the @code{configure} script.
  14. @menu
  15. * Common configuration::
  16. * Configuring workers::
  17. * Extension configuration::
  18. * Advanced configuration::
  19. @end menu
  20. @node Common configuration
  21. @subsection Common configuration
  22. @defvr {Configure option} --enable-debug
  23. Enable debugging messages.
  24. @end defvr
  25. @defvr {Configure option} --enable-debug
  26. Enable debugging messages.
  27. @end defvr
  28. @defvr {Configure option} --enable-fast
  29. Disable assertion checks, which saves computation time.
  30. @end defvr
  31. @defvr {Configure option} --enable-verbose
  32. Increase the verbosity of the debugging messages. This can be disabled
  33. at runtime by setting the environment variable @code{STARPU_SILENT} to
  34. any value.
  35. @smallexample
  36. $ STARPU_SILENT=1 ./vector_scal
  37. @end smallexample
  38. @end defvr
  39. @defvr {Configure option} --enable-coverage
  40. Enable flags for the @code{gcov} coverage tool.
  41. @end defvr
  42. @defvr {Configure option} --enable-quick-check
  43. Specify tests and examples should be run on a smaller data set, i.e
  44. allowing a faster execution time
  45. @end defvr
  46. @defvr {Configure option} --enable-long-check
  47. Enable some exhaustive checks which take a really long time.
  48. @end defvr
  49. @defvr {Configure option} --with-hwloc
  50. Specify hwloc should be used by StarPU. hwloc should be found by the
  51. means of the tools @code{pkg-config}.
  52. @end defvr
  53. @defvr {Configure option} --with-hwloc=@var{prefix}
  54. Specify hwloc should be used by StarPU. hwloc should be found in the
  55. directory specified by @var{prefix}.
  56. @end defvr
  57. @defvr {Configure option} --without-hwloc
  58. Specify hwloc should not be used by StarPU.
  59. @end defvr
  60. @defvr {Configure option} --disable-build-doc
  61. Disable the creation of the documentation. This should be done on a
  62. machine which does not have the tools @code{makeinfo} and @code{tex}.
  63. @end defvr
  64. Additionally, the @command{configure} script recognize many variables, which
  65. can be listed by typing @code{./configure --help}. For example,
  66. @code{./configure NVCCFLAGS="-arch sm_13"} adds a flag for the compilation of
  67. CUDA kernels.
  68. @node Configuring workers
  69. @subsection Configuring workers
  70. @defvr {Configure option} --enable-maxcpus=@var{count}
  71. Use at most @var{count} CPU cores. This information is then
  72. available as the @code{STARPU_MAXCPUS} macro.
  73. @end defvr
  74. @defvr {Configure option} --disable-cpu
  75. Disable the use of CPUs of the machine. Only GPUs etc. will be used.
  76. @end defvr
  77. @defvr {Configure option} --enable-maxcudadev=@var{count}
  78. Use at most @var{count} CUDA devices. This information is then
  79. available as the @code{STARPU_MAXCUDADEVS} macro.
  80. @end defvr
  81. @defvr {Configure option} --disable-cuda
  82. Disable the use of CUDA, even if a valid CUDA installation was detected.
  83. @end defvr
  84. @defvr {Configure option} --with-cuda-dir=@var{prefix}
  85. Search for CUDA under @var{prefix}, which should notably contain
  86. @file{include/cuda.h}.
  87. @end defvr
  88. @defvr {Configure option} --with-cuda-include-dir=@var{dir}
  89. Search for CUDA headers under @var{dir}, which should
  90. notably contain @code{cuda.h}. This defaults to @code{/include} appended to the
  91. value given to @code{--with-cuda-dir}.
  92. @end defvr
  93. @defvr {Configure option} --with-cuda-lib-dir=@var{dir}
  94. Search for CUDA libraries under @var{dir}, which should notably contain
  95. the CUDA shared libraries---e.g., @file{libcuda.so}. This defaults to
  96. @code{/lib} appended to the value given to @code{--with-cuda-dir}.
  97. @end defvr
  98. @defvr {Configure option} --disable-cuda-memcpy-peer
  99. Explicitly disable peer transfers when using CUDA 4.0.
  100. @end defvr
  101. @defvr {Configure option} --enable-maxopencldev=@var{count}
  102. Use at most @var{count} OpenCL devices. This information is then
  103. available as the @code{STARPU_MAXOPENCLDEVS} macro.
  104. @end defvr
  105. @defvr {Configure option} --disable-opencl
  106. Disable the use of OpenCL, even if the SDK is detected.
  107. @end defvr
  108. @defvr {Configure option} --with-opencl-dir=@var{prefix}
  109. Search for an OpenCL implementation under @var{prefix}, which should
  110. notably contain @file{include/CL/cl.h} (or @file{include/OpenCL/cl.h} on
  111. Mac OS).
  112. @end defvr
  113. @defvr {Configure option} --with-opencl-include-dir=@var{dir}
  114. Search for OpenCL headers under @var{dir}, which should notably contain
  115. @file{CL/cl.h} (or @file{OpenCL/cl.h} on Mac OS). This defaults to
  116. @code{/include} appended to the value given to @code{--with-opencl-dir}.
  117. @end defvr
  118. @defvr {Configure option} --with-opencl-lib-dir=@var{dir}
  119. Search for an OpenCL library under @var{dir}, which should notably
  120. contain the OpenCL shared libraries---e.g. @file{libOpenCL.so}. This defaults to
  121. @code{/lib} appended to the value given to @code{--with-opencl-dir}.
  122. @end defvr
  123. @defvr {Configure option} --enable-opencl-simulator
  124. Enable considering the provided OpenCL implementation as a simulator, i.e. use
  125. the kernel duration returned by OpenCL profiling information as wallclock time
  126. instead of the actual measured real time. This requires simgrid support.
  127. @end defvr
  128. @defvr {Configure option} --enable-maximplementations=@var{count}
  129. Allow for at most @var{count} codelet implementations for the same
  130. target device. This information is then available as the
  131. @code{STARPU_MAXIMPLEMENTATIONS} macro.
  132. @end defvr
  133. @defvr {Configure option} --enable-max-sched-ctxs=@var{count}
  134. Allow for at most @var{count} scheduling contexts
  135. This information is then available as the
  136. @code{STARPU_NMAX_SCHED_CTXS} macro.
  137. @end defvr
  138. @defvr {Configure option} --disable-asynchronous-copy
  139. Disable asynchronous copies between CPU and GPU devices.
  140. The AMD implementation of OpenCL is known to
  141. fail when copying data asynchronously. When using this implementation,
  142. it is therefore necessary to disable asynchronous data transfers.
  143. @end defvr
  144. @defvr {Configure option} --disable-asynchronous-cuda-copy
  145. Disable asynchronous copies between CPU and CUDA devices.
  146. @end defvr
  147. @defvr {Configure option} --disable-asynchronous-opencl-copy
  148. Disable asynchronous copies between CPU and OpenCL devices.
  149. The AMD implementation of OpenCL is known to
  150. fail when copying data asynchronously. When using this implementation,
  151. it is therefore necessary to disable asynchronous data transfers.
  152. @end defvr
  153. @node Extension configuration
  154. @subsection Extension configuration
  155. @defvr {Configure option} --disable-socl
  156. Disable the SOCL extension (@pxref{SOCL OpenCL Extensions}). By
  157. default, it is enabled when an OpenCL implementation is found.
  158. @end defvr
  159. @defvr {Configure option} --disable-starpu-top
  160. Disable the StarPU-Top interface (@pxref{StarPU-Top}). By default, it
  161. is enabled when the required dependencies are found.
  162. @end defvr
  163. @defvr {Configure option} --disable-gcc-extensions
  164. Disable the GCC plug-in (@pxref{C Extensions}). By default, it is
  165. enabled when the GCC compiler provides a plug-in support.
  166. @end defvr
  167. @defvr {Configure option} --with-mpicc=@var{path}
  168. Use the @command{mpicc} compiler at @var{path}, for starpumpi
  169. (@pxref{StarPU MPI support}).
  170. @end defvr
  171. @node Advanced configuration
  172. @subsection Advanced configuration
  173. @defvr {Configure option} --enable-perf-debug
  174. Enable performance debugging through gprof.
  175. @end defvr
  176. @defvr {Configure option} --enable-model-debug
  177. Enable performance model debugging.
  178. @end defvr
  179. @defvr {Configure option} --enable-stats
  180. @c see ../../src/datawizard/datastats.c
  181. Enable gathering of various data statistics (@pxref{Data statistics}).
  182. @end defvr
  183. @defvr {Configure option} --enable-maxbuffers
  184. Define the maximum number of buffers that tasks will be able to take
  185. as parameters, then available as the @code{STARPU_NMAXBUFS} macro.
  186. @end defvr
  187. @defvr {Configure option} --enable-allocation-cache
  188. Enable the use of a data allocation cache to avoid the cost of it with
  189. CUDA. Still experimental.
  190. @end defvr
  191. @defvr {Configure option} --enable-opengl-render
  192. Enable the use of OpenGL for the rendering of some examples.
  193. @c TODO: rather default to enabled when detected
  194. @end defvr
  195. @defvr {Configure option} --enable-blas-lib
  196. Specify the blas library to be used by some of the examples. The
  197. library has to be 'atlas' or 'goto'.
  198. @end defvr
  199. @defvr {Configure option} --disable-starpufft
  200. Disable the build of libstarpufft, even if fftw or cuFFT is available.
  201. @end defvr
  202. @defvr {Configure option} --with-magma=@var{prefix}
  203. Search for MAGMA under @var{prefix}. @var{prefix} should notably
  204. contain @file{include/magmablas.h}.
  205. @end defvr
  206. @defvr {Configure option} --with-fxt=@var{prefix}
  207. Search for FxT under @var{prefix}.
  208. @url{http://savannah.nongnu.org/projects/fkt, FxT} is used to generate
  209. traces of scheduling events, which can then be rendered them using ViTE
  210. (@pxref{Off-line, off-line performance feedback}). @var{prefix} should
  211. notably contain @code{include/fxt/fxt.h}.
  212. @end defvr
  213. @defvr {Configure option} --with-perf-model-dir=@var{dir}
  214. Store performance models under @var{dir}, instead of the current user's
  215. home.
  216. @end defvr
  217. @defvr {Configure option} --with-goto-dir=@var{prefix}
  218. Search for GotoBLAS under @var{prefix}, which should notably contain @file{libgoto.so} or @file{libgoto2.so}.
  219. @end defvr
  220. @defvr {Configure option} --with-atlas-dir=@var{prefix}
  221. Search for ATLAS under @var{prefix}, which should notably contain
  222. @file{include/cblas.h}.
  223. @end defvr
  224. @defvr {Configure option} --with-mkl-cflags=@var{cflags}
  225. Use @var{cflags} to compile code that uses the MKL library.
  226. @end defvr
  227. @defvr {Configure option} --with-mkl-ldflags=@var{ldflags}
  228. Use @var{ldflags} when linking code that uses the MKL library. Note
  229. that the
  230. @url{http://software.intel.com/en-us/articles/intel-mkl-link-line-advisor/,
  231. MKL website} provides a script to determine the linking flags.
  232. @end defvr
  233. @defvr {Configure option} --disable-build-examples
  234. Disable the build of examples.
  235. @end defvr
  236. @defvr {Configure option} --enable-sched-ctx-hypervisor
  237. Enables the Scheduling Context Hypervisor plugin(@pxref{Scheduling Context Hypervisor}).
  238. By default, it is disabled.
  239. @end defvr
  240. @defvr {Configure option} --enable-memory-stats
  241. Enable memory statistics (@pxref{Memory feedback}).
  242. @end defvr
  243. @defvr {Configure option} --enable-simgrid
  244. Enable simulation of execution in simgrid, to allow easy experimentation with
  245. various numbers of cores and GPUs, or amount of memory, etc. Experimental.
  246. The path to simgrid can be specified through the @code{SIMGRID_CFLAGS} and
  247. @code{SIMGRID_LIBS} environment variables, for instance:
  248. @example
  249. export SIMGRID_CFLAGS="-I/usr/local/simgrid/include"
  250. export SIMGRID_LIBS="-L/usr/local/simgrid/lib -lsimgrid"
  251. @end example
  252. @end defvr
  253. @node Execution configuration through environment variables
  254. @section Execution configuration through environment variables
  255. @menu
  256. * Workers:: Configuring workers
  257. * Scheduling:: Configuring the Scheduling engine
  258. * Extensions::
  259. * Misc:: Miscellaneous and debug
  260. @end menu
  261. @node Workers
  262. @subsection Configuring workers
  263. @defvr {Environment variable} STARPU_NCPU
  264. Specify the number of CPU workers (thus not including workers dedicated to control accelerators). Note that by default, StarPU will not allocate
  265. more CPU workers than there are physical CPUs, and that some CPUs are used to control
  266. the accelerators.
  267. @end defvr
  268. @defvr {Environment variable} STARPU_NCPUS
  269. This variable is deprecated. You should use @code{STARPU_NCPU}.
  270. @end defvr
  271. @defvr {Environment variable} STARPU_NCUDA
  272. Specify the number of CUDA devices that StarPU can use. If
  273. @code{STARPU_NCUDA} is lower than the number of physical devices, it is
  274. possible to select which CUDA devices should be used by the means of the
  275. @code{STARPU_WORKERS_CUDAID} environment variable. By default, StarPU will
  276. create as many CUDA workers as there are CUDA devices.
  277. @end defvr
  278. @defvr {Environment variable} STARPU_NOPENCL
  279. OpenCL equivalent of the @code{STARPU_NCUDA} environment variable.
  280. @end defvr
  281. @defvr {Environment variable} STARPU_OPENCL_ON_CPUS
  282. By default, the OpenCL driver only enables GPU and accelerator
  283. devices. By setting the environment variable
  284. @code{STARPU_OPENCL_ON_CPUS} to 1, the OpenCL driver will also enable
  285. CPU devices.
  286. @end defvr
  287. @defvr {Environment variable} STARPU_OPENCL_ONLY_ON_CPUS
  288. By default, the OpenCL driver enables GPU and accelerator
  289. devices. By setting the environment variable
  290. @code{STARPU_OPENCL_ONLY_ON_CPUS} to 1, the OpenCL driver will ONLY enable
  291. CPU devices.
  292. @end defvr
  293. @defvr {Environment variable} STARPU_WORKERS_NOBIND
  294. Setting it to non-zero will prevent StarPU from binding its threads to
  295. CPUs. This is for instance useful when running the testsuite in parallel.
  296. @end defvr
  297. @defvr {Environment variable} STARPU_WORKERS_CPUID
  298. Passing an array of integers (starting from 0) in @code{STARPU_WORKERS_CPUID}
  299. specifies on which logical CPU the different workers should be
  300. bound. For instance, if @code{STARPU_WORKERS_CPUID = "0 1 4 5"}, the first
  301. worker will be bound to logical CPU #0, the second CPU worker will be bound to
  302. logical CPU #1 and so on. Note that the logical ordering of the CPUs is either
  303. determined by the OS, or provided by the @code{hwloc} library in case it is
  304. available.
  305. Note that the first workers correspond to the CUDA workers, then come the
  306. OpenCL workers, and finally the CPU workers. For example if
  307. we have @code{STARPU_NCUDA=1}, @code{STARPU_NOPENCL=1}, @code{STARPU_NCPU=2}
  308. and @code{STARPU_WORKERS_CPUID = "0 2 1 3"}, the CUDA device will be controlled
  309. by logical CPU #0, the OpenCL device will be controlled by logical CPU #2, and
  310. the logical CPUs #1 and #3 will be used by the CPU workers.
  311. If the number of workers is larger than the array given in
  312. @code{STARPU_WORKERS_CPUID}, the workers are bound to the logical CPUs in a
  313. round-robin fashion: if @code{STARPU_WORKERS_CPUID = "0 1"}, the first and the
  314. third (resp. second and fourth) workers will be put on CPU #0 (resp. CPU #1).
  315. This variable is ignored if the @code{use_explicit_workers_bindid} flag of the
  316. @code{starpu_conf} structure passed to @code{starpu_init} is set.
  317. @end defvr
  318. @defvr {Environment variable} STARPU_WORKERS_CUDAID
  319. Similarly to the @code{STARPU_WORKERS_CPUID} environment variable, it is
  320. possible to select which CUDA devices should be used by StarPU. On a machine
  321. equipped with 4 GPUs, setting @code{STARPU_WORKERS_CUDAID = "1 3"} and
  322. @code{STARPU_NCUDA=2} specifies that 2 CUDA workers should be created, and that
  323. they should use CUDA devices #1 and #3 (the logical ordering of the devices is
  324. the one reported by CUDA).
  325. This variable is ignored if the @code{use_explicit_workers_cuda_gpuid} flag of
  326. the @code{starpu_conf} structure passed to @code{starpu_init} is set.
  327. @end defvr
  328. @defvr {Environment variable} STARPU_WORKERS_OPENCLID
  329. OpenCL equivalent of the @code{STARPU_WORKERS_CUDAID} environment variable.
  330. This variable is ignored if the @code{use_explicit_workers_opencl_gpuid} flag of
  331. the @code{starpu_conf} structure passed to @code{starpu_init} is set.
  332. @end defvr
  333. @defvr {Environment variable} @code{STARPU_SINGLE_COMBINED_WORKER}
  334. If set, StarPU will create several workers which won't be able to work
  335. concurrently. It will by default create combined workers which size goes from 1
  336. to the total number of CPU workers in the system. @code{STARPU_MIN_WORKERSIZE}
  337. and @code{STARPU_MAX_WORKERSIZE} can be used to change this default.
  338. @end defvr
  339. @defvr {Environment variable} @code{STARPU_MIN_WORKERSIZE}
  340. When @code{STARPU_SINGLE_COMBINED_WORKER} is set, @code{STARPU_MIN_WORKERSIZE}
  341. permits to specify the minimum size of the combined workers (instead of the default 1)
  342. @end defvr
  343. @defvr {Environment variable} @code{STARPU_MAX_WORKERSIZE}
  344. When @code{STARPU_SINGLE_COMBINED_WORKER} is set, @code{STARPU_MAX_WORKERSIZE}
  345. permits to specify the minimum size of the combined workers (instead of the
  346. number of CPU workers in the system)
  347. @end defvr
  348. @defvr {Environment variable} STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
  349. Let the user decide how many elements are allowed between combined workers
  350. created from hwloc information. For instance, in the case of sockets with 6
  351. cores without shared L2 caches, if @code{SYNTHESIZE_ARITY_COMBINED_WORKER} is
  352. set to 6, no combined worker will be synthesized beyond one for the socket
  353. and one per core. If it is set to 3, 3 intermediate combined workers will be
  354. synthesized, to divide the socket cores into 3 chunks of 2 cores. If it set to
  355. 2, 2 intermediate combined workers will be synthesized, to divide the the socket
  356. cores into 2 chunks of 3 cores, and then 3 additional combined workers will be
  357. synthesized, to divide the former synthesized workers into a bunch of 2 cores,
  358. and the remaining core (for which no combined worker is synthesized since there
  359. is already a normal worker for it).
  360. The default, 2, thus makes StarPU tend to building a binary trees of combined
  361. workers.
  362. @end defvr
  363. @defvr {Environment variable} STARPU_DISABLE_ASYNCHRONOUS_COPY
  364. Disable asynchronous copies between CPU and GPU devices.
  365. The AMD implementation of OpenCL is known to
  366. fail when copying data asynchronously. When using this implementation,
  367. it is therefore necessary to disable asynchronous data transfers.
  368. @end defvr
  369. @defvr {Environment variable} STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY
  370. Disable asynchronous copies between CPU and CUDA devices.
  371. @end defvr
  372. @defvr {Environment variable} STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY
  373. Disable asynchronous copies between CPU and OpenCL devices.
  374. The AMD implementation of OpenCL is known to
  375. fail when copying data asynchronously. When using this implementation,
  376. it is therefore necessary to disable asynchronous data transfers.
  377. @end defvr
  378. @defvr {Environment variable} STARPU_DISABLE_CUDA_GPU_GPU_DIRECT
  379. Disable direct CUDA transfers from GPU to GPU, and let CUDA copy through RAM
  380. instead. This permits to test the performance effect of GPU-Direct.
  381. @end defvr
  382. @node Scheduling
  383. @subsection Configuring the Scheduling engine
  384. @defvr {Environment variable} STARPU_SCHED
  385. Choose between the different scheduling policies proposed by StarPU: work
  386. random, stealing, greedy, with performance models, etc.
  387. Use @code{STARPU_SCHED=help} to get the list of available schedulers.
  388. @end defvr
  389. @defvr {Environment variable} STARPU_CALIBRATE
  390. If this variable is set to 1, the performance models are calibrated during
  391. the execution. If it is set to 2, the previous values are dropped to restart
  392. calibration from scratch. Setting this variable to 0 disable calibration, this
  393. is the default behaviour.
  394. Note: this currently only applies to @code{dm} and @code{dmda} scheduling policies.
  395. @end defvr
  396. @defvr {Environment variable} STARPU_BUS_CALIBRATE
  397. If this variable is set to 1, the bus is recalibrated during intialization.
  398. @end defvr
  399. @defvr {Environment variable} STARPU_PREFETCH
  400. @anchor{STARPU_PREFETCH}
  401. This variable indicates whether data prefetching should be enabled (0 means
  402. that it is disabled). If prefetching is enabled, when a task is scheduled to be
  403. executed e.g. on a GPU, StarPU will request an asynchronous transfer in
  404. advance, so that data is already present on the GPU when the task starts. As a
  405. result, computation and data transfers are overlapped.
  406. Note that prefetching is enabled by default in StarPU.
  407. @end defvr
  408. @defvr {Environment variable} STARPU_SCHED_ALPHA
  409. To estimate the cost of a task StarPU takes into account the estimated
  410. computation time (obtained thanks to performance models). The alpha factor is
  411. the coefficient to be applied to it before adding it to the communication part.
  412. @end defvr
  413. @defvr {Environment variable} STARPU_SCHED_BETA
  414. To estimate the cost of a task StarPU takes into account the estimated
  415. data transfer time (obtained thanks to performance models). The beta factor is
  416. the coefficient to be applied to it before adding it to the computation part.
  417. @end defvr
  418. @defvr {Environment variable} STARPU_SCHED_GAMMA
  419. Define the execution time penalty of a joule (@pxref{Power-based scheduling}).
  420. @end defvr
  421. @defvr {Environment variable} STARPU_IDLE_POWER
  422. Define the idle power of the machine (@pxref{Power-based scheduling}).
  423. @end defvr
  424. @defvr {Environment variable} STARPU_PROFILING
  425. Enable on-line performance monitoring (@pxref{Enabling on-line performance monitoring}).
  426. @end defvr
  427. @node Extensions
  428. @subsection Extensions
  429. @defvr {Environment variable} SOCL_OCL_LIB_OPENCL
  430. THE SOCL test suite is only run when the environment variable
  431. @code{SOCL_OCL_LIB_OPENCL} is defined. It should contain the location
  432. of the libOpenCL.so file of the OCL ICD implementation.
  433. @end defvr
  434. @defvr {Environment variable} STARPU_COMM_STATS
  435. @anchor{STARPU_COMM_STATS}
  436. Communication statistics for starpumpi (@pxref{StarPU MPI support})
  437. will be enabled when the environment variable @code{STARPU_COMM_STATS}
  438. is defined to an value other than 0.
  439. @end defvr
  440. @defvr {Environment variable} STARPU_MPI_CACHE
  441. @anchor{STARPU_MPI_CACHE}
  442. Communication cache for starpumpi (@pxref{StarPU MPI support}) will be
  443. disabled when the environment variable @code{STARPU_MPI_CACHE} is set
  444. to 0. It is enabled by default or for any other values of the variable
  445. @code{STARPU_MPI_CACHE}.
  446. @end defvr
  447. @node Misc
  448. @subsection Miscellaneous and debug
  449. @defvr {Environment variable} STARPU_HOME
  450. @anchor{STARPU_HOME}
  451. This specifies the main directory in which StarPU stores its
  452. configuration files. The default is @code{$HOME} on Unix environments,
  453. and @code{$USERPROFILE} on Windows environments.
  454. @end defvr
  455. @defvr {Environment variable} STARPU_HOSTNAME
  456. When set, force the hostname to be used when dealing performance model
  457. files. Models are indexed by machine name. When running for example on
  458. a homogenenous cluster, it is possible to share the models between
  459. machines by setting @code{export STARPU_HOSTNAME=some_global_name}.
  460. @end defvr
  461. @defvr {Environment variable} STARPU_OPENCL_PROGRAM_DIR
  462. @anchor{STARPU_OPENCL_PROGRAM_DIR}
  463. This specifies the directory where the OpenCL codelet source files are
  464. located. The function @ref{starpu_opencl_load_program_source} looks
  465. for the codelet in the current directory, in the directory specified
  466. by the environment variable @code{STARPU_OPENCL_PROGRAM_DIR}, in the
  467. directory @code{share/starpu/opencl} of the installation directory of
  468. StarPU, and finally in the source directory of StarPU.
  469. @end defvr
  470. @defvr {Environment variable} STARPU_SILENT
  471. This variable allows to disable verbose mode at runtime when StarPU
  472. has been configured with the option @code{--enable-verbose}. It also
  473. disables the display of StarPU information and warning messages.
  474. @end defvr
  475. @defvr {Environment variable} STARPU_LOGFILENAME
  476. This variable specifies in which file the debugging output should be saved to.
  477. @end defvr
  478. @defvr {Environment variable} STARPU_FXT_PREFIX
  479. This variable specifies in which directory to save the trace generated if FxT is enabled. It needs to have a trailing '/' character.
  480. @end defvr
  481. @defvr {Environment variable} STARPU_LIMIT_CUDA_devid_MEM
  482. This variable specifies the maximum number of megabytes that should be
  483. available to the application on the CUDA device with the identifier
  484. @code{devid}. This variable is intended to be used for experimental
  485. purposes as it emulates devices that have a limited amount of memory.
  486. When defined, the variable overwrites the value of the variable
  487. @code{STARPU_LIMIT_CUDA_MEM}.
  488. @end defvr
  489. @defvr {Environment variable} STARPU_LIMIT_CUDA_MEM
  490. This variable specifies the maximum number of megabytes that should be
  491. available to the application on each CUDA devices. This variable is
  492. intended to be used for experimental purposes as it emulates devices
  493. that have a limited amount of memory.
  494. @end defvr
  495. @defvr {Environment variable} STARPU_LIMIT_OPENCL_devid_MEM
  496. This variable specifies the maximum number of megabytes that should be
  497. available to the application on the OpenCL device with the identifier
  498. @code{devid}. This variable is intended to be used for experimental
  499. purposes as it emulates devices that have a limited amount of memory.
  500. When defined, the variable overwrites the value of the variable
  501. @code{STARPU_LIMIT_OPENCL_MEM}.
  502. @end defvr
  503. @defvr {Environment variable} STARPU_LIMIT_OPENCL_MEM
  504. This variable specifies the maximum number of megabytes that should be
  505. available to the application on each OpenCL devices. This variable is
  506. intended to be used for experimental purposes as it emulates devices
  507. that have a limited amount of memory.
  508. @end defvr
  509. @defvr {Environment variable} STARPU_LIMIT_CPU_MEM
  510. This variable specifies the maximum number of megabytes that should be
  511. available to the application on each CPU device. This variable is
  512. intended to be used for experimental purposes as it emulates devices
  513. that have a limited amount of memory.
  514. @end defvr
  515. @defvr {Environment variable} STARPU_GENERATE_TRACE
  516. When set to @code{1}, this variable indicates that StarPU should automatically
  517. generate a Paje trace when @code{starpu_shutdown()} is called.
  518. @end defvr
  519. @defvr {Environment variable} STARPU_MEMORY_STATS
  520. When set to 0, disable the display of memory statistics on data which
  521. have not been unregistered at the end of the execution (@pxref{Memory
  522. feedback}).
  523. @end defvr
  524. @defvr {Environment variable} STARPU_BUS_STATS
  525. When defined, statistics about data transfers will be displayed when calling
  526. @code{starpu_shutdown()} (@pxref{Profiling}).
  527. @end defvr
  528. @defvr {Environment variable} STARPU_WORKER_STATS
  529. When defined, statistics about the workers will be displayed when calling
  530. @code{starpu_shutdown()} (@pxref{Profiling}). When combined with the
  531. environment variable @code{STARPU_PROFILING}, it displays the power
  532. consumption (@pxref{Power-based scheduling}).
  533. @end defvr
  534. @defvr {Environment variable} STARPU_STATS
  535. When set to 0, data statistics will not be displayed at the
  536. end of the execution of an application (@pxref{Data statistics}).
  537. @end defvr