07data_management.doxy 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721
  1. /*
  2. * This file is part of the StarPU Handbook.
  3. * Copyright (C) 2009--2011 Universit@'e de Bordeaux
  4. * Copyright (C) 2010, 2011, 2012, 2013, 2014 CNRS
  5. * Copyright (C) 2011, 2012 INRIA
  6. * See the file version.doxy for copying conditions.
  7. */
  8. /*! \page DataManagement Data Management
  9. intro qui parle de coherency entre autres
  10. \section DataManagement Data Management
  11. When the application allocates data, whenever possible it should use
  12. the starpu_malloc() function, which will ask CUDA or OpenCL to make
  13. the allocation itself and pin the corresponding allocated memory, or to use the
  14. starpu_memory_pin() function to pin memory allocated by other ways, such as local arrays. This
  15. is needed to permit asynchronous data transfer, i.e. permit data
  16. transfer to overlap with computations. Otherwise, the trace will show
  17. that the <c>DriverCopyAsync</c> state takes a lot of time, this is
  18. because CUDA or OpenCL then reverts to synchronous transfers.
  19. By default, StarPU leaves replicates of data wherever they were used, in case they
  20. will be re-used by other tasks, thus saving the data transfer time. When some
  21. task modifies some data, all the other replicates are invalidated, and only the
  22. processing unit which ran that task will have a valid replicate of the data. If the application knows
  23. that this data will not be re-used by further tasks, it should advise StarPU to
  24. immediately replicate it to a desired list of memory nodes (given through a
  25. bitmask). This can be understood like the write-through mode of CPU caches.
  26. \code{.c}
  27. starpu_data_set_wt_mask(img_handle, 1<<0);
  28. \endcode
  29. will for instance request to always automatically transfer a replicate into the
  30. main memory (node <c>0</c>), as bit <c>0</c> of the write-through bitmask is being set.
  31. \code{.c}
  32. starpu_data_set_wt_mask(img_handle, ~0U);
  33. \endcode
  34. will request to always automatically broadcast the updated data to all memory
  35. nodes.
  36. Setting the write-through mask to <c>~0U</c> can also be useful to make sure all
  37. memory nodes always have a copy of the data, so that it is never evicted when
  38. memory gets scarse.
  39. Implicit data dependency computation can become expensive if a lot
  40. of tasks access the same piece of data. If no dependency is required
  41. on some piece of data (e.g. because it is only accessed in read-only
  42. mode, or because write accesses are actually commutative), use the
  43. function starpu_data_set_sequential_consistency_flag() to disable
  44. implicit dependencies on that data.
  45. In the same vein, accumulation of results in the same data can become a
  46. bottleneck. The use of the mode ::STARPU_REDUX permits to optimize such
  47. accumulation (see \ref DataReduction). To a lesser extent, the use of
  48. the flag ::STARPU_COMMUTE keeps the bottleneck (see \ref DataCommute), but at least permits
  49. the accumulation to happen in any order.
  50. Applications often need a data just for temporary results. In such a case,
  51. registration can be made without an initial value, for instance this produces a vector data:
  52. \code{.c}
  53. starpu_vector_data_register(&handle, -1, 0, n, sizeof(float));
  54. \endcode
  55. StarPU will then allocate the actual buffer only when it is actually needed,
  56. e.g. directly on the GPU without allocating in main memory.
  57. In the same vein, once the temporary results are not useful any more, the
  58. data should be thrown away. If the handle is not to be reused, it can be
  59. unregistered:
  60. \code{.c}
  61. starpu_data_unregister_submit(handle);
  62. \endcode
  63. actual unregistration will be done after all tasks working on the handle
  64. terminate.
  65. If the handle is to be reused, instead of unregistering it, it can simply be invalidated:
  66. \code{.c}
  67. starpu_data_invalidate_submit(handle);
  68. \endcode
  69. the buffers containing the current value will then be freed, and reallocated
  70. only when another task writes some value to the handle.
  71. \section DataPrefetch Data Prefetch
  72. The scheduling policies <c>heft</c>, <c>dmda</c> and <c>pheft</c>
  73. perform data prefetch (see \ref STARPU_PREFETCH):
  74. as soon as a scheduling decision is taken for a task, requests are issued to
  75. transfer its required data to the target processing unit, if needed, so that
  76. when the processing unit actually starts the task, its data will hopefully be
  77. already available and it will not have to wait for the transfer to finish.
  78. The application may want to perform some manual prefetching, for several reasons
  79. such as excluding initial data transfers from performance measurements, or
  80. setting up an initial statically-computed data distribution on the machine
  81. before submitting tasks, which will thus guide StarPU toward an initial task
  82. distribution (since StarPU will try to avoid further transfers).
  83. This can be achieved by giving the function starpu_data_prefetch_on_node() the
  84. handle and the desired target memory node. The
  85. starpu_data_idle_prefetch_on_node() variant can be used to issue the transfer
  86. only when the bus is idle.
  87. Conversely, one can advise StarPU that some data will not be useful in the
  88. close future by calling starpu_data_wont_use. StarPU will then write its value
  89. back to its home node, and evict it from GPUs when room is needed.
  90. \section PartitioningData Partitioning Data
  91. An existing piece of data can be partitioned in sub parts to be used by different tasks, for instance:
  92. \code{.c}
  93. int vector[NX];
  94. starpu_data_handle_t handle;
  95. /* Declare data to StarPU */
  96. starpu_vector_data_register(&handle, STARPU_MAIN_RAM, (uintptr_t)vector,
  97. NX, sizeof(vector[0]));
  98. /* Partition the vector in PARTS sub-vectors */
  99. struct starpu_data_filter f =
  100. {
  101. .filter_func = starpu_vector_filter_block,
  102. .nchildren = PARTS
  103. };
  104. starpu_data_partition(handle, &f);
  105. \endcode
  106. The task submission then uses the function starpu_data_get_sub_data()
  107. to retrieve the sub-handles to be passed as tasks parameters.
  108. \code{.c}
  109. /* Submit a task on each sub-vector */
  110. for (i=0; i<starpu_data_get_nb_children(handle); i++) {
  111. /* Get subdata number i (there is only 1 dimension) */
  112. starpu_data_handle_t sub_handle = starpu_data_get_sub_data(handle, 1, i);
  113. struct starpu_task *task = starpu_task_create();
  114. task->handles[0] = sub_handle;
  115. task->cl = &cl;
  116. task->synchronous = 1;
  117. task->cl_arg = &factor;
  118. task->cl_arg_size = sizeof(factor);
  119. starpu_task_submit(task);
  120. }
  121. \endcode
  122. Partitioning can be applied several times, see
  123. <c>examples/basic_examples/mult.c</c> and <c>examples/filters/</c>.
  124. Wherever the whole piece of data is already available, the partitioning will
  125. be done in-place, i.e. without allocating new buffers but just using pointers
  126. inside the existing copy. This is particularly important to be aware of when
  127. using OpenCL, where the kernel parameters are not pointers, but handles. The
  128. kernel thus needs to be also passed the offset within the OpenCL buffer:
  129. \code{.c}
  130. void opencl_func(void *buffers[], void *cl_arg)
  131. {
  132. cl_mem vector = (cl_mem) STARPU_VECTOR_GET_DEV_HANDLE(buffers[0]);
  133. unsigned offset = STARPU_BLOCK_GET_OFFSET(buffers[0]);
  134. ...
  135. clSetKernelArg(kernel, 0, sizeof(vector), &vector);
  136. clSetKernelArg(kernel, 1, sizeof(offset), &offset);
  137. ...
  138. }
  139. \endcode
  140. And the kernel has to shift from the pointer passed by the OpenCL driver:
  141. \code{.c}
  142. __kernel void opencl_kernel(__global int *vector, unsigned offset)
  143. {
  144. block = (__global void *)block + offset;
  145. ...
  146. }
  147. \endcode
  148. StarPU provides various interfaces and filters for matrices, vectors, etc.,
  149. but applications can also write their own data interfaces and filters, see
  150. <c>examples/interface</c> and <c>examples/filters/custom_mf</c> for an example.
  151. \section AsynchronousPartitioning Asynchronous Partitioning
  152. The partitioning functions described in the previous section are synchronous:
  153. starpu_data_partition and starpu_data_unpartition both wait for all the tasks
  154. currently working on the data. This can be a bottleneck for the application.
  155. An asynchronous API also exists, it works only on handles with sequential
  156. consistency. The principle is to first plan the partitioning, which returns
  157. data handles of the partition, which are not functional yet. Along other task
  158. submission, one can submit the actual partitioning, and then use the handles
  159. of the partition. Before using the handle of the whole data, one has to submit
  160. the unpartitioning. <c>fmultiple_automatic</c> is a complete example using this
  161. technique.
  162. In short, we first register a matrix and plan the partitioning:
  163. \code{.c}
  164. starpu_matrix_data_register(&handle, STARPU_MAIN_RAM, (uintptr_t)matrix, NX, NX, NY, sizeof(matrix[0]));
  165. struct starpu_data_filter f_vert =
  166. {
  167. .filter_func = starpu_matrix_filter_block,
  168. .nchildren = PARTS
  169. };
  170. starpu_data_partition_plan(handle, &f_vert, vert_handle);
  171. \endcode
  172. starpu_data_partition_plan returns the handles for the partition in vert_handle.
  173. One can submit tasks working on the main handle, but not yet on the vert_handle
  174. handles. Now we submit the partitioning:
  175. \code{.c}
  176. starpu_data_partition_submit(handle, PARTS, vert_handle);
  177. \endcode
  178. And now we can submit tasks working on vert_handle handles (and not on the main
  179. handle any more). Eventually we want to work on the main handle again, so we
  180. submit the unpartitioning:
  181. starpu_data_unpartition_submit(handle, PARTS, vert_handle);
  182. And now we can submit tasks working on the main handle again.
  183. All this code is asynchronous, just submitting which tasks, partitioning and
  184. unpartitioning should be done at runtime.
  185. Planning several partitioning of the same data is also possible, one just has
  186. to submit unpartitioning (to get back to the initial handle) before submitting
  187. another partitioning.
  188. It is also possible to activate several partitioning at the same time, in read-only mode.
  189. \section ManualPartitioning Manual Partitioning
  190. One can also handle partitioning by hand, by registering several views on the
  191. same piece of data. The idea is then to manage the coherency of the various
  192. views through the common buffer in the main memory.
  193. <c>fmultiple_manual</c> is a complete example using this technique.
  194. In short, we first register the same matrix several times:
  195. \code{.c}
  196. starpu_matrix_data_register(&handle, STARPU_MAIN_RAM, (uintptr_t)matrix, NX, NX, NY, sizeof(matrix[0]));
  197. for (i = 0; i < PARTS; i++)
  198. starpu_matrix_data_register(&vert_handle[i], STARPU_MAIN_RAM, (uintptr_t)&matrix[0][i*(NX/PARTS)], NX, NX/PARTS, NY, sizeof(matrix[0][0]));
  199. \endcode
  200. Since StarPU is not aware that the two handles are actually pointing to the same
  201. data, we have a danger of inadvertently submitting tasks to both views, which
  202. will bring a mess since StarPU will not guarantee any coherency between the two
  203. views. To make sure we don't do this, we invalidate the view that we will not
  204. use:
  205. \code{.c}
  206. for (i = 0; i < PARTS; i++)
  207. starpu_data_invalidate(vert_handle[i]);
  208. \endcode
  209. Then we can safely work on <c>handle</c>.
  210. When we want to switch to the vertical slice view, all we need to do is bring
  211. coherency between them by running an empty task on the home node of the data:
  212. \code{.c}
  213. void empty(void *buffers[] STARPU_ATTRIBUTE_UNUSED, void *cl_arg STARPU_ATTRIBUTE_UNUSED)
  214. { }
  215. struct starpu_codelet cl_switch =
  216. {
  217. .cpu_funcs = {empty},
  218. .nbuffers = STARPU_VARIABLE_NBUFFERS,
  219. };
  220. ret = starpu_task_insert(&cl_switch, STARPU_RW, handle,
  221. STARPU_W, vert_handle[0],
  222. STARPU_W, vert_handle[1],
  223. 0);
  224. \endcode
  225. The execution of the <c>switch</c> task will get back the matrix data into the
  226. main memory, and thus the vertical slices will get the updated value there.
  227. Again, we prefer to make sure that we don't accidentally access the matrix through the whole-matrix handle:
  228. \code{.c}
  229. starpu_data_invalidate_submit(handle);
  230. \end
  231. And now we can start using vertical slices, etc.
  232. \section DataReduction Data Reduction
  233. In various cases, some piece of data is used to accumulate intermediate
  234. results. For instances, the dot product of a vector, maximum/minimum finding,
  235. the histogram of a photograph, etc. When these results are produced along the
  236. whole machine, it would not be efficient to accumulate them in only one place,
  237. incurring data transmission each and access concurrency.
  238. StarPU provides a mode ::STARPU_REDUX, which permits to optimize
  239. that case: it will allocate a buffer on each memory node, and accumulate
  240. intermediate results there. When the data is eventually accessed in the normal
  241. mode ::STARPU_R, StarPU will collect the intermediate results in just one
  242. buffer.
  243. For this to work, the user has to use the function
  244. starpu_data_set_reduction_methods() to declare how to initialize these
  245. buffers, and how to assemble partial results.
  246. For instance, <c>cg</c> uses that to optimize its dot product: it first defines
  247. the codelets for initialization and reduction:
  248. \code{.c}
  249. struct starpu_codelet bzero_variable_cl =
  250. {
  251. .cpu_funcs = { bzero_variable_cpu },
  252. .cpu_funcs_name = { "bzero_variable_cpu" },
  253. .cuda_funcs = { bzero_variable_cuda },
  254. .nbuffers = 1,
  255. }
  256. static void accumulate_variable_cpu(void *descr[], void *cl_arg)
  257. {
  258. double *v_dst = (double *)STARPU_VARIABLE_GET_PTR(descr[0]);
  259. double *v_src = (double *)STARPU_VARIABLE_GET_PTR(descr[1]);
  260. *v_dst = *v_dst + *v_src;
  261. }
  262. static void accumulate_variable_cuda(void *descr[], void *cl_arg)
  263. {
  264. double *v_dst = (double *)STARPU_VARIABLE_GET_PTR(descr[0]);
  265. double *v_src = (double *)STARPU_VARIABLE_GET_PTR(descr[1]);
  266. cublasaxpy(1, (double)1.0, v_src, 1, v_dst, 1);
  267. cudaStreamSynchronize(starpu_cuda_get_local_stream());
  268. }
  269. struct starpu_codelet accumulate_variable_cl =
  270. {
  271. .cpu_funcs = { accumulate_variable_cpu },
  272. .cpu_funcs_name = { "accumulate_variable_cpu" },
  273. .cuda_funcs = { accumulate_variable_cuda },
  274. .nbuffers = 1,
  275. }
  276. \endcode
  277. and attaches them as reduction methods for its handle <c>dtq</c>:
  278. \code{.c}
  279. starpu_variable_data_register(&dtq_handle, -1, NULL, sizeof(type));
  280. starpu_data_set_reduction_methods(dtq_handle,
  281. &accumulate_variable_cl, &bzero_variable_cl);
  282. \endcode
  283. and <c>dtq_handle</c> can now be used in mode ::STARPU_REDUX for the
  284. dot products with partitioned vectors:
  285. \code{.c}
  286. for (b = 0; b < nblocks; b++)
  287. starpu_task_insert(&dot_kernel_cl,
  288. STARPU_REDUX, dtq_handle,
  289. STARPU_R, starpu_data_get_sub_data(v1, 1, b),
  290. STARPU_R, starpu_data_get_sub_data(v2, 1, b),
  291. 0);
  292. \endcode
  293. During registration, we have here provided <c>NULL</c>, i.e. there is
  294. no initial value to be taken into account during reduction. StarPU
  295. will thus only take into account the contributions from the tasks
  296. <c>dot_kernel_cl</c>. Also, it will not allocate any memory for
  297. <c>dtq_handle</c> before tasks <c>dot_kernel_cl</c> are ready to run.
  298. If another dot product has to be performed, one could unregister
  299. <c>dtq_handle</c>, and re-register it. But one can also call
  300. starpu_data_invalidate_submit() with the parameter <c>dtq_handle</c>,
  301. which will clear all data from the handle, thus resetting it back to
  302. the initial status <c>register(NULL)</c>.
  303. The example <c>cg</c> also uses reduction for the blocked gemv kernel,
  304. leading to yet more relaxed dependencies and more parallelism.
  305. ::STARPU_REDUX can also be passed to starpu_mpi_task_insert() in the MPI
  306. case. That will however not produce any MPI communication, but just pass
  307. ::STARPU_REDUX to the underlying starpu_task_insert(). It is up to the
  308. application to call starpu_mpi_redux_data(), which posts tasks that will
  309. reduce the partial results among MPI nodes into the MPI node which owns the
  310. data. For instance, some hypothetical application which collects partial results
  311. into data <c>res</c>, then uses it for other computation, before looping again
  312. with a new reduction:
  313. \code{.c}
  314. for (i = 0; i < 100; i++) {
  315. starpu_mpi_task_insert(MPI_COMM_WORLD, &init_res, STARPU_W, res, 0);
  316. starpu_mpi_task_insert(MPI_COMM_WORLD, &work, STARPU_RW, A,
  317. STARPU_R, B, STARPU_REDUX, res, 0);
  318. starpu_mpi_redux_data(MPI_COMM_WORLD, res);
  319. starpu_mpi_task_insert(MPI_COMM_WORLD, &work2, STARPU_RW, B, STARPU_R, res, 0);
  320. }
  321. \endcode
  322. \section DataCommute Commute Data Access
  323. By default, the implicit dependencies computed from data access use the
  324. sequential semantic. Notably, write accesses are always serialized in the order
  325. of submission. In some applicative cases, the write contributions can actually
  326. be performed in any order without affecting the eventual result. In that case
  327. it is useful to drop the strictly sequential semantic, to improve parallelism
  328. by allowing StarPU to reorder the write accesses. This can be done by using
  329. the ::STARPU_COMMUTE data access flag. Accesses without this flag will however
  330. properly be serialized against accesses with this flag. For instance:
  331. \code{.c}
  332. starpu_task_insert(&cl1,
  333. STARPU_R, h,
  334. STARPU_RW, handle,
  335. 0);
  336. starpu_task_insert(&cl2,
  337. STARPU_R, handle1,
  338. STARPU_RW|STARPU_COMMUTE, handle,
  339. 0);
  340. starpu_task_insert(&cl2,
  341. STARPU_R, handle2,
  342. STARPU_RW|STARPU_COMMUTE, handle,
  343. 0);
  344. starpu_task_insert(&cl3,
  345. STARPU_R, g,
  346. STARPU_RW, handle,
  347. 0);
  348. \endcode
  349. The two tasks running cl2 will be able to commute: depending on whether the
  350. value of handle1 or handle2 becomes available first, the corresponding task
  351. running cl2 will start first. The task running cl1 will however always be run
  352. before them, and the task running cl3 will always be run after them.
  353. If a lot of tasks use the commute access on the same set of data and a lot of
  354. them are ready at the same time, it may become interesting to use an arbiter,
  355. see \ref ConcurrentDataAccess .
  356. \section ConcurrentDataAccess Concurrent Data accesses
  357. When several tasks are ready and will work on several data, StarPU is faced with
  358. the classical Dining Philosophers problem, and has to determine the order in
  359. which it will run the tasks.
  360. Data accesses usually use sequential ordering, so data accesses are usually
  361. already serialized, and thus by default StarPU uses the Dijkstra solution which
  362. scales very well in terms of overhead: tasks will just acquire data one by one
  363. by data handle pointer value order.
  364. When sequential ordering is disabled or the ::STARPU_COMMUTE flag is used, there
  365. may be a lot of concurrent accesses to the same data, and the Dijkstra solution
  366. gets only poor parallelism, typically in some pathological cases which do happen
  367. in various applications. In that case, one can use a data access arbiter, which
  368. implements the classical centralized solution for the Dining Philosophers
  369. problem. This is more expensive in terms of overhead since it is centralized,
  370. but it opportunistically gets a lot of parallelism. The centralization can also
  371. be avoided by using several arbiters, thus separating sets of data for which
  372. arbitration will be done. If a task accesses data from different arbiters, it
  373. will acquire them arbiter by arbiter, in arbiter pointer value order.
  374. See the tests/datawizard/test_arbiter.cpp example.
  375. Arbiters however do not support the STARPU_REDUX flag yet.
  376. \section TemporaryBuffers Temporary Buffers
  377. There are two kinds of temporary buffers: temporary data which just pass results
  378. from a task to another, and scratch data which are needed only internally by
  379. tasks.
  380. \subsection TemporaryData Temporary Data
  381. Data can sometimes be entirely produced by a task, and entirely consumed by
  382. another task, without the need for other parts of the application to access
  383. it. In such case, registration can be done without prior allocation, by using
  384. the special memory node number <c>-1</c>, and passing a zero pointer. StarPU will
  385. actually allocate memory only when the task creating the content gets scheduled,
  386. and destroy it on unregistration.
  387. In addition to that, it can be tedious for the application to have to unregister
  388. the data, since it will not use its content anyway. The unregistration can be
  389. done lazily by using the function starpu_data_unregister_submit(),
  390. which will record that no more tasks accessing the handle will be submitted, so
  391. that it can be freed as soon as the last task accessing it is over.
  392. The following code examplifies both points: it registers the temporary
  393. data, submits three tasks accessing it, and records the data for automatic
  394. unregistration.
  395. \code{.c}
  396. starpu_vector_data_register(&handle, -1, 0, n, sizeof(float));
  397. starpu_task_insert(&produce_data, STARPU_W, handle, 0);
  398. starpu_task_insert(&compute_data, STARPU_RW, handle, 0);
  399. starpu_task_insert(&summarize_data, STARPU_R, handle, STARPU_W, result_handle, 0);
  400. starpu_data_unregister_submit(handle);
  401. \endcode
  402. The application may also want to see the temporary data initialized
  403. on the fly before being used by the task. This can be done by using
  404. starpu_data_set_reduction_methods() to set an initialization codelet (no redux
  405. codelet is needed).
  406. \subsection ScratchData Scratch Data
  407. Some kernels sometimes need temporary data to achieve the computations, i.e. a
  408. workspace. The application could allocate it at the start of the codelet
  409. function, and free it at the end, but that would be costly. It could also
  410. allocate one buffer per worker (similarly to \ref
  411. HowToInitializeAComputationLibraryOnceForEachWorker), but that would
  412. make them systematic and permanent. A more optimized way is to use
  413. the data access mode ::STARPU_SCRATCH, as examplified below, which
  414. provides per-worker buffers without content consistency.
  415. \code{.c}
  416. starpu_vector_data_register(&workspace, -1, 0, sizeof(float));
  417. for (i = 0; i < N; i++)
  418. starpu_task_insert(&compute, STARPU_R, input[i],
  419. STARPU_SCRATCH, workspace, STARPU_W, output[i], 0);
  420. \endcode
  421. StarPU will make sure that the buffer is allocated before executing the task,
  422. and make this allocation per-worker: for CPU workers, notably, each worker has
  423. its own buffer. This means that each task submitted above will actually have its
  424. own workspace, which will actually be the same for all tasks running one after
  425. the other on the same worker. Also, if for instance GPU memory becomes scarce,
  426. StarPU will notice that it can free such buffers easily, since the content does
  427. not matter.
  428. The example <c>examples/pi</c> uses scratches for some temporary buffer.
  429. \section TheMultiformatInterface The Multiformat Interface
  430. It may be interesting to represent the same piece of data using two different
  431. data structures: one that would only be used on CPUs, and one that would only
  432. be used on GPUs. This can be done by using the multiformat interface. StarPU
  433. will be able to convert data from one data structure to the other when needed.
  434. Note that the scheduler <c>dmda</c> is the only one optimized for this
  435. interface. The user must provide StarPU with conversion codelets:
  436. \snippet multiformat.c To be included. You should update doxygen if you see this text.
  437. Kernels can be written almost as for any other interface. Note that
  438. ::STARPU_MULTIFORMAT_GET_CPU_PTR shall only be used for CPU kernels. CUDA kernels
  439. must use ::STARPU_MULTIFORMAT_GET_CUDA_PTR, and OpenCL kernels must use
  440. ::STARPU_MULTIFORMAT_GET_OPENCL_PTR. ::STARPU_MULTIFORMAT_GET_NX may
  441. be used in any kind of kernel.
  442. \code{.c}
  443. static void
  444. multiformat_scal_cpu_func(void *buffers[], void *args)
  445. {
  446. struct point *aos;
  447. unsigned int n;
  448. aos = STARPU_MULTIFORMAT_GET_CPU_PTR(buffers[0]);
  449. n = STARPU_MULTIFORMAT_GET_NX(buffers[0]);
  450. ...
  451. }
  452. extern "C" void multiformat_scal_cuda_func(void *buffers[], void *_args)
  453. {
  454. unsigned int n;
  455. struct struct_of_arrays *soa;
  456. soa = (struct struct_of_arrays *) STARPU_MULTIFORMAT_GET_CUDA_PTR(buffers[0]);
  457. n = STARPU_MULTIFORMAT_GET_NX(buffers[0]);
  458. ...
  459. }
  460. \endcode
  461. A full example may be found in <c>examples/basic_examples/multiformat.c</c>.
  462. \section DefiningANewDataInterface Defining A New Data Interface
  463. Let's define a new data interface to manage complex numbers.
  464. \code{.c}
  465. /* interface for complex numbers */
  466. struct starpu_complex_interface
  467. {
  468. double *real;
  469. double *imaginary;
  470. int nx;
  471. };
  472. \endcode
  473. Registering such a data to StarPU is easily done using the function
  474. starpu_data_register(). The last
  475. parameter of the function, <c>interface_complex_ops</c>, will be
  476. described below.
  477. \code{.c}
  478. void starpu_complex_data_register(starpu_data_handle_t *handle,
  479. unsigned home_node, double *real, double *imaginary, int nx)
  480. {
  481. struct starpu_complex_interface complex =
  482. {
  483. .real = real,
  484. .imaginary = imaginary,
  485. .nx = nx
  486. };
  487. if (interface_complex_ops.interfaceid == STARPU_UNKNOWN_INTERFACE_ID)
  488. {
  489. interface_complex_ops.interfaceid = starpu_data_interface_get_next_id();
  490. }
  491. starpu_data_register(handleptr, home_node, &complex, &interface_complex_ops);
  492. }
  493. \endcode
  494. Different operations need to be defined for a data interface through
  495. the type starpu_data_interface_ops. We only define here the basic
  496. operations needed to run simple applications. The source code for the
  497. different functions can be found in the file
  498. <c>examples/interface/complex_interface.c</c>.
  499. \code{.c}
  500. static struct starpu_data_interface_ops interface_complex_ops =
  501. {
  502. .register_data_handle = complex_register_data_handle,
  503. .allocate_data_on_node = complex_allocate_data_on_node,
  504. .copy_methods = &complex_copy_methods,
  505. .get_size = complex_get_size,
  506. .footprint = complex_footprint,
  507. .interfaceid = STARPU_UNKNOWN_INTERFACE_ID,
  508. .interface_size = sizeof(struct starpu_complex_interface),
  509. };
  510. \endcode
  511. Functions need to be defined to access the different fields of the
  512. complex interface from a StarPU data handle.
  513. \code{.c}
  514. double *starpu_complex_get_real(starpu_data_handle_t handle)
  515. {
  516. struct starpu_complex_interface *complex_interface =
  517. (struct starpu_complex_interface *) starpu_data_get_interface_on_node(handle, STARPU_MAIN_RAM);
  518. return complex_interface->real;
  519. }
  520. double *starpu_complex_get_imaginary(starpu_data_handle_t handle);
  521. int starpu_complex_get_nx(starpu_data_handle_t handle);
  522. \endcode
  523. Similar functions need to be defined to access the different fields of the
  524. complex interface from a <c>void *</c> pointer to be used within codelet
  525. implemetations.
  526. \snippet complex.c To be included. You should update doxygen if you see this text.
  527. Complex data interfaces can then be registered to StarPU.
  528. \code{.c}
  529. double real = 45.0;
  530. double imaginary = 12.0;starpu_complex_data_register(&handle1, STARPU_MAIN_RAM, &real, &imaginary, 1);
  531. starpu_task_insert(&cl_display, STARPU_R, handle1, 0);
  532. \endcode
  533. and used by codelets.
  534. \code{.c}
  535. void display_complex_codelet(void *descr[], __attribute__ ((unused)) void *_args)
  536. {
  537. int nx = STARPU_COMPLEX_GET_NX(descr[0]);
  538. double *real = STARPU_COMPLEX_GET_REAL(descr[0]);
  539. double *imaginary = STARPU_COMPLEX_GET_IMAGINARY(descr[0]);
  540. int i;
  541. for(i=0 ; i<nx ; i++)
  542. {
  543. fprintf(stderr, "Complex[%d] = %3.2f + %3.2f i\n", i, real[i], imaginary[i]);
  544. }
  545. }
  546. \endcode
  547. The whole code for this complex data interface is available in the
  548. directory <c>examples/interface/</c>.
  549. \section SpecifyingATargetNode Specifying a target node for task data
  550. When executing a task on a GPU for instance, StarPU would normally copy all the
  551. needed data for the tasks on the embedded memory of the GPU. It may however
  552. happen that the task kernel would rather have some of the datas kept in the
  553. main memory instead of copied in the GPU, a pivoting vector for instance.
  554. This can be achieved by setting the starpu_codelet::specific_nodes flag to
  555. 1, and then fill the starpu_codelet::nodes array (or starpu_codelet::dyn_nodes when
  556. starpu_codelet::nbuffers is greater than STARPU_NMAXBUFS) with the node numbers
  557. where data should be copied to, or -1 to let StarPU copy it to the memory node
  558. where the task will be executed. For instance, with the following codelet:
  559. \code{.c}
  560. struct starpu_codelet cl =
  561. {
  562. .cuda_funcs = { kernel },
  563. .nbuffers = 2,
  564. .modes = {STARPU_RW, STARPU_RW},
  565. .specific_nodes = 1,
  566. .nodes = {STARPU_MAIN_RAM, -1},
  567. };
  568. \endcode
  569. the first data of the task will be kept in the main memory, while the second
  570. data will be copied to the CUDA GPU as usual.
  571. */