Update documentation and prep for a release canidate

Author: mplegendre

CHANGELOG

@@ -1,3 +1,11 @@
+Spindle 0.13
+-----------
+  - Fix handling of ORIGIN when it appears in .so libraries.
+  - Can now wrap IBM's jsrun (and the LLNL alias lrun) with spindle.
+  - New SLURM plugin for launching spindle with "srun --spindle ..."
+  - New spindle launch mode that starts up daemons via an rsh/ssh tree
+  - New interfaces in spindle_launch for easier RM integration.
+
 Spindle 0.12
 -----------
   - Fixes for handling libraries with aliases, such as the same library loaded twice under two different symlink paths

COPYRIGHT

@@ -1,11 +1,11 @@
 Spindle is co-developed by Lawrence Livermore National Security and 
 Juelich Supercomputing Center.  The following copyrights apply:
 
-Copyright (c) 2014, Lawrence Livermore National Security, LLC. Produced at
+Copyright (c) 2020, Lawrence Livermore National Security, LLC. Produced at
 the Lawrence Livermore National Laboratory. Written by Matthew LeGendre 
 'legendre1 at llnl dot gov'. CODE-636292. All rights reserved.
 
-Copyright (c) 2014, Juelich Supercomputing Center.  Written by Wolfgang Frings
+Copyright (c) 2020, Juelich Supercomputing Center.  Written by Wolfgang Frings
 'W.Frings at fz-juelich dot de'. All rights reserved.
 
 

INSTALL

@@ -101,8 +101,27 @@ run 'configure --help' to see them all.
 
 3) Specify a start-up mechanism that works on your cluster
 
