#include <PeerSelectState.h>

Inheritance diagram for PeerSelector:

Collaboration diagram for PeerSelector:

[legend]

Public Member Functions
	PeerSelector (PeerSelectionInitiator *)

	~PeerSelector () override

void	noteIp (const Ip::Address &ip) override
	Called when/if nbgethostbyname() discovers a new good IP address. More...

void	noteIps (const Dns::CachedIps *ips, const Dns::LookupDetails &details) override

void	noteLookup (const Dns::LookupDetails &details) override

const SBuf	url () const

PeerSelectionInitiator *	interestedInitiator ()

bool	wantsMoreDestinations () const

void	handlePath (const Comm::ConnectionPointer &path, FwdServer &fs)
	processes a newly discovered/finalized path More...

void	selectMore ()
	a single selection loop iteration: attempts to add more destinations More...

void	startPingWaiting ()
	switches into the PING_WAITING state (and associated timeout monitoring) More...

void	cancelPingTimeoutMonitoring ()
	terminates ICP ping timeout monitoring More...

virtual void *	toCbdata ()=0

Static Public Member Functions
static void	HandlePingTimeout (PeerSelector *)
	called when the given selector should stop expecting ICP ping responses More...

Public Attributes
HttpRequest *	request

AccessLogEntry::Pointer	al
	info for the future access.log entry More...

StoreEntry *	entry

void *	peerCountMcastPeerXXX = nullptr
	a hack to help peerCountMcastPeersStart() More...

ping_data	ping

Protected Member Functions
bool	selectionAborted ()

void	handlePingTimeout ()

void	handleIcpReply (CachePeer , const peer_t, icp_common_t header)

void	handleIcpParentMiss (CachePeer , icp_common_t )

void	handleHtcpParentMiss (CachePeer , HtcpReplyData )

void	handleHtcpReply (CachePeer , const peer_t, HtcpReplyData )

int	checkNetdbDirect ()

void	checkAlwaysDirectDone (const Acl::Answer answer)

void	checkNeverDirectDone (const Acl::Answer answer)

void	selectSomeNeighbor ()

void	selectSomeNeighborReplies ()
	Selects a neighbor (parent or sibling) based on ICP/HTCP replies. More...

void	selectSomeDirect ()
	Adds a "direct" entry if the request can be forwarded to the origin server. More...

void	selectSomeParent ()

void	selectAllParents ()
	Adds alive parents. Used as a last resort for never_direct. More...

void	selectPinned ()
	Selects a pinned connection if it exists, is valid, and is allowed. More...

void	addSelection (CachePeer *, const hier_code)

void	resolveSelected ()
	A single DNS resolution loop iteration: Converts selected FwdServer to IPs. More...

Static Protected Attributes
static IRCB	HandlePingReply

static ACLCB	CheckAlwaysDirectDone

static ACLCB	CheckNeverDirectDone

Private Types
typedef CbcPointer< PeerSelectionInitiator >	Initiator

Private Member Functions
	CBDATA_CHILD (PeerSelector)

virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

Private Attributes
Acl::Answer	always_direct

Acl::Answer	never_direct

int	direct

size_t	foundPaths = 0
	number of unique destinations identified so far More...

ErrorState *	lastError

FwdServer *	servers
	a linked list of (unresolved) selected peers More...

Ip::Address	first_parent_miss

Ip::Address	closest_parent_miss

CachePeer *	hit

peer_t	hit_type

ACLChecklist *	acl_checklist

Initiator	initiator_
	recipient of the destinations we select; use interestedInitiator() to access More...

const InstanceId< PeerSelector >	id
	unique identification in worker log More...

Detailed Description

Finds peer (including origin server) IPs for forwarding a single request. Gives PeerSelectionInitiator each found destination, in the right order.

Definition at line 59 of file PeerSelectState.h.

Member Typedef Documentation

◆ Initiator

typedef CbcPointer<PeerSelectionInitiator> PeerSelector::Initiator

private

Definition at line 163 of file PeerSelectState.h.

Constructor & Destructor Documentation

◆ PeerSelector()

PeerSelector::PeerSelector ( PeerSelectionInitiator * initiator )

explicit

Definition at line 1110 of file peer_select.cc.

◆ ~PeerSelector()

PeerSelector::~PeerSelector ( )

override

Definition at line 231 of file peer_select.cc.

References acl_checklist, assert, cancelPingTimeoutMonitoring(), DBG_IMPORTANT, debugs, entry, HTTPMSGUNLOCK(), lastError, FwdServer::next, PING_DONE, StoreEntry::ping_status, PING_WAITING, request, servers, StoreEntry::unlock(), and StoreEntry::url().

Member Function Documentation

◆ addSelection()

void PeerSelector::addSelection	(	CachePeer *	peer,
		const hier_code	code
	)

protected

Definition at line 1086 of file peer_select.cc.

References code, debugs, PINNED, server, and servers.

Referenced by selectAllParents(), selectPinned(), selectSomeDirect(), selectSomeNeighbor(), selectSomeNeighborReplies(), and selectSomeParent().

◆ cancelPingTimeoutMonitoring()

void PeerSelector::cancelPingTimeoutMonitoring ( )

Definition at line 272 of file peer_select.cc.

References PeerSelectorPingMonitor::forget(), and PingMonitor().

Referenced by ~PeerSelector(), and selectMore().

◆ CBDATA_CHILD()

PeerSelector::CBDATA_CHILD ( PeerSelector )

private

◆ checkAlwaysDirectDone()

void PeerSelector::checkAlwaysDirectDone ( const Acl::Answer answer )

protected

if always_direct says YES, do that.

Definition at line 371 of file peer_select.cc.

References ACCESS_ALLOWED, ACCESS_AUTH_REQUIRED, ACCESS_DENIED, ACCESS_DUNNO, acl_checklist, always_direct, DBG_IMPORTANT, debugs, direct, DIRECT_YES, DirectStr, and selectMore().

◆ checkNetdbDirect()

int PeerSelector::checkNetdbDirect ( )

protected

Definition at line 568 of file peer_select.cc.

References closest_parent_miss, Config, debugs, direct, DIRECT_NO, AnyP::Uri::host(), SquidConfig::minDirectHops, SquidConfig::minDirectRtt, netdbHostHops(), netdbHostRtt(), ping_data::p_rtt, ping, request, HttpRequest::url, and whichPeer().

Referenced by selectMore(), and selectSomeNeighborReplies().

◆ checkNeverDirectDone()

void PeerSelector::checkNeverDirectDone ( const Acl::Answer answer )

protected

if never_direct says YES, do that.

Definition at line 343 of file peer_select.cc.

References ACCESS_ALLOWED, ACCESS_AUTH_REQUIRED, ACCESS_DENIED, ACCESS_DUNNO, acl_checklist, DBG_IMPORTANT, debugs, direct, DIRECT_NO, DirectStr, never_direct, and selectMore().

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ handleHtcpParentMiss()

void PeerSelector::handleHtcpParentMiss	(	CachePeer *	p,
		HtcpReplyData *	htcp
	)

protected

Definition at line 1026 of file peer_select.cc.

References CachePeer::basetime, CachePeer::closest_only, closest_parent_miss, Config, HtcpReplyData::cto, current_time, first_parent_miss, HtcpReplyData::cto_t::hops, CachePeer::in_addr, int, Ip::Address::isAnyAddr(), netdbUpdatePeer(), SquidConfig::onoff, CachePeer::options, ping_data::p_rtt, ping, SquidConfig::query_icmp, request, HtcpReplyData::cto_t::rtt, ping_data::start, tvSubMsec(), HttpRequest::url, ping_data::w_rtt, and CachePeer::weight.

Referenced by handleHtcpReply().

◆ handleHtcpReply()

void PeerSelector::handleHtcpReply	(	CachePeer *	p,
		const peer_t	type,
		HtcpReplyData *	htcp
	)

protected

Definition at line 1004 of file peer_select.cc.

References debugs, handleHtcpParentMiss(), HtcpReplyData::hit, hit, hit_type, ping_data::n_recv, ping_data::n_replies_expected, PEER_PARENT, ping, selectMore(), and url().

◆ handleIcpParentMiss()

void PeerSelector::handleIcpParentMiss	(	CachePeer *	p,
		icp_common_t *	header
	)

protected

Definition at line 928 of file peer_select.cc.

References CachePeer::basetime, CachePeer::closest_only, closest_parent_miss, Config, current_time, first_parent_miss, icp_common_t::flags, ICP_FLAG_SRC_RTT, CachePeer::in_addr, Ip::Address::isAnyAddr(), netdbUpdatePeer(), SquidConfig::onoff, CachePeer::options, ping_data::p_rtt, icp_common_t::pad, ping, SquidConfig::query_icmp, request, ping_data::start, tvSubMsec(), HttpRequest::url, ping_data::w_rtt, and CachePeer::weight.

Referenced by handleIcpReply().

◆ handleIcpReply()

void PeerSelector::handleIcpReply	(	CachePeer *	p,
		const peer_t	type,
		icp_common_t *	header
	)

protected

Definition at line 971 of file peer_select.cc.

References debugs, icp_common_t::getOpCode(), handleIcpParentMiss(), hit, hit_type, ICP_DECHO, ICP_HIT, ICP_MISS, icp_opcode_str, ping_data::n_recv, ping_data::n_replies_expected, PEER_PARENT, peerDigestLookup(), peerNoteDigestLookup(), ping, request, selectMore(), and url().

◆ handlePath()

void PeerSelector::handlePath	(	const Comm::ConnectionPointer &	path,
		FwdServer &	fs
	)

Definition at line 1168 of file peer_select.cc.

References FwdServer::_peer, always_direct, FwdServer::code, debugs, foundPaths, CbcPointer< Cbc >::get(), getOutgoingAddress(), HttpRequest::hier, interestedInitiator(), never_direct, Comm::Connection::peerType, HierarchyLogEntry::ping, ping, request, Comm::Connection::setPeer(), ping_data::timedout, and url().

Referenced by noteIp(), and resolveSelected().

◆ handlePingTimeout()

void PeerSelector::handlePingTimeout ( )

protected

Definition at line 897 of file peer_select.cc.

References debugs, entry, PeerStats, ping, PING_DONE, StoreEntry::ping_status, PING_WAITING, selectionAborted(), selectMore(), ping_data::timedout, and url().

Referenced by HandlePingTimeout().

◆ HandlePingTimeout()

void PeerSelector::HandlePingTimeout ( PeerSelector * selector )

static

Definition at line 916 of file peer_select.cc.

References handlePingTimeout().

◆ interestedInitiator()

PeerSelectionInitiator * PeerSelector::interestedInitiator ( )

Returns: valid/interested peer initiator or nil

Definition at line 1143 of file peer_select.cc.

References debugs, initiator_, and CbcPointer< Cbc >::valid().

Referenced by handlePath(), resolveSelected(), and selectionAborted().

◆ noteIp()

void PeerSelector::noteIp ( const Ip::Address & )

overridevirtual

Reimplemented from Dns::IpReceiver.

Definition at line 516 of file peer_select.cc.

References FwdServer::_peer, HttpRequest::client_addr, HttpRequest::flags, handlePath(), Ip::Address::isIPv4(), Ip::Address::port(), AnyP::Uri::port(), Comm::Connection::remote, request, selectionAborted(), servers, RequestFlags::spoofClientIp, HttpRequest::url, CbcPointer< Cbc >::valid(), and wantsMoreDestinations().

◆ noteIps()

void PeerSelector::noteIps	(	const Dns::CachedIps *	ips,
		const Dns::LookupDetails &	details
	)

overridevirtual

Called when nbgethostbyname() fully resolves the name. The ips may contain both bad and good IP addresses, but each good IP (if any) is guaranteed to had been previously reported via noteIp(). When no IPs were obtained, ips is nil.

Implements Dns::IpReceiver.

Definition at line 542 of file peer_select.cc.

References FwdServer::_peer, al, FwdServer::code, debugs, ErrorState::dnsError, ERR_DNS_FAIL, Dns::LookupDetails::error, HIER_DIRECT, AnyP::Uri::host(), CachePeer::host, lastError, FwdServer::next, request, resolveSelected(), Http::scServiceUnavailable, selectionAborted(), servers, HttpRequest::url, and CbcPointer< Cbc >::valid().