Skip to content

Commit 08b1f2d

Browse files
jsquyresjsquyres
authored
Merge pull request #8428 from awlauria/fix_mpir_breakpoint_v4.1.x
v4.1.x: Make sure MPIR_Breakpoint() is compiled without CFLAGS.
2 parents 2974b60 + 70d13e5 commit 08b1f2d

File tree

7 files changed

+134
-70
lines changed

7 files changed

+134
-70
lines changed

‎config/orte_config_files.m4‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
# Copyright (c) 2011-2012 Los Alamos National Security, LLC. All rights
88
# reserved.
99
# Copyright (c) 2015-2018 Intel, Inc. All rights reserved.
10+
# Copyright (c) 2021 IBM Corporation. All rights reserved.
1011
# $COPYRIGHT$
1112
#
1213
# Additional copyrights may follow
@@ -19,7 +20,7 @@ AC_DEFUN([ORTE_CONFIG_FILES],[
1920
orte/Makefile
2021
orte/include/Makefile
2122
orte/etc/Makefile
22-
23+
orte/orted/orted-mpir/Makefile
2324
orte/tools/orted/Makefile
2425
orte/tools/orterun/Makefile
2526
orte/tools/wrappers/Makefile

‎orte/Makefile.am‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
# Copyright (c) 2009-2014 Cisco Systems, Inc. All rights reserved.
1313
# Copyright (c) 2015 Los Alamos National Security, LLC. All rights
1414
# reserved.
15+
# Copyright (c) 2021 IBM Corporation. All rights reserved.
1516
# $COPYRIGHT$
1617
#
1718
# Additional copyrights may follow
@@ -24,12 +25,14 @@ SUBDIRS = \
2425
$(MCA_orte_FRAMEWORKS_SUBDIRS) \
2526
$(MCA_orte_FRAMEWORK_COMPONENT_STATIC_SUBDIRS) \
2627
etc \
28+
orted/orted-mpir \
2729
. \
2830
$(MCA_orte_FRAMEWORK_COMPONENT_DSO_SUBDIRS)
2931

3032
DIST_SUBDIRS = \
3133
include \
3234
etc \
35+
orted/orted-mpir \
3336
$(MCA_orte_FRAMEWORKS_SUBDIRS) \
3437
$(MCA_orte_FRAMEWORK_COMPONENT_ALL_SUBDIRS)
3538

@@ -39,7 +42,8 @@ lib_LTLIBRARIES = lib@ORTE_LIB_PREFIX@open-rte.la
3942
lib@ORTE_LIB_PREFIX@open_rte_la_SOURCES =
4043
lib@ORTE_LIB_PREFIX@open_rte_la_LIBADD = \
4144
$(MCA_orte_FRAMEWORK_LIBS) \
42-
$(ORTE_TOP_BUILDDIR)/opal/lib@OPAL_LIB_PREFIX@open-pal.la
45+
$(ORTE_TOP_BUILDDIR)/opal/lib@OPAL_LIB_PREFIX@open-pal.la \
46+
orted/orted-mpir/lib@ORTE_LIB_PREFIX@open-orted-mpir.la
4347
lib@ORTE_LIB_PREFIX@open_rte_la_DEPENDENCIES = $(libopen_rte_la_LIBADD)
4448
lib@ORTE_LIB_PREFIX@open_rte_la_LDFLAGS = -version-info $(libopen_rte_so_version)
4549

‎orte/orted/Makefile.am‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# All rights reserved.
1313
# Copyright (c) 2014 Cisco Systems, Inc. All rights reserved.
1414
# Copyright (c) 2015 Intel, Inc. All rights reserved.
15-
# Copyright (c) 2018 IBM Corporation. All rights reserved.
15+
# Copyright (c) 2018-2021 IBM Corporation. All rights reserved.
1616
# $COPYRIGHT$
1717
#
1818
# Additional copyrights may follow
@@ -30,17 +30,7 @@ headers += \
3030

3131
lib@ORTE_LIB_PREFIX@open_rte_la_SOURCES += \
3232
orted/orted_main.c \
33-
orted/orted_comm.c
34-
35-
# The MPIR portion of the library must be built with -g, even if
36-
# the rest of the library has other optimization flags.
37-
# Use an intermediate library to isolate the debug object.
38-
noinst_LTLIBRARIES += liborted_mpir.la
39-
liborted_mpir_la_SOURCES = \
33+
orted/orted_comm.c \
4034
orted/orted_submit.c
41-
liborted_mpir_la_CFLAGS = $(CFLAGS_WITHOUT_OPTFLAGS) $(DEBUGGER_CFLAGS)
42-
43-
lib@ORTE_LIB_PREFIX@open_rte_la_LIBADD += liborted_mpir.la
44-
4535

4636
include orted/pmix/Makefile.am

‎orte/orted/orted-mpir/Makefile.am‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# -*- makefile -*-
2+
#
3+
# Copyright (c) 2021 IBM Corporation. All rights reserved.
4+
# $COPYRIGHT$
5+
#
6+
# Additional copyrights may follow
7+
#
8+
# $HEADER$
9+
#
10+
11+
# This is not quite in the Automake spirit, but we have to do it.
12+
# Since the mpir portion of the library must be built with -g, we
13+
# must eliminate the CFLAGS that are passed in here by default (which
14+
# may already have debugging and/or optimization flags).
15+
16+
CFLAGS = $(CFLAGS_WITHOUT_OPTFLAGS) $(DEBUGGER_CFLAGS)
17+
18+
lib_LTLIBRARIES = lib@ORTE_LIB_PREFIX@open-orted-mpir.la
19+
lib@ORTE_LIB_PREFIX@open_orted_mpir_la_SOURCES = \
20+
orted_mpir_breakpoint.c \
21+
orted_mpir.h
22+
lib@ORTE_LIB_PREFIX@open_orted_mpir_la_LDFLAGS = -avoid-version

‎orte/orted/orted-mpir/orted_mpir.h‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/* Copyright (c) 2021 IBM Corporation. All rights reserved.
2+
* $COPYRIGHT$
3+
*
4+
* Additional copyrights may follow
5+
*
6+
* $HEADER$
7+
*/
8+
9+
#ifndef ORTED_MPIR_H
10+
#define ORTED_MPIR_H
11+
12+
#include "orte_config.h"
13+
14+
#include "orte/runtime/orte_globals.h"
15+
16+
BEGIN_C_DECLS
17+
18+
#define MPIR_MAX_PATH_LENGTH 512
19+
#define MPIR_MAX_ARG_LENGTH 1024
20+
21+
extern struct MPIR_PROCDESC *MPIR_proctable;
22+
extern int MPIR_proctable_size;
23+
extern volatile int MPIR_being_debugged;
24+
extern volatile int MPIR_debug_state;
25+
extern int MPIR_i_am_starter;
26+
extern int MPIR_partial_attach_ok;
27+
extern char MPIR_executable_path[MPIR_MAX_PATH_LENGTH];
28+
extern char MPIR_server_arguments[MPIR_MAX_ARG_LENGTH];
29+
extern volatile int MPIR_forward_output;
30+
extern volatile int MPIR_forward_comm;
31+
extern char MPIR_attach_fifo[MPIR_MAX_PATH_LENGTH];
32+
extern int MPIR_force_to_main;
33+
34+
ORTE_DECLSPEC void __opal_attribute_optnone__ MPIR_Breakpoint(void);
35+
36+
#endif

‎orte/orted/orted-mpir/orted_mpir_breakpoint.c‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
2+
/*
3+
* Copyright (c) 2021 IBM Corporation. All rights reserved.
4+
* $COPYRIGHT$
5+
*
6+
* Additional copyrights may follow
7+
*
8+
* $HEADER$
9+
*/
10+
11+
#include "orte_config.h"
12+
#include "orte/constants.h"
13+
#include "orted_mpir.h"
14+
15+
/* instance the standard MPIR interfaces */
16+
struct MPIR_PROCDESC *MPIR_proctable = NULL;
17+
int MPIR_proctable_size = 0;
18+
volatile int MPIR_being_debugged = 0;
19+
volatile int MPIR_debug_state = 0;
20+
int MPIR_i_am_starter = 0;
21+
int MPIR_partial_attach_ok = 1;
22+
char MPIR_executable_path[MPIR_MAX_PATH_LENGTH] = {0};
23+
char MPIR_server_arguments[MPIR_MAX_ARG_LENGTH] = {0};
24+
volatile int MPIR_forward_output = 0;
25+
volatile int MPIR_forward_comm = 0;
26+
char MPIR_attach_fifo[MPIR_MAX_PATH_LENGTH] = {0};
27+
int MPIR_force_to_main = 0;
28+
29+
/*
30+
* Attempt to prevent the compiler from optimizing out
31+
* MPIR_Breakpoint().
32+
*
33+
* Some older versions of automake can add -O3 to every
34+
* file via CFLAGS (which was demonstrated in automake v1.13.4),
35+
* so there is a possibility that the compiler will see
36+
* this function as a NOOP and optimize it out on older versions.
37+
* While using the current/recommended version of automake
38+
* does not do this, the following will help those
39+
* stuck with an older version, as well as guard against
40+
* future regressions.
41+
*
42+
* See the following git issue for more discussion:
43+
* https://github.com/open-mpi/ompi/issues/5501
44+
*/
45+
volatile void* volatile orte_noop_mpir_breakpoint_ptr = NULL;
46+
47+
/*
48+
* Breakpoint function for parallel debuggers
49+
*/
50+
void MPIR_Breakpoint(void)
51+
{
52+
/*
53+
* Actually do something with this pointer to make
54+
* sure the compiler does not optimize out this function.
55+
* The compiler should be forced to keep this
56+
* function around due to the volatile void* type.
57+
*
58+
* This pointer doesn't actually do anything other than
59+
* prevent unwanted optimization, and
60+
* *should not* be used anywhere else in the code.
61+
* So pointing this to the weeds should be OK.
62+
*/
63+
orte_noop_mpir_breakpoint_ptr = (volatile void *) 0x42;
64+
return;
65+
}

‎orte/orted/orted_submit.c‎

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
* Copyright (c) 2013-2018 Intel, Inc. All rights reserved.
1818
* Copyright (c) 2015-2018 Research Organization for Information Science
1919
* and Technology (RIST). All rights reserved.
20-
* Copyright (c) 2017 IBM Corporation. All rights reserved.
20+
* Copyright (c) 2017-2021 IBM Corporation. All rights reserved.
2121
* $COPYRIGHT$
2222
*
2323
* Additional copyrights may follow
@@ -108,6 +108,7 @@
108108
#include "orte/util/show_help.h"
109109

110110
#include "orted_submit.h"
111+
#include "orted-mpir/orted_mpir.h"
111112

112113
/**
113114
* Global struct for catching orte command line options.
@@ -156,63 +157,8 @@ static void run_debugger(char *basename, opal_cmd_line_t *cmd_line,
156157
int argc, char *argv[], int num_procs);
157158
static void print_help(void);
158159

159-
/* instance the standard MPIR interfaces */
160-
#define MPIR_MAX_PATH_LENGTH 512
161-
#define MPIR_MAX_ARG_LENGTH 1024
162-
struct MPIR_PROCDESC *MPIR_proctable = NULL;
163-
int MPIR_proctable_size = 0;
164-
volatile int MPIR_being_debugged = 0;
165-
volatile int MPIR_debug_state = 0;
166-
int MPIR_i_am_starter = 0;
167-
int MPIR_partial_attach_ok = 1;
168-
char MPIR_executable_path[MPIR_MAX_PATH_LENGTH] = {0};
169-
char MPIR_server_arguments[MPIR_MAX_ARG_LENGTH] = {0};
170-
volatile int MPIR_forward_output = 0;
171-
volatile int MPIR_forward_comm = 0;
172-
char MPIR_attach_fifo[MPIR_MAX_PATH_LENGTH] = {0};
173-
int MPIR_force_to_main = 0;
174160
static void orte_debugger_init_before_spawn(orte_job_t *jdata);
175161

176-
ORTE_DECLSPEC void __opal_attribute_optnone__ MPIR_Breakpoint(void);
177-
178-
/*
179-
* Attempt to prevent the compiler from optimizing out
180-
* MPIR_Breakpoint().
181-
*
182-
* Some older versions of automake can add -O3 to every
183-
* file via CFLAGS (which was demonstrated in automake v1.13.4),
184-
* so there is a possibility that the compiler will see
185-
* this function as a NOOP and optimize it out on older versions.
186-
* While using the current/recommended version of automake
187-
* does not do this, the following will help those
188-
* stuck with an older version, as well as guard against
189-
* future regressions.
190-
*
191-
* See the following git issue for more discussion:
192-
* https://github.com/open-mpi/ompi/issues/5501
193-
*/
194-
volatile void* volatile orte_noop_mpir_breakpoint_ptr = NULL;
195-
196-
/*
197-
* Breakpoint function for parallel debuggers
198-
*/
199-
void MPIR_Breakpoint(void)
200-
{
201-
/*
202-
* Actually do something with this pointer to make
203-
* sure the compiler does not optimize out this function.
204-
* The compiler should be forced to keep this
205-
* function around due to the volatile void* type.
206-
*
207-
* This pointer doesn't actually do anything other than
208-
* prevent unwanted optimization, and
209-
* *should not* be used anywhere else in the code.
210-
* So pointing this to the weeds should be OK.
211-
*/
212-
orte_noop_mpir_breakpoint_ptr = (volatile void *) 0x42;
213-
return;
214-
}
215-
216162
/* local objects */
217163
typedef struct {
218164
opal_object_t super;

0 commit comments

Comments
 (0)