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 #include "lws_config.h"
24 #ifdef HAVE_SYS_TYPES_H
25 #include <sys/types.h>
36 #ifdef HAVE_SYS_STAT_H
40 #if defined(WIN32) || defined(_WIN32)
41 #define LWS_NO_DAEMONIZE
42 #define LWS_ERRNO WSAGetLastError()
43 #define LWS_EAGAIN WSAEWOULDBLOCK
44 #define LWS_EALREADY WSAEALREADY
45 #define LWS_EINPROGRESS WSAEINPROGRESS
46 #define LWS_EINTR WSAEINTR
47 #define LWS_EISCONN WSAEISCONN
48 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
49 #define LWS_POLLHUP (FD_CLOSE)
50 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
51 #define LWS_POLLOUT (FD_WRITE)
52 #define MSG_NOSIGNAL 0
53 #define SHUT_RDWR SD_BOTH
54 #define SOL_TCP IPPROTO_TCP
56 #define compatible_close(fd) closesocket(fd)
57 #define compatible_file_close(fd) CloseHandle(fd)
58 #define compatible_file_seek_cur(fd, offset) SetFilePointer(fd, offset, NULL, FILE_CURRENT)
59 #define compatible_file_read(amount, fd, buf, len) {\
61 if (!ReadFile(fd, buf, len, &_amount, NULL)) \
66 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = TRUE
76 #define __func__ __FUNCTION__
80 #define vsnprintf _vsnprintf
83 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
84 #else /* not windows --> */
91 #include <sys/types.h>
92 #include <sys/socket.h>
93 #ifdef LWS_BUILTIN_GETIFADDRS
94 #include <getifaddrs.h>
98 #if defined (__ANDROID__)
101 #include <sys/syslog.h>
104 #include <sys/socket.h>
107 #ifdef HAVE_SYS_PRCTL_H
108 #include <sys/prctl.h>
111 #include <netinet/in.h>
112 #include <netinet/tcp.h>
113 #include <arpa/inet.h>
117 #endif /* LWS_USE_LIBEV */
119 #include <sys/mman.h>
120 #include <sys/time.h>
122 #define LWS_ERRNO errno
123 #define LWS_EAGAIN EAGAIN
124 #define LWS_EALREADY EALREADY
125 #define LWS_EINPROGRESS EINPROGRESS
126 #define LWS_EINTR EINTR
127 #define LWS_EISCONN EISCONN
128 #define LWS_EWOULDBLOCK EWOULDBLOCK
129 #define LWS_INVALID_FILE -1
130 #define LWS_POLLHUP (POLLHUP|POLLERR)
131 #define LWS_POLLIN (POLLIN)
132 #define LWS_POLLOUT (POLLOUT)
133 #define compatible_close(fd) close(fd)
134 #define compatible_file_close(fd) close(fd)
135 #define compatible_file_seek_cur(fd, offset) lseek(fd, offset, SEEK_CUR)
136 #define compatible_file_read(amount, fd, buf, len) \
137 amount = read(fd, buf, len);
138 #define lws_set_blocking_send(wsi)
143 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
147 #ifndef HAVE_STRERROR
148 #define strerror(x) ""
151 #ifdef LWS_OPENSSL_SUPPORT
153 #include <wolfssl/openssl/ssl.h>
154 #include <wolfssl/error-ssl.h>
156 #include <openssl/ssl.h>
157 #include <openssl/evp.h>
158 #include <openssl/err.h>
159 #include <openssl/md5.h>
160 #include <openssl/sha.h>
161 #endif /* not USE_WOLFSSL */
164 #include "libwebsockets.h"
166 #if defined(WIN32) || defined(_WIN32)
169 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
171 #ifndef LITTLE_ENDIAN
172 #define LITTLE_ENDIAN 1234
175 #define BYTE_ORDER LITTLE_ENDIAN
177 typedef unsigned __int64 u_int64_t;
182 #define __P(protos) protos
184 #define __P(protos) ()
190 #include <sys/stat.h>
191 #include <sys/cdefs.h>
192 #include <sys/time.h>
194 #if defined(__APPLE__)
195 #include <machine/endian.h>
196 #elif defined(__FreeBSD__)
197 #include <sys/endian.h>
198 #elif defined(__linux__)
205 #define container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
209 #include <gulliver.h>
210 #if defined(__LITTLEENDIAN__)
211 #define BYTE_ORDER __LITTLEENDIAN__
212 #define LITTLE_ENDIAN __LITTLEENDIAN__
213 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
215 #if defined(__BIGENDIAN__)
216 #define BYTE_ORDER __BIGENDIAN__
217 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
218 #define BIG_ENDIAN __BIGENDIAN__
222 #if !defined(BYTE_ORDER)
223 # define BYTE_ORDER __BYTE_ORDER
225 #if !defined(LITTLE_ENDIAN)
226 # define LITTLE_ENDIAN __LITTLE_ENDIAN
228 #if !defined(BIG_ENDIAN)
229 # define BIG_ENDIAN __BIG_ENDIAN
235 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
236 * but happily have something equivalent in the SO_NOSIGPIPE flag.
239 #define MSG_NOSIGNAL SO_NOSIGPIPE
243 #ifndef FD_HASHTABLE_MODULUS
244 #define FD_HASHTABLE_MODULUS 32
248 #ifndef LWS_MAX_HEADER_LEN
249 #define LWS_MAX_HEADER_LEN 1024
251 #ifndef LWS_MAX_PROTOCOLS
252 #define LWS_MAX_PROTOCOLS 5
254 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
255 #define LWS_MAX_EXTENSIONS_ACTIVE 3
257 #ifndef SPEC_LATEST_SUPPORTED
258 #define SPEC_LATEST_SUPPORTED 13
260 #ifndef AWAITING_TIMEOUT
261 #define AWAITING_TIMEOUT 5
263 #ifndef CIPHERS_LIST_STRING
264 #define CIPHERS_LIST_STRING "DEFAULT"
266 #ifndef LWS_SOMAXCONN
267 #define LWS_SOMAXCONN SOMAXCONN
270 #define MAX_WEBSOCKET_04_KEY_LEN 128
271 #define LWS_MAX_SOCKET_IO_BUF 4096
273 #ifndef SYSTEM_RANDOM_FILEPATH
274 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
276 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
277 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
281 * if not in a connection storm, check for incoming
282 * connections this many normal connection services
284 #define LWS_LISTEN_SERVICE_MODULO 10
286 enum lws_websocket_opcodes_07 {
287 LWS_WS_OPCODE_07__CONTINUATION = 0,
288 LWS_WS_OPCODE_07__TEXT_FRAME = 1,
289 LWS_WS_OPCODE_07__BINARY_FRAME = 2,
291 LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
293 /* control extensions 8+ */
295 LWS_WS_OPCODE_07__CLOSE = 8,
296 LWS_WS_OPCODE_07__PING = 9,
297 LWS_WS_OPCODE_07__PONG = 0xa,
301 enum lws_connection_states {
303 WSI_STATE_HTTP_ISSUING_FILE,
304 WSI_STATE_HTTP_HEADERS,
306 WSI_STATE_DEAD_SOCKET,
307 WSI_STATE_ESTABLISHED,
308 WSI_STATE_CLIENT_UNCONNECTED,
309 WSI_STATE_RETURNED_CLOSE_ALREADY,
310 WSI_STATE_AWAITING_CLOSE_ACK,
311 WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE,
313 WSI_STATE_HTTP2_AWAIT_CLIENT_PREFACE,
314 WSI_STATE_HTTP2_ESTABLISHED_PRE_SETTINGS,
315 WSI_STATE_HTTP2_ESTABLISHED,
323 enum http_connection_type {
324 HTTP_CONNECTION_CLOSE,
325 HTTP_CONNECTION_KEEP_ALIVE
328 enum lws_pending_protocol_send {
330 LWS_PPS_HTTP2_MY_SETTINGS,
331 LWS_PPS_HTTP2_ACK_SETTINGS,
335 enum lws_rx_parse_state {
338 LWS_RXPS_04_MASK_NONCE_1,
339 LWS_RXPS_04_MASK_NONCE_2,
340 LWS_RXPS_04_MASK_NONCE_3,
342 LWS_RXPS_04_FRAME_HDR_1,
343 LWS_RXPS_04_FRAME_HDR_LEN,
344 LWS_RXPS_04_FRAME_HDR_LEN16_2,
345 LWS_RXPS_04_FRAME_HDR_LEN16_1,
346 LWS_RXPS_04_FRAME_HDR_LEN64_8,
347 LWS_RXPS_04_FRAME_HDR_LEN64_7,
348 LWS_RXPS_04_FRAME_HDR_LEN64_6,
349 LWS_RXPS_04_FRAME_HDR_LEN64_5,
350 LWS_RXPS_04_FRAME_HDR_LEN64_4,
351 LWS_RXPS_04_FRAME_HDR_LEN64_3,
352 LWS_RXPS_04_FRAME_HDR_LEN64_2,
353 LWS_RXPS_04_FRAME_HDR_LEN64_1,
355 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
356 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
357 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
358 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
360 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
364 enum connection_mode {
365 LWS_CONNMODE_HTTP_SERVING,
366 LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
367 LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
369 LWS_CONNMODE_WS_SERVING,
370 LWS_CONNMODE_WS_CLIENT,
372 LWS_CONNMODE_HTTP2_SERVING,
374 /* transient, ssl delay hiding */
375 LWS_CONNMODE_SSL_ACK_PENDING,
377 /* transient modes */
378 LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
379 LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
380 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
381 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE2,
382 LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
383 LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
384 LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
385 LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
387 /* special internal types */
388 LWS_CONNMODE_SERVER_LISTENER,
392 LWS_RXFLOW_ALLOW = (1 << 0),
393 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
396 struct libwebsocket_protocols;
400 struct lws_io_watcher {
401 struct ev_io watcher;
402 struct libwebsocket_context* context;
405 struct lws_signal_watcher {
406 struct ev_signal watcher;
407 struct libwebsocket_context* context;
409 #endif /* LWS_USE_LIBEV */
412 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
413 struct libwebsocket_fd_hashtable {
414 struct libwebsocket **wsi;
419 struct libwebsocket_context {
423 struct libwebsocket_pollfd *fds;
425 /* different implementation between unix and windows */
426 struct libwebsocket_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
428 struct libwebsocket **lws_lookup; /* fd to wsi */
432 struct ev_loop* io_loop;
433 struct lws_io_watcher w_accept;
434 struct lws_signal_watcher w_sigint;
435 #endif /* LWS_USE_LIBEV */
439 char http_proxy_address[128];
440 char canonical_hostname[128];
441 unsigned int http_proxy_port;
442 unsigned int options;
443 time_t last_timeout_check_s;
446 * usable by anything in the service code, but only if the scope
447 * does not last longer than the service action (since next service
448 * of any socket can likewise use it and overwrite)
450 unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
452 int started_with_parent;
455 int listen_service_modulo;
456 int listen_service_count;
457 int listen_service_fd;
458 int listen_service_extraseen;
461 * set to the Thread ID that's doing the service loop just before entry
462 * to poll indicates service thread likely idling in poll()
463 * volatile because other threads may check it as part of processing
464 * for pollfd event change.
466 volatile int service_tid;
468 int dummy_pipe_fds[2];
476 unsigned long worst_latency;
477 char worst_latency_info[256];
480 #ifdef LWS_OPENSSL_SUPPORT
482 int allow_non_ssl_on_ssl_port;
483 unsigned int user_supplied_ssl_ctx:1;
485 SSL_CTX *ssl_client_ctx;
486 struct libwebsocket *pending_read_list; /* linked list */
487 #define lws_ssl_anybody_has_buffered_read(ctx) (ctx->use_ssl && ctx->pending_read_list)
489 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
491 struct libwebsocket_protocols *protocols;
493 #ifndef LWS_NO_EXTENSIONS
494 struct libwebsocket_extension *extensions;
496 struct lws_token_limits *token_limits;
501 LWS_EV_READ = (1 << 0),
502 LWS_EV_WRITE = (1 << 1),
503 LWS_EV_START = (1 << 2),
504 LWS_EV_STOP = (1 << 3),
508 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
509 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
511 lws_libev_accept(struct libwebsocket_context *context,
512 struct libwebsocket *new_wsi, int accept_fd);
514 lws_libev_io(struct libwebsocket_context *context,
515 struct libwebsocket *wsi, int flags);
517 lws_libev_init_fd_table(struct libwebsocket_context *context);
519 lws_libev_run(struct libwebsocket_context *context);
521 #define LWS_LIBEV_ENABLED(context) (0)
522 #define lws_feature_status_libev(_a) \
523 lwsl_notice("libev support not compiled in\n")
524 #define lws_libev_accept(_a, _b, _c) ((void) 0)
525 #define lws_libev_io(_a, _b, _c) ((void) 0)
526 #define lws_libev_init_fd_table(_a) (0)
527 #define lws_libev_run(_a) ((void) 0)
531 #define LWS_IPV6_ENABLED(context) (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
533 #define LWS_IPV6_ENABLED(context) (0)
536 enum uri_path_states {
539 URIPS_SEEN_SLASH_DOT,
540 URIPS_SEEN_SLASH_DOT_DOT,
544 enum uri_esc_states {
547 URIES_SEEN_PERCENT_H1,
551 * This is totally opaque to code using the library. It's exported as a
552 * forward-reference pointer-only declaration; the user can use the pointer with
553 * other APIs to get information out of it.
556 struct lws_fragments {
557 unsigned short offset;
559 unsigned char next_frag_index;
562 /* notice that these union members:
568 * all have a pointer to allocated_headers struct as their first member.
570 * It means for allocated_headers access, the three union paths can all be
571 * used interchangably to access the same data
574 struct allocated_headers {
575 unsigned short next_frag_index;
577 unsigned char frag_index[WSI_TOKEN_COUNT];
578 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
579 char data[LWS_MAX_HEADER_LEN];
580 #ifndef LWS_NO_CLIENT
581 char initial_handshake_hash_base64[30];
582 unsigned short c_port;
586 struct _lws_http_mode_related {
587 /* MUST be first in struct */
588 struct allocated_headers *ah; /* mirroring _lws_header_related */
589 #if defined(WIN32) || defined(_WIN32)
594 unsigned long filepos;
595 unsigned long filelen;
597 enum http_version request_version;
598 enum http_connection_type connection_type;
606 enum lws_http2_settings {
607 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
608 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
609 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
610 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
611 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
612 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
614 LWS_HTTP2_SETTINGS__COUNT /* always last */
617 enum lws_http2_wellknown_frame_types {
618 LWS_HTTP2_FRAME_TYPE_DATA,
619 LWS_HTTP2_FRAME_TYPE_HEADERS,
620 LWS_HTTP2_FRAME_TYPE_PRIORITY,
621 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
622 LWS_HTTP2_FRAME_TYPE_SETTINGS,
623 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
624 LWS_HTTP2_FRAME_TYPE_PING,
625 LWS_HTTP2_FRAME_TYPE_GOAWAY,
626 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
627 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
629 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
632 enum lws_http2_flags {
633 LWS_HTTP2_FLAG_END_STREAM = 1,
634 LWS_HTTP2_FLAG_END_HEADERS = 4,
635 LWS_HTTP2_FLAG_PADDED = 8,
636 LWS_HTTP2_FLAG_PRIORITY = 0x20,
638 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
641 #define LWS_HTTP2_STREAM_ID_MASTER 0
642 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
643 #define LWS_HTTP2_SETTINGS_LENGTH 6
645 struct http2_settings {
646 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
649 enum http2_hpack_state {
651 /* optional before first header block */
653 HKPS_OPT_E_DEPENDENCY,
666 /* optional after last header block */
667 HKPS_OPT_DISCARD_PADDING,
670 enum http2_hpack_type {
672 HPKT_INDEXED_HDR_6_VALUE_INCR,
673 HPKT_LITERAL_HDR_VALUE_INCR,
674 HPKT_INDEXED_HDR_4_VALUE,
675 HPKT_LITERAL_HDR_VALUE,
679 struct hpack_dt_entry {
680 int token; /* additions that don't map to a token are ignored */
685 struct hpack_dynamic_table {
686 struct hpack_dt_entry *entries;
694 struct _lws_http2_related {
696 * having this first lets us also re-use all HTTP union code
697 * and in turn, http_mode_related has allocated headers in right
698 * place so we can use the header apis on the wsi directly still
700 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
702 struct http2_settings my_settings;
703 struct http2_settings peer_settings;
705 struct libwebsocket *parent_wsi;
706 struct libwebsocket *next_child_wsi;
708 struct hpack_dynamic_table *hpack_dyn_table;
714 unsigned int stream_id;
715 struct libwebsocket *stream_wsi;
718 unsigned char frame_state;
719 unsigned char padding;
721 unsigned char ping_payload[8];
723 unsigned short round_robin_POLLOUT;
724 unsigned short count_POLLOUT_children;
726 unsigned int END_STREAM:1;
727 unsigned int END_HEADERS:1;
728 unsigned int send_END_STREAM:1;
729 unsigned int GOING_AWAY;
730 unsigned int requested_POLLOUT:1;
731 unsigned int waiting_tx_credit:1;
734 enum http2_hpack_state hpack;
735 enum http2_hpack_type hpack_type;
736 unsigned int header_index;
737 unsigned int hpack_len;
738 unsigned short hpack_pos;
739 unsigned char hpack_m;
740 unsigned int hpack_e_dep;
742 unsigned int value:1;
744 /* negative credit is mandated by the spec */
746 unsigned int my_stream_id;
747 unsigned int child_count;
749 unsigned char initialized;
750 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
753 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
757 struct _lws_header_related {
758 /* MUST be first in struct */
759 struct allocated_headers *ah;
761 unsigned short current_token_limit;
762 unsigned char parser_state; /* enum lws_token_indexes */
763 enum uri_path_states ups;
764 enum uri_esc_states ues;
768 struct _lws_websocket_related {
769 char *rx_user_buffer;
770 int rx_user_buffer_head;
771 unsigned char frame_masking_nonce_04[4];
772 unsigned char frame_mask_index;
773 size_t rx_packet_length;
774 unsigned char opcode;
775 unsigned int final:1;
777 unsigned int frame_is_binary:1;
778 unsigned int all_zero_nonce:1;
779 short close_reason; /* enum lws_close_status */
781 unsigned int this_frame_masked:1;
782 unsigned int inside_frame:1; /* next write will be more of frame */
783 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
784 unsigned int payload_is_close:1; /* process as PONG, but it is close */
786 unsigned char *ping_payload_buf; /* non-NULL if malloc'd */
787 unsigned int ping_payload_alloc; /* length malloc'd */
788 unsigned int ping_payload_len;
789 unsigned char ping_pending_flag;
792 struct libwebsocket {
794 /* lifetime members */
797 struct lws_io_watcher w_read;
798 struct lws_io_watcher w_write;
799 #endif /* LWS_USE_LIBEV */
800 const struct libwebsocket_protocols *protocol;
801 #ifndef LWS_NO_EXTENSIONS
802 struct libwebsocket_extension *
803 active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
804 void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
805 unsigned char count_active_extensions;
806 unsigned int extension_data_pending:1;
808 unsigned char ietf_spec_revision;
809 enum lws_pending_protocol_send pps;
811 char mode; /* enum connection_mode */
812 char state; /* enum lws_connection_states */
813 char lws_rx_parse_state; /* enum lws_rx_parse_state */
814 char rx_frame_type; /* enum libwebsocket_write_protocol */
816 unsigned int hdr_parsing_completed:1;
817 unsigned int user_space_externally_allocated:1;
818 unsigned int socket_is_permanently_unusable:1;
820 char pending_timeout; /* enum pending_timeout */
821 time_t pending_timeout_limit;
823 int position_in_fds_table;
825 unsigned long action_start;
826 unsigned long latency_start;
828 /* rxflow handling */
829 unsigned char *rxflow_buffer;
832 unsigned int rxflow_change_to:2;
834 /* truncated send handling */
835 unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
836 unsigned int truncated_send_allocation; /* size of malloc */
837 unsigned int truncated_send_offset; /* where we are in terms of spilling */
838 unsigned int truncated_send_len; /* how much is buffered */
842 /* members with mutually exclusive lifetimes are unionized */
845 struct _lws_http_mode_related http;
847 struct _lws_http2_related http2;
849 struct _lws_header_related hdr;
850 struct _lws_websocket_related ws;
853 #ifdef LWS_OPENSSL_SUPPORT
856 struct libwebsocket *pending_read_list_prev, *pending_read_list_next;
857 unsigned int use_ssl:2;
858 unsigned int upgraded:1;
862 BOOL sock_send_blocking;
866 LWS_EXTERN int log_level;
869 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
870 struct libwebsocket *wsi, enum lws_close_status);
873 remove_wsi_socket_from_fds(struct libwebsocket_context *context,
874 struct libwebsocket *wsi);
876 lws_rxflow_cache(struct libwebsocket *wsi, unsigned char *buf, int n, int len);
879 static inline void lws_latency(struct libwebsocket_context *context,
880 struct libwebsocket *wsi, const char *action,
881 int ret, int completion) { do { } while (0); }
882 static inline void lws_latency_pre(struct libwebsocket_context *context,
883 struct libwebsocket *wsi) { do { } while (0); }
885 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
887 lws_latency(struct libwebsocket_context *context,
888 struct libwebsocket *wsi, const char *action,
889 int ret, int completion);
892 LWS_EXTERN void lws_set_protocol_write_pending(struct libwebsocket_context *context,
893 struct libwebsocket *wsi,
894 enum lws_pending_protocol_send pend);
896 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
899 libwebsocket_parse(struct libwebsocket_context *context,
900 struct libwebsocket *wsi, unsigned char c);
903 lws_http_action(struct libwebsocket_context *context, struct libwebsocket *wsi);
906 lws_b64_selftest(void);
909 LWS_EXTERN struct libwebsocket *
910 wsi_from_fd(struct libwebsocket_context *context, int fd);
913 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi);
916 delete_from_fd(struct libwebsocket_context *context, int fd);
918 #define wsi_from_fd(A,B) A->lws_lookup[B]
919 #define insert_wsi(A,B) A->lws_lookup[B->sock]=B
920 #define delete_from_fd(A,B) A->lws_lookup[B]=0
924 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
925 struct libwebsocket *wsi);
928 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
932 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
933 struct libwebsocket *wsi, unsigned int sec);
935 LWS_EXTERN struct libwebsocket *
936 libwebsocket_client_connect_2(struct libwebsocket_context *context,
937 struct libwebsocket *wsi);
939 LWS_EXTERN struct libwebsocket *
940 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
943 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
944 struct libwebsocket *wsi, char *pkt);
947 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
948 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
954 #ifndef LWS_NO_EXTENSIONS
956 lws_context_init_extensions(struct lws_context_creation_info *info,
957 struct libwebsocket_context *context);
959 lws_any_extension_handled(struct libwebsocket_context *context,
960 struct libwebsocket *wsi,
961 enum libwebsocket_extension_callback_reasons r,
962 void *v, size_t len);
965 lws_ext_callback_for_each_active(struct libwebsocket *wsi, int reason,
968 lws_ext_callback_for_each_extension_type(
969 struct libwebsocket_context *context, struct libwebsocket *wsi,
970 int reason, void *arg, int len);
972 #define lws_any_extension_handled(_a, _b, _c, _d, _e) (0)
973 #define lws_ext_callback_for_each_active(_a, _b, _c, _d) (0)
974 #define lws_ext_callback_for_each_extension_type(_a, _b, _c, _d, _e) (0)
975 #define lws_issue_raw_ext_access lws_issue_raw
976 #define lws_context_init_extensions(_a, _b)
980 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
981 struct libwebsocket *wsi);
984 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
987 lws_issue_raw_ext_access(struct libwebsocket *wsi,
988 unsigned char *buf, size_t len);
991 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
994 lws_union_transition(struct libwebsocket *wsi, enum connection_mode mode);
997 user_callback_handle_rxflow(callback_function,
998 struct libwebsocket_context *context,
999 struct libwebsocket *wsi,
1000 enum libwebsocket_callback_reasons reason, void *user,
1001 void *in, size_t len);
1002 #ifdef LWS_USE_HTTP2
1003 LWS_EXTERN struct libwebsocket *lws_http2_get_network_wsi(struct libwebsocket *wsi);
1004 struct libwebsocket * lws_http2_get_nth_child(struct libwebsocket *wsi, int n);
1006 lws_http2_interpret_settings_payload(struct http2_settings *settings, unsigned char *buf, int len);
1007 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1009 lws_http2_parser(struct libwebsocket_context *context,
1010 struct libwebsocket *wsi, unsigned char c);
1011 LWS_EXTERN int lws_http2_do_pps_send(struct libwebsocket_context *context, struct libwebsocket *wsi);
1012 LWS_EXTERN int lws_http2_frame_write(struct libwebsocket *wsi, int type, int flags, unsigned int sid, unsigned int len, unsigned char *buf);
1013 LWS_EXTERN struct libwebsocket *
1014 lws_http2_wsi_from_id(struct libwebsocket *wsi, unsigned int sid);
1015 LWS_EXTERN int lws_hpack_interpret(struct libwebsocket_context *context,
1016 struct libwebsocket *wsi,
1019 lws_add_http2_header_by_name(struct libwebsocket_context *context,
1020 struct libwebsocket *wsi,
1021 const unsigned char *name,
1022 const unsigned char *value,
1025 unsigned char *end);
1027 lws_add_http2_header_by_token(struct libwebsocket_context *context,
1028 struct libwebsocket *wsi,
1029 enum lws_token_indexes token,
1030 const unsigned char *value,
1033 unsigned char *end);
1035 lws_add_http2_header_status(struct libwebsocket_context *context,
1036 struct libwebsocket *wsi,
1039 unsigned char *end);
1041 void lws_http2_configure_if_upgraded(struct libwebsocket *wsi);
1043 #define lws_http2_configure_if_upgraded(x)
1047 lws_plat_set_socket_options(struct libwebsocket_context *context, int fd);
1050 lws_allocate_header_table(struct libwebsocket *wsi);
1053 lws_free_header_table(struct libwebsocket *wsi);
1056 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
1059 lws_hdr_simple_create(struct libwebsocket *wsi,
1060 enum lws_token_indexes h, const char *s);
1063 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
1066 lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or);
1068 #ifndef LWS_NO_SERVER
1069 int lws_context_init_server(struct lws_context_creation_info *info,
1070 struct libwebsocket_context *context);
1071 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
1072 struct libwebsocket *wsi);
1074 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
1075 unsigned char *buf, size_t len);
1077 lws_server_get_canonical_hostname(struct libwebsocket_context *context,
1078 struct lws_context_creation_info *info);
1080 #define lws_context_init_server(_a, _b) (0)
1081 #define libwebsocket_interpret_incoming_packet(_a, _b, _c) (0)
1082 #define lws_server_get_canonical_hostname(_a, _b)
1085 #ifndef LWS_NO_DAEMONIZE
1086 LWS_EXTERN int get_daemonize_pid();
1088 #define get_daemonize_pid() (0)
1091 LWS_EXTERN int interface_to_sa(struct libwebsocket_context *context,
1092 const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1094 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1097 LWS_EXTERN HANDLE lws_plat_open_file(const char* filename, unsigned long* filelen);
1099 LWS_EXTERN int lws_plat_open_file(const char* filename, unsigned long* filelen);
1102 enum lws_ssl_capable_status {
1103 LWS_SSL_CAPABLE_ERROR = -1,
1104 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1107 #ifndef LWS_OPENSSL_SUPPORT
1108 #define LWS_SSL_ENABLED(context) (0)
1109 #define lws_context_init_server_ssl(_a, _b) (0)
1110 #define lws_ssl_destroy(_a)
1111 #define lws_context_init_http2_ssl(_a)
1112 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1113 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1114 #define lws_ssl_pending lws_ssl_pending_no_ssl
1115 #define lws_server_socket_service_ssl(_a, _b, _c, _d, _e) (0)
1116 #define lws_ssl_close(_a) (0)
1117 #define lws_ssl_context_destroy(_a)
1118 #define lws_ssl_remove_wsi_from_buffered_list(_a, _b)
1120 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1121 LWS_EXTERN int openssl_websocket_private_data_index;
1123 lws_ssl_capable_read(struct libwebsocket_context *context,
1124 struct libwebsocket *wsi, unsigned char *buf, int len);
1126 lws_ssl_capable_write(struct libwebsocket *wsi, unsigned char *buf, int len);
1128 lws_ssl_pending(struct libwebsocket *wsi);
1130 lws_server_socket_service_ssl(struct libwebsocket_context *context,
1131 struct libwebsocket **wsi, struct libwebsocket *new_wsi,
1132 int accept_fd, struct libwebsocket_pollfd *pollfd);
1134 lws_ssl_close(struct libwebsocket *wsi);
1136 lws_ssl_context_destroy(struct libwebsocket_context *context);
1138 lws_ssl_remove_wsi_from_buffered_list(struct libwebsocket_context *context,
1139 struct libwebsocket *wsi);
1140 #ifndef LWS_NO_SERVER
1142 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1143 struct libwebsocket_context *context);
1145 #define lws_context_init_server_ssl(_a, _b) (0)
1148 lws_ssl_destroy(struct libwebsocket_context *context);
1152 #ifdef LWS_USE_HTTP2
1154 lws_context_init_http2_ssl(struct libwebsocket_context *context);
1156 #define lws_context_init_http2_ssl(_a)
1161 lws_ssl_capable_read_no_ssl(struct libwebsocket_context *context,
1162 struct libwebsocket *wsi, unsigned char *buf, int len);
1165 lws_ssl_capable_write_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len);
1168 lws_ssl_pending_no_ssl(struct libwebsocket *wsi);
1170 #ifndef LWS_NO_CLIENT
1171 LWS_EXTERN int lws_client_socket_service(
1172 struct libwebsocket_context *context,
1173 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1174 #ifdef LWS_OPENSSL_SUPPORT
1175 LWS_EXTERN int lws_context_init_client_ssl(struct lws_context_creation_info *info,
1176 struct libwebsocket_context *context);
1178 #define lws_context_init_client_ssl(_a, _b) (0)
1180 LWS_EXTERN int lws_handshake_client(struct libwebsocket *wsi, unsigned char **buf, size_t len);
1182 libwebsockets_decode_ssl_error(void);
1184 #define lws_context_init_client_ssl(_a, _b) (0)
1185 #define lws_handshake_client(_a, _b, _c) (0)
1187 #ifndef LWS_NO_SERVER
1188 LWS_EXTERN int lws_server_socket_service(
1189 struct libwebsocket_context *context,
1190 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1191 LWS_EXTERN int _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
1192 LWS_EXTERN int lws_handshake_server(struct libwebsocket_context *context,
1193 struct libwebsocket *wsi, unsigned char **buf, size_t len);
1195 #define lws_server_socket_service(_a, _b, _c) (0)
1196 #define _libwebsocket_rx_flow_control(_a) (0)
1197 #define lws_handshake_server(_a, _b, _c, _d) (0)
1200 LWS_EXTERN int libwebsockets_get_addresses(struct libwebsocket_context *context,
1201 void *ads, char *name, int name_len,
1202 char *rip, int rip_len);
1208 lws_realloc(void *ptr, size_t size);
1211 lws_zalloc(size_t size);
1213 #define lws_malloc(S) lws_realloc(NULL, S)
1214 #define lws_free(P) lws_realloc(P, 0)
1215 #define lws_free2(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
1221 lws_plat_delete_socket_from_fds(struct libwebsocket_context *context,
1222 struct libwebsocket *wsi, int m);
1224 lws_plat_insert_socket_into_fds(struct libwebsocket_context *context,
1225 struct libwebsocket *wsi);
1227 lws_plat_service_periodic(struct libwebsocket_context *context);
1230 lws_plat_change_pollfd(struct libwebsocket_context *context,
1231 struct libwebsocket *wsi, struct libwebsocket_pollfd *pfd);
1233 lws_plat_context_early_init(void);
1235 lws_plat_context_early_destroy(struct libwebsocket_context *context);
1237 lws_plat_context_late_destroy(struct libwebsocket_context *context);
1239 lws_poll_listen_fd(struct libwebsocket_pollfd *fd);
1241 lws_plat_service(struct libwebsocket_context *context, int timeout_ms);
1243 lws_plat_init_fd_tables(struct libwebsocket_context *context);
1245 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1246 LWS_EXTERN unsigned long long
1247 time_in_microseconds(void);
1248 LWS_EXTERN const char *
1249 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);