#include <MemBuf.h>

Inheritance diagram for MemBuf:

Collaboration diagram for MemBuf:

Public Member Functions
	CBDATA_DECL_ (MemBuf, noexcept)

	MemBuf ()

	~MemBuf () override

char *	content ()
	start of the added data

const char *	content () const
	start of the added data

mb_size_t	contentSize () const
	available data size

bool	hasContent () const

char *	space ()
	returns buffer after data; does not check space existence

char *	space (mb_size_t required)

mb_size_t	spaceSize () const

bool	hasSpace () const

mb_size_t	potentialSpaceSize () const

bool	hasPotentialSpace () const

void	consume (mb_size_t sz)
	removes sz bytes and "packs" by moving content left

void	consumeWhitespacePrefix ()
	removes all prefix whitespace, moving content left

void	appended (mb_size_t sz)
	updates content size after external append

void	truncate (mb_size_t sz)

void	terminate ()

bool	wasStolen () const

void	init (mb_size_t szInit, mb_size_t szMax)

void	init ()

void	clean ()

void	reset ()

int	isNull () const

FREE *	freeFunc ()

void	append (const char *c, int sz) override

void	vappendf (const char *fmt, va_list ap) override

void	appendf (const char *fmt,...) PRINTF_FORMAT_ARG2
	Append operation with printf-style arguments.

virtual void	buffer ()

virtual void	flush ()

Public Attributes
char *	buf

mb_size_t	size

mb_size_t	max_capacity

mb_size_t	capacity

unsigned	stolen:1

Private Member Functions
	MemBuf (const MemBuf &)

MemBuf &	operator= (const MemBuf &)

void	grow (mb_size_t min_cap)

Detailed Description

Auto-growing memory-resident buffer with Packable interface

Deprecated:: Use SBuf instead.

Definition at line 23 of file MemBuf.h.

Constructor & Destructor Documentation

◆ MemBuf() [1/2]

MemBuf::MemBuf ( )

inline

Definition at line 28 of file MemBuf.h.

◆ ~MemBuf()

MemBuf::~MemBuf ( )

inlineoverride

Definition at line 35 of file MemBuf.h.

References buf, clean(), and stolen.

◆ MemBuf() [2/2]

MemBuf::MemBuf ( const MemBuf & )

inlineprivate

private copy constructor and assignment operator generates compiler errors if someone tries to copy/assign a MemBuf

Definition at line 120 of file MemBuf.h.

References assert.

Member Function Documentation

◆ append()

void MemBuf::append	(	const char *	newContent,
		int	sz
	)

overridevirtual

calls memcpy, appends exactly size bytes, extends buffer or creates buffer if needed.

Implements Packable.

Definition at line 209 of file MemBuf.cc.

References appended(), assert, buf, capacity, grow(), size, space(), and stolen.

◆ appended()

void MemBuf::appended ( mb_size_t sz )

Definition at line 226 of file MemBuf.cc.

References assert, capacity, size, and terminate().

Referenced by append(), Fs::Ufs::UFSSwapDir::openTmpSwapLog(), storeRebuildLoadEntry(), and storeRebuildLoadEntry().

◆ appendf()

void Packable::appendf	(	const char *	fmt,
			...
	)

inlineinherited

Definition at line 61 of file Packable.h.

References Packable::vappendf().

◆ buffer()

virtual void Packable::buffer ( )

inlinevirtualinherited

start buffering appends (if relevant)

Indicates that a number of small appends are about to follow so would be detrimental to trigger expensive activity on each.

Reimplemented in StoreEntry, and CapturingStoreEntry.

Definition at line 88 of file Packable.h.

◆ CBDATA_DECL_()

MemBuf::CBDATA_DECL_	(	MemBuf	,
		noexcept
	)

◆ clean()

void MemBuf::clean ( )

cleans mb; last function to call if you do not give .buf away

cleans the mb; last function to call if you do not give .buf away with memBufFreeFunc

Definition at line 110 of file MemBuf.cc.

