starpu.texi 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. \input texinfo @c -*-texinfo-*-
  2. @c %**start of header
  3. @setfilename starpu.info
  4. @settitle StarPU Handbook
  5. @c %**end of header
  6. @include version.texi
  7. @copying
  8. Copyright @copyright{} 2009--2011 Universit@'e de Bordeaux 1
  9. @noindent
  10. Copyright @copyright{} 2010, 2011, 2012 Centre National de la Recherche Scientifique
  11. @noindent
  12. Copyright @copyright{} 2011, 2012 Institut National de Recherche en Informatique et Automatique
  13. @quotation
  14. Permission is granted to copy, distribute and/or modify this document
  15. under the terms of the GNU Free Documentation License, Version 1.3
  16. or any later version published by the Free Software Foundation;
  17. with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  18. Texts. A copy of the license is included in the section entitled ``GNU
  19. Free Documentation License''.
  20. @end quotation
  21. @end copying
  22. @setchapternewpage odd
  23. @dircategory Development
  24. @direntry
  25. * StarPU: (starpu). StarPU Handbook
  26. @end direntry
  27. @titlepage
  28. @title StarPU Handbook
  29. @subtitle for StarPU @value{VERSION}
  30. @page
  31. @vskip 0pt plus 1fill
  32. @insertcopying
  33. @end titlepage
  34. @c @summarycontents
  35. @contents
  36. @page
  37. @node Top
  38. @top Preface
  39. This manual documents the usage of StarPU version @value{VERSION}. It
  40. was last updated on @value{UPDATED}.
  41. @ifnottex
  42. @insertcopying
  43. @end ifnottex
  44. @comment
  45. @comment When you add a new menu item, please keep the right hand
  46. @comment aligned to the same column. Do not use tabs. This provides
  47. @comment better formatting.
  48. @comment
  49. @menu
  50. * Introduction:: Getting started
  51. * Installing StarPU:: How to configure, build and install StarPU
  52. * Using StarPU:: How to run StarPU application
  53. * Basic Examples:: Basic examples of the use of StarPU
  54. * Advanced Examples:: Advanced examples of the use of StarPU
  55. * Performance optimization:: How to optimize performance with StarPU
  56. * Performance feedback:: Performance debugging tools
  57. * Tips and Tricks:: Tips and tricks to know about
  58. * StarPU MPI support:: How to combine StarPU with MPI
  59. * StarPU FFT support:: How to perform FFT computations with StarPU
  60. * C Extensions:: Easier StarPU programming with GCC
  61. * SOCL OpenCL Extensions:: How to use OpenCL on top of StarPU
  62. * StarPU Basic API:: The Basic API to use StarPU
  63. * StarPU Advanced API:: Advanced use of StarPU
  64. * Configuring StarPU:: How to configure StarPU
  65. * Full source code for the 'Scaling a Vector' example::
  66. * GNU Free Documentation License:: How you can copy and share this manual.
  67. * Function Index:: Index of C functions.
  68. * Datatype Index:: Index of C datatypes
  69. @end menu
  70. @c ---------------------------------------------------------------------
  71. @c Introduction to StarPU
  72. @c ---------------------------------------------------------------------
  73. @node Introduction
  74. @chapter Introduction to StarPU
  75. @include chapters/introduction.texi
  76. @c ---------------------------------------------------------------------
  77. @c Installing StarPU
  78. @c ---------------------------------------------------------------------
  79. @node Installing StarPU
  80. @chapter Installing StarPU
  81. @include chapters/installing.texi
  82. @c ---------------------------------------------------------------------
  83. @c Using StarPU
  84. @c ---------------------------------------------------------------------
  85. @node Using StarPU
  86. @chapter Using StarPU
  87. @include chapters/using.texi
  88. @c ---------------------------------------------------------------------
  89. @c Basic Examples
  90. @c ---------------------------------------------------------------------
  91. @node Basic Examples
  92. @chapter Basic Examples
  93. @include chapters/basic-examples.texi
  94. @c ---------------------------------------------------------------------
  95. @c Advanced Examples
  96. @c ---------------------------------------------------------------------
  97. @node Advanced Examples
  98. @chapter Advanced Examples
  99. @include chapters/advanced-examples.texi
  100. @c ---------------------------------------------------------------------
  101. @c Performance options
  102. @c ---------------------------------------------------------------------
  103. @node Performance optimization
  104. @chapter How to optimize performance with StarPU
  105. @include chapters/perf-optimization.texi
  106. @c ---------------------------------------------------------------------
  107. @c Performance feedback
  108. @c ---------------------------------------------------------------------
  109. @node Performance feedback
  110. @chapter Performance feedback
  111. @include chapters/perf-feedback.texi
  112. @c ---------------------------------------------------------------------
  113. @c Tips and Tricks
  114. @c ---------------------------------------------------------------------
  115. @node Tips and Tricks
  116. @chapter Tips and Tricks to know about
  117. @include chapters/tips-tricks.texi
  118. @c ---------------------------------------------------------------------
  119. @c MPI support
  120. @c ---------------------------------------------------------------------
  121. @node StarPU MPI support
  122. @chapter StarPU MPI support
  123. @include chapters/mpi-support.texi
  124. @c ---------------------------------------------------------------------
  125. @c FFT support
  126. @c ---------------------------------------------------------------------
  127. @node StarPU FFT support
  128. @chapter StarPU FFT support
  129. @include chapters/fft-support.texi
  130. @c ---------------------------------------------------------------------
  131. @c C Extensions
  132. @c ---------------------------------------------------------------------
  133. @node C Extensions
  134. @chapter C Extensions
  135. @include chapters/c-extensions.texi
  136. @c ---------------------------------------------------------------------
  137. @c SOCL
  138. @c ---------------------------------------------------------------------
  139. @node SOCL OpenCL Extensions
  140. @chapter SOCL OpenCL Extensions
  141. @include chapters/socl.texi
  142. @c ---------------------------------------------------------------------
  143. @c StarPU API
  144. @c ---------------------------------------------------------------------
  145. @node StarPU Basic API
  146. @chapter StarPU Basic API
  147. @include chapters/basic-api.texi
  148. @c ---------------------------------------------------------------------
  149. @c Advanced Topics
  150. @c ---------------------------------------------------------------------
  151. @node StarPU Advanced API
  152. @chapter StarPU Advanced API
  153. @include chapters/advanced-api.texi
  154. @c ---------------------------------------------------------------------
  155. @c Configuration options
  156. @c ---------------------------------------------------------------------
  157. @node Configuring StarPU
  158. @chapter Configuring StarPU
  159. @include chapters/configuration.texi
  160. @c ---------------------------------------------------------------------
  161. @c Appendices
  162. @c ---------------------------------------------------------------------
  163. @c ---------------------------------------------------------------------
  164. @c Full source code for the 'Scaling a Vector' example
  165. @c ---------------------------------------------------------------------
  166. @node Full source code for the 'Scaling a Vector' example
  167. @appendix Full source code for the 'Scaling a Vector' example
  168. @include chapters/scaling-vector-example.texi
  169. @c ---------------------------------------------------------------------
  170. @c License
  171. @c ---------------------------------------------------------------------
  172. @node GNU Free Documentation License
  173. @appendix GNU Free Documentation License
  174. @include chapters/fdl-1.3.texi
  175. @c ---------------------------------------------------------------------
  176. @c Indices
  177. @c ---------------------------------------------------------------------
  178. @node Function Index
  179. @unnumbered Function Index
  180. @printindex fn
  181. @node Datatype Index
  182. @unnumbered Datatype Index
  183. @printindex tp
  184. @bye