#include "squid.h"
#include "acl/FilledChecklist.h"
#include "anyp/PortCfg.h"
#include "base/EnumIterator.h"
#include "base/IoManip.h"
#include "base/PackableStream.h"
#include "CacheDigest.h"
#include "CachePeer.h"
#include "comm/Connection.h"
#include "comm/ConnOpener.h"
#include "debug/Messages.h"
#include "event.h"
#include "FwdState.h"
#include "globals.h"
#include "htcp.h"
#include "HttpRequest.h"
#include "icmp/net_db.h"
#include "ICP.h"
#include "int.h"
#include "ip/Address.h"
#include "ip/tools.h"
#include "ipcache.h"
#include "MemObject.h"
#include "mgr/Registration.h"
#include "multicast.h"
#include "neighbors.h"
#include "NeighborTypeDomainList.h"
#include "pconn.h"
#include "PeerDigest.h"
#include "PeerPoolMgr.h"
#include "PeerSelectState.h"
#include "RequestFlags.h"
#include "SquidConfig.h"
#include "SquidMath.h"
#include "stat.h"
#include "Store.h"
#include "store_key_md5.h"
#include "tools.h"

Include dependency graph for neighbors.cc:

Macros
#define	MCAST_COUNT_RATE 900

Functions
bool	peerAllowedToUse (const CachePeer , PeerSelector )

static int	peerWouldBePinged (const CachePeer , PeerSelector )

static void	neighborRemove (CachePeer *)

static void	neighborAlive (CachePeer , const MemObject , const icp_common_t *)

static void	neighborAliveHtcp (CachePeer , const MemObject , const HtcpReplyData *)

static void	neighborCountIgnored (CachePeer *)

static void	peerRefreshDNS (void *)

static void	peerProbeConnect (CachePeer *, const bool reprobeIfBusy=false)

static void	peerCountMcastPeersDone (void *data)

static void	peerCountMcastPeersStart (void *data)

static void	peerCountMcastPeersSchedule (CachePeer *p, time_t when)

static void	peerCountMcastPeersAbort (PeerSelector *)

static void	peerCountMcastPeersCreateAndSend (CachePeer *const p)
	initiates an ICP transaction to a multicast peer More...

static void	neighborIgnoreNonPeer (const Ip::Address &, icp_opcode)

static void	dump_peers (StoreEntry sentry, CachePeer peers)

const char *	neighborTypeStr (const CachePeer *p)

CachePeer *	whichPeer (const Ip::Address &from)

peer_t	neighborType (const CachePeer *p, const AnyP::Uri &url)

bool	peerCanOpenMore (const CachePeer *p)
	Whether we can open new connections to the peer (e.g., despite max-conn) More...

bool	peerHasConnAvailable (const CachePeer *p)
	Whether the peer has idle or standby connections that can be used now. More...

void	peerConnClosed (CachePeer *p)
	Notifies peer of an associated connection closure. More...

int	peerHTTPOkay (const CachePeer p, PeerSelector ps)

int	neighborsCount (PeerSelector *ps)

CachePeer *	getFirstUpParent (PeerSelector *ps)

CachePeer *	getRoundRobinParent (PeerSelector *ps)

CachePeer *	getWeightedRoundRobinParent (PeerSelector *ps)

static void	peerClearRRLoop (void *data)

void	peerClearRRStart (void)

void	peerClearRR ()

void	peerAlive (CachePeer *p)

CachePeer *	getDefaultParent (PeerSelector *ps)

CachePeer *	getNextPeer (CachePeer *p)

CachePeer *	getFirstPeer (void)

static void	neighborsRegisterWithCacheManager ()

void	neighbors_init (void)

int	neighborsUdpPing (HttpRequest request, StoreEntry entry, IRCB callback, PeerSelector ps, int exprep, int timeout)

lookup_t	peerDigestLookup (CachePeer p, PeerSelector ps)

CachePeer *	neighborsDigestSelect (PeerSelector *ps)

void	peerNoteDigestLookup (HttpRequest request, CachePeer p, lookup_t lookup)

static void	neighborUpdateRtt (CachePeer p, MemObject mem)

