services/keepstore/unix_volume.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package keepstore
   6
   7 import (
   8         "context"
   9         "encoding/json"
  10         "errors"
  11         "fmt"
  12         "io"
  13         "io/ioutil"
  14         "os"
  15         "os/exec"
  16         "path/filepath"
  17         "regexp"
  18         "strconv"
  19         "strings"
  20         "sync"
  21         "sync/atomic"
  22         "syscall"
  23         "time"
  24
  25         "git.arvados.org/arvados.git/sdk/go/arvados"
  26         "github.com/prometheus/client_golang/prometheus"
  27         "github.com/sirupsen/logrus"
  28 )
  29
  30 func init() {
  31         driver["Directory"] = newDirectoryVolume
  32 }
  33
  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)
  37         if err != nil {
  38                 return nil, err
  39         }
  40         v.logger = v.logger.WithField("Volume", v.String())
  41         return v, v.check()
  42 }
  43
  44 func (v *UnixVolume) check() error {
  45         if v.Root == "" {
  46                 return errors.New("DriverParameters.Root was not provided")
  47         }
  48         if v.Serialize {
  49                 v.locker = &sync.Mutex{}
  50         }
  51         if !strings.HasPrefix(v.Root, "/") {
  52                 return fmt.Errorf("DriverParameters.Root %q does not start with '/'", v.Root)
  53         }
  54
  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)
  58
  59         _, err := v.os.Stat(v.Root)
  60         return err
  61 }
  62
  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
  66         Serialize bool
  67
  68         cluster *arvados.Cluster
  69         volume  arvados.Volume
  70         logger  logrus.FieldLogger
  71         metrics *volumeMetricsVecs
  72
  73         // something to lock during IO, typically a sync.Mutex (or nil
  74         // to skip locking)
  75         locker sync.Locker
  76
  77         os osWithStats
  78 }
  79
  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)...)
  88                 return ""
  89         }
  90         buf, err := exec.Command("findmnt", "--noheadings", "--target", v.Root).CombinedOutput()
  91         if err != nil {
  92                 return giveup("findmnt: %s (%q)", err, buf)
  93         }
  94         findmnt := strings.Fields(string(buf))
  95         if len(findmnt) < 2 {
  96                 return giveup("could not parse findmnt output: %q", buf)
  97         }
  98         fsRoot, dev := findmnt[0], findmnt[1]
  99
 100         absRoot, err := filepath.Abs(v.Root)
 101         if err != nil {
 102                 return giveup("resolving relative path %q: %s", v.Root, err)
 103         }
 104         realRoot, err := filepath.EvalSymlinks(absRoot)
 105         if err != nil {
 106                 return giveup("resolving symlinks in %q: %s", absRoot, err)
 107         }
 108
 109         // Find path from filesystem root to realRoot
 110         var fsPath string
 111         if strings.HasPrefix(realRoot, fsRoot+"/") {
 112                 fsPath = realRoot[len(fsRoot):]
 113         } else if fsRoot == "/" {
 114                 fsPath = realRoot
 115         } else if fsRoot == realRoot {
 116                 fsPath = ""
 117         } else {
 118                 return giveup("findmnt reports mount point %q which is not a prefix of volume root %q", fsRoot, realRoot)
 119         }
 120
 121         if !strings.HasPrefix(dev, "/") {
 122                 return giveup("mount %q device %q is not a path", fsRoot, dev)
 123         }
 124
 125         fi, err := os.Stat(dev)
 126         if err != nil {
 127                 return giveup("stat %q: %s", dev, err)
 128         }
 129         ino := fi.Sys().(*syscall.Stat_t).Ino
 130
 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)
 135         if err != nil {
 136                 return giveup("opening %q: %s", udir, err)
 137         }
 138         defer d.Close()
 139         uuids, err := d.Readdirnames(0)
 140         if err != nil {
 141                 return giveup("reading %q: %s", udir, err)
 142         }
 143         for _, uuid := range uuids {
 144                 link := filepath.Join(udir, uuid)
 145                 fi, err = os.Stat(link)
 146                 if err != nil {
 147                         v.logger.WithError(err).Errorf("stat(%q) failed", link)
 148                         continue
 149                 }
 150                 if fi.Sys().(*syscall.Stat_t).Ino == ino {
 151                         return uuid + fsPath
 152                 }
 153         }
 154         return giveup("could not find entry in %q matching %q", udir, dev)
 155 }
 156
 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
 161         }
 162         p := v.blockPath(loc)
 163         f, err := v.os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
 164         if err != nil {
 165                 return err
 166         }
 167         defer f.Close()
 168         if err := v.lock(context.TODO()); err != nil {
 169                 return err
 170         }
 171         defer v.unlock()
 172         if e := v.lockfile(f); e != nil {
 173                 return e
 174         }
 175         defer v.unlockfile(f)
 176         ts := time.Now()
 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)
 181         return err
 182 }
 183
 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)
 188         if err != nil {
 189                 return time.Time{}, err
 190         }
 191         return fi.ModTime(), nil
 192 }
 193
 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 {
 198                 return err
 199         }
 200         defer v.unlock()
 201         f, err := v.os.Open(path)
 202         if err != nil {
 203                 return err
 204         }
 205         defer f.Close()
 206         return fn(NewCountingReader(ioutil.NopCloser(f), v.os.stats.TickInBytes))
 207 }
 208
 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)
 212         if err == nil {
 213                 if stat.Size() < 0 {
 214                         err = os.ErrInvalid
 215                 } else if stat.Size() > BlockSize {
 216                         err = TooLongError
 217                 }
 218         }
 219         return stat, err
 220 }
 221
 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)
 226 }
 227
 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)
 232         if err != nil {
 233                 return v.translateError(err)
 234         }
 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
 239                 }
 240                 return err
 241         })
 242 }
 243
 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)
 251         }
 252         return v.getFunc(ctx, path, func(rdr io.Reader) error {
 253                 return compareReaderWithBuf(ctx, rdr, expect, loc[:32])
 254         })
 255 }
 256
 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)
 263 }
 264
 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
 269         }
 270         if v.IsFull() {
 271                 return FullError
 272         }
 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)
 276         }
 277
 278         bpath := v.blockPath(loc)
 279         tmpfile, err := v.os.TempFile(bdir, "tmp"+loc)
 280         if err != nil {
 281                 return fmt.Errorf("TempFile(%s, tmp%s) failed: %s", bdir, loc, err)
 282         }
 283         defer v.os.Remove(tmpfile.Name())
 284         defer tmpfile.Close()
 285
 286         if err = v.lock(ctx); err != nil {
 287                 return err
 288         }
 289         defer v.unlock()
 290         n, err := io.Copy(tmpfile, rdr)
 291         v.os.stats.TickOutBytes(uint64(n))
 292         if err != nil {
 293                 return fmt.Errorf("error writing %s: %s", bpath, err)
 294         }
 295         if err = tmpfile.Close(); err != nil {
 296                 return fmt.Errorf("error closing %s: %s", tmpfile.Name(), err)
 297         }
 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.
 303         ts := time.Now()
 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)
 308         }
 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)
 311         }
 312         return nil
 313 }
 314
 315 // Status returns a VolumeStatus struct describing the volume's
 316 // current state, or nil if an error occurs.
 317 //
 318 func (v *UnixVolume) Status() *VolumeStatus {
 319         fi, err := v.os.Stat(v.Root)
 320         if err != nil {
 321                 v.logger.WithError(err).Error("stat failed")
 322                 return nil
 323         }
 324         // uint64() cast here supports GOOS=darwin where Dev is
 325         // int32. If the device number is negative, the unsigned
 326         // devnum won't be the real device number any more, but that's
 327         // fine -- all we care about is getting the same number each
 328         // time.
 329         devnum := uint64(fi.Sys().(*syscall.Stat_t).Dev)
 330
 331         var fs syscall.Statfs_t
 332         if err := syscall.Statfs(v.Root, &fs); err != nil {
 333                 v.logger.WithError(err).Error("statfs failed")
 334                 return nil
 335         }
 336         // These calculations match the way df calculates disk usage:
 337         // "free" space is measured by fs.Bavail, but "used" space
 338         // uses fs.Blocks - fs.Bfree.
 339         free := fs.Bavail * uint64(fs.Bsize)
 340         used := (fs.Blocks - fs.Bfree) * uint64(fs.Bsize)
 341         return &VolumeStatus{
 342                 MountPoint: v.Root,
 343                 DeviceNum:  devnum,
 344                 BytesFree:  free,
 345                 BytesUsed:  used,
 346         }
 347 }
 348
 349 var blockDirRe = regexp.MustCompile(`^[0-9a-f]+$`)
 350 var blockFileRe = regexp.MustCompile(`^[0-9a-f]{32}$`)
 351
 352 // IndexTo writes (to the given Writer) a list of blocks found on this
 353 // volume which begin with the specified prefix. If the prefix is an
 354 // empty string, IndexTo writes a complete list of blocks.
 355 //
 356 // Each block is given in the format
 357 //
 358 //     locator+size modification-time {newline}
 359 //
 360 // e.g.:
 361 //
 362 //     e4df392f86be161ca6ed3773a962b8f3+67108864 1388894303
 363 //     e4d41e6fd68460e0e3fc18cc746959d2+67108864 1377796043
 364 //     e4de7a2810f5554cd39b36d8ddb132ff+67108864 1388701136
 365 //
 366 func (v *UnixVolume) IndexTo(prefix string, w io.Writer) error {
 367         rootdir, err := v.os.Open(v.Root)
 368         if err != nil {
 369                 return err
 370         }
 371         v.os.stats.TickOps("readdir")
 372         v.os.stats.Tick(&v.os.stats.ReaddirOps)
 373         subdirs, err := rootdir.Readdirnames(-1)
 374         rootdir.Close()
 375         if err != nil {
 376                 return err
 377         }
 378         for _, subdir := range subdirs {
 379                 if !strings.HasPrefix(subdir, prefix) && !strings.HasPrefix(prefix, subdir) {
 380                         // prefix excludes all blocks stored in this dir
 381                         continue
 382                 }
 383                 if !blockDirRe.MatchString(subdir) {
 384                         continue
 385                 }
 386                 blockdirpath := filepath.Join(v.Root, subdir)
 387
 388                 var dirents []os.DirEntry
 389                 for attempt := 0; ; attempt++ {
 390                         v.os.stats.TickOps("readdir")
 391                         v.os.stats.Tick(&v.os.stats.ReaddirOps)
 392                         dirents, err = os.ReadDir(blockdirpath)
 393                         if err == nil {
 394                                 break
 395                         } else if attempt < 5 && strings.Contains(err.Error(), "errno 523") {
 396                                 // EBADCOOKIE (NFS stopped accepting
 397                                 // our readdirent cookie) -- retry a
 398                                 // few times before giving up
 399                                 v.logger.WithError(err).Printf("retry after error reading %s", blockdirpath)
 400                                 continue
 401                         } else {
 402                                 return err
 403                         }
 404                 }
 405
 406                 for _, dirent := range dirents {
 407                         fileInfo, err := dirent.Info()
 408                         if os.IsNotExist(err) {
 409                                 // File disappeared between ReadDir() and now
 410                                 continue
 411                         } else if err != nil {
 412                                 v.logger.WithError(err).Errorf("error getting FileInfo for %q in %q", dirent.Name(), blockdirpath)
 413                                 return err
 414                         }
 415                         name := fileInfo.Name()
 416                         if !strings.HasPrefix(name, prefix) {
 417                                 continue
 418                         }
 419                         if !blockFileRe.MatchString(name) {
 420                                 continue
 421                         }
 422                         _, err = fmt.Fprint(w,
 423                                 name,
 424                                 "+", fileInfo.Size(),
 425                                 " ", fileInfo.ModTime().UnixNano(),
 426                                 "\n")
 427                         if err != nil {
 428                                 return fmt.Errorf("error writing: %s", err)
 429                         }
 430                 }
 431         }
 432         return nil
 433 }
 434
 435 // Trash trashes the block data from the unix storage
 436 // If BlobTrashLifetime == 0, the block is deleted
 437 // Else, the block is renamed as path/{loc}.trash.{deadline},
 438 // where deadline = now + BlobTrashLifetime
 439 func (v *UnixVolume) Trash(loc string) error {
 440         // Touch() must be called before calling Write() on a block.  Touch()
 441         // also uses lockfile().  This avoids a race condition between Write()
 442         // and Trash() because either (a) the file will be trashed and Touch()
 443         // will signal to the caller that the file is not present (and needs to
 444         // be re-written), or (b) Touch() will update the file's timestamp and
 445         // Trash() will read the correct up-to-date timestamp and choose not to
 446         // trash the file.
 447
 448         if v.volume.ReadOnly || !v.cluster.Collections.BlobTrash {
 449                 return MethodDisabledError
 450         }
 451         if err := v.lock(context.TODO()); err != nil {
 452                 return err
 453         }
 454         defer v.unlock()
 455         p := v.blockPath(loc)
 456         f, err := v.os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
 457         if err != nil {
 458                 return err
 459         }
 460         defer f.Close()
 461         if e := v.lockfile(f); e != nil {
 462                 return e
 463         }
 464         defer v.unlockfile(f)
 465
 466         // If the block has been PUT in the last blobSignatureTTL
 467         // seconds, return success without removing the block. This
 468         // protects data from garbage collection until it is no longer
 469         // possible for clients to retrieve the unreferenced blocks
 470         // anyway (because the permission signatures have expired).
 471         if fi, err := v.os.Stat(p); err != nil {
 472                 return err
 473         } else if time.Since(fi.ModTime()) < v.cluster.Collections.BlobSigningTTL.Duration() {
 474                 return nil
 475         }
 476
 477         if v.cluster.Collections.BlobTrashLifetime == 0 {
 478                 return v.os.Remove(p)
 479         }
 480         return v.os.Rename(p, fmt.Sprintf("%v.trash.%d", p, time.Now().Add(v.cluster.Collections.BlobTrashLifetime.Duration()).Unix()))
 481 }
 482
 483 // Untrash moves block from trash back into store
 484 // Look for path/{loc}.trash.{deadline} in storage,
 485 // and rename the first such file as path/{loc}
 486 func (v *UnixVolume) Untrash(loc string) (err error) {
 487         if v.volume.ReadOnly {
 488                 return MethodDisabledError
 489         }
 490
 491         v.os.stats.TickOps("readdir")
 492         v.os.stats.Tick(&v.os.stats.ReaddirOps)
 493         files, err := ioutil.ReadDir(v.blockDir(loc))
 494         if err != nil {
 495                 return err
 496         }
 497
 498         if len(files) == 0 {
 499                 return os.ErrNotExist
 500         }
 501
 502         foundTrash := false
 503         prefix := fmt.Sprintf("%v.trash.", loc)
 504         for _, f := range files {
 505                 if strings.HasPrefix(f.Name(), prefix) {
 506                         foundTrash = true
 507                         err = v.os.Rename(v.blockPath(f.Name()), v.blockPath(loc))
 508                         if err == nil {
 509                                 break
 510                         }
 511                 }
 512         }
 513
 514         if foundTrash == false {
 515                 return os.ErrNotExist
 516         }
 517
 518         return
 519 }
 520
 521 // blockDir returns the fully qualified directory name for the directory
 522 // where loc is (or would be) stored on this volume.
 523 func (v *UnixVolume) blockDir(loc string) string {
 524         return filepath.Join(v.Root, loc[0:3])
 525 }
 526
 527 // blockPath returns the fully qualified pathname for the path to loc
 528 // on this volume.
 529 func (v *UnixVolume) blockPath(loc string) string {
 530         return filepath.Join(v.blockDir(loc), loc)
 531 }
 532
 533 // IsFull returns true if the free space on the volume is less than
 534 // MinFreeKilobytes.
 535 //
 536 func (v *UnixVolume) IsFull() (isFull bool) {
 537         fullSymlink := v.Root + "/full"
 538
 539         // Check if the volume has been marked as full in the last hour.
 540         if link, err := os.Readlink(fullSymlink); err == nil {
 541                 if ts, err := strconv.Atoi(link); err == nil {
 542                         fulltime := time.Unix(int64(ts), 0)
 543                         if time.Since(fulltime).Hours() < 1.0 {
 544                                 return true
 545                         }
 546                 }
 547         }
 548
 549         if avail, err := v.FreeDiskSpace(); err == nil {
 550                 isFull = avail < MinFreeKilobytes
 551         } else {
 552                 v.logger.WithError(err).Errorf("%s: FreeDiskSpace failed", v)
 553                 isFull = false
 554         }
 555
 556         // If the volume is full, timestamp it.
 557         if isFull {
 558                 now := fmt.Sprintf("%d", time.Now().Unix())
 559                 os.Symlink(now, fullSymlink)
 560         }
 561         return
 562 }
 563
 564 // FreeDiskSpace returns the number of unused 1k blocks available on
 565 // the volume.
 566 //
 567 func (v *UnixVolume) FreeDiskSpace() (free uint64, err error) {
 568         var fs syscall.Statfs_t
 569         err = syscall.Statfs(v.Root, &fs)
 570         if err == nil {
 571                 // Statfs output is not guaranteed to measure free
 572                 // space in terms of 1K blocks.
 573                 free = fs.Bavail * uint64(fs.Bsize) / 1024
 574         }
 575         return
 576 }
 577
 578 func (v *UnixVolume) String() string {
 579         return fmt.Sprintf("[UnixVolume %s]", v.Root)
 580 }
 581
 582 // InternalStats returns I/O and filesystem ops counters.
 583 func (v *UnixVolume) InternalStats() interface{} {
 584         return &v.os.stats
 585 }
 586
 587 // lock acquires the serialize lock, if one is in use. If ctx is done
 588 // before the lock is acquired, lock returns ctx.Err() instead of
 589 // acquiring the lock.
 590 func (v *UnixVolume) lock(ctx context.Context) error {
 591         if v.locker == nil {
 592                 return nil
 593         }
 594         t0 := time.Now()
 595         locked := make(chan struct{})
 596         go func() {
 597                 v.locker.Lock()
 598                 close(locked)
 599         }()
 600         select {
 601         case <-ctx.Done():
 602                 v.logger.Infof("client hung up while waiting for Serialize lock (%s)", time.Since(t0))
 603                 go func() {
 604                         <-locked
 605                         v.locker.Unlock()
 606                 }()
 607                 return ctx.Err()
 608         case <-locked:
 609                 return nil
 610         }
 611 }
 612
 613 // unlock releases the serialize lock, if one is in use.
 614 func (v *UnixVolume) unlock() {
 615         if v.locker == nil {
 616                 return
 617         }
 618         v.locker.Unlock()
 619 }
 620
 621 // lockfile and unlockfile use flock(2) to manage kernel file locks.
 622 func (v *UnixVolume) lockfile(f *os.File) error {
 623         v.os.stats.TickOps("flock")
 624         v.os.stats.Tick(&v.os.stats.FlockOps)
 625         err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX)
 626         v.os.stats.TickErr(err)
 627         return err
 628 }
 629
 630 func (v *UnixVolume) unlockfile(f *os.File) error {
 631         err := syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
 632         v.os.stats.TickErr(err)
 633         return err
 634 }
 635
 636 // Where appropriate, translate a more specific filesystem error to an
 637 // error recognized by handlers, like os.ErrNotExist.
 638 func (v *UnixVolume) translateError(err error) error {
 639         switch err.(type) {
 640         case *os.PathError:
 641                 // stat() returns a PathError if the parent directory
 642                 // (not just the file itself) is missing
 643                 return os.ErrNotExist
 644         default:
 645                 return err
 646         }
 647 }
 648
 649 var unixTrashLocRegexp = regexp.MustCompile(`/([0-9a-f]{32})\.trash\.(\d+)$`)
 650
 651 // EmptyTrash walks hierarchy looking for {hash}.trash.*
 652 // and deletes those with deadline < now.
 653 func (v *UnixVolume) EmptyTrash() {
 654         if v.cluster.Collections.BlobDeleteConcurrency < 1 {
 655                 return
 656         }
 657
 658         var bytesDeleted, bytesInTrash int64
 659         var blocksDeleted, blocksInTrash int64
 660
 661         doFile := func(path string, info os.FileInfo) {
 662                 if info.Mode().IsDir() {
 663                         return
 664                 }
 665                 matches := unixTrashLocRegexp.FindStringSubmatch(path)
 666                 if len(matches) != 3 {
 667                         return
 668                 }
 669                 deadline, err := strconv.ParseInt(matches[2], 10, 64)
 670                 if err != nil {
 671                         v.logger.WithError(err).Errorf("EmptyTrash: %v: ParseInt(%q) failed", path, matches[2])
 672                         return
 673                 }
 674                 atomic.AddInt64(&bytesInTrash, info.Size())
 675                 atomic.AddInt64(&blocksInTrash, 1)
 676                 if deadline > time.Now().Unix() {
 677                         return
 678                 }
 679                 err = v.os.Remove(path)
 680                 if err != nil {
 681                         v.logger.WithError(err).Errorf("EmptyTrash: Remove(%q) failed", path)
 682                         return
 683                 }
 684                 atomic.AddInt64(&bytesDeleted, info.Size())
 685                 atomic.AddInt64(&blocksDeleted, 1)
 686         }
 687
 688         type dirent struct {
 689                 path string
 690                 info os.FileInfo
 691         }
 692         var wg sync.WaitGroup
 693         todo := make(chan dirent, v.cluster.Collections.BlobDeleteConcurrency)
 694         for i := 0; i < v.cluster.Collections.BlobDeleteConcurrency; i++ {
 695                 wg.Add(1)
 696                 go func() {
 697                         defer wg.Done()
 698                         for e := range todo {
 699                                 doFile(e.path, e.info)
 700                         }
 701                 }()
 702         }
 703
 704         err := filepath.Walk(v.Root, func(path string, info os.FileInfo, err error) error {
 705                 if err != nil {
 706                         v.logger.WithError(err).Errorf("EmptyTrash: filepath.Walk(%q) failed", path)
 707                         // Don't give up -- keep walking other
 708                         // files/dirs
 709                         return nil
 710                 } else if !info.Mode().IsDir() {
 711                         todo <- dirent{path, info}
 712                         return nil
 713                 } else if path == v.Root || blockDirRe.MatchString(info.Name()) {
 714                         // Descend into a directory that we might have
 715                         // put trash in.
 716                         return nil
 717                 } else {
 718                         // Don't descend into other dirs.
 719                         return filepath.SkipDir
 720                 }
 721         })
 722         close(todo)
 723         wg.Wait()
 724
 725         if err != nil {
 726                 v.logger.WithError(err).Error("EmptyTrash failed")
 727         }
 728
 729         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)
 730 }
 731
 732 type unixStats struct {
 733         statsTicker
 734         OpenOps    uint64
 735         StatOps    uint64
 736         FlockOps   uint64
 737         UtimesOps  uint64
 738         CreateOps  uint64
 739         RenameOps  uint64
 740         UnlinkOps  uint64
 741         ReaddirOps uint64
 742 }
 743
 744 func (s *unixStats) TickErr(err error) {
 745         if err == nil {
 746                 return
 747         }
 748         s.statsTicker.TickErr(err, fmt.Sprintf("%T", err))
 749 }
 750
 751 type osWithStats struct {
 752         stats unixStats
 753 }
 754
 755 func (o *osWithStats) Open(name string) (*os.File, error) {
 756         o.stats.TickOps("open")
 757         o.stats.Tick(&o.stats.OpenOps)
 758         f, err := os.Open(name)
 759         o.stats.TickErr(err)
 760         return f, err
 761 }
 762
 763 func (o *osWithStats) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error) {
 764         o.stats.TickOps("open")
 765         o.stats.Tick(&o.stats.OpenOps)
 766         f, err := os.OpenFile(name, flag, perm)
 767         o.stats.TickErr(err)
 768         return f, err
 769 }
 770
 771 func (o *osWithStats) Remove(path string) error {
 772         o.stats.TickOps("unlink")
 773         o.stats.Tick(&o.stats.UnlinkOps)
 774         err := os.Remove(path)
 775         o.stats.TickErr(err)
 776         return err
 777 }
 778
 779 func (o *osWithStats) Rename(a, b string) error {
 780         o.stats.TickOps("rename")
 781         o.stats.Tick(&o.stats.RenameOps)
 782         err := os.Rename(a, b)
 783         o.stats.TickErr(err)
 784         return err
 785 }
 786
 787 func (o *osWithStats) Stat(path string) (os.FileInfo, error) {
 788         o.stats.TickOps("stat")
 789         o.stats.Tick(&o.stats.StatOps)
 790         fi, err := os.Stat(path)
 791         o.stats.TickErr(err)
 792         return fi, err
 793 }
 794
 795 func (o *osWithStats) TempFile(dir, base string) (*os.File, error) {
 796         o.stats.TickOps("create")
 797         o.stats.Tick(&o.stats.CreateOps)
 798         f, err := ioutil.TempFile(dir, base)
 799         o.stats.TickErr(err)
 800         return f, err
 801 }