services/keepstore/volume_unix.go

   1 package main
   2
   3 import (
   4         "bufio"
   5         "context"
   6         "flag"
   7         "fmt"
   8         "io"
   9         "io/ioutil"
  10         "log"
  11         "os"
  12         "path/filepath"
  13         "regexp"
  14         "strconv"
  15         "strings"
  16         "sync"
  17         "syscall"
  18         "time"
  19 )
  20
  21 type unixVolumeAdder struct {
  22         *Config
  23 }
  24
  25 // String implements flag.Value
  26 func (s *unixVolumeAdder) String() string {
  27         return "-"
  28 }
  29
  30 func (vs *unixVolumeAdder) Set(path string) error {
  31         if dirs := strings.Split(path, ","); len(dirs) > 1 {
  32                 log.Print("DEPRECATED: using comma-separated volume list.")
  33                 for _, dir := range dirs {
  34                         if err := vs.Set(dir); err != nil {
  35                                 return err
  36                         }
  37                 }
  38                 return nil
  39         }
  40         vs.Config.Volumes = append(vs.Config.Volumes, &UnixVolume{
  41                 Root:      path,
  42                 ReadOnly:  deprecated.flagReadonly,
  43                 Serialize: deprecated.flagSerializeIO,
  44         })
  45         return nil
  46 }
  47
  48 func init() {
  49         VolumeTypes = append(VolumeTypes, func() VolumeWithExamples { return &UnixVolume{} })
  50
  51         flag.Var(&unixVolumeAdder{theConfig}, "volumes", "see Volumes configuration")
  52         flag.Var(&unixVolumeAdder{theConfig}, "volume", "see Volumes configuration")
  53 }
  54
  55 // Discover adds a UnixVolume for every directory named "keep" that is
  56 // located at the top level of a device- or tmpfs-backed mount point
  57 // other than "/". It returns the number of volumes added.
  58 func (vs *unixVolumeAdder) Discover() int {
  59         added := 0
  60         f, err := os.Open(ProcMounts)
  61         if err != nil {
  62                 log.Fatalf("opening %s: %s", ProcMounts, err)
  63         }
  64         scanner := bufio.NewScanner(f)
  65         for scanner.Scan() {
  66                 args := strings.Fields(scanner.Text())
  67                 if err := scanner.Err(); err != nil {
  68                         log.Fatalf("reading %s: %s", ProcMounts, err)
  69                 }
  70                 dev, mount := args[0], args[1]
  71                 if mount == "/" {
  72                         continue
  73                 }
  74                 if dev != "tmpfs" && !strings.HasPrefix(dev, "/dev/") {
  75                         continue
  76                 }
  77                 keepdir := mount + "/keep"
  78                 if st, err := os.Stat(keepdir); err != nil || !st.IsDir() {
  79                         continue
  80                 }
  81                 // Set the -readonly flag (but only for this volume)
  82                 // if the filesystem is mounted readonly.
  83                 flagReadonlyWas := deprecated.flagReadonly
  84                 for _, fsopt := range strings.Split(args[3], ",") {
  85                         if fsopt == "ro" {
  86                                 deprecated.flagReadonly = true
  87                                 break
  88                         }
  89                         if fsopt == "rw" {
  90                                 break
  91                         }
  92                 }
  93                 if err := vs.Set(keepdir); err != nil {
  94                         log.Printf("adding %q: %s", keepdir, err)
  95                 } else {
  96                         added++
  97                 }
  98                 deprecated.flagReadonly = flagReadonlyWas
  99         }
 100         return added
 101 }
 102
 103 // A UnixVolume stores and retrieves blocks in a local directory.
 104 type UnixVolume struct {
 105         Root                 string // path to the volume's root directory
 106         ReadOnly             bool
 107         Serialize            bool
 108         DirectoryReplication int
 109
 110         // something to lock during IO, typically a sync.Mutex (or nil
 111         // to skip locking)
 112         locker sync.Locker
 113 }
 114
 115 // Examples implements VolumeWithExamples.
 116 func (*UnixVolume) Examples() []Volume {
 117         return []Volume{
 118                 &UnixVolume{
 119                         Root:                 "/mnt/local-disk",
 120                         Serialize:            true,
 121                         DirectoryReplication: 1,
 122                 },
 123                 &UnixVolume{
 124                         Root:                 "/mnt/network-disk",
 125                         Serialize:            false,
 126                         DirectoryReplication: 2,
 127                 },
 128         }
 129 }
 130
 131 // Type implements Volume
 132 func (v *UnixVolume) Type() string {
 133         return "Directory"
 134 }
 135
 136 // Start implements Volume
 137 func (v *UnixVolume) Start() error {
 138         if v.Serialize {
 139                 v.locker = &sync.Mutex{}
 140         }
 141         if !strings.HasPrefix(v.Root, "/") {
 142                 return fmt.Errorf("volume root does not start with '/': %q", v.Root)
 143         }
 144         if v.DirectoryReplication == 0 {
 145                 v.DirectoryReplication = 1
 146         }
 147         _, err := os.Stat(v.Root)
 148         return err
 149 }
 150
 151 // Touch sets the timestamp for the given locator to the current time
 152 func (v *UnixVolume) Touch(loc string) error {
 153         if v.ReadOnly {
 154                 return MethodDisabledError
 155         }
 156         p := v.blockPath(loc)
 157         f, err := os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
 158         if err != nil {
 159                 return err
 160         }
 161         defer f.Close()
 162         if v.locker != nil {
 163                 v.locker.Lock()
 164                 defer v.locker.Unlock()
 165         }
 166         if e := lockfile(f); e != nil {
 167                 return e
 168         }
 169         defer unlockfile(f)
 170         ts := syscall.NsecToTimespec(time.Now().UnixNano())
 171         return syscall.UtimesNano(p, []syscall.Timespec{ts, ts})
 172 }
 173
 174 // Mtime returns the stored timestamp for the given locator.
 175 func (v *UnixVolume) Mtime(loc string) (time.Time, error) {
 176         p := v.blockPath(loc)
 177         fi, err := os.Stat(p)
 178         if err != nil {
 179                 return time.Time{}, err
 180         }
 181         return fi.ModTime(), nil
 182 }
 183
 184 // Lock the locker (if one is in use), open the file for reading, and
 185 // call the given function if and when the file is ready to read.
 186 func (v *UnixVolume) getFunc(ctx context.Context, path string, fn func(io.Reader) error) error {
 187         if v.locker != nil {
 188                 v.locker.Lock()
 189                 defer v.locker.Unlock()
 190         }
 191         if ctx.Err() != nil {
 192                 return ctx.Err()
 193         }
 194         f, err := os.Open(path)
 195         if err != nil {
 196                 return err
 197         }
 198         defer f.Close()
 199         return fn(f)
 200 }
 201
 202 // stat is os.Stat() with some extra sanity checks.
 203 func (v *UnixVolume) stat(path string) (os.FileInfo, error) {
 204         stat, err := os.Stat(path)
 205         if err == nil {
 206                 if stat.Size() < 0 {
 207                         err = os.ErrInvalid
 208                 } else if stat.Size() > BlockSize {
 209                         err = TooLongError
 210                 }
 211         }
 212         return stat, err
 213 }
 214
 215 // Get retrieves a block, copies it to the given slice, and returns
 216 // the number of bytes copied.
 217 func (v *UnixVolume) Get(ctx context.Context, loc string, buf []byte) (int, error) {
 218         path := v.blockPath(loc)
 219         stat, err := v.stat(path)
 220         if err != nil {
 221                 return 0, v.translateError(err)
 222         }
 223         if stat.Size() > int64(len(buf)) {
 224                 return 0, TooLongError
 225         }
 226         var read int
 227         size := int(stat.Size())
 228         err = v.getFunc(ctx, path, func(rdr io.Reader) error {
 229                 read, err = io.ReadFull(rdr, buf[:size])
 230                 return err
 231         })
 232         return read, err
 233 }
 234
 235 // Compare returns nil if Get(loc) would return the same content as
 236 // expect. It is functionally equivalent to Get() followed by
 237 // bytes.Compare(), but uses less memory.
 238 func (v *UnixVolume) Compare(ctx context.Context, loc string, expect []byte) error {
 239         path := v.blockPath(loc)
 240         if _, err := v.stat(path); err != nil {
 241                 return v.translateError(err)
 242         }
 243         return v.getFunc(ctx, path, func(rdr io.Reader) error {
 244                 return compareReaderWithBuf(ctx, rdr, expect, loc[:32])
 245         })
 246 }
 247
 248 // Put stores a block of data identified by the locator string
 249 // "loc".  It returns nil on success.  If the volume is full, it
 250 // returns a FullError.  If the write fails due to some other error,
 251 // that error is returned.
 252 func (v *UnixVolume) Put(ctx context.Context, loc string, block []byte) error {
 253         if v.ReadOnly {
 254                 return MethodDisabledError
 255         }
 256         if v.IsFull() {
 257                 return FullError
 258         }
 259         bdir := v.blockDir(loc)
 260         if err := os.MkdirAll(bdir, 0755); err != nil {
 261                 log.Printf("%s: could not create directory %s: %s",
 262                         loc, bdir, err)
 263                 return err
 264         }
 265
 266         tmpfile, tmperr := ioutil.TempFile(bdir, "tmp"+loc)
 267         if tmperr != nil {
 268                 log.Printf("ioutil.TempFile(%s, tmp%s): %s", bdir, loc, tmperr)
 269                 return tmperr
 270         }
 271         bpath := v.blockPath(loc)
 272
 273         if v.locker != nil {
 274                 v.locker.Lock()
 275                 defer v.locker.Unlock()
 276         }
 277         select {
 278         case <-ctx.Done():
 279                 return ctx.Err()
 280         default:
 281         }
 282         if _, err := tmpfile.Write(block); err != nil {
 283                 log.Printf("%s: writing to %s: %s\n", v, bpath, err)
 284                 tmpfile.Close()
 285                 os.Remove(tmpfile.Name())
 286                 return err
 287         }
 288         if err := tmpfile.Close(); err != nil {
 289                 log.Printf("closing %s: %s\n", tmpfile.Name(), err)
 290                 os.Remove(tmpfile.Name())
 291                 return err
 292         }
 293         if err := os.Rename(tmpfile.Name(), bpath); err != nil {
 294                 log.Printf("rename %s %s: %s\n", tmpfile.Name(), bpath, err)
 295                 os.Remove(tmpfile.Name())
 296                 return err
 297         }
 298         return nil
 299 }
 300
 301 // Status returns a VolumeStatus struct describing the volume's
 302 // current state, or nil if an error occurs.
 303 //
 304 func (v *UnixVolume) Status() *VolumeStatus {
 305         var fs syscall.Statfs_t
 306         var devnum uint64
 307
 308         if fi, err := os.Stat(v.Root); err == nil {
 309                 devnum = fi.Sys().(*syscall.Stat_t).Dev
 310         } else {
 311                 log.Printf("%s: os.Stat: %s\n", v, err)
 312                 return nil
 313         }
 314
 315         err := syscall.Statfs(v.Root, &fs)
 316         if err != nil {
 317                 log.Printf("%s: statfs: %s\n", v, err)
 318                 return nil
 319         }
 320         // These calculations match the way df calculates disk usage:
 321         // "free" space is measured by fs.Bavail, but "used" space
 322         // uses fs.Blocks - fs.Bfree.
 323         free := fs.Bavail * uint64(fs.Bsize)
 324         used := (fs.Blocks - fs.Bfree) * uint64(fs.Bsize)
 325         return &VolumeStatus{
 326                 MountPoint: v.Root,
 327                 DeviceNum:  devnum,
 328                 BytesFree:  free,
 329                 BytesUsed:  used,
 330         }
 331 }
 332
 333 var blockDirRe = regexp.MustCompile(`^[0-9a-f]+$`)
 334 var blockFileRe = regexp.MustCompile(`^[0-9a-f]{32}$`)
 335
 336 // IndexTo writes (to the given Writer) a list of blocks found on this
 337 // volume which begin with the specified prefix. If the prefix is an
 338 // empty string, IndexTo writes a complete list of blocks.
 339 //
 340 // Each block is given in the format
 341 //
 342 //     locator+size modification-time {newline}
 343 //
 344 // e.g.:
 345 //
 346 //     e4df392f86be161ca6ed3773a962b8f3+67108864 1388894303
 347 //     e4d41e6fd68460e0e3fc18cc746959d2+67108864 1377796043
 348 //     e4de7a2810f5554cd39b36d8ddb132ff+67108864 1388701136
 349 //
 350 func (v *UnixVolume) IndexTo(prefix string, w io.Writer) error {
 351         var lastErr error
 352         rootdir, err := os.Open(v.Root)
 353         if err != nil {
 354                 return err
 355         }
 356         defer rootdir.Close()
 357         for {
 358                 names, err := rootdir.Readdirnames(1)
 359                 if err == io.EOF {
 360                         return lastErr
 361                 } else if err != nil {
 362                         return err
 363                 }
 364                 if !strings.HasPrefix(names[0], prefix) && !strings.HasPrefix(prefix, names[0]) {
 365                         // prefix excludes all blocks stored in this dir
 366                         continue
 367                 }
 368                 if !blockDirRe.MatchString(names[0]) {
 369                         continue
 370                 }
 371                 blockdirpath := filepath.Join(v.Root, names[0])
 372                 blockdir, err := os.Open(blockdirpath)
 373                 if err != nil {
 374                         log.Print("Error reading ", blockdirpath, ": ", err)
 375                         lastErr = err
 376                         continue
 377                 }
 378                 for {
 379                         fileInfo, err := blockdir.Readdir(1)
 380                         if err == io.EOF {
 381                                 break
 382                         } else if err != nil {
 383                                 log.Print("Error reading ", blockdirpath, ": ", err)
 384                                 lastErr = err
 385                                 break
 386                         }
 387                         name := fileInfo[0].Name()
 388                         if !strings.HasPrefix(name, prefix) {
 389                                 continue
 390                         }
 391                         if !blockFileRe.MatchString(name) {
 392                                 continue
 393                         }
 394                         _, err = fmt.Fprint(w,
 395                                 name,
 396                                 "+", fileInfo[0].Size(),
 397                                 " ", fileInfo[0].ModTime().UnixNano(),
 398                                 "\n")
 399                 }
 400                 blockdir.Close()
 401         }
 402 }
 403
 404 // Trash trashes the block data from the unix storage
 405 // If TrashLifetime == 0, the block is deleted
 406 // Else, the block is renamed as path/{loc}.trash.{deadline},
 407 // where deadline = now + TrashLifetime
 408 func (v *UnixVolume) Trash(loc string) error {
 409         // Touch() must be called before calling Write() on a block.  Touch()
 410         // also uses lockfile().  This avoids a race condition between Write()
 411         // and Trash() because either (a) the file will be trashed and Touch()
 412         // will signal to the caller that the file is not present (and needs to
 413         // be re-written), or (b) Touch() will update the file's timestamp and
 414         // Trash() will read the correct up-to-date timestamp and choose not to
 415         // trash the file.
 416
 417         if v.ReadOnly {
 418                 return MethodDisabledError
 419         }
 420         if v.locker != nil {
 421                 v.locker.Lock()
 422                 defer v.locker.Unlock()
 423         }
 424         p := v.blockPath(loc)
 425         f, err := os.OpenFile(p, os.O_RDWR|os.O_APPEND, 0644)
 426         if err != nil {
 427                 return err
 428         }
 429         defer f.Close()
 430         if e := lockfile(f); e != nil {
 431                 return e
 432         }
 433         defer unlockfile(f)
 434
 435         // If the block has been PUT in the last blobSignatureTTL
 436         // seconds, return success without removing the block. This
 437         // protects data from garbage collection until it is no longer
 438         // possible for clients to retrieve the unreferenced blocks
 439         // anyway (because the permission signatures have expired).
 440         if fi, err := os.Stat(p); err != nil {
 441                 return err
 442         } else if time.Since(fi.ModTime()) < time.Duration(theConfig.BlobSignatureTTL) {
 443                 return nil
 444         }
 445
 446         if theConfig.TrashLifetime == 0 {
 447                 return os.Remove(p)
 448         }
 449         return os.Rename(p, fmt.Sprintf("%v.trash.%d", p, time.Now().Add(theConfig.TrashLifetime.Duration()).Unix()))
 450 }
 451
 452 // Untrash moves block from trash back into store
 453 // Look for path/{loc}.trash.{deadline} in storage,
 454 // and rename the first such file as path/{loc}
 455 func (v *UnixVolume) Untrash(loc string) (err error) {
 456         if v.ReadOnly {
 457                 return MethodDisabledError
 458         }
 459
 460         files, err := ioutil.ReadDir(v.blockDir(loc))
 461         if err != nil {
 462                 return err
 463         }
 464
 465         if len(files) == 0 {
 466                 return os.ErrNotExist
 467         }
 468
 469         foundTrash := false
 470         prefix := fmt.Sprintf("%v.trash.", loc)
 471         for _, f := range files {
 472                 if strings.HasPrefix(f.Name(), prefix) {
 473                         foundTrash = true
 474                         err = os.Rename(v.blockPath(f.Name()), v.blockPath(loc))
 475                         if err == nil {
 476                                 break
 477                         }
 478                 }
 479         }
 480
 481         if foundTrash == false {
 482                 return os.ErrNotExist
 483         }
 484
 485         return
 486 }
 487
 488 // blockDir returns the fully qualified directory name for the directory
 489 // where loc is (or would be) stored on this volume.
 490 func (v *UnixVolume) blockDir(loc string) string {
 491         return filepath.Join(v.Root, loc[0:3])
 492 }
 493
 494 // blockPath returns the fully qualified pathname for the path to loc
 495 // on this volume.
 496 func (v *UnixVolume) blockPath(loc string) string {
 497         return filepath.Join(v.blockDir(loc), loc)
 498 }
 499
 500 // IsFull returns true if the free space on the volume is less than
 501 // MinFreeKilobytes.
 502 //
 503 func (v *UnixVolume) IsFull() (isFull bool) {
 504         fullSymlink := v.Root + "/full"
 505
 506         // Check if the volume has been marked as full in the last hour.
 507         if link, err := os.Readlink(fullSymlink); err == nil {
 508                 if ts, err := strconv.Atoi(link); err == nil {
 509                         fulltime := time.Unix(int64(ts), 0)
 510                         if time.Since(fulltime).Hours() < 1.0 {
 511                                 return true
 512                         }
 513                 }
 514         }
 515
 516         if avail, err := v.FreeDiskSpace(); err == nil {
 517                 isFull = avail < MinFreeKilobytes
 518         } else {
 519                 log.Printf("%s: FreeDiskSpace: %s\n", v, err)
 520                 isFull = false
 521         }
 522
 523         // If the volume is full, timestamp it.
 524         if isFull {
 525                 now := fmt.Sprintf("%d", time.Now().Unix())
 526                 os.Symlink(now, fullSymlink)
 527         }
 528         return
 529 }
 530
 531 // FreeDiskSpace returns the number of unused 1k blocks available on
 532 // the volume.
 533 //
 534 func (v *UnixVolume) FreeDiskSpace() (free uint64, err error) {
 535         var fs syscall.Statfs_t
 536         err = syscall.Statfs(v.Root, &fs)
 537         if err == nil {
 538                 // Statfs output is not guaranteed to measure free
 539                 // space in terms of 1K blocks.
 540                 free = fs.Bavail * uint64(fs.Bsize) / 1024
 541         }
 542         return
 543 }
 544
 545 func (v *UnixVolume) String() string {
 546         return fmt.Sprintf("[UnixVolume %s]", v.Root)
 547 }
 548
 549 // Writable returns false if all future Put, Mtime, and Delete calls
 550 // are expected to fail.
 551 func (v *UnixVolume) Writable() bool {
 552         return !v.ReadOnly
 553 }
 554
 555 // Replication returns the number of replicas promised by the
 556 // underlying device (as specified in configuration).
 557 func (v *UnixVolume) Replication() int {
 558         return v.DirectoryReplication
 559 }
 560
 561 // lockfile and unlockfile use flock(2) to manage kernel file locks.
 562 func lockfile(f *os.File) error {
 563         return syscall.Flock(int(f.Fd()), syscall.LOCK_EX)
 564 }
 565
 566 func unlockfile(f *os.File) error {
 567         return syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
 568 }
 569
 570 // Where appropriate, translate a more specific filesystem error to an
 571 // error recognized by handlers, like os.ErrNotExist.
 572 func (v *UnixVolume) translateError(err error) error {
 573         switch err.(type) {
 574         case *os.PathError:
 575                 // stat() returns a PathError if the parent directory
 576                 // (not just the file itself) is missing
 577                 return os.ErrNotExist
 578         default:
 579                 return err
 580         }
 581 }
 582
 583 var unixTrashLocRegexp = regexp.MustCompile(`/([0-9a-f]{32})\.trash\.(\d+)$`)
 584
 585 // EmptyTrash walks hierarchy looking for {hash}.trash.*
 586 // and deletes those with deadline < now.
 587 func (v *UnixVolume) EmptyTrash() {
 588         var bytesDeleted, bytesInTrash int64
 589         var blocksDeleted, blocksInTrash int
 590
 591         err := filepath.Walk(v.Root, func(path string, info os.FileInfo, err error) error {
 592                 if err != nil {
 593                         log.Printf("EmptyTrash: filepath.Walk: %v: %v", path, err)
 594                         return nil
 595                 }
 596                 if info.Mode().IsDir() {
 597                         return nil
 598                 }
 599                 matches := unixTrashLocRegexp.FindStringSubmatch(path)
 600                 if len(matches) != 3 {
 601                         return nil
 602                 }
 603                 deadline, err := strconv.ParseInt(matches[2], 10, 64)
 604                 if err != nil {
 605                         log.Printf("EmptyTrash: %v: ParseInt(%v): %v", path, matches[2], err)
 606                         return nil
 607                 }
 608                 bytesInTrash += info.Size()
 609                 blocksInTrash++
 610                 if deadline > time.Now().Unix() {
 611                         return nil
 612                 }
 613                 err = os.Remove(path)
 614                 if err != nil {
 615                         log.Printf("EmptyTrash: Remove %v: %v", path, err)
 616                         return nil
 617                 }
 618                 bytesDeleted += info.Size()
 619                 blocksDeleted++
 620                 return nil
 621         })
 622
 623         if err != nil {
 624                 log.Printf("EmptyTrash error for %v: %v", v.String(), err)
 625         }
 626
 627         log.Printf("EmptyTrash stats for %v: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", v.String(), bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted)
 628 }