refman.tex 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. % StarPU --- Runtime system for heterogeneous multicore architectures.
  2. %
  3. % Copyright (C) 2018-2020 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
  4. %
  5. % StarPU is free software; you can redistribute it and/or modify
  6. % it under the terms of the GNU Lesser General Public License as published by
  7. % the Free Software Foundation; either version 2.1 of the License, or (at
  8. % your option) any later version.
  9. %
  10. % StarPU is distributed in the hope that it will be useful, but
  11. % WITHOUT ANY WARRANTY; without even the implied warranty of
  12. % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13. %
  14. % See the GNU Lesser General Public License in COPYING.LGPL for more details.
  15. %
  16. \input{./version.sty}
  17. \setlength{\parskip}{0pt}
  18. \begin{titlepage}
  19. \vspace*{4cm}
  20. {\Huge \textbf{StarPU Internal Handbook}}\\
  21. \rule{\textwidth}{1.5mm}
  22. \begin{flushright}
  23. {\Large for StarPU \STARPUVERSION}
  24. \end{flushright}
  25. \rule{\textwidth}{1mm}
  26. ~\\
  27. \vspace*{15cm}
  28. \begin{flushright}
  29. Generated by Doxygen.
  30. \end{flushright}
  31. \end{titlepage}
  32. \begin{figure}[p]
  33. This manual documents the internal usage of StarPU version \STARPUVERSION. Its contents
  34. was last updated on \STARPUUPDATED.\\
  35. Copyright © 2009–2020 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
  36. \medskip
  37. \begin{quote}
  38. Permission is granted to copy, distribute and/or modify this document
  39. under the terms of the GNU Free Documentation License, Version 1.3 or
  40. any later version published by the Free Software Foundation; with no
  41. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  42. copy of the license is included in the section entitled “GNU Free
  43. Documentation License”.
  44. \end{quote}
  45. \end{figure}
  46. \pagenumbering{roman}
  47. \setcounter{tocdepth}{2}
  48. \tableofcontents
  49. \pagenumbering{arabic}
  50. \hypersetup{pageanchor=true,citecolor=blue}
  51. \chapter{Introduction}
  52. \label{index}
  53. \hypertarget{index}{}
  54. \input{index}
  55. \chapter{Star\+PU Core}
  56. \label{StarPUCore}
  57. \hypertarget{StarPUCore}{}
  58. \input{StarPUCore}
  59. \chapter{Module Index}
  60. \input{modules}
  61. \chapter{Module Documentation}
  62. \label{ModuleDocumentation}
  63. \hypertarget{ModuleDocumentation}{}
  64. \input{group__workers}
  65. \chapter{File Index}
  66. \input{files}
  67. \chapter{StarPU File Documentation}
  68. \input{barrier_8h}
  69. \input{barrier__counter_8h}
  70. \input{bound_8h}
  71. \input{cg_8h}
  72. \input{coherency_8h}
  73. \input{combined__workers_8h}
  74. \input{config_8h}
  75. \input{copy__driver_8h}
  76. \input{data__concurrency_8h}
  77. \input{data__interface_8h}
  78. \input{data__request_8h}
  79. \input{datastats_8h}
  80. \input{datawizard_8h}
  81. \input{debug_8h}
  82. \input{detect__combined__workers_8h}
  83. \input{disk_8h}
  84. \input{disk__unistd__global_8h}
  85. \input{driver__common_8h}
  86. \input{driver__cpu_8h}
  87. \input{driver__cuda_8h}
  88. \input{driver__disk_8h}
  89. \input{driver__mic__common_8h}
  90. \input{driver__mic__sink_8h}
  91. \input{driver__mic__source_8h}
  92. \input{driver__mpi__common_8h}
  93. \input{driver__mpi__sink_8h}
  94. \input{driver__mpi__source_8h}
  95. \input{driver__opencl_8h}
  96. \input{driver__opencl__utils_8h}
  97. \input{drivers_8h}
  98. \input{errorcheck_8h}
  99. \input{fifo__queues_8h}
  100. \input{filters_8h}
  101. \input{footprint_8h}
  102. \input{fxt_8h}
  103. \input{graph_8h}
  104. \input{helper__mct_8h}
  105. \input{idle__hook_8h}
  106. \input{implicit__data__deps_8h}
  107. \input{jobs_8h}
  108. \input{knobs_8h}
  109. \input{malloc_8h}
  110. \input{memalloc_8h}
  111. \input{memory__manager_8h}
  112. \input{memory__nodes_8h}
  113. \input{memstats_8h}
  114. \input{mp__common_8h}
  115. \input{multiple__regression_8h}
  116. \input{node__ops_8h}
  117. \input{openmp__runtime__support_8h}
  118. \input{perfmodel_8h}
  119. \input{prio__deque_8h}
  120. \input{prio__list_8h}
  121. \input{profiling_8h}
  122. \input{progress__hook_8h}
  123. \input{rbtree_8h}
  124. \input{rbtree__i_8h}
  125. \input{regression_8h}
  126. \input{rwlock_8h}
  127. \input{sched__component_8h}
  128. \input{sched__ctx_8h}
  129. \input{sched__ctx__list_8h}
  130. \input{sched__policy_8h}
  131. \input{simgrid_8h}
  132. \input{sink__common_8h}
  133. \input{sort__data__handles_8h}
  134. \input{source__common_8h}
  135. \input{starpu__clusters__create_8h}
  136. \input{starpu__data__cpy_8h}
  137. \input{starpu__debug__helpers_8h}
  138. \input{starpu__fxt_8h}
  139. \input{starpu__parameters_8h}
  140. \input{starpu__spinlock_8h}
  141. \input{starpu__task__insert__utils_8h}
  142. \input{tags_8h}
  143. \input{task_8h}
  144. \input{task__bundle_8h}
  145. \input{thread_8h}
  146. \input{timing_8h}
  147. \input{topology_8h}
  148. \input{utils_8h}
  149. \input{uthash_8h}
  150. \input{write__back_8h}
  151. \chapter{StarPU MPI File Documentation}
  152. \input{starpu__mpi__cache_8h}
  153. \input{starpu__mpi__driver_8h}
  154. \input{starpu__mpi__init_8h}
  155. \input{starpu__mpi__nmad__backend_8h}
  156. \input{starpu__mpi__stats_8h}
  157. \input{starpu__mpi__cache__stats_8h}
  158. \input{starpu__mpi__early__data_8h}
  159. \input{starpu__mpi__mpi_8h}
  160. \input{starpu__mpi__nmad__unknown__datatype_8h}
  161. \input{starpu__mpi__sync__data_8h}
  162. \input{starpu__mpi__comm_8h}
  163. \input{starpu__mpi__early__request_8h}
  164. \input{starpu__mpi__mpi__backend_8h}
  165. \input{starpu__mpi__private_8h}
  166. \input{starpu__mpi__tag_8h}
  167. \input{starpu__mpi__datatype_8h}
  168. \input{starpu__mpi__fxt_8h}
  169. \input{starpu__mpi__nmad_8h}
  170. \input{starpu__mpi__select__node_8h}
  171. \input{starpu__mpi__task__insert_8h}
  172. \input{load__balancer__policy_8h}
  173. \input{load__data__interface_8h}
  174. \input{data__movements__interface_8h}
  175. \chapter{StarPU Resource Manager File Documentation}
  176. \input{starpurm__private_8h}
  177. \end{document}