2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010 - 2016 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"
23 #include "lws_config_private.h"
26 #if defined(LWS_WITH_CGI) && defined(LWS_HAVE_VFORK)
30 #ifdef LWS_HAVE_SYS_TYPES_H
31 #include <sys/types.h>
46 #ifdef LWS_HAVE_SYS_STAT_H
50 #if defined(WIN32) || defined(_WIN32)
55 #define _WIN32_WINNT WINVER
57 #define LWS_NO_DAEMONIZE
58 #define LWS_ERRNO WSAGetLastError()
59 #define LWS_EAGAIN WSAEWOULDBLOCK
60 #define LWS_EALREADY WSAEALREADY
61 #define LWS_EINPROGRESS WSAEINPROGRESS
62 #define LWS_EINTR WSAEINTR
63 #define LWS_EISCONN WSAEISCONN
64 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
65 #define LWS_POLLHUP (FD_CLOSE)
66 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
67 #define LWS_POLLOUT (FD_WRITE)
68 #define MSG_NOSIGNAL 0
69 #define SHUT_RDWR SD_BOTH
70 #define SOL_TCP IPPROTO_TCP
71 #define SHUT_WR SD_SEND
73 #define compatible_close(fd) closesocket(fd)
74 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
75 #define lws_socket_is_valid(x) (!!x)
76 #define LWS_SOCK_INVALID 0
81 #ifdef LWS_HAVE_IN6ADDR_H
87 #define __func__ __FUNCTION__
91 #define vsnprintf _vsnprintf
93 #ifdef LWS_HAVE__VSNPRINTF
94 #define vsnprintf _vsnprintf
98 #ifdef LWS_HAVE__SNPRINTF
99 #define snprintf _snprintf
102 #else /* not windows --> */
107 #include <sys/types.h>
108 #ifndef MBED_OPERATORS
114 #include <sys/socket.h>
115 #ifdef LWS_BUILTIN_GETIFADDRS
116 #include <getifaddrs.h>
120 #if defined (__ANDROID__)
123 #include <sys/syslog.h>
126 #include <sys/socket.h>
128 #include <netinet/in.h>
129 #include <netinet/tcp.h>
130 #include <arpa/inet.h>
138 #include <sys/mman.h>
143 #ifdef LWS_HAVE_SYS_PRCTL_H
144 #include <sys/prctl.h>
148 #include <sys/time.h>
150 #define LWS_ERRNO errno
151 #define LWS_EAGAIN EAGAIN
152 #define LWS_EALREADY EALREADY
153 #define LWS_EINPROGRESS EINPROGRESS
154 #define LWS_EINTR EINTR
155 #define LWS_EISCONN EISCONN
156 #define LWS_EWOULDBLOCK EWOULDBLOCK
157 #define LWS_POLLHUP (POLLHUP|POLLERR)
158 #define LWS_POLLIN (POLLIN)
159 #define LWS_POLLOUT (POLLOUT)
160 #define compatible_close(fd) close(fd)
161 #define lws_set_blocking_send(wsi)
163 #ifdef MBED_OPERATORS
164 #define lws_socket_is_valid(x) ((x) != NULL)
165 #define LWS_SOCK_INVALID (NULL)
167 #define lws_socket_is_valid(x) (x >= 0)
168 #define LWS_SOCK_INVALID (-1)
172 #ifndef LWS_HAVE_BZERO
174 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
178 #ifndef LWS_HAVE_STRERROR
179 #define strerror(x) ""
182 #ifdef LWS_OPENSSL_SUPPORT
184 #ifdef USE_OLD_CYASSL
185 #include <cyassl/openssl/ssl.h>
186 #include <cyassl/error-ssl.h>
188 #include <wolfssl/openssl/ssl.h>
189 #include <wolfssl/error-ssl.h>
190 #endif /* not USE_OLD_CYASSL */
192 #include <openssl/ssl.h>
193 #include <openssl/evp.h>
194 #include <openssl/err.h>
195 #include <openssl/md5.h>
196 #include <openssl/sha.h>
197 #endif /* not USE_WOLFSSL */
200 #include "libwebsockets.h"
202 #if defined(MBED_OPERATORS)
203 #undef compatible_close
204 #define compatible_close(fd) mbed3_delete_tcp_stream_socket(fd)
206 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
208 #ifndef LITTLE_ENDIAN
209 #define LITTLE_ENDIAN 1234
212 #define BYTE_ORDER LITTLE_ENDIAN
216 #if defined(WIN32) || defined(_WIN32)
219 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
221 #ifndef LITTLE_ENDIAN
222 #define LITTLE_ENDIAN 1234
225 #define BYTE_ORDER LITTLE_ENDIAN
228 typedef unsigned __int64 u_int64_t;
234 #define __P(protos) protos
236 #define __P(protos) ()
242 #include <sys/stat.h>
243 #include <sys/cdefs.h>
244 #include <sys/time.h>
246 #if defined(__APPLE__)
247 #include <machine/endian.h>
248 #elif defined(__FreeBSD__)
249 #include <sys/endian.h>
250 #elif defined(__linux__)
260 #define container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
264 #include <gulliver.h>
265 #if defined(__LITTLEENDIAN__)
266 #define BYTE_ORDER __LITTLEENDIAN__
267 #define LITTLE_ENDIAN __LITTLEENDIAN__
268 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
270 #if defined(__BIGENDIAN__)
271 #define BYTE_ORDER __BIGENDIAN__
272 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
273 #define BIG_ENDIAN __BIGENDIAN__
277 #if !defined(BYTE_ORDER)
278 # define BYTE_ORDER __BYTE_ORDER
280 #if !defined(LITTLE_ENDIAN)
281 # define LITTLE_ENDIAN __LITTLE_ENDIAN
283 #if !defined(BIG_ENDIAN)
284 # define BIG_ENDIAN __BIG_ENDIAN
290 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
291 * but happily have something equivalent in the SO_NOSIGPIPE flag.
294 #define MSG_NOSIGNAL SO_NOSIGPIPE
298 #ifndef FD_HASHTABLE_MODULUS
299 #define FD_HASHTABLE_MODULUS 32
303 #ifndef LWS_DEF_HEADER_LEN
304 #define LWS_DEF_HEADER_LEN 1024
306 #ifndef LWS_DEF_HEADER_POOL
307 #define LWS_DEF_HEADER_POOL 16
309 #ifndef LWS_MAX_PROTOCOLS
310 #define LWS_MAX_PROTOCOLS 5
312 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
313 #define LWS_MAX_EXTENSIONS_ACTIVE 2
315 #ifndef LWS_MAX_EXT_OFFERS
316 #define LWS_MAX_EXT_OFFERS 8
318 #ifndef SPEC_LATEST_SUPPORTED
319 #define SPEC_LATEST_SUPPORTED 13
321 #ifndef AWAITING_TIMEOUT
322 #define AWAITING_TIMEOUT 20
324 #ifndef CIPHERS_LIST_STRING
325 #define CIPHERS_LIST_STRING "DEFAULT"
327 #ifndef LWS_SOMAXCONN
328 #define LWS_SOMAXCONN SOMAXCONN
331 #define MAX_WEBSOCKET_04_KEY_LEN 128
332 #define LWS_MAX_SOCKET_IO_BUF 4096
334 #ifndef SYSTEM_RANDOM_FILEPATH
335 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
338 enum lws_websocket_opcodes_07 {
339 LWSWSOPC_CONTINUATION = 0,
340 LWSWSOPC_TEXT_FRAME = 1,
341 LWSWSOPC_BINARY_FRAME = 2,
343 LWSWSOPC_NOSPEC__MUX = 7,
345 /* control extensions 8+ */
353 enum lws_connection_states {
355 LWSS_HTTP_ISSUING_FILE,
360 LWSS_CLIENT_HTTP_ESTABLISHED,
361 LWSS_CLIENT_UNCONNECTED,
362 LWSS_RETURNED_CLOSE_ALREADY,
363 LWSS_AWAITING_CLOSE_ACK,
364 LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
367 LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
368 LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
369 LWSS_HTTP2_ESTABLISHED,
379 enum http_connection_type {
380 HTTP_CONNECTION_CLOSE,
381 HTTP_CONNECTION_KEEP_ALIVE
384 enum lws_pending_protocol_send {
386 LWS_PPS_HTTP2_MY_SETTINGS,
387 LWS_PPS_HTTP2_ACK_SETTINGS,
391 enum lws_rx_parse_state {
398 LWS_RXPS_04_FRAME_HDR_1,
399 LWS_RXPS_04_FRAME_HDR_LEN,
400 LWS_RXPS_04_FRAME_HDR_LEN16_2,
401 LWS_RXPS_04_FRAME_HDR_LEN16_1,
402 LWS_RXPS_04_FRAME_HDR_LEN64_8,
403 LWS_RXPS_04_FRAME_HDR_LEN64_7,
404 LWS_RXPS_04_FRAME_HDR_LEN64_6,
405 LWS_RXPS_04_FRAME_HDR_LEN64_5,
406 LWS_RXPS_04_FRAME_HDR_LEN64_4,
407 LWS_RXPS_04_FRAME_HDR_LEN64_3,
408 LWS_RXPS_04_FRAME_HDR_LEN64_2,
409 LWS_RXPS_04_FRAME_HDR_LEN64_1,
411 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
412 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
413 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
414 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
416 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
420 enum connection_mode {
422 LWSCM_HTTP_CLIENT, /* we are client to someone else's server */
423 LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
424 LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
425 LWSCM_PRE_WS_SERVING_ACCEPT,
432 /* transient, ssl delay hiding */
433 LWSCM_SSL_ACK_PENDING,
436 /* transient modes */
437 LWSCM_WSCL_WAITING_CONNECT,
438 LWSCM_WSCL_WAITING_PROXY_REPLY,
439 LWSCM_WSCL_ISSUE_HANDSHAKE,
440 LWSCM_WSCL_ISSUE_HANDSHAKE2,
441 LWSCM_WSCL_WAITING_SSL,
442 LWSCM_WSCL_WAITING_SERVER_REPLY,
443 LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
444 LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
446 /* special internal types */
447 LWSCM_SERVER_LISTENER,
448 LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
452 LWS_RXFLOW_ALLOW = (1 << 0),
453 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
456 /* this is not usable directly by user code any more, lws_close_reason() */
457 #define LWS_WRITE_CLOSE 4
459 struct lws_protocols;
462 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
464 struct lws_io_watcher {
469 uv_poll_t uv_watcher;
471 struct lws_context *context;
474 struct lws_signal_watcher {
476 ev_signal ev_watcher;
479 uv_signal_t uv_watcher;
481 struct lws_context *context;
486 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
487 struct lws_fd_hashtable {
494 * This is totally opaque to code using the library. It's exported as a
495 * forward-reference pointer-only declaration; the user can use the pointer with
496 * other APIs to get information out of it.
499 struct lws_fragments {
500 unsigned short offset;
502 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
506 * these are assigned from a pool held in the context.
507 * Both client and server mode uses them for http header analysis
510 struct allocated_headers {
511 struct lws *wsi; /* owner */
512 char *data; /* prepared by context init to point to dedicated storage */
514 * the randomly ordered fragments, indexed by frag_index and
515 * lws_fragments->nfrag for continuation.
517 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
520 * for each recognized token, frag_index says which frag[] his data
521 * starts in (0 means the token did not appear)
522 * the actual header data gets dumped as it comes in, into data[]
524 unsigned char frag_index[WSI_TOKEN_COUNT];
525 unsigned char rx[2048];
529 #ifndef LWS_NO_CLIENT
530 char initial_handshake_hash_base64[30];
534 unsigned char in_use;
539 * so we can have n connections being serviced simultaneously,
540 * these things need to be isolated per-thread.
543 struct lws_context_per_thread {
545 pthread_mutex_t lock;
547 struct lws_pollfd *fds;
548 struct lws *rx_draining_ext_list;
549 struct lws *tx_draining_ext_list;
550 struct lws *timeout_list;
551 struct lws_context *context;
553 struct lws_cgi *cgi_list;
555 void *http_header_data;
556 struct allocated_headers *ah_pool;
557 struct lws *ah_wait_list;
558 int ah_wait_list_length;
559 #ifdef LWS_OPENSSL_SUPPORT
560 struct lws *pending_read_list; /* linked list */
562 #ifndef LWS_NO_SERVER
563 struct lws *wsi_listening;
565 #if defined(LWS_USE_LIBEV)
566 struct ev_loop *io_loop_ev;
568 #if defined(LWS_USE_LIBUV)
569 uv_loop_t *io_loop_uv;
570 uv_signal_t signals[8];
571 uv_timer_t uv_timeout_watcher;
573 #if defined(LWS_USE_LIBEV)
574 struct lws_io_watcher w_accept;
576 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
577 struct lws_signal_watcher w_sigint;
578 unsigned char ev_loop_foreign:1;
580 lws_sockfd_type lserv_fd;
582 unsigned long count_conns;
584 * usable by anything in the service code, but only if the scope
585 * does not last longer than the service action (since next service
586 * of any socket can likewise use it and overwrite)
588 unsigned char *serv_buf;
592 int dummy_pipe_fds[2];
594 unsigned int fds_count;
596 short ah_count_in_use;
601 * the rest is managed per-context, that includes
603 * - processwide single fd -> wsi lookup
604 * - contextwide headers pool
605 * - contextwide ssl context
606 * - contextwide proxy
610 time_t last_timeout_check_s;
611 struct lws_plat_file_ops fops;
612 struct lws_context_per_thread pt[LWS_MAX_SMP];
614 /* different implementation between unix and windows */
615 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
617 struct lws **lws_lookup; /* fd to wsi */
620 const struct lws_token_limits *token_limits;
623 const struct lws_protocols *protocols;
625 #ifdef LWS_OPENSSL_SUPPORT
627 SSL_CTX *ssl_client_ctx;
629 #ifndef LWS_NO_EXTENSIONS
630 const struct lws_extension *extensions;
632 #if defined(LWS_USE_LIBEV)
633 lws_ev_signal_cb_t * lws_ev_sigint_cb;
635 #if defined(LWS_USE_LIBUV)
636 lws_uv_signal_cb_t * lws_uv_sigint_cb;
638 char http_proxy_address[128];
639 char proxy_basic_auth_token[128];
640 char canonical_hostname[128];
642 unsigned long worst_latency;
643 char worst_latency_info[256];
648 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
651 int started_with_parent;
655 int count_wsi_allocated;
656 unsigned int http_proxy_port;
657 unsigned int options;
658 unsigned int fd_limit_per_thread;
659 unsigned int timeout_secs;
662 * set to the Thread ID that's doing the service loop just before entry
663 * to poll indicates service thread likely idling in poll()
664 * volatile because other threads may check it as part of processing
665 * for pollfd event change.
667 volatile int service_tid;
668 int service_tid_detected;
675 #ifdef LWS_OPENSSL_SUPPORT
677 int allow_non_ssl_on_ssl_port;
678 unsigned int user_supplied_ssl_ctx:1;
679 #define lws_ssl_anybody_has_buffered_read(w) \
680 (w->context->use_ssl && \
681 w->context->pt[(int)w->tsi].pending_read_list)
682 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
684 c->pt[(int)t].pending_read_list)
686 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
687 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
690 short max_http_header_data;
691 short max_http_header_pool;
694 unsigned int being_destroyed:1;
695 unsigned int requested_kill:1;
699 lws_close_free_wsi_final(struct lws *wsi);
701 lws_libuv_closehandle(struct lws *wsi);
704 LWS_EV_READ = (1 << 0),
705 LWS_EV_WRITE = (1 << 1),
706 LWS_EV_START = (1 << 2),
707 LWS_EV_STOP = (1 << 3),
709 LWS_EV_PREPARE_DELETION = (1 << 31),
712 #if defined(LWS_USE_LIBEV)
714 lws_libev_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
716 lws_libev_io(struct lws *wsi, int flags);
718 lws_libev_init_fd_table(struct lws_context *context);
720 lws_libev_destroyloop(struct lws_context *context, int tsi);
722 lws_libev_run(const struct lws_context *context, int tsi);
723 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
724 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
726 #define lws_libev_accept(_a, _b) ((void) 0)
727 #define lws_libev_io(_a, _b) ((void) 0)
728 #define lws_libev_init_fd_table(_a) (0)
729 #define lws_libev_run(_a, _b) ((void) 0)
730 #define lws_libev_destroyloop(_a, _b) ((void) 0)
731 #define LWS_LIBEV_ENABLED(context) (0)
733 #define lws_feature_status_libev(_a) \
734 lwsl_notice("libev support not compiled in\n")
736 #define lws_feature_status_libev(_a)
740 #if defined(LWS_USE_LIBUV)
742 lws_libuv_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
744 lws_libuv_io(struct lws *wsi, int flags);
746 lws_libuv_init_fd_table(struct lws_context *context);
748 lws_libuv_run(const struct lws_context *context, int tsi);
750 lws_libuv_destroyloop(struct lws_context *context, int tsi);
751 #define LWS_LIBUV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBUV)
752 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
754 #define lws_libuv_accept(_a, _b) ((void) 0)
755 #define lws_libuv_io(_a, _b) ((void) 0)
756 #define lws_libuv_init_fd_table(_a) (0)
757 #define lws_libuv_run(_a, _b) ((void) 0)
758 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
759 #define LWS_LIBUV_ENABLED(context) (0)
761 #define lws_feature_status_libuv(_a) \
762 lwsl_notice("libuv support not compiled in\n")
764 #define lws_feature_status_libuv(_a)
770 #define LWS_IPV6_ENABLED(context) \
771 (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
773 #define LWS_IPV6_ENABLED(context) (0)
776 enum uri_path_states {
779 URIPS_SEEN_SLASH_DOT,
780 URIPS_SEEN_SLASH_DOT_DOT,
783 enum uri_esc_states {
786 URIES_SEEN_PERCENT_H1,
789 /* notice that these union members:
795 * all have a pointer to allocated_headers struct as their first member.
797 * It means for allocated_headers access, the three union paths can all be
798 * used interchangeably to access the same data
802 #ifndef LWS_NO_CLIENT
803 struct client_info_stash {
813 struct _lws_header_related {
814 /* MUST be first in struct */
815 struct allocated_headers *ah;
816 struct lws *ah_wait_list;
817 unsigned char *preamble_rx;
818 #ifndef LWS_NO_CLIENT
819 struct client_info_stash *stash;
821 unsigned int preamble_rx_len;
822 enum uri_path_states ups;
823 enum uri_esc_states ues;
825 unsigned short current_token_limit;
826 #ifndef LWS_NO_CLIENT
827 unsigned short c_port;
830 char post_literal_equal;
831 unsigned char parser_state; /* enum lws_token_indexes */
835 struct _lws_http_mode_related {
836 /* MUST be first in struct */
837 struct allocated_headers *ah; /* mirroring _lws_header_related */
838 struct lws *ah_wait_list;
839 unsigned char *preamble_rx;
840 #ifndef LWS_NO_CLIENT
841 struct client_info_stash *stash;
843 unsigned int preamble_rx_len;
844 struct lws *new_wsi_list;
845 unsigned long filepos;
846 unsigned long filelen;
849 enum http_version request_version;
850 enum http_connection_type connection_type;
851 unsigned int content_length;
852 unsigned int content_remain;
857 enum lws_http2_settings {
858 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
859 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
860 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
861 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
862 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
863 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
865 LWS_HTTP2_SETTINGS__COUNT /* always last */
868 enum lws_http2_wellknown_frame_types {
869 LWS_HTTP2_FRAME_TYPE_DATA,
870 LWS_HTTP2_FRAME_TYPE_HEADERS,
871 LWS_HTTP2_FRAME_TYPE_PRIORITY,
872 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
873 LWS_HTTP2_FRAME_TYPE_SETTINGS,
874 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
875 LWS_HTTP2_FRAME_TYPE_PING,
876 LWS_HTTP2_FRAME_TYPE_GOAWAY,
877 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
878 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
880 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
883 enum lws_http2_flags {
884 LWS_HTTP2_FLAG_END_STREAM = 1,
885 LWS_HTTP2_FLAG_END_HEADERS = 4,
886 LWS_HTTP2_FLAG_PADDED = 8,
887 LWS_HTTP2_FLAG_PRIORITY = 0x20,
889 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
892 #define LWS_HTTP2_STREAM_ID_MASTER 0
893 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
894 #define LWS_HTTP2_SETTINGS_LENGTH 6
896 struct http2_settings {
897 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
900 enum http2_hpack_state {
902 /* optional before first header block */
904 HKPS_OPT_E_DEPENDENCY,
917 /* optional after last header block */
918 HKPS_OPT_DISCARD_PADDING,
921 enum http2_hpack_type {
923 HPKT_INDEXED_HDR_6_VALUE_INCR,
924 HPKT_LITERAL_HDR_VALUE_INCR,
925 HPKT_INDEXED_HDR_4_VALUE,
926 HPKT_LITERAL_HDR_VALUE,
930 struct hpack_dt_entry {
931 int token; /* additions that don't map to a token are ignored */
936 struct hpack_dynamic_table {
937 struct hpack_dt_entry *entries;
945 struct _lws_http2_related {
947 * having this first lets us also re-use all HTTP union code
948 * and in turn, http_mode_related has allocated headers in right
949 * place so we can use the header apis on the wsi directly still
951 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
953 struct http2_settings my_settings;
954 struct http2_settings peer_settings;
956 struct lws *parent_wsi;
957 struct lws *next_child_wsi;
959 struct hpack_dynamic_table *hpack_dyn_table;
960 struct lws *stream_wsi;
961 unsigned char ping_payload[8];
962 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
966 unsigned int stream_id;
967 enum http2_hpack_state hpack;
968 enum http2_hpack_type hpack_type;
969 unsigned int header_index;
970 unsigned int hpack_len;
971 unsigned int hpack_e_dep;
973 unsigned int my_stream_id;
974 unsigned int child_count;
977 unsigned int END_STREAM:1;
978 unsigned int END_HEADERS:1;
979 unsigned int send_END_STREAM:1;
980 unsigned int GOING_AWAY;
981 unsigned int requested_POLLOUT:1;
982 unsigned int waiting_tx_credit:1;
984 unsigned int value:1;
986 unsigned short round_robin_POLLOUT;
987 unsigned short count_POLLOUT_children;
988 unsigned short hpack_pos;
992 unsigned char frame_state;
993 unsigned char padding;
994 unsigned char hpack_m;
995 unsigned char initialized;
998 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1002 struct _lws_websocket_related {
1003 /* cheapest way to deal with ah overlap with ws union transition */
1004 struct _lws_header_related hdr;
1006 unsigned int rx_ubuf_alloc;
1007 struct lws *rx_draining_ext_list;
1008 struct lws *tx_draining_ext_list;
1009 size_t rx_packet_length;
1010 unsigned int rx_ubuf_head;
1011 unsigned char mask[4];
1012 /* Also used for close content... control opcode == < 128 */
1013 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1015 unsigned char ping_payload_len;
1016 unsigned char mask_idx;
1017 unsigned char opcode;
1019 unsigned char rsv_first_msg;
1020 /* zero if no info, or length including 2-byte close code */
1021 unsigned char close_in_ping_buffer_len;
1023 unsigned char stashed_write_type;
1024 unsigned char tx_draining_stashed_wp;
1026 unsigned int final:1;
1027 unsigned int frame_is_binary:1;
1028 unsigned int all_zero_nonce:1;
1029 unsigned int this_frame_masked:1;
1030 unsigned int inside_frame:1; /* next write will be more of frame */
1031 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1032 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1033 unsigned int ping_pending_flag:1;
1034 unsigned int continuation_possible:1;
1035 unsigned int owed_a_fin:1;
1036 unsigned int check_utf8:1;
1037 unsigned int defeat_check_utf8:1;
1038 unsigned int pmce_compressed_message:1;
1039 unsigned int stashed_write_pending:1;
1040 unsigned int rx_draining_ext:1;
1041 unsigned int tx_draining_ext:1;
1046 /* wsi who is master of the cgi points to an lws_cgi */
1049 struct lws_cgi *cgi_list;
1050 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1051 struct lws *wsi; /* owner */
1055 unsigned int being_closed:1;
1062 /* members with mutually exclusive lifetimes are unionized */
1065 struct _lws_http_mode_related http;
1066 #ifdef LWS_USE_HTTP2
1067 struct _lws_http2_related http2;
1069 struct _lws_header_related hdr;
1070 struct _lws_websocket_related ws;
1073 /* lifetime members */
1075 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1076 struct lws_io_watcher w_read;
1078 #if defined(LWS_USE_LIBEV)
1079 struct lws_io_watcher w_write;
1081 time_t pending_timeout_limit;
1085 struct lws_context *context;
1086 struct lws *parent; /* points to parent, if any */
1087 struct lws *child_list; /* points to first child */
1088 struct lws *sibling_list; /* subsequent children at same level */
1090 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1092 const struct lws_protocols *protocol;
1093 struct lws *timeout_list;
1094 struct lws **timeout_list_prev;
1096 /* rxflow handling */
1097 unsigned char *rxflow_buffer;
1098 /* truncated send handling */
1099 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1100 #ifndef LWS_NO_EXTENSIONS
1101 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1102 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1104 #ifdef LWS_OPENSSL_SUPPORT
1107 struct lws *pending_read_list_prev, *pending_read_list_next;
1110 unsigned long action_start;
1111 unsigned long latency_start;
1114 lws_sockfd_type sock;
1117 int position_in_fds_table;
1120 unsigned int trunc_alloc_len; /* size of malloc */
1121 unsigned int trunc_offset; /* where we are in terms of spilling */
1122 unsigned int trunc_len; /* how much is buffered */
1124 unsigned int hdr_parsing_completed:1;
1125 unsigned int user_space_externally_allocated:1;
1126 unsigned int socket_is_permanently_unusable:1;
1127 unsigned int rxflow_change_to:2;
1128 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1129 #ifndef LWS_NO_CLIENT
1130 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1132 #ifndef LWS_NO_EXTENSIONS
1133 unsigned int extension_data_pending:1;
1135 #ifdef LWS_OPENSSL_SUPPORT
1136 unsigned int use_ssl:2;
1137 unsigned int upgraded:1;
1140 unsigned int sock_send_blocking:1;
1144 #ifndef LWS_NO_EXTENSIONS
1145 unsigned char count_act_ext;
1147 unsigned char ietf_spec_revision;
1148 char mode; /* enum connection_mode */
1149 char state; /* enum lws_connection_states */
1150 char state_pre_close;
1151 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1152 char rx_frame_type; /* enum lws_write_protocol */
1153 char pending_timeout; /* enum pending_timeout */
1154 char pps; /* enum lws_pending_protocol_send */
1155 char tsi; /* thread service index we belong to */
1157 char cgi_channel; /* which of stdin/out/err */
1161 LWS_EXTERN int log_level;
1164 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1167 remove_wsi_socket_from_fds(struct lws *wsi);
1169 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1173 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1174 int ret, int completion) {
1176 (void)context; (void)wsi; (void)action; (void)ret;
1181 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1182 do { (void)context; (void)wsi; } while (0);
1185 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1187 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1188 int ret, int completion);
1192 lws_set_protocol_write_pending(struct lws *wsi,
1193 enum lws_pending_protocol_send pend);
1194 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1195 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1197 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1198 lws_parse(struct lws *wsi, unsigned char c);
1200 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1201 lws_http_action(struct lws *wsi);
1204 lws_b64_selftest(void);
1207 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
1210 lws_service_flag_pending(struct lws_context *context, int tsi);
1212 #if defined(_WIN32) || defined(MBED_OPERATORS)
1213 LWS_EXTERN struct lws *
1214 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1217 insert_wsi(struct lws_context *context, struct lws *wsi);
1220 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1222 #define wsi_from_fd(A,B) A->lws_lookup[B]
1223 #define insert_wsi(A,B) assert(A->lws_lookup[B->sock] == 0); A->lws_lookup[B->sock]=B
1224 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1227 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1228 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1230 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1231 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1234 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1235 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1237 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1238 lws_client_connect_2(struct lws *wsi);
1240 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1241 lws_client_reset(struct lws *wsi, int ssl, const char *address, int port,
1242 const char *path, const char *host);
1244 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1245 lws_create_new_server_wsi(struct lws_context *context);
1247 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1248 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1251 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1253 LWS_EXTERN struct lws *
1254 lws_client_connect_via_info2(struct lws *wsi);
1260 #ifndef LWS_NO_EXTENSIONS
1262 lws_context_init_extensions(struct lws_context_creation_info *info,
1263 struct lws_context *context);
1265 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1266 void *v, size_t len);
1269 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1271 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1272 void *arg, int len);
1275 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1276 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1277 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1278 #define lws_issue_raw_ext_access lws_issue_raw
1279 #define lws_context_init_extensions(_a, _b)
1282 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1283 lws_client_interpret_server_handshake(struct lws *wsi);
1285 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1286 lws_rx_sm(struct lws *wsi, unsigned char c);
1288 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1289 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1292 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1294 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1295 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1296 enum lws_callback_reasons reason, void *user,
1297 void *in, size_t len);
1298 #ifdef LWS_USE_HTTP2
1299 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1300 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1302 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1303 unsigned char *buf, int len);
1304 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1306 lws_http2_parser(struct lws *wsi, unsigned char c);
1307 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1309 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1310 unsigned int sid, unsigned int len,
1311 unsigned char *buf);
1312 LWS_EXTERN struct lws *
1313 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1314 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1317 lws_add_http2_header_by_name(struct lws *wsi,
1318 const unsigned char *name,
1319 const unsigned char *value, int length,
1320 unsigned char **p, unsigned char *end);
1322 lws_add_http2_header_by_token(struct lws *wsi,
1323 enum lws_token_indexes token,
1324 const unsigned char *value, int length,
1325 unsigned char **p, unsigned char *end);
1327 lws_add_http2_header_status(struct lws *wsi,
1328 unsigned int code, unsigned char **p,
1329 unsigned char *end);
1331 void lws_http2_configure_if_upgraded(struct lws *wsi);
1333 #define lws_http2_configure_if_upgraded(x)
1337 lws_plat_set_socket_options(struct lws_context *context, lws_sockfd_type fd);
1339 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1340 lws_header_table_attach(struct lws *wsi, int autoservice);
1343 lws_header_table_detach(struct lws *wsi, int autoservice);
1346 lws_header_table_reset(struct lws *wsi, int autoservice);
1348 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1349 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1351 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1352 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1355 lws_ensure_user_space(struct lws *wsi);
1358 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1360 #ifndef LWS_NO_SERVER
1361 int lws_context_init_server(struct lws_context_creation_info *info,
1362 struct lws_context *context);
1364 handshake_0405(struct lws_context *context, struct lws *wsi);
1365 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1366 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1368 lws_server_get_canonical_hostname(struct lws_context *context,
1369 struct lws_context_creation_info *info);
1371 #define lws_context_init_server(_a, _b) (0)
1372 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1373 #define lws_server_get_canonical_hostname(_a, _b)
1376 #ifndef LWS_NO_DAEMONIZE
1377 LWS_EXTERN int get_daemonize_pid();
1379 #define get_daemonize_pid() (0)
1382 #if !defined(MBED_OPERATORS)
1383 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1384 interface_to_sa(struct lws_context *context, const char *ifname,
1385 struct sockaddr_in *addr, size_t addrlen);
1387 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1389 enum lws_ssl_capable_status {
1390 LWS_SSL_CAPABLE_ERROR = -1,
1391 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1394 #ifndef LWS_OPENSSL_SUPPORT
1395 #define LWS_SSL_ENABLED(context) (0)
1396 #define lws_context_init_server_ssl(_a, _b) (0)
1397 #define lws_ssl_destroy(_a)
1398 #define lws_context_init_http2_ssl(_a)
1399 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1400 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1401 #define lws_ssl_pending lws_ssl_pending_no_ssl
1402 #define lws_server_socket_service_ssl(_b, _c) (0)
1403 #define lws_ssl_close(_a) (0)
1404 #define lws_ssl_context_destroy(_a)
1405 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1407 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1408 LWS_EXTERN int openssl_websocket_private_data_index;
1409 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1410 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1411 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1412 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1413 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1414 lws_ssl_pending(struct lws *wsi);
1415 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1416 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1418 lws_ssl_close(struct lws *wsi);
1420 lws_ssl_context_destroy(struct lws_context *context);
1422 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1423 #ifndef LWS_NO_SERVER
1425 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1426 struct lws_context *context);
1428 #define lws_context_init_server_ssl(_a, _b) (0)
1431 lws_ssl_destroy(struct lws_context *context);
1435 #ifdef LWS_USE_HTTP2
1437 lws_context_init_http2_ssl(struct lws_context *context);
1439 #define lws_context_init_http2_ssl(_a)
1444 static LWS_INLINE void
1445 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1447 pthread_mutex_init(&pt->lock, NULL);
1449 static LWS_INLINE void
1450 lws_pt_lock(struct lws_context_per_thread *pt)
1452 pthread_mutex_lock(&pt->lock);
1455 static LWS_INLINE void
1456 lws_pt_unlock(struct lws_context_per_thread *pt)
1458 pthread_mutex_unlock(&pt->lock);
1461 #define lws_pt_mutex_init(_a) (void)(_a)
1462 #define lws_pt_lock(_a) (void)(_a)
1463 #define lws_pt_unlock(_a) (void)(_a)
1466 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1467 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1469 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1470 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1472 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1473 lws_ssl_pending_no_ssl(struct lws *wsi);
1475 #ifndef LWS_NO_CLIENT
1476 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1478 struct lws_pollfd *pollfd);
1479 #ifdef LWS_OPENSSL_SUPPORT
1481 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1482 struct lws_context *context);
1484 #define lws_context_init_client_ssl(_a, _b) (0)
1486 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1487 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1489 lws_decode_ssl_error(void);
1491 #define lws_context_init_client_ssl(_a, _b) (0)
1492 #define lws_handshake_client(_a, _b, _c) (0)
1496 _lws_rx_flow_control(struct lws *wsi);
1499 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1501 #ifndef LWS_NO_SERVER
1503 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1504 struct lws_pollfd *pollfd);
1506 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1508 _lws_server_listen_accept_flow_control(struct lws *twsi, int on);
1510 #define lws_server_socket_service(_a, _b, _c) (0)
1511 #define lws_handshake_server(_a, _b, _c) (0)
1512 #define _lws_server_listen_accept_flow_control(a, b) (0)
1516 lws_get_addresses(struct lws_context *context, void *ads, char *name,
1517 int name_len, char *rip, int rip_len);
1520 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1526 lws_realloc(void *ptr, size_t size);
1528 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1529 lws_zalloc(size_t size);
1531 #define lws_malloc(S) lws_realloc(NULL, S)
1532 #define lws_free(P) lws_realloc(P, 0)
1533 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
1537 lws_plat_delete_socket_from_fds(struct lws_context *context,
1538 struct lws *wsi, int m);
1540 lws_plat_insert_socket_into_fds(struct lws_context *context,
1543 lws_plat_service_periodic(struct lws_context *context);
1546 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1547 struct lws_pollfd *pfd);
1549 lws_plat_context_early_init(void);
1551 lws_plat_context_early_destroy(struct lws_context *context);
1553 lws_plat_context_late_destroy(struct lws_context *context);
1555 lws_poll_listen_fd(struct lws_pollfd *fd);
1557 lws_plat_service(struct lws_context *context, int timeout_ms);
1558 LWS_EXTERN LWS_VISIBLE int
1559 lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1561 lws_plat_init(struct lws_context *context,
1562 struct lws_context_creation_info *info);
1564 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1565 LWS_EXTERN unsigned long long
1566 time_in_microseconds(void);
1567 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1568 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
1570 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1571 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);