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
137 #if !defined(LWS_HAVE_ATOLL)
138 #if defined(LWS_HAVE__ATOI64)
139 #define atoll _atoi64
141 #warning No atoll or _atoi64 available, using atoi
147 #define __func__ __FUNCTION__
150 #ifdef LWS_HAVE__VSNPRINTF
151 #define vsnprintf _vsnprintf
154 /* we don't have an implementation for this on windows... */
155 int kill(int pid, int sig);
161 #else /* not windows --> */
166 #include <sys/types.h>
173 #ifdef LWS_WITH_ESP8266
175 #define vsnprintf ets_vsnprintf
176 #define snprintf ets_snprintf
177 #define sprintf ets_sprintf
179 int kill(int pid, int sig);
182 #include <sys/socket.h>
184 #ifdef LWS_WITH_HTTP_PROXY
185 #include <hubbub/hubbub.h>
186 #include <hubbub/parser.h>
188 #if defined(LWS_BUILTIN_GETIFADDRS)
189 #include <getifaddrs.h>
191 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
195 #if defined (__ANDROID__)
197 #include <sys/resource.h>
198 #elif defined (__sun)
201 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
202 #include <sys/syslog.h>
206 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
207 #include <sys/mman.h>
209 #include <netinet/in.h>
210 #include <netinet/tcp.h>
211 #include <arpa/inet.h>
220 #ifdef LWS_USE_LIBEVENT
221 #include <event2/event.h>
225 #ifdef LWS_HAVE_SYS_PRCTL_H
226 #include <sys/prctl.h>
230 #include <sys/time.h>
232 #define LWS_ERRNO errno
233 #define LWS_EAGAIN EAGAIN
234 #define LWS_EALREADY EALREADY
235 #define LWS_EINPROGRESS EINPROGRESS
236 #define LWS_EINTR EINTR
237 #define LWS_EISCONN EISCONN
238 #define LWS_EWOULDBLOCK EWOULDBLOCK
240 #define lws_set_blocking_send(wsi)
242 #if defined(LWS_WITH_ESP8266)
243 #define lws_socket_is_valid(x) ((x) != NULL)
244 #define LWS_SOCK_INVALID (NULL)
247 lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
249 #define lws_socket_is_valid(x) (x >= 0)
250 #define LWS_SOCK_INVALID (-1)
254 #ifndef LWS_HAVE_BZERO
256 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
260 #ifndef LWS_HAVE_STRERROR
261 #define strerror(x) ""
264 #ifdef LWS_OPENSSL_SUPPORT
267 #ifdef USE_OLD_CYASSL
268 #include <cyassl/openssl/ssl.h>
269 #include <cyassl/error-ssl.h>
271 #include <wolfssl/openssl/ssl.h>
272 #include <wolfssl/error-ssl.h>
273 #define OPENSSL_NO_TLSEXT
274 #endif /* not USE_OLD_CYASSL */
276 #include <openssl/ssl.h>
277 #if !defined(LWS_WITH_ESP32)
278 #include <openssl/evp.h>
279 #include <openssl/err.h>
280 #include <openssl/md5.h>
281 #include <openssl/sha.h>
282 #ifdef LWS_HAVE_OPENSSL_ECDH_H
283 #include <openssl/ecdh.h>
285 #include <openssl/x509v3.h>
287 #if (OPENSSL_VERSION_NUMBER < 0x0009080afL)
288 /* later openssl defines this to negate the presence of tlsext... but it was only
289 * introduced at 0.9.8j. Earlier versions don't know it exists so don't
290 * define it... making it look like the feature exists...
292 #define OPENSSL_NO_TLSEXT
294 #endif /* not USE_WOLFSSL */
297 #include "libwebsockets.h"
298 #if defined(WIN32) || defined(_WIN32)
300 static inline int compatible_close(int fd) { return close(fd); }
303 #if defined(WIN32) || defined(_WIN32)
304 #include <gettimeofday.h>
307 #if defined(LWS_WITH_ESP8266)
308 #undef compatible_close
309 #define compatible_close(fd) { fd->state=ESPCONN_CLOSE; espconn_delete(fd); }
311 esp8266_create_tcp_stream_socket(void);
313 esp8266_tcp_stream_bind(lws_sockfd_type fd, int port, struct lws *wsi);
315 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
317 #ifndef LITTLE_ENDIAN
318 #define LITTLE_ENDIAN 1234
321 #define BYTE_ORDER LITTLE_ENDIAN
326 #if defined(WIN32) || defined(_WIN32)
329 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
331 #ifndef LITTLE_ENDIAN
332 #define LITTLE_ENDIAN 1234
335 #define BYTE_ORDER LITTLE_ENDIAN
338 typedef unsigned __int64 u_int64_t;
344 #define __P(protos) protos
346 #define __P(protos) ()
352 #include <sys/stat.h>
353 #include <sys/time.h>
355 #if defined(__APPLE__)
356 #include <machine/endian.h>
357 #elif defined(__FreeBSD__)
358 #include <sys/endian.h>
359 #elif defined(__linux__)
368 #include <gulliver.h>
369 #if defined(__LITTLEENDIAN__)
370 #define BYTE_ORDER __LITTLEENDIAN__
371 #define LITTLE_ENDIAN __LITTLEENDIAN__
372 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
374 #if defined(__BIGENDIAN__)
375 #define BYTE_ORDER __BIGENDIAN__
376 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
377 #define BIG_ENDIAN __BIGENDIAN__
381 #if defined(__sun) && defined(__GNUC__)
383 #include <arpa/nameser_compat.h>
385 #if !defined (BYTE_ORDER)
386 # define BYTE_ORDER __BYTE_ORDER__
389 #if !defined(LITTLE_ENDIAN)
390 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
393 #if !defined(BIG_ENDIAN)
394 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
397 #endif /* sun + GNUC */
399 #if !defined(BYTE_ORDER)
400 # define BYTE_ORDER __BYTE_ORDER
402 #if !defined(LITTLE_ENDIAN)
403 # define LITTLE_ENDIAN __LITTLE_ENDIAN
405 #if !defined(BIG_ENDIAN)
406 # define BIG_ENDIAN __BIG_ENDIAN
412 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
413 * but happily have something equivalent in the SO_NOSIGPIPE flag.
416 #define MSG_NOSIGNAL SO_NOSIGPIPE
420 * Solaris 11.X only supports POSIX 2001, MSG_NOSIGNAL appears in
424 #define MSG_NOSIGNAL 0
428 #ifndef FD_HASHTABLE_MODULUS
429 #define FD_HASHTABLE_MODULUS 32
433 #ifndef LWS_DEF_HEADER_LEN
434 #define LWS_DEF_HEADER_LEN 4096
436 #ifndef LWS_DEF_HEADER_POOL
437 #define LWS_DEF_HEADER_POOL 4
439 #ifndef LWS_MAX_PROTOCOLS
440 #define LWS_MAX_PROTOCOLS 5
442 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
443 #define LWS_MAX_EXTENSIONS_ACTIVE 2
445 #ifndef LWS_MAX_EXT_OFFERS
446 #define LWS_MAX_EXT_OFFERS 8
448 #ifndef SPEC_LATEST_SUPPORTED
449 #define SPEC_LATEST_SUPPORTED 13
451 #ifndef AWAITING_TIMEOUT
452 #define AWAITING_TIMEOUT 20
454 #ifndef CIPHERS_LIST_STRING
455 #define CIPHERS_LIST_STRING "DEFAULT"
457 #ifndef LWS_SOMAXCONN
458 #define LWS_SOMAXCONN SOMAXCONN
461 #define MAX_WEBSOCKET_04_KEY_LEN 128
463 #ifndef SYSTEM_RANDOM_FILEPATH
464 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
467 enum lws_websocket_opcodes_07 {
468 LWSWSOPC_CONTINUATION = 0,
469 LWSWSOPC_TEXT_FRAME = 1,
470 LWSWSOPC_BINARY_FRAME = 2,
472 LWSWSOPC_NOSPEC__MUX = 7,
474 /* control extensions 8+ */
482 enum lws_connection_states {
484 LWSS_HTTP_ISSUING_FILE,
489 LWSS_CLIENT_HTTP_ESTABLISHED,
490 LWSS_CLIENT_UNCONNECTED,
491 LWSS_RETURNED_CLOSE_ALREADY,
492 LWSS_AWAITING_CLOSE_ACK,
493 LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
496 LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
497 LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
498 LWSS_HTTP2_ESTABLISHED,
509 enum http_connection_type {
510 HTTP_CONNECTION_CLOSE,
511 HTTP_CONNECTION_KEEP_ALIVE
514 enum lws_pending_protocol_send {
516 LWS_PPS_HTTP2_MY_SETTINGS,
517 LWS_PPS_HTTP2_ACK_SETTINGS,
521 enum lws_rx_parse_state {
528 LWS_RXPS_04_FRAME_HDR_1,
529 LWS_RXPS_04_FRAME_HDR_LEN,
530 LWS_RXPS_04_FRAME_HDR_LEN16_2,
531 LWS_RXPS_04_FRAME_HDR_LEN16_1,
532 LWS_RXPS_04_FRAME_HDR_LEN64_8,
533 LWS_RXPS_04_FRAME_HDR_LEN64_7,
534 LWS_RXPS_04_FRAME_HDR_LEN64_6,
535 LWS_RXPS_04_FRAME_HDR_LEN64_5,
536 LWS_RXPS_04_FRAME_HDR_LEN64_4,
537 LWS_RXPS_04_FRAME_HDR_LEN64_3,
538 LWS_RXPS_04_FRAME_HDR_LEN64_2,
539 LWS_RXPS_04_FRAME_HDR_LEN64_1,
541 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
542 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
543 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
544 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
546 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
549 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
551 enum connection_mode {
553 LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
554 LWSCM_PRE_WS_SERVING_ACCEPT,
561 /* transient, ssl delay hiding */
562 LWSCM_SSL_ACK_PENDING,
564 /* as above, but complete into LWSCM_RAW */
565 LWSCM_SSL_ACK_PENDING_RAW,
568 /* special internal types */
569 LWSCM_SERVER_LISTENER,
570 LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
571 LWSCM_RAW, /* raw with bulk handling */
572 LWSCM_RAW_FILEDESC, /* raw without bulk handling */
574 /* HTTP Client related */
575 LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
576 LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
577 LWSCM_WSCL_WAITING_CONNECT,
578 LWSCM_WSCL_WAITING_PROXY_REPLY,
579 LWSCM_WSCL_ISSUE_HANDSHAKE,
580 LWSCM_WSCL_ISSUE_HANDSHAKE2,
581 LWSCM_WSCL_ISSUE_HTTP_BODY,
582 LWSCM_WSCL_WAITING_SSL,
583 LWSCM_WSCL_WAITING_SERVER_REPLY,
584 LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
585 LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
586 LWSCM_WSCL_WAITING_SOCKS_GREETING_REPLY,
587 LWSCM_WSCL_WAITING_SOCKS_CONNECT_REPLY,
588 LWSCM_WSCL_WAITING_SOCKS_AUTH_REPLY,
590 /****** add new things just above ---^ ******/
595 /* enums of socks version */
601 /* enums of subnegotiation version */
602 enum socks_subnegotiation_version {
603 SOCKS_SUBNEGOTIATION_VERSION_1 = 1,
606 /* enums of socks commands */
608 SOCKS_COMMAND_CONNECT = 1,
609 SOCKS_COMMAND_BIND = 2,
610 SOCKS_COMMAND_UDP_ASSOCIATE = 3
613 /* enums of socks address type */
616 SOCKS_ATYP_DOMAINNAME = 3,
620 /* enums of socks authentication methods */
621 enum socks_auth_method {
622 SOCKS_AUTH_NO_AUTH = 0,
623 SOCKS_AUTH_GSSAPI = 1,
624 SOCKS_AUTH_USERNAME_PASSWORD = 2
627 /* enums of subnegotiation status */
628 enum socks_subnegotiation_status {
629 SOCKS_SUBNEGOTIATION_STATUS_SUCCESS = 0,
632 /* enums of socks request reply */
633 enum socks_request_reply {
634 SOCKS_REQUEST_REPLY_SUCCESS = 0,
635 SOCKS_REQUEST_REPLY_FAILURE_GENERAL = 1,
636 SOCKS_REQUEST_REPLY_CONNECTION_NOT_ALLOWED = 2,
637 SOCKS_REQUEST_REPLY_NETWORK_UNREACHABLE = 3,
638 SOCKS_REQUEST_REPLY_HOST_UNREACHABLE = 4,
639 SOCKS_REQUEST_REPLY_CONNECTION_REFUSED = 5,
640 SOCKS_REQUEST_REPLY_TTL_EXPIRED = 6,
641 SOCKS_REQUEST_REPLY_COMMAND_NOT_SUPPORTED = 7,
642 SOCKS_REQUEST_REPLY_ATYP_NOT_SUPPORTED = 8
645 /* enums used to generate socks messages */
646 enum socks_msg_type {
649 /* credential, user name and password */
650 SOCKS_MSG_USERNAME_PASSWORD,
651 /* connect command */
656 LWS_RXFLOW_ALLOW = (1 << 0),
657 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
660 /* this is not usable directly by user code any more, lws_close_reason() */
661 #define LWS_WRITE_CLOSE 4
663 struct lws_protocols;
666 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
668 struct lws_io_watcher {
673 uv_poll_t uv_watcher;
675 #ifdef LWS_USE_LIBEVENT
676 struct event *event_watcher;
678 struct lws_context *context;
681 struct lws_signal_watcher {
683 ev_signal ev_watcher;
686 uv_signal_t uv_watcher;
688 #ifdef LWS_USE_LIBEVENT
689 struct event *event_watcher;
691 struct lws_context *context;
696 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
697 struct lws_fd_hashtable {
704 * This is totally opaque to code using the library. It's exported as a
705 * forward-reference pointer-only declaration; the user can use the pointer with
706 * other APIs to get information out of it.
709 struct lws_fragments {
712 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
716 * these are assigned from a pool held in the context.
717 * Both client and server mode uses them for http header analysis
720 struct allocated_headers {
721 struct lws *wsi; /* owner */
722 char *data; /* prepared by context init to point to dedicated storage */
724 * the randomly ordered fragments, indexed by frag_index and
725 * lws_fragments->nfrag for continuation.
727 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
730 * for each recognized token, frag_index says which frag[] his data
731 * starts in (0 means the token did not appear)
732 * the actual header data gets dumped as it comes in, into data[]
734 unsigned char frag_index[WSI_TOKEN_COUNT];
735 unsigned char rx[2048];
741 unsigned int http_response;
743 #ifndef LWS_NO_CLIENT
744 char initial_handshake_hash_base64[30];
747 unsigned char in_use;
752 * so we can have n connections being serviced simultaneously,
753 * these things need to be isolated per-thread.
756 struct lws_context_per_thread {
758 pthread_mutex_t lock;
760 struct lws_pollfd *fds;
761 #if defined(LWS_WITH_ESP8266)
762 struct lws **lws_vs_fds_index;
764 struct lws *rx_draining_ext_list;
765 struct lws *tx_draining_ext_list;
766 struct lws *timeout_list;
767 #if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
768 struct lws_context *context;
771 struct lws_cgi *cgi_list;
773 void *http_header_data;
774 struct allocated_headers *ah_pool;
775 struct lws *ah_wait_list;
776 int ah_wait_list_length;
777 #ifdef LWS_OPENSSL_SUPPORT
778 struct lws *pending_read_list; /* linked list */
780 #if defined(LWS_USE_LIBEV)
781 struct ev_loop *io_loop_ev;
783 #if defined(LWS_USE_LIBUV)
784 uv_loop_t *io_loop_uv;
785 uv_signal_t signals[8];
786 uv_timer_t uv_timeout_watcher;
789 #if defined(LWS_USE_LIBEVENT)
790 struct event_base *io_loop_event_base;
792 #if defined(LWS_USE_LIBEV)
793 struct lws_io_watcher w_accept;
795 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
796 struct lws_signal_watcher w_sigint;
797 unsigned char ev_loop_foreign:1;
800 unsigned long count_conns;
802 * usable by anything in the service code, but only if the scope
803 * does not last longer than the service action (since next service
804 * of any socket can likewise use it and overwrite)
806 unsigned char *serv_buf;
810 lws_sockfd_type dummy_pipe_fds[2];
812 unsigned int fds_count;
814 short ah_count_in_use;
816 unsigned char lock_depth;
819 struct lws_conn_stats {
820 unsigned long long rx, tx;
821 unsigned long conn, trans, ws_upg, http2_upg, rejected;
825 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
828 * virtual host -related context information
829 * vhostwide SSL context
834 * context -> vhost -> wsi
836 * incoming connection non-SSL vhost binding:
838 * listen socket -> wsi -> select vhost after first headers
840 * incoming connection SSL vhost binding:
842 * SSL SNI -> wsi -> bind after SSL negotiation
846 #if !defined(LWS_WITH_ESP8266)
847 char http_proxy_address[128];
848 char proxy_basic_auth_token[128];
849 #if defined(LWS_WITH_SOCKS5)
850 char socks_proxy_address[128];
852 char socks_password[96];
855 #if defined(LWS_WITH_ESP8266)
856 /* listen sockets need a place to hang their hat */
859 struct lws_conn_stats conn_stats;
860 struct lws_context *context;
861 struct lws_vhost *vhost_next;
862 const struct lws_http_mount *mount_list;
863 struct lws *lserv_wsi;
866 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32) && !defined(OPTEE_TA) && !defined(WIN32)
869 const struct lws_protocols *protocols;
870 void **protocol_vh_privs;
871 const struct lws_protocol_vhost_options *pvo;
872 const struct lws_protocol_vhost_options *headers;
873 struct lws **same_vh_protocol_list;
874 #ifdef LWS_OPENSSL_SUPPORT
876 SSL_CTX *ssl_client_ctx;
878 #ifndef LWS_NO_EXTENSIONS
879 const struct lws_extension *extensions;
883 unsigned int http_proxy_port;
884 #if defined(LWS_WITH_SOCKS5)
885 unsigned int socks_proxy_port;
887 unsigned int options;
892 int keepalive_timeout;
893 int ssl_info_event_mask;
894 #ifdef LWS_WITH_ACCESS_LOG
898 #ifdef LWS_OPENSSL_SUPPORT
900 int allow_non_ssl_on_ssl_port;
901 unsigned int user_supplied_ssl_ctx:1;
904 unsigned int created_vhost_protocols:1;
906 unsigned char default_protocol_index;
907 unsigned char raw_protocol_index;
911 * the rest is managed per-context, that includes
913 * - processwide single fd -> wsi lookup
914 * - contextwide headers pool
918 time_t last_timeout_check_s;
919 time_t last_ws_ping_pong_check_s;
921 const struct lws_plat_file_ops *fops;
922 struct lws_plat_file_ops fops_platform;
923 #if defined(LWS_WITH_ZIP_FOPS)
924 struct lws_plat_file_ops fops_zip;
926 struct lws_context_per_thread pt[LWS_MAX_SMP];
927 struct lws_conn_stats conn_stats;
929 /* different implementation between unix and windows */
930 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
932 #if defined(LWS_WITH_ESP8266)
933 struct espconn **connpool; /* .reverse points to the wsi */
938 struct lws **lws_lookup; /* fd to wsi */
941 struct lws_vhost *vhost_list;
942 struct lws_plugin *plugin_list;
944 void *external_baggage_free_on_destroy;
945 const struct lws_token_limits *token_limits;
947 const char *server_string;
948 const struct lws_protocol_vhost_options *reject_service_keywords;
949 lws_reload_func deprecation_cb;
951 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
956 #if defined(LWS_USE_LIBEV)
957 lws_ev_signal_cb_t * lws_ev_sigint_cb;
959 #if defined(LWS_USE_LIBUV)
960 uv_signal_cb lws_uv_sigint_cb;
962 #if defined(LWS_USE_LIBEVENT)
963 lws_event_signal_cb_t * lws_event_sigint_cb;
965 char canonical_hostname[128];
967 unsigned long worst_latency;
968 char worst_latency_info[256];
971 #if defined(LWS_WITH_STATS)
972 uint64_t lws_stats[LWSSTATS_SIZE];
978 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
981 int started_with_parent;
985 #ifdef LWS_OPENSSL_SUPPORT
986 #define lws_ssl_anybody_has_buffered_read(w) \
987 (w->vhost->use_ssl && \
988 w->context->pt[(int)w->tsi].pending_read_list)
989 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
990 (/*c->use_ssl && */ \
991 c->pt[(int)t].pending_read_list)
993 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
994 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
996 int count_wsi_allocated;
997 int count_cgi_spawned;
998 unsigned int options;
999 unsigned int fd_limit_per_thread;
1000 unsigned int timeout_secs;
1001 unsigned int pt_serv_buf_size;
1002 int max_http_header_data;
1003 int simultaneous_ssl_restriction;
1004 int simultaneous_ssl;
1006 unsigned int deprecated:1;
1007 unsigned int being_destroyed:1;
1008 unsigned int being_destroyed1:1;
1009 unsigned int requested_kill:1;
1010 unsigned int protocol_init_done:1;
1011 unsigned int ssl_gate_accepts:1;
1013 * set to the Thread ID that's doing the service loop just before entry
1014 * to poll indicates service thread likely idling in poll()
1015 * volatile because other threads may check it as part of processing
1016 * for pollfd event change.
1018 volatile int service_tid;
1019 int service_tid_detected;
1021 short max_http_header_pool;
1022 short count_threads;
1023 short plugin_protocol_count;
1024 short plugin_extension_count;
1025 short server_string_len;
1026 unsigned short ws_ping_pong_interval;
1027 unsigned short deprecation_pending_listen_close_count;
1031 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
1032 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
1035 lws_close_free_wsi_final(struct lws *wsi);
1037 lws_libuv_closehandle(struct lws *wsi);
1039 lws_libuv_closehandle_manually(struct lws *wsi);
1041 lws_libuv_check_watcher_active(struct lws *wsi);
1043 LWS_VISIBLE LWS_EXTERN int
1044 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
1046 LWS_VISIBLE LWS_EXTERN int
1047 lws_plat_plugins_destroy(struct lws_context * context);
1050 lws_restart_ws_ping_pong_timer(struct lws *wsi);
1053 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
1057 LWS_EV_READ = (1 << 0),
1058 LWS_EV_WRITE = (1 << 1),
1059 LWS_EV_START = (1 << 2),
1060 LWS_EV_STOP = (1 << 3),
1062 LWS_EV_PREPARE_DELETION = (1 << 31),
1065 #if defined(LWS_USE_LIBEV)
1067 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1069 lws_libev_io(struct lws *wsi, int flags);
1071 lws_libev_init_fd_table(struct lws_context *context);
1073 lws_libev_destroyloop(struct lws_context *context, int tsi);
1075 lws_libev_run(const struct lws_context *context, int tsi);
1076 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
1077 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
1079 #define lws_libev_accept(_a, _b) ((void) 0)
1080 #define lws_libev_io(_a, _b) ((void) 0)
1081 #define lws_libev_init_fd_table(_a) (0)
1082 #define lws_libev_run(_a, _b) ((void) 0)
1083 #define lws_libev_destroyloop(_a, _b) ((void) 0)
1084 #define LWS_LIBEV_ENABLED(context) (0)
1085 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1086 #define lws_feature_status_libev(_a) \
1087 lwsl_notice("libev support not compiled in\n")
1089 #define lws_feature_status_libev(_a)
1093 #if defined(LWS_USE_LIBUV)
1095 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1097 lws_libuv_io(struct lws *wsi, int flags);
1099 lws_libuv_init_fd_table(struct lws_context *context);
1101 lws_libuv_run(const struct lws_context *context, int tsi);
1103 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1105 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1106 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1107 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1109 #define lws_libuv_accept(_a, _b) ((void) 0)
1110 #define lws_libuv_io(_a, _b) ((void) 0)
1111 #define lws_libuv_init_fd_table(_a) (0)
1112 #define lws_libuv_run(_a, _b) ((void) 0)
1113 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1114 #define LWS_LIBUV_ENABLED(context) (0)
1115 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1116 #define lws_feature_status_libuv(_a) \
1117 lwsl_notice("libuv support not compiled in\n")
1119 #define lws_feature_status_libuv(_a)
1123 #if defined(LWS_USE_LIBEVENT)
1125 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1127 lws_libevent_io(struct lws *wsi, int flags);
1129 lws_libevent_init_fd_table(struct lws_context *context);
1131 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1133 lws_libevent_run(const struct lws_context *context, int tsi);
1134 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1135 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1137 #define lws_libevent_accept(_a, _b) ((void) 0)
1138 #define lws_libevent_io(_a, _b) ((void) 0)
1139 #define lws_libevent_init_fd_table(_a) (0)
1140 #define lws_libevent_run(_a, _b) ((void) 0)
1141 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1142 #define LWS_LIBEVENT_ENABLED(context) (0)
1143 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1144 #define lws_feature_status_libevent(_a) \
1145 lwsl_notice("libevent support not compiled in\n")
1147 #define lws_feature_status_libevent(_a)
1153 #define LWS_IPV6_ENABLED(vh) \
1154 (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1155 !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1157 #define LWS_IPV6_ENABLED(context) (0)
1160 #ifdef LWS_USE_UNIX_SOCK
1161 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1162 (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1164 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1169 struct sockaddr_in6 sa6;
1171 struct sockaddr_in sa4;
1174 enum uri_path_states {
1177 URIPS_SEEN_SLASH_DOT,
1178 URIPS_SEEN_SLASH_DOT_DOT,
1181 enum uri_esc_states {
1184 URIES_SEEN_PERCENT_H1,
1187 /* notice that these union members:
1193 * all have a pointer to allocated_headers struct as their first member.
1195 * It means for allocated_headers access, the three union paths can all be
1196 * used interchangeably to access the same data
1200 #ifndef LWS_NO_CLIENT
1201 struct client_info_stash {
1212 struct _lws_header_related {
1213 /* MUST be first in struct */
1214 struct allocated_headers *ah;
1215 struct lws *ah_wait_list;
1216 unsigned char *preamble_rx;
1217 #ifndef LWS_NO_CLIENT
1218 struct client_info_stash *stash;
1220 unsigned int preamble_rx_len;
1221 enum uri_path_states ups;
1222 enum uri_esc_states ues;
1224 unsigned int current_token_limit;
1227 char post_literal_equal;
1228 unsigned char parser_state; /* enum lws_token_indexes */
1231 #if defined(LWS_WITH_RANGES)
1233 LWSRS_NO_ACTIVE_RANGE,
1242 struct lws_range_parsing {
1243 unsigned long long start, end, extent, agg, budget;
1244 const char buf[128];
1246 enum range_states state;
1247 char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1251 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1253 lws_ranges_next(struct lws_range_parsing *rp);
1255 lws_ranges_reset(struct lws_range_parsing *rp);
1258 struct _lws_http_mode_related {
1259 /* MUST be first in struct */
1260 struct allocated_headers *ah; /* mirroring _lws_header_related */
1261 struct lws *ah_wait_list;
1262 unsigned char *preamble_rx;
1263 #ifndef LWS_NO_CLIENT
1264 struct client_info_stash *stash;
1266 unsigned int preamble_rx_len;
1267 struct lws *new_wsi_list;
1268 lws_filepos_t filepos;
1269 lws_filepos_t filelen;
1270 lws_fop_fd_t fop_fd;
1272 #if defined(LWS_WITH_RANGES)
1273 struct lws_range_parsing range;
1274 char multipart_content_type[64];
1277 enum http_version request_version;
1278 enum http_connection_type connection_type;
1279 lws_filepos_t content_length;
1280 lws_filepos_t content_remain;
1283 #ifdef LWS_USE_HTTP2
1285 enum lws_http2_settings {
1286 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1287 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1288 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1289 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1290 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1291 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1293 LWS_HTTP2_SETTINGS__COUNT /* always last */
1296 enum lws_http2_wellknown_frame_types {
1297 LWS_HTTP2_FRAME_TYPE_DATA,
1298 LWS_HTTP2_FRAME_TYPE_HEADERS,
1299 LWS_HTTP2_FRAME_TYPE_PRIORITY,
1300 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1301 LWS_HTTP2_FRAME_TYPE_SETTINGS,
1302 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1303 LWS_HTTP2_FRAME_TYPE_PING,
1304 LWS_HTTP2_FRAME_TYPE_GOAWAY,
1305 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1306 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1308 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1311 enum lws_http2_flags {
1312 LWS_HTTP2_FLAG_END_STREAM = 1,
1313 LWS_HTTP2_FLAG_END_HEADERS = 4,
1314 LWS_HTTP2_FLAG_PADDED = 8,
1315 LWS_HTTP2_FLAG_PRIORITY = 0x20,
1317 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1320 #define LWS_HTTP2_STREAM_ID_MASTER 0
1321 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1322 #define LWS_HTTP2_SETTINGS_LENGTH 6
1324 struct http2_settings {
1325 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1328 enum http2_hpack_state {
1330 /* optional before first header block */
1332 HKPS_OPT_E_DEPENDENCY,
1345 /* optional after last header block */
1346 HKPS_OPT_DISCARD_PADDING,
1349 enum http2_hpack_type {
1351 HPKT_INDEXED_HDR_6_VALUE_INCR,
1352 HPKT_LITERAL_HDR_VALUE_INCR,
1353 HPKT_INDEXED_HDR_4_VALUE,
1354 HPKT_LITERAL_HDR_VALUE,
1358 struct hpack_dt_entry {
1359 int token; /* additions that don't map to a token are ignored */
1364 struct hpack_dynamic_table {
1365 struct hpack_dt_entry *entries;
1373 struct _lws_http2_related {
1375 * having this first lets us also re-use all HTTP union code
1376 * and in turn, http_mode_related has allocated headers in right
1377 * place so we can use the header apis on the wsi directly still
1379 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1381 struct http2_settings my_settings;
1382 struct http2_settings peer_settings;
1384 struct lws *parent_wsi;
1385 struct lws *next_child_wsi;
1387 struct hpack_dynamic_table *hpack_dyn_table;
1388 struct lws *stream_wsi;
1389 unsigned char ping_payload[8];
1390 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1393 unsigned int length;
1394 unsigned int stream_id;
1395 enum http2_hpack_state hpack;
1396 enum http2_hpack_type hpack_type;
1397 unsigned int header_index;
1398 unsigned int hpack_len;
1399 unsigned int hpack_e_dep;
1401 unsigned int my_stream_id;
1402 unsigned int child_count;
1405 unsigned int END_STREAM:1;
1406 unsigned int END_HEADERS:1;
1407 unsigned int send_END_STREAM:1;
1408 unsigned int GOING_AWAY;
1409 unsigned int requested_POLLOUT:1;
1410 unsigned int waiting_tx_credit:1;
1411 unsigned int huff:1;
1412 unsigned int value:1;
1414 unsigned short round_robin_POLLOUT;
1415 unsigned short count_POLLOUT_children;
1416 unsigned short hpack_pos;
1419 unsigned char flags;
1420 unsigned char frame_state;
1421 unsigned char padding;
1422 unsigned char hpack_m;
1423 unsigned char initialized;
1426 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1430 struct _lws_websocket_related {
1431 /* cheapest way to deal with ah overlap with ws union transition */
1432 struct _lws_header_related hdr;
1434 unsigned int rx_ubuf_alloc;
1435 struct lws *rx_draining_ext_list;
1436 struct lws *tx_draining_ext_list;
1437 time_t time_next_ping_check;
1438 size_t rx_packet_length;
1439 unsigned int rx_ubuf_head;
1440 unsigned char mask[4];
1441 /* Also used for close content... control opcode == < 128 */
1442 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1444 unsigned char ping_payload_len;
1445 unsigned char mask_idx;
1446 unsigned char opcode;
1448 unsigned char rsv_first_msg;
1449 /* zero if no info, or length including 2-byte close code */
1450 unsigned char close_in_ping_buffer_len;
1452 unsigned char stashed_write_type;
1453 unsigned char tx_draining_stashed_wp;
1455 unsigned int final:1;
1456 unsigned int frame_is_binary:1;
1457 unsigned int all_zero_nonce:1;
1458 unsigned int this_frame_masked:1;
1459 unsigned int inside_frame:1; /* next write will be more of frame */
1460 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1461 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1462 unsigned int ping_pending_flag:1;
1463 unsigned int continuation_possible:1;
1464 unsigned int owed_a_fin:1;
1465 unsigned int check_utf8:1;
1466 unsigned int defeat_check_utf8:1;
1467 unsigned int pmce_compressed_message:1;
1468 unsigned int stashed_write_pending:1;
1469 unsigned int rx_draining_ext:1;
1470 unsigned int tx_draining_ext:1;
1471 unsigned int send_check_ping:1;
1477 SIGNIFICANT_HDR_CONTENT_LENGTH,
1478 SIGNIFICANT_HDR_LOCATION,
1479 SIGNIFICANT_HDR_STATUS,
1480 SIGNIFICANT_HDR_TRANSFER_ENCODING,
1482 SIGNIFICANT_HDR_COUNT
1485 /* wsi who is master of the cgi points to an lws_cgi */
1488 struct lws_cgi *cgi_list;
1489 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1490 struct lws *wsi; /* owner */
1491 unsigned char *headers_buf;
1492 unsigned char *headers_pos;
1493 unsigned char *headers_dumped;
1494 unsigned char *headers_end;
1495 lws_filepos_t content_length;
1496 lws_filepos_t content_length_seen;
1498 int match[SIGNIFICANT_HDR_COUNT];
1504 unsigned int being_closed:1;
1505 unsigned int explicitly_chunked:1;
1507 unsigned char chunked_grace;
1511 signed char char_to_hex(const char c);
1513 #ifndef LWS_NO_CLIENT
1514 enum lws_chunk_parser {
1525 #ifdef LWS_WITH_ACCESS_LOG
1526 struct lws_access_log {
1537 /* members with mutually exclusive lifetimes are unionized */
1540 struct _lws_http_mode_related http;
1541 #ifdef LWS_USE_HTTP2
1542 struct _lws_http2_related http2;
1544 struct _lws_header_related hdr;
1545 struct _lws_websocket_related ws;
1548 /* lifetime members */
1550 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1551 struct lws_io_watcher w_read;
1553 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1554 struct lws_io_watcher w_write;
1556 time_t pending_timeout_limit;
1560 struct lws_context *context;
1561 struct lws_vhost *vhost;
1562 struct lws *parent; /* points to parent, if any */
1563 struct lws *child_list; /* points to first child */
1564 struct lws *sibling_list; /* subsequent children at same level */
1566 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1568 const struct lws_protocols *protocol;
1569 struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1570 struct lws *timeout_list;
1571 struct lws **timeout_list_prev;
1572 #ifdef LWS_WITH_ACCESS_LOG
1573 struct lws_access_log access_log;
1576 /* rxflow handling */
1577 unsigned char *rxflow_buffer;
1578 /* truncated send handling */
1579 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1581 #if defined (LWS_WITH_ESP8266)
1583 unsigned short prem_rx_size, prem_rx_pos;
1586 #ifndef LWS_NO_EXTENSIONS
1587 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1588 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1590 #ifdef LWS_OPENSSL_SUPPORT
1593 struct lws *pending_read_list_prev, *pending_read_list_next;
1594 #if defined(LWS_WITH_STATS)
1595 uint64_t accept_start_us;
1599 #ifdef LWS_WITH_HTTP_PROXY
1600 struct lws_rewrite *rw;
1603 unsigned long action_start;
1604 unsigned long latency_start;
1606 lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1607 #if defined(LWS_WITH_STATS)
1608 uint64_t active_writable_req_us;
1611 int position_in_fds_table;
1614 unsigned int trunc_alloc_len; /* size of malloc */
1615 unsigned int trunc_offset; /* where we are in terms of spilling */
1616 unsigned int trunc_len; /* how much is buffered */
1617 #ifndef LWS_NO_CLIENT
1618 int chunk_remaining;
1620 unsigned int cache_secs;
1622 unsigned int hdr_parsing_completed:1;
1623 unsigned int http2_substream:1;
1624 unsigned int listener:1;
1625 unsigned int user_space_externally_allocated:1;
1626 unsigned int socket_is_permanently_unusable:1;
1627 unsigned int rxflow_change_to:2;
1628 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1629 unsigned int conn_stat_done:1;
1630 unsigned int cache_reuse:1;
1631 unsigned int cache_revalidate:1;
1632 unsigned int cache_intermediaries:1;
1633 unsigned int favoured_pollin:1;
1634 unsigned int sending_chunked:1;
1635 unsigned int already_did_cce:1;
1636 unsigned int told_user_closed:1;
1637 unsigned int ipv6:1;
1639 #if defined(LWS_WITH_ESP8266)
1640 unsigned int pending_send_completion:3;
1641 unsigned int close_is_pending_send_completion:1;
1643 #ifdef LWS_WITH_ACCESS_LOG
1644 unsigned int access_log_pending:1;
1646 #ifndef LWS_NO_CLIENT
1647 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1648 unsigned int chunked:1; /* if the clientside connection is chunked */
1649 unsigned int client_rx_avail:1;
1650 unsigned int client_http_body_pending:1;
1652 #ifdef LWS_WITH_HTTP_PROXY
1653 unsigned int perform_rewrite:1;
1655 #ifndef LWS_NO_EXTENSIONS
1656 unsigned int extension_data_pending:1;
1658 #ifdef LWS_OPENSSL_SUPPORT
1659 unsigned int use_ssl:4;
1662 unsigned int sock_send_blocking:1;
1664 #ifdef LWS_OPENSSL_SUPPORT
1665 unsigned int redirect_to_https:1;
1668 /* volatile to make sure code is aware other thread can change */
1669 volatile unsigned int handling_pollout:1;
1670 volatile unsigned int leave_pollout_active:1;
1672 #ifndef LWS_NO_CLIENT
1673 unsigned short c_port;
1677 #ifndef LWS_NO_EXTENSIONS
1678 unsigned char count_act_ext;
1680 unsigned char ietf_spec_revision;
1681 char mode; /* enum connection_mode */
1682 char state; /* enum lws_connection_states */
1683 char state_pre_close;
1684 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1685 char rx_frame_type; /* enum lws_write_protocol */
1686 char pending_timeout; /* enum pending_timeout */
1687 char pps; /* enum lws_pending_protocol_send */
1688 char tsi; /* thread service index we belong to */
1689 char protocol_interpret_idx;
1692 char cgi_channel; /* which of stdin/out/err */
1695 #ifndef LWS_NO_CLIENT
1696 char chunk_parser; /* enum lws_chunk_parser */
1698 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1699 char reason_bf; /* internal writeable callback reason bitfield */
1703 LWS_EXTERN int log_level;
1706 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1709 #if defined(LWS_USE_IPV6)
1710 LWS_EXTERN unsigned long
1711 lws_get_addr_scope(const char *ipaddr);
1715 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1718 remove_wsi_socket_from_fds(struct lws *wsi);
1720 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1724 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1725 int ret, int completion) {
1727 (void)context; (void)wsi; (void)action; (void)ret;
1732 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1733 do { (void)context; (void)wsi; } while (0);
1736 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1738 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1739 int ret, int completion);
1743 lws_set_protocol_write_pending(struct lws *wsi,
1744 enum lws_pending_protocol_send pend);
1745 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1746 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1748 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1749 lws_parse(struct lws *wsi, unsigned char c);
1751 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1752 lws_http_action(struct lws *wsi);
1755 lws_b64_selftest(void);
1758 lws_service_flag_pending(struct lws_context *context, int tsi);
1760 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1761 LWS_EXTERN struct lws *
1762 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1765 insert_wsi(struct lws_context *context, struct lws *wsi);
1768 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1770 #define wsi_from_fd(A,B) A->lws_lookup[B]
1771 #define insert_wsi(A,B) assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1772 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1775 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1776 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1778 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1779 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1782 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1783 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1786 lws_remove_from_timeout_list(struct lws *wsi);
1788 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1789 lws_client_connect_2(struct lws *wsi);
1791 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1792 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1793 const char *path, const char *host);
1795 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1796 lws_create_new_server_wsi(struct lws_vhost *vhost);
1798 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1799 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1802 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1804 LWS_EXTERN struct lws *
1805 lws_client_connect_via_info2(struct lws *wsi);
1811 #ifndef LWS_NO_EXTENSIONS
1813 lws_context_init_extensions(struct lws_context_creation_info *info,
1814 struct lws_context *context);
1816 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1817 void *v, size_t len);
1820 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1822 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1823 void *arg, int len);
1826 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1827 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1828 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1829 #define lws_issue_raw_ext_access lws_issue_raw
1830 #define lws_context_init_extensions(_a, _b)
1833 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1834 lws_client_interpret_server_handshake(struct lws *wsi);
1836 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1837 lws_rx_sm(struct lws *wsi, unsigned char c);
1840 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1842 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1843 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1846 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1848 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1849 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1850 enum lws_callback_reasons reason, void *user,
1851 void *in, size_t len);
1852 #ifdef LWS_USE_HTTP2
1853 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1854 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1856 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1857 unsigned char *buf, int len);
1858 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1860 lws_http2_parser(struct lws *wsi, unsigned char c);
1861 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1863 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1864 unsigned int sid, unsigned int len,
1865 unsigned char *buf);
1866 LWS_EXTERN struct lws *
1867 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1868 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1871 lws_add_http2_header_by_name(struct lws *wsi,
1872 const unsigned char *name,
1873 const unsigned char *value, int length,
1874 unsigned char **p, unsigned char *end);
1876 lws_add_http2_header_by_token(struct lws *wsi,
1877 enum lws_token_indexes token,
1878 const unsigned char *value, int length,
1879 unsigned char **p, unsigned char *end);
1881 lws_add_http2_header_status(struct lws *wsi,
1882 unsigned int code, unsigned char **p,
1883 unsigned char *end);
1885 void lws_http2_configure_if_upgraded(struct lws *wsi);
1887 #define lws_http2_configure_if_upgraded(x)
1891 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1894 lws_plat_check_connection_error(struct lws *wsi);
1896 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1897 lws_header_table_attach(struct lws *wsi, int autoservice);
1900 lws_header_table_detach(struct lws *wsi, int autoservice);
1903 lws_header_table_reset(struct lws *wsi, int autoservice);
1905 _lws_header_table_reset(struct allocated_headers *ah);
1907 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1908 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1910 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1911 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1913 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1914 lws_ensure_user_space(struct lws *wsi);
1917 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1919 #ifndef LWS_NO_SERVER
1920 int lws_context_init_server(struct lws_context_creation_info *info,
1921 struct lws_vhost *vhost);
1922 LWS_EXTERN struct lws_vhost *
1923 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1925 handshake_0405(struct lws_context *context, struct lws *wsi);
1926 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1927 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1929 lws_server_get_canonical_hostname(struct lws_context *context,
1930 struct lws_context_creation_info *info);
1932 #define lws_context_init_server(_a, _b) (0)
1933 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1934 #define lws_server_get_canonical_hostname(_a, _b)
1937 #ifndef LWS_NO_DAEMONIZE
1938 LWS_EXTERN int get_daemonize_pid();
1940 #define get_daemonize_pid() (0)
1943 #if !defined(LWS_WITH_ESP8266)
1944 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1945 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1946 struct sockaddr_in *addr, size_t addrlen);
1948 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1950 enum lws_ssl_capable_status {
1951 LWS_SSL_CAPABLE_ERROR = -1,
1952 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1955 #ifndef LWS_OPENSSL_SUPPORT
1956 #define LWS_SSL_ENABLED(context) (0)
1957 #define lws_context_init_server_ssl(_a, _b) (0)
1958 #define lws_ssl_destroy(_a)
1959 #define lws_context_init_http2_ssl(_a)
1960 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1961 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1962 #define lws_ssl_pending lws_ssl_pending_no_ssl
1963 #define lws_server_socket_service_ssl(_b, _c) (0)
1964 #define lws_ssl_close(_a) (0)
1965 #define lws_ssl_context_destroy(_a)
1966 #define lws_ssl_SSL_CTX_destroy(_a)
1967 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1968 #define lws_context_init_ssl_library(_a)
1970 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1971 LWS_EXTERN int openssl_websocket_private_data_index;
1972 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1973 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1974 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1975 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1976 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1977 lws_ssl_pending(struct lws *wsi);
1979 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1980 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1981 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1983 lws_ssl_close(struct lws *wsi);
1985 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1987 lws_ssl_context_destroy(struct lws_context *context);
1989 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1991 lws_ssl_client_bio_create(struct lws *wsi);
1993 lws_ssl_client_connect1(struct lws *wsi);
1995 lws_ssl_client_connect2(struct lws *wsi);
1997 lws_ssl_elaborate_error(void);
1998 #ifndef LWS_NO_SERVER
2000 lws_context_init_server_ssl(struct lws_context_creation_info *info,
2001 struct lws_vhost *vhost);
2003 #define lws_context_init_server_ssl(_a, _b) (0)
2006 lws_ssl_destroy(struct lws_vhost *vhost);
2009 #ifdef LWS_USE_HTTP2
2011 lws_context_init_http2_ssl(struct lws_vhost *vhost);
2013 #define lws_context_init_http2_ssl(_a)
2018 static LWS_INLINE void
2019 lws_pt_mutex_init(struct lws_context_per_thread *pt)
2021 pthread_mutex_init(&pt->lock, NULL);
2024 static LWS_INLINE void
2025 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
2027 pthread_mutex_destroy(&pt->lock);
2030 static LWS_INLINE void
2031 lws_pt_lock(struct lws_context_per_thread *pt)
2033 if (!pt->lock_depth++)
2034 pthread_mutex_lock(&pt->lock);
2037 static LWS_INLINE void
2038 lws_pt_unlock(struct lws_context_per_thread *pt)
2040 if (!(--pt->lock_depth))
2041 pthread_mutex_unlock(&pt->lock);
2044 #define lws_pt_mutex_init(_a) (void)(_a)
2045 #define lws_pt_mutex_destroy(_a) (void)(_a)
2046 #define lws_pt_lock(_a) (void)(_a)
2047 #define lws_pt_unlock(_a) (void)(_a)
2050 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2051 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2053 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2054 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2056 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2057 lws_ssl_pending_no_ssl(struct lws *wsi);
2059 #ifdef LWS_WITH_HTTP_PROXY
2060 struct lws_rewrite {
2061 hubbub_parser *parser;
2062 hubbub_parser_optparams params;
2063 const char *from, *to;
2064 int from_len, to_len;
2065 unsigned char *p, *end;
2068 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
2073 return strncmp((const char *)s->ptr, p, len);
2075 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
2076 LWS_EXTERN struct lws_rewrite *
2077 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
2079 lws_rewrite_destroy(struct lws_rewrite *r);
2081 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
2084 #ifndef LWS_NO_CLIENT
2085 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
2087 struct lws_pollfd *pollfd);
2088 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2089 lws_http_transaction_completed_client(struct lws *wsi);
2090 #ifdef LWS_OPENSSL_SUPPORT
2092 lws_context_init_client_ssl(struct lws_context_creation_info *info,
2093 struct lws_vhost *vhost);
2096 lws_ssl_info_callback(const SSL *ssl, int where, int ret);
2099 #define lws_context_init_client_ssl(_a, _b) (0)
2101 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2102 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
2104 lws_decode_ssl_error(void);
2106 #define lws_context_init_client_ssl(_a, _b) (0)
2107 #define lws_handshake_client(_a, _b, _c) (0)
2111 _lws_rx_flow_control(struct lws *wsi);
2114 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
2116 #ifndef LWS_NO_SERVER
2118 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
2119 struct lws_pollfd *pollfd);
2121 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
2123 #define lws_server_socket_service(_a, _b, _c) (0)
2124 #define lws_handshake_server(_a, _b, _c) (0)
2127 #ifdef LWS_WITH_ACCESS_LOG
2129 lws_access_log(struct lws *wsi);
2131 #define lws_access_log(_a)
2135 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2138 lws_protocol_init(struct lws_context *context);
2141 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2143 const struct lws_http_mount *
2144 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2150 lws_realloc(void *ptr, size_t size);
2152 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2153 lws_zalloc(size_t size);
2155 #ifdef LWS_PLAT_OPTEE
2156 void *lws_malloc(size_t size);
2157 void lws_free(void *p);
2158 #define lws_free_set_NULL(P) do { lws_free(P); (P) = NULL; } while(0)
2160 #define lws_malloc(S) lws_realloc(NULL, S)
2161 #define lws_free(P) lws_realloc(P, 0)
2162 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
2165 const struct lws_plat_file_ops *
2166 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2167 const char **vpath);
2171 lws_plat_delete_socket_from_fds(struct lws_context *context,
2172 struct lws *wsi, int m);
2174 lws_plat_insert_socket_into_fds(struct lws_context *context,
2177 lws_plat_service_periodic(struct lws_context *context);
2180 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2181 struct lws_pollfd *pfd);
2183 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2185 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2187 lws_plat_context_early_init(void);
2189 lws_plat_context_early_destroy(struct lws_context *context);
2191 lws_plat_context_late_destroy(struct lws_context *context);
2193 lws_poll_listen_fd(struct lws_pollfd *fd);
2195 lws_plat_service(struct lws_context *context, int timeout_ms);
2196 LWS_EXTERN LWS_VISIBLE int
2197 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2199 lws_plat_init(struct lws_context *context,
2200 struct lws_context_creation_info *info);
2202 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2203 LWS_EXTERN unsigned long long
2204 time_in_microseconds(void);
2205 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2206 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2207 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2208 lws_plat_inet_pton(int af, const char *src, void *dst);
2210 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2211 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2212 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2213 lws_filepos_t *amount);
2214 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2215 lws_filepos_t *amount);
2218 lws_same_vh_protocol_remove(struct lws *wsi);
2220 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2222 #if defined(LWS_WITH_STATS)
2224 lws_stats_atomic_bump(struct lws_context * context,
2225 struct lws_context_per_thread *pt, int index, uint64_t bump);
2227 lws_stats_atomic_max(struct lws_context * context,
2228 struct lws_context_per_thread *pt, int index, uint64_t val);
2230 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2231 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2232 (void)context; (void)pt; (void)index; (void)bump; return 0; }
2233 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2234 struct lws_context_per_thread *pt, int index, uint64_t val) {
2235 (void)context; (void)pt; (void)index; (void)val; return 0; }
2239 void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,