btcd: Simplify shutdown signal handling logic. (#733)

This rewrites the shutdown logic to simplify the shutdown signalling.
All cleanup is now run from deferred functions in the main function and
channels are used to signal shutdown either from OS signals or from
other subsystems such as the RPC server and windows service controller.

The RPC server has been modified to use a new channel for signalling
shutdown that is exposed via the RequestedProcessShutdown function
instead of directly calling Stop on the server as it previously did.

Finally, it adds a few checks for early termination during the main
start sequence so the process can be stopped without starting all the
subsystems if desired.

This is a backport of the equivalent logic from Decred with a few slight
modifications.  Credits go to @jrick.

btcd.go

@@ -20,7 +20,6 @@ import (
 
 var (
 	cfg *config
-	shutdownChannel = make(chan struct{})
 )
 
 // winServiceMain is only invoked on Windows.  It detects when btcd is running
@@ -42,6 +41,12 @@ func btcdMain(serverChan chan<- *server) error {
 	cfg = tcfg
 	defer backendLog.Flush()
 
+	// Get a channel that will be closed when a shutdown signal has been
+	// triggered either from an OS signal such as SIGINT (Ctrl+C) or from
+	// another subsystem such as the RPC server.
+	interruptedChan := interruptListener()
+	defer btcdLog.Info("Shutdown complete")
+
 	// Show version at startup.
 	btcdLog.Infof("Version %s", version())
 
@@ -75,19 +80,27 @@ func btcdMain(serverChan chan<- *server) error {
 		return err
 	}
 
+	// Return now if an interrupt signal was triggered.
+	if interruptRequested(interruptedChan) {
+		return nil
+	}
+
 	// Load the block database.
 	db, err := loadBlockDB()
 	if err != nil {
 		btcdLog.Errorf("%v", err)
 		return err
 	}
-	defer db.Close()
+	defer func() {
-
+		// Ensure the database is sync'd and closed on shutdown.
-	// Ensure the database is sync'd and closed on Ctrl+C.
-	addInterruptHandler(func() {
 		btcdLog.Infof("Gracefully shutting down the database...")
 		db.Close()
-	})
+	}()
+
+	// Return now if an interrupt signal was triggered.
+	if interruptRequested(interruptedChan) {
+		return nil
+	}
 
 	// Drop indexes and exit if requested.
 	//
@@ -118,32 +131,21 @@ func btcdMain(serverChan chan<- *server) error {
 			cfg.Listeners, err)
 		return err
 	}
-	addInterruptHandler(func() {
+	defer func() {
 		btcdLog.Infof("Gracefully shutting down the server...")
 		server.Stop()
 		server.WaitForShutdown()
-	})
+		srvrLog.Infof("Server shutdown complete")
+	}()
 	server.Start()
 	if serverChan != nil {
 		serverChan <- server
 	}
 
-	// Monitor for graceful server shutdown and signal the main goroutine
+	// Wait until the interrupt signal is received from an OS signal or
-	// when done.  This is done in a separate goroutine rather than waiting
+	// shutdown is requested through one of the subsystems such as the RPC
-	// directly so the main goroutine can be signaled for shutdown by either
+	// server.
-	// a graceful shutdown or from the main interrupt handler.  This is
+	<-interruptedChan
-	// necessary since the main goroutine must be kept running long enough
-	// for the interrupt handler goroutine to finish.
-	go func() {
-		server.WaitForShutdown()
-		srvrLog.Infof("Server shutdown complete")
-		shutdownChannel <- struct{}{}
-	}()
-
-	// Wait for shutdown signal from either a graceful server stop or from
-	// the interrupt handler.
-	<-shutdownChannel
-	btcdLog.Info("Shutdown complete")
 	return nil
 }
 

rpcserver.go

@@ -3513,7 +3513,10 @@ func handleSetGenerate(s *rpcServer, cmd interface{}, closeChan <-chan struct{})
 
 // handleStop implements the stop command.
 func handleStop(s *rpcServer, cmd interface{}, closeChan <-chan struct{}) (interface{}, error) {
-	s.server.Stop()
+	select {
+	case s.requestProcessShutdown <- struct{}{}:
+	default:
+	}
 	return "btcd stopping.", nil
 }
 
@@ -3699,6 +3702,7 @@ type rpcServer struct {
 	workState              *workState
 	gbtWorkState           *gbtWorkState
 	helpCacher             *helpCacher
+	requestProcessShutdown chan struct{}
 	quit                   chan int
 }
 
@@ -3783,6 +3787,13 @@ func (s *rpcServer) Stop() error {
 	return nil
 }
 
+// RequestedProcessShutdown returns a channel that is sent to when an authorized
+// RPC client requests the process to shutdown.  If the request can not be read
+// immediately, it is dropped.
+func (s *rpcServer) RequestedProcessShutdown() <-chan struct{} {
+	return s.requestProcessShutdown
+}
+
 // limitConnections responds with a 503 service unavailable and returns true if
 // adding another client would exceed the maximum allow RPC clients.
 //
@@ -4171,6 +4182,7 @@ func newRPCServer(listenAddrs []string, policy *mining.Policy, s *server) (*rpcS
 		workState:              newWorkState(),
 		gbtWorkState:           newGbtWorkState(s.timeSource),
 		helpCacher:             newHelpCacher(),
+		requestProcessShutdown: make(chan struct{}),
 		quit: make(chan int),
 	}
 	if cfg.RPCUser != "" && cfg.RPCPass != "" {

server.go

@@ -2555,6 +2555,12 @@ func newServer(listenAddrs []string, db database.DB, chainParams *chaincfg.Param
 		if err != nil {
 			return nil, err
 		}
+
+		// Signal process shutdown when the RPC server requests it.
+		go func() {
+			<-s.rpcServer.RequestedProcessShutdown()
+			shutdownRequestChannel <- struct{}{}
+		}()
 	}
 
 	return &s, nil

service_windows.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2013-2014 The btcsuite developers
+// Copyright (c) 2013-2016 The btcsuite developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -85,18 +85,8 @@ loop:
 				// more commands while pending.
 				changes <- svc.Status{State: svc.StopPending}
 
-				// Stop the main server gracefully when it is
+				// Signal the main function to exit.
-				// already setup or just break out and allow
+				shutdownRequestChannel <- struct{}{}
-				// the service to exit immediately if it's not
-				// setup yet.  Note that calling Stop will cause
-				// btcdMain to exit in the goroutine above which
-				// will in turn send a signal (and a potential
-				// error) to doneChan.
-				if mainServer != nil {
-					mainServer.Stop()
-				} else {
-					break loop
-				}
 
 			default:
 				elog.Error(1, fmt.Sprintf("Unexpected control "+

signal.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2013-2014 The btcsuite developers
+// Copyright (c) 2013-2016 The btcsuite developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -9,79 +9,63 @@ import (
 	"os/signal"
 )
 
-// interruptChannel is used to receive SIGINT (Ctrl+C) signals.
+// shutdownRequestChannel is used to initiate shutdown from one of the
-var interruptChannel chan os.Signal
+// subsystems using the same code paths as when an interrupt signal is received.
+var shutdownRequestChannel = make(chan struct{})
 
-// addHandlerChannel is used to add an interrupt handler to the list of handlers
+// interruptSignals defines the default signals to catch in order to do a proper
-// to be invoked on SIGINT (Ctrl+C) signals.
+// shutdown.  This may be modified during init depending on the platform.
-var addHandlerChannel = make(chan func())
+var interruptSignals = []os.Signal{os.Interrupt}
 
-// signals defines the default signals to catch in order to do a proper
+// interruptListener listens for OS Signals such as SIGINT (Ctrl+C) and shutdown
-// shutdown.
+// requests from shutdownRequestChannel.  It returns a channel that is closed
-var signals = []os.Signal{os.Interrupt}
+// when either signal is received.
+func interruptListener() <-chan struct{} {
+	c := make(chan struct{})
+	go func() {
+		interruptChannel := make(chan os.Signal, 1)
+		signal.Notify(interruptChannel, interruptSignals...)
 
-// mainInterruptHandler listens for SIGINT (Ctrl+C) signals on the
+		// Listen for initial shutdown signal and close the returned
-// interruptChannel and invokes the registered interruptCallbacks accordingly.
+		// channel to notify the caller.
-// It also listens for callback registration.  It must be run as a goroutine.
-func mainInterruptHandler() {
-	// interruptCallbacks is a list of callbacks to invoke when a
-	// SIGINT (Ctrl+C) is received.
-	var interruptCallbacks []func()
-
-	// isShutdown is a flag which is used to indicate whether or not
-	// the shutdown signal has already been received and hence any future
-	// attempts to add a new interrupt handler should invoke them
-	// immediately.
-	var isShutdown bool
-
-	for {
 		select {
 		case sig := <-interruptChannel:
-			// Ignore more than one shutdown signal.
-			if isShutdown {
-				btcdLog.Infof("Received signal (%s).  "+
-					"Already shutting down...", sig)
-				continue
-			}
-
-			isShutdown = true
 			btcdLog.Infof("Received signal (%s).  Shutting down...",
 				sig)
 
-			// Run handlers in LIFO order.
+		case <-shutdownRequestChannel:
-			for i := range interruptCallbacks {
+			btcdLog.Info("Shutdown requested.  Shutting down...")
-				idx := len(interruptCallbacks) - 1 - i
-				callback := interruptCallbacks[idx]
-				callback()
 		}
+		close(c)
 
-			// Signal the main goroutine to shutdown.
+		// Listen for repeated signals and display a message so the user
-			go func() {
+		// knows the shutdown is in progress and the process is not
-				shutdownChannel <- struct{}{}
+		// hung.
+		for {
+			select {
+			case sig := <-interruptChannel:
+				btcdLog.Infof("Received signal (%s).  Already "+
+					"shutting down...", sig)
+
+			case <-shutdownRequestChannel:
+				btcdLog.Info("Shutdown requested.  Already " +
+					"shutting down...")
+			}
+		}
 	}()
 
-		case handler := <-addHandlerChannel:
+	return c
-			// The shutdown signal has already been received, so
-			// just invoke and new handlers immediately.
-			if isShutdown {
-				handler()
 }
 
-			interruptCallbacks = append(interruptCallbacks, handler)
+// interruptRequested returns true when the channel returned by
-		}
+// interruptListener was closed.  This simplifies early shutdown slightly since
-	}
+// the caller can just use an if statement instead of a select.
+func interruptRequested(interrupted <-chan struct{}) bool {
+	select {
+	case <-interrupted:
+		return true
+	default:
 	}
 
-// addInterruptHandler adds a handler to call when a SIGINT (Ctrl+C) is
+	return false
-// received.
-func addInterruptHandler(handler func()) {
-	// Create the channel and start the main interrupt handler which invokes
-	// all other callbacks and exits if not already done.
-	if interruptChannel == nil {
-		interruptChannel = make(chan os.Signal, 1)
-		signal.Notify(interruptChannel, signals...)
-		go mainInterruptHandler()
-	}
-
-	addHandlerChannel <- handler
 }

signalsigterm.go

@@ -12,5 +12,5 @@ import (
 )
 
 func init() {
-	signals = []os.Signal{os.Interrupt, syscall.SIGTERM}
+	interruptSignals = []os.Signal{os.Interrupt, syscall.SIGTERM}
 }