sdk/go/keepclient/keepclient.go

   1 /* Provides low-level Get/Put primitives for accessing Arvados Keep blocks. */
   2 package keepclient
   3
   4 import (
   5         "bytes"
   6         "crypto/md5"
   7         "crypto/tls"
   8         "errors"
   9         "fmt"
  10         "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
  11         "git.curoverse.com/arvados.git/sdk/go/streamer"
  12         "io"
  13         "io/ioutil"
  14         "log"
  15         "net/http"
  16         "os"
  17         "regexp"
  18         "strconv"
  19         "strings"
  20         "sync"
  21 )
  22
  23 // A Keep "block" is 64MB.
  24 const BLOCKSIZE = 64 * 1024 * 1024
  25
  26 var BlockNotFound = errors.New("Block not found")
  27 var InsufficientReplicasError = errors.New("Could not write sufficient replicas")
  28 var OversizeBlockError = errors.New("Exceeded maximum block size (" + strconv.Itoa(BLOCKSIZE) + ")")
  29 var MissingArvadosApiHost = errors.New("Missing required environment variable ARVADOS_API_HOST")
  30 var MissingArvadosApiToken = errors.New("Missing required environment variable ARVADOS_API_TOKEN")
  31 var InvalidLocatorError = errors.New("Invalid locator")
  32
  33 // ErrNoSuchKeepServer is returned when GetIndex is invoked with a UUID with no matching keep server
  34 var ErrNoSuchKeepServer = errors.New("No keep server matching the given UUID is found")
  35
  36 // ErrIncompleteIndex is returned when the Index response does not end with a new empty line
  37 var ErrIncompleteIndex = errors.New("Got incomplete index")
  38
  39 const X_Keep_Desired_Replicas = "X-Keep-Desired-Replicas"
  40 const X_Keep_Replicas_Stored = "X-Keep-Replicas-Stored"
  41
  42 // Information about Arvados and Keep servers.
  43 type KeepClient struct {
  44         Arvados            *arvadosclient.ArvadosClient
  45         Want_replicas      int
  46         Using_proxy        bool
  47         localRoots         *map[string]string
  48         writableLocalRoots *map[string]string
  49         gatewayRoots       *map[string]string
  50         lock               sync.RWMutex
  51         Client             *http.Client
  52
  53         // set to 1 if all writable services are of disk type, otherwise 0
  54         replicasPerService int
  55 }
  56
  57 // Create a new KeepClient.  This will contact the API server to discover Keep
  58 // servers.
  59 func MakeKeepClient(arv *arvadosclient.ArvadosClient) (*KeepClient, error) {
  60         var matchTrue = regexp.MustCompile("^(?i:1|yes|true)$")
  61         insecure := matchTrue.MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE"))
  62         kc := &KeepClient{
  63                 Arvados:       arv,
  64                 Want_replicas: 2,
  65                 Using_proxy:   false,
  66                 Client: &http.Client{Transport: &http.Transport{
  67                         TLSClientConfig: &tls.Config{InsecureSkipVerify: insecure}}},
  68         }
  69         return kc, kc.DiscoverKeepServers()
  70 }
  71
  72 // Put a block given the block hash, a reader, and the number of bytes
  73 // to read from the reader (which must be between 0 and BLOCKSIZE).
  74 //
  75 // Returns the locator for the written block, the number of replicas
  76 // written, and an error.
  77 //
  78 // Returns an InsufficientReplicas error if 0 <= replicas <
  79 // kc.Wants_replicas.
  80 func (kc *KeepClient) PutHR(hash string, r io.Reader, dataBytes int64) (string, int, error) {
  81         // Buffer for reads from 'r'
  82         var bufsize int
  83         if dataBytes > 0 {
  84                 if dataBytes > BLOCKSIZE {
  85                         return "", 0, OversizeBlockError
  86                 }
  87                 bufsize = int(dataBytes)
  88         } else {
  89                 bufsize = BLOCKSIZE
  90         }
  91
  92         t := streamer.AsyncStreamFromReader(bufsize, HashCheckingReader{r, md5.New(), hash})
  93         defer t.Close()
  94
  95         return kc.putReplicas(hash, t, dataBytes)
  96 }
  97
  98 // PutHB writes a block to Keep. The hash of the bytes is given in
  99 // hash, and the data is given in buf.
 100 //
 101 // Return values are the same as for PutHR.
 102 func (kc *KeepClient) PutHB(hash string, buf []byte) (string, int, error) {
 103         t := streamer.AsyncStreamFromSlice(buf)
 104         defer t.Close()
 105         return kc.putReplicas(hash, t, int64(len(buf)))
 106 }
 107
 108 // PutB writes a block to Keep. It computes the hash itself.
 109 //
 110 // Return values are the same as for PutHR.
 111 func (kc *KeepClient) PutB(buffer []byte) (string, int, error) {
 112         hash := fmt.Sprintf("%x", md5.Sum(buffer))
 113         return kc.PutHB(hash, buffer)
 114 }
 115
 116 // PutR writes a block to Keep. It first reads all data from r into a buffer
 117 // in order to compute the hash.
 118 //
 119 // Return values are the same as for PutHR.
 120 //
 121 // If the block hash and data size are known, PutHR is more efficient.
 122 func (kc *KeepClient) PutR(r io.Reader) (locator string, replicas int, err error) {
 123         if buffer, err := ioutil.ReadAll(r); err != nil {
 124                 return "", 0, err
 125         } else {
 126                 return kc.PutB(buffer)
 127         }
 128 }
 129
 130 // Get() retrieves a block, given a locator. Returns a reader, the
 131 // expected data length, the URL the block is being fetched from, and
 132 // an error.
 133 //
 134 // If the block checksum does not match, the final Read() on the
 135 // reader returned by this method will return a BadChecksum error
 136 // instead of EOF.
 137 func (kc *KeepClient) Get(locator string) (io.ReadCloser, int64, string, error) {
 138         var errs []string
 139         for _, host := range kc.getSortedRoots(locator) {
 140                 url := host + "/" + locator
 141                 req, err := http.NewRequest("GET", url, nil)
 142                 if err != nil {
 143                         continue
 144                 }
 145                 req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", kc.Arvados.ApiToken))
 146                 resp, err := kc.Client.Do(req)
 147                 if err != nil || resp.StatusCode != http.StatusOK {
 148                         if resp != nil {
 149                                 var respbody []byte
 150                                 if resp.Body != nil {
 151                                         respbody, _ = ioutil.ReadAll(&io.LimitedReader{resp.Body, 4096})
 152                                 }
 153                                 errs = append(errs, fmt.Sprintf("%s: %d %s",
 154                                         url, resp.StatusCode, strings.TrimSpace(string(respbody))))
 155                         } else {
 156                                 errs = append(errs, fmt.Sprintf("%s: %v", url, err))
 157                         }
 158                         continue
 159                 }
 160                 return HashCheckingReader{
 161                         Reader: resp.Body,
 162                         Hash:   md5.New(),
 163                         Check:  locator[0:32],
 164                 }, resp.ContentLength, url, nil
 165         }
 166         log.Printf("DEBUG: GET %s failed: %v", locator, errs)
 167         return nil, 0, "", BlockNotFound
 168 }
 169
 170 // Ask() verifies that a block with the given hash is available and
 171 // readable, according to at least one Keep service. Unlike Get, it
 172 // does not retrieve the data or verify that the data content matches
 173 // the hash specified by the locator.
 174 //
 175 // Returns the data size (content length) reported by the Keep service
 176 // and the URI reporting the data size.
 177 func (kc *KeepClient) Ask(locator string) (int64, string, error) {
 178         for _, host := range kc.getSortedRoots(locator) {
 179                 url := host + "/" + locator
 180                 req, err := http.NewRequest("HEAD", url, nil)
 181                 if err != nil {
 182                         continue
 183                 }
 184                 req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", kc.Arvados.ApiToken))
 185                 if resp, err := kc.Client.Do(req); err == nil && resp.StatusCode == http.StatusOK {
 186                         return resp.ContentLength, url, nil
 187                 }
 188         }
 189         return 0, "", BlockNotFound
 190 }
 191
 192 // GetIndex retrieves a list of blocks stored on the given server whose hashes
 193 // begin with the given prefix. The returned reader will return an error (other
 194 // than EOF) if the complete index cannot be retrieved.
 195 //
 196 // This is meant to be used only by system components and admin tools.
 197 // It will return an error unless the client is using a "data manager token"
 198 // recognized by the Keep services.
 199 func (kc *KeepClient) GetIndex(keepServiceUUID, prefix string) (io.Reader, error) {
 200         url := kc.LocalRoots()[keepServiceUUID]
 201         if url == "" {
 202                 return nil, ErrNoSuchKeepServer
 203         }
 204
 205         url += "/index"
 206         if prefix != "" {
 207                 url += "/" + prefix
 208         }
 209
 210         req, err := http.NewRequest("GET", url, nil)
 211         if err != nil {
 212                 return nil, err
 213         }
 214
 215         req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", kc.Arvados.ApiToken))
 216         resp, err := kc.Client.Do(req)
 217         if err != nil {
 218                 return nil, err
 219         }
 220
 221         defer resp.Body.Close()
 222
 223         if resp.StatusCode != http.StatusOK {
 224                 return nil, fmt.Errorf("Got http status code: %d", resp.StatusCode)
 225         }
 226
 227         var respBody []byte
 228         respBody, err = ioutil.ReadAll(resp.Body)
 229         if err != nil {
 230                 return nil, err
 231         }
 232
 233         // Got index; verify that it is complete
 234         // The response should be "\n" if no locators matched the prefix
 235         // Else, it should be a list of locators followed by a blank line
 236         if !bytes.Equal(respBody, []byte("\n")) && !bytes.HasSuffix(respBody, []byte("\n\n")) {
 237                 return nil, ErrIncompleteIndex
 238         }
 239
 240         // Got complete index; strip the trailing newline and send
 241         return bytes.NewReader(respBody[0 : len(respBody)-1]), nil
 242 }
 243
 244 // LocalRoots() returns the map of local (i.e., disk and proxy) Keep
 245 // services: uuid -> baseURI.
 246 func (kc *KeepClient) LocalRoots() map[string]string {
 247         kc.lock.RLock()
 248         defer kc.lock.RUnlock()
 249         return *kc.localRoots
 250 }
 251
 252 // GatewayRoots() returns the map of Keep remote gateway services:
 253 // uuid -> baseURI.
 254 func (kc *KeepClient) GatewayRoots() map[string]string {
 255         kc.lock.RLock()
 256         defer kc.lock.RUnlock()
 257         return *kc.gatewayRoots
 258 }
 259
 260 // WritableLocalRoots() returns the map of writable local Keep services:
 261 // uuid -> baseURI.
 262 func (kc *KeepClient) WritableLocalRoots() map[string]string {
 263         kc.lock.RLock()
 264         defer kc.lock.RUnlock()
 265         return *kc.writableLocalRoots
 266 }
 267
 268 // SetServiceRoots updates the localRoots and gatewayRoots maps,
 269 // without risk of disrupting operations that are already in progress.
 270 //
 271 // The KeepClient makes its own copy of the supplied maps, so the
 272 // caller can reuse/modify them after SetServiceRoots returns, but
 273 // they should not be modified by any other goroutine while
 274 // SetServiceRoots is running.
 275 func (kc *KeepClient) SetServiceRoots(newLocals, newWritableLocals map[string]string, newGateways map[string]string) {
 276         locals := make(map[string]string)
 277         for uuid, root := range newLocals {
 278                 locals[uuid] = root
 279         }
 280
 281         writables := make(map[string]string)
 282         for uuid, root := range newWritableLocals {
 283                 writables[uuid] = root
 284         }
 285
 286         gateways := make(map[string]string)
 287         for uuid, root := range newGateways {
 288                 gateways[uuid] = root
 289         }
 290
 291         kc.lock.Lock()
 292         defer kc.lock.Unlock()
 293         kc.localRoots = &locals
 294         kc.writableLocalRoots = &writables
 295         kc.gatewayRoots = &gateways
 296 }
 297
 298 // getSortedRoots returns a list of base URIs of Keep services, in the
 299 // order they should be attempted in order to retrieve content for the
 300 // given locator.
 301 func (kc *KeepClient) getSortedRoots(locator string) []string {
 302         var found []string
 303         for _, hint := range strings.Split(locator, "+") {
 304                 if len(hint) < 7 || hint[0:2] != "K@" {
 305                         // Not a service hint.
 306                         continue
 307                 }
 308                 if len(hint) == 7 {
 309                         // +K@abcde means fetch from proxy at
 310                         // keep.abcde.arvadosapi.com
 311                         found = append(found, "https://keep."+hint[2:]+".arvadosapi.com")
 312                 } else if len(hint) == 29 {
 313                         // +K@abcde-abcde-abcdeabcdeabcde means fetch
 314                         // from gateway with given uuid
 315                         if gwURI, ok := kc.GatewayRoots()[hint[2:]]; ok {
 316                                 found = append(found, gwURI)
 317                         }
 318                         // else this hint is no use to us; carry on.
 319                 }
 320         }
 321         // After trying all usable service hints, fall back to local roots.
 322         found = append(found, NewRootSorter(kc.LocalRoots(), locator[0:32]).GetSortedRoots()...)
 323         return found
 324 }
 325
 326 type Locator struct {
 327         Hash  string
 328         Size  int      // -1 if data size is not known
 329         Hints []string // Including the size hint, if any
 330 }
 331
 332 func (loc *Locator) String() string {
 333         s := loc.Hash
 334         if len(loc.Hints) > 0 {
 335                 s = s + "+" + strings.Join(loc.Hints, "+")
 336         }
 337         return s
 338 }
 339
 340 var locatorMatcher = regexp.MustCompile("^([0-9a-f]{32})([+](.*))?$")
 341
 342 func MakeLocator(path string) (*Locator, error) {
 343         sm := locatorMatcher.FindStringSubmatch(path)
 344         if sm == nil {
 345                 return nil, InvalidLocatorError
 346         }
 347         loc := Locator{Hash: sm[1], Size: -1}
 348         if sm[2] != "" {
 349                 loc.Hints = strings.Split(sm[3], "+")
 350         } else {
 351                 loc.Hints = []string{}
 352         }
 353         if len(loc.Hints) > 0 {
 354                 if size, err := strconv.Atoi(loc.Hints[0]); err == nil {
 355                         loc.Size = size
 356                 }
 357         }
 358         return &loc, nil
 359 }