40environment_variables.doxy 23 KB

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