References assert, buf, capacity, isNull(), max_capacity, memFreeBuf(), size, and stolen.

Referenced by BodyPipe::~BodyPipe(), ~MemBuf(), debugObj(), helperDispatchWriteDone(), htcpClear(), htcpQuery(), htcpTstReply(), httpHeaderPutStrvf(), idnsReadVC(), ACLExternal::makeExternalAclKey(), Adaptation::Icap::ModXact::makeRequestHeaders(), ClientHttpRequest::mRangeCLen(), Http::Message::parseCharBuf(), prepareLogWithRequestDetails(), Adaptation::Icap::ModXact::prepEchoing(), HttpHeader::putCc(), HttpHeader::putContRange(), HttpHeader::putRange(), HttpHeader::putSc(), ACLExternal::startLookup(), statObjects(), and Adaptation::Icap::ModXact::writeSomeBody().

◆ consume()

void MemBuf::consume ( mb_size_t sz )

Note: there is currently no stretch() method to grow without appending

Definition at line 168 of file MemBuf.cc.

References assert, buf, contentSize(), size, stolen, and terminate().

Referenced by Client::adaptVirginReplyBody(), BodyPipe::consume(), consumeWhitespacePrefix(), BodyPipe::getMoreData(), Client::handleMoreAdaptedBodyAvailable(), and ClientHttpRequest::noteMoreBodyDataAvailable().

◆ consumeWhitespacePrefix()

void MemBuf::consumeWhitespacePrefix ( )

removes all whitespace prefix bytes and "packs" by moving content left

Definition at line 185 of file MemBuf.cc.

References buf, consume(), contentSize(), and xisspace.

◆ content() [1/2]

char * MemBuf::content ( )

inline

Definition at line 41 of file MemBuf.h.

References buf.

Referenced by Client::adaptVirginReplyBody(), Format::Format::assemble(), ErrorState::compileLegacyCode(), ErrorState::compileLogformatCode(), constructHelperQuery(), Auth::SchemeConfig::CreateAuthUser(), HttpStateData::decodeAndWriteReplyBody(), ErrorState::Dump(), Note::Value::format(), BodyPipe::getMoreData(), HttpStateData::getMoreRequestBody(), helperDispatch(), Auth::UserRequest::helperRequestKeyExtras(), Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), httpHdrAdd(), Adaptation::Ecap::HeaderRep::image(), Adaptation::Icap::OptXact::makeRequest(), Adaptation::Icap::ModXact::makeRequestHeaders(), Fs::Ufs::UFSSwapDir::openTmpSwapLog(), Helper::operator<<(), HttpReply::packHeadersUsingSlowPacker(), Ftp::Gateway::parseListing(), Adaptation::Icap::ModXact::prepEchoing(), redirectHandleReply(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), snmpDebugOid(), Log::Format::SquidNative(), ConnStateData::sslCrtdHandleReply(), Adaptation::Icap::ModXact::startShoveling(), Adaptation::Icap::OptXact::startShoveling(), Adaptation::Ecap::ServiceRep::status(), AsyncJob::status(), BodyPipe::status(), Adaptation::Ecap::XactionRep::status(), Adaptation::Icap::ServiceRep::status(), Adaptation::Icap::Xaction::status(), Http::Tunneler::status(), Comm::TcpAcceptor::status(), Ipc::Inquirer::status(), Security::PeerConnector::status(), TestEvent::testDump(), TestHttpReply::testSanityCheckFirstLine(), TestHttpRequest::testSanityCheckStartLine(), Ftp::UnescapeDoubleQuoted(), Store::UnpackIndexSwapMeta(), Adaptation::Ecap::XactionRep::vbContent(), and ZeroedSlot().

◆ content() [2/2]

const char * MemBuf::content ( ) const

inline

Definition at line 44 of file MemBuf.h.

References buf.

◆ contentSize()

mb_size_t MemBuf::contentSize ( ) const

inline

Definition at line 47 of file MemBuf.h.

References size.

Referenced by Client::adaptVirginReplyBody(), Format::Format::assemble(), BodyPipe::checkIn(), ErrorState::compileLegacyCode(), ErrorState::compileLogformatCode(), consume(), consumeWhitespacePrefix(), HttpStateData::decodeAndWriteReplyBody(), Adaptation::Icap::ModXact::encapsulateHead(), BodyPipe::getMoreData(), HttpStateData::getMoreRequestBody(), Client::handleMoreAdaptedBodyAvailable(), helperDispatch(), htcpTstReply(), idnsDoSendQueryVC(), idnsReadVC(), idnsSendQueryVC(), Adaptation::Ecap::HeaderRep::image(), Adaptation::Icap::OptXact::makeRequest(), Adaptation::Icap::ModXact::makeRequestHeaders(), BodySink::noteMoreBodyDataAvailable(), ClientHttpRequest::noteMoreBodyDataAvailable(), Fs::Ufs::UFSSwapDir::openTmpSwapLog(), HttpReply::packHeadersUsingSlowPacker(), Ftp::Gateway::parseListing(), Adaptation::Icap::ModXact::prepEchoing(), HttpStateData::readReply(), redirectHandleReply(), Http::Stream::sendBody(), Client::sendMoreRequestBody(), Http::Stream::sendStartOfMessage(), ConnStateData::sslCrtdHandleReply(), BodyPipe::status(), TestEvent::testDump(), TestHttpReply::testSanityCheckFirstLine(), TestHttpRequest::testSanityCheckStartLine(), clientReplyContext::traceReply(), truncate(), BodyPipe::undoCheckOut(), Store::UnpackIndexSwapMeta(), Adaptation::Ecap::XactionRep::vbContent(), Adaptation::Ecap::XactionRep::vbContentShift(), Adaptation::Icap::ModXact::virginConsume(), Adaptation::Icap::ModXact::writeSomeBody(), and ZeroedSlot().

◆ flush()

virtual void Packable::flush ( )

inlinevirtualinherited

perform a buffer flush (if relevant)

Used by code such as PackableStream, that assumes the Packable leads to some form of output buffer.

Reimplemented in StoreEntry, and CapturingStoreEntry.

Definition at line 95 of file Packable.h.

◆ freeFunc()

FREE * MemBuf::freeFunc ( )

freezes the object! and returns function to clear it up.

Return values

free() function to be used.

Important: calling this function "freezes" mb, do not update mb after that in any way (you still can read-access .buf and .size)

Return values

free() function to be used.

Definition at line 303 of file MemBuf.cc.

References assert, buf, capacity, memFreeBufFunc(), and stolen.

Referenced by Fs::Ufs::UFSSwapDir::openTmpSwapLog(), and Comm::Write().

◆ grow()

void MemBuf::grow ( mb_size_t min_cap )

private

Grows (doubles) internal buffer to satisfy required minimal capacity

Definition at line 318 of file MemBuf.cc.

References assert, buf, capacity, max_capacity, memReallocBuf(), size_t, and stolen.

Referenced by append(), init(), space(), and vappendf().

◆ hasContent()

bool MemBuf::hasContent ( ) const

inline

Whether the buffer contains any data.

Return values

true	if data exists in the buffer
false	if data exists in the buffer

Definition at line 54 of file MemBuf.h.

References size.

Referenced by constructHelperQuery(), Auth::SchemeConfig::CreateAuthUser(), BodyPipe::getMoreData(), ConnStateData::handleChunkedRequestBody(), Helper::operator<<(), redirectHandleReply(), BodyPipe::setConsumerIfNotLate(), ConnStateData::sslCrtdHandleReply(), BodyPipe::startAutoConsumptionIfNeeded(), and Adaptation::Icap::ModXact::writeSomeBody().

◆ hasPotentialSpace()

bool MemBuf::hasPotentialSpace ( ) const

inline

Definition at line 75 of file MemBuf.h.

References potentialSpaceSize().

Referenced by HttpStateData::readReply().

◆ hasSpace()

bool MemBuf::hasSpace ( ) const

inline

Whether the buffer contains any data space available.

Return values

true	if data can be added to the buffer
false	if the buffer is full

Definition at line 72 of file MemBuf.h.

References capacity, and size.

Referenced by storeRebuildLoadEntry(), and storeRebuildLoadEntry().

◆ init() [1/2]

void MemBuf::init ( )

init with defaults

Definition at line 86 of file MemBuf.cc.

References init(), MEM_BUF_INIT_SIZE, and MEM_BUF_MAX_SIZE.

Referenced by init(), and reset().

◆ init() [2/2]

void MemBuf::init	(	mb_size_t	szInit,
		mb_size_t	szMax
	)

init with specific sizes

Definition at line 93 of file MemBuf.cc.

References assert, buf, capacity, grow(), max_capacity, size, stolen, and terminate().

Referenced by BodyPipe::BodyPipe(), Ftp::Server::acceptDataConnection(), Client::adaptVirginReplyBody(), Format::Format::assemble(), debugObj(), HttpStateData::decodeAndWriteReplyBody(), ErrorState::Dump(), Helper::Reply::emptyBuf(), BodyPipe::getMoreData(), HttpStateData::getMoreRequestBody(), Ftp::Server::handleDataReply(), Ftp::Server::handleEpsvReply(), Ftp::Server::handlePasvReply(), Ftp::Server::handleRequest(), helperDispatch(), htcpClear(), htcpQuery(), htcpTstReply(), Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), httpHdrAdd(), httpHeaderPutStrvf(), idnsReadVCHeader(), idnsSendQueryVC(), Adaptation::Ecap::HeaderRep::image(), Ftp::Client::initReadBuf(), ACLExternal::makeExternalAclKey(), Adaptation::Icap::ModXact::makeRequestHeaders(), ClientHttpRequest::mRangeCLen(), Fs::Ufs::UFSSwapDir::openTmpSwapLog(), HttpReply::pack(), HttpReply::packHeadersUsingSlowPacker(), Http::Message::parseCharBuf(), Ftp::Gateway::parseListing(), prepareLogWithRequestDetails(), Adaptation::Icap::ModXact::prepEchoing(), HttpHeader::putCc(), HttpHeader::putContRange(), HttpHeader::putRange(), HttpHeader::putSc(), Fs::Ufs::RebuildState::rebuildFromDirectory(), redirectHandleReply(), Http::Stream::sendBody(), HttpStateData::sendRequest(), Log::Format::SquidNative(), ACLExternal::startLookup(), Adaptation::Icap::ModXact::startShoveling(), Adaptation::Icap::OptXact::startShoveling(), statObjects(), TestEvent::testDump(), TestHttpReply::testSanityCheckFirstLine(), TestHttpRequest::testSanityCheckStartLine(), clientReplyContext::traceReply(), Ftp::Server::writeCustomReply(), Ftp::Server::writeEarlyReply(), Ftp::Server::writeErrorReply(), Ftp::Server::writeForwardedReplyAndCall(), Http::Tunneler::writeRequest(), and Adaptation::Icap::ModXact::writeSomeBody().

◆ isNull()

int MemBuf::isNull ( ) const

unfirtunate hack to test if the buffer has been Init()ialized

Unfortunate hack to test if the buffer has been Init()ialized

Definition at line 145 of file MemBuf.cc.

References assert, buf, capacity, max_capacity, and size.

Referenced by clean(), Helper::Reply::emptyBuf(), BodyPipe::getMoreData(), helperDispatch(), idnsSendQueryVC(), Helper::Reply::other(), and reset().

◆ operator=()

MemBuf & MemBuf::operator= ( const MemBuf & )

inlineprivate

Definition at line 122 of file MemBuf.h.

References assert.

◆ potentialSpaceSize()

mb_size_t MemBuf::potentialSpaceSize ( ) const

Definition at line 161 of file MemBuf.cc.

References max_capacity, and size.