static int	ignoreMulticastReply (CachePeer p, PeerSelector ps)

void	neighborsUdpAck (const cache_key key, icp_common_t header, const Ip::Address &from)

CachePeer *	findCachePeerByName (const char *const name)
	cache_peer with a given name (or nil) More...

int	neighborUp (const CachePeer *p)

time_t	positiveTimeout (const time_t timeout)

static void	peerDNSConfigure (const ipcache_addrs ia, const Dns::LookupDetails &, void data)

static bool	peerProbeIsBusy (const CachePeer *p)
	whether new TCP probes are currently banned More...

static void	peerProbeConnectDone (const Comm::ConnectionPointer &conn, Comm::Flag status, int, void *data)

static void	peerCountHandleIcpReply (CachePeer p, peer_t, AnyP::ProtocolType proto, void , void *data)

static void	neighborDumpPeers (StoreEntry *sentry)

void	dump_peer_options (StoreEntry sentry, CachePeer p)

void	neighborsHtcpReply (const cache_key key, HtcpReplyData htcp, const Ip::Address &from)

void	neighborsHtcpClear (StoreEntry e, HttpRequest req, const HttpRequestMethod &method, htcp_clr_reason reason)

Variables
static IPH	peerDNSConfigure

static CNCB	peerProbeConnectDone

static IRCB	peerCountHandleIcpReply

static OBJH	neighborDumpPeers

static unsigned short	echo_port

static int	NLateReplies = 0

static CachePeer *	first_ping = nullptr

Macro Definition Documentation

◆ MCAST_COUNT_RATE

#define MCAST_COUNT_RATE 900

Definition at line 51 of file neighbors.cc.

Function Documentation

◆ dump_peer_options()

void dump_peer_options	(	StoreEntry *	sentry,
		CachePeer *	p
	)

Definition at line 1426 of file neighbors.cc.

References CachePeer::allow_miss, CachePeer::background_ping, CachePeer::carp, CachePeer::closest_only, CachePeer::connect_fail_limit, CachePeer::connect_timeout_raw, CachePeer::connection_auth, CachePeer::default_parent, CachePeer::digest_url, CachePeer::domain, Security::PeerOptions::dumpCfg(), CachePeer::htcp, CachePeer::htcp_no_clr, CachePeer::htcp_no_purge_clr, CachePeer::htcp_oldsquid, CachePeer::htcp_only_clr, CachePeer::limit, CachePeer::login, CachePeer::max_conn, CachePeer::mcast, CachePeer::mcast_responder, CachePeer::mcast_siblings, CachePeer::no_delay, CachePeer::no_digest, CachePeer::no_netdb_exchange, CachePeer::no_query, CachePeer::no_tproxy, CachePeer::options, CachePeer::originserver, PEER_TCP_MAGIC_COUNT, CachePeer::proxy_only, CachePeer::roundrobin, CachePeer::secure, CachePeer::sourcehash, CachePeer::standby, storeAppendPrintf(), CachePeer::ttl, CachePeer::userhash, CachePeer::weight, and CachePeer::weighted_roundrobin.

Referenced by dump_peer(), and dump_peers().

◆ dump_peers()

static void dump_peers	(	StoreEntry *	sentry,
		CachePeer *	peers
	)

static

Definition at line 1556 of file neighbors.cc.

References assert, dump_peer_options(), Time::FormatHttpd(), icp_opcode_str, Math::intPercent(), MAX_IPSTRLEN, neighborTypeStr(), neighborUp(), CachePeer::next, squid_curtime, and storeAppendPrintf().

Referenced by neighborDumpPeers().

◆ findCachePeerByName()

CachePeer * findCachePeerByName ( const char *const name )

Definition at line 1100 of file neighbors.cc.

References Config, CachePeer::name, CachePeer::next, and SquidConfig::peers.

Referenced by ConfigParser::cachePeer(), and parse_peer().

◆ getDefaultParent()

CachePeer * getDefaultParent ( PeerSelector * ps )

Definition at line 476 of file neighbors.cc.

