Function-ABI-Documentation.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1999-2017 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Funding Free Software", the Front-Cover
  8. Texts being (a) (see below), and with the Back-Cover Texts being (b)
  9. (see below). A copy of the license is included in the section entitled
  10. "GNU Free Documentation License".
  11. (a) The FSF's Front-Cover Text is:
  12. A GNU Manual
  13. (b) The FSF's Back-Cover Text is:
  14. You have freedom to copy and modify this GNU Manual, like GNU
  15. software. Copies published by the Free Software Foundation raise
  16. funds for GNU development. -->
  17. <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <title>The GNU Fortran Compiler: Function ABI Documentation</title>
  20. <meta name="description" content="The GNU Fortran Compiler: Function ABI Documentation">
  21. <meta name="keywords" content="The GNU Fortran Compiler: Function ABI Documentation">
  22. <meta name="resource-type" content="document">
  23. <meta name="distribution" content="global">
  24. <meta name="Generator" content="makeinfo">
  25. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="Coarray-Programming.html#Coarray-Programming" rel="up" title="Coarray Programming">
  30. <link href="_005fgfortran_005fcaf_005finit.html#g_t_005fgfortran_005fcaf_005finit" rel="next" title="_gfortran_caf_init">
  31. <link href="caf_005fteam_005ft.html#caf_005fteam_005ft" rel="prev" title="caf_team_t">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.smallquotation {font-size: smaller}
  36. div.display {margin-left: 3.2em}
  37. div.example {margin-left: 3.2em}
  38. div.indentedblock {margin-left: 3.2em}
  39. div.lisp {margin-left: 3.2em}
  40. div.smalldisplay {margin-left: 3.2em}
  41. div.smallexample {margin-left: 3.2em}
  42. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  43. div.smalllisp {margin-left: 3.2em}
  44. kbd {font-style:oblique}
  45. pre.display {font-family: inherit}
  46. pre.format {font-family: inherit}
  47. pre.menu-comment {font-family: serif}
  48. pre.menu-preformatted {font-family: serif}
  49. pre.smalldisplay {font-family: inherit; font-size: smaller}
  50. pre.smallexample {font-size: smaller}
  51. pre.smallformat {font-family: inherit; font-size: smaller}
  52. pre.smalllisp {font-size: smaller}
  53. span.nocodebreak {white-space:nowrap}
  54. span.nolinebreak {white-space:nowrap}
  55. span.roman {font-family:serif; font-weight:normal}
  56. span.sansserif {font-family:sans-serif; font-weight:normal}
  57. ul.no-bullet {list-style: none}
  58. -->
  59. </style>
  60. </head>
  61. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  62. <a name="Function-ABI-Documentation"></a>
  63. <div class="header">
  64. <p>
  65. Previous: <a href="Type-and-enum-ABI-Documentation.html#Type-and-enum-ABI-Documentation" accesskey="p" rel="prev">Type and enum ABI Documentation</a>, Up: <a href="Coarray-Programming.html#Coarray-Programming" accesskey="u" rel="up">Coarray Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  66. </div>
  67. <hr>
  68. <a name="Function-ABI-Documentation-1"></a>
  69. <h3 class="section">8.2 Function ABI Documentation</h3>
  70. <table class="menu" border="0" cellspacing="0">
  71. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005finit.html#g_t_005fgfortran_005fcaf_005finit" accesskey="1">_gfortran_caf_init</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Initialiation function
  72. </td></tr>
  73. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005ffinish.html#g_t_005fgfortran_005fcaf_005ffinish" accesskey="2">_gfortran_caf_finish</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Finalization function
  74. </td></tr>
  75. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fthis_005fimage.html#g_t_005fgfortran_005fcaf_005fthis_005fimage" accesskey="3">_gfortran_caf_this_image</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Querying the image number
  76. </td></tr>
  77. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fnum_005fimages.html#g_t_005fgfortran_005fcaf_005fnum_005fimages" accesskey="4">_gfortran_caf_num_images</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Querying the maximal number of images
  78. </td></tr>
  79. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fimage_005fstatus.html#g_t_005fgfortran_005fcaf_005fimage_005fstatus" accesskey="5">_gfortran_caf_image_status </a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Query the status of an image
  80. </td></tr>
  81. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005ffailed_005fimages.html#g_t_005fgfortran_005fcaf_005ffailed_005fimages" accesskey="6">_gfortran_caf_failed_images </a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Get an array of the indexes of the failed images
  82. </td></tr>
  83. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fstopped_005fimages.html#g_t_005fgfortran_005fcaf_005fstopped_005fimages" accesskey="7">_gfortran_caf_stopped_images </a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Get an array of the indexes of the stopped images
  84. </td></tr>
  85. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fregister.html#g_t_005fgfortran_005fcaf_005fregister" accesskey="8">_gfortran_caf_register</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Registering coarrays
  86. </td></tr>
  87. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fderegister.html#g_t_005fgfortran_005fcaf_005fderegister" accesskey="9">_gfortran_caf_deregister</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Deregistering coarrays
  88. </td></tr>
  89. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fis_005fpresent.html#g_t_005fgfortran_005fcaf_005fis_005fpresent">_gfortran_caf_is_present</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Query whether an allocatable or pointer component in a derived type coarray is allocated
  90. </td></tr>
  91. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsend.html#g_t_005fgfortran_005fcaf_005fsend">_gfortran_caf_send</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Sending data from a local image to a remote image
  92. </td></tr>
  93. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fget.html#g_t_005fgfortran_005fcaf_005fget">_gfortran_caf_get</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Getting data from a remote image
  94. </td></tr>
  95. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsendget.html#g_t_005fgfortran_005fcaf_005fsendget">_gfortran_caf_sendget</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Sending data between remote images
  96. </td></tr>
  97. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsend_005fby_005fref.html#g_t_005fgfortran_005fcaf_005fsend_005fby_005fref">_gfortran_caf_send_by_ref</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Sending data from a local image to a remote image using enhanced references
  98. </td></tr>
  99. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fget_005fby_005fref.html#g_t_005fgfortran_005fcaf_005fget_005fby_005fref">_gfortran_caf_get_by_ref</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Getting data from a remote image using enhanced references
  100. </td></tr>
  101. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsendget_005fby_005fref.html#g_t_005fgfortran_005fcaf_005fsendget_005fby_005fref">_gfortran_caf_sendget_by_ref</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Sending data between remote images using enhanced references
  102. </td></tr>
  103. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005flock.html#g_t_005fgfortran_005fcaf_005flock">_gfortran_caf_lock</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Locking a lock variable
  104. </td></tr>
  105. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005funlock.html#g_t_005fgfortran_005fcaf_005funlock">_gfortran_caf_unlock</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Unlocking a lock variable
  106. </td></tr>
  107. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fevent_005fpost.html#g_t_005fgfortran_005fcaf_005fevent_005fpost">_gfortran_caf_event_post</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Post an event
  108. </td></tr>
  109. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fevent_005fwait.html#g_t_005fgfortran_005fcaf_005fevent_005fwait">_gfortran_caf_event_wait</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Wait that an event occurred
  110. </td></tr>
  111. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fevent_005fquery.html#g_t_005fgfortran_005fcaf_005fevent_005fquery">_gfortran_caf_event_query</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Query event count
  112. </td></tr>
  113. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsync_005fall.html#g_t_005fgfortran_005fcaf_005fsync_005fall">_gfortran_caf_sync_all</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">All-image barrier
  114. </td></tr>
  115. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsync_005fimages.html#g_t_005fgfortran_005fcaf_005fsync_005fimages">_gfortran_caf_sync_images</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Barrier for selected images
  116. </td></tr>
  117. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fsync_005fmemory.html#g_t_005fgfortran_005fcaf_005fsync_005fmemory">_gfortran_caf_sync_memory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Wait for completion of segment-memory operations
  118. </td></tr>
  119. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005ferror_005fstop.html#g_t_005fgfortran_005fcaf_005ferror_005fstop">_gfortran_caf_error_stop</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Error termination with exit code
  120. </td></tr>
  121. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005ferror_005fstop_005fstr.html#g_t_005fgfortran_005fcaf_005ferror_005fstop_005fstr">_gfortran_caf_error_stop_str</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Error termination with string
  122. </td></tr>
  123. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005ffail_005fimage.html#g_t_005fgfortran_005fcaf_005ffail_005fimage">_gfortran_caf_fail_image </a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Mark the image failed and end its execution
  124. </td></tr>
  125. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fatomic_005fdefine.html#g_t_005fgfortran_005fcaf_005fatomic_005fdefine">_gfortran_caf_atomic_define</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Atomic variable assignment
  126. </td></tr>
  127. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fatomic_005fref.html#g_t_005fgfortran_005fcaf_005fatomic_005fref">_gfortran_caf_atomic_ref</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Atomic variable reference
  128. </td></tr>
  129. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fatomic_005fcas.html#g_t_005fgfortran_005fcaf_005fatomic_005fcas">_gfortran_caf_atomic_cas</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Atomic compare and swap
  130. </td></tr>
  131. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fatomic_005fop.html#g_t_005fgfortran_005fcaf_005fatomic_005fop">_gfortran_caf_atomic_op</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Atomic operation
  132. </td></tr>
  133. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fco_005fbroadcast.html#g_t_005fgfortran_005fcaf_005fco_005fbroadcast">_gfortran_caf_co_broadcast</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Sending data to all images
  134. </td></tr>
  135. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fco_005fmax.html#g_t_005fgfortran_005fcaf_005fco_005fmax">_gfortran_caf_co_max</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Collective maximum reduction
  136. </td></tr>
  137. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fco_005fmin.html#g_t_005fgfortran_005fcaf_005fco_005fmin">_gfortran_caf_co_min</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Collective minimum reduction
  138. </td></tr>
  139. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fco_005fsum.html#g_t_005fgfortran_005fcaf_005fco_005fsum">_gfortran_caf_co_sum</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Collective summing reduction
  140. </td></tr>
  141. <tr><td align="left" valign="top">&bull; <a href="_005fgfortran_005fcaf_005fco_005freduce.html#g_t_005fgfortran_005fcaf_005fco_005freduce">_gfortran_caf_co_reduce</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Generic collective reduction
  142. </td></tr>
  143. </table>
  144. <hr>
  145. <div class="header">
  146. <p>
  147. Previous: <a href="Type-and-enum-ABI-Documentation.html#Type-and-enum-ABI-Documentation" accesskey="p" rel="prev">Type and enum ABI Documentation</a>, Up: <a href="Coarray-Programming.html#Coarray-Programming" accesskey="u" rel="up">Coarray Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  148. </div>
  149. </body>
  150. </html>