X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/8626abb0a44cfc303bef3552a7bc57163c79231a..c980683a243903babe9cc09cabc71e1c6229fef1:/services/keepstore/azure_blob_volume.go

diff --git a/services/keepstore/azure_blob_volume.go b/services/keepstore/azure_blob_volume.go
index b1d528db8c..f08cebff63 100644
--- a/services/keepstore/azure_blob_volume.go
+++ b/services/keepstore/azure_blob_volume.go
@@ -1,13 +1,103 @@
 package main
 
 import (
+	"bytes"
+	"errors"
+	"flag"
 	"fmt"
 	"io"
+	"io/ioutil"
+	"log"
+	"os"
+	"regexp"
+	"strings"
+	"sync"
 	"time"
 
-	"github.com/Azure/azure-sdk-for-go/storage"
+	"github.com/curoverse/azure-sdk-for-go/storage"
 )
 
+var (
+	azureMaxGetBytes           int
+	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
+}
+
+func (s *azureVolumeAdder) Set(containerName string) error {
+	if trashLifetime != 0 {
+		return ErrNotImplemented
+	}
+
+	if containerName == "" {
+		return errors.New("no container name given")
+	}
+	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, err := readKeyFromFile(azureStorageAccountKeyFile)
+	if err != nil {
+		return err
+	}
+	azClient, err := storage.NewBasicClient(azureStorageAccountName, accountKey)
+	if err != nil {
+		return errors.New("creating Azure storage client: " + err.Error())
+	}
+	if flagSerializeIO {
+		log.Print("Notice: -serialize is not supported by azure-blob-container volumes.")
+	}
+	v := NewAzureBlobVolume(azClient, containerName, flagReadonly, azureStorageReplication)
+	if err := v.Check(); err != nil {
+		return err
+	}
+	*s.volumeSet = append(*s.volumeSet, v)
+	return nil
+}
+
+func init() {
+	flag.Var(&azureVolumeAdder{&volumes},
+		"azure-storage-container-volume",
+		"Use the given container as a storage volume. Can be given multiple times.")
+	flag.StringVar(
+		&azureStorageAccountName,
+		"azure-storage-account-name",
+		"",
+		"Azure storage account name used for subsequent --azure-storage-container-volume arguments.")
+	flag.StringVar(
+		&azureStorageAccountKeyFile,
+		"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.")
+	flag.IntVar(
+		&azureMaxGetBytes,
+		"azure-max-get-bytes",
+		BlockSize,
+		fmt.Sprintf("Maximum bytes to request in a single GET request. If smaller than %d, use multiple concurrent range requests to retrieve a block.", BlockSize))
+}
+
 // An AzureBlobVolume stores and retrieves blocks in an Azure Blob
 // container.
 type AzureBlobVolume struct {
@@ -15,57 +105,252 @@ 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,
 	}
 }
 
-func (v *AzureBlobVolume) Get(loc string) ([]byte, error) {
-	rdr, err := v.bsClient.GetBlob(v.containerName, loc)
+// Check returns nil if the volume is usable.
+func (v *AzureBlobVolume) Check() error {
+	ok, err := v.bsClient.ContainerExists(v.containerName)
 	if err != nil {
-		return nil, err
+		return err
 	}
-	buf := bufs.Get(BlockSize)
-	n, err := io.ReadFull(rdr, buf)
-	switch err {
-	case io.EOF, io.ErrUnexpectedEOF:
-		return buf[:n], nil
-	default:
+	if !ok {
+		return errors.New("container does not exist")
+	}
+	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)
-		return nil, err
+		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) Compare(loc string, data []byte) error {
-	return NotFoundError
+func (v *AzureBlobVolume) get(loc string) ([]byte, error) {
+	expectSize := BlockSize
+	if azureMaxGetBytes < BlockSize {
+		// Unfortunately the handler doesn't tell us how long the blob
+		// is expected to be, so we have to ask Azure.
+		props, err := v.bsClient.GetBlobProperties(v.containerName, loc)
+		if err != nil {
+			return nil, v.translateError(err)
+		}
+		if props.ContentLength > int64(BlockSize) || props.ContentLength < 0 {
+			return nil, fmt.Errorf("block %s invalid size %d (max %d)", loc, props.ContentLength, BlockSize)
+		}
+		expectSize = int(props.ContentLength)
+	}
+
+	buf := bufs.Get(expectSize)
+	if expectSize == 0 {
+		return buf, nil
+	}
+
+	// We'll update this actualSize if/when we get the last piece.
+	actualSize := -1
+	pieces := (expectSize + azureMaxGetBytes - 1) / azureMaxGetBytes
+	errors := make([]error, pieces)
+	var wg sync.WaitGroup
+	wg.Add(pieces)
+	for p := 0; p < pieces; p++ {
+		go func(p int) {
+			defer wg.Done()
+			startPos := p * azureMaxGetBytes
+			endPos := startPos + azureMaxGetBytes
+			if endPos > expectSize {
+				endPos = expectSize
+			}
+			var rdr io.ReadCloser
+			var err error
+			if startPos == 0 && endPos == expectSize {
+				rdr, err = v.bsClient.GetBlob(v.containerName, loc)
+			} else {
+				rdr, err = v.bsClient.GetBlobRange(v.containerName, loc, fmt.Sprintf("%d-%d", startPos, endPos-1))
+			}
+			if err != nil {
+				errors[p] = err
+				return
+			}
+			defer rdr.Close()
+			n, err := io.ReadFull(rdr, buf[startPos:endPos])
+			if pieces == 1 && (err == io.ErrUnexpectedEOF || err == io.EOF) {
+				// If we don't know the actual size,
+				// and just tried reading 64 MiB, it's
+				// normal to encounter EOF.
+			} else if err != nil {
+				errors[p] = err
+			}
+			if p == pieces-1 {
+				actualSize = startPos + n
+			}
+		}(p)
+	}
+	wg.Wait()
+	for _, err := range errors {
+		if err != nil {
+			bufs.Put(buf)
+			return nil, v.translateError(err)
+		}
+	}
+	return buf[:actualSize], nil
 }
 
+// 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 stores a Keep block as a block blob in the container.
 func (v *AzureBlobVolume) Put(loc string, block []byte) error {
-	return NotFoundError
+	if v.readonly {
+		return MethodDisabledError
+	}
+	return v.bsClient.CreateBlockBlobFromReader(v.containerName, loc, uint64(len(block)), bytes.NewReader(block), nil)
 }
 
+// Touch updates the last-modified property of a block blob.
 func (v *AzureBlobVolume) Touch(loc string) error {
-	return NotFoundError
+	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) {
-	return time.Time{}, NotFoundError
+	props, err := v.bsClient.GetBlobProperties(v.containerName, loc)
+	if err != nil {
+		return time.Time{}, err
+	}
+	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 {
-	return nil
+	params := storage.ListBlobsParameters{
+		Prefix: prefix,
+	}
+	for {
+		resp, err := v.bsClient.ListBlobs(v.containerName, params)
+		if err != nil {
+			return err
+		}
+		for _, b := range resp.Blobs {
+			t, err := time.Parse(time.RFC1123, b.Properties.LastModified)
+			if err != nil {
+				return err
+			}
+			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
+		}
+		params.Marker = resp.NextMarker
+	}
+}
+
+// Trash a Keep block.
+func (v *AzureBlobVolume) Trash(loc string) error {
+	if v.readonly {
+		return MethodDisabledError
+	}
+
+	if trashLifetime != 0 {
+		return ErrNotImplemented
+	}
+
+	// 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, map[string]string{
+		"If-Match": props.Etag,
+	})
 }
 
-func (v *AzureBlobVolume) Delete(loc string) error {
-	return NotFoundError
+// Untrash a Keep block.
+// TBD
+func (v *AzureBlobVolume) Untrash(loc string) error {
+	return ErrNotImplemented
 }
 
+// Status returns a VolumeStatus struct with placeholder data.
 func (v *AzureBlobVolume) Status() *VolumeStatus {
 	return &VolumeStatus{
 		DeviceNum: 1,
@@ -74,10 +359,45 @@ func (v *AzureBlobVolume) Status() *VolumeStatus {
 	}
 }
 
+// String returns a volume label, including the container name.
 func (v *AzureBlobVolume) String() string {
-	return fmt.Sprintf("%+v", v.azClient)
+	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)
+}
+
+// EmptyTrash looks for trashed blocks that exceeded trashLifetime
+// and deletes them from the volume.
+// TBD
+func (v *AzureBlobVolume) EmptyTrash() {
+}