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)
153 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
157 #ifndef HAVE_STRERROR
158 #define strerror(x) ""
161 #ifdef LWS_OPENSSL_SUPPORT
163 #include <cyassl/openssl/ssl.h>
164 #include <cyassl/error-ssl.h>
166 #include <openssl/ssl.h>
167 #include <openssl/evp.h>
168 #include <openssl/err.h>
169 #include <openssl/md5.h>
170 #include <openssl/sha.h>
171 #endif /* not USE_CYASSL */
174 #include "libwebsockets.h"
176 #if defined(WIN32) || defined(_WIN32)
179 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
181 #ifndef LITTLE_ENDIAN
182 #define LITTLE_ENDIAN 1234
185 #define BYTE_ORDER LITTLE_ENDIAN
187 typedef unsigned __int64 u_int64_t;
192 #define __P(protos) protos
194 #define __P(protos) ()
200 #include <sys/stat.h>
201 #include <sys/cdefs.h>
202 #include <sys/time.h>
204 #if defined(__APPLE__)
205 #include <machine/endian.h>
206 #elif defined(__FreeBSD__)
207 #include <sys/endian.h>
208 #elif defined(__linux__)
215 #define container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
219 #include <gulliver.h>
220 #if defined(__LITTLEENDIAN__)
221 #define BYTE_ORDER __LITTLEENDIAN__
222 #define LITTLE_ENDIAN __LITTLEENDIAN__
223 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
225 #if defined(__BIGENDIAN__)
226 #define BYTE_ORDER __BIGENDIAN__
227 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
228 #define BIG_ENDIAN __BIGENDIAN__
232 #if !defined(BYTE_ORDER)
233 # define BYTE_ORDER __BYTE_ORDER
235 #if !defined(LITTLE_ENDIAN)
236 # define LITTLE_ENDIAN __LITTLE_ENDIAN
238 #if !defined(BIG_ENDIAN)
239 # define BIG_ENDIAN __BIG_ENDIAN
245 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
246 * but happily have something equivalent in the SO_NOSIGPIPE flag.
249 #define MSG_NOSIGNAL SO_NOSIGPIPE
253 #ifndef FD_HASHTABLE_MODULUS
254 #define FD_HASHTABLE_MODULUS 32
258 #ifndef LWS_MAX_HEADER_LEN
259 #define LWS_MAX_HEADER_LEN 1024
261 #ifndef LWS_MAX_PROTOCOLS
262 #define LWS_MAX_PROTOCOLS 5
264 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
265 #define LWS_MAX_EXTENSIONS_ACTIVE 3
267 #ifndef SPEC_LATEST_SUPPORTED
268 #define SPEC_LATEST_SUPPORTED 13
270 #ifndef AWAITING_TIMEOUT
271 #define AWAITING_TIMEOUT 5
273 #ifndef CIPHERS_LIST_STRING
274 #define CIPHERS_LIST_STRING "DEFAULT"
276 #ifndef LWS_SOMAXCONN
277 #define LWS_SOMAXCONN SOMAXCONN
280 #define MAX_WEBSOCKET_04_KEY_LEN 128
281 #define LWS_MAX_SOCKET_IO_BUF 4096
283 #ifndef SYSTEM_RANDOM_FILEPATH
284 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
286 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
287 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
291 * if not in a connection storm, check for incoming
292 * connections this many normal connection services
294 #define LWS_LISTEN_SERVICE_MODULO 10
296 enum lws_websocket_opcodes_07 {
297 LWS_WS_OPCODE_07__CONTINUATION = 0,
298 LWS_WS_OPCODE_07__TEXT_FRAME = 1,
299 LWS_WS_OPCODE_07__BINARY_FRAME = 2,
301 LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
303 /* control extensions 8+ */
305 LWS_WS_OPCODE_07__CLOSE = 8,
306 LWS_WS_OPCODE_07__PING = 9,
307 LWS_WS_OPCODE_07__PONG = 0xa,
311 enum lws_connection_states {
313 WSI_STATE_HTTP_ISSUING_FILE,
314 WSI_STATE_HTTP_HEADERS,
316 WSI_STATE_DEAD_SOCKET,
317 WSI_STATE_ESTABLISHED,
318 WSI_STATE_CLIENT_UNCONNECTED,
319 WSI_STATE_RETURNED_CLOSE_ALREADY,
320 WSI_STATE_AWAITING_CLOSE_ACK,
321 WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE,
323 WSI_STATE_HTTP2_AWAIT_CLIENT_PREFACE,
324 WSI_STATE_HTTP2_ESTABLISHED_PRE_SETTINGS,
325 WSI_STATE_HTTP2_ESTABLISHED,
333 enum http_connection_type {
334 HTTP_CONNECTION_CLOSE,
335 HTTP_CONNECTION_KEEP_ALIVE
338 enum lws_pending_protocol_send {
340 LWS_PPS_HTTP2_MY_SETTINGS,
341 LWS_PPS_HTTP2_ACK_SETTINGS,
345 enum lws_rx_parse_state {
348 LWS_RXPS_04_MASK_NONCE_1,
349 LWS_RXPS_04_MASK_NONCE_2,
350 LWS_RXPS_04_MASK_NONCE_3,
352 LWS_RXPS_04_FRAME_HDR_1,
353 LWS_RXPS_04_FRAME_HDR_LEN,
354 LWS_RXPS_04_FRAME_HDR_LEN16_2,
355 LWS_RXPS_04_FRAME_HDR_LEN16_1,
356 LWS_RXPS_04_FRAME_HDR_LEN64_8,
357 LWS_RXPS_04_FRAME_HDR_LEN64_7,
358 LWS_RXPS_04_FRAME_HDR_LEN64_6,
359 LWS_RXPS_04_FRAME_HDR_LEN64_5,
360 LWS_RXPS_04_FRAME_HDR_LEN64_4,
361 LWS_RXPS_04_FRAME_HDR_LEN64_3,
362 LWS_RXPS_04_FRAME_HDR_LEN64_2,
363 LWS_RXPS_04_FRAME_HDR_LEN64_1,
365 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
366 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
367 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
368 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
370 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
374 enum connection_mode {
375 LWS_CONNMODE_HTTP_SERVING,
376 LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
377 LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
379 LWS_CONNMODE_WS_SERVING,
380 LWS_CONNMODE_WS_CLIENT,
382 LWS_CONNMODE_HTTP2_SERVING,
384 /* transient, ssl delay hiding */
385 LWS_CONNMODE_SSL_ACK_PENDING,
387 /* transient modes */
388 LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
389 LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
390 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
391 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE2,
392 LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
393 LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
394 LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
395 LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
397 /* special internal types */
398 LWS_CONNMODE_SERVER_LISTENER,
402 LWS_RXFLOW_ALLOW = (1 << 0),
403 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
406 struct libwebsocket_protocols;
410 struct lws_io_watcher {
411 struct ev_io watcher;
412 struct libwebsocket_context* context;
415 struct lws_signal_watcher {
416 struct ev_signal watcher;
417 struct libwebsocket_context* context;
419 #endif /* LWS_USE_LIBEV */
422 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
423 struct libwebsocket_fd_hashtable {
424 struct libwebsocket **wsi;
429 struct libwebsocket_context {
433 struct libwebsocket_pollfd *fds;
435 /* different implementation between unix and windows */
436 struct libwebsocket_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
438 struct libwebsocket **lws_lookup; /* fd to wsi */
442 struct ev_loop* io_loop;
443 struct lws_io_watcher w_accept;
444 struct lws_signal_watcher w_sigint;
445 #endif /* LWS_USE_LIBEV */
449 char http_proxy_address[128];
450 char canonical_hostname[128];
451 unsigned int http_proxy_port;
452 unsigned int options;
453 time_t last_timeout_check_s;
456 * usable by anything in the service code, but only if the scope
457 * does not last longer than the service action (since next service
458 * of any socket can likewise use it and overwrite)
460 unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
462 int started_with_parent;
465 int listen_service_modulo;
466 int listen_service_count;
467 int listen_service_fd;
468 int listen_service_extraseen;
471 * set to the Thread ID that's doing the service loop just before entry
472 * to poll indicates service thread likely idling in poll()
473 * volatile because other threads may check it as part of processing
474 * for pollfd event change.
476 volatile int service_tid;
478 int dummy_pipe_fds[2];
486 unsigned long worst_latency;
487 char worst_latency_info[256];
490 #ifdef LWS_OPENSSL_SUPPORT
492 int allow_non_ssl_on_ssl_port;
493 unsigned int user_supplied_ssl_ctx:1;
495 SSL_CTX *ssl_client_ctx;
496 struct libwebsocket *pending_read_list; /* linked list */
497 #define lws_ssl_anybody_has_buffered_read(ctx) (ctx->use_ssl && ctx->pending_read_list)
499 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
501 struct libwebsocket_protocols *protocols;
503 #ifndef LWS_NO_EXTENSIONS
504 struct libwebsocket_extension *extensions;
506 struct lws_token_limits *token_limits;
511 LWS_EV_READ = (1 << 0),
512 LWS_EV_WRITE = (1 << 1),
513 LWS_EV_START = (1 << 2),
514 LWS_EV_STOP = (1 << 3),
518 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
519 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
521 lws_libev_accept(struct libwebsocket_context *context,
522 struct libwebsocket *new_wsi, int accept_fd);
524 lws_libev_io(struct libwebsocket_context *context,
525 struct libwebsocket *wsi, int flags);
527 lws_libev_init_fd_table(struct libwebsocket_context *context);
529 lws_libev_run(struct libwebsocket_context *context);
531 #define LWS_LIBEV_ENABLED(context) (0)
532 #define lws_feature_status_libev(_a) \
533 lwsl_notice("libev support not compiled in\n")
534 #define lws_libev_accept(_a, _b, _c) ((void) 0)
535 #define lws_libev_io(_a, _b, _c) ((void) 0)
536 #define lws_libev_init_fd_table(_a) (0)
537 #define lws_libev_run(_a) ((void) 0)
541 #define LWS_IPV6_ENABLED(context) (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
543 #define LWS_IPV6_ENABLED(context) (0)
546 enum uri_path_states {
549 URIPS_SEEN_SLASH_DOT,
550 URIPS_SEEN_SLASH_DOT_DOT,
554 enum uri_esc_states {
557 URIES_SEEN_PERCENT_H1,
561 * This is totally opaque to code using the library. It's exported as a
562 * forward-reference pointer-only declaration; the user can use the pointer with
563 * other APIs to get information out of it.
566 struct lws_fragments {
567 unsigned short offset;
569 unsigned char next_frag_index;
572 /* notice that these union members:
578 * all have a pointer to allocated_headers struct as their first member.
580 * It means for allocated_headers access, the three union paths can all be
581 * used interchangably to access the same data
584 struct allocated_headers {
585 unsigned short next_frag_index;
587 unsigned char frag_index[WSI_TOKEN_COUNT];
588 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
589 char data[LWS_MAX_HEADER_LEN];
590 #ifndef LWS_NO_CLIENT
591 char initial_handshake_hash_base64[30];
592 unsigned short c_port;
596 struct _lws_http_mode_related {
597 /* MUST be first in struct */
598 struct allocated_headers *ah; /* mirroring _lws_header_related */
599 #if defined(WIN32) || defined(_WIN32)
604 unsigned long filepos;
605 unsigned long filelen;
607 enum http_version request_version;
608 enum http_connection_type connection_type;
616 enum lws_http2_settings {
617 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
618 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
619 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
620 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
621 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
622 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
624 LWS_HTTP2_SETTINGS__COUNT /* always last */
627 enum lws_http2_wellknown_frame_types {
628 LWS_HTTP2_FRAME_TYPE_DATA,
629 LWS_HTTP2_FRAME_TYPE_HEADERS,
630 LWS_HTTP2_FRAME_TYPE_PRIORITY,
631 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
632 LWS_HTTP2_FRAME_TYPE_SETTINGS,
633 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
634 LWS_HTTP2_FRAME_TYPE_PING,
635 LWS_HTTP2_FRAME_TYPE_GOAWAY,
636 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
637 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
639 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
642 enum lws_http2_flags {
643 LWS_HTTP2_FLAG_END_STREAM = 1,
644 LWS_HTTP2_FLAG_END_HEADERS = 4,
645 LWS_HTTP2_FLAG_PADDED = 8,
646 LWS_HTTP2_FLAG_PRIORITY = 0x20,
648 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
651 #define LWS_HTTP2_STREAM_ID_MASTER 0
652 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
653 #define LWS_HTTP2_SETTINGS_LENGTH 6
655 struct http2_settings {
656 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
659 enum http2_hpack_state {
661 /* optional before first header block */
663 HKPS_OPT_E_DEPENDENCY,
676 /* optional after last header block */
677 HKPS_OPT_DISCARD_PADDING,
680 enum http2_hpack_type {
682 HPKT_INDEXED_HDR_6_VALUE_INCR,
683 HPKT_LITERAL_HDR_VALUE_INCR,
684 HPKT_INDEXED_HDR_4_VALUE,
685 HPKT_LITERAL_HDR_VALUE,
689 struct hpack_dt_entry {
690 int token; /* additions that don't map to a token are ignored */
695 struct hpack_dynamic_table {
696 struct hpack_dt_entry *entries;
704 struct _lws_http2_related {
706 * having this first lets us also re-use all HTTP union code
707 * and in turn, http_mode_related has allocated headers in right
708 * place so we can use the header apis on the wsi directly still
710 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
712 struct http2_settings my_settings;
713 struct http2_settings peer_settings;
715 struct libwebsocket *parent_wsi;
716 struct libwebsocket *next_child_wsi;
718 struct hpack_dynamic_table *hpack_dyn_table;
724 unsigned int stream_id;
725 struct libwebsocket *stream_wsi;
728 unsigned char frame_state;
729 unsigned char padding;
731 unsigned char ping_payload[8];
733 unsigned short round_robin_POLLOUT;
734 unsigned short count_POLLOUT_children;
736 unsigned int END_STREAM:1;
737 unsigned int END_HEADERS:1;
738 unsigned int send_END_STREAM:1;
739 unsigned int GOING_AWAY;
740 unsigned int requested_POLLOUT:1;
741 unsigned int waiting_tx_credit:1;
744 enum http2_hpack_state hpack;
745 enum http2_hpack_type hpack_type;
746 unsigned int header_index;
747 unsigned int hpack_len;
748 unsigned short hpack_pos;
749 unsigned char hpack_m;
750 unsigned int hpack_e_dep;
752 unsigned int value:1;
754 /* negative credit is mandated by the spec */
756 unsigned int my_stream_id;
757 unsigned int child_count;
759 unsigned char initialized;
760 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
763 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
767 struct _lws_header_related {
768 /* MUST be first in struct */
769 struct allocated_headers *ah;
771 unsigned short current_token_limit;
772 unsigned char parser_state; /* enum lws_token_indexes */
773 enum uri_path_states ups;
774 enum uri_esc_states ues;
778 struct _lws_websocket_related {
779 char *rx_user_buffer;
780 int rx_user_buffer_head;
781 unsigned char frame_masking_nonce_04[4];
782 unsigned char frame_mask_index;
783 size_t rx_packet_length;
784 unsigned char opcode;
785 unsigned int final:1;
787 unsigned int frame_is_binary:1;
788 unsigned int all_zero_nonce:1;
789 short close_reason; /* enum lws_close_status */
791 unsigned int this_frame_masked:1;
792 unsigned int inside_frame:1; /* next write will be more of frame */
793 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
794 unsigned int payload_is_close:1; /* process as PONG, but it is close */
796 unsigned char *ping_payload_buf; /* non-NULL if malloc'd */
797 unsigned int ping_payload_alloc; /* length malloc'd */
798 unsigned int ping_payload_len;
799 unsigned char ping_pending_flag;
802 struct libwebsocket {
804 /* lifetime members */
807 struct lws_io_watcher w_read;
808 struct lws_io_watcher w_write;
809 #endif /* LWS_USE_LIBEV */
810 const struct libwebsocket_protocols *protocol;
811 #ifndef LWS_NO_EXTENSIONS
812 struct libwebsocket_extension *
813 active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
814 void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
815 unsigned char count_active_extensions;
816 unsigned int extension_data_pending:1;
818 unsigned char ietf_spec_revision;
819 enum lws_pending_protocol_send pps;
821 char mode; /* enum connection_mode */
822 char state; /* enum lws_connection_states */
823 char lws_rx_parse_state; /* enum lws_rx_parse_state */
824 char rx_frame_type; /* enum libwebsocket_write_protocol */
826 unsigned int hdr_parsing_completed:1;
827 unsigned int user_space_externally_allocated:1;
828 unsigned int socket_is_permanently_unusable:1;
830 char pending_timeout; /* enum pending_timeout */
831 time_t pending_timeout_limit;
833 int position_in_fds_table;
835 unsigned long action_start;
836 unsigned long latency_start;
838 /* rxflow handling */
839 unsigned char *rxflow_buffer;
842 unsigned int rxflow_change_to:2;
844 /* truncated send handling */
845 unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
846 unsigned int truncated_send_allocation; /* size of malloc */
847 unsigned int truncated_send_offset; /* where we are in terms of spilling */
848 unsigned int truncated_send_len; /* how much is buffered */
852 /* members with mutually exclusive lifetimes are unionized */
855 struct _lws_http_mode_related http;
857 struct _lws_http2_related http2;
859 struct _lws_header_related hdr;
860 struct _lws_websocket_related ws;
863 #ifdef LWS_OPENSSL_SUPPORT
866 struct libwebsocket *pending_read_list_prev, *pending_read_list_next;
867 unsigned int use_ssl:2;
868 unsigned int upgraded:1;
872 BOOL sock_send_blocking;
876 LWS_EXTERN int log_level;
879 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
880 struct libwebsocket *wsi, enum lws_close_status);
883 remove_wsi_socket_from_fds(struct libwebsocket_context *context,
884 struct libwebsocket *wsi);
886 lws_rxflow_cache(struct libwebsocket *wsi, unsigned char *buf, int n, int len);
889 static inline void lws_latency(struct libwebsocket_context *context,
890 struct libwebsocket *wsi, const char *action,
891 int ret, int completion) { do { } while (0); }
892 static inline void lws_latency_pre(struct libwebsocket_context *context,
893 struct libwebsocket *wsi) { do { } while (0); }
895 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
897 lws_latency(struct libwebsocket_context *context,
898 struct libwebsocket *wsi, const char *action,
899 int ret, int completion);
902 LWS_EXTERN void lws_set_protocol_write_pending(struct libwebsocket_context *context,
903 struct libwebsocket *wsi,
904 enum lws_pending_protocol_send pend);
906 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
909 libwebsocket_parse(struct libwebsocket_context *context,
910 struct libwebsocket *wsi, unsigned char c);
913 lws_http_action(struct libwebsocket_context *context, struct libwebsocket *wsi);
916 lws_b64_selftest(void);
919 LWS_EXTERN struct libwebsocket *
920 wsi_from_fd(struct libwebsocket_context *context, int fd);
923 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi);
926 delete_from_fd(struct libwebsocket_context *context, int fd);
928 #define wsi_from_fd(A,B) A->lws_lookup[B]
929 #define insert_wsi(A,B) A->lws_lookup[B->sock]=B
930 #define delete_from_fd(A,B) A->lws_lookup[B]=0
934 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
935 struct libwebsocket *wsi);
938 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
942 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
943 struct libwebsocket *wsi, unsigned int sec);
945 LWS_EXTERN struct libwebsocket *
946 libwebsocket_client_connect_2(struct libwebsocket_context *context,
947 struct libwebsocket *wsi);
949 LWS_EXTERN struct libwebsocket *
950 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
953 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
954 struct libwebsocket *wsi, char *pkt);
957 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
958 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
964 #ifndef LWS_NO_EXTENSIONS
966 lws_context_init_extensions(struct lws_context_creation_info *info,
967 struct libwebsocket_context *context);
969 lws_any_extension_handled(struct libwebsocket_context *context,
970 struct libwebsocket *wsi,
971 enum libwebsocket_extension_callback_reasons r,
972 void *v, size_t len);
975 lws_ext_callback_for_each_active(struct libwebsocket *wsi, int reason,
978 lws_ext_callback_for_each_extension_type(
979 struct libwebsocket_context *context, struct libwebsocket *wsi,
980 int reason, void *arg, int len);
982 #define lws_any_extension_handled(_a, _b, _c, _d, _e) (0)
983 #define lws_ext_callback_for_each_active(_a, _b, _c, _d) (0)
984 #define lws_ext_callback_for_each_extension_type(_a, _b, _c, _d, _e) (0)
985 #define lws_issue_raw_ext_access lws_issue_raw
986 #define lws_context_init_extensions(_a, _b)
990 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
991 struct libwebsocket *wsi);
994 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
997 lws_issue_raw_ext_access(struct libwebsocket *wsi,
998 unsigned char *buf, size_t len);
1001 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
1004 lws_union_transition(struct libwebsocket *wsi, enum connection_mode mode);
1007 user_callback_handle_rxflow(callback_function,
1008 struct libwebsocket_context *context,
1009 struct libwebsocket *wsi,
1010 enum libwebsocket_callback_reasons reason, void *user,
1011 void *in, size_t len);
1012 #ifdef LWS_USE_HTTP2
1013 LWS_EXTERN struct libwebsocket *lws_http2_get_network_wsi(struct libwebsocket *wsi);
1014 struct libwebsocket * lws_http2_get_nth_child(struct libwebsocket *wsi, int n);
1016 lws_http2_interpret_settings_payload(struct http2_settings *settings, unsigned char *buf, int len);
1017 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1019 lws_http2_parser(struct libwebsocket_context *context,
1020 struct libwebsocket *wsi, unsigned char c);
1021 LWS_EXTERN int lws_http2_do_pps_send(struct libwebsocket_context *context, struct libwebsocket *wsi);
1022 LWS_EXTERN int lws_http2_frame_write(struct libwebsocket *wsi, int type, int flags, unsigned int sid, unsigned int len, unsigned char *buf);
1023 LWS_EXTERN struct libwebsocket *
1024 lws_http2_wsi_from_id(struct libwebsocket *wsi, unsigned int sid);
1025 LWS_EXTERN int lws_hpack_interpret(struct libwebsocket_context *context,
1026 struct libwebsocket *wsi,
1029 lws_add_http2_header_by_name(struct libwebsocket_context *context,
1030 struct libwebsocket *wsi,
1031 const unsigned char *name,
1032 const unsigned char *value,
1035 unsigned char *end);
1037 lws_add_http2_header_by_token(struct libwebsocket_context *context,
1038 struct libwebsocket *wsi,
1039 enum lws_token_indexes token,
1040 const unsigned char *value,
1043 unsigned char *end);
1045 lws_add_http2_header_status(struct libwebsocket_context *context,
1046 struct libwebsocket *wsi,
1049 unsigned char *end);
1051 void lws_http2_configure_if_upgraded(struct libwebsocket *wsi);
1053 #define lws_http2_configure_if_upgraded(x)
1057 lws_plat_set_socket_options(struct libwebsocket_context *context, int fd);
1060 lws_allocate_header_table(struct libwebsocket *wsi);
1063 lws_free_header_table(struct libwebsocket *wsi);
1066 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
1069 lws_hdr_simple_create(struct libwebsocket *wsi,
1070 enum lws_token_indexes h, const char *s);
1073 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
1076 lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or);
1078 #ifndef LWS_NO_SERVER
1079 int lws_context_init_server(struct lws_context_creation_info *info,
1080 struct libwebsocket_context *context);
1081 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
1082 struct libwebsocket *wsi);
1084 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
1085 unsigned char *buf, size_t len);
1087 lws_server_get_canonical_hostname(struct libwebsocket_context *context,
1088 struct lws_context_creation_info *info);
1090 #define lws_context_init_server(_a, _b) (0)
1091 #define libwebsocket_interpret_incoming_packet(_a, _b, _c) (0)
1092 #define lws_server_get_canonical_hostname(_a, _b)
1095 #ifndef LWS_NO_DAEMONIZE
1096 LWS_EXTERN int get_daemonize_pid();
1098 #define get_daemonize_pid() (0)
1101 LWS_EXTERN int interface_to_sa(struct libwebsocket_context *context,
1102 const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1104 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1107 LWS_EXTERN HANDLE lws_plat_open_file(const char* filename, unsigned long* filelen);
1109 LWS_EXTERN int lws_plat_open_file(const char* filename, unsigned long* filelen);
1112 enum lws_ssl_capable_status {
1113 LWS_SSL_CAPABLE_ERROR = -1,
1114 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1117 #ifndef LWS_OPENSSL_SUPPORT
1118 #define LWS_SSL_ENABLED(context) (0)
1119 #define lws_context_init_server_ssl(_a, _b) (0)
1120 #define lws_ssl_destroy(_a)
1121 #define lws_context_init_http2_ssl(_a)
1122 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1123 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1124 #define lws_server_socket_service_ssl(_a, _b, _c, _d, _e) (0)
1125 #define lws_ssl_close(_a) (0)
1126 #define lws_ssl_context_destroy(_a)
1127 #define lws_ssl_remove_wsi_from_buffered_list(_a, _b)
1129 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1130 LWS_EXTERN int openssl_websocket_private_data_index;
1132 lws_ssl_capable_read(struct libwebsocket_context *context,
1133 struct libwebsocket *wsi, unsigned char *buf, int len);
1136 lws_ssl_capable_write(struct libwebsocket *wsi, unsigned char *buf, int len);
1138 lws_server_socket_service_ssl(struct libwebsocket_context *context,
1139 struct libwebsocket **wsi, struct libwebsocket *new_wsi,
1140 int accept_fd, struct libwebsocket_pollfd *pollfd);
1142 lws_ssl_close(struct libwebsocket *wsi);
1144 lws_ssl_context_destroy(struct libwebsocket_context *context);
1146 lws_ssl_remove_wsi_from_buffered_list(struct libwebsocket_context *context,
1147 struct libwebsocket *wsi);
1148 #ifndef LWS_NO_SERVER
1150 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1151 struct libwebsocket_context *context);
1153 #define lws_context_init_server_ssl(_a, _b) (0)
1156 lws_ssl_destroy(struct libwebsocket_context *context);
1160 #ifdef LWS_USE_HTTP2
1162 lws_context_init_http2_ssl(struct libwebsocket_context *context);
1164 #define lws_context_init_http2_ssl(_a)
1169 lws_ssl_capable_read_no_ssl(struct libwebsocket_context *context,
1170 struct libwebsocket *wsi, unsigned char *buf, int len);
1173 lws_ssl_capable_write_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len);
1175 #ifndef LWS_NO_CLIENT
1176 LWS_EXTERN int lws_client_socket_service(
1177 struct libwebsocket_context *context,
1178 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1179 #ifdef LWS_OPENSSL_SUPPORT
1180 LWS_EXTERN int lws_context_init_client_ssl(struct lws_context_creation_info *info,
1181 struct libwebsocket_context *context);
1183 #define lws_context_init_client_ssl(_a, _b) (0)
1185 LWS_EXTERN int lws_handshake_client(struct libwebsocket *wsi, unsigned char **buf, size_t len);
1187 libwebsockets_decode_ssl_error(void);
1189 #define lws_context_init_client_ssl(_a, _b) (0)
1190 #define lws_handshake_client(_a, _b, _c) (0)
1192 #ifndef LWS_NO_SERVER
1193 LWS_EXTERN int lws_server_socket_service(
1194 struct libwebsocket_context *context,
1195 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1196 LWS_EXTERN int _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
1197 LWS_EXTERN int lws_handshake_server(struct libwebsocket_context *context,
1198 struct libwebsocket *wsi, unsigned char **buf, size_t len);
1200 #define lws_server_socket_service(_a, _b, _c) (0)
1201 #define _libwebsocket_rx_flow_control(_a) (0)
1202 #define lws_handshake_server(_a, _b, _c, _d) (0)
1205 LWS_EXTERN int libwebsockets_get_addresses(struct libwebsocket_context *context,
1206 void *ads, char *name, int name_len,
1207 char *rip, int rip_len);
1213 lws_realloc(void *ptr, size_t size);
1216 lws_zalloc(size_t size);
1218 #define lws_malloc(S) lws_realloc(NULL, S)
1219 #define lws_free(P) lws_realloc(P, 0)
1220 #define lws_free2(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
1226 lws_plat_delete_socket_from_fds(struct libwebsocket_context *context,
1227 struct libwebsocket *wsi, int m);
1229 lws_plat_insert_socket_into_fds(struct libwebsocket_context *context,
1230 struct libwebsocket *wsi);
1232 lws_plat_service_periodic(struct libwebsocket_context *context);
1235 lws_plat_change_pollfd(struct libwebsocket_context *context,
1236 struct libwebsocket *wsi, struct libwebsocket_pollfd *pfd);
1238 lws_plat_context_early_init(void);
1240 lws_plat_context_early_destroy(struct libwebsocket_context *context);
1242 lws_plat_context_late_destroy(struct libwebsocket_context *context);
1244 lws_poll_listen_fd(struct libwebsocket_pollfd *fd);
1246 lws_plat_service(struct libwebsocket_context *context, int timeout_ms);
1248 lws_plat_init_fd_tables(struct libwebsocket_context *context);
1250 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1251 LWS_EXTERN unsigned long long
1252 time_in_microseconds(void);
1253 LWS_EXTERN const char *
1254 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);