db

Documentation

Overview

Package db implements a simple key-value database. The database is cached in memory and mirrored on disk. It is used to store corpus in syz-manager and syz-hub. The database strives to minimize number of disk accesses as they can be slow in virtualized environments (GCE).

Index

• func Create(filename string, version uint64, records []Record) error
• func ReadCorpus(filename string, target *prog.Target) (progs []*prog.Prog, err error)
• type DB
  • func Open(filename string, repair bool) (*DB, error)
  • func (db *DB) BumpVersion(version uint64) error
  • func (db *DB) Delete(key string)
  • func (db *DB) DiscardData()
  • func (db *DB) Flush() error
  • func (db *DB) Save(key string, val []byte, seq uint64)
• type Record

Functions

func Create

func Create(filename string, version uint64, records []Record) error

Create creates a new database in the specified file with the specified records.

func ReadCorpus

func ReadCorpus(filename string, target *prog.Target) (progs []*prog.Prog, err error)

Types

type DB

type DB struct {
	Version uint64            // arbitrary user version (0 for new database)
	Records map[string]Record // in-memory cache, must not be modified directly
	// contains filtered or unexported fields
}

func Open

func Open(filename string, repair bool) (*DB, error)

Open opens the specified database file. If the database is corrupted and reading failed, then it returns an non-nil db with whatever records were recovered and a non-nil error at the same time.

func (*DB) BumpVersion

func (db *DB) BumpVersion(version uint64) error

func (*DB) Delete

func (db *DB) Delete(key string)

func (*DB) DiscardData

func (db *DB) DiscardData()

DiscardData discards all record's values from memory. This allows to save memory if values are not needed anymore, but in exchange every compaction will need to re-read all data from disk.

func (*DB) Flush

func (db *DB) Flush() error

func (*DB) Save

func (db *DB) Save(key string, val []byte, seq uint64)

type Record

type Record struct {
	Val []byte
	Seq uint64
}