fb_service.h

Go to the documentation of this file.

 
 
 
#pragma once
 
#include <config.h>
 
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <time.h>
#include <stdbool.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
 
#ifdef FOOTBALL_THREADS
#include <pthread.h>
#endif
 
#include "fb_public.h"
#include "fb_transport.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Logging facilities */
typedef enum fb_log_types_t {
    FB_LOG_ERROR = 0, /* Nonmaskable */
    FB_LOG_WARNING = 0x01,
    FB_LOG_PARSER = 0x04,
    FB_LOG_IO_TRACE = 0x08,
    FB_LOG_CONN_STATUS = 0x10,
    FB_LOG_CONN_ERROR = 0x20,
    FB_LOG_TLS_STATUS = 0x100,
    FB_LOG_TLS_ERROR = 0x200,
    FB_LOG_HTTP_STATUS = 0x1000,
    FB_LOG_HTTP_ERROR = 0x2000,
    FB_LOG_HTTP_TRAFFIC = 0x4000,
} FB_LOG_TYPE;
 
#ifdef NDEBUG
#define FB_WHERE(level) (level)
#else
#define FB_WHERE(level) __FILE__, __LINE__, __func__, (level)
#endif
#define fb_perror(errfunc) fb_log(FB_WHERE (FB_LOG_ERROR), (errfunc ": %s"), strerror (errno))
 
 
/* Mutexes are allocated in the following orders:
   - Service module -> socket manager
   - Service -> connection
*/
/* Wrap pthread mutexes in a macro so we don't need to #ifdef every use. */
#ifdef FOOTBALL_THREADS
#ifdef NDEBUG
#define fb_mutex_init(var)          (pthread_mutex_init(var, NULL))
#define fb_mutex_destroy(var)       (pthread_mutex_destroy(var))
#define fb_mutex_lock(var)          (pthread_mutex_lock(var))
#define fb_mutex_unlock(var)        (pthread_mutex_unlock(var))
#else
#define fb_mutex_init(var)          (assert(pthread_mutex_init(var, NULL) == 0))
#define fb_mutex_destroy(var)       (assert(pthread_mutex_destroy(var) == 0))
#define fb_mutex_lock(var)          (assert(pthread_mutex_lock(var) == 0))
#define fb_mutex_unlock(var)        (assert(pthread_mutex_unlock(var) == 0))
#endif
#else
#define fb_mutex_init(mutex) ((void)0)
#define fb_mutex_destroy(mutex) ((void)0)
#define fb_mutex_lock(mutex) ((void)0)
#define fb_mutex_unlock(mutex) ((void)0)
#endif
 
typedef enum fb_socket_type_t {
    FB_SOCKTYPE_SERVICE = 0x3692, 
    FB_SOCKTYPE_CONNECTION = 0x5285,
    FB_SOCKTYPE_USER = 0xa9f7,
    FB_SOCKTYPE_EVENT = 0xbd53
} FB_SOCKETTYPE;
 
typedef enum fb_socket_state_t {
    FB_SOCKET_STATE_TLS_HANDSHAKE, 
    FB_SOCKET_STATE_GREETING, 
    FB_SOCKET_STATE_GATHERING_HEADER, 
    FB_SOCKET_STATE_OPEN, 
    FB_SOCKET_STATE_FLUSHING, 
    FB_SOCKET_STATE_CLOSING 
} FB_SOCKETSTATE;
 
typedef enum fb_socketid_t {
    FB_SOCKET_LINE_IP4,
    FB_SOCKET_LINE_IP6,
    FB_SOCKET_HTTP_IP4,
    FB_SOCKET_HTTP_IP6,
    FB_SOCKET_HTTPS_IP4,
    FB_SOCKET_HTTPS_IP6,
    FB_SOCKET_COUNT
} FB_SOCKETID;
 
typedef union fb_socketaddr_t {
    struct sockaddr_in ip4;
#ifdef HAVE_IPV6
    struct sockaddr_in6 ip6;
#endif
} FB_SOCKETADDR;
 
#define fb_http_socket(id) ((id) == FB_SOCKET_HTTP_IP4 || (id) == FB_SOCKET_HTTP_IP6 || \
                            (id) == FB_SOCKET_HTTPS_IP4 || (id) == FB_SOCKET_HTTPS_IP6)
#define fb_ip6_socket(id) ((id) == FB_SOCKET_LINE_IP6 || (id) == FB_SOCKET_HTTP_IP6 || \
                           (id) == FB_SOCKET_HTTPS_IP6)
#define fb_encrypted_socket(id) ((id) == FB_SOCKET_HTTPS_IP4 || (id) == FB_SOCKET_HTTPS_IP6)
 
struct fb_service_t {
    FB_SOCKETTYPE type; 
    FB_SOCKETSTATE state;   
    FB_SERVICE_OPTIONS options; 
    int socket [FB_SOCKET_COUNT]; 
    FB_SOCKETADDR address [FB_SOCKET_COUNT]; 
    size_t connection_count;    
    size_t connections_size;    
    struct fb_connection_t **connections;   
    struct fb_service_t *next_reap; 
    bool shutdown_event_done; 
    struct fb_service_t *next_child; 
#ifdef FOOTBALL_THREADS
    pthread_mutex_t mutex; 
#endif
    void *relatedObject; 
};
 
/* Nomenclature:
   Message - Contains the message data and a use count, allowing
             use in several Qs for efficiency.
   Q a/k/a MessageList - Per-connection linked list of Messages.
   Queue - header data structure for Q MessageList.
 */
typedef struct fb_message_t {
    int usecount; 
    ssize_t length; 
    char *message; 
} FB_MESSAGE;
 
typedef struct fb_messagelist_t {
    struct fb_messagelist_t *next;
    FB_MESSAGE *message;
} FB_MESSAGELIST;
 
typedef struct fb_ioqueue_t {
    FB_MESSAGELIST *first;
    FB_MESSAGELIST *last;
    ssize_t consumed; /***< Number of bytes consumed in first message. */
} FB_IOQUEUE;
 
typedef struct fb_inputbuffer_t {
    size_t size; 
    size_t capacity; 
    char *message; 
} FB_INPUTBUFFER;
 
typedef struct fb_http_request_t {
    bool unsupported; 
    bool headonly; 
    char *http; 
    char *host; 
    char *service_name; 
    char *filename; 
    char *query_string; 
    char *upgrade_type;
    char *websocket_key;
    char *websocket_protocol;
    char *websocket_version;
    char *if_modified_since; 
    char *language; 
    bool invalid; 
    bool failure; 
} FB_HTTPREQUEST;
 
struct fb_connection_t {
    FB_SOCKETTYPE type; 
    FB_SERVICE *service; 
    int socket; 
    FB_SOCKETSTATE state;   
    time_t expiry_time; 
    bool greeted; 
    bool http; 
    bool encrypted; 
    const FB_TRANSPORT_FUNCS *transport;
#ifdef FB_HAVE_TLS
    FB_TLS_CONTEXT tls; 
#endif
    FB_HTTPREQUEST request;
    FB_IOQUEUE assembly; 
    FB_IOQUEUE out; 
    FB_INPUTBUFFER in; 
    time_t next_ping; 
    int domain; 
    union {
        struct sockaddr_in ip4addr;
#ifdef HAVE_IPV6
        struct sockaddr_in6 ip6addr;
#endif
    } origin;
    char *filename;     
#ifdef FOOTBALL_THREADS
    pthread_mutex_t mutex; 
#endif
    void *context;      
    void *relatedObject; 
};
 
struct fb_iterator_t {
    FB_SERVICE *service;
    ssize_t iteration;
};
 
/* Message data management */
extern void fb_free_freelists (void);
extern FB_MESSAGE *fb_messagealloc(void);
extern void fb_messagefree(FB_MESSAGE *freethis);
 
extern FB_MESSAGELIST *fb_qalloc();
extern void fb_qfree (FB_MESSAGELIST *freethis);
 
extern bool fb_queue_add (FB_IOQUEUE *queue, FB_MESSAGE *message);
extern bool fb_queue_empty (FB_IOQUEUE *q);
extern void fb_queue_consume (FB_IOQUEUE *q, size_t consume);
extern void fb_queue_destroy (FB_IOQUEUE *q);
 
/* Destroy the service when all connections are closed. */
extern void fb_destroy_service (struct fb_service_t *service);
extern void fb_schedule_reap (FB_SERVICE *service);
 
/* Transfer service for HELO <svc> or http://my.server/<service> */
extern bool fb_transfer_by_name (FB_CONNECTION *connection, const char *name);
 
/* Register/Unregister a connection with the socket manager */
extern void fb_queue_event (FB_EVENT *event);
extern void fb_dispose_event (FB_EVENT *event);
extern bool fb_register (int socket, FB_SOCKETTYPE type, void *thing);
extern void fb_unregister (int socket);
 
/* Accept/Close & release a socket and its resources */
extern FB_CONNECTION *fb_accept_connection (FB_SERVICE *service, FB_SOCKETID id);
extern void fb_destroy_connection (FB_CONNECTION *connection);
 
/* Event handling functions */
extern bool fb_set_input_buffer_size (FB_CONNECTION *connection, size_t size);
extern bool fb_recv_input (FB_CONNECTION *connection, ssize_t byte_count);
extern FB_EVENT *fb_read_input (FB_EVENT *event, FB_CONNECTION *connection);
extern FB_EVENT *fb_new_connect (FB_EVENT *event, FB_SERVICE *service);
extern FB_EVENT *fb_send_output (FB_EVENT *event, FB_CONNECTION *connection);
 
/* HTTP & Websocket support */
extern FB_EVENT *fb_read_websocket_input (FB_EVENT *event, FB_CONNECTION *connection);
extern bool fb_websocket_ping (FB_CONNECTION *connection);
extern bool fb_websocket_announce_close (FB_CONNECTION *connection);
extern bool fb_websocket_encode (FB_CONNECTION *connection);
extern void fb_destroy_httprequest (FB_HTTPREQUEST *request);
extern void fb_collect_http_request (FB_EVENT *event, FB_HTTPREQUEST *request);
extern void fb_collect_http_parameter (char *line, FB_HTTPREQUEST *request);
extern bool fb_http_command (const char *command);
extern FB_EVENT *fb_execute_http_request (FB_EVENT *event, FB_CONNECTION *connection);
 
/* Utility/TLS functions */
extern int fb_create_argv (const char *commandline, char ***result);
extern int fb_create_argv_from_query_string (const char *query_string, char ***result, char ***remainders);
extern void fb_destroy_argv (char **argv);
extern const char *fb_connection_info (FB_CONNECTION *connection);
 
/* Enabling/disabling events for the socket manager */
extern void fb_set_buffering (int socket_fd, bool enable);
extern void fb_set_readable (int socket, bool enable);
extern void fb_set_writable (int socket, bool enable);
 
#define FAR_FUTURE ((time_t) (((time_t) 0x7fffffff) << ((sizeof (time_t) - 4) * 8)))
 
#ifdef __cplusplus
}
#endif