#include <httpserver.h>
#include <chainparamsbase.h>
#include <common/args.h>
#include <compat.h>
#include <config.h>
#include <logging.h>
#include <netbase.h>
#include <node/ui_interface.h>
#include <rpc/protocol.h>
#include <shutdown.h>
#include <sync.h>
#include <util/strencodings.h>
#include <util/threadnames.h>
#include <util/translation.h>
#include <event2/buffer.h>
#include <event2/bufferevent.h>
#include <event2/keyvalq_struct.h>
#include <event2/thread.h>
#include <event2/util.h>
#include <support/events.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <deque>
#include <memory>

Include dependency graph for httpserver.cpp:

Classes
class	HTTPWorkItem
	HTTP request work item. More...

class	WorkQueue< WorkItem >
	Simple work queue for distributing work over multiple threads. More...

struct	HTTPPathHandler

Macros
#define	EVENT_LOG_WARN _EVENT_LOG_WARN

Functions
static bool	ClientAllowed (const CNetAddr &netaddr)
	Check if a network address is allowed to access the HTTP server.

static bool	InitHTTPAllowList ()
	Initialize ACL list for HTTP server.

std::string	RequestMethodString (HTTPRequest::RequestMethod m)
	HTTP request method as string - use for logging only.

static void	http_request_cb (struct evhttp_request req, void arg)
	HTTP request callback.

static void	http_reject_request_cb (struct evhttp_request req, void )
	Callback to reject HTTP requests after shutdown.

static bool	ThreadHTTP (struct event_base *base)
	Event dispatcher thread.

static bool	HTTPBindAddresses (struct evhttp *http)
	Bind HTTP server to specified addresses.

static void	HTTPWorkQueueRun (WorkQueue< HTTPClosure > *queue, int worker_num)
	Simple wrapper to set thread name and run work queue.

static void	libevent_log_cb (int severity, const char *msg)
	libevent event log callback

bool	InitHTTPServer (Config &config)
	Initialize HTTP server.

bool	UpdateHTTPServerLogging (bool enable)
	Change logging level for libevent.

void	StartHTTPServer ()
	Start HTTP server.

void	InterruptHTTPServer ()
	Interrupt HTTP server threads.

void	StopHTTPServer ()
	Stop HTTP server.

struct event_base *	EventBase ()
	Return evhttp event base.

static void	httpevent_callback_fn (evutil_socket_t, short, void *data)

