Skip to content

Commit f4796a8

Browse files
bwbarrettbwbarrett
committed
Improve pkg-config wrapper compiler handling
Rewrite the pkg-config code to split LDFLAGS and LIBS detection as well as to return the flags in an environment variable instead of updating the wrapper compiler flags directly. The split keeps us from adding -L flags to LIBS (as we had been doing) and the environment variable means that we can consider using pkg-config in OPAL_CHECK_PACKAGE, since some of our dependencies (PMIX) are getting more complicated over time and our package checks will struggle to keep up. Rewrite the wrapper compiler code in the hwloc, libevent, and pmix checks to handle the new pkg-config interface. Signed-off-by: Brian Barrett <bbarrett@amazon.com>
1 parent 9e158e1 commit f4796a8

File tree

4 files changed

+140
-119
lines changed

4 files changed

+140
-119
lines changed

‎config/opal_check_pc.m4‎

Lines changed: 44 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
dnl -*- shell-script -*-
1+
dnl -*- autoconf -*-
22
dnl
33
dnl Copyright (c) 2021 IBM Corporation. All rights reserved.
4-
dnl
4+
dnl Copyright (c) 2021 Amazon.com, Inc. or its affiliates. All Rights
5+
dnl reserved.
56
dnl $COPYRIGHT$
67
dnl
78
dnl Additional copyrights may follow
@@ -10,96 +11,62 @@ dnl $HEADER$
1011
dnl
1112

1213

13-
dnl OPAL_CHECK_PKG_CONFIG
14+
dnl OPAL_CHECK_PKG_CONFIG()
15+
dnl
1416
dnl Check for availability of pkg-config and store the result.
1517
dnl If it is not available, store any passed in libs from the
1618
dnl --with-extra-libs configure option, or the known defaults.
1719
dnl
1820
dnl If it is available, allow configury to check for .pc files
1921
dnl and append to OPAL_WRAPPER_EXTRA_LIBS.
2022
AC_DEFUN([OPAL_CHECK_PKG_CONFIG], [
21-
AS_IF([test -z "$OPAL_HAS_PKG_CONFIG"],
22-
[
23-
AC_MSG_CHECKING([If pkg-config is available])
24-
which pkg-config > /dev/null 2>&1
25-
AS_IF([test "$?" -eq "0"],
26-
[
27-
AC_MSG_RESULT([yes])
28-
OPAL_HAS_PKG_CONFIG="yes"
29-
],
30-
[
31-
AC_MSG_RESULT([no])
32-
OPAL_HAS_PKG_CONFIG="no"
33-
OPAL_FLAGS_APPEND_UNIQ([OPAL_WRAPPER_EXTRA_LIBS], [$OPAL_EXTRA_LIBS])
34-
]
35-
)
36-
]
37-
)
23+
AC_CHECK_PROG([PKG_CONFIG], [pkg-config], [pkg-config])
3824
])
3925

40-
dnl OPAL_GET_LFLAGS_FROM_PC
41-
dnl Get the -l flags using pkg-config on the passed in .pc file, and
42-
dnl append them to OPAL_WRAPPER_EXTRA_LIBS.
43-
dnl
44-
dnl Requires 1 or more arguments.
45-
dnl
46-
dnl Arg 1 (Required): the name of the .pc file to look for (hwloc/pmix/libevent_core).pc
47-
dnl
48-
dnl Arg 2..n (Optional): The search path for the .pc file above and any dependencies.
49-
dnl These search will be appended and set in the env variable
50-
dnl PKG_CONFIG_PATH to tell pkg-config where to locate the .pc
51-
dnl file from argument 1, and its dependencies.
52-
dnl
53-
AC_DEFUN([OPAL_GET_LFLAGS_FROM_PC], [
26+
dnl OPAL_GET_LDFLAGS_FROM_PC(library name, variable-to-set-if-found,
27+
dnl action-if-not-found)
28+
AC_DEFUN([OPAL_GET_LDFLAGS_FROM_PC], [
29+
OPAL_VAR_SCOPE_PUSH([pkg_config_results happy])
5430
5531
AC_REQUIRE([OPAL_CHECK_PKG_CONFIG])
56-
AS_IF([test "$OPAL_HAS_PKG_CONFIG" = "yes"],
57-
[
58-
AC_MSG_NOTICE([Looking for pc file for $1])
59-
OPAL_VAR_SCOPE_PUSH([opal_pkg_config_name opal_pkg_config_env_to_set opal_pkg_config_args opal_pkg_config_cmd opal_pkg_config_result])
60-
opal_pkg_config_name=$1
61-
opal_pkg_config_env_to_set=""
62-
opal_pkg_config_cmd=""
6332
64-
AS_LITERAL_WORD_IF([$1], [], [m4_fatal([Non-literal argument $1])], [])
65-
$1_OMPI_PC_DIR=""
33+
AC_MSG_CHECKING([for ldflags from pkg-config file $1])
34+
35+
happy=1
36+
AS_IF([test "$PKG_CONFIG" = ""],
37+
[happy=0],
38+
[OPAL_LOG_COMMAND([pkg_config_results=`$PKG_CONFIG --static --libs-only-L --libs-only-other $1`],
39+
[AS_VAR_COPY([$2], [pkg_config_results])],
40+
[happy=0])])
41+
AS_IF([test $happy -eq 0],
42+
[pkg_config_results="none"
43+
$3])
6644
67-
# Tell pkg-config where to find the .pc file from argument 1
68-
# as well as any/all dependencies.
69-
# The following block will append the path
70-
# to those .pc files into the pkg-config command.
71-
# num_paths > 1 implies there is at least one dependent .pc file
72-
# to append.
73-
AS_IF([test $# -gt 1],
74-
[
75-
$1_OMPI_PC_DIR=$2
45+
AC_MSG_RESULT([$pkg_config_results])
46+
47+
OPAL_VAR_SCOPE_POP
48+
])
49+
50+
dnl OPAL_GET_LIBS_FROM_PC(library name, variable-to-set-if-found,
51+
dnl action-if-not-found)
52+
AC_DEFUN([OPAL_GET_LIBS_FROM_PC], [
53+
OPAL_VAR_SCOPE_PUSH([pkg_config_results happy])
54+
55+
AC_REQUIRE([OPAL_CHECK_PKG_CONFIG])
7656
77-
# Shift the arguments by one to get to the actual paths.
78-
opal_pkg_config_args=m4_shift($@)
57+
AC_MSG_CHECKING([for libs from pkg-config file $1])
7958
80-
# Iterate over the comma seperated arguments, and replace the ','
81-
for i in $(echo $opal_pkg_config_args | sed "s/,/ /g"); do
82-
opal_pkg_config_env_to_set="$i:${opal_pkg_config_env_to_set}"
83-
done
84-
opal_pkg_config_cmd="env PKG_CONFIG_PATH=$opal_pkg_config_env_to_set pkg-config --libs $opal_pkg_config_name"
85-
],
86-
[opal_pkg_config_cmd="pkg-config --libs $opal_pkg_config_name"]
87-
)
59+
happy=1
60+
AS_IF([test "$PKG_CONFIG" = ""],
61+
[happy=0],
62+
[OPAL_LOG_COMMAND([pkg_config_results=`$PKG_CONFIG --libs-only-l $1`],
63+
[AS_VAR_COPY([$2], [pkg_config_results])],
64+
[happy=0])])
65+
AS_IF([test $happy -eq 0],
66+
[pkg_config_results="none"
67+
$3])
8868
89-
OPAL_LOG_MSG([pkg-config cmd for $opal_pkg_config_name: $opal_pkg_config_cmd])
69+
AC_MSG_RESULT([$pkg_config_results])
9070
91-
opal_pkg_config_result=$($opal_pkg_config_cmd)
92-
AS_IF([test -z "$opal_pkg_config_result"],
93-
[
94-
AC_MSG_WARN([Could not find viable $opal_pkg_config_name.pc])
95-
],
96-
[
97-
AC_MSG_NOTICE([pkg-config result $opal_pkg_config_result])
98-
OPAL_FLAGS_APPEND_UNIQ([OPAL_WRAPPER_EXTRA_LIBS], [$opal_pkg_config_result])
99-
]
100-
)
101-
OPAL_VAR_SCOPE_POP
102-
],
103-
[]
104-
)
71+
OPAL_VAR_SCOPE_POP
10572
])

‎config/opal_config_hwloc.m4‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ dnl
33
dnl Copyright (c) 2009-2017 Cisco Systems, Inc. All rights reserved
44
dnl Copyright (c) 2014-2018 Research Organization for Information Science
55
dnl and Technology (RIST). All rights reserved.
6-
dnl Copyright (c) 2020 Amazon.com, Inc. or its affiliates. All Rights
6+
dnl Copyright (c) 2020-2021 Amazon.com, Inc. or its affiliates. All Rights
77
dnl reserved.
88
dnl Copyright (c) 2020 Intel, Inc. All rights reserved.
99
dnl $COPYRIGHT$
@@ -39,10 +39,16 @@ dnl uses Hwloc. Cannot be added to LIBS yet, because then
3939
dnl other execution tests later in configure (there are sadly
4040
dnl some) would fail if the path in LDFLAGS was not added to
4141
dnl LD_LIBRARY_PATH.
42+
dnl * opal_hwloc_WRAPPER_LDFLAGS - the linker flags necessary to
43+
dnl add to the wrapper compilers in order to link an opal
44+
dnl application when opal is built as a static library.
45+
dnl * opal_hwloc_WRAPPER_LIBS - the linker flags necessary to
46+
dnl add to the wrapper compilers in order to link an opal
47+
dnl application when opal is built as a static library.
4248
dnl * CPPFLAGS, LDFLAGS - Updated opal_hwloc_CPPFLAGS and
4349
dnl opal_hwloc_LDFLAGS.
4450
AC_DEFUN([OPAL_CONFIG_HWLOC], [
45-
OPAL_VAR_SCOPE_PUSH([external_hwloc_happy internal_hwloc_happy])
51+
OPAL_VAR_SCOPE_PUSH([external_hwloc_happy internal_hwloc_happy pkg_config_file pkg_config_happy pkg_config_ldflags pkg_config_libs])
4652
4753
opal_show_subtitle "Configuring hwloc"
4854
@@ -70,13 +76,27 @@ AC_DEFUN([OPAL_CONFIG_HWLOC], [
7076
AS_IF([test "$external_hwloc_happy" = "0" -a "$internal_hwloc_happy" = "0"],
7177
[AC_MSG_ERROR([Could not find viable hwloc build.])])
7278
73-
AS_IF([test "$opal_hwloc_mode" = "external"],
74-
[AS_IF([test -n "$with_hwloc"],
75-
[OPAL_GET_LFLAGS_FROM_PC(hwloc, $with_hwloc/lib/pkgconfig)],
76-
[OPAL_GET_LFLAGS_FROM_PC(hwloc)]
77-
)],
78-
[OPAL_GET_LFLAGS_FROM_PC(hwloc, $OMPI_TOP_SRCDIR/3rd-party/hwloc_directory)]
79-
)
79+
AS_IF([test "$opal_hwloc_mode" = "internal"],
80+
[pkg_config_file="${OMPI_TOP_BUILDDIR}/3rd-party/hwloc_directory/hwloc.pc"
81+
PKG_CONFIG_PATH="${OMPI_TOP_BUILDDIR}/3rd-party/hwloc_directory:${PKG_CONFIG_PATH}"],
82+
[test -n "$with_hwloc"],
83+
[pkg_config_file="${with_hwloc}/lib/pkgconfig/hwloc.pc"
84+
PKG_CONFIG_PATH="${with_hwloc}/lib/pkgconfig:${PKG_CONFIG_PATH}"],
85+
[pkg_config_file="hwloc"])
86+
87+
pkg_config_happy=1
88+
OPAL_GET_LDFLAGS_FROM_PC([$pkg_config_file], [pkg_config_ldflags], [pkg_config_happy=0])
89+
OPAL_GET_LIBS_FROM_PC([$pkg_config_file], [pkg_config_libs], [pkg_config_happy=0])
90+
91+
AS_IF([test $pkg_config_happy -ne 0],
92+
[opal_hwloc_WRAPPER_LDFLAGS="$pkg_config_ldflags"
93+
opal_hwloc_WRAPPER_LIBS="$pkg_config_libs"],
94+
[# guess that what we have from compiling OMPI is good enough
95+
opal_hwloc_WRAPPER_LDFLAGS="$opal_hwloc_LDFLAGS"
96+
opal_hwloc_WRAPPER_LIBS="$opal_hwloc_LIBS"])
97+
98+
OPAL_WRAPPER_FLAGS_ADD([LDFLAGS], [$opal_hwloc_WRAPPER_LDFLAGS])
99+
OPAL_WRAPPER_FLAGS_ADD([LIBS], [$opal_hwloc_WRAPPER_LIBS])
80100
81101
# this will work even if there is no hwloc package included,
82102
# because hwloc_tarball and hwloc_directory will evaluate to an

‎config/opal_config_libevent.m4‎

Lines changed: 40 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ dnl Copyright (c) 2009-2018 Cisco Systems, Inc. All rights reserved
44
dnl Copyright (c) 2013 Los Alamos National Security, LLC. All rights reserved.
55
dnl Copyright (c) 2015-2018 Research Organization for Information Science
66
dnl and Technology (RIST). All rights reserved.
7-
dnl Copyright (c) 2020 Amazon.com, Inc. or its affiliates. All Rights
7+
dnl Copyright (c) 2020-2021 Amazon.com, Inc. or its affiliates. All Rights
88
dnl reserved.
99
dnl $COPYRIGHT$
1010
dnl
@@ -39,10 +39,16 @@ dnl uses Libevent. Cannot be added to LIBS yet, because then
3939
dnl other execution tests later in configure (there are sadly
4040
dnl some) would fail if the path in LDFLAGS was not added to
4141
dnl LD_LIBRARY_PATH.
42+
dnl * opal_libevent_WRAPPER_LDFLAGS - the linker flags necessary to
43+
dnl add to the wrapper compilers in order to link an opal
44+
dnl application when opal is built as a static library.
45+
dnl * opal_libevent_WRAPPER_LIBS - the linker flags necessary to
46+
dnl add to the wrapper compilers in order to link an opal
47+
dnl application when opal is built as a static library.
4248
dnl * CPPFLAGS, LDFLAGS - Updated opal_libevent_CPPFLAGS and
4349
dnl opal_libevent_LDFLAGS.
4450
AC_DEFUN([OPAL_CONFIG_LIBEVENT], [
45-
OPAL_VAR_SCOPE_PUSH([internal_libevent_happy external_libevent_happy])
51+
OPAL_VAR_SCOPE_PUSH([internal_libevent_happy external_libevent_happy pkg_config_core pkg_config_pthreads pkg_config_core_ldflags pkg_config_pthreads_ldflags pkg_config_core_libs pkg_config_pthreads_libs pkg_config_happy])
4652
4753
opal_show_subtitle "Configuring Libevent"
4854
@@ -70,30 +76,38 @@ AC_DEFUN([OPAL_CONFIG_LIBEVENT], [
7076
AS_IF([test "$external_libevent_happy" = "0" -a "$internal_libevent_happy" = "0"],
7177
[AC_MSG_ERROR([Could not find viable libevent build.])])
7278
73-
AS_IF([test "$opal_libevent_mode" = "external"],
74-
# The libevent.pc file only returns -levent, however we want
75-
# only -libevent_core and -libevent_pthreads, so ompi needs to
76-
# do this twice, once for each.
77-
[AS_IF([test -n "$with_libevent"],
78-
[
79-
OPAL_GET_LFLAGS_FROM_PC(libevent_core, $with_libevent/lib/pkgconfig)
80-
OPAL_GET_LFLAGS_FROM_PC(libevent_pthreads, $with_libevent/lib/pkgconfig)
81-
],
82-
[
83-
OPAL_GET_LFLAGS_FROM_PC(libevent_core)
84-
OPAL_GET_LFLAGS_FROM_PC(libevent_pthreads)
85-
]
86-
)],
87-
[
88-
OPAL_GET_LFLAGS_FROM_PC(libevent_core, $OMPI_TOP_SRCDIR/3rd-party/libevent_directory)
89-
OPAL_GET_LFLAGS_FROM_PC(libevent_pthreads, $OMPI_TOP_SRCDIR/3rd-party/libevent_directory)
90-
]
91-
)
92-
93-
# Strip -levent as we don't want it. We only want -levent_core/-levent_pthreads.
94-
# See https://github.com/open-mpi/ompi/pull/8792
95-
OPAL_WRAPPER_EXTRA_LIBS=$(echo $OPAL_WRAPPER_EXTRA_LIBS | sed "s/\\-levent\b//g");
96-
AC_MSG_NOTICE([OPAL_WRAPPER_EXTRA_LIBS stripped -levent: $OPAL_WRAPPER_EXTRA_LIBS])
79+
AS_IF([test "$opal_libevent_mode" = "internal"],
80+
[pkg_config_core="${OMPI_TOP_BUILDDIR}/3rd-party/libevent_directory/libevent_core.pc"
81+
pkg_config_pthreads="${OMPI_TOP_BUILDDIR}/3rd-party/libevent_directory/libevent_pthreads.pc"
82+
PKG_CONFIG_PATH="${OMPI_TOP_BUILDDIR}/3rd-party/libevent_directory:${PKG_CONFIG_PATH}"],
83+
[test -n "$with_libevent"],
84+
[pkg_config_core="${with_libevent}/lib/pkgconfig/libevent_core.pc"
85+
pkg_config_pthreads="${with_libevent}/lib/pkgconfig/libevent_pthreads.pc"
86+
PKG_CONFIG_PATH="${with_libevent}/lib/pkgconfig:${PKG_CONFIG_PATH}"],
87+
[pkg_config_core="libevent_core"
88+
pkg_config_pthreads="libevent_pthreads"])
89+
90+
pkg_config_happy=1
91+
OPAL_GET_LDFLAGS_FROM_PC([$pkg_config_core], [pkg_config_core_ldflags], [pkg_config_happy=0])
92+
OPAL_GET_LDFLAGS_FROM_PC([$pkg_config_pthreads], [pkg_config_pthreads_ldflags], [pkg_config_happy=0])
93+
OPAL_GET_LIBS_FROM_PC([$pkg_config_core], [pkg_config_core_libs], [pkg_config_happy=0])
94+
OPAL_GET_LIBS_FROM_PC([$pkg_config_pthreads], [pkg_config_pthreads_libs], [pkg_config_happy=0])
95+
96+
AS_IF([test $pkg_config_happy -ne 0],
97+
[# Strip -levent from pkg_config_pthreads_libs, since we
98+
# only want to link against libevent_core. We'll pick up
99+
# the core library from pkg_config_core_libs.
100+
pkg_config_pthreads_libs=`echo $pkg_config_pthreads_libs | sed "s/\\-levent\b//g"`
101+
opal_libevent_WRAPPER_LDFLAGS="$pkg_config_core_ldflags"
102+
OPAL_FLAGS_APPEND_UNIQ([opal_libevent_WRAPPER_LDFLAGS], [$pkg_config_pthreads_ldflags])
103+
opal_libevent_WRAPPER_LIBS="$pkg_config_pthreads_libs"
104+
OPAL_FLAGS_APPEND_UNIQ([opal_libevent_WRAPPER_LIBS], [$pkg_config_core_libs])],
105+
[# guess that what we have from compiling OMPI is good enough
106+
opal_libevent_WRAPPER_LDFLAGS="$opal_libevent_LDFLAGS"
107+
opal_libevent_WRAPPER_LIBS="$opal_libevent_LIBS"])
108+
109+
OPAL_WRAPPER_FLAGS_ADD([LDFLAGS], [$opal_libevent_WRAPPER_LDFLAGS])
110+
OPAL_WRAPPER_FLAGS_ADD([LIBS], [$opal_libevent_WRAPPER_LIBS])
97111
98112
# this will work even if there is no libevent package included,
99113
# because libevent_tarball and libevent_directory will evaluate to

‎config/opal_config_pmix.m4‎

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ dnl uses PMIx. Cannot be added to LIBS yet, because then
5555
dnl other execution tests later in configure (there are sadly
5656
dnl some) would fail if the path in LDFLAGS was not added to
5757
dnl LD_LIBRARY_PATH.
58+
dnl * opal_pmix_WRAPPER_LDFLAGS - the linker flags necessary to
59+
dnl add to the wrapper compilers in order to link an opal
60+
dnl application when opal is built as a static library.
61+
dnl * opal_pmix_WRAPPER_LIBS - the linker flags necessary to
62+
dnl add to the wrapper compilers in order to link an opal
63+
dnl application when opal is built as a static library.
5864
dnl * CPPFLAGS, LDFLAGS - Updated opal_pmix_CPPFLAGS and
5965
dnl opal_pmix_LDFLAGS.
6066
AC_DEFUN([OPAL_CONFIG_PMIX], [
@@ -142,13 +148,27 @@ AC_DEFUN([OPAL_CONFIG_PMIX], [
142148
AS_IF([test "$external_pmix_happy" = "0" -a "$internal_pmix_happy" = "0"],
143149
[AC_MSG_ERROR([Could not find viable pmix build.])])
144150
145-
AS_IF([test "$external_pmix_happy" = "1"],
146-
[AS_IF([test -n "$with_pmix"],
147-
[OPAL_GET_LFLAGS_FROM_PC(pmix, $with_pmix/lib/pkgconfig, $libevent_core_OMPI_PC_DIR, $hwloc_OMPI_PC_DIR)],
148-
[OPAL_GET_LFLAGS_FROM_PC(pmix, "", $libevent_core_OMPI_PC_DIR, $hwloc_OMPI_PC_DIR)]
149-
)],
150-
[OPAL_GET_LFLAGS_FROM_PC(pmix, $OMPI_TOP_SRCDIR/3rd-party/openpmix/maint, $libevent_core_OMPI_PC_DIR, $hwloc_OMPI_PC_DIR)]
151-
)
151+
AS_IF([test "$opal_pmix_mode" = "internal"],
152+
[pkg_config_file="${OMPI_TOP_BUILDDIR}/3rd-party/openpmix/maint/pmix.pc"
153+
PKG_CONFIG_PATH="${OMPI_TOP_BUILDDIR}/3rd-party/openpmix/maint:${PKG_CONFIG_PATH}"],
154+
[test -n "$with_hwloc"],
155+
[pkg_config_file="${with_pmix}/lib/pkgconfig/pmix.pc"
156+
PKG_CONFIG_PATH="${with_pmix}/lib/pkgconfig:${PKG_CONFIG_PATH}"],
157+
[pkg_config_file="pmix"])
158+
159+
pkg_config_happy=1
160+
OPAL_GET_LDFLAGS_FROM_PC([$pkg_config_file], [pkg_config_ldflags], [pkg_config_happy=0])
161+
OPAL_GET_LIBS_FROM_PC([$pkg_config_file], [pkg_config_libs], [pkg_config_happy=0])
162+
163+
AS_IF([test $pkg_config_happy -ne 0],
164+
[opal_pmix_WRAPPER_LDFLAGS="$pkg_config_ldflags"
165+
opal_pmix_WRAPPER_LIBS="$pkg_config_libs"],
166+
[# guess that what we have from compiling OMPI is good enough
167+
opal_pmix_WRAPPER_LDFLAGS="$opal_hwloc_LDFLAGS"
168+
opal_pmix_WRAPPER_LIBS="$opal_hwloc_LIBS"])
169+
170+
OPAL_WRAPPER_FLAGS_ADD([LDFLAGS], [$opal_pmix_WRAPPER_LDFLAGS])
171+
OPAL_WRAPPER_FLAGS_ADD([LIBS], [$opal_pmix_WRAPPER_LIBS])
152172
153173
AC_DEFINE_UNQUOTED([OPAL_USING_INTERNAL_PMIX],
154174
[$OPAL_USING_INTERNAL_PMIX],

0 commit comments

Comments
 (0)