Protect shutdown callbacks lists with a mutex (#2432)

.travis.yml

@@ -19,12 +19,5 @@ script:
 after_success:
 - bash <(curl -s https://codecov.io/bash)
 
-after_success:
-- bash <(curl -s https://codecov.io/bash)
-
 go:
-- 1.6
-
-notifications:
-  slack:
-    secure: K9tsn5MvrCAxuEZTxn+m3Kq1K2NG2xMEJFSv/sTp+RQBW7TslPHzv859GsIvrm8mU1y1btOU9RlOzqrRUczI5cJpE8IL1oljPZbXrIXgetE0kbsw0Wpy99g27UQ2VGp933WDu8tfj7zU4cZv+BI0RltNLwqYO6GWXmcWP0IueCU=
+- 1.6.2

fs-v1.go

@@ -62,36 +62,6 @@ func loadFormatFS(storageDisk StorageAPI) (format formatConfigV1, err error) {
 	return format, nil
 }
 
-// Should be called when process shuts down.
-func shutdownFS(storage StorageAPI) errCode {
-	// List if there are any multipart entries.
-	_, err := storage.ListDir(minioMetaBucket, mpartMetaPrefix)
-	if err != errFileNotFound {
-		// Multipart directory is not empty hence do not remove '.minio.sys' volume.
-		return exitSuccess
-	}
-	// List if there are any bucket configuration entries.
-	_, err = storage.ListDir(minioMetaBucket, bucketConfigPrefix)
-	if err != errFileNotFound {
-		// Bucket config directory is not empty hence do not remove '.minio.sys' volume.
-		return exitSuccess
-	}
-	// Cleanup everything else.
-	prefix := ""
-	if err = cleanupDir(storage, minioMetaBucket, prefix); err != nil {
-		errorIf(err, "Unable to cleanup minio meta bucket")
-		return exitFailure
-	}
-	if err = storage.DeleteVol(minioMetaBucket); err != nil {
-		if err != errVolumeNotEmpty {
-			errorIf(err, "Unable to delete minio meta bucket %s", minioMetaBucket)
-			return exitFailure
-		}
-	}
-	// Successful exit.
-	return exitSuccess
-}
-
 // newFSObjects - initialize new fs object layer.
 func newFSObjects(disk string) (ObjectLayer, error) {
 	storage, err := newStorageAPI(disk)
@@ -132,11 +102,6 @@ func newFSObjects(disk string) (ObjectLayer, error) {
 		return nil, errFSDiskFormat
 	}
 
-	// Register the callback that should be called when the process shuts down.
-	registerObjectStorageShutdown(func() errCode {
-		return shutdownFS(storage)
-	})
-
 	// Initialize fs objects.
 	fs := fsObjects{
 		storage:      storage,
@@ -148,6 +113,36 @@ func newFSObjects(disk string) (ObjectLayer, error) {
 	return fs, nil
 }
 
+// Should be called when process shuts down.
+func (fs fsObjects) Shutdown() error {
+	// List if there are any multipart entries.
+	_, err := fs.storage.ListDir(minioMetaBucket, mpartMetaPrefix)
+	if err != errFileNotFound {
+		// Multipart directory is not empty hence do not remove '.minio.sys' volume.
+		return nil
+	}
+	// List if there are any bucket configuration entries.
+	_, err = fs.storage.ListDir(minioMetaBucket, bucketConfigPrefix)
+	if err != errFileNotFound {
+		// Bucket config directory is not empty hence do not remove '.minio.sys' volume.
+		return nil
+	}
+	// Cleanup everything else.
+	prefix := ""
+	if err = cleanupDir(fs.storage, minioMetaBucket, prefix); err != nil {
+		errorIf(err, "Unable to cleanup minio meta bucket")
+		return err
+	}
+	if err = fs.storage.DeleteVol(minioMetaBucket); err != nil {
+		if err != errVolumeNotEmpty {
+			errorIf(err, "Unable to delete minio meta bucket %s", minioMetaBucket)
+			return err
+		}
+	}
+	// Successful.
+	return nil
+}
+
 // StorageInfo - returns underlying storage statistics.
 func (fs fsObjects) StorageInfo() StorageInfo {
 	info, err := disk.GetInfo(fs.physicalDisk)

main.go

@@ -158,9 +158,6 @@ func main() {
 		// Enable all loggers by now.
 		enableLoggers()
 
-		// Initialize name space lock.
-		initNSLock()
-
 		// Set global quiet flag.
 		globalQuiet = c.Bool("quiet") || c.GlobalBool("quiet")
 
@@ -189,10 +186,6 @@ func main() {
 		defer profile.Start(profile.BlockProfile, profile.ProfilePath(profileDir)).Stop()
 	}
 
-	// Initialize and monitor shutdown signal
-	shutdownSignal = make(chan bool, 1)
-	monitorShutdownSignal(os.Exit)
-
 	// Run the app - exit on error.
 	app.RunAndExitOnError()
 }

object-interface.go

@@ -21,6 +21,7 @@ import "io"
 // ObjectLayer implements primitives for object API layer.
 type ObjectLayer interface {
 	// Storage operations.
+	Shutdown() error
 	StorageInfo() StorageInfo
 
 	// Bucket operations.

routers.go

@@ -42,6 +42,9 @@ func newObjectLayer(disks, ignoredDisks []string) (ObjectLayer, error) {
 
 // configureServer handler returns final handler for the http server.
 func configureServerHandler(srvCmdConfig serverCmdConfig) http.Handler {
+	// Initialize name space lock.
+	initNSLock()
+
 	objAPI, err := newObjectLayer(srvCmdConfig.disks, srvCmdConfig.ignoredDisks)
 	fatalIf(err, "Unable to intialize object layer.")
 
@@ -66,6 +69,18 @@ func configureServerHandler(srvCmdConfig serverCmdConfig) http.Handler {
 		ObjectAPI: objAPI,
 	}
 
+	// Initialize and monitor shutdown signals.
+	err = initGracefulShutdown(os.Exit)
+	fatalIf(err, "Unable to initialize graceful shutdown operation")
+
+	// Register the callback that should be called when the process shuts down.
+	globalShutdownCBs.AddObjectLayerCB(func() errCode {
+		if sErr := objAPI.Shutdown(); sErr != nil {
+			return exitFailure
+		}
+		return exitSuccess
+	})
+
 	// Initialize a new event notifier.
 	err = initEventNotifier(objAPI)
 	fatalIf(err, "Unable to initialize event notification queue")

server-main.go

@@ -259,7 +259,8 @@ func serverMain(c *cli.Context) {
 	// Prints the formatted startup message.
 	printStartupMessage(endPoints)
 
-	registerShutdown(func() errCode {
+	// Register generic callbacks.
+	globalShutdownCBs.AddGenericCB(func() errCode {
 		// apiServer.Stop()
 		return exitSuccess
 	})

utils.go

@@ -22,6 +22,7 @@ import (
 	"io"
 	"os"
 	"strings"
+	"sync"
 	"syscall"
 )
 
@@ -76,62 +77,112 @@ func contains(stringList []string, element string) bool {
 	return false
 }
 
-// shutdownSignal - is the channel that receives any boolean when
-// we want broadcast the start of shutdown
-var shutdownSignal chan bool
+// Represents a type of an exit func which will be invoked upon shutdown signal.
+type onExitFunc func(code int)
 
-// shutdownCallbacks - is the list of function callbacks executed one by one
-// when a shutdown starts. A callback returns 0 for success and 1 for failure.
-// Failure is considered an emergency error that needs an immediate exit
-var shutdownCallbacks []func() errCode
+// Represents a type for all the the callback functions invoked upon shutdown signal.
+type cleanupOnExitFunc func() errCode
+
+// Represents a collection of various callbacks executed upon exit signals.
+type shutdownCallbacks struct {
+	// Protect callbacks list from a concurrent access
+	*sync.RWMutex
+	// genericCallbacks - is the list of function callbacks executed one by one
+	// when a shutdown starts. A callback returns 0 for success and 1 for failure.
+	// Failure is considered an emergency error that needs an immediate exit
+	genericCallbacks []cleanupOnExitFunc
+	// objectLayerCallbacks - contains the list of function callbacks that
+	// need to be invoked when a shutdown starts. These callbacks will be called before
+	// the general callback shutdowns
+	objectLayerCallbacks []cleanupOnExitFunc
+}
 
-// shutdownObjectStorageCallbacks - contains the list of function callbacks that
-// need to be invoked when a shutdown starts. These callbacks will be called before
-// the general callback shutdowns
-var shutdownObjectStorageCallbacks []func() errCode
+// globalShutdownCBs stores regular and object storages callbacks
+var globalShutdownCBs *shutdownCallbacks
 
-// Register callback functions that need to be called when process terminates.
-func registerShutdown(callback func() errCode) {
-	shutdownCallbacks = append(shutdownCallbacks, callback)
+func (s shutdownCallbacks) GetObjectLayerCBs() []cleanupOnExitFunc {
+	s.RLock()
+	defer s.RUnlock()
+	return s.objectLayerCallbacks
 }
 
-// Register object storagecallback functions that need to be called when process terminates.
-func registerObjectStorageShutdown(callback func() errCode) {
-	shutdownObjectStorageCallbacks = append(shutdownObjectStorageCallbacks, callback)
+func (s shutdownCallbacks) GetGenericCBs() []cleanupOnExitFunc {
+	s.RLock()
+	defer s.RUnlock()
+	return s.genericCallbacks
 }
 
-// Represents a type of an exit func which will be invoked during shutdown signal.
-type onExitFunc func(code int)
+func (s *shutdownCallbacks) AddObjectLayerCB(callback cleanupOnExitFunc) error {
+	s.Lock()
+	defer s.Unlock()
+	if callback == nil {
+		return errInvalidArgument
+	}
+	s.objectLayerCallbacks = append(s.objectLayerCallbacks, callback)
+	return nil
+}
+
+func (s *shutdownCallbacks) AddGenericCB(callback cleanupOnExitFunc) error {
+	s.Lock()
+	defer s.Unlock()
+	if callback == nil {
+		return errInvalidArgument
+	}
+	s.genericCallbacks = append(s.genericCallbacks, callback)
+	return nil
+}
+
+// Initialize graceful shutdown mechanism.
+func initGracefulShutdown(onExitFn onExitFunc) error {
+	// Validate exit func.
+	if onExitFn == nil {
+		return errInvalidArgument
+	}
+	globalShutdownCBs = &shutdownCallbacks{
+		RWMutex: &sync.RWMutex{},
+	}
+	// Return start monitor shutdown signal.
+	return startMonitorShutdownSignal(onExitFn)
+}
+
+// Global shutdown signal channel.
+var globalShutdownSignalCh = make(chan struct{})
 
 // Start to monitor shutdownSignal to execute shutdown callbacks
-func monitorShutdownSignal(onExitFn onExitFunc) {
+func startMonitorShutdownSignal(onExitFn onExitFunc) error {
+	// Validate exit func.
+	if onExitFn == nil {
+		return errInvalidArgument
+	}
 	go func() {
+		defer close(globalShutdownSignalCh)
 		// Monitor signals.
 		trapCh := signalTrap(os.Interrupt, syscall.SIGTERM)
 		for {
 			select {
 			case <-trapCh:
-				// Start a graceful shutdown call
-				shutdownSignal <- true
-			case <-shutdownSignal:
-				// Call all callbacks and exit for emergency
-				for _, callback := range shutdownCallbacks {
+				// Initiate graceful shutdown.
+				globalShutdownSignalCh <- struct{}{}
+			case <-globalShutdownSignalCh:
+				// Call all object storage shutdown callbacks and exit for emergency
+				for _, callback := range globalShutdownCBs.GetObjectLayerCBs() {
 					exitCode := callback()
 					if exitCode != exitSuccess {
 						onExitFn(int(exitCode))
 					}
 
 				}
-				// Call all object storage shutdown callbacks and exit for emergency
-				for _, callback := range shutdownObjectStorageCallbacks {
+				// Call all callbacks and exit for emergency
+				for _, callback := range globalShutdownCBs.GetGenericCBs() {
 					exitCode := callback()
 					if exitCode != exitSuccess {
 						onExitFn(int(exitCode))
 					}
-
 				}
 				onExitFn(int(exitSuccess))
 			}
 		}
 	}()
+	// Successfully started routine.
+	return nil
 }

utils_test.go

@@ -20,21 +20,19 @@ import "testing"
 
 // ShutdownCallback simulates a successful and failure exit here.
 func TestShutdownCallbackSuccess(t *testing.T) {
-	// Register two callbacks that return success
-	registerObjectStorageShutdown(func() errCode {
-		return exitSuccess
-	})
-	registerShutdown(func() errCode {
-		return exitSuccess
-	})
-
-	shutdownSignal = make(chan bool, 1)
-	shutdownSignal <- true
-	// Start executing callbacks and exitFunc receives a success.
+	// initialize graceful shutdown
 	dummySuccess := func(code int) {
 		if code != int(exitSuccess) {
 			t.Fatalf("Expected %d, got %d instead.", code, exitSuccess)
 		}
 	}
-	monitorShutdownSignal(dummySuccess)
+	initGracefulShutdown(dummySuccess)
+	// Register two callbacks that return success
+	globalShutdownCBs.AddObjectLayerCB(func() errCode {
+		return exitSuccess
+	})
+	globalShutdownCBs.AddGenericCB(func() errCode {
+		return exitSuccess
+	})
+	globalShutdownSignalCh <- struct{}{}
 }

xl-v1.go

@@ -206,6 +206,12 @@ func newXLObjects(disks, ignoredDisks []string) (ObjectLayer, error) {
 	return xl, nil
 }
 
+// Shutdown function for object storage interface.
+func (xl xlObjects) Shutdown() error {
+	// Add any object layer shutdown activities here.
+	return nil
+}
+
 // byDiskTotal is a collection satisfying sort.Interface.
 type byDiskTotal []disk.Info