Merge pull request open-mpi#939 from jsquyres/pr/v2.0.0/dont-build-verbs-usnic-by-default

v2.x: verbs_usnic: do not build by default

Author: jsquyres

README

@@ -8,7 +8,7 @@ Copyright (c) 2004-2008 High Performance Computing Center Stuttgart,
                         University of Stuttgart.  All rights reserved.
 Copyright (c) 2004-2007 The Regents of the University of California.
                         All rights reserved.
-Copyright (c) 2006-2015 Cisco Systems, Inc.  All rights reserved.
+Copyright (c) 2006-2016 Cisco Systems, Inc.  All rights reserved.
 Copyright (c) 2006-2011 Mellanox Technologies. All rights reserved.
 Copyright (c) 2006-2012 Oracle and/or its affiliates.  All rights reserved.
 Copyright (c) 2007      Myricom, Inc.  All rights reserved.
@@ -947,6 +947,17 @@ NETWORKING SUPPORT / OPTIONS
   which covers most cases.  This option is only needed for special
   configurations.
 
+--with-verbs-usnic
+  This option will activate support in Open MPI for disabling a
+  dire-sounding warning message from libibverbs that Cisco usNIC
+  devices are not supported (because Cisco usNIC devices are supported
+  through libfabric, not libibverbs).  This libibverbs warning can
+  also be suppressed by installing the "no op" libusnic_verbs plugin
+  for libibverbs (see https://github.com/cisco/libusnic_verbs, or
+  download binaries from cisco.com).  This option is disabled by
+  default because it causes libopen-pal.so to depend on libibverbs.so,
+  which is undesirable to many downstream packagers.
+
 --with-usnic
   Abort configure if Cisco usNIC support cannot be built.
 

opal/mca/common/verbs/common_verbs_basics.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2015 Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2012-2016 Cisco Systems, Inc.  All rights reserved.
  *
  * $COPYRIGHT$
  *
@@ -21,7 +21,9 @@
 #include <unistd.h>
 #endif
 
+#if OPAL_COMMON_VERBS_USNIC_HAPPY
 #include "opal/mca/common/verbs_usnic/common_verbs_usnic.h"
+#endif
 
 /* This is crummy, but <infiniband/driver.h> doesn't work on all
    platforms with all compilers.  Specifically, trying to include it
@@ -91,12 +93,14 @@ int opal_common_verbs_fork_test(void)
     }
 #endif
 
+#if OPAL_COMMON_VERBS_USNIC_HAPPY
     /* Now register any necessary fake libibverbs drivers.  We
        piggyback loading these fake drivers on the fork test because
        they must be loaded before ibv_get_device_list() is invoked.
        Note that this routine is in a different common component (see
        comments over there for an explanation why).  */
     opal_common_verbs_usnic_register_fake_drivers();
+#endif
 
     return ret;
 }

opal/mca/common/verbs_usnic/configure.m4

@@ -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-2015 Cisco Systems, Inc.  All rights reserved.
+# Copyright (c) 2007-2016 Cisco Systems, Inc.  All rights reserved.
 # Copyright (c) 2009-2012 Mellanox Technologies.  All rights reserved.
 # Copyright (c) 2009-2012 Oak Ridge National Laboratory.  All rights reserved.
 # $COPYRIGHT$
@@ -20,6 +20,22 @@
 # $HEADER$
 #
 
+#
+# This component is a workaround to a bug in libibverbs that prints a
+# dire warning that usNIC devices are not supported (of course not --
+# usNIC devices provide functionality through libfabric, not
+# libibverbs).  This component was written before a better workaround
+# was created: a "no op" libibverbs plugin for usNIC devices
+# (https://github.com/cisco/libusnic_verbs, and is also available in
+# binary form on cisco.com).
+#
+# Hence, this component no longer builds by default.  It's still
+# available if a user specifically asks for it (e.g., if they do not
+# want to install the "no op" libibverbs plugin), but it's not the
+# default.  This component also has the side-effect of making
+# libopen-pal.so depend on libibverbs.so, which can be annoying for
+# packagers (which is another reason it isn't built by default any
+# more).
 #
 # This component must be linked statically into libopen-pal because it
 # registers a provider for libibverbs at run time, and there's no
@@ -38,12 +54,26 @@ AC_DEFUN([MCA_opal_common_verbs_usnic_COMPILE_MODE], [
 # ------------------------------------------------
 AC_DEFUN([MCA_opal_common_verbs_usnic_CONFIG],[
     AC_CONFIG_FILES([opal/mca/common/verbs_usnic/Makefile])
-    common_verbs_usnic_happy="no"
+    common_verbs_usnic_happy=0
+
+    AC_ARG_WITH(verbs-usnic,
+                AC_HELP_STRING([--with-verbs-usnic],
+                               [Add support in Open MPI to defeat a seemingly dire warning message from libibverbs that Cisco usNIC devices are not supported.  This support is not compiled by default because you can also avoid this libibverbs bug by installing the libibverbs_usnic "no no" plugin, available from https://github.com/cisco/libusnic_verbs or in binary form from cisco.com]))
+
+    AS_IF([test "$with_verbs_usnic" = "yes"],
+          [common_verbs_usnic_happy=1])
+
+    AS_IF([test $common_verbs_usnic_happy -eq 1],
+          [OPAL_CHECK_OPENFABRICS([common_verbs_usnic],
+                                  [common_verbs_usnic_happy=1],
+                                  [common_verbs_usnic_happy=0])
+          ])
 
-    OPAL_CHECK_OPENFABRICS([common_verbs_usnic],
-                           [common_verbs_usnic_happy="yes"])
+    AC_DEFINE_UNQUOTED([OPAL_COMMON_VERBS_USNIC_HAPPY],
+                       [$common_verbs_usnic_happy],
+                       [Whether the common/usnic_verbs component is being built or not])
 
-    AS_IF([test "$common_verbs_usnic_happy" = "yes"],
+    AS_IF([test $common_verbs_usnic_happy -eq 1],
           [$1],
           [$2])