#include <RockHeaderUpdater.h>

Inheritance diagram for Rock::HeaderUpdater:

Collaboration diagram for Rock::HeaderUpdater:

Classes
class	IoCbParams

Public Types
typedef CbcPointer< AsyncJob >	Pointer

Public Member Functions
	HeaderUpdater (const Rock::SwapDir::Pointer &aStore, const Ipc::StoreMapUpdate &update)

	~HeaderUpdater () override=default

bool	canBeCalled (AsyncCall &call) const
	whether we can be called

void	callStart (AsyncCall &call)

virtual void	callEnd ()
	called right after the called job method

virtual void	callException (const std::exception &e)
	called when the job throws during an async call

void	handleStopRequest ()
	process external request to terminate now (i.e. during this async call)

virtual void *	toCbdata ()=0

Static Public Member Functions
static void	Start (const Pointer &job)

static void	RegisterWithCacheManager ()

Public Attributes
const InstanceId< AsyncJob >	id
	job identifier

Protected Member Functions
void	start () override
	called by AsyncStart; do not call directly

bool	doneAll () const override
	whether positive goal has been reached

void	swanSong () override

void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

bool	done () const
	the job is destroyed in callEnd() when done()

virtual const char *	status () const
	internal cleanup; do not call directly

Static Protected Member Functions
static void	ReportAllJobs (StoreEntry *)
	writes a cache manager report about all jobs existing in this worker

Protected Attributes
const char *	stopReason
	reason for forcing done() to be true

const char *	typeName
	kid (leaf) class name, for debugging

AsyncCall::Pointer	inCall
	the asynchronous call being handled, if any

bool	started_ = false
	Start() has finished successfully.

bool	swanSang_ = false
	swanSong() was called

Private Member Functions
	CBDATA_CHILD (HeaderUpdater)

void	startReading ()

void	stopReading (const char *why)

void	readMore (const char *why)

void	noteRead (const IoCbParams result)

void	noteDoneReading (int errflag)

void	parseReadBytes ()

void	startWriting ()

void	noteDoneWriting (int errflag)

virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE()

Private Attributes
Rock::SwapDir::Pointer	store
	cache_dir where the entry is stored

Ipc::StoreMapUpdate	update
	Ipc::StoreMap update reservation.

StoreIOState::Pointer	reader
	reads old headers and old data

StoreIOState::Pointer	writer
	writes new headers and old data

SBuf	readerBuffer
	I/O buffer for a single read operation.

SBuf	exchangeBuffer
	bytes read but not yet discarded or written

uint64_t	bytesRead
	total entry bytes read from Store so far

size_t	staleSwapHeaderSize
	stored size of the stale entry metadata

SlotId	staleSplicingPointNext
	non-updatable old HTTP body suffix start

Static Private Attributes
static StoreIOState::STRCB	NoteRead

static StoreIOState::STIOCB	NoteDoneReading

static StoreIOState::STIOCB	NoteDoneWriting

Detailed Description

Updates HTTP headers of a single Rock store entry:

reads old body data in the same slot as the last old headers slot, if any
writes new headers (1+ slots)
writes old data (0-2 slots)
chains the new entry prefix (1+ slots) to the old entry suffix (0+ slots)

Definition at line 26 of file RockHeaderUpdater.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ HeaderUpdater()

Rock::HeaderUpdater::HeaderUpdater	(	const Rock::SwapDir::Pointer &	aStore,
		const Ipc::StoreMapUpdate &	update
	)

Definition at line 20 of file RockHeaderUpdater.cc.

◆ ~HeaderUpdater()

Rock::HeaderUpdater::~HeaderUpdater ( )

overridedefault

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 152 of file AsyncJob.cc.

References assert, AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), AsyncJob::inCall, AsyncJob::started_, AsyncJob::status(), AsyncJob::swanSang_, AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), and AsyncJob::deleteThis().

◆ callException()

void AsyncJob::callException ( const std::exception & e )

virtualinherited

Reimplemented in ConnStateData, ClientHttpRequest, Rock::Rebuild, Adaptation::Icap::ModXact, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Ipc::Forwarder, Ipc::Inquirer, and Ftp::Server.

