#include <RockRebuild.h>

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

Classes

class  Stats
 cache_dir indexing statistics shared across same-kid process restarts More...
 

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

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 bool Start (SwapDir &dir)
 
static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Protected Member Functions

 Rebuild (SwapDir *dir, const Ipc::Mem::Pointer< Stats > &)
 
virtual ~Rebuild () override
 
virtual void startShutdown () override
 
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...
 

Static Protected Member Functions

static bool IsResponsible (const SwapDir &)
 whether the current kid is responsible for rebuilding this db file 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 Types

typedef void(RegisteredRunner::* Method) ()
 a pointer to one of the above notification methods 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...
 
SBuf progressDescription () const
 
void registerRunner ()
 
void unregisterRunner ()
 unregisters self; safe to call multiple times More...
 
virtual void finalizeConfig ()
 
virtual void claimMemoryNeeds ()
 
virtual void useConfig ()
 
virtual void startReconfigure ()
 
virtual void syncConfig ()
 
virtual void endingShutdown ()
 
virtual void finishShutdown ()
 Meant for cleanup of services needed by the already destroyed objects. More...
 

Static Private Member Functions

static void Steps (void *data)
 

Private Attributes

SwapDirsd
 
LoadingPartsparts
 parts of store entries being loaded from disk More...
 
Ipc::Mem::Pointer< Statsstats
 indexing statistics in shared memory More...
 
int64_t dbSize
 
int dbSlotSize
 the size of a db cell, including the cell header More...
 
int64_t dbSlotLimit
 total number of db cells More...
 
int64_t dbEntryLimit
 maximum number of entries that can be stored in db More...
 
int fd
 
int64_t dbOffset
 
int64_t loadingPos
 index of the db slot being loaded from disk now More...
 
int64_t validationPos
 index of the loaded db slot being validated now More...
 
MemBuf buf
 space to load current db slot (and entry metadata) into More...
 
StoreRebuildDatacounts
 a reference to the shared memory counters More...
 
const bool resuming
 

Detailed Description

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

Definition at line 30 of file RockRebuild.h.

Member Typedef Documentation

◆ Method

typedef void(RegisteredRunner::* RegisteredRunner::Method) ()
inherited

Definition at line 90 of file RunnersRegistry.h.

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Rebuild()

◆ ~Rebuild()

Rock::Rebuild::~Rebuild ( )
overrideprotectedvirtual

Definition at line 320 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 737 of file RockRebuild.cc.

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

◆ checkpoint()

void Rock::Rebuild::checkpoint ( )
private

Definition at line 373 of file RockRebuild.cc.

References eventAdd(), and Steps().

◆ claimMemoryNeeds()

virtual void RegisteredRunner::claimMemoryNeeds ( )
inlinevirtualinherited

Called after finalizeConfig(). Meant for announcing memory reservations before memory is allocated.

Reimplemented in IpcIoRr, and MemStoreRr.

Definition at line 51 of file RunnersRegistry.h.

Referenced by RunConfigUsers().

◆ 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 392 of file RockRebuild.cc.

References AsyncJob::doneAll().

◆ doneLoading()

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

Definition at line 380 of file RockRebuild.cc.

References Rock::DoneLoading().

◆ doneValidating()

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

Definition at line 386 of file RockRebuild.cc.

References Rock::DoneValidating().

◆ endingShutdown()

virtual void RegisteredRunner::endingShutdown ( )
inlinevirtualinherited

Called after shutdown_lifetime grace period ends and before stopping the main loop. At least one main loop iteration is guaranteed after this call. Meant for cleanup and state saving that may require other modules.

Reimplemented in Dns::ConfigRr, Auth::CredentialCacheRr, ConnStateData, and IdleConnList.

Definition at line 80 of file RunnersRegistry.h.

Referenced by SignalEngine::FinalShutdownRunners().

◆ failure()

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

Definition at line 676 of file RockRebuild.cc.

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

◆ finalizeConfig()

virtual void RegisteredRunner::finalizeConfig ( )
inlinevirtualinherited

Called after parsing squid.conf. Meant for setting configuration options that depend on other configuration options and were not explicitly configured.

Reimplemented in sslBumpCfgRr, and MemStoreRr.

Definition at line 47 of file RunnersRegistry.h.

Referenced by SquidMain().

◆ 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 610 of file RockRebuild.cc.

◆ finalizeOrThrow()

◆ finishShutdown()

virtual void RegisteredRunner::finishShutdown ( )
inlinevirtualinherited

Definition at line 87 of file RunnersRegistry.h.

Referenced by RunRegistered(), SquidShutdown(), testRock::tearDown(), and watch_child().

◆ 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 648 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 712 of file RockRebuild.cc.

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

◆ importEntry()

◆ IsResponsible()

bool Rock::Rebuild::IsResponsible ( const SwapDir sd)
staticprotected

Definition at line 270 of file RockRebuild.cc.

References IamDiskProcess(), and UsingSmp().

◆ loadingEntry()

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

Definition at line 451 of file RockRebuild.cc.

References Must.

◆ loadingSlot()

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

Definition at line 458 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()

◆ progressDescription()

SBuf Rock::Rebuild::progressDescription ( ) const
private

Definition at line 910 of file RockRebuild.cc.

References SBufStream::buf(), Debug::Extra(), and opt_store_doublecheck.

◆ registerRunner()

