#include <RockRebuild.h>

Inheritance diagram for Rock::Rebuild:
Collaboration diagram for Rock::Rebuild:

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 Rebuild (SwapDir *dir)
 
virtual ~Rebuild () override
 
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
 
void callStart (AsyncCall &call)
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Protected Member Functions

virtual void start () override
 prepares and initiates entry loading sequence More...
 
virtual bool doneAll () const override
 whether positive goal has been reached More...
 
virtual void swanSong () override
 
bool doneLoading () const
 
bool doneValidating () const
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 

Protected Attributes

const char * stopReason
 reason for forcing done() to be true More...
 
const char * typeName
 kid (leaf) class name, for debugging More...
 
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
 
const InstanceId< AsyncJobid
 job identifier More...
 

Private Member Functions

 CBDATA_CHILD (Rebuild)
 
void checkpoint ()
 continues after a pause if not done More...
 
void steps ()
 
void loadingSteps ()
 
void validationSteps ()
 
void loadOneSlot ()
 
void validateOneEntry (const sfileno fileNo)
 
void validateOneSlot (const SlotId slotId)
 
bool importEntry (Ipc::StoreMapAnchor &anchor, const sfileno slotId, const DbCellHeader &header)
 parse StoreEntry basics and add them to the map, returning true on success More...
 
void freeBadEntry (const sfileno fileno, const char *eDescription)
 
void failure (const char *msg, int errNo=0)
 
LoadingEntry loadingEntry (const sfileno fileNo)
 
void startNewEntry (const sfileno fileno, const SlotId slotId, const DbCellHeader &header)
 handle a slot from an entry that we have not seen before More...
 
void primeNewEntry (Ipc::StoreMapAnchor &anchor, const sfileno fileno, const DbCellHeader &header)
 initialize housekeeping information for a newly accepted entry More...
 
void finalizeOrFree (const sfileno fileNo, LoadingEntry &le)
 
void finalizeOrThrow (const sfileno fileNo, LoadingEntry &le)
 
void addSlotToEntry (const sfileno fileno, const SlotId slotId, const DbCellHeader &header)
 
void useNewSlot (const SlotId slotId, const DbCellHeader &header)
 handle freshly loaded (and validated) db slot header More...
 
LoadingSlot loadingSlot (const SlotId slotId)
 
void mapSlot (const SlotId slotId, const DbCellHeader &header)
 adds slot to the entry chain in the map More...
 
void freeUnusedSlot (const SlotId slotId, const bool invalid)
 freeSlot() for never-been-mapped slots More...
 
void freeSlot (const SlotId slotId, const bool invalid)
 adds slot to the free slot index More...
 
template<class SlotIdType >
void chainSlots (SlotIdType &from, const SlotId to)
 
bool sameEntry (const sfileno fileno, const DbCellHeader &header) const
 does the header belong to the fileno entry being loaded? More...
 

Static Private Member Functions

static void Steps (void *data)
 

Private Attributes

SwapDirsd
 
LoadingPartsparts
 parts of store entries being loaded from disk More...
 
int64_t dbSize
 
int dbSlotSize
 the size of a db cell, including the cell header More...
 
int dbSlotLimit
 total number of db cells More...
 
int dbEntryLimit
 maximum number of entries that can be stored in db More...
 
int fd
 
int64_t dbOffset
 
sfileno loadingPos
 index of the db slot being loaded from disk now More...
 
sfileno validationPos
 index of the loaded db slot being validated now More...
 
MemBuf buf
 space to load current db slot (and entry metadata) into More...
 
StoreRebuildData counts
 

Detailed Description

manages store rebuild process: loading meta information from db on disk

Definition at line 27 of file RockRebuild.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Rebuild()

◆ ~Rebuild()

Rock::Rebuild::~Rebuild ( )
overridevirtual

Definition at line 223 of file RockRebuild.cc.

References file_close().

Member Function Documentation

◆ addSlotToEntry()

void Rock::Rebuild::addSlotToEntry ( const sfileno  fileno,
const SlotId  slotId,
const DbCellHeader header 
)
private

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)
inherited

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

◆ CBDATA_CHILD()

Rock::Rebuild::CBDATA_CHILD ( Rebuild  )
private

◆ chainSlots()

template<class SlotIdType >
void Rock::Rebuild::chainSlots ( SlotIdType &  from,
const SlotId  to 
)
private

Definition at line 628 of file RockRebuild.cc.

References assert, and Rock::LoadingSlot::more.

◆ checkpoint()

void Rock::Rebuild::checkpoint ( )
private

Definition at line 266 of file RockRebuild.cc.

References eventAdd(), and Steps().

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

◆ doneAll()

bool Rock::Rebuild::doneAll ( ) const
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 287 of file RockRebuild.cc.

References AsyncJob::doneAll().

◆ doneLoading()

bool Rock::Rebuild::doneLoading ( ) const
protected

Definition at line 273 of file RockRebuild.cc.

◆ doneValidating()

bool Rock::Rebuild::doneValidating ( ) const
protected

Definition at line 279 of file RockRebuild.cc.

References opt_store_doublecheck.

◆ failure()

void Rock::Rebuild::failure ( const char *  msg,
int  errNo = 0 
)
private

Definition at line 567 of file RockRebuild.cc.

References assert, DBG_CRITICAL, debugs, fatalf(), and xstrerr().

◆ finalizeOrFree()

void Rock::Rebuild::finalizeOrFree ( const sfileno  fileNo,
LoadingEntry le 
)
private

Either make the entry accessible to all or free it. This method must only be called when no more entry slots are expected.

Definition at line 500 of file RockRebuild.cc.

◆ finalizeOrThrow()

◆ freeBadEntry()

void Rock::Rebuild::freeBadEntry ( const sfileno  fileno,
const char *  eDescription 
)
private

Marks remaining bad entry slots as free and unlocks the entry. The map cannot do this because Loading entries may have holes in the slots chain.

Definition at line 538 of file RockRebuild.cc.

References assert, debugs, Rock::LoadingEntry::leCorrupted, Rock::LoadingEntry::size, Ipc::StoreMapAnchor::start, and Rock::LoadingEntry::state().

◆ freeSlot()

void Rock::Rebuild::freeSlot ( const SlotId  slotId,
const bool  invalid 
)
private

◆ freeUnusedSlot()

void Rock::Rebuild::freeUnusedSlot ( const SlotId  slotId,
const bool  invalid 
)
private

Definition at line 603 of file RockRebuild.cc.

References assert, and Rock::LoadingSlot::mapped().

◆ importEntry()

◆ loadingEntry()

Rock::LoadingEntry Rock::Rebuild::loadingEntry ( const sfileno  fileNo)
private

Definition at line 346 of file RockRebuild.cc.

References Must.

◆ loadingSlot()

Rock::LoadingSlot Rock::Rebuild::loadingSlot ( const SlotId  slotId)
private

Definition at line 353 of file RockRebuild.cc.

References Must.

◆ loadingSteps()

void Rock::Rebuild::loadingSteps ( )
private

◆ loadOneSlot()

void Rock::Rebuild::loadOneSlot ( )
private

◆ mapSlot()

void Rock::Rebuild::mapSlot ( const SlotId  slotId,
const DbCellHeader header 
)
private

◆ mustStop()

◆ primeNewEntry()

◆ sameEntry()

bool Rock::Rebuild::sameEntry ( const sfileno  fileno,
const DbCellHeader header 
) const
private

Definition at line 735 of file RockRebuild.cc.

References Rock::DbCellHeader::key, and Ipc::StoreMapAnchor::sameKey().

◆ start()

void Rock::Rebuild::start ( )
overrideprotectedvirtual

◆ Start()

◆ startNewEntry()

void Rock::Rebuild::startNewEntry ( const sfileno  fileno,
const SlotId  slotId,
const DbCellHeader header 
)
private

◆ status()

const char * AsyncJob::status ( ) const
protectedvirtualinherited

◆ steps()

void Rock::Rebuild::steps ( )
private

Definition at line 300 of file RockRebuild.cc.

◆ Steps()

void Rock::Rebuild::Steps ( void *  data)
staticprivate

Definition at line 293 of file RockRebuild.cc.

References CallJobHere, and data.

Referenced by checkpoint().

◆ swanSong()

void Rock::Rebuild::swanSong ( )
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 558 of file RockRebuild.cc.

References counts, debugs, HERE(), Store::Controller::store_dirs_rebuilding, and storeRebuildComplete().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

◆ useNewSlot()

◆ validateOneEntry()

◆ validateOneSlot()

void Rock::Rebuild::validateOneSlot ( const SlotId  slotId)
private

◆ validationSteps()

void Rock::Rebuild::validationSteps ( )
private

Definition at line 430 of file RockRebuild.cc.

References current_time, debugs, getCurrentTime(), opt_foreground_rebuild, and tvSubMsec().

Member Data Documentation

◆ buf

MemBuf Rock::Rebuild::buf
private

Definition at line 87 of file RockRebuild.h.

◆ counts

StoreRebuildData Rock::Rebuild::counts
private

Definition at line 89 of file RockRebuild.h.

◆ dbEntryLimit

int Rock::Rebuild::dbEntryLimit
private

Definition at line 81 of file RockRebuild.h.

Referenced by Rebuild().

◆ dbOffset

int64_t Rock::Rebuild::dbOffset
private

Definition at line 84 of file RockRebuild.h.

◆ dbSize

int64_t Rock::Rebuild::dbSize
private

Definition at line 78 of file RockRebuild.h.

Referenced by Rebuild().

◆ dbSlotLimit

int Rock::Rebuild::dbSlotLimit
private

Definition at line 80 of file RockRebuild.h.

Referenced by Rebuild().

◆ dbSlotSize

int Rock::Rebuild::dbSlotSize
private

Definition at line 79 of file RockRebuild.h.

Referenced by Rebuild().

◆ fd

int Rock::Rebuild::fd
private

Definition at line 83 of file RockRebuild.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

◆ loadingPos

sfileno Rock::Rebuild::loadingPos
private

Definition at line 85 of file RockRebuild.h.

◆ parts

LoadingParts* Rock::Rebuild::parts
private

Definition at line 76 of file RockRebuild.h.

◆ sd

SwapDir* Rock::Rebuild::sd
private

Definition at line 75 of file RockRebuild.h.

Referenced by Rebuild().

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

◆ typeName

◆ validationPos

sfileno Rock::Rebuild::validationPos
private

Definition at line 86 of file RockRebuild.h.


The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors