Skip to content

Commit 12d6502

Browse files
hppritchahppritcha
committed
squash me: more man pages
Signed-off-by: Howard Pritchard <howardp@lanl.gov>
1 parent 3329226 commit 12d6502

19 files changed

+882
-0
lines changed

‎docs/Makefile.am

+18
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,21 @@ OMPI_MAN3 = \
437437
MPI_T_cvar_write.3 \
438438
MPI_T_enum_get_info.3 \
439439
MPI_T_enum_get_item.3 \
440+
MPI_T_event_callback_get_info.3 \
441+
MPI_T_event_callback_set_info.3 \
442+
MPI_T_event_copy.3 \
443+
MPI_T_event_get_index.3 \
444+
MPI_T_event_get_info.3 \
445+
MPI_T_event_get_num.3 \
446+
MPI_T_event_get_source.3 \
447+
MPI_T_event_get_timestamp.3 \
448+
MPI_T_event_handle_alloc.3 \
449+
MPI_T_event_handle_free.3 \
450+
MPI_T_event_handle_get_info.3 \
451+
MPI_T_event_handle_set_info.3 \
452+
MPI_T_event_read.3 \
453+
MPI_T_event_register_callback.3 \
454+
MPI_T_event_set_dropped_handler.3 \
440455
MPI_Test.3 \
441456
MPI_Testall.3 \
442457
MPI_Testany.3 \
@@ -457,6 +472,9 @@ OMPI_MAN3 = \
457472
MPI_T_pvar_start.3 \
458473
MPI_T_pvar_stop.3 \
459474
MPI_T_pvar_write.3 \
475+
MPI_T_source_get_info.3 \
476+
MPI_T_source_get_num.3 \
477+
MPI_T_source_get_timestamp.3 \
460478
MPI_Type_c2f.3 \
461479
MPI_Type_commit.3 \
462480
MPI_Type_contiguous.3 \

‎docs/man-openmpi/man3/MPI_T_event_callback_get_info.3.rst

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.. _mpi_t_event_callback_get_info:
2+
3+
4+
MPI_T_event_callback_get_info
5+
=============================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_event_callback_get_info` |mdash| Returns a new info object containing the hints of the callback function registered for the callback safety level specified by cb_safety of the event-registration handle associated with event_registration.
10+
11+
SYNTAX
12+
------
13+
14+
15+
C Syntax
16+
^^^^^^^^
17+
18+
.. code-block:: c
19+
20+
#include <mpi.h>
21+
22+
int MPI_T_event_callback_get_info(MPI_T_event_registration event_registration,
23+
MPI_T_cb_safety cb_safety, MPI_Info *info_used)
24+
25+
26+
INPUT PARAMETERS
27+
----------------
28+
* ``event_registration``: Event registration
29+
* ``cb_safety``: maximum callback safety level
30+
31+
OUTPUT PARAMETERS
32+
-----------------
33+
34+
* ``info_used``: Info argument
35+
36+
DESCRIPTION
37+
-----------
38+
39+
:ref:`MPI_T_event_callback_get_info` returns a new info object containing the
40+
hints of the callback function registered for the callback safety level specified by `cb_safety` of
41+
the event-registration handle associated with `event_registration`.
42+
43+
44+
ERRORS
45+
------
46+
47+
:ref:`MPI_T_event_callback_get_info` will fail if:
48+
49+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
50+
51+
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
52+
53+
* ``MPI_T_ERR_INVALID_HANDLE``: Invalid use of the interface or bad parameter values(s).
54+
55+
* ``MPI_T_ERR_OTHER``: Other error

‎docs/man-openmpi/man3/MPI_T_event_callback_set_info.3.rst

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _mpi_t_event_callback_set_info:
2+
3+
4+
MPI_T_event_callback_set_info
5+
=============================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_event_callback_set_info` |mdash| Updates the hints of the callback function registered for the callback safety level specified by cb_safety of the event-registration handle associated with event_registration.
10+
11+
SYNTAX
12+
------
13+
14+
15+
C Syntax
16+
^^^^^^^^
17+
18+
.. code-block:: c
19+
20+
#include <mpi.h>
21+
22+
int MPI_T_event_callback_set_info(MPI_T_event_registration event_registration,
23+
MPI_T_cb_safety cb_safety, MPI_Info info)
24+
25+
26+
INPUT PARAMETERS
27+
----------------
28+
* ``event_registration``: Event registration
29+
* ``cb_safety``: maximum callback safety level
30+
* ``info``: Info argument
31+
32+
DESCRIPTION
33+
-----------
34+
35+
:ref:`MPI_T_event_callback_set_info` Updates the hints of the callback function registered for the callback safety level specified by `cb_safety` of the event-registration handle associated with event_registration.
36+
37+
38+
ERRORS
39+
------
40+
41+
:ref:`MPI_T_event_callback_set_info` will fail if:
42+
43+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
44+
45+
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
46+
47+
* ``MPI_T_ERR_INVALID_HANDLE``: Invalid use of the interface or bad parameter values(s).
48+
49+
* ``MPI_T_ERR_OTHER``: Other error