void IndependentRunner::registerRunner ( )
protectedinherited

◆ sameEntry()

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

Definition at line 844 of file RockRebuild.cc.

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

◆ start()

void Rock::Rebuild::start ( )
overrideprotectedvirtual

◆ Start() [1/2]

◆ Start() [2/2]

bool Rock::Rebuild::Start ( SwapDir dir)
static

starts indexing the given cache_dir if that indexing is necessary

Returns
whether the indexing was necessary (and, hence, started)

Definition at line 277 of file RockRebuild.cc.

References debugs, Rock::SwapDir::filePath, Store::Disk::index, Must, Store::Disk::path, shm_old, AsyncJob::Start(), and Ping::stats.

Referenced by Rock::SwapDir::ioCompletedNotification().

◆ startNewEntry()

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

◆ startReconfigure()

virtual void RegisteredRunner::startReconfigure ( )
inlinevirtualinherited

Called after receiving a reconfigure request and before parsing squid.conf. Meant for modules that need to prepare for their configuration being changed [outside their control]. The changes end with the syncConfig() event.

Reimplemented in Dns::ConfigRr.

Definition at line 63 of file RunnersRegistry.h.

Referenced by mainReconfigureStart().

◆ startShutdown()

void Rock::Rebuild::startShutdown ( )
overrideprotectedvirtual

Called after receiving a shutdown request and before stopping the main loop. At least one main loop iteration is guaranteed after this call. Meant for cleanup and state saving that may require other modules.

Reimplemented from RegisteredRunner.

Definition at line 330 of file RockRebuild.cc.

◆ status()

const char * AsyncJob::status ( ) const
protectedvirtualinherited

◆ steps()

void Rock::Rebuild::steps ( )
private

Definition at line 405 of file RockRebuild.cc.

◆ Steps()

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

Definition at line 398 of file RockRebuild.cc.

References CallJobHere, and data.

Referenced by checkpoint().

◆ swanSong()

void Rock::Rebuild::swanSong ( )
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 668 of file RockRebuild.cc.

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

◆ syncConfig()

virtual void RegisteredRunner::syncConfig ( )
inlinevirtualinherited

Called after parsing squid.conf during reconfiguration. Meant for adjusting the module state based on configuration changes.

Reimplemented in Auth::CredentialCacheRr, and PeerPoolMgrsRr.

Definition at line 67 of file RunnersRegistry.h.

Referenced by mainReconfigureFinish().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

◆ unregisterRunner()

void IndependentRunner::unregisterRunner ( )
protectedinherited

Definition at line 96 of file RunnersRegistry.cc.

References FindRunners().

Referenced by IndependentRunner::~IndependentRunner().

◆ useConfig()

virtual void RegisteredRunner::useConfig ( )
inlinevirtualinherited

Called after claimMemoryNeeds(). Meant for activating modules and features using a finalized configuration with known memory requirements.

Reimplemented in MemStoreRr, TransientsRr, SharedSessionCacheRr, PeerPoolMgrsRr, ClientDbRr, SharedMemPagesRr, and Ipc::Mem::RegisteredRunner.

Definition at line 56 of file RunnersRegistry.h.

Referenced by RunConfigUsers().

◆ useNewSlot()

◆ validateOneEntry()

◆ validateOneSlot()

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

◆ validationSteps()

void Rock::Rebuild::validationSteps ( )
private

Member Data Documentation

◆ buf

MemBuf Rock::Rebuild::buf
private

Definition at line 120 of file RockRebuild.h.

◆ counts

StoreRebuildData& Rock::Rebuild::counts
private

Definition at line 122 of file RockRebuild.h.

◆ dbEntryLimit

int64_t Rock::Rebuild::dbEntryLimit
private

Definition at line 114 of file RockRebuild.h.

Referenced by Rebuild().

◆ dbOffset

int64_t Rock::Rebuild::dbOffset
private

Definition at line 117 of file RockRebuild.h.

◆ dbSize

int64_t Rock::Rebuild::dbSize
private

Definition at line 111 of file RockRebuild.h.

Referenced by Rebuild().

◆ dbSlotLimit

int64_t Rock::Rebuild::dbSlotLimit
private

Definition at line 113 of file RockRebuild.h.

Referenced by Rebuild().

◆ dbSlotSize

int Rock::Rebuild::dbSlotSize
private

Definition at line 112 of file RockRebuild.h.

Referenced by Rebuild().

◆ fd

int Rock::Rebuild::fd
private

Definition at line 116 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

int64_t Rock::Rebuild::loadingPos
private

Definition at line 118 of file RockRebuild.h.

◆ parts

LoadingParts* Rock::Rebuild::parts
private

Definition at line 107 of file RockRebuild.h.

◆ resuming

const bool Rock::Rebuild::resuming
private

whether we have started indexing this cache_dir before, presumably in the previous process performing the same-kid role

Definition at line 126 of file RockRebuild.h.

◆ sd

SwapDir* Rock::Rebuild::sd
private

Definition at line 106 of file RockRebuild.h.

Referenced by Rebuild().

◆ stats

Ipc::Mem::Pointer<Stats> Rock::Rebuild::stats
private

Definition at line 109 of file RockRebuild.h.

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

◆ typeName

◆ validationPos

int64_t Rock::Rebuild::validationPos
private

Definition at line 119 of file RockRebuild.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors