hwloc: rename opal/mca/hwloc/hwloc.h -> hwloc-internal.h

Per a prior commit, the presence of "hwloc.h" can cause ambiguity when
using --with-hwloc=external (i.e., whether to include
opal/mca/hwloc/hwloc.h or whether to include the system-installed
hwloc.h).

This commit:

1. Renames opal/mca/hwloc/hwloc.h to hwloc-internal.h.
2. Adds opal/mca/hwloc/autogen.options to tell autogen.pl to expect to
   find hwloc-internal.h (instead of hwloc.h) in opal/mca/hwloc.
3. s@opal/mca/hwloc/hwloc.h@opal/mca/hwloc/hwloc-internal.h@g in the
   rest of the code base.

Signed-off-by: Jeff Squyres <[email protected]>

Author: jsquyres

ompi/mca/topo/treematch/topo_treematch_dist_graph_create.c

@@ -10,6 +10,7 @@
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2016      Los Alamos National Security, LLC. All rights
  *                         reserved.
+ * Copyright (c) 2017      Cisco Systems, Inc.  All rights reserved
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -20,7 +21,7 @@
 #include "ompi_config.h"
 
 #include "opal/constants.h"
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 
 #include "ompi/mca/topo/treematch/topo_treematch.h"
 #include "ompi/mca/topo/treematch/treematch/tm_mapping.h"

ompi/mca/topo/treematch/treematch/tm_hwloc.c

@@ -1,4 +1,4 @@
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 #include "tm_tree.h"
 #include "tm_mapping.h"
 #include <ctype.h>

ompi/mca/topo/treematch/treematch/tm_hwloc.h

@@ -1,4 +1,4 @@
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 #include "tm_tree.h"
 
 void hwloc_topology_tag(hwloc_topology_t topology);

ompi/mca/topo/treematch/treematch/tm_thread_pool.c

@@ -1,7 +1,7 @@
 #include <pthread.h>
 #include "tm_thread_pool.h"
 #include "tm_verbose.h"
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 #include "tm_verbose.h"
 #include "tm_tree.h"
 #include <errno.h>

ompi/mca/topo/treematch/treematch/tm_thread_pool.h

@@ -2,7 +2,7 @@
 #define THREAD_POOL_H
 
 #include <pthread.h>
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 
 
 typedef struct _work_t{

opal/mca/btl/openib/btl_openib.c

@@ -10,7 +10,7 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
- * Copyright (c) 2007-2013 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2007-2017 Cisco Systems, Inc.  All rights reserved
  * Copyright (c) 2006-2015 Mellanox Technologies. All rights reserved.
  * Copyright (c) 2006-2016 Los Alamos National Security, LLC.  All rights
  *                         reserved.
@@ -84,7 +84,7 @@
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 
 #ifndef MIN
 #define MIN(a,b) ((a)<(b)?(a):(b))

opal/mca/btl/openib/btl_openib_component.c

@@ -10,7 +10,7 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
- * Copyright (c) 2006-2016 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2006-2017 Cisco Systems, Inc.  All rights reserved
  * Copyright (c) 2006-2015 Mellanox Technologies. All rights reserved.
  * Copyright (c) 2006-2015 Los Alamos National Security, LLC.  All rights
  *                         reserved.
@@ -59,7 +59,7 @@
    know its exact path.  We have to rely on the framework header files
    to find the right hwloc verbs helper file for us. */
 #define OPAL_HWLOC_WANT_VERBS_HELPER 1
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 #include "opal/mca/hwloc/base/base.h"
 #include "opal/mca/installdirs/installdirs.h"
 #include "opal_stdint.h"

opal/mca/hwloc/Makefile.am

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011-2016 Cisco Systems, Inc.  All rights reserved.
+# Copyright (c) 2011-2017 Cisco Systems, Inc.  All rights reserved
 # Copyright (c) 2016      Research Organization for Information Science
 #                         and Technology (RIST). All rights reserved.
 # $COPYRIGHT$
@@ -9,17 +9,12 @@
 # $HEADER$
 #
 
-# We do not want -I$(srcdir) in AM_CPPFLAGS, or there can be a
-# conflict between system hwloc.h and opal/mca/hwloc/hwloc.h.  So just
-# set only what we need to AM_CPPFLAGS.
-AM_CPPFLAGS = -I$(top_builddir)/opal/include
-
 # main library setup
 noinst_LTLIBRARIES = libmca_hwloc.la
 libmca_hwloc_la_SOURCES =
 
 # local files
-headers = hwloc.h
+headers = hwloc-internal.h
 libmca_hwloc_la_SOURCES += $(headers)
 
 # Conditionally install the header files

opal/mca/hwloc/autogen.options

@@ -0,0 +1,13 @@
+# Copyright (c) 2017 Cisco Systems, Inc.  All rights reserved
+# $COPYRIGHT$
+#
+
+# Per https://github.com/open-mpi/ompi/issues/2616, we cannot have an
+# "hwloc.h" in the framework directory (due to conflicts of finding
+# the system hwloc.h file when using "--with-hwloc=external").  Hence,
+# we need to deviate from the framework norm of having
+# framework/framework.h (i.e., hwloc/hwloc.h).  Instead, we'll have
+# hwloc/hwloc-internal.h to make sure that this header file can never
+# be mistaken for a system-level hwloc.h.
+
+framework_header = hwloc-internal.h

opal/mca/hwloc/base/base.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2012 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2011-2017 Cisco Systems, Inc.  All rights reserved
  * Copyright (c) 2013-2017 Intel, Inc.  All rights reserved.
  * $COPYRIGHT$
  *
@@ -15,7 +15,7 @@
 
 #include "opal/dss/dss_types.h"
 
-#include "opal/mca/hwloc/hwloc.h"
+#include "opal/mca/hwloc/hwloc-internal.h"
 
 /*
  * Global functions for MCA overall hwloc open and close
@@ -88,7 +88,7 @@ OPAL_DECLSPEC int opal_hwloc_base_set_binding_policy(opal_binding_policy_t *poli
 
 /**
  * Loads opal_hwloc_my_cpuset (global variable in
- * opal/mca/hwloc/hwloc.h) for this process.  opal_hwloc_my_cpuset
+ * opal/mca/hwloc/hwloc-internal.h) for this process.  opal_hwloc_my_cpuset
  * will be loaded with this process' binding, or, if the process is
  * not bound, use the hwloc root object's (available and online)
  * cpuset.