helper.cc File Reference

#include "squid.h"
#include "base/AsyncCbdataCalls.h"
#include "base/Packable.h"
#include "base/Raw.h"
#include "comm.h"
#include "comm/Connection.h"
#include "comm/Read.h"
#include "comm/Write.h"
#include "debug/Messages.h"
#include "fd.h"
#include "fde.h"
#include "format/Quoting.h"
#include "helper.h"
#include "helper/Reply.h"
#include "helper/Request.h"
#include "MemBuf.h"
#include "SquidConfig.h"
#include "SquidIpc.h"
#include "SquidMath.h"
#include "Store.h"
#include "wordlist.h"
#include "mem/Pool.h"

Include dependency graph for helper.cc:

Go to the source code of this file.

Macros
#define	HELPER_MAX_ARGS   64
#define	MAX_RETRIES   2
	The maximum allowed request retries. More...

Functions
const size_t	ReadBufSize (32 *1024)
	Helpers input buffer size. More...
static void	Enqueue (Helper::Client *const hlp, Helper::Xaction *const r)
	Handles a request when all running helpers, if any, are busy. More...
static Helper::Session *	GetFirstAvailable (const Helper::Client::Pointer &)
static helper_stateful_server *	StatefulGetFirstAvailable (const statefulhelper::Pointer &)
static void	helperDispatch (Helper::Session *, Helper::Xaction *)
static void	helperStatefulDispatch (helper_stateful_server *srv, Helper::Xaction *r)
static void	helperKickQueue (const Helper::Client::Pointer &)
static void	helperStatefulKickQueue (const statefulhelper::Pointer &)
static void	helperStatefulServerDone (helper_stateful_server *srv)
static void	StatefulEnqueue (statefulhelper *hlp, Helper::Xaction *r)
	InstanceIdDefinitions (Helper::SessionBase, "Hlpr")
void	helperOpenServers (const Helper::Client::Pointer &hlp)
void	helperStatefulOpenServers (const statefulhelper::Pointer &hlp)
static void	SubmissionFailure (const Helper::Client::Pointer &hlp, HLPCB *callback, void *data)
	handles helperSubmit() and helperStatefulSubmit() failures More...
void	helperSubmit (const Helper::Client::Pointer &hlp, const char *const buf, HLPCB *const callback, void *const data)
void	helperStatefulSubmit (const statefulhelper::Pointer &hlp, const char *buf, HLPCB *callback, void *data, const Helper::ReservationId &reservation)
void	helperShutdown (const Helper::Client::Pointer &hlp)
void	helperStatefulShutdown (const statefulhelper::Pointer &hlp)
static void	helperReturnBuffer (Helper::Session *srv, const Helper::Client::Pointer &hlp, char *const msg, const size_t msgSize, const char *const msgEnd)
	Calls back with a pointer to the buffer with the helper output. More...
static void	helperHandleRead (const Comm::ConnectionPointer &conn, char *, size_t len, Comm::Flag flag, int, void *data)
static void	helperStatefulHandleRead (const Comm::ConnectionPointer &conn, char *, size_t len, Comm::Flag flag, int, void *data)
static void	helperDispatchWriteDone (const Comm::ConnectionPointer &, char *, size_t, Comm::Flag flag, int, void *data)
static void	helperStatefulDispatchWriteDone (const Comm::ConnectionPointer &, char *, size_t, Comm::Flag, int, void *)

Variables
static IOCB	helperHandleRead
static IOCB	helperStatefulHandleRead

Macro Definition Documentation

HELPER_MAX_ARGS

#define HELPER_MAX_ARGS   64

Definition at line 36 of file helper.cc.

MAX_RETRIES

#define MAX_RETRIES   2

Definition at line 39 of file helper.cc.

Function Documentation

Enqueue()

static void Enqueue ( Helper::Client *  hlp, Helper::Xaction *  r  )

static

Definition at line 1239 of file helper.cc.

