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>
213 #ifdef LWS_HAVE_SYS_PRCTL_H
214 #include <sys/prctl.h>
218 #include <sys/time.h>
220 #define LWS_ERRNO errno
221 #define LWS_EAGAIN EAGAIN
222 #define LWS_EALREADY EALREADY
223 #define LWS_EINPROGRESS EINPROGRESS
224 #define LWS_EINTR EINTR
225 #define LWS_EISCONN EISCONN
226 #define LWS_EWOULDBLOCK EWOULDBLOCK
228 #define lws_set_blocking_send(wsi)
230 #if defined(LWS_WITH_ESP8266)
231 #define lws_socket_is_valid(x) ((x) != NULL)
232 #define LWS_SOCK_INVALID (NULL)
235 lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
237 #define lws_socket_is_valid(x) (x >= 0)
238 #define LWS_SOCK_INVALID (-1)
242 #ifndef LWS_HAVE_BZERO
244 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
248 #ifndef LWS_HAVE_STRERROR
249 #define strerror(x) ""
252 #ifdef LWS_OPENSSL_SUPPORT
255 #ifdef USE_OLD_CYASSL
256 #include <cyassl/openssl/ssl.h>
257 #include <cyassl/error-ssl.h>
259 #include <wolfssl/openssl/ssl.h>
260 #include <wolfssl/error-ssl.h>
261 #define OPENSSL_NO_TLSEXT
262 #endif /* not USE_OLD_CYASSL */
264 #include <openssl/ssl.h>
265 #include <openssl/evp.h>
266 #include <openssl/err.h>
267 #include <openssl/md5.h>
268 #include <openssl/sha.h>
269 #ifdef LWS_HAVE_OPENSSL_ECDH_H
270 #include <openssl/ecdh.h>
272 #include <openssl/x509v3.h>
274 #if (OPENSSL_VERSION_NUMBER < 0x0009080afL)
275 /* later openssl defines this to negate the presence of tlsext... but it was only
276 * introduced at 0.9.8j. Earlier versions don't know it exists so don't
277 * define it... making it look like the feature exists...
279 #define OPENSSL_NO_TLSEXT
281 #endif /* not USE_WOLFSSL */
284 #include "libwebsockets.h"
285 #if defined(WIN32) || defined(_WIN32)
287 static inline int compatible_close(int fd) { return close(fd); }
290 #if defined(WIN32) || defined(_WIN32)
291 #include <gettimeofday.h>
294 #if defined(LWS_WITH_ESP8266)
295 #undef compatible_close
296 #define compatible_close(fd) { fd->state=ESPCONN_CLOSE; espconn_delete(fd); }
298 esp8266_create_tcp_stream_socket(void);
300 esp8266_tcp_stream_bind(lws_sockfd_type fd, int port, struct lws *wsi);
302 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
304 #ifndef LITTLE_ENDIAN
305 #define LITTLE_ENDIAN 1234
308 #define BYTE_ORDER LITTLE_ENDIAN
313 #if defined(WIN32) || defined(_WIN32)
316 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
318 #ifndef LITTLE_ENDIAN
319 #define LITTLE_ENDIAN 1234
322 #define BYTE_ORDER LITTLE_ENDIAN
325 typedef unsigned __int64 u_int64_t;
331 #define __P(protos) protos
333 #define __P(protos) ()
339 #include <sys/stat.h>
340 #include <sys/time.h>
342 #if defined(__APPLE__)
343 #include <machine/endian.h>
344 #elif defined(__FreeBSD__)
345 #include <sys/endian.h>
346 #elif defined(__linux__)
355 #include <gulliver.h>
356 #if defined(__LITTLEENDIAN__)
357 #define BYTE_ORDER __LITTLEENDIAN__
358 #define LITTLE_ENDIAN __LITTLEENDIAN__
359 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
361 #if defined(__BIGENDIAN__)
362 #define BYTE_ORDER __BIGENDIAN__
363 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
364 #define BIG_ENDIAN __BIGENDIAN__
368 #if defined(__sun) && defined(__GNUC__)
369 # define BYTE_ORDER __BYTE_ORDER__
370 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
371 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
374 #if !defined(BYTE_ORDER)
375 # define BYTE_ORDER __BYTE_ORDER
377 #if !defined(LITTLE_ENDIAN)
378 # define LITTLE_ENDIAN __LITTLE_ENDIAN
380 #if !defined(BIG_ENDIAN)
381 # define BIG_ENDIAN __BIG_ENDIAN
387 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
388 * but happily have something equivalent in the SO_NOSIGPIPE flag.
391 #define MSG_NOSIGNAL SO_NOSIGPIPE
395 * Solaris 11.X only supports POSIX 2001, MSG_NOSIGNAL appears in
399 #define MSG_NOSIGNAL 0
403 #ifndef FD_HASHTABLE_MODULUS
404 #define FD_HASHTABLE_MODULUS 32
408 #ifndef LWS_DEF_HEADER_LEN
409 #define LWS_DEF_HEADER_LEN 4096
411 #ifndef LWS_DEF_HEADER_POOL
412 #define LWS_DEF_HEADER_POOL 4
414 #ifndef LWS_MAX_PROTOCOLS
415 #define LWS_MAX_PROTOCOLS 5
417 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
418 #define LWS_MAX_EXTENSIONS_ACTIVE 2
420 #ifndef LWS_MAX_EXT_OFFERS
421 #define LWS_MAX_EXT_OFFERS 8
423 #ifndef SPEC_LATEST_SUPPORTED
424 #define SPEC_LATEST_SUPPORTED 13
426 #ifndef AWAITING_TIMEOUT
427 #define AWAITING_TIMEOUT 20
429 #ifndef CIPHERS_LIST_STRING
430 #define CIPHERS_LIST_STRING "DEFAULT"
432 #ifndef LWS_SOMAXCONN
433 #define LWS_SOMAXCONN SOMAXCONN
436 #define MAX_WEBSOCKET_04_KEY_LEN 128
438 #ifndef SYSTEM_RANDOM_FILEPATH
439 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
442 enum lws_websocket_opcodes_07 {
443 LWSWSOPC_CONTINUATION = 0,
444 LWSWSOPC_TEXT_FRAME = 1,
445 LWSWSOPC_BINARY_FRAME = 2,
447 LWSWSOPC_NOSPEC__MUX = 7,
449 /* control extensions 8+ */
457 enum lws_connection_states {
459 LWSS_HTTP_ISSUING_FILE,
464 LWSS_CLIENT_HTTP_ESTABLISHED,
465 LWSS_CLIENT_UNCONNECTED,
466 LWSS_RETURNED_CLOSE_ALREADY,
467 LWSS_AWAITING_CLOSE_ACK,
468 LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
471 LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
472 LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
473 LWSS_HTTP2_ESTABLISHED,
484 enum http_connection_type {
485 HTTP_CONNECTION_CLOSE,
486 HTTP_CONNECTION_KEEP_ALIVE
489 enum lws_pending_protocol_send {
491 LWS_PPS_HTTP2_MY_SETTINGS,
492 LWS_PPS_HTTP2_ACK_SETTINGS,
496 enum lws_rx_parse_state {
503 LWS_RXPS_04_FRAME_HDR_1,
504 LWS_RXPS_04_FRAME_HDR_LEN,
505 LWS_RXPS_04_FRAME_HDR_LEN16_2,
506 LWS_RXPS_04_FRAME_HDR_LEN16_1,
507 LWS_RXPS_04_FRAME_HDR_LEN64_8,
508 LWS_RXPS_04_FRAME_HDR_LEN64_7,
509 LWS_RXPS_04_FRAME_HDR_LEN64_6,
510 LWS_RXPS_04_FRAME_HDR_LEN64_5,
511 LWS_RXPS_04_FRAME_HDR_LEN64_4,
512 LWS_RXPS_04_FRAME_HDR_LEN64_3,
513 LWS_RXPS_04_FRAME_HDR_LEN64_2,
514 LWS_RXPS_04_FRAME_HDR_LEN64_1,
516 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
517 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
518 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
519 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
521 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
524 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
526 enum connection_mode {
528 LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
529 LWSCM_PRE_WS_SERVING_ACCEPT,
536 /* transient, ssl delay hiding */
537 LWSCM_SSL_ACK_PENDING,
539 /* as above, but complete into LWSCM_RAW */
540 LWSCM_SSL_ACK_PENDING_RAW,
543 /* special internal types */
544 LWSCM_SERVER_LISTENER,
545 LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
548 /* HTTP Client related */
549 LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
550 LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
551 LWSCM_WSCL_WAITING_CONNECT,
552 LWSCM_WSCL_WAITING_PROXY_REPLY,
553 LWSCM_WSCL_ISSUE_HANDSHAKE,
554 LWSCM_WSCL_ISSUE_HANDSHAKE2,
555 LWSCM_WSCL_ISSUE_HTTP_BODY,
556 LWSCM_WSCL_WAITING_SSL,
557 LWSCM_WSCL_WAITING_SERVER_REPLY,
558 LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
559 LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
561 /****** add new things just above ---^ ******/
567 LWS_RXFLOW_ALLOW = (1 << 0),
568 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
571 /* this is not usable directly by user code any more, lws_close_reason() */
572 #define LWS_WRITE_CLOSE 4
574 struct lws_protocols;
577 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
579 struct lws_io_watcher {
584 uv_poll_t uv_watcher;
586 struct lws_context *context;
589 struct lws_signal_watcher {
591 ev_signal ev_watcher;
594 uv_signal_t uv_watcher;
596 struct lws_context *context;
601 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
602 struct lws_fd_hashtable {
609 * This is totally opaque to code using the library. It's exported as a
610 * forward-reference pointer-only declaration; the user can use the pointer with
611 * other APIs to get information out of it.
614 struct lws_fragments {
617 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
621 * these are assigned from a pool held in the context.
622 * Both client and server mode uses them for http header analysis
625 struct allocated_headers {
626 struct lws *wsi; /* owner */
627 char *data; /* prepared by context init to point to dedicated storage */
629 * the randomly ordered fragments, indexed by frag_index and
630 * lws_fragments->nfrag for continuation.
632 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
635 * for each recognized token, frag_index says which frag[] his data
636 * starts in (0 means the token did not appear)
637 * the actual header data gets dumped as it comes in, into data[]
639 unsigned char frag_index[WSI_TOKEN_COUNT];
640 unsigned char rx[2048];
646 unsigned int http_response;
648 #ifndef LWS_NO_CLIENT
649 char initial_handshake_hash_base64[30];
652 unsigned char in_use;
657 * so we can have n connections being serviced simultaneously,
658 * these things need to be isolated per-thread.
661 struct lws_context_per_thread {
663 pthread_mutex_t lock;
665 struct lws_pollfd *fds;
666 #if defined(LWS_WITH_ESP8266)
667 struct lws **lws_vs_fds_index;
669 struct lws *rx_draining_ext_list;
670 struct lws *tx_draining_ext_list;
671 struct lws *timeout_list;
673 struct lws_context *context;
676 struct lws_cgi *cgi_list;
678 void *http_header_data;
679 struct allocated_headers *ah_pool;
680 struct lws *ah_wait_list;
681 int ah_wait_list_length;
682 #ifdef LWS_OPENSSL_SUPPORT
683 struct lws *pending_read_list; /* linked list */
685 #if defined(LWS_USE_LIBEV)
686 struct ev_loop *io_loop_ev;
688 #if defined(LWS_USE_LIBUV)
689 uv_loop_t *io_loop_uv;
690 uv_signal_t signals[8];
691 uv_timer_t uv_timeout_watcher;
694 #if defined(LWS_USE_LIBEV)
695 struct lws_io_watcher w_accept;
697 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
698 struct lws_signal_watcher w_sigint;
699 unsigned char ev_loop_foreign:1;
702 unsigned long count_conns;
704 * usable by anything in the service code, but only if the scope
705 * does not last longer than the service action (since next service
706 * of any socket can likewise use it and overwrite)
708 unsigned char *serv_buf;
712 lws_sockfd_type dummy_pipe_fds[2];
714 unsigned int fds_count;
716 short ah_count_in_use;
718 unsigned char lock_depth;
721 struct lws_conn_stats {
722 unsigned long long rx, tx;
723 unsigned long conn, trans, ws_upg, http2_upg, rejected;
727 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
730 * virtual host -related context information
731 * vhostwide SSL context
736 * context -> vhost -> wsi
738 * incoming connection non-SSL vhost binding:
740 * listen socket -> wsi -> select vhost after first headers
742 * incoming connection SSL vhost binding:
744 * SSL SNI -> wsi -> bind after SSL negotiation
748 #if !defined(LWS_WITH_ESP8266)
749 char http_proxy_address[128];
750 char proxy_basic_auth_token[128];
752 #if defined(LWS_WITH_ESP8266)
753 /* listen sockets need a place to hang their hat */
756 struct lws_conn_stats conn_stats;
757 struct lws_context *context;
758 struct lws_vhost *vhost_next;
759 const struct lws_http_mount *mount_list;
760 struct lws *lserv_wsi;
763 const struct lws_protocols *protocols;
764 void **protocol_vh_privs;
765 const struct lws_protocol_vhost_options *pvo;
766 const struct lws_protocol_vhost_options *headers;
767 struct lws **same_vh_protocol_list;
768 #ifdef LWS_OPENSSL_SUPPORT
770 SSL_CTX *ssl_client_ctx;
772 #ifndef LWS_NO_EXTENSIONS
773 const struct lws_extension *extensions;
777 unsigned int http_proxy_port;
778 unsigned int options;
783 int keepalive_timeout;
784 #ifdef LWS_WITH_ACCESS_LOG
788 #ifdef LWS_OPENSSL_SUPPORT
790 int allow_non_ssl_on_ssl_port;
791 unsigned int user_supplied_ssl_ctx:1;
794 unsigned int created_vhost_protocols:1;
796 unsigned char default_protocol_index;
800 * the rest is managed per-context, that includes
802 * - processwide single fd -> wsi lookup
803 * - contextwide headers pool
807 time_t last_timeout_check_s;
808 time_t last_ws_ping_pong_check_s;
810 struct lws_plat_file_ops fops;
811 struct lws_context_per_thread pt[LWS_MAX_SMP];
812 struct lws_conn_stats conn_stats;
814 /* different implementation between unix and windows */
815 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
817 #if defined(LWS_WITH_ESP8266)
818 struct espconn **connpool; /* .reverse points to the wsi */
823 struct lws **lws_lookup; /* fd to wsi */
826 struct lws_vhost *vhost_list;
827 struct lws_plugin *plugin_list;
829 void *external_baggage_free_on_destroy;
830 const struct lws_token_limits *token_limits;
832 const char *server_string;
833 const struct lws_protocol_vhost_options *reject_service_keywords;
834 lws_reload_func deprecation_cb;
836 #if defined(LWS_USE_LIBEV)
837 lws_ev_signal_cb_t * lws_ev_sigint_cb;
839 #if defined(LWS_USE_LIBUV)
840 uv_signal_cb lws_uv_sigint_cb;
842 char canonical_hostname[128];
844 unsigned long worst_latency;
845 char worst_latency_info[256];
849 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
852 int started_with_parent;
856 #ifdef LWS_OPENSSL_SUPPORT
857 #define lws_ssl_anybody_has_buffered_read(w) \
858 (w->vhost->use_ssl && \
859 w->context->pt[(int)w->tsi].pending_read_list)
860 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
861 (/*c->use_ssl && */ \
862 c->pt[(int)t].pending_read_list)
864 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
865 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
867 int count_wsi_allocated;
868 int count_cgi_spawned;
869 unsigned int options;
870 unsigned int fd_limit_per_thread;
871 unsigned int timeout_secs;
872 unsigned int pt_serv_buf_size;
873 int max_http_header_data;
875 unsigned int deprecated:1;
876 unsigned int being_destroyed:1;
877 unsigned int being_destroyed1:1;
878 unsigned int requested_kill:1;
879 unsigned int protocol_init_done:1;
882 * set to the Thread ID that's doing the service loop just before entry
883 * to poll indicates service thread likely idling in poll()
884 * volatile because other threads may check it as part of processing
885 * for pollfd event change.
887 volatile int service_tid;
888 int service_tid_detected;
890 short max_http_header_pool;
892 short plugin_protocol_count;
893 short plugin_extension_count;
894 short server_string_len;
895 unsigned short ws_ping_pong_interval;
896 unsigned short deprecation_pending_listen_close_count;
899 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
900 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
903 lws_close_free_wsi_final(struct lws *wsi);
905 lws_libuv_closehandle(struct lws *wsi);
907 LWS_VISIBLE LWS_EXTERN int
908 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
910 LWS_VISIBLE LWS_EXTERN int
911 lws_plat_plugins_destroy(struct lws_context * context);
914 lws_restart_ws_ping_pong_timer(struct lws *wsi);
917 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
921 LWS_EV_READ = (1 << 0),
922 LWS_EV_WRITE = (1 << 1),
923 LWS_EV_START = (1 << 2),
924 LWS_EV_STOP = (1 << 3),
926 LWS_EV_PREPARE_DELETION = (1 << 31),
929 #if defined(LWS_USE_LIBEV)
931 lws_libev_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
933 lws_libev_io(struct lws *wsi, int flags);
935 lws_libev_init_fd_table(struct lws_context *context);
937 lws_libev_destroyloop(struct lws_context *context, int tsi);
939 lws_libev_run(const struct lws_context *context, int tsi);
940 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
941 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
943 #define lws_libev_accept(_a, _b) ((void) 0)
944 #define lws_libev_io(_a, _b) ((void) 0)
945 #define lws_libev_init_fd_table(_a) (0)
946 #define lws_libev_run(_a, _b) ((void) 0)
947 #define lws_libev_destroyloop(_a, _b) ((void) 0)
948 #define LWS_LIBEV_ENABLED(context) (0)
949 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
950 #define lws_feature_status_libev(_a) \
951 lwsl_notice("libev support not compiled in\n")
953 #define lws_feature_status_libev(_a)
957 #if defined(LWS_USE_LIBUV)
959 lws_libuv_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
961 lws_libuv_io(struct lws *wsi, int flags);
963 lws_libuv_init_fd_table(struct lws_context *context);
965 lws_libuv_run(const struct lws_context *context, int tsi);
967 lws_libuv_destroyloop(struct lws_context *context, int tsi);
969 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
970 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
971 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
973 #define lws_libuv_accept(_a, _b) ((void) 0)
974 #define lws_libuv_io(_a, _b) ((void) 0)
975 #define lws_libuv_init_fd_table(_a) (0)
976 #define lws_libuv_run(_a, _b) ((void) 0)
977 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
978 #define LWS_LIBUV_ENABLED(context) (0)
979 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
980 #define lws_feature_status_libuv(_a) \
981 lwsl_notice("libuv support not compiled in\n")
983 #define lws_feature_status_libuv(_a)
989 #define LWS_IPV6_ENABLED(vh) \
990 (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
991 !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
993 #define LWS_IPV6_ENABLED(context) (0)
996 #ifdef LWS_USE_UNIX_SOCK
997 #define LWS_UNIX_SOCK_ENABLED(vhost) \
998 (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1000 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1002 enum uri_path_states {
1005 URIPS_SEEN_SLASH_DOT,
1006 URIPS_SEEN_SLASH_DOT_DOT,
1009 enum uri_esc_states {
1012 URIES_SEEN_PERCENT_H1,
1015 /* notice that these union members:
1021 * all have a pointer to allocated_headers struct as their first member.
1023 * It means for allocated_headers access, the three union paths can all be
1024 * used interchangeably to access the same data
1028 #ifndef LWS_NO_CLIENT
1029 struct client_info_stash {
1039 struct _lws_header_related {
1040 /* MUST be first in struct */
1041 struct allocated_headers *ah;
1042 struct lws *ah_wait_list;
1043 unsigned char *preamble_rx;
1044 #ifndef LWS_NO_CLIENT
1045 struct client_info_stash *stash;
1047 unsigned int preamble_rx_len;
1048 enum uri_path_states ups;
1049 enum uri_esc_states ues;
1051 unsigned int current_token_limit;
1054 char post_literal_equal;
1055 unsigned char parser_state; /* enum lws_token_indexes */
1058 #if defined(LWS_WITH_RANGES)
1060 LWSRS_NO_ACTIVE_RANGE,
1069 struct lws_range_parsing {
1070 unsigned long long start, end, extent, agg, budget;
1071 const char buf[128];
1073 enum range_states state;
1074 char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1078 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1080 lws_ranges_next(struct lws_range_parsing *rp);
1082 lws_ranges_reset(struct lws_range_parsing *rp);
1085 struct _lws_http_mode_related {
1086 /* MUST be first in struct */
1087 struct allocated_headers *ah; /* mirroring _lws_header_related */
1088 struct lws *ah_wait_list;
1089 unsigned char *preamble_rx;
1090 #ifndef LWS_NO_CLIENT
1091 struct client_info_stash *stash;
1093 unsigned int preamble_rx_len;
1094 struct lws *new_wsi_list;
1095 unsigned long filepos;
1096 unsigned long filelen;
1099 #if defined(LWS_WITH_RANGES)
1100 struct lws_range_parsing range;
1101 char multipart_content_type[64];
1104 enum http_version request_version;
1105 enum http_connection_type connection_type;
1106 unsigned int content_length;
1107 unsigned int content_remain;
1110 #ifdef LWS_USE_HTTP2
1112 enum lws_http2_settings {
1113 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1114 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1115 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1116 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1117 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1118 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1120 LWS_HTTP2_SETTINGS__COUNT /* always last */
1123 enum lws_http2_wellknown_frame_types {
1124 LWS_HTTP2_FRAME_TYPE_DATA,
1125 LWS_HTTP2_FRAME_TYPE_HEADERS,
1126 LWS_HTTP2_FRAME_TYPE_PRIORITY,
1127 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1128 LWS_HTTP2_FRAME_TYPE_SETTINGS,
1129 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1130 LWS_HTTP2_FRAME_TYPE_PING,
1131 LWS_HTTP2_FRAME_TYPE_GOAWAY,
1132 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1133 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1135 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1138 enum lws_http2_flags {
1139 LWS_HTTP2_FLAG_END_STREAM = 1,
1140 LWS_HTTP2_FLAG_END_HEADERS = 4,
1141 LWS_HTTP2_FLAG_PADDED = 8,
1142 LWS_HTTP2_FLAG_PRIORITY = 0x20,
1144 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1147 #define LWS_HTTP2_STREAM_ID_MASTER 0
1148 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1149 #define LWS_HTTP2_SETTINGS_LENGTH 6
1151 struct http2_settings {
1152 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1155 enum http2_hpack_state {
1157 /* optional before first header block */
1159 HKPS_OPT_E_DEPENDENCY,
1172 /* optional after last header block */
1173 HKPS_OPT_DISCARD_PADDING,
1176 enum http2_hpack_type {
1178 HPKT_INDEXED_HDR_6_VALUE_INCR,
1179 HPKT_LITERAL_HDR_VALUE_INCR,
1180 HPKT_INDEXED_HDR_4_VALUE,
1181 HPKT_LITERAL_HDR_VALUE,
1185 struct hpack_dt_entry {
1186 int token; /* additions that don't map to a token are ignored */
1191 struct hpack_dynamic_table {
1192 struct hpack_dt_entry *entries;
1200 struct _lws_http2_related {
1202 * having this first lets us also re-use all HTTP union code
1203 * and in turn, http_mode_related has allocated headers in right
1204 * place so we can use the header apis on the wsi directly still
1206 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1208 struct http2_settings my_settings;
1209 struct http2_settings peer_settings;
1211 struct lws *parent_wsi;
1212 struct lws *next_child_wsi;
1214 struct hpack_dynamic_table *hpack_dyn_table;
1215 struct lws *stream_wsi;
1216 unsigned char ping_payload[8];
1217 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1220 unsigned int length;
1221 unsigned int stream_id;
1222 enum http2_hpack_state hpack;
1223 enum http2_hpack_type hpack_type;
1224 unsigned int header_index;
1225 unsigned int hpack_len;
1226 unsigned int hpack_e_dep;
1228 unsigned int my_stream_id;
1229 unsigned int child_count;
1232 unsigned int END_STREAM:1;
1233 unsigned int END_HEADERS:1;
1234 unsigned int send_END_STREAM:1;
1235 unsigned int GOING_AWAY;
1236 unsigned int requested_POLLOUT:1;
1237 unsigned int waiting_tx_credit:1;
1238 unsigned int huff:1;
1239 unsigned int value:1;
1241 unsigned short round_robin_POLLOUT;
1242 unsigned short count_POLLOUT_children;
1243 unsigned short hpack_pos;
1246 unsigned char flags;
1247 unsigned char frame_state;
1248 unsigned char padding;
1249 unsigned char hpack_m;
1250 unsigned char initialized;
1253 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1257 struct _lws_websocket_related {
1258 /* cheapest way to deal with ah overlap with ws union transition */
1259 struct _lws_header_related hdr;
1261 unsigned int rx_ubuf_alloc;
1262 struct lws *rx_draining_ext_list;
1263 struct lws *tx_draining_ext_list;
1264 time_t time_next_ping_check;
1265 size_t rx_packet_length;
1266 unsigned int rx_ubuf_head;
1267 unsigned char mask[4];
1268 /* Also used for close content... control opcode == < 128 */
1269 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1271 unsigned char ping_payload_len;
1272 unsigned char mask_idx;
1273 unsigned char opcode;
1275 unsigned char rsv_first_msg;
1276 /* zero if no info, or length including 2-byte close code */
1277 unsigned char close_in_ping_buffer_len;
1279 unsigned char stashed_write_type;
1280 unsigned char tx_draining_stashed_wp;
1282 unsigned int final:1;
1283 unsigned int frame_is_binary:1;
1284 unsigned int all_zero_nonce:1;
1285 unsigned int this_frame_masked:1;
1286 unsigned int inside_frame:1; /* next write will be more of frame */
1287 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1288 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1289 unsigned int ping_pending_flag:1;
1290 unsigned int continuation_possible:1;
1291 unsigned int owed_a_fin:1;
1292 unsigned int check_utf8:1;
1293 unsigned int defeat_check_utf8:1;
1294 unsigned int pmce_compressed_message:1;
1295 unsigned int stashed_write_pending:1;
1296 unsigned int rx_draining_ext:1;
1297 unsigned int tx_draining_ext:1;
1298 unsigned int send_check_ping:1;
1303 /* wsi who is master of the cgi points to an lws_cgi */
1306 struct lws_cgi *cgi_list;
1307 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1308 struct lws *wsi; /* owner */
1309 unsigned long content_length;
1310 unsigned long content_length_seen;
1314 unsigned int being_closed:1;
1316 unsigned char chunked_grace;
1320 signed char char_to_hex(const char c);
1322 #ifndef LWS_NO_CLIENT
1323 enum lws_chunk_parser {
1334 #ifdef LWS_WITH_ACCESS_LOG
1335 struct lws_access_log {
1346 /* members with mutually exclusive lifetimes are unionized */
1349 struct _lws_http_mode_related http;
1350 #ifdef LWS_USE_HTTP2
1351 struct _lws_http2_related http2;
1353 struct _lws_header_related hdr;
1354 struct _lws_websocket_related ws;
1357 /* lifetime members */
1359 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1360 struct lws_io_watcher w_read;
1362 #if defined(LWS_USE_LIBEV)
1363 struct lws_io_watcher w_write;
1365 time_t pending_timeout_limit;
1369 struct lws_context *context;
1370 struct lws_vhost *vhost;
1371 struct lws *parent; /* points to parent, if any */
1372 struct lws *child_list; /* points to first child */
1373 struct lws *sibling_list; /* subsequent children at same level */
1375 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1377 const struct lws_protocols *protocol;
1378 struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1379 struct lws *timeout_list;
1380 struct lws **timeout_list_prev;
1381 #ifdef LWS_WITH_ACCESS_LOG
1382 struct lws_access_log access_log;
1385 /* rxflow handling */
1386 unsigned char *rxflow_buffer;
1387 /* truncated send handling */
1388 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1390 #if defined (LWS_WITH_ESP8266)
1392 unsigned short prem_rx_size, prem_rx_pos;
1395 #ifndef LWS_NO_EXTENSIONS
1396 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1397 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1399 #ifdef LWS_OPENSSL_SUPPORT
1402 struct lws *pending_read_list_prev, *pending_read_list_next;
1404 #ifdef LWS_WITH_HTTP_PROXY
1405 struct lws_rewrite *rw;
1408 unsigned long action_start;
1409 unsigned long latency_start;
1412 lws_sockfd_type sock;
1415 int position_in_fds_table;
1418 unsigned int trunc_alloc_len; /* size of malloc */
1419 unsigned int trunc_offset; /* where we are in terms of spilling */
1420 unsigned int trunc_len; /* how much is buffered */
1421 #ifndef LWS_NO_CLIENT
1422 int chunk_remaining;
1424 unsigned int cache_secs;
1426 unsigned int hdr_parsing_completed:1;
1427 unsigned int http2_substream:1;
1428 unsigned int listener:1;
1429 unsigned int user_space_externally_allocated:1;
1430 unsigned int socket_is_permanently_unusable:1;
1431 unsigned int rxflow_change_to:2;
1432 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1433 unsigned int conn_stat_done:1;
1434 unsigned int cache_reuse:1;
1435 unsigned int cache_revalidate:1;
1436 unsigned int cache_intermediaries:1;
1437 unsigned int favoured_pollin:1;
1438 unsigned int sending_chunked:1;
1439 unsigned int already_did_cce:1;
1440 unsigned int told_user_closed:1;
1442 #if defined(LWS_WITH_ESP8266)
1443 unsigned int pending_send_completion:3;
1444 unsigned int close_is_pending_send_completion:1;
1446 #ifdef LWS_WITH_ACCESS_LOG
1447 unsigned int access_log_pending:1;
1449 #ifndef LWS_NO_CLIENT
1450 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1451 unsigned int chunked:1; /* if the clientside connection is chunked */
1452 unsigned int client_rx_avail:1;
1453 unsigned int client_http_body_pending:1;
1455 #ifdef LWS_WITH_HTTP_PROXY
1456 unsigned int perform_rewrite:1;
1458 #ifndef LWS_NO_EXTENSIONS
1459 unsigned int extension_data_pending:1;
1461 #ifdef LWS_OPENSSL_SUPPORT
1462 unsigned int use_ssl:4;
1465 unsigned int sock_send_blocking:1;
1467 #ifdef LWS_OPENSSL_SUPPORT
1468 unsigned int redirect_to_https:1;
1471 #ifndef LWS_NO_CLIENT
1472 unsigned short c_port;
1476 #ifndef LWS_NO_EXTENSIONS
1477 unsigned char count_act_ext;
1479 unsigned char ietf_spec_revision;
1480 char mode; /* enum connection_mode */
1481 char state; /* enum lws_connection_states */
1482 char state_pre_close;
1483 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1484 char rx_frame_type; /* enum lws_write_protocol */
1485 char pending_timeout; /* enum pending_timeout */
1486 char pps; /* enum lws_pending_protocol_send */
1487 char tsi; /* thread service index we belong to */
1488 char protocol_interpret_idx;
1491 char cgi_channel; /* which of stdin/out/err */
1494 #ifndef LWS_NO_CLIENT
1495 char chunk_parser; /* enum lws_chunk_parser */
1497 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1498 char reason_bf; /* internal writeable callback reason bitfield */
1502 LWS_EXTERN int log_level;
1505 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1509 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1512 remove_wsi_socket_from_fds(struct lws *wsi);
1514 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1518 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1519 int ret, int completion) {
1521 (void)context; (void)wsi; (void)action; (void)ret;
1526 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1527 do { (void)context; (void)wsi; } while (0);
1530 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1532 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1533 int ret, int completion);
1537 lws_set_protocol_write_pending(struct lws *wsi,
1538 enum lws_pending_protocol_send pend);
1539 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1540 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1542 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1543 lws_parse(struct lws *wsi, unsigned char c);
1545 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1546 lws_http_action(struct lws *wsi);
1549 lws_b64_selftest(void);
1552 lws_service_flag_pending(struct lws_context *context, int tsi);
1554 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1555 LWS_EXTERN struct lws *
1556 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1559 insert_wsi(struct lws_context *context, struct lws *wsi);
1562 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1564 #define wsi_from_fd(A,B) A->lws_lookup[B]
1565 #define insert_wsi(A,B) assert(A->lws_lookup[B->sock] == 0); A->lws_lookup[B->sock]=B
1566 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1569 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1570 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1572 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1573 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1576 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1577 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1580 lws_remove_from_timeout_list(struct lws *wsi);
1582 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1583 lws_client_connect_2(struct lws *wsi);
1585 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1586 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1587 const char *path, const char *host);
1589 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1590 lws_create_new_server_wsi(struct lws_vhost *vhost);
1592 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1593 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1596 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1598 LWS_EXTERN struct lws *
1599 lws_client_connect_via_info2(struct lws *wsi);
1605 #ifndef LWS_NO_EXTENSIONS
1607 lws_context_init_extensions(struct lws_context_creation_info *info,
1608 struct lws_context *context);
1610 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1611 void *v, size_t len);
1614 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1616 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1617 void *arg, int len);
1620 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1621 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1622 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1623 #define lws_issue_raw_ext_access lws_issue_raw
1624 #define lws_context_init_extensions(_a, _b)
1627 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1628 lws_client_interpret_server_handshake(struct lws *wsi);
1630 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1631 lws_rx_sm(struct lws *wsi, unsigned char c);
1634 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1636 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1637 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1640 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1642 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1643 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1644 enum lws_callback_reasons reason, void *user,
1645 void *in, size_t len);
1646 #ifdef LWS_USE_HTTP2
1647 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1648 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1650 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1651 unsigned char *buf, int len);
1652 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1654 lws_http2_parser(struct lws *wsi, unsigned char c);
1655 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1657 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1658 unsigned int sid, unsigned int len,
1659 unsigned char *buf);
1660 LWS_EXTERN struct lws *
1661 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1662 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1665 lws_add_http2_header_by_name(struct lws *wsi,
1666 const unsigned char *name,
1667 const unsigned char *value, int length,
1668 unsigned char **p, unsigned char *end);
1670 lws_add_http2_header_by_token(struct lws *wsi,
1671 enum lws_token_indexes token,
1672 const unsigned char *value, int length,
1673 unsigned char **p, unsigned char *end);
1675 lws_add_http2_header_status(struct lws *wsi,
1676 unsigned int code, unsigned char **p,
1677 unsigned char *end);
1679 void lws_http2_configure_if_upgraded(struct lws *wsi);
1681 #define lws_http2_configure_if_upgraded(x)
1685 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1688 lws_plat_check_connection_error(struct lws *wsi);
1690 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1691 lws_header_table_attach(struct lws *wsi, int autoservice);
1694 lws_header_table_detach(struct lws *wsi, int autoservice);
1697 lws_header_table_reset(struct lws *wsi, int autoservice);
1699 _lws_header_table_reset(struct allocated_headers *ah);
1701 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1702 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1704 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1705 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1707 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1708 lws_ensure_user_space(struct lws *wsi);
1711 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1713 #ifndef LWS_NO_SERVER
1714 int lws_context_init_server(struct lws_context_creation_info *info,
1715 struct lws_vhost *vhost);
1716 LWS_EXTERN struct lws_vhost *
1717 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1719 handshake_0405(struct lws_context *context, struct lws *wsi);
1720 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1721 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1723 lws_server_get_canonical_hostname(struct lws_context *context,
1724 struct lws_context_creation_info *info);
1726 #define lws_context_init_server(_a, _b) (0)
1727 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1728 #define lws_server_get_canonical_hostname(_a, _b)
1731 #ifndef LWS_NO_DAEMONIZE
1732 LWS_EXTERN int get_daemonize_pid();
1734 #define get_daemonize_pid() (0)
1737 #if !defined(LWS_WITH_ESP8266)
1738 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1739 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1740 struct sockaddr_in *addr, size_t addrlen);
1742 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1744 enum lws_ssl_capable_status {
1745 LWS_SSL_CAPABLE_ERROR = -1,
1746 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1749 #ifndef LWS_OPENSSL_SUPPORT
1750 #define LWS_SSL_ENABLED(context) (0)
1751 #define lws_context_init_server_ssl(_a, _b) (0)
1752 #define lws_ssl_destroy(_a)
1753 #define lws_context_init_http2_ssl(_a)
1754 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1755 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1756 #define lws_ssl_pending lws_ssl_pending_no_ssl
1757 #define lws_server_socket_service_ssl(_b, _c) (0)
1758 #define lws_ssl_close(_a) (0)
1759 #define lws_ssl_context_destroy(_a)
1760 #define lws_ssl_SSL_CTX_destroy(_a)
1761 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1762 #define lws_context_init_ssl_library(_a)
1764 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1765 LWS_EXTERN int openssl_websocket_private_data_index;
1766 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1767 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1768 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1769 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1770 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1771 lws_ssl_pending(struct lws *wsi);
1773 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1774 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1775 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1777 lws_ssl_close(struct lws *wsi);
1779 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1781 lws_ssl_context_destroy(struct lws_context *context);
1783 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1785 lws_ssl_client_bio_create(struct lws *wsi);
1787 lws_ssl_client_connect1(struct lws *wsi);
1789 lws_ssl_client_connect2(struct lws *wsi);
1791 lws_ssl_elaborate_error(void);
1792 #ifndef LWS_NO_SERVER
1794 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1795 struct lws_vhost *vhost);
1797 #define lws_context_init_server_ssl(_a, _b) (0)
1800 lws_ssl_destroy(struct lws_vhost *vhost);
1804 #ifdef LWS_USE_HTTP2
1806 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1808 #define lws_context_init_http2_ssl(_a)
1813 static LWS_INLINE void
1814 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1816 pthread_mutex_init(&pt->lock, NULL);
1819 static LWS_INLINE void
1820 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
1822 pthread_mutex_destroy(&pt->lock);
1825 static LWS_INLINE void
1826 lws_pt_lock(struct lws_context_per_thread *pt)
1828 if (!pt->lock_depth++)
1829 pthread_mutex_lock(&pt->lock);
1832 static LWS_INLINE void
1833 lws_pt_unlock(struct lws_context_per_thread *pt)
1835 if (!(--pt->lock_depth))
1836 pthread_mutex_unlock(&pt->lock);
1839 #define lws_pt_mutex_init(_a) (void)(_a)
1840 #define lws_pt_mutex_destroy(_a) (void)(_a)
1841 #define lws_pt_lock(_a) (void)(_a)
1842 #define lws_pt_unlock(_a) (void)(_a)
1845 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1846 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1848 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1849 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1851 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1852 lws_ssl_pending_no_ssl(struct lws *wsi);
1854 #ifdef LWS_WITH_HTTP_PROXY
1855 struct lws_rewrite {
1856 hubbub_parser *parser;
1857 hubbub_parser_optparams params;
1858 const char *from, *to;
1859 int from_len, to_len;
1860 unsigned char *p, *end;
1863 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1868 return strncmp((const char *)s->ptr, p, len);
1870 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1871 LWS_EXTERN struct lws_rewrite *
1872 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1874 lws_rewrite_destroy(struct lws_rewrite *r);
1876 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1879 #ifndef LWS_NO_CLIENT
1880 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1882 struct lws_pollfd *pollfd);
1883 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1884 lws_http_transaction_completed_client(struct lws *wsi);
1885 #ifdef LWS_OPENSSL_SUPPORT
1887 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1888 struct lws_vhost *vhost);
1890 #define lws_context_init_client_ssl(_a, _b) (0)
1892 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1893 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1895 lws_decode_ssl_error(void);
1897 #define lws_context_init_client_ssl(_a, _b) (0)
1898 #define lws_handshake_client(_a, _b, _c) (0)
1902 _lws_rx_flow_control(struct lws *wsi);
1905 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1907 #ifndef LWS_NO_SERVER
1909 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1910 struct lws_pollfd *pollfd);
1912 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1914 #define lws_server_socket_service(_a, _b, _c) (0)
1915 #define lws_handshake_server(_a, _b, _c) (0)
1918 #ifdef LWS_WITH_ACCESS_LOG
1920 lws_access_log(struct lws *wsi);
1922 #define lws_access_log(_a)
1926 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1929 lws_protocol_init(struct lws_context *context);
1932 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
1934 const struct lws_http_mount *
1935 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
1941 lws_realloc(void *ptr, size_t size);
1943 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1944 lws_zalloc(size_t size);
1946 #ifdef LWS_PLAT_OPTEE
1947 void *lws_malloc(size_t size);
1948 void lws_free(void *p);
1949 #define lws_free_set_NULL(P) do { lws_free(P); (P) = NULL; } while(0)
1951 #define lws_malloc(S) lws_realloc(NULL, S)
1952 #define lws_free(P) lws_realloc(P, 0)
1953 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
1958 lws_plat_delete_socket_from_fds(struct lws_context *context,
1959 struct lws *wsi, int m);
1961 lws_plat_insert_socket_into_fds(struct lws_context *context,
1964 lws_plat_service_periodic(struct lws_context *context);
1967 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1968 struct lws_pollfd *pfd);
1970 lws_plat_context_early_init(void);
1972 lws_plat_context_early_destroy(struct lws_context *context);
1974 lws_plat_context_late_destroy(struct lws_context *context);
1976 lws_poll_listen_fd(struct lws_pollfd *fd);
1978 lws_plat_service(struct lws_context *context, int timeout_ms);
1979 LWS_EXTERN LWS_VISIBLE int
1980 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1982 lws_plat_init(struct lws_context *context,
1983 struct lws_context_creation_info *info);
1985 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1986 LWS_EXTERN unsigned long long
1987 time_in_microseconds(void);
1988 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1989 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
1991 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1992 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);