References assert, Config, debugs, CachePeer::default_parent, neighborType(), CachePeer::next, CachePeer::options, PEER_PARENT, peerHTTPOkay(), SquidConfig::peers, PeerSelector::request, and HttpRequest::url.

Referenced by PeerSelector::selectAllParents(), and PeerSelector::selectSomeParent().

◆ getFirstPeer()

CachePeer * getFirstPeer ( void )

Definition at line 510 of file neighbors.cc.

References Config, and SquidConfig::peers.

Referenced by statPeerSelect().

◆ getFirstUpParent()

CachePeer * getFirstUpParent ( PeerSelector * ps )

Definition at line 289 of file neighbors.cc.

References assert, Config, debugs, neighborType(), neighborUp(), CachePeer::next, PEER_PARENT, peerHTTPOkay(), SquidConfig::peers, RawPointer(), PeerSelector::request, and HttpRequest::url.

Referenced by PeerSelector::selectSomeParent().

◆ getNextPeer()

CachePeer * getNextPeer ( CachePeer * p )

Definition at line 504 of file neighbors.cc.

References CachePeer::next.

Referenced by statPeerSelect().

◆ getRoundRobinParent()

CachePeer * getRoundRobinParent ( PeerSelector * ps )

Definition at line 314 of file neighbors.cc.

References assert, Config, debugs, neighborType(), CachePeer::next, CachePeer::options, PEER_PARENT, peerHTTPOkay(), SquidConfig::peers, RawPointer(), PeerSelector::request, CachePeer::roundrobin, CachePeer::rr_count, HttpRequest::url, and CachePeer::weight.

Referenced by PeerSelector::selectSomeParent().

◆ getWeightedRoundRobinParent()

CachePeer * getWeightedRoundRobinParent ( PeerSelector * ps )

Definition at line 356 of file neighbors.cc.

References assert, CachePeer::basetime, Config, debugs, neighborType(), CachePeer::next, CachePeer::options, PEER_PARENT, peerHTTPOkay(), SquidConfig::peers, RawPointer(), PeerSelector::request, CachePeer::rr_count, CachePeer::rtt, CachePeer::stats, HttpRequest::url, CachePeer::weight, and CachePeer::weighted_roundrobin.

Referenced by PeerSelector::selectSomeParent().

◆ ignoreMulticastReply()

static int ignoreMulticastReply	(	CachePeer *	p,
		PeerSelector *	ps
	)

static

Definition at line 957 of file neighbors.cc.

References CachePeer::mcast_responder, CachePeer::options, and peerHTTPOkay().

Referenced by neighborsHtcpReply(), and neighborsUdpAck().

◆ neighborAlive()

static void neighborAlive	(	CachePeer *	p,
		const MemObject *	,
		const icp_common_t *	header
	)

static

Definition at line 881 of file neighbors.cc.

References CachePeer::icp_::counts, CachePeer::icp, ICP_END, int, icp_common_t::opcode, peerAlive(), CachePeer::pings_acked, CachePeer::stats, CachePeer::icp_::version, and icp_common_t::version.

Referenced by neighborsUdpAck().

◆ neighborAliveHtcp()

static void neighborAliveHtcp	(	CachePeer *	p,
		const MemObject *	,
		const HtcpReplyData *	htcp
	)

static

Definition at line 918 of file neighbors.cc.

References CachePeer::counts, HtcpReplyData::hit, CachePeer::htcp, peerAlive(), CachePeer::pings_acked, CachePeer::stats, CachePeer::version, and HtcpReplyData::version.

Referenced by neighborsHtcpReply().

◆ neighborCountIgnored()

static void neighborCountIgnored ( CachePeer * p )

static

Definition at line 929 of file neighbors.cc.

References CachePeer::ignored_replies, NLateReplies, and CachePeer::stats.

Referenced by neighborsHtcpReply(), and neighborsUdpAck().

◆ neighborDumpPeers()

static void neighborDumpPeers ( StoreEntry * sentry )

static

Definition at line 1420 of file neighbors.cc.

References Config, dump_peers(), and SquidConfig::peers.

◆ neighborIgnoreNonPeer()

