Stochastical (IP) address manager. More...

#include <addrman.h>

Collaboration diagram for CAddrMan:

Public Member Functions
template<typename Stream >
void	Serialize (Stream &s) const
	serialized format: More...

template<typename Stream >
void	Unserialize (Stream &s)

void	Clear ()

	CAddrMan ()

	~CAddrMan ()

size_t	size () const
	Return the number of (unique) addresses in all tables. More...

void	Check ()
	Consistency check. More...

bool	Add (const CAddress &addr, const CNetAddr &source, int64_t nTimePenalty=0)
	Add a single address. More...

bool	Add (const std::vector< CAddress > &vAddr, const CNetAddr &source, int64_t nTimePenalty=0)
	Add multiple addresses. More...

void	Good (const CService &addr, bool test_before_evict=true, int64_t nTime=GetAdjustedTime())
	Mark an entry as accessible. More...

void	Attempt (const CService &addr, bool fCountFailure, int64_t nTime=GetAdjustedTime())
	Mark an entry as connection attempted to. More...

void	ResolveCollisions ()
	See if any to-be-evicted tried table entries have been tested and if so resolve the collisions. More...

CAddrInfo	SelectTriedCollision ()
	Randomly select an address in tried that another address is attempting to evict. More...

CAddrInfo	Select (bool newOnly=false)
	Choose an address to connect to. More...

std::vector< CAddress >	GetAddr ()
	Return a bunch of addresses, selected at random. More...

void	Connected (const CService &addr, int64_t nTime=GetAdjustedTime())
	Mark an entry as currently-connected-to. More...

void	SetServices (const CService &addr, ServiceFlags nServices)

