netevent.c File Reference

This file contains event notification functions. More...

#include "config.h"
#include "util/netevent.h"
#include "util/ub_event.h"
#include "util/log.h"
#include "util/net_help.h"
#include "util/tcp_conn_limit.h"
#include "util/fptr_wlist.h"
#include "util/proxy_protocol.h"
#include "util/timeval_func.h"
#include "sldns/pkthdr.h"
#include "sldns/sbuffer.h"
#include "sldns/str2wire.h"
#include "dnstap/dnstap.h"
#include "dnscrypt/dnscrypt.h"
#include "services/listen_dnsport.h"
#include "util/random.h"

Data Structures

struct  internal_event
 The internal event structure for keeping ub_event info for the event. More...
 
struct  internal_base
 Internal base structure, so that every thread has its own events. More...
 
struct  internal_timer
 Internal timer structure, to store timer event in. More...
 
struct  internal_signal
 Internal signal structure, to store signal event in. More...
 

Macros

#define CMSG_ALIGN(len)   (((len)+sizeof(long)-1) & ~(sizeof(long)-1))
 if CMSG_ALIGN is not defined on this platform, a workaround
 
#define CMSG_LEN(len)   (CMSG_ALIGN(sizeof(struct cmsghdr))+(len))
 if CMSG_LEN is not defined on this platform, a workaround
 
#define CMSG_SPACE(l)   (CMSG_ALIGN(l)+CMSG_ALIGN(sizeof(struct cmsghdr)))
 if CMSG_SPACE is not defined on this platform, a workaround
 
#define TCP_QUERY_TIMEOUT   120000
 The TCP writing query timeout in milliseconds.
 
#define TCP_QUERY_TIMEOUT_MINIMUM   200
 The minimum actual TCP timeout to use, regardless of what we advertise, in msec.
 
#define NUM_UDP_PER_SELECT   100
 number of UDP reads to perform per read indication from select
 
#define SEND_BLOCKED_WAIT_TIMEOUT   200
 timeout in millisec to wait for write to unblock, packets dropped after.
 
#define SEND_BLOCKED_MAX_RETRY   5
 max number of times to wait for write to unblock, packets dropped after.
 
#define SO_TIMESTAMP   29
 Let's make timestamping code cleaner and redefine SO_TIMESTAMP*.
 
#define SO_TIMESTAMPNS   35
 
#define SO_TIMESTAMPING   37
 

Functions

static struct comm_pointcomm_point_create_tcp_handler (struct comm_base *base, struct comm_point *parent, size_t bufsize, struct sldns_buffer *spoolbuf, comm_point_callback_type *callback, void *callback_arg, struct unbound_socket *socket)
 create a tcp handler with a parent
 
struct comm_basecomm_base_create (int sigs)
 Create a new comm base. More...
 
struct comm_basecomm_base_create_event (struct ub_event_base *base)
 Create comm base that uses the given ub_event_base (underlying pluggable event mechanism pointer). More...
 
void comm_base_delete (struct comm_base *b)
 Destroy a comm base. More...
 
void comm_base_delete_no_base (struct comm_base *b)
 Delete comm base structure but not the underlying lib event base. More...
 
void comm_base_timept (struct comm_base *b, time_t **tt, struct timeval **tv)
 Obtain two pointers. More...
 
void comm_base_dispatch (struct comm_base *b)
 Dispatch the comm base events. More...
 
void comm_base_exit (struct comm_base *b)
 Exit from dispatch loop. More...
 
void comm_base_set_slow_accept_handlers (struct comm_base *b, void(*stop_acc)(void *), void(*start_acc)(void *), void *arg)
 Set the slow_accept mode handlers. More...
 
struct ub_event_basecomm_base_internal (struct comm_base *b)
 Access internal data structure (for util/tube.c on windows) More...
 
static int udp_send_errno_needs_log (struct sockaddr *addr, socklen_t addrlen)
 see if errno for udp has to be logged or not uses globals
 
int tcp_connect_errno_needs_log (struct sockaddr *addr, socklen_t addrlen)
 See if errno for tcp connect has to be logged or not. More...
 
int comm_point_send_udp_msg (struct comm_point *c, sldns_buffer *packet, struct sockaddr *addr, socklen_t addrlen, int is_connected)
 Send an udp message over a commpoint. More...
 
static int comm_point_send_udp_msg_if (struct comm_point *c, sldns_buffer *packet, struct sockaddr *addr, socklen_t addrlen, struct comm_reply *r)
 send a UDP reply over specified interface
 
static int udp_recv_needs_log (int err)
 return true is UDP receive error needs to be logged
 
static int consume_pp2_header (struct sldns_buffer *buf, struct comm_reply *rep, int stream)
 Parses the PROXYv2 header from buf and updates the comm_reply struct. More...
 
void comm_point_udp_callback (int fd, short event, void *arg)
 This routine is published for checks and tests, and is only used internally. More...
 
int adjusted_tcp_timeout (struct comm_point *c)
 For TCP handlers that use c->tcp_timeout_msec, this routine adjusts it with the minimum. More...
 
static void setup_tcp_handler (struct comm_point *c, int fd, int cur, int max)
 Use a new tcp handler for new query fd, set to read query.
 
void comm_base_handle_slow_accept (int ATTR_UNUSED(fd), short ATTR_UNUSED(event), void *arg)
 
int comm_point_perform_accept (struct comm_point *c, struct sockaddr_storage *addr, socklen_t *addrlen)
 perform accept(2) with error checking. More...
 
void comm_point_tcp_accept_callback (int fd, short event, void *arg)
 This routine is published for checks and tests, and is only used internally. More...
 
static void reclaim_tcp_handler (struct comm_point *c)
 Make tcp handler free for next assignment.
 
static void tcp_callback_writer (struct comm_point *c)
 do the callback when writing is done
 
static void tcp_callback_reader (struct comm_point *c)
 do the callback when reading is done
 
static int ssl_handle_read (struct comm_point *c)
 continue ssl handshake More...
 
static int ssl_handle_write (struct comm_point *c)
 ssl write callback on TCP
 
static int ssl_handle_it (struct comm_point *c, int is_write)
 handle ssl tcp connection with dns contents
 
static int comm_point_tcp_handle_read (int fd, struct comm_point *c, int short_ok)
 Handle tcp reading callback. More...
 
static int comm_point_tcp_handle_write (int fd, struct comm_point *c)
 Handle tcp writing callback. More...
 
static int tcp_req_info_read_again (int fd, struct comm_point *c)
 read again to drain buffers when there could be more to read, returns 0 on failure which means the comm point is closed.
 
static void tcp_more_read_again (int fd, struct comm_point *c)
 read again to drain buffers when there could be more to read
 
static void tcp_more_write_again (int fd, struct comm_point *c)
 write again to fill up when there could be more to write
 
void comm_point_tcp_handle_callback (int fd, short event, void *arg)
 This routine is published for checks and tests, and is only used internally. More...
 
static void reclaim_http_handler (struct comm_point *c)
 Make http handler free for next assignment.
 
static int ssl_http_read_more (struct comm_point *c)
 read more data for http (with ssl)
 
static int http_read_more (int fd, struct comm_point *c)
 read more data for http
 
static int http_header_done (sldns_buffer *buf)
 return true if http header has been read (one line complete)
 
static char * http_header_line (sldns_buffer *buf)
 return character string into buffer for header line, moves buffer past that line and puts zero terminator into linefeed-newline
 
static void http_moveover_buffer (sldns_buffer *buf)
 move unread buffer to start and clear rest for putting the rest into it
 
static int http_process_initial_header (struct comm_point *c)
 a http header is complete, process it
 
static int http_process_chunk_header (struct comm_point *c)
 a chunk header is complete, process it, return 0=fail, 1=continue next header line, 2=done with chunked transfer
 
static int http_nonchunk_segment (struct comm_point *c)
 handle nonchunked data segment, 0=fail, 1=wait
 
static int http_chunked_segment (struct comm_point *c)
 handle chunked data segment, return 0=fail, 1=wait, 2=process more
 
static void http2_session_delete (struct http2_session *h2_session)
 Delete http2 session. More...
 
void http2_stream_add_meshstate (struct http2_stream *h2_stream, struct mesh_area *mesh, struct mesh_state *m)
 Add mesh state to stream. More...
 
void http2_stream_remove_mesh_state (struct http2_stream *h2_stream)
 Remove mesh state from stream. More...
 
static void http2_session_server_delete (struct http2_session *h2_session)
 delete http2 session server. More...
 
static int comm_point_http2_handle_read (int ATTR_UNUSED(fd), struct comm_point *c)
 Handle http2 read.
 
static int comm_point_http_handle_read (int fd, struct comm_point *c)
 Handle http reading callback. More...
 
static int http_check_connect (int fd, struct comm_point *c)
 check pending connect for http
 
static int ssl_http_write_more (struct comm_point *c)
 write more data for http (with ssl)
 
static int http_write_more (int fd, struct comm_point *c)
 write more data for http
 
static int comm_point_http2_handle_write (int ATTR_UNUSED(fd), struct comm_point *c)
 Handle http2 writing.
 
static int comm_point_http_handle_write (int fd, struct comm_point *c)
 Handle http writing callback. More...
 
void comm_point_http_handle_callback (int fd, short event, void *arg)
 This routine is published for checks and tests, and is only used internally. More...
 
void comm_point_local_handle_callback (int fd, short event, void *arg)
 This routine is published for checks and tests, and is only used internally. More...
 
void comm_point_raw_handle_callback (int ATTR_UNUSED(fd), short event, void *arg)
 
struct comm_pointcomm_point_create_udp (struct comm_base *base, int fd, sldns_buffer *buffer, int pp2_enabled, comm_point_callback_type *callback, void *callback_arg, struct unbound_socket *socket)
 Create an UDP comm point. More...
 
struct comm_pointcomm_point_create_doq (struct comm_base *base, int fd, sldns_buffer *buffer, comm_point_callback_type *callback, void *callback_arg, struct unbound_socket *socket, struct doq_table *table, struct ub_randstate *rnd, const char *ssl_service_key, const char *ssl_service_pem, struct config_file *cfg)
 Create an UDP comm point for DoQ. More...
 
static struct comm_pointcomm_point_create_http_handler (struct comm_base *base, struct comm_point *parent, size_t bufsize, int harden_large_queries, uint32_t http_max_streams, char *http_endpoint, comm_point_callback_type *callback, void *callback_arg, struct unbound_socket *socket)
 
struct comm_pointcomm_point_create_tcp (struct comm_base *base, int fd, int num, int idle_timeout, int harden_large_queries, uint32_t http_max_streams, char *http_endpoint, struct tcl_list *tcp_conn_limit, size_t bufsize, struct sldns_buffer *spoolbuf, enum listen_type port_type, int pp2_enabled, comm_point_callback_type *callback, void *callback_arg, struct unbound_socket *socket)
 Create a TCP listener comm point. More...
 
struct comm_pointcomm_point_create_tcp_out (struct comm_base *base, size_t bufsize, comm_point_callback_type *callback, void *callback_arg)
 Create an outgoing TCP commpoint. More...
 
struct comm_pointcomm_point_create_http_out (struct comm_base *base, size_t bufsize, comm_point_callback_type *callback, void *callback_arg, sldns_buffer *temp)
 Create an outgoing HTTP commpoint. More...
 
struct comm_pointcomm_point_create_local (struct comm_base *base, int fd, size_t bufsize, comm_point_callback_type *callback, void *callback_arg)
 Create commpoint to listen to a local domain file descriptor. More...
 
struct comm_pointcomm_point_create_raw (struct comm_base *base, int fd, int writing, comm_point_callback_type *callback, void *callback_arg)
 Create commpoint to listen to a local domain pipe descriptor. More...
 
void comm_point_close (struct comm_point *c)
 Close a comm point fd. More...
 
void comm_point_delete (struct comm_point *c)
 Close and deallocate (free) the comm point. More...
 
void comm_point_send_reply (struct comm_reply *repinfo)
 Send reply. More...
 
void comm_point_drop_reply (struct comm_reply *repinfo)
 Drop reply. More...
 
void comm_point_stop_listening (struct comm_point *c)
 Stop listening for input on the commpoint. More...
 
void comm_point_start_listening (struct comm_point *c, int newfd, int msec)
 Start listening again for input on the comm point. More...
 
void comm_point_listen_for_rw (struct comm_point *c, int rd, int wr)
 Stop listening and start listening again for reading or writing. More...
 
size_t comm_point_get_mem (struct comm_point *c)
 Get size of memory used by comm point. More...
 
struct comm_timercomm_timer_create (struct comm_base *base, void(*cb)(void *), void *cb_arg)
 create timer. More...
 
void comm_timer_disable (struct comm_timer *timer)
 disable timer. More...
 
void comm_timer_set (struct comm_timer *timer, struct timeval *tv)
 reset timevalue for timer. More...
 
void comm_timer_delete (struct comm_timer *timer)
 delete timer. More...
 
void comm_timer_callback (int ATTR_UNUSED(fd), short event, void *arg)
 
int comm_timer_is_set (struct comm_timer *timer)
 see if timeout has been set to a value. More...
 
size_t comm_timer_get_mem (struct comm_timer *ATTR_UNUSED(timer))
 
struct comm_signalcomm_signal_create (struct comm_base *base, void(*callback)(int, void *), void *cb_arg)
 Create a signal handler. More...
 
void comm_signal_callback (int sig, short event, void *arg)
 This routine is published for checks and tests, and is only used internally. More...
 
int comm_signal_bind (struct comm_signal *comsig, int sig)
 Bind signal struct to catch a signal. More...
 
void comm_signal_delete (struct comm_signal *comsig)
 Delete the signal communication point. More...
 

Detailed Description

This file contains event notification functions.

Function Documentation

◆ comm_base_create()

struct comm_base* comm_base_create ( int  sigs)

Create a new comm base.

Parameters
sigsif true it attempts to create a default loop for signal handling.
Returns
: the new comm base. NULL on error.

References internal_base::base, comm_base::eb, internal_base::now, internal_base::secs, ub_comm_base_now(), ub_default_event_base(), ub_get_event_sys(), VERB_ALGO, and verbose().

◆ comm_base_create_event()

struct comm_base* comm_base_create_event ( struct ub_event_base base)

Create comm base that uses the given ub_event_base (underlying pluggable event mechanism pointer).

Parameters
baseunderlying pluggable event base.
Returns
: the new comm base. NULL on error.

References internal_base::base, comm_base::eb, and ub_comm_base_now().

Referenced by libworker_setup().

◆ comm_base_delete()

void comm_base_delete ( struct comm_base b)

Destroy a comm base.

All comm points must have been deleted.

Parameters
bthe base to delete.

References internal_base::base, comm_base::eb, log_err(), internal_base::slow_accept, internal_base::slow_accept_enabled, ub_event_base_free(), ub_event_del(), and ub_event_free().

◆ comm_base_delete_no_base()

void comm_base_delete_no_base ( struct comm_base b)

Delete comm base structure but not the underlying lib event base.

All comm points must have been deleted.

Parameters
bthe base to delete.

References internal_base::base, comm_base::eb, log_err(), internal_base::slow_accept, internal_base::slow_accept_enabled, ub_event_del(), and ub_event_free().

Referenced by libworker_delete_event().

◆ comm_base_timept()

void comm_base_timept ( struct comm_base b,
time_t **  tt,
struct timeval **  tv 
)

Obtain two pointers.

The pointers never change (until base_delete()). The pointers point to time values that are updated regularly.

Parameters
bthe communication base that will update the time values.
ttpointer to time in seconds is returned.
tvpointer to time in microseconds is returned.

References comm_base::eb, internal_base::now, and internal_base::secs.

◆ comm_base_dispatch()

void comm_base_dispatch ( struct comm_base b)

Dispatch the comm base events.

Parameters
bthe communication to perform.

References internal_base::base, comm_base::eb, and ub_event_base_dispatch().

◆ comm_base_exit()

void comm_base_exit ( struct comm_base b)

Exit from dispatch loop.

Parameters
bthe communication base that is in dispatch().

References internal_base::base, comm_base::eb, log_err(), and ub_event_base_loopexit().

◆ comm_base_set_slow_accept_handlers()

void comm_base_set_slow_accept_handlers ( struct comm_base b,
void(*)(void *)  stop_accept,
void(*)(void *)  start_accept,
void *  arg 
)

Set the slow_accept mode handlers.

You can not provide these if you do not perform accept() calls.

Parameters
bcomm base
stop_acceptfunction that stops listening to accept fds.
start_acceptfunction that resumes listening to accept fds.
argcallback arg to pass to the functions.

References comm_base::cb_arg, comm_base::start_accept, and comm_base::stop_accept.

◆ comm_base_internal()

struct ub_event_base* comm_base_internal ( struct comm_base b)

Access internal data structure (for util/tube.c on windows)

Parameters
bcomm base
Returns
ub_event_base.

References internal_base::base, and comm_base::eb.

◆ tcp_connect_errno_needs_log()

int tcp_connect_errno_needs_log ( struct sockaddr *  addr,
socklen_t  addrlen 
)

See if errno for tcp connect has to be logged or not.

This uses errno

Parameters
addrapart from checking errno, the addr is checked for ip4mapped and broadcast type, hence passed.
addrlenlength of the addr parameter.
Returns
true if it needs to be logged.

References udp_send_errno_needs_log().

Referenced by comm_point_tcp_handle_write().

◆ comm_point_send_udp_msg()

int comm_point_send_udp_msg ( struct comm_point c,
struct sldns_buffer packet,
struct sockaddr *  addr,
socklen_t  addrlen,
int  is_connected 
)

Send an udp message over a commpoint.

Parameters
ccommpoint to send it from.
packetwhat to send.
addrwhere to send it to. If NULL, send is performed, for connected sockets, to the connected address.
addrlenlength of addr.
is_connectedif the UDP socket is connect()ed.
Returns
: false on a failure.

References internal_event::base, comm_base::eb, comm_point::ev, comm_point::fd, internal_base::last_writewait_log, log_addr(), log_assert, log_err(), internal_base::secs, SEND_BLOCKED_MAX_RETRY, SEND_BLOCKED_WAIT_TIMEOUT, sldns_buffer_begin(), sldns_buffer_remaining(), SLOW_LOG_TIME, sock_strerror(), udp_send_errno_needs_log(), VERB_OPS, and verbose().

Referenced by comm_point_udp_callback().

◆ consume_pp2_header()