static void neighborIgnoreNonPeer	(	const Ip::Address &	from,
		icp_opcode	opcode
	)

static

Definition at line 940 of file neighbors.cc.

References DBG_IMPORTANT, debugs, Debug::Extra(), icp_opcode_str, and isPowTen().

Referenced by neighborsUdpAck().

◆ neighborRemove()

static void neighborRemove ( CachePeer * target )

static

Definition at line 516 of file neighbors.cc.

References Config, first_ping, CachePeer::next, SquidConfig::npeers, and SquidConfig::peers.

Referenced by neighbors_init(), and neighborsUdpAck().

◆ neighbors_init()

void neighbors_init ( void )

Definition at line 551 of file neighbors.cc.

References Config, DBG_IMPORTANT, debugs, echo_port, Debug::Extra(), first_ping, getMyHostname(), CachePeer::host, CachePeer::http_port, HttpPortList, icpIncomingConn, Comm::IsConnOpen(), neighborRemove(), neighborsRegisterWithCacheManager(), CachePeer::next, peerRefreshDNS(), and SquidConfig::peers.

Referenced by mainInitialize(), and mainReconfigureFinish().

◆ neighborsCount()

int neighborsCount ( PeerSelector * ps )

Definition at line 274 of file neighbors.cc.

References Config, debugs, CachePeer::next, SquidConfig::peers, and peerWouldBePinged().

Referenced by peerSelectIcpPing().

◆ neighborsDigestSelect()

CachePeer * neighborsDigestSelect ( PeerSelector * ps )

Definition at line 796 of file neighbors.cc.

References assert, Config, debugs, first_ping, HttpRequest::flags, HttpRequest::hier, RequestFlags::hierarchical, CachePeer::host, LOOKUP_HIT, LOOKUP_MISS, LOOKUP_NONE, HierarchyLogEntry::n_choices, HierarchyLogEntry::n_ichoices, netdbHostRtt(), CachePeer::next, SquidConfig::npeers, peerDigestLookup(), peerNoteDigestLookup(), SquidConfig::peers, PeerSelector::request, and storeKeyPublicByRequest().

Referenced by PeerSelector::selectSomeNeighbor().

◆ neighborsHtcpClear()

void neighborsHtcpClear	(	StoreEntry *	e,
		HttpRequest *	req,
		const HttpRequestMethod &	method,
		htcp_clr_reason	reason
	)

Definition at line 1723 of file neighbors.cc.

References Config, debugs, CachePeer::htcp, HTCP_CLR_PURGE, CachePeer::htcp_no_clr, CachePeer::htcp_no_purge_clr, htcpClear(), CachePeer::in_addr, CachePeer::next, CachePeer::options, SquidConfig::peers, and Ip::Address::toUrl().

Referenced by httpMaybeRemovePublic(), purgeEntriesByUrl(), and clientReplyContext::purgeEntry().

◆ neighborsHtcpReply()

void neighborsHtcpReply	(	const cache_key *	key,
		HtcpReplyData *	htcp,
		const Ip::Address &	from
	)

◆ neighborsRegisterWithCacheManager()

static void neighborsRegisterWithCacheManager ( )

static

Definition at line 543 of file neighbors.cc.

References neighborDumpPeers, and Mgr::RegisterAction().

Referenced by neighbors_init().

◆ neighborsUdpAck()

void neighborsUdpAck	(	const cache_key *	key,
		icp_common_t *	header,
		const Ip::Address &	from
	)

I should attach these records to the entry. We take the first hit we get our wait until everyone misses. The timeout handler call needs to nip this shopping list or call one of the misses.

If a hit process is already started, then sobeit

Definition at line 979 of file neighbors.cc.

References CachePeer::icp_::counts, DBG_CRITICAL, DBG_IMPORTANT, debug_trap(), debugs, EBIT_TEST, ENTRY_DISPATCHED, StoreEntry::flags, CachePeer::icp, ICP_DECHO, ICP_DENIED, ICP_END, ICP_HIT, ICP_MISS, ICP_MISS_NOFETCH, icp_opcode_str, ICP_SECHO, ignoreMulticastReply(), MemObject::ircb_data, StoreEntry::locked(), StoreEntry::mem_obj, neighborAlive(), neighborCountIgnored(), neighborIgnoreNonPeer(), neighborRemove(), neighborType(), neighborUpdateRtt(), icp_common_t::opcode, PEER_NONE, PEER_SIBLING, MemObject::ping_reply_callback, StoreEntry::ping_status, PING_WAITING, CachePeer::pings_acked, AnyP::PROTO_ICP, RawPointer(), MemObject::request, Store::Root(), CachePeer::stats, storeKeyText(), HttpRequest::url, and whichPeer().

Referenced by icp_common_t::handleReply().

◆ neighborsUdpPing()

int neighborsUdpPing	(	HttpRequest *	request,
		StoreEntry *	entry,
		IRCB *	callback,
		PeerSelector *	ps,
		int *	exprep,
		int *	timeout
	)

Definition at line 589 of file neighbors.cc.

References assert, Config, current_time, DBG_CRITICAL, DBG_IMPORTANT, debugs, echo_port, Comm::Connection::fd, first_ping, StoreEntry::getMD5Text(), StoreEntry::hasDisk(), CachePeer::htcp, SquidConfig::htcp, CachePeer::htcp_only_clr, htcpQuery(), CachePeer::icp, SquidConfig::icp, ICP_DECHO, ICP_FLAG_SRC_RTT, ICP_QUERY, SquidConfig::icp_query, SquidConfig::icp_query_max, SquidConfig::icp_query_min, ICP_VERSION_2, icpCreateAndSend(), icpOutgoingConn, icpSetCacheKey(), CachePeer::in_addr, MemObject::ircb_data, Comm::IsConnOpen(), hash_link::key, CachePeer::last_query, CachePeer::logged_state, CachePeer::mcast, mcastSetTtl(), StoreEntry::mem_obj, CachePeer::n_replies_expected, neighborType(), neighborTypeStr(), neighborUp(), CachePeer::next, SquidConfig::npeers, SquidConfig::onoff, CachePeer::options, PEER_ALIVE, PEER_DEAD, PEER_MULTICAST, PEER_PARENT, SquidConfig::peers, peerWouldBePinged(), MemObject::ping_reply_callback, CachePeer::pings_sent, CachePeer::icp_::port, SquidConfig::Port, CachePeer::probe_start, SquidConfig::query_icmp, CachePeer::rtt, squid_curtime, MemObject::start_ping, CachePeer::stats, SquidConfig::Timeout, CachePeer::ttl, CachePeer::type, HttpRequest::url, StoreEntry::url(), and CachePeer::icp_::version.

Referenced by PeerSelector::selectSomeNeighbor().

◆ neighborType()

peer_t neighborType	(	const CachePeer *	p,
		const AnyP::Uri &	url
	)

◆ neighborTypeStr()

const char * neighborTypeStr ( const CachePeer * p )

Definition at line 82 of file neighbors.cc.

References PEER_MULTICAST, PEER_NONE, PEER_SIBLING, and CachePeer::type.

Referenced by CachePeer::countFailure(), dump_peer(), dump_peers(), neighborsUdpPing(), peerAlive(), and peerDNSConfigure().

◆ neighborUp()

int neighborUp ( const CachePeer * p )

Definition at line 1113 of file neighbors.cc.

References CallService(), Config, SquidConfig::deadPeer, debugs, CachePeer::n_addresses, CachePeer::no_query, CachePeer::options, peerProbeConnect(), CachePeer::probe_start, squid_curtime, CachePeer::stats, CachePeer::tcp_up, and SquidConfig::Timeout.

Referenced by dump_peers(), getFirstUpParent(), neighborsUdpPing(), PeerPoolMgr::openNewConnection(), peerHTTPOkay(), peerWouldBePinged(), and snmp_meshPtblFn().

◆ neighborUpdateRtt()

static void neighborUpdateRtt	(	CachePeer *	p,
		MemObject *	mem
	)

static

Definition at line 893 of file neighbors.cc.

References current_time, Math::intAverage(), CachePeer::options, CachePeer::pings_acked, CachePeer::rtt, RTT_AV_FACTOR, RTT_BACKGROUND_AV_FACTOR, MemObject::start_ping, CachePeer::stats, tvSubMsec(), and CachePeer::weighted_roundrobin.

Referenced by neighborsHtcpReply(), and neighborsUdpAck().

◆ peerAlive()

void peerAlive ( CachePeer * p )

Updates protocol-agnostic CachePeer state after an indication of a successful contact with the given cache_peer.

Definition at line 457 of file neighbors.cc.

References PeerPoolMgr::Checkpoint(), DBG_IMPORTANT, debugs, CachePeer::host, ipcache_nbgethostbyname(), CachePeer::last_reply, CachePeer::logged_state, CachePeer::mgr, CachePeer::n_addresses, neighborTypeStr(), PEER_ALIVE, PEER_DEAD, peerClearRR(), peerDNSConfigure, CachePeer::probe_start, squid_curtime, CachePeer::standby, CachePeer::stats, CachePeer::tcp_up, and CbcPointer< Cbc >::valid().

Referenced by neighborAlive(), neighborAliveHtcp(), and CachePeer::noteSuccess().

◆ peerAllowedToUse()

bool peerAllowedToUse	(	const CachePeer *	p,
		PeerSelector *	ps
	)

Returns: Whether it is appropriate to fetch REQUEST from PEER.

Definition at line 139 of file neighbors.cc.

References CachePeer::access, ACLFilledChecklist::al, PeerSelector::al, Acl::Answer::allowed(), assert, AnyP::Uri::authority(), debugs, ACLChecklist::fastCheck(), HttpRequest::flags, RefCount< C >::getRaw(), CachePeer::http_port, HTTPMSGLOCK(), RequestFlags::loopDetected, CachePeer::mcast_siblings, HttpRequest::method, Http::METHOD_CONNECT, RequestFlags::needValidation, neighborType(), RequestFlags::noCache, CachePeer::options, CachePeer::originserver, PEER_MULTICAST, PEER_SIBLING, AnyP::Uri::port(), RequestFlags::refresh, AccessLogEntry::reply, ACLFilledChecklist::reply, PeerSelector::request, ACLFilledChecklist::syncAle(), CachePeer::type, and HttpRequest::url.

Referenced by peerHTTPOkay(), peerWouldBePinged(), and PeerSelector::selectPinned().

◆ peerCanOpenMore()

bool peerCanOpenMore ( const CachePeer * p )

Definition at line 224 of file neighbors.cc.

References CachePeer::conn_open, debugs, CachePeer::max_conn, Squid_MaxFD, and CachePeer::stats.

Referenced by PeerPoolMgr::openNewConnection(), peerConnClosed(), and peerHTTPOkay().

◆ peerClearRR()

void peerClearRR ( void )

Called whenever the round-robin counters need to be reset to a sane state. So far those times are:

On startup and reconfigure - to set the counters to sane initial settings.
When a CachePeer has revived from dead, to prevent the revived CachePeer being flooded with requests which it has 'missed' during the down period.

Definition at line 448 of file neighbors.cc.

References Config, CachePeer::next, SquidConfig::peers, and CachePeer::rr_count.

Referenced by peerAlive(), and peerClearRRLoop().

◆ peerClearRRLoop()

static void peerClearRRLoop ( void * data )

static

This gets called every 5 minutes to clear the round-robin counter. The exact timing is an arbitrary default, set on estimate timing of a large number of requests in a high-performance environment during the period. The larger the number of requests between cycled resets the more balanced the operations.

Parameters

data unused

TODO: Make the reset timing a selectable parameter in squid.conf

Definition at line 419 of file neighbors.cc.

References eventAdd(), peerClearRR(), and peerClearRRLoop().

Referenced by peerClearRRLoop(), and peerClearRRStart().

◆ peerClearRRStart()

void peerClearRRStart ( void )

This gets called on startup and restart to kick off the CachePeer round-robin maintenance event. It ensures that no matter how many times its called no more than one event is scheduled.

Definition at line 431 of file neighbors.cc.

References peerClearRRLoop().

Referenced by parse_peer().