Protected Member Functions
CAddrInfo *	Find (const CNetAddr &addr, int *pnId=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Find an entry. More...

CAddrInfo *	Create (const CAddress &addr, const CNetAddr &addrSource, int *pnId=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs)
	find an entry, creating it if necessary. More...

void	SwapRandom (unsigned int nRandomPos1, unsigned int nRandomPos2) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Swap two elements in vRandom. More...

void	MakeTried (CAddrInfo &info, int nId) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Move an entry from the "new" table(s) to the "tried" table. More...

void	Delete (int nId) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Delete an entry. It must not be in tried, and have refcount 0. More...

void	ClearNew (int nUBucket, int nUBucketPos) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Clear a position in a "new" table. This is the only place where entries are actually deleted. More...

void	Good_ (const CService &addr, bool test_before_evict, int64_t time) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Mark an entry "good", possibly moving it from "new" to "tried". More...

bool	Add_ (const CAddress &addr, const CNetAddr &source, int64_t nTimePenalty) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Add an entry to the "new" table. More...

void	Attempt_ (const CService &addr, bool fCountFailure, int64_t nTime) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Mark an entry as attempted to connect. More...

CAddrInfo	Select_ (bool newOnly) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Select an address to connect to, if newOnly is set to true, only the new table is selected from. More...

void	ResolveCollisions_ () EXCLUSIVE_LOCKS_REQUIRED(cs)
	See if any to-be-evicted tried table entries have been tested and if so resolve the collisions. More...

CAddrInfo	SelectTriedCollision_ () EXCLUSIVE_LOCKS_REQUIRED(cs)
	Return a random to-be-evicted tried table address. More...

virtual int	RandomInt (int nMax)
	Wraps GetRandInt to allow tests to override RandomInt and make it determinismistic. More...

void	GetAddr_ (std::vector< CAddress > &vAddr) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Select several addresses at once. More...

void	Connected_ (const CService &addr, int64_t nTime) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Mark an entry as currently-connected-to. More...

void	SetServices_ (const CService &addr, ServiceFlags nServices) EXCLUSIVE_LOCKS_REQUIRED(cs)
	Update an entry's service bits. More...

Protected Attributes
CCriticalSection	cs
	critical section to protect the inner data structures More...

uint256	nKey
	secret key to randomize bucket select with More...

FastRandomContext	insecure_rand
	Source of random numbers for randomization in inner loops. More...

Private Member Functions
int nIdCount	GUARDED_BY (cs)
	last used nId More...

std::map< int, CAddrInfo > mapInfo	GUARDED_BY (cs)
	table with information about all nIds More...

std::map< CNetAddr, int > mapAddr	GUARDED_BY (cs)
	find an nId based on its network address More...

std::vector< int > vRandom	GUARDED_BY (cs)
	randomly-ordered vector of all nIds More...

int nTried	GUARDED_BY (cs)

int vvTried [ADDRMAN_TRIED_BUCKET_COUNT][ADDRMAN_BUCKET_SIZE]	GUARDED_BY (cs)
	list of "tried" buckets More...

int nNew	GUARDED_BY (cs)
	number of (unique) "new" entries More...

int vvNew [ADDRMAN_NEW_BUCKET_COUNT][ADDRMAN_BUCKET_SIZE]	GUARDED_BY (cs)
	list of "new" buckets More...

int64_t nLastGood	GUARDED_BY (cs)
	last time Good was called (memory only) More...

Private Attributes
std::set< int >	m_tried_collisions
	Holds addrs inserted into tried table that collide with existing entries. Test-before-evict discipline used to resolve these collisions. More...

Detailed Description

Stochastical (IP) address manager.

Definition at line 188 of file addrman.h.

Constructor & Destructor Documentation

◆ CAddrMan()

CAddrMan::CAddrMan ( )

inline

Definition at line 496 of file addrman.h.

Here is the call graph for this function:

◆ ~CAddrMan()

CAddrMan::~CAddrMan ( )

inline

Definition at line 501 of file addrman.h.

Here is the call graph for this function:

Member Function Documentation

◆ Add() [1/2]

bool CAddrMan::Add	(	const CAddress &	addr,
		const CNetAddr &	source,
		int64_t	nTimePenalty = `0`
	)

inline

Add a single address.

Definition at line 527 of file addrman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Add() [2/2]

bool CAddrMan::Add	(	const std::vector< CAddress > &	vAddr,
		const CNetAddr &	source,
		int64_t	nTimePenalty = `0`
	)

inline

Add multiple addresses.

Definition at line 541 of file addrman.h.

Here is the call graph for this function:

◆ Add_()

bool CAddrMan::Add_	(	const CAddress &	addr,
		const CNetAddr &	source,
		int64_t	nTimePenalty
	)

protected

Add an entry to the "new" table.

Definition at line 254 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Attempt()

void CAddrMan::Attempt	(	const CService &	addr,
		bool	fCountFailure,
		int64_t	nTime = `GetAdjustedTime()`
	)

inline

Mark an entry as connection attempted to.

Definition at line 565 of file addrman.h.

Here is the call graph for this function:

◆ Attempt_()

void CAddrMan::Attempt_	(	const CService &	addr,
		bool	fCountFailure,
		int64_t	nTime
	)

protected

Mark an entry as attempted to connect.

Definition at line 327 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Check()

void CAddrMan::Check ( )

inline

Consistency check.

Definition at line 514 of file addrman.h.

Here is the caller graph for this function:

◆ Clear()

void CAddrMan::Clear ( )

inline

Definition at line 472 of file addrman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearNew()

void CAddrMan::ClearNew	(	int	nUBucket,
		int	nUBucketPos
	)

protected

Clear a position in a "new" table. This is the only place where entries are actually deleted.

Definition at line 127 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Connected()

void CAddrMan::Connected	(	const CService &	addr,
		int64_t	nTime = `GetAdjustedTime()`
	)

inline

Mark an entry as currently-connected-to.

Definition at line 624 of file addrman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Connected_()

void CAddrMan::Connected_	(	const CService &	addr,
		int64_t	nTime
	)

protected

Mark an entry as currently-connected-to.

Definition at line 495 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

CAddrInfo * CAddrMan::Create	(	const CAddress &	addr,
		const CNetAddr &	addrSource,
		int *	pnId = `nullptr`
	)

protected

find an entry, creating it if necessary.

nTime and nServices of the found node are updated, if necessary.

Definition at line 81 of file addrman.cpp.

Here is the caller graph for this function:

◆ Delete()

void CAddrMan::Delete ( int nId )

protected

Delete an entry. It must not be in tried, and have refcount 0.

Definition at line 113 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Find()

CAddrInfo * CAddrMan::Find	(	const CNetAddr &	addr,
		int *	pnId = `nullptr`
	)

protected

Find an entry.

Definition at line 68 of file addrman.cpp.

Here is the caller graph for this function:

◆ GetAddr()

std::vector<CAddress> CAddrMan::GetAddr ( )

inline

Return a bunch of addresses, selected at random.

Definition at line 611 of file addrman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddr_()

void CAddrMan::GetAddr_ ( std::vector< CAddress > & vAddr )

protected

Select several addresses at once.

Definition at line 474 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Good()

void CAddrMan::Good	(	const CService &	addr,
		bool	test_before_evict = `true`,
		int64_t	nTime = `GetAdjustedTime()`
	)

inline

Mark an entry as accessible.

Definition at line 556 of file addrman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Good_()

void CAddrMan::Good_	(	const CService &	addr,
		bool	test_before_evict,
		int64_t	time
	)

protected

Mark an entry "good", possibly moving it from "new" to "tried".

Definition at line 190 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/9]

