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>
42 #if defined(LWS_WITH_ESP32)
43 #define MSG_NOSIGNAL 0
47 #if defined(LWS_WITH_ESP8266)
48 #include <user_interface.h>
51 /* rom-provided stdc functions for free, ensure use these instead of libc ones */
53 int ets_vsprintf(char *str, const char *format, va_list argptr);
54 int ets_vsnprintf(char *buffer, size_t sizeOfBuffer, const char *format, va_list argptr);
55 int ets_snprintf(char *str, size_t size, const char *format, ...);
56 int ets_sprintf(char *str, const char *format, ...);
57 int os_printf_plus(const char *format, ...);
61 void *pvPortMalloc(size_t s, const char *f, int line);
62 #define malloc(s) pvPortMalloc(s, "", 0)
63 void *pvPortRealloc(void *p, size_t s, const char *f, int line);
64 #define realloc(p, s) pvPortRealloc(p, s, "", 0)
65 void vPortFree(void *p, const char *f, int line);
66 #define free(p) vPortFree(p, "", 0)
68 void *ets_memcpy(void *dest, const void *src, size_t n);
69 #define memcpy ets_memcpy
70 void *ets_memset(void *dest, int v, size_t n);
71 #define memset ets_memset
72 char *ets_strcpy(char *dest, const char *src);
73 #define strcpy ets_strcpy
74 char *ets_strncpy(char *dest, const char *src, size_t n);
75 #define strncpy ets_strncpy
76 char *ets_strstr(const char *haystack, const char *needle);
77 #define strstr ets_strstr
78 int ets_strcmp(const char *s1, const char *s2);
79 int ets_strncmp(const char *s1, const char *s2, size_t n);
80 #define strcmp ets_strcmp
81 #define strncmp ets_strncmp
82 size_t ets_strlen(const char *s);
83 #define strlen ets_strlen
84 void *ets_memmove(void *dest, const void *src, size_t n);
85 #define memmove ets_memmove
86 char *ets_strchr(const char *s, int c);
87 #define strchr_ets_strchr
99 #ifdef LWS_HAVE_SYS_STAT_H
100 #include <sys/stat.h>
103 #if defined(WIN32) || defined(_WIN32)
104 #if (WINVER < 0x0501)
107 #define WINVER 0x0501
108 #define _WIN32_WINNT WINVER
110 #define LWS_NO_DAEMONIZE
111 #define LWS_ERRNO WSAGetLastError()
112 #define LWS_EAGAIN WSAEWOULDBLOCK
113 #define LWS_EALREADY WSAEALREADY
114 #define LWS_EINPROGRESS WSAEINPROGRESS
115 #define LWS_EINTR WSAEINTR
116 #define LWS_EISCONN WSAEISCONN
117 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
118 #define MSG_NOSIGNAL 0
119 #define SHUT_RDWR SD_BOTH
120 #define SOL_TCP IPPROTO_TCP
121 #define SHUT_WR SD_SEND
123 #define compatible_close(fd) closesocket(fd)
124 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
125 #define lws_socket_is_valid(x) (!!x)
126 #define LWS_SOCK_INVALID 0
127 #include <winsock2.h>
128 #include <ws2tcpip.h>
131 #ifdef LWS_HAVE_IN6ADDR_H
138 #define __func__ __FUNCTION__
141 #ifdef LWS_HAVE__VSNPRINTF
142 #define vsnprintf _vsnprintf
145 /* we don't have an implementation for this on windows... */
146 int kill(int pid, int sig);
152 #else /* not windows --> */
157 #include <sys/types.h>
164 #ifdef LWS_WITH_ESP8266
166 #define vsnprintf ets_vsnprintf
167 #define snprintf ets_snprintf
168 #define sprintf ets_sprintf
170 int kill(int pid, int sig);
173 #include <sys/socket.h>
175 #ifdef LWS_WITH_HTTP_PROXY
176 #include <hubbub/hubbub.h>
177 #include <hubbub/parser.h>
179 #if defined(LWS_BUILTIN_GETIFADDRS)
180 #include <getifaddrs.h>
182 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
186 #if defined (__ANDROID__)
188 #include <sys/resource.h>
189 #elif defined (__sun)
192 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
193 #include <sys/syslog.h>
197 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
198 #include <sys/mman.h>
200 #include <netinet/in.h>
201 #include <netinet/tcp.h>
202 #include <arpa/inet.h>
211 #ifdef LWS_USE_LIBEVENT
212 #include <event2/event.h>
216 #ifdef LWS_HAVE_SYS_PRCTL_H
217 #include <sys/prctl.h>
221 #include <sys/time.h>
223 #define LWS_ERRNO errno
224 #define LWS_EAGAIN EAGAIN
225 #define LWS_EALREADY EALREADY
226 #define LWS_EINPROGRESS EINPROGRESS
227 #define LWS_EINTR EINTR
228 #define LWS_EISCONN EISCONN
229 #define LWS_EWOULDBLOCK EWOULDBLOCK
231 #define lws_set_blocking_send(wsi)
233 #if defined(LWS_WITH_ESP8266)
234 #define lws_socket_is_valid(x) ((x) != NULL)
235 #define LWS_SOCK_INVALID (NULL)
238 lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
240 #define lws_socket_is_valid(x) (x >= 0)
241 #define LWS_SOCK_INVALID (-1)
245 #ifndef LWS_HAVE_BZERO
247 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
251 #ifndef LWS_HAVE_STRERROR
252 #define strerror(x) ""
255 #ifdef LWS_OPENSSL_SUPPORT
258 #ifdef USE_OLD_CYASSL
259 #include <cyassl/openssl/ssl.h>
260 #include <cyassl/error-ssl.h>
262 #include <wolfssl/openssl/ssl.h>
263 #include <wolfssl/error-ssl.h>
264 #define OPENSSL_NO_TLSEXT
265 #endif /* not USE_OLD_CYASSL */
267 #include <openssl/ssl.h>
268 #if !defined(LWS_WITH_ESP32)
269 #include <openssl/evp.h>
270 #include <openssl/err.h>
271 #include <openssl/md5.h>
272 #include <openssl/sha.h>
273 #ifdef LWS_HAVE_OPENSSL_ECDH_H
274 #include <openssl/ecdh.h>
276 #include <openssl/x509v3.h>
278 #if (OPENSSL_VERSION_NUMBER < 0x0009080afL)
279 /* later openssl defines this to negate the presence of tlsext... but it was only
280 * introduced at 0.9.8j. Earlier versions don't know it exists so don't
281 * define it... making it look like the feature exists...
283 #define OPENSSL_NO_TLSEXT
285 #endif /* not USE_WOLFSSL */
288 #include "libwebsockets.h"
289 #if defined(WIN32) || defined(_WIN32)
291 static inline int compatible_close(int fd) { return close(fd); }
294 #if defined(WIN32) || defined(_WIN32)
295 #include <gettimeofday.h>
298 #if defined(LWS_WITH_ESP8266)
299 #undef compatible_close
300 #define compatible_close(fd) { fd->state=ESPCONN_CLOSE; espconn_delete(fd); }
302 esp8266_create_tcp_stream_socket(void);
304 esp8266_tcp_stream_bind(lws_sockfd_type fd, int port, struct lws *wsi);
306 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
308 #ifndef LITTLE_ENDIAN
309 #define LITTLE_ENDIAN 1234
312 #define BYTE_ORDER LITTLE_ENDIAN
317 #if defined(WIN32) || defined(_WIN32)
320 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
322 #ifndef LITTLE_ENDIAN
323 #define LITTLE_ENDIAN 1234
326 #define BYTE_ORDER LITTLE_ENDIAN
329 typedef unsigned __int64 u_int64_t;
335 #define __P(protos) protos
337 #define __P(protos) ()
343 #include <sys/stat.h>
344 #include <sys/time.h>
346 #if defined(__APPLE__)
347 #include <machine/endian.h>
348 #elif defined(__FreeBSD__)
349 #include <sys/endian.h>
350 #elif defined(__linux__)
359 #include <gulliver.h>
360 #if defined(__LITTLEENDIAN__)
361 #define BYTE_ORDER __LITTLEENDIAN__
362 #define LITTLE_ENDIAN __LITTLEENDIAN__
363 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
365 #if defined(__BIGENDIAN__)
366 #define BYTE_ORDER __BIGENDIAN__
367 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
368 #define BIG_ENDIAN __BIGENDIAN__
372 #if defined(__sun) && defined(__GNUC__)
374 #include <arpa/nameser_compat.h>
376 #if !defined (BYTE_ORDER)
377 # define BYTE_ORDER __BYTE_ORDER__
380 #if !defined(LITTLE_ENDIAN)
381 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
384 #if !defined(BIG_ENDIAN)
385 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
388 #endif /* sun + GNUC */
390 #if !defined(BYTE_ORDER)
391 # define BYTE_ORDER __BYTE_ORDER
393 #if !defined(LITTLE_ENDIAN)
394 # define LITTLE_ENDIAN __LITTLE_ENDIAN
396 #if !defined(BIG_ENDIAN)
397 # define BIG_ENDIAN __BIG_ENDIAN
403 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
404 * but happily have something equivalent in the SO_NOSIGPIPE flag.
407 #define MSG_NOSIGNAL SO_NOSIGPIPE
411 * Solaris 11.X only supports POSIX 2001, MSG_NOSIGNAL appears in
415 #define MSG_NOSIGNAL 0
419 #ifndef FD_HASHTABLE_MODULUS
420 #define FD_HASHTABLE_MODULUS 32
424 #ifndef LWS_DEF_HEADER_LEN
425 #define LWS_DEF_HEADER_LEN 4096
427 #ifndef LWS_DEF_HEADER_POOL
428 #define LWS_DEF_HEADER_POOL 4
430 #ifndef LWS_MAX_PROTOCOLS
431 #define LWS_MAX_PROTOCOLS 5
433 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
434 #define LWS_MAX_EXTENSIONS_ACTIVE 2
436 #ifndef LWS_MAX_EXT_OFFERS
437 #define LWS_MAX_EXT_OFFERS 8
439 #ifndef SPEC_LATEST_SUPPORTED
440 #define SPEC_LATEST_SUPPORTED 13
442 #ifndef AWAITING_TIMEOUT
443 #define AWAITING_TIMEOUT 20
445 #ifndef CIPHERS_LIST_STRING
446 #define CIPHERS_LIST_STRING "DEFAULT"
448 #ifndef LWS_SOMAXCONN
449 #define LWS_SOMAXCONN SOMAXCONN
452 #define MAX_WEBSOCKET_04_KEY_LEN 128
454 #ifndef SYSTEM_RANDOM_FILEPATH
455 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
458 enum lws_websocket_opcodes_07 {
459 LWSWSOPC_CONTINUATION = 0,
460 LWSWSOPC_TEXT_FRAME = 1,
461 LWSWSOPC_BINARY_FRAME = 2,
463 LWSWSOPC_NOSPEC__MUX = 7,
465 /* control extensions 8+ */
473 enum lws_connection_states {
475 LWSS_HTTP_ISSUING_FILE,
480 LWSS_CLIENT_HTTP_ESTABLISHED,
481 LWSS_CLIENT_UNCONNECTED,
482 LWSS_RETURNED_CLOSE_ALREADY,
483 LWSS_AWAITING_CLOSE_ACK,
484 LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
487 LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
488 LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
489 LWSS_HTTP2_ESTABLISHED,
500 enum http_connection_type {
501 HTTP_CONNECTION_CLOSE,
502 HTTP_CONNECTION_KEEP_ALIVE
505 enum lws_pending_protocol_send {
507 LWS_PPS_HTTP2_MY_SETTINGS,
508 LWS_PPS_HTTP2_ACK_SETTINGS,
512 enum lws_rx_parse_state {
519 LWS_RXPS_04_FRAME_HDR_1,
520 LWS_RXPS_04_FRAME_HDR_LEN,
521 LWS_RXPS_04_FRAME_HDR_LEN16_2,
522 LWS_RXPS_04_FRAME_HDR_LEN16_1,
523 LWS_RXPS_04_FRAME_HDR_LEN64_8,
524 LWS_RXPS_04_FRAME_HDR_LEN64_7,
525 LWS_RXPS_04_FRAME_HDR_LEN64_6,
526 LWS_RXPS_04_FRAME_HDR_LEN64_5,
527 LWS_RXPS_04_FRAME_HDR_LEN64_4,
528 LWS_RXPS_04_FRAME_HDR_LEN64_3,
529 LWS_RXPS_04_FRAME_HDR_LEN64_2,
530 LWS_RXPS_04_FRAME_HDR_LEN64_1,
532 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
533 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
534 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
535 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
537 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
540 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
542 enum connection_mode {
544 LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
545 LWSCM_PRE_WS_SERVING_ACCEPT,
552 /* transient, ssl delay hiding */
553 LWSCM_SSL_ACK_PENDING,
555 /* as above, but complete into LWSCM_RAW */
556 LWSCM_SSL_ACK_PENDING_RAW,
559 /* special internal types */
560 LWSCM_SERVER_LISTENER,
561 LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
562 LWSCM_RAW, /* raw with bulk handling */
563 LWSCM_RAW_FILEDESC, /* raw without bulk handling */
565 /* HTTP Client related */
566 LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
567 LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
568 LWSCM_WSCL_WAITING_CONNECT,
569 LWSCM_WSCL_WAITING_PROXY_REPLY,
570 LWSCM_WSCL_ISSUE_HANDSHAKE,
571 LWSCM_WSCL_ISSUE_HANDSHAKE2,
572 LWSCM_WSCL_ISSUE_HTTP_BODY,
573 LWSCM_WSCL_WAITING_SSL,
574 LWSCM_WSCL_WAITING_SERVER_REPLY,
575 LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
576 LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
577 LWSCM_WSCL_WAITING_SOCKS_GREETING_REPLY,
578 LWSCM_WSCL_WAITING_SOCKS_CONNECT_REPLY,
579 LWSCM_WSCL_WAITING_SOCKS_AUTH_REPLY,
581 /****** add new things just above ---^ ******/
586 /* enums of socks version */
592 /* enums of subnegotiation version */
593 enum socks_subnegotiation_version {
594 SOCKS_SUBNEGOTIATION_VERSION_1 = 1,
597 /* enums of socks commands */
599 SOCKS_COMMAND_CONNECT = 1,
600 SOCKS_COMMAND_BIND = 2,
601 SOCKS_COMMAND_UDP_ASSOCIATE = 3
604 /* enums of socks address type */
607 SOCKS_ATYP_DOMAINNAME = 3,
611 /* enums of socks authentication methods */
612 enum socks_auth_method {
613 SOCKS_AUTH_NO_AUTH = 0,
614 SOCKS_AUTH_GSSAPI = 1,
615 SOCKS_AUTH_USERNAME_PASSWORD = 2
618 /* enums of subnegotiation status */
619 enum socks_subnegotiation_status {
620 SOCKS_SUBNEGOTIATION_STATUS_SUCCESS = 0,
623 /* enums of socks request reply */
624 enum socks_request_reply {
625 SOCKS_REQUEST_REPLY_SUCCESS = 0,
626 SOCKS_REQUEST_REPLY_FAILURE_GENERAL = 1,
627 SOCKS_REQUEST_REPLY_CONNECTION_NOT_ALLOWED = 2,
628 SOCKS_REQUEST_REPLY_NETWORK_UNREACHABLE = 3,
629 SOCKS_REQUEST_REPLY_HOST_UNREACHABLE = 4,
630 SOCKS_REQUEST_REPLY_CONNECTION_REFUSED = 5,
631 SOCKS_REQUEST_REPLY_TTL_EXPIRED = 6,
632 SOCKS_REQUEST_REPLY_COMMAND_NOT_SUPPORTED = 7,
633 SOCKS_REQUEST_REPLY_ATYP_NOT_SUPPORTED = 8
636 /* enums used to generate socks messages */
637 enum socks_msg_type {
640 /* credential, user name and password */
641 SOCKS_MSG_USERNAME_PASSWORD,
642 /* connect command */
647 LWS_RXFLOW_ALLOW = (1 << 0),
648 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
651 /* this is not usable directly by user code any more, lws_close_reason() */
652 #define LWS_WRITE_CLOSE 4
654 struct lws_protocols;
657 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
659 struct lws_io_watcher {
664 uv_poll_t uv_watcher;
666 #ifdef LWS_USE_LIBEVENT
667 struct event *event_watcher;
669 struct lws_context *context;
672 struct lws_signal_watcher {
674 ev_signal ev_watcher;
677 uv_signal_t uv_watcher;
679 #ifdef LWS_USE_LIBEVENT
680 struct event *event_watcher;
682 struct lws_context *context;
687 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
688 struct lws_fd_hashtable {
695 * This is totally opaque to code using the library. It's exported as a
696 * forward-reference pointer-only declaration; the user can use the pointer with
697 * other APIs to get information out of it.
700 struct lws_fragments {
703 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
707 * these are assigned from a pool held in the context.
708 * Both client and server mode uses them for http header analysis
711 struct allocated_headers {
712 struct lws *wsi; /* owner */
713 char *data; /* prepared by context init to point to dedicated storage */
715 * the randomly ordered fragments, indexed by frag_index and
716 * lws_fragments->nfrag for continuation.
718 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
721 * for each recognized token, frag_index says which frag[] his data
722 * starts in (0 means the token did not appear)
723 * the actual header data gets dumped as it comes in, into data[]
725 unsigned char frag_index[WSI_TOKEN_COUNT];
726 unsigned char rx[2048];
732 unsigned int http_response;
734 #ifndef LWS_NO_CLIENT
735 char initial_handshake_hash_base64[30];
738 unsigned char in_use;
743 * so we can have n connections being serviced simultaneously,
744 * these things need to be isolated per-thread.
747 struct lws_context_per_thread {
749 pthread_mutex_t lock;
751 struct lws_pollfd *fds;
752 #if defined(LWS_WITH_ESP8266)
753 struct lws **lws_vs_fds_index;
755 struct lws *rx_draining_ext_list;
756 struct lws *tx_draining_ext_list;
757 struct lws *timeout_list;
758 #if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
759 struct lws_context *context;
762 struct lws_cgi *cgi_list;
764 void *http_header_data;
765 struct allocated_headers *ah_pool;
766 struct lws *ah_wait_list;
767 int ah_wait_list_length;
768 #ifdef LWS_OPENSSL_SUPPORT
769 struct lws *pending_read_list; /* linked list */
771 #if defined(LWS_USE_LIBEV)
772 struct ev_loop *io_loop_ev;
774 #if defined(LWS_USE_LIBUV)
775 uv_loop_t *io_loop_uv;
776 uv_signal_t signals[8];
777 uv_timer_t uv_timeout_watcher;
780 #if defined(LWS_USE_LIBEVENT)
781 struct event_base *io_loop_event_base;
783 #if defined(LWS_USE_LIBEV)
784 struct lws_io_watcher w_accept;
786 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
787 struct lws_signal_watcher w_sigint;
788 unsigned char ev_loop_foreign:1;
791 unsigned long count_conns;
793 * usable by anything in the service code, but only if the scope
794 * does not last longer than the service action (since next service
795 * of any socket can likewise use it and overwrite)
797 unsigned char *serv_buf;
801 lws_sockfd_type dummy_pipe_fds[2];
803 unsigned int fds_count;
805 short ah_count_in_use;
807 unsigned char lock_depth;
810 struct lws_conn_stats {
811 unsigned long long rx, tx;
812 unsigned long conn, trans, ws_upg, http2_upg, rejected;
816 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
819 * virtual host -related context information
820 * vhostwide SSL context
825 * context -> vhost -> wsi
827 * incoming connection non-SSL vhost binding:
829 * listen socket -> wsi -> select vhost after first headers
831 * incoming connection SSL vhost binding:
833 * SSL SNI -> wsi -> bind after SSL negotiation
837 #if !defined(LWS_WITH_ESP8266)
838 char http_proxy_address[128];
839 char proxy_basic_auth_token[128];
840 #if defined(LWS_WITH_SOCKS5)
841 char socks_proxy_address[128];
843 char socks_password[96];
846 #if defined(LWS_WITH_ESP8266)
847 /* listen sockets need a place to hang their hat */
850 struct lws_conn_stats conn_stats;
851 struct lws_context *context;
852 struct lws_vhost *vhost_next;
853 const struct lws_http_mount *mount_list;
854 struct lws *lserv_wsi;
857 const struct lws_protocols *protocols;
858 void **protocol_vh_privs;
859 const struct lws_protocol_vhost_options *pvo;
860 const struct lws_protocol_vhost_options *headers;
861 struct lws **same_vh_protocol_list;
862 #ifdef LWS_OPENSSL_SUPPORT
864 SSL_CTX *ssl_client_ctx;
866 #ifndef LWS_NO_EXTENSIONS
867 const struct lws_extension *extensions;
871 unsigned int http_proxy_port;
872 #if defined(LWS_WITH_SOCKS5)
873 unsigned int socks_proxy_port;
875 unsigned int options;
880 int keepalive_timeout;
881 #ifdef LWS_WITH_ACCESS_LOG
885 #ifdef LWS_OPENSSL_SUPPORT
887 int allow_non_ssl_on_ssl_port;
888 unsigned int user_supplied_ssl_ctx:1;
891 unsigned int created_vhost_protocols:1;
893 unsigned char default_protocol_index;
894 unsigned char raw_protocol_index;
898 * the rest is managed per-context, that includes
900 * - processwide single fd -> wsi lookup
901 * - contextwide headers pool
905 time_t last_timeout_check_s;
906 time_t last_ws_ping_pong_check_s;
908 const struct lws_plat_file_ops *fops;
909 struct lws_plat_file_ops fops_platform;
910 #if defined(LWS_WITH_ZIP_FOPS)
911 struct lws_plat_file_ops fops_zip;
913 struct lws_context_per_thread pt[LWS_MAX_SMP];
914 struct lws_conn_stats conn_stats;
916 /* different implementation between unix and windows */
917 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
919 #if defined(LWS_WITH_ESP8266)
920 struct espconn **connpool; /* .reverse points to the wsi */
925 struct lws **lws_lookup; /* fd to wsi */
928 struct lws_vhost *vhost_list;
929 struct lws_plugin *plugin_list;
931 void *external_baggage_free_on_destroy;
932 const struct lws_token_limits *token_limits;
934 const char *server_string;
935 const struct lws_protocol_vhost_options *reject_service_keywords;
936 lws_reload_func deprecation_cb;
938 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
943 #if defined(LWS_USE_LIBEV)
944 lws_ev_signal_cb_t * lws_ev_sigint_cb;
946 #if defined(LWS_USE_LIBUV)
947 uv_signal_cb lws_uv_sigint_cb;
949 #if defined(LWS_USE_LIBEVENT)
950 lws_event_signal_cb_t * lws_event_sigint_cb;
952 char canonical_hostname[128];
954 unsigned long worst_latency;
955 char worst_latency_info[256];
958 #if defined(LWS_WITH_STATS)
959 uint64_t lws_stats[LWSSTATS_SIZE];
965 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
968 int started_with_parent;
972 #ifdef LWS_OPENSSL_SUPPORT
973 #define lws_ssl_anybody_has_buffered_read(w) \
974 (w->vhost->use_ssl && \
975 w->context->pt[(int)w->tsi].pending_read_list)
976 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
977 (/*c->use_ssl && */ \
978 c->pt[(int)t].pending_read_list)
980 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
981 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
983 int count_wsi_allocated;
984 int count_cgi_spawned;
985 unsigned int options;
986 unsigned int fd_limit_per_thread;
987 unsigned int timeout_secs;
988 unsigned int pt_serv_buf_size;
989 int max_http_header_data;
990 int simultaneous_ssl_restriction;
991 int simultaneous_ssl;
993 unsigned int deprecated:1;
994 unsigned int being_destroyed:1;
995 unsigned int being_destroyed1:1;
996 unsigned int requested_kill:1;
997 unsigned int protocol_init_done:1;
998 unsigned int ssl_gate_accepts:1;
1000 * set to the Thread ID that's doing the service loop just before entry
1001 * to poll indicates service thread likely idling in poll()
1002 * volatile because other threads may check it as part of processing
1003 * for pollfd event change.
1005 volatile int service_tid;
1006 int service_tid_detected;
1008 short max_http_header_pool;
1009 short count_threads;
1010 short plugin_protocol_count;
1011 short plugin_extension_count;
1012 short server_string_len;
1013 unsigned short ws_ping_pong_interval;
1014 unsigned short deprecation_pending_listen_close_count;
1018 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
1019 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
1022 lws_close_free_wsi_final(struct lws *wsi);
1024 lws_libuv_closehandle(struct lws *wsi);
1026 LWS_VISIBLE LWS_EXTERN int
1027 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
1029 LWS_VISIBLE LWS_EXTERN int
1030 lws_plat_plugins_destroy(struct lws_context * context);
1033 lws_restart_ws_ping_pong_timer(struct lws *wsi);
1036 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
1040 LWS_EV_READ = (1 << 0),
1041 LWS_EV_WRITE = (1 << 1),
1042 LWS_EV_START = (1 << 2),
1043 LWS_EV_STOP = (1 << 3),
1045 LWS_EV_PREPARE_DELETION = (1 << 31),
1048 #if defined(LWS_USE_LIBEV)
1050 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1052 lws_libev_io(struct lws *wsi, int flags);
1054 lws_libev_init_fd_table(struct lws_context *context);
1056 lws_libev_destroyloop(struct lws_context *context, int tsi);
1058 lws_libev_run(const struct lws_context *context, int tsi);
1059 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
1060 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
1062 #define lws_libev_accept(_a, _b) ((void) 0)
1063 #define lws_libev_io(_a, _b) ((void) 0)
1064 #define lws_libev_init_fd_table(_a) (0)
1065 #define lws_libev_run(_a, _b) ((void) 0)
1066 #define lws_libev_destroyloop(_a, _b) ((void) 0)
1067 #define LWS_LIBEV_ENABLED(context) (0)
1068 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1069 #define lws_feature_status_libev(_a) \
1070 lwsl_notice("libev support not compiled in\n")
1072 #define lws_feature_status_libev(_a)
1076 #if defined(LWS_USE_LIBUV)
1078 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1080 lws_libuv_io(struct lws *wsi, int flags);
1082 lws_libuv_init_fd_table(struct lws_context *context);
1084 lws_libuv_run(const struct lws_context *context, int tsi);
1086 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1088 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1089 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1090 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1092 #define lws_libuv_accept(_a, _b) ((void) 0)
1093 #define lws_libuv_io(_a, _b) ((void) 0)
1094 #define lws_libuv_init_fd_table(_a) (0)
1095 #define lws_libuv_run(_a, _b) ((void) 0)
1096 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1097 #define LWS_LIBUV_ENABLED(context) (0)
1098 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1099 #define lws_feature_status_libuv(_a) \
1100 lwsl_notice("libuv support not compiled in\n")
1102 #define lws_feature_status_libuv(_a)
1106 #if defined(LWS_USE_LIBEVENT)
1108 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1110 lws_libevent_io(struct lws *wsi, int flags);
1112 lws_libevent_init_fd_table(struct lws_context *context);
1114 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1116 lws_libevent_run(const struct lws_context *context, int tsi);
1117 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1118 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1120 #define lws_libevent_accept(_a, _b) ((void) 0)
1121 #define lws_libevent_io(_a, _b) ((void) 0)
1122 #define lws_libevent_init_fd_table(_a) (0)
1123 #define lws_libevent_run(_a, _b) ((void) 0)
1124 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1125 #define LWS_LIBEVENT_ENABLED(context) (0)
1126 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1127 #define lws_feature_status_libevent(_a) \
1128 lwsl_notice("libevent support not compiled in\n")
1130 #define lws_feature_status_libevent(_a)
1136 #define LWS_IPV6_ENABLED(vh) \
1137 (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1138 !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1140 #define LWS_IPV6_ENABLED(context) (0)
1143 #ifdef LWS_USE_UNIX_SOCK
1144 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1145 (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1147 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1149 enum uri_path_states {
1152 URIPS_SEEN_SLASH_DOT,
1153 URIPS_SEEN_SLASH_DOT_DOT,
1156 enum uri_esc_states {
1159 URIES_SEEN_PERCENT_H1,
1162 /* notice that these union members:
1168 * all have a pointer to allocated_headers struct as their first member.
1170 * It means for allocated_headers access, the three union paths can all be
1171 * used interchangeably to access the same data
1175 #ifndef LWS_NO_CLIENT
1176 struct client_info_stash {
1186 struct _lws_header_related {
1187 /* MUST be first in struct */
1188 struct allocated_headers *ah;
1189 struct lws *ah_wait_list;
1190 unsigned char *preamble_rx;
1191 #ifndef LWS_NO_CLIENT
1192 struct client_info_stash *stash;
1194 unsigned int preamble_rx_len;
1195 enum uri_path_states ups;
1196 enum uri_esc_states ues;
1198 unsigned int current_token_limit;
1201 char post_literal_equal;
1202 unsigned char parser_state; /* enum lws_token_indexes */
1205 #if defined(LWS_WITH_RANGES)
1207 LWSRS_NO_ACTIVE_RANGE,
1216 struct lws_range_parsing {
1217 unsigned long long start, end, extent, agg, budget;
1218 const char buf[128];
1220 enum range_states state;
1221 char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1225 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1227 lws_ranges_next(struct lws_range_parsing *rp);
1229 lws_ranges_reset(struct lws_range_parsing *rp);
1232 struct _lws_http_mode_related {
1233 /* MUST be first in struct */
1234 struct allocated_headers *ah; /* mirroring _lws_header_related */
1235 struct lws *ah_wait_list;
1236 unsigned char *preamble_rx;
1237 #ifndef LWS_NO_CLIENT
1238 struct client_info_stash *stash;
1240 unsigned int preamble_rx_len;
1241 struct lws *new_wsi_list;
1242 lws_filepos_t filepos;
1243 lws_filepos_t filelen;
1244 lws_fop_fd_t fop_fd;
1246 #if defined(LWS_WITH_RANGES)
1247 struct lws_range_parsing range;
1248 char multipart_content_type[64];
1251 enum http_version request_version;
1252 enum http_connection_type connection_type;
1253 unsigned int content_length;
1254 unsigned int content_remain;
1257 #ifdef LWS_USE_HTTP2
1259 enum lws_http2_settings {
1260 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1261 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1262 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1263 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1264 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1265 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1267 LWS_HTTP2_SETTINGS__COUNT /* always last */
1270 enum lws_http2_wellknown_frame_types {
1271 LWS_HTTP2_FRAME_TYPE_DATA,
1272 LWS_HTTP2_FRAME_TYPE_HEADERS,
1273 LWS_HTTP2_FRAME_TYPE_PRIORITY,
1274 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1275 LWS_HTTP2_FRAME_TYPE_SETTINGS,
1276 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1277 LWS_HTTP2_FRAME_TYPE_PING,
1278 LWS_HTTP2_FRAME_TYPE_GOAWAY,
1279 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1280 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1282 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1285 enum lws_http2_flags {
1286 LWS_HTTP2_FLAG_END_STREAM = 1,
1287 LWS_HTTP2_FLAG_END_HEADERS = 4,
1288 LWS_HTTP2_FLAG_PADDED = 8,
1289 LWS_HTTP2_FLAG_PRIORITY = 0x20,
1291 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1294 #define LWS_HTTP2_STREAM_ID_MASTER 0
1295 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1296 #define LWS_HTTP2_SETTINGS_LENGTH 6
1298 struct http2_settings {
1299 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1302 enum http2_hpack_state {
1304 /* optional before first header block */
1306 HKPS_OPT_E_DEPENDENCY,
1319 /* optional after last header block */
1320 HKPS_OPT_DISCARD_PADDING,
1323 enum http2_hpack_type {
1325 HPKT_INDEXED_HDR_6_VALUE_INCR,
1326 HPKT_LITERAL_HDR_VALUE_INCR,
1327 HPKT_INDEXED_HDR_4_VALUE,
1328 HPKT_LITERAL_HDR_VALUE,
1332 struct hpack_dt_entry {
1333 int token; /* additions that don't map to a token are ignored */
1338 struct hpack_dynamic_table {
1339 struct hpack_dt_entry *entries;
1347 struct _lws_http2_related {
1349 * having this first lets us also re-use all HTTP union code
1350 * and in turn, http_mode_related has allocated headers in right
1351 * place so we can use the header apis on the wsi directly still
1353 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1355 struct http2_settings my_settings;
1356 struct http2_settings peer_settings;
1358 struct lws *parent_wsi;
1359 struct lws *next_child_wsi;
1361 struct hpack_dynamic_table *hpack_dyn_table;
1362 struct lws *stream_wsi;
1363 unsigned char ping_payload[8];
1364 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1367 unsigned int length;
1368 unsigned int stream_id;
1369 enum http2_hpack_state hpack;
1370 enum http2_hpack_type hpack_type;
1371 unsigned int header_index;
1372 unsigned int hpack_len;
1373 unsigned int hpack_e_dep;
1375 unsigned int my_stream_id;
1376 unsigned int child_count;
1379 unsigned int END_STREAM:1;
1380 unsigned int END_HEADERS:1;
1381 unsigned int send_END_STREAM:1;
1382 unsigned int GOING_AWAY;
1383 unsigned int requested_POLLOUT:1;
1384 unsigned int waiting_tx_credit:1;
1385 unsigned int huff:1;
1386 unsigned int value:1;
1388 unsigned short round_robin_POLLOUT;
1389 unsigned short count_POLLOUT_children;
1390 unsigned short hpack_pos;
1393 unsigned char flags;
1394 unsigned char frame_state;
1395 unsigned char padding;
1396 unsigned char hpack_m;
1397 unsigned char initialized;
1400 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1404 struct _lws_websocket_related {
1405 /* cheapest way to deal with ah overlap with ws union transition */
1406 struct _lws_header_related hdr;
1408 unsigned int rx_ubuf_alloc;
1409 struct lws *rx_draining_ext_list;
1410 struct lws *tx_draining_ext_list;
1411 time_t time_next_ping_check;
1412 size_t rx_packet_length;
1413 unsigned int rx_ubuf_head;
1414 unsigned char mask[4];
1415 /* Also used for close content... control opcode == < 128 */
1416 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1418 unsigned char ping_payload_len;
1419 unsigned char mask_idx;
1420 unsigned char opcode;
1422 unsigned char rsv_first_msg;
1423 /* zero if no info, or length including 2-byte close code */
1424 unsigned char close_in_ping_buffer_len;
1426 unsigned char stashed_write_type;
1427 unsigned char tx_draining_stashed_wp;
1429 unsigned int final:1;
1430 unsigned int frame_is_binary:1;
1431 unsigned int all_zero_nonce:1;
1432 unsigned int this_frame_masked:1;
1433 unsigned int inside_frame:1; /* next write will be more of frame */
1434 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1435 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1436 unsigned int ping_pending_flag:1;
1437 unsigned int continuation_possible:1;
1438 unsigned int owed_a_fin:1;
1439 unsigned int check_utf8:1;
1440 unsigned int defeat_check_utf8:1;
1441 unsigned int pmce_compressed_message:1;
1442 unsigned int stashed_write_pending:1;
1443 unsigned int rx_draining_ext:1;
1444 unsigned int tx_draining_ext:1;
1445 unsigned int send_check_ping:1;
1451 SIGNIFICANT_HDR_CONTENT_LENGTH,
1452 SIGNIFICANT_HDR_LOCATION,
1453 SIGNIFICANT_HDR_STATUS,
1454 SIGNIFICANT_HDR_TRANSFER_ENCODING,
1456 SIGNIFICANT_HDR_COUNT
1459 /* wsi who is master of the cgi points to an lws_cgi */
1462 struct lws_cgi *cgi_list;
1463 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1464 struct lws *wsi; /* owner */
1465 unsigned char *headers_buf;
1466 unsigned char *headers_pos;
1467 unsigned char *headers_dumped;
1468 unsigned char *headers_end;
1469 unsigned long content_length;
1470 unsigned long content_length_seen;
1472 int match[SIGNIFICANT_HDR_COUNT];
1478 unsigned int being_closed:1;
1479 unsigned int explicitly_chunked:1;
1481 unsigned char chunked_grace;
1485 signed char char_to_hex(const char c);
1487 #ifndef LWS_NO_CLIENT
1488 enum lws_chunk_parser {
1499 #ifdef LWS_WITH_ACCESS_LOG
1500 struct lws_access_log {
1511 /* members with mutually exclusive lifetimes are unionized */
1514 struct _lws_http_mode_related http;
1515 #ifdef LWS_USE_HTTP2
1516 struct _lws_http2_related http2;
1518 struct _lws_header_related hdr;
1519 struct _lws_websocket_related ws;
1522 /* lifetime members */
1524 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1525 struct lws_io_watcher w_read;
1527 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1528 struct lws_io_watcher w_write;
1530 time_t pending_timeout_limit;
1534 struct lws_context *context;
1535 struct lws_vhost *vhost;
1536 struct lws *parent; /* points to parent, if any */
1537 struct lws *child_list; /* points to first child */
1538 struct lws *sibling_list; /* subsequent children at same level */
1540 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1542 const struct lws_protocols *protocol;
1543 struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1544 struct lws *timeout_list;
1545 struct lws **timeout_list_prev;
1546 #ifdef LWS_WITH_ACCESS_LOG
1547 struct lws_access_log access_log;
1550 /* rxflow handling */
1551 unsigned char *rxflow_buffer;
1552 /* truncated send handling */
1553 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1555 #if defined (LWS_WITH_ESP8266)
1557 unsigned short prem_rx_size, prem_rx_pos;
1560 #ifndef LWS_NO_EXTENSIONS
1561 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1562 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1564 #ifdef LWS_OPENSSL_SUPPORT
1567 struct lws *pending_read_list_prev, *pending_read_list_next;
1568 #if defined(LWS_WITH_STATS)
1569 uint64_t accept_start_us;
1573 #ifdef LWS_WITH_HTTP_PROXY
1574 struct lws_rewrite *rw;
1577 unsigned long action_start;
1578 unsigned long latency_start;
1580 lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1581 #if defined(LWS_WITH_STATS)
1582 uint64_t active_writable_req_us;
1585 int position_in_fds_table;
1588 unsigned int trunc_alloc_len; /* size of malloc */
1589 unsigned int trunc_offset; /* where we are in terms of spilling */
1590 unsigned int trunc_len; /* how much is buffered */
1591 #ifndef LWS_NO_CLIENT
1592 int chunk_remaining;
1594 unsigned int cache_secs;
1596 unsigned int hdr_parsing_completed:1;
1597 unsigned int http2_substream:1;
1598 unsigned int listener:1;
1599 unsigned int user_space_externally_allocated:1;
1600 unsigned int socket_is_permanently_unusable:1;
1601 unsigned int rxflow_change_to:2;
1602 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1603 unsigned int conn_stat_done:1;
1604 unsigned int cache_reuse:1;
1605 unsigned int cache_revalidate:1;
1606 unsigned int cache_intermediaries:1;
1607 unsigned int favoured_pollin:1;
1608 unsigned int sending_chunked:1;
1609 unsigned int already_did_cce:1;
1610 unsigned int told_user_closed:1;
1612 #if defined(LWS_WITH_ESP8266)
1613 unsigned int pending_send_completion:3;
1614 unsigned int close_is_pending_send_completion:1;
1616 #ifdef LWS_WITH_ACCESS_LOG
1617 unsigned int access_log_pending:1;
1619 #ifndef LWS_NO_CLIENT
1620 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1621 unsigned int chunked:1; /* if the clientside connection is chunked */
1622 unsigned int client_rx_avail:1;
1623 unsigned int client_http_body_pending:1;
1625 #ifdef LWS_WITH_HTTP_PROXY
1626 unsigned int perform_rewrite:1;
1628 #ifndef LWS_NO_EXTENSIONS
1629 unsigned int extension_data_pending:1;
1631 #ifdef LWS_OPENSSL_SUPPORT
1632 unsigned int use_ssl:4;
1635 unsigned int sock_send_blocking:1;
1637 #ifdef LWS_OPENSSL_SUPPORT
1638 unsigned int redirect_to_https:1;
1641 /* volatile to make sure code is aware other thread can change */
1642 volatile unsigned int handling_pollout:1;
1643 volatile unsigned int leave_pollout_active:1;
1645 #ifndef LWS_NO_CLIENT
1646 unsigned short c_port;
1650 #ifndef LWS_NO_EXTENSIONS
1651 unsigned char count_act_ext;
1653 unsigned char ietf_spec_revision;
1654 char mode; /* enum connection_mode */
1655 char state; /* enum lws_connection_states */
1656 char state_pre_close;
1657 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1658 char rx_frame_type; /* enum lws_write_protocol */
1659 char pending_timeout; /* enum pending_timeout */
1660 char pps; /* enum lws_pending_protocol_send */
1661 char tsi; /* thread service index we belong to */
1662 char protocol_interpret_idx;
1665 char cgi_channel; /* which of stdin/out/err */
1668 #ifndef LWS_NO_CLIENT
1669 char chunk_parser; /* enum lws_chunk_parser */
1671 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1672 char reason_bf; /* internal writeable callback reason bitfield */
1676 LWS_EXTERN int log_level;
1679 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1682 #if defined(LWS_USE_IPV6)
1683 LWS_EXTERN unsigned long
1684 lws_get_addr_scope(const char *ipaddr);
1688 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1691 remove_wsi_socket_from_fds(struct lws *wsi);
1693 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1697 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1698 int ret, int completion) {
1700 (void)context; (void)wsi; (void)action; (void)ret;
1705 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1706 do { (void)context; (void)wsi; } while (0);
1709 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1711 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1712 int ret, int completion);
1716 lws_set_protocol_write_pending(struct lws *wsi,
1717 enum lws_pending_protocol_send pend);
1718 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1719 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1721 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1722 lws_parse(struct lws *wsi, unsigned char c);
1724 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1725 lws_http_action(struct lws *wsi);
1728 lws_b64_selftest(void);
1731 lws_service_flag_pending(struct lws_context *context, int tsi);
1733 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1734 LWS_EXTERN struct lws *
1735 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1738 insert_wsi(struct lws_context *context, struct lws *wsi);
1741 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1743 #define wsi_from_fd(A,B) A->lws_lookup[B]
1744 #define insert_wsi(A,B) assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1745 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1748 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1749 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1751 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1752 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1755 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1756 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1759 lws_remove_from_timeout_list(struct lws *wsi);
1761 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1762 lws_client_connect_2(struct lws *wsi);
1764 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1765 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1766 const char *path, const char *host);
1768 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1769 lws_create_new_server_wsi(struct lws_vhost *vhost);
1771 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1772 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1775 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1777 LWS_EXTERN struct lws *
1778 lws_client_connect_via_info2(struct lws *wsi);
1784 #ifndef LWS_NO_EXTENSIONS
1786 lws_context_init_extensions(struct lws_context_creation_info *info,
1787 struct lws_context *context);
1789 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1790 void *v, size_t len);
1793 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1795 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1796 void *arg, int len);
1799 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1800 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1801 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1802 #define lws_issue_raw_ext_access lws_issue_raw
1803 #define lws_context_init_extensions(_a, _b)
1806 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1807 lws_client_interpret_server_handshake(struct lws *wsi);
1809 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1810 lws_rx_sm(struct lws *wsi, unsigned char c);
1813 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1815 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1816 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1819 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1821 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1822 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1823 enum lws_callback_reasons reason, void *user,
1824 void *in, size_t len);
1825 #ifdef LWS_USE_HTTP2
1826 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1827 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1829 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1830 unsigned char *buf, int len);
1831 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1833 lws_http2_parser(struct lws *wsi, unsigned char c);
1834 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1836 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1837 unsigned int sid, unsigned int len,
1838 unsigned char *buf);
1839 LWS_EXTERN struct lws *
1840 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1841 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1844 lws_add_http2_header_by_name(struct lws *wsi,
1845 const unsigned char *name,
1846 const unsigned char *value, int length,
1847 unsigned char **p, unsigned char *end);
1849 lws_add_http2_header_by_token(struct lws *wsi,
1850 enum lws_token_indexes token,
1851 const unsigned char *value, int length,
1852 unsigned char **p, unsigned char *end);
1854 lws_add_http2_header_status(struct lws *wsi,
1855 unsigned int code, unsigned char **p,
1856 unsigned char *end);
1858 void lws_http2_configure_if_upgraded(struct lws *wsi);
1860 #define lws_http2_configure_if_upgraded(x)
1864 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1867 lws_plat_check_connection_error(struct lws *wsi);
1869 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1870 lws_header_table_attach(struct lws *wsi, int autoservice);
1873 lws_header_table_detach(struct lws *wsi, int autoservice);
1876 lws_header_table_reset(struct lws *wsi, int autoservice);
1878 _lws_header_table_reset(struct allocated_headers *ah);
1880 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1881 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1883 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1884 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1886 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1887 lws_ensure_user_space(struct lws *wsi);
1890 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1892 #ifndef LWS_NO_SERVER
1893 int lws_context_init_server(struct lws_context_creation_info *info,
1894 struct lws_vhost *vhost);
1895 LWS_EXTERN struct lws_vhost *
1896 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1898 handshake_0405(struct lws_context *context, struct lws *wsi);
1899 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1900 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1902 lws_server_get_canonical_hostname(struct lws_context *context,
1903 struct lws_context_creation_info *info);
1905 #define lws_context_init_server(_a, _b) (0)
1906 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1907 #define lws_server_get_canonical_hostname(_a, _b)
1910 #ifndef LWS_NO_DAEMONIZE
1911 LWS_EXTERN int get_daemonize_pid();
1913 #define get_daemonize_pid() (0)
1916 #if !defined(LWS_WITH_ESP8266)
1917 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1918 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1919 struct sockaddr_in *addr, size_t addrlen);
1921 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1923 enum lws_ssl_capable_status {
1924 LWS_SSL_CAPABLE_ERROR = -1,
1925 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1928 #ifndef LWS_OPENSSL_SUPPORT
1929 #define LWS_SSL_ENABLED(context) (0)
1930 #define lws_context_init_server_ssl(_a, _b) (0)
1931 #define lws_ssl_destroy(_a)
1932 #define lws_context_init_http2_ssl(_a)
1933 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1934 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1935 #define lws_ssl_pending lws_ssl_pending_no_ssl
1936 #define lws_server_socket_service_ssl(_b, _c) (0)
1937 #define lws_ssl_close(_a) (0)
1938 #define lws_ssl_context_destroy(_a)
1939 #define lws_ssl_SSL_CTX_destroy(_a)
1940 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1941 #define lws_context_init_ssl_library(_a)
1943 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1944 LWS_EXTERN int openssl_websocket_private_data_index;
1945 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1946 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1947 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1948 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1949 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1950 lws_ssl_pending(struct lws *wsi);
1952 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1953 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1954 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1956 lws_ssl_close(struct lws *wsi);
1958 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1960 lws_ssl_context_destroy(struct lws_context *context);
1962 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1964 lws_ssl_client_bio_create(struct lws *wsi);
1966 lws_ssl_client_connect1(struct lws *wsi);
1968 lws_ssl_client_connect2(struct lws *wsi);
1970 lws_ssl_elaborate_error(void);
1971 #ifndef LWS_NO_SERVER
1973 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1974 struct lws_vhost *vhost);
1976 #define lws_context_init_server_ssl(_a, _b) (0)
1979 lws_ssl_destroy(struct lws_vhost *vhost);
1982 #ifdef LWS_USE_HTTP2
1984 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1986 #define lws_context_init_http2_ssl(_a)
1991 static LWS_INLINE void
1992 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1994 pthread_mutex_init(&pt->lock, NULL);
1997 static LWS_INLINE void
1998 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
2000 pthread_mutex_destroy(&pt->lock);
2003 static LWS_INLINE void
2004 lws_pt_lock(struct lws_context_per_thread *pt)
2006 if (!pt->lock_depth++)
2007 pthread_mutex_lock(&pt->lock);
2010 static LWS_INLINE void
2011 lws_pt_unlock(struct lws_context_per_thread *pt)
2013 if (!(--pt->lock_depth))
2014 pthread_mutex_unlock(&pt->lock);
2017 #define lws_pt_mutex_init(_a) (void)(_a)
2018 #define lws_pt_mutex_destroy(_a) (void)(_a)
2019 #define lws_pt_lock(_a) (void)(_a)
2020 #define lws_pt_unlock(_a) (void)(_a)
2023 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2024 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2026 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2027 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2029 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2030 lws_ssl_pending_no_ssl(struct lws *wsi);
2032 #ifdef LWS_WITH_HTTP_PROXY
2033 struct lws_rewrite {
2034 hubbub_parser *parser;
2035 hubbub_parser_optparams params;
2036 const char *from, *to;
2037 int from_len, to_len;
2038 unsigned char *p, *end;
2041 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
2046 return strncmp((const char *)s->ptr, p, len);
2048 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
2049 LWS_EXTERN struct lws_rewrite *
2050 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
2052 lws_rewrite_destroy(struct lws_rewrite *r);
2054 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
2057 #ifndef LWS_NO_CLIENT
2058 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
2060 struct lws_pollfd *pollfd);
2061 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2062 lws_http_transaction_completed_client(struct lws *wsi);
2063 #ifdef LWS_OPENSSL_SUPPORT
2065 lws_context_init_client_ssl(struct lws_context_creation_info *info,
2066 struct lws_vhost *vhost);
2068 #define lws_context_init_client_ssl(_a, _b) (0)
2070 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2071 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
2073 lws_decode_ssl_error(void);
2075 #define lws_context_init_client_ssl(_a, _b) (0)
2076 #define lws_handshake_client(_a, _b, _c) (0)
2080 _lws_rx_flow_control(struct lws *wsi);
2083 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
2085 #ifndef LWS_NO_SERVER
2087 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
2088 struct lws_pollfd *pollfd);
2090 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
2092 #define lws_server_socket_service(_a, _b, _c) (0)
2093 #define lws_handshake_server(_a, _b, _c) (0)
2096 #ifdef LWS_WITH_ACCESS_LOG
2098 lws_access_log(struct lws *wsi);
2100 #define lws_access_log(_a)
2104 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2107 lws_protocol_init(struct lws_context *context);
2110 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2112 const struct lws_http_mount *
2113 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2119 lws_realloc(void *ptr, size_t size);
2121 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2122 lws_zalloc(size_t size);
2124 #ifdef LWS_PLAT_OPTEE
2125 void *lws_malloc(size_t size);
2126 void lws_free(void *p);
2127 #define lws_free_set_NULL(P) do { lws_free(P); (P) = NULL; } while(0)
2129 #define lws_malloc(S) lws_realloc(NULL, S)
2130 #define lws_free(P) lws_realloc(P, 0)
2131 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
2134 const struct lws_plat_file_ops *
2135 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2136 const char **vpath);
2140 lws_plat_delete_socket_from_fds(struct lws_context *context,
2141 struct lws *wsi, int m);
2143 lws_plat_insert_socket_into_fds(struct lws_context *context,
2146 lws_plat_service_periodic(struct lws_context *context);
2149 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2150 struct lws_pollfd *pfd);
2152 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2154 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2156 lws_plat_context_early_init(void);
2158 lws_plat_context_early_destroy(struct lws_context *context);
2160 lws_plat_context_late_destroy(struct lws_context *context);
2162 lws_poll_listen_fd(struct lws_pollfd *fd);
2164 lws_plat_service(struct lws_context *context, int timeout_ms);
2165 LWS_EXTERN LWS_VISIBLE int
2166 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2168 lws_plat_init(struct lws_context *context,
2169 struct lws_context_creation_info *info);
2171 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2172 LWS_EXTERN unsigned long long
2173 time_in_microseconds(void);
2174 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2175 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2176 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2177 lws_plat_inet_pton(int af, const char *src, void *dst);
2179 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2180 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2181 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2182 lws_filepos_t *amount);
2183 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2184 lws_filepos_t *amount);
2187 lws_same_vh_protocol_remove(struct lws *wsi);
2189 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2191 #if defined(LWS_WITH_STATS)
2193 lws_stats_atomic_bump(struct lws_context * context,
2194 struct lws_context_per_thread *pt, int index, uint64_t bump);
2196 lws_stats_atomic_max(struct lws_context * context,
2197 struct lws_context_per_thread *pt, int index, uint64_t val);
2199 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2200 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2201 (void)context; (void)pt; (void)index; (void)bump; return 0; }
2202 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2203 struct lws_context_per_thread *pt, int index, uint64_t val) {
2204 (void)context; (void)pt; (void)index; (void)val; return 0; }
2208 void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,