#include <FwdState.h>

Inheritance diagram for FwdState:
Collaboration diagram for FwdState:

Public Types

typedef RefCount< FwdStatePointer
 

Public Member Functions

virtual ~FwdState ()
 
void useDestinations ()
 
void fail (ErrorState *err)
 
void unregister (Comm::ConnectionPointer &conn)
 
void unregister (int fd)
 
void complete ()
 
void handleUnregisteredServerEnd ()
 
int reforward ()
 
bool reforwardableStatus (const Http::StatusCode s) const
 
void serverClosed (int fd)
 
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)
 
Comm::ConnectionPointer const & 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 abort (void *)
 

Public Attributes

StoreEntryentry
 
HttpRequestrequest
 
AccessLogEntryPointer al
 info for the future access.log entry More...
 
bool subscribed = false
 whether noteDestination() and noteDestinationsEnd() calls are allowed More...
 
AsyncCall::Pointer connector
 a call linking us to the ConnOpener producing serverConn. 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...
 
virtual void noteDestination (Comm::ConnectionPointer conn) override
 called when a new unique destination has been found More...
 
virtual void noteDestinationsEnd (ErrorState *selectionError) override
 
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
 
ErrorStatemakeConnectingError (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 ()
 
void tunnelEstablishmentDone (Http::TunnelerAnswer &answer)
 resumes operations after the (possibly failed) HTTP CONNECT exchange More...
 
void secureConnectionToPeerIfNeeded ()
 handles an established TCP connection to peer (including origin servers) More...
 
void successfullyConnectedToPeer ()
 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...
 
time_t connectingTimeout (const Comm::ConnectionPointer &conn) const
 
bool opening () const
 
void cancelOpening (const char *reason)
 
void notifyConnOpener ()
 makes sure connOpener knows that destinations have changed More...
 

Static Private Member Functions

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

Private Attributes

Pointer self
 
ErrorStateerr
 
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 {
   AsyncCall::Pointer   connector
 a call linking us to the ConnOpener producing serverConn. More...
 
calls
 
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
 
HappyConnOpenerPointer connOpener
 current connection opening job More...
 
ResolvedPeersPointer destinations
 paths for forwarding the request More...
 
Comm::ConnectionPointer serverConn
 a successfully opened connection to a server. More...
 
AsyncCall::Pointer closeHandler
 The serverConn close handler. More...
 
PconnRace pconnRace
 current pconn race state More...
 

Detailed Description

Definition at line 61 of file FwdState.h.

Member Typedef Documentation

◆ Pointer

Definition at line 66 of file FwdState.h.

Member Enumeration Documentation

◆ PconnRace

enum FwdState::PconnRace
private
Enumerator
raceImpossible 
racePossible 
raceHappened 

Definition at line 196 of file FwdState.h.

Constructor & Destructor Documentation

◆ ~FwdState()

◆ FwdState()

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

Definition at line 133 of file FwdState.cc.

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

Referenced by Start().

Member Function Documentation

◆ abort()

void FwdState::abort ( void *  d)
static

Definition at line 108 of file FwdState.cc.

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

Referenced by start().

◆ cancelOpening()

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

Notify connOpener that we no longer need connections. We do not have to do this – connOpener would eventually notice on its own, but notifying reduces waste and speeds up spare connection opening for other transactions (that could otherwise wait for this transaction to use its spare allowance).

Definition at line 209 of file FwdState.cc.

References ResolvedPeers::addPath(), assert, calls, CbcPointer< Cbc >::clear(), clientConn, connOpener, debugs, destinations, ResolvedPeers::destinationsFinalized, entry, getOutgoingAddress(), HERE(), Comm::Connection::local, notifyConnOpener(), ORIGINAL_DST, p, PING_DONE, StoreEntry::ping_status, HttpRequest::pinnedConnection(), request, PeerSelectionInitiator::subscribed, useDestinations(), and usePinned().

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

◆ CBDATA_CHILD()

FwdState::CBDATA_CHILD ( FwdState  )
private

◆ checkRetriable()

bool FwdState::checkRetriable ( )

◆ checkRetry()

◆ closeServerConnection()

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

◆ 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 512 of file FwdState.cc.

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

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

◆ completed()

◆ connectDone()

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

◆ connectedToPeer()

◆ 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 1319 of file FwdState.cc.

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

Referenced by establishTunnelThruProxy(), and secureConnectionToPeerIfNeeded().

◆ connectStart()

void FwdState::connectStart ( )

◆ dispatch()

◆ doneWithRetries()

void FwdState::doneWithRetries ( )
private

Definition at line 741 of file FwdState.cc.

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

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

◆ dontRetry() [1/2]

◆ dontRetry() [2/2]

void FwdState::dontRetry ( bool  val)
inline

Definition at line 103 of file FwdState.h.

◆ 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 430 of file FwdState.cc.

References ForwardTimeout().

Referenced by checkRetry().

◆ establishTunnelThruProxy()

void FwdState::establishTunnelThruProxy ( )
private

◆ exhaustedTries()

bool FwdState::exhaustedTries ( ) const
private

Definition at line 1291 of file FwdState.cc.

References Config, SquidConfig::forward_max_tries, and n_tries.

Referenced by checkRetry(), and reforward().

◆ fail()

◆ ForwardTimeout()

time_t FwdState::ForwardTimeout ( const time_t  fwdStart)
static

◆ fwdStart()

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

Definition at line 406 of file FwdState.cc.

References NULL, and Start().

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

◆ handleUnregisteredServerEnd()

void FwdState::handleUnregisteredServerEnd ( )

Definition at line 749 of file FwdState.cc.

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

Referenced by Client::swanSong().

◆ initModule()

void FwdState::initModule ( )
static

Definition at line 1265 of file FwdState.cc.

References RegisterWithCacheManager().

Referenced by mainInitialize().

◆ logReplyStatus()

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

Definition at line 1277 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

◆ noteConnection()

◆ noteDestination()

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

◆ 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 581 of file FwdState.cc.

References debugs, destinations, ResolvedPeers::destinationsFinalized, err, fail(), flags, Comm::IsConnOpen(), Must, notifyConnOpener(), opening(), serverConn, PeerSelectionInitiator::subscribed, and useDestinations().

◆ notifyConnOpener()

void FwdState::notifyConnOpener ( )
private

◆ opening()

bool FwdState::opening ( ) const
inlineprivate

whether we are waiting for HappyConnOpener same as calls.connector but may differ from connOpener.valid()

Definition at line 157 of file FwdState.h.

Referenced by connectStart(), noteDestination(), noteDestinationsEnd(), stopAndDestroy(), and ~FwdState().

◆ 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 1297 of file FwdState.cc.

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

Referenced by checkRetry(), and reforward().

◆ reforward()

◆ reforwardableStatus()

◆ RegisterWithCacheManager()

void FwdState::RegisterWithCacheManager ( void  )
staticprivate

Definition at line 1271 of file FwdState.cc.

References fwdStats, and Mgr::RegisterAction().

Referenced by initModule().

◆ retryOrBail()

◆ secureConnectionToPeerIfNeeded()

◆ serverClosed()

void FwdState::serverClosed ( int  fd)

◆ serverConnection()

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

◆ 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 329 of file FwdState.cc.

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

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

◆ 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 193 of file peer_select.cc.

References peerSelect().

Referenced by start(), and tunnelStart().

◆ stopAndDestroy()

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

◆ successfullyConnectedToPeer()

void FwdState::successfullyConnectedToPeer ( )
private

◆ syncHierNote()

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

◆ syncWithServerConn()

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

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

◆ tunnelEstablishmentDone()

◆ unregister() [1/2]

◆ unregister() [2/2]

void FwdState::unregister ( int  fd)

◆ 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 436 of file FwdState.cc.

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

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

◆ usePinned()

Member Data Documentation

◆ al

◆ calls

struct { ... } FwdState::calls

◆ clientConn

Comm::ConnectionPointer FwdState::clientConn
private

Definition at line 173 of file FwdState.h.

Referenced by cancelOpening(), dispatch(), and secureConnectionToPeerIfNeeded().

◆ closeHandler

AsyncCall::Pointer FwdState::closeHandler
private

Definition at line 193 of file FwdState.h.

Referenced by syncWithServerConn(), and unregister().

◆ connected_okay

bool FwdState::connected_okay

Definition at line 183 of file FwdState.h.

◆ connector

AsyncCall::Pointer FwdState::connector

Definition at line 179 of file FwdState.h.

Referenced by secureConnectionToPeerIfNeeded().

◆ connOpener

HappyConnOpenerPointer FwdState::connOpener
private

Definition at line 189 of file FwdState.h.

Referenced by cancelOpening(), connectStart(), noteConnection(), and notifyConnOpener().

◆ destinations

◆ destinationsFound

bool FwdState::destinationsFound

Definition at line 186 of file FwdState.h.

◆ dont_retry

bool FwdState::dont_retry

Definition at line 184 of file FwdState.h.

◆ entry

◆ err

◆ flags

◆ forward_completed

bool FwdState::forward_completed

Definition at line 185 of file FwdState.h.

◆ n_tries

int FwdState::n_tries
private

◆ pconnRace

PconnRace FwdState::pconnRace
private

Definition at line 197 of file FwdState.h.

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

◆ request

◆ self

Pointer FwdState::self
private

Definition at line 171 of file FwdState.h.

◆ serverConn

◆ start_t

time_t FwdState::start_t
private

Definition at line 174 of file FwdState.h.

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

◆ subscribed

bool PeerSelectionInitiator::subscribed = false
inherited

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors