40environment_variables.doxy 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
  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 Centre National de la Recherche Scientifique
  5. * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  6. * See the file version.doxy for copying conditions.
  7. */
  8. /*! \page ExecutionConfigurationThroughEnvironmentVariables Execution Configuration Through Environment Variables
  9. The behavior of the StarPU library and tools may be tuned thanks to
  10. the following environment variables.
  11. \section ConfiguringWorkers Configuring Workers
  12. <dl>
  13. <dt>STARPU_NCPU</dt>
  14. <dd>
  15. \anchor STARPU_NCPU
  16. \addindex __env__STARPU_NCPU
  17. Specify the number of CPU workers (thus not including workers
  18. dedicated to control accelerators). Note that by default, StarPU will
  19. not allocate more CPU workers than there are physical CPUs, and that
  20. some CPUs are used to control the accelerators.
  21. </dd>
  22. <dt>STARPU_NCPUS</dt>
  23. <dd>
  24. \anchor STARPU_NCPUS
  25. \addindex __env__STARPU_NCPUS
  26. This variable is deprecated. You should use \ref STARPU_NCPU.
  27. </dd>
  28. <dt>STARPU_NCUDA</dt>
  29. <dd>
  30. \anchor STARPU_NCUDA
  31. \addindex __env__STARPU_NCUDA
  32. Specify the number of CUDA devices that StarPU can use. If
  33. \ref STARPU_NCUDA is lower than the number of physical devices, it is
  34. possible to select which CUDA devices should be used by the means of the
  35. environment variable \ref STARPU_WORKERS_CUDAID. By default, StarPU will
  36. create as many CUDA workers as there are CUDA devices.
  37. </dd>
  38. <dt>STARPU_NWORKER_PER_CUDA</dt>
  39. <dd>
  40. \anchor STARPU_NWORKER_PER_CUDA
  41. \addindex __env__STARPU_NWORKER_PER_CUDA
  42. Specify the number of workers per CUDA device, and thus the number of kernels
  43. which will be concurrently running on the devices. The default value is 1.
  44. </dd>
  45. <dt>STARPU_CUDA_PIPELINE</dt>
  46. <dd>
  47. \anchor STARPU_CUDA_PIPELINE
  48. \addindex __env__STARPU_CUDA_PIPELINE
  49. Specify how many asynchronous tasks are submitted in advance on CUDA
  50. devices. This for instance permits to overlap task management with the execution
  51. of previous tasks, but it also allows concurrent execution on Fermi cards, which
  52. otherwise bring spurious synchronizations. The default is 2. Setting the value to 0 forces a synchronous
  53. execution of all tasks.
  54. </dd>
  55. <dt>STARPU_NOPENCL</dt>
  56. <dd>
  57. \anchor STARPU_NOPENCL
  58. \addindex __env__STARPU_NOPENCL
  59. OpenCL equivalent of the environment variable \ref STARPU_NCUDA.
  60. </dd>
  61. <dt>STARPU_OPENCL_PIPELINE</dt>
  62. <dd>
  63. \anchor STARPU_OPENCL_PIPELINE
  64. \addindex __env__STARPU_OPENCL_PIPELINE
  65. Specify how many asynchronous tasks are submitted in advance on OpenCL
  66. devices. This for instance permits to overlap task management with the execution
  67. of previous tasks, but it also allows concurrent execution on Fermi cards, which
  68. otherwise bring spurious synchronizations. The default is 2. Setting the value to 0 forces a synchronous
  69. execution of all tasks.
  70. </dd>
  71. <dt>STARPU_NMICDEVS</dt>
  72. <dd>
  73. \anchor STARPU_NMICDEVS
  74. \addindex __env__STARPU_NMICDEVS
  75. MIC equivalent of the environment variable \ref STARPU_NCUDA.
  76. </dd>
  77. <dt>STARPU_OPENCL_ON_CPUS</dt>
  78. <dd>
  79. \anchor STARPU_OPENCL_ON_CPUS
  80. \addindex __env__STARPU_OPENCL_ON_CPUS
  81. By default, the OpenCL driver only enables GPU and accelerator
  82. devices. By setting the environment variable \ref
  83. STARPU_OPENCL_ON_CPUS to 1, the OpenCL driver will also enable CPU
  84. devices.
  85. </dd>
  86. <dt>STARPU_OPENCL_ONLY_ON_CPUS</dt>
  87. <dd>
  88. \anchor STARPU_OPENCL_ONLY_ON_CPUS
  89. \addindex __env__STARPU_OPENCL_ONLY_ON_CPUS
  90. By default, the OpenCL driver enables GPU and accelerator
  91. devices. By setting the environment variable \ref
  92. STARPU_OPENCL_ONLY_ON_CPUS to 1, the OpenCL driver will ONLY enable
  93. CPU devices.
  94. </dd>
  95. <dt>STARPU_NMIC</dt>
  96. <dd>
  97. \anchor STARPU_NMIC
  98. \addindex __env__STARPU_NMIC
  99. MIC equivalent of the environment variable \ref STARPU_NCUDA.
  100. </dd>
  101. <dt>STARPU_NSCC</dt>
  102. <dd>
  103. \anchor STARPU_NSCC
  104. \addindex __env__STARPU_NSCC
  105. SCC equivalent of the environment variable \ref STARPU_NCUDA.
  106. </dd>
  107. <dt>STARPU_WORKERS_NOBIND</dt>
  108. <dd>
  109. \anchor STARPU_WORKERS_NOBIND
  110. \addindex __env__STARPU_WORKERS_NOBIND
  111. Setting it to non-zero will prevent StarPU from binding its threads to
  112. CPUs. This is for instance useful when running the testsuite in parallel.
  113. </dd>
  114. <dt>STARPU_WORKERS_CPUID</dt>
  115. <dd>
  116. \anchor STARPU_WORKERS_CPUID
  117. \addindex __env__STARPU_WORKERS_CPUID
  118. Passing an array of integers (starting from 0) in \ref STARPU_WORKERS_CPUID
  119. specifies on which logical CPU the different workers should be
  120. bound. For instance, if <c>STARPU_WORKERS_CPUID = "0 1 4 5"</c>, the first
  121. worker will be bound to logical CPU #0, the second CPU worker will be bound to
  122. logical CPU #1 and so on. Note that the logical ordering of the CPUs is either
  123. determined by the OS, or provided by the library <c>hwloc</c> in case it is
  124. available.
  125. Note that the first workers correspond to the CUDA workers, then come the
  126. OpenCL workers, and finally the CPU workers. For example if
  127. we have <c>STARPU_NCUDA=1</c>, <c>STARPU_NOPENCL=1</c>, <c>STARPU_NCPU=2</c>
  128. and <c>STARPU_WORKERS_CPUID = "0 2 1 3"</c>, the CUDA device will be controlled
  129. by logical CPU #0, the OpenCL device will be controlled by logical CPU #2, and
  130. the logical CPUs #1 and #3 will be used by the CPU workers.
  131. If the number of workers is larger than the array given in \ref
  132. STARPU_WORKERS_CPUID, the workers are bound to the logical CPUs in a
  133. round-robin fashion: if <c>STARPU_WORKERS_CPUID = "0 1"</c>, the first
  134. and the third (resp. second and fourth) workers will be put on CPU #0
  135. (resp. CPU #1).
  136. This variable is ignored if the field
  137. starpu_conf::use_explicit_workers_bindid passed to starpu_init() is
  138. set.
  139. </dd>
  140. <dt>STARPU_WORKERS_CUDAID</dt>
  141. <dd>
  142. \anchor STARPU_WORKERS_CUDAID
  143. \addindex __env__STARPU_WORKERS_CUDAID
  144. Similarly to the \ref STARPU_WORKERS_CPUID environment variable, it is
  145. possible to select which CUDA devices should be used by StarPU. On a machine
  146. equipped with 4 GPUs, setting <c>STARPU_WORKERS_CUDAID = "1 3"</c> and
  147. <c>STARPU_NCUDA=2</c> specifies that 2 CUDA workers should be created, and that
  148. they should use CUDA devices #1 and #3 (the logical ordering of the devices is
  149. the one reported by CUDA).
  150. This variable is ignored if the field
  151. starpu_conf::use_explicit_workers_cuda_gpuid passed to starpu_init()
  152. is set.
  153. </dd>
  154. <dt>STARPU_WORKERS_OPENCLID</dt>
  155. <dd>
  156. \anchor STARPU_WORKERS_OPENCLID
  157. \addindex __env__STARPU_WORKERS_OPENCLID
  158. OpenCL equivalent of the \ref STARPU_WORKERS_CUDAID environment variable.
  159. This variable is ignored if the field
  160. starpu_conf::use_explicit_workers_opencl_gpuid passed to starpu_init()
  161. is set.
  162. </dd>
  163. <dt>STARPU_WORKERS_MICID</dt>
  164. <dd>
  165. \anchor STARPU_WORKERS_MICID
  166. \addindex __env__STARPU_WORKERS_MICID
  167. MIC equivalent of the \ref STARPU_WORKERS_CUDAID environment variable.
  168. This variable is ignored if the field
  169. starpu_conf::use_explicit_workers_mic_deviceid passed to starpu_init()
  170. is set.
  171. </dd>
  172. <dt>STARPU_WORKERS_SCCID</dt>
  173. <dd>
  174. \anchor STARPU_WORKERS_SCCID
  175. \addindex __env__STARPU_WORKERS_SCCID
  176. SCC equivalent of the \ref STARPU_WORKERS_CUDAID environment variable.
  177. This variable is ignored if the field
  178. starpu_conf::use_explicit_workers_scc_deviceid passed to starpu_init()
  179. is set.
  180. </dd>
  181. <dt>STARPU_SINGLE_COMBINED_WORKER</dt>
  182. <dd>
  183. \anchor STARPU_SINGLE_COMBINED_WORKER
  184. \addindex __env__STARPU_SINGLE_COMBINED_WORKER
  185. If set, StarPU will create several workers which won't be able to work
  186. concurrently. It will by default create combined workers which size goes from 1
  187. to the total number of CPU workers in the system. \ref STARPU_MIN_WORKERSIZE
  188. and \ref STARPU_MAX_WORKERSIZE can be used to change this default.
  189. </dd>
  190. <dt>STARPU_MIN_WORKERSIZE</dt>
  191. <dd>
  192. \anchor STARPU_MIN_WORKERSIZE
  193. \addindex __env__STARPU_MIN_WORKERSIZE
  194. \ref STARPU_MIN_WORKERSIZE
  195. permits to specify the minimum size of the combined workers (instead of the default 2)
  196. </dd>
  197. <dt>STARPU_MAX_WORKERSIZE</dt>
  198. <dd>
  199. \anchor STARPU_MAX_WORKERSIZE
  200. \addindex __env__STARPU_MAX_WORKERSIZE
  201. \ref STARPU_MAX_WORKERSIZE
  202. permits to specify the minimum size of the combined workers (instead of the
  203. number of CPU workers in the system)
  204. </dd>
  205. <dt>STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER</dt>
  206. <dd>
  207. \anchor STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
  208. \addindex __env__STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
  209. Let the user decide how many elements are allowed between combined workers
  210. created from hwloc information. For instance, in the case of sockets with 6
  211. cores without shared L2 caches, if \ref STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER is
  212. set to 6, no combined worker will be synthesized beyond one for the socket
  213. and one per core. If it is set to 3, 3 intermediate combined workers will be
  214. synthesized, to divide the socket cores into 3 chunks of 2 cores. If it set to
  215. 2, 2 intermediate combined workers will be synthesized, to divide the the socket
  216. cores into 2 chunks of 3 cores, and then 3 additional combined workers will be
  217. synthesized, to divide the former synthesized workers into a bunch of 2 cores,
  218. and the remaining core (for which no combined worker is synthesized since there
  219. is already a normal worker for it).
  220. The default, 2, thus makes StarPU tend to building a binary trees of combined
  221. workers.
  222. </dd>
  223. <dt>STARPU_DISABLE_ASYNCHRONOUS_COPY</dt>
  224. <dd>
  225. \anchor STARPU_DISABLE_ASYNCHRONOUS_COPY
  226. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_COPY
  227. Disable asynchronous copies between CPU and GPU devices.
  228. The AMD implementation of OpenCL is known to
  229. fail when copying data asynchronously. When using this implementation,
  230. it is therefore necessary to disable asynchronous data transfers.
  231. </dd>
  232. <dt>STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY</dt>
  233. <dd>
  234. \anchor STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY
  235. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY
  236. Disable asynchronous copies between CPU and CUDA devices.
  237. </dd>
  238. <dt>STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY</dt>
  239. <dd>
  240. \anchor STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY
  241. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY
  242. Disable asynchronous copies between CPU and OpenCL devices.
  243. The AMD implementation of OpenCL is known to
  244. fail when copying data asynchronously. When using this implementation,
  245. it is therefore necessary to disable asynchronous data transfers.
  246. </dd>
  247. <dt>STARPU_DISABLE_ASYNCHRONOUS_MIC_COPY</dt>
  248. <dd>
  249. \anchor STARPU_DISABLE_ASYNCHRONOUS_MIC_COPY
  250. \addindex __env__STARPU_DISABLE_ASYNCHRONOUS_MIC_COPY
  251. Disable asynchronous copies between CPU and MIC devices.
  252. </dd>
  253. <dt>STARPU_ENABLE_CUDA_GPU_GPU_DIRECT</dt>
  254. <dd>
  255. \anchor STARPU_ENABLE_CUDA_GPU_GPU_DIRECT
  256. \addindex __env__STARPU_ENABLE_CUDA_GPU_GPU_DIRECT
  257. Enable (1) or Disable (0) direct CUDA transfers from GPU to GPU, without copying
  258. through RAM. The default is Enabled.
  259. This permits to test the performance effect of GPU-Direct.
  260. </dd>
  261. <dt>STARPU_DISABLE_PINNING</dt>
  262. <dd>
  263. \anchor STARPU_DISABLE_PINNING
  264. \addindex __env__STARPU_DISABLE_PINNING
  265. Disable (1) or Enable (0) pinning host memory allocated through starpu_malloc
  266. and friends. The default is Enabled.
  267. This permits to test the performance effect of memory pinning.
  268. </dd>
  269. </dl>
  270. \section ConfiguringTheSchedulingEngine Configuring The Scheduling Engine
  271. <dl>
  272. <dt>STARPU_SCHED</dt>
  273. <dd>
  274. \anchor STARPU_SCHED
  275. \addindex __env__STARPU_SCHED
  276. Choose between the different scheduling policies proposed by StarPU: work
  277. random, stealing, greedy, with performance models, etc.
  278. Use <c>STARPU_SCHED=help</c> to get the list of available schedulers.
  279. </dd>
  280. <dt>STARPU_CALIBRATE</dt>
  281. <dd>
  282. \anchor STARPU_CALIBRATE
  283. \addindex __env__STARPU_CALIBRATE
  284. If this variable is set to 1, the performance models are calibrated during
  285. the execution. If it is set to 2, the previous values are dropped to restart
  286. calibration from scratch. Setting this variable to 0 disable calibration, this
  287. is the default behaviour.
  288. Note: this currently only applies to <c>dm</c> and <c>dmda</c> scheduling policies.
  289. </dd>
  290. <dt>STARPU_CALIBRATE_MINIMUM</dt>
  291. <dd>
  292. \anchor STARPU_CALIBRATE_MINIMUM
  293. \addindex __env__STARPU_CALIBRATE_MINIMUM
  294. This defines the minimum number of calibration measurements that will be made
  295. before considering that the performance model is calibrated. The default value is 10.
  296. </dd>
  297. <dt>STARPU_BUS_CALIBRATE</dt>
  298. <dd>
  299. \anchor STARPU_BUS_CALIBRATE
  300. \addindex __env__STARPU_BUS_CALIBRATE
  301. If this variable is set to 1, the bus is recalibrated during intialization.
  302. </dd>
  303. <dt>STARPU_PREFETCH</dt>
  304. <dd>
  305. \anchor STARPU_PREFETCH
  306. \addindex __env__STARPU_PREFETCH
  307. This variable indicates whether data prefetching should be enabled (0 means
  308. that it is disabled). If prefetching is enabled, when a task is scheduled to be
  309. executed e.g. on a GPU, StarPU will request an asynchronous transfer in
  310. advance, so that data is already present on the GPU when the task starts. As a
  311. result, computation and data transfers are overlapped.
  312. Note that prefetching is enabled by default in StarPU.
  313. </dd>
  314. <dt>STARPU_SCHED_ALPHA</dt>
  315. <dd>
  316. \anchor STARPU_SCHED_ALPHA
  317. \addindex __env__STARPU_SCHED_ALPHA
  318. To estimate the cost of a task StarPU takes into account the estimated
  319. computation time (obtained thanks to performance models). The alpha factor is
  320. the coefficient to be applied to it before adding it to the communication part.
  321. </dd>
  322. <dt>STARPU_SCHED_BETA</dt>
  323. <dd>
  324. \anchor STARPU_SCHED_BETA
  325. \addindex __env__STARPU_SCHED_BETA
  326. To estimate the cost of a task StarPU takes into account the estimated
  327. data transfer time (obtained thanks to performance models). The beta factor is
  328. the coefficient to be applied to it before adding it to the computation part.
  329. </dd>
  330. <dt>STARPU_SCHED_GAMMA</dt>
  331. <dd>
  332. \anchor STARPU_SCHED_GAMMA
  333. \addindex __env__STARPU_SCHED_GAMMA
  334. Define the execution time penalty of a joule (\ref Power-basedScheduling).
  335. </dd>
  336. <dt>STARPU_IDLE_POWER</dt>
  337. <dd>
  338. \anchor STARPU_IDLE_POWER
  339. \addindex __env__STARPU_IDLE_POWER
  340. Define the idle power of the machine (\ref Power-basedScheduling).
  341. </dd>
  342. <dt>STARPU_PROFILING</dt>
  343. <dd>
  344. \anchor STARPU_PROFILING
  345. \addindex __env__STARPU_PROFILING
  346. Enable on-line performance monitoring (\ref EnablingOn-linePerformanceMonitoring).
  347. </dd>
  348. </dl>
  349. \section Extensions Extensions
  350. <dl>
  351. <dt>SOCL_OCL_LIB_OPENCL</dt>
  352. <dd>
  353. \anchor SOCL_OCL_LIB_OPENCL
  354. \addindex __env__SOCL_OCL_LIB_OPENCL
  355. THE SOCL test suite is only run when the environment variable \ref
  356. SOCL_OCL_LIB_OPENCL is defined. It should contain the location
  357. of the file <c>libOpenCL.so</c> of the OCL ICD implementation.
  358. </dd>
  359. <dt>OCL_ICD_VENDORS</dt>
  360. <dd>
  361. \anchor OCL_ICD_VENDORS
  362. \addindex __env__OCL_ICD_VENDORS
  363. When using SOCL with OpenCL ICD
  364. (https://forge.imag.fr/projects/ocl-icd/), this variable may be used
  365. to point to the directory where ICD files are installed. The default
  366. directory is <c>/etc/OpenCL/vendors</c>. StarPU installs ICD
  367. files in the directory <c>$prefix/share/starpu/opencl/vendors</c>.
  368. </dd>
  369. <dt>STARPU_COMM_STATS</dt>
  370. <dd>
  371. \anchor STARPU_COMM_STATS
  372. \addindex __env__STARPU_COMM_STATS
  373. Communication statistics for starpumpi (\ref MPISupport)
  374. will be enabled when the environment variable \ref STARPU_COMM_STATS
  375. is defined to an value other than 0.
  376. </dd>
  377. <dt>STARPU_MPI_CACHE</dt>
  378. <dd>
  379. \anchor STARPU_MPI_CACHE
  380. \addindex __env__STARPU_MPI_CACHE
  381. Communication cache for starpumpi (\ref MPISupport) will be
  382. disabled when the environment variable \ref STARPU_MPI_CACHE is set
  383. to 0. It is enabled by default or for any other values of the variable
  384. \ref STARPU_MPI_CACHE.
  385. </dd>
  386. <dt>STARPU_MPI_CACHE_STATS</dt>
  387. <dd>
  388. \anchor STARPU_MPI_CACHE_STATS
  389. \addindex __env__STARPU_MPI_CACHE_STATS
  390. When set to 1, statistics are enabled for the communication cache (\ref MPISupport). For now,
  391. it prints messages on the standard output when data are added or removed from the received
  392. communication cache.
  393. </dd>
  394. </dl>
  395. \section MiscellaneousAndDebug Miscellaneous And Debug
  396. <dl>
  397. <dt>STARPU_HOME</dt>
  398. <dd>
  399. \anchor STARPU_HOME
  400. \addindex __env__STARPU_HOME
  401. This specifies the main directory in which StarPU stores its
  402. configuration files. The default is <c>$HOME</c> on Unix environments,
  403. and <c>$USERPROFILE</c> on Windows environments.
  404. </dd>
  405. <dt>STARPU_HOSTNAME</dt>
  406. <dd>
  407. \anchor STARPU_HOSTNAME
  408. \addindex __env__STARPU_HOSTNAME
  409. When set, force the hostname to be used when dealing performance model
  410. files. Models are indexed by machine name. When running for example on
  411. a homogenenous cluster, it is possible to share the models between
  412. machines by setting <c>export STARPU_HOSTNAME=some_global_name</c>.
  413. </dd>
  414. <dt>STARPU_OPENCL_PROGRAM_DIR</dt>
  415. <dd>
  416. \anchor STARPU_OPENCL_PROGRAM_DIR
  417. \addindex __env__STARPU_OPENCL_PROGRAM_DIR
  418. This specifies the directory where the OpenCL codelet source files are
  419. located. The function starpu_opencl_load_program_source() looks
  420. for the codelet in the current directory, in the directory specified
  421. by the environment variable \ref STARPU_OPENCL_PROGRAM_DIR, in the
  422. directory <c>share/starpu/opencl</c> of the installation directory of
  423. StarPU, and finally in the source directory of StarPU.
  424. </dd>
  425. <dt>STARPU_SILENT</dt>
  426. <dd>
  427. \anchor STARPU_SILENT
  428. \addindex __env__STARPU_SILENT
  429. This variable allows to disable verbose mode at runtime when StarPU
  430. has been configured with the option \ref enable-verbose "--enable-verbose". It also
  431. disables the display of StarPU information and warning messages.
  432. </dd>
  433. <dt>STARPU_LOGFILENAME</dt>
  434. <dd>
  435. \anchor STARPU_LOGFILENAME
  436. \addindex __env__STARPU_LOGFILENAME
  437. This variable specifies in which file the debugging output should be saved to.
  438. </dd>
  439. <dt>STARPU_FXT_PREFIX</dt>
  440. <dd>
  441. \anchor STARPU_FXT_PREFIX
  442. \addindex __env__STARPU_FXT_PREFIX
  443. This variable specifies in which directory to save the trace generated if FxT is enabled. It needs to have a trailing '/' character.
  444. </dd>
  445. <dt>STARPU_LIMIT_CUDA_devid_MEM</dt>
  446. <dd>
  447. \anchor STARPU_LIMIT_CUDA_devid_MEM
  448. \addindex __env__STARPU_LIMIT_CUDA_devid_MEM
  449. This variable specifies the maximum number of megabytes that should be
  450. available to the application on the CUDA device with the identifier
  451. <c>devid</c>. This variable is intended to be used for experimental
  452. purposes as it emulates devices that have a limited amount of memory.
  453. When defined, the variable overwrites the value of the variable
  454. \ref STARPU_LIMIT_CUDA_MEM.
  455. </dd>
  456. <dt>STARPU_LIMIT_CUDA_MEM</dt>
  457. <dd>
  458. \anchor STARPU_LIMIT_CUDA_MEM
  459. \addindex __env__STARPU_LIMIT_CUDA_MEM
  460. This variable specifies the maximum number of megabytes that should be
  461. available to the application on each CUDA devices. This variable is
  462. intended to be used for experimental purposes as it emulates devices
  463. that have a limited amount of memory.
  464. </dd>
  465. <dt>STARPU_LIMIT_OPENCL_devid_MEM</dt>
  466. <dd>
  467. \anchor STARPU_LIMIT_OPENCL_devid_MEM
  468. \addindex __env__STARPU_LIMIT_OPENCL_devid_MEM
  469. This variable specifies the maximum number of megabytes that should be
  470. available to the application on the OpenCL device with the identifier
  471. <c>devid</c>. This variable is intended to be used for experimental
  472. purposes as it emulates devices that have a limited amount of memory.
  473. When defined, the variable overwrites the value of the variable
  474. \ref STARPU_LIMIT_OPENCL_MEM.
  475. </dd>
  476. <dt>STARPU_LIMIT_OPENCL_MEM</dt>
  477. <dd>
  478. \anchor STARPU_LIMIT_OPENCL_MEM
  479. \addindex __env__STARPU_LIMIT_OPENCL_MEM
  480. This variable specifies the maximum number of megabytes that should be
  481. available to the application on each OpenCL devices. This variable is
  482. intended to be used for experimental purposes as it emulates devices
  483. that have a limited amount of memory.
  484. </dd>
  485. <dt>STARPU_LIMIT_CPU_MEM</dt>
  486. <dd>
  487. \anchor STARPU_LIMIT_CPU_MEM
  488. \addindex __env__STARPU_LIMIT_CPU_MEM
  489. This variable specifies the maximum number of megabytes that should be
  490. available to the application on each CPU device. This variable is
  491. intended to be used for experimental purposes as it emulates devices
  492. that have a limited amount of memory.
  493. </dd>
  494. <dt>STARPU_TRACE_BUFFER_SIZE</dt>
  495. <dd>
  496. \anchor STARPU_TRACE_BUFFER_SIZE
  497. \addindex __env__STARPU_TRACE_BUFFER_SIZE
  498. This sets the buffer size for recording trace events in MiB. Setting it to a big
  499. size allows to avoid pauses in the trace while it is recorded on the disk. This
  500. however also consumes memory, of course. The default value is 64.
  501. </dd>
  502. <dt>STARPU_GENERATE_TRACE</dt>
  503. <dd>
  504. \anchor STARPU_GENERATE_TRACE
  505. \addindex __env__STARPU_GENERATE_TRACE
  506. When set to <c>1</c>, this variable indicates that StarPU should automatically
  507. generate a Paje trace when starpu_shutdown() is called.
  508. </dd>
  509. <dt>STARPU_MEMORY_STATS</dt>
  510. <dd>
  511. \anchor STARPU_MEMORY_STATS
  512. \addindex __env__STARPU_MEMORY_STATS
  513. When set to 0, disable the display of memory statistics on data which
  514. have not been unregistered at the end of the execution (\ref MemoryFeedback).
  515. </dd>
  516. <dt>STARPU_BUS_STATS</dt>
  517. <dd>
  518. \anchor STARPU_BUS_STATS
  519. \addindex __env__STARPU_BUS_STATS
  520. When defined, statistics about data transfers will be displayed when calling
  521. starpu_shutdown() (\ref Profiling).
  522. </dd>
  523. <dt>STARPU_WORKER_STATS</dt>
  524. <dd>
  525. \anchor STARPU_WORKER_STATS
  526. \addindex __env__STARPU_WORKER_STATS
  527. When defined, statistics about the workers will be displayed when calling
  528. starpu_shutdown() (\ref Profiling). When combined with the
  529. environment variable \ref STARPU_PROFILING, it displays the power
  530. consumption (\ref Power-basedScheduling).
  531. </dd>
  532. <dt>STARPU_STATS</dt>
  533. <dd>
  534. \anchor STARPU_STATS
  535. \addindex __env__STARPU_STATS
  536. When set to 0, data statistics will not be displayed at the
  537. end of the execution of an application (\ref DataStatistics).
  538. </dd>
  539. <dt>STARPU_WATCHDOG_TIMEOUT</dt>
  540. <dd>
  541. \anchor STARPU_WATCHDOG_TIMEOUT
  542. \addindex __env__STARPU_WATCHDOG_TIMEOUT
  543. When set to a value other than 0, allows to make StarPU print an error
  544. message whenever StarPU does not terminate any task for the given time (in µs). Should
  545. be used in combination with \ref STARPU_WATCHDOG_CRASH (see \ref
  546. DetectionStuckConditions).
  547. </dd>
  548. <dt>STARPU_WATCHDOG_CRASH</dt>
  549. <dd>
  550. \anchor STARPU_WATCHDOG_CRASH
  551. \addindex __env__STARPU_WATCHDOG_CRASH
  552. When set to a value other than 0, it triggers a crash when the watch
  553. dog is reached, thus allowing to catch the situation in gdb, etc
  554. (see \ref DetectionStuckConditions)
  555. </dd>
  556. <dt>STARPU_DISABLE_KERNELS</dt>
  557. <dd>
  558. \anchor STARPU_DISABLE_KERNELS
  559. \addindex __env__STARPU_DISABLE_KERNELS
  560. When set to a value other than 1, it disables actually calling the kernel
  561. functions, thus allowing to quickly check that the task scheme is working
  562. properly, without performing the actual application-provided computation.
  563. </dd>
  564. <dt>STARPU_HISTORY_MAX_ERROR</dt>
  565. <dd>
  566. \anchor STARPU_HISTORY_MAX_ERROR
  567. \addindex __env__STARPU_HISTORY_MAX_ERROR
  568. History-based performance models will drop measurements which are really far
  569. froom the measured average. This specifies the allowed variation. The default is
  570. 50 (%), i.e. the measurement is allowed to be x1.5 faster or /1.5 slower than the
  571. average.
  572. </dd>
  573. </dl>
  574. \section ConfiguringTheHypervisor Configuring The Hypervisor
  575. <dl>
  576. <dt>SC_HYPERVISOR_POLICY</dt>
  577. <dd>
  578. \anchor SC_HYPERVISOR_POLICY
  579. \addindex __env__SC_HYPERVISOR_POLICY
  580. Choose between the different resizing policies proposed by StarPU for the hypervisor:
  581. idle, app_driven, feft_lp, teft_lp; ispeed_lp, throughput_lp etc.
  582. Use <c>SC_HYPERVISOR_POLICY=help</c> to get the list of available policies for the hypervisor
  583. </dd>
  584. <dt>SC_HYPERVISOR_TRIGGER_RESIZE</dt>
  585. <dd>
  586. \anchor SC_HYPERVISOR_TRIGGER_RESIZE
  587. \addindex __env__SC_HYPERVISOR_TRIGGER_RESIZE
  588. Choose how should the hypervisor be triggered: <c>speed</c> if the resizing algorithm should
  589. be called whenever the speed of the context does not correspond to an optimal precomputed value,
  590. <c>idle</c> it the resizing algorithm should be called whenever the workers are idle for a period
  591. longer than the value indicated when configuring the hypervisor.
  592. </dd>
  593. <dt>SC_HYPERVISOR_START_RESIZE</dt>
  594. <dd>
  595. \anchor SC_HYPERVISOR_START_RESIZE
  596. \addindex __env__SC_HYPERVISOR_START_RESIZE
  597. Indicate the moment when the resizing should be available. The value correspond to the percentage
  598. of the total time of execution of the application. The default value is the resizing frame.
  599. </dd>
  600. <dt>SC_HYPERVISOR_MAX_SPEED_GAP</dt>
  601. <dd>
  602. \anchor SC_HYPERVISOR_MAX_SPEED_GAP
  603. \addindex __env__SC_HYPERVISOR_MAX_SPEED_GAP
  604. Indicate the ratio of speed difference between contexts that should trigger the hypervisor.
  605. This situation may occur only when a theoretical speed could not be computed and the hypervisor
  606. has no value to compare the speed to. Otherwise the resizing of a context is not influenced by the
  607. the speed of the other contexts, but only by the the value that a context should have.
  608. </dd>
  609. <dt>SC_HYPERVISOR_STOP_PRINT</dt>
  610. <dd>
  611. \anchor SC_HYPERVISOR_STOP_PRINT
  612. \addindex __env__SC_HYPERVISOR_STOP_PRINT
  613. By default the values of the speed of the workers is printed during the execution
  614. of the application. If the value 1 is given to this environment variable this printing
  615. is not done.
  616. </dd>
  617. <dt>SC_HYPERVISOR_LAZY_RESIZE</dt>
  618. <dd>
  619. \anchor SC_HYPERVISOR_LAZY_RESIZE
  620. \addindex __env__SC_HYPERVISOR_LAZY_RESIZE
  621. By default the hypervisor resizes the contexts in a lazy way, that is workers are firstly added to a new context
  622. before removing them from the previous one. Once this workers are clearly taken into account
  623. into the new context (a task was poped there) we remove them from the previous one. However if the application
  624. would like that the change in the distribution of workers should change right away this variable should be set to 0
  625. </dd>
  626. <dt>SC_HYPERVISOR_SAMPLE_CRITERIA</dt>
  627. <dd>
  628. \anchor SC_HYPERVISOR_SAMPLE_CRITERIA
  629. \addindex __env__SC_HYPERVISOR_SAMPLE_CRITERIA
  630. By default the hypervisor uses a sample of flops when computing the speed of the contexts and of the workers.
  631. If this variable is set to <c>time</c> the hypervisor uses a sample of time (10% of an aproximation of the total
  632. execution time of the application)
  633. </dd>
  634. </dl>
  635. */