#include <helper.h>

Inheritance diagram for helper:
Collaboration diagram for helper:

Classes

struct  _stats
 

Public Member Functions

void * operator new (size_t size)
 
void operator delete (void *address)
 
void * toCbdata () noexcept
 
 helper (const char *name)
 
 ~helper ()
 
Helper::XactionnextRequest ()
 
bool trySubmit (const char *buf, HLPCB *callback, void *data)
 If possible, submit request. Otherwise, either kill Squid or return false. More...
 
void submitRequest (Helper::Xaction *r)
 
void packStatsInto (Packable *p, const char *label=NULL) const
 Dump some stats about the helper state to a Packable object. More...
 
bool willOverload () const
 
void handleKilledServer (HelperServerBase *srv, bool &needsNewServers)
 

Public Attributes

wordlistcmdline
 
dlink_list servers
 
std::queue< Helper::Xaction * > queue
 
const char * id_name
 
Helper::ChildConfig childs
 Configuration settings for number running. More...
 
int ipc_type
 
Ip::Address addr
 
unsigned int droppedRequests
 requests not sent during helper overload More...
 
time_t overloadStart
 when the helper became overloaded (zero if it is not) More...
 
time_t last_queue_warn
 
time_t last_restart
 
time_t timeout
 Requests timeout. More...
 
bool retryTimedOut
 Whether the timed-out requests must retried. More...
 
bool retryBrokenHelper
 Whether the requests must retried on BH replies. More...
 
SBuf onTimedOutResponse
 The response to use when helper response timedout. More...
 
char eom
 The char which marks the end of (response) message, normally '
'. More...
 
struct helper::_stats stats
 

Protected Member Functions

bool queueFull () const
 whether queuing an additional request would overload the helper More...
 
bool overloaded () const
 
void syncQueueStats ()
 synchronizes queue-dependent measurements with the current queue state More...
 
bool prepSubmit ()
 
void submit (const char *buf, HLPCB *callback, void *data)
 dispatches or enqueues a helper requests; does not enforce queue limits More...
 

Static Private Attributes

static cbdata_type CBDATA_helper = CBDATA_UNKNOWN
 

Friends

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

Detailed Description

Managers a set of individual helper processes with a common queue of requests.

With respect to load, a helper goes through these states (roughly): idle: no processes are working on requests (and no requests are queued); normal: some, but not all processes are working (and no requests are queued); busy: all processes are working (and some requests are possibly queued); overloaded: a busy helper with more than queue-size requests in the queue.

A busy helper queues new requests and issues a WARNING every 10 minutes or so. An overloaded helper either drops new requests or keeps queuing them, depending on whether the caller can handle dropped requests (trySubmit vs helperSubmit APIs). If an overloaded helper has been overloaded for 3+ minutes, an attempt to use it results in on-persistent-overload action, which may kill worker.

Definition at line 63 of file helper.h.

Constructor & Destructor Documentation

◆ helper()

helper::helper ( const char *  name)
inline

Definition at line 68 of file helper.h.

References buf, callback, data, NULL, p, and Ping::stats.

◆ ~helper()

void const char HLPCB void helper_stateful_server *lastserver STUB helper::~helper ( )

Definition at line 818 of file helper.cc.

References DBG_CRITICAL, debugs, and HelperServerBase::stats.

Member Function Documentation

◆ handleKilledServer()

void helper::handleKilledServer ( HelperServerBase srv,
bool &  needsNewServers 
)

Updates interall statistics and start new helper server processes after an unexpected server exit

Parameters
needsNewServerstrue if new servers must started, false otherwise

Definition at line 828 of file helper.cc.

References assert, DBG_CRITICAL, DBG_IMPORTANT, debugs, fatalf(), HelperServerBase::flags, HelperServerBase::index, HelperServerBase::replies, HelperServerBase::_helper_flags::shutdown, squid_curtime, and HelperServerBase::stats.

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

◆ nextRequest()

Helper::Xaction * helper::nextRequest ( )
Returns
next request in the queue, or nil.

Definition at line 1257 of file helper.cc.

References HelperServerBase::stats.

Referenced by helperKickQueue(), and helperStatefulKickQueue().