References Helper::Client::childs, DBG_CRITICAL, debugs, helperOpenServers(), Helper::Client::id_name, Helper::Client::last_queue_warn, Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::needNew(), Helper::Client::queue, Helper::Client::_stats::queue_size, Helper::ChildConfig::queue_size, reconfiguring, shutting_down, squid_curtime, and Helper::Client::stats.

Referenced by Helper::Client::submitRequest().

GetFirstAvailable()

static Helper::Session * GetFirstAvailable ( const Helper::Client::Pointer &  hlp )

static

Definition at line 1309 of file helper.cc.

References Helper::Client::childs, Helper::ChildConfig::concurrency, dlink_node::data, debugs, dlink_list::head, Helper::SessionBase::index, Helper::ChildConfig::n_running, dlink_node::next, Helper::SessionBase::pending, Helper::Client::servers, and Helper::SessionBase::stats.

Referenced by helperKickQueue(), Helper::Client::submitRequest(), and Helper::Client::willOverload().

helperDispatch()

static void helperDispatch ( Helper::Session *  srv, Helper::Xaction *  r  )

static

Definition at line 1424 of file helper.cc.

References MemBuf::append(), Packable::appendf(), assert, Helper::Request::buf, cbdataReferenceValid(), commCbCall(), MemBuf::content(), MemBuf::contentSize(), current_time, Helper::Request::data, DBG_IMPORTANT, debugs, Helper::Request::dispatch_time, Helper::SessionBase::flags, helperDispatchWriteDone(), Helper::Request::Id, Helper::SessionBase::index, MemBuf::init(), MemBuf::isNull(), Helper::Session::nextRequestId, Helper::Session::parent, Helper::SessionBase::pending, PRIu64, Helper::Xaction::request, Helper::SessionBase::requests, Helper::Session::requestsIndex, Helper::SessionBase::stats, Helper::SessionBase::uses, Helper::Session::wqueue, Comm::Write(), Helper::Session::writebuf, Helper::SessionBase::writePipe, and Helper::SessionBase::_helper_flags::writing.

Referenced by helperKickQueue(), and Helper::Client::submitRequest().

helperDispatchWriteDone()

static void helperDispatchWriteDone ( const Comm::ConnectionPointer &  , char *  , size_t  , Comm::Flag  flag, int  , void *  data  )

static

Definition at line 1398 of file helper.cc.

References MemBuf::clean(), commCbCall(), DBG_CRITICAL, debugs, helperDispatchWriteDone(), Comm::OK, Comm::Write(), and Helper::Session::writebuf.

Referenced by helperDispatch(), and helperDispatchWriteDone().

helperHandleRead()

static void helperHandleRead ( const Comm::ConnectionPointer &  conn, char *  , size_t  len, Comm::Flag  flag, int  , void *  data  )

static

Definition at line 1016 of file helper.cc.

References assert, cbdataReferenceValid(), comm_read(), commCbCall(), conn, DBG_DATA, DBG_IMPORTANT, debugs, Comm::ERR_CLOSING, fd_table, helperHandleRead, helperReturnBuffer(), Comm::IsConnOpen(), Comm::OK, Helper::Session::parent, and xisspace.

helperKickQueue()

static void helperKickQueue ( const Helper::Client::Pointer &  hlp )

static

Definition at line 1519 of file helper.cc.

References GetFirstAvailable(), helperDispatch(), and Helper::Client::nextRequest().

Referenced by helperOpenServers(), and helperReturnBuffer().

helperOpenServers()

void helperOpenServers

(

const Helper::Client::Pointer &

hlp

)

Definition at line 196 of file helper.cc.

References Helper::Client::addr, assert, asyncCall(), cbdataDialer(), Helper::Client::childs, Helper::Client::cmdline, comm_add_close_handler(), comm_read(), commCbCall(), commSetConnTimeout(), commSetNonBlocking(), Helper::ChildConfig::concurrency, DBG_IMPORTANT, debugs, dlinkAddTail(), FD_DESC_SZ, fd_note(), getCurrentTime(), Helper::Client::handleFewerServers(), HELPER_MAX_ARGS, helperHandleRead, helperKickQueue(), Helper::Session::HelperServerClosed(), hIpc, Important, Helper::Client::ipc_type, ipcCreate(), wordlist::key, Helper::Client::last_restart, memAllocBuf(), Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::n_running, Helper::ChildConfig::needNew(), wordlist::next, pid, progname, ReadBufSize(), Helper::Session::requestTimeout(), safe_free, Helper::Client::servers, squid_curtime, Helper::Client::timeout, xmalloc, and xstrdup.

Referenced by Enqueue(), externalAclInit(), Helper::Session::HelperServerClosed(), Ssl::Helper::Init(), Ssl::CertValidationHelper::Init(), and redirectInit().

helperReturnBuffer()

static void helperReturnBuffer ( Helper::Session *  srv, const Helper::Client::Pointer &  hlp, char *const  msg, const size_t  msgSize, const char *const  msgEnd  )

static

Definition at line 952 of file helper.cc.

References Helper::SessionBase::answer_time, Helper::Client::_stats::avg_svc_time, Helper::BrokenHelper, cbdataReferenceValid(), cbdataReferenceValidDone, Helper::Session::checkForTimedOutRequests(), Helper::Client::childs, Helper::SessionBase::closePipesSafely(), Helper::SessionBase::closeWritePipeSafely(), Helper::SessionBase::_helper_flags::closing, Helper::ChildConfig::concurrency, current_time, DBG_IMPORTANT, debugs, Helper::SessionBase::dispatch_time, Helper::SessionBase::flags, helperKickQueue(), Helper::Client::id_name, Helper::SessionBase::index, Math::intAverage(), MAX_RETRIES, Helper::Session::parent, Helper::SessionBase::pending, Helper::SessionBase::rbuf_sz, REDIRECT_AV_FACTOR, Helper::Client::_stats::replies, Helper::SessionBase::replies, Helper::Session::replyXaction, Helper::Xaction::request, Helper::Request::retries, Helper::Client::retryTimedOut, Helper::SessionBase::_helper_flags::shutdown, Helper::Client::stats, Helper::SessionBase::stats, Helper::Client::submitRequest(), Helper::Client::timeout, and tvSubMsec().

Referenced by helperHandleRead().

helperShutdown()

void helperShutdown

(

const Helper::Client::Pointer &

hlp

)

Definition at line 764 of file helper.cc.

References assert, Helper::Client::childs, dlink_node::data, debugs, dlink_list::head, Helper::Client::id_name, Helper::ChildConfig::n_active, dlink_node::next, and Helper::Client::servers.

Referenced by external_acl::~external_acl(), externalAclShutdown(), redirectShutdown(), Ssl::Helper::Shutdown(), and Ssl::CertValidationHelper::Shutdown().

helperStatefulDispatch()

static void helperStatefulDispatch ( helper_stateful_server *  srv, Helper::Xaction *  r  )

static

Definition at line 1471 of file helper.cc.

References assert, Helper::Request::buf, Helper::Request::callback, cbdataReferenceValid(), commCbCall(), current_time, Helper::Request::data, DBG_IMPORTANT, debugs, Helper::SessionBase::dispatch_time, helperStatefulDispatchWriteDone(), helperStatefulServerDone(), Helper::SessionBase::index, helper_stateful_server::parent, Helper::SessionBase::pending, Helper::Request::placeholder, Helper::Xaction::reply, Helper::Xaction::request, Helper::SessionBase::requests, helper_stateful_server::reservationId, Helper::Reply::reservationId, Helper::Reply::result, Helper::SessionBase::stats, Helper::Unknown, Helper::SessionBase::uses, Comm::Write(), and Helper::SessionBase::writePipe.

Referenced by helperStatefulKickQueue(), and statefulhelper::submit().

helperStatefulDispatchWriteDone()

static void helperStatefulDispatchWriteDone ( const Comm::ConnectionPointer &  , char *  , size_t  , Comm::Flag  , int  , void *    )

static

Definition at line 1467 of file helper.cc.

Referenced by helperStatefulDispatch().

helperStatefulHandleRead()

static void helperStatefulHandleRead ( const Comm::ConnectionPointer &  conn, char *  , size_t  len, Comm::Flag  flag, int  , void *  data  )

static

BUG: the below assumes that only one response per read() was received and discards any octets remaining. Doing this prohibits concurrency support with multiple replies per read(). TODO: check that read() setup on these buffers pays attention to roffest!=0 TODO: check that replies bigger than the buffer are discarded and do not to affect future replies

Definition at line 1132 of file helper.cc.

References Helper::Reply::accumulate(), Helper::SessionBase::answer_time, assert, Helper::Request::callback, cbdataReferenceValid(), Helper::SessionBase::closePipesSafely(), comm_read(), commCbCall(), conn, current_time, Helper::Request::data, DBG_DATA, DBG_IMPORTANT, debugs, Helper::SessionBase::dispatch_time, Comm::ERR_CLOSING, Comm::Connection::fd, fd_table, Helper::Reply::finalize(), helperStatefulHandleRead, helperStatefulServerDone(), Helper::SessionBase::index, Math::intAverage(), Comm::IsConnOpen(), Comm::OK, helper_stateful_server::parent, Helper::SessionBase::pending, Helper::SessionBase::rbuf, Helper::SessionBase::rbuf_sz, Helper::SessionBase::readPipe, REDIRECT_AV_FACTOR, Helper::SessionBase::replies, Helper::Xaction::reply, Helper::Xaction::request, Helper::SessionBase::requests, helper_stateful_server::reservationId, Helper::Reply::reservationId, Helper::SessionBase::roffset, Helper::SessionBase::stats, and tvSubMsec().

helperStatefulKickQueue()

static void helperStatefulKickQueue ( const statefulhelper::Pointer &  hlp )

static

Definition at line 1529 of file helper.cc.

References debugs, helperStatefulDispatch(), Helper::SessionBase::index, Helper::Client::nextRequest(), statefulhelper::reserveServer(), and StatefulGetFirstAvailable().

Referenced by helperStatefulOpenServers(), and helperStatefulServerDone().

helperStatefulOpenServers()

void helperStatefulOpenServers

(

const statefulhelper::Pointer &

hlp

)

DPW 2007-05-08

helperStatefulOpenServers: create the stateful child helper processes

Definition at line 336 of file helper.cc.

References Helper::Client::addr, Helper::SessionBase::addr, assert, asyncCall(), cbdataDialer(), Helper::Client::childs, Helper::Client::cmdline, comm_add_close_handler(), comm_read(), commCbCall(), commSetNonBlocking(), Helper::ChildConfig::concurrency, DBG_CRITICAL, DBG_IMPORTANT, debugs, dlinkAddTail(), Comm::Connection::fd, FD_DESC_SZ, fd_note(), getCurrentTime(), Helper::Client::handleFewerServers(), HELPER_MAX_ARGS, helper_stateful_server::HelperServerClosed(), helperStatefulHandleRead, helperStatefulKickQueue(), Helper::SessionBase::hIpc, hIpc, Helper::SessionBase::initStats(), Helper::Client::ipc_type, ipcCreate(), wordlist::key, Helper::Client::last_restart, Helper::SessionBase::link, memAllocBuf(), Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::n_running, Helper::ChildConfig::needNew(), wordlist::next, helper_stateful_server::parent, Helper::SessionBase::pid, pid, progname, Helper::SessionBase::rbuf, Helper::SessionBase::rbuf_sz, ReadBufSize(), Helper::SessionBase::readPipe, helper_stateful_server::reservationStart, Helper::SessionBase::roffset, safe_free, Helper::Client::servers, squid_curtime, Helper::SessionBase::writePipe, xmalloc, and xstrdup.

Referenced by helper_stateful_server::HelperServerClosed(), and StatefulEnqueue().

helperStatefulServerDone()

static void helperStatefulServerDone ( helper_stateful_server *  srv )

static

Definition at line 1541 of file helper.cc.

References Helper::SessionBase::closeWritePipeSafely(), Helper::SessionBase::_helper_flags::closing, Helper::SessionBase::flags, helperStatefulKickQueue(), Helper::Client::id_name, helper_stateful_server::parent, Helper::SessionBase::pending, helper_stateful_server::reserved(), Helper::SessionBase::_helper_flags::shutdown, and Helper::SessionBase::stats.

Referenced by statefulhelper::cancelReservation(), helperStatefulDispatch(), and helperStatefulHandleRead().

helperStatefulShutdown()

void helperStatefulShutdown

(

const statefulhelper::Pointer &

hlp

)

Definition at line 800 of file helper.cc.

References assert, Helper::Client::childs, Helper::SessionBase::closePipesSafely(), Helper::SessionBase::_helper_flags::closing, dlink_node::data, debugs, Helper::SessionBase::flags, dlink_list::head, Helper::Client::id_name, Helper::SessionBase::index, Helper::ChildConfig::n_active, dlink_node::next, Helper::SessionBase::pending, helper_stateful_server::reserved(), Helper::Client::servers, Helper::SessionBase::_helper_flags::shutdown, shutting_down, and Helper::SessionBase::stats.

helperStatefulSubmit()

void helperStatefulSubmit	(	const statefulhelper::Pointer &	hlp,
		const char *	buf,
		HLPCB *	callback,
		void *	data,
		const Helper::ReservationId &	reservation
	)

Submit request or callback the caller with a Helper::Error error. If the reservation is not set then reserves a new helper.

Definition at line 579 of file helper.cc.

helperSubmit()

void helperSubmit	(	const Helper::Client::Pointer &	hlp,
		const char *const	buf,
		HLPCB *const	callback,
		void *const	data
	)

Definition at line 485 of file helper.cc.

References SubmissionFailure(), and Helper::Client::trySubmit().

Referenced by constructHelperQuery().

InstanceIdDefinitions()

InstanceIdDefinitions	(	Helper::SessionBase	,
		"Hlpr"
	)

ReadBufSize()

const size_t ReadBufSize

(

32 *

1024

)

Referenced by helperOpenServers(), and helperStatefulOpenServers().

StatefulEnqueue()

static void StatefulEnqueue ( statefulhelper *  hlp, Helper::Xaction *  r  )

static

Definition at line 1268 of file helper.cc.

References Helper::Client::childs, DBG_CRITICAL, debugs, helperStatefulOpenServers(), Helper::Client::id_name, Helper::Client::last_queue_warn, Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::needNew(), Helper::Client::queue, Helper::Client::_stats::queue_size, Helper::ChildConfig::queue_size, reconfiguring, shutting_down, squid_curtime, and Helper::Client::stats.

Referenced by statefulhelper::submit().

StatefulGetFirstAvailable()

static helper_stateful_server * StatefulGetFirstAvailable ( const statefulhelper::Pointer &  hlp )

static

Definition at line 1354 of file helper.cc.

References Helper::Client::childs, dlink_node::data, debugs, Helper::SessionBase::flags, dlink_list::head, Helper::SessionBase::index, Helper::ChildConfig::n_running, dlink_node::next, Helper::SessionBase::pending, helper_stateful_server::reservationId, helper_stateful_server::reservationStart, Helper::ChildConfig::reservationTimeout, helper_stateful_server::reserved(), Helper::Client::servers, Helper::SessionBase::_helper_flags::shutdown, squid_curtime, and Helper::SessionBase::stats.

Referenced by helperStatefulKickQueue(), and statefulhelper::submit().

SubmissionFailure()

static void SubmissionFailure ( const Helper::Client::Pointer &  hlp, HLPCB *  callback, void *  data  )

static

Definition at line 472 of file helper.cc.

References debugs, Helper::Error, and Helper::Unknown.

Referenced by helperSubmit().

Variable Documentation

helperHandleRead

IOCB helperHandleRead

static

Definition at line 44 of file helper.cc.

Referenced by helperHandleRead(), and helperOpenServers().

helperStatefulHandleRead

IOCB helperStatefulHandleRead

static

Definition at line 45 of file helper.cc.

Referenced by helperStatefulHandleRead(), and helperStatefulOpenServers().