Bitcoin Core  0.19.99
P2P Digital Currency
Classes | Macros | Functions | Variables
httpserver.cpp File Reference
#include <httpserver.h>
#include <chainparamsbase.h>
#include <compat.h>
#include <util/threadnames.h>
#include <util/system.h>
#include <util/strencodings.h>
#include <netbase.h>
#include <rpc/protocol.h>
#include <shutdown.h>
#include <sync.h>
#include <ui_interface.h>
#include <deque>
#include <memory>
#include <stdio.h>
#include <stdlib.h>
#include <string>
#include <sys/types.h>
#include <sys/stat.h>
#include <event2/thread.h>
#include <event2/buffer.h>
#include <event2/bufferevent.h>
#include <event2/util.h>
#include <event2/keyvalq_struct.h>
#include <support/events.h>
Include dependency graph for httpserver.cpp:

Go to the source code of this file.

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. More...
 
static bool InitHTTPAllowList ()
 Initialize ACL list for HTTP server. More...
 
static std::string RequestMethodString (HTTPRequest::RequestMethod m)
 HTTP request method as string - use for logging only. More...
 
static void http_request_cb (struct evhttp_request *req, void *arg)
 HTTP request callback. More...
 
static void http_reject_request_cb (struct evhttp_request *req, void *)
 Callback to reject HTTP requests after shutdown. More...
 
static bool ThreadHTTP (struct event_base *base)
 Event dispatcher thread. More...
 
static bool HTTPBindAddresses (struct evhttp *http)
 Bind HTTP server to specified addresses. More...
 
static void HTTPWorkQueueRun (WorkQueue< HTTPClosure > *queue, int worker_num)
 Simple wrapper to set thread name and run work queue. More...
 
static void libevent_log_cb (int severity, const char *msg)
 libevent event log callback More...
 
bool InitHTTPServer ()
 Initialize HTTP server. More...
 
bool UpdateHTTPServerLogging (bool enable)
 Change logging level for libevent. More...
 
void StartHTTPServer ()
 Start HTTP server. More...
 
void InterruptHTTPServer ()
 Interrupt HTTP server threads. More...
 
void StopHTTPServer ()
 Stop HTTP server. More...
 
struct event_base * EventBase ()
 Return evhttp event base. More...
 
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. More...
 
void UnregisterHTTPHandler (const std::string &prefix, bool exactMatch)
 Unregister handler for prefix. More...
 

Variables

static const size_t MAX_HEADERS_SIZE = 8192
 Maximum size of http request (request line + headers) More...
 
static struct event_base * eventBase = nullptr
 HTTP module state. More...
 
static struct evhttp * eventHTTP = nullptr
 HTTP server. More...
 
static std::vector< CSubNetrpc_allow_subnets
 List of subnets to allow RPC connections from. More...
 
static WorkQueue< HTTPClosure > * workQueue = nullptr
 Work queue for handling longer requests off the event loop thread. More...
 
static std::vector< HTTPPathHandlerpathHandlers
 Handlers for (sub)paths. More...
 
static std::vector< evhttp_bound_socket * > boundSockets
 Bound listening sockets. More...
 
static std::thread threadHTTP
 
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 153 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 482 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 279 of file httpserver.cpp.

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 213 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 297 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 487 of file httpserver.cpp.

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 339 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 164 of file httpserver.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InitHTTPServer()

bool InitHTTPServer ( )

Initialize HTTP server.

Call this before RegisterHTTPHandler or EventBase().

Definition at line 358 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 438 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 346 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 640 of file httpserver.cpp.

Here is the caller graph for this function:

◆ RequestMethodString()

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

HTTP request method as string - use for logging only.

Definition at line 192 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 426 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 449 of file httpserver.cpp.

Here is the caller graph for this function:

◆ ThreadHTTP()

static bool ThreadHTTP ( struct event_base *  base)
static

Event dispatcher thread.

Definition at line 286 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 646 of file httpserver.cpp.

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 409 of file httpserver.cpp.

Here is the caller graph for this function:

Variable Documentation

◆ boundSockets

std::vector<evhttp_bound_socket *> boundSockets
static

Bound listening sockets.

Definition at line 150 of file httpserver.cpp.

◆ eventBase

struct event_base* eventBase = nullptr
static

HTTP module state.

libevent event loop

Definition at line 140 of file httpserver.cpp.

◆ eventHTTP

struct evhttp* eventHTTP = nullptr
static

HTTP server.

Definition at line 142 of file httpserver.cpp.

◆ g_thread_http_workers

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

Definition at line 424 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 43 of file httpserver.cpp.

◆ pathHandlers

std::vector<HTTPPathHandler> pathHandlers
static

Handlers for (sub)paths.

Definition at line 148 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 144 of file httpserver.cpp.

◆ threadHTTP

std::thread threadHTTP
static

Definition at line 423 of file httpserver.cpp.

◆ workQueue

WorkQueue<HTTPClosure>* workQueue = nullptr
static

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

Definition at line 146 of file httpserver.cpp.