40environment_variables.doxy 25 KB

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