Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
FwdState Class Referenceabstract

#include <FwdState.h>

Inheritance diagram for FwdState:
Inheritance graph
[legend]
Collaboration diagram for FwdState:
Collaboration graph
[legend]

Public Types

typedef RefCount< FwdState > Pointer
 

Public Member Functions

 ~FwdState () override
 
void useDestinations ()
 
void fail (ErrorState *err)
 
void unregister (Comm::ConnectionPointer &conn)
 
void unregister (int fd)
 
void complete ()
 
void markStoredReplyAsWhole (const char *whyWeAreSure)
 
void handleUnregisteredServerEnd ()
 
int reforward ()
 
void serverClosed ()
 
void connectStart ()
 
void connectDone (const Comm::ConnectionPointer &conn, Comm::Flag status, int xerrno)
 
bool checkRetry ()
 
bool checkRetriable ()
 Whether we may try sending this request again after a failure. More...
 
void dispatch ()
 
void pconnPush (Comm::ConnectionPointer &conn, const char *domain)
 
bool dontRetry ()
 
void dontRetry (bool val)
 
void closePendingConnection (const Comm::ConnectionPointer &conn, const char *reason)
 get rid of a to-server connection that failed to become serverConn More...
 
const Comm::ConnectionPointer & serverConnection () const
 
void startSelectingDestinations (HttpRequest *request, const AccessLogEntry::Pointer &ale, StoreEntry *entry)
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static void initModule ()
 
static void Start (const Comm::ConnectionPointer &client, StoreEntry *, HttpRequest *, const AccessLogEntryPointer &alp)
 Initiates request forwarding to a peer or origin server. More...
 
static void fwdStart (const Comm::ConnectionPointer &client, StoreEntry *, HttpRequest *)
 Same as Start() but no master xaction info (AccessLogEntry) available. More...
 
static time_t ForwardTimeout (const time_t fwdStart)
 time left to finish the whole forwarding process (which started at fwdStart) More...
 
static bool EnoughTimeToReForward (const time_t fwdStart)
 
static void HandleStoreAbort (FwdState *)
 called by Store if the entry is no longer usable More...
 

Public Attributes

StoreEntry * entry
 
HttpRequest * request
 
AccessLogEntryPointer al
 info for the future access.log entry More...
 
bool subscribed = false
 whether noteDestination() and noteDestinationsEnd() calls are allowed More...
 
bool connected_okay
 TCP link ever opened properly. This affects retry of POST,PUT,CONNECT,etc. More...
 
bool dont_retry
 
bool forward_completed
 
bool destinationsFound
 at least one candidate path found More...
 

Private Types

enum  PconnRace {
  raceImpossible,
  racePossible,
  raceHappened
}
 possible pconn race states More...
 

Private Member Functions

 CBDATA_CHILD (FwdState)
 
 FwdState (const Comm::ConnectionPointer &client, StoreEntry *, HttpRequest *, const AccessLogEntryPointer &alp)
 
void start (Pointer aSelf)
 
void stopAndDestroy (const char *reason)
 ends forwarding; relies on refcounting so the effect may not be immediate More...
 
void noteDestination (Comm::ConnectionPointer conn) override
 called when a new unique destination has been found More...
 
void noteDestinationsEnd (ErrorState *selectionError) override
 
bool transporting () const
 
void noteConnection (HappyConnOpenerAnswer &)
 
void doneWithRetries ()
 
void completed ()
 
void retryOrBail ()
 
void usePinned ()
 send request on an existing connection dedicated to the requesting client More...
 
bool pinnedCanRetry () const
 
template<typename StepStart >
void advanceDestination (const char *stepDescription, const Comm::ConnectionPointer &conn, const StepStart &startStep)
 starts a preparation step for an established connection; retries on failures More...
 
ErrorState * makeConnectingError (const err_type type) const
 
void connectedToPeer (Security::EncryptorAnswer &answer)
 called when all negotiations with the TLS-speaking peer have been completed More...
 
void establishTunnelThruProxy (const Comm::ConnectionPointer &)
 
void tunnelEstablishmentDone (Http::TunnelerAnswer &answer)
 resumes operations after the (possibly failed) HTTP CONNECT exchange More...
 
void secureConnectionToPeerIfNeeded (const Comm::ConnectionPointer &)
 handles an established TCP connection to peer (including origin servers) More...
 
void secureConnectionToPeer (const Comm::ConnectionPointer &)
 encrypts an established TCP connection to peer (including origin servers) More...
 
void successfullyConnectedToPeer (const Comm::ConnectionPointer &)
 called when all negotiations with the peer have been completed More...
 
void closeServerConnection (const char *reason)
 stops monitoring server connection for closure and updates pconn stats More...
 
void syncWithServerConn (const Comm::ConnectionPointer &server, const char *host, const bool reused)
 commits to using the given open to-peer connection More...
 
void syncHierNote (const Comm::ConnectionPointer &server, const char *host)
 
bool exhaustedTries () const
 whether we have used up all permitted forwarding attempts More...
 
void updateAttempts (int)
 sets n_tries to the given value (while keeping ALE, if any, in sync) More...
 
time_t connectingTimeout (const Comm::ConnectionPointer &conn) const
 
void cancelStep (const char *reason)
 
void notifyConnOpener ()
 makes sure connection opener knows that the destinations have changed More...
 
void reactToZeroSizeObject ()
 ERR_ZERO_SIZE_OBJECT requires special adjustments. More...
 
void updateAleWithFinalError ()
 updates ALE when we finalize the transaction error (if any) More...
 
virtual void finalizedInCbdataChild ()=0
 hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...
 

Static Private Member Functions

static void logReplyStatus (int tries, const Http::StatusCode status)
 
static void RegisterWithCacheManager (void)
 

Private Attributes

Pointer self
 
ErrorState * err
 
Comm::ConnectionPointer clientConn
 a possibly open connection to the client. More...
 
time_t start_t
 
int n_tries
 the number of forwarding attempts so far More...
 
struct {
   bool   connected_okay
 TCP link ever opened properly. This affects retry of POST,PUT,CONNECT,etc. More...
 
   bool   dont_retry
 
   bool   forward_completed
 
   bool   destinationsFound
 at least one candidate path found More...
 
} flags
 
JobWait< HappyConnOpener > transportWait
 waits for a transport connection to the peer to be established/opened More...
 
JobWait< Security::PeerConnector > encryptionWait
 waits for the established transport connection to be secured/encrypted More...
 
JobWait< Http::Tunneler > peerWait
 
bool waitingForDispatched
 whether we are waiting for the last dispatch()ed activity to end More...
 
ResolvedPeersPointer destinations
 paths for forwarding the request More...
 
Comm::ConnectionPointer serverConn
 a successfully opened connection to a server. More...
 
PeerConnectionPointer destinationReceipt
 peer selection result (or nil) More...
 
AsyncCall::Pointer closeHandler
 The serverConn close handler. More...
 
PconnRace pconnRace
 current pconn race state More...
 
const char * storedWholeReply_
 
PeeringActivityTimer peeringTimer
 Measures time spent on selecting and communicating with peers. More...
 

Detailed Description

Definition at line 86 of file FwdState.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<FwdState> FwdState::Pointer

Definition at line 91 of file FwdState.h.

Member Enumeration Documentation

◆ PconnRace

enum FwdState::PconnRace
private
Enumerator
raceImpossible 
racePossible 
raceHappened 

Definition at line 243 of file FwdState.h.

Constructor & Destructor Documentation

◆ ~FwdState()

FwdState::~FwdState ( )
override

Definition at line 305 of file FwdState.cc.

References cancelStep(), closeServerConnection(), completed(), debugs, doneWithRetries(), entry, err, flags, HTTPMSGUNLOCK(), Comm::IsConnOpen(), request, serverConn, StoreEntry::unlock(), and StoreEntry::unregisterAbortCallback().

◆ FwdState()

FwdState::FwdState ( const Comm::ConnectionPointer &  client,
StoreEntry *  e,
HttpRequest *  r,
const AccessLogEntryPointer &  alp 
)
private

Definition at line 120 of file FwdState.cc.

References debugs, flags, HTTPMSGLOCK(), StoreEntry::lock(), request, and StoreEntry::url().

Referenced by Start().

Member Function Documentation

◆ advanceDestination()

template<typename StepStart >
void FwdState::advanceDestination ( const char *  stepDescription,
const Comm::ConnectionPointer &  conn,
const StepStart &  startStep 
)
private

Definition at line 820 of file FwdState.cc.

References al, closePendingConnection(), CurrentException(), debugs, err, ERR_GATEWAY_FAILURE, fail(), request, retryOrBail(), and Http::scInternalServerError.

Referenced by noteConnection(), and secureConnectionToPeerIfNeeded().

◆ cancelStep()

void FwdState::cancelStep ( const char *  reason)
private

Notify a pending subtask, if any, that we no longer need its help. We do not have to do this – the subtask job will eventually end – but ending it earlier reduces waste and may reduce DoS attack surface.

Definition at line 201 of file FwdState.cc.

References encryptionWait, peerWait, and transportWait.

Referenced by stopAndDestroy(), and ~FwdState().

◆ CBDATA_CHILD()

FwdState::CBDATA_CHILD ( FwdState  )
private

◆ checkRetriable()

bool FwdState::checkRetriable ( )

Definition at line 735 of file FwdState.cc.

References Http::Message::body_pipe, HttpRequestMethod::isHttpSafe(), HttpRequestMethod::isIdempotent(), HttpRequest::method, and request.

Referenced by checkRetry(), and connectStart().

◆ checkRetry()

bool FwdState::checkRetry ( )

Definition at line 691 of file FwdState.cc.

References HttpRequest::bodyNibbled(), checkRetriable(), debugs, EnoughTimeToReForward(), entry, exhaustedTries(), HttpRequest::flags, flags, StoreEntry::isEmpty(), RequestFlags::pinned, pinnedCanRetry(), request, shutting_down, start_t, STORE_PENDING, and StoreEntry::store_status.

Referenced by retryOrBail().

◆ closePendingConnection()

void FwdState::closePendingConnection ( const Comm::ConnectionPointer &  conn,
const char *  reason 
)

Definition at line 96 of file FwdState.cc.

References assert, Comm::Connection::close(), closeHandler, debugs, Comm::Connection::fd, fd_table, fwdPconnPool, Comm::IsConnOpen(), PconnPool::noteUses(), and serverConn.

Referenced by advanceDestination(), connectedToPeer(), noteConnection(), and tunnelEstablishmentDone().

◆ closeServerConnection()

void FwdState::closeServerConnection ( const char *  reason)
private

Definition at line 108 of file FwdState.cc.

References assert, Comm::Connection::close(), closeHandler, comm_remove_close_handler(), debugs, Comm::Connection::fd, fd_table, fwdPconnPool, Comm::IsConnOpen(), PconnPool::noteUses(), and serverConn.

Referenced by HandleStoreAbort(), and ~FwdState().

◆ complete()

void FwdState::complete ( )

FooClient modules call fwdComplete() when they are done downloading an object. Then, we either 1) re-forward the request somewhere else if needed, or 2) call storeComplete() to finish it off

Definition at line 526 of file FwdState.cc.

References MemObject::baseReply(), completed(), debugs, destinationReceipt, entry, Comm::IsConnOpen(), logReplyStatus(), StoreEntry::mem(), StoreEntry::mem_obj, n_tries, reforward(), StoreEntry::reset(), serverConn, serverConnection(), HttpReply::sline, Http::StatusLine::status(), stopAndDestroy(), storedWholeReply_, unregister(), StoreEntry::url(), useDestinations(), and waitingForDispatched.

Referenced by Client::completeForwarding(), connectedToPeer(), dispatch(), and WhoisState::readReply().

◆ completed()

void FwdState::completed ( )
private

Definition at line 256 of file FwdState.cc.

References al, assert, CallJobHere1, HttpRequest::clientConnectionManager, StoreEntry::completeSuccessfully(), StoreEntry::completeTruncated(), DBG_IMPORTANT, debugs, EBIT_TEST, entry, ENTRY_ABORTED, ENTRY_FWD_HDR_WAIT, err, ERR_READ_ERROR, errorAppendEntry(), fail(), HttpRequest::flags, flags, StoreEntry::flags, ConnStateData::httpsPeeked(), StoreEntry::isEmpty(), StoreEntry::mem_obj, request, Http::scBadGateway, RequestFlags::sslPeek, STORE_PENDING, StoreEntry::store_status, storedWholeReply_, storePendingNClients(), and updateAleWithFinalError().

Referenced by complete(), and ~FwdState().

◆ connectDone()

void FwdState::connectDone ( const Comm::ConnectionPointer &  conn,
Comm::Flag  status,
int  xerrno 
)

◆ connectedToPeer()

void FwdState::connectedToPeer ( Security::EncryptorAnswer &  answer)
private

Definition at line 1014 of file FwdState.cc.

References StoreEntry::abort(), al, assert, CbcPointer< Cbc >::clear(), closePendingConnection(), complete(), Security::EncryptorAnswer::conn, encryptionWait, entry, ERR_CANNOT_FORWARD, Security::EncryptorAnswer::error, error(), fail(), Comm::Connection::fd, fd_table, flags, CbcPointer< Cbc >::get(), Comm::IsConnOpen(), request, retryOrBail(), Http::scServiceUnavailable, successfullyConnectedToPeer(), and Security::EncryptorAnswer::tunneled.

Referenced by secureConnectionToPeer().

◆ connectingTimeout()

time_t FwdState::connectingTimeout ( const Comm::ConnectionPointer &  conn) const
private
Returns
the time left for this connection to become connected or 1 second if it is less than one second left

Definition at line 1444 of file FwdState.cc.

References Comm::Connection::connectTimeout(), positiveTimeout(), and start_t.

Referenced by establishTunnelThruProxy(), and secureConnectionToPeer().

◆ connectStart()

void FwdState::connectStart ( )

Called after forwarding path selection (via peer select) has taken place and whenever forwarding needs to attempt a new connection (routing failover). We have a vector of possible localIP->remoteIP paths now ready to start being connected.

Definition at line 1115 of file FwdState.cc.

References SquidConfig::accessList, ACLFilledChecklist::al, al, Acl::Answer::allowed(), assert, asyncCallback, checkRetriable(), HttpRequest::clearError(), Config, debugs, destinations, ResolvedPeers::empty(), entry, err, ACLChecklist::fastCheck(), AnyP::Uri::host(), Must, n_tries, noteConnection(), ResolvedPeers::notificationPending, pconnRace, HttpRequest::pinnedConnection(), raceHappened, request, SquidConfig::serverPconnForNonretriable, JobWait< Job >::start(), start_t, ACLFilledChecklist::syncAle(), transporting(), transportWait, HttpRequest::url, and StoreEntry::url().

Referenced by useDestinations().

◆ dispatch()

void FwdState::dispatch ( )

Definition at line 1186 of file FwdState.cc.

References StoreEntry::abort(), al, assert, CallJobHere1, clientConn, HttpRequest::clientConnectionManager, Comm::Connection::close(), complete(), DBG_IMPORTANT, debugs, Ip::Qos::dirOpened, EBIT_SET, entry, ENTRY_DISPATCHED, ERR_UNSUP_REQ, fail(), fatal_dump(), Comm::Connection::fd, fd_note(), fd_table, HttpRequest::flags, flags, StoreEntry::flags, RequestFlags::ftpNative, Ip::Qos::getNfConnmark(), AnyP::Uri::getScheme(), Ip::Qos::getTosFromServer(), AnyP::Uri::host(), ConnStateData::httpsPeeked(), httpStart(), Comm::IsConnOpen(), StoreEntry::locked(), HttpRequest::method, netdbPingSite(), fde::nfConnmarkFromServer, StoreEntry::ping_status, PING_WAITING, HttpRequest::prepForDirect(), HttpRequest::prepForPeering(), AnyP::PROTO_FTP, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, AnyP::PROTO_URN, AnyP::PROTO_WAIS, AnyP::PROTO_WHOIS, request, Http::scBadRequest, serverConn, serverConnection(), RequestFlags::sslPeek, Ftp::StartGateway(), Ftp::StartRelay(), Ip::Qos::TheConfig, unregister(), HttpRequest::url, StoreEntry::url(), waitingForDispatched, and whoisStart().

Referenced by noteConnection(), successfullyConnectedToPeer(), and usePinned().

◆ doneWithRetries()

void FwdState::doneWithRetries ( )
private

Definition at line 796 of file FwdState.cc.

References Http::Message::body_pipe, BodyPipe::expectNoConsumption(), and request.

Referenced by retryOrBail(), and ~FwdState().

◆ dontRetry() [1/2]

bool FwdState::dontRetry ( )
inline

Definition at line 130 of file FwdState.h.

References flags.

Referenced by HttpStateData::continueAfterParsingHeader(), Client::handleAdaptationBlocked(), Client::handledEarlyAdaptationAbort(), Client::handleRequestBodyProducerAborted(), and Client::sendBodyIsTooLargeError().

◆ dontRetry() [2/2]

void FwdState::dontRetry ( bool  val)
inline

Definition at line 132 of file FwdState.h.

References flags.

◆ EnoughTimeToReForward()

bool FwdState::EnoughTimeToReForward ( const time_t  fwdStart)
static

Whether there is still time to re-try after a previous connection failure.

Parameters
fwdStartThe start time of the peer selection/connection process.

Definition at line 431 of file FwdState.cc.

References ForwardTimeout(), and fwdStart().

Referenced by checkRetry(), and TunnelStateData::checkRetry().

◆ establishTunnelThruProxy()

void FwdState::establishTunnelThruProxy ( const Comm::ConnectionPointer &  conn)
private

Definition at line 908 of file FwdState.cc.

References al, asyncCallback, connectingTimeout(), entry, Comm::Connection::getPeer(), StoreEntry::mem_obj, MemObject::mostBytesAllowed(), Must, CachePeer::no_delay, CachePeer::options, peerWait, request, JobWait< Job >::start(), and tunnelEstablishmentDone().

◆ exhaustedTries()

bool FwdState::exhaustedTries ( ) const
private

Definition at line 1416 of file FwdState.cc.

References Config, SquidConfig::forward_max_tries, and n_tries.

Referenced by checkRetry(), and reforward().

◆ fail()

void FwdState::fail ( ErrorState *  err)

Definition at line 458 of file FwdState.cc.

References debugs, destinationReceipt, err, ERR_ZERO_SIZE_OBJECT, reactToZeroSizeObject(), ErrorState::request, request, and ErrorState::type.

Referenced by advanceDestination(), completed(), connectedToPeer(), HttpStateData::continueAfterParsingHeader(), dispatch(), HttpStateData::drop1xx(), Client::handleAdaptationBlocked(), Client::handledEarlyAdaptationAbort(), HttpStateData::handleRequestBodyProducerAborted(), HttpStateData::httpTimeout(), HttpStateData::markPrematureReplyBodyEofFailure(), noteConnection(), noteDestinationsEnd(), WhoisState::readReply(), HttpStateData::readReply(), Client::sendBodyIsTooLargeError(), Client::sentRequestBody(), tunnelEstablishmentDone(), useDestinations(), usePinned(), and HttpStateData::wroteLast().

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )
privatepure virtualinherited

◆ ForwardTimeout()

time_t FwdState::ForwardTimeout ( const time_t  fwdStart)
static

Definition at line 423 of file FwdState.cc.

References Config, diffOrZero(), SquidConfig::forward, fwdStart(), squid_curtime, and SquidConfig::Timeout.

Referenced by Comm::Connection::connectTimeout(), EnoughTimeToReForward(), and HappyConnOpener::ranOutOfTimeOrAttempts().

◆ fwdStart()

void FwdState::fwdStart ( const Comm::ConnectionPointer &  client,
StoreEntry *  entry,
HttpRequest *  request 
)
static

Definition at line 407 of file FwdState.cc.

References clientConn, entry, request, and Start().

Referenced by asnCacheStart(), EnoughTimeToReForward(), ForwardTimeout(), netdbExchangeStart(), and peerDigestRequest().

◆ HandleStoreAbort()

void FwdState::HandleStoreAbort ( FwdState *  fwd)
static

Definition at line 83 of file FwdState.cc.

References closeServerConnection(), debugs, Comm::IsConnOpen(), serverConnection(), and stopAndDestroy().

Referenced by start().

◆ handleUnregisteredServerEnd()

void FwdState::handleUnregisteredServerEnd ( )

Definition at line 804 of file FwdState.cc.

References assert, debugs, destinationReceipt, entry, err, Comm::IsConnOpen(), retryOrBail(), serverConn, StoreEntry::url(), and waitingForDispatched.

Referenced by Client::swanSong().

◆ initModule()

void FwdState::initModule ( )
static

Definition at line 1390 of file FwdState.cc.

References RegisterWithCacheManager().

Referenced by mainInitialize().

◆ logReplyStatus()

void FwdState::logReplyStatus ( int  tries,
const Http::StatusCode  status 
)
staticprivate

Definition at line 1402 of file FwdState.cc.

References assert, FwdReplyCodes, MAX_FWD_STATS_IDX, and Http::scInvalidHeader.

Referenced by complete().

◆ makeConnectingError()

ErrorState* FwdState::makeConnectingError ( const err_type  type) const
private

◆ markStoredReplyAsWhole()

void FwdState::markStoredReplyAsWhole ( const char *  whyWeAreSure)

Mark reply as written to Store in its entirety, including the header and any body. If the reply has a body, the entire body has to be stored.

Definition at line 575 of file FwdState.cc.

References debugs, EBIT_TEST, entry, ENTRY_ABORTED, StoreEntry::flags, and storedWholeReply_.

Referenced by Client::endAdaptedBodyConsumption(), Client::handleAdaptedHeader(), Client::markParsedVirginReplyAsWhole(), and WhoisState::readReply().

◆ noteConnection()

void FwdState::noteConnection ( HappyConnOpenerAnswer &  answer)
private

called when a to-peer connection has been successfully obtained or when all candidate destinations have been tried and all have failed

Definition at line 840 of file FwdState.cc.

References advanceDestination(), al, assert, CbcPointer< Cbc >::clear(), closePendingConnection(), HappyConnOpenerAnswer::conn, destinationReceipt, dispatch(), ERR_CANNOT_FORWARD, HappyConnOpenerAnswer::error, error(), fail(), Comm::Connection::fd, fd_table, HttpRequest::flags, flags, CbcPointer< Cbc >::get(), Comm::Connection::getPeer(), AnyP::Uri::host(), Comm::IsConnOpen(), HttpRequest::method, Http::METHOD_CONNECT, Must, HappyConnOpenerAnswer::n_tries, request, retryOrBail(), HappyConnOpenerAnswer::reused, Http::scServiceUnavailable, secureConnectionToPeerIfNeeded(), RequestFlags::sslBumped, RequestFlags::sslPeek, syncHierNote(), syncWithServerConn(), transportWait, updateAttempts(), and HttpRequest::url.

Referenced by connectStart().

◆ noteDestination()

void FwdState::noteDestination ( Comm::ConnectionPointer  path)
overrideprivatevirtual

Implements PeerSelectionInitiator.

Definition at line 587 of file FwdState.cc.

References ResolvedPeers::addPath(), assert, debugs, destinations, ResolvedPeers::empty(), flags, notifyConnOpener(), transporting(), transportWait, useDestinations(), and usePinned().

◆ noteDestinationsEnd()

void FwdState::noteDestinationsEnd ( ErrorState *  error)
overrideprivatevirtual

called when there will be no more noteDestination() calls

Parameters
erroris a possible reason why no destinations were found; it is guaranteed to be nil if there was at least one noteDestination() call

Implements PeerSelectionInitiator.

Definition at line 616 of file FwdState.cc.

References al, assert, debugs, destinations, ResolvedPeers::destinationsFinalized, err, ERR_CANNOT_FORWARD, fail(), flags, MakeNamedErrorDetail(), Must, n_tries, notifyConnOpener(), request, Http::scBadGateway, stopAndDestroy(), PeerSelectionInitiator::subscribed, transporting(), and transportWait.

◆ notifyConnOpener()

void FwdState::notifyConnOpener ( )
private

Definition at line 661 of file FwdState.cc.

References CallJobHere, debugs, destinations, JobWait< Job >::job(), ResolvedPeers::notificationPending, and transportWait.

Referenced by noteDestination(), and noteDestinationsEnd().

◆ pconnPush()

void FwdState::pconnPush ( Comm::ConnectionPointer &  conn,
const char *  domain 
)

◆ pinnedCanRetry()

bool FwdState::pinnedCanRetry ( ) const
private

whether a pinned to-peer connection can be replaced with another one (in order to retry or reforward a failed request)

Definition at line 1422 of file FwdState.cc.

References assert, HttpRequest::flags, pconnRace, RequestFlags::pinned, raceHappened, request, and RequestFlags::sslBumped.

Referenced by checkRetry(), and reforward().

◆ reactToZeroSizeObject()

void FwdState::reactToZeroSizeObject ( )
private

Definition at line 476 of file FwdState.cc.

References assert, debugs, destinationReceipt, destinations, err, ERR_ZERO_SIZE_OBJECT, pconnRace, HttpRequest::pinnedConnection(), raceHappened, racePossible, ResolvedPeers::reinstatePath(), request, and ErrorState::type.

Referenced by fail().

◆ reforward()

int FwdState::reforward ( )

Definition at line 1308 of file FwdState.cc.

References assert, MemObject::baseReply(), HttpRequest::bodyNibbled(), debugs, destinations, EBIT_TEST, ResolvedPeers::empty(), entry, ENTRY_ABORTED, ENTRY_FWD_HDR_WAIT, exhaustedTries(), HttpRequest::flags, StoreEntry::flags, Http::IsReforwardableStatus(), StoreEntry::mem(), StoreEntry::mem_obj, RequestFlags::pinned, pinnedCanRetry(), request, HttpReply::sline, Http::StatusLine::status(), STORE_PENDING, StoreEntry::store_status, PeerSelectionInitiator::subscribed, and StoreEntry::url().

Referenced by complete().

◆ RegisterWithCacheManager()

void FwdState::RegisterWithCacheManager ( void  )
staticprivate

Definition at line 1396 of file FwdState.cc.

References fwdStats, and Mgr::RegisterAction().

Referenced by initModule().

◆ retryOrBail()

void FwdState::retryOrBail ( )
private

Definition at line 773 of file FwdState.cc.

References al, checkRetry(), debugs, doneWithRetries(), entry, err, ERR_SHUTTING_DOWN, errorAppendEntry(), StoreEntry::isEmpty(), n_tries, request, Http::scServiceUnavailable, shutting_down, squid_curtime, start_t, stopAndDestroy(), and useDestinations().

Referenced by advanceDestination(), connectedToPeer(), handleUnregisteredServerEnd(), noteConnection(), serverClosed(), and tunnelEstablishmentDone().

◆ secureConnectionToPeer()

void FwdState::secureConnectionToPeer ( const Comm::ConnectionPointer &  conn)
private

Definition at line 996 of file FwdState.cc.

References al, asyncCallback, clientConn, connectedToPeer(), connectingTimeout(), encryptionWait, HttpRequest::flags, Security::PeerConnector::noteFwdPconnUse, request, RequestFlags::sslPeek, and JobWait< Job >::start().

Referenced by secureConnectionToPeerIfNeeded().

◆ secureConnectionToPeerIfNeeded()

void FwdState::secureConnectionToPeerIfNeeded ( const Comm::ConnectionPointer &  conn)
private

Definition at line 967 of file FwdState.cc.

References advanceDestination(), assert, Security::PeerOptions::encryptTransport, HttpRequest::flags, Comm::Connection::getPeer(), AnyP::Uri::getScheme(), HttpRequest::method, Http::METHOD_CONNECT, RequestFlags::pinned, AnyP::PROTO_HTTPS, request, CachePeer::secure, secureConnectionToPeer(), RequestFlags::sslBumped, RequestFlags::sslPeek, successfullyConnectedToPeer(), and HttpRequest::url.

Referenced by noteConnection(), and tunnelEstablishmentDone().

◆ serverClosed()

void FwdState::serverClosed ( )

Definition at line 748 of file FwdState.cc.

References closeHandler, debugs, destinationReceipt, Comm::Connection::fd, fd_table, fwdPconnPool, Comm::IsConnOpen(), Comm::Connection::noteClosure(), PconnPool::noteUses(), retryOrBail(), serverConn, and waitingForDispatched.

Referenced by fwdServerClosedWrapper().

◆ serverConnection()

const Comm::ConnectionPointer& FwdState::serverConnection ( ) const
inline

return a ConnectionPointer to the current server connection (may or may not be open)

Definition at line 138 of file FwdState.h.

References serverConn.

Referenced by Ftp::Client::Client(), complete(), dispatch(), HandleStoreAbort(), HttpStateData::HttpStateData(), successfullyConnectedToPeer(), unregister(), and whoisStart().

◆ Start()

void FwdState::Start ( const Comm::ConnectionPointer &  clientConn,
StoreEntry *  entry,
HttpRequest *  request,
const AccessLogEntryPointer &  al 
)
static

This is the entry point for client-side to start forwarding a transaction. It is a static method that may or may not allocate a FwdState.

Note
client_addr == no_addr indicates this is an "internal" request from peer_digest.c, asn.c, netdb.c, etc and should always be allowed. yuck, I know.

Check if this host is allowed to fetch MISSES from us (miss_access). Intentionally replace the src_addr automatically selected by the checklist code we do NOT want the indirect client address to be tested here.

Definition at line 338 of file FwdState.cc.

References SquidConfig::accessList, ACLFilledChecklist::al, al, HttpRequest::client_addr, clientConn, Config, ACLChecklist::currentAnswer(), debugs, Acl::Answer::denied(), entry, ERR_FORWARDING_DENIED, ERR_NONE, ERR_SHUTTING_DOWN, errorAppendEntry(), ACLChecklist::fastCheck(), FindDenyInfoPage(), HttpRequest::flags, FwdState(), AnyP::Uri::getScheme(), RequestFlags::internal, internalStart(), Ip::Address::isNoAddr(), StoreEntry::mem_obj, SquidConfig::miss, AnyP::PROTO_URN, request, MemObject::request, Http::scForbidden, Http::scServiceUnavailable, shutting_down, ACLFilledChecklist::src_addr, start(), ACLFilledChecklist::syncAle(), HttpRequest::url, StoreEntry::url(), and urnStart().

Referenced by fwdStart(), ConnStateData::parseTlsHandshake(), clientReplyContext::processExpired(), clientReplyContext::processMiss(), UrnState::start(), and ConnStateData::startPeekAndSplice().

◆ start()

void FwdState::start ( Pointer  aSelf)
private

Definition at line 145 of file FwdState.cc.

References al, asyncCall(), cbdataDialer(), SquidConfig::client_dst_passthru, Config, entry, HttpRequest::flags, RequestFlags::ftpNative, HandleStoreAbort(), RequestFlags::hostVerified, RequestFlags::intercepted, RequestFlags::interceptTproxy, SquidConfig::onoff, RequestFlags::pinned, RequestFlags::redirected, StoreEntry::registerAbortCallback(), request, and PeerSelectionInitiator::startSelectingDestinations().

Referenced by Start().

◆ startSelectingDestinations()

void PeerSelectionInitiator::startSelectingDestinations ( HttpRequest *  request,
const AccessLogEntry::Pointer &  ale,
StoreEntry *  entry 
)
inherited

Initiates asynchronous peer selection that eventually results in zero or more noteDestination() calls and exactly one noteDestinationsEnd() call.

Definition at line 330 of file peer_select.cc.

References peerSelect(), and PeerSelectionInitiator::subscribed.

Referenced by start(), and tunnelStart().

◆ stopAndDestroy()

void FwdState::stopAndDestroy ( const char *  reason)
private

Definition at line 184 of file FwdState.cc.

References cancelStep(), debugs, peeringTimer, PeeringActivityTimer::stop(), and PeerSelectionInitiator::subscribed.

Referenced by complete(), HandleStoreAbort(), noteDestinationsEnd(), retryOrBail(), useDestinations(), and usePinned().

◆ successfullyConnectedToPeer()

void FwdState::successfullyConnectedToPeer ( const Comm::ConnectionPointer &  conn)
private

Definition at line 1050 of file FwdState.cc.

References CallJobHere1, HttpRequest::clientConnectionManager, dispatch(), AnyP::Uri::host(), NoteOutgoingConnectionSuccess(), ConnStateData::notePeerConnection(), request, serverConnection(), syncWithServerConn(), and HttpRequest::url.

Referenced by connectedToPeer(), and secureConnectionToPeerIfNeeded().

◆ syncHierNote()

void FwdState::syncHierNote ( const Comm::ConnectionPointer &  server,
const char *  host 
)
private

Definition at line 1085 of file FwdState.cc.

References al, HttpRequest::hier, AccessLogEntry::hier, request, HierarchyLogEntry::resetPeerNotes(), and server.

Referenced by noteConnection(), syncWithServerConn(), and usePinned().

◆ syncWithServerConn()

void FwdState::syncWithServerConn ( const Comm::ConnectionPointer &  server,
const char *  host,
const bool  reused 
)
private

Definition at line 1065 of file FwdState.cc.

References closeHandler, comm_add_close_handler(), Comm::Connection::fd, fwdServerClosedWrapper, Comm::IsConnOpen(), Must, pconnRace, raceImpossible, racePossible, request, ResetMarkingsToServer(), serverConn, and syncHierNote().

Referenced by noteConnection(), successfullyConnectedToPeer(), and usePinned().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

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

◆ transporting()

bool FwdState::transporting ( ) const
private

Whether a forwarding attempt to some selected destination X is in progress (after successfully opening/reusing a transport connection to X). See also: transportWait

Definition at line 569 of file FwdState.cc.

References encryptionWait, peerWait, and waitingForDispatched.

Referenced by connectStart(), noteDestination(), and noteDestinationsEnd().

◆ tunnelEstablishmentDone()

void FwdState::tunnelEstablishmentDone ( Http::TunnelerAnswer &  answer)
private

Definition at line 929 of file FwdState.cc.

