501_environment_variables.doxy 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315
  1. /* StarPU --- Runtime system for heterogeneous multicore architectures.
  2. *
  3. * Copyright (C) 2011-2013,2015-2017 Inria
  4. * Copyright (C) 2010-2019 CNRS
  5. * Copyright (C) 2009-2011,2013-2018 Université de Bordeaux
  6. * Copyright (C) 2016 Uppsala University
  7. *
  8. * StarPU is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU Lesser General Public License as published by
  10. * the Free Software Foundation; either version 2.1 of the License, or (at
  11. * your option) any later version.
  12. *
  13. * StarPU is distributed in the hope that it will be useful, but
  14. * WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16. *
  17. * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  18. */
  19. /*! \page ExecutionConfigurationThroughEnvironmentVariables Execution Configuration Through Environment Variables
  20. The behavior of the StarPU library and tools may be tuned thanks to
  21. the following environment variables.
  22. \section ConfiguringWorkers Configuring Workers
  23. <dl>
  24. <dt>STARPU_NCPU</dt>
  25. <dd>
  26. \anchor STARPU_NCPU
  27. \addindex __env__STARPU_NCPU
  28. Specify the number of CPU workers (thus not including workers
  29. dedicated to control accelerators). Note that by default, StarPU will
  30. not allocate more CPU workers than there are physical CPUs, and that
  31. some CPUs are used to control the accelerators.
  32. </dd>
  33. <dt>STARPU_RESERVE_NCPU</dt>
  34. <dd>
  35. \anchor STARPU_RESERVE_NCPU
  36. \addindex __env__STARPU_RESERVE_NCPU
  37. Specify the number of CPU cores that should not be used by StarPU, so the
  38. application can use starpu_get_next_bindid() and starpu_bind_thread_on() to bind
  39. its own threads.
  40. This option is ignored if \ref STARPU_NCPU or starpu_conf::ncpus is set.
  41. </dd>
  42. <dt>STARPU_NCPUS</dt>
  43. <dd>
  44. \anchor STARPU_NCPUS
  45. \addindex __env__STARPU_NCPUS
  46. This variable is deprecated. You should use \ref STARPU_NCPU.
  47. </dd>
  48. <dt>STARPU_NCUDA</dt>
  49. <dd>
  50. \anchor STARPU_NCUDA
  51. \addindex __env__STARPU_NCUDA
  52. Specify the number of CUDA devices that StarPU can use. If
  53. \ref STARPU_NCUDA is lower than the number of physical devices, it is
  54. possible to select which CUDA devices should be used by the means of the
  55. environment variable \ref STARPU_WORKERS_CUDAID. By default, StarPU will
  56. create as many CUDA workers as there are CUDA devices.
  57. </dd>
  58. <dt>STARPU_NWORKER_PER_CUDA</dt>
  59. <dd>
  60. \anchor STARPU_NWORKER_PER_CUDA
  61. \addindex __env__STARPU_NWORKER_PER_CUDA
  62. Specify the number of workers per CUDA device, and thus the number of kernels
  63. which will be concurrently running on the devices. The default value is 1.
  64. </dd>
  65. <dt>STARPU_CUDA_THREAD_PER_WORKER</dt>
  66. <dd>
  67. \anchor STARPU_CUDA_THREAD_PER_WORKER
  68. \addindex __env__STARPU_CUDA_THREAD_PER_WORKER
  69. Specify whether the cuda driver should use one thread per stream (1) or to use
  70. a single thread to drive all the streams of the device or all devices (0), and
  71. \ref STARPU_CUDA_THREAD_PER_DEV determines whether is it one thread per device or one
  72. thread for all devices. The default value is 0. Setting it to 1 is contradictory
  73. with setting \ref STARPU_CUDA_THREAD_PER_DEV.
  74. </dd>
  75. <dt>STARPU_CUDA_THREAD_PER_DEV</dt>
  76. <dd>
  77. \anchor STARPU_CUDA_THREAD_PER_DEV
  78. \addindex __env__STARPU_CUDA_THREAD_PER_DEV
  79. Specify whether the cuda driver should use one thread per device (1) or to use a
  80. single thread to drive all the devices (0). The default value is 1. It does not
  81. make sense to set this variable if \ref STARPU_CUDA_THREAD_PER_WORKER is set to to 1
  82. (since \ref STARPU_CUDA_THREAD_PER_DEV is then meaningless).
  83. </dd>
  84. <dt>STARPU_CUDA_PIPELINE</dt>
  85. <dd>
  86. \anchor STARPU_CUDA_PIPELINE
  87. \addindex __env__STARPU_CUDA_PIPELINE
  88. Specify how many asynchronous tasks are submitted in advance on CUDA
  89. devices. This for instance permits to overlap task management with the execution
  90. of previous tasks, but it also allows concurrent execution on Fermi cards, which
  91. otherwise bring spurious synchronizations. The default is 2. Setting the value to 0 forces a synchronous
  92. execution of all tasks.
  93. </dd>
  94. <dt>STARPU_NOPENCL</dt>
  95. <dd>
  96. \anchor STARPU_NOPENCL
  97. \addindex __env__STARPU_NOPENCL
  98. OpenCL equivalent of the environment variable \ref STARPU_NCUDA.
  99. </dd>
  100. <dt>STARPU_OPENCL_PIPELINE</dt>
  101. <dd>
  102. \anchor STARPU_OPENCL_PIPELINE
  103. \addindex __env__STARPU_OPENCL_PIPELINE
  104. Specify how many asynchronous tasks are submitted in advance on OpenCL
  105. devices. This for instance permits to overlap task management with the execution
  106. of previous tasks, but it also allows concurrent execution on Fermi cards, which
  107. otherwise bring spurious synchronizations. The default is 2. Setting the value to 0 forces a synchronous
  108. execution of all tasks.
  109. </dd>
  110. <dt>STARPU_OPENCL_ON_CPUS</dt>
  111. <dd>
  112. \anchor STARPU_OPENCL_ON_CPUS
  113. \addindex __env__STARPU_OPENCL_ON_CPUS
  114. By default, the OpenCL driver only enables GPU and accelerator
  115. devices. By setting the environment variable \ref STARPU_OPENCL_ON_CPUS
  116. to 1, the OpenCL driver will also enable CPU devices.
  117. </dd>
  118. <dt>STARPU_OPENCL_ONLY_ON_CPUS</dt>
  119. <dd>
  120. \anchor STARPU_OPENCL_ONLY_ON_CPUS
  121. \addindex __env__STARPU_OPENCL_ONLY_ON_CPUS
  122. By default, the OpenCL driver enables GPU and accelerator
  123. devices. By setting the environment variable \ref STARPU_OPENCL_ONLY_ON_CPUS
  124. to 1, the OpenCL driver will ONLY enable CPU devices.
  125. </dd>
  126. <dt>STARPU_NMIC</dt>
  127. <dd>
  128. \anchor STARPU_NMIC
  129. \addindex __env__STARPU_NMIC
  130. MIC equivalent of the environment variable \ref STARPU_NCUDA, i.e. the number of
  131. MIC devices to use.
  132. </dd>
  133. <dt>STARPU_NMICTHREADS</dt>
  134. <dd>
  135. \anchor STARPU_NMICTHREADS
  136. \addindex __env__STARPU_NMICTHREADS
  137. Number of threads to use on the MIC devices.
  138. </dd>
  139. <dt>STARPU_NMPI_MS</dt>
  140. <dd>
  141. \anchor STARPU_NMPI_MS
  142. \addindex __env__STARPU_NMPI_MS
  143. MPI Master Slave equivalent of the environment variable \ref STARPU_NCUDA, i.e. the number of
  144. MPI Master Slave devices to use.
  145. </dd>
  146. <dt>STARPU_NMPIMSTHREADS</dt>
  147. <dd>
  148. \anchor STARPU_NMPIMSTHREADS
  149. \addindex __env__STARPU_NMPIMSTHREADS
  150. Number of threads to use on the MPI Slave devices.
  151. </dd>
  152. <dt>STARPU_MPI_MASTER_NODE</dt>
  153. <dd>
  154. \anchor STARPU_MPI_MASTER_NODE
  155. \addindex __env__STARPU_MPI_MASTER_NODE
  156. This variable allows to chose which MPI node (with the MPI ID) will be the master.
  157. </dd>
  158. <dt>STARPU_NSCC</dt>
  159. <dd>
  160. \anchor STARPU_NSCC
  161. \addindex __env__STARPU_NSCC
  162. SCC equivalent of the environment variable \ref STARPU_NCUDA.
  163. </dd>
  164. <dt>STARPU_WORKERS_NOBIND</dt>
  165. <dd>
  166. \anchor STARPU_WORKERS_NOBIND
  167. \addindex __env__STARPU_WORKERS_NOBIND
  168. Setting it to non-zero will prevent StarPU from binding its threads to
  169. CPUs. This is for instance useful when running the testsuite in parallel.
  170. </dd>
  171. <dt>STARPU_WORKERS_CPUID</dt>
  172. <dd>
  173. \anchor STARPU_WORKERS_CPUID
  174. \addindex __env__STARPU_WORKERS_CPUID
  175. Passing an array of integers in \ref STARPU_WORKERS_CPUID
  176. specifies on which logical CPU the different workers should be
  177. bound. For instance, if <c>STARPU_WORKERS_CPUID = "0 1 4 5"</c>, the first
  178. worker will be bound to logical CPU #0, the second CPU worker will be bound to
  179. logical CPU #1 and so on. Note that the logical ordering of the CPUs is either
  180. determined by the OS, or provided by the library <c>hwloc</c> in case it is
  181. available. Ranges can be provided: for instance, <c>STARPU_WORKERS_CPUID = "1-3
  182. 5"</c> will bind the first three workers on logical CPUs #1, #2, and #3, and the
  183. fourth worker on logical CPU #5. Unbound ranges can also be provided:
  184. <c>STARPU_WORKERS_CPUID = "1-"</c> will bind the workers starting from logical
  185. CPU #1 up to last CPU.
  186. Note that the first workers correspond to the CUDA workers, then come the
  187. OpenCL workers, and finally the CPU workers. For example if
  188. we have <c>STARPU_NCUDA=1</c>, <c>STARPU_NOPENCL=1</c>, <c>STARPU_NCPU=2</c>
  189. and <c>STARPU_WORKERS_CPUID = "0 2 1 3"</c>, the CUDA device will be controlled
  190. by logical CPU #0, the OpenCL device will be controlled by logical CPU #2, and
  191. the logical CPUs #1 and #3 will be used by the CPU workers.
  192. If the number of workers is larger than the array given in
  193. \ref STARPU_WORKERS_CPUID, the workers are bound to the logical CPUs in a
  194. round-robin fashion: if <c>STARPU_WORKERS_CPUID = "0 1"</c>, the first
  195. and the third (resp. second and fourth) workers will be put on CPU #0
  196. (resp. CPU #1).
  197. This variable is ignored if the field
  198. starpu_conf::use_explicit_workers_bindid passed to starpu_init() is
  199. set.
  200. </dd>
  201. <dt>STARPU_MAIN_THREAD_BIND</dt>
  202. <dd>
  203. \anchor STARPU_MAIN_THREAD_BIND
  204. \addindex __env__STARPU_MAIN_THREAD_BIND
  205. When defined, this make StarPU bind the thread that calls starpu_initialize() to
  206. a reserved CPU, subtracted from the CPU workers.
  207. </dd>
  208. <dt>STARPU_MAIN_THREAD_CPUID</dt>
  209. <dd>
  210. \anchor STARPU_MAIN_THREAD_CPUID
  211. \addindex __env__STARPU_MAIN_THREAD_CPUID
  212. When defined, this make StarPU bind the thread that calls starpu_initialize() to
  213. the given CPU ID.
  214. </dd>
  215. <dt>STARPU_MPI_THREAD_CPUID</dt>
  216. <dd>
  217. \anchor STARPU_MPI_THREAD_CPUID
  218. \addindex __env__STARPU_MPI_THREAD_CPUID
  219. When defined, this make StarPU bind its MPI thread to the given CPU ID. Setting
  220. it to -1 (the default value) will use a reserved CPU, subtracted from the CPU
  221. workers.
  222. </dd>
  223. <dt>STARPU_WORKERS_CUDAID</dt>
  224. <dd>
  225. \anchor STARPU_WORKERS_CUDAID
  226. \addindex __env__STARPU_WORKERS_CUDAID
  227. Similarly to the \ref STARPU_WORKERS_CPUID environment variable, it is
  228. possible to select which CUDA devices should be used by StarPU. On a machine
  229. equipped with 4 GPUs, setting <c>STARPU_WORKERS_CUDAID = "1 3"</c> and
  230. <c>STARPU_NCUDA=2</c> specifies that 2 CUDA workers should be created, and that
  231. they should use CUDA devices #1 and #3 (the logical ordering of the devices is
  232. the one reported by CUDA).
  233. This variable is ignored if the field
  234. starpu_conf::use_explicit_workers_cuda_gpuid passed to starpu_init()
  235. is set.
  236. </dd>
  237. <dt>STARPU_WORKERS_OPENCLID</dt>
  238. <dd>
  239. \anchor STARPU_WORKERS_OPENCLID
  240. \addindex __env__STARPU_WORKERS_OPENCLID
  241. OpenCL equivalent of the \ref STARPU_WORKERS_CUDAID environment variable.
  242. This variable is ignored if the field
  243. starpu_conf::use_explicit_workers_opencl_gpuid passed to starpu_init()
  244. is set.
  245. </dd>
  246. <dt>STARPU_WORKERS_MICID</dt>
  247. <dd>
  248. \anchor STARPU_WORKERS_MICID
  249. \addindex __env__STARPU_WORKERS_MICID
  250. MIC equivalent of the \ref STARPU_WORKERS_CUDAID environment variable.
  251. This variable is ignored if the field
  252. starpu_conf::use_explicit_workers_mic_deviceid passed to starpu_init()
  253. is set.
  254. </dd>
  255. <dt>STARPU_WORKERS_SCCID</dt>
  256. <dd>
  257. \anchor STARPU_WORKERS_SCCID
  258. \addindex __env__STARPU_WORKERS_SCCID
  259. SCC equivalent of the \ref STARPU_WORKERS_CUDAID environment variable.
  260. This variable is ignored if the field
  261. starpu_conf::use_explicit_workers_scc_deviceid passed to starpu_init()
  262. is set.
  263. </dd>
  264. <dt>STARPU_WORKER_TREE</dt>
  265. <dd>
  266. \anchor STARPU_WORKER_TREE
  267. \addindex __env__STARPU_WORKER_TREE
  268. Define to 1 to enable the tree iterator in schedulers.
  269. </dd>
  270. <dt>STARPU_SINGLE_COMBINED_WORKER</dt>
  271. <dd>
  272. \anchor STARPU_SINGLE_COMBINED_WORKER
  273. \addindex __env__STARPU_SINGLE_COMBINED_WORKER
  274. If set, StarPU will create several workers which won't be able to work
  275. concurrently. It will by default create combined workers which size goes from 1
  276. to the total number of CPU workers in the system. \ref STARPU_MIN_WORKERSIZE
  277. and \ref STARPU_MAX_WORKERSIZE can be used to change this default.
  278. </dd>
  279. <dt>STARPU_MIN_WORKERSIZE</dt>
  280. <dd>
  281. \anchor STARPU_MIN_WORKERSIZE
  282. \addindex __env__STARPU_MIN_WORKERSIZE
  283. \ref STARPU_MIN_WORKERSIZE
  284. permits to specify the minimum size of the combined workers (instead of the default 2)
  285. </dd>
  286. <dt>STARPU_MAX_WORKERSIZE</dt>
  287. <dd>
  288. \anchor STARPU_MAX_WORKERSIZE
  289. \addindex __env__STARPU_MAX_WORKERSIZE
  290. \ref STARPU_MAX_WORKERSIZE
  291. permits to specify the minimum size of the combined workers (instead of the
  292. number of CPU workers in the system)
  293. </dd>
  294. <dt>STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER</dt>
  295. <dd>
  296. \anchor STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
  297. \addindex __env__STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
  298. Let the user decide how many elements are allowed between combined workers
  299. created from hwloc information. For instance, in the case of sockets with 6
  300. cores without shared L2 caches, if \ref STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER is
  301. set to 6, no combined worker will be synthesized beyond one for the socket
  302. and one per core. If it is set to 3, 3 intermediate combined workers will be
  303. synthesized, to divide the socket cores into 3 chunks of 2 cores. If it set to
  304. 2, 2 intermediate combined workers will be synthesized, to divide the the socket
  305. cores into 2 chunks of 3 cores, and then 3 additional combined workers will be
  306. synthesized, to divide the former synthesized workers into a bunch of 2 cores,
  307. and the remaining core (for which no combined worker is synthesized since there
  308. is already a normal worker for it).
  309. The default, 2, thus makes StarPU tend to building a binary trees of combined
  310. workers.
  311. </dd>
  312. <dt>STARPU_DISABLE_ASYNCHRONOUS_COPY</dt>
  313. <dd>
  314. \anchor STARPU_DISABLE_ASYNCHRONOUS_COPY
  315. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_COPY
  316. Disable asynchronous copies between CPU and GPU devices.
  317. The AMD implementation of OpenCL is known to
  318. fail when copying data asynchronously. When using this implementation,
  319. it is therefore necessary to disable asynchronous data transfers.
  320. </dd>
  321. <dt>STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY</dt>
  322. <dd>
  323. \anchor STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY
  324. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY
  325. Disable asynchronous copies between CPU and CUDA devices.
  326. </dd>
  327. <dt>STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY</dt>
  328. <dd>
  329. \anchor STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY
  330. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY
  331. Disable asynchronous copies between CPU and OpenCL devices.
  332. The AMD implementation of OpenCL is known to
  333. fail when copying data asynchronously. When using this implementation,
  334. it is therefore necessary to disable asynchronous data transfers.
  335. </dd>
  336. <dt>STARPU_DISABLE_ASYNCHRONOUS_MIC_COPY</dt>
  337. <dd>
  338. \anchor STARPU_DISABLE_ASYNCHRONOUS_MIC_COPY
  339. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_MIC_COPY
  340. Disable asynchronous copies between CPU and MIC devices.
  341. </dd>
  342. <dt>STARPU_DISABLE_ASYNCHRONOUS_MPI_MS_COPY</dt>
  343. <dd>
  344. \anchor STARPU_DISABLE_ASYNCHRONOUS_MPI_MS_COPY
  345. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_MPI_MS_COPY
  346. Disable asynchronous copies between CPU and MPI Slave devices.
  347. </dd>
  348. <dt>STARPU_ENABLE_CUDA_GPU_GPU_DIRECT</dt>
  349. <dd>
  350. \anchor STARPU_ENABLE_CUDA_GPU_GPU_DIRECT
  351. \addindex __env__STARPU_ENABLE_CUDA_GPU_GPU_DIRECT
  352. Enable (1) or Disable (0) direct CUDA transfers from GPU to GPU, without copying
  353. through RAM. The default is Enabled.
  354. This permits to test the performance effect of GPU-Direct.
  355. </dd>
  356. <dt>STARPU_DISABLE_PINNING</dt>
  357. <dd>
  358. \anchor STARPU_DISABLE_PINNING
  359. \addindex __env__STARPU_DISABLE_PINNING
  360. Disable (1) or Enable (0) pinning host memory allocated through starpu_malloc, starpu_memory_pin
  361. and friends. The default is Enabled.
  362. This permits to test the performance effect of memory pinning.
  363. </dd>
  364. <dt>STARPU_MIC_SINK_PROGRAM_NAME</dt>
  365. <dd>
  366. \anchor STARPU_MIC_SINK_PROGRAM_NAME
  367. \addindex __env__STARPU_MIC_SINK_PROGRAM_NAME
  368. todo
  369. </dd>
  370. <dt>STARPU_MIC_SINK_PROGRAM_PATH</dt>
  371. <dd>
  372. \anchor STARPU_MIC_SINK_PROGRAM_PATH
  373. \addindex __env__STARPU_MIC_SINK_PROGRAM_PATH
  374. todo
  375. </dd>
  376. <dt>STARPU_MIC_PROGRAM_PATH</dt>
  377. <dd>
  378. \anchor STARPU_MIC_PROGRAM_PATH
  379. \addindex __env__STARPU_MIC_PROGRAM_PATH
  380. todo
  381. </dd>
  382. </dl>
  383. \section ConfiguringTheSchedulingEngine Configuring The Scheduling Engine
  384. <dl>
  385. <dt>STARPU_SCHED</dt>
  386. <dd>
  387. \anchor STARPU_SCHED
  388. \addindex __env__STARPU_SCHED
  389. Choose between the different scheduling policies proposed by StarPU: work
  390. random, stealing, greedy, with performance models, etc.
  391. Use <c>STARPU_SCHED=help</c> to get the list of available schedulers.
  392. </dd>
  393. <dt>STARPU_MIN_PRIO</dt>
  394. <dd>
  395. \anchor STARPU_MIN_PRIO_env
  396. \addindex __env__STARPU_MIN_PRIO
  397. Set the mininum priority used by priorities-aware schedulers.
  398. </dd>
  399. <dt>STARPU_MAX_PRIO</dt>
  400. <dd>
  401. \anchor STARPU_MAX_PRIO_env
  402. \addindex __env__STARPU_MAX_PRIO
  403. Set the maximum priority used by priorities-aware schedulers.
  404. </dd>
  405. <dt>STARPU_CALIBRATE</dt>
  406. <dd>
  407. \anchor STARPU_CALIBRATE
  408. \addindex __env__STARPU_CALIBRATE
  409. If this variable is set to 1, the performance models are calibrated during
  410. the execution. If it is set to 2, the previous values are dropped to restart
  411. calibration from scratch. Setting this variable to 0 disable calibration, this
  412. is the default behaviour.
  413. Note: this currently only applies to <c>dm</c> and <c>dmda</c> scheduling policies.
  414. </dd>
  415. <dt>STARPU_CALIBRATE_MINIMUM</dt>
  416. <dd>
  417. \anchor STARPU_CALIBRATE_MINIMUM
  418. \addindex __env__STARPU_CALIBRATE_MINIMUM
  419. Define the minimum number of calibration measurements that will be made
  420. before considering that the performance model is calibrated. The default value is 10.
  421. </dd>
  422. <dt>STARPU_BUS_CALIBRATE</dt>
  423. <dd>
  424. \anchor STARPU_BUS_CALIBRATE
  425. \addindex __env__STARPU_BUS_CALIBRATE
  426. If this variable is set to 1, the bus is recalibrated during intialization.
  427. </dd>
  428. <dt>STARPU_PREFETCH</dt>
  429. <dd>
  430. \anchor STARPU_PREFETCH
  431. \addindex __env__STARPU_PREFETCH
  432. Indicate whether data prefetching should be enabled (0 means
  433. that it is disabled). If prefetching is enabled, when a task is scheduled to be
  434. executed e.g. on a GPU, StarPU will request an asynchronous transfer in
  435. advance, so that data is already present on the GPU when the task starts. As a
  436. result, computation and data transfers are overlapped.
  437. Note that prefetching is enabled by default in StarPU.
  438. </dd>
  439. <dt>STARPU_SCHED_ALPHA</dt>
  440. <dd>
  441. \anchor STARPU_SCHED_ALPHA
  442. \addindex __env__STARPU_SCHED_ALPHA
  443. To estimate the cost of a task StarPU takes into account the estimated
  444. computation time (obtained thanks to performance models). The alpha factor is
  445. the coefficient to be applied to it before adding it to the communication part.
  446. </dd>
  447. <dt>STARPU_SCHED_BETA</dt>
  448. <dd>
  449. \anchor STARPU_SCHED_BETA
  450. \addindex __env__STARPU_SCHED_BETA
  451. To estimate the cost of a task StarPU takes into account the estimated
  452. data transfer time (obtained thanks to performance models). The beta factor is
  453. the coefficient to be applied to it before adding it to the computation part.
  454. </dd>
  455. <dt>STARPU_SCHED_GAMMA</dt>
  456. <dd>
  457. \anchor STARPU_SCHED_GAMMA
  458. \addindex __env__STARPU_SCHED_GAMMA
  459. Define the execution time penalty of a joule (\ref Energy-basedScheduling).
  460. </dd>
  461. <dt>STARPU_IDLE_POWER</dt>
  462. <dd>
  463. \anchor STARPU_IDLE_POWER
  464. \addindex __env__STARPU_IDLE_POWER
  465. Define the idle power of the machine (\ref Energy-basedScheduling).
  466. </dd>
  467. <dt>STARPU_PROFILING</dt>
  468. <dd>
  469. \anchor STARPU_PROFILING
  470. \addindex __env__STARPU_PROFILING
  471. Enable on-line performance monitoring (\ref EnablingOn-linePerformanceMonitoring).
  472. </dd>
  473. </dl>
  474. \section Extensions Extensions
  475. <dl>
  476. <dt>SOCL_OCL_LIB_OPENCL</dt>
  477. <dd>
  478. \anchor SOCL_OCL_LIB_OPENCL
  479. \addindex __env__SOCL_OCL_LIB_OPENCL
  480. THE SOCL test suite is only run when the environment variable
  481. \ref SOCL_OCL_LIB_OPENCL is defined. It should contain the location
  482. of the file <c>libOpenCL.so</c> of the OCL ICD implementation.
  483. </dd>
  484. <dt>OCL_ICD_VENDORS</dt>
  485. <dd>
  486. \anchor OCL_ICD_VENDORS
  487. \addindex __env__OCL_ICD_VENDORS
  488. When using SOCL with OpenCL ICD
  489. (https://forge.imag.fr/projects/ocl-icd/), this variable may be used
  490. to point to the directory where ICD files are installed. The default
  491. directory is <c>/etc/OpenCL/vendors</c>. StarPU installs ICD
  492. files in the directory <c>$prefix/share/starpu/opencl/vendors</c>.
  493. </dd>
  494. <dt>STARPU_COMM_STATS</dt>
  495. <dd>
  496. \anchor STARPU_COMM_STATS
  497. \addindex __env__STARPU_COMM_STATS
  498. Communication statistics for starpumpi (\ref MPISupport)
  499. will be enabled when the environment variable \ref STARPU_COMM_STATS
  500. is defined to an value other than 0.
  501. </dd>
  502. <dt>STARPU_MPI_CACHE</dt>
  503. <dd>
  504. \anchor STARPU_MPI_CACHE
  505. \addindex __env__STARPU_MPI_CACHE
  506. Communication cache for starpumpi (\ref MPISupport) will be
  507. disabled when the environment variable \ref STARPU_MPI_CACHE is set
  508. to 0. It is enabled by default or for any other values of the variable
  509. \ref STARPU_MPI_CACHE.
  510. </dd>
  511. <dt>STARPU_MPI_COMM</dt>
  512. <dd>
  513. \anchor STARPU_MPI_COMM
  514. \addindex __env__STARPU_MPI_COMM
  515. Communication trace for starpumpi (\ref MPISupport) will be
  516. enabled when the environment variable \ref STARPU_MPI_COMM is set
  517. to 1, and StarPU has been configured with the option
  518. \ref enable-verbose "--enable-verbose".
  519. </dd>
  520. <dt>STARPU_MPI_CACHE_STATS</dt>
  521. <dd>
  522. \anchor STARPU_MPI_CACHE_STATS
  523. \addindex __env__STARPU_MPI_CACHE_STATS
  524. When set to 1, statistics are enabled for the communication cache (\ref MPISupport). For now,
  525. it prints messages on the standard output when data are added or removed from the received
  526. communication cache.
  527. </dd>
  528. <dt>STARPU_MPI_PRIORITIES</dt>
  529. <dd>
  530. \anchor STARPU_MPI_PRIORITIES
  531. \addindex __env__STARPU_MPI_PRIORITIES
  532. When set to 0, the use of priorities to order MPI communications is disabled
  533. (\ref MPISupport).
  534. </dd>
  535. <dt>STARPU_MPI_FAKE_SIZE</dt>
  536. <dd>
  537. \anchor STARPU_MPI_FAKE_SIZE
  538. \addindex __env__STARPU_MPI_FAKE_SIZE
  539. Setting to a number makes StarPU believe that there are as many MPI nodes, even
  540. if it was run on only one MPI node. This allows e.g. to simulate the execution
  541. of one of the nodes of a big cluster without actually running the rest.
  542. It of course does not provide computation results and timing.
  543. </dd>
  544. <dt>STARPU_MPI_FAKE_RANK</dt>
  545. <dd>
  546. \anchor STARPU_MPI_FAKE_RANK
  547. \addindex __env__STARPU_MPI_FAKE_RANK
  548. Setting to a number makes StarPU believe that it runs the given MPI node, even
  549. if it was run on only one MPI node. This allows e.g. to simulate the execution
  550. of one of the nodes of a big cluster without actually running the rest.
  551. It of course does not provide computation results and timing.
  552. </dd>
  553. <dt>STARPU_MPI_DRIVER_CALL_FREQUENCY</dt>
  554. <dd>
  555. \anchor STARPU_MPI_DRIVER_CALL_FREQUENCY
  556. \addindex __env__STARPU_MPI_DRIVER_CALL_FREQUENCY
  557. When set to a positive value, activates the interleaving of the execution of
  558. tasks with the progression of MPI communications (\ref MPISupport). The
  559. starpu_mpi_init_conf() function must have been called by the application
  560. for that environment variable to be used. When set to 0, the MPI progression
  561. thread does not use at all the driver given by the user, and only focuses on
  562. making MPI communications progress.
  563. </dd>
  564. <dt>STARPU_MPI_DRIVER_TASK_FREQUENCY</dt>
  565. <dd>
  566. \anchor STARPU_MPI_DRIVER_TASK_FREQUENCY
  567. \addindex __env__STARPU_MPI_DRIVER_TASK_FREQUENCY
  568. When set to a positive value, the interleaving of the execution of tasks with
  569. the progression of MPI communications mechanism to execute several tasks before
  570. checking communication requests again (\ref MPISupport). The
  571. starpu_mpi_init_conf() function must have been called by the application
  572. for that environment variable to be used, and the
  573. STARPU_MPI_DRIVER_CALL_FREQUENCY environment variable set to a positive value.
  574. </dd>
  575. <dt>STARPU_SIMGRID_CUDA_MALLOC_COST</dt>
  576. <dd>
  577. \anchor STARPU_SIMGRID_CUDA_MALLOC_COST
  578. \addindex __env__STARPU_SIMGRID_CUDA_MALLOC_COST
  579. When set to 1 (which is the default), CUDA malloc costs are taken into account
  580. in simgrid mode.
  581. </dd>
  582. <dt>STARPU_SIMGRID_CUDA_QUEUE_COST</dt>
  583. <dd>
  584. \anchor STARPU_SIMGRID_CUDA_QUEUE_COST
  585. \addindex __env__STARPU_SIMGRID_CUDA_QUEUE_COST
  586. When set to 1 (which is the default), CUDA task and transfer queueing costs are
  587. taken into account in simgrid mode.
  588. </dd>
  589. <dt>STARPU_PCI_FLAT</dt>
  590. <dd>
  591. \anchor STARPU_PCI_FLAT
  592. \addindex __env__STARPU_PCI_FLAT
  593. When unset or set to 0, the platform file created for simgrid will
  594. contain PCI bandwidths and routes.
  595. </dd>
  596. <dt>STARPU_SIMGRID_QUEUE_MALLOC_COST</dt>
  597. <dd>
  598. \anchor STARPU_SIMGRID_QUEUE_MALLOC_COST
  599. \addindex __env__STARPU_SIMGRID_QUEUE_MALLOC_COST
  600. When unset or set to 1, simulate within simgrid the GPU transfer queueing.
  601. </dd>
  602. <dt>STARPU_MALLOC_SIMULATION_FOLD</dt>
  603. <dd>
  604. \anchor STARPU_MALLOC_SIMULATION_FOLD
  605. \addindex __env__STARPU_MALLOC_SIMULATION_FOLD
  606. Define the size of the file used for folding virtual allocation, in
  607. MiB. The default is 1, thus allowing 64GiB virtual memory when Linux's
  608. <c>sysctl vm.max_map_count</c> value is the default 65535.
  609. </dd>
  610. <dt>STARPU_SIMGRID_TASK_SUBMIT_COST</dt>
  611. <dd>
  612. \anchor STARPU_SIMGRID_TASK_SUBMIT_COST
  613. \addindex __env__STARPU_SIMGRID_TASK_SUBMIT_COST
  614. When set to 1 (which is the default), task submission costs are taken into
  615. account in simgrid mode. This provides more accurate simgrid predictions,
  616. especially for the beginning of the execution.
  617. </dd>
  618. <dt>STARPU_SIMGRID_FETCHING_INPUT_COST</dt>
  619. <dd>
  620. \anchor STARPU_SIMGRID_FETCHING_INPUT_COST
  621. \addindex __env__STARPU_SIMGRID_FETCHING_INPUT_COST
  622. When set to 1 (which is the default), fetching input costs are taken into
  623. account in simgrid mode. This provides more accurate simgrid predictions,
  624. especially regarding data transfers.
  625. </dd>
  626. <dt>STARPU_SIMGRID_SCHED_COST</dt>
  627. <dd>
  628. \anchor STARPU_SIMGRID_SCHED_COST
  629. \addindex __env__STARPU_SIMGRID_SCHED_COST
  630. When set to 1 (0 is the default), scheduling costs are taken into
  631. account in simgrid mode. This provides more accurate simgrid predictions,
  632. and allows studying scheduling overhead of the runtime system. However,
  633. it also makes simulation non-deterministic.
  634. </dd>
  635. </dl>
  636. \section MiscellaneousAndDebug Miscellaneous And Debug
  637. <dl>
  638. <dt>STARPU_HOME</dt>
  639. <dd>
  640. \anchor STARPU_HOME
  641. \addindex __env__STARPU_HOME
  642. Specify the main directory in which StarPU stores its
  643. configuration files. The default is <c>$HOME</c> on Unix environments,
  644. and <c>$USERPROFILE</c> on Windows environments.
  645. </dd>
  646. <dt>STARPU_PATH</dt>
  647. <dd>
  648. \anchor STARPU_PATH
  649. \addindex __env__STARPU_PATH
  650. Only used on Windows environments.
  651. Specify the main directory in which StarPU is installed
  652. (\ref RunningABasicStarPUApplicationOnMicrosoft)
  653. </dd>
  654. <dt>STARPU_PERF_MODEL_DIR</dt>
  655. <dd>
  656. \anchor STARPU_PERF_MODEL_DIR
  657. \addindex __env__STARPU_PERF_MODEL_DIR
  658. Specify the main directory in which StarPU stores its
  659. performance model files. The default is <c>$STARPU_HOME/.starpu/sampling</c>.
  660. </dd>
  661. <dt>STARPU_PERF_MODEL_HOMOGENEOUS_CPU</dt>
  662. <dd>
  663. \anchor STARPU_PERF_MODEL_HOMOGENEOUS_CPU
  664. \addindex __env__STARPU_PERF_MODEL_HOMOGENEOUS_CPU
  665. When this is set to 0, StarPU will assume that CPU devices do not have the same
  666. performance, and thus use different performance models for them, thus making
  667. kernel calibration much longer, since measurements have to be made for each CPU
  668. core.
  669. </dd>
  670. <dt>STARPU_PERF_MODEL_HOMOGENEOUS_CUDA</dt>
  671. <dd>
  672. \anchor STARPU_PERF_MODEL_HOMOGENEOUS_CUDA
  673. \addindex __env__STARPU_PERF_MODEL_HOMOGENEOUS_CUDA
  674. When this is set to 1, StarPU will assume that all CUDA devices have the same
  675. performance, and thus share performance models for them, thus allowing kernel
  676. calibration to be much faster, since measurements only have to be once for all
  677. CUDA GPUs.
  678. </dd>
  679. <dt>STARPU_PERF_MODEL_HOMOGENEOUS_OPENCL</dt>
  680. <dd>
  681. \anchor STARPU_PERF_MODEL_HOMOGENEOUS_OPENCL
  682. \addindex __env__STARPU_PERF_MODEL_HOMOGENEOUS_OPENCL
  683. When this is set to 1, StarPU will assume that all OPENCL devices have the same
  684. performance, and thus share performance models for them, thus allowing kernel
  685. calibration to be much faster, since measurements only have to be once for all
  686. OPENCL GPUs.
  687. </dd>
  688. <dt>STARPU_PERF_MODEL_HOMOGENEOUS_MIC</dt>
  689. <dd>
  690. \anchor STARPU_PERF_MODEL_HOMOGENEOUS_MIC
  691. \addindex __env__STARPU_PERF_MODEL_HOMOGENEOUS_MIC
  692. When this is set to 1, StarPU will assume that all MIC devices have the same
  693. performance, and thus share performance models for them, thus allowing kernel
  694. calibration to be much faster, since measurements only have to be once for all
  695. MIC GPUs.
  696. </dd>
  697. <dt>STARPU_PERF_MODEL_HOMOGENEOUS_MPI_MS</dt>
  698. <dd>
  699. \anchor STARPU_PERF_MODEL_HOMOGENEOUS_MPI_MS
  700. \addindex __env__STARPU_PERF_MODEL_HOMOGENEOUS_MPI_MS
  701. When this is set to 1, StarPU will assume that all MPI Slave devices have the same
  702. performance, and thus share performance models for them, thus allowing kernel
  703. calibration to be much faster, since measurements only have to be once for all
  704. MPI Slaves.
  705. </dd>
  706. <dt>STARPU_PERF_MODEL_HOMOGENEOUS_SCC</dt>
  707. <dd>
  708. \anchor STARPU_PERF_MODEL_HOMOGENEOUS_SCC
  709. \addindex __env__STARPU_PERF_MODEL_HOMOGENEOUS_SCC
  710. When this is set to 1, StarPU will assume that all SCC devices have the same
  711. performance, and thus share performance models for them, thus allowing kernel
  712. calibration to be much faster, since measurements only have to be once for all
  713. SCC GPUs.
  714. </dd>
  715. <dt>STARPU_HOSTNAME</dt>
  716. <dd>
  717. \anchor STARPU_HOSTNAME
  718. \addindex __env__STARPU_HOSTNAME
  719. When set, force the hostname to be used when dealing performance model
  720. files. Models are indexed by machine name. When running for example on
  721. a homogenenous cluster, it is possible to share the models between
  722. machines by setting <c>export STARPU_HOSTNAME=some_global_name</c>.
  723. </dd>
  724. <dt>STARPU_OPENCL_PROGRAM_DIR</dt>
  725. <dd>
  726. \anchor STARPU_OPENCL_PROGRAM_DIR
  727. \addindex __env__STARPU_OPENCL_PROGRAM_DIR
  728. Specify the directory where the OpenCL codelet source files are
  729. located. The function starpu_opencl_load_program_source() looks
  730. for the codelet in the current directory, in the directory specified
  731. by the environment variable \ref STARPU_OPENCL_PROGRAM_DIR, in the
  732. directory <c>share/starpu/opencl</c> of the installation directory of
  733. StarPU, and finally in the source directory of StarPU.
  734. </dd>
  735. <dt>STARPU_SILENT</dt>
  736. <dd>
  737. \anchor STARPU_SILENT
  738. \addindex __env__STARPU_SILENT
  739. Allow to disable verbose mode at runtime when StarPU
  740. has been configured with the option \ref enable-verbose "--enable-verbose". Also
  741. disable the display of StarPU information and warning messages.
  742. </dd>
  743. <dt>STARPU_LOGFILENAME</dt>
  744. <dd>
  745. \anchor STARPU_LOGFILENAME
  746. \addindex __env__STARPU_LOGFILENAME
  747. Specify in which file the debugging output should be saved to.
  748. </dd>
  749. <dt>STARPU_FXT_PREFIX</dt>
  750. <dd>
  751. \anchor STARPU_FXT_PREFIX
  752. \addindex __env__STARPU_FXT_PREFIX
  753. Specify in which directory to save the trace generated if FxT is enabled. It needs to have a trailing '/' character.
  754. </dd>
  755. <dt>STARPU_FXT_TRACE</dt>
  756. <dd>
  757. \anchor STARPU_FXT_TRACE
  758. \addindex __env__STARPU_FXT_TRACE
  759. Specify whether to generate (1) or not (0) the FxT trace in /tmp/prof_file_XXX_YYY . The default is 1 (generate it)
  760. </dd>
  761. <dt>STARPU_LIMIT_CUDA_devid_MEM</dt>
  762. <dd>
  763. \anchor STARPU_LIMIT_CUDA_devid_MEM
  764. \addindex __env__STARPU_LIMIT_CUDA_devid_MEM
  765. Specify the maximum number of megabytes that should be
  766. available to the application on the CUDA device with the identifier
  767. <c>devid</c>. This variable is intended to be used for experimental
  768. purposes as it emulates devices that have a limited amount of memory.
  769. When defined, the variable overwrites the value of the variable
  770. \ref STARPU_LIMIT_CUDA_MEM.
  771. </dd>
  772. <dt>STARPU_LIMIT_CUDA_MEM</dt>
  773. <dd>
  774. \anchor STARPU_LIMIT_CUDA_MEM
  775. \addindex __env__STARPU_LIMIT_CUDA_MEM
  776. Specify the maximum number of megabytes that should be
  777. available to the application on each CUDA devices. This variable is
  778. intended to be used for experimental purposes as it emulates devices
  779. that have a limited amount of memory.
  780. </dd>
  781. <dt>STARPU_LIMIT_OPENCL_devid_MEM</dt>
  782. <dd>
  783. \anchor STARPU_LIMIT_OPENCL_devid_MEM
  784. \addindex __env__STARPU_LIMIT_OPENCL_devid_MEM
  785. Specify the maximum number of megabytes that should be
  786. available to the application on the OpenCL device with the identifier
  787. <c>devid</c>. This variable is intended to be used for experimental
  788. purposes as it emulates devices that have a limited amount of memory.
  789. When defined, the variable overwrites the value of the variable
  790. \ref STARPU_LIMIT_OPENCL_MEM.
  791. </dd>
  792. <dt>STARPU_LIMIT_OPENCL_MEM</dt>
  793. <dd>
  794. \anchor STARPU_LIMIT_OPENCL_MEM
  795. \addindex __env__STARPU_LIMIT_OPENCL_MEM
  796. Specify the maximum number of megabytes that should be
  797. available to the application on each OpenCL devices. This variable is
  798. intended to be used for experimental purposes as it emulates devices
  799. that have a limited amount of memory.
  800. </dd>
  801. <dt>STARPU_LIMIT_CPU_MEM</dt>
  802. <dd>
  803. \anchor STARPU_LIMIT_CPU_MEM
  804. \addindex __env__STARPU_LIMIT_CPU_MEM
  805. Specify the maximum number of megabytes that should be
  806. available to the application in the main CPU memory. Setting it enables allocation
  807. cache in main memory. Setting it to zero lets StarPU overflow memory.
  808. </dd>
  809. <dt>STARPU_LIMIT_CPU_NUMA_devid_MEM</dt>
  810. <dd>
  811. \anchor STARPU_LIMIT_CPU_NUMA_devid_MEM
  812. \addindex __env__STARPU_LIMIT_CPU_NUMA_devid_MEM
  813. Specify the maximum number of megabytes that should be
  814. available to the application on the NUMA node with the OS identifier <c>devid</c>.
  815. </dd>
  816. <dt>STARPU_MINIMUM_AVAILABLE_MEM</dt>
  817. <dd>
  818. \anchor STARPU_MINIMUM_AVAILABLE_MEM
  819. \addindex __env__STARPU_MINIMUM_AVAILABLE_MEM
  820. Specify the minimum percentage of memory that should be available in GPUs
  821. (or in main memory, when using out of core), below which a reclaiming pass is
  822. performed. The default is 0%.
  823. </dd>
  824. <dt>STARPU_TARGET_AVAILABLE_MEM</dt>
  825. <dd>
  826. \anchor STARPU_TARGET_AVAILABLE_MEM
  827. \addindex __env__STARPU_TARGET_AVAILABLE_MEM
  828. Specify the target percentage of memory that should be reached in
  829. GPUs (or in main memory, when using out of core), when performing a periodic
  830. reclaiming pass. The default is 0%.
  831. </dd>
  832. <dt>STARPU_MINIMUM_CLEAN_BUFFERS</dt>
  833. <dd>
  834. \anchor STARPU_MINIMUM_CLEAN_BUFFERS
  835. \addindex __env__STARPU_MINIMUM_CLEAN_BUFFERS
  836. Specify the minimum percentage of number of buffers that should be clean in GPUs
  837. (or in main memory, when using out of core), below which asynchronous writebacks will be
  838. issued. The default is 5%.
  839. </dd>
  840. <dt>STARPU_TARGET_CLEAN_BUFFERS</dt>
  841. <dd>
  842. \anchor STARPU_TARGET_CLEAN_BUFFERS
  843. \addindex __env__STARPU_TARGET_CLEAN_BUFFERS
  844. Specify the target percentage of number of buffers that should be reached in
  845. GPUs (or in main memory, when using out of core), when performing an asynchronous
  846. writeback pass. The default is 10%.
  847. </dd>
  848. <dt>STARPU_DIDUSE_BARRIER</dt>
  849. <dd>
  850. \anchor STARPU_DIDUSE_BARRIER
  851. \addindex __env__STARPU_DIDUSE_BARRIER
  852. When set to 1, StarPU will never evict a piece of data if it has not been used
  853. by at least one task. This avoids odd behaviors under high memory pressure, but
  854. can lead to deadlocks, so is to be considered experimental only.
  855. </dd>
  856. <dt>STARPU_DISK_SWAP</dt>
  857. <dd>
  858. \anchor STARPU_DISK_SWAP
  859. \addindex __env__STARPU_DISK_SWAP
  860. Specify a path where StarPU can push data when the main memory is getting
  861. full.
  862. </dd>
  863. <dt>STARPU_DISK_SWAP_BACKEND</dt>
  864. <dd>
  865. \anchor STARPU_DISK_SWAP_BACKEND
  866. \addindex __env__STARPU_DISK_SWAP_BACKEND
  867. Specify the backend to be used by StarPU to push data when the main
  868. memory is getting full. The default is unistd (i.e. using read/write functions),
  869. other values are stdio (i.e. using fread/fwrite), unistd_o_direct (i.e. using
  870. read/write with O_DIRECT), leveldb (i.e. using a leveldb database), and hdf5
  871. (i.e. using HDF5 library).
  872. </dd>
  873. <dt>STARPU_DISK_SWAP_SIZE</dt>
  874. <dd>
  875. \anchor STARPU_DISK_SWAP_SIZE
  876. \addindex __env__STARPU_DISK_SWAP_SIZE
  877. Specify the maximum size in MiB to be used by StarPU to push data when the main
  878. memory is getting full. The default is unlimited.
  879. </dd>
  880. <dt>STARPU_LIMIT_MAX_SUBMITTED_TASKS</dt>
  881. <dd>
  882. \anchor STARPU_LIMIT_MAX_SUBMITTED_TASKS
  883. \addindex __env__STARPU_LIMIT_MAX_SUBMITTED_TASKS
  884. Allow users to control the task submission flow by specifying
  885. to StarPU a maximum number of submitted tasks allowed at a given time, i.e. when
  886. this limit is reached task submission becomes blocking until enough tasks have
  887. completed, specified by \ref STARPU_LIMIT_MIN_SUBMITTED_TASKS.
  888. Setting it enables allocation cache buffer reuse in main memory.
  889. </dd>
  890. <dt>STARPU_LIMIT_MIN_SUBMITTED_TASKS</dt>
  891. <dd>
  892. \anchor STARPU_LIMIT_MIN_SUBMITTED_TASKS
  893. \addindex __env__STARPU_LIMIT_MIN_SUBMITTED_TASKS
  894. Allow users to control the task submission flow by specifying
  895. to StarPU a submitted task threshold to wait before unblocking task submission. This
  896. variable has to be used in conjunction with \ref STARPU_LIMIT_MAX_SUBMITTED_TASKS
  897. which puts the task submission thread to
  898. sleep. Setting it enables allocation cache buffer reuse in main memory.
  899. </dd>
  900. <dt>STARPU_TRACE_BUFFER_SIZE</dt>
  901. <dd>
  902. \anchor STARPU_TRACE_BUFFER_SIZE
  903. \addindex __env__STARPU_TRACE_BUFFER_SIZE
  904. Set the buffer size for recording trace events in MiB. Setting it to a big
  905. size allows to avoid pauses in the trace while it is recorded on the disk. This
  906. however also consumes memory, of course. The default value is 64.
  907. </dd>
  908. <dt>STARPU_GENERATE_TRACE</dt>
  909. <dd>
  910. \anchor STARPU_GENERATE_TRACE
  911. \addindex __env__STARPU_GENERATE_TRACE
  912. When set to <c>1</c>, indicate that StarPU should automatically
  913. generate a Paje trace when starpu_shutdown() is called.
  914. </dd>
  915. <dt>STARPU_GENERATE_TRACE_OPTIONS</dt>
  916. <dd>
  917. \anchor STARPU_GENERATE_TRACE_OPTIONS
  918. \addindex __env__STARPU_GENERATE_TRACE_OPTIONS
  919. When the variable \ref STARPU_GENERATE_TRACE is set to <c>1</c> to
  920. generate a Paje trace, this variable can be set to specify options (see
  921. <c>starpu_fxt_tool --help</c>).
  922. </dd>
  923. <dt>STARPU_ENABLE_STATS</dt>
  924. <dd>
  925. \anchor STARPU_ENABLE_STATS
  926. \addindex __env__STARPU_ENABLE_STATS
  927. When defined, enable gathering various data statistics (\ref DataStatistics).
  928. </dd>
  929. <dt>STARPU_MEMORY_STATS</dt>
  930. <dd>
  931. \anchor STARPU_MEMORY_STATS
  932. \addindex __env__STARPU_MEMORY_STATS
  933. When set to 0, disable the display of memory statistics on data which
  934. have not been unregistered at the end of the execution (\ref MemoryFeedback).
  935. </dd>
  936. <dt>STARPU_MAX_MEMORY_USE</dt>
  937. <dd>
  938. \anchor STARPU_MAX_MEMORY_USE
  939. \addindex __env__STARPU_MAX_MEMORY_USE
  940. When set to 1, display at the end of the execution the maximum memory used by
  941. StarPU for internal data structures during execution.
  942. </dd>
  943. <dt>STARPU_BUS_STATS</dt>
  944. <dd>
  945. \anchor STARPU_BUS_STATS
  946. \addindex __env__STARPU_BUS_STATS
  947. When defined, statistics about data transfers will be displayed when calling
  948. starpu_shutdown() (\ref Profiling).
  949. </dd>
  950. <dt>STARPU_WORKER_STATS</dt>
  951. <dd>
  952. \anchor STARPU_WORKER_STATS
  953. \addindex __env__STARPU_WORKER_STATS
  954. When defined, statistics about the workers will be displayed when calling
  955. starpu_shutdown() (\ref Profiling). When combined with the
  956. environment variable \ref STARPU_PROFILING, it displays the energy
  957. consumption (\ref Energy-basedScheduling).
  958. </dd>
  959. <dt>STARPU_STATS</dt>
  960. <dd>
  961. \anchor STARPU_STATS
  962. \addindex __env__STARPU_STATS
  963. When set to 0, data statistics will not be displayed at the
  964. end of the execution of an application (\ref DataStatistics).
  965. </dd>
  966. <dt>STARPU_WATCHDOG_TIMEOUT</dt>
  967. <dd>
  968. \anchor STARPU_WATCHDOG_TIMEOUT
  969. \addindex __env__STARPU_WATCHDOG_TIMEOUT
  970. When set to a value other than 0, allows to make StarPU print an error
  971. message whenever StarPU does not terminate any task for the given time (in µs),
  972. but lets the application continue normally. Should
  973. be used in combination with \ref STARPU_WATCHDOG_CRASH
  974. (see \ref DetectionStuckConditions).
  975. </dd>
  976. <dt>STARPU_WATCHDOG_CRASH</dt>
  977. <dd>
  978. \anchor STARPU_WATCHDOG_CRASH
  979. \addindex __env__STARPU_WATCHDOG_CRASH
  980. When set to a value other than 0, trigger a crash when the watch
  981. dog is reached, thus allowing to catch the situation in gdb, etc
  982. (see \ref DetectionStuckConditions)
  983. </dd>
  984. <dt>STARPU_WATCHDOG_DELAY</dt>
  985. <dd>
  986. \anchor STARPU_WATCHDOG_DELAY
  987. \addindex __env__STARPU_WATCHDOG_DELAY
  988. Delay the activation of the watchdog by the given time (in µs). This can
  989. be convenient for letting the application initialize data etc. before starting
  990. to look for idle time.
  991. </dd>
  992. <dt>STARPU_TASK_BREAK_ON_PUSH</dt>
  993. <dd>
  994. \anchor STARPU_TASK_BREAK_ON_PUSH
  995. \addindex __env__STARPU_TASK_BREAK_ON_PUSH
  996. When this variable contains a job id, StarPU will raise SIGTRAP when the task
  997. with that job id is being pushed to the scheduler, which will be nicely catched by debuggers
  998. (see \ref DebuggingScheduling)
  999. </dd>
  1000. <dt>STARPU_TASK_BREAK_ON_SCHED</dt>
  1001. <dd>
  1002. \anchor STARPU_TASK_BREAK_ON_SCHED
  1003. \addindex __env__STARPU_TASK_BREAK_ON_SCHED
  1004. When this variable contains a job id, StarPU will raise SIGTRAP when the task
  1005. with that job id is being scheduled by the scheduler (at a scheduler-specific
  1006. point), which will be nicely catched by debuggers.
  1007. This only works for schedulers which have such a scheduling point defined
  1008. (see \ref DebuggingScheduling)
  1009. </dd>
  1010. <dt>STARPU_TASK_BREAK_ON_POP</dt>
  1011. <dd>
  1012. \anchor STARPU_TASK_BREAK_ON_POP
  1013. \addindex __env__STARPU_TASK_BREAK_ON_POP
  1014. When this variable contains a job id, StarPU will raise SIGTRAP when the task
  1015. with that job id is being popped from the scheduler, which will be nicely catched by debuggers
  1016. (see \ref DebuggingScheduling)
  1017. </dd>
  1018. <dt>STARPU_TASK_BREAK_ON_EXEC</dt>
  1019. <dd>
  1020. \anchor STARPU_TASK_BREAK_ON_EXEC
  1021. \addindex __env__STARPU_TASK_BREAK_ON_EXEC
  1022. When this variable contains a job id, StarPU will raise SIGTRAP when the task
  1023. with that job id is being executed, which will be nicely catched by debuggers
  1024. (see \ref DebuggingScheduling)
  1025. </dd>
  1026. <dt>STARPU_DISABLE_KERNELS</dt>
  1027. <dd>
  1028. \anchor STARPU_DISABLE_KERNELS
  1029. \addindex __env__STARPU_DISABLE_KERNELS
  1030. When set to a value other than 1, it disables actually calling the kernel
  1031. functions, thus allowing to quickly check that the task scheme is working
  1032. properly, without performing the actual application-provided computation.
  1033. </dd>
  1034. <dt>STARPU_HISTORY_MAX_ERROR</dt>
  1035. <dd>
  1036. \anchor STARPU_HISTORY_MAX_ERROR
  1037. \addindex __env__STARPU_HISTORY_MAX_ERROR
  1038. History-based performance models will drop measurements which are really far
  1039. froom the measured average. This specifies the allowed variation. The default is
  1040. 50 (%), i.e. the measurement is allowed to be x1.5 faster or /1.5 slower than the
  1041. average.
  1042. </dd>
  1043. <dt>STARPU_RAND_SEED</dt>
  1044. <dd>
  1045. \anchor STARPU_RAND_SEED
  1046. \addindex __env__STARPU_RAND_SEED
  1047. The random scheduler and some examples use random numbers for their own
  1048. working. Depending on the examples, the seed is by default juste always 0 or
  1049. the current time() (unless simgrid mode is enabled, in which case it is always
  1050. 0). \ref STARPU_RAND_SEED allows to set the seed to a specific value.
  1051. </dd>
  1052. <dt>STARPU_IDLE_TIME</dt>
  1053. <dd>
  1054. \anchor STARPU_IDLE_TIME
  1055. \addindex __env__STARPU_IDLE_TIME
  1056. When set to a value being a valid filename, a corresponding file
  1057. will be created when shutting down StarPU. The file will contain the
  1058. sum of all the workers' idle time.
  1059. </dd>
  1060. <dt>STARPU_GLOBAL_ARBITER</dt>
  1061. <dd>
  1062. \anchor STARPU_GLOBAL_ARBITER
  1063. \addindex __env__STARPU_GLOBAL_ARBITER
  1064. When set to a positive value, StarPU will create a arbiter, which
  1065. implements an advanced but centralized management of concurrent data
  1066. accesses (see \ref ConcurrentDataAccess).
  1067. </dd>
  1068. <dt>STARPU_USE_NUMA</dt>
  1069. <dd>
  1070. \anchor STARPU_USE_NUMA
  1071. \addindex __env__STARPU_USE_NUMA
  1072. When defined, NUMA nodes are taking into account by StarPU. Otherwise, memory
  1073. is considered as only one node. This is experimental for now.
  1074. When enabled, STARPU_MAIN_MEMORY is a pointer to the NUMA node associated to the
  1075. first CPU worker if it exists, the NUMA node associated to the first GPU discovered otherwise.
  1076. If StarPU doesn't find any NUMA node after these step, STARPU_MAIN_MEMORY is the first NUMA node
  1077. discovered by StarPU.
  1078. </dd>
  1079. <dt>STARPU_IDLE_FILE</dt>
  1080. <dd>
  1081. \anchor STARPU_IDLE_FILE
  1082. \addindex __env__STARPU_IDLE_FILE
  1083. If the environment variable STARPU_IDLE_FILE is defined, a file named after its contents will be created at the end of the execution.
  1084. The file will contain the sum of the idle times of all the workers.
  1085. </dd>
  1086. </dl>
  1087. \section ConfiguringTheHypervisor Configuring The Hypervisor
  1088. <dl>
  1089. <dt>SC_HYPERVISOR_POLICY</dt>
  1090. <dd>
  1091. \anchor SC_HYPERVISOR_POLICY
  1092. \addindex __env__SC_HYPERVISOR_POLICY
  1093. Choose between the different resizing policies proposed by StarPU for the hypervisor:
  1094. idle, app_driven, feft_lp, teft_lp; ispeed_lp, throughput_lp etc.
  1095. Use <c>SC_HYPERVISOR_POLICY=help</c> to get the list of available policies for the hypervisor
  1096. </dd>
  1097. <dt>SC_HYPERVISOR_TRIGGER_RESIZE</dt>
  1098. <dd>
  1099. \anchor SC_HYPERVISOR_TRIGGER_RESIZE
  1100. \addindex __env__SC_HYPERVISOR_TRIGGER_RESIZE
  1101. Choose how should the hypervisor be triggered: <c>speed</c> if the resizing algorithm should
  1102. be called whenever the speed of the context does not correspond to an optimal precomputed value,
  1103. <c>idle</c> it the resizing algorithm should be called whenever the workers are idle for a period
  1104. longer than the value indicated when configuring the hypervisor.
  1105. </dd>
  1106. <dt>SC_HYPERVISOR_START_RESIZE</dt>
  1107. <dd>
  1108. \anchor SC_HYPERVISOR_START_RESIZE
  1109. \addindex __env__SC_HYPERVISOR_START_RESIZE
  1110. Indicate the moment when the resizing should be available. The value correspond to the percentage
  1111. of the total time of execution of the application. The default value is the resizing frame.
  1112. </dd>
  1113. <dt>SC_HYPERVISOR_MAX_SPEED_GAP</dt>
  1114. <dd>
  1115. \anchor SC_HYPERVISOR_MAX_SPEED_GAP
  1116. \addindex __env__SC_HYPERVISOR_MAX_SPEED_GAP
  1117. Indicate the ratio of speed difference between contexts that should trigger the hypervisor.
  1118. This situation may occur only when a theoretical speed could not be computed and the hypervisor
  1119. has no value to compare the speed to. Otherwise the resizing of a context is not influenced by the
  1120. the speed of the other contexts, but only by the the value that a context should have.
  1121. </dd>
  1122. <dt>SC_HYPERVISOR_STOP_PRINT</dt>
  1123. <dd>
  1124. \anchor SC_HYPERVISOR_STOP_PRINT
  1125. \addindex __env__SC_HYPERVISOR_STOP_PRINT
  1126. By default the values of the speed of the workers is printed during the execution
  1127. of the application. If the value 1 is given to this environment variable this printing
  1128. is not done.
  1129. </dd>
  1130. <dt>SC_HYPERVISOR_LAZY_RESIZE</dt>
  1131. <dd>
  1132. \anchor SC_HYPERVISOR_LAZY_RESIZE
  1133. \addindex __env__SC_HYPERVISOR_LAZY_RESIZE
  1134. By default the hypervisor resizes the contexts in a lazy way, that is workers are firstly added to a new context
  1135. before removing them from the previous one. Once this workers are clearly taken into account
  1136. into the new context (a task was poped there) we remove them from the previous one. However if the application
  1137. would like that the change in the distribution of workers should change right away this variable should be set to 0
  1138. </dd>
  1139. <dt>SC_HYPERVISOR_SAMPLE_CRITERIA</dt>
  1140. <dd>
  1141. \anchor SC_HYPERVISOR_SAMPLE_CRITERIA
  1142. \addindex __env__SC_HYPERVISOR_SAMPLE_CRITERIA
  1143. By default the hypervisor uses a sample of flops when computing the speed of the contexts and of the workers.
  1144. If this variable is set to <c>time</c> the hypervisor uses a sample of time (10% of an aproximation of the total
  1145. execution time of the application)
  1146. </dd>
  1147. </dl>
  1148. */