void	RegisterHTTPHandler (const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
	Register handler for prefix.

void	UnregisterHTTPHandler (const std::string &prefix, bool exactMatch)
	Unregister handler for prefix.

Variables
static const size_t	MAX_HEADERS_SIZE = 8192
	Maximum size of http request (request line + headers)

static const size_t	MIN_SUPPORTED_BODY_SIZE = 0x02000000
	Maximum HTTP post body size.

static struct event_base *	eventBase = nullptr
	HTTP module state.

static struct evhttp *	eventHTTP = nullptr
	HTTP server.

static std::vector< CSubNet >	rpc_allow_subnets
	List of subnets to allow RPC connections from.

static WorkQueue< HTTPClosure > *	workQueue = nullptr
	Work queue for handling longer requests off the event loop thread.

static std::vector< HTTPPathHandler >	pathHandlers
	Handlers for (sub)paths.

static std::vector< evhttp_bound_socket * >	boundSockets
	Bound listening sockets.

static std::thread	g_thread_http

static std::vector< std::thread >	g_thread_http_workers

Macro Definition Documentation

◆ EVENT_LOG_WARN

#define EVENT_LOG_WARN _EVENT_LOG_WARN

Function Documentation

◆ ClientAllowed()

static bool ClientAllowed ( const CNetAddr & netaddr )

static

Check if a network address is allowed to access the HTTP server.

Definition at line 148 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EventBase()

struct event_base * EventBase ( )

Return evhttp event base.

This can be used by submodules to queue timers or custom events.

Definition at line 517 of file httpserver.cpp.

Here is the caller graph for this function:

◆ http_reject_request_cb()

static void http_reject_request_cb	(	struct evhttp_request *	req,
		void *
	)

static

Callback to reject HTTP requests after shutdown.

Definition at line 293 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ http_request_cb()

static void http_request_cb	(	struct evhttp_request *	req,
		void *	arg
	)

static

HTTP request callback.

Definition at line 214 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HTTPBindAddresses()

static bool HTTPBindAddresses ( struct evhttp * http )

static

Bind HTTP server to specified addresses.

Definition at line 309 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ httpevent_callback_fn()

static void httpevent_callback_fn	(	evutil_socket_t	,
		short	,
		void *	data
	)

static

Definition at line 521 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HTTPWorkQueueRun()

static void HTTPWorkQueueRun	(	WorkQueue< HTTPClosure > *	queue,
		int	worker_num
	)

static

Simple wrapper to set thread name and run work queue.

Definition at line 363 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitHTTPAllowList()

static bool InitHTTPAllowList ( )

static

Initialize ACL list for HTTP server.

Definition at line 161 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitHTTPServer()

bool InitHTTPServer ( Config & config )

Initialize HTTP server.

Call this before RegisterHTTPHandler or EventBase().

Definition at line 382 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterruptHTTPServer()

void InterruptHTTPServer ( )

Interrupt HTTP server threads.

Definition at line 472 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ libevent_log_cb()

static void libevent_log_cb	(	int	severity,
		const char *	msg
	)

static

libevent event log callback

Definition at line 369 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterHTTPHandler()

void RegisterHTTPHandler	(	const std::string &	prefix,
		bool	exactMatch,
		const HTTPRequestHandler &	handler
	)

Register handler for prefix.

If multiple handlers match a prefix, the first-registered one will be invoked.

Definition at line 672 of file httpserver.cpp.

Here is the caller graph for this function:

◆ RequestMethodString()

std::string RequestMethodString ( HTTPRequest::RequestMethod m )

HTTP request method as string - use for logging only.

Definition at line 196 of file httpserver.cpp.

Here is the caller graph for this function:

◆ StartHTTPServer()

void StartHTTPServer ( )

Start HTTP server.

This is separate from InitHTTPServer to give users race-condition-free time to register their handlers between InitHTTPServer and StartHTTPServer.

Definition at line 460 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopHTTPServer()

void StopHTTPServer ( )

Stop HTTP server.

Definition at line 483 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ThreadHTTP()

static bool ThreadHTTP ( struct event_base * base )

static

Event dispatcher thread.

Definition at line 299 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnregisterHTTPHandler()

void UnregisterHTTPHandler	(	const std::string &	prefix,
		bool	exactMatch
	)

Unregister handler for prefix.

Definition at line 679 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateHTTPServerLogging()

bool UpdateHTTPServerLogging ( bool enable )

Change logging level for libevent.

Removes BCLog::LIBEVENT from log categories if libevent doesn't support debug logging.

Definition at line 443 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ boundSockets

std::vector<evhttp_bound_socket *> boundSockets

static

Bound listening sockets.

Definition at line 145 of file httpserver.cpp.

◆ eventBase

struct event_base* eventBase = nullptr

static

HTTP module state.

libevent event loop

Definition at line 135 of file httpserver.cpp.

◆ eventHTTP

struct evhttp* eventHTTP = nullptr

static

HTTP server.

Definition at line 137 of file httpserver.cpp.

◆ g_thread_http

std::thread g_thread_http

static

Definition at line 457 of file httpserver.cpp.

◆ g_thread_http_workers

std::vector<std::thread> g_thread_http_workers

static

Definition at line 458 of file httpserver.cpp.

◆ MAX_HEADERS_SIZE

const size_t MAX_HEADERS_SIZE = 8192

static

Maximum size of http request (request line + headers)

Definition at line 40 of file httpserver.cpp.

◆ MIN_SUPPORTED_BODY_SIZE

const size_t MIN_SUPPORTED_BODY_SIZE = 0x02000000

static

Maximum HTTP post body size.

Twice the maximum block size is added to this value in practice.

Definition at line 46 of file httpserver.cpp.

◆ pathHandlers

std::vector<HTTPPathHandler> pathHandlers

static

Handlers for (sub)paths.

Definition at line 143 of file httpserver.cpp.

◆ rpc_allow_subnets

std::vector<CSubNet> rpc_allow_subnets

static

List of subnets to allow RPC connections from.

Definition at line 139 of file httpserver.cpp.

◆ workQueue

WorkQueue<HTTPClosure>* workQueue = nullptr

static

Work queue for handling longer requests off the event loop thread.

Definition at line 141 of file httpserver.cpp.

Classes

Macros

Functions

Variables

Macro Definition Documentation

◆ EVENT_LOG_WARN

Function Documentation

◆ ClientAllowed()

◆ EventBase()

◆ http_reject_request_cb()

◆ http_request_cb()

◆ HTTPBindAddresses()

◆ httpevent_callback_fn()

◆ HTTPWorkQueueRun()

◆ InitHTTPAllowList()

◆ InitHTTPServer()

◆ InterruptHTTPServer()

◆ libevent_log_cb()

◆ RegisterHTTPHandler()

◆ RequestMethodString()

◆ StartHTTPServer()

◆ StopHTTPServer()

◆ ThreadHTTP()

◆ UnregisterHTTPHandler()

◆ UpdateHTTPServerLogging()

Variable Documentation

◆ boundSockets

◆ eventBase

◆ eventHTTP

◆ g_thread_http

◆ g_thread_http_workers

◆ MAX_HEADERS_SIZE

◆ MIN_SUPPORTED_BODY_SIZE

◆ pathHandlers

◆ rpc_allow_subnets

◆ workQueue