-Spindle prefers to use LaunchMON
-(http://sourceforge.net/projects/launchmon) to start its daemons, but
+If you're integrating Spindle with SLURM, then you can use Spindle's slurm
+wrappers, and optionally use Spindle's slurm plugin.  The wrappers can be
+enabled by --with-rm=slurm.  These let you run spindle on slurm by invoking
+"spindle srun ...".  But you have to get a SLURM allocation before running 
+spindle/srun.  You can also build a SLURM plugin by adding the 
+--enable-slurm-plugin option to configure.  By putting the resulting plugin
+file libspindleslurm.so into SLURM's plugstack.conf, you can run Spindle 
+with "srun --spindle ...".  This mode does not nead an allocation already
+setup when you invoke srun (but it doesn't hurt to have one).  The ideal 
+launch mode would be to enable both.
+
+If you're integrating Spindle with IBM's LSF, then you can use IBM's built-in
+LSF integration, or you can enable Spindle's jsrun/lrun wrappers.  See IBM's
+documentation for using their built-in Spindle integration--it's invoked 
+with something similar to "jsrun --use_spindle=1".  To enable Spindle's 
+LSF wrapper, configure spindle with the "--with-rm=jsrun" (if building
+Spindle with LLNL's lrun wrappers to jsrun, then use --with-rm=lrun).  
+This will let you run Spindle with "spindle jsrun ...".
+
+Otherwise, you can use LaunchMON
+(http://sourceforge.net/projects/launchmon) to start spindle, but
 that won't work on all clusters.  LaunchMON is normally used for
 starting debuggers on clusters, but Spindle has different requirements
 than debuggers.  One way to tell if Spindle/LaunchMON will work on

LIB_VERSION

@@ -23,12 +23,13 @@
 # Spindle 0.10 - libspindlefe.so 1.0.1, libspindlebe.so 1.0.1, libspindle.so 0.1.0
 # Spindle 0.11 - libspindlefe.so 2.0.0, libspindlebe.so 2.0.0, libspindle.so 0.1.0
 # Spindle 0.12 - libspindlefe.so 2.1.0, libspindlebe.so 2.1.0, libspindle.so 0.1.0
+# Spindle 0.13 - libspindlefe.so 3.0.1, libspindlebe.so 3.0.1, libspindle.so 0.1.0, libspindleslurm.so 0.0.0
 
 if test "x$1" == "xspindlefe"; then
-echo 2:1:0
+echo 3:0:1
 fi
 if test "x$1" == "xspindlebe"; then
-echo 2:1:0
+echo 3:0:1
 fi
 if test "x$1" == "xlibspindle"; then
 echo 0:1:0

README

@@ -5,7 +5,7 @@ Authors:    SPINDLE:              Matthew LeGendre (legendre1 at llnl dot gov)
                                   W.Frings <W.Frings at fz-juelich dot de>
             COBO:                 Adam Moody <moody20 at llnl dot gov>
 
-Version:    0.12 (May 2020)
+Version:    0.13 (Aug 2020)
 
 Summary:
 ===========

VERSION

@@ -1 +1 @@
-0.12
+0.13rc1

configure

@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.69 for spindle 0.12.
+# Generated by GNU Autoconf 2.69 for spindle 0.13rc1.
 #
 # Report bugs to <[email protected]>.
 #
@@ -590,8 +590,8 @@ MAKEFLAGS=
 # Identity of this package.
 PACKAGE_NAME='spindle'
 PACKAGE_TARNAME='spindle'
-PACKAGE_VERSION='0.12'
-PACKAGE_STRING='spindle 0.12'
+PACKAGE_VERSION='0.13rc1'
+PACKAGE_STRING='spindle 0.13rc1'
 PACKAGE_BUGREPORT='[email protected]'
 PACKAGE_URL=''
 
@@ -1423,7 +1423,7 @@ if test "$ac_init_help" = "long"; then
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures spindle 0.12 to adapt to many kinds of systems.
+\`configure' configures spindle 0.13rc1 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -1494,7 +1494,7 @@ fi
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of spindle 0.12:";;
+     short | recursive ) echo "Configuration of spindle 0.13rc1:";;
    esac
   cat <<\_ACEOF
 
@@ -1665,7 +1665,7 @@ fi
 test -n "$ac_init_help" && exit $ac_status
 if $ac_init_version; then
   cat <<\_ACEOF
-spindle configure 0.12
+spindle configure 0.13rc1
 generated by GNU Autoconf 2.69
 
 Copyright (C) 2012 Free Software Foundation, Inc.
@@ -2155,7 +2155,7 @@ cat >config.log <<_ACEOF
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by spindle $as_me 0.12, which was
+It was created by spindle $as_me 0.13rc1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   $ $0 $@
@@ -3130,7 +3130,7 @@ fi
 
 # Define the identity of the package.
  PACKAGE='spindle'
- VERSION='0.12'
+ VERSION='0.13rc1'
 
 
 cat >>confdefs.h <<_ACEOF
@@ -18461,7 +18461,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
 # report actual input values of CONFIG_FILES etc. instead of their
 # values after options handling.
 ac_log="
-This file was extended by spindle $as_me 0.12, which was
+This file was extended by spindle $as_me 0.13rc1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -18527,7 +18527,7 @@ _ACEOF
 cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-spindle config.status 0.12
+spindle config.status 0.13rc1
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"
 

doc/spindle_launch_README.md

@@ -9,11 +9,11 @@ Overview
 --------
 
 While Spindle comes with several mechanisms for launching (launchmon,
-hostbin, slurm, and serial as of v0.13), each of these has disadvantages such
-as in-operatability with debuggers (launchmon), difficult to use
-(hostbin), or of limited scope (serial). In the ideal case Spindle
-should be integrated directly into a job launcher, which can easily
-perform the necessary actions of starting the servers, managing the job
+hostbin, slurm, LSF, and serial as of v0.13), each of these has 
+disadvantages such as in-operatability with debuggers (launchmon), 
+difficult to use (hostbin), or of limited scope (serial). In the ideal 
+case Spindle should be integrated directly into a job launcher, which can 
+easily perform the necessary actions of starting the servers, managing the job
 lifetime, and helping Spindle establish connections. This document
 describes the API for integrating Spindle into job launchers.
 
@@ -113,6 +113,15 @@ we have to break ABI compatibility.
         high-latency networks.
    -    'OPT_BEEXIT' - Spindle will block its exit until each BE has
         had 'spindleExitBE()' called on it.
+   -    'OPT_PROCCLEAN' - Spindle will launch a dedicated process to do
+        cleaning operations for after spindle exits.  Can be useful for
+        ensuring cleaning happens in less-stable environments.
+   -    'OPT_RSHLAUNCH' - When mixed with compatible launch modes, spindle 
+        will start its daemons with a tree of RSH/SSH commands.  Enabling
+        this mode means you don't have to manually start the BE with
+        `spindleRunBE()`.  Whether the daemons are launched via ssh or rsh
+        can be controlled through command arguments, configure, or an
+        environment variable (SPINDLE_RSH).
 
 - `typedef struct { ... } spindle_args_t`
 
@@ -290,6 +299,21 @@ of hostnames used in the job. The FE API functions are:
 
     This function return 0 on success and non-0 on error.
 
+-   `pid_t getRSHPidFE()`
+
+    If the spindle FE is initialized with OPT_RSHLAUNCH set, then the
+    spindle daemons will be launched with a tree of RSH processes.  
+    This function will return the pid of the rsh command at the top
+    of the tree.  This process will exit when Spindle shuts down.
+
+-   `markRSHPidReapedFE()`
+
+    This function should be called if the spindle FE was initialized 
+    with OPT_RSHLAUNCH, and the RM collects the rsh pid (via waitpid 
+    or wait) for spinlde.  If this function hasn't been been called then 
+    Spindle will try to collect the RSH process in spindleCloseFE(), which
+    could lead to hangs if the process has already been collected.
+   
 The BackEnd API
 ---------------
 

src/client/configure

@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.69 for spindle 0.12.
+# Generated by GNU Autoconf 2.69 for spindle 0.13rc1.
 #
 # Report bugs to <[email protected]>.
 #
@@ -590,8 +590,8 @@ MAKEFLAGS=
 # Identity of this package.
 PACKAGE_NAME='spindle'
 PACKAGE_TARNAME='spindle'
-PACKAGE_VERSION='0.12'
-PACKAGE_STRING='spindle 0.12'
+PACKAGE_VERSION='0.13rc1'
+PACKAGE_STRING='spindle 0.13rc1'
 PACKAGE_BUGREPORT='[email protected]'
 PACKAGE_URL=''
 
@@ -1368,7 +1368,7 @@ if test "$ac_init_help" = "long"; then
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures spindle 0.12 to adapt to many kinds of systems.
+\`configure' configures spindle 0.13rc1 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -1439,7 +1439,7 @@ fi
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of spindle 0.12:";;
+     short | recursive ) echo "Configuration of spindle 0.13rc1:";;
    esac
   cat <<\_ACEOF
 
@@ -1587,7 +1587,7 @@ fi
 test -n "$ac_init_help" && exit $ac_status
 if $ac_init_version; then
   cat <<\_ACEOF
-spindle configure 0.12
+spindle configure 0.13rc1
 generated by GNU Autoconf 2.69
 
 Copyright (C) 2012 Free Software Foundation, Inc.
@@ -1865,7 +1865,7 @@ cat >config.log <<_ACEOF
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by spindle $as_me 0.12, which was
+It was created by spindle $as_me 0.13rc1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   $ $0 $@
@@ -2840,7 +2840,7 @@ fi
 
 # Define the identity of the package.
  PACKAGE='spindle'
- VERSION='0.12'
+ VERSION='0.13rc1'
 
 
 cat >>confdefs.h <<_ACEOF
@@ -13566,7 +13566,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
 # report actual input values of CONFIG_FILES etc. instead of their
 # values after options handling.
 ac_log="
-This file was extended by spindle $as_me 0.12, which was
+This file was extended by spindle $as_me 0.13rc1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -13632,7 +13632,7 @@ _ACEOF
 cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-spindle config.status 0.12
+spindle config.status 0.13rc1
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"
 

src/fe/configure

@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.69 for spindle 0.12.
+# Generated by GNU Autoconf 2.69 for spindle 0.13rc1.
 #
 # Report bugs to <[email protected]>.
 #
@@ -590,8 +590,8 @@ MAKEFLAGS=
 # Identity of this package.
 PACKAGE_NAME='spindle'
 PACKAGE_TARNAME='spindle'
-PACKAGE_VERSION='0.12'
-PACKAGE_STRING='spindle 0.12'
+PACKAGE_VERSION='0.13rc1'
+PACKAGE_STRING='spindle 0.13rc1'
 PACKAGE_BUGREPORT='[email protected]'
 PACKAGE_URL=''
 
@@ -1402,7 +1402,7 @@ if test "$ac_init_help" = "long"; then
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures spindle 0.12 to adapt to many kinds of systems.
+\`configure' configures spindle 0.13rc1 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -1473,7 +1473,7 @@ fi
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of spindle 0.12:";;
+     short | recursive ) echo "Configuration of spindle 0.13rc1:";;
    esac
   cat <<\_ACEOF
 
@@ -1637,7 +1637,7 @@ fi
 test -n "$ac_init_help" && exit $ac_status
 if $ac_init_version; then
   cat <<\_ACEOF
-spindle configure 0.12
+spindle configure 0.13rc1
 generated by GNU Autoconf 2.69
 
 Copyright (C) 2012 Free Software Foundation, Inc.
@@ -2127,7 +2127,7 @@ cat >config.log <<_ACEOF
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by spindle $as_me 0.12, which was
+It was created by spindle $as_me 0.13rc1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   $ $0 $@
@@ -3102,7 +3102,7 @@ fi
 
 # Define the identity of the package.
  PACKAGE='spindle'
- VERSION='0.12'
+ VERSION='0.13rc1'
 
 
 cat >>confdefs.h <<_ACEOF
@@ -17959,7 +17959,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
 # report actual input values of CONFIG_FILES etc. instead of their
 # values after options handling.
 ac_log="
-This file was extended by spindle $as_me 0.12, which was
+This file was extended by spindle $as_me 0.13rc1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -18025,7 +18025,7 @@ _ACEOF
 cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-spindle config.status 0.12
+spindle config.status 0.13rc1
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"