501_environment_variables.doxy 42 KB

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