starpu.texi 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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 Centre National de la Recherche Scientifique
  11. @noindent
  12. Copyright @copyright{} 2011 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:: A basic introduction to using StarPU
  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. * StarPU Basic API:: The Basic API to use StarPU
  56. * StarPU Advanced API:: Advanced use of StarPU
  57. * Performance optimization:: How to optimize performance with StarPU
  58. * Performance feedback:: Performance debugging tools
  59. * Tips and Tricks:: Tips and tricks to know about
  60. * Configuring StarPU:: How to configure StarPU
  61. * StarPU MPI support:: How to combine StarPU with MPI
  62. * StarPU FFT support:: How to perform FFT computations with StarPU
  63. * C Extensions:: Easier StarPU programming with GCC
  64. * Full source code for the 'Scaling a Vector' example::
  65. * GNU Free Documentation License:: How you can copy and share this manual.
  66. * Function Index:: Index of C functions.
  67. * Datatype Index:: Index of C datatypes
  68. @end menu
  69. @c ---------------------------------------------------------------------
  70. @c Introduction to StarPU
  71. @c ---------------------------------------------------------------------
  72. @include chapters/introduction.texi
  73. @c ---------------------------------------------------------------------
  74. @c Installing StarPU
  75. @c ---------------------------------------------------------------------
  76. @include chapters/installing.texi
  77. @c ---------------------------------------------------------------------
  78. @c Using StarPU
  79. @c ---------------------------------------------------------------------
  80. @include chapters/using.texi
  81. @c ---------------------------------------------------------------------
  82. @c Basic Examples
  83. @c ---------------------------------------------------------------------
  84. @include chapters/basic-examples.texi
  85. @c ---------------------------------------------------------------------
  86. @c Advanced Examples
  87. @c ---------------------------------------------------------------------
  88. @include chapters/advanced-examples.texi
  89. @c ---------------------------------------------------------------------
  90. @c StarPU API
  91. @c ---------------------------------------------------------------------
  92. @include chapters/basic-api.texi
  93. @c ---------------------------------------------------------------------
  94. @c Advanced Topics
  95. @c ---------------------------------------------------------------------
  96. @include chapters/advanced-api.texi
  97. @c ---------------------------------------------------------------------
  98. @c Performance options
  99. @c ---------------------------------------------------------------------
  100. @include chapters/perf-optimization.texi
  101. @c ---------------------------------------------------------------------
  102. @c Performance feedback
  103. @c ---------------------------------------------------------------------
  104. @include chapters/perf-feedback.texi
  105. @c ---------------------------------------------------------------------
  106. @c Tips and Tricks
  107. @c ---------------------------------------------------------------------
  108. @include chapters/tips-tricks.texi
  109. @c ---------------------------------------------------------------------
  110. @c Configuration options
  111. @c ---------------------------------------------------------------------
  112. @include chapters/configuration.texi
  113. @c ---------------------------------------------------------------------
  114. @c MPI support
  115. @c ---------------------------------------------------------------------
  116. @include chapters/mpi-support.texi
  117. @c ---------------------------------------------------------------------
  118. @c FFT support
  119. @c ---------------------------------------------------------------------
  120. @include chapters/fft-support.texi
  121. @c ---------------------------------------------------------------------
  122. @c C Extensions
  123. @c ---------------------------------------------------------------------
  124. @include chapters/c-extensions.texi
  125. @c ---------------------------------------------------------------------
  126. @c Appendices
  127. @c ---------------------------------------------------------------------
  128. @c ---------------------------------------------------------------------
  129. @c Full source code for the 'Scaling a Vector' example
  130. @c ---------------------------------------------------------------------
  131. @include chapters/scaling-vector-example.texi
  132. @c ---------------------------------------------------------------------
  133. @c License
  134. @c ---------------------------------------------------------------------
  135. @node GNU Free Documentation License
  136. @appendix GNU Free Documentation License
  137. @include chapters/fdl-1.3.texi
  138. @c ---------------------------------------------------------------------
  139. @c Indices
  140. @c ---------------------------------------------------------------------
  141. @node Function Index
  142. @unnumbered Function Index
  143. @printindex fn
  144. @node Datatype Index
  145. @unnumbered Datatype Index
  146. @printindex tp
  147. @bye