References al, CbcPointer< Cbc >::clear(), closePendingConnection(), Http::TunnelerAnswer::conn, DBG_IMPORTANT, debugs, ERR_CANNOT_FORWARD, ERR_CONNECT_FAIL, error(), fail(), Comm::Connection::fd, fd_table, CbcPointer< Cbc >::get(), Comm::IsConnOpen(), SBuf::isEmpty(), Http::TunnelerAnswer::leftovers, SBuf::length(), Must, peerWait, Http::TunnelerAnswer::positive(), request, retryOrBail(), Http::scBadGateway, Http::scServiceUnavailable, secureConnectionToPeerIfNeeded(), and Http::TunnelerAnswer::squidError.

Referenced by establishTunnelThruProxy().

◆ unregister() [1/2]

void FwdState::unregister ( Comm::ConnectionPointer &  conn)

Frees fwdState without closing FD or generating an abort

Definition at line 499 of file FwdState.cc.

References assert, closeHandler, comm_remove_close_handler(), debugs, destinationReceipt, entry, Comm::Connection::fd, Comm::IsConnOpen(), serverConn, serverConnection(), and StoreEntry::url().

Referenced by HttpStateData::closeServer(), complete(), dispatch(), HttpStateData::proceedAfter1xx(), HttpStateData::processReplyBody(), and unregister().

◆ unregister() [2/2]

void FwdState::unregister ( int  fd)

Definition at line 512 of file FwdState.cc.

References assert, debugs, entry, serverConn, serverConnection(), unregister(), and StoreEntry::url().

◆ updateAleWithFinalError()

void FwdState::updateAleWithFinalError ( )
private

Definition at line 241 of file FwdState.cc.

References al, AccessLogEntry::cache, AccessLogEntry::CacheDetails::code, ErrorState::detail, ErrorState::detailError(), LogTags::err, err, ERR_READ_TIMEOUT, Helper::Error, LogTagsErrors::FromErrno(), MakeNamedErrorDetail(), ErrorState::type, LogTagsErrors::update(), AccessLogEntry::updateError(), and ErrorState::xerrno.

Referenced by completed().

◆ updateAttempts()

void FwdState::updateAttempts ( int  newValue)
private

Definition at line 1095 of file FwdState.cc.

References al, Assure, debugs, n_tries, and AccessLogEntry::requestAttempts.

Referenced by noteConnection(), and usePinned().

◆ useDestinations()

void FwdState::useDestinations ( )

This is the real beginning of server connection. Call it whenever the forwarding server destination has changed and a new one needs to be opened. Produces the cannot-forward error on fail if no better error exists.

Definition at line 437 of file FwdState.cc.

References al, connectStart(), debugs, destinations, ResolvedPeers::empty(), entry, err, ERR_CANNOT_FORWARD, fail(), request, Http::scInternalServerError, stopAndDestroy(), PeerSelectionInitiator::subscribed, and StoreEntry::url().

Referenced by complete(), noteDestination(), and retryOrBail().

◆ usePinned()

void FwdState::usePinned ( )
private

Definition at line 1149 of file FwdState.cc.

References al, assert, RequestFlags::auth, ConnStateData::BorrowPinnedConnection(), debugs, dispatch(), fail(), HttpRequest::flags, AnyP::Uri::host(), n_tries, RequestFlags::pinned, HttpRequest::pinnedConnection(), request, serverConn, stopAndDestroy(), syncHierNote(), syncWithServerConn(), updateAttempts(), and HttpRequest::url.

Referenced by noteDestination().

Member Data Documentation

◆ al

AccessLogEntryPointer FwdState::al

Definition at line 204 of file FwdState.h.

Referenced by Client::adaptOrFinalizeReply(), advanceDestination(), Client::blockCaching(), HttpStateData::buildRequestPrefix(), completed(), connectedToPeer(), connectStart(), HttpStateData::continueAfterParsingHeader(), dispatch(), HttpStateData::drop1xx(), establishTunnelThruProxy(), HttpStateData::finishingBrokenPost(), HttpStateData::forwardUpgrade(), ftpFail(), ftpSendReply(), HttpStateData::handle1xx(), Client::handleAdaptationBlocked(), Client::handledEarlyAdaptationAbort(), HttpStateData::handleRequestBodyProducerAborted(), HttpStateData::httpTimeout(), HttpStateData::markPrematureReplyBodyEofFailure(), noteConnection(), noteDestinationsEnd(), WhoisState::readReply(), HttpStateData::readReply(), retryOrBail(), secureConnectionToPeer(), Client::sendBodyIsTooLargeError(), Client::sentRequestBody(), Client::setFinalReply(), Client::setVirginReply(), Start(), start(), Client::startAdaptation(), syncHierNote(), tunnelEstablishmentDone(), updateAleWithFinalError(), updateAttempts(), useDestinations(), usePinned(), and HttpStateData::wroteLast().

◆ clientConn

Comm::ConnectionPointer FwdState::clientConn
private

Definition at line 212 of file FwdState.h.

Referenced by dispatch(), fwdStart(), secureConnectionToPeer(), and Start().

◆ closeHandler

AsyncCall::Pointer FwdState::closeHandler
private

Definition at line 240 of file FwdState.h.

Referenced by closePendingConnection(), closeServerConnection(), serverClosed(), syncWithServerConn(), and unregister().

◆ connected_okay

bool FwdState::connected_okay

Definition at line 217 of file FwdState.h.

◆ destinationReceipt

PeerConnectionPointer FwdState::destinationReceipt
private

Definition at line 238 of file FwdState.h.

Referenced by complete(), fail(), handleUnregisteredServerEnd(), noteConnection(), reactToZeroSizeObject(), serverClosed(), and unregister().

◆ destinations

ResolvedPeersPointer FwdState::destinations
private

Definition at line 236 of file FwdState.h.

Referenced by connectStart(), noteDestination(), noteDestinationsEnd(), notifyConnOpener(), reactToZeroSizeObject(), reforward(), and useDestinations().

◆ destinationsFound

bool FwdState::destinationsFound

Definition at line 220 of file FwdState.h.

◆ dont_retry

bool FwdState::dont_retry

Definition at line 218 of file FwdState.h.

◆ encryptionWait

JobWait<Security::PeerConnector> FwdState::encryptionWait
private

Definition at line 227 of file FwdState.h.

Referenced by cancelStep(), connectedToPeer(), secureConnectionToPeer(), and transporting().

◆ entry

StoreEntry* FwdState::entry

Definition at line 202 of file FwdState.h.

Referenced by checkRetry(), Client::Client(), complete(), completed(), connectedToPeer(), connectStart(), dispatch(), establishTunnelThruProxy(), fwdStart(), handleUnregisteredServerEnd(), httpStart(), markStoredReplyAsWhole(), reforward(), retryOrBail(), Start(), start(), unregister(), useDestinations(), whoisStart(), and ~FwdState().

◆ err

ErrorState* FwdState::err
private

Definition at line 211 of file FwdState.h.

Referenced by advanceDestination(), completed(), connectStart(), fail(), handleUnregisteredServerEnd(), noteDestinationsEnd(), reactToZeroSizeObject(), retryOrBail(), updateAleWithFinalError(), useDestinations(), and ~FwdState().

◆ flags

struct { ... } FwdState::flags

Referenced by checkRetry(), completed(), connectedToPeer(), dispatch(), dontRetry(), FwdState(), noteConnection(), noteDestination(), noteDestinationsEnd(), and ~FwdState().

◆ forward_completed

bool FwdState::forward_completed

Definition at line 219 of file FwdState.h.

◆ n_tries

int FwdState::n_tries
private

Definition at line 214 of file FwdState.h.

Referenced by complete(), connectStart(), exhaustedTries(), noteDestinationsEnd(), retryOrBail(), updateAttempts(), and usePinned().

◆ pconnRace

PconnRace FwdState::pconnRace
private

Definition at line 244 of file FwdState.h.

Referenced by connectStart(), pinnedCanRetry(), reactToZeroSizeObject(), and syncWithServerConn().

◆ peeringTimer

PeeringActivityTimer FwdState::peeringTimer
private

Definition at line 251 of file FwdState.h.

Referenced by stopAndDestroy().

◆ peerWait

JobWait<Http::Tunneler> FwdState::peerWait
private

waits for an HTTP CONNECT tunnel through a cache_peer to be negotiated over the (encrypted, if needed) transport connection to that cache_peer

Definition at line 231 of file FwdState.h.

Referenced by cancelStep(), establishTunnelThruProxy(), transporting(), and tunnelEstablishmentDone().

◆ request

HttpRequest* FwdState::request

Definition at line 203 of file FwdState.h.

Referenced by advanceDestination(), checkRetriable(), checkRetry(), completed(), connectedToPeer(), connectStart(), HttpStateData::continueAfterParsingHeader(), dispatch(), doneWithRetries(), establishTunnelThruProxy(), fail(), ftpFail(), fwdStart(), FwdState(), HttpStateData::handleRequestBodyProducerAborted(), httpStart(), HttpStateData::httpTimeout(), HttpStateData::markPrematureReplyBodyEofFailure(), noteConnection(), noteDestinationsEnd(), pinnedCanRetry(), reactToZeroSizeObject(), WhoisState::readReply(), HttpStateData::readReply(), reforward(), retryOrBail(), secureConnectionToPeer(), secureConnectionToPeerIfNeeded(), Client::sentRequestBody(), Start(), start(), successfullyConnectedToPeer(), syncHierNote(), syncWithServerConn(), tunnelEstablishmentDone(), useDestinations(), usePinned(), whoisStart(), HttpStateData::wroteLast(), and ~FwdState().

◆ self

Pointer FwdState::self
private

Definition at line 210 of file FwdState.h.

◆ serverConn

Comm::ConnectionPointer FwdState::serverConn
private

Definition at line 237 of file FwdState.h.

Referenced by closePendingConnection(), closeServerConnection(), complete(), dispatch(), handleUnregisteredServerEnd(), serverClosed(), serverConnection(), syncWithServerConn(), unregister(), usePinned(), and ~FwdState().

◆ start_t

time_t FwdState::start_t
private

Definition at line 213 of file FwdState.h.

Referenced by checkRetry(), connectingTimeout(), connectStart(), and retryOrBail().

◆ storedWholeReply_

const char* FwdState::storedWholeReply_
private

Whether the entire reply (including any body) was written to Store. The string literal value is only used for debugging.

Definition at line 248 of file FwdState.h.

Referenced by complete(), completed(), and markStoredReplyAsWhole().

◆ subscribed

bool PeerSelectionInitiator::subscribed = false
inherited

Definition at line 46 of file PeerSelectState.h.

Referenced by TunnelStateData::commitToServer(), noteDestinationsEnd(), TunnelStateData::noteDestinationsEnd(), reforward(), TunnelStateData::retryOrBail(), TunnelStateData::sendError(), PeerSelectionInitiator::startSelectingDestinations(), stopAndDestroy(), and useDestinations().

◆ transportWait

JobWait<HappyConnOpener> FwdState::transportWait
private

Definition at line 224 of file FwdState.h.

Referenced by cancelStep(), connectStart(), noteConnection(), noteDestination(), noteDestinationsEnd(), and notifyConnOpener().

◆ waitingForDispatched

bool FwdState::waitingForDispatched
private

Definition at line 234 of file FwdState.h.

Referenced by complete(), dispatch(), handleUnregisteredServerEnd(), serverClosed(), and transporting().

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

 

Introduction

Documentation

Support

Miscellaneous