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