Merge pull request #8572 from awlauria/mpir_v3.1.x

v3.1.x: Fix case where debuggers cannot read the MPIR proctable.

Author: jsquyres

orte/orted/orted-mpir/orted_mpir.h

@@ -18,6 +18,27 @@ BEGIN_C_DECLS
 #define MPIR_MAX_PATH_LENGTH 512
 #define MPIR_MAX_ARG_LENGTH 1024
 
+
+/* Note to future MPIR maintainers:
+ *
+ * This struct MUST (along with all other MPIR_* symbols) be declared
+ * and defined in this file. Otherwise they may be compiled *without* -g
+ * and *with* optimizations in production. In the case where they are
+ * not here, the debugger won't have the complete definition of the proctable.
+ * This will prevent the debugger from reading it properly.
+ *
+ * It also needs to be seen by multiple files (orted_submih.c and
+ * orted_mpir_breakpoint.c), so this is a better place for it anyway.
+ *
+ * For more info/discussion on this, see the following github issue:
+ * https://github.com/open-mpi/ompi/issues/8563
+ */
+struct MPIR_PROCDESC {
+    char *host_name;        /* something that can be passed to inet_addr */
+    char *executable_name;  /* name of binary */
+    int pid;                /* process pid */
+};
+
 extern struct MPIR_PROCDESC *MPIR_proctable;
 extern int MPIR_proctable_size;
 extern volatile int MPIR_being_debugged;

orte/orted/orted_submit.c

@@ -2207,13 +2207,6 @@ static void complete_recv(int status, orte_process_name_t* sender,
 #define DUMP_INT(X) fprintf(stderr, "  %s = %d\n", # X, X);
 #define FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)
 
-struct MPIR_PROCDESC {
-    char *host_name;        /* something that can be passed to inet_addr */
-    char *executable_name;  /* name of binary */
-    int pid;                /* process pid */
-};
-
-
 /**
  * Initialization of data structures for running under a debugger
  * using the MPICH/TotalView parallel debugger interface.  Before the