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 *hlp, Helper::Xaction *r)
	Handles a request when all running helpers, if any, are busy. More...
static helper_server *	GetFirstAvailable (const helper *hlp)
static helper_stateful_server *	StatefulGetFirstAvailable (statefulhelper *hlp)
static void	helperDispatch (helper_server *srv, Helper::Xaction *r)
static void	helperStatefulDispatch (helper_stateful_server *srv, Helper::Xaction *r)
static void	helperKickQueue (helper *hlp)
static void	helperStatefulKickQueue (statefulhelper *hlp)
static void	helperStatefulServerDone (helper_stateful_server *srv)
static void	StatefulEnqueue (statefulhelper *hlp, Helper::Xaction *r)
	InstanceIdDefinitions (HelperServerBase, "Hlpr")
void	helperOpenServers (helper *hlp)
void	helperStatefulOpenServers (statefulhelper *hlp)
static void	SubmissionFailure (helper *hlp, HLPCB *callback, void *data)
	handles helperSubmit() and helperStatefulSubmit() failures More...
void	helperSubmit (helper *hlp, const char *buf, HLPCB *callback, void *data)
void	helperStatefulSubmit (statefulhelper *hlp, const char *buf, HLPCB *callback, void *data, const Helper::ReservationId &reservation)
void	helperShutdown (helper *hlp)
void	helperStatefulShutdown (statefulhelper *hlp)
static void	helperReturnBuffer (helper_server *srv, helper *hlp, char *msg, size_t msgSize, char *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 *  hlp, Helper::Xaction *  r  )

static

Definition at line 1203 of file helper.cc.

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

Referenced by helper::submitRequest().

GetFirstAvailable()

static helper_server * GetFirstAvailable ( const helper *  hlp )

static

Definition at line 1273 of file helper.cc.

References helper::childs, Helper::ChildConfig::concurrency, dlink_node::data, debugs, HelperServerBase::flags, dlink_list::head, HelperServerBase::index, Helper::ChildConfig::n_running, dlink_node::next, HelperServerBase::pending, helper::servers, HelperServerBase::_helper_flags::shutdown, and HelperServerBase::stats.

Referenced by helperKickQueue(), helper::submitRequest(), and helper::willOverload().

helperDispatch()

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

static

Definition at line 1389 of file helper.cc.

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

Referenced by helperKickQueue(), and helper::submitRequest().

helperDispatchWriteDone()

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

static

Definition at line 1363 of file helper.cc.

References MemBuf::clean(), commCbCall(), MemBuf::content(), MemBuf::contentSize(), DBG_CRITICAL, debugs, HelperServerBase::flags, helperDispatchWriteDone(), helper::id_name, HelperServerBase::index, MemBuf::isNull(), Comm::OK, helper_server::parent, helper_server::wqueue, Comm::Write(), helper_server::writebuf, HelperServerBase::writePipe, and HelperServerBase::_helper_flags::writing.

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 980 of file helper.cc.

References assert, cbdataReferenceValid(), helper::childs, HelperServerBase::closePipesSafely(), comm_read(), commCbCall(), Helper::ChildConfig::concurrency, conn, DBG_DATA, DBG_IMPORTANT, debugs, helper::eom, Comm::ERR_CLOSING, Comm::Connection::fd, fd_table, helperHandleRead, helperReturnBuffer(), helper::id_name, helper_server::ignoreToEom, HelperServerBase::index, Comm::IsConnOpen(), Comm::OK, helper_server::parent, HelperServerBase::pending, helper_server::popRequest(), HelperServerBase::rbuf, HelperServerBase::rbuf_sz, HelperServerBase::readPipe, helper_server::replyXaction, HelperServerBase::roffset, HelperServerBase::stats, HelperServerBase::timedout, and xisspace.

helperKickQueue()

static void helperKickQueue ( helper *  hlp )

static

Definition at line 1484 of file helper.cc.

References GetFirstAvailable(), helperDispatch(), and helper::nextRequest().

Referenced by helperOpenServers(), and helperReturnBuffer().

helperOpenServers()

void helperOpenServers

(

helper *

hlp

)

Definition at line 201 of file helper.cc.

References helper::addr, HelperServerBase::addr, assert, asyncCall(), cbdataDialer(), cbdataReference, helper::childs, helper::cmdline, comm_add_close_handler(), comm_read(), commCbCall(), commSetConnTimeout(), commSetNonBlocking(), Helper::ChildConfig::concurrency, DBG_IMPORTANT, debugs, dlinkAddTail(), Comm::Connection::fd, FD_DESC_SZ, fd_note(), getCurrentTime(), HELPER_MAX_ARGS, helperHandleRead, helperKickQueue(), helper_server::HelperServerClosed(), HelperServerBase::hIpc, hIpc, helper_server::ignoreToEom, Important, HelperServerBase::initStats(), helper::ipc_type, ipcCreate(), wordlist::key, helper::last_restart, HelperServerBase::link, memAllocBuf(), Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::n_running, Helper::ChildConfig::needNew(), wordlist::next, helper_server::nextRequestId, helper_server::parent, HelperServerBase::pid, pid, progname, HelperServerBase::rbuf, HelperServerBase::rbuf_sz, ReadBufSize(), HelperServerBase::readPipe, helper_server::replyXaction, helper_server::requestTimeout(), HelperServerBase::roffset, safe_free, helper::servers, squid_curtime, helper::timeout, helper_server::wqueue, HelperServerBase::writePipe, xmalloc, and xstrdup.

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

helperReturnBuffer()

static void helperReturnBuffer ( helper_server *  srv, helper *  hlp, char *  msg, size_t  msgSize, char *  msgEnd  )

static

Definition at line 916 of file helper.cc.

References Helper::Reply::accumulate(), HelperServerBase::answer_time, helper::_stats::avg_svc_time, Helper::BrokenHelper, Helper::Request::callback, cbdataReferenceValid(), cbdataReferenceValidDone, helper_server::checkForTimedOutRequests(), helper::childs, HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), HelperServerBase::_helper_flags::closing, Helper::ChildConfig::concurrency, current_time, Helper::Request::data, DBG_IMPORTANT, debugs, HelperServerBase::dispatch_time, Helper::Request::dispatch_time, Helper::Reply::finalize(), HelperServerBase::flags, helperKickQueue(), helper::id_name, HelperServerBase::index, Math::intAverage(), MAX_RETRIES, helper_server::parent, HelperServerBase::pending, HelperServerBase::rbuf_sz, REDIRECT_AV_FACTOR, helper::_stats::replies, HelperServerBase::replies, Helper::Xaction::reply, helper_server::replyXaction, Helper::Xaction::request, Helper::Reply::result, Helper::Request::retries, helper::retryTimedOut, HelperServerBase::_helper_flags::shutdown, helper::stats, HelperServerBase::stats, helper::submitRequest(), helper::timeout, and tvSubMsec().

Referenced by helperHandleRead().

helperShutdown()

void helperShutdown

(

helper *

hlp

)

Definition at line 740 of file helper.cc.

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

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 1436 of file helper.cc.

References assert, Helper::Request::buf, Helper::Request::callback, statefulhelper::cancelReservation(), cbdataReferenceValid(), commCbCall(), current_time, Helper::Request::data, DBG_IMPORTANT, debugs, HelperServerBase::dispatch_time, helperStatefulDispatchWriteDone(), helperStatefulServerDone(), helper::id_name, HelperServerBase::index, helper_stateful_server::parent, HelperServerBase::pending, Helper::Request::placeholder, Helper::Xaction::reply, Helper::Xaction::request, helper::_stats::requests, HelperServerBase::requests, helper_stateful_server::reservationId, Helper::Reply::reservationId, Helper::Reply::result, helper::stats, HelperServerBase::stats, Helper::Unknown, HelperServerBase::uses, Comm::Write(), and HelperServerBase::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 1432 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 1096 of file helper.cc.

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

helperStatefulKickQueue()

static void helperStatefulKickQueue ( statefulhelper *  hlp )

static

Definition at line 1494 of file helper.cc.

References debugs, helperStatefulDispatch(), HelperServerBase::index, helper::nextRequest(), statefulhelper::reserveServer(), and StatefulGetFirstAvailable().

Referenced by helperStatefulOpenServers(), and helperStatefulServerDone().

helperStatefulOpenServers()

void helperStatefulOpenServers

(

statefulhelper *

hlp

)

DPW 2007-05-08

helperStatefulOpenServers: create the stateful child helper processes

Definition at line 332 of file helper.cc.

References helper::addr, HelperServerBase::addr, assert, asyncCall(), cbdataDialer(), cbdataReference, helper::childs, helper::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_MAX_ARGS, helper_stateful_server::HelperServerClosed(), helperStatefulHandleRead, helperStatefulKickQueue(), HelperServerBase::hIpc, hIpc, HelperServerBase::initStats(), helper::ipc_type, ipcCreate(), wordlist::key, helper::last_restart, HelperServerBase::link, memAllocBuf(), Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::n_running, Helper::ChildConfig::needNew(), wordlist::next, helper_stateful_server::parent, HelperServerBase::pid, pid, progname, HelperServerBase::rbuf, HelperServerBase::rbuf_sz, ReadBufSize(), HelperServerBase::readPipe, helper_stateful_server::reservationStart, HelperServerBase::roffset, safe_free, helper::servers, squid_curtime, HelperServerBase::writePipe, xmalloc, and xstrdup.

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

helperStatefulServerDone()

static void helperStatefulServerDone ( helper_stateful_server *  srv )

static

Definition at line 1506 of file helper.cc.

References HelperServerBase::closeWritePipeSafely(), HelperServerBase::_helper_flags::closing, HelperServerBase::flags, helperStatefulKickQueue(), helper::id_name, helper_stateful_server::parent, HelperServerBase::pending, helper_stateful_server::reserved(), HelperServerBase::_helper_flags::shutdown, and HelperServerBase::stats.

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

helperStatefulShutdown()

void helperStatefulShutdown

(

statefulhelper *

hlp

)

Definition at line 777 of file helper.cc.

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

helperStatefulSubmit()

void helperStatefulSubmit	(	statefulhelper *	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 567 of file helper.cc.

helperSubmit()

void helperSubmit	(	helper *	hlp,
		const char *	buf,
		HLPCB *	callback,
		void *	data
	)

Definition at line 473 of file helper.cc.

Referenced by constructHelperQuery().

InstanceIdDefinitions()

InstanceIdDefinitions	(	HelperServerBase	,
		"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 1232 of file helper.cc.

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

Referenced by statefulhelper::submit().

StatefulGetFirstAvailable()

static helper_stateful_server * StatefulGetFirstAvailable ( statefulhelper *  hlp )

static

Definition at line 1319 of file helper.cc.

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

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

SubmissionFailure()

static void SubmissionFailure ( helper *  hlp, HLPCB *  callback, void *  data  )

static

Definition at line 460 of file helper.cc.

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

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().