Merge branch '7159-clean-index' refs #7159 refs #7168
[arvados.git] / services / keepstore / azure_blob_volume.go
index 0d0e5462258b47d7bf45c4d91761d0512416faea..e9fda2ab76dd41c6cdde36cb139e3f3f030c273b 100644 (file)
@@ -1,23 +1,41 @@
 package main
 
 import (
+       "bytes"
        "errors"
        "flag"
        "fmt"
        "io"
        "io/ioutil"
        "log"
+       "os"
+       "regexp"
        "strings"
        "time"
 
-       "github.com/Azure/azure-sdk-for-go/storage"
+       "github.com/curoverse/azure-sdk-for-go/storage"
 )
 
 var (
        azureStorageAccountName    string
        azureStorageAccountKeyFile string
+       azureStorageReplication    int
+       azureWriteRaceInterval     = 15 * time.Second
+       azureWriteRacePollTime     = time.Second
 )
 
+func readKeyFromFile(file string) (string, error) {
+       buf, err := ioutil.ReadFile(file)
+       if err != nil {
+               return "", errors.New("reading key from " + file + ": " + err.Error())
+       }
+       accountKey := strings.TrimSpace(string(buf))
+       if accountKey == "" {
+               return "", errors.New("empty account key in " + file)
+       }
+       return accountKey, nil
+}
+
 type azureVolumeAdder struct {
        *volumeSet
 }
@@ -26,13 +44,12 @@ func (s *azureVolumeAdder) Set(containerName string) error {
        if containerName == "" {
                return errors.New("no container name given")
        }
-       buf, err := ioutil.ReadFile(azureStorageAccountKeyFile)
-       if err != nil {
-               return errors.New("reading key from " + azureStorageAccountKeyFile + ": " + err.Error())
+       if azureStorageAccountName == "" || azureStorageAccountKeyFile == "" {
+               return errors.New("-azure-storage-account-name and -azure-storage-account-key-file arguments must given before -azure-storage-container-volume")
        }
-       accountKey := strings.TrimSpace(string(buf))
-       if accountKey == "" {
-               return errors.New("empty account key in " + azureStorageAccountKeyFile)
+       accountKey, err := readKeyFromFile(azureStorageAccountKeyFile)
+       if err != nil {
+               return err
        }
        azClient, err := storage.NewBasicClient(azureStorageAccountName, accountKey)
        if err != nil {
@@ -41,7 +58,7 @@ func (s *azureVolumeAdder) Set(containerName string) error {
        if flagSerializeIO {
                log.Print("Notice: -serialize is not supported by azure-blob-container volumes.")
        }
-       v := NewAzureBlobVolume(azClient, containerName, flagReadonly)
+       v := NewAzureBlobVolume(azClient, containerName, flagReadonly, azureStorageReplication)
        if err := v.Check(); err != nil {
                return err
        }
@@ -63,6 +80,11 @@ func init() {
                "azure-storage-account-key-file",
                "",
                "File containing the account key used for subsequent --azure-storage-container-volume arguments.")
+       flag.IntVar(
+               &azureStorageReplication,
+               "azure-storage-replication",
+               3,
+               "Replication level to report to clients when data is stored in an Azure container.")
 }
 
 // An AzureBlobVolume stores and retrieves blocks in an Azure Blob
@@ -72,14 +94,19 @@ type AzureBlobVolume struct {
        bsClient      storage.BlobStorageClient
        containerName string
        readonly      bool
+       replication   int
 }
 
-func NewAzureBlobVolume(client storage.Client, containerName string, readonly bool) *AzureBlobVolume {
+// NewAzureBlobVolume returns a new AzureBlobVolume using the given
+// client and container name. The replication argument specifies the
+// replication level to report when writing data.
+func NewAzureBlobVolume(client storage.Client, containerName string, readonly bool, replication int) *AzureBlobVolume {
        return &AzureBlobVolume{
-               azClient: client,
-               bsClient: client.GetBlobService(),
+               azClient:      client,
+               bsClient:      client.GetBlobService(),
                containerName: containerName,
-               readonly: readonly,
+               readonly:      readonly,
+               replication:   replication,
        }
 }
 
@@ -95,16 +122,56 @@ func (v *AzureBlobVolume) Check() error {
        return nil
 }
 
+// Get reads a Keep block that has been stored as a block blob in the
+// container.
+//
+// If the block is younger than azureWriteRaceInterval and is
+// unexpectedly empty, assume a PutBlob operation is in progress, and
+// wait for it to finish writing.
 func (v *AzureBlobVolume) Get(loc string) ([]byte, error) {
+       var deadline time.Time
+       haveDeadline := false
+       buf, err := v.get(loc)
+       for err == nil && len(buf) == 0 && loc != "d41d8cd98f00b204e9800998ecf8427e" {
+               // Seeing a brand new empty block probably means we're
+               // in a race with CreateBlob, which under the hood
+               // (apparently) does "CreateEmpty" and "CommitData"
+               // with no additional transaction locking.
+               if !haveDeadline {
+                       t, err := v.Mtime(loc)
+                       if err != nil {
+                               log.Print("Got empty block (possible race) but Mtime failed: ", err)
+                               break
+                       }
+                       deadline = t.Add(azureWriteRaceInterval)
+                       if time.Now().After(deadline) {
+                               break
+                       }
+                       log.Printf("Race? Block %s is 0 bytes, %s old. Polling until %s", loc, time.Since(t), deadline)
+                       haveDeadline = true
+               } else if time.Now().After(deadline) {
+                       break
+               }
+               bufs.Put(buf)
+               time.Sleep(azureWriteRacePollTime)
+               buf, err = v.get(loc)
+       }
+       if haveDeadline {
+               log.Printf("Race ended with len(buf)==%d", len(buf))
+       }
+       return buf, err
+}
+
+func (v *AzureBlobVolume) get(loc string) ([]byte, error) {
        rdr, err := v.bsClient.GetBlob(v.containerName, loc)
        if err != nil {
-               return nil, err
+               return nil, v.translateError(err)
        }
        defer rdr.Close()
        buf := bufs.Get(BlockSize)
        n, err := io.ReadFull(rdr, buf)
        switch err {
-       case io.EOF, io.ErrUnexpectedEOF:
+       case nil, io.EOF, io.ErrUnexpectedEOF:
                return buf[:n], nil
        default:
                bufs.Put(buf)
@@ -112,25 +179,35 @@ func (v *AzureBlobVolume) Get(loc string) ([]byte, error) {
        }
 }
 
-func (v *AzureBlobVolume) Compare(loc string, data []byte) error {
-       return NotFoundError
+// Compare the given data with existing stored data.
+func (v *AzureBlobVolume) Compare(loc string, expect []byte) error {
+       rdr, err := v.bsClient.GetBlob(v.containerName, loc)
+       if err != nil {
+               return v.translateError(err)
+       }
+       defer rdr.Close()
+       return compareReaderWithBuf(rdr, expect, loc[:32])
 }
 
+// Put sotres a Keep block as a block blob in the container.
 func (v *AzureBlobVolume) Put(loc string, block []byte) error {
-       if err := v.bsClient.CreateBlockBlob(v.containerName, loc); err != nil {
-               return err
+       if v.readonly {
+               return MethodDisabledError
        }
-       // We use the same block ID, base64("0")=="MA==", for everything.
-       if err := v.bsClient.PutBlock(v.containerName, loc, "MA==", block); err != nil {
-               return err
-       }
-       return v.bsClient.PutBlockList(v.containerName, loc, []storage.Block{{"MA==", storage.BlockStatusUncommitted}})
+       return v.bsClient.CreateBlockBlobFromReader(v.containerName, loc, uint64(len(block)), bytes.NewReader(block))
 }
 
+// Touch updates the last-modified property of a block blob.
 func (v *AzureBlobVolume) Touch(loc string) error {
-       return v.bsClient.PutBlockList(v.containerName, loc, []storage.Block{{"MA==", storage.BlockStatusCommitted}})
+       if v.readonly {
+               return MethodDisabledError
+       }
+       return v.bsClient.SetBlobMetadata(v.containerName, loc, map[string]string{
+               "touch": fmt.Sprintf("%d", time.Now()),
+       })
 }
 
+// Mtime returns the last-modified property of a block blob.
 func (v *AzureBlobVolume) Mtime(loc string) (time.Time, error) {
        props, err := v.bsClient.GetBlobProperties(v.containerName, loc)
        if err != nil {
@@ -139,6 +216,8 @@ func (v *AzureBlobVolume) Mtime(loc string) (time.Time, error) {
        return time.Parse(time.RFC1123, props.LastModified)
 }
 
+// IndexTo writes a list of Keep blocks that are stored in the
+// container.
 func (v *AzureBlobVolume) IndexTo(prefix string, writer io.Writer) error {
        params := storage.ListBlobsParameters{
                Prefix: prefix,
@@ -153,7 +232,18 @@ func (v *AzureBlobVolume) IndexTo(prefix string, writer io.Writer) error {
                        if err != nil {
                                return err
                        }
-                       fmt.Fprintf(writer, "%s+%d\n", b.Name, t.Unix())
+                       if !v.isKeepBlock(b.Name) {
+                               continue
+                       }
+                       if b.Properties.ContentLength == 0 && t.Add(azureWriteRaceInterval).After(time.Now()) {
+                               // A new zero-length blob is probably
+                               // just a new non-empty blob that
+                               // hasn't committed its data yet (see
+                               // Get()), and in any case has no
+                               // value.
+                               continue
+                       }
+                       fmt.Fprintf(writer, "%s+%d %d\n", b.Name, b.Properties.ContentLength, t.Unix())
                }
                if resp.NextMarker == "" {
                        return nil
@@ -162,16 +252,31 @@ func (v *AzureBlobVolume) IndexTo(prefix string, writer io.Writer) error {
        }
 }
 
+// Delete a Keep block.
 func (v *AzureBlobVolume) Delete(loc string) error {
-       // TODO: Use leases to handle races with Touch and Put.
+       if v.readonly {
+               return MethodDisabledError
+       }
+       // Ideally we would use If-Unmodified-Since, but that
+       // particular condition seems to be ignored by Azure. Instead,
+       // we get the Etag before checking Mtime, and use If-Match to
+       // ensure we don't delete data if Put() or Touch() happens
+       // between our calls to Mtime() and DeleteBlob().
+       props, err := v.bsClient.GetBlobProperties(v.containerName, loc)
+       if err != nil {
+               return err
+       }
        if t, err := v.Mtime(loc); err != nil {
                return err
        } else if time.Since(t) < blobSignatureTTL {
                return nil
        }
-       return v.bsClient.DeleteBlob(v.containerName, loc)
+       return v.bsClient.DeleteBlob(v.containerName, loc, map[string]string{
+               "If-Match": props.Etag,
+       })
 }
 
+// Status returns a VolumeStatus struct with placeholder data.
 func (v *AzureBlobVolume) Status() *VolumeStatus {
        return &VolumeStatus{
                DeviceNum: 1,
@@ -180,10 +285,38 @@ func (v *AzureBlobVolume) Status() *VolumeStatus {
        }
 }
 
+// String returns a volume label, including the container name.
 func (v *AzureBlobVolume) String() string {
        return fmt.Sprintf("azure-storage-container:%+q", v.containerName)
 }
 
+// Writable returns true, unless the -readonly flag was on when the
+// volume was added.
 func (v *AzureBlobVolume) Writable() bool {
        return !v.readonly
 }
+
+// Replication returns the replication level of the container, as
+// specified by the -azure-storage-replication argument.
+func (v *AzureBlobVolume) Replication() int {
+       return v.replication
+}
+
+// If possible, translate an Azure SDK error to a recognizable error
+// like os.ErrNotExist.
+func (v *AzureBlobVolume) translateError(err error) error {
+       switch {
+       case err == nil:
+               return err
+       case strings.Contains(err.Error(), "404 Not Found"):
+               // "storage: service returned without a response body (404 Not Found)"
+               return os.ErrNotExist
+       default:
+               return err
+       }
+}
+
+var keepBlockRegexp = regexp.MustCompile(`^[0-9a-f]{32}$`)
+func (v *AzureBlobVolume) isKeepBlock(s string) bool {
+       return keepBlockRegexp.MatchString(s)
+}