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 */
546 LWSCM_RAW, /* raw with bulk handling */
547 LWSCM_RAW_FILEDESC, /* raw without bulk handling */
549 /* HTTP Client related */
550 LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
551 LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
552 LWSCM_WSCL_WAITING_CONNECT,
553 LWSCM_WSCL_WAITING_PROXY_REPLY,
554 LWSCM_WSCL_ISSUE_HANDSHAKE,
555 LWSCM_WSCL_ISSUE_HANDSHAKE2,
556 LWSCM_WSCL_ISSUE_HTTP_BODY,
557 LWSCM_WSCL_WAITING_SSL,
558 LWSCM_WSCL_WAITING_SERVER_REPLY,
559 LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
560 LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
562 /****** add new things just above ---^ ******/
568 LWS_RXFLOW_ALLOW = (1 << 0),
569 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
572 /* this is not usable directly by user code any more, lws_close_reason() */
573 #define LWS_WRITE_CLOSE 4
575 struct lws_protocols;
578 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
580 struct lws_io_watcher {
585 uv_poll_t uv_watcher;
587 struct lws_context *context;
590 struct lws_signal_watcher {
592 ev_signal ev_watcher;
595 uv_signal_t uv_watcher;
597 struct lws_context *context;
602 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
603 struct lws_fd_hashtable {
610 * This is totally opaque to code using the library. It's exported as a
611 * forward-reference pointer-only declaration; the user can use the pointer with
612 * other APIs to get information out of it.
615 struct lws_fragments {
618 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
622 * these are assigned from a pool held in the context.
623 * Both client and server mode uses them for http header analysis
626 struct allocated_headers {
627 struct lws *wsi; /* owner */
628 char *data; /* prepared by context init to point to dedicated storage */
630 * the randomly ordered fragments, indexed by frag_index and
631 * lws_fragments->nfrag for continuation.
633 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
636 * for each recognized token, frag_index says which frag[] his data
637 * starts in (0 means the token did not appear)
638 * the actual header data gets dumped as it comes in, into data[]
640 unsigned char frag_index[WSI_TOKEN_COUNT];
641 unsigned char rx[2048];
647 unsigned int http_response;
649 #ifndef LWS_NO_CLIENT
650 char initial_handshake_hash_base64[30];
653 unsigned char in_use;
658 * so we can have n connections being serviced simultaneously,
659 * these things need to be isolated per-thread.
662 struct lws_context_per_thread {
664 pthread_mutex_t lock;
666 struct lws_pollfd *fds;
667 #if defined(LWS_WITH_ESP8266)
668 struct lws **lws_vs_fds_index;
670 struct lws *rx_draining_ext_list;
671 struct lws *tx_draining_ext_list;
672 struct lws *timeout_list;
674 struct lws_context *context;
677 struct lws_cgi *cgi_list;
679 void *http_header_data;
680 struct allocated_headers *ah_pool;
681 struct lws *ah_wait_list;
682 int ah_wait_list_length;
683 #ifdef LWS_OPENSSL_SUPPORT
684 struct lws *pending_read_list; /* linked list */
686 #if defined(LWS_USE_LIBEV)
687 struct ev_loop *io_loop_ev;
689 #if defined(LWS_USE_LIBUV)
690 uv_loop_t *io_loop_uv;
691 uv_signal_t signals[8];
692 uv_timer_t uv_timeout_watcher;
695 #if defined(LWS_USE_LIBEV)
696 struct lws_io_watcher w_accept;
698 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
699 struct lws_signal_watcher w_sigint;
700 unsigned char ev_loop_foreign:1;
703 unsigned long count_conns;
705 * usable by anything in the service code, but only if the scope
706 * does not last longer than the service action (since next service
707 * of any socket can likewise use it and overwrite)
709 unsigned char *serv_buf;
713 lws_sockfd_type dummy_pipe_fds[2];
715 unsigned int fds_count;
717 short ah_count_in_use;
719 unsigned char lock_depth;
722 struct lws_conn_stats {
723 unsigned long long rx, tx;
724 unsigned long conn, trans, ws_upg, http2_upg, rejected;
728 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
731 * virtual host -related context information
732 * vhostwide SSL context
737 * context -> vhost -> wsi
739 * incoming connection non-SSL vhost binding:
741 * listen socket -> wsi -> select vhost after first headers
743 * incoming connection SSL vhost binding:
745 * SSL SNI -> wsi -> bind after SSL negotiation
749 #if !defined(LWS_WITH_ESP8266)
750 char http_proxy_address[128];
751 char proxy_basic_auth_token[128];
753 #if defined(LWS_WITH_ESP8266)
754 /* listen sockets need a place to hang their hat */
757 struct lws_conn_stats conn_stats;
758 struct lws_context *context;
759 struct lws_vhost *vhost_next;
760 const struct lws_http_mount *mount_list;
761 struct lws *lserv_wsi;
764 const struct lws_protocols *protocols;
765 void **protocol_vh_privs;
766 const struct lws_protocol_vhost_options *pvo;
767 const struct lws_protocol_vhost_options *headers;
768 struct lws **same_vh_protocol_list;
769 #ifdef LWS_OPENSSL_SUPPORT
771 SSL_CTX *ssl_client_ctx;
773 #ifndef LWS_NO_EXTENSIONS
774 const struct lws_extension *extensions;
778 unsigned int http_proxy_port;
779 unsigned int options;
784 int keepalive_timeout;
785 #ifdef LWS_WITH_ACCESS_LOG
789 #ifdef LWS_OPENSSL_SUPPORT
791 int allow_non_ssl_on_ssl_port;
792 unsigned int user_supplied_ssl_ctx:1;
795 unsigned int created_vhost_protocols:1;
797 unsigned char default_protocol_index;
801 * the rest is managed per-context, that includes
803 * - processwide single fd -> wsi lookup
804 * - contextwide headers pool
808 time_t last_timeout_check_s;
809 time_t last_ws_ping_pong_check_s;
811 const struct lws_plat_file_ops *fops;
812 struct lws_plat_file_ops fops_platform;
813 #if defined(LWS_WITH_ZIP_FOPS)
814 struct lws_plat_file_ops fops_zip;
816 struct lws_context_per_thread pt[LWS_MAX_SMP];
817 struct lws_conn_stats conn_stats;
819 /* different implementation between unix and windows */
820 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
822 #if defined(LWS_WITH_ESP8266)
823 struct espconn **connpool; /* .reverse points to the wsi */
828 struct lws **lws_lookup; /* fd to wsi */
831 struct lws_vhost *vhost_list;
832 struct lws_plugin *plugin_list;
834 void *external_baggage_free_on_destroy;
835 const struct lws_token_limits *token_limits;
837 const char *server_string;
838 const struct lws_protocol_vhost_options *reject_service_keywords;
839 lws_reload_func deprecation_cb;
841 #if defined(LWS_USE_LIBEV)
842 lws_ev_signal_cb_t * lws_ev_sigint_cb;
844 #if defined(LWS_USE_LIBUV)
845 uv_signal_cb lws_uv_sigint_cb;
847 char canonical_hostname[128];
849 unsigned long worst_latency;
850 char worst_latency_info[256];
854 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
857 int started_with_parent;
861 #ifdef LWS_OPENSSL_SUPPORT
862 #define lws_ssl_anybody_has_buffered_read(w) \
863 (w->vhost->use_ssl && \
864 w->context->pt[(int)w->tsi].pending_read_list)
865 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
866 (/*c->use_ssl && */ \
867 c->pt[(int)t].pending_read_list)
869 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
870 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
872 int count_wsi_allocated;
873 int count_cgi_spawned;
874 unsigned int options;
875 unsigned int fd_limit_per_thread;
876 unsigned int timeout_secs;
877 unsigned int pt_serv_buf_size;
878 int max_http_header_data;
880 unsigned int deprecated:1;
881 unsigned int being_destroyed:1;
882 unsigned int being_destroyed1:1;
883 unsigned int requested_kill:1;
884 unsigned int protocol_init_done:1;
887 * set to the Thread ID that's doing the service loop just before entry
888 * to poll indicates service thread likely idling in poll()
889 * volatile because other threads may check it as part of processing
890 * for pollfd event change.
892 volatile int service_tid;
893 int service_tid_detected;
895 short max_http_header_pool;
897 short plugin_protocol_count;
898 short plugin_extension_count;
899 short server_string_len;
900 unsigned short ws_ping_pong_interval;
901 unsigned short deprecation_pending_listen_close_count;
905 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
906 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
909 lws_close_free_wsi_final(struct lws *wsi);
911 lws_libuv_closehandle(struct lws *wsi);
913 LWS_VISIBLE LWS_EXTERN int
914 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
916 LWS_VISIBLE LWS_EXTERN int
917 lws_plat_plugins_destroy(struct lws_context * context);
920 lws_restart_ws_ping_pong_timer(struct lws *wsi);
923 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
927 LWS_EV_READ = (1 << 0),
928 LWS_EV_WRITE = (1 << 1),
929 LWS_EV_START = (1 << 2),
930 LWS_EV_STOP = (1 << 3),
932 LWS_EV_PREPARE_DELETION = (1 << 31),
935 #if defined(LWS_USE_LIBEV)
937 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
939 lws_libev_io(struct lws *wsi, int flags);
941 lws_libev_init_fd_table(struct lws_context *context);
943 lws_libev_destroyloop(struct lws_context *context, int tsi);
945 lws_libev_run(const struct lws_context *context, int tsi);
946 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
947 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
949 #define lws_libev_accept(_a, _b) ((void) 0)
950 #define lws_libev_io(_a, _b) ((void) 0)
951 #define lws_libev_init_fd_table(_a) (0)
952 #define lws_libev_run(_a, _b) ((void) 0)
953 #define lws_libev_destroyloop(_a, _b) ((void) 0)
954 #define LWS_LIBEV_ENABLED(context) (0)
955 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
956 #define lws_feature_status_libev(_a) \
957 lwsl_notice("libev support not compiled in\n")
959 #define lws_feature_status_libev(_a)
963 #if defined(LWS_USE_LIBUV)
965 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
967 lws_libuv_io(struct lws *wsi, int flags);
969 lws_libuv_init_fd_table(struct lws_context *context);
971 lws_libuv_run(const struct lws_context *context, int tsi);
973 lws_libuv_destroyloop(struct lws_context *context, int tsi);
975 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
976 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
977 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
979 #define lws_libuv_accept(_a, _b) ((void) 0)
980 #define lws_libuv_io(_a, _b) ((void) 0)
981 #define lws_libuv_init_fd_table(_a) (0)
982 #define lws_libuv_run(_a, _b) ((void) 0)
983 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
984 #define LWS_LIBUV_ENABLED(context) (0)
985 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
986 #define lws_feature_status_libuv(_a) \
987 lwsl_notice("libuv support not compiled in\n")
989 #define lws_feature_status_libuv(_a)
995 #define LWS_IPV6_ENABLED(vh) \
996 (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
997 !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
999 #define LWS_IPV6_ENABLED(context) (0)
1002 #ifdef LWS_USE_UNIX_SOCK
1003 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1004 (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1006 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1008 enum uri_path_states {
1011 URIPS_SEEN_SLASH_DOT,
1012 URIPS_SEEN_SLASH_DOT_DOT,
1015 enum uri_esc_states {
1018 URIES_SEEN_PERCENT_H1,
1021 /* notice that these union members:
1027 * all have a pointer to allocated_headers struct as their first member.
1029 * It means for allocated_headers access, the three union paths can all be
1030 * used interchangeably to access the same data
1034 #ifndef LWS_NO_CLIENT
1035 struct client_info_stash {
1045 struct _lws_header_related {
1046 /* MUST be first in struct */
1047 struct allocated_headers *ah;
1048 struct lws *ah_wait_list;
1049 unsigned char *preamble_rx;
1050 #ifndef LWS_NO_CLIENT
1051 struct client_info_stash *stash;
1053 unsigned int preamble_rx_len;
1054 enum uri_path_states ups;
1055 enum uri_esc_states ues;
1057 unsigned int current_token_limit;
1060 char post_literal_equal;
1061 unsigned char parser_state; /* enum lws_token_indexes */
1064 #if defined(LWS_WITH_RANGES)
1066 LWSRS_NO_ACTIVE_RANGE,
1075 struct lws_range_parsing {
1076 unsigned long long start, end, extent, agg, budget;
1077 const char buf[128];
1079 enum range_states state;
1080 char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1084 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1086 lws_ranges_next(struct lws_range_parsing *rp);
1088 lws_ranges_reset(struct lws_range_parsing *rp);
1091 struct _lws_http_mode_related {
1092 /* MUST be first in struct */
1093 struct allocated_headers *ah; /* mirroring _lws_header_related */
1094 struct lws *ah_wait_list;
1095 unsigned char *preamble_rx;
1096 #ifndef LWS_NO_CLIENT
1097 struct client_info_stash *stash;
1099 unsigned int preamble_rx_len;
1100 struct lws *new_wsi_list;
1101 lws_filepos_t filepos;
1102 lws_filepos_t filelen;
1103 lws_fop_fd_t fop_fd;
1105 #if defined(LWS_WITH_RANGES)
1106 struct lws_range_parsing range;
1107 char multipart_content_type[64];
1110 enum http_version request_version;
1111 enum http_connection_type connection_type;
1112 unsigned int content_length;
1113 unsigned int content_remain;
1116 #ifdef LWS_USE_HTTP2
1118 enum lws_http2_settings {
1119 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1120 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1121 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1122 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1123 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1124 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1126 LWS_HTTP2_SETTINGS__COUNT /* always last */
1129 enum lws_http2_wellknown_frame_types {
1130 LWS_HTTP2_FRAME_TYPE_DATA,
1131 LWS_HTTP2_FRAME_TYPE_HEADERS,
1132 LWS_HTTP2_FRAME_TYPE_PRIORITY,
1133 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1134 LWS_HTTP2_FRAME_TYPE_SETTINGS,
1135 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1136 LWS_HTTP2_FRAME_TYPE_PING,
1137 LWS_HTTP2_FRAME_TYPE_GOAWAY,
1138 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1139 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1141 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1144 enum lws_http2_flags {
1145 LWS_HTTP2_FLAG_END_STREAM = 1,
1146 LWS_HTTP2_FLAG_END_HEADERS = 4,
1147 LWS_HTTP2_FLAG_PADDED = 8,
1148 LWS_HTTP2_FLAG_PRIORITY = 0x20,
1150 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1153 #define LWS_HTTP2_STREAM_ID_MASTER 0
1154 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1155 #define LWS_HTTP2_SETTINGS_LENGTH 6
1157 struct http2_settings {
1158 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1161 enum http2_hpack_state {
1163 /* optional before first header block */
1165 HKPS_OPT_E_DEPENDENCY,
1178 /* optional after last header block */
1179 HKPS_OPT_DISCARD_PADDING,
1182 enum http2_hpack_type {
1184 HPKT_INDEXED_HDR_6_VALUE_INCR,
1185 HPKT_LITERAL_HDR_VALUE_INCR,
1186 HPKT_INDEXED_HDR_4_VALUE,
1187 HPKT_LITERAL_HDR_VALUE,
1191 struct hpack_dt_entry {
1192 int token; /* additions that don't map to a token are ignored */
1197 struct hpack_dynamic_table {
1198 struct hpack_dt_entry *entries;
1206 struct _lws_http2_related {
1208 * having this first lets us also re-use all HTTP union code
1209 * and in turn, http_mode_related has allocated headers in right
1210 * place so we can use the header apis on the wsi directly still
1212 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1214 struct http2_settings my_settings;
1215 struct http2_settings peer_settings;
1217 struct lws *parent_wsi;
1218 struct lws *next_child_wsi;
1220 struct hpack_dynamic_table *hpack_dyn_table;
1221 struct lws *stream_wsi;
1222 unsigned char ping_payload[8];
1223 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1226 unsigned int length;
1227 unsigned int stream_id;
1228 enum http2_hpack_state hpack;
1229 enum http2_hpack_type hpack_type;
1230 unsigned int header_index;
1231 unsigned int hpack_len;
1232 unsigned int hpack_e_dep;
1234 unsigned int my_stream_id;
1235 unsigned int child_count;
1238 unsigned int END_STREAM:1;
1239 unsigned int END_HEADERS:1;
1240 unsigned int send_END_STREAM:1;
1241 unsigned int GOING_AWAY;
1242 unsigned int requested_POLLOUT:1;
1243 unsigned int waiting_tx_credit:1;
1244 unsigned int huff:1;
1245 unsigned int value:1;
1247 unsigned short round_robin_POLLOUT;
1248 unsigned short count_POLLOUT_children;
1249 unsigned short hpack_pos;
1252 unsigned char flags;
1253 unsigned char frame_state;
1254 unsigned char padding;
1255 unsigned char hpack_m;
1256 unsigned char initialized;
1259 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1263 struct _lws_websocket_related {
1264 /* cheapest way to deal with ah overlap with ws union transition */
1265 struct _lws_header_related hdr;
1267 unsigned int rx_ubuf_alloc;
1268 struct lws *rx_draining_ext_list;
1269 struct lws *tx_draining_ext_list;
1270 time_t time_next_ping_check;
1271 size_t rx_packet_length;
1272 unsigned int rx_ubuf_head;
1273 unsigned char mask[4];
1274 /* Also used for close content... control opcode == < 128 */
1275 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1277 unsigned char ping_payload_len;
1278 unsigned char mask_idx;
1279 unsigned char opcode;
1281 unsigned char rsv_first_msg;
1282 /* zero if no info, or length including 2-byte close code */
1283 unsigned char close_in_ping_buffer_len;
1285 unsigned char stashed_write_type;
1286 unsigned char tx_draining_stashed_wp;
1288 unsigned int final:1;
1289 unsigned int frame_is_binary:1;
1290 unsigned int all_zero_nonce:1;
1291 unsigned int this_frame_masked:1;
1292 unsigned int inside_frame:1; /* next write will be more of frame */
1293 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1294 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1295 unsigned int ping_pending_flag:1;
1296 unsigned int continuation_possible:1;
1297 unsigned int owed_a_fin:1;
1298 unsigned int check_utf8:1;
1299 unsigned int defeat_check_utf8:1;
1300 unsigned int pmce_compressed_message:1;
1301 unsigned int stashed_write_pending:1;
1302 unsigned int rx_draining_ext:1;
1303 unsigned int tx_draining_ext:1;
1304 unsigned int send_check_ping:1;
1309 /* wsi who is master of the cgi points to an lws_cgi */
1312 struct lws_cgi *cgi_list;
1313 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1314 struct lws *wsi; /* owner */
1315 unsigned long content_length;
1316 unsigned long content_length_seen;
1320 unsigned int being_closed:1;
1322 unsigned char chunked_grace;
1326 signed char char_to_hex(const char c);
1328 #ifndef LWS_NO_CLIENT
1329 enum lws_chunk_parser {
1340 #ifdef LWS_WITH_ACCESS_LOG
1341 struct lws_access_log {
1352 /* members with mutually exclusive lifetimes are unionized */
1355 struct _lws_http_mode_related http;
1356 #ifdef LWS_USE_HTTP2
1357 struct _lws_http2_related http2;
1359 struct _lws_header_related hdr;
1360 struct _lws_websocket_related ws;
1363 /* lifetime members */
1365 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1366 struct lws_io_watcher w_read;
1368 #if defined(LWS_USE_LIBEV)
1369 struct lws_io_watcher w_write;
1371 time_t pending_timeout_limit;
1375 struct lws_context *context;
1376 struct lws_vhost *vhost;
1377 struct lws *parent; /* points to parent, if any */
1378 struct lws *child_list; /* points to first child */
1379 struct lws *sibling_list; /* subsequent children at same level */
1381 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1383 const struct lws_protocols *protocol;
1384 struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1385 struct lws *timeout_list;
1386 struct lws **timeout_list_prev;
1387 #ifdef LWS_WITH_ACCESS_LOG
1388 struct lws_access_log access_log;
1391 /* rxflow handling */
1392 unsigned char *rxflow_buffer;
1393 /* truncated send handling */
1394 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1396 #if defined (LWS_WITH_ESP8266)
1398 unsigned short prem_rx_size, prem_rx_pos;
1401 #ifndef LWS_NO_EXTENSIONS
1402 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1403 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1405 #ifdef LWS_OPENSSL_SUPPORT
1408 struct lws *pending_read_list_prev, *pending_read_list_next;
1410 #ifdef LWS_WITH_HTTP_PROXY
1411 struct lws_rewrite *rw;
1414 unsigned long action_start;
1415 unsigned long latency_start;
1417 lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1420 int position_in_fds_table;
1423 unsigned int trunc_alloc_len; /* size of malloc */
1424 unsigned int trunc_offset; /* where we are in terms of spilling */
1425 unsigned int trunc_len; /* how much is buffered */
1426 #ifndef LWS_NO_CLIENT
1427 int chunk_remaining;
1429 unsigned int cache_secs;
1431 unsigned int hdr_parsing_completed:1;
1432 unsigned int http2_substream:1;
1433 unsigned int listener:1;
1434 unsigned int user_space_externally_allocated:1;
1435 unsigned int socket_is_permanently_unusable:1;
1436 unsigned int rxflow_change_to:2;
1437 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1438 unsigned int conn_stat_done:1;
1439 unsigned int cache_reuse:1;
1440 unsigned int cache_revalidate:1;
1441 unsigned int cache_intermediaries:1;
1442 unsigned int favoured_pollin:1;
1443 unsigned int sending_chunked:1;
1444 unsigned int already_did_cce:1;
1445 unsigned int told_user_closed:1;
1447 #if defined(LWS_WITH_ESP8266)
1448 unsigned int pending_send_completion:3;
1449 unsigned int close_is_pending_send_completion:1;
1451 #ifdef LWS_WITH_ACCESS_LOG
1452 unsigned int access_log_pending:1;
1454 #ifndef LWS_NO_CLIENT
1455 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1456 unsigned int chunked:1; /* if the clientside connection is chunked */
1457 unsigned int client_rx_avail:1;
1458 unsigned int client_http_body_pending:1;
1460 #ifdef LWS_WITH_HTTP_PROXY
1461 unsigned int perform_rewrite:1;
1463 #ifndef LWS_NO_EXTENSIONS
1464 unsigned int extension_data_pending:1;
1466 #ifdef LWS_OPENSSL_SUPPORT
1467 unsigned int use_ssl:4;
1470 unsigned int sock_send_blocking:1;
1472 #ifdef LWS_OPENSSL_SUPPORT
1473 unsigned int redirect_to_https:1;
1476 #ifndef LWS_NO_CLIENT
1477 unsigned short c_port;
1481 #ifndef LWS_NO_EXTENSIONS
1482 unsigned char count_act_ext;
1484 unsigned char ietf_spec_revision;
1485 char mode; /* enum connection_mode */
1486 char state; /* enum lws_connection_states */
1487 char state_pre_close;
1488 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1489 char rx_frame_type; /* enum lws_write_protocol */
1490 char pending_timeout; /* enum pending_timeout */
1491 char pps; /* enum lws_pending_protocol_send */
1492 char tsi; /* thread service index we belong to */
1493 char protocol_interpret_idx;
1496 char cgi_channel; /* which of stdin/out/err */
1499 #ifndef LWS_NO_CLIENT
1500 char chunk_parser; /* enum lws_chunk_parser */
1502 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1503 char reason_bf; /* internal writeable callback reason bitfield */
1507 LWS_EXTERN int log_level;
1510 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1514 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1517 remove_wsi_socket_from_fds(struct lws *wsi);
1519 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1523 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1524 int ret, int completion) {
1526 (void)context; (void)wsi; (void)action; (void)ret;
1531 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1532 do { (void)context; (void)wsi; } while (0);
1535 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1537 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1538 int ret, int completion);
1542 lws_set_protocol_write_pending(struct lws *wsi,
1543 enum lws_pending_protocol_send pend);
1544 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1545 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1547 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1548 lws_parse(struct lws *wsi, unsigned char c);
1550 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1551 lws_http_action(struct lws *wsi);
1554 lws_b64_selftest(void);
1557 lws_service_flag_pending(struct lws_context *context, int tsi);
1559 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1560 LWS_EXTERN struct lws *
1561 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1564 insert_wsi(struct lws_context *context, struct lws *wsi);
1567 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1569 #define wsi_from_fd(A,B) A->lws_lookup[B]
1570 #define insert_wsi(A,B) assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1571 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1574 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1575 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1577 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1578 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1581 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1582 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1585 lws_remove_from_timeout_list(struct lws *wsi);
1587 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1588 lws_client_connect_2(struct lws *wsi);
1590 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1591 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1592 const char *path, const char *host);
1594 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1595 lws_create_new_server_wsi(struct lws_vhost *vhost);
1597 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1598 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1601 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1603 LWS_EXTERN struct lws *
1604 lws_client_connect_via_info2(struct lws *wsi);
1610 #ifndef LWS_NO_EXTENSIONS
1612 lws_context_init_extensions(struct lws_context_creation_info *info,
1613 struct lws_context *context);
1615 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1616 void *v, size_t len);
1619 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1621 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1622 void *arg, int len);
1625 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1626 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1627 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1628 #define lws_issue_raw_ext_access lws_issue_raw
1629 #define lws_context_init_extensions(_a, _b)
1632 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1633 lws_client_interpret_server_handshake(struct lws *wsi);
1635 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1636 lws_rx_sm(struct lws *wsi, unsigned char c);
1639 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1641 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1642 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1645 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1647 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1648 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1649 enum lws_callback_reasons reason, void *user,
1650 void *in, size_t len);
1651 #ifdef LWS_USE_HTTP2
1652 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1653 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1655 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1656 unsigned char *buf, int len);
1657 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1659 lws_http2_parser(struct lws *wsi, unsigned char c);
1660 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1662 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1663 unsigned int sid, unsigned int len,
1664 unsigned char *buf);
1665 LWS_EXTERN struct lws *
1666 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1667 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1670 lws_add_http2_header_by_name(struct lws *wsi,
1671 const unsigned char *name,
1672 const unsigned char *value, int length,
1673 unsigned char **p, unsigned char *end);
1675 lws_add_http2_header_by_token(struct lws *wsi,
1676 enum lws_token_indexes token,
1677 const unsigned char *value, int length,
1678 unsigned char **p, unsigned char *end);
1680 lws_add_http2_header_status(struct lws *wsi,
1681 unsigned int code, unsigned char **p,
1682 unsigned char *end);
1684 void lws_http2_configure_if_upgraded(struct lws *wsi);
1686 #define lws_http2_configure_if_upgraded(x)
1690 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1693 lws_plat_check_connection_error(struct lws *wsi);
1695 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1696 lws_header_table_attach(struct lws *wsi, int autoservice);
1699 lws_header_table_detach(struct lws *wsi, int autoservice);
1702 lws_header_table_reset(struct lws *wsi, int autoservice);
1704 _lws_header_table_reset(struct allocated_headers *ah);
1706 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1707 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1709 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1710 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1712 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1713 lws_ensure_user_space(struct lws *wsi);
1716 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1718 #ifndef LWS_NO_SERVER
1719 int lws_context_init_server(struct lws_context_creation_info *info,
1720 struct lws_vhost *vhost);
1721 LWS_EXTERN struct lws_vhost *
1722 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1724 handshake_0405(struct lws_context *context, struct lws *wsi);
1725 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1726 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1728 lws_server_get_canonical_hostname(struct lws_context *context,
1729 struct lws_context_creation_info *info);
1731 #define lws_context_init_server(_a, _b) (0)
1732 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1733 #define lws_server_get_canonical_hostname(_a, _b)
1736 #ifndef LWS_NO_DAEMONIZE
1737 LWS_EXTERN int get_daemonize_pid();
1739 #define get_daemonize_pid() (0)
1742 #if !defined(LWS_WITH_ESP8266)
1743 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1744 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1745 struct sockaddr_in *addr, size_t addrlen);
1747 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1749 enum lws_ssl_capable_status {
1750 LWS_SSL_CAPABLE_ERROR = -1,
1751 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1754 #ifndef LWS_OPENSSL_SUPPORT
1755 #define LWS_SSL_ENABLED(context) (0)
1756 #define lws_context_init_server_ssl(_a, _b) (0)
1757 #define lws_ssl_destroy(_a)
1758 #define lws_context_init_http2_ssl(_a)
1759 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1760 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1761 #define lws_ssl_pending lws_ssl_pending_no_ssl
1762 #define lws_server_socket_service_ssl(_b, _c) (0)
1763 #define lws_ssl_close(_a) (0)
1764 #define lws_ssl_context_destroy(_a)
1765 #define lws_ssl_SSL_CTX_destroy(_a)
1766 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1767 #define lws_context_init_ssl_library(_a)
1769 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1770 LWS_EXTERN int openssl_websocket_private_data_index;
1771 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1772 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1773 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1774 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1775 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1776 lws_ssl_pending(struct lws *wsi);
1778 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1779 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1780 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1782 lws_ssl_close(struct lws *wsi);
1784 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1786 lws_ssl_context_destroy(struct lws_context *context);
1788 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1790 lws_ssl_client_bio_create(struct lws *wsi);
1792 lws_ssl_client_connect1(struct lws *wsi);
1794 lws_ssl_client_connect2(struct lws *wsi);
1796 lws_ssl_elaborate_error(void);
1797 #ifndef LWS_NO_SERVER
1799 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1800 struct lws_vhost *vhost);
1802 #define lws_context_init_server_ssl(_a, _b) (0)
1805 lws_ssl_destroy(struct lws_vhost *vhost);
1809 #ifdef LWS_USE_HTTP2
1811 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1813 #define lws_context_init_http2_ssl(_a)
1818 static LWS_INLINE void
1819 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1821 pthread_mutex_init(&pt->lock, NULL);
1824 static LWS_INLINE void
1825 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
1827 pthread_mutex_destroy(&pt->lock);
1830 static LWS_INLINE void
1831 lws_pt_lock(struct lws_context_per_thread *pt)
1833 if (!pt->lock_depth++)
1834 pthread_mutex_lock(&pt->lock);
1837 static LWS_INLINE void
1838 lws_pt_unlock(struct lws_context_per_thread *pt)
1840 if (!(--pt->lock_depth))
1841 pthread_mutex_unlock(&pt->lock);
1844 #define lws_pt_mutex_init(_a) (void)(_a)
1845 #define lws_pt_mutex_destroy(_a) (void)(_a)
1846 #define lws_pt_lock(_a) (void)(_a)
1847 #define lws_pt_unlock(_a) (void)(_a)
1850 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1851 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1853 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1854 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1856 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1857 lws_ssl_pending_no_ssl(struct lws *wsi);
1859 #ifdef LWS_WITH_HTTP_PROXY
1860 struct lws_rewrite {
1861 hubbub_parser *parser;
1862 hubbub_parser_optparams params;
1863 const char *from, *to;
1864 int from_len, to_len;
1865 unsigned char *p, *end;
1868 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1873 return strncmp((const char *)s->ptr, p, len);
1875 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1876 LWS_EXTERN struct lws_rewrite *
1877 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1879 lws_rewrite_destroy(struct lws_rewrite *r);
1881 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1884 #ifndef LWS_NO_CLIENT
1885 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1887 struct lws_pollfd *pollfd);
1888 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1889 lws_http_transaction_completed_client(struct lws *wsi);
1890 #ifdef LWS_OPENSSL_SUPPORT
1892 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1893 struct lws_vhost *vhost);
1895 #define lws_context_init_client_ssl(_a, _b) (0)
1897 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1898 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1900 lws_decode_ssl_error(void);
1902 #define lws_context_init_client_ssl(_a, _b) (0)
1903 #define lws_handshake_client(_a, _b, _c) (0)
1907 _lws_rx_flow_control(struct lws *wsi);
1910 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1912 #ifndef LWS_NO_SERVER
1914 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1915 struct lws_pollfd *pollfd);
1917 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1919 #define lws_server_socket_service(_a, _b, _c) (0)
1920 #define lws_handshake_server(_a, _b, _c) (0)
1923 #ifdef LWS_WITH_ACCESS_LOG
1925 lws_access_log(struct lws *wsi);
1927 #define lws_access_log(_a)
1931 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1934 lws_protocol_init(struct lws_context *context);
1937 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
1939 const struct lws_http_mount *
1940 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
1946 lws_realloc(void *ptr, size_t size);
1948 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1949 lws_zalloc(size_t size);
1951 #ifdef LWS_PLAT_OPTEE
1952 void *lws_malloc(size_t size);
1953 void lws_free(void *p);
1954 #define lws_free_set_NULL(P) do { lws_free(P); (P) = NULL; } while(0)
1956 #define lws_malloc(S) lws_realloc(NULL, S)
1957 #define lws_free(P) lws_realloc(P, 0)
1958 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
1961 const struct lws_plat_file_ops *
1962 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
1963 const char **vpath);
1967 lws_plat_delete_socket_from_fds(struct lws_context *context,
1968 struct lws *wsi, int m);
1970 lws_plat_insert_socket_into_fds(struct lws_context *context,
1973 lws_plat_service_periodic(struct lws_context *context);
1976 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1977 struct lws_pollfd *pfd);
1979 lws_plat_context_early_init(void);
1981 lws_plat_context_early_destroy(struct lws_context *context);
1983 lws_plat_context_late_destroy(struct lws_context *context);
1985 lws_poll_listen_fd(struct lws_pollfd *fd);
1987 lws_plat_service(struct lws_context *context, int timeout_ms);
1988 LWS_EXTERN LWS_VISIBLE int
1989 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1991 lws_plat_init(struct lws_context *context,
1992 struct lws_context_creation_info *info);
1994 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1995 LWS_EXTERN unsigned long long
1996 time_in_microseconds(void);
1997 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1998 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2000 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2001 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);