prometheus/block.go

// Copyright 2017 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package tsdb

import (
	"bufio"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"sort"

	"github.com/oklog/ulid"
	"github.com/pkg/errors"
	"github.com/prometheus/tsdb/labels"
)

// DiskBlock handles reads against a Block of time series data.
type DiskBlock interface {
	// Directory where block data is stored.
	Dir() string

	// Stats returns statistics about the block.
	Meta() BlockMeta

	// Index returns an IndexReader over the block's data.
	Index() IndexReader

	// Chunks returns a ChunkReader over the block's data.
	Chunks() ChunkReader

	// Delete deletes data from the block.
	Delete(mint, maxt int64, ms ...labels.Matcher) error

	// Close releases all underlying resources of the block.
	Close() error
}

// Block is an interface to a DiskBlock that can also be queried.
type Block interface {
	DiskBlock
	Queryable
}

// headBlock is a regular block that can still be appended to.
type headBlock interface {
	Block
	Appendable
}

// Appendable defines an entity to which data can be appended.
type Appendable interface {
	// Appender returns a new Appender against an underlying store.
	Appender() Appender

	// Busy returns whether there are any currently active appenders.
	Busy() bool
}

// Queryable defines an entity which provides a Querier.
type Queryable interface {
	Querier(mint, maxt int64) Querier
}

// BlockMeta provides meta information about a block.
type BlockMeta struct {
	// Unique identifier for the block and its contents. Changes on compaction.
	ULID ulid.ULID `json:"ulid"`

	// Sequence number of the block.
	Sequence int `json:"sequence"`

	// MinTime and MaxTime specify the time range all samples
	// in the block are in.
	MinTime int64 `json:"minTime"`
	MaxTime int64 `json:"maxTime"`

	// Stats about the contents of the block.
	Stats struct {
		NumSamples uint64 `json:"numSamples,omitempty"`
		NumSeries  uint64 `json:"numSeries,omitempty"`
		NumChunks  uint64 `json:"numChunks,omitempty"`
	} `json:"stats,omitempty"`

	// Information on compactions the block was created from.
	Compaction struct {
		Generation int `json:"generation"`
	} `json:"compaction"`
}

const (
	flagNone = 0
	flagStd  = 1
)

type blockMeta struct {
	Version int `json:"version"`

	*BlockMeta
}

const metaFilename = "meta.json"
const tombstoneFilename = "tombstones"

func readMetaFile(dir string) (*BlockMeta, error) {
	b, err := ioutil.ReadFile(filepath.Join(dir, metaFilename))
	if err != nil {
		return nil, err
	}
	var m blockMeta

	if err := json.Unmarshal(b, &m); err != nil {
		return nil, err
	}
	if m.Version != 1 {
		return nil, errors.Errorf("unexpected meta file version %d", m.Version)
	}

	return m.BlockMeta, nil
}

func writeMetaFile(dir string, meta *BlockMeta) error {
	// Make any changes to the file appear atomic.
	path := filepath.Join(dir, metaFilename)
	tmp := path + ".tmp"

	f, err := os.Create(tmp)
	if err != nil {
		return err
	}

	enc := json.NewEncoder(f)
	enc.SetIndent("", "\t")

	var merr MultiError
	if merr.Add(enc.Encode(&blockMeta{Version: 1, BlockMeta: meta})); merr.Err() != nil {
		merr.Add(f.Close())
		return merr
	}
	if err := f.Close(); err != nil {
		return err
	}
	return renameFile(tmp, path)
}

type persistedBlock struct {
	dir  string
	meta BlockMeta

	chunkr *chunkReader
	indexr *indexReader
}

func newPersistedBlock(dir string) (*persistedBlock, error) {
	meta, err := readMetaFile(dir)
	if err != nil {
		return nil, err
	}

	cr, err := newChunkReader(chunkDir(dir))
	if err != nil {
		return nil, err
	}
	ir, err := newIndexReader(dir)
	if err != nil {
		return nil, err
	}

	pb := &persistedBlock{
		dir:    dir,
		meta:   *meta,
		chunkr: cr,
		indexr: ir,
	}
	return pb, nil
}

func (pb *persistedBlock) Close() error {
	var merr MultiError

	merr.Add(pb.chunkr.Close())
	merr.Add(pb.indexr.Close())

	return merr.Err()
}

func (pb *persistedBlock) String() string {
	return fmt.Sprintf("(%d, %s)", pb.meta.Sequence, pb.meta.ULID)
}

func (pb *persistedBlock) Querier(mint, maxt int64) Querier {
	return &blockQuerier{
		mint:   mint,
		maxt:   maxt,
		index:  pb.Index(),
		chunks: pb.Chunks(),
	}
}

func (pb *persistedBlock) Dir() string         { return pb.dir }
func (pb *persistedBlock) Index() IndexReader  { return pb.indexr }
func (pb *persistedBlock) Chunks() ChunkReader { return pb.chunkr }
func (pb *persistedBlock) Meta() BlockMeta     { return pb.meta }

func (pb *persistedBlock) Delete(mint, maxt int64, ms ...labels.Matcher) error {
	pr := newPostingsReader(pb.indexr)
	p, absent := pr.Select(ms...)

	ir := pb.indexr

	// Choose only valid postings which have chunks in the time-range.
	vPostings := []uint32{}

Outer:
	for p.Next() {
		lset, chunks, err := ir.Series(p.At())

		for _, abs := range absent {
			if lset.Get(abs) != "" {
				continue Outer
			}
		}

		// XXX(gouthamve): Adjust mint and maxt to match the time-range in the chunks?
		for _, chk := range chunks {
			if (mint <= chk.MinTime && maxt >= MinTime) ||
				(mint > chk.MinTime && mint <= chk.MaxTime) {
				vPostings = append(vPostings, p.At())
				continue
			}
		}
	}

	if p.Err() != nil {
		return p.Err()
	}

	// Merge the current and new tombstones.
	tr := ir.tombstones()
	stones := make([]rip, 0, len(vPostings))
	i := 0
	for tr.Next() {
		stone := tr.At()
		for stone.ref > vPostings[i] {
			stones = append(stones, rip{ref: vPostings[i], mint: mint, maxt: maxt})
			i++
		}

		if stone.ref == vPostings[i] {
			if stone.mint > mint {
				stone.mint = mint
			}
			if stone.maxt < maxt {
				stone.maxt = maxt
			}

			stones = append(stones, stone)
			continue
		}

		stones = append(stones, stone)
	}

	path := filepath.Join(pb.dir, tombstoneFilename)
	tmp := path + ".tmp"

	f, err := os.Create(tmp)
	if err != nil {
		return err
	}

	// TODO: Proper format and all.
	buf := encbuf{b: make([]byte, 0, 20)}
	fbuf := bufio.NewWriterSize(f, 20)

	for _, stone := range stones {
		buf.reset()
		buf.putBE32(stone.ref)
		buf.putBE64int64(stone.mint)
		buf.putBE64int64(stone.maxt)

		_, err := fbuf.Write(buf.get())
		if err != nil {
			return err
		}
	}

	if err := fbuf.Flush(); err != nil {
		return err
	}
	if err := f.Close(); err != nil {
		return err
	}

	return renameFile(tmp, path)
}

// rip (after rest-in-peace) holds the information on the posting and time-range
// that is deleted.
type rip struct {
	ref        uint32
	mint, maxt int64
}

// TODO(gouthamve): Move to cur and reduction in byte-array vis-a-vis BEPostings.
type tombstoneReader struct {
	data []byte
	idx  int
	len  int
}

func newTombStoneReader(data []byte) *tombstoneReader {
	// TODO(gouthamve): Error handling.
	return &tombstoneReader{data: data, idx: -1, len: len(data) / 20}
}

func (t *tombstoneReader) Next() bool {
	t.idx++

	return t.idx < t.len
}

func (t *tombstoneReader) At() rip {
	bytIdx := t.idx * (4 + 8 + 8)
	dat := t.data[bytIdx : bytIdx+20]

	db := &decbuf{b: dat}
	ref := db.be32()
	mint := db.be64int64()
	maxt := db.be64int64()

	// TODO(gouthamve): Handle errors.
	return rip{ref: ref, mint: mint, maxt: maxt}
}

func (t *tombstoneReader) Seek(ref uint32) bool {
	if s := t.At(); s.ref >= ref {
		return true
	}

	i := sort.Search(t.len-t.idx, func(i int) bool {
		bytIdx := (t.idx + i) * 20
		dat := t.data[bytIdx : bytIdx+20]

		db := &decbuf{b: dat}
		ref2 := db.be32()
		if ref >= ref2 {
			return true
		}
	})

	t.idx += idx
	return t.idx < t.len
}

func (t *tombstoneReader) Err() error {
	return nil
}

func chunkDir(dir string) string { return filepath.Join(dir, "chunks") }
func walDir(dir string) string   { return filepath.Join(dir, "wal") }

type mmapFile struct {
	f *os.File
	b []byte
}

func openMmapFile(path string) (*mmapFile, error) {
	f, err := os.Open(path)
	if err != nil {
		return nil, errors.Wrap(err, "try lock file")
	}
	info, err := f.Stat()
	if err != nil {
		return nil, errors.Wrap(err, "stat")
	}

	b, err := mmap(f, int(info.Size()))
	if err != nil {
		return nil, errors.Wrap(err, "mmap")
	}

	return &mmapFile{f: f, b: b}, nil
}

func (f *mmapFile) Close() error {
	err0 := munmap(f.b)
	err1 := f.f.Close()

	if err0 != nil {
		return err0
	}
	return err1
}