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>
41 #if defined(LWS_WITH_ESP8266)
42 #include <user_interface.h>
45 /* rom-provided stdc functions for free, ensure use these instead of libc ones */
47 int ets_vsprintf(char *str, const char *format, va_list argptr);
48 int ets_vsnprintf(char *buffer, size_t sizeOfBuffer, const char *format, va_list argptr);
49 int ets_snprintf(char *str, size_t size, const char *format, ...);
50 int ets_sprintf(char *str, const char *format, ...);
51 int os_printf_plus(const char *format, ...);
55 void *pvPortMalloc(size_t s, const char *f, int line);
56 #define malloc(s) pvPortMalloc(s, "", 0)
57 void *pvPortRealloc(void *p, size_t s, const char *f, int line);
58 #define realloc(p, s) pvPortRealloc(p, s, "", 0)
59 void vPortFree(void *p, const char *f, int line);
60 #define free(p) vPortFree(p, "", 0)
62 void *ets_memcpy(void *dest, const void *src, size_t n);
63 #define memcpy ets_memcpy
64 void *ets_memset(void *dest, int v, size_t n);
65 #define memset ets_memset
66 char *ets_strcpy(char *dest, const char *src);
67 #define strcpy ets_strcpy
68 char *ets_strncpy(char *dest, const char *src, size_t n);
69 #define strncpy ets_strncpy
70 char *ets_strstr(const char *haystack, const char *needle);
71 #define strstr ets_strstr
72 int ets_strcmp(const char *s1, const char *s2);
73 int ets_strncmp(const char *s1, const char *s2, size_t n);
74 #define strcmp ets_strcmp
75 #define strncmp ets_strncmp
76 size_t ets_strlen(const char *s);
77 #define strlen ets_strlen
78 void *ets_memmove(void *dest, const void *src, size_t n);
79 #define memmove ets_memmove
80 char *ets_strchr(const char *s, int c);
81 #define strchr_ets_strchr
93 #ifdef LWS_HAVE_SYS_STAT_H
97 #if defined(WIN32) || defined(_WIN32)
101 #define WINVER 0x0501
102 #define _WIN32_WINNT WINVER
104 #define LWS_NO_DAEMONIZE
105 #define LWS_ERRNO WSAGetLastError()
106 #define LWS_EAGAIN WSAEWOULDBLOCK
107 #define LWS_EALREADY WSAEALREADY
108 #define LWS_EINPROGRESS WSAEINPROGRESS
109 #define LWS_EINTR WSAEINTR
110 #define LWS_EISCONN WSAEISCONN
111 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
112 #define MSG_NOSIGNAL 0
113 #define SHUT_RDWR SD_BOTH
114 #define SOL_TCP IPPROTO_TCP
115 #define SHUT_WR SD_SEND
117 #define compatible_close(fd) closesocket(fd)
118 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
119 #define lws_socket_is_valid(x) (!!x)
120 #define LWS_SOCK_INVALID 0
121 #include <winsock2.h>
122 #include <ws2tcpip.h>
125 #ifdef LWS_HAVE_IN6ADDR_H
132 #define __func__ __FUNCTION__
135 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
136 #define vsnprintf _vsnprintf
138 #ifdef LWS_HAVE__VSNPRINTF
139 #define vsnprintf _vsnprintf
143 #ifdef LWS_HAVE__SNPRINTF
144 #define lws_snprintf _snprintf
147 #else /* not windows --> */
152 #include <sys/types.h>
153 #ifndef MBED_OPERATORS
159 #ifdef LWS_WITH_ESP8266
161 #define vsnprintf ets_vsnprintf
162 #define snprintf ets_snprintf
163 #define sprintf ets_sprintf
165 #include <sys/socket.h>
167 #ifdef LWS_WITH_HTTP_PROXY
168 #include <hubbub/hubbub.h>
169 #include <hubbub/parser.h>
171 #if defined(LWS_BUILTIN_GETIFADDRS)
172 #include <getifaddrs.h>
174 #if !defined(LWS_WITH_ESP8266)
178 #if defined (__ANDROID__)
180 #include <sys/resource.h>
181 #elif defined (__sun)
184 #if !defined(LWS_WITH_ESP8266)
185 #include <sys/syslog.h>
189 #if !defined(LWS_WITH_ESP8266)
190 #include <sys/mman.h>
192 #include <netinet/in.h>
193 #include <netinet/tcp.h>
194 #include <arpa/inet.h>
207 #ifdef LWS_HAVE_SYS_PRCTL_H
208 #include <sys/prctl.h>
212 #include <sys/time.h>
214 #define LWS_ERRNO errno
215 #define LWS_EAGAIN EAGAIN
216 #define LWS_EALREADY EALREADY
217 #define LWS_EINPROGRESS EINPROGRESS
218 #define LWS_EINTR EINTR
219 #define LWS_EISCONN EISCONN
220 #define LWS_EWOULDBLOCK EWOULDBLOCK
222 #define lws_set_blocking_send(wsi)
224 #if defined(MBED_OPERATORS) || defined(LWS_WITH_ESP8266)
225 #define lws_socket_is_valid(x) ((x) != NULL)
226 #define LWS_SOCK_INVALID (NULL)
229 lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
231 #define lws_socket_is_valid(x) (x >= 0)
232 #define LWS_SOCK_INVALID (-1)
236 #ifndef LWS_HAVE_BZERO
238 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
242 #ifndef LWS_HAVE_STRERROR
243 #define strerror(x) ""
246 #ifdef LWS_OPENSSL_SUPPORT
249 #ifdef USE_OLD_CYASSL
250 #include <cyassl/openssl/ssl.h>
251 #include <cyassl/error-ssl.h>
253 #include <wolfssl/openssl/ssl.h>
254 #include <wolfssl/error-ssl.h>
255 #endif /* not USE_OLD_CYASSL */
257 #if defined(LWS_USE_POLARSSL)
258 #include <polarssl/ssl.h>
259 #include <polarssl/error.h>
260 #include <polarssl/md5.h>
261 #include <polarssl/sha1.h>
262 #include <polarssl/ecdh.h>
263 #define SSL_ERROR_WANT_READ POLARSSL_ERR_NET_WANT_READ
264 #define SSL_ERROR_WANT_WRITE POLARSSL_ERR_NET_WANT_WRITE
265 #define OPENSSL_VERSION_NUMBER 0x10002000L
267 #if defined(LWS_USE_MBEDTLS)
268 #include <mbedtls/ssl.h>
269 #include <mbedtls/error.h>
270 #include <mbedtls/md5.h>
271 #include <mbedtls/sha1.h>
272 #include <mbedtls/ecdh.h>
274 #include <openssl/ssl.h>
275 #include <openssl/evp.h>
276 #include <openssl/err.h>
277 #include <openssl/md5.h>
278 #include <openssl/sha.h>
279 #ifdef LWS_HAVE_OPENSSL_ECDH_H
280 #include <openssl/ecdh.h>
282 #include <openssl/x509v3.h>
283 #endif /* not USE_MBEDTLS */
284 #endif /* not USE_POLARSSL */
285 #endif /* not USE_WOLFSSL */
288 #include "libwebsockets.h"
289 #if defined(WIN32) || defined(_WIN32)
291 static inline int compatible_close(int fd) { return close(fd); }
294 #if defined(WIN32) || defined(_WIN32)
295 #include <gettimeofday.h>
298 #if defined(MBED_OPERATORS)
299 #undef compatible_close
300 #define compatible_close(fd) mbed3_delete_tcp_stream_socket(fd)
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
312 #if defined(LWS_WITH_ESP8266)
313 #undef compatible_close
314 #define compatible_close(fd) { fd->state=ESPCONN_CLOSE; espconn_delete(fd); }
316 esp8266_create_tcp_stream_socket(void);
318 esp8266_tcp_stream_bind(lws_sockfd_type fd, int port, struct lws *wsi);
320 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
322 #ifndef LITTLE_ENDIAN
323 #define LITTLE_ENDIAN 1234
326 #define BYTE_ORDER LITTLE_ENDIAN
331 #if defined(WIN32) || defined(_WIN32)
334 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
336 #ifndef LITTLE_ENDIAN
337 #define LITTLE_ENDIAN 1234
340 #define BYTE_ORDER LITTLE_ENDIAN
343 typedef unsigned __int64 u_int64_t;
349 #define __P(protos) protos
351 #define __P(protos) ()
357 #include <sys/stat.h>
358 #include <sys/time.h>
360 #if defined(__APPLE__)
361 #include <machine/endian.h>
362 #elif defined(__FreeBSD__)
363 #include <sys/endian.h>
364 #elif defined(__linux__)
373 #include <gulliver.h>
374 #if defined(__LITTLEENDIAN__)
375 #define BYTE_ORDER __LITTLEENDIAN__
376 #define LITTLE_ENDIAN __LITTLEENDIAN__
377 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
379 #if defined(__BIGENDIAN__)
380 #define BYTE_ORDER __BIGENDIAN__
381 #define LITTLE_ENDIAN 1234 /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
382 #define BIG_ENDIAN __BIGENDIAN__
386 #if defined(__sun) && defined(__GNUC__)
387 # define BYTE_ORDER __BYTE_ORDER__
388 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
389 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
392 #if !defined(BYTE_ORDER)
393 # define BYTE_ORDER __BYTE_ORDER
395 #if !defined(LITTLE_ENDIAN)
396 # define LITTLE_ENDIAN __LITTLE_ENDIAN
398 #if !defined(BIG_ENDIAN)
399 # define BIG_ENDIAN __BIG_ENDIAN
405 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
406 * but happily have something equivalent in the SO_NOSIGPIPE flag.
409 #define MSG_NOSIGNAL SO_NOSIGPIPE
413 * Solaris 11.X only supports POSIX 2001, MSG_NOSIGNAL appears in
417 #define MSG_NOSIGNAL 0
421 #ifndef FD_HASHTABLE_MODULUS
422 #define FD_HASHTABLE_MODULUS 32
426 #ifndef LWS_DEF_HEADER_LEN
427 #define LWS_DEF_HEADER_LEN 4096
429 #ifndef LWS_DEF_HEADER_POOL
430 #define LWS_DEF_HEADER_POOL 4
432 #ifndef LWS_MAX_PROTOCOLS
433 #define LWS_MAX_PROTOCOLS 5
435 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
436 #define LWS_MAX_EXTENSIONS_ACTIVE 2
438 #ifndef LWS_MAX_EXT_OFFERS
439 #define LWS_MAX_EXT_OFFERS 8
441 #ifndef SPEC_LATEST_SUPPORTED
442 #define SPEC_LATEST_SUPPORTED 13
444 #ifndef AWAITING_TIMEOUT
445 #define AWAITING_TIMEOUT 20
447 #ifndef CIPHERS_LIST_STRING
448 #define CIPHERS_LIST_STRING "DEFAULT"
450 #ifndef LWS_SOMAXCONN
451 #define LWS_SOMAXCONN SOMAXCONN
454 #define MAX_WEBSOCKET_04_KEY_LEN 128
456 #ifndef SYSTEM_RANDOM_FILEPATH
457 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
460 enum lws_websocket_opcodes_07 {
461 LWSWSOPC_CONTINUATION = 0,
462 LWSWSOPC_TEXT_FRAME = 1,
463 LWSWSOPC_BINARY_FRAME = 2,
465 LWSWSOPC_NOSPEC__MUX = 7,
467 /* control extensions 8+ */
475 enum lws_connection_states {
477 LWSS_HTTP_ISSUING_FILE,
482 LWSS_CLIENT_HTTP_ESTABLISHED,
483 LWSS_CLIENT_UNCONNECTED,
484 LWSS_RETURNED_CLOSE_ALREADY,
485 LWSS_AWAITING_CLOSE_ACK,
486 LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
489 LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
490 LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
491 LWSS_HTTP2_ESTABLISHED,
502 enum http_connection_type {
503 HTTP_CONNECTION_CLOSE,
504 HTTP_CONNECTION_KEEP_ALIVE
507 enum lws_pending_protocol_send {
509 LWS_PPS_HTTP2_MY_SETTINGS,
510 LWS_PPS_HTTP2_ACK_SETTINGS,
514 enum lws_rx_parse_state {
521 LWS_RXPS_04_FRAME_HDR_1,
522 LWS_RXPS_04_FRAME_HDR_LEN,
523 LWS_RXPS_04_FRAME_HDR_LEN16_2,
524 LWS_RXPS_04_FRAME_HDR_LEN16_1,
525 LWS_RXPS_04_FRAME_HDR_LEN64_8,
526 LWS_RXPS_04_FRAME_HDR_LEN64_7,
527 LWS_RXPS_04_FRAME_HDR_LEN64_6,
528 LWS_RXPS_04_FRAME_HDR_LEN64_5,
529 LWS_RXPS_04_FRAME_HDR_LEN64_4,
530 LWS_RXPS_04_FRAME_HDR_LEN64_3,
531 LWS_RXPS_04_FRAME_HDR_LEN64_2,
532 LWS_RXPS_04_FRAME_HDR_LEN64_1,
534 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
535 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
536 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
537 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
539 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
542 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
544 enum connection_mode {
546 LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
547 LWSCM_PRE_WS_SERVING_ACCEPT,
554 /* transient, ssl delay hiding */
555 LWSCM_SSL_ACK_PENDING,
558 /* special internal types */
559 LWSCM_SERVER_LISTENER,
560 LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
562 /* HTTP Client related */
563 LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
564 LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
565 LWSCM_WSCL_WAITING_CONNECT,
566 LWSCM_WSCL_WAITING_PROXY_REPLY,
567 LWSCM_WSCL_ISSUE_HANDSHAKE,
568 LWSCM_WSCL_ISSUE_HANDSHAKE2,
569 LWSCM_WSCL_ISSUE_HTTP_BODY,
570 LWSCM_WSCL_WAITING_SSL,
571 LWSCM_WSCL_WAITING_SERVER_REPLY,
572 LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
573 LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
575 /****** add new things just above ---^ ******/
581 LWS_RXFLOW_ALLOW = (1 << 0),
582 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
585 /* this is not usable directly by user code any more, lws_close_reason() */
586 #define LWS_WRITE_CLOSE 4
588 struct lws_protocols;
591 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
593 struct lws_io_watcher {
598 uv_poll_t uv_watcher;
600 struct lws_context *context;
603 struct lws_signal_watcher {
605 ev_signal ev_watcher;
608 uv_signal_t uv_watcher;
610 struct lws_context *context;
615 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
616 struct lws_fd_hashtable {
623 * This is totally opaque to code using the library. It's exported as a
624 * forward-reference pointer-only declaration; the user can use the pointer with
625 * other APIs to get information out of it.
628 struct lws_fragments {
631 unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
635 * these are assigned from a pool held in the context.
636 * Both client and server mode uses them for http header analysis
639 struct allocated_headers {
640 struct lws *wsi; /* owner */
641 char *data; /* prepared by context init to point to dedicated storage */
643 * the randomly ordered fragments, indexed by frag_index and
644 * lws_fragments->nfrag for continuation.
646 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
649 * for each recognized token, frag_index says which frag[] his data
650 * starts in (0 means the token did not appear)
651 * the actual header data gets dumped as it comes in, into data[]
653 unsigned char frag_index[WSI_TOKEN_COUNT];
654 unsigned char rx[2048];
659 unsigned int http_response;
661 #ifndef LWS_NO_CLIENT
662 char initial_handshake_hash_base64[30];
665 unsigned char in_use;
670 * so we can have n connections being serviced simultaneously,
671 * these things need to be isolated per-thread.
674 struct lws_context_per_thread {
676 pthread_mutex_t lock;
678 struct lws_pollfd *fds;
679 #if defined(LWS_WITH_ESP8266)
680 struct lws **lws_vs_fds_index;
682 struct lws *rx_draining_ext_list;
683 struct lws *tx_draining_ext_list;
684 struct lws *timeout_list;
686 struct lws_context *context;
689 struct lws_cgi *cgi_list;
691 void *http_header_data;
692 struct allocated_headers *ah_pool;
693 struct lws *ah_wait_list;
694 int ah_wait_list_length;
695 #ifdef LWS_OPENSSL_SUPPORT
696 struct lws *pending_read_list; /* linked list */
698 #ifndef LWS_NO_SERVER
699 struct lws *wsi_listening;
701 #if defined(LWS_USE_LIBEV)
702 struct ev_loop *io_loop_ev;
704 #if defined(LWS_USE_LIBUV)
705 uv_loop_t *io_loop_uv;
706 uv_signal_t signals[8];
707 uv_timer_t uv_timeout_watcher;
710 #if defined(LWS_USE_LIBEV)
711 struct lws_io_watcher w_accept;
713 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
714 struct lws_signal_watcher w_sigint;
715 unsigned char ev_loop_foreign:1;
718 unsigned long count_conns;
720 * usable by anything in the service code, but only if the scope
721 * does not last longer than the service action (since next service
722 * of any socket can likewise use it and overwrite)
724 unsigned char *serv_buf;
728 lws_sockfd_type dummy_pipe_fds[2];
730 unsigned int fds_count;
732 short ah_count_in_use;
734 unsigned char lock_depth;
738 * virtual host -related context information
739 * vhostwide SSL context
744 * context -> vhost -> wsi
746 * incoming connection non-SSL vhost binding:
748 * listen socket -> wsi -> select vhost after first headers
750 * incoming connection SSL vhost binding:
752 * SSL SNI -> wsi -> bind after SSL negotiation
756 #if !defined(LWS_WITH_ESP8266)
757 char http_proxy_address[128];
758 char proxy_basic_auth_token[128];
760 #if defined(LWS_WITH_ESP8266)
761 /* listen sockets need a place to hang their hat */
764 struct lws_context *context;
765 struct lws_vhost *vhost_next;
766 const struct lws_http_mount *mount_list;
767 struct lws *lserv_wsi;
770 const struct lws_protocols *protocols;
771 void **protocol_vh_privs;
772 const struct lws_protocol_vhost_options *pvo;
773 const struct lws_protocol_vhost_options *headers;
774 struct lws **same_vh_protocol_list;
775 #ifdef LWS_OPENSSL_SUPPORT
777 SSL_CTX *ssl_client_ctx;
779 #ifndef LWS_NO_EXTENSIONS
780 const struct lws_extension *extensions;
782 unsigned long long rx, tx;
783 unsigned long conn, trans, ws_upgrades, http2_upgrades;
786 unsigned int http_proxy_port;
787 unsigned int options;
792 int keepalive_timeout;
793 #ifdef LWS_WITH_ACCESS_LOG
797 #ifdef LWS_OPENSSL_SUPPORT
799 int allow_non_ssl_on_ssl_port;
800 unsigned int user_supplied_ssl_ctx:1;
803 unsigned char default_protocol_index;
807 * the rest is managed per-context, that includes
809 * - processwide single fd -> wsi lookup
810 * - contextwide headers pool
814 time_t last_timeout_check_s;
815 time_t last_ws_ping_pong_check_s;
817 struct lws_plat_file_ops fops;
818 struct lws_context_per_thread pt[LWS_MAX_SMP];
820 /* different implementation between unix and windows */
821 struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
823 #if defined(LWS_WITH_ESP8266)
824 struct espconn **connpool; /* .reverse points to the wsi */
829 struct lws **lws_lookup; /* fd to wsi */
832 struct lws_vhost *vhost_list;
833 struct lws_plugin *plugin_list;
834 const struct lws_token_limits *token_limits;
836 const char *server_string;
837 const struct lws_protocol_vhost_options *reject_service_keywords;
839 #if defined(LWS_USE_LIBEV)
840 lws_ev_signal_cb_t * lws_ev_sigint_cb;
842 #if defined(LWS_USE_LIBUV)
843 uv_signal_cb lws_uv_sigint_cb;
845 char canonical_hostname[128];
847 unsigned long worst_latency;
848 char worst_latency_info[256];
852 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
855 int started_with_parent;
859 #ifdef LWS_OPENSSL_SUPPORT
860 #define lws_ssl_anybody_has_buffered_read(w) \
861 (w->vhost->use_ssl && \
862 w->context->pt[(int)w->tsi].pending_read_list)
863 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
864 (/*c->use_ssl && */ \
865 c->pt[(int)t].pending_read_list)
867 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
868 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
870 int count_wsi_allocated;
871 int count_cgi_spawned;
872 unsigned int options;
873 unsigned int fd_limit_per_thread;
874 unsigned int timeout_secs;
875 unsigned int pt_serv_buf_size;
876 int max_http_header_data;
879 * set to the Thread ID that's doing the service loop just before entry
880 * to poll indicates service thread likely idling in poll()
881 * volatile because other threads may check it as part of processing
882 * for pollfd event change.
884 volatile int service_tid;
885 int service_tid_detected;
887 short max_http_header_pool;
889 short plugin_protocol_count;
890 short plugin_extension_count;
891 short server_string_len;
892 unsigned short ws_ping_pong_interval;
894 unsigned int being_destroyed:1;
895 unsigned int requested_kill:1;
896 unsigned int protocol_init_done:1;
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)
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);
968 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
969 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
971 #define lws_libuv_accept(_a, _b) ((void) 0)
972 #define lws_libuv_io(_a, _b) ((void) 0)
973 #define lws_libuv_init_fd_table(_a) (0)
974 #define lws_libuv_run(_a, _b) ((void) 0)
975 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
976 #define LWS_LIBUV_ENABLED(context) (0)
978 #define lws_feature_status_libuv(_a) \
979 lwsl_notice("libuv support not compiled in\n")
981 #define lws_feature_status_libuv(_a)
987 #define LWS_IPV6_ENABLED(vh) \
988 (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
989 !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
991 #define LWS_IPV6_ENABLED(context) (0)
994 #ifdef LWS_USE_UNIX_SOCK
995 #define LWS_UNIX_SOCK_ENABLED(vhost) \
996 (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
998 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1000 enum uri_path_states {
1003 URIPS_SEEN_SLASH_DOT,
1004 URIPS_SEEN_SLASH_DOT_DOT,
1007 enum uri_esc_states {
1010 URIES_SEEN_PERCENT_H1,
1013 /* notice that these union members:
1019 * all have a pointer to allocated_headers struct as their first member.
1021 * It means for allocated_headers access, the three union paths can all be
1022 * used interchangeably to access the same data
1026 #ifndef LWS_NO_CLIENT
1027 struct client_info_stash {
1037 struct _lws_header_related {
1038 /* MUST be first in struct */
1039 struct allocated_headers *ah;
1040 struct lws *ah_wait_list;
1041 unsigned char *preamble_rx;
1042 #ifndef LWS_NO_CLIENT
1043 struct client_info_stash *stash;
1045 unsigned int preamble_rx_len;
1046 enum uri_path_states ups;
1047 enum uri_esc_states ues;
1049 unsigned int current_token_limit;
1050 #ifndef LWS_NO_CLIENT
1051 unsigned short c_port;
1054 char post_literal_equal;
1055 unsigned char parser_state; /* enum lws_token_indexes */
1059 struct _lws_http_mode_related {
1060 /* MUST be first in struct */
1061 struct allocated_headers *ah; /* mirroring _lws_header_related */
1062 struct lws *ah_wait_list;
1063 unsigned char *preamble_rx;
1064 #ifndef LWS_NO_CLIENT
1065 struct client_info_stash *stash;
1067 unsigned int preamble_rx_len;
1068 struct lws *new_wsi_list;
1069 unsigned long filepos;
1070 unsigned long filelen;
1073 enum http_version request_version;
1074 enum http_connection_type connection_type;
1075 unsigned int content_length;
1076 unsigned int content_remain;
1079 #ifdef LWS_USE_HTTP2
1081 enum lws_http2_settings {
1082 LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1083 LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1084 LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1085 LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1086 LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1087 LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1089 LWS_HTTP2_SETTINGS__COUNT /* always last */
1092 enum lws_http2_wellknown_frame_types {
1093 LWS_HTTP2_FRAME_TYPE_DATA,
1094 LWS_HTTP2_FRAME_TYPE_HEADERS,
1095 LWS_HTTP2_FRAME_TYPE_PRIORITY,
1096 LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1097 LWS_HTTP2_FRAME_TYPE_SETTINGS,
1098 LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1099 LWS_HTTP2_FRAME_TYPE_PING,
1100 LWS_HTTP2_FRAME_TYPE_GOAWAY,
1101 LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1102 LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1104 LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1107 enum lws_http2_flags {
1108 LWS_HTTP2_FLAG_END_STREAM = 1,
1109 LWS_HTTP2_FLAG_END_HEADERS = 4,
1110 LWS_HTTP2_FLAG_PADDED = 8,
1111 LWS_HTTP2_FLAG_PRIORITY = 0x20,
1113 LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1116 #define LWS_HTTP2_STREAM_ID_MASTER 0
1117 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1118 #define LWS_HTTP2_SETTINGS_LENGTH 6
1120 struct http2_settings {
1121 unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1124 enum http2_hpack_state {
1126 /* optional before first header block */
1128 HKPS_OPT_E_DEPENDENCY,
1141 /* optional after last header block */
1142 HKPS_OPT_DISCARD_PADDING,
1145 enum http2_hpack_type {
1147 HPKT_INDEXED_HDR_6_VALUE_INCR,
1148 HPKT_LITERAL_HDR_VALUE_INCR,
1149 HPKT_INDEXED_HDR_4_VALUE,
1150 HPKT_LITERAL_HDR_VALUE,
1154 struct hpack_dt_entry {
1155 int token; /* additions that don't map to a token are ignored */
1160 struct hpack_dynamic_table {
1161 struct hpack_dt_entry *entries;
1169 struct _lws_http2_related {
1171 * having this first lets us also re-use all HTTP union code
1172 * and in turn, http_mode_related has allocated headers in right
1173 * place so we can use the header apis on the wsi directly still
1175 struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1177 struct http2_settings my_settings;
1178 struct http2_settings peer_settings;
1180 struct lws *parent_wsi;
1181 struct lws *next_child_wsi;
1183 struct hpack_dynamic_table *hpack_dyn_table;
1184 struct lws *stream_wsi;
1185 unsigned char ping_payload[8];
1186 unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1189 unsigned int length;
1190 unsigned int stream_id;
1191 enum http2_hpack_state hpack;
1192 enum http2_hpack_type hpack_type;
1193 unsigned int header_index;
1194 unsigned int hpack_len;
1195 unsigned int hpack_e_dep;
1197 unsigned int my_stream_id;
1198 unsigned int child_count;
1201 unsigned int END_STREAM:1;
1202 unsigned int END_HEADERS:1;
1203 unsigned int send_END_STREAM:1;
1204 unsigned int GOING_AWAY;
1205 unsigned int requested_POLLOUT:1;
1206 unsigned int waiting_tx_credit:1;
1207 unsigned int huff:1;
1208 unsigned int value:1;
1210 unsigned short round_robin_POLLOUT;
1211 unsigned short count_POLLOUT_children;
1212 unsigned short hpack_pos;
1215 unsigned char flags;
1216 unsigned char frame_state;
1217 unsigned char padding;
1218 unsigned char hpack_m;
1219 unsigned char initialized;
1222 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1226 struct _lws_websocket_related {
1227 /* cheapest way to deal with ah overlap with ws union transition */
1228 struct _lws_header_related hdr;
1230 unsigned int rx_ubuf_alloc;
1231 struct lws *rx_draining_ext_list;
1232 struct lws *tx_draining_ext_list;
1233 time_t time_next_ping_check;
1234 size_t rx_packet_length;
1235 unsigned int rx_ubuf_head;
1236 unsigned char mask[4];
1237 /* Also used for close content... control opcode == < 128 */
1238 unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1240 unsigned char ping_payload_len;
1241 unsigned char mask_idx;
1242 unsigned char opcode;
1244 unsigned char rsv_first_msg;
1245 /* zero if no info, or length including 2-byte close code */
1246 unsigned char close_in_ping_buffer_len;
1248 unsigned char stashed_write_type;
1249 unsigned char tx_draining_stashed_wp;
1251 unsigned int final:1;
1252 unsigned int frame_is_binary:1;
1253 unsigned int all_zero_nonce:1;
1254 unsigned int this_frame_masked:1;
1255 unsigned int inside_frame:1; /* next write will be more of frame */
1256 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1257 unsigned int payload_is_close:1; /* process as PONG, but it is close */
1258 unsigned int ping_pending_flag:1;
1259 unsigned int continuation_possible:1;
1260 unsigned int owed_a_fin:1;
1261 unsigned int check_utf8:1;
1262 unsigned int defeat_check_utf8:1;
1263 unsigned int pmce_compressed_message:1;
1264 unsigned int stashed_write_pending:1;
1265 unsigned int rx_draining_ext:1;
1266 unsigned int tx_draining_ext:1;
1267 unsigned int send_check_ping:1;
1272 /* wsi who is master of the cgi points to an lws_cgi */
1275 struct lws_cgi *cgi_list;
1276 struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1277 struct lws *wsi; /* owner */
1278 unsigned long content_length;
1279 unsigned long content_length_seen;
1283 unsigned int being_closed:1;
1287 signed char char_to_hex(const char c);
1289 #ifndef LWS_NO_CLIENT
1290 enum lws_chunk_parser {
1301 #ifdef LWS_WITH_ACCESS_LOG
1302 struct lws_access_log {
1313 /* members with mutually exclusive lifetimes are unionized */
1316 struct _lws_http_mode_related http;
1317 #ifdef LWS_USE_HTTP2
1318 struct _lws_http2_related http2;
1320 struct _lws_header_related hdr;
1321 struct _lws_websocket_related ws;
1324 /* lifetime members */
1326 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1327 struct lws_io_watcher w_read;
1329 #if defined(LWS_USE_LIBEV)
1330 struct lws_io_watcher w_write;
1332 time_t pending_timeout_limit;
1336 struct lws_context *context;
1337 struct lws_vhost *vhost;
1338 struct lws *parent; /* points to parent, if any */
1339 struct lws *child_list; /* points to first child */
1340 struct lws *sibling_list; /* subsequent children at same level */
1342 struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1344 const struct lws_protocols *protocol;
1345 struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1346 struct lws *timeout_list;
1347 struct lws **timeout_list_prev;
1348 #ifdef LWS_WITH_ACCESS_LOG
1349 struct lws_access_log access_log;
1352 /* rxflow handling */
1353 unsigned char *rxflow_buffer;
1354 /* truncated send handling */
1355 unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1357 #if defined (LWS_WITH_ESP8266)
1359 unsigned short prem_rx_size, prem_rx_pos;
1362 #ifndef LWS_NO_EXTENSIONS
1363 const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1364 void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1366 #ifdef LWS_OPENSSL_SUPPORT
1368 #if !defined(LWS_USE_POLARSSL) && !defined(LWS_USE_MBEDTLS)
1371 struct lws *pending_read_list_prev, *pending_read_list_next;
1373 #ifdef LWS_WITH_HTTP_PROXY
1374 struct lws_rewrite *rw;
1377 unsigned long action_start;
1378 unsigned long latency_start;
1381 lws_sockfd_type sock;
1384 int position_in_fds_table;
1387 unsigned int trunc_alloc_len; /* size of malloc */
1388 unsigned int trunc_offset; /* where we are in terms of spilling */
1389 unsigned int trunc_len; /* how much is buffered */
1390 #ifndef LWS_NO_CLIENT
1391 int chunk_remaining;
1393 unsigned int cache_secs;
1395 unsigned int hdr_parsing_completed:1;
1396 unsigned int http2_substream:1;
1397 unsigned int listener:1;
1398 unsigned int user_space_externally_allocated:1;
1399 unsigned int socket_is_permanently_unusable:1;
1400 unsigned int rxflow_change_to:2;
1401 unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1402 unsigned int conn_stat_done:1;
1403 unsigned int cache_reuse:1;
1404 unsigned int cache_revalidate:1;
1405 unsigned int cache_intermediaries:1;
1406 unsigned int favoured_pollin:1;
1407 unsigned int sending_chunked:1;
1408 unsigned int already_did_cce:1;
1409 unsigned int told_user_closed:1;
1410 #if defined(LWS_WITH_ESP8266)
1411 unsigned int pending_send_completion:3;
1412 unsigned int close_is_pending_send_completion:1;
1414 #ifdef LWS_WITH_ACCESS_LOG
1415 unsigned int access_log_pending:1;
1417 #ifndef LWS_NO_CLIENT
1418 unsigned int do_ws:1; /* whether we are doing http or ws flow */
1419 unsigned int chunked:1; /* if the clientside connection is chunked */
1420 unsigned int client_rx_avail:1;
1421 unsigned int client_http_body_pending:1;
1423 #ifdef LWS_WITH_HTTP_PROXY
1424 unsigned int perform_rewrite:1;
1426 #ifndef LWS_NO_EXTENSIONS
1427 unsigned int extension_data_pending:1;
1429 #ifdef LWS_OPENSSL_SUPPORT
1430 unsigned int use_ssl:3;
1431 unsigned int upgraded:1;
1434 unsigned int sock_send_blocking:1;
1436 #ifdef LWS_OPENSSL_SUPPORT
1437 unsigned int redirect_to_https:1;
1441 #ifndef LWS_NO_EXTENSIONS
1442 unsigned char count_act_ext;
1444 unsigned char ietf_spec_revision;
1445 char mode; /* enum connection_mode */
1446 char state; /* enum lws_connection_states */
1447 char state_pre_close;
1448 char lws_rx_parse_state; /* enum lws_rx_parse_state */
1449 char rx_frame_type; /* enum lws_write_protocol */
1450 char pending_timeout; /* enum pending_timeout */
1451 char pps; /* enum lws_pending_protocol_send */
1452 char tsi; /* thread service index we belong to */
1453 char protocol_interpret_idx;
1455 char cgi_channel; /* which of stdin/out/err */
1458 #ifndef LWS_NO_CLIENT
1459 char chunk_parser; /* enum lws_chunk_parser */
1461 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1462 char reason_bf; /* internal writeable callback reason bitfield */
1466 LWS_EXTERN int log_level;
1469 lws_socket_bind(struct lws_vhost *vhost, int sockfd, int port,
1473 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1476 remove_wsi_socket_from_fds(struct lws *wsi);
1478 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1482 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1483 int ret, int completion) {
1485 (void)context; (void)wsi; (void)action; (void)ret;
1490 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1491 do { (void)context; (void)wsi; } while (0);
1494 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1496 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1497 int ret, int completion);
1501 lws_set_protocol_write_pending(struct lws *wsi,
1502 enum lws_pending_protocol_send pend);
1503 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1504 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1506 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1507 lws_parse(struct lws *wsi, unsigned char c);
1509 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1510 lws_http_action(struct lws *wsi);
1513 lws_b64_selftest(void);
1516 lws_service_flag_pending(struct lws_context *context, int tsi);
1518 #if defined(_WIN32) || defined(MBED_OPERATORS) || defined(LWS_WITH_ESP8266)
1519 LWS_EXTERN struct lws *
1520 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1523 insert_wsi(struct lws_context *context, struct lws *wsi);
1526 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1528 #define wsi_from_fd(A,B) A->lws_lookup[B]
1529 #define insert_wsi(A,B) assert(A->lws_lookup[B->sock] == 0); A->lws_lookup[B->sock]=B
1530 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1533 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1534 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1536 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1537 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1540 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1541 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1543 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1544 lws_client_connect_2(struct lws *wsi);
1546 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1547 lws_client_reset(struct lws *wsi, int ssl, const char *address, int port,
1548 const char *path, const char *host);
1550 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1551 lws_create_new_server_wsi(struct lws_vhost *vhost);
1553 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1554 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1557 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1559 LWS_EXTERN struct lws *
1560 lws_client_connect_via_info2(struct lws *wsi);
1566 #ifndef LWS_NO_EXTENSIONS
1568 lws_context_init_extensions(struct lws_context_creation_info *info,
1569 struct lws_context *context);
1571 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1572 void *v, size_t len);
1575 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1577 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1578 void *arg, int len);
1581 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1582 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1583 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1584 #define lws_issue_raw_ext_access lws_issue_raw
1585 #define lws_context_init_extensions(_a, _b)
1588 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1589 lws_client_interpret_server_handshake(struct lws *wsi);
1591 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1592 lws_rx_sm(struct lws *wsi, unsigned char c);
1595 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1597 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1598 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1601 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1603 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1604 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1605 enum lws_callback_reasons reason, void *user,
1606 void *in, size_t len);
1607 #ifdef LWS_USE_HTTP2
1608 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1609 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1611 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1612 unsigned char *buf, int len);
1613 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1615 lws_http2_parser(struct lws *wsi, unsigned char c);
1616 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1618 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1619 unsigned int sid, unsigned int len,
1620 unsigned char *buf);
1621 LWS_EXTERN struct lws *
1622 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1623 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1626 lws_add_http2_header_by_name(struct lws *wsi,
1627 const unsigned char *name,
1628 const unsigned char *value, int length,
1629 unsigned char **p, unsigned char *end);
1631 lws_add_http2_header_by_token(struct lws *wsi,
1632 enum lws_token_indexes token,
1633 const unsigned char *value, int length,
1634 unsigned char **p, unsigned char *end);
1636 lws_add_http2_header_status(struct lws *wsi,
1637 unsigned int code, unsigned char **p,
1638 unsigned char *end);
1640 void lws_http2_configure_if_upgraded(struct lws *wsi);
1642 #define lws_http2_configure_if_upgraded(x)
1646 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1649 lws_plat_check_connection_error(struct lws *wsi);
1651 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1652 lws_header_table_attach(struct lws *wsi, int autoservice);
1655 lws_header_table_detach(struct lws *wsi, int autoservice);
1658 lws_header_table_reset(struct lws *wsi, int autoservice);
1660 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1661 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1663 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1664 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1666 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1667 lws_ensure_user_space(struct lws *wsi);
1670 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1672 #ifndef LWS_NO_SERVER
1673 int lws_context_init_server(struct lws_context_creation_info *info,
1674 struct lws_vhost *vhost);
1675 LWS_EXTERN struct lws_vhost *
1676 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1678 handshake_0405(struct lws_context *context, struct lws *wsi);
1679 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1680 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1682 lws_server_get_canonical_hostname(struct lws_context *context,
1683 struct lws_context_creation_info *info);
1685 #define lws_context_init_server(_a, _b) (0)
1686 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1687 #define lws_server_get_canonical_hostname(_a, _b)
1690 #ifndef LWS_NO_DAEMONIZE
1691 LWS_EXTERN int get_daemonize_pid();
1693 #define get_daemonize_pid() (0)
1696 #if !defined(MBED_OPERATORS) && !defined(LWS_WITH_ESP8266)
1697 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1698 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1699 struct sockaddr_in *addr, size_t addrlen);
1701 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1703 enum lws_ssl_capable_status {
1704 LWS_SSL_CAPABLE_ERROR = -1,
1705 LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1708 #ifndef LWS_OPENSSL_SUPPORT
1709 #define LWS_SSL_ENABLED(context) (0)
1710 #define lws_context_init_server_ssl(_a, _b) (0)
1711 #define lws_ssl_destroy(_a)
1712 #define lws_context_init_http2_ssl(_a)
1713 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1714 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1715 #define lws_ssl_pending lws_ssl_pending_no_ssl
1716 #define lws_server_socket_service_ssl(_b, _c) (0)
1717 #define lws_ssl_close(_a) (0)
1718 #define lws_ssl_context_destroy(_a)
1719 #define lws_ssl_SSL_CTX_destroy(_a)
1720 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1721 #define lws_context_init_ssl_library(_a)
1723 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1724 LWS_EXTERN int openssl_websocket_private_data_index;
1725 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1726 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1727 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1728 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1729 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1730 lws_ssl_pending(struct lws *wsi);
1732 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1733 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1734 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1736 lws_ssl_close(struct lws *wsi);
1738 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1740 lws_ssl_context_destroy(struct lws_context *context);
1742 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1744 lws_ssl_client_bio_create(struct lws *wsi);
1746 lws_ssl_client_connect1(struct lws *wsi);
1748 lws_ssl_client_connect2(struct lws *wsi);
1750 lws_ssl_elaborate_error(void);
1751 #ifndef LWS_NO_SERVER
1753 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1754 struct lws_vhost *vhost);
1756 #define lws_context_init_server_ssl(_a, _b) (0)
1759 lws_ssl_destroy(struct lws_vhost *vhost);
1763 #ifdef LWS_USE_HTTP2
1765 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1767 #define lws_context_init_http2_ssl(_a)
1772 static LWS_INLINE void
1773 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1775 pthread_mutex_init(&pt->lock, NULL);
1778 static LWS_INLINE void
1779 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
1781 pthread_mutex_destroy(&pt->lock);
1784 static LWS_INLINE void
1785 lws_pt_lock(struct lws_context_per_thread *pt)
1787 if (!pt->lock_depth++)
1788 pthread_mutex_lock(&pt->lock);
1791 static LWS_INLINE void
1792 lws_pt_unlock(struct lws_context_per_thread *pt)
1794 if (!(--pt->lock_depth))
1795 pthread_mutex_unlock(&pt->lock);
1798 #define lws_pt_mutex_init(_a) (void)(_a)
1799 #define lws_pt_mutex_destroy(_a) (void)(_a)
1800 #define lws_pt_lock(_a) (void)(_a)
1801 #define lws_pt_unlock(_a) (void)(_a)
1804 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1805 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1807 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1808 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1810 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1811 lws_ssl_pending_no_ssl(struct lws *wsi);
1813 #ifdef LWS_WITH_HTTP_PROXY
1814 struct lws_rewrite {
1815 hubbub_parser *parser;
1816 hubbub_parser_optparams params;
1817 const char *from, *to;
1818 int from_len, to_len;
1819 unsigned char *p, *end;
1822 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1827 return strncmp((const char *)s->ptr, p, len);
1829 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1830 LWS_EXTERN struct lws_rewrite *
1831 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1833 lws_rewrite_destroy(struct lws_rewrite *r);
1835 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1838 #ifndef LWS_NO_CLIENT
1839 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1841 struct lws_pollfd *pollfd);
1842 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1843 lws_http_transaction_completed_client(struct lws *wsi);
1844 #ifdef LWS_OPENSSL_SUPPORT
1846 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1847 struct lws_vhost *vhost);
1849 #define lws_context_init_client_ssl(_a, _b) (0)
1851 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1852 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1854 lws_decode_ssl_error(void);
1856 #define lws_context_init_client_ssl(_a, _b) (0)
1857 #define lws_handshake_client(_a, _b, _c) (0)
1861 _lws_rx_flow_control(struct lws *wsi);
1864 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1866 #ifndef LWS_NO_SERVER
1868 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1869 struct lws_pollfd *pollfd);
1871 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1873 _lws_server_listen_accept_flow_control(struct lws *twsi, int on);
1875 #define lws_server_socket_service(_a, _b, _c) (0)
1876 #define lws_handshake_server(_a, _b, _c) (0)
1877 #define _lws_server_listen_accept_flow_control(a, b) (0)
1880 #ifdef LWS_WITH_ACCESS_LOG
1882 lws_access_log(struct lws *wsi);
1884 #define lws_access_log(_a)
1888 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1891 lws_protocol_init(struct lws_context *context);
1894 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
1896 const struct lws_http_mount *
1897 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
1903 lws_realloc(void *ptr, size_t size);
1905 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1906 lws_zalloc(size_t size);
1908 #define lws_malloc(S) lws_realloc(NULL, S)
1909 #define lws_free(P) lws_realloc(P, 0)
1910 #define lws_free_set_NULL(P) do { lws_realloc(P, 0); (P) = NULL; } while(0)
1914 lws_plat_delete_socket_from_fds(struct lws_context *context,
1915 struct lws *wsi, int m);
1917 lws_plat_insert_socket_into_fds(struct lws_context *context,
1920 lws_plat_service_periodic(struct lws_context *context);
1923 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1924 struct lws_pollfd *pfd);
1926 lws_plat_context_early_init(void);
1928 lws_plat_context_early_destroy(struct lws_context *context);
1930 lws_plat_context_late_destroy(struct lws_context *context);
1932 lws_poll_listen_fd(struct lws_pollfd *fd);
1934 lws_plat_service(struct lws_context *context, int timeout_ms);
1935 LWS_EXTERN LWS_VISIBLE int
1936 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1938 lws_plat_init(struct lws_context *context,
1939 struct lws_context_creation_info *info);
1941 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1942 LWS_EXTERN unsigned long long
1943 time_in_microseconds(void);
1944 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1945 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
1947 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1948 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);