Definition at line 143 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by ConnStateData::callException(), Adaptation::Icap::Xaction::callException(), Ipc::Forwarder::callException(), Ipc::Inquirer::callException(), and Ftp::Server::callException().

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

inherited

called just before the called method

Definition at line 130 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall & call ) const

inherited

Definition at line 117 of file AsyncJob.cc.

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

◆ CBDATA_CHILD()

Rock::HeaderUpdater::CBDATA_CHILD ( HeaderUpdater )

private

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 65 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::deleteThis(), AsyncJob::inCall, JobMemFun(), Must, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by ConnStateData::connStateClosed(), and AsyncJob::deleteThis().

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 106 of file AsyncJob.cc.

References AsyncJob::doneAll(), and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), HappyConnOpener::checkForNewConnection(), Downloader::downloadFinished(), and HappyConnOpener::maybeOpenPrimeConnection().

◆ doneAll()

bool Rock::HeaderUpdater::doneAll ( ) const

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 34 of file RockHeaderUpdater.cc.

References AsyncJob::doneAll().

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 73 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protectedinherited

Definition at line 85 of file AsyncJob.cc.

References debugs, AsyncJob::inCall, Must, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::drop1xx(), AsyncJob::handleStopRequest(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), HttpStateData::proceedAfter1xx(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

◆ noteDoneReading()

void Rock::HeaderUpdater::noteDoneReading ( int errflag )

private

Definition at line 152 of file RockHeaderUpdater.cc.

References debugs, and Must.

◆ noteDoneWriting()

void Rock::HeaderUpdater::noteDoneWriting ( int errflag )

private

Definition at line 250 of file RockHeaderUpdater.cc.

References debugs, Must, Rock::IoState::splicingPoint, and Rock::IoState::writeableAnchor_.

◆ noteRead()

void Rock::HeaderUpdater::noteRead ( const IoCbParams result )

private

Definition at line 110 of file RockHeaderUpdater.cc.

References Rock::HeaderUpdater::IoCbParams::buf, debugs, Must, and Rock::HeaderUpdater::IoCbParams::size.

◆ parseReadBytes()

void Rock::HeaderUpdater::parseReadBytes ( )

private

Definition at line 268 of file RockHeaderUpdater.cc.

References debugs, headersEnd(), Must, and Store::UnpackSwapMetaSize().

◆ readMore()

void Rock::HeaderUpdater::readMore ( const char * why )

private

Definition at line 127 of file RockHeaderUpdater.cc.

References debugs, Must, and storeRead().

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

staticinherited

Definition at line 215 of file AsyncJob.cc.

References Mgr::RegisterAction(), and AsyncJob::ReportAllJobs().

Referenced by mainInitialize().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry * e )

staticprotectedinherited

Definition at line 198 of file AsyncJob.cc.

References AllJobs().

Referenced by AsyncJob::RegisterWithCacheManager().

◆ start()

void Rock::HeaderUpdater::start ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 63 of file RockHeaderUpdater.cc.

References Must.

◆ Start()

void AsyncJob::Start ( const Pointer & job )

staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 37 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by Ftp::Server::AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Log::TcpLogger::Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), and Rock::SwapDir::updateHeaders().

◆ startReading()

void Rock::HeaderUpdater::startReading ( )

private

Definition at line 72 of file RockHeaderUpdater.cc.

◆ startWriting()

void Rock::HeaderUpdater::startWriting ( )

private

Definition at line 166 of file RockHeaderUpdater.cc.

References debugs, Must, Rock::IoState::staleSplicingPointNext, StoreIOState::wroteAll, and xfree.

◆ status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Ecap::XactionRep, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Adaptation::Initiate, Http::Tunneler, Comm::TcpAcceptor, HappyConnOpener, Ipc::Inquirer, and Security::PeerConnector.

Definition at line 182 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), MemBuf::content(), MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), Adaptation::Initiate::status(), and Comm::TcpAcceptor::status().

◆ stopReading()

void Rock::HeaderUpdater::stopReading ( const char * why )

private

Definition at line 82 of file RockHeaderUpdater.cc.

References debugs, Must, StoreIOState::readerDone, Rock::IoState::splicingPoint, and Rock::IoState::staleSplicingPointNext.

◆ swanSong()

void Rock::HeaderUpdater::swanSong ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 40 of file RockHeaderUpdater.cc.

References StoreIOState::readerDone, AsyncJob::swanSong(), Rock::IoState::writeableAnchor_, and StoreIOState::writerGone.

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )

pure virtualinherited

Referenced by AsyncJob::callException(), and AsyncJob::callStart().

Member Data Documentation

◆ bytesRead

uint64_t Rock::HeaderUpdater::bytesRead

private

Definition at line 69 of file RockHeaderUpdater.h.

◆ exchangeBuffer

SBuf Rock::HeaderUpdater::exchangeBuffer

private

Definition at line 68 of file RockHeaderUpdater.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id

inherited

Definition at line 75 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 86 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ NoteDoneReading

void Rock::HeaderUpdater::NoteDoneReading

staticprivate

Definition at line 48 of file RockHeaderUpdater.h.

◆ NoteDoneWriting

void Rock::HeaderUpdater::NoteDoneWriting

staticprivate

Definition at line 49 of file RockHeaderUpdater.h.

◆ NoteRead

void Rock::HeaderUpdater::NoteRead

staticprivate

Definition at line 47 of file RockHeaderUpdater.h.

◆ reader

StoreIOState::Pointer Rock::HeaderUpdater::reader

private

Definition at line 64 of file RockHeaderUpdater.h.

◆ readerBuffer

SBuf Rock::HeaderUpdater::readerBuffer

private

Definition at line 67 of file RockHeaderUpdater.h.

◆ staleSplicingPointNext

SlotId Rock::HeaderUpdater::staleSplicingPointNext

private

Definition at line 73 of file RockHeaderUpdater.h.

◆ staleSwapHeaderSize

size_t Rock::HeaderUpdater::staleSwapHeaderSize

private

Definition at line 71 of file RockHeaderUpdater.h.

◆ started_

bool AsyncJob::started_ = false

protectedinherited

Definition at line 88 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason

protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().

◆ store

Rock::SwapDir::Pointer Rock::HeaderUpdater::store

private

Definition at line 61 of file RockHeaderUpdater.h.

◆ swanSang_

bool AsyncJob::swanSang_ = false

protectedinherited

Definition at line 89 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ typeName

const char* AsyncJob::typeName

protectedinherited

Definition at line 85 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), Adaptation::Icap::Xaction::Xaction(), AsyncJob::~AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ update

Ipc::StoreMapUpdate Rock::HeaderUpdater::update

private

Definition at line 62 of file RockHeaderUpdater.h.

◆ writer

StoreIOState::Pointer Rock::HeaderUpdater::writer

private

Definition at line 65 of file RockHeaderUpdater.h.

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

squid/src/fs/rock/RockHeaderUpdater.h
squid/src/fs/rock/RockHeaderUpdater.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

Constructor & Destructor Documentation

◆ HeaderUpdater()

◆ ~HeaderUpdater()

Member Function Documentation

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ CBDATA_CHILD()

◆ deleteThis()

◆ done()

◆ doneAll()

◆ finalizedInCbdataChild()

◆ handleStopRequest()

◆ mustStop()

◆ noteDoneReading()

◆ noteDoneWriting()

◆ noteRead()

◆ parseReadBytes()

◆ readMore()

◆ RegisterWithCacheManager()

◆ ReportAllJobs()

◆ start()

◆ Start()

◆ startReading()

◆ startWriting()

◆ status()

◆ stopReading()

◆ swanSong()

◆ toCbdata()

Member Data Documentation

◆ bytesRead

◆ exchangeBuffer

◆ id

◆ inCall

◆ NoteDoneReading

◆ NoteDoneWriting

◆ NoteRead

◆ reader

◆ readerBuffer

◆ staleSplicingPointNext

◆ staleSwapHeaderSize

◆ started_

◆ stopReason

◆ store

◆ swanSang_

◆ typeName

◆ update

◆ writer