common

Documentation

Index

• Constants
• Variables
• func RuntimeStack() error
• func SH_Assert(condition bool, msg string)
• func ShPrintf(logLevel LogLevel, fmtStl string, a ...interface{})
• type LogLevel
• type ReaderWriterLatch
  • func NewRWLatch() ReaderWriterLatch
  • func NewRWLatchDebug() ReaderWriterLatch
  • func NewRWLatchDummy() ReaderWriterLatch
  • func NewRWLatchTrace() ReaderWriterLatch
• type SH_Mutex
  • func NewSH_Mutex() *SH_Mutex
  • func (m *SH_Mutex) Lock()
  • func (m *SH_Mutex) Unlock()
• type SlotOffset
• type TxnID

Constants

const (
	// invalid page id
	InvalidPageID = -1
	// invalid transaction id
	InvalidTxnID = -1
	// invalid log sequence number
	InvalidLSN = -1
	// the header page id
	HeaderPageID = 0
	// size of a data page in byte
	PageSize                     = 4096 //1024  //512
	BufferPoolMaxFrameNumForTest = 500  //4000 //32
	// number for calculate log buffer size (number of page size)
	LogBufferSizeBase = 32
	// size of a log buffer in byte
	LogBufferSize = ((LogBufferSizeBase + 1) * PageSize)
	// size of hash bucket
	BucketSizeOfHashIndex = 10
	// probability used for determin node level on SkipList
	SkipListProb         = 0.5                             //0.25
	ActiveLogKindSetting = INFO | NOT_ABORABLE_TXN_FEATURE //| COMMIT_ABORT_HANDLE_INFO | NOT_ABORABLE_TXN_FEATURE | DEBUGGING | RDB_OP_FUNC_CALL // | DEBUG_INFO  //| BUFFER_INTERNAL_STATE //| DEBUGGING | DEBUG_INFO //| PIN_COUNT_ASSERT //DEBUG_INFO_DETAIL  //DEBUGGING
)

const (
	DEBUG_INFO_DETAIL        LogLevel = 1
	DEBUG_INFO                        = 2
	CACHE_OUT_IN_INFO                 = 2 << 1
	RDB_OP_FUNC_CALL                  = 2 << 2 // print several info at core functions (ex: CRUD at TableHeap and SkipList/SkipListBlockPage)
	BUFFER_INTERNAL_STATE             = 2 << 3 // print internal state of buffer of BufferPoolManager
	PIN_COUNT_ASSERT                  = 2 << 4
	COMMIT_ABORT_HANDLE_INFO          = 2 << 5
	NOT_ABORABLE_TXN_FEATURE          = 2 << 6
	DEBUGGING                         = 2 << 7 // print debug info for a debugging period (not permanently used)
	INFO                              = 2 << 8
	WARN                              = 2 << 9
	ERROR                             = 2 << 10
	FATAL                             = 2 << 11
)

const EnableDebug bool = false //true

var EnableLogging bool = false //true

const EnableOnMemStorage = false //true //false

use virtual storage or not

const (
	MaxReaders = math.MaxUint32
)

Variables

var LogTimeout time.Duration

var NewRIDAtNormal = false

TODO: for debugging

var NewRIDAtRollback = false

var TempSuppressOnMemStorage = false

when this is true, virtual storage use is suppressed for test case which can't work with virtual storage

var TempSuppressOnMemStorageMutex sync.Mutex

Functions

func RuntimeStack

func RuntimeStack() error

REFERENCES

• https://pkg.go.dev/runtime#Stack
• https://stackoverflow.com/questions/19094099/how-to-dump-goroutine-stacktraces

func SH_Assert

func SH_Assert(condition bool, msg string)

func ShPrintf

func ShPrintf(logLevel LogLevel, fmtStl string, a ...interface{})

Types

type LogLevel

type LogLevel int32

type ReaderWriterLatch

type ReaderWriterLatch interface {
	WLock()
	WUnlock()
	RLock()
	RUnlock()
	PrintDebugInfo()
}

func NewRWLatch

func NewRWLatch() ReaderWriterLatch

func NewRWLatchDebug

func NewRWLatchDebug() ReaderWriterLatch

func NewRWLatchDummy

func NewRWLatchDummy() ReaderWriterLatch

func NewRWLatchTrace

func NewRWLatchTrace() ReaderWriterLatch

type SH_Mutex

type SH_Mutex struct {
	// contains filtered or unexported fields
}

func NewSH_Mutex

func NewSH_Mutex() *SH_Mutex

func (*SH_Mutex) Lock

func (m *SH_Mutex) Lock()

func (*SH_Mutex) Unlock

func (m *SH_Mutex) Unlock()

type SlotOffset

type SlotOffset uintptr // slot offset type

type TxnID

type TxnID int32 // transaction id type