‎docs/man-openmpi/man3/MPI_T_event_copy.3.rst

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. _mpi_t_event_copy:
2+
3+
4+
MPI_T_event_copy
5+
================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_event_copy` |mdash| Copy event data as a whole into a user-specified buffer.
10+
11+
12+
SYNTAX
13+
------
14+
15+
16+
C Syntax
17+
^^^^^^^^
18+
19+
.. code-block:: c
20+
21+
#include <mpi.h>
22+
23+
int MPI_T_event_copy(MPI_T_event_instance event_instance, void *buffer)
24+
25+
26+
INPUT PARAMETERS
27+
----------------
28+
* ``event_instance``: event-instance handle provided to the callback function.
29+
* ``buf``: pointer to a memory location to store the event data.
30+
31+
DESCRIPTION
32+
-----------
33+
34+
:ref:`MPI_T_event_copy` copies the event data as a whole into the user-provided buffer.
35+
The user must assure that the buffer is of at least the size of the extent of the event
36+
type, which can be computed from the type and displacement information returned by the
37+
corresponding call to :ref:`MPI_T_event_get_info`.
38+
39+
ERRORS
40+
------
41+
42+
:ref:`MPI_T_event_copy` will fail if:
43+
44+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
45+
46+
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
47+
48+
* ``MPI_T_ERR_INVALID``: Invalid use of the interface or bad parameter values(s).
49+
50+
51+
.. seealso::
52+
* :ref:`MPI_T_event_read`

‎docs/man-openmpi/man3/MPI_T_event_get_index.3.rst

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. _mpi_t_event_get_index:
2+
3+
4+
MPI_T_event_get_index
5+
=====================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_event_get_index` |mdash| Query the index of an event type identified by a known event type name
10+
11+
12+
SYNTAX
13+
------
14+
15+
16+
C Syntax
17+
^^^^^^^^
18+
19+
.. code-block:: c
20+
21+
#include <mpi.h>
22+
23+
int MPI_T_event_get_index(const char *name, int *event_index)
24+
25+
26+
INPUT PARAMETERS
27+
-----------------
28+
29+
* ``name``: name of the event type
30+
31+
OUTPUT PARAMETERS
32+
-----------------
33+
34+
* ``event_index``: index of the event type
35+
36+
37+
DESCRIPTION
38+
-----------
39+
40+
:ref:`MPI_T_event_get_index` can be used to query for the index of an event type identified by a known
41+
event type name.
42+
43+
ERRORS
44+
------
45+
46+
:ref:`MPI_T_event_get_index` will fail if:
47+
48+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface is not
49+
initialized
50+
51+
* ``MPI_T_ERR_INVALID_NAME``: The event name is invalid
52+
initialized

