瀏覽代碼

Document some CUDA specific helpers

Cédric Augonnet 15 年之前
父節點
當前提交
d62de104af
共有 1 個文件被更改,包括 48 次插入0 次删除
  1. 48 0
      doc/starpu.texi

+ 48 - 0
doc/starpu.texi

@@ -987,10 +987,58 @@ DAG before actually giving StarPU the opportunity to execute the tasks.
 
 @section Extensions
 
+@menu
+* CUDA extensions::        CUDA extensions
+* Cell extensions::        Cell extensions
+@end menu
+
+@node CUDA extensions
 @subsection CUDA extensions
 
 @c void starpu_malloc_pinned_if_possible(float **A, size_t dim);
 
+@c starpu_helper_init_cublas TODO
+
+@c starpu_helper_shutdown_cublas TODO
+
+@node starpu_get_local_cuda_stream
+@subsubsection @code{starpu_get_local_cuda_stream} -- Get current worker's CUDA stream
+@table @asis
+@item @emph{Description}:
+StarPU provides a stream for every CUDA device controlled by StarPU. This
+function is only provided for convenience so that programmers can easily use
+asynchronous operations within codelets without having to create a stream by
+hand. Note that the application is not forced to use the stream provided by
+@code{starpu_get_local_cuda_stream} and may also create its own streams.
+
+@item @emph{Prototype}:
+@code{cudaStream_t *starpu_get_local_cuda_stream(void);}
+@end table
+
+@node starpu_helper_init_cublas
+@subsubsection @code{starpu_helper_init_cublas} -- Initialize CUBLAS on every CUDA device
+@table @asis
+@item @emph{Description}:
+The CUBLAS library must be initialized prior to any CUBLAS call. Calling
+@code{starpu_helper_init_cublas} will initialize CUBLAS on every CUDA device
+controlled by StarPU. This call blocks until CUBLAS has been properly
+initialized on every device.
+
+@item @emph{Prototype}:
+@code{void starpu_helper_init_cublas(void);}
+@end table
+
+@node starpu_helper_shutdown_cublas
+@subsubsection @code{starpu_helper_shutdown_cublas} -- Deinitialize CUBLAS on every CUDA device
+@table @asis
+@item @emph{Description}:
+This function synchronously deinitializes the CUBLAS library on every CUDA device.
+
+@item @emph{Prototype}:
+@code{void starpu_helper_shutdown_cublas(void);}
+@end table
+
+@node Cell extensions
 @subsection Cell extensions
 
 @c ---------------------------------------------------------------------