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,
578 /****** add new things just above ---^ ******/
584 LWS_RXFLOW_ALLOW = (1 << 0),
585 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
588 /* this is not usable directly by user code any more, lws_close_reason() */
589 #define LWS_WRITE_CLOSE 4
591 struct lws_protocols;
594 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
596 struct lws_io_watcher {
601 uv_poll_t uv_watcher;
603 #ifdef LWS_USE_LIBEVENT
604 struct event *event_watcher;
606 struct lws_context *context;
609 struct lws_signal_watcher {
611 ev_signal ev_watcher;
614 uv_signal_t uv_watcher;
616 #ifdef LWS_USE_LIBEVENT
617 struct event *event_watcher;
619 struct lws_context *context;
624 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
625 struct lws_fd_hashtable {
632 * This is totally opaque to code using the library. It's exported as a
633 * forward-reference pointer-only declaration; the user can use the pointer with
634 * other APIs to get information out of it.
637 struct lws_fragments {
640 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
644 * these are assigned from a pool held in the context.
645 * Both client and server mode uses them for http header analysis
648 struct allocated_headers {
649 struct lws *wsi; /* owner */
650 char *data; /* prepared by context init to point to dedicated storage */
652 * the randomly ordered fragments, indexed by frag_index and
653 * lws_fragments->nfrag for continuation.
655 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
658 * for each recognized token, frag_index says which frag[] his data
659 * starts in (0 means the token did not appear)
660 * the actual header data gets dumped as it comes in, into data[]
662 unsigned char frag_index[WSI_TOKEN_COUNT];
663 unsigned char rx[2048];
669 unsigned int http_response;
671 #ifndef LWS_NO_CLIENT
672 char initial_handshake_hash_base64[30];
675 unsigned char in_use;
680 * so we can have n connections being serviced simultaneously,
681 * these things need to be isolated per-thread.
684 struct lws_context_per_thread {
686 pthread_mutex_t lock;
688 struct lws_pollfd *fds;
689 #if defined(LWS_WITH_ESP8266)
690 struct lws **lws_vs_fds_index;
692 struct lws *rx_draining_ext_list;
693 struct lws *tx_draining_ext_list;
694 struct lws *timeout_list;
695 #if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
696 struct lws_context *context;
699 struct lws_cgi *cgi_list;
701 void *http_header_data;
702 struct allocated_headers *ah_pool;
703 struct lws *ah_wait_list;
704 int ah_wait_list_length;
705 #ifdef LWS_OPENSSL_SUPPORT
706 struct lws *pending_read_list; /* linked list */
708 #if defined(LWS_USE_LIBEV)
709 struct ev_loop *io_loop_ev;
711 #if defined(LWS_USE_LIBUV)
712 uv_loop_t *io_loop_uv;
713 uv_signal_t signals[8];
714 uv_timer_t uv_timeout_watcher;
717 #if defined(LWS_USE_LIBEVENT)
718 struct event_base *io_loop_event_base;
720 #if defined(LWS_USE_LIBEV)
721 struct lws_io_watcher w_accept;
723 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
724 struct lws_signal_watcher w_sigint;
725 unsigned char ev_loop_foreign:1;
728 unsigned long count_conns;
730 * usable by anything in the service code, but only if the scope
731 * does not last longer than the service action (since next service
732 * of any socket can likewise use it and overwrite)
734 unsigned char *serv_buf;
738 lws_sockfd_type dummy_pipe_fds[2];
740 unsigned int fds_count;
742 short ah_count_in_use;
744 unsigned char lock_depth;
747 struct lws_conn_stats {
748 unsigned long long rx, tx;
749 unsigned long conn, trans, ws_upg, http2_upg, rejected;
753 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
756 * virtual host -related context information
757 * vhostwide SSL context
762 * context -> vhost -> wsi
764 * incoming connection non-SSL vhost binding:
766 * listen socket -> wsi -> select vhost after first headers
768 * incoming connection SSL vhost binding:
770 * SSL SNI -> wsi -> bind after SSL negotiation
774 #if !defined(LWS_WITH_ESP8266)
775 char http_proxy_address[128];
776 char proxy_basic_auth_token[128];
778 #if defined(LWS_WITH_ESP8266)
779 /* listen sockets need a place to hang their hat */
782 struct lws_conn_stats conn_stats;
783 struct lws_context *context;
784 struct lws_vhost *vhost_next;
785 const struct lws_http_mount *mount_list;
786 struct lws *lserv_wsi;
789 const struct lws_protocols *protocols;
790 void **protocol_vh_privs;
791 const struct lws_protocol_vhost_options *pvo;
792 const struct lws_protocol_vhost_options *headers;
793 struct lws **same_vh_protocol_list;
794 #ifdef LWS_OPENSSL_SUPPORT
796 SSL_CTX *ssl_client_ctx;
798 #ifndef LWS_NO_EXTENSIONS
799 const struct lws_extension *extensions;
803 unsigned int http_proxy_port;
804 unsigned int options;
809 int keepalive_timeout;
810 #ifdef LWS_WITH_ACCESS_LOG
814 #ifdef LWS_OPENSSL_SUPPORT
816 int allow_non_ssl_on_ssl_port;
817 unsigned int user_supplied_ssl_ctx:1;
820 unsigned int created_vhost_protocols:1;
822 unsigned char default_protocol_index;
823 unsigned char raw_protocol_index;
827 * the rest is managed per-context, that includes
829 * - processwide single fd -> wsi lookup
830 * - contextwide headers pool
834 time_t last_timeout_check_s;
835 time_t last_ws_ping_pong_check_s;
837 const struct lws_plat_file_ops *fops;
838 struct lws_plat_file_ops fops_platform;
839 #if defined(LWS_WITH_ZIP_FOPS)
840 struct lws_plat_file_ops fops_zip;
842 struct lws_context_per_thread pt[LWS_MAX_SMP];
843 struct lws_conn_stats conn_stats;
845 /* different implementation between unix and windows */
846 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
848 #if defined(LWS_WITH_ESP8266)
849 struct espconn **connpool; /* .reverse points to the wsi */
854 struct lws **lws_lookup; /* fd to wsi */
857 struct lws_vhost *vhost_list;
858 struct lws_plugin *plugin_list;
860 void *external_baggage_free_on_destroy;
861 const struct lws_token_limits *token_limits;
863 const char *server_string;
864 const struct lws_protocol_vhost_options *reject_service_keywords;
865 lws_reload_func deprecation_cb;
867 #if defined(LWS_USE_LIBEV)
868 lws_ev_signal_cb_t * lws_ev_sigint_cb;
870 #if defined(LWS_USE_LIBUV)
871 uv_signal_cb lws_uv_sigint_cb;
873 #if defined(LWS_USE_LIBEVENT)
874 lws_event_signal_cb_t * lws_event_sigint_cb;
876 char canonical_hostname[128];
878 unsigned long worst_latency;
879 char worst_latency_info[256];
883 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
886 int started_with_parent;
890 #ifdef LWS_OPENSSL_SUPPORT
891 #define lws_ssl_anybody_has_buffered_read(w) \
892 (w->vhost->use_ssl && \
893 w->context->pt[(int)w->tsi].pending_read_list)
894 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
895 (/*c->use_ssl && */ \
896 c->pt[(int)t].pending_read_list)
898 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
899 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
901 int count_wsi_allocated;
902 int count_cgi_spawned;
903 unsigned int options;
904 unsigned int fd_limit_per_thread;
905 unsigned int timeout_secs;
906 unsigned int pt_serv_buf_size;
907 int max_http_header_data;
908 int simultaneous_ssl_restriction;
909 int simultaneous_ssl;
911 unsigned int deprecated:1;
912 unsigned int being_destroyed:1;
913 unsigned int being_destroyed1:1;
914 unsigned int requested_kill:1;
915 unsigned int protocol_init_done:1;
918 * set to the Thread ID that's doing the service loop just before entry
919 * to poll indicates service thread likely idling in poll()
920 * volatile because other threads may check it as part of processing
921 * for pollfd event change.
923 volatile int service_tid;
924 int service_tid_detected;
926 short max_http_header_pool;
928 short plugin_protocol_count;
929 short plugin_extension_count;
930 short server_string_len;
931 unsigned short ws_ping_pong_interval;
932 unsigned short deprecation_pending_listen_close_count;
936 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
937 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
940 lws_close_free_wsi_final(struct lws *wsi);
942 lws_libuv_closehandle(struct lws *wsi);
944 LWS_VISIBLE LWS_EXTERN int
945 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
947 LWS_VISIBLE LWS_EXTERN int
948 lws_plat_plugins_destroy(struct lws_context * context);
951 lws_restart_ws_ping_pong_timer(struct lws *wsi);
954 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
958 LWS_EV_READ = (1 << 0),
959 LWS_EV_WRITE = (1 << 1),
960 LWS_EV_START = (1 << 2),
961 LWS_EV_STOP = (1 << 3),
963 LWS_EV_PREPARE_DELETION = (1 << 31),
966 #if defined(LWS_USE_LIBEV)
968 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
970 lws_libev_io(struct lws *wsi, int flags);
972 lws_libev_init_fd_table(struct lws_context *context);
974 lws_libev_destroyloop(struct lws_context *context, int tsi);
976 lws_libev_run(const struct lws_context *context, int tsi);
977 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
978 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
980 #define lws_libev_accept(_a, _b) ((void) 0)
981 #define lws_libev_io(_a, _b) ((void) 0)
982 #define lws_libev_init_fd_table(_a) (0)
983 #define lws_libev_run(_a, _b) ((void) 0)
984 #define lws_libev_destroyloop(_a, _b) ((void) 0)
985 #define LWS_LIBEV_ENABLED(context) (0)
986 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
987 #define lws_feature_status_libev(_a) \
988 lwsl_notice("libev support not compiled in\n")
990 #define lws_feature_status_libev(_a)
994 #if defined(LWS_USE_LIBUV)
996 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
998 lws_libuv_io(struct lws *wsi, int flags);
1000 lws_libuv_init_fd_table(struct lws_context *context);
1002 lws_libuv_run(const struct lws_context *context, int tsi);
1004 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1006 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1007 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1008 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1010 #define lws_libuv_accept(_a, _b) ((void) 0)
1011 #define lws_libuv_io(_a, _b) ((void) 0)
1012 #define lws_libuv_init_fd_table(_a) (0)
1013 #define lws_libuv_run(_a, _b) ((void) 0)
1014 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1015 #define LWS_LIBUV_ENABLED(context) (0)
1016 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1017 #define lws_feature_status_libuv(_a) \
1018 lwsl_notice("libuv support not compiled in\n")
1020 #define lws_feature_status_libuv(_a)
1024 #if defined(LWS_USE_LIBEVENT)
1026 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1028 lws_libevent_io(struct lws *wsi, int flags);
1030 lws_libevent_init_fd_table(struct lws_context *context);
1032 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1034 lws_libevent_run(const struct lws_context *context, int tsi);
1035 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1036 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1038 #define lws_libevent_accept(_a, _b) ((void) 0)
1039 #define lws_libevent_io(_a, _b) ((void) 0)
1040 #define lws_libevent_init_fd_table(_a) (0)
1041 #define lws_libevent_run(_a, _b) ((void) 0)
1042 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1043 #define LWS_LIBEVENT_ENABLED(context) (0)
1044 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1045 #define lws_feature_status_libevent(_a) \
1046 lwsl_notice("libevent support not compiled in\n")
1048 #define lws_feature_status_libevent(_a)
1054 #define LWS_IPV6_ENABLED(vh) \
1055 (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1056 !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1058 #define LWS_IPV6_ENABLED(context) (0)
1061 #ifdef LWS_USE_UNIX_SOCK
1062 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1063 (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1065 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1067 enum uri_path_states {
1070 URIPS_SEEN_SLASH_DOT,
1071 URIPS_SEEN_SLASH_DOT_DOT,
1074 enum uri_esc_states {
1077 URIES_SEEN_PERCENT_H1,
1080 /* notice that these union members:
1086 * all have a pointer to allocated_headers struct as their first member.
1088 * It means for allocated_headers access, the three union paths can all be
1089 * used interchangeably to access the same data
1093 #ifndef LWS_NO_CLIENT
1094 struct client_info_stash {
1104 struct _lws_header_related {
1105 /* MUST be first in struct */
1106 struct allocated_headers *ah;
1107 struct lws *ah_wait_list;
1108 unsigned char *preamble_rx;
1109 #ifndef LWS_NO_CLIENT
1110 struct client_info_stash *stash;
1112 unsigned int preamble_rx_len;
1113 enum uri_path_states ups;
1114 enum uri_esc_states ues;
1116 unsigned int current_token_limit;
1119 char post_literal_equal;
1120 unsigned char parser_state; /* enum lws_token_indexes */
1123 #if defined(LWS_WITH_RANGES)
1125 LWSRS_NO_ACTIVE_RANGE,
1134 struct lws_range_parsing {
1135 unsigned long long start, end, extent, agg, budget;
1136 const char buf[128];
1138 enum range_states state;
1139 char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1143 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1145 lws_ranges_next(struct lws_range_parsing *rp);
1147 lws_ranges_reset(struct lws_range_parsing *rp);
1150 struct _lws_http_mode_related {
1151 /* MUST be first in struct */
1152 struct allocated_headers *ah; /* mirroring _lws_header_related */
1153 struct lws *ah_wait_list;
1154 unsigned char *preamble_rx;
1155 #ifndef LWS_NO_CLIENT
1156 struct client_info_stash *stash;
1158 unsigned int preamble_rx_len;
1159 struct lws *new_wsi_list;
1160 lws_filepos_t filepos;
1161 lws_filepos_t filelen;
1162 lws_fop_fd_t fop_fd;
1164 #if defined(LWS_WITH_RANGES)
1165 struct lws_range_parsing range;
1166 char multipart_content_type[64];
1169 enum http_version request_version;
1170 enum http_connection_type connection_type;
1171 unsigned int content_length;
1172 unsigned int content_remain;
1175 #ifdef LWS_USE_HTTP2
1177 enum lws_http2_settings {
1178 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1179 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1180 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1181 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1182 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1183 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1185 LWS_HTTP2_SETTINGS__COUNT /* always last */
1188 enum lws_http2_wellknown_frame_types {
1189 LWS_HTTP2_FRAME_TYPE_DATA,
1190 LWS_HTTP2_FRAME_TYPE_HEADERS,
1191 LWS_HTTP2_FRAME_TYPE_PRIORITY,
1192 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1193 LWS_HTTP2_FRAME_TYPE_SETTINGS,
1194 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1195 LWS_HTTP2_FRAME_TYPE_PING,
1196 LWS_HTTP2_FRAME_TYPE_GOAWAY,
1197 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1198 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1200 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1203 enum lws_http2_flags {
1204 LWS_HTTP2_FLAG_END_STREAM = 1,
1205 LWS_HTTP2_FLAG_END_HEADERS = 4,
1206 LWS_HTTP2_FLAG_PADDED = 8,
1207 LWS_HTTP2_FLAG_PRIORITY = 0x20,
1209 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1212 #define LWS_HTTP2_STREAM_ID_MASTER 0
1213 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1214 #define LWS_HTTP2_SETTINGS_LENGTH 6
1216 struct http2_settings {
1217 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1220 enum http2_hpack_state {
1222 /* optional before first header block */
1224 HKPS_OPT_E_DEPENDENCY,
1237 /* optional after last header block */
1238 HKPS_OPT_DISCARD_PADDING,
1241 enum http2_hpack_type {
1243 HPKT_INDEXED_HDR_6_VALUE_INCR,
1244 HPKT_LITERAL_HDR_VALUE_INCR,
1245 HPKT_INDEXED_HDR_4_VALUE,
1246 HPKT_LITERAL_HDR_VALUE,
1250 struct hpack_dt_entry {
1251 int token; /* additions that don't map to a token are ignored */
1256 struct hpack_dynamic_table {
1257 struct hpack_dt_entry *entries;
1265 struct _lws_http2_related {
1267 * having this first lets us also re-use all HTTP union code
1268 * and in turn, http_mode_related has allocated headers in right
1269 * place so we can use the header apis on the wsi directly still
1271 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1273 struct http2_settings my_settings;
1274 struct http2_settings peer_settings;
1276 struct lws *parent_wsi;
1277 struct lws *next_child_wsi;
1279 struct hpack_dynamic_table *hpack_dyn_table;
1280 struct lws *stream_wsi;
1281 unsigned char ping_payload[8];
1282 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1285 unsigned int length;
1286 unsigned int stream_id;
1287 enum http2_hpack_state hpack;
1288 enum http2_hpack_type hpack_type;
1289 unsigned int header_index;
1290 unsigned int hpack_len;
1291 unsigned int hpack_e_dep;
1293 unsigned int my_stream_id;
1294 unsigned int child_count;
1297 unsigned int END_STREAM:1;
1298 unsigned int END_HEADERS:1;
1299 unsigned int send_END_STREAM:1;
1300 unsigned int GOING_AWAY;
1301 unsigned int requested_POLLOUT:1;
1302 unsigned int waiting_tx_credit:1;
1303 unsigned int huff:1;
1304 unsigned int value:1;
1306 unsigned short round_robin_POLLOUT;
1307 unsigned short count_POLLOUT_children;
1308 unsigned short hpack_pos;
1311 unsigned char flags;
1312 unsigned char frame_state;
1313 unsigned char padding;
1314 unsigned char hpack_m;
1315 unsigned char initialized;
1318 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1322 struct _lws_websocket_related {
1323 /* cheapest way to deal with ah overlap with ws union transition */
1324 struct _lws_header_related hdr;
1326 unsigned int rx_ubuf_alloc;
1327 struct lws *rx_draining_ext_list;
1328 struct lws *tx_draining_ext_list;
1329 time_t time_next_ping_check;
1330 size_t rx_packet_length;
1331 unsigned int rx_ubuf_head;
1332 unsigned char mask[4];
1333 /* Also used for close content... control opcode == < 128 */
1334 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1336 unsigned char ping_payload_len;
1337 unsigned char mask_idx;
1338 unsigned char opcode;
1340 unsigned char rsv_first_msg;
1341 /* zero if no info, or length including 2-byte close code */
1342 unsigned char close_in_ping_buffer_len;
1344 unsigned char stashed_write_type;
1345 unsigned char tx_draining_stashed_wp;
1347 unsigned int final:1;
1348 unsigned int frame_is_binary:1;
1349 unsigned int all_zero_nonce:1;
1350 unsigned int this_frame_masked:1;
1351 unsigned int inside_frame:1; /* next write will be more of frame */
1352 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1353 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1354 unsigned int ping_pending_flag:1;
1355 unsigned int continuation_possible:1;
1356 unsigned int owed_a_fin:1;
1357 unsigned int check_utf8:1;
1358 unsigned int defeat_check_utf8:1;
1359 unsigned int pmce_compressed_message:1;
1360 unsigned int stashed_write_pending:1;
1361 unsigned int rx_draining_ext:1;
1362 unsigned int tx_draining_ext:1;
1363 unsigned int send_check_ping:1;
1368 /* wsi who is master of the cgi points to an lws_cgi */
1371 struct lws_cgi *cgi_list;
1372 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1373 struct lws *wsi; /* owner */
1374 unsigned long content_length;
1375 unsigned long content_length_seen;
1379 unsigned int being_closed:1;
1381 unsigned char chunked_grace;
1385 signed char char_to_hex(const char c);
1387 #ifndef LWS_NO_CLIENT
1388 enum lws_chunk_parser {
1399 #ifdef LWS_WITH_ACCESS_LOG
1400 struct lws_access_log {
1411 /* members with mutually exclusive lifetimes are unionized */
1414 struct _lws_http_mode_related http;
1415 #ifdef LWS_USE_HTTP2
1416 struct _lws_http2_related http2;
1418 struct _lws_header_related hdr;
1419 struct _lws_websocket_related ws;
1422 /* lifetime members */
1424 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1425 struct lws_io_watcher w_read;
1427 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1428 struct lws_io_watcher w_write;
1430 time_t pending_timeout_limit;
1434 struct lws_context *context;
1435 struct lws_vhost *vhost;
1436 struct lws *parent; /* points to parent, if any */
1437 struct lws *child_list; /* points to first child */
1438 struct lws *sibling_list; /* subsequent children at same level */
1440 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1442 const struct lws_protocols *protocol;
1443 struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1444 struct lws *timeout_list;
1445 struct lws **timeout_list_prev;
1446 #ifdef LWS_WITH_ACCESS_LOG
1447 struct lws_access_log access_log;
1450 /* rxflow handling */
1451 unsigned char *rxflow_buffer;
1452 /* truncated send handling */
1453 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1455 #if defined (LWS_WITH_ESP8266)
1457 unsigned short prem_rx_size, prem_rx_pos;
1460 #ifndef LWS_NO_EXTENSIONS
1461 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1462 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1464 #ifdef LWS_OPENSSL_SUPPORT
1467 struct lws *pending_read_list_prev, *pending_read_list_next;
1469 #ifdef LWS_WITH_HTTP_PROXY
1470 struct lws_rewrite *rw;
1473 unsigned long action_start;
1474 unsigned long latency_start;
1476 lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1479 int position_in_fds_table;
1482 unsigned int trunc_alloc_len; /* size of malloc */
1483 unsigned int trunc_offset; /* where we are in terms of spilling */
1484 unsigned int trunc_len; /* how much is buffered */
1485 #ifndef LWS_NO_CLIENT
1486 int chunk_remaining;
1488 unsigned int cache_secs;
1490 unsigned int hdr_parsing_completed:1;
1491 unsigned int http2_substream:1;
1492 unsigned int listener:1;
1493 unsigned int user_space_externally_allocated:1;
1494 unsigned int socket_is_permanently_unusable:1;
1495 unsigned int rxflow_change_to:2;
1496 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1497 unsigned int conn_stat_done:1;
1498 unsigned int cache_reuse:1;
1499 unsigned int cache_revalidate:1;
1500 unsigned int cache_intermediaries:1;
1501 unsigned int favoured_pollin:1;
1502 unsigned int sending_chunked:1;
1503 unsigned int already_did_cce:1;
1504 unsigned int told_user_closed:1;
1506 #if defined(LWS_WITH_ESP8266)
1507 unsigned int pending_send_completion:3;
1508 unsigned int close_is_pending_send_completion:1;
1510 #ifdef LWS_WITH_ACCESS_LOG
1511 unsigned int access_log_pending:1;
1513 #ifndef LWS_NO_CLIENT
1514 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1515 unsigned int chunked:1; /* if the clientside connection is chunked */
1516 unsigned int client_rx_avail:1;
1517 unsigned int client_http_body_pending:1;
1519 #ifdef LWS_WITH_HTTP_PROXY
1520 unsigned int perform_rewrite:1;
1522 #ifndef LWS_NO_EXTENSIONS
1523 unsigned int extension_data_pending:1;
1525 #ifdef LWS_OPENSSL_SUPPORT
1526 unsigned int use_ssl:4;
1529 unsigned int sock_send_blocking:1;
1531 #ifdef LWS_OPENSSL_SUPPORT
1532 unsigned int redirect_to_https:1;
1535 /* volatile to make sure code is aware other thread can change */
1536 volatile unsigned int handling_pollout:1;
1537 volatile unsigned int leave_pollout_active:1;
1539 #ifndef LWS_NO_CLIENT
1540 unsigned short c_port;
1544 #ifndef LWS_NO_EXTENSIONS
1545 unsigned char count_act_ext;
1547 unsigned char ietf_spec_revision;
1548 char mode; /* enum connection_mode */
1549 char state; /* enum lws_connection_states */
1550 char state_pre_close;
1551 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1552 char rx_frame_type; /* enum lws_write_protocol */
1553 char pending_timeout; /* enum pending_timeout */
1554 char pps; /* enum lws_pending_protocol_send */
1555 char tsi; /* thread service index we belong to */
1556 char protocol_interpret_idx;
1559 char cgi_channel; /* which of stdin/out/err */
1562 #ifndef LWS_NO_CLIENT
1563 char chunk_parser; /* enum lws_chunk_parser */
1565 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1566 char reason_bf; /* internal writeable callback reason bitfield */
1570 LWS_EXTERN int log_level;
1573 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1577 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1580 remove_wsi_socket_from_fds(struct lws *wsi);
1582 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1586 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1587 int ret, int completion) {
1589 (void)context; (void)wsi; (void)action; (void)ret;
1594 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1595 do { (void)context; (void)wsi; } while (0);
1598 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1600 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1601 int ret, int completion);
1605 lws_set_protocol_write_pending(struct lws *wsi,
1606 enum lws_pending_protocol_send pend);
1607 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1608 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1610 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1611 lws_parse(struct lws *wsi, unsigned char c);
1613 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1614 lws_http_action(struct lws *wsi);
1617 lws_b64_selftest(void);
1620 lws_service_flag_pending(struct lws_context *context, int tsi);
1622 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1623 LWS_EXTERN struct lws *
1624 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1627 insert_wsi(struct lws_context *context, struct lws *wsi);
1630 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1632 #define wsi_from_fd(A,B) A->lws_lookup[B]
1633 #define insert_wsi(A,B) assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1634 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1637 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1638 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1640 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1641 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1644 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1645 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1648 lws_remove_from_timeout_list(struct lws *wsi);
1650 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1651 lws_client_connect_2(struct lws *wsi);
1653 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1654 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1655 const char *path, const char *host);
1657 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1658 lws_create_new_server_wsi(struct lws_vhost *vhost);
1660 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1661 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1664 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1666 LWS_EXTERN struct lws *
1667 lws_client_connect_via_info2(struct lws *wsi);
1673 #ifndef LWS_NO_EXTENSIONS
1675 lws_context_init_extensions(struct lws_context_creation_info *info,
1676 struct lws_context *context);
1678 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1679 void *v, size_t len);
1682 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1684 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1685 void *arg, int len);
1688 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1689 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1690 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1691 #define lws_issue_raw_ext_access lws_issue_raw
1692 #define lws_context_init_extensions(_a, _b)
1695 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1696 lws_client_interpret_server_handshake(struct lws *wsi);
1698 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1699 lws_rx_sm(struct lws *wsi, unsigned char c);
1702 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1704 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1705 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1708 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1710 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1711 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1712 enum lws_callback_reasons reason, void *user,
1713 void *in, size_t len);
1714 #ifdef LWS_USE_HTTP2
1715 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1716 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1718 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1719 unsigned char *buf, int len);
1720 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1722 lws_http2_parser(struct lws *wsi, unsigned char c);
1723 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1725 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1726 unsigned int sid, unsigned int len,
1727 unsigned char *buf);
1728 LWS_EXTERN struct lws *
1729 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1730 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1733 lws_add_http2_header_by_name(struct lws *wsi,
1734 const unsigned char *name,
1735 const unsigned char *value, int length,
1736 unsigned char **p, unsigned char *end);
1738 lws_add_http2_header_by_token(struct lws *wsi,
1739 enum lws_token_indexes token,
1740 const unsigned char *value, int length,
1741 unsigned char **p, unsigned char *end);
1743 lws_add_http2_header_status(struct lws *wsi,
1744 unsigned int code, unsigned char **p,
1745 unsigned char *end);
1747 void lws_http2_configure_if_upgraded(struct lws *wsi);
1749 #define lws_http2_configure_if_upgraded(x)
1753 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1756 lws_plat_check_connection_error(struct lws *wsi);
1758 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1759 lws_header_table_attach(struct lws *wsi, int autoservice);
1762 lws_header_table_detach(struct lws *wsi, int autoservice);
1765 lws_header_table_reset(struct lws *wsi, int autoservice);
1767 _lws_header_table_reset(struct allocated_headers *ah);
1769 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1770 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1772 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1773 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1775 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1776 lws_ensure_user_space(struct lws *wsi);
1779 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1781 #ifndef LWS_NO_SERVER
1782 int lws_context_init_server(struct lws_context_creation_info *info,
1783 struct lws_vhost *vhost);
1784 LWS_EXTERN struct lws_vhost *
1785 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1787 handshake_0405(struct lws_context *context, struct lws *wsi);
1788 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1789 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1791 lws_server_get_canonical_hostname(struct lws_context *context,
1792 struct lws_context_creation_info *info);
1794 #define lws_context_init_server(_a, _b) (0)
1795 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1796 #define lws_server_get_canonical_hostname(_a, _b)
1799 #ifndef LWS_NO_DAEMONIZE
1800 LWS_EXTERN int get_daemonize_pid();
1802 #define get_daemonize_pid() (0)
1805 #if !defined(LWS_WITH_ESP8266)
1806 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1807 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1808 struct sockaddr_in *addr, size_t addrlen);
1810 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1812 enum lws_ssl_capable_status {
1813 LWS_SSL_CAPABLE_ERROR = -1,
1814 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1817 #ifndef LWS_OPENSSL_SUPPORT
1818 #define LWS_SSL_ENABLED(context) (0)
1819 #define lws_context_init_server_ssl(_a, _b) (0)
1820 #define lws_ssl_destroy(_a)
1821 #define lws_context_init_http2_ssl(_a)
1822 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1823 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1824 #define lws_ssl_pending lws_ssl_pending_no_ssl
1825 #define lws_server_socket_service_ssl(_b, _c) (0)
1826 #define lws_ssl_close(_a) (0)
1827 #define lws_ssl_context_destroy(_a)
1828 #define lws_ssl_SSL_CTX_destroy(_a)
1829 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1830 #define lws_context_init_ssl_library(_a)
1832 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1833 LWS_EXTERN int openssl_websocket_private_data_index;
1834 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1835 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1836 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1837 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1838 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1839 lws_ssl_pending(struct lws *wsi);
1841 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1842 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1843 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1845 lws_ssl_close(struct lws *wsi);
1847 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1849 lws_ssl_context_destroy(struct lws_context *context);
1851 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1853 lws_ssl_client_bio_create(struct lws *wsi);
1855 lws_ssl_client_connect1(struct lws *wsi);
1857 lws_ssl_client_connect2(struct lws *wsi);
1859 lws_ssl_elaborate_error(void);
1860 #ifndef LWS_NO_SERVER
1862 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1863 struct lws_vhost *vhost);
1865 #define lws_context_init_server_ssl(_a, _b) (0)
1868 lws_ssl_destroy(struct lws_vhost *vhost);
1871 #ifdef LWS_USE_HTTP2
1873 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1875 #define lws_context_init_http2_ssl(_a)
1880 static LWS_INLINE void
1881 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1883 pthread_mutex_init(&pt->lock, NULL);
1886 static LWS_INLINE void
1887 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
1889 pthread_mutex_destroy(&pt->lock);
1892 static LWS_INLINE void
1893 lws_pt_lock(struct lws_context_per_thread *pt)
1895 if (!pt->lock_depth++)
1896 pthread_mutex_lock(&pt->lock);
1899 static LWS_INLINE void
1900 lws_pt_unlock(struct lws_context_per_thread *pt)
1902 if (!(--pt->lock_depth))
1903 pthread_mutex_unlock(&pt->lock);
1906 #define lws_pt_mutex_init(_a) (void)(_a)
1907 #define lws_pt_mutex_destroy(_a) (void)(_a)
1908 #define lws_pt_lock(_a) (void)(_a)
1909 #define lws_pt_unlock(_a) (void)(_a)
1912 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1913 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1915 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1916 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1918 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1919 lws_ssl_pending_no_ssl(struct lws *wsi);
1921 #ifdef LWS_WITH_HTTP_PROXY
1922 struct lws_rewrite {
1923 hubbub_parser *parser;
1924 hubbub_parser_optparams params;
1925 const char *from, *to;
1926 int from_len, to_len;
1927 unsigned char *p, *end;
1930 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1935 return strncmp((const char *)s->ptr, p, len);
1937 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1938 LWS_EXTERN struct lws_rewrite *
1939 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1941 lws_rewrite_destroy(struct lws_rewrite *r);
1943 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1946 #ifndef LWS_NO_CLIENT
1947 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1949 struct lws_pollfd *pollfd);
1950 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1951 lws_http_transaction_completed_client(struct lws *wsi);
1952 #ifdef LWS_OPENSSL_SUPPORT
1954 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1955 struct lws_vhost *vhost);
1957 #define lws_context_init_client_ssl(_a, _b) (0)
1959 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1960 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1962 lws_decode_ssl_error(void);
1964 #define lws_context_init_client_ssl(_a, _b) (0)
1965 #define lws_handshake_client(_a, _b, _c) (0)
1969 _lws_rx_flow_control(struct lws *wsi);
1972 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1974 #ifndef LWS_NO_SERVER
1976 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1977 struct lws_pollfd *pollfd);
1979 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1981 #define lws_server_socket_service(_a, _b, _c) (0)
1982 #define lws_handshake_server(_a, _b, _c) (0)
1985 #ifdef LWS_WITH_ACCESS_LOG
1987 lws_access_log(struct lws *wsi);
1989 #define lws_access_log(_a)
1993 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1996 lws_protocol_init(struct lws_context *context);
1999 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2001 const struct lws_http_mount *
2002 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2008 lws_realloc(void *ptr, size_t size);
2010 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2011 lws_zalloc(size_t size);
2013 #ifdef LWS_PLAT_OPTEE
2014 void *lws_malloc(size_t size);
2015 void lws_free(void *p);
2016 #define lws_free_set_NULL(P) do { lws_free(P); (P) = NULL; } while(0)
2018 #define lws_malloc(S) lws_realloc(NULL, S)
2019 #define lws_free(P) lws_realloc(P, 0)
2020 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
2023 const struct lws_plat_file_ops *
2024 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2025 const char **vpath);
2029 lws_plat_delete_socket_from_fds(struct lws_context *context,
2030 struct lws *wsi, int m);
2032 lws_plat_insert_socket_into_fds(struct lws_context *context,
2035 lws_plat_service_periodic(struct lws_context *context);
2038 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2039 struct lws_pollfd *pfd);
2041 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2043 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2045 lws_plat_context_early_init(void);
2047 lws_plat_context_early_destroy(struct lws_context *context);
2049 lws_plat_context_late_destroy(struct lws_context *context);
2051 lws_poll_listen_fd(struct lws_pollfd *fd);
2053 lws_plat_service(struct lws_context *context, int timeout_ms);
2054 LWS_EXTERN LWS_VISIBLE int
2055 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2057 lws_plat_init(struct lws_context *context,
2058 struct lws_context_creation_info *info);
2060 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2061 LWS_EXTERN unsigned long long
2062 time_in_microseconds(void);
2063 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2064 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2066 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2067 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2068 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2069 lws_filepos_t *amount);
2071 lws_same_vh_protocol_remove(struct lws *wsi);
2073 lws_same_vh_protocol_insert(struct lws *wsi, int n);