‎docs/man-openmpi/man3/MPI_T_event_get_info.3.rst

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
.. _mpi_t_event_get_info:
2+
3+
4+
MPI_T_event_get_info
5+
====================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_event_get_info` |mdash| Returns additional information about a specific event type
10+
11+
12+
SYNTAX
13+
------
14+
15+
16+
C Syntax
17+
^^^^^^^^
18+
19+
.. code-block:: c
20+
21+
#include <mpi.h>
22+
23+
int MPI_T_event_get_info(int event_index, char *name, int *name_len,
24+
int *verbosity, MPI_Datatype array_of_datatypes[],
25+
MPI_Aint array_of_displacements[], int *num_elements,
26+
MPI_T_enum *enumtype, MPI_Info *info, char *desc,
27+
int *desc_len, int *bind)
28+
29+
INPUT PARAMETERS
30+
----------------
31+
* ``event_index``: Index of the event to be queried.
32+
33+
INPUT/OUTPUT PARAMETERS
34+
-----------------------
35+
* ``name_len``: Length of the string and/or buffer for name.
36+
* ``desc_len``: Length of the string and/or buffer for desc.
37+
* ``num_elements``: length of array of datatypes and displacements.
38+
39+
OUTPUT PARAMETERS
40+
-----------------
41+
* ``name``: Buffer to return the string containing the name of the event type.
42+
* ``verbosity``: Verbosity level of this event type
43+
* ``array_of_datatypes``: Array of mpi basic datatypes used to encode the event data
44+
* ``array_of_displacements``: Array of byte displacements of the elements in the event buffer
45+
* ``enumtype``: Optional descriptor for enumeration information
46+
* ``info``: Optional info argument.
47+
* ``desc``: Buffer to return the string containing the description of the event type.
48+
* ``bind``: Type of mpi object to which an event of this type must be bound
49+
50+
DESCRIPTION
51+
-----------
52+
53+
:ref:`MPI_T_event_get_info` can be used to query information from for a specific event type.
54+
55+
56+
ERRORS
57+
------
58+
59+
:ref:`MPI_T_event_get_info` will fail if:
60+
61+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
62+
63+
* ``MPI_T_ERR_INVALID_INDEX``: The source index is invalid
64+
65+
* ``MPI_T_ERR_INVALID``: Invalid use of the interface or bad parameter values(s).
66+
67+
* ``MPI_ERR_OTHER``: Other error

‎docs/man-openmpi/man3/MPI_T_event_get_num.3.rst

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. _mpi_t_event_get_num:
2+
3+
4+
MPI_T_event_get_num
5+
===================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_event_get_num` |mdash| Query the number of MPI_T event types
10+
11+
12+
SYNTAX
13+
------
14+
15+
16+
C Syntax
17+
^^^^^^^^
18+
19+
.. code-block:: c
20+
21+
#include <mpi.h>
22+
23+
int MPI_T_event_get_num(int *num_events)
24+
25+
26+
OUTPUT PARAMETERS
27+
-----------------
28+
29+
* ``num_events``: Returns number of event types
30+
31+
32+
DESCRIPTION
33+
-----------
34+
35+
:ref:`MPI_T_event_get_num` can be used to query the current number of MPI_T event types.
36+
37+
The number of available event types can be queried with a call to
38+
:ref:`MPI_T_event_get_num`. An MPI implementation is allowed to increase the number of event types during the
39+
execution of an MPI process. However, MPI implementations are not allowed to change the
40+
index of an event type or to delete an event type once it has been made visible to the user.
41+
42+
.. note:: Open MPI will currently return that there are 0 event types.
43+
44+
45+
ERRORS
46+
------
47+
48+
:ref:`MPI_T_event_get_num` will fail if:
49+
50+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface is not
51+
initialized

0 commit comments

Comments
 (0)