1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
25 "git.arvados.org/arvados.git/sdk/go/arvados"
26 "github.com/prometheus/client_golang/prometheus"
27 "github.com/sirupsen/logrus"
31 driver["Directory"] = newDirectoryVolume
34 func newDirectoryVolume(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) {
35 v := &UnixVolume{cluster: cluster, volume: volume, logger: logger, metrics: metrics}
36 err := json.Unmarshal(volume.DriverParameters, &v)
40 v.logger = v.logger.WithField("Volume", v.String())
44 func (v *UnixVolume) check() error {
46 return errors.New("DriverParameters.Root was not provided")
49 v.locker = &sync.Mutex{}
51 if !strings.HasPrefix(v.Root, "/") {
52 return fmt.Errorf("DriverParameters.Root %q does not start with '/'", v.Root)
55 // Set up prometheus metrics
56 lbls := prometheus.Labels{"device_id": v.GetDeviceID()}
57 v.os.stats.opsCounters, v.os.stats.errCounters, v.os.stats.ioBytes = v.metrics.getCounterVecsFor(lbls)
59 _, err := v.os.Stat(v.Root)
63 // A UnixVolume stores and retrieves blocks in a local directory.
64 type UnixVolume struct {
65 Root string // path to the volume's root directory
68 cluster *arvados.Cluster
70 logger logrus.FieldLogger
71 metrics *volumeMetricsVecs
73 // something to lock during IO, typically a sync.Mutex (or nil
80 // GetDeviceID returns a globally unique ID for the volume's root
81 // directory, consisting of the filesystem's UUID and the path from
82 // filesystem root to storage directory, joined by "/". For example,
83 // the device ID for a local directory "/mnt/xvda1/keep" might be
84 // "fa0b6166-3b55-4994-bd3f-92f4e00a1bb0/keep".
85 func (v *UnixVolume) GetDeviceID() string {
86 giveup := func(f string, args ...interface{}) string {
87 v.logger.Infof(f+"; using blank DeviceID for volume %s", append(args, v)...)
90 buf, err := exec.Command("findmnt", "--noheadings", "--target", v.Root).CombinedOutput()
92 return giveup("findmnt: %s (%q)", err, buf)
94 findmnt := strings.Fields(string(buf))
96 return giveup("could not parse findmnt output: %q", buf)
98 fsRoot, dev := findmnt[0], findmnt[1]
100 absRoot, err := filepath.Abs(v.Root)
102 return giveup("resolving relative path %q: %s", v.Root, err)
104 realRoot, err := filepath.EvalSymlinks(absRoot)
106 return giveup("resolving symlinks in %q: %s", absRoot, err)
109 // Find path from filesystem root to realRoot
111 if strings.HasPrefix(realRoot, fsRoot+"/") {
112 fsPath = realRoot[len(fsRoot):]
113 } else if fsRoot == "/" {
115 } else if fsRoot == realRoot {
118 return giveup("findmnt reports mount point %q which is not a prefix of volume root %q", fsRoot, realRoot)
121 if !strings.HasPrefix(dev, "/") {
122 return giveup("mount %q device %q is not a path", fsRoot, dev)
125 fi, err := os.Stat(dev)
127 return giveup("stat %q: %s", dev, err)
129 ino := fi.Sys().(*syscall.Stat_t).Ino
131 // Find a symlink in /dev/disk/by-uuid/ whose target is (i.e.,
132 // has the same inode as) the mounted device
133 udir := "/dev/disk/by-uuid"
134 d, err := os.Open(udir)
136 return giveup("opening %q: %s", udir, err)
139 uuids, err := d.Readdirnames(0)
141 return giveup("reading %q: %s", udir, err)
143 for _, uuid := range uuids {
144 link := filepath.Join(udir, uuid)
145 fi, err = os.Stat(link)
147 v.logger.WithError(err).Errorf("stat(%q) failed", link)
150 if fi.Sys().(*syscall.Stat_t).Ino == ino {
154 return giveup("could not find entry in %q matching %q", udir, dev)
157 // Touch sets the timestamp for the given locator to the current time
158 func (v *UnixVolume) Touch(loc string) error {
159 if v.volume.ReadOnly {
160 return MethodDisabledError
162 p := v.blockPath(loc)
163 f, err := v.os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
168 if err := v.lock(context.TODO()); err != nil {
172 if e := v.lockfile(f); e != nil {
175 defer v.unlockfile(f)
177 v.os.stats.TickOps("utimes")
178 v.os.stats.Tick(&v.os.stats.UtimesOps)
179 err = os.Chtimes(p, ts, ts)
180 v.os.stats.TickErr(err)
184 // Mtime returns the stored timestamp for the given locator.
185 func (v *UnixVolume) Mtime(loc string) (time.Time, error) {
186 p := v.blockPath(loc)
187 fi, err := v.os.Stat(p)
189 return time.Time{}, err
191 return fi.ModTime(), nil
194 // Lock the locker (if one is in use), open the file for reading, and
195 // call the given function if and when the file is ready to read.
196 func (v *UnixVolume) getFunc(ctx context.Context, path string, fn func(io.Reader) error) error {
197 if err := v.lock(ctx); err != nil {
201 f, err := v.os.Open(path)
206 return fn(NewCountingReader(ioutil.NopCloser(f), v.os.stats.TickInBytes))
209 // stat is os.Stat() with some extra sanity checks.
210 func (v *UnixVolume) stat(path string) (os.FileInfo, error) {
211 stat, err := v.os.Stat(path)
215 } else if stat.Size() > BlockSize {
222 // Get retrieves a block, copies it to the given slice, and returns
223 // the number of bytes copied.
224 func (v *UnixVolume) Get(ctx context.Context, loc string, buf []byte) (int, error) {
225 return getWithPipe(ctx, loc, buf, v)
228 // ReadBlock implements BlockReader.
229 func (v *UnixVolume) ReadBlock(ctx context.Context, loc string, w io.Writer) error {
230 path := v.blockPath(loc)
231 stat, err := v.stat(path)
233 return v.translateError(err)
235 return v.getFunc(ctx, path, func(rdr io.Reader) error {
236 n, err := io.Copy(w, rdr)
237 if err == nil && n != stat.Size() {
238 err = io.ErrUnexpectedEOF
244 // Compare returns nil if Get(loc) would return the same content as
245 // expect. It is functionally equivalent to Get() followed by
246 // bytes.Compare(), but uses less memory.
247 func (v *UnixVolume) Compare(ctx context.Context, loc string, expect []byte) error {
248 path := v.blockPath(loc)
249 if _, err := v.stat(path); err != nil {
250 return v.translateError(err)
252 return v.getFunc(ctx, path, func(rdr io.Reader) error {
253 return compareReaderWithBuf(ctx, rdr, expect, loc[:32])
257 // Put stores a block of data identified by the locator string
258 // "loc". It returns nil on success. If the volume is full, it
259 // returns a FullError. If the write fails due to some other error,
260 // that error is returned.
261 func (v *UnixVolume) Put(ctx context.Context, loc string, block []byte) error {
262 return putWithPipe(ctx, loc, block, v)
265 // WriteBlock implements BlockWriter.
266 func (v *UnixVolume) WriteBlock(ctx context.Context, loc string, rdr io.Reader) error {
267 if v.volume.ReadOnly {
268 return MethodDisabledError
273 bdir := v.blockDir(loc)
274 if err := os.MkdirAll(bdir, 0755); err != nil {
275 return fmt.Errorf("error creating directory %s: %s", bdir, err)
278 bpath := v.blockPath(loc)
279 tmpfile, err := v.os.TempFile(bdir, "tmp"+loc)
281 return fmt.Errorf("TempFile(%s, tmp%s) failed: %s", bdir, loc, err)
283 defer v.os.Remove(tmpfile.Name())
284 defer tmpfile.Close()
286 if err = v.lock(ctx); err != nil {
290 n, err := io.Copy(tmpfile, rdr)
291 v.os.stats.TickOutBytes(uint64(n))
293 return fmt.Errorf("error writing %s: %s", bpath, err)
295 if err = tmpfile.Close(); err != nil {
296 return fmt.Errorf("error closing %s: %s", tmpfile.Name(), err)
298 // ext4 uses a low-precision clock and effectively backdates
299 // files by up to 10 ms, sometimes across a 1-second boundary,
300 // which produces confusing results in logs and tests. We
301 // avoid this by setting the output file's timestamps
302 // explicitly, using a higher resolution clock.
304 v.os.stats.TickOps("utimes")
305 v.os.stats.Tick(&v.os.stats.UtimesOps)
306 if err = os.Chtimes(tmpfile.Name(), ts, ts); err != nil {
307 return fmt.Errorf("error setting timestamps on %s: %s", tmpfile.Name(), err)
309 if err = v.os.Rename(tmpfile.Name(), bpath); err != nil {
310 return fmt.Errorf("error renaming %s to %s: %s", tmpfile.Name(), bpath, err)
315 // Status returns a VolumeStatus struct describing the volume's
316 // current state, or nil if an error occurs.
318 func (v *UnixVolume) Status() *VolumeStatus {
319 fi, err := v.os.Stat(v.Root)
321 v.logger.WithError(err).Error("stat failed")
324 devnum := fi.Sys().(*syscall.Stat_t).Dev
326 var fs syscall.Statfs_t
327 if err := syscall.Statfs(v.Root, &fs); err != nil {
328 v.logger.WithError(err).Error("statfs failed")
331 // These calculations match the way df calculates disk usage:
332 // "free" space is measured by fs.Bavail, but "used" space
333 // uses fs.Blocks - fs.Bfree.
334 free := fs.Bavail * uint64(fs.Bsize)
335 used := (fs.Blocks - fs.Bfree) * uint64(fs.Bsize)
336 return &VolumeStatus{
344 var blockDirRe = regexp.MustCompile(`^[0-9a-f]+$`)
345 var blockFileRe = regexp.MustCompile(`^[0-9a-f]{32}$`)
347 // IndexTo writes (to the given Writer) a list of blocks found on this
348 // volume which begin with the specified prefix. If the prefix is an
349 // empty string, IndexTo writes a complete list of blocks.
351 // Each block is given in the format
353 // locator+size modification-time {newline}
357 // e4df392f86be161ca6ed3773a962b8f3+67108864 1388894303
358 // e4d41e6fd68460e0e3fc18cc746959d2+67108864 1377796043
359 // e4de7a2810f5554cd39b36d8ddb132ff+67108864 1388701136
361 func (v *UnixVolume) IndexTo(prefix string, w io.Writer) error {
363 rootdir, err := v.os.Open(v.Root)
367 defer rootdir.Close()
368 v.os.stats.TickOps("readdir")
369 v.os.stats.Tick(&v.os.stats.ReaddirOps)
371 names, err := rootdir.Readdirnames(1)
374 } else if err != nil {
377 if !strings.HasPrefix(names[0], prefix) && !strings.HasPrefix(prefix, names[0]) {
378 // prefix excludes all blocks stored in this dir
381 if !blockDirRe.MatchString(names[0]) {
384 blockdirpath := filepath.Join(v.Root, names[0])
385 blockdir, err := v.os.Open(blockdirpath)
387 v.logger.WithError(err).Errorf("error reading %q", blockdirpath)
388 lastErr = fmt.Errorf("error reading %q: %s", blockdirpath, err)
391 v.os.stats.TickOps("readdir")
392 v.os.stats.Tick(&v.os.stats.ReaddirOps)
394 fileInfo, err := blockdir.Readdir(1)
397 } else if err != nil {
398 v.logger.WithError(err).Errorf("error reading %q", blockdirpath)
399 lastErr = fmt.Errorf("error reading %q: %s", blockdirpath, err)
402 name := fileInfo[0].Name()
403 if !strings.HasPrefix(name, prefix) {
406 if !blockFileRe.MatchString(name) {
409 _, err = fmt.Fprint(w,
411 "+", fileInfo[0].Size(),
412 " ", fileInfo[0].ModTime().UnixNano(),
416 return fmt.Errorf("error writing: %s", err)
423 // Trash trashes the block data from the unix storage
424 // If BlobTrashLifetime == 0, the block is deleted
425 // Else, the block is renamed as path/{loc}.trash.{deadline},
426 // where deadline = now + BlobTrashLifetime
427 func (v *UnixVolume) Trash(loc string) error {
428 // Touch() must be called before calling Write() on a block. Touch()
429 // also uses lockfile(). This avoids a race condition between Write()
430 // and Trash() because either (a) the file will be trashed and Touch()
431 // will signal to the caller that the file is not present (and needs to
432 // be re-written), or (b) Touch() will update the file's timestamp and
433 // Trash() will read the correct up-to-date timestamp and choose not to
436 if v.volume.ReadOnly || !v.cluster.Collections.BlobTrash {
437 return MethodDisabledError
439 if err := v.lock(context.TODO()); err != nil {
443 p := v.blockPath(loc)
444 f, err := v.os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
449 if e := v.lockfile(f); e != nil {
452 defer v.unlockfile(f)
454 // If the block has been PUT in the last blobSignatureTTL
455 // seconds, return success without removing the block. This
456 // protects data from garbage collection until it is no longer
457 // possible for clients to retrieve the unreferenced blocks
458 // anyway (because the permission signatures have expired).
459 if fi, err := v.os.Stat(p); err != nil {
461 } else if time.Since(fi.ModTime()) < v.cluster.Collections.BlobSigningTTL.Duration() {
465 if v.cluster.Collections.BlobTrashLifetime == 0 {
466 return v.os.Remove(p)
468 return v.os.Rename(p, fmt.Sprintf("%v.trash.%d", p, time.Now().Add(v.cluster.Collections.BlobTrashLifetime.Duration()).Unix()))
471 // Untrash moves block from trash back into store
472 // Look for path/{loc}.trash.{deadline} in storage,
473 // and rename the first such file as path/{loc}
474 func (v *UnixVolume) Untrash(loc string) (err error) {
475 if v.volume.ReadOnly {
476 return MethodDisabledError
479 v.os.stats.TickOps("readdir")
480 v.os.stats.Tick(&v.os.stats.ReaddirOps)
481 files, err := ioutil.ReadDir(v.blockDir(loc))
487 return os.ErrNotExist
491 prefix := fmt.Sprintf("%v.trash.", loc)
492 for _, f := range files {
493 if strings.HasPrefix(f.Name(), prefix) {
495 err = v.os.Rename(v.blockPath(f.Name()), v.blockPath(loc))
502 if foundTrash == false {
503 return os.ErrNotExist
509 // blockDir returns the fully qualified directory name for the directory
510 // where loc is (or would be) stored on this volume.
511 func (v *UnixVolume) blockDir(loc string) string {
512 return filepath.Join(v.Root, loc[0:3])
515 // blockPath returns the fully qualified pathname for the path to loc
517 func (v *UnixVolume) blockPath(loc string) string {
518 return filepath.Join(v.blockDir(loc), loc)
521 // IsFull returns true if the free space on the volume is less than
524 func (v *UnixVolume) IsFull() (isFull bool) {
525 fullSymlink := v.Root + "/full"
527 // Check if the volume has been marked as full in the last hour.
528 if link, err := os.Readlink(fullSymlink); err == nil {
529 if ts, err := strconv.Atoi(link); err == nil {
530 fulltime := time.Unix(int64(ts), 0)
531 if time.Since(fulltime).Hours() < 1.0 {
537 if avail, err := v.FreeDiskSpace(); err == nil {
538 isFull = avail < MinFreeKilobytes
540 v.logger.WithError(err).Errorf("%s: FreeDiskSpace failed", v)
544 // If the volume is full, timestamp it.
546 now := fmt.Sprintf("%d", time.Now().Unix())
547 os.Symlink(now, fullSymlink)
552 // FreeDiskSpace returns the number of unused 1k blocks available on
555 func (v *UnixVolume) FreeDiskSpace() (free uint64, err error) {
556 var fs syscall.Statfs_t
557 err = syscall.Statfs(v.Root, &fs)
559 // Statfs output is not guaranteed to measure free
560 // space in terms of 1K blocks.
561 free = fs.Bavail * uint64(fs.Bsize) / 1024
566 func (v *UnixVolume) String() string {
567 return fmt.Sprintf("[UnixVolume %s]", v.Root)
570 // InternalStats returns I/O and filesystem ops counters.
571 func (v *UnixVolume) InternalStats() interface{} {
575 // lock acquires the serialize lock, if one is in use. If ctx is done
576 // before the lock is acquired, lock returns ctx.Err() instead of
577 // acquiring the lock.
578 func (v *UnixVolume) lock(ctx context.Context) error {
583 locked := make(chan struct{})
590 v.logger.Infof("client hung up while waiting for Serialize lock (%s)", time.Since(t0))
601 // unlock releases the serialize lock, if one is in use.
602 func (v *UnixVolume) unlock() {
609 // lockfile and unlockfile use flock(2) to manage kernel file locks.
610 func (v *UnixVolume) lockfile(f *os.File) error {
611 v.os.stats.TickOps("flock")
612 v.os.stats.Tick(&v.os.stats.FlockOps)
613 err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX)
614 v.os.stats.TickErr(err)
618 func (v *UnixVolume) unlockfile(f *os.File) error {
619 err := syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
620 v.os.stats.TickErr(err)
624 // Where appropriate, translate a more specific filesystem error to an
625 // error recognized by handlers, like os.ErrNotExist.
626 func (v *UnixVolume) translateError(err error) error {
629 // stat() returns a PathError if the parent directory
630 // (not just the file itself) is missing
631 return os.ErrNotExist
637 var unixTrashLocRegexp = regexp.MustCompile(`/([0-9a-f]{32})\.trash\.(\d+)$`)
639 // EmptyTrash walks hierarchy looking for {hash}.trash.*
640 // and deletes those with deadline < now.
641 func (v *UnixVolume) EmptyTrash() {
642 if v.cluster.Collections.BlobDeleteConcurrency < 1 {
646 var bytesDeleted, bytesInTrash int64
647 var blocksDeleted, blocksInTrash int64
649 doFile := func(path string, info os.FileInfo) {
650 if info.Mode().IsDir() {
653 matches := unixTrashLocRegexp.FindStringSubmatch(path)
654 if len(matches) != 3 {
657 deadline, err := strconv.ParseInt(matches[2], 10, 64)
659 v.logger.WithError(err).Errorf("EmptyTrash: %v: ParseInt(%q) failed", path, matches[2])
662 atomic.AddInt64(&bytesInTrash, info.Size())
663 atomic.AddInt64(&blocksInTrash, 1)
664 if deadline > time.Now().Unix() {
667 err = v.os.Remove(path)
669 v.logger.WithError(err).Errorf("EmptyTrash: Remove(%q) failed", path)
672 atomic.AddInt64(&bytesDeleted, info.Size())
673 atomic.AddInt64(&blocksDeleted, 1)
680 var wg sync.WaitGroup
681 todo := make(chan dirent, v.cluster.Collections.BlobDeleteConcurrency)
682 for i := 0; i < v.cluster.Collections.BlobDeleteConcurrency; i++ {
686 for e := range todo {
687 doFile(e.path, e.info)
692 err := filepath.Walk(v.Root, func(path string, info os.FileInfo, err error) error {
694 v.logger.WithError(err).Errorf("EmptyTrash: filepath.Walk(%q) failed", path)
695 // Don't give up -- keep walking other
698 } else if !info.Mode().IsDir() {
699 todo <- dirent{path, info}
701 } else if path == v.Root || blockDirRe.MatchString(info.Name()) {
702 // Descend into a directory that we might have
706 // Don't descend into other dirs.
707 return filepath.SkipDir
714 v.logger.WithError(err).Error("EmptyTrash failed")
717 v.logger.Infof("EmptyTrash stats: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted)
720 type unixStats struct {
732 func (s *unixStats) TickErr(err error) {
736 s.statsTicker.TickErr(err, fmt.Sprintf("%T", err))
739 type osWithStats struct {
743 func (o *osWithStats) Open(name string) (*os.File, error) {
744 o.stats.TickOps("open")
745 o.stats.Tick(&o.stats.OpenOps)
746 f, err := os.Open(name)
751 func (o *osWithStats) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error) {
752 o.stats.TickOps("open")
753 o.stats.Tick(&o.stats.OpenOps)
754 f, err := os.OpenFile(name, flag, perm)
759 func (o *osWithStats) Remove(path string) error {
760 o.stats.TickOps("unlink")
761 o.stats.Tick(&o.stats.UnlinkOps)
762 err := os.Remove(path)
767 func (o *osWithStats) Rename(a, b string) error {
768 o.stats.TickOps("rename")
769 o.stats.Tick(&o.stats.RenameOps)
770 err := os.Rename(a, b)
775 func (o *osWithStats) Stat(path string) (os.FileInfo, error) {
776 o.stats.TickOps("stat")
777 o.stats.Tick(&o.stats.StatOps)
778 fi, err := os.Stat(path)
783 func (o *osWithStats) TempFile(dir, base string) (*os.File, error) {
784 o.stats.TickOps("create")
785 o.stats.Tick(&o.stats.CreateOps)
786 f, err := ioutil.TempFile(dir, base)