9855655376

Committed 08 Jul 2024 07:20AM UTC coverage: 66.338% (-0.04%) from 66.38%

Build # 9855655376

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #14435 from omoerbeek/backport-14425-to-rec-5.1.x

rec: Backport 14425 to rec 5.1.x: fix typo in log message

Run Details

16574 of 34958 branches covered (47.41%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

73 existing lines in 9 files now uncovered.

56761 of 75590 relevant lines covered (75.09%)

3576143.83 hits per line

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

53.13

/pdns/remote_logger.cc

#include <unistd.h>
#include "threadname.hh"
#include "remote_logger.hh"
#include <sys/uio.h>
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#ifdef PDNS_CONFIG_ARGS
#include "logger.hh"
#define WE_ARE_RECURSOR
#else
#include "dolog.hh"
#endif
#include "logging.hh"

bool CircularWriteBuffer::hasRoomFor(const std::string& str) const
{
  if (d_buffer.size() + 2 + str.size() > d_buffer.capacity()) {
    return false;
  }

  return true;
}

bool CircularWriteBuffer::write(const std::string& str)
{
  if (str.size() > std::numeric_limits<uint16_t>::max() || !hasRoomFor(str)) {
    return false;
  }

  uint16_t len = htons(str.size());
  const char* ptr = reinterpret_cast<const char*>(&len);
  d_buffer.insert(d_buffer.end(), ptr, ptr + 2);
  d_buffer.insert(d_buffer.end(), str.begin(), str.end());

  return true;
}

bool CircularWriteBuffer::flush(int fd)
{
  if (d_buffer.empty()) {
    // not optional, we report EOF otherwise
    return false;
  }

  auto arr1 = d_buffer.array_one();
  auto arr2 = d_buffer.array_two();

  struct iovec iov[2];
  int pos = 0;
  for(const auto& arr : {arr1, arr2}) {
    if(arr.second) {
      iov[pos].iov_base = arr.first;
      iov[pos].iov_len = arr.second;
      ++pos;
    }
  }

  ssize_t res = 0;
  do {
    res = writev(fd, iov, pos);

    if (res < 0) {
      if (errno == EINTR) {
        continue;
      }

      if (errno == EAGAIN || errno == EWOULDBLOCK) {
        return false;
      }

      /* we can't be sure we haven't sent a partial message,
         and we don't want to send the remaining part after reconnecting */
      d_buffer.clear();
      throw std::runtime_error("Couldn't flush a thing: " + stringerror());
    }
    else if (!res) {
      /* we can't be sure we haven't sent a partial message,
         and we don't want to send the remaining part after reconnecting */
      d_buffer.clear();
      throw std::runtime_error("EOF");
    }
  }
  while (res < 0);

  if (static_cast<size_t>(res) == d_buffer.size()) {
    d_buffer.clear();
  }
  else {
    while (res--) {
      d_buffer.pop_front();
    }
  }

  return true;
}

const std::string& RemoteLoggerInterface::toErrorString(Result r)
{
  static const std::array<std::string,5> str = {
    "Queued",
    "Queue full, dropping",
    "Not sending too large protobuf message",
    "Submiting to queue failed",
    "?"
  };
  auto i = static_cast<unsigned int>(r);
  return str[std::min(i, 4U)];
}

RemoteLogger::RemoteLogger(const ComboAddress& remote, uint16_t timeout, uint64_t maxQueuedBytes, uint8_t reconnectWaitTime, bool asyncConnect): d_remote(remote), d_timeout(timeout), d_reconnectWaitTime(reconnectWaitTime), d_asyncConnect(asyncConnect), d_runtime({CircularWriteBuffer(maxQueuedBytes), nullptr})
{
  if (!d_asyncConnect) {
    reconnect();
  }

  d_thread = std::thread(&RemoteLogger::maintenanceThread, this);
}

bool RemoteLogger::reconnect()
{
  try {
    auto newSock = make_unique<Socket>(d_remote.sin4.sin_family, SOCK_STREAM, 0);
    newSock->setNonBlocking();
    newSock->connect(d_remote, d_timeout);

    {
      /* we are now successfully connected, time to take the lock and update the
         socket */
      auto runtime = d_runtime.lock();
      runtime->d_socket = std::move(newSock);
    }
  }
  catch (const std::exception& e) {
#ifdef WE_ARE_RECURSOR
    SLOG(g_log<<Logger::Warning<<"Error connecting to remote logger "<<d_remote.toStringWithPort()<<": "<<e.what()<<std::endl,
         g_slog->withName("protobuf")->error(Logr::Error, e.what(), "Exception while connecting to remote logger", "address", Logging::Loggable(d_remote)));
#else
    warnlog("Error connecting to remote logger %s: %s", d_remote.toStringWithPort(), e.what());
#endif

    return false;
  }
  return true;
}

RemoteLoggerInterface::Result RemoteLogger::queueData(const std::string& data)
{
  auto runtime = d_runtime.lock();

  if (data.size() > std::numeric_limits<uint16_t>::max()) {
    ++runtime->d_stats.d_tooLarge;
    return Result::TooLarge;
  }

  if (!runtime->d_writer.hasRoomFor(data)) {
    /* not connected, queue is full, just drop */
    if (!runtime->d_socket) {
      ++runtime->d_stats.d_pipeFull;
      return Result::PipeFull;
    }
    try {
      /* we try to flush some data */
      if (!runtime->d_writer.flush(runtime->d_socket->getHandle())) {
        /* but failed, let's just drop */
        ++runtime->d_stats.d_pipeFull;
        return Result::PipeFull;
      }

      /* see if we freed enough data */
      if (!runtime->d_writer.hasRoomFor(data)) {
        /* we didn't */
        ++runtime->d_stats.d_pipeFull;
        return Result::PipeFull;
      }
    }
    catch(const std::exception& e) {
      //      cout << "Got exception writing: "<<e.what()<<endl;
      runtime->d_socket.reset();
      ++runtime->d_stats.d_otherError;
      return Result::OtherError;
    }
  }

  runtime->d_writer.write(data);
  ++runtime->d_stats.d_queued;
  return Result::Queued;
}

void RemoteLogger::maintenanceThread() 
{
  try {
#ifdef WE_ARE_RECURSOR
    string threadName = "rec/remlog";
#else
    string threadName = "dnsdist/remLog";
#endif
    setThreadName(threadName);

    for (;;) {
      if (d_exiting) {
        break;
      }

      bool connected = true;
      if (d_runtime.lock()->d_socket == nullptr) {
        // if it was unset, it will remain so, we are the only ones setting it!
        connected = reconnect();
      }

      /* we will just go to sleep if the reconnection just failed */
      if (connected) {
        try {
          /* we don't want to take the lock while trying to reconnect */
          auto runtime = d_runtime.lock();
          if (runtime->d_socket) { // check if it is set
            /* if flush() returns false, it means that we couldn't flush anything yet
               either because there is nothing to flush, or because the outgoing TCP
               buffer is full. That's fine by us */
            runtime->d_writer.flush(runtime->d_socket->getHandle());
          }
          else {
            connected = false;
          }
        }
        catch (const std::exception& e) {
          d_runtime.lock()->d_socket.reset();
          connected = false;
        }

        if (!connected) {
          /* let's try to reconnect right away, we are about to sleep anyway */
          reconnect();
        }
      }

      sleep(d_reconnectWaitTime);
    }
  }
  catch (const std::exception& e)
  {
    SLOG(cerr << "Remote Logger's maintenance thread died on: " << e.what() << endl,
         g_slog->withName("protobuf")->error(Logr::Error, e.what(), "Remote Logger's maintenance thread died"));
  }
  catch (...) {
    SLOG(cerr << "Remote Logger's maintenance thread died on unknown exception" << endl,
         g_slog->withName("protobuf")->info(Logr::Error, "Remote Logger's maintenance thread died"));
  }
}

RemoteLogger::~RemoteLogger()
{
  d_exiting = true;

  d_thread.join();
}


1	#include <unistd.h>
2	#include "threadname.hh"
3	#include "remote_logger.hh"
4	#include <sys/uio.h>
5	#ifdef HAVE_CONFIG_H
6	#include "config.h"
7	#endif
8	#ifdef PDNS_CONFIG_ARGS
9	#include "logger.hh"
10	#define WE_ARE_RECURSOR
11	#else
12	#include "dolog.hh"
13	#endif
14	#include "logging.hh"
15
16	bool CircularWriteBuffer::hasRoomFor(const std::string& str) const
17	{	344✔
18	if (d_buffer.size() + 2 + str.size() > d_buffer.capacity()) {	344!
19	return false;	×
20	}	×
21
22	return true;	344✔
23	}	344✔
24
25	bool CircularWriteBuffer::write(const std::string& str)
26	{	172✔
27	if (str.size() > std::numeric_limits<uint16_t>::max() \|\| !hasRoomFor(str)) {	172!
28	return false;	×
29	}	×
30
31	uint16_t len = htons(str.size());	172✔
32	const char* ptr = reinterpret_cast<const char*>(&len);	172✔
33	d_buffer.insert(d_buffer.end(), ptr, ptr + 2);	172✔
34	d_buffer.insert(d_buffer.end(), str.begin(), str.end());	172✔
35
36	return true;	172✔
37	}	172✔
38
39	bool CircularWriteBuffer::flush(int fd)
40	{	902✔
41	if (d_buffer.empty()) {	902✔
42	// not optional, we report EOF otherwise
43	return false;	822✔
44	}	822✔
45
46	auto arr1 = d_buffer.array_one();	80✔
47	auto arr2 = d_buffer.array_two();	80✔
48
49	struct iovec iov[2];	80✔
50	int pos = 0;	80✔
51	for(const auto& arr : {arr1, arr2}) {	161✔
52	if(arr.second) {	161✔
53	iov[pos].iov_base = arr.first;	81✔
54	iov[pos].iov_len = arr.second;	81✔
55	++pos;	81✔
56	}	81✔
57	}	161✔
58
59	ssize_t res = 0;	80✔
60	do {	80✔
61	res = writev(fd, iov, pos);	80✔
62
63	if (res < 0) {	80!
64	if (errno == EINTR) {	×
65	continue;	×
66	}	×
67
68	if (errno == EAGAIN \|\| errno == EWOULDBLOCK) {	×
69	return false;	×
70	}	×
71
72	/* we can't be sure we haven't sent a partial message,
73	and we don't want to send the remaining part after reconnecting */
74	d_buffer.clear();	×
75	throw std::runtime_error("Couldn't flush a thing: " + stringerror());	×
76	}	×
77	else if (!res) {	80!
78	/* we can't be sure we haven't sent a partial message,
79	and we don't want to send the remaining part after reconnecting */
80	d_buffer.clear();	×
81	throw std::runtime_error("EOF");	×
82	}	×
83	}	80✔
84	while (res < 0);	80!
85
86	if (static_cast<size_t>(res) == d_buffer.size()) {	80!
87	d_buffer.clear();	80✔
88	}	80✔
UNCOV 89	else {	×
UNCOV 90	while (res--) {	×
91	d_buffer.pop_front();	×
92	}	×
UNCOV 93	}	×
94
95	return true;	80✔
96	}	80✔
97
98	const std::string& RemoteLoggerInterface::toErrorString(Result r)
99	{	×
100	static const std::array<std::string,5> str = {	×
101	"Queued",	×
102	"Queue full, dropping",	×
103	"Not sending too large protobuf message",	×
104	"Submiting to queue failed",	×
105	"?"	×
106	};	×
107	auto i = static_cast<unsigned int>(r);	×
108	return str[std::min(i, 4U)];	×
109	}	×
110
111	RemoteLogger::RemoteLogger(const ComboAddress& remote, uint16_t timeout, uint64_t maxQueuedBytes, uint8_t reconnectWaitTime, bool asyncConnect): d_remote(remote), d_timeout(timeout), d_reconnectWaitTime(reconnectWaitTime), d_asyncConnect(asyncConnect), d_runtime({CircularWriteBuffer(maxQueuedBytes), nullptr})
112	{	220✔
113	if (!d_asyncConnect) {	220✔
114	reconnect();	219✔
115	}	219✔
116
117	d_thread = std::thread(&RemoteLogger::maintenanceThread, this);	220✔
118	}	220✔
119
120	bool RemoteLogger::reconnect()
121	{	220✔
122	try {	220✔
123	auto newSock = make_unique<Socket>(d_remote.sin4.sin_family, SOCK_STREAM, 0);	220✔
124	newSock->setNonBlocking();	220✔
125	newSock->connect(d_remote, d_timeout);	220✔
126
127	{	220✔
128	/* we are now successfully connected, time to take the lock and update the
129	socket */
130	auto runtime = d_runtime.lock();	220✔
131	runtime->d_socket = std::move(newSock);	220✔
132	}	220✔
133	}	220✔
134	catch (const std::exception& e) {	220✔
135	#ifdef WE_ARE_RECURSOR	×
136	SLOG(g_log<<Logger::Warning<<"Error connecting to remote logger "<<d_remote.toStringWithPort()<<": "<<e.what()<<std::endl,	×
137	g_slog->withName("protobuf")->error(Logr::Error, e.what(), "Exception while connecting to remote logger", "address", Logging::Loggable(d_remote)));	×
138	#else
139	warnlog("Error connecting to remote logger %s: %s", d_remote.toStringWithPort(), e.what());
140	#endif
141
142	return false;	×
143	}	×
144	return true;	220✔
145	}	220✔
146
147	RemoteLoggerInterface::Result RemoteLogger::queueData(const std::string& data)
148	{	172✔
149	auto runtime = d_runtime.lock();	172✔
150
151	if (data.size() > std::numeric_limits<uint16_t>::max()) {	172!
152	++runtime->d_stats.d_tooLarge;	×
153	return Result::TooLarge;	×
154	}	×
155
156	if (!runtime->d_writer.hasRoomFor(data)) {	172!
157	/* not connected, queue is full, just drop */
158	if (!runtime->d_socket) {	×
159	++runtime->d_stats.d_pipeFull;	×
160	return Result::PipeFull;	×
161	}	×
162	try {	×
163	/* we try to flush some data */
164	if (!runtime->d_writer.flush(runtime->d_socket->getHandle())) {	×
165	/* but failed, let's just drop */
166	++runtime->d_stats.d_pipeFull;	×
167	return Result::PipeFull;	×
168	}	×
169
170	/* see if we freed enough data */
171	if (!runtime->d_writer.hasRoomFor(data)) {	×
172	/* we didn't */
173	++runtime->d_stats.d_pipeFull;	×
174	return Result::PipeFull;	×
175	}	×
176	}	×
177	catch(const std::exception& e) {	×
178	// cout << "Got exception writing: "<<e.what()<<endl;
179	runtime->d_socket.reset();	×
180	++runtime->d_stats.d_otherError;	×
181	return Result::OtherError;	×
182	}	×
183	}	×
184
185	runtime->d_writer.write(data);	172✔
186	++runtime->d_stats.d_queued;	172✔
187	return Result::Queued;	172✔
188	}	172✔
189
190	void RemoteLogger::maintenanceThread()
191	{	220✔
192	try {	220✔
193	#ifdef WE_ARE_RECURSOR	220✔
194	string threadName = "rec/remlog";	220✔
195	#else
196	string threadName = "dnsdist/remLog";
197	#endif
198	setThreadName(threadName);	220✔
199
200	for (;;) {	906✔
201	if (d_exiting) {	906!
202	break;	×
203	}	×
204
205	bool connected = true;	906✔
206	if (d_runtime.lock()->d_socket == nullptr) {	906!
207	// if it was unset, it will remain so, we are the only ones setting it!
208	connected = reconnect();	×
209	}	×
210
211	/* we will just go to sleep if the reconnection just failed */
212	if (connected) {	906✔
213	try {	905✔
214	/* we don't want to take the lock while trying to reconnect */
215	auto runtime = d_runtime.lock();	905✔
216	if (runtime->d_socket) { // check if it is set	906✔
217	/* if flush() returns false, it means that we couldn't flush anything yet
218	either because there is nothing to flush, or because the outgoing TCP
219	buffer is full. That's fine by us */
220	runtime->d_writer.flush(runtime->d_socket->getHandle());	906✔
221	}	906✔
222	else {	2,147,483,647✔
223	connected = false;	2,147,483,647✔
224	}	2,147,483,647✔
225	}	905✔
226	catch (const std::exception& e) {	905✔
227	d_runtime.lock()->d_socket.reset();	×
228	connected = false;	×
229	}	×
230
231	if (!connected) {	905!
232	/* let's try to reconnect right away, we are about to sleep anyway */
233	reconnect();	×
234	}	×
235	}	904✔
236
237	sleep(d_reconnectWaitTime);	906✔
238	}	905✔
239	}	220✔
240	catch (const std::exception& e)	220✔
241	{	220✔
242	SLOG(cerr << "Remote Logger's maintenance thread died on: " << e.what() << endl,	×
243	g_slog->withName("protobuf")->error(Logr::Error, e.what(), "Remote Logger's maintenance thread died"));	×
244	}	×
245	catch (...) {	220✔
246	SLOG(cerr << "Remote Logger's maintenance thread died on unknown exception" << endl,	×
247	g_slog->withName("protobuf")->info(Logr::Error, "Remote Logger's maintenance thread died"));	×
248	}	×
249	}	220✔
250
251	RemoteLogger::~RemoteLogger()
252	{	×
253	d_exiting = true;	×
254
255	d_thread.join();	×
256	}	×
257

PowerDNS / pdns / 9855655376

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