40environment_variables.doxy 24 KB

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