Added status.json handler. (refs #2561)
[arvados.git] / services / keep / keep.go
index 4534860685655eb44233f0d9689bb9100cd5dfb3..b96afff991864b567a5df91be4448c1629cf22b4 100644 (file)
@@ -2,6 +2,7 @@ package main
 
 import (
        "bufio"
+       "bytes"
        "crypto/md5"
        "errors"
        "fmt"
@@ -9,9 +10,10 @@ import (
        "log"
        "net/http"
        "os"
-       "os/exec"
+       "path/filepath"
        "strconv"
        "strings"
+       "syscall"
        "time"
 )
 
@@ -34,6 +36,15 @@ type KeepError struct {
        Err      error
 }
 
+const (
+       ErrCollision = 400
+       ErrMD5Fail   = 401
+       ErrCorrupt   = 402
+       ErrNotFound  = 404
+       ErrOther     = 500
+       ErrFull      = 503
+)
+
 func (e *KeepError) Error() string {
        return fmt.Sprintf("Error %d: %s", e.HTTPCode, e.Err.Error())
 }
@@ -54,8 +65,11 @@ func main() {
        // appropriate handler.
        //
        rest := mux.NewRouter()
-       rest.HandleFunc("/{hash:[0-9a-f]{32}}", GetBlockHandler).Methods("GET")
-       rest.HandleFunc("/{hash:[0-9a-f]{32}}", PutBlockHandler).Methods("PUT")
+       rest.HandleFunc(`/{hash:[0-9a-f]{32}}`, GetBlockHandler).Methods("GET", "HEAD")
+       rest.HandleFunc(`/{hash:[0-9a-f]{32}}`, PutBlockHandler).Methods("PUT")
+       rest.HandleFunc(`/index`, IndexHandler).Methods("GET", "HEAD")
+       rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, IndexHandler).Methods("GET", "HEAD")
+       rest.HandleFunc(`/status\.json`, StatusHandler).Methods("GET", "HEAD")
 
        // Tell the built-in HTTP server to direct all requests to the REST
        // router.
@@ -134,6 +148,136 @@ func PutBlockHandler(w http.ResponseWriter, req *http.Request) {
        }
 }
 
+func IndexHandler(w http.ResponseWriter, req *http.Request) {
+       prefix := mux.Vars(req)["prefix"]
+
+       index := IndexLocators(prefix)
+       w.Write([]byte(index))
+}
+
+// StatusHandler
+//     Responds to /status.json requests with the current node status,
+//     described in a JSON structure.
+//
+//     The data given in a status.json response includes:
+//        time - the time the status was last updated
+//        df   - the output of the most recent `df --block-size=1k`
+//        disk_devices - list of disk device files (i.e. /dev/(s|xv|h)d)
+//        dirs - an object describing Keep volumes, keyed on Keep volume dirs,
+//          each value is an object describing the status of that volume
+//            * status ("full [timestamp]" or "ok [timestamp]")
+//            * last_error
+//            * last_error_time
+//
+type VolumeStatus struct {
+       Space       string
+       LastErr     string
+       LastErrTime time.Time
+}
+
+type NodeStatus struct {
+       LastUpdate time.Time
+       DfOutput   string
+       DiskDev    []string
+       Volumes    map[string]VolumeStatus
+}
+
+func StatusHandler(w http.ResponseWriter, req *http.Request) {
+       st := new(NodeStatus)
+       st.LastUpdate = time.Now()
+
+       // Get a list of disk devices on this system.
+       st.DiskDev = make([]string, 1)
+       if devdir, err := os.Open("/dev"); err != nil {
+               log.Printf("StatusHandler: opening /dev: %s\n", err)
+       } else {
+               devs, err := devdir.Readdirnames(0)
+               if err == nil {
+                       for _, d := range devs {
+                               if strings.HasPrefix(d, "sd") ||
+                                       strings.HasPrefix(d, "hd") ||
+                                       strings.HasPrefix(d, "xvd") {
+                                       st.DiskDev = append(st.DiskDev, d)
+                               }
+                       }
+               } else {
+                       log.Printf("Readdirnames: %s", err)
+               }
+       }
+
+       for _, vol := range KeepVolumes {
+               st.Volumes[vol] = GetVolumeStatus(vol)
+       }
+}
+
+// GetVolumeStatus
+//     Returns a VolumeStatus describing the requested volume.
+func GetVolumeStatus(volume string) VolumeStatus {
+       var isfull, lasterr string
+       var lasterrtime time.Time
+
+       if IsFull(volume) {
+               isfull = fmt.Sprintf("full %d", time.Now().Unix())
+       } else {
+               isfull = fmt.Sprintf("ok %d", time.Now().Unix())
+       }
+
+       // Not implemented yet
+       lasterr = ""
+       lasterrtime = time.Unix(0, 0)
+
+       return VolumeStatus{isfull, lasterr, lasterrtime}
+}
+
+// IndexLocators
+//     Returns a string containing a list of locator ids found on this
+//     Keep server.  If {prefix} is given, return only those locator
+//     ids that begin with the given prefix string.
+//
+//     The return string consists of a sequence of newline-separated
+//     strings in the format
+//
+//         locator+size modification-time
+//
+//     e.g.:
+//
+//         e4df392f86be161ca6ed3773a962b8f3+67108864 1388894303
+//         e4d41e6fd68460e0e3fc18cc746959d2+67108864 1377796043
+//         e4de7a2810f5554cd39b36d8ddb132ff+67108864 1388701136
+//
+func IndexLocators(prefix string) string {
+       var output string
+       for _, vol := range KeepVolumes {
+               filepath.Walk(vol,
+                       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",
+                                               vol, 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
+                               }
+                               // 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 output
+}
+
 func GetBlock(hash string) ([]byte, error) {
        var buf = make([]byte, BLOCKSIZE)
 
@@ -172,7 +316,7 @@ func GetBlock(hash string) ([]byte, error) {
                        //
                        log.Printf("%s: checksum mismatch: %s (actual hash %s)\n",
                                vol, blockFilename, filehash)
-                       continue
+                       return buf, &KeepError{ErrCorrupt, errors.New("Corrupt")}
                }
 
                // Success!
@@ -180,7 +324,7 @@ func GetBlock(hash string) ([]byte, error) {
        }
 
        log.Printf("%s: not found on any volumes, giving up\n", hash)
-       return buf, &KeepError{404, errors.New("not found: " + hash)}
+       return buf, &KeepError{ErrNotFound, errors.New("not found: " + hash)}
 }
 
 /* PutBlock(block, hash)
@@ -195,15 +339,18 @@ func GetBlock(hash string) ([]byte, error) {
    On success, PutBlock returns nil.
    On failure, it returns a KeepError with one of the following codes:
 
+   400 Collision
+          A different block with the same hash already exists on this
+          Keep server.
    401 MD5Fail
-         -- The MD5 hash of the BLOCK does not match the argument HASH.
+          The MD5 hash of the BLOCK does not match the argument HASH.
    503 Full
-         -- There was not enough space left in any Keep volume to store
-            the object.
+          There was not enough space left in any Keep volume to store
+          the object.
    500 Fail
-         -- The object could not be stored for some other reason (e.g.
-            all writes failed). The text of the error message should
-            provide as much detail as possible.
+          The object could not be stored for some other reason (e.g.
+          all writes failed). The text of the error message should
+          provide as much detail as possible.
 */
 
 func PutBlock(block []byte, hash string) error {
@@ -211,9 +358,25 @@ func PutBlock(block []byte, hash string) error {
        blockhash := fmt.Sprintf("%x", md5.Sum(block))
        if blockhash != hash {
                log.Printf("%s: MD5 checksum %s did not match request", hash, blockhash)
-               return &KeepError{401, errors.New("MD5Fail")}
+               return &KeepError{ErrMD5Fail, errors.New("MD5Fail")}
+       }
+
+       // If we already have a block on disk under this identifier, return
+       // success (but check for MD5 collisions, which may signify on-disk corruption).
+       if oldblock, err := GetBlock(hash); err == nil {
+               if bytes.Compare(block, oldblock) == 0 {
+                       return nil
+               } else {
+                       return &KeepError{ErrCollision, errors.New("Collision")}
+               }
+       } else {
+               ke := err.(*KeepError)
+               if ke.HTTPCode == ErrCorrupt {
+                       return &KeepError{ErrCollision, errors.New("Collision")}
+               }
        }
 
+       // Store the block on the first available Keep volume.
        allFull := true
        for _, vol := range KeepVolumes {
                if IsFull(vol) {
@@ -228,18 +391,11 @@ func PutBlock(block []byte, hash string) error {
                }
 
                blockFilename := fmt.Sprintf("%s/%s", blockDir, hash)
+
                f, err := os.OpenFile(blockFilename, os.O_CREATE|os.O_WRONLY, 0644)
                if err != nil {
-                       // if the block already exists, just return success.
-                       // TODO(twp): should we check here whether the file on disk
-                       // matches the file we were asked to store?
-                       if os.IsExist(err) {
-                               return nil
-                       } else {
-                               // Open failed for some other reason.
-                               log.Printf("%s: creating %s: %s\n", vol, blockFilename, err)
-                               continue
-                       }
+                       log.Printf("%s: creating %s: %s\n", vol, blockFilename, err)
+                       continue
                }
 
                if _, err := f.Write(block); err == nil {
@@ -253,10 +409,10 @@ func PutBlock(block []byte, hash string) error {
 
        if allFull {
                log.Printf("all Keep volumes full")
-               return &KeepError{503, errors.New("Full")}
+               return &KeepError{ErrFull, errors.New("Full")}
        } else {
                log.Printf("all Keep volumes failed")
-               return &KeepError{500, errors.New("Fail")}
+               return &KeepError{ErrOther, errors.New("Fail")}
        }
 }
 
@@ -292,32 +448,13 @@ func IsFull(volume string) (isFull bool) {
 //     Returns the amount of available disk space on VOLUME,
 //     as a number of 1k blocks.
 //
-func FreeDiskSpace(volume string) (free int, err error) {
-       // Run df to find out how much disk space is left.
-       cmd := exec.Command("df", "--block-size=1k", volume)
-       stdout, perr := cmd.StdoutPipe()
-       if perr != nil {
-               return 0, perr
+func FreeDiskSpace(volume string) (free uint64, err error) {
+       var fs syscall.Statfs_t
+       err = syscall.Statfs(volume, &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
        }
-       scanner := bufio.NewScanner(stdout)
-       if perr := cmd.Start(); err != nil {
-               return 0, perr
-       }
-
-       scanner.Scan() // skip header line of df output
-       scanner.Scan()
-
-       f := strings.Fields(scanner.Text())
-       if avail, err := strconv.Atoi(f[3]); err == nil {
-               free = avail
-       } else {
-               err = errors.New("bad df format: " + scanner.Text())
-       }
-
-       // Flush the df output and shut it down cleanly.
-       for scanner.Scan() {
-       }
-       cmd.Wait()
-
        return
 }