2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010 - 2013 Andy Green <andy@warmcat.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation:
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
22 /* System introspection configs */
24 #include "lws_config.h"
26 #if defined(WIN32) || defined(_WIN32)
27 #define inline __inline
31 #endif /* not WIN32 */
32 #endif /* not CMAKE */
34 #ifdef HAVE_SYS_TYPES_H
35 #include <sys/types.h>
46 #ifdef HAVE_SYS_STAT_H
50 #if defined(WIN32) || defined(_WIN32)
51 #define LWS_NO_DAEMONIZE
52 #define LWS_ERRNO WSAGetLastError()
53 #define LWS_EAGAIN WSAEWOULDBLOCK
54 #define LWS_EALREADY WSAEALREADY
55 #define LWS_EINPROGRESS WSAEINPROGRESS
56 #define LWS_EINTR WSAEINTR
57 #define LWS_EISCONN WSAEISCONN
58 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
59 #define LWS_POLLHUP (FD_CLOSE)
60 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
61 #define LWS_POLLOUT (FD_WRITE)
62 #define MSG_NOSIGNAL 0
63 #define SHUT_RDWR SD_BOTH
64 #define SOL_TCP IPPROTO_TCP
66 #define compatible_close(fd) closesocket(fd)
67 #define compatible_file_close(fd) CloseHandle(fd)
68 #define compatible_file_seek_cur(fd, offset) SetFilePointer(fd, offset, NULL, FILE_CURRENT)
69 #define compatible_file_read(amount, fd, buf, len) {\
71 if (!ReadFile(fd, buf, len, &_amount, NULL)) \
76 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = TRUE
86 #define __func__ __FUNCTION__
90 #define vsnprintf _vsnprintf
93 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
94 #else /* not windows --> */
101 #include <sys/types.h>
102 #include <sys/socket.h>
103 #ifdef LWS_BUILTIN_GETIFADDRS
104 #include <getifaddrs.h>
108 #if defined (__ANDROID__)
111 #include <sys/syslog.h>
114 #include <sys/socket.h>
117 #ifdef HAVE_SYS_PRCTL_H
118 #include <sys/prctl.h>
121 #include <netinet/in.h>
122 #include <netinet/tcp.h>
123 #include <arpa/inet.h>
127 #endif /* LWS_USE_LIBEV */
129 #include <sys/mman.h>
130 #include <sys/time.h>
132 #define LWS_ERRNO errno
133 #define LWS_EAGAIN EAGAIN
134 #define LWS_EALREADY EALREADY
135 #define LWS_EINPROGRESS EINPROGRESS
136 #define LWS_EINTR EINTR
137 #define LWS_EISCONN EISCONN
138 #define LWS_EWOULDBLOCK EWOULDBLOCK
139 #define LWS_INVALID_FILE -1
140 #define LWS_POLLHUP (POLLHUP|POLLERR)
141 #define LWS_POLLIN (POLLIN)
142 #define LWS_POLLOUT (POLLOUT)
143 #define compatible_close(fd) close(fd)
144 #define compatible_file_close(fd) close(fd)
145 #define compatible_file_seek_cur(fd, offset) lseek(fd, offset, SEEK_CUR)
146 #define compatible_file_read(amount, fd, buf, len) \
147 amount = read(fd, buf, len);
148 #define lws_set_blocking_send(wsi)
152 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
155 #ifndef HAVE_STRERROR
156 #define strerror(x) ""
159 #ifdef LWS_OPENSSL_SUPPORT
161 #include <cyassl/openssl/ssl.h>
162 #include <cyassl/error-ssl.h>
164 #include <openssl/ssl.h>
165 #include <openssl/evp.h>
166 #include <openssl/err.h>
167 #include <openssl/md5.h>
168 #include <openssl/sha.h>
169 #endif /* not USE_CYASSL */
172 #include "libwebsockets.h"
174 #if defined(WIN32) || defined(_WIN32)
177 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
179 #ifndef LITTLE_ENDIAN
180 #define LITTLE_ENDIAN 1234
183 #define BYTE_ORDER LITTLE_ENDIAN
185 typedef unsigned __int64 u_int64_t;
190 #define __P(protos) protos
192 #define __P(protos) ()
198 #include <sys/stat.h>
199 #include <sys/cdefs.h>
200 #include <sys/time.h>
202 #if defined(__APPLE__)
203 #include <machine/endian.h>
204 #elif defined(__FreeBSD__)
205 #include <sys/endian.h>
206 #elif defined(__linux__)
211 #include <gulliver.h>
212 #if defined(__LITTLEENDIAN__)
213 #define BYTE_ORDER __LITTLEENDIAN__
214 #define LITTLE_ENDIAN __LITTLEENDIAN__
215 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
217 #if defined(__BIGENDIAN__)
218 #define BYTE_ORDER __BIGENDIAN__
219 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
220 #define BIG_ENDIAN __BIGENDIAN__
224 #if !defined(BYTE_ORDER)
225 # define BYTE_ORDER __BYTE_ORDER
227 #if !defined(LITTLE_ENDIAN)
228 # define LITTLE_ENDIAN __LITTLE_ENDIAN
230 #if !defined(BIG_ENDIAN)
231 # define BIG_ENDIAN __BIG_ENDIAN
237 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
238 * but happily have something equivalent in the SO_NOSIGPIPE flag.
241 #define MSG_NOSIGNAL SO_NOSIGPIPE
244 #ifndef LWS_MAX_HEADER_LEN
245 #define LWS_MAX_HEADER_LEN 1024
247 #ifndef LWS_MAX_PROTOCOLS
248 #define LWS_MAX_PROTOCOLS 5
250 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
251 #define LWS_MAX_EXTENSIONS_ACTIVE 3
253 #ifndef SPEC_LATEST_SUPPORTED
254 #define SPEC_LATEST_SUPPORTED 13
256 #ifndef AWAITING_TIMEOUT
257 #define AWAITING_TIMEOUT 5
259 #ifndef CIPHERS_LIST_STRING
260 #define CIPHERS_LIST_STRING "DEFAULT"
262 #ifndef LWS_SOMAXCONN
263 #define LWS_SOMAXCONN SOMAXCONN
266 #define MAX_WEBSOCKET_04_KEY_LEN 128
267 #define LWS_MAX_SOCKET_IO_BUF 4096
269 #ifndef SYSTEM_RANDOM_FILEPATH
270 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
272 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
273 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
277 * if not in a connection storm, check for incoming
278 * connections this many normal connection services
280 #define LWS_LISTEN_SERVICE_MODULO 10
282 enum lws_websocket_opcodes_07 {
283 LWS_WS_OPCODE_07__CONTINUATION = 0,
284 LWS_WS_OPCODE_07__TEXT_FRAME = 1,
285 LWS_WS_OPCODE_07__BINARY_FRAME = 2,
287 LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
289 /* control extensions 8+ */
291 LWS_WS_OPCODE_07__CLOSE = 8,
292 LWS_WS_OPCODE_07__PING = 9,
293 LWS_WS_OPCODE_07__PONG = 0xa,
297 enum lws_connection_states {
299 WSI_STATE_HTTP_ISSUING_FILE,
300 WSI_STATE_HTTP_HEADERS,
302 WSI_STATE_DEAD_SOCKET,
303 WSI_STATE_ESTABLISHED,
304 WSI_STATE_CLIENT_UNCONNECTED,
305 WSI_STATE_RETURNED_CLOSE_ALREADY,
306 WSI_STATE_AWAITING_CLOSE_ACK,
307 WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE,
309 WSI_STATE_HTTP2_AWAIT_CLIENT_PREFACE,
310 WSI_STATE_HTTP2_ESTABLISHED_PRE_SETTINGS,
311 WSI_STATE_HTTP2_ESTABLISHED,
319 enum http_connection_type {
320 HTTP_CONNECTION_CLOSE,
321 HTTP_CONNECTION_KEEP_ALIVE
324 enum lws_pending_protocol_send {
326 LWS_PPS_HTTP2_MY_SETTINGS,
327 LWS_PPS_HTTP2_ACK_SETTINGS,
331 enum lws_rx_parse_state {
334 LWS_RXPS_04_MASK_NONCE_1,
335 LWS_RXPS_04_MASK_NONCE_2,
336 LWS_RXPS_04_MASK_NONCE_3,
338 LWS_RXPS_04_FRAME_HDR_1,
339 LWS_RXPS_04_FRAME_HDR_LEN,
340 LWS_RXPS_04_FRAME_HDR_LEN16_2,
341 LWS_RXPS_04_FRAME_HDR_LEN16_1,
342 LWS_RXPS_04_FRAME_HDR_LEN64_8,
343 LWS_RXPS_04_FRAME_HDR_LEN64_7,
344 LWS_RXPS_04_FRAME_HDR_LEN64_6,
345 LWS_RXPS_04_FRAME_HDR_LEN64_5,
346 LWS_RXPS_04_FRAME_HDR_LEN64_4,
347 LWS_RXPS_04_FRAME_HDR_LEN64_3,
348 LWS_RXPS_04_FRAME_HDR_LEN64_2,
349 LWS_RXPS_04_FRAME_HDR_LEN64_1,
351 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
352 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
353 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
354 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
356 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
360 enum connection_mode {
361 LWS_CONNMODE_HTTP_SERVING,
362 LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
363 LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
365 LWS_CONNMODE_WS_SERVING,
366 LWS_CONNMODE_WS_CLIENT,
368 LWS_CONNMODE_HTTP2_SERVING,
370 /* transient, ssl delay hiding */
371 LWS_CONNMODE_SSL_ACK_PENDING,
373 /* transient modes */
374 LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
375 LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
376 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
377 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE2,
378 LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
379 LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
380 LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
381 LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
383 /* special internal types */
384 LWS_CONNMODE_SERVER_LISTENER,
388 LWS_RXFLOW_ALLOW = (1 << 0),
389 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
392 struct libwebsocket_protocols;
396 struct lws_io_watcher {
397 struct ev_io watcher;
398 struct libwebsocket_context* context;
401 struct lws_signal_watcher {
402 struct ev_signal watcher;
403 struct libwebsocket_context* context;
405 #endif /* LWS_USE_LIBEV */
407 struct libwebsocket_context {
411 struct libwebsocket_pollfd *fds;
412 struct libwebsocket **lws_lookup; /* fd to wsi */
415 struct ev_loop* io_loop;
416 struct lws_io_watcher w_accept;
417 struct lws_signal_watcher w_sigint;
418 #endif /* LWS_USE_LIBEV */
422 char http_proxy_address[128];
423 char canonical_hostname[128];
424 unsigned int http_proxy_port;
425 unsigned int options;
426 time_t last_timeout_check_s;
429 * usable by anything in the service code, but only if the scope
430 * does not last longer than the service action (since next service
431 * of any socket can likewise use it and overwrite)
433 unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
435 int started_with_parent;
438 int listen_service_modulo;
439 int listen_service_count;
440 int listen_service_fd;
441 int listen_service_extraseen;
444 * set to the Thread ID that's doing the service loop just before entry
445 * to poll indicates service thread likely idling in poll()
446 * volatile because other threads may check it as part of processing
447 * for pollfd event change.
449 volatile int service_tid;
451 int dummy_pipe_fds[2];
459 unsigned long worst_latency;
460 char worst_latency_info[256];
463 #ifdef LWS_OPENSSL_SUPPORT
465 int allow_non_ssl_on_ssl_port;
466 unsigned int user_supplied_ssl_ctx:1;
468 SSL_CTX *ssl_client_ctx;
469 unsigned int ssl_flag_buffered_reads:1;
471 struct libwebsocket_protocols *protocols;
473 #ifndef LWS_NO_EXTENSIONS
474 struct libwebsocket_extension *extensions;
476 struct lws_token_limits *token_limits;
481 LWS_EV_READ = (1 << 0),
482 LWS_EV_WRITE = (1 << 1),
483 LWS_EV_START = (1 << 2),
484 LWS_EV_STOP = (1 << 3),
488 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
489 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
491 lws_libev_accept(struct libwebsocket_context *context,
492 struct libwebsocket *new_wsi, int accept_fd);
494 lws_libev_io(struct libwebsocket_context *context,
495 struct libwebsocket *wsi, int flags);
497 lws_libev_init_fd_table(struct libwebsocket_context *context);
499 lws_libev_run(struct libwebsocket_context *context);
501 #define LWS_LIBEV_ENABLED(context) (0)
502 #define lws_feature_status_libev(_a) \
503 lwsl_notice("libev support not compiled in\n")
504 #define lws_libev_accept(_a, _b, _c) ((void) 0)
505 #define lws_libev_io(_a, _b, _c) ((void) 0)
506 #define lws_libev_init_fd_table(_a) (0)
507 #define lws_libev_run(_a) ((void) 0)
511 #define LWS_IPV6_ENABLED(context) (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
513 #define LWS_IPV6_ENABLED(context) (0)
516 enum uri_path_states {
519 URIPS_SEEN_SLASH_DOT,
520 URIPS_SEEN_SLASH_DOT_DOT,
524 enum uri_esc_states {
527 URIES_SEEN_PERCENT_H1,
531 * This is totally opaque to code using the library. It's exported as a
532 * forward-reference pointer-only declaration; the user can use the pointer with
533 * other APIs to get information out of it.
536 struct lws_fragments {
537 unsigned short offset;
539 unsigned char next_frag_index;
542 /* notice that these union members:
548 * all have a pointer to allocated_headers struct as their first member.
550 * It means for allocated_headers access, the three union paths can all be
551 * used interchangably to access the same data
554 struct allocated_headers {
555 unsigned short next_frag_index;
557 unsigned char frag_index[WSI_TOKEN_COUNT];
558 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
559 char data[LWS_MAX_HEADER_LEN];
560 #ifndef LWS_NO_CLIENT
561 char initial_handshake_hash_base64[30];
562 unsigned short c_port;
566 struct _lws_http_mode_related {
567 /* MUST be first in struct */
568 struct allocated_headers *ah; /* mirroring _lws_header_related */
569 #if defined(WIN32) || defined(_WIN32)
574 unsigned long filepos;
575 unsigned long filelen;
577 enum http_version request_version;
578 enum http_connection_type connection_type;
586 enum lws_http2_settings {
587 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
588 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
589 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
590 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
591 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
592 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
594 LWS_HTTP2_SETTINGS__COUNT /* always last */
597 enum lws_http2_wellknown_frame_types {
598 LWS_HTTP2_FRAME_TYPE_DATA,
599 LWS_HTTP2_FRAME_TYPE_HEADERS,
600 LWS_HTTP2_FRAME_TYPE_PRIORITY,
601 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
602 LWS_HTTP2_FRAME_TYPE_SETTINGS,
603 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
604 LWS_HTTP2_FRAME_TYPE_PING,
605 LWS_HTTP2_FRAME_TYPE_GOAWAY,
606 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
607 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
609 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
612 enum lws_http2_flags {
613 LWS_HTTP2_FLAG_END_STREAM = 1,
614 LWS_HTTP2_FLAG_END_HEADERS = 4,
615 LWS_HTTP2_FLAG_PADDED = 8,
616 LWS_HTTP2_FLAG_PRIORITY = 0x20,
618 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
621 #define LWS_HTTP2_STREAM_ID_MASTER 0
622 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
623 #define LWS_HTTP2_SETTINGS_LENGTH 6
625 struct http2_settings {
626 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
629 enum http2_hpack_state {
631 /* optional before first header block */
633 HKPS_OPT_E_DEPENDENCY,
646 /* optional after last header block */
647 HKPS_OPT_DISCARD_PADDING,
650 enum http2_hpack_type {
652 HPKT_INDEXED_HDR_6_VALUE_INCR,
653 HPKT_LITERAL_HDR_VALUE_INCR,
654 HPKT_INDEXED_HDR_4_VALUE,
655 HPKT_LITERAL_HDR_VALUE,
659 struct hpack_dt_entry {
660 int token; /* additions that don't map to a token are ignored */
665 struct hpack_dynamic_table {
666 struct hpack_dt_entry *entries;
674 struct _lws_http2_related {
676 * having this first lets us also re-use all HTTP union code
677 * and in turn, http_mode_related has allocated headers in right
678 * place so we can use the header apis on the wsi directly still
680 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
682 struct http2_settings my_settings;
683 struct http2_settings peer_settings;
685 struct libwebsocket *parent_wsi;
686 struct libwebsocket *next_child_wsi;
688 struct hpack_dynamic_table *hpack_dyn_table;
694 unsigned int stream_id;
695 struct libwebsocket *stream_wsi;
698 unsigned char frame_state;
699 unsigned char padding;
701 unsigned char ping_payload[8];
703 unsigned short round_robin_POLLOUT;
704 unsigned short count_POLLOUT_children;
706 unsigned int END_STREAM:1;
707 unsigned int END_HEADERS:1;
708 unsigned int send_END_STREAM:1;
709 unsigned int GOING_AWAY;
710 unsigned int requested_POLLOUT:1;
711 unsigned int waiting_tx_credit:1;
714 enum http2_hpack_state hpack;
715 enum http2_hpack_type hpack_type;
716 unsigned int header_index;
717 unsigned int hpack_len;
718 unsigned short hpack_pos;
719 unsigned char hpack_m;
720 unsigned int hpack_e_dep;
722 unsigned int value:1;
724 /* negative credit is mandated by the spec */
726 unsigned int my_stream_id;
727 unsigned int child_count;
729 unsigned char initialized;
730 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
733 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
737 struct _lws_header_related {
738 /* MUST be first in struct */
739 struct allocated_headers *ah;
741 unsigned short current_token_limit;
742 unsigned char parser_state; /* enum lws_token_indexes */
743 enum uri_path_states ups;
744 enum uri_esc_states ues;
748 struct _lws_websocket_related {
749 char *rx_user_buffer;
750 int rx_user_buffer_head;
751 unsigned char frame_masking_nonce_04[4];
752 unsigned char frame_mask_index;
753 size_t rx_packet_length;
754 unsigned char opcode;
755 unsigned int final:1;
757 unsigned int frame_is_binary:1;
758 unsigned int all_zero_nonce:1;
759 short close_reason; /* enum lws_close_status */
761 unsigned int this_frame_masked:1;
762 unsigned int inside_frame:1; /* next write will be more of frame */
763 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
765 unsigned char *ping_payload_buf; /* non-NULL if malloc'd */
766 unsigned int ping_payload_alloc; /* length malloc'd */
767 unsigned int ping_payload_len; /* nonzero if PONG pending */
770 struct libwebsocket {
772 /* lifetime members */
775 struct lws_io_watcher w_read;
776 struct lws_io_watcher w_write;
777 #endif /* LWS_USE_LIBEV */
778 const struct libwebsocket_protocols *protocol;
779 #ifndef LWS_NO_EXTENSIONS
780 struct libwebsocket_extension *
781 active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
782 void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
783 unsigned char count_active_extensions;
784 unsigned int extension_data_pending:1;
786 unsigned char ietf_spec_revision;
787 enum lws_pending_protocol_send pps;
789 char mode; /* enum connection_mode */
790 char state; /* enum lws_connection_states */
791 char lws_rx_parse_state; /* enum lws_rx_parse_state */
792 char rx_frame_type; /* enum libwebsocket_write_protocol */
794 unsigned int hdr_parsing_completed:1;
795 unsigned int user_space_externally_allocated:1;
796 unsigned int socket_is_permanently_unusable:1;
798 char pending_timeout; /* enum pending_timeout */
799 time_t pending_timeout_limit;
802 int position_in_fds_table;
804 unsigned long action_start;
805 unsigned long latency_start;
807 /* rxflow handling */
808 unsigned char *rxflow_buffer;
811 unsigned int rxflow_change_to:2;
813 /* truncated send handling */
814 unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
815 unsigned int truncated_send_allocation; /* size of malloc */
816 unsigned int truncated_send_offset; /* where we are in terms of spilling */
817 unsigned int truncated_send_len; /* how much is buffered */
821 /* members with mutually exclusive lifetimes are unionized */
824 struct _lws_http_mode_related http;
826 struct _lws_http2_related http2;
828 struct _lws_header_related hdr;
829 struct _lws_websocket_related ws;
832 #ifdef LWS_OPENSSL_SUPPORT
835 unsigned int use_ssl:2;
836 unsigned int buffered_reads_pending:1;
837 unsigned int upgraded:1;
841 BOOL sock_send_blocking;
845 LWS_EXTERN int log_level;
848 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
849 struct libwebsocket *wsi, enum lws_close_status);
852 remove_wsi_socket_from_fds(struct libwebsocket_context *context,
853 struct libwebsocket *wsi);
855 lws_rxflow_cache(struct libwebsocket *wsi, unsigned char *buf, int n, int len);
858 static inline void lws_latency(struct libwebsocket_context *context,
859 struct libwebsocket *wsi, const char *action,
860 int ret, int completion) { while (0); }
861 static inline void lws_latency_pre(struct libwebsocket_context *context,
862 struct libwebsocket *wsi) { while (0); }
864 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
866 lws_latency(struct libwebsocket_context *context,
867 struct libwebsocket *wsi, const char *action,
868 int ret, int completion);
871 LWS_EXTERN void lws_set_protocol_write_pending(struct libwebsocket_context *context,
872 struct libwebsocket *wsi,
873 enum lws_pending_protocol_send pend);
875 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
878 libwebsocket_parse(struct libwebsocket_context *context,
879 struct libwebsocket *wsi, unsigned char c);
882 lws_http_action(struct libwebsocket_context *context, struct libwebsocket *wsi);
885 lws_b64_selftest(void);
887 LWS_EXTERN struct libwebsocket *
888 wsi_from_fd(struct libwebsocket_context *context, int fd);
891 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
892 struct libwebsocket *wsi);
895 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
899 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
900 struct libwebsocket *wsi, unsigned int sec);
902 LWS_EXTERN struct libwebsocket *
903 libwebsocket_client_connect_2(struct libwebsocket_context *context,
904 struct libwebsocket *wsi);
906 LWS_EXTERN struct libwebsocket *
907 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
910 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
911 struct libwebsocket *wsi, char *pkt);
914 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
915 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
921 #ifndef LWS_NO_EXTENSIONS
923 lws_context_init_extensions(struct lws_context_creation_info *info,
924 struct libwebsocket_context *context);
926 lws_any_extension_handled(struct libwebsocket_context *context,
927 struct libwebsocket *wsi,
928 enum libwebsocket_extension_callback_reasons r,
929 void *v, size_t len);
932 lws_ext_callback_for_each_active(struct libwebsocket *wsi, int reason,
935 lws_ext_callback_for_each_extension_type(
936 struct libwebsocket_context *context, struct libwebsocket *wsi,
937 int reason, void *arg, int len);
939 #define lws_any_extension_handled(_a, _b, _c, _d, _e) (0)
940 #define lws_ext_callback_for_each_active(_a, _b, _c, _d) (0)
941 #define lws_ext_callback_for_each_extension_type(_a, _b, _c, _d, _e) (0)
942 #define lws_issue_raw_ext_access lws_issue_raw
943 #define lws_context_init_extensions(_a, _b)
947 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
948 struct libwebsocket *wsi);
951 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
954 lws_issue_raw_ext_access(struct libwebsocket *wsi,
955 unsigned char *buf, size_t len);
958 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
961 user_callback_handle_rxflow(callback_function,
962 struct libwebsocket_context *context,
963 struct libwebsocket *wsi,
964 enum libwebsocket_callback_reasons reason, void *user,
965 void *in, size_t len);
967 LWS_EXTERN struct libwebsocket *lws_http2_get_network_wsi(struct libwebsocket *wsi);
968 struct libwebsocket * lws_http2_get_nth_child(struct libwebsocket *wsi, int n);
970 lws_http2_interpret_settings_payload(struct http2_settings *settings, unsigned char *buf, int len);
971 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
973 lws_http2_parser(struct libwebsocket_context *context,
974 struct libwebsocket *wsi, unsigned char c);
975 LWS_EXTERN int lws_http2_do_pps_send(struct libwebsocket_context *context, struct libwebsocket *wsi);
976 LWS_EXTERN int lws_http2_frame_write(struct libwebsocket *wsi, int type, int flags, unsigned int sid, unsigned int len, unsigned char *buf);
977 LWS_EXTERN struct libwebsocket *
978 lws_http2_wsi_from_id(struct libwebsocket *wsi, unsigned int sid);
979 LWS_EXTERN int lws_hpack_interpret(struct libwebsocket_context *context,
980 struct libwebsocket *wsi,
983 lws_add_http2_header_by_name(struct libwebsocket_context *context,
984 struct libwebsocket *wsi,
985 const unsigned char *name,
986 const unsigned char *value,
991 lws_add_http2_header_by_token(struct libwebsocket_context *context,
992 struct libwebsocket *wsi,
993 enum lws_token_indexes token,
994 const unsigned char *value,
999 lws_add_http2_header_status(struct libwebsocket_context *context,
1000 struct libwebsocket *wsi,
1003 unsigned char *end);
1005 void lws_http2_configure_if_upgraded(struct libwebsocket *wsi);
1007 #define lws_http2_configure_if_upgraded(x)
1011 lws_plat_set_socket_options(struct libwebsocket_context *context, int fd);
1014 lws_allocate_header_table(struct libwebsocket *wsi);
1017 lws_free_header_table(struct libwebsocket *wsi);
1020 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
1023 lws_hdr_simple_create(struct libwebsocket *wsi,
1024 enum lws_token_indexes h, const char *s);
1027 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
1030 lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or);
1032 #ifndef LWS_NO_SERVER
1033 int lws_context_init_server(struct lws_context_creation_info *info,
1034 struct libwebsocket_context *context);
1035 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
1036 struct libwebsocket *wsi);
1038 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
1039 unsigned char *buf, size_t len);
1041 lws_server_get_canonical_hostname(struct libwebsocket_context *context,
1042 struct lws_context_creation_info *info);
1044 #define lws_context_init_server(_a, _b) (0)
1045 #define libwebsocket_interpret_incoming_packet(_a, _b, _c) (0)
1046 #define lws_server_get_canonical_hostname(_a, _b)
1049 #ifndef LWS_NO_DAEMONIZE
1050 LWS_EXTERN int get_daemonize_pid();
1052 #define get_daemonize_pid() (0)
1055 LWS_EXTERN int interface_to_sa(struct libwebsocket_context *context,
1056 const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1058 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1061 LWS_EXTERN HANDLE lws_plat_open_file(const char* filename, unsigned long* filelen);
1063 LWS_EXTERN int lws_plat_open_file(const char* filename, unsigned long* filelen);
1066 enum lws_ssl_capable_status {
1067 LWS_SSL_CAPABLE_ERROR = -1,
1068 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1071 #ifndef LWS_OPENSSL_SUPPORT
1072 #define LWS_SSL_ENABLED(context) (0)
1073 #define lws_context_init_server_ssl(_a, _b) (0)
1074 #define lws_ssl_destroy(_a)
1075 #define lws_context_init_http2_ssl(_a)
1076 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1077 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1078 #define lws_server_socket_service_ssl(_a, _b, _c, _d, _e) (0)
1079 #define lws_ssl_close(_a) (0)
1080 #define lws_ssl_context_destroy(_a)
1082 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1083 LWS_EXTERN int openssl_websocket_private_data_index;
1085 lws_ssl_capable_read(struct libwebsocket_context *context,
1086 struct libwebsocket *wsi, unsigned char *buf, int len);
1089 lws_ssl_capable_write(struct libwebsocket *wsi, unsigned char *buf, int len);
1091 lws_server_socket_service_ssl(struct libwebsocket_context *context,
1092 struct libwebsocket **wsi, struct libwebsocket *new_wsi,
1093 int accept_fd, struct libwebsocket_pollfd *pollfd);
1095 lws_ssl_close(struct libwebsocket *wsi);
1097 lws_ssl_context_destroy(struct libwebsocket_context *context);
1098 #ifndef LWS_NO_SERVER
1100 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1101 struct libwebsocket_context *context);
1103 #define lws_context_init_server_ssl(_a, _b) (0)
1106 lws_ssl_destroy(struct libwebsocket_context *context);
1110 #ifdef LWS_USE_HTTP2
1112 lws_context_init_http2_ssl(struct libwebsocket_context *context);
1114 #define lws_context_init_http2_ssl(_a)
1119 lws_ssl_capable_read_no_ssl(struct libwebsocket_context *context,
1120 struct libwebsocket *wsi, unsigned char *buf, int len);
1123 lws_ssl_capable_write_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len);
1125 #ifndef LWS_NO_CLIENT
1126 LWS_EXTERN int lws_client_socket_service(
1127 struct libwebsocket_context *context,
1128 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1129 #ifdef LWS_OPENSSL_SUPPORT
1130 LWS_EXTERN int lws_context_init_client_ssl(struct lws_context_creation_info *info,
1131 struct libwebsocket_context *context);
1133 #define lws_context_init_client_ssl(_a, _b) (0)
1135 LWS_EXTERN int lws_handshake_client(struct libwebsocket *wsi, unsigned char **buf, size_t len);
1137 libwebsockets_decode_ssl_error(void);
1139 #define lws_context_init_client_ssl(_a, _b) (0)
1140 #define lws_handshake_client(_a, _b, _c) (0)
1142 #ifndef LWS_NO_SERVER
1143 LWS_EXTERN int lws_server_socket_service(
1144 struct libwebsocket_context *context,
1145 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1146 LWS_EXTERN int _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
1147 LWS_EXTERN int lws_handshake_server(struct libwebsocket_context *context,
1148 struct libwebsocket *wsi, unsigned char **buf, size_t len);
1150 #define lws_server_socket_service(_a, _b, _c) (0)
1151 #define _libwebsocket_rx_flow_control(_a) (0)
1152 #define lws_handshake_server(_a, _b, _c, _d) (0)
1159 lws_plat_delete_socket_from_fds(struct libwebsocket_context *context,
1160 struct libwebsocket *wsi, int m);
1162 lws_plat_insert_socket_into_fds(struct libwebsocket_context *context,
1163 struct libwebsocket *wsi);
1165 lws_plat_service_periodic(struct libwebsocket_context *context);
1168 lws_plat_change_pollfd(struct libwebsocket_context *context,
1169 struct libwebsocket *wsi, struct libwebsocket_pollfd *pfd);
1171 lws_plat_context_early_init(void);
1173 lws_plat_context_early_destroy(struct libwebsocket_context *context);
1175 lws_plat_context_late_destroy(struct libwebsocket_context *context);
1177 lws_poll_listen_fd(struct libwebsocket_pollfd *fd);
1179 lws_plat_service(struct libwebsocket_context *context, int timeout_ms);
1181 lws_plat_init_fd_tables(struct libwebsocket_context *context);
1183 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1184 LWS_EXTERN unsigned long long
1185 time_in_microseconds(void);
1186 LWS_EXTERN const char *
1187 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);