X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ec27d93c1d8918ec509ec3c64ed11dcd51f28374..c4e6d3c9a8a55460c4ee663e66ea1093c6088d4f:/services/keepstore/handlers.go diff --git a/services/keepstore/handlers.go b/services/keepstore/handlers.go index 69807d9e62..2d90aba14e 100644 --- a/services/keepstore/handlers.go +++ b/services/keepstore/handlers.go @@ -1,3 +1,7 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + package main // REST handlers for Keep are implemented here. @@ -13,9 +17,7 @@ import ( "crypto/md5" "encoding/json" "fmt" - "github.com/gorilla/mux" "io" - "log" "net/http" "os" "regexp" @@ -24,13 +26,24 @@ import ( "strings" "sync" "time" + + "github.com/gorilla/mux" + + "git.curoverse.com/arvados.git/sdk/go/health" + "git.curoverse.com/arvados.git/sdk/go/httpserver" + log "github.com/Sirupsen/logrus" ) -// MakeRESTRouter returns a new mux.Router that forwards all Keep -// requests to the appropriate handlers. -// -func MakeRESTRouter() *mux.Router { +type router struct { + *mux.Router + limiter httpserver.RequestCounter +} + +// MakeRESTRouter returns a new router that forwards all Keep requests +// to the appropriate handlers. +func MakeRESTRouter() *router { rest := mux.NewRouter() + rtr := &router{Router: rest} rest.HandleFunc( `/{hash:[0-9a-f]{32}}`, GetBlockHandler).Methods("GET", "HEAD") @@ -41,13 +54,21 @@ func MakeRESTRouter() *mux.Router { rest.HandleFunc(`/{hash:[0-9a-f]{32}}`, PutBlockHandler).Methods("PUT") rest.HandleFunc(`/{hash:[0-9a-f]{32}}`, DeleteHandler).Methods("DELETE") // List all blocks stored here. Privileged client only. - rest.HandleFunc(`/index`, IndexHandler).Methods("GET", "HEAD") + rest.HandleFunc(`/index`, rtr.IndexHandler).Methods("GET", "HEAD") // List blocks stored here whose hash has the given prefix. // Privileged client only. - rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, IndexHandler).Methods("GET", "HEAD") + rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, rtr.IndexHandler).Methods("GET", "HEAD") + + // Internals/debugging info (runtime.MemStats) + rest.HandleFunc(`/debug.json`, rtr.DebugHandler).Methods("GET", "HEAD") // List volumes: path, device number, bytes used/avail. - rest.HandleFunc(`/status.json`, StatusHandler).Methods("GET", "HEAD") + rest.HandleFunc(`/status.json`, rtr.StatusHandler).Methods("GET", "HEAD") + + // List mounts: UUID, readonly, tier, device ID, ... + rest.HandleFunc(`/mounts`, rtr.MountsHandler).Methods("GET") + rest.HandleFunc(`/mounts/{uuid}/blocks`, rtr.IndexHandler).Methods("GET") + rest.HandleFunc(`/mounts/{uuid}/blocks/`, rtr.IndexHandler).Methods("GET") // Replace the current pull queue. rest.HandleFunc(`/pull`, PullHandler).Methods("PUT") @@ -58,11 +79,16 @@ func MakeRESTRouter() *mux.Router { // Untrash moves blocks from trash back into store rest.HandleFunc(`/untrash/{hash:[0-9a-f]{32}}`, UntrashHandler).Methods("PUT") + rest.Handle("/_health/{check}", &health.Handler{ + Token: theConfig.ManagementToken, + Prefix: "/_health/", + }).Methods("GET") + // Any request which does not match any of these routes gets // 400 Bad Request. rest.NotFoundHandler = http.HandlerFunc(BadRequestHandler) - return rest + return rtr } // BadRequestHandler is a HandleFunc to address bad requests. @@ -72,7 +98,8 @@ func BadRequestHandler(w http.ResponseWriter, r *http.Request) { // GetBlockHandler is a HandleFunc to address Get block requests. func GetBlockHandler(resp http.ResponseWriter, req *http.Request) { - ctx := contextForResponse(context.TODO(), resp) + ctx, cancel := contextForResponse(context.TODO(), resp) + defer cancel() if theConfig.RequireSignatures { locator := req.URL.Path[1:] // strip leading slash @@ -89,7 +116,7 @@ func GetBlockHandler(resp http.ResponseWriter, req *http.Request) { // isn't here, we can return 404 now instead of waiting for a // buffer. - buf, err := getBufferForResponseWriter(resp, bufs, BlockSize) + buf, err := getBufferWithContext(ctx, bufs, BlockSize) if err != nil { http.Error(resp, err.Error(), http.StatusServiceUnavailable) return @@ -111,40 +138,33 @@ func GetBlockHandler(resp http.ResponseWriter, req *http.Request) { resp.Write(buf[:size]) } -// Return a new context that gets cancelled by resp's -// CloseNotifier. If resp does not implement http.CloseNotifier, -// return parent. -func contextForResponse(parent context.Context, resp http.ResponseWriter) context.Context { - cn, ok := resp.(http.CloseNotifier) - if !ok { - return parent - } +// Return a new context that gets cancelled by resp's CloseNotifier. +func contextForResponse(parent context.Context, resp http.ResponseWriter) (context.Context, context.CancelFunc) { ctx, cancel := context.WithCancel(parent) - go func(c <-chan bool) { - <-c - cancel() - }(cn.CloseNotify()) - return ctx + if cn, ok := resp.(http.CloseNotifier); ok { + go func(c <-chan bool) { + select { + case <-c: + theConfig.debugLogf("cancel context") + cancel() + case <-ctx.Done(): + } + }(cn.CloseNotify()) + } + return ctx, cancel } // Get a buffer from the pool -- but give up and return a non-nil -// error if resp implements http.CloseNotifier and tells us that the -// client has disconnected before we get a buffer. -func getBufferForResponseWriter(resp http.ResponseWriter, bufs *bufferPool, bufSize int) ([]byte, error) { - var closeNotifier <-chan bool - if resp, ok := resp.(http.CloseNotifier); ok { - closeNotifier = resp.CloseNotify() - } - var buf []byte +// error if ctx ends before we get a buffer. +func getBufferWithContext(ctx context.Context, bufs *bufferPool, bufSize int) ([]byte, error) { bufReady := make(chan []byte) go func() { bufReady <- bufs.Get(bufSize) - close(bufReady) }() select { - case buf = <-bufReady: + case buf := <-bufReady: return buf, nil - case <-closeNotifier: + case <-ctx.Done(): go func() { // Even if closeNotifier happened first, we // need to keep waiting for our buf so we can @@ -157,7 +177,8 @@ func getBufferForResponseWriter(resp http.ResponseWriter, bufs *bufferPool, bufS // PutBlockHandler is a HandleFunc to address Put block requests. func PutBlockHandler(resp http.ResponseWriter, req *http.Request) { - ctx := contextForResponse(context.TODO(), resp) + ctx, cancel := contextForResponse(context.TODO(), resp) + defer cancel() hash := mux.Vars(req)["hash"] @@ -180,7 +201,7 @@ func PutBlockHandler(resp http.ResponseWriter, req *http.Request) { return } - buf, err := getBufferForResponseWriter(resp, bufs, int(req.ContentLength)) + buf, err := getBufferWithContext(ctx, bufs, int(req.ContentLength)) if err != nil { http.Error(resp, err.Error(), http.StatusServiceUnavailable) return @@ -197,8 +218,11 @@ func PutBlockHandler(resp http.ResponseWriter, req *http.Request) { bufs.Put(buf) if err != nil { - ke := err.(*KeepError) - http.Error(resp, ke.Error(), ke.HTTPCode) + code := http.StatusInternalServerError + if err, ok := err.(*KeepError); ok { + code = err.HTTPCode + } + http.Error(resp, err.Error(), code) return } @@ -214,18 +238,34 @@ func PutBlockHandler(resp http.ResponseWriter, req *http.Request) { resp.Write([]byte(returnHash + "\n")) } -// IndexHandler is a HandleFunc to address /index and /index/{prefix} requests. -func IndexHandler(resp http.ResponseWriter, req *http.Request) { - // Reject unauthorized requests. +// IndexHandler responds to "/index", "/index/{prefix}", and +// "/mounts/{uuid}/blocks" requests. +func (rtr *router) IndexHandler(resp http.ResponseWriter, req *http.Request) { if !IsSystemAuth(GetAPIToken(req)) { http.Error(resp, UnauthorizedError.Error(), UnauthorizedError.HTTPCode) return } prefix := mux.Vars(req)["prefix"] + if prefix == "" { + req.ParseForm() + prefix = req.Form.Get("prefix") + } - for _, vol := range KeepVM.AllReadable() { - if err := vol.IndexTo(prefix, resp); err != nil { + uuid := mux.Vars(req)["uuid"] + + var vols []Volume + if uuid == "" { + vols = KeepVM.AllReadable() + } else if v := KeepVM.Lookup(uuid, false); v == nil { + http.Error(resp, "mount not found", http.StatusNotFound) + return + } else { + vols = []Volume{v} + } + + for _, v := range vols { + if err := v.IndexTo(prefix, resp); err != nil { // The only errors returned by IndexTo are // write errors returned by resp.Write(), // which probably means the client has @@ -241,41 +281,58 @@ func IndexHandler(resp http.ResponseWriter, req *http.Request) { resp.Write([]byte{'\n'}) } -// 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: -// volumes - a list of Keep volumes currently in use by this server -// each volume is an object with the following fields: -// * mount_point -// * device_num (an integer identifying the underlying filesystem) -// * bytes_free -// * bytes_used +// MountsHandler responds to "GET /mounts" requests. +func (rtr *router) MountsHandler(resp http.ResponseWriter, req *http.Request) { + err := json.NewEncoder(resp).Encode(KeepVM.Mounts()) + if err != nil { + http.Error(resp, err.Error(), http.StatusInternalServerError) + } +} // PoolStatus struct type PoolStatus struct { - Alloc uint64 `json:"BytesAllocated"` + Alloc uint64 `json:"BytesAllocatedCumulative"` Cap int `json:"BuffersMax"` Len int `json:"BuffersInUse"` } +type volumeStatusEnt struct { + Label string + Status *VolumeStatus `json:",omitempty"` + VolumeStats *ioStats `json:",omitempty"` + InternalStats interface{} `json:",omitempty"` +} + // NodeStatus struct type NodeStatus struct { - Volumes []*VolumeStatus `json:"volumes"` - BufferPool PoolStatus - PullQueue WorkQueueStatus - TrashQueue WorkQueueStatus - Memory runtime.MemStats + Volumes []*volumeStatusEnt + BufferPool PoolStatus + PullQueue WorkQueueStatus + TrashQueue WorkQueueStatus + RequestsCurrent int + RequestsMax int } var st NodeStatus var stLock sync.Mutex +// DebugHandler addresses /debug.json requests. +func (rtr *router) DebugHandler(resp http.ResponseWriter, req *http.Request) { + type debugStats struct { + MemStats runtime.MemStats + } + var ds debugStats + runtime.ReadMemStats(&ds.MemStats) + err := json.NewEncoder(resp).Encode(&ds) + if err != nil { + http.Error(resp, err.Error(), 500) + } +} + // StatusHandler addresses /status.json requests. -func StatusHandler(resp http.ResponseWriter, req *http.Request) { +func (rtr *router) StatusHandler(resp http.ResponseWriter, req *http.Request) { stLock.Lock() - readNodeStatus(&st) + rtr.readNodeStatus(&st) jstat, err := json.Marshal(&st) stLock.Unlock() if err == nil { @@ -288,23 +345,33 @@ func StatusHandler(resp http.ResponseWriter, req *http.Request) { } // populate the given NodeStatus struct with current values. -func readNodeStatus(st *NodeStatus) { +func (rtr *router) readNodeStatus(st *NodeStatus) { vols := KeepVM.AllReadable() if cap(st.Volumes) < len(vols) { - st.Volumes = make([]*VolumeStatus, len(vols)) + st.Volumes = make([]*volumeStatusEnt, len(vols)) } st.Volumes = st.Volumes[:0] for _, vol := range vols { - if s := vol.Status(); s != nil { - st.Volumes = append(st.Volumes, s) + var internalStats interface{} + if vol, ok := vol.(InternalStatser); ok { + internalStats = vol.InternalStats() } + st.Volumes = append(st.Volumes, &volumeStatusEnt{ + Label: vol.String(), + Status: vol.Status(), + InternalStats: internalStats, + //VolumeStats: KeepVM.VolumeStats(vol), + }) } st.BufferPool.Alloc = bufs.Alloc() st.BufferPool.Cap = bufs.Cap() st.BufferPool.Len = bufs.Len() st.PullQueue = getWorkQueueStatus(pullq) st.TrashQueue = getWorkQueueStatus(trashq) - runtime.ReadMemStats(&st.Memory) + if rtr.limiter != nil { + st.RequestsCurrent = rtr.limiter.Current() + st.RequestsMax = rtr.limiter.Max() + } } // return a WorkQueueStatus for the given queue. If q is nil (which @@ -435,6 +502,9 @@ func DeleteHandler(resp http.ResponseWriter, req *http.Request) { type PullRequest struct { Locator string `json:"locator"` Servers []string `json:"servers"` + + // Destination mount, or "" for "anywhere" + MountUUID string } // PullHandler processes "PUT /pull" requests for the data manager. @@ -471,6 +541,9 @@ func PullHandler(resp http.ResponseWriter, req *http.Request) { type TrashRequest struct { Locator string `json:"locator"` BlockMtime int64 `json:"block_mtime"` + + // Target mount, or "" for "everywhere" + MountUUID string } // TrashHandler processes /trash requests. @@ -577,7 +650,7 @@ func GetBlock(ctx context.Context, hash string, buf []byte, resp http.ResponseWr size, err := vol.Get(ctx, hash, buf) select { case <-ctx.Done(): - return 0, ctx.Err() + return 0, ErrClientDisconnect default: } if err != nil { @@ -649,16 +722,21 @@ func PutBlock(ctx context.Context, block []byte, hash string) (int, error) { // If we already have this data, it's intact on disk, and we // can update its timestamp, return success. If we have // different data with the same hash, return failure. - if n, err := CompareAndTouch(hash, block); err == nil || err == CollisionError { + if n, err := CompareAndTouch(ctx, hash, block); err == nil || err == CollisionError { return n, err + } else if ctx.Err() != nil { + return 0, ErrClientDisconnect } // Choose a Keep volume to write to. // If this volume fails, try all of the volumes in order. if vol := KeepVM.NextWritable(); vol != nil { - if err := vol.Put(context.TODO(), hash, block); err == nil { + if err := vol.Put(ctx, hash, block); err == nil { return vol.Replication(), nil // success! } + if ctx.Err() != nil { + return 0, ErrClientDisconnect + } } writables := KeepVM.AllWritable() @@ -670,10 +748,8 @@ func PutBlock(ctx context.Context, block []byte, hash string) (int, error) { allFull := true for _, vol := range writables { err := vol.Put(ctx, hash, block) - select { - case <-ctx.Done(): - return 0, ctx.Err() - default: + if ctx.Err() != nil { + return 0, ErrClientDisconnect } if err == nil { return vol.Replication(), nil // success! @@ -700,10 +776,13 @@ func PutBlock(ctx context.Context, block []byte, hash string) (int, error) { // the relevant block's modification time in order to protect it from // premature garbage collection. Otherwise, it returns a non-nil // error. -func CompareAndTouch(hash string, buf []byte) (int, error) { +func CompareAndTouch(ctx context.Context, hash string, buf []byte) (int, error) { var bestErr error = NotFoundError for _, vol := range KeepVM.AllWritable() { - if err := vol.Compare(hash, buf); err == CollisionError { + err := vol.Compare(ctx, hash, buf) + if ctx.Err() != nil { + return 0, ctx.Err() + } else if err == CollisionError { // Stop if we have a block with same hash but // different content. (It will be impossible // to tell which one is wanted if we have