40environment_variables.doxy 22 KB

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