Referenced by Client::calcBufferSpaceToReserve(), BodyPipe::getMoreData(), hasPotentialSpace(), idnsSendQueryVC(), BodyPipe::putMoreData(), and Adaptation::Icap::ModXact::virginConsume().

◆ reset()

void MemBuf::reset ( )

resets mb preserving (or initializing if needed) memory buffer

Cleans the buffer without changing its capacity if called with a Null buffer, calls memBufDefInit()

Definition at line 129 of file MemBuf.cc.

References assert, buf, capacity, init(), isNull(), size, and stolen.

Referenced by ErrorState::compileLegacyCode(), ErrorState::compileLogformatCode(), constructHelperQuery(), Auth::SchemeConfig::CreateAuthUser(), errorInitialize(), Note::Value::format(), Auth::UserRequest::helperRequestKeyExtras(), htcpTstReply(), internalRemoteUri(), ACLExternal::makeExternalAclKey(), ClientHttpRequest::mRangeCLen(), prepareLogWithRequestDetails(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), snmpDebugOid(), Log::Format::SquidCustom(), Adaptation::Ecap::ServiceRep::status(), AsyncJob::status(), BodyPipe::status(), Adaptation::Ecap::XactionRep::status(), Adaptation::Icap::ServiceRep::status(), Adaptation::Icap::Xaction::status(), Http::Tunneler::status(), Comm::TcpAcceptor::status(), Ipc::Inquirer::status(), Security::PeerConnector::status(), TestHttpReply::testSanityCheckFirstLine(), TestHttpRequest::testSanityCheckStartLine(), and Ftp::UnescapeDoubleQuoted().

◆ space() [1/2]

char * MemBuf::space ( )

inline

space to add data

Definition at line 57 of file MemBuf.h.

References buf, and size.

Referenced by append(), Fs::Ufs::UFSSwapDir::openTmpSwapLog(), storeRebuildLoadEntry(), storeRebuildLoadEntry(), and terminate().

◆ space() [2/2]

char * MemBuf::space ( mb_size_t required )

inline

Returns buffer following data, after possibly growing the buffer to accommodate addition of the required bytes PLUS a 0-terminator char. The caller is not required to terminate the buffer, but MemBuf does terminate internally, trading termination for size calculation bugs.

Definition at line 63 of file MemBuf.h.

References buf, capacity, grow(), and size.

◆ spaceSize()

mb_size_t MemBuf::spaceSize ( ) const

Definition at line 155 of file MemBuf.cc.

References capacity, and size.

Referenced by BodyPipe::status(), storeRebuildLoadEntry(), and storeRebuildLoadEntry().

◆ terminate()

void MemBuf::terminate ( )

Null-terminate in case we are used as a string. Extra octet is not counted in the content size (or space size)

Note: XXX: but the extra octet is counted when growth decisions are made! This will cause the buffer to grow when spaceSize() == 1 on append, which will assert() if the buffer cannot grow any more.

Definition at line 241 of file MemBuf.cc.

References assert, capacity, size, and space().

Referenced by appended(), consume(), init(), Adaptation::Icap::OptXact::makeRequest(), Http::Message::parseCharBuf(), Adaptation::Icap::ModXact::prepEchoing(), Adaptation::Icap::ModXact::startShoveling(), Adaptation::Icap::OptXact::startShoveling(), Adaptation::Ecap::ServiceRep::status(), AsyncJob::status(), BodyPipe::status(), Adaptation::Ecap::XactionRep::status(), Adaptation::Icap::ServiceRep::status(), Adaptation::Icap::Xaction::status(), Http::Tunneler::status(), Ipc::Inquirer::status(), and Security::PeerConnector::status().

◆ truncate()

void MemBuf::truncate ( mb_size_t sz )

Definition at line 197 of file MemBuf.cc.

References assert, contentSize(), size, and stolen.

◆ vappendf()

void MemBuf::vappendf	(	const char *	fmt,
		va_list	vargs
	)

overridevirtual

vappendf for other printf()'s to use; calls vsnprintf, extends buf if needed

Implements Packable.

