Support shared library in system path. (#6362)

doc/build.rst

@@ -320,6 +320,26 @@ is a simple bash script does that:
   cd ../python-package
   pip install -e .  # or equivalently python setup.py develop
 
+3. Use ``libxgboost.so`` on system path.
+
+This is for distributing xgboost in a language independent manner, where ``libxgboost.so``
+is separately packaged with Python package.  Assuming `libxgboost.so` is already presented
+in system library path, which can be queried via:
+
+.. code-block:: python
+
+  import sys
+  import os
+  os.path.join(sys.prefix, 'lib')
+
+Then one only needs to provide an user option when installing Python package to reuse the
+shared object in system path:
+
+.. code-block:: bash
+
+  cd xgboost/python-package
+  python setup.py install --use-system-libxgboost
+
 .. _mingw_python:
 
 Building XGBoost library for Python for Windows with MinGW-w64 (Advanced)

python-package/setup.py

@@ -17,6 +17,7 @@
 # Options only effect `python setup.py install`, building `bdist_wheel`
 # requires using CMake directly.
 USER_OPTIONS = {
+    # libxgboost options.
     'use-openmp': (None, 'Build with OpenMP support.', 1),
     'use-cuda':   (None, 'Build with GPU acceleration.', 0),
     'use-nccl':   (None, 'Build with NCCL to enable distributed GPU support.', 0),
@@ -26,7 +27,9 @@
     'use-azure':  (None, 'Build with AZURE support.', 0),
     'use-s3':     (None, 'Build with S3 support', 0),
     'plugin-lz4': (None, 'Build lz4 plugin.', 0),
-    'plugin-dense-parser': (None, 'Build dense parser plugin.', 0)
+    'plugin-dense-parser': (None, 'Build dense parser plugin.', 0),
+    # Python specific
+    'use-system-libxgboost': (None, 'Use libxgboost.so in system path.', 0)
 }
 
 NEED_CLEAN_TREE = set()
@@ -103,6 +106,8 @@ def build(self, src_dir, build_dir, generator, build_tool=None, use_omp=1):
             arg = k.replace('-', '_').upper()
             value = str(v[2])
             cmake_cmd.append('-D' + arg + '=' + value)
+            if k == 'USE-SYSTEM-LIBXGBOOST':
+                continue
             if k == 'USE_OPENMP' and use_omp == 0:
                 continue
 
@@ -119,6 +124,10 @@ def build(self, src_dir, build_dir, generator, build_tool=None, use_omp=1):
 
     def build_cmake_extension(self):
         '''Configure and build using CMake'''
+        if USER_OPTIONS['use-system-libxgboost'][2]:
+            self.logger.info('Using system libxgboost.')
+            return
+
         src_dir = 'xgboost'
         try:
             copy_tree(os.path.join(CURRENT_DIR, os.path.pardir),
@@ -205,6 +214,15 @@ class InstallLib(install_lib.install_lib):
 
     def install(self):
         outfiles = super().install()
+
+        if USER_OPTIONS['use-system-libxgboost'][2] != 0:
+            self.logger.info('Using system libxgboost.')
+            lib_path = os.path.join(sys.prefix, 'lib')
+            msg = 'use-system-libxgboost is specified, but ' + lib_name() + \
+                ' is not found in: ' + lib_path
+            assert os.path.exists(os.path.join(lib_path, lib_name())), msg
+            return []
+
         lib_dir = os.path.join(self.install_dir, 'xgboost', 'lib')
         if not os.path.exists(lib_dir):
             os.mkdir(lib_dir)
@@ -251,7 +269,12 @@ def initialize_options(self):
         self.plugin_lz4 = 0
         self.plugin_dense_parser = 0
 
+        self.use_system_libxgboost = 0
+
     def run(self):
+        # setuptools will configure the options according to user supplied command line
+        # arguments, then here we propagate them into `USER_OPTIONS` for visibility to
+        # other sub-commands like `build_ext`.
         for k, v in USER_OPTIONS.items():
             arg = k.replace('-', '_')
             if hasattr(self, arg):

python-package/xgboost/libpath.py

@@ -24,7 +24,11 @@ def find_lib_path():
         os.path.join(curr_path, 'lib'),
         # editable installation, no copying is performed.
         os.path.join(curr_path, os.path.pardir, os.path.pardir, 'lib'),
+        # use libxgboost from a system prefix, if available.  This should be the last
+        # option.
+        os.path.join(sys.prefix, 'lib'),
     ]
+
     if sys.platform == 'win32':
         if platform.architecture()[0] == '64bit':
             dll_path.append(