static int consume_pp2_header ( struct sldns_buffer buf,
struct comm_reply rep,
int  stream 
)
static

Parses the PROXYv2 header from buf and updates the comm_reply struct.

Returns 1 on success, 0 on failure.

References PP2_HEADER_SIZE, pp2_read_header(), sldns_buffer_begin(), and sldns_buffer_remaining().

Referenced by comm_point_tcp_handle_read(), comm_point_udp_callback(), and ssl_handle_read().

◆ comm_point_udp_callback()

◆ adjusted_tcp_timeout()

int adjusted_tcp_timeout ( struct comm_point c)

For TCP handlers that use c->tcp_timeout_msec, this routine adjusts it with the minimum.

Otherwise, a 0 value advertised without the minimum applied moves to a 0 in comm_point_start_listening and that routine treats it as no timeout, listen forever, which is not wanted.

Parameters
ccomm point to use the tcp_timeout_msec of.
Returns
adjusted tcp_timeout_msec value with the minimum if smaller.

References TCP_QUERY_TIMEOUT_MINIMUM, and comm_point::tcp_timeout_msec.

Referenced by setup_tcp_handler(), tcp_callback_reader(), and tcp_callback_writer().

◆ comm_point_perform_accept()

int comm_point_perform_accept ( struct comm_point c,
struct sockaddr_storage *  addr,
socklen_t *  addrlen 
)

◆ comm_point_tcp_accept_callback()

◆ ssl_handle_read()

◆ comm_point_tcp_handle_read()

◆ comm_point_tcp_handle_write()

◆ comm_point_tcp_handle_callback()

◆ http2_session_delete()

static void http2_session_delete ( struct http2_session h2_session)
static

Delete http2 session.

After closing connection or on error

Referenced by comm_point_delete().

◆ http2_stream_add_meshstate()

void http2_stream_add_meshstate ( struct http2_stream h2_stream,
struct mesh_area mesh,
struct mesh_state m 
)

Add mesh state to stream.

To be able to remove mesh reply on stream closure

References http2_stream::mesh, and http2_stream::mesh_state.

◆ http2_stream_remove_mesh_state()

void http2_stream_remove_mesh_state ( struct http2_stream h2_stream)

Remove mesh state from stream.

When the mesh state has been removed.

References http2_stream::mesh_state.

◆ http2_session_server_delete()

static void http2_session_server_delete ( struct http2_session h2_session)
static

◆ comm_point_http_handle_read()

◆ comm_point_http_handle_write()

◆ comm_point_http_handle_callback()

void comm_point_http_handle_callback ( int  fd,
short  event,
void *  arg 
)

This routine is published for checks and tests, and is only used internally.

handle libevent callback for tcp data comm point

Parameters
fdfile descriptor.
eventevent bits from libevent: EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT.
argthe comm_point structure.

References internal_event::base, comm_point::callback, comm_point::cb_arg, comm_point::comm_http, comm_point_http_handle_read(), comm_point_http_handle_write(), comm_point::ev, comm_point::fd, fptr_ok, fptr_whitelist_comm_point(), log_assert, log_err(), NETEVENT_CLOSED, NETEVENT_TIMEOUT, reclaim_http_handler(), comm_point::tcp_do_close, comm_point::type, ub_comm_base_now(), UB_EV_READ, UB_EV_TIMEOUT, UB_EV_WRITE, VERB_QUERY, and verbose().

Referenced by comm_point_create_http_out(), and comm_point_tcp_accept_callback().

◆ comm_point_local_handle_callback()

void comm_point_local_handle_callback ( int  fd,
short  event,
void *  arg 
)

This routine is published for checks and tests, and is only used internally.

libevent callback for AF_UNIX fds

Parameters
fdfile descriptor.
eventevent bits from libevent: EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT.
argthe comm_point structure.

References internal_event::base, comm_point::callback, comm_point::cb_arg, comm_point::comm_local, comm_point_tcp_handle_read(), comm_point::ev, comm_point::fd, fptr_ok, fptr_whitelist_comm_point(), log_assert, log_err(), NETEVENT_CLOSED, comm_point::type, ub_comm_base_now(), and UB_EV_READ.

Referenced by comm_point_create_local().

◆ comm_point_create_udp()

struct comm_point* comm_point_create_udp ( struct comm_base base,
int  fd,
struct sldns_buffer buffer,
int  pp2_enabled,
comm_point_callback_type callback,
void *  callback_arg,
struct unbound_socket socket 
)

Create an UDP comm point.

Calls malloc. setups the structure with the parameters you provide.

Parameters
basein which base to alloc the commpoint.
fdfile descriptor of open UDP socket.
buffershared buffer by UDP sockets from this thread.
pp2_enabledif the comm point will support PROXYv2.
callbackcallback function pointer.
callback_argwill be passed to your callback function.
socketand opened socket properties will be passed to your callback function.
Returns
: returns the allocated communication point. NULL on error. Sets timeout to NULL. Turns off TCP options.

References internal_event::base, internal_base::base, comm_point::buffer, comm_point::callback, comm_point::cb_arg, comm_point_delete(), comm_point_udp_callback(), comm_point::cur_tcp_count, comm_point::do_not_close, comm_base::eb, internal_event::ev, comm_point::ev, comm_point::event_added, comm_point::fd, comm_point::inuse, log_err(), comm_point::max_tcp_count, comm_point::pp2_enabled, comm_point::pp2_header_state, comm_point::socket, comm_point::tcp_byte_count, comm_point::tcp_check_nb_connect, comm_point::tcp_do_close, comm_point::tcp_do_toggle_rw, comm_point::tcp_free, comm_point::tcp_handlers, comm_point::tcp_is_reading, comm_point::tcp_parent, comm_point::timeout, comm_point::type, UB_EV_PERSIST, UB_EV_READ, ub_event_add(), and ub_event_new().

◆ comm_point_create_doq()

struct comm_point* comm_point_create_doq ( struct comm_base base,
int  fd,
struct sldns_buffer buffer,
comm_point_callback_type callback,
void *  callback_arg,
struct unbound_socket socket,
struct doq_table *  table,
struct ub_randstate *  rnd,
const char *  ssl_service_key,
const char *  ssl_service_pem,
struct config_file cfg 
)

Create an UDP comm point for DoQ.

Calls malloc. setups the structure with the parameters you provide.

Parameters
basein which base to alloc the commpoint.
fd: file descriptor of open UDP socket.
buffershared buffer by UDP sockets from this thread.
callbackcallback function pointer.
callback_argwill be passed to your callback function.
socketand opened socket properties will be passed to your callback function.
tablethe doq connection table for the host.
rndrandom generator to use.
ssl_service_keythe ssl service key file.
ssl_service_pemthe ssl service pem file.
cfgconfig file struct.
Returns
: returns the allocated communication point. NULL on error. Sets timeout to NULL. Turns off TCP options.

References internal_event::base, internal_base::base, comm_point::buffer, comm_point::callback, comm_point::cb_arg, comm_point_delete(), comm_point_doq_callback(), comm_point::cur_tcp_count, comm_point::do_not_close, comm_base::eb, internal_event::ev, comm_point::ev, comm_point::event_added, comm_point::fd, comm_point::inuse, log_err(), comm_point::max_tcp_count, comm_point::pp2_enabled, comm_point::pp2_header_state, sock_close(), comm_point::socket, comm_point::tcp_byte_count, comm_point::tcp_check_nb_connect, comm_point::tcp_do_close, comm_point::tcp_do_toggle_rw, comm_point::tcp_free, comm_point::tcp_handlers, comm_point::tcp_is_reading, comm_point::tcp_parent, comm_point::timeout, comm_point::type, UB_EV_PERSIST, UB_EV_READ, ub_event_add(), and ub_event_new().

◆ comm_point_create_tcp()

struct comm_point* comm_point_create_tcp ( struct comm_base base,
int  fd,
int  num,
int  idle_timeout,
int  harden_large_queries,
uint32_t  http_max_streams,
char *  http_endpoint,
struct tcl_list tcp_conn_limit,
size_t  bufsize,
struct sldns_buffer spoolbuf,
enum listen_type  port_type,
int  pp2_enabled,
comm_point_callback_type callback,
void *  callback_arg,
struct unbound_socket socket 
)

Create a TCP listener comm point.

Calls malloc. Setups the structure with the parameters you provide. Also Creates TCP Handlers, pre allocated for you. Uses the parameters you provide.

Parameters
basein which base to alloc the commpoint.
fdfile descriptor of open TCP socket set to listen nonblocking.
numbecomes max_tcp_count, the routine allocates that many tcp handler commpoints.
idle_timeoutTCP idle timeout in ms.
harden_large_querieswhether query size should be limited.
http_max_streamsmaximum number of HTTP/2 streams per connection.
http_endpointHTTP endpoint to service queries on
tcp_conn_limitTCP connection limit info.
bufsizesize of buffer to create for handlers.
spoolbufshared spool buffer for tcp_req_info structures. or NULL to not create those structures in the tcp handlers.
port_typethe type of port we are creating a TCP listener for. Used to select handler type to use.
pp2_enabledif the comm point will support PROXYv2.
callbackcallback function pointer for TCP handlers.
callback_argwill be passed to your callback function.
socketand opened socket properties will be passed to your callback function.
Returns
: returns the TCP listener commpoint. You can find the TCP handlers in the array inside the listener commpoint. returns NULL on error. Inits timeout to NULL. All handlers are on the free list.

References internal_event::base, internal_base::base, comm_point::buffer, comm_point::callback, comm_point::cb_arg, comm_point_create_tcp_handler(), comm_point_delete(), comm_point_tcp_accept_callback(), comm_point::comm_tcp_accept, comm_point::cur_tcp_count, comm_point::do_not_close, comm_base::eb, internal_event::ev, comm_point::ev, comm_point::event_added, comm_point::fd, listen_type_http, listen_type_ssl, listen_type_tcp, listen_type_tcp_dnscrypt, log_err(), comm_point::max_tcp_count, comm_point::pp2_enabled, comm_point::pp2_header_none, comm_point::pp2_header_state, comm_point::socket, comm_point::tcl_addr, comm_point::tcp_byte_count, comm_point::tcp_check_nb_connect, comm_point::tcp_conn_limit, comm_point::tcp_do_close, comm_point::tcp_do_toggle_rw, comm_point::tcp_free, comm_point::tcp_handlers, comm_point::tcp_is_reading, comm_point::tcp_keepalive, comm_point::tcp_parent, comm_point::tcp_timeout_msec, comm_point::timeout, comm_point::type, UB_EV_PERSIST, UB_EV_READ, ub_event_add(), and ub_event_new().

◆ comm_point_create_tcp_out()

◆ comm_point_create_http_out()

struct comm_point* comm_point_create_http_out ( struct comm_base base,
size_t  bufsize,
comm_point_callback_type callback,
void *  callback_arg,
struct sldns_buffer temp 
)

◆ comm_point_create_local()

struct comm_point* comm_point_create_local ( struct comm_base base,
int  fd,
size_t  bufsize,
comm_point_callback_type callback,
void *  callback_arg 
)

Create commpoint to listen to a local domain file descriptor.

Parameters
basein which base to alloc the commpoint.
fdfile descriptor of open AF_UNIX socket set to listen nonblocking.
bufsizesize of buffer to create for handlers.
callbackcallback function pointer for the handler.
callback_argwill be passed to your callback function.
Returns
: the commpoint or NULL on error.

References internal_event::base, internal_base::base, comm_point::buffer, comm_point::callback, comm_point::cb_arg, comm_point_local_handle_callback(), comm_point::cur_tcp_count, comm_point::do_not_close, comm_base::eb, internal_event::ev, comm_point::ev, comm_point::event_added, comm_point::fd, log_err(), comm_point::max_tcp_count, comm_point::pp2_enabled, comm_point::pp2_header_state, sldns_buffer_new(), comm_point::tcp_byte_count, comm_point::tcp_check_nb_connect, comm_point::tcp_do_close, comm_point::tcp_do_toggle_rw, comm_point::tcp_free, comm_point::tcp_handlers, comm_point::tcp_is_reading, comm_point::tcp_parent, comm_point::timeout, comm_point::type, UB_EV_PERSIST, UB_EV_READ, ub_event_add(), ub_event_free(), and ub_event_new().

◆ comm_point_create_raw()

struct comm_point* comm_point_create_raw ( struct comm_base base,
int  fd,
int  writing,
comm_point_callback_type callback,
void *  callback_arg 
)

◆ comm_point_close()

◆ comm_point_delete()

void comm_point_delete ( struct comm_point c)

◆ comm_point_send_reply()

void comm_point_send_reply ( struct comm_reply repinfo)

Send reply.

Put message into commpoint buffer.

Parameters
repinfoThe reply info copied from a commpoint callback call.

References comm_reply::c, and log_assert.

◆ comm_point_drop_reply()

void comm_point_drop_reply ( struct comm_reply repinfo)

◆ comm_point_stop_listening()

void comm_point_stop_listening ( struct comm_point c)

Stop listening for input on the commpoint.

No callbacks will happen.

Parameters
ccommpoint to disable. The fd is not closed.

References internal_event::ev, comm_point::ev, comm_point::event_added, comm_point::fd, log_err(), ub_event_del(), VERB_ALGO, and verbose().

Referenced by comm_point_http_handle_write(), comm_point_tcp_accept_callback(), tcp_callback_reader(), and tcp_callback_writer().

◆ comm_point_start_listening()

void comm_point_start_listening ( struct comm_point c,
int  newfd,
int  msec 
)

◆ comm_point_listen_for_rw()

void comm_point_listen_for_rw ( struct comm_point c,
int  rd,
int  wr 
)

Stop listening and start listening again for reading or writing.

Parameters
ccommpoint
rdif true, listens for reading.
wrif true, listens for writing.

References internal_event::ev, comm_point::ev, comm_point::event_added, comm_point::fd, log_err(), comm_point::timeout, UB_EV_READ, UB_EV_TIMEOUT, UB_EV_WRITE, ub_event_add(), ub_event_add_bits(), ub_event_del(), ub_event_del_bits(), VERB_ALGO, and verbose().

Referenced by remote_handshake_later(), ssl_handle_read(), ssl_handle_write(), ssl_http_read_more(), and ssl_http_write_more().

◆ comm_point_get_mem()

size_t comm_point_get_mem ( struct comm_point c)

Get size of memory used by comm point.

For TCP handlers this includes subhandlers. For UDP handlers, this does not include the (shared) UDP buffer.

Parameters
ccommpoint.
Returns
size in bytes.

References comm_point::buffer, comm_point::ev, comm_point::max_tcp_count, sldns_buffer_capacity(), comm_point::tcp_handlers, comm_point::timeout, and comm_point::type.

◆ comm_timer_create()

struct comm_timer* comm_timer_create ( struct comm_base base,
void(*)(void *)  cb,
void *  cb_arg 
)

create timer.

Not active upon creation.

Parameters
baseevent handling base.
cbcallback function: void myfunc(void* myarg);
cb_arguser callback argument.
Returns
: the new timer or NULL on error.

References internal_base::base, internal_timer::base, comm_timer::callback, comm_timer::cb_arg, comm_timer_callback(), comm_base::eb, internal_timer::ev, comm_timer::ev_timer, log_err(), internal_timer::super, UB_EV_TIMEOUT, and ub_event_new().

◆ comm_timer_disable()

void comm_timer_disable ( struct comm_timer timer)

disable timer.

Stops callbacks from happening.

Parameters
timerto disable.

References internal_timer::enabled, internal_timer::ev, comm_timer::ev_timer, and ub_timer_del().

Referenced by comm_timer_delete(), and comm_timer_set().

◆ comm_timer_set()

void comm_timer_set ( struct comm_timer timer,
struct timeval *  tv 
)

reset timevalue for timer.

Parameters
timertimer to (re)set.
tvwhen the timer should activate. if NULL timer is disabled.

References internal_base::base, internal_timer::base, comm_timer_callback(), comm_timer_disable(), comm_base::eb, internal_timer::enabled, internal_timer::ev, comm_timer::ev_timer, log_assert, log_err(), and ub_timer_add().

◆ comm_timer_delete()

void comm_timer_delete ( struct comm_timer timer)

delete timer.

Parameters
timerto delete.

References comm_timer_disable(), internal_timer::ev, comm_timer::ev_timer, and ub_event_free().

◆ comm_timer_is_set()

int comm_timer_is_set ( struct comm_timer timer)

see if timeout has been set to a value.

Parameters
timerthe timer to examine.
Returns
: false if disabled or not set.

References internal_timer::enabled, and comm_timer::ev_timer.

◆ comm_signal_create()

struct comm_signal* comm_signal_create ( struct comm_base base,
void(*)(int, void *)  callback,
void *  cb_arg 
)

Create a signal handler.

Call signal_bind() later to bind to a signal.

Parameters
basecommunication base to use.
callbackcalled when signal is caught.
cb_arguser argument to callback
Returns
: the signal struct or NULL on error.

References comm_signal::base, comm_signal::callback, comm_signal::cb_arg, comm_signal::ev_signal, and log_err().

◆ comm_signal_callback()

void comm_signal_callback ( int  fd,
short  event,
void *  arg 
)

This routine is published for checks and tests, and is only used internally.

handle libevent callback for signal comm.

Parameters
fdfile descriptor (used for the signal number).
eventevent bits from libevent: EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT.
argthe internal commsignal structure.

References comm_signal::base, comm_signal::callback, comm_signal::cb_arg, fptr_ok, fptr_whitelist_comm_signal(), ub_comm_base_now(), and UB_EV_SIGNAL.

Referenced by comm_signal_bind().

◆ comm_signal_bind()

int comm_signal_bind ( struct comm_signal comsig,
int  sig 
)

Bind signal struct to catch a signal.

A single comm_signal can be bound to multiple signals, calling comm_signal_bind multiple times.

Parameters
comsigthe communication point, with callback information.
sigsignal number.
Returns
: true on success. false on error.

References internal_base::base, comm_signal::base, comm_signal_callback(), comm_base::eb, comm_signal::ev_signal, log_assert, log_err(), entry::next, ub_event_free(), ub_signal_add(), and ub_signal_new().

◆ comm_signal_delete()

void comm_signal_delete ( struct comm_signal comsig)

Delete the signal communication point.

Parameters
comsigto delete.

References internal_signal::ev, comm_signal::ev_signal, internal_signal::next, ub_event_free(), and ub_signal_del().