Definition at line 251 of file MemBuf.cc.

References assert, buf, capacity, grow(), max_capacity, size, and stolen.

Referenced by httpHeaderPutStrvf().

◆ wasStolen()

bool MemBuf::wasStolen ( ) const

inline

Definition at line 87 of file MemBuf.h.

References stolen.

Member Data Documentation

◆ buf

char* MemBuf::buf

Deprecated:: use space*() and content*() methods to access safely instead. public, read-only.

TODO: hide these members completely and remove 0-termination so that consume() does not need to memmove all the time

Definition at line 134 of file MemBuf.h.

Referenced by ~MemBuf(), append(), clean(), ErrorState::compileLegacyCode(), consume(), consumeWhitespacePrefix(), content(), content(), debugObj(), freeFunc(), grow(), Ftp::Server::handleEpsvReply(), Ftp::Server::handlePasvReply(), Ftp::Server::handleRequest(), htcpClear(), htcpQuery(), htcpTstReply(), httpHeaderPutStrvf(), idnsReadVC(), idnsReadVCHeader(), init(), internalRemoteUri(), isNull(), ACLExternal::makeExternalAclKey(), Http::Message::parseCharBuf(), prepareLogWithRequestDetails(), HttpHeader::putCc(), HttpHeader::putContRange(), HttpHeader::putRange(), HttpHeader::putSc(), reset(), HttpStateData::sendRequest(), Http::Stream::sendStartOfMessage(), space(), space(), Log::Format::SquidCustom(), ACLExternal::startLookup(), statObjects(), clientReplyContext::traceReply(), vappendf(), Comm::Write(), Http::One::Server::writeControlMsgAndCall(), Ftp::Server::writeForwardedReplyAndCall(), Ftp::Server::writeReply(), and Http::Tunneler::writeRequest().

◆ capacity

mb_size_t MemBuf::capacity

allocated space

Deprecated:: Use interface function instead TODO: make these private after converting memBuf*() functions to methods

Definition at line 149 of file MemBuf.h.

Referenced by append(), appended(), clean(), freeFunc(), grow(), hasSpace(), init(), isNull(), reset(), space(), spaceSize(), terminate(), and vappendf().

◆ max_capacity

mb_size_t MemBuf::max_capacity

when grows: assert(new_capacity <= max_capacity)

Deprecated:: Use interface function instead TODO: make these private after converting memBuf*() functions to methods

Definition at line 142 of file MemBuf.h.

Referenced by clean(), Adaptation::Icap::ModXact::estimateVirginBody(), HttpStateData::getMoreRequestBody(), grow(), init(), isNull(), potentialSpaceSize(), and vappendf().

◆ size

mb_size_t MemBuf::size

◆ stolen

unsigned MemBuf::stolen

Definition at line 151 of file MemBuf.h.

Referenced by ~MemBuf(), append(), Format::Format::assemble(), clean(), consume(), freeFunc(), grow(), init(), reset(), truncate(), vappendf(), and wasStolen().

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

squid/src/MemBuf.h
squid/src/MemBuf.cc

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MemBuf() [1/2]

◆ ~MemBuf()

◆ MemBuf() [2/2]

Member Function Documentation

◆ append()

◆ appended()

◆ appendf()

◆ buffer()

◆ CBDATA_DECL_()

◆ clean()

◆ consume()

◆ consumeWhitespacePrefix()

◆ content() [1/2]

◆ content() [2/2]

◆ contentSize()

◆ flush()

◆ freeFunc()

◆ grow()

◆ hasContent()

◆ hasPotentialSpace()

◆ hasSpace()

◆ init() [1/2]

◆ init() [2/2]

◆ isNull()

◆ operator=()

◆ potentialSpaceSize()

◆ reset()

◆ space() [1/2]

◆ space() [2/2]

◆ spaceSize()

◆ terminate()

◆ truncate()

◆ vappendf()

◆ wasStolen()

Member Data Documentation

◆ buf

◆ capacity

◆ max_capacity

◆ size

◆ stolen