int nIdCount CAddrMan::GUARDED_BY ( cs )

private

last used nId

◆ GUARDED_BY() [2/9]

std::map<int, CAddrInfo> mapInfo CAddrMan::GUARDED_BY ( cs )

private

table with information about all nIds

◆ GUARDED_BY() [3/9]

std::map<CNetAddr, int> mapAddr CAddrMan::GUARDED_BY ( cs )

private

find an nId based on its network address

◆ GUARDED_BY() [4/9]

std::vector<int> vRandom CAddrMan::GUARDED_BY ( cs )

private

randomly-ordered vector of all nIds

◆ GUARDED_BY() [5/9]

int nTried CAddrMan::GUARDED_BY ( cs )

private

◆ GUARDED_BY() [6/9]

int vvTried [ADDRMAN_TRIED_BUCKET_COUNT][ADDRMAN_BUCKET_SIZE] CAddrMan::GUARDED_BY ( cs )

private

list of "tried" buckets

◆ GUARDED_BY() [7/9]

int nNew CAddrMan::GUARDED_BY ( cs )

private

number of (unique) "new" entries

◆ GUARDED_BY() [8/9]

int vvNew [ADDRMAN_NEW_BUCKET_COUNT][ADDRMAN_BUCKET_SIZE] CAddrMan::GUARDED_BY ( cs )

private

list of "new" buckets

◆ GUARDED_BY() [9/9]

int64_t nLastGood CAddrMan::GUARDED_BY ( cs )

private

last time Good was called (memory only)

◆ MakeTried()

void CAddrMan::MakeTried	(	CAddrInfo &	info,
		int	nId
	)

protected

Move an entry from the "new" table(s) to the "tried" table.

Definition at line 142 of file addrman.cpp.

Here is the call graph for this function:

◆ RandomInt()

int CAddrMan::RandomInt ( int nMax )

protectedvirtual

Wraps GetRandInt to allow tests to override RandomInt and make it determinismistic.

Definition at line 533 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResolveCollisions()

void CAddrMan::ResolveCollisions ( )

inline

See if any to-be-evicted tried table entries have been tested and if so resolve the collisions.

Definition at line 574 of file addrman.h.

Here is the call graph for this function:

◆ ResolveCollisions_()

void CAddrMan::ResolveCollisions_ ( )

protected

See if any to-be-evicted tried table entries have been tested and if so resolve the collisions.

Definition at line 537 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Select()

CAddrInfo CAddrMan::Select ( bool newOnly = false )

inline

Choose an address to connect to.

Definition at line 598 of file addrman.h.

Here is the call graph for this function:

◆ Select_()

CAddrInfo CAddrMan::Select_ ( bool newOnly )

protected

Select an address to connect to, if newOnly is set to true, only the new table is selected from.

Definition at line 349 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SelectTriedCollision()

CAddrInfo CAddrMan::SelectTriedCollision ( )

inline

Randomly select an address in tried that another address is attempting to evict.

Definition at line 583 of file addrman.h.

Here is the call graph for this function:

◆ SelectTriedCollision_()

CAddrInfo CAddrMan::SelectTriedCollision_ ( )

protected

Return a random to-be-evicted tried table address.

Definition at line 589 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize()

template<typename Stream >

void CAddrMan::Serialize ( Stream & s ) const

inline

serialized format:

version byte (currently 1)
0x20 + nKey (serialized as if it were a vector, for backward compatibility)
nNew
nTried
number of "new" buckets XOR 2**30
all nNew addrinfos in vvNew
all nTried addrinfos in vvTried
for each bucket:
- number of elements
- for each element: index

2**30 is xorred with the number of buckets to make addrman deserializer v0 detect it as incompatible. This is necessary because it did not check the version number on deserialization.

Notice that vvTried, mapAddr and vVector are never encoded explicitly; they are instead reconstructed from the other information.

vvNew is serialized, but only used if ADDRMAN_UNKNOWN_BUCKET_COUNT didn't change, otherwise it is reconstructed as well.

This format is more complex, but significantly smaller (at most 1.5 MiB), and supports changes to the ADDRMAN_ parameters without breaking the on-disk structure.

We don't use ADD_SERIALIZE_METHODS since the serialization and deserialization code has very little in common.

Definition at line 317 of file addrman.h.

◆ SetServices()

void CAddrMan::SetServices	(	const CService &	addr,
		ServiceFlags	nServices
	)

inline

Definition at line 632 of file addrman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetServices_()

void CAddrMan::SetServices_	(	const CService &	addr,
		ServiceFlags	nServices
	)

protected

Update an entry's service bits.

Definition at line 515 of file addrman.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

size_t CAddrMan::size ( ) const

inline

Return the number of (unique) addresses in all tables.

Definition at line 507 of file addrman.h.

Here is the caller graph for this function:

◆ SwapRandom()

void CAddrMan::SwapRandom	(	unsigned int	nRandomPos1,
		unsigned int	nRandomPos2
	)

protected

Swap two elements in vRandom.

Definition at line 93 of file addrman.cpp.

Here is the caller graph for this function:

◆ Unserialize()

template<typename Stream >

void CAddrMan::Unserialize ( Stream & s )

inline

Definition at line 367 of file addrman.h.

Here is the call graph for this function:

Member Data Documentation

◆ cs

CCriticalSection CAddrMan::cs

mutableprotected

critical section to protect the inner data structures

Definition at line 192 of file addrman.h.

◆ insecure_rand

FastRandomContext CAddrMan::insecure_rand

protected

Source of random numbers for randomization in inner loops.

Definition at line 230 of file addrman.h.

◆ m_tried_collisions

std::set<int> CAddrMan::m_tried_collisions

private

Holds addrs inserted into tried table that collide with existing entries. Test-before-evict discipline used to resolve these collisions.

Definition at line 223 of file addrman.h.

◆ nKey

uint256 CAddrMan::nKey

protected

secret key to randomize bucket select with

Definition at line 227 of file addrman.h.

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

src/addrman.h
src/addrman.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CAddrMan()

◆ ~CAddrMan()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ Add_()

◆ Attempt()

◆ Attempt_()

◆ Check()

◆ Clear()

◆ ClearNew()

◆ Connected()

◆ Connected_()

◆ Create()

◆ Delete()

◆ Find()

◆ GetAddr()

◆ GetAddr_()

◆ Good()

◆ Good_()

◆ GUARDED_BY() [1/9]

◆ GUARDED_BY() [2/9]

◆ GUARDED_BY() [3/9]

◆ GUARDED_BY() [4/9]

◆ GUARDED_BY() [5/9]

◆ GUARDED_BY() [6/9]

◆ GUARDED_BY() [7/9]

◆ GUARDED_BY() [8/9]

◆ GUARDED_BY() [9/9]

◆ MakeTried()

◆ RandomInt()

◆ ResolveCollisions()

◆ ResolveCollisions_()

◆ Select()

◆ Select_()

◆ SelectTriedCollision()

◆ SelectTriedCollision_()

◆ Serialize()

◆ SetServices()

◆ SetServices_()

◆ size()

◆ SwapRandom()

◆ Unserialize()

Member Data Documentation

◆ cs

◆ insecure_rand

◆ m_tried_collisions

◆ nKey