first pass at errhandler support

Signed-off-by: Howard Pritchard <howardp@lanl.gov>

Author: hppritcha

ompi/errhandler/errhandler.c

@@ -255,7 +255,8 @@ void ompi_errhandler_free (ompi_errhandler_t *errhandler)
 
 ompi_errhandler_t *ompi_errhandler_create(ompi_errhandler_type_t object_type,
                                           ompi_errhandler_generic_handler_fn_t *func,
-                                          ompi_errhandler_lang_t lang)
+                                          ompi_errhandler_lang_t lang,
+                                          ompi_errhandler_converter_fn_t *converter)
 {
     ompi_errhandler_t *new_errhandler;
     int ret;
@@ -298,6 +299,11 @@ ompi_errhandler_t *ompi_errhandler_create(ompi_errhandler_type_t object_type,
             default:
                 break;
             }
+            if (NULL != converter) {
+                new_errhandler->eh_converter_fn = converter;
+            } else {
+                new_errhandler->eh_converter_fn = NULL;
+            }
         }
 
         if (NULL != new_errhandler) {
@@ -626,9 +632,9 @@ static void ompi_errhandler_destruct(ompi_errhandler_t *errhandler)
   /* reset the ompi_errhandler_f_to_c_table entry - make sure that the
      entry is in the table */
 
-  if (NULL!= opal_pointer_array_get_item(&ompi_errhandler_f_to_c_table,
+    if (NULL!= opal_pointer_array_get_item(&ompi_errhandler_f_to_c_table,
                                         errhandler->eh_f_to_c_index)) {
-    opal_pointer_array_set_item(&ompi_errhandler_f_to_c_table,
-                                errhandler->eh_f_to_c_index, NULL);
-  }
+        opal_pointer_array_set_item(&ompi_errhandler_f_to_c_table,
+                                    errhandler->eh_f_to_c_index, NULL);
+    }
 }

ompi/errhandler/errhandler.h

@@ -17,7 +17,7 @@
  *                         reserved.
  * Copyright (c) 2016      Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
- * Copyright (c) 2018-2021 Triad National Security, LLC. All rights
+ * Copyright (c) 2018-2025 Triad National Security, LLC. All rights
  *                         reserved.
  * $COPYRIGHT$
  *
@@ -68,6 +68,13 @@ typedef void (ompi_errhandler_fortran_handler_fn_t)(MPI_Fint *,
  */
 typedef void (ompi_errhandler_generic_handler_fn_t)(void *, int *, ...);
 
+
+/**
+ * Typedef for convert function (internal MPI ABI support)
+ */
+
+typedef void (ompi_errhandler_converter_fn_t)(void *object, int object_type, int *err_code);
+
 /**
  * Enum to denote what language the error handler was created from
  */
@@ -108,12 +115,17 @@ struct ompi_errhandler_t {
     /* Function pointers.  Note that we *have* to have all 4 types
        (vs., for example, a union) because the predefined errhandlers
        can be invoked on any MPI object type, so we need callbacks for
-       all of three. */
+       all of four. */
     MPI_Comm_errhandler_function *eh_comm_fn;
     ompi_file_errhandler_function *eh_file_fn;
     MPI_Win_errhandler_function *eh_win_fn;
     MPI_Session_errhandler_function *eh_instance_fn;
     ompi_errhandler_fortran_handler_fn_t *eh_fort_fn;
+    /*
+     * use a single function for converting OMPI internal handles to ABI
+     * compliant ones.  Only used for user defined errhandlers.
+     */
+    ompi_errhandler_converter_fn_t *eh_converter_fn;
 
     /* index in Fortran <-> C translation array */
     int eh_f_to_c_index;
@@ -185,6 +197,7 @@ OMPI_DECLSPEC extern ompi_errhandler_t* ompi_initial_error_handler_eh;
  */
 OMPI_DECLSPEC extern void (*ompi_initial_error_handler)(struct ompi_communicator_t **comm, int *error_code, ...);
 
+
 /**
  * Forward declaration so that we don't have to include
  * request/request.h here.
@@ -381,6 +394,7 @@ extern opal_atomic_int32_t ompi_instance_count;
    * @param[in]  object_type    Enum of the type of MPI object
    * @param[in]  func           Function pointer of the error handler
    * @param[in]  language       Calling language
+   * @param[in]  converter      Optional converter function (used internally for MPI ABI)
    *
    * @returns errhandler Pointer to the ompi_errorhandler_t that will be
    *   created and returned
@@ -400,7 +414,8 @@ extern opal_atomic_int32_t ompi_instance_count;
    */
   OMPI_DECLSPEC ompi_errhandler_t *ompi_errhandler_create(ompi_errhandler_type_t object_type,
                                             ompi_errhandler_generic_handler_fn_t *func,
-                                            ompi_errhandler_lang_t language);
+                                            ompi_errhandler_lang_t language,
+                                            ompi_errhandler_converter_fn_t *converter);
 
   OMPI_DECLSPEC void ompi_errhandler_free (ompi_errhandler_t *errhandler);
 

ompi/errhandler/errhandler_invoke.c

@@ -84,6 +84,7 @@ int ompi_errhandler_invoke(ompi_errhandler_t *errhandler, void *mpi_object,
         comm = (ompi_communicator_t *) mpi_object;
         switch (errhandler->eh_lang) {
         case OMPI_ERRHANDLER_LANG_C:
+            if(NULL != errhandler->eh_converter_fn) errhandler->eh_converter_fn((void *)&comm, object_type, &err_code);
             errhandler->eh_comm_fn(&comm, &err_code, message, NULL);
             break;
 
@@ -99,6 +100,7 @@ int ompi_errhandler_invoke(ompi_errhandler_t *errhandler, void *mpi_object,
         win = (ompi_win_t *) mpi_object;
         switch (errhandler->eh_lang) {
         case OMPI_ERRHANDLER_LANG_C:
+            if(NULL != errhandler->eh_converter_fn) errhandler->eh_converter_fn((void *)&win, object_type, &err_code);
             errhandler->eh_win_fn(&win, &err_code, message, NULL);
             break;
 
@@ -114,6 +116,7 @@ int ompi_errhandler_invoke(ompi_errhandler_t *errhandler, void *mpi_object,
         file = (ompi_file_t *) mpi_object;
         switch (errhandler->eh_lang) {
         case OMPI_ERRHANDLER_LANG_C:
+            if(NULL != errhandler->eh_converter_fn) errhandler->eh_converter_fn((void *)&file, object_type, &err_code);
             errhandler->eh_file_fn(&file, &err_code, message, NULL);
             break;
 
@@ -129,6 +132,7 @@ int ompi_errhandler_invoke(ompi_errhandler_t *errhandler, void *mpi_object,
         instance = (ompi_instance_t *) mpi_object;
         switch (errhandler->eh_lang) {
         case OMPI_ERRHANDLER_LANG_C:
+            if(NULL != errhandler->eh_converter_fn) errhandler->eh_converter_fn((void *)&instance, object_type, &err_code);
             errhandler->eh_instance_fn(&instance, &err_code, message, NULL);
             break;
 

ompi/mpi/bindings/bindings.py

@@ -59,6 +59,8 @@ def main():
     parser_header.set_defaults(handler=lambda args, out: c.generate_header(args, out))
     parser_header = subparsers_c.add_parser('converters', help='generate converter header file')
     parser_header.set_defaults(handler=lambda args, out: c.generate_converters(args, out))
+    parser_header = subparsers_c.add_parser('converter_aux_functions', help='generate converter auxiliary functions')
+    parser_header.set_defaults(handler=lambda args, out: c.generate_converter_auxiliary_funcs(args, out))
     parser_gen = subparsers_c.add_parser('source', help='generate source file from template file')
     # parser = argparse.ArgumentParser(description='C ABI binding generation code')
     parser_gen.add_argument('type', choices=('ompi', 'standard'),

ompi/mpi/bindings/c_header.py

@@ -40,10 +40,14 @@
     "MPI_Win",
     "MPI_Comm_copy_attr_function",
     "MPI_Comm_delete_attr_function",
+    "MPI_Comm_errhandler_function",
+    "MPI_File_errhandler_function",
+    "MPI_Session_errhandler_function",
     "MPI_Type_copy_attr_function",
     "MPI_Type_delete_attr_function",
     "MPI_Win_delete_attr_function",
     "MPI_Win_copy_attr_function",
+    "MPI_Win_errhandler_function",
     "MPI_T_enum",
     "MPI_T_cvar_handle",
     "MPI_T_pvar_handle",
@@ -58,21 +62,29 @@
 ]
 
 DEPRECATED_FUNCTIONS = [
-    "MPI_Keyval_create",
-    "MPI_Keyval_free",
-    "MPI_Attr_put",
-    "MPI_Attr_get",
-    "MPI_Attr_delete",
     "MPI_Address",
-    "MPI_Errhandler_create",
-    "MPI_Errhandler_get",
-    "MPI_Errhandler_set",
-    "MPI_Type_extent",
     "MPI_Type_hindexed",
     "MPI_Type_hvector",
-    "MPI_Type_lb",
     "MPI_Type_struct",
-    "MPI_Type_ub",
+    "MPI_Type_extent",
+    "MPI_Type_lb",
+    "MPI_Type_lb",
+    "MPI_LB",
+    "MPI_UB",
+    "MPI_Errhandler_create",
+    "MPI_Errhandler_get",
+    "MPI_Errhandler_set",
+    "MPI_Keyval_create",
+    "MPI_Keyval_free",
+    "MPI_DUP_FN"
+    "MPI_NULL_COPY_FN"
+    "MPI_NULL_DELETE_FN"
+    "MPI_Attr_delete",
+    "MPI_Attr_get",
+    "MPI_Attr_put",
+    "MPI_COMBINER_HVECTOR_INTEGER",
+    "MPI_COMBINER_HINDEXED_INTEGER",
+    "MPI_COMBINER_STRUCT_INTEGER",
 ]
 
 ENUM_CATEGORIES = [
@@ -323,6 +335,7 @@ def output_constant(const, use_enum: bool, mangle_name: bool):
             line = re.sub(datatype_pattern, f"\\g<1>\\g<2>{ABI_INTERNAL}\\g<3>", line)
     # TODO: need to enhance pympistandard to be able to prune out deprecated functions
     # This stands in as a workaround
+    comment_out = False
     comment_out = any(i in line for i in DEPRECATED_FUNCTIONS)
 
     # function is not in the ABI standard (things in MPI 5.1 chapter 19 sections 19.3.4 and 19.3.5

ompi/mpi/bindings/ompi_bindings/c.py

@@ -672,6 +672,36 @@ def generate_status_convert_fn_intern_to_abi(self):
         # Ignoring the private fields for now
         self.dump('}')
 
+    def generate_errhandler_args_convert_fn_intern_to_abi(self):
+        self.dump(f'{consts.INLINE_ATTRS} void ompi_convert_errhandler_args_intern_to_abi(void *object, int object_type, int *err_code)')
+        self.dump('{')
+        lines = []
+        lines.append('ompi_communicator_t **comm;')
+        lines.append('ompi_file_t **file;')
+        lines.append('ompi_instance_t **instance;')
+        lines.append('ompi_win_t **win;')
+        lines.append(f'*err_code = {ConvertOMPIToStandard.ERROR_CLASS}(*err_code);')
+        lines.append('switch(object_type) {')
+        lines.append('case OMPI_ERRHANDLER_TYPE_COMM:')
+        lines.append('comm = (ompi_communicator_t **)object;')
+        lines.append(f'*comm = (MPI_Comm *){ConvertOMPIToStandard.COMM}(*comm);')
+        lines.append('break;')
+        lines.append('case OMPI_ERRHANDLER_TYPE_WIN:')
+        lines.append('win = (ompi_win_t **)object;')
+        lines.append(f'*win = (MPI_Win *){ConvertOMPIToStandard.WIN}(*win);')
+        lines.append('break;')
+        lines.append('case OMPI_ERRHANDLER_TYPE_FILE:')
+        lines.append('file = (ompi_file_t **)object;')
+        lines.append(f'*file = (MPI_File *){ConvertOMPIToStandard.FILE}(*file);')
+        lines.append('break;')
+        lines.append('case OMPI_ERRHANDLER_TYPE_INSTANCE:')
+        lines.append('instance = (ompi_instance_t **)object;')
+        lines.append(f'*instance = (MPI_Session *){ConvertOMPIToStandard.SESSION}(*instance);')
+        lines.append('break;')
+        lines.append('};')
+        self.dump_lines(lines);
+        self.dump('}')
+
     def define(self, type_, name, value):
         self.dump(f'#define {name} OMPI_CAST_CONSTANT({type_}, {value})')
 
@@ -713,6 +743,12 @@ def dump_code(self):
         lines.append('}')
         lines.append('\n')
         self.dump_lines(lines)
+#
+# TODO: need to do something smarter
+#
+        self.dump('\n')
+        self.dump(f'void ompi_convert_errhandler_args_intern_to_abi(void *object, int object_type, int *err_code);')
+        self.dump('\n')
 
         # Now generate the conversion code - there's a reason for the order here
         # some converters depend on others being declared earlier in the include
@@ -810,6 +846,55 @@ def dump_code(self):
 """)
         self.dump(f'#endif /* {header_guard} */')
 
+class ABIConverterGlobalBuilder(ABIConverterBuilder):
+
+    def generate_errhandler_args_convert_fn_intern_to_abi(self):
+        self.dump(f'void ompi_convert_errhandler_args_intern_to_abi(void *object, int object_type, int *err_code)')
+        self.dump('{')
+        lines = []
+        lines.append('ompi_communicator_t **comm;')
+        lines.append('ompi_file_t **file;')
+        lines.append('ompi_instance_t **instance;')
+        lines.append('ompi_win_t **win;')
+        lines.append(f'*err_code = {ConvertOMPIToStandard.ERROR_CLASS}(*err_code);')
+        lines.append('switch(object_type) {')
+        lines.append('case OMPI_ERRHANDLER_TYPE_COMM:')
+        lines.append('comm = (ompi_communicator_t **)object;')
+        lines.append(f'*comm = (ompi_communicator_t *){ConvertOMPIToStandard.COMM}(*comm);')
+        lines.append('break;')
+        lines.append('case OMPI_ERRHANDLER_TYPE_WIN:')
+        lines.append('win = (ompi_win_t **)object;')
+        lines.append(f'*win = (ompi_win_t *){ConvertOMPIToStandard.WIN}(*win);')
+        lines.append('break;')
+        lines.append('case OMPI_ERRHANDLER_TYPE_FILE:')
+        lines.append('file = (ompi_file_t **)object;')
+        lines.append(f'*file = (ompi_file_t *){ConvertOMPIToStandard.FILE}(*file);')
+        lines.append('break;')
+        lines.append('case OMPI_ERRHANDLER_TYPE_INSTANCE:')
+        lines.append('instance = (ompi_instance_t **)object;')
+        lines.append(f'*instance = (ompi_instance_t *){ConvertOMPIToStandard.SESSION}(*instance);')
+        lines.append('break;')
+        lines.append('};')
+        self.dump_lines(lines);
+        self.dump('}')
+
+    def dump_code(self):
+        self.dump('#include "stddef.h"')
+        self.dump('#include "stdint.h"')
+        self.dump('#include "ompi/communicator/communicator.h"')
+        self.dump('#include "ompi/win/win.h"')
+        self.dump('#include "ompi/file/file.h"')
+        self.dump('#include "ompi/instance/instance.h"')
+        self.dump('#include "ompi/errhandler/errhandler.h"')
+        self.dump('#include "ompi/mpi/c/abi.h"')
+        self.dump('#include "ompi/mpi/c/abi_converters.h"')
+
+        #
+        # special case converters:
+        #    - errhandler functions convert
+        #
+        self.generate_errhandler_args_convert_fn_intern_to_abi()
+
 def print_profiling_header(fn_name, out):
     """Print the profiling header code."""
     out.dump('#if OMPI_BUILD_MPI_PROFILING')
@@ -956,6 +1041,12 @@ def generate_function(prototype, fn_name, internal_fn, out, enable_count=False):
                           enable_count=True)
 
 
+def generate_converter_auxiliary_funcs(args, out):
+    """Generate ABI auxiliary files. """
+    out.dump(f'/* {consts.GENERATED_MESSAGE} */')
+    builder = ABIConverterGlobalBuilder(out)
+    builder.dump_code()
+
 def generate_converters(args, out):
     """Generate ABI conversion methods. """
     out.dump(f'/* {consts.GENERATED_MESSAGE} */')