file_block_map_disk.go

// Copyright 2019 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.

package libkbfs

import (
	"context"

	"github.com/keybase/client/go/kbfs/data"
	"github.com/keybase/client/go/kbfs/kbfsblock"
	"github.com/keybase/client/go/kbfs/libkey"
	"github.com/pkg/errors"
)

type fileBlockMapDiskInfo struct {
	pps data.PathPartString
	ptr data.BlockPointer
}

// fileBlockMapDisk tracks block info while making a revision, by
// using a disk-based block cache.
type fileBlockMapDisk struct {
	dirtyBcache *DirtyBlockCacheDisk
	kmd         libkey.KeyMetadata
	ptrs        map[data.BlockPointer]map[string]fileBlockMapDiskInfo
}

var _ fileBlockMap = (*fileBlockMapDisk)(nil)

func newFileBlockMapDisk(
	dirtyBcache *DirtyBlockCacheDisk, kmd libkey.KeyMetadata) *fileBlockMapDisk {
	return &fileBlockMapDisk{
		dirtyBcache: dirtyBcache,
		kmd:         kmd,
		ptrs:        make(map[data.BlockPointer]map[string]fileBlockMapDiskInfo),
	}
}

func (fbmd *fileBlockMapDisk) putTopBlock(
	ctx context.Context, parentPtr data.BlockPointer,
	childName data.PathPartString, topBlock *data.FileBlock) error {
	// To reuse the DirtyBlockCacheDisk code, we need to assign a
	// random BlockPointer to this block.
	id, err := kbfsblock.MakeTemporaryID()
	if err != nil {
		return err
	}
	ptr := data.BlockPointer{ID: id}

	err = fbmd.dirtyBcache.Put(
		ctx, fbmd.kmd.TlfID(), ptr, data.MasterBranch, topBlock)
	if err != nil {
		return err
	}

	ptrMap, ok := fbmd.ptrs[parentPtr]
	if !ok {
		ptrMap = make(map[string]fileBlockMapDiskInfo)
		fbmd.ptrs[parentPtr] = ptrMap
	}

	ptrMap[childName.Plaintext()] = fileBlockMapDiskInfo{childName, ptr}
	return nil
}

func (fbmd *fileBlockMapDisk) GetTopBlock(
	ctx context.Context, parentPtr data.BlockPointer,
	childName data.PathPartString) (*data.FileBlock, error) {
	ptrMap, ok := fbmd.ptrs[parentPtr]
	if !ok {
		return nil, errors.Errorf("No such parent %s", parentPtr)
	}
	info, ok := ptrMap[childName.Plaintext()]
	if !ok {
		return nil, errors.Errorf(
			"No such name %s in parent %s", childName, parentPtr)
	}
	block, err := fbmd.dirtyBcache.Get(
		ctx, fbmd.kmd.TlfID(), info.ptr, data.MasterBranch)
	if err != nil {
		return nil, err
	}
	fblock, ok := block.(*data.FileBlock)
	if !ok {
		return nil, errors.Errorf(
			"Unexpected block type for file block: %T", block)
	}
	return fblock, nil
}

func (fbmd *fileBlockMapDisk) getFilenames(
	_ context.Context, parentPtr data.BlockPointer) (
	names []data.PathPartString, err error) {
	ptrMap, ok := fbmd.ptrs[parentPtr]
	if !ok {
		return nil, nil
	}
	names = make([]data.PathPartString, 0, len(ptrMap))
	for _, info := range ptrMap {
		names = append(names, info.pps)
	}
	return names, nil
}