[ARVADOS] updated: f74cbd153b5cbe4e3678c9b86178019f593b553d
git at public.curoverse.com
git at public.curoverse.com
Fri Apr 25 17:45:32 EDT 2014
Summary of changes:
services/keep/src/keep/volume.go | 298 +++-----------------
services/keep/src/keep/volume_mock.go | 61 ----
.../keep/src/keep/{volume.go => volume_unix.go} | 36 +--
3 files changed, 47 insertions(+), 348 deletions(-)
delete mode 100644 services/keep/src/keep/volume_mock.go
copy services/keep/src/keep/{volume.go => volume_unix.go} (88%)
via f74cbd153b5cbe4e3678c9b86178019f593b553d (commit)
from f37f7c068b8d59934c7b0632d531c08470323123 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit f74cbd153b5cbe4e3678c9b86178019f593b553d
Author: Tim Pierce <twp at curoverse.com>
Date: Fri Apr 25 17:47:15 2014 -0400
Reorganized Volume code for easier comprehension.
Refs #2620
diff --git a/services/keep/src/keep/volume.go b/services/keep/src/keep/volume.go
index 2e1e661..dd4245a 100644
--- a/services/keep/src/keep/volume.go
+++ b/services/keep/src/keep/volume.go
@@ -1,21 +1,13 @@
// A Volume is an interface representing a Keep back-end storage unit:
// for example, a single mounted disk, a RAID array, an Amazon S3 volume,
// etc.
-//
-// A UnixVolume is a Volume that is backed by a locally mounted disk.
package main
import (
+ "errors"
"fmt"
- "io/ioutil"
- "log"
- "os"
- "path/filepath"
- "strconv"
"strings"
- "syscall"
- "time"
)
type Volume interface {
@@ -26,280 +18,56 @@ type Volume interface {
String() string
}
-// IORequests are encapsulated requests to perform I/O on a Keep volume.
-// When running in serialized mode, the Keep front end sends IORequests
-// on a channel to an IORunner, which handles them one at a time and
-// returns an IOResponse.
+// MockVolumes are Volumes used to test the Keep front end.
//
-type IOMethod int
-
-const (
- KeepGet IOMethod = iota
- KeepPut
-)
-
-type IORequest struct {
- method IOMethod
- loc string
- data []byte
- reply chan *IOResponse
-}
-
-type IOResponse struct {
- data []byte
- err error
-}
-
-// A UnixVolume is configured with:
+// If the Bad field is true, this volume should return an error
+// on all writes and puts.
//
-// * root: the path to the volume's root directory
-// * queue: if non-nil, all I/O requests for this volume should be queued
-// on this channel. The response will be delivered on the IOResponse
-// channel included in the request.
-//
-type UnixVolume struct {
- root string // path to this volume
- queue chan *IORequest
+type MockVolume struct {
+ Store map[string][]byte
+ Bad bool
}
-func (v *UnixVolume) IOHandler() {
- for req := range v.queue {
- var result IOResponse
- switch req.method {
- case KeepGet:
- result.data, result.err = v.Read(req.loc)
- case KeepPut:
- result.err = v.Write(req.loc, req.data)
- }
- req.reply <- &result
- }
+func CreateMockVolume() *MockVolume {
+ return &MockVolume{make(map[string][]byte), false}
}
-func MakeUnixVolume(root string, serialize bool) (v UnixVolume) {
- if serialize {
- v = UnixVolume{root, make(chan *IORequest)}
- go v.IOHandler()
- } else {
- v = UnixVolume{root, nil}
+func (v *MockVolume) Get(loc string) ([]byte, error) {
+ if v.Bad {
+ return nil, errors.New("Bad volume")
+ } else if block, ok := v.Store[loc]; ok {
+ return block, nil
}
- return
+ return nil, errors.New("not found")
}
-func (v *UnixVolume) Get(loc string) ([]byte, error) {
- if v.queue == nil {
- return v.Read(loc)
- }
- reply := make(chan *IOResponse)
- v.queue <- &IORequest{KeepGet, loc, nil, reply}
- response := <-reply
- return response.data, response.err
-}
-
-func (v *UnixVolume) Put(loc string, block []byte) error {
- if v.queue == nil {
- return v.Write(loc, block)
- }
- reply := make(chan *IOResponse)
- v.queue <- &IORequest{KeepPut, loc, block, reply}
- response := <-reply
- return response.err
-}
-
-// Read retrieves a block identified by the locator string "loc", and
-// returns its contents as a byte slice.
-//
-// If the block could not be opened or read, Read returns a nil slice
-// and the os.Error that was generated.
-//
-// If the block is present but its content hash does not match loc,
-// Read returns the block and a CorruptError. It is the caller's
-// responsibility to decide what (if anything) to do with the
-// corrupted data block.
-//
-func (v *UnixVolume) Read(loc string) ([]byte, error) {
- var f *os.File
- var err error
- var nread int
-
- blockFilename := fmt.Sprintf("%s/%s/%s", v.root, loc[0:3], loc)
-
- f, err = os.Open(blockFilename)
- if err != nil {
- return nil, err
- }
-
- var buf = make([]byte, BLOCKSIZE)
- nread, err = f.Read(buf)
- if err != nil {
- log.Printf("%s: reading %s: %s\n", v, blockFilename, err)
- return buf, err
- }
-
- // Success!
- return buf[:nread], nil
-}
-
-// Write stores a block of data identified by the locator string
-// "loc". It returns nil on success. If the volume is full, it
-// returns a FullError. If the write fails due to some other error,
-// that error is returned.
-//
-func (v *UnixVolume) Write(loc string, block []byte) error {
- if v.IsFull() {
- return FullError
- }
- blockDir := fmt.Sprintf("%s/%s", v.root, loc[0:3])
- if err := os.MkdirAll(blockDir, 0755); err != nil {
- log.Printf("%s: could not create directory %s: %s",
- loc, blockDir, err)
- return err
- }
-
- tmpfile, tmperr := ioutil.TempFile(blockDir, "tmp"+loc)
- if tmperr != nil {
- log.Printf("ioutil.TempFile(%s, tmp%s): %s", blockDir, loc, tmperr)
- return tmperr
- }
- blockFilename := fmt.Sprintf("%s/%s", blockDir, loc)
-
- if _, err := tmpfile.Write(block); err != nil {
- log.Printf("%s: writing to %s: %s\n", v, blockFilename, err)
- return err
- }
- if err := tmpfile.Close(); err != nil {
- log.Printf("closing %s: %s\n", tmpfile.Name(), err)
- os.Remove(tmpfile.Name())
- return err
- }
- if err := os.Rename(tmpfile.Name(), blockFilename); err != nil {
- log.Printf("rename %s %s: %s\n", tmpfile.Name(), blockFilename, err)
- os.Remove(tmpfile.Name())
- return err
+func (v *MockVolume) Put(loc string, block []byte) error {
+ if v.Bad {
+ return errors.New("Bad volume")
}
+ v.Store[loc] = block
return nil
}
-// Status returns a VolumeStatus struct describing the volume's
-// current state.
-//
-func (v *UnixVolume) Status() *VolumeStatus {
- var fs syscall.Statfs_t
- var devnum uint64
-
- if fi, err := os.Stat(v.root); err == nil {
- devnum = fi.Sys().(*syscall.Stat_t).Dev
- } else {
- log.Printf("%s: os.Stat: %s\n", v, err)
- return nil
- }
-
- err := syscall.Statfs(v.root, &fs)
- if err != nil {
- log.Printf("%s: statfs: %s\n", v, err)
- return nil
- }
- // These calculations match the way df calculates disk usage:
- // "free" space is measured by fs.Bavail, but "used" space
- // uses fs.Blocks - fs.Bfree.
- free := fs.Bavail * uint64(fs.Bsize)
- used := (fs.Blocks - fs.Bfree) * uint64(fs.Bsize)
- return &VolumeStatus{v.root, devnum, free, used}
-}
-
-// Index returns a list of blocks found on this volume which begin with
-// the specified prefix. If the prefix is an empty string, Index returns
-// a complete list of blocks.
-//
-// The return value is a multiline string (separated by
-// newlines). Each line is in the format
-//
-// locator+size modification-time
-//
-// e.g.:
-//
-// e4df392f86be161ca6ed3773a962b8f3+67108864 1388894303
-// e4d41e6fd68460e0e3fc18cc746959d2+67108864 1377796043
-// e4de7a2810f5554cd39b36d8ddb132ff+67108864 1388701136
-//
-func (v *UnixVolume) Index(prefix string) (output string) {
- filepath.Walk(v.root,
- func(path string, info os.FileInfo, err error) error {
- // This WalkFunc inspects each path in the volume
- // and prints an index line for all files that begin
- // with prefix.
- if err != nil {
- log.Printf("IndexHandler: %s: walking to %s: %s",
- v, path, err)
- return nil
- }
- locator := filepath.Base(path)
- // Skip directories that do not match prefix.
- // We know there is nothing interesting inside.
- if info.IsDir() &&
- !strings.HasPrefix(locator, prefix) &&
- !strings.HasPrefix(prefix, locator) {
- return filepath.SkipDir
- }
- // Skip any file that is not apparently a locator, e.g. .meta files
- if !IsValidLocator(locator) {
- return nil
- }
- // Print filenames beginning with prefix
- if !info.IsDir() && strings.HasPrefix(locator, prefix) {
- output = output + fmt.Sprintf(
- "%s+%d %d\n", locator, info.Size(), info.ModTime().Unix())
- }
- return nil
- })
-
- return
-}
-
-// IsFull returns true if the free space on the volume is less than
-// MIN_FREE_KILOBYTES.
-//
-func (v *UnixVolume) IsFull() (isFull bool) {
- fullSymlink := v.root + "/full"
-
- // Check if the volume has been marked as full in the last hour.
- if link, err := os.Readlink(fullSymlink); err == nil {
- if ts, err := strconv.Atoi(link); err == nil {
- fulltime := time.Unix(int64(ts), 0)
- if time.Since(fulltime).Hours() < 1.0 {
- return true
- }
+func (v *MockVolume) Index(prefix string) string {
+ var result string
+ for loc, block := range v.Store {
+ if IsValidLocator(loc) && strings.HasPrefix(loc, prefix) {
+ result = result + fmt.Sprintf("%s+%d %d\n",
+ loc, len(block), 123456789)
}
}
-
- if avail, err := v.FreeDiskSpace(); err == nil {
- isFull = avail < MIN_FREE_KILOBYTES
- } else {
- log.Printf("%s: FreeDiskSpace: %s\n", v, err)
- isFull = false
- }
-
- // If the volume is full, timestamp it.
- if isFull {
- now := fmt.Sprintf("%d", time.Now().Unix())
- os.Symlink(now, fullSymlink)
- }
- return
+ return result
}
-// FreeDiskSpace returns the number of unused 1k blocks available on
-// the volume.
-//
-func (v *UnixVolume) FreeDiskSpace() (free uint64, err error) {
- var fs syscall.Statfs_t
- err = syscall.Statfs(v.root, &fs)
- if err == nil {
- // Statfs output is not guaranteed to measure free
- // space in terms of 1K blocks.
- free = fs.Bavail * uint64(fs.Bsize) / 1024
+func (v *MockVolume) Status() *VolumeStatus {
+ var used uint64
+ for _, block := range v.Store {
+ used = used + uint64(len(block))
}
- return
+ return &VolumeStatus{"/bogo", 123, 1000000 - used, used}
}
-func (v *UnixVolume) String() string {
- return fmt.Sprintf("[UnixVolume %s]", v.root)
+func (v *MockVolume) String() string {
+ return "[MockVolume]"
}
diff --git a/services/keep/src/keep/volume_mock.go b/services/keep/src/keep/volume_mock.go
deleted file mode 100644
index ec9a3a7..0000000
--- a/services/keep/src/keep/volume_mock.go
+++ /dev/null
@@ -1,61 +0,0 @@
-package main
-
-import (
- "errors"
- "fmt"
- "strings"
-)
-
-// MockVolumes are Volumes used to test the Keep front end.
-//
-// If the Bad field is true, this volume should return an error
-// on all writes and puts.
-//
-type MockVolume struct {
- Store map[string][]byte
- Bad bool
-}
-
-func CreateMockVolume() *MockVolume {
- return &MockVolume{make(map[string][]byte), false}
-}
-
-func (v *MockVolume) Get(loc string) ([]byte, error) {
- if v.Bad {
- return nil, errors.New("Bad volume")
- } else if block, ok := v.Store[loc]; ok {
- return block, nil
- }
- return nil, errors.New("not found")
-}
-
-func (v *MockVolume) Put(loc string, block []byte) error {
- if v.Bad {
- return errors.New("Bad volume")
- }
- v.Store[loc] = block
- return nil
-}
-
-func (v *MockVolume) Index(prefix string) string {
- var result string
- for loc, block := range v.Store {
- if IsValidLocator(loc) && strings.HasPrefix(loc, prefix) {
- result = result + fmt.Sprintf("%s+%d %d\n",
- loc, len(block), 123456789)
- }
- }
- return result
-}
-
-func (v *MockVolume) Status() *VolumeStatus {
- var used uint64
- for _, block := range v.Store {
- used = used + uint64(len(block))
- }
- return &VolumeStatus{"/bogo", 123, 1000000 - used, used}
-}
-
-func (v *MockVolume) String() string {
- return "[MockVolume]"
-}
diff --git a/services/keep/src/keep/volume.go b/services/keep/src/keep/volume_unix.go
similarity index 88%
copy from services/keep/src/keep/volume.go
copy to services/keep/src/keep/volume_unix.go
index 2e1e661..95e0f4b 100644
--- a/services/keep/src/keep/volume.go
+++ b/services/keep/src/keep/volume_unix.go
@@ -1,9 +1,5 @@
-// A Volume is an interface representing a Keep back-end storage unit:
-// for example, a single mounted disk, a RAID array, an Amazon S3 volume,
-// etc.
+// A UnixVolume is a Volume backed by a locally mounted disk.
//
-// A UnixVolume is a Volume that is backed by a locally mounted disk.
-
package main
import (
@@ -18,18 +14,11 @@ import (
"time"
)
-type Volume interface {
- Get(loc string) ([]byte, error)
- Put(loc string, block []byte) error
- Index(prefix string) string
- Status() *VolumeStatus
- String() string
-}
-
-// IORequests are encapsulated requests to perform I/O on a Keep volume.
-// When running in serialized mode, the Keep front end sends IORequests
-// on a channel to an IORunner, which handles them one at a time and
-// returns an IOResponse.
+// IORequests are encapsulated Get or Put requests. They are used to
+// implement serialized I/O (i.e. only one read/write operation per
+// volume). When running in serialized mode, the Keep front end sends
+// IORequests on a channel to an IORunner, which handles them one at a
+// time and returns an IOResponse.
//
type IOMethod int
@@ -50,12 +39,15 @@ type IOResponse struct {
err error
}
-// A UnixVolume is configured with:
+// A UnixVolume has the following properties:
//
-// * root: the path to the volume's root directory
-// * queue: if non-nil, all I/O requests for this volume should be queued
-// on this channel. The response will be delivered on the IOResponse
-// channel included in the request.
+// root
+// the path to the volume's root directory
+// queue
+// A channel of IORequests. If non-nil, all I/O requests for
+// this volume should be queued on this channel; the result
+// will be delivered on the IOResponse channel supplied in the
+// request.
//
type UnixVolume struct {
root string // path to this volume
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list