◆ operator delete()

void helper::operator delete ( void *  address)
inline

Definition at line 65 of file helper.h.

◆ operator new()

void* helper::operator new ( size_t  size)
inline

Definition at line 65 of file helper.h.

◆ overloaded()

bool helper::overloaded ( ) const
protected

Definition at line 481 of file helper.cc.

References HelperServerBase::stats.

◆ packStatsInto()

◆ prepSubmit()

bool helper::prepSubmit ( )
protected

prepares the helper for request submission returns true if and only if the submission should proceed may kill Squid if the helper remains overloaded for too long

Definition at line 514 of file helper.cc.

References Helper::ChildConfig::actDie, DBG_IMPORTANT, debugs, fatalf(), and squid_curtime.

◆ queueFull()

bool helper::queueFull ( ) const
protected

Definition at line 476 of file helper.cc.

References HelperServerBase::stats.

◆ submit()

void helper::submit ( const char *  buf,
HLPCB callback,
void *  data 
)
protected

Definition at line 552 of file helper.cc.

References DBG_DATA, and debugs.

◆ submitRequest()

void helper::submitRequest ( Helper::Xaction r)

Submits a request to the helper or add it to the queue if none of the servers is available.

Definition at line 441 of file helper.cc.

References Enqueue(), GetFirstAvailable(), and helperDispatch().

Referenced by helperReturnBuffer().

◆ syncQueueStats()

void helper::syncQueueStats ( )
protected

Definition at line 487 of file helper.cc.

References DBG_IMPORTANT, debugs, and squid_curtime.

◆ toCbdata()

void* helper::toCbdata ( )
inlinenoexcept

Definition at line 65 of file helper.h.

◆ trySubmit()

bool helper::trySubmit ( const char *  buf,
HLPCB callback,
void *  data 
)

Definition at line 541 of file helper.cc.

Referenced by helperSubmit(), and ExternalACLLookup::Start().

◆ willOverload()

bool helper::willOverload ( ) const

whether the helper will be in "overloaded" state after one more request already overloaded helpers return true

Definition at line 730 of file helper.cc.

References GetFirstAvailable().

Referenced by aclMatchExternal(), redirectStart(), and storeIdStart().

Friends And Related Function Documentation

◆ helperSubmit

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

Definition at line 468 of file helper.cc.

Member Data Documentation

◆ addr

Ip::Address helper::addr

Definition at line 112 of file helper.h.

Referenced by helperOpenServers(), and helperStatefulOpenServers().

◆ CBDATA_helper

cbdata_type helper::CBDATA_helper = CBDATA_UNKNOWN
staticprivate

Definition at line 65 of file helper.h.

◆ childs

◆ cmdline

◆ droppedRequests

unsigned int helper::droppedRequests

Definition at line 113 of file helper.h.

◆ eom

char helper::eom

Definition at line 121 of file helper.h.

Referenced by helperHandleRead(), and helperStatefulHandleRead().

◆ id_name

◆ ipc_type

◆ last_queue_warn

time_t helper::last_queue_warn

Definition at line 115 of file helper.h.

Referenced by Enqueue(), and StatefulEnqueue().

◆ last_restart

time_t helper::last_restart

Definition at line 116 of file helper.h.

Referenced by helperOpenServers(), and helperStatefulOpenServers().

◆ onTimedOutResponse

SBuf helper::onTimedOutResponse

Definition at line 120 of file helper.h.

Referenced by redirectInit().

◆ overloadStart

time_t helper::overloadStart

Definition at line 114 of file helper.h.

◆ queue

std::queue<Helper::Xaction *> helper::queue

Definition at line 108 of file helper.h.

Referenced by Enqueue(), and StatefulEnqueue().

◆ retryBrokenHelper

bool helper::retryBrokenHelper

Definition at line 119 of file helper.h.

Referenced by redirectInit().

◆ retryTimedOut

bool helper::retryTimedOut

Definition at line 118 of file helper.h.

Referenced by helperReturnBuffer(), redirectInit(), and helper_server::requestTimeout().

◆ servers

◆ stats

◆ timeout

time_t helper::timeout

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors