17611467588

Committed 10 Sep 2025 10:53AM UTC coverage: 66.01% (+0.03%) from 65.978%

Build # 17611467588

Build Type

Pull #16108

github

Committed by

web-flow

Commit Message

Merge b6eb1a724 into 29382c4af

Pull Request Pull Request #16108: dnsdist: implement simple packet shuffle in cache

Run Details

42255 of 92634 branches covered (45.62%)

Branch coverage included in aggregate %.

9 of 120 new or added lines in 6 files covered. (7.5%)

12 existing lines in 5 files now uncovered.

128490 of 166031 relevant lines covered (77.39%)

5519579.39 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.55

/pdns/recursordist/recpacketcache.hh

/*
 * This file is part of PowerDNS or dnsdist.
 * Copyright -- PowerDNS.COM B.V. and its contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * In addition, for the avoidance of any doubt, permission is granted to
 * link this program with OpenSSL and to (re)distribute the binaries
 * produced as the result of such linking.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#pragma once
#include <string>
#include <cinttypes>
#include "dns.hh"
#include "namespaces.hh"
#include <iostream>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/key_extractors.hpp>
#include <boost/optional.hpp>

#include "packetcache.hh"
#include "validate.hh"
#include "lock.hh"
#include "stat_t.hh"

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

using namespace ::boost::multi_index;

class RecursorPacketCache : public PacketCache
{
public:
  static unsigned int s_refresh_ttlperc;

  struct PBData
  {
    std::string d_message;
    std::string d_response;
    bool d_tagged;
  };
  using OptPBData = boost::optional<PBData>;

  RecursorPacketCache(size_t maxsize, size_t shards = 1024) :
    d_maps(shards)
  {
    setMaxSize(maxsize);
  }

  bool getResponsePacket(unsigned int tag, const std::string& queryPacket, time_t now,
                         std::string* responsePacket, uint32_t* age, uint32_t* qhash)
  {
    DNSName qname;
    uint16_t qtype{0};
    uint16_t qclass{0};
    vState valState{vState::Indeterminate};
    return getResponsePacket(tag, queryPacket, qname, &qtype, &qclass, now, responsePacket, age, &valState, qhash, nullptr, false);
  }

  bool getResponsePacket(unsigned int tag, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass, time_t now,
                         std::string* responsePacket, uint32_t* age, uint32_t* qhash)
  {
    vState valState{vState::Indeterminate};
    return getResponsePacket(tag, queryPacket, qname, qtype, qclass, now, responsePacket, age, &valState, qhash, nullptr, false);
  }

  bool getResponsePacket(unsigned int tag, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass, time_t now, std::string* responsePacket, uint32_t* age, vState* valState, uint32_t* qhash, OptPBData* pbdata, bool tcp);
  bool getResponsePacket(unsigned int tag, const std::string& queryPacket, DNSName& qname, uint16_t* qtype, uint16_t* qclass, time_t now, std::string* responsePacket, uint32_t* age, vState* valState, uint32_t* qhash, OptPBData* pbdata, bool tcp);

  void insertResponsePacket(unsigned int tag, uint32_t qhash, std::string&& query, const DNSName& qname, uint16_t qtype, uint16_t qclass, std::string&& responsePacket, time_t now, uint32_t ttl, const vState& valState, OptPBData&& pbdata, bool tcp);
  void doPruneTo(time_t now, size_t maxSize);
  uint64_t doDump(int file);
  uint64_t doWipePacketCache(const DNSName& name, uint16_t qtype = 0xffff, bool subtree = false);

  void setMaxSize(size_t size)
  {
    if (size < d_maps.size()) {
      size = d_maps.size();
    }
    setShardSizes(size / d_maps.size());
  }

  [[nodiscard]] uint64_t size() const;
  [[nodiscard]] uint64_t bytes();
  [[nodiscard]] uint64_t getHits();
  [[nodiscard]] uint64_t getMisses();
  [[nodiscard]] pair<uint64_t, uint64_t> stats();

private:
  struct Entry
  {
    Entry(DNSName&& qname, uint16_t qtype, uint16_t qclass, std::string&& packet, std::string&& query, bool tcp,
          // NOLINTNEXTLINE(bugprone-easily-swappable-parameters)
          uint32_t qhash, time_t ttd, time_t now, uint32_t tag, vState vstate) :
      d_name(std::move(qname)),
      d_packet(std::move(packet)),
      d_query(std::move(query)),
      d_ttd(ttd),
      d_creation(now),
      d_qhash(qhash),
      d_tag(tag),
      d_type(qtype),
      d_class(qclass),
      d_vstate(vstate),
      d_tcp(tcp)
    {
    }

    DNSName d_name;
    mutable std::string d_packet;
    mutable std::string d_query;
    mutable OptPBData d_pbdata;
    mutable time_t d_ttd;
    mutable time_t d_creation; // so we can 'age' our packets
    uint32_t d_qhash;
    uint32_t d_tag;
    uint16_t d_type;
    uint16_t d_class;
    mutable vState d_vstate;
    mutable bool d_submitted{false}; // whether this entry has been queued for refetch
    bool d_tcp; // whether this entry was created from a TCP query
    inline bool operator<(const struct Entry& rhs) const;

    bool isStale(time_t now) const
    {
      return d_ttd < now;
    }

    uint32_t getOrigTTL() const
    {
      return d_ttd - d_creation;
    }
  };

  struct HashTag
  {
  };
  struct NameTag
  {
  };
  struct SequencedTag
  {
  };
  using packetCache_t = multi_index_container<Entry,
                                              indexed_by<hashed_non_unique<tag<HashTag>,
                                                                           composite_key<Entry,
                                                                                         member<Entry, uint32_t, &Entry::d_tag>,
                                                                                         member<Entry, uint32_t, &Entry::d_qhash>,
                                                                                         member<Entry, bool, &Entry::d_tcp>>>,
                                                         sequenced<tag<SequencedTag>>,
                                                         ordered_non_unique<tag<NameTag>, member<Entry, DNSName, &Entry::d_name>, CanonDNSNameCompare>>>;

  struct MapCombo
  {
    MapCombo() = default;
    ~MapCombo() = default;
    MapCombo(const MapCombo&) = delete;
    MapCombo(MapCombo&&) = delete;
    MapCombo& operator=(const MapCombo&) = delete;
    MapCombo& operator=(MapCombo&&) = delete;

    struct LockedContent
    {
      packetCache_t d_map;
      size_t d_shardSize{0};
      uint64_t d_hits{0};
      uint64_t d_misses{0};
      uint64_t d_contended_count{0};
      uint64_t d_acquired_count{0};
      void invalidate() {}
      void preRemoval(const Entry& /* entry */) {}
    };

    LockGuardedTryHolder<MapCombo::LockedContent> lock()
    {
      auto locked = d_content.try_lock();
      if (!locked.owns_lock()) {
        locked.lock();
        ++locked->d_contended_count;
      }
      ++locked->d_acquired_count;
      return locked;
    }

    [[nodiscard]] auto getEntriesCount() const
    {
      return d_entriesCount.load();
    }

    void incEntriesCount()
    {
      ++d_entriesCount;
    }

    void decEntriesCount()
    {
      --d_entriesCount;
    }

  private:
    LockGuarded<LockedContent> d_content;
    pdns::stat_t d_entriesCount{0};
  };

  vector<MapCombo> d_maps;

  static size_t combine(unsigned int tag, uint32_t hash, bool tcp)
  {
    size_t ret = 0;
    boost::hash_combine(ret, tag);
    boost::hash_combine(ret, hash);
    boost::hash_combine(ret, tcp);
    return ret;
  }

  MapCombo& getMap(unsigned int tag, uint32_t hash, bool tcp)
  {
    return d_maps.at(combine(tag, hash, tcp) % d_maps.size());
  }

  [[nodiscard]] const MapCombo& getMap(unsigned int tag, uint32_t hash, bool tcp) const
  {
    return d_maps.at(combine(tag, hash, tcp) % d_maps.size());
  }

  static bool qrMatch(const packetCache_t::index<HashTag>::type::iterator& iter, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass);
  static bool checkResponseMatches(MapCombo::LockedContent& shard, std::pair<packetCache_t::index<HashTag>::type::iterator, packetCache_t::index<HashTag>::type::iterator> range, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass, time_t now, std::string* responsePacket, uint32_t* age, vState* valState, OptPBData* pbdata);

  void setShardSizes(size_t shardSize);
};

1	/*
2	* This file is part of PowerDNS or dnsdist.
3	* Copyright -- PowerDNS.COM B.V. and its contributors
4	*
5	* This program is free software; you can redistribute it and/or modify
6	* it under the terms of version 2 of the GNU General Public License as
7	* published by the Free Software Foundation.
8	*
9	* In addition, for the avoidance of any doubt, permission is granted to
10	* link this program with OpenSSL and to (re)distribute the binaries
11	* produced as the result of such linking.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License
19	* along with this program; if not, write to the Free Software
20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21	*/
22	#pragma once
23	#include <string>
24	#include <cinttypes>
25	#include "dns.hh"
26	#include "namespaces.hh"
27	#include <iostream>
28	#include <boost/multi_index_container.hpp>
29	#include <boost/multi_index/ordered_index.hpp>
30	#include <boost/multi_index/hashed_index.hpp>
31	#include <boost/multi_index/sequenced_index.hpp>
32	#include <boost/multi_index/key_extractors.hpp>
33	#include <boost/optional.hpp>
34
35	#include "packetcache.hh"
36	#include "validate.hh"
37	#include "lock.hh"
38	#include "stat_t.hh"
39
40	#ifdef HAVE_CONFIG_H
41	#include "config.h"
42	#endif
43
44	using namespace ::boost::multi_index;
45
46	class RecursorPacketCache : public PacketCache
47	{
48	public:
49	static unsigned int s_refresh_ttlperc;
50
51	struct PBData
52	{
53	std::string d_message;
54	std::string d_response;
55	bool d_tagged;
56	};
57	using OptPBData = boost::optional<PBData>;
58
59	RecursorPacketCache(size_t maxsize, size_t shards = 1024) :
60	d_maps(shards)
61	{	178✔
62	setMaxSize(maxsize);	178✔
63	}	178✔
64
65	bool getResponsePacket(unsigned int tag, const std::string& queryPacket, time_t now,
66	std::string* responsePacket, uint32_t* age, uint32_t* qhash)
67	{	32✔
68	DNSName qname;	32✔
69	uint16_t qtype{0};	32✔
70	uint16_t qclass{0};	32✔
71	vState valState{vState::Indeterminate};	32✔
72	return getResponsePacket(tag, queryPacket, qname, &qtype, &qclass, now, responsePacket, age, &valState, qhash, nullptr, false);	32✔
73	}	32✔
74
75	bool getResponsePacket(unsigned int tag, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass, time_t now,
76	std::string* responsePacket, uint32_t* age, uint32_t* qhash)
77	{	36✔
78	vState valState{vState::Indeterminate};	36✔
79	return getResponsePacket(tag, queryPacket, qname, qtype, qclass, now, responsePacket, age, &valState, qhash, nullptr, false);	36✔
80	}	36✔
81
82	bool getResponsePacket(unsigned int tag, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass, time_t now, std::string* responsePacket, uint32_t* age, vState* valState, uint32_t* qhash, OptPBData* pbdata, bool tcp);
83	bool getResponsePacket(unsigned int tag, const std::string& queryPacket, DNSName& qname, uint16_t* qtype, uint16_t* qclass, time_t now, std::string* responsePacket, uint32_t* age, vState* valState, uint32_t* qhash, OptPBData* pbdata, bool tcp);
84
85	void insertResponsePacket(unsigned int tag, uint32_t qhash, std::string&& query, const DNSName& qname, uint16_t qtype, uint16_t qclass, std::string&& responsePacket, time_t now, uint32_t ttl, const vState& valState, OptPBData&& pbdata, bool tcp);
86	void doPruneTo(time_t now, size_t maxSize);
87	uint64_t doDump(int file);
88	uint64_t doWipePacketCache(const DNSName& name, uint16_t qtype = 0xffff, bool subtree = false);
89
90	void setMaxSize(size_t size)
91	{	178✔
92	if (size < d_maps.size()) {	178✔
93	size = d_maps.size();	10✔
94	}	10✔
95	setShardSizes(size / d_maps.size());	178✔
96	}	178✔
97
98	[[nodiscard]] uint64_t size() const;
99	[[nodiscard]] uint64_t bytes();
100	[[nodiscard]] uint64_t getHits();
101	[[nodiscard]] uint64_t getMisses();
102	[[nodiscard]] pair<uint64_t, uint64_t> stats();
103
104	private:
105	struct Entry
106	{
107	Entry(DNSName&& qname, uint16_t qtype, uint16_t qclass, std::string&& packet, std::string&& query, bool tcp,
108	// NOLINTNEXTLINE(bugprone-easily-swappable-parameters)
109	uint32_t qhash, time_t ttd, time_t now, uint32_t tag, vState vstate) :
110	d_name(std::move(qname)),
111	d_packet(std::move(packet)),
112	d_query(std::move(query)),
113	d_ttd(ttd),
114	d_creation(now),
115	d_qhash(qhash),
116	d_tag(tag),
117	d_type(qtype),
118	d_class(qclass),
119	d_vstate(vstate),
120	d_tcp(tcp)
121	{	2,169✔
122	}	2,169✔
123
124	DNSName d_name;
125	mutable std::string d_packet;
126	mutable std::string d_query;
127	mutable OptPBData d_pbdata;
128	mutable time_t d_ttd;
129	mutable time_t d_creation; // so we can 'age' our packets
130	uint32_t d_qhash;
131	uint32_t d_tag;
132	uint16_t d_type;
133	uint16_t d_class;
134	mutable vState d_vstate;
135	mutable bool d_submitted{false}; // whether this entry has been queued for refetch
136	bool d_tcp; // whether this entry was created from a TCP query
137	inline bool operator<(const struct Entry& rhs) const;
138
139	bool isStale(time_t now) const
140	{	1,610✔
141	return d_ttd < now;	1,610✔
142	}	1,610✔
143
144	uint32_t getOrigTTL() const
145	{	2,775✔
146	return d_ttd - d_creation;	2,775✔
147	}	2,775✔
148	};
149
150	struct HashTag
151	{
152	};
153	struct NameTag
154	{
155	};
156	struct SequencedTag
157	{
158	};
159	using packetCache_t = multi_index_container<Entry,
160	indexed_by<hashed_non_unique<tag<HashTag>,
161	composite_key<Entry,
162	member<Entry, uint32_t, &Entry::d_tag>,
163	member<Entry, uint32_t, &Entry::d_qhash>,
164	member<Entry, bool, &Entry::d_tcp>>>,
165	sequenced<tag<SequencedTag>>,
166	ordered_non_unique<tag<NameTag>, member<Entry, DNSName, &Entry::d_name>, CanonDNSNameCompare>>>;
167
168	struct MapCombo
169	{
170	MapCombo() = default;	182,272✔
171	~MapCombo() = default;	10,240✔
172	MapCombo(const MapCombo&) = delete;
173	MapCombo(MapCombo&&) = delete;
174	MapCombo& operator=(const MapCombo&) = delete;
175	MapCombo& operator=(MapCombo&&) = delete;
176
177	struct LockedContent
178	{
179	packetCache_t d_map;
180	size_t d_shardSize{0};
181	uint64_t d_hits{0};
182	uint64_t d_misses{0};
183	uint64_t d_contended_count{0};
184	uint64_t d_acquired_count{0};
185	void invalidate() {}	76,812✔
186	void preRemoval(const Entry& /* entry */) {}	33✔
187	};
188
189	LockGuardedTryHolder<MapCombo::LockedContent> lock()
190	{	1,433,379✔
191	auto locked = d_content.try_lock();	1,433,379✔
192	if (!locked.owns_lock()) {	1,433,379!
UNCOV 193	locked.lock();	×
UNCOV 194	++locked->d_contended_count;	×
UNCOV 195	}	×
196	++locked->d_acquired_count;	1,433,379✔
197	return locked;	1,433,379✔
198	}	1,433,379✔
199
200	[[nodiscard]] auto getEntriesCount() const
201	{	405,625✔
202	return d_entriesCount.load();	405,625✔
203	}	405,625✔
204
205	void incEntriesCount()
206	{	2,169✔
207	++d_entriesCount;	2,169✔
208	}	2,169✔
209
210	void decEntriesCount()
211	{	211✔
212	--d_entriesCount;	211✔
213	}	211✔
214
215	private:
216	LockGuarded<LockedContent> d_content;
217	pdns::stat_t d_entriesCount{0};
218	};
219
220	vector<MapCombo> d_maps;
221
222	static size_t combine(unsigned int tag, uint32_t hash, bool tcp)
223	{	8,897✔
224	size_t ret = 0;	8,897✔
225	boost::hash_combine(ret, tag);	8,897✔
226	boost::hash_combine(ret, hash);	8,897✔
227	boost::hash_combine(ret, tcp);	8,897✔
228	return ret;	8,897✔
229	}	8,897✔
230
231	MapCombo& getMap(unsigned int tag, uint32_t hash, bool tcp)
232	{	8,893✔
233	return d_maps.at(combine(tag, hash, tcp) % d_maps.size());	8,893✔
234	}	8,893✔
235
236	[[nodiscard]] const MapCombo& getMap(unsigned int tag, uint32_t hash, bool tcp) const
237	{	×
238	return d_maps.at(combine(tag, hash, tcp) % d_maps.size());	×
239	}	×
240
241	static bool qrMatch(const packetCache_t::index<HashTag>::type::iterator& iter, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass);
242	static bool checkResponseMatches(MapCombo::LockedContent& shard, std::pair<packetCache_t::index<HashTag>::type::iterator, packetCache_t::index<HashTag>::type::iterator> range, const std::string& queryPacket, const DNSName& qname, uint16_t qtype, uint16_t qclass, time_t now, std::string* responsePacket, uint32_t* age, vState* valState, OptPBData* pbdata);
243
244	void setShardSizes(size_t shardSize);
245	};

PowerDNS / pdns / 17611467588

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous