[mpich-commits] [mpich] MPICH primary repository branch, master, updated. v3.1rc1-22-gfe5ff95

mysql vizuser noreply at mpich.org
Thu Nov 14 16:43:34 CST 2013 

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "MPICH primary repository".

The branch, master has been updated
       via  fe5ff951ef10d30793ac3d89b03d269503d22573 (commit)
       via  b60f15e1073d64823254385dec4b26cb831ecdac (commit)
      from  a95629278a2478ef7b6da223353ea0c8a9e69434 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
http://git.mpich.org/mpich.git/commitdiff/fe5ff951ef10d30793ac3d89b03d269503d22573

commit fe5ff951ef10d30793ac3d89b03d269503d22573
Author: Junchao Zhang <jczhang at mcs.anl.gov>
Date:   Wed Nov 13 16:14:31 2013 -0600

    Add missing manpages for MPI_T routines
    
    Fixes #1969
    
    Signed-off-by: Antonio J. Pena <apenya at mcs.anl.gov>

diff --git a/src/mpi_t/cat_changed.c b/src/mpi_t/cat_changed.c
index aebff45..9717d76 100644
--- a/src/mpi_t/cat_changed.c
+++ b/src/mpi_t/cat_changed.c
@@ -28,16 +28,21 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_category_changed - XXX description here
+MPI_T_category_changed - Get the timestamp indicating the last change to the categories
 
 Output Parameters:
 . stamp - a virtual time stamp to indicate the last change to the categories (integer)
 
-.N ThreadSafe
+Notes:
+If two subsequent calls to this routine return the same timestamp, it is guaranteed that
+the category information has not changed between the two calls. If the timestamp retrieved
+from the second call is higher, then some categories have been added or expanded.
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
 @*/
 int MPI_T_category_changed(int *stamp)
 {
diff --git a/src/mpi_t/cat_get_categories.c b/src/mpi_t/cat_get_categories.c
index 93e088a..743f5cb 100644
--- a/src/mpi_t/cat_get_categories.c
+++ b/src/mpi_t/cat_get_categories.c
@@ -55,7 +55,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_category_get_categories - XXX description here
+MPI_T_category_get_categories - Get sub-categories in a category
 
 Input Parameters:
 + cat_index - index of the category to be queried, in the range [0,N-1] (integer)
@@ -66,9 +66,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
 @*/
 int MPI_T_category_get_categories(int cat_index, int len, int indices[])
 {
diff --git a/src/mpi_t/cat_get_cvars.c b/src/mpi_t/cat_get_cvars.c
index 5117c30..b1f4f98 100644
--- a/src/mpi_t/cat_get_cvars.c
+++ b/src/mpi_t/cat_get_cvars.c
@@ -55,7 +55,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_category_get_cvars - XXX description here
+MPI_T_category_get_cvars - Get control variables in a category
 
 Input Parameters:
 + cat_index - index of the category to be queried, in the range [0,N-1] (integer)
@@ -66,9 +66,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
 @*/
 int MPI_T_category_get_cvars(int cat_index, int len, int indices[])
 {
diff --git a/src/mpi_t/cat_get_info.c b/src/mpi_t/cat_get_info.c
index 4bdb274..a4f05d9 100644
--- a/src/mpi_t/cat_get_info.c
+++ b/src/mpi_t/cat_get_info.c
@@ -28,7 +28,7 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_category_get_info - XXX description here
+MPI_T_category_get_info - Get the information about a category
 
 Input/Output Parameters:
 + name_len - length of the string and/or buffer for name (integer)
@@ -46,9 +46,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
 @*/
 int MPI_T_category_get_info(int cat_index, char *name, int *name_len, char *desc,
         int *desc_len, int *num_cvars, int *num_pvars, int *num_categories)
diff --git a/src/mpi_t/cat_get_num.c b/src/mpi_t/cat_get_num.c
index f0f3e9c..3bad314 100644
--- a/src/mpi_t/cat_get_num.c
+++ b/src/mpi_t/cat_get_num.c
@@ -28,16 +28,16 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_category_get_num - XXX description here
+MPI_T_category_get_num - Get the number of categories
 
 Output Parameters:
 . num_cat - current number of categories (integer)
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
 @*/
 int MPI_T_category_get_num(int *num_cat)
 {
diff --git a/src/mpi_t/cat_get_pvars.c b/src/mpi_t/cat_get_pvars.c
index 9190ec5..7e8010c 100644
--- a/src/mpi_t/cat_get_pvars.c
+++ b/src/mpi_t/cat_get_pvars.c
@@ -55,7 +55,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_category_get_pvars - XXX description here
+MPI_T_category_get_pvars - Get performance variables in a category
 
 Input Parameters:
 + cat_index - index of the category to be queried, in the range [0,N-1] (integer)
@@ -66,9 +66,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
 @*/
 int MPI_T_category_get_pvars(int cat_index, int len, int indices[])
 {
diff --git a/src/mpi_t/cvar_get_info.c b/src/mpi_t/cvar_get_info.c
index ef2f1ab..1c5ca38 100644
--- a/src/mpi_t/cvar_get_info.c
+++ b/src/mpi_t/cvar_get_info.c
@@ -28,7 +28,7 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_cvar_get_info - XXX description here
+MPI_T_cvar_get_info - Get the information about a control variable
 
 Input/Output Parameters:
 + name_len - length of the string and/or buffer for name (integer)
@@ -48,9 +48,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
 @*/
 int MPI_T_cvar_get_info(int cvar_index, char *name, int *name_len,
     int *verbosity, MPI_Datatype *datatype, MPI_T_enum *enumtype,
diff --git a/src/mpi_t/cvar_get_num.c b/src/mpi_t/cvar_get_num.c
index c1291b6..958f18a 100644
--- a/src/mpi_t/cvar_get_num.c
+++ b/src/mpi_t/cvar_get_num.c
@@ -28,16 +28,16 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_cvar_get_num - XXX description here
+MPI_T_cvar_get_num - Get the number of control variables
 
 Output Parameters:
 . num_cvar - returns number of control variables (integer)
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
 @*/
 int MPI_T_cvar_get_num(int *num_cvar)
 {
diff --git a/src/mpi_t/cvar_handle_alloc.c b/src/mpi_t/cvar_handle_alloc.c
index 737815c..c9ac07d 100644
--- a/src/mpi_t/cvar_handle_alloc.c
+++ b/src/mpi_t/cvar_handle_alloc.c
@@ -74,7 +74,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_cvar_handle_alloc - XXX description here
+MPI_T_cvar_handle_alloc - Allocate a handle for a control variable
 
 Input Parameters:
 + cvar_index - index of control variable for which handle is to be allocated (index)
@@ -86,9 +86,12 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_OUT_OF_HANDLES
 @*/
 int MPI_T_cvar_handle_alloc(int cvar_index, void *obj_handle, MPI_T_cvar_handle *handle, int *count)
 {
diff --git a/src/mpi_t/cvar_handle_free.c b/src/mpi_t/cvar_handle_free.c
index 81c5f11..9c8a82a 100644
--- a/src/mpi_t/cvar_handle_free.c
+++ b/src/mpi_t/cvar_handle_free.c
@@ -28,16 +28,17 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_cvar_handle_free - XXX description here
+MPI_T_cvar_handle_free - Free an existing handle for a control variable
 
 Input/Output Parameters:
 . handle - handle to be freed (handle)
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_HANDLE
 @*/
 int MPI_T_cvar_handle_free(MPI_T_cvar_handle *handle)
 {
diff --git a/src/mpi_t/cvar_read.c b/src/mpi_t/cvar_read.c
index 7c92bb2..e963ef7 100644
--- a/src/mpi_t/cvar_read.c
+++ b/src/mpi_t/cvar_read.c
@@ -82,7 +82,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_cvar_read - XXX description here
+MPI_T_cvar_read - Read the value of a control variable
 
 Input Parameters:
 . handle - handle to the control variable to be read (handle)
@@ -92,9 +92,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_HANDLE
 @*/
 int MPI_T_cvar_read(MPI_T_cvar_handle handle, void *buf)
 {
diff --git a/src/mpi_t/cvar_write.c b/src/mpi_t/cvar_write.c
index fb616eb..0bfdc5d 100644
--- a/src/mpi_t/cvar_write.c
+++ b/src/mpi_t/cvar_write.c
@@ -90,7 +90,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_cvar_write - XXX description here
+MPI_T_cvar_write - Write a control variable
 
 Input Parameters:
 + handle - handle of the control variable to be written (handle)
@@ -98,9 +98,12 @@ Input Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_CVAR_SET_NOT_NOW
+.N MPI_T_ERR_CVAR_SET_NEVER
 @*/
 int MPI_T_cvar_write(MPI_T_cvar_handle handle, void *buf)
 {
diff --git a/src/mpi_t/enum_get_info.c b/src/mpi_t/enum_get_info.c
index 2e3bd66..a08cad6 100644
--- a/src/mpi_t/enum_get_info.c
+++ b/src/mpi_t/enum_get_info.c
@@ -28,7 +28,7 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_enum_get_info - XXX description here
+MPI_T_enum_get_info - Get the information about an enumeration
 
 Input/Output Parameters:
 . name_len - length of the string and/or buffer for name (integer)
@@ -42,9 +42,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_HANDLE
 @*/
 int MPI_T_enum_get_info(MPI_T_enum enumtype, int *num, char *name, int *name_len)
 {
diff --git a/src/mpi_t/enum_get_item.c b/src/mpi_t/enum_get_item.c
index da7e115..aa928c4 100644
--- a/src/mpi_t/enum_get_item.c
+++ b/src/mpi_t/enum_get_item.c
@@ -28,7 +28,7 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_enum_get_item - XXX description here
+MPI_T_enum_get_item - Get the information about an item in an enumeration
 
 Input/Output Parameters:
 . name_len - length of the string and/or buffer for name (integer)
@@ -43,9 +43,11 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_INVALID_ITEM
 @*/
 int MPI_T_enum_get_item(MPI_T_enum enumtype, int index, int *value, char *name, int *name_len)
 {
diff --git a/src/mpi_t/mpit_finalize.c b/src/mpi_t/mpit_finalize.c
index ea33a4e..0321cd0 100644
--- a/src/mpi_t/mpit_finalize.c
+++ b/src/mpi_t/mpit_finalize.c
@@ -170,13 +170,30 @@ void MPIR_T_env_finalize(void)
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_finalize - XXX description here
+MPI_T_finalize - Finalize the MPI tool information interface
+
+Notes:
+This routine may be called as often as the corresponding MPI_T_init_thread() routine
+up to the current point of execution. Calling it more times returns a corresponding
+error code. As long as the number of calls to MPI_T_finalize() is smaller than the
+number of calls to MPI_T_init_thread() up to the current point of execution, the MPI
+tool information interface remains initialized and calls to its routines are permissible.
+Further, additional calls to MPI_T_init_thread() after one or more calls to MPI_T_finalize()
+are permissible. Once MPI_T_finalize() is called the same number of times as the routine
+MPI_T_init_thread() up to the current point of execution, the MPI tool information
+interface is no longer initialized. The interface can be reinitialized by subsequent calls
+to MPI_T_init_thread().
+
+At the end of the program execution, unless MPI_Abort() is called, an application must
+have called MPI_T_init_thread() and MPI_T_finalize() an equal number of times.
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+
+.seealso MPI_T_init_thread
 @*/
 int MPI_T_finalize(void)
 {
diff --git a/src/mpi_t/mpit_initthread.c b/src/mpi_t/mpit_initthread.c
index 02aed27..23ab02e 100644
--- a/src/mpi_t/mpit_initthread.c
+++ b/src/mpi_t/mpit_initthread.c
@@ -83,7 +83,7 @@ void MPIR_T_env_init(void)
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_init_thread - XXX description here
+MPI_T_init_thread - Initialize the MPI_T execution environment
 
 Input Parameters:
 . required - desired level of thread support (integer)
@@ -91,11 +91,23 @@ Input Parameters:
 Output Parameters:
 . provided - provided level of thread support (integer)
 
-.N ThreadSafe
+Notes:
+  The valid values for the level of thread support are:
++ MPI_THREAD_SINGLE - Only one thread will execute.
+. MPI_THREAD_FUNNELED - The process may be multi-threaded, but only the main
+  thread will make MPI_T calls (all MPI_T calls are funneled to the
+  main thread).
+. MPI_THREAD_SERIALIZED - The process may be multi-threaded, and multiple
+  threads may make MPI_T calls, but only one at a time: MPI_T calls are not
+  made concurrently from two distinct threads (all MPI_T calls are serialized).
+- MPI_THREAD_MULTIPLE - Multiple threads may call MPI_T, with no restrictions.
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+
+.seealso MPI_T_finalize
 @*/
 int MPI_T_init_thread(int required, int *provided)
 {
diff --git a/src/mpi_t/pvar_get_info.c b/src/mpi_t/pvar_get_info.c
index 5df055f..af56992 100644
--- a/src/mpi_t/pvar_get_info.c
+++ b/src/mpi_t/pvar_get_info.c
@@ -28,7 +28,7 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_get_info - XXX description here
+MPI_T_pvar_get_info - Get the inforamtion about a performance variable
 
 Input/Output Parameters:
 + name_len - length of the string and/or buffer for name (integer)
@@ -51,9 +51,10 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_INDEX
 @*/
 int MPI_T_pvar_get_info(int pvar_index, char *name, int *name_len, int *verbosity,
     int *var_class, MPI_Datatype *datatype, MPI_T_enum *enumtype, char *desc,
diff --git a/src/mpi_t/pvar_get_num.c b/src/mpi_t/pvar_get_num.c
index c4a8fdd..1f69872 100644
--- a/src/mpi_t/pvar_get_num.c
+++ b/src/mpi_t/pvar_get_num.c
@@ -28,16 +28,16 @@
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_get_num - XXX description here
+MPI_T_pvar_get_num - Get the number of performance variables
 
 Output Parameters:
 . num_pvar - returns number of performance variables (integer)
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
 @*/
 int MPI_T_pvar_get_num(int *num_pvar)
 {
diff --git a/src/mpi_t/pvar_handle_alloc.c b/src/mpi_t/pvar_handle_alloc.c
index 151ca78..26ce0b8 100644
--- a/src/mpi_t/pvar_handle_alloc.c
+++ b/src/mpi_t/pvar_handle_alloc.c
@@ -167,7 +167,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_handle_alloc - XXX description here
+MPI_T_pvar_handle_alloc - Allocate a handle for a performance variable
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
@@ -180,9 +180,12 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_INDEX
+.N MPI_T_ERR_OUT_OF_HANDLES
 @*/
 int MPI_T_pvar_handle_alloc(MPI_T_pvar_session session, int pvar_index,
                             void *obj_handle, MPI_T_pvar_handle *handle, int *count)
diff --git a/src/mpi_t/pvar_handle_free.c b/src/mpi_t/pvar_handle_free.c
index d22df03..6563812 100644
--- a/src/mpi_t/pvar_handle_free.c
+++ b/src/mpi_t/pvar_handle_free.c
@@ -73,7 +73,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_handle_free - XXX description here
+MPI_T_pvar_handle_free - Free an existing handle for a performance variable
 
 Input/Output Parameters:
 + session - identifier of performance experiment session (handle)
@@ -81,9 +81,11 @@ Input/Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
 @*/
 int MPI_T_pvar_handle_free(MPI_T_pvar_session session, MPI_T_pvar_handle *handle)
 {
diff --git a/src/mpi_t/pvar_read.c b/src/mpi_t/pvar_read.c
index 0ef169c..ef0f7d5 100644
--- a/src/mpi_t/pvar_read.c
+++ b/src/mpi_t/pvar_read.c
@@ -208,7 +208,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_read - XXX description here
+MPI_T_pvar_read - Read the value of a performance variable
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
@@ -217,11 +217,24 @@ Input Parameters:
 Output Parameters:
 . buf - initial address of storage location for variable value (choice)
 
-.N ThreadSafe
+Notes:
+The MPI_T_pvar_read() call queries the value of the performance variable with the
+handle "handle" in the session identified by the parameter session and stores the result
+in the buffer identified by the parameter buf. The user is responsible to ensure that the
+buffer is of the appropriate size to hold the entire value of the performance variable
+(based on the datatype and count returned by the corresponding previous calls to
+MPI_T_pvar_get_info() and MPI_T_pvar_handle_alloc(), respectively).
+
+The constant MPI_T_PVAR_ALL_HANDLES cannot be used as an argument for the function
+MPI_T_pvar_read().
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
 @*/
 int MPI_T_pvar_read(MPI_T_pvar_session session, MPI_T_pvar_handle handle, void *buf)
 {
diff --git a/src/mpi_t/pvar_readreset.c b/src/mpi_t/pvar_readreset.c
index 2347218..b01f220 100644
--- a/src/mpi_t/pvar_readreset.c
+++ b/src/mpi_t/pvar_readreset.c
@@ -51,7 +51,7 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_readreset - XXX description here
+MPI_T_pvar_readreset - Read the value of a performance variable and then reset it
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
@@ -62,9 +62,13 @@ Output Parameters:
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_PVAR_NO_WRITE
+.N MPI_T_ERR_PVAR_NO_ATOMIC
 @*/
 int MPI_T_pvar_readreset(MPI_T_pvar_session session, MPI_T_pvar_handle handle, void *buf)
 {
diff --git a/src/mpi_t/pvar_reset.c b/src/mpi_t/pvar_reset.c
index 783ccdd..00982e8 100644
--- a/src/mpi_t/pvar_reset.c
+++ b/src/mpi_t/pvar_reset.c
@@ -78,17 +78,30 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_reset - XXX description here
+MPI_T_pvar_reset - Reset a performance variable
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
 - handle - handle of a performance variable (handle)
 
-.N ThreadSafe
+Notes:
+The MPI_T_pvar_reset() call sets the performance variable with the handle identified
+by the parameter handle to its starting value. If it is not possible
+to change the variable, the function returns MPI_T_ERR_PVAR_NO_WRITE.
+If the constant MPI_T_PVAR_ALL_HANDLES is passed in handle, the MPI implementation
+attempts to reset all variables within the session identified by the parameter session for
+which handles have been allocated. In this case, the routine returns MPI_SUCCESS if all
+variables are reset successfully, otherwise MPI_T_ERR_PVAR_NO_WRITE is returned. Readonly
+variables are ignored when MPI_T_PVAR_ALL_HANDLES is specified.
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_PVAR_NO_WRITE
 @*/
 int MPI_T_pvar_reset(MPI_T_pvar_session session, MPI_T_pvar_handle handle)
 {
diff --git a/src/mpi_t/pvar_session_create.c b/src/mpi_t/pvar_session_create.c
index ec5f5b7..b6f9d07 100644
--- a/src/mpi_t/pvar_session_create.c
+++ b/src/mpi_t/pvar_session_create.c
@@ -55,16 +55,17 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_session_create - XXX description here
+MPI_T_pvar_session_create - Create a new session for accessing performance variables
 
 Output Parameters:
 . session - identifier of performance session (handle)
 
 .N ThreadSafe
 
-.N Fortran
-
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_OUT_OF_SESSIONS
 @*/
 int MPI_T_pvar_session_create(MPI_T_pvar_session *session)
 {
diff --git a/src/mpi_t/pvar_session_free.c b/src/mpi_t/pvar_session_free.c
index 968b1fa..4b86cd1 100644
--- a/src/mpi_t/pvar_session_free.c
+++ b/src/mpi_t/pvar_session_free.c
@@ -60,16 +60,22 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_session_free - XXX description here
+MPI_T_pvar_session_free - Free an existing performance variable session
 
 Input/Output Parameters:
 . session - identifier of performance experiment session (handle)
 
-.N ThreadSafe
+Notes:
+Calls to the MPI tool information interface can no longer be made
+within the context of a session after it is freed. On a successful
+return, MPI sets the session identifier to MPI_T_PVAR_SESSION_NULL.
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZEDE
+.N MPI_T_ERR_INVALID_SESSION
 @*/
 int MPI_T_pvar_session_free(MPI_T_pvar_session *session)
 {
diff --git a/src/mpi_t/pvar_start.c b/src/mpi_t/pvar_start.c
index 21037c8..d94cde9 100644
--- a/src/mpi_t/pvar_start.c
+++ b/src/mpi_t/pvar_start.c
@@ -78,17 +78,28 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_start - XXX description here
+MPI_T_pvar_start - Start a performance variable
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
 - handle - handle of a performance variable (handle)
 
-.N ThreadSafe
+Notes:
+If the constant MPI_T_PVAR_ALL_HANDLES is passed in handle, the MPI implementation
+attempts to start all variables within the session identified by the parameter session for
+which handles have been allocated. In this case, the routine returns MPI_SUCCESS if all
+variables are started successfully, otherwise MPI_T_ERR_PVAR_NO_STARTSTOP is returned.
+Continuous variables and variables that are already started are ignored when
+MPI_T_PVAR_ALL_HANDLES is specified.
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_PVAR_NO_STARTSTOP
 @*/
 int MPI_T_pvar_start(MPI_T_pvar_session session, MPI_T_pvar_handle handle)
 {
diff --git a/src/mpi_t/pvar_stop.c b/src/mpi_t/pvar_stop.c
index 3b1599d..b8e4337 100644
--- a/src/mpi_t/pvar_stop.c
+++ b/src/mpi_t/pvar_stop.c
@@ -104,17 +104,31 @@ fn_fail:
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_stop - XXX description here
+MPI_T_pvar_stop - Stop a performance variable
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
 - handle - handle of a performance variable (handle)
 
-.N ThreadSafe
+Notes:
+This functions stops the performance variable with the handle identified by the parameter
+handle in the session identified by the parameter session.
+
+If the constant MPI_T_PVAR_ALL_HANDLES is passed in handle, the MPI implementation
+attempts to stop all variables within the session identified by the parameter session for
+which handles have been allocated. In this case, the routine returns MPI_SUCCESS if all
+variables are stopped successfully, otherwise MPI_T_ERR_PVAR_NO_STARTSTOP is returned.
+Continuous variables and variables that are already stopped are ignored when
+MPI_T_PVAR_ALL_HANDLES is specified.
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_PVAR_NO_STARTSTOP
 @*/
 int MPI_T_pvar_stop(MPI_T_pvar_session session, MPI_T_pvar_handle handle)
 {
diff --git a/src/mpi_t/pvar_write.c b/src/mpi_t/pvar_write.c
index bf9f568..9548229 100644
--- a/src/mpi_t/pvar_write.c
+++ b/src/mpi_t/pvar_write.c
@@ -41,18 +41,32 @@ int MPIR_T_pvar_write_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle,
 #undef FCNAME
 #define FCNAME MPIU_QUOTE(FUNCNAME)
 /*@
-MPI_T_pvar_write - XXX description here
+MPI_T_pvar_write - Write a performance variable
 
 Input Parameters:
 + session - identifier of performance experiment session (handle)
 . handle - handle of a performance variable (handle)
 - buf - initial address of storage location for variable value (choice)
 
-.N ThreadSafe
+Notes:
+The MPI_T_pvar_write() call attempts to write the value of the performance variable
+with the handle identified by the parameter handle in the session identified by the parameter
+session. The value to be written is passed in the buffer identified by the parameter buf. The
+user must ensure that the buffer is of the appropriate size to hold the entire value of the
+performance variable (based on the datatype and count returned by the corresponding previous
+calls to MPI_T_pvar_get_info() and MPI_T_pvar_handle_alloc(), respectively).
+
+The constant MPI_T_PVAR_ALL_HANDLES cannot be used as an argument for the function
+MPI_T_pvar_write().
 
-.N Fortran
+.N ThreadSafe
 
 .N Errors
+.N MPI_SUCCESS
+.N MPI_T_ERR_NOT_INITIALIZED
+.N MPI_T_ERR_INVALID_SESSION
+.N MPI_T_ERR_INVALID_HANDLE
+.N MPI_T_ERR_PVAR_NO_WRITE
 @*/
 int MPI_T_pvar_write(MPI_T_pvar_session session, MPI_T_pvar_handle handle, void *buf)
 {

http://git.mpich.org/mpich.git/commitdiff/b60f15e1073d64823254385dec4b26cb831ecdac

commit b60f15e1073d64823254385dec4b26cb831ecdac
Author: Junchao Zhang <jczhang at mcs.anl.gov>
Date:   Wed Nov 13 14:15:52 2013 -0600

    Add new MPI_T error codes in doctext

diff --git a/maint/docnotes b/maint/docnotes
index 412221c..4279cbe 100644
--- a/maint/docnotes
+++ b/maint/docnotes
@@ -467,6 +467,62 @@ N*/
 . MPI_ERR_UNSUPPORTED_DATAREP - 
 N*/
 
+/*N MPI_T_ERR_NOT_INITIALIZED
+. MPI_T_ERR_NOT_INITIALIZED - The MPI tool information interface is not initialized.
+N*/
+
+/*N MPI_T_ERR_MEMORY
+. MPI_T_ERR_MEMORY - The MPI tool information interface is out of memory.
+N*/
+
+/*N MPI_T_ERR_CANNOT_INIT
+. MPI_T_ERR_CANNOT_INIT - The MPI tool information interface is not in the state to be initialized.
+N*/
+
+/*N MPI_T_ERR_INVALID_INDEX
+. MPI_T_ERR_INVALID_INDEX - Index is invalid or has been deleted.
+N*/
+
+/*N MPI_T_ERR_INVALID_ITEM
+. MPI_T_ERR_INVALID_ITEM - Item index queried is out of range.
+N*/
+
+/*N MPI_T_ERR_INVALID_HANDLE
+. MPI_T_ERR_INVALID_HANDLE - The handle is invalid.
+N*/
+
+/*N MPI_T_ERR_OUT_OF_HANDLES
+. MPI_T_ERR_OUT_OF_HANDLES - No more handles available.
+N*/
+
+/*N MPI_T_ERR_OUT_OF_SESSIONS
+. MPI_T_ERR_OUT_OF_SESSIONS - No more sessions available.
+N*/
+
+/*N MPI_T_ERR_INVALID_SESSION
+. MPI_T_ERR_INVALID_SESSION - Session argument is not valid.
+N*/
+
+/*N MPI_T_ERR_CVAR_SET_NOT_NOW
+. MPI_T_ERR_CVAR_SET_NOT_NOW - The control variable can't be set at this moment.
+N*/
+
+/*N MPI_T_ERR_CVAR_SET_NEVER
+. MPI_T_ERR_CVAR_SET_NEVER -  The control variable can't be set until end of execution.
+N*/
+
+/*N MPI_T_ERR_PVAR_NO_STARTSTOP
+. MPI_T_ERR_PVAR_NO_STARTSTOP - The performance variable can't be started or stopped.
+N*/
+
+/*N MPI_T_ERR_PVAR_NO_WRITE
+. MPI_T_ERR_PVAR_NO_WRITE - The performance variable can't be written or reset.
+N*/
+
+/*N MPI_T_ERR_PVAR_NO_ATOMIC
+. MPI_T_ERR_PVAR_NO_ATOMIC - The performance variable can't be read/write atomically.
+N*/
+
 /*N NULL
 Null Handles:
 The MPI 1.1 specification, in the section on opaque objects, explicitly

-----------------------------------------------------------------------

Summary of changes:
 maint/docnotes                  |   56 +++++++++++++++++++++++++++++++++++++++
 src/mpi_t/cat_changed.c         |   11 +++++--
 src/mpi_t/cat_get_categories.c  |    7 +++--
 src/mpi_t/cat_get_cvars.c       |    7 +++--
 src/mpi_t/cat_get_info.c        |    7 +++--
 src/mpi_t/cat_get_num.c         |    6 ++--
 src/mpi_t/cat_get_pvars.c       |    7 +++--
 src/mpi_t/cvar_get_info.c       |    7 +++--
 src/mpi_t/cvar_get_num.c        |    6 ++--
 src/mpi_t/cvar_handle_alloc.c   |    9 ++++--
 src/mpi_t/cvar_handle_free.c    |    7 +++--
 src/mpi_t/cvar_read.c           |    7 +++--
 src/mpi_t/cvar_write.c          |    9 ++++--
 src/mpi_t/enum_get_info.c       |    7 +++--
 src/mpi_t/enum_get_item.c       |    8 +++--
 src/mpi_t/mpit_finalize.c       |   23 ++++++++++++++--
 src/mpi_t/mpit_initthread.c     |   18 ++++++++++--
 src/mpi_t/pvar_get_info.c       |    7 +++--
 src/mpi_t/pvar_get_num.c        |    6 ++--
 src/mpi_t/pvar_handle_alloc.c   |    9 ++++--
 src/mpi_t/pvar_handle_free.c    |    8 +++--
 src/mpi_t/pvar_read.c           |   19 +++++++++++--
 src/mpi_t/pvar_readreset.c      |   10 +++++--
 src/mpi_t/pvar_reset.c          |   19 +++++++++++--
 src/mpi_t/pvar_session_create.c |    7 +++--
 src/mpi_t/pvar_session_free.c   |   12 ++++++--
 src/mpi_t/pvar_start.c          |   17 +++++++++--
 src/mpi_t/pvar_stop.c           |   20 ++++++++++++--
 src/mpi_t/pvar_write.c          |   20 ++++++++++++--
 29 files changed, 272 insertions(+), 84 deletions(-)


hooks/post-receive
-- 
MPICH primary repository

More information about the commits mailing list