Browse code

Fix volume plugin refecounting on daemon restart

Ensures all known volumes (known b/c they are persisted to disk) have
their volume drivers refcounted properly.

In testing this, I found an issue with `--live-restore` (required since
currently the provided volume plugin doesn't keep state on restart)
where restorted plugins did not have a plugin client loaded causing a
panic when trying to use the plugin.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

Brian Goff authored on 2016/12/02 07:17:07
Showing 7 changed files
... ...
@@ -794,6 +794,12 @@ func (daemon *Daemon) Shutdown() error {
794 794
 		})
795 795
 	}
796 796
 
797
+	if daemon.volumes != nil {
798
+		if err := daemon.volumes.Shutdown(); err != nil {
799
+			logrus.Errorf("Error shutting down volume store: %v", err)
800
+		}
801
+	}
802
+
797 803
 	if daemon.layerStore != nil {
798 804
 		if err := daemon.layerStore.Cleanup(); err != nil {
799 805
 			logrus.Errorf("Error during layer Store.Cleanup(): %v", err)
... ...
@@ -253,6 +253,27 @@ func (s *DockerDaemonSuite) TestGraphdriverPlugin(c *check.C) {
253 253
 	c.Assert(err, checker.IsNil, check.Commentf(out))
254 254
 }
255 255
 
256
+func (s *DockerDaemonSuite) TestPluginVolumeRemoveOnRestart(c *check.C) {
257
+	testRequires(c, DaemonIsLinux, Network, IsAmd64)
258
+
259
+	s.d.Start(c, "--live-restore=true")
260
+
261
+	out, err := s.d.Cmd("plugin", "install", "--grant-all-permissions", pName)
262
+	c.Assert(err, checker.IsNil, check.Commentf(out))
263
+	c.Assert(strings.TrimSpace(out), checker.Contains, pName)
264
+
265
+	out, err = s.d.Cmd("volume", "create", "--driver", pName, "test")
266
+	c.Assert(err, checker.IsNil, check.Commentf(out))
267
+
268
+	s.d.Restart(c, "--live-restore=true")
269
+
270
+	out, err = s.d.Cmd("plugin", "disable", pName)
271
+	c.Assert(err, checker.IsNil, check.Commentf(out))
272
+	out, err = s.d.Cmd("plugin", "rm", pName)
273
+	c.Assert(err, checker.NotNil, check.Commentf(out))
274
+	c.Assert(out, checker.Contains, "in use")
275
+}
276
+
256 277
 func existsMountpointWithPrefix(mountpointPrefix string) (bool, error) {
257 278
 	mounts, err := mount.GetMounts()
258 279
 	if err != nil {
... ...
@@ -1263,7 +1263,7 @@ func (s *DockerDaemonSuite) TestDaemonWithWrongkey(c *check.C) {
1263 1263
 	c.Assert(err, checker.IsNil)
1264 1264
 
1265 1265
 	if !strings.Contains(string(content), "Public Key ID does not match") {
1266
-		c.Fatal("Missing KeyID message from daemon logs")
1266
+		c.Fatalf("Missing KeyID message from daemon logs: %s", string(content))
1267 1267
 	}
1268 1268
 }
1269 1269
 
1270 1270
new file mode 100644
... ...
@@ -0,0 +1,78 @@
0
+package store
1
+
2
+import (
3
+	"encoding/json"
4
+
5
+	"github.com/boltdb/bolt"
6
+	"github.com/pkg/errors"
7
+)
8
+
9
+var volumeBucketName = []byte("volumes")
10
+
11
+type dbEntry struct {
12
+	Key   []byte
13
+	Value []byte
14
+}
15
+
16
+type volumeMetadata struct {
17
+	Name    string
18
+	Driver  string
19
+	Labels  map[string]string
20
+	Options map[string]string
21
+}
22
+
23
+func (s *VolumeStore) setMeta(name string, meta volumeMetadata) error {
24
+	return s.db.Update(func(tx *bolt.Tx) error {
25
+		return setMeta(tx, name, meta)
26
+	})
27
+}
28
+
29
+func setMeta(tx *bolt.Tx, name string, meta volumeMetadata) error {
30
+	metaJSON, err := json.Marshal(meta)
31
+	if err != nil {
32
+		return err
33
+	}
34
+	b := tx.Bucket(volumeBucketName)
35
+	return errors.Wrap(b.Put([]byte(name), metaJSON), "error setting volume metadata")
36
+}
37
+
38
+func (s *VolumeStore) getMeta(name string) (volumeMetadata, error) {
39
+	var meta volumeMetadata
40
+	err := s.db.View(func(tx *bolt.Tx) error {
41
+		return getMeta(tx, name, &meta)
42
+	})
43
+	return meta, err
44
+}
45
+
46
+func getMeta(tx *bolt.Tx, name string, meta *volumeMetadata) error {
47
+	b := tx.Bucket(volumeBucketName)
48
+	val := b.Get([]byte(name))
49
+	if string(val) == "" {
50
+		return nil
51
+	}
52
+	if err := json.Unmarshal(val, meta); err != nil {
53
+		return errors.Wrap(err, "error unmarshaling volume metadata")
54
+	}
55
+	return nil
56
+}
57
+
58
+func (s *VolumeStore) removeMeta(name string) error {
59
+	return s.db.Update(func(tx *bolt.Tx) error {
60
+		return removeMeta(tx, name)
61
+	})
62
+}
63
+
64
+func removeMeta(tx *bolt.Tx, name string) error {
65
+	b := tx.Bucket(volumeBucketName)
66
+	return errors.Wrap(b.Delete([]byte(name)), "error removing volume metadata")
67
+}
68
+
69
+func listEntries(tx *bolt.Tx) []*dbEntry {
70
+	var entries []*dbEntry
71
+	b := tx.Bucket(volumeBucketName)
72
+	b.ForEach(func(k, v []byte) error {
73
+		entries = append(entries, &dbEntry{k, v})
74
+		return nil
75
+	})
76
+	return entries
77
+}
0 78
new file mode 100644
... ...
@@ -0,0 +1,91 @@
0
+package store
1
+
2
+import (
3
+	"encoding/json"
4
+	"sync"
5
+
6
+	"github.com/Sirupsen/logrus"
7
+	"github.com/boltdb/bolt"
8
+	"github.com/docker/docker/volume"
9
+	"github.com/docker/docker/volume/drivers"
10
+)
11
+
12
+// restore is called when a new volume store is created.
13
+// It's primary purpose is to ensure that all drivers' refcounts are set based
14
+// on known volumes after a restart.
15
+// This only attempts to track volumes that are actually stored in the on-disk db.
16
+// It does not probe the available drivers to find anything that may have been added
17
+// out of band.
18
+func (s *VolumeStore) restore() {
19
+	var entries []*dbEntry
20
+	s.db.View(func(tx *bolt.Tx) error {
21
+		entries = listEntries(tx)
22
+		return nil
23
+	})
24
+
25
+	chRemove := make(chan []byte, len(entries))
26
+	var wg sync.WaitGroup
27
+	for _, entry := range entries {
28
+		wg.Add(1)
29
+		// this is potentially a very slow operation, so do it in a goroutine
30
+		go func(entry *dbEntry) {
31
+			defer wg.Done()
32
+			var meta volumeMetadata
33
+			if len(entry.Value) != 0 {
34
+				if err := json.Unmarshal(entry.Value, &meta); err != nil {
35
+					logrus.Errorf("Error while reading volume metadata for volume %q: %v", string(entry.Key), err)
36
+					// don't return here, we can try with `getVolume` below
37
+				}
38
+			}
39
+
40
+			var v volume.Volume
41
+			var err error
42
+			if meta.Driver != "" {
43
+				v, err = lookupVolume(meta.Driver, string(entry.Key))
44
+				if err != nil && err != errNoSuchVolume {
45
+					logrus.WithError(err).WithField("driver", meta.Driver).WithField("volume", string(entry.Key)).Warn("Error restoring volume")
46
+					return
47
+				}
48
+				if v == nil {
49
+					// doesn't exist in the driver, remove it from the db
50
+					chRemove <- entry.Key
51
+					return
52
+				}
53
+			} else {
54
+				v, err = s.getVolume(string(entry.Key))
55
+				if err != nil {
56
+					if err == errNoSuchVolume {
57
+						chRemove <- entry.Key
58
+					}
59
+					return
60
+				}
61
+
62
+				meta.Driver = v.DriverName()
63
+				if err := s.setMeta(v.Name(), meta); err != nil {
64
+					logrus.WithError(err).WithField("driver", meta.Driver).WithField("volume", v.Name()).Warn("Error updating volume metadata on restore")
65
+				}
66
+			}
67
+
68
+			// increment driver refcount
69
+			volumedrivers.CreateDriver(meta.Driver)
70
+
71
+			// cache the volume
72
+			s.globalLock.Lock()
73
+			s.options[v.Name()] = meta.Options
74
+			s.labels[v.Name()] = meta.Labels
75
+			s.names[v.Name()] = v
76
+			s.globalLock.Unlock()
77
+		}(entry)
78
+	}
79
+
80
+	wg.Wait()
81
+	close(chRemove)
82
+	s.db.Update(func(tx *bolt.Tx) error {
83
+		for k := range chRemove {
84
+			if err := removeMeta(tx, string(k)); err != nil {
85
+				logrus.Warnf("Error removing stale entry from volume db: %v", err)
86
+			}
87
+		}
88
+		return nil
89
+	})
90
+}
... ...
@@ -1,8 +1,6 @@
1 1
 package store
2 2
 
3 3
 import (
4
-	"bytes"
5
-	"encoding/json"
6 4
 	"net"
7 5
 	"os"
8 6
 	"path/filepath"
... ...
@@ -19,16 +17,9 @@ import (
19 19
 )
20 20
 
21 21
 const (
22
-	volumeDataDir    = "volumes"
23
-	volumeBucketName = "volumes"
22
+	volumeDataDir = "volumes"
24 23
 )
25 24
 
26
-type volumeMetadata struct {
27
-	Name    string
28
-	Labels  map[string]string
29
-	Options map[string]string
30
-}
31
-
32 25
 type volumeWrapper struct {
33 26
 	volume.Volume
34 27
 	labels  map[string]string
... ...
@@ -89,16 +80,17 @@ func New(rootPath string) (*VolumeStore, error) {
89 89
 
90 90
 		// initialize volumes bucket
91 91
 		if err := vs.db.Update(func(tx *bolt.Tx) error {
92
-			if _, err := tx.CreateBucketIfNotExists([]byte(volumeBucketName)); err != nil {
92
+			if _, err := tx.CreateBucketIfNotExists(volumeBucketName); err != nil {
93 93
 				return errors.Wrap(err, "error while setting up volume store metadata database")
94 94
 			}
95
-
96 95
 			return nil
97 96
 		}); err != nil {
98 97
 			return nil, err
99 98
 		}
100 99
 	}
101 100
 
101
+	vs.restore()
102
+
102 103
 	return vs, nil
103 104
 }
104 105
 
... ...
@@ -150,6 +142,15 @@ func (s *VolumeStore) getRefs(name string) []string {
150 150
 // the internal data is out of sync with volumes driver plugins.
151 151
 func (s *VolumeStore) Purge(name string) {
152 152
 	s.globalLock.Lock()
153
+	v, exists := s.names[name]
154
+	if exists {
155
+		if _, err := volumedrivers.RemoveDriver(v.DriverName()); err != nil {
156
+			logrus.Error("Error dereferencing volume driver: %v", err)
157
+		}
158
+	}
159
+	if err := s.removeMeta(name); err != nil {
160
+		logrus.Errorf("Error removing volume metadata for volume %q: %v", name, err)
161
+	}
153 162
 	delete(s.names, name)
154 163
 	delete(s.refs, name)
155 164
 	delete(s.labels, name)
... ...
@@ -341,24 +342,11 @@ func (s *VolumeStore) checkConflict(name, driverName string) (volume.Volume, err
341 341
 // volumeExists returns if the volume is still present in the driver.
342 342
 // An error is returned if there was an issue communicating with the driver.
343 343
 func volumeExists(v volume.Volume) (bool, error) {
344
-	vd, err := volumedrivers.GetDriver(v.DriverName())
344
+	exists, err := lookupVolume(v.DriverName(), v.Name())
345 345
 	if err != nil {
346
-		return false, errors.Wrapf(err, "error while checking if volume %q exists in driver %q", v.Name(), v.DriverName())
347
-	}
348
-	exists, err := vd.Get(v.Name())
349
-	if err != nil {
350
-		err = errors.Cause(err)
351
-		if _, ok := err.(net.Error); ok {
352
-			return false, errors.Wrapf(err, "error while checking if volume %q exists in driver %q", v.Name(), v.DriverName())
353
-		}
354
-
355
-		// At this point, the error could be anything from the driver, such as "no such volume"
356
-		// Let's not check an error here, and instead check if the driver returned a volume
357
-	}
358
-	if exists == nil {
359
-		return false, nil
346
+		return false, err
360 347
 	}
361
-	return true, nil
348
+	return exists != nil, nil
362 349
 }
363 350
 
364 351
 // create asks the given driver to create a volume with the name/opts.
... ...
@@ -415,27 +403,16 @@ func (s *VolumeStore) create(name, driverName string, opts, labels map[string]st
415 415
 	s.refs[name] = make(map[string]struct{})
416 416
 	s.globalLock.Unlock()
417 417
 
418
-	if s.db != nil {
419
-		metadata := &volumeMetadata{
420
-			Name:    name,
421
-			Labels:  labels,
422
-			Options: opts,
423
-		}
424
-
425
-		volData, err := json.Marshal(metadata)
426
-		if err != nil {
427
-			return nil, err
428
-		}
429
-
430
-		if err := s.db.Update(func(tx *bolt.Tx) error {
431
-			b := tx.Bucket([]byte(volumeBucketName))
432
-			err := b.Put([]byte(name), volData)
433
-			return err
434
-		}); err != nil {
435
-			return nil, errors.Wrap(err, "error while persisting volume metadata")
436
-		}
418
+	metadata := volumeMetadata{
419
+		Name:    name,
420
+		Driver:  vd.Name(),
421
+		Labels:  labels,
422
+		Options: opts,
437 423
 	}
438 424
 
425
+	if err := s.setMeta(name, metadata); err != nil {
426
+		return nil, err
427
+	}
439 428
 	return volumeWrapper{v, labels, vd.Scope(), opts}, nil
440 429
 }
441 430
 
... ...
@@ -482,48 +459,41 @@ func (s *VolumeStore) Get(name string) (volume.Volume, error) {
482 482
 // if the driver is unknown it probes all drivers until it finds the first volume with that name.
483 483
 // it is expected that callers of this function hold any necessary locks
484 484
 func (s *VolumeStore) getVolume(name string) (volume.Volume, error) {
485
-	labels := map[string]string{}
486
-	options := map[string]string{}
487
-
488
-	if s.db != nil {
489
-		// get meta
490
-		if err := s.db.Update(func(tx *bolt.Tx) error {
491
-			b := tx.Bucket([]byte(volumeBucketName))
492
-			data := b.Get([]byte(name))
493
-
494
-			if string(data) == "" {
495
-				return nil
496
-			}
497
-
498
-			var meta volumeMetadata
499
-			buf := bytes.NewBuffer(data)
485
+	var meta volumeMetadata
486
+	meta, err := s.getMeta(name)
487
+	if err != nil {
488
+		return nil, err
489
+	}
500 490
 
501
-			if err := json.NewDecoder(buf).Decode(&meta); err != nil {
502
-				return err
491
+	driverName := meta.Driver
492
+	if driverName == "" {
493
+		s.globalLock.RLock()
494
+		v, exists := s.names[name]
495
+		s.globalLock.RUnlock()
496
+		if exists {
497
+			meta.Driver = v.DriverName()
498
+			if err := s.setMeta(name, meta); err != nil {
499
+				return nil, err
503 500
 			}
504
-			labels = meta.Labels
505
-			options = meta.Options
506
-
507
-			return nil
508
-		}); err != nil {
509
-			return nil, err
510 501
 		}
511 502
 	}
512 503
 
513
-	logrus.Debugf("Getting volume reference for name: %s", name)
514
-	s.globalLock.RLock()
515
-	v, exists := s.names[name]
516
-	s.globalLock.RUnlock()
517
-	if exists {
518
-		vd, err := volumedrivers.GetDriver(v.DriverName())
504
+	if meta.Driver != "" {
505
+		vol, err := lookupVolume(meta.Driver, name)
519 506
 		if err != nil {
520 507
 			return nil, err
521 508
 		}
522
-		vol, err := vd.Get(name)
523
-		if err != nil {
524
-			return nil, err
509
+		if vol == nil {
510
+			s.Purge(name)
511
+			return nil, errNoSuchVolume
525 512
 		}
526
-		return volumeWrapper{vol, labels, vd.Scope(), options}, nil
513
+
514
+		var scope string
515
+		vd, err := volumedrivers.GetDriver(meta.Driver)
516
+		if err == nil {
517
+			scope = vd.Scope()
518
+		}
519
+		return volumeWrapper{vol, meta.Labels, scope, meta.Options}, nil
527 520
 	}
528 521
 
529 522
 	logrus.Debugf("Probing all drivers for volume with name: %s", name)
... ...
@@ -534,15 +504,42 @@ func (s *VolumeStore) getVolume(name string) (volume.Volume, error) {
534 534
 
535 535
 	for _, d := range drivers {
536 536
 		v, err := d.Get(name)
537
-		if err != nil {
537
+		if err != nil || v == nil {
538 538
 			continue
539 539
 		}
540
-
541
-		return volumeWrapper{v, labels, d.Scope(), options}, nil
540
+		meta.Driver = v.DriverName()
541
+		if err := s.setMeta(name, meta); err != nil {
542
+			return nil, err
543
+		}
544
+		return volumeWrapper{v, meta.Labels, d.Scope(), meta.Options}, nil
542 545
 	}
543 546
 	return nil, errNoSuchVolume
544 547
 }
545 548
 
549
+// lookupVolume gets the specified volume from the specified driver.
550
+// This will only return errors related to communications with the driver.
551
+// If the driver returns an error that is not communication related the
552
+//   error is logged but not returned.
553
+// If the volume is not found it will return `nil, nil``
554
+func lookupVolume(driverName, volumeName string) (volume.Volume, error) {
555
+	vd, err := volumedrivers.GetDriver(driverName)
556
+	if err != nil {
557
+		return nil, errors.Wrapf(err, "error while checking if volume %q exists in driver %q", volumeName, driverName)
558
+	}
559
+	v, err := vd.Get(volumeName)
560
+	if err != nil {
561
+		err = errors.Cause(err)
562
+		if _, ok := err.(net.Error); ok {
563
+			return nil, errors.Wrapf(err, "error while checking if volume %q exists in driver %q", v.Name(), v.DriverName())
564
+		}
565
+
566
+		// At this point, the error could be anything from the driver, such as "no such volume"
567
+		// Let's not check an error here, and instead check if the driver returned a volume
568
+		logrus.WithError(err).WithField("driver", driverName).WithField("volume", volumeName).Warnf("Error while looking up volume")
569
+	}
570
+	return v, nil
571
+}
572
+
546 573
 // Remove removes the requested volume. A volume is not removed if it has any refs
547 574
 func (s *VolumeStore) Remove(v volume.Volume) error {
548 575
 	name := normaliseVolumeName(v.Name())
... ...
@@ -553,7 +550,7 @@ func (s *VolumeStore) Remove(v volume.Volume) error {
553 553
 		return &OpErr{Err: errVolumeInUse, Name: v.Name(), Op: "remove", Refs: s.getRefs(name)}
554 554
 	}
555 555
 
556
-	vd, err := volumedrivers.RemoveDriver(v.DriverName())
556
+	vd, err := volumedrivers.GetDriver(v.DriverName())
557 557
 	if err != nil {
558 558
 		return &OpErr{Err: err, Name: vd.Name(), Op: "remove"}
559 559
 	}
... ...
@@ -651,3 +648,9 @@ func unwrapVolume(v volume.Volume) volume.Volume {
651 651
 
652 652
 	return v
653 653
 }
654
+
655
+// Shutdown releases all resources used by the volume store
656
+// It does not make any changes to volumes, drivers, etc.
657
+func (s *VolumeStore) Shutdown() error {
658
+	return s.db.Close()
659
+}
... ...
@@ -2,6 +2,8 @@ package store
2 2
 
3 3
 import (
4 4
 	"errors"
5
+	"io/ioutil"
6
+	"os"
5 7
 	"strings"
6 8
 	"testing"
7 9
 
... ...
@@ -16,7 +18,13 @@ func TestCreate(t *testing.T) {
16 16
 
17 17
 	volumedrivers.Register(volumetestutils.NewFakeDriver("fake"), "fake")
18 18
 	defer volumedrivers.Unregister("fake")
19
-	s, err := New("")
19
+	dir, err := ioutil.TempDir("", "test-create")
20
+	if err != nil {
21
+		t.Fatal(err)
22
+	}
23
+	defer os.RemoveAll(dir)
24
+
25
+	s, err := New(dir)
20 26
 	if err != nil {
21 27
 		t.Fatal(err)
22 28
 	}
... ...
@@ -47,7 +55,12 @@ func TestRemove(t *testing.T) {
47 47
 	volumedrivers.Register(volumetestutils.NewFakeDriver("noop"), "noop")
48 48
 	defer volumedrivers.Unregister("fake")
49 49
 	defer volumedrivers.Unregister("noop")
50
-	s, err := New("")
50
+	dir, err := ioutil.TempDir("", "test-remove")
51
+	if err != nil {
52
+		t.Fatal(err)
53
+	}
54
+	defer os.RemoveAll(dir)
55
+	s, err := New(dir)
51 56
 	if err != nil {
52 57
 		t.Fatal(err)
53 58
 	}
... ...
@@ -80,8 +93,13 @@ func TestList(t *testing.T) {
80 80
 	volumedrivers.Register(volumetestutils.NewFakeDriver("fake2"), "fake2")
81 81
 	defer volumedrivers.Unregister("fake")
82 82
 	defer volumedrivers.Unregister("fake2")
83
+	dir, err := ioutil.TempDir("", "test-list")
84
+	if err != nil {
85
+		t.Fatal(err)
86
+	}
87
+	defer os.RemoveAll(dir)
83 88
 
84
-	s, err := New("")
89
+	s, err := New(dir)
85 90
 	if err != nil {
86 91
 		t.Fatal(err)
87 92
 	}
... ...
@@ -99,9 +117,12 @@ func TestList(t *testing.T) {
99 99
 	if len(ls) != 2 {
100 100
 		t.Fatalf("expected 2 volumes, got: %d", len(ls))
101 101
 	}
102
+	if err := s.Shutdown(); err != nil {
103
+		t.Fatal(err)
104
+	}
102 105
 
103 106
 	// and again with a new store
104
-	s, err = New("")
107
+	s, err = New(dir)
105 108
 	if err != nil {
106 109
 		t.Fatal(err)
107 110
 	}
... ...
@@ -119,7 +140,11 @@ func TestFilterByDriver(t *testing.T) {
119 119
 	volumedrivers.Register(volumetestutils.NewFakeDriver("noop"), "noop")
120 120
 	defer volumedrivers.Unregister("fake")
121 121
 	defer volumedrivers.Unregister("noop")
122
-	s, err := New("")
122
+	dir, err := ioutil.TempDir("", "test-filter-driver")
123
+	if err != nil {
124
+		t.Fatal(err)
125
+	}
126
+	s, err := New(dir)
123 127
 	if err != nil {
124 128
 		t.Fatal(err)
125 129
 	}
... ...
@@ -146,8 +171,12 @@ func TestFilterByDriver(t *testing.T) {
146 146
 func TestFilterByUsed(t *testing.T) {
147 147
 	volumedrivers.Register(volumetestutils.NewFakeDriver("fake"), "fake")
148 148
 	volumedrivers.Register(volumetestutils.NewFakeDriver("noop"), "noop")
149
+	dir, err := ioutil.TempDir("", "test-filter-used")
150
+	if err != nil {
151
+		t.Fatal(err)
152
+	}
149 153
 
150
-	s, err := New("")
154
+	s, err := New(dir)
151 155
 	if err != nil {
152 156
 		t.Fatal(err)
153 157
 	}
... ...
@@ -183,8 +212,12 @@ func TestFilterByUsed(t *testing.T) {
183 183
 
184 184
 func TestDerefMultipleOfSameRef(t *testing.T) {
185 185
 	volumedrivers.Register(volumetestutils.NewFakeDriver("fake"), "fake")
186
+	dir, err := ioutil.TempDir("", "test-same-deref")
187
+	if err != nil {
188
+		t.Fatal(err)
189
+	}
186 190
 
187
-	s, err := New("")
191
+	s, err := New(dir)
188 192
 	if err != nil {
189 193
 		t.Fatal(err)
190 194
 	}