40environment_variables.doxy 24 KB

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