advanced-examples.texi 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  1. @c -*-texinfo-*-
  2. @c This file is part of the StarPU Handbook.
  3. @c Copyright (C) 2009--2011 Universit@'e de Bordeaux 1
  4. @c Copyright (C) 2010, 2011 Centre National de la Recherche Scientifique
  5. @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
  6. @c See the file starpu.texi for copying conditions.
  7. @node Advanced Examples
  8. @chapter Advanced Examples
  9. @menu
  10. * Using multiple implementations of a codelet::
  11. * Enabling implementation according to capabilities::
  12. * Task and Worker Profiling::
  13. * Partitioning Data:: Partitioning Data
  14. * Performance model example::
  15. * Theoretical lower bound on execution time::
  16. * Insert Task Utility::
  17. * The multiformat interface::
  18. * On-GPU rendering::
  19. * More examples:: More examples shipped with StarPU
  20. * Debugging:: When things go wrong.
  21. @end menu
  22. @node Using multiple implementations of a codelet
  23. @section Using multiple implementations of a codelet
  24. One may want to write multiple implementations of a codelet for a single type of
  25. device and let StarPU choose which one to run. As an example, we will show how
  26. to use SSE to scale a vector. The codelet can be written as follows :
  27. @cartouche
  28. @smallexample
  29. #include <xmmintrin.h>
  30. void scal_sse_func(void *buffers[], void *cl_arg)
  31. @{
  32. float *vector = (float *) STARPU_VECTOR_GET_PTR(buffers[0]);
  33. unsigned int n = STARPU_VECTOR_GET_NX(buffers[0]);
  34. unsigned int n_iterations = n/4;
  35. if (n % 4 != 0)
  36. n_iterations++;
  37. __m128 *VECTOR = (__m128*) vector;
  38. __m128 factor __attribute__((aligned(16)));
  39. factor = _mm_set1_ps(*(float *) cl_arg);
  40. unsigned int i;
  41. for (i = 0; i < n_iterations; i++)
  42. VECTOR[i] = _mm_mul_ps(factor, VECTOR[i]);
  43. @}
  44. @end smallexample
  45. @end cartouche
  46. @cartouche
  47. @smallexample
  48. struct starpu_codelet cl = @{
  49. .where = STARPU_CPU,
  50. .cpu_funcs = @{ scal_cpu_func, scal_sse_func, NULL @},
  51. .nbuffers = 1
  52. @};
  53. @end smallexample
  54. @end cartouche
  55. Schedulers which are multi-implementation aware (only @code{dmda}, @code{heft}
  56. and @code{pheft} for now) will use the performance models of all the
  57. implementations it was given, and pick the one that seems to be the fastest.
  58. @node Enabling implementation according to capabilities
  59. @section Enabling implementation according to capabilities
  60. Some implementations may not run on some devices. For instance, some CUDA
  61. devices do not support double floating point precision, and thus the kernel
  62. execution would just fail; or the device may not have enough shared memory for
  63. the implementation being used. The @code{can_execute} field of the @code{struct
  64. starpu_codelet} structure permits to express this. For instance:
  65. @cartouche
  66. @smallexample
  67. static int can_execute(unsigned workerid, struct starpu_task *task, unsigned nimpl)
  68. @{
  69. const struct cudaDeviceProp *props;
  70. if (starpu_worker_get_type(workerid) == STARPU_CPU_WORKER)
  71. return 1;
  72. /* Cuda device */
  73. props = starpu_cuda_get_device_properties(workerid);
  74. if (props->major >= 2 || props->minor >= 3)
  75. /* At least compute capability 1.3, supports doubles */
  76. return 1;
  77. /* Old card, does not support doubles */
  78. return 0;
  79. @}
  80. struct starpu_codelet cl = @{
  81. .where = STARPU_CPU|STARPU_CUDA,
  82. .can_execute = can_execute,
  83. .cpu_funcs = @{ cpu_func, NULL @},
  84. .cuda_funcs = @{ gpu_func, NULL @}
  85. .nbuffers = 1
  86. @};
  87. @end smallexample
  88. @end cartouche
  89. This can be essential e.g. when running on a machine which mixes various models
  90. of CUDA devices, to take benefit from the new models without crashing on old models.
  91. Note: the @code{can_execute} function is called by the scheduler each time it
  92. tries to match a task with a worker, and should thus be very fast. The
  93. @code{starpu_cuda_get_device_properties} provides a quick access to CUDA
  94. properties of CUDA devices to achieve such efficiency.
  95. Another example is compiling CUDA code for various compute capabilities,
  96. resulting with two CUDA functions, e.g. @code{scal_gpu_13} for compute capability
  97. 1.3, and @code{scal_gpu_20} for compute capability 2.0. Both functions can be
  98. provided to StarPU by using @code{cuda_funcs}, and @code{can_execute} can then be
  99. used to rule out the @code{scal_gpu_20} variant on a CUDA device which
  100. will not be able to execute it:
  101. @cartouche
  102. @smallexample
  103. static int can_execute(unsigned workerid, struct starpu_task *task, unsigned nimpl)
  104. @{
  105. const struct cudaDeviceProp *props;
  106. if (starpu_worker_get_type(workerid) == STARPU_CPU_WORKER)
  107. return 1;
  108. /* Cuda device */
  109. if (nimpl == 0)
  110. /* Trying to execute the 1.3 capability variant, we assume it is ok in all cases. */
  111. return 1;
  112. /* Trying to execute the 2.0 capability variant, check that the card can do it. */
  113. props = starpu_cuda_get_device_properties(workerid);
  114. if (props->major >= 2 || props->minor >= 0)
  115. /* At least compute capability 2.0, can run it */
  116. return 1;
  117. /* Old card, does not support 2.0, will not be able to execute the 2.0 variant. */
  118. return 0;
  119. @}
  120. struct starpu_codelet cl = @{
  121. .where = STARPU_CPU|STARPU_CUDA,
  122. .can_execute = can_execute,
  123. .cpu_funcs = @{ cpu_func, NULL @},
  124. .cuda_funcs = @{ scal_gpu_13, scal_gpu_20, NULL @},
  125. .nbuffers = 1
  126. @};
  127. @end smallexample
  128. @end cartouche
  129. Note: the most generic variant should be provided first, as some schedulers are
  130. not able to try the different variants.
  131. @node Task and Worker Profiling
  132. @section Task and Worker Profiling
  133. A full example showing how to use the profiling API is available in
  134. the StarPU sources in the directory @code{examples/profiling/}.
  135. @cartouche
  136. @smallexample
  137. struct starpu_task *task = starpu_task_create();
  138. task->cl = &cl;
  139. task->synchronous = 1;
  140. /* We will destroy the task structure by hand so that we can
  141. * query the profiling info before the task is destroyed. */
  142. task->destroy = 0;
  143. /* Submit and wait for completion (since synchronous was set to 1) */
  144. starpu_task_submit(task);
  145. /* The task is finished, get profiling information */
  146. struct starpu_task_profiling_info *info = task->profiling_info;
  147. /* How much time did it take before the task started ? */
  148. double delay += starpu_timing_timespec_delay_us(&info->submit_time, &info->start_time);
  149. /* How long was the task execution ? */
  150. double length += starpu_timing_timespec_delay_us(&info->start_time, &info->end_time);
  151. /* We don't need the task structure anymore */
  152. starpu_task_destroy(task);
  153. @end smallexample
  154. @end cartouche
  155. @cartouche
  156. @smallexample
  157. /* Display the occupancy of all workers during the test */
  158. int worker;
  159. for (worker = 0; worker < starpu_worker_get_count(); worker++)
  160. @{
  161. struct starpu_worker_profiling_info worker_info;
  162. int ret = starpu_worker_get_profiling_info(worker, &worker_info);
  163. STARPU_ASSERT(!ret);
  164. double total_time = starpu_timing_timespec_to_us(&worker_info.total_time);
  165. double executing_time = starpu_timing_timespec_to_us(&worker_info.executing_time);
  166. double sleeping_time = starpu_timing_timespec_to_us(&worker_info.sleeping_time);
  167. float executing_ratio = 100.0*executing_time/total_time;
  168. float sleeping_ratio = 100.0*sleeping_time/total_time;
  169. char workername[128];
  170. starpu_worker_get_name(worker, workername, 128);
  171. fprintf(stderr, "Worker %s:\n", workername);
  172. fprintf(stderr, "\ttotal time : %.2lf ms\n", total_time*1e-3);
  173. fprintf(stderr, "\texec time : %.2lf ms (%.2f %%)\n", executing_time*1e-3,
  174. executing_ratio);
  175. fprintf(stderr, "\tblocked time : %.2lf ms (%.2f %%)\n", sleeping_time*1e-3,
  176. sleeping_ratio);
  177. @}
  178. @end smallexample
  179. @end cartouche
  180. @node Partitioning Data
  181. @section Partitioning Data
  182. An existing piece of data can be partitioned in sub parts to be used by different tasks, for instance:
  183. @cartouche
  184. @smallexample
  185. int vector[NX];
  186. starpu_data_handle_t handle;
  187. /* Declare data to StarPU */
  188. starpu_vector_data_register(&handle, 0, (uintptr_t)vector, NX, sizeof(vector[0]));
  189. /* Partition the vector in PARTS sub-vectors */
  190. starpu_filter f =
  191. @{
  192. .filter_func = starpu_block_filter_func_vector,
  193. .nchildren = PARTS
  194. @};
  195. starpu_data_partition(handle, &f);
  196. @end smallexample
  197. @end cartouche
  198. The task submission then uses @code{starpu_data_get_sub_data} to retrive the
  199. sub-handles to be passed as tasks parameters.
  200. @cartouche
  201. @smallexample
  202. /* Submit a task on each sub-vector */
  203. for (i=0; i<starpu_data_get_nb_children(handle); i++) @{
  204. /* Get subdata number i (there is only 1 dimension) */
  205. starpu_data_handle_t sub_handle = starpu_data_get_sub_data(handle, 1, i);
  206. struct starpu_task *task = starpu_task_create();
  207. task->buffers[0].handle = sub_handle;
  208. task->buffers[0].mode = STARPU_RW;
  209. task->cl = &cl;
  210. task->synchronous = 1;
  211. task->cl_arg = &factor;
  212. task->cl_arg_size = sizeof(factor);
  213. starpu_task_submit(task);
  214. @}
  215. @end smallexample
  216. @end cartouche
  217. Partitioning can be applied several times, see
  218. @code{examples/basic_examples/mult.c} and @code{examples/filters/}.
  219. Wherever the whole piece of data is already available, the partitioning will
  220. be done in-place, i.e. without allocating new buffers but just using pointers
  221. inside the existing copy. This is particularly important to be aware of when
  222. using OpenCL, where the kernel parameters are not pointers, but handles. The
  223. kernel thus needs to be also passed the offset within the OpenCL buffer:
  224. @cartouche
  225. @smallexample
  226. void opencl_func(void *buffers[], void *cl_arg)
  227. @{
  228. cl_mem vector = (cl_mem) STARPU_VECTOR_GET_DEV_HANDLE(buffers[0]);
  229. unsigned offset = STARPU_BLOCK_GET_OFFSET(buffers[0]);
  230. ...
  231. clSetKernelArg(kernel, 0, sizeof(vector), &vector);
  232. clSetKernelArg(kernel, 1, sizeof(offset), &offset);
  233. ...
  234. @}
  235. @end smallexample
  236. @end cartouche
  237. And the kernel has to shift from the pointer passed by the OpenCL driver:
  238. @cartouche
  239. @smallexample
  240. __kernel void opencl_kernel(__global int *vector, unsigned offset)
  241. @{
  242. block = (__global void *)block + offset;
  243. ...
  244. @}
  245. @end smallexample
  246. @end cartouche
  247. @node Performance model example
  248. @section Performance model example
  249. To achieve good scheduling, StarPU scheduling policies need to be able to
  250. estimate in advance the duration of a task. This is done by giving to codelets
  251. a performance model, by defining a @code{starpu_perfmodel} structure and
  252. providing its address in the @code{model} field of the @code{struct starpu_codelet}
  253. structure. The @code{symbol} and @code{type} fields of @code{starpu_perfmodel}
  254. are mandatory, to give a name to the model, and the type of the model, since
  255. there are several kinds of performance models.
  256. @itemize
  257. @item
  258. Measured at runtime (@code{STARPU_HISTORY_BASED} model type). This assumes that for a
  259. given set of data input/output sizes, the performance will always be about the
  260. same. This is very true for regular kernels on GPUs for instance (<0.1% error),
  261. and just a bit less true on CPUs (~=1% error). This also assumes that there are
  262. few different sets of data input/output sizes. StarPU will then keep record of
  263. the average time of previous executions on the various processing units, and use
  264. it as an estimation. History is done per task size, by using a hash of the input
  265. and ouput sizes as an index.
  266. It will also save it in @code{~/.starpu/sampling/codelets}
  267. for further executions, and can be observed by using the
  268. @code{starpu_perfmodel_display} command, or drawn by using
  269. the @code{starpu_perfmodel_plot}. The models are indexed by machine name. To
  270. share the models between machines (e.g. for a homogeneous cluster), use
  271. @code{export STARPU_HOSTNAME=some_global_name}. Measurements are only done when using a task scheduler which makes use of it, such as @code{heft} or @code{dmda}.
  272. The following is a small code example.
  273. If e.g. the code is recompiled with other compilation options, or several
  274. variants of the code are used, the symbol string should be changed to reflect
  275. that, in order to recalibrate a new model from zero. The symbol string can even
  276. be constructed dynamically at execution time, as long as this is done before
  277. submitting any task using it.
  278. @cartouche
  279. @smallexample
  280. static struct starpu_perfmodel mult_perf_model = @{
  281. .type = STARPU_HISTORY_BASED,
  282. .symbol = "mult_perf_model"
  283. @};
  284. struct starpu_codelet cl = @{
  285. .where = STARPU_CPU,
  286. .cpu_funcs = @{ cpu_mult, NULL @},
  287. .nbuffers = 3,
  288. /* for the scheduling policy to be able to use performance models */
  289. .model = &mult_perf_model
  290. @};
  291. @end smallexample
  292. @end cartouche
  293. @item
  294. Measured at runtime and refined by regression (@code{STARPU_REGRESSION_*_BASED}
  295. model type). This still assumes performance regularity, but can work
  296. with various data input sizes, by applying regression over observed
  297. execution times. STARPU_REGRESSION_BASED uses an a*n^b regression
  298. form, STARPU_NL_REGRESSION_BASED uses an a*n^b+c (more precise than
  299. STARPU_REGRESSION_BASED, but costs a lot more to compute). For instance,
  300. @code{tests/perfmodels/regression_based.c} uses a regression-based performance
  301. model for the @code{memset} operation. Of course, the application has to issue
  302. tasks with varying size so that the regression can be computed. StarPU will not
  303. trust the regression unless there is at least 10% difference between the minimum
  304. and maximum observed input size. For non-linear regression, since computing it
  305. is quite expensive, it is only done at termination of the application. This
  306. means that the first execution uses history-based performance model to perform
  307. scheduling.
  308. @item
  309. Provided as an estimation from the application itself (@code{STARPU_COMMON} model type and @code{cost_model} field),
  310. see for instance
  311. @code{examples/common/blas_model.h} and @code{examples/common/blas_model.c}.
  312. @item
  313. Provided explicitly by the application (@code{STARPU_PER_ARCH} model type): the
  314. @code{.per_arch[i].cost_model} fields have to be filled with pointers to
  315. functions which return the expected duration of the task in micro-seconds, one
  316. per architecture.
  317. @end itemize
  318. How to use schedulers which can benefit from such performance model is explained
  319. in @ref{Task scheduling policy}.
  320. The same can be done for task power consumption estimation, by setting the
  321. @code{power_model} field the same way as the @code{model} field. Note: for
  322. now, the application has to give to the power consumption performance model
  323. a name which is different from the execution time performance model.
  324. The application can request time estimations from the StarPU performance
  325. models by filling a task structure as usual without actually submitting
  326. it. The data handles can be created by calling @code{starpu_data_register}
  327. functions with a @code{NULL} pointer (and need to be unregistered as usual)
  328. and the desired data sizes. The @code{starpu_task_expected_length} and
  329. @code{starpu_task_expected_power} functions can then be called to get an
  330. estimation of the task duration on a given arch. @code{starpu_task_destroy}
  331. needs to be called to destroy the dummy task afterwards. See
  332. @code{tests/perfmodels/regression_based.c} for an example.
  333. @node Theoretical lower bound on execution time
  334. @section Theoretical lower bound on execution time
  335. For kernels with history-based performance models, StarPU can very easily provide a theoretical lower
  336. bound for the execution time of a whole set of tasks. See for
  337. instance @code{examples/lu/lu_example.c}: before submitting tasks,
  338. call @code{starpu_bound_start}, and after complete execution, call
  339. @code{starpu_bound_stop}. @code{starpu_bound_print_lp} or
  340. @code{starpu_bound_print_mps} can then be used to output a Linear Programming
  341. problem corresponding to the schedule of your tasks. Run it through
  342. @code{lp_solve} or any other linear programming solver, and that will give you a
  343. lower bound for the total execution time of your tasks. If StarPU was compiled
  344. with the glpk library installed, @code{starpu_bound_compute} can be used to
  345. solve it immediately and get the optimized minimum, in ms. Its @code{integer}
  346. parameter allows to decide whether integer resolution should be computed
  347. and returned too.
  348. The @code{deps} parameter tells StarPU whether to take tasks and implicit data
  349. dependencies into account. It must be understood that the linear programming
  350. problem size is quadratic with the number of tasks and thus the time to solve it
  351. will be very long, it could be minutes for just a few dozen tasks. You should
  352. probably use @code{lp_solve -timeout 1 test.pl -wmps test.mps} to convert the
  353. problem to MPS format and then use a better solver, @code{glpsol} might be
  354. better than @code{lp_solve} for instance (the @code{--pcost} option may be
  355. useful), but sometimes doesn't manage to converge. @code{cbc} might look
  356. slower, but it is parallel. Be sure to try at least all the @code{-B} options
  357. of @code{lp_solve}. For instance, we often just use
  358. @code{lp_solve -cc -B1 -Bb -Bg -Bp -Bf -Br -BG -Bd -Bs -BB -Bo -Bc -Bi} , and
  359. the @code{-gr} option can also be quite useful.
  360. Setting @code{deps} to 0 will only take into account the actual computations
  361. on processing units. It however still properly takes into account the varying
  362. performances of kernels and processing units, which is quite more accurate than
  363. just comparing StarPU performances with the fastest of the kernels being used.
  364. The @code{prio} parameter tells StarPU whether to simulate taking into account
  365. the priorities as the StarPU scheduler would, i.e. schedule prioritized
  366. tasks before less prioritized tasks, to check to which extend this results
  367. to a less optimal solution. This increases even more computation time.
  368. Note that for simplicity, all this however doesn't take into account data
  369. transfers, which are assumed to be completely overlapped.
  370. @node Insert Task Utility
  371. @section Insert Task Utility
  372. StarPU provides the wrapper function @code{starpu_insert_task} to ease
  373. the creation and submission of tasks.
  374. @deftypefun int starpu_insert_task (struct starpu_codelet *@var{cl}, ...)
  375. Create and submit a task corresponding to @var{cl} with the following
  376. arguments. The argument list must be zero-terminated.
  377. The arguments following the codelets can be of the following types:
  378. @itemize
  379. @item
  380. @code{STARPU_R}, @code{STARPU_W}, @code{STARPU_RW}, @code{STARPU_SCRATCH}, @code{STARPU_REDUX} an access mode followed by a data handle;
  381. @item
  382. @code{STARPU_VALUE} followed by a pointer to a constant value and
  383. the size of the constant;
  384. @item
  385. @code{STARPU_CALLBACK} followed by a pointer to a callback function;
  386. @item
  387. @code{STARPU_CALLBACK_ARG} followed by a pointer to be given as an
  388. argument to the callback function;
  389. @item
  390. @code{STARPU_CALLBACK_WITH_ARG} followed by two pointers: one to a callback
  391. function, and the other to be given as an argument to the callback
  392. function; this is equivalent to using both @code{STARPU_CALLBACK} and
  393. @code{STARPU_CALLBACK_WITH_ARG}
  394. @item
  395. @code{STARPU_PRIORITY} followed by a integer defining a priority level.
  396. @end itemize
  397. Parameters to be passed to the codelet implementation are defined
  398. through the type @code{STARPU_VALUE}. The function
  399. @code{starpu_unpack_cl_args} must be called within the codelet
  400. implementation to retrieve them.
  401. @end deftypefun
  402. Here the implementation of the codelet:
  403. @smallexample
  404. void func_cpu(void *descr[], void *_args)
  405. @{
  406. int *x0 = (int *)STARPU_VARIABLE_GET_PTR(descr[0]);
  407. float *x1 = (float *)STARPU_VARIABLE_GET_PTR(descr[1]);
  408. int ifactor;
  409. float ffactor;
  410. starpu_unpack_cl_args(_args, &ifactor, &ffactor);
  411. *x0 = *x0 * ifactor;
  412. *x1 = *x1 * ffactor;
  413. @}
  414. struct starpu_codelet mycodelet = @{
  415. .where = STARPU_CPU,
  416. .cpu_funcs = @{ func_cpu, NULL @},
  417. .nbuffers = 2
  418. @};
  419. @end smallexample
  420. And the call to the @code{starpu_insert_task} wrapper:
  421. @smallexample
  422. starpu_insert_task(&mycodelet,
  423. STARPU_VALUE, &ifactor, sizeof(ifactor),
  424. STARPU_VALUE, &ffactor, sizeof(ffactor),
  425. STARPU_RW, data_handles[0], STARPU_RW, data_handles[1],
  426. 0);
  427. @end smallexample
  428. The call to @code{starpu_insert_task} is equivalent to the following
  429. code:
  430. @smallexample
  431. struct starpu_task *task = starpu_task_create();
  432. task->cl = &mycodelet;
  433. task->buffers[0].handle = data_handles[0];
  434. task->buffers[0].mode = STARPU_RW;
  435. task->buffers[1].handle = data_handles[1];
  436. task->buffers[1].mode = STARPU_RW;
  437. char *arg_buffer;
  438. size_t arg_buffer_size;
  439. starpu_pack_cl_args(&arg_buffer, &arg_buffer_size,
  440. STARPU_VALUE, &ifactor, sizeof(ifactor),
  441. STARPU_VALUE, &ffactor, sizeof(ffactor),
  442. 0);
  443. task->cl_arg = arg_buffer;
  444. task->cl_arg_size = arg_buffer_size;
  445. int ret = starpu_task_submit(task);
  446. @end smallexample
  447. If some part of the task insertion depends on the value of some computation,
  448. the @code{STARPU_DATA_ACQUIRE_CB} macro can be very convenient. For
  449. instance, assuming that the index variable @code{i} was registered as handle
  450. @code{i_handle}:
  451. @smallexample
  452. /* Compute which portion we will work on, e.g. pivot */
  453. starpu_insert_task(&which_index, STARPU_W, i_handle, 0);
  454. /* And submit the corresponding task */
  455. STARPU_DATA_ACQUIRE_CB(i_handle, STARPU_R, starpu_insert_task(&work, STARPU_RW, A_handle[i], 0));
  456. @end smallexample
  457. The @code{STARPU_DATA_ACQUIRE_CB} macro submits an asynchronous request for
  458. acquiring data @code{i} for the main application, and will execute the code
  459. given as third parameter when it is acquired. In other words, as soon as the
  460. value of @code{i} computed by the @code{which_index} codelet can be read, the
  461. portion of code passed as third parameter of @code{STARPU_DATA_ACQUIRE_CB} will
  462. be executed, and is allowed to read from @code{i} to use it e.g. as an
  463. index. Note that this macro is only avaible when compiling StarPU with
  464. the compiler @code{gcc}.
  465. @node Debugging
  466. @section Debugging
  467. StarPU provides several tools to help debugging aplications. Execution traces
  468. can be generated and displayed graphically, see @ref{Generating traces}. Some
  469. gdb helpers are also provided to show the whole StarPU state:
  470. @smallexample
  471. (gdb) source tools/gdbinit
  472. (gdb) help starpu
  473. @end smallexample
  474. @node The multiformat interface
  475. @section The multiformat interface
  476. It may be interesting to represent the same piece of data using two different
  477. data structures : one that would only be used on CPUs, and one that would only
  478. be used on GPUs. This can be done by using the multiformat interface. StarPU
  479. will be able to convert data from one data structure to the other when needed.
  480. Note that the heft scheduler is the only one optimized for this interface. The
  481. user must provide StarPU with conversion codelets :
  482. @example
  483. #define NX 1024
  484. struct point array_of_structs[NX];
  485. starpu_data_handle_t handle;
  486. /*
  487. * The conversion of a piece of data is itself a task, though it is created,
  488. * submitted and destroyed by StarPU internals and not by the user. Therefore,
  489. * we have to define two codelets.
  490. * Note that for now the conversion from the CPU format to the GPU format has to
  491. * be executed on the GPU, and the conversion from the GPU to the CPU has to be
  492. * executed on the CPU.
  493. */
  494. #ifdef STARPU_USE_OPENCL
  495. void cpu_to_opencl_opencl_func(void *buffers[], void *args);
  496. struct starpu_codelet cpu_to_opencl_cl = @{
  497. .where = STARPU_OPENCL,
  498. .opencl_funcs = @{ cpu_to_opencl_opencl_func, NULL @},
  499. .nbuffers = 1
  500. @};
  501. void opencl_to_cpu_func(void *buffers[], void *args);
  502. struct starpu_codelet opencl_to_cpu_cl = @{
  503. .where = STARPU_CPU,
  504. .cpu_funcs = @{ opencl_to_cpu_func, NULL @},
  505. .nbuffers = 1
  506. @};
  507. #endif
  508. struct starpu_multiformat_data_interface_ops format_ops = @{
  509. #ifdef STARPU_USE_OPENCL
  510. .opencl_elemsize = 2 * sizeof(float),
  511. .cpu_to_opencl_cl = &cpu_to_opencl_cl,
  512. .opencl_to_cpu_cl = &opencl_to_cpu_cl,
  513. #endif
  514. .cpu_elemsize = 2 * sizeof(float),
  515. ...
  516. @};
  517. starpu_multiformat_data_register(handle, 0, &array_of_structs, NX, &format_ops);
  518. @end example
  519. Kernels can be written almost as for any other interface. Note that
  520. STARPU_MULTIFORMAT_GET_PTR shall only be used for CPU kernels. CUDA kernels
  521. must use STARPU_MULTIFORMAT_GET_CUDA_PTR, and OpenCL kernels must use
  522. STARPU_MULTIFORMAT_GET_OPENCL_PTR. STARPU_MULTIFORMAT_GET_NX may be used in any
  523. kind of kernel.
  524. @example
  525. static void
  526. multiformat_scal_cpu_func(void *buffers[], void *args)
  527. @{
  528. struct point *aos;
  529. unsigned int n;
  530. aos = STARPU_MULTIFORMAT_GET_PTR(buffers[0]);
  531. n = STARPU_MULTIFORMAT_GET_NX(buffers[0]);
  532. ...
  533. @}
  534. extern "C" void multiformat_scal_cuda_func(void *buffers[], void *_args)
  535. @{
  536. unsigned int n;
  537. struct struct_of_arrays *soa;
  538. soa = (struct struct_of_arrays *) STARPU_MULTIFORMAT_GET_CUDA_PTR(buffers[0]);
  539. n = STARPU_MULTIFORMAT_GET_NX(buffers[0]);
  540. ...
  541. @}
  542. @end example
  543. A full example may be found in @code{examples/basic_examples/multiformat.c}.
  544. @node On-GPU rendering
  545. @section On-GPU rendering
  546. Graphical-oriented applications need to draw the result of their computations,
  547. typically on the very GPU where these happened. Technologies such as OpenGL/CUDA
  548. interoperability permit to let CUDA directly work on the OpenGL buffers, making
  549. them thus immediately ready for drawing, by mapping OpenGL buffer, textures or
  550. renderbuffer objects into CUDA. To achieve this with StarPU, it simply needs to
  551. be given the CUDA pointer at registration, for instance:
  552. @cartouche
  553. @example
  554. for (workerid = 0; workerid < starpu_worker_get_count(); workerid++)
  555. if (starpu_worker_get_type(workerid) == STARPU_CUDA_WORKER)
  556. break;
  557. cudaSetDevice(starpu_worker_get_devid(workerid));
  558. cudaGraphicsResourceGetMappedPointer((void**)&output,
  559. &num_bytes, resource);
  560. starpu_vector_data_register(&handle, starpu_worker_get_memory_node(workerid), output, num_bytes / sizeof(float4), sizeof(float4));
  561. starpu_insert_task(&cl, STARPU_RW, handle, 0);
  562. starpu_data_unregister(handle);
  563. cudaGraphicsUnmapResources(1, &resource, 0);
  564. /* Now display it */
  565. @end example
  566. @end cartouche
  567. @node More examples
  568. @section More examples
  569. More examples are available in the StarPU sources in the @code{examples/}
  570. directory. Simple examples include:
  571. @table @asis
  572. @item @code{incrementer/}:
  573. Trivial incrementation test.
  574. @item @code{basic_examples/}:
  575. Simple documented Hello world (as shown in @ref{Hello World}), vector/scalar product (as shown
  576. in @ref{Vector Scaling on an Hybrid CPU/GPU Machine}), matrix
  577. product examples (as shown in @ref{Performance model example}), an example using the blocked matrix data
  578. interface, an example using the variable data interface, and an example
  579. using different formats on CPUs and GPUs.
  580. @item @code{matvecmult/}:
  581. OpenCL example from NVidia, adapted to StarPU.
  582. @item @code{axpy/}:
  583. AXPY CUBLAS operation adapted to StarPU.
  584. @item @code{fortran/}:
  585. Example of Fortran bindings.
  586. @end table
  587. More advanced examples include:
  588. @table @asis
  589. @item @code{filters/}:
  590. Examples using filters, as shown in @ref{Partitioning Data}.
  591. @item @code{lu/}:
  592. LU matrix factorization, see for instance @code{xlu_implicit.c}
  593. @item @code{cholesky/}:
  594. Cholesky matrix factorization, see for instance @code{cholesky_implicit.c}.
  595. @end table