5f118ad765abe818ee4d941ca908ea9cbb03bfab
[platform/upstream/libwebsockets.git] / lib / private-libwebsockets.h
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010 - 2016 Andy Green <andy@warmcat.com>
5  *
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.
10  *
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.
15  *
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,
19  *  MA  02110-1301  USA
20  */
21
22 #include "lws_config.h"
23 #include "lws_config_private.h"
24
25
26 #if defined(LWS_WITH_CGI) && defined(LWS_HAVE_VFORK)
27 #define  _GNU_SOURCE
28 #endif
29
30 #ifdef LWS_HAVE_SYS_TYPES_H
31 #include <sys/types.h>
32 #endif
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <time.h>
38 #include <ctype.h>
39 #include <limits.h>
40 #include <stdarg.h>
41 #include <assert.h>
42 #if LWS_MAX_SMP > 1
43 #include <pthread.h>
44 #endif
45
46 #ifdef LWS_HAVE_SYS_STAT_H
47 #include <sys/stat.h>
48 #endif
49
50 #if defined(WIN32) || defined(_WIN32)
51 #if (WINVER < 0x0501)
52 #undef WINVER
53 #undef _WIN32_WINNT
54 #define WINVER 0x0501
55 #define _WIN32_WINNT WINVER
56 #endif
57 #define LWS_NO_DAEMONIZE
58 #define LWS_ERRNO WSAGetLastError()
59 #define LWS_EAGAIN WSAEWOULDBLOCK
60 #define LWS_EALREADY WSAEALREADY
61 #define LWS_EINPROGRESS WSAEINPROGRESS
62 #define LWS_EINTR WSAEINTR
63 #define LWS_EISCONN WSAEISCONN
64 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
65 #define LWS_POLLHUP (FD_CLOSE)
66 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
67 #define LWS_POLLOUT (FD_WRITE)
68 #define MSG_NOSIGNAL 0
69 #define SHUT_RDWR SD_BOTH
70 #define SOL_TCP IPPROTO_TCP
71 #define SHUT_WR SD_SEND
72
73 #define compatible_close(fd) closesocket(fd)
74 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
75 #define lws_socket_is_valid(x) (!!x)
76 #define LWS_SOCK_INVALID 0
77 #include <winsock2.h>
78 #include <ws2tcpip.h>
79 #include <windows.h>
80 #include <tchar.h>
81 #ifdef LWS_HAVE_IN6ADDR_H
82 #include <in6addr.h>
83 #endif
84 #include <mstcpip.h>
85
86 #ifndef __func__
87 #define __func__ __FUNCTION__
88 #endif
89
90 #ifdef _WIN32_WCE
91 #define vsnprintf _vsnprintf
92 #else
93 #ifdef LWS_HAVE__VSNPRINTF
94 #define vsnprintf _vsnprintf
95 #endif
96 #endif
97
98 #ifdef LWS_HAVE__SNPRINTF
99 #define snprintf _snprintf
100 #endif
101
102 #else /* not windows --> */
103
104 #include <fcntl.h>
105 #include <strings.h>
106 #include <unistd.h>
107 #include <sys/types.h>
108 #ifndef MBED_OPERATORS
109 #ifndef __cplusplus
110 #include <errno.h>
111 #endif
112 #include <netdb.h>
113 #include <signal.h>
114 #include <sys/socket.h>
115 #ifdef LWS_BUILTIN_GETIFADDRS
116  #include <getifaddrs.h>
117 #else
118  #include <ifaddrs.h>
119 #endif
120 #if defined (__ANDROID__)
121 #include <syslog.h>
122 #else
123 #include <sys/syslog.h>
124 #endif
125 #include <sys/un.h>
126 #include <sys/socket.h>
127 #include <netdb.h>
128 #include <netinet/in.h>
129 #include <netinet/tcp.h>
130 #include <arpa/inet.h>
131 #include <poll.h>
132 #ifdef LWS_USE_LIBEV
133 #include <ev.h>
134 #endif
135 #ifdef LWS_USE_LIBUV
136 #include <uv.h>
137 #endif
138 #include <sys/mman.h>
139
140 #endif /* MBED */
141
142 #ifndef LWS_NO_FORK
143 #ifdef LWS_HAVE_SYS_PRCTL_H
144 #include <sys/prctl.h>
145 #endif
146 #endif
147
148 #include <sys/time.h>
149
150 #define LWS_ERRNO errno
151 #define LWS_EAGAIN EAGAIN
152 #define LWS_EALREADY EALREADY
153 #define LWS_EINPROGRESS EINPROGRESS
154 #define LWS_EINTR EINTR
155 #define LWS_EISCONN EISCONN
156 #define LWS_EWOULDBLOCK EWOULDBLOCK
157 #define LWS_POLLHUP (POLLHUP|POLLERR)
158 #define LWS_POLLIN (POLLIN)
159 #define LWS_POLLOUT (POLLOUT)
160 #define compatible_close(fd) close(fd)
161 #define lws_set_blocking_send(wsi)
162
163 #ifdef MBED_OPERATORS
164 #define lws_socket_is_valid(x) ((x) != NULL)
165 #define LWS_SOCK_INVALID (NULL)
166 #else
167 #define lws_socket_is_valid(x) (x >= 0)
168 #define LWS_SOCK_INVALID (-1)
169 #endif
170 #endif
171
172 #ifndef LWS_HAVE_BZERO
173 #ifndef bzero
174 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
175 #endif
176 #endif
177
178 #ifndef LWS_HAVE_STRERROR
179 #define strerror(x) ""
180 #endif
181
182 #ifdef LWS_OPENSSL_SUPPORT
183 #ifdef USE_WOLFSSL
184 #ifdef USE_OLD_CYASSL
185 #include <cyassl/openssl/ssl.h>
186 #include <cyassl/error-ssl.h>
187 #else
188 #include <wolfssl/openssl/ssl.h>
189 #include <wolfssl/error-ssl.h>
190 #endif /* not USE_OLD_CYASSL */
191 #else
192 #include <openssl/ssl.h>
193 #include <openssl/evp.h>
194 #include <openssl/err.h>
195 #include <openssl/md5.h>
196 #include <openssl/sha.h>
197 #endif /* not USE_WOLFSSL */
198 #endif
199
200 #include "libwebsockets.h"
201
202 #if defined(MBED_OPERATORS)
203 #undef compatible_close
204 #define compatible_close(fd) mbed3_delete_tcp_stream_socket(fd)
205 #ifndef BIG_ENDIAN
206 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
207 #endif
208 #ifndef LITTLE_ENDIAN
209 #define LITTLE_ENDIAN 1234
210 #endif
211 #ifndef BYTE_ORDER
212 #define BYTE_ORDER LITTLE_ENDIAN
213 #endif
214 #endif
215
216 #if defined(WIN32) || defined(_WIN32)
217
218 #ifndef BIG_ENDIAN
219 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
220 #endif
221 #ifndef LITTLE_ENDIAN
222 #define LITTLE_ENDIAN 1234
223 #endif
224 #ifndef BYTE_ORDER
225 #define BYTE_ORDER LITTLE_ENDIAN
226 #endif
227 #ifndef u_int64_t
228 typedef unsigned __int64 u_int64_t;
229 #endif
230
231 #undef __P
232 #ifndef __P
233 #if __STDC__
234 #define __P(protos) protos
235 #else
236 #define __P(protos) ()
237 #endif
238 #endif
239
240 #else
241
242 #include <sys/stat.h>
243 #include <sys/cdefs.h>
244 #include <sys/time.h>
245
246 #if defined(__APPLE__)
247 #include <machine/endian.h>
248 #elif defined(__FreeBSD__)
249 #include <sys/endian.h>
250 #elif defined(__linux__)
251 #include <endian.h>
252 #endif
253
254 #ifdef __cplusplus
255 extern "C" {
256 #endif
257 #include <stddef.h>
258
259 #ifndef container_of
260 #define container_of(P,T,M)     ((T *)((char *)(P) - offsetof(T, M)))
261 #endif
262
263 #if defined(__QNX__)
264         #include <gulliver.h>
265         #if defined(__LITTLEENDIAN__)
266                 #define BYTE_ORDER __LITTLEENDIAN__
267                 #define LITTLE_ENDIAN __LITTLEENDIAN__
268                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
269         #endif
270         #if defined(__BIGENDIAN__)
271                 #define BYTE_ORDER __BIGENDIAN__
272                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
273                 #define BIG_ENDIAN __BIGENDIAN__
274         #endif
275 #endif
276
277 #if !defined(BYTE_ORDER)
278 # define BYTE_ORDER __BYTE_ORDER
279 #endif
280 #if !defined(LITTLE_ENDIAN)
281 # define LITTLE_ENDIAN __LITTLE_ENDIAN
282 #endif
283 #if !defined(BIG_ENDIAN)
284 # define BIG_ENDIAN __BIG_ENDIAN
285 #endif
286
287 #endif
288
289 /*
290  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
291  * but happily have something equivalent in the SO_NOSIGPIPE flag.
292  */
293 #ifdef __APPLE__
294 #define MSG_NOSIGNAL SO_NOSIGPIPE
295 #endif
296
297 #ifdef _WIN32
298 #ifndef FD_HASHTABLE_MODULUS
299 #define FD_HASHTABLE_MODULUS 32
300 #endif
301 #endif
302
303 #ifndef LWS_DEF_HEADER_LEN
304 #define LWS_DEF_HEADER_LEN 1024
305 #endif
306 #ifndef LWS_DEF_HEADER_POOL
307 #define LWS_DEF_HEADER_POOL 16
308 #endif
309 #ifndef LWS_MAX_PROTOCOLS
310 #define LWS_MAX_PROTOCOLS 5
311 #endif
312 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
313 #define LWS_MAX_EXTENSIONS_ACTIVE 2
314 #endif
315 #ifndef LWS_MAX_EXT_OFFERS
316 #define LWS_MAX_EXT_OFFERS 8
317 #endif
318 #ifndef SPEC_LATEST_SUPPORTED
319 #define SPEC_LATEST_SUPPORTED 13
320 #endif
321 #ifndef AWAITING_TIMEOUT
322 #define AWAITING_TIMEOUT 20
323 #endif
324 #ifndef CIPHERS_LIST_STRING
325 #define CIPHERS_LIST_STRING "DEFAULT"
326 #endif
327 #ifndef LWS_SOMAXCONN
328 #define LWS_SOMAXCONN SOMAXCONN
329 #endif
330
331 #define MAX_WEBSOCKET_04_KEY_LEN 128
332 #define LWS_MAX_SOCKET_IO_BUF 4096
333
334 #ifndef SYSTEM_RANDOM_FILEPATH
335 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
336 #endif
337
338 enum lws_websocket_opcodes_07 {
339         LWSWSOPC_CONTINUATION = 0,
340         LWSWSOPC_TEXT_FRAME = 1,
341         LWSWSOPC_BINARY_FRAME = 2,
342
343         LWSWSOPC_NOSPEC__MUX = 7,
344
345         /* control extensions 8+ */
346
347         LWSWSOPC_CLOSE = 8,
348         LWSWSOPC_PING = 9,
349         LWSWSOPC_PONG = 0xa,
350 };
351
352
353 enum lws_connection_states {
354         LWSS_HTTP,
355         LWSS_HTTP_ISSUING_FILE,
356         LWSS_HTTP_HEADERS,
357         LWSS_HTTP_BODY,
358         LWSS_DEAD_SOCKET,
359         LWSS_ESTABLISHED,
360         LWSS_CLIENT_HTTP_ESTABLISHED,
361         LWSS_CLIENT_UNCONNECTED,
362         LWSS_RETURNED_CLOSE_ALREADY,
363         LWSS_AWAITING_CLOSE_ACK,
364         LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
365         LWSS_SHUTDOWN,
366
367         LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
368         LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
369         LWSS_HTTP2_ESTABLISHED,
370
371         LWSS_CGI,
372 };
373
374 enum http_version {
375         HTTP_VERSION_1_0,
376         HTTP_VERSION_1_1,
377 };
378
379 enum http_connection_type {
380         HTTP_CONNECTION_CLOSE,
381         HTTP_CONNECTION_KEEP_ALIVE
382 };
383
384 enum lws_pending_protocol_send {
385         LWS_PPS_NONE,
386         LWS_PPS_HTTP2_MY_SETTINGS,
387         LWS_PPS_HTTP2_ACK_SETTINGS,
388         LWS_PPS_HTTP2_PONG,
389 };
390
391 enum lws_rx_parse_state {
392         LWS_RXPS_NEW,
393
394         LWS_RXPS_04_mask_1,
395         LWS_RXPS_04_mask_2,
396         LWS_RXPS_04_mask_3,
397
398         LWS_RXPS_04_FRAME_HDR_1,
399         LWS_RXPS_04_FRAME_HDR_LEN,
400         LWS_RXPS_04_FRAME_HDR_LEN16_2,
401         LWS_RXPS_04_FRAME_HDR_LEN16_1,
402         LWS_RXPS_04_FRAME_HDR_LEN64_8,
403         LWS_RXPS_04_FRAME_HDR_LEN64_7,
404         LWS_RXPS_04_FRAME_HDR_LEN64_6,
405         LWS_RXPS_04_FRAME_HDR_LEN64_5,
406         LWS_RXPS_04_FRAME_HDR_LEN64_4,
407         LWS_RXPS_04_FRAME_HDR_LEN64_3,
408         LWS_RXPS_04_FRAME_HDR_LEN64_2,
409         LWS_RXPS_04_FRAME_HDR_LEN64_1,
410
411         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
412         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
413         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
414         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
415
416         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
417 };
418
419
420 enum connection_mode {
421         LWSCM_HTTP_SERVING,
422         LWSCM_HTTP_CLIENT, /* we are client to someone else's server */
423         LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
424         LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
425         LWSCM_PRE_WS_SERVING_ACCEPT,
426
427         LWSCM_WS_SERVING,
428         LWSCM_WS_CLIENT,
429
430         LWSCM_HTTP2_SERVING,
431
432         /* transient, ssl delay hiding */
433         LWSCM_SSL_ACK_PENDING,
434         LWSCM_SSL_INIT,
435
436         /* transient modes */
437         LWSCM_WSCL_WAITING_CONNECT,
438         LWSCM_WSCL_WAITING_PROXY_REPLY,
439         LWSCM_WSCL_ISSUE_HANDSHAKE,
440         LWSCM_WSCL_ISSUE_HANDSHAKE2,
441         LWSCM_WSCL_WAITING_SSL,
442         LWSCM_WSCL_WAITING_SERVER_REPLY,
443         LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
444         LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
445
446         /* special internal types */
447         LWSCM_SERVER_LISTENER,
448         LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
449 };
450
451 enum {
452         LWS_RXFLOW_ALLOW = (1 << 0),
453         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
454 };
455
456 /* this is not usable directly by user code any more, lws_close_reason() */
457 #define LWS_WRITE_CLOSE 4
458
459 struct lws_protocols;
460 struct lws;
461
462 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
463
464 struct lws_io_watcher {
465 #ifdef LWS_USE_LIBEV
466         ev_io ev_watcher;
467 #endif
468 #ifdef LWS_USE_LIBUV
469         uv_poll_t uv_watcher;
470 #endif
471         struct lws_context *context;
472 };
473
474 struct lws_signal_watcher {
475 #ifdef LWS_USE_LIBEV
476         ev_signal ev_watcher;
477 #endif
478 #ifdef LWS_USE_LIBUV
479         uv_signal_t uv_watcher;
480 #endif
481         struct lws_context *context;
482 };
483 #endif
484
485 #ifdef _WIN32
486 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
487 struct lws_fd_hashtable {
488         struct lws **wsi;
489         int length;
490 };
491 #endif
492
493 /*
494  * This is totally opaque to code using the library.  It's exported as a
495  * forward-reference pointer-only declaration; the user can use the pointer with
496  * other APIs to get information out of it.
497  */
498
499 struct lws_fragments {
500         unsigned short offset;
501         unsigned short len;
502         unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
503 };
504
505 /*
506  * these are assigned from a pool held in the context.
507  * Both client and server mode uses them for http header analysis
508  */
509
510 struct allocated_headers {
511         struct lws *wsi; /* owner */
512         char *data; /* prepared by context init to point to dedicated storage */
513         /*
514          * the randomly ordered fragments, indexed by frag_index and
515          * lws_fragments->nfrag for continuation.
516          */
517         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
518         time_t assigned;
519         /*
520          * for each recognized token, frag_index says which frag[] his data
521          * starts in (0 means the token did not appear)
522          * the actual header data gets dumped as it comes in, into data[]
523          */
524         unsigned char frag_index[WSI_TOKEN_COUNT];
525         unsigned char rx[2048];
526         unsigned int rxpos;
527         unsigned int rxlen;
528
529 #ifndef LWS_NO_CLIENT
530         char initial_handshake_hash_base64[30];
531 #endif
532
533         unsigned short pos;
534         unsigned char in_use;
535         unsigned char nfrag;
536 };
537
538 /*
539  * so we can have n connections being serviced simultaneously,
540  * these things need to be isolated per-thread.
541  */
542
543 struct lws_context_per_thread {
544 #if LWS_MAX_SMP > 1
545         pthread_mutex_t lock;
546 #endif
547         struct lws_pollfd *fds;
548         struct lws *rx_draining_ext_list;
549         struct lws *tx_draining_ext_list;
550         struct lws *timeout_list;
551         struct lws_context *context;
552 #ifdef LWS_WITH_CGI
553         struct lws_cgi *cgi_list;
554 #endif
555         void *http_header_data;
556         struct allocated_headers *ah_pool;
557         struct lws *ah_wait_list;
558         int ah_wait_list_length;
559 #ifdef LWS_OPENSSL_SUPPORT
560         struct lws *pending_read_list; /* linked list */
561 #endif
562 #ifndef LWS_NO_SERVER
563         struct lws *wsi_listening;
564 #endif
565 #if defined(LWS_USE_LIBEV)
566         struct ev_loop *io_loop_ev;
567 #endif
568 #if defined(LWS_USE_LIBUV)
569         uv_loop_t *io_loop_uv;
570         uv_signal_t signals[8];
571         uv_timer_t uv_timeout_watcher;
572 #endif
573 #if defined(LWS_USE_LIBEV)
574         struct lws_io_watcher w_accept;
575 #endif
576 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
577         struct lws_signal_watcher w_sigint;
578         unsigned char ev_loop_foreign:1;
579 #endif
580         lws_sockfd_type lserv_fd;
581
582         unsigned long count_conns;
583         /*
584          * usable by anything in the service code, but only if the scope
585          * does not last longer than the service action (since next service
586          * of any socket can likewise use it and overwrite)
587          */
588         unsigned char *serv_buf;
589 #ifdef _WIN32
590         WSAEVENT *events;
591 #else
592         int dummy_pipe_fds[2];
593 #endif
594         unsigned int fds_count;
595
596         short ah_count_in_use;
597         unsigned char tid;
598 };
599
600 /*
601  * the rest is managed per-context, that includes
602  *
603  *  - processwide single fd -> wsi lookup
604  *  - contextwide headers pool
605  *  - contextwide ssl context
606  *  - contextwide proxy
607  */
608
609 struct lws_context {
610         time_t last_timeout_check_s;
611         struct lws_plat_file_ops fops;
612         struct lws_context_per_thread pt[LWS_MAX_SMP];
613 #ifdef _WIN32
614 /* different implementation between unix and windows */
615         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
616 #else
617         struct lws **lws_lookup;  /* fd to wsi */
618 #endif
619         const char *iface;
620         const struct lws_token_limits *token_limits;
621         void *user_space;
622
623         const struct lws_protocols *protocols;
624
625 #ifdef LWS_OPENSSL_SUPPORT
626         SSL_CTX *ssl_ctx;
627         SSL_CTX *ssl_client_ctx;
628 #endif
629 #ifndef LWS_NO_EXTENSIONS
630         const struct lws_extension *extensions;
631 #endif
632 #if defined(LWS_USE_LIBEV)
633         lws_ev_signal_cb_t * lws_ev_sigint_cb;
634 #endif
635 #if defined(LWS_USE_LIBUV)
636         lws_uv_signal_cb_t * lws_uv_sigint_cb;
637 #endif
638         char http_proxy_address[128];
639         char proxy_basic_auth_token[128];
640         char canonical_hostname[128];
641 #ifdef LWS_LATENCY
642         unsigned long worst_latency;
643         char worst_latency_info[256];
644 #endif
645
646         int max_fds;
647         int listen_port;
648 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
649         int use_ev_sigint;
650 #endif
651         int started_with_parent;
652
653         int fd_random;
654         int lserv_mod;
655         int count_wsi_allocated;
656         unsigned int http_proxy_port;
657         unsigned int options;
658         unsigned int fd_limit_per_thread;
659         unsigned int timeout_secs;
660
661         /*
662          * set to the Thread ID that's doing the service loop just before entry
663          * to poll indicates service thread likely idling in poll()
664          * volatile because other threads may check it as part of processing
665          * for pollfd event change.
666          */
667         volatile int service_tid;
668         int service_tid_detected;
669
670         int count_protocols;
671         int ka_time;
672         int ka_probes;
673         int ka_interval;
674
675 #ifdef LWS_OPENSSL_SUPPORT
676         int use_ssl;
677         int allow_non_ssl_on_ssl_port;
678         unsigned int user_supplied_ssl_ctx:1;
679 #define lws_ssl_anybody_has_buffered_read(w) \
680                 (w->context->use_ssl && \
681                  w->context->pt[(int)w->tsi].pending_read_list)
682 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
683                 (c->use_ssl && \
684                  c->pt[(int)t].pending_read_list)
685 #else
686 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
687 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
688 #endif
689
690         short max_http_header_data;
691         short max_http_header_pool;
692         short count_threads;
693
694         unsigned int being_destroyed:1;
695         unsigned int requested_kill:1;
696 };
697
698 LWS_EXTERN void
699 lws_close_free_wsi_final(struct lws *wsi);
700 LWS_EXTERN void
701 lws_libuv_closehandle(struct lws *wsi);
702
703 enum {
704         LWS_EV_READ = (1 << 0),
705         LWS_EV_WRITE = (1 << 1),
706         LWS_EV_START = (1 << 2),
707         LWS_EV_STOP = (1 << 3),
708
709         LWS_EV_PREPARE_DELETION = (1 << 31),
710 };
711
712 #if defined(LWS_USE_LIBEV)
713 LWS_EXTERN void
714 lws_libev_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
715 LWS_EXTERN void
716 lws_libev_io(struct lws *wsi, int flags);
717 LWS_EXTERN int
718 lws_libev_init_fd_table(struct lws_context *context);
719 LWS_EXTERN void
720 lws_libev_destroyloop(struct lws_context *context, int tsi);
721 LWS_EXTERN void
722 lws_libev_run(const struct lws_context *context, int tsi);
723 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
724 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
725 #else
726 #define lws_libev_accept(_a, _b) ((void) 0)
727 #define lws_libev_io(_a, _b) ((void) 0)
728 #define lws_libev_init_fd_table(_a) (0)
729 #define lws_libev_run(_a, _b) ((void) 0)
730 #define lws_libev_destroyloop(_a, _b) ((void) 0)
731 #define LWS_LIBEV_ENABLED(context) (0)
732 #if LWS_POSIX
733 #define lws_feature_status_libev(_a) \
734                         lwsl_notice("libev support not compiled in\n")
735 #else
736 #define lws_feature_status_libev(_a)
737 #endif
738 #endif
739
740 #if defined(LWS_USE_LIBUV)
741 LWS_EXTERN void
742 lws_libuv_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
743 LWS_EXTERN void
744 lws_libuv_io(struct lws *wsi, int flags);
745 LWS_EXTERN int
746 lws_libuv_init_fd_table(struct lws_context *context);
747 LWS_EXTERN void
748 lws_libuv_run(const struct lws_context *context, int tsi);
749 LWS_EXTERN void
750 lws_libuv_destroyloop(struct lws_context *context, int tsi);
751 #define LWS_LIBUV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBUV)
752 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
753 #else
754 #define lws_libuv_accept(_a, _b) ((void) 0)
755 #define lws_libuv_io(_a, _b) ((void) 0)
756 #define lws_libuv_init_fd_table(_a) (0)
757 #define lws_libuv_run(_a, _b) ((void) 0)
758 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
759 #define LWS_LIBUV_ENABLED(context) (0)
760 #if LWS_POSIX
761 #define lws_feature_status_libuv(_a) \
762                         lwsl_notice("libuv support not compiled in\n")
763 #else
764 #define lws_feature_status_libuv(_a)
765 #endif
766 #endif
767
768
769 #ifdef LWS_USE_IPV6
770 #define LWS_IPV6_ENABLED(context) \
771         (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
772 #else
773 #define LWS_IPV6_ENABLED(context) (0)
774 #endif
775
776 enum uri_path_states {
777         URIPS_IDLE,
778         URIPS_SEEN_SLASH,
779         URIPS_SEEN_SLASH_DOT,
780         URIPS_SEEN_SLASH_DOT_DOT,
781 };
782
783 enum uri_esc_states {
784         URIES_IDLE,
785         URIES_SEEN_PERCENT,
786         URIES_SEEN_PERCENT_H1,
787 };
788
789 /* notice that these union members:
790  *
791  *  hdr
792  *  http
793  *  http2
794  *
795  * all have a pointer to allocated_headers struct as their first member.
796  *
797  * It means for allocated_headers access, the three union paths can all be
798  * used interchangeably to access the same data
799  */
800
801
802 #ifndef LWS_NO_CLIENT
803 struct client_info_stash {
804         char address[256];
805         char path[1024];
806         char host[256];
807         char origin[256];
808         char protocol[256];
809         char method[16];
810 };
811 #endif
812
813 struct _lws_header_related {
814         /* MUST be first in struct */
815         struct allocated_headers *ah;
816         struct lws *ah_wait_list;
817         unsigned char *preamble_rx;
818 #ifndef LWS_NO_CLIENT
819         struct client_info_stash *stash;
820 #endif
821         unsigned int preamble_rx_len;
822         enum uri_path_states ups;
823         enum uri_esc_states ues;
824         short lextable_pos;
825         unsigned short current_token_limit;
826 #ifndef LWS_NO_CLIENT
827         unsigned short c_port;
828 #endif
829         char esc_stash;
830         char post_literal_equal;
831         unsigned char parser_state; /* enum lws_token_indexes */
832         char redirects;
833 };
834
835 struct _lws_http_mode_related {
836         /* MUST be first in struct */
837         struct allocated_headers *ah; /* mirroring  _lws_header_related */
838         struct lws *ah_wait_list;
839         unsigned char *preamble_rx;
840 #ifndef LWS_NO_CLIENT
841         struct client_info_stash *stash;
842 #endif
843         unsigned int preamble_rx_len;
844         struct lws *new_wsi_list;
845         unsigned long filepos;
846         unsigned long filelen;
847         lws_filefd_type fd;
848
849         enum http_version request_version;
850         enum http_connection_type connection_type;
851         unsigned int content_length;
852         unsigned int content_remain;
853 };
854
855 #ifdef LWS_USE_HTTP2
856
857 enum lws_http2_settings {
858         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
859         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
860         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
861         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
862         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
863         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
864
865         LWS_HTTP2_SETTINGS__COUNT /* always last */
866 };
867
868 enum lws_http2_wellknown_frame_types {
869         LWS_HTTP2_FRAME_TYPE_DATA,
870         LWS_HTTP2_FRAME_TYPE_HEADERS,
871         LWS_HTTP2_FRAME_TYPE_PRIORITY,
872         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
873         LWS_HTTP2_FRAME_TYPE_SETTINGS,
874         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
875         LWS_HTTP2_FRAME_TYPE_PING,
876         LWS_HTTP2_FRAME_TYPE_GOAWAY,
877         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
878         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
879
880         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
881 };
882
883 enum lws_http2_flags {
884         LWS_HTTP2_FLAG_END_STREAM = 1,
885         LWS_HTTP2_FLAG_END_HEADERS = 4,
886         LWS_HTTP2_FLAG_PADDED = 8,
887         LWS_HTTP2_FLAG_PRIORITY = 0x20,
888
889         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
890 };
891
892 #define LWS_HTTP2_STREAM_ID_MASTER 0
893 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
894 #define LWS_HTTP2_SETTINGS_LENGTH 6
895
896 struct http2_settings {
897         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
898 };
899
900 enum http2_hpack_state {
901
902         /* optional before first header block */
903         HPKS_OPT_PADDING,
904         HKPS_OPT_E_DEPENDENCY,
905         HKPS_OPT_WEIGHT,
906
907         /* header block */
908         HPKS_TYPE,
909
910         HPKS_IDX_EXT,
911
912         HPKS_HLEN,
913         HPKS_HLEN_EXT,
914
915         HPKS_DATA,
916
917         /* optional after last header block */
918         HKPS_OPT_DISCARD_PADDING,
919 };
920
921 enum http2_hpack_type {
922         HPKT_INDEXED_HDR_7,
923         HPKT_INDEXED_HDR_6_VALUE_INCR,
924         HPKT_LITERAL_HDR_VALUE_INCR,
925         HPKT_INDEXED_HDR_4_VALUE,
926         HPKT_LITERAL_HDR_VALUE,
927         HPKT_SIZE_5
928 };
929
930 struct hpack_dt_entry {
931         int token; /* additions that don't map to a token are ignored */
932         int arg_offset;
933         int arg_len;
934 };
935
936 struct hpack_dynamic_table {
937         struct hpack_dt_entry *entries;
938         char *args;
939         int pos;
940         int next;
941         int num_entries;
942         int args_length;
943 };
944
945 struct _lws_http2_related {
946         /*
947          * having this first lets us also re-use all HTTP union code
948          * and in turn, http_mode_related has allocated headers in right
949          * place so we can use the header apis on the wsi directly still
950          */
951         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
952
953         struct http2_settings my_settings;
954         struct http2_settings peer_settings;
955
956         struct lws *parent_wsi;
957         struct lws *next_child_wsi;
958
959         struct hpack_dynamic_table *hpack_dyn_table;
960         struct lws *stream_wsi;
961         unsigned char ping_payload[8];
962         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
963
964         unsigned int count;
965         unsigned int length;
966         unsigned int stream_id;
967         enum http2_hpack_state hpack;
968         enum http2_hpack_type hpack_type;
969         unsigned int header_index;
970         unsigned int hpack_len;
971         unsigned int hpack_e_dep;
972         int tx_credit;
973         unsigned int my_stream_id;
974         unsigned int child_count;
975         int my_priority;
976
977         unsigned int END_STREAM:1;
978         unsigned int END_HEADERS:1;
979         unsigned int send_END_STREAM:1;
980         unsigned int GOING_AWAY;
981         unsigned int requested_POLLOUT:1;
982         unsigned int waiting_tx_credit:1;
983         unsigned int huff:1;
984         unsigned int value:1;
985
986         unsigned short round_robin_POLLOUT;
987         unsigned short count_POLLOUT_children;
988         unsigned short hpack_pos;
989
990         unsigned char type;
991         unsigned char flags;
992         unsigned char frame_state;
993         unsigned char padding;
994         unsigned char hpack_m;
995         unsigned char initialized;
996 };
997
998 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
999
1000 #endif
1001
1002 struct _lws_websocket_related {
1003         /* cheapest way to deal with ah overlap with ws union transition */
1004         struct _lws_header_related hdr;
1005         char *rx_ubuf;
1006         unsigned int rx_ubuf_alloc;
1007         struct lws *rx_draining_ext_list;
1008         struct lws *tx_draining_ext_list;
1009         size_t rx_packet_length;
1010         unsigned int rx_ubuf_head;
1011         unsigned char mask[4];
1012         /* Also used for close content... control opcode == < 128 */
1013         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1014
1015         unsigned char ping_payload_len;
1016         unsigned char mask_idx;
1017         unsigned char opcode;
1018         unsigned char rsv;
1019         unsigned char rsv_first_msg;
1020         /* zero if no info, or length including 2-byte close code */
1021         unsigned char close_in_ping_buffer_len;
1022         unsigned char utf8;
1023         unsigned char stashed_write_type;
1024         unsigned char tx_draining_stashed_wp;
1025
1026         unsigned int final:1;
1027         unsigned int frame_is_binary:1;
1028         unsigned int all_zero_nonce:1;
1029         unsigned int this_frame_masked:1;
1030         unsigned int inside_frame:1; /* next write will be more of frame */
1031         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1032         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1033         unsigned int ping_pending_flag:1;
1034         unsigned int continuation_possible:1;
1035         unsigned int owed_a_fin:1;
1036         unsigned int check_utf8:1;
1037         unsigned int defeat_check_utf8:1;
1038         unsigned int pmce_compressed_message:1;
1039         unsigned int stashed_write_pending:1;
1040         unsigned int rx_draining_ext:1;
1041         unsigned int tx_draining_ext:1;
1042 };
1043
1044 #ifdef LWS_WITH_CGI
1045
1046 /* wsi who is master of the cgi points to an lws_cgi */
1047
1048 struct lws_cgi {
1049         struct lws_cgi *cgi_list;
1050         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1051         struct lws *wsi; /* owner */
1052         int pipe_fds[3][2];
1053         int pid;
1054
1055         unsigned int being_closed:1;
1056 };
1057
1058 #endif
1059
1060 struct lws {
1061
1062         /* structs */
1063         /* members with mutually exclusive lifetimes are unionized */
1064
1065         union u {
1066                 struct _lws_http_mode_related http;
1067 #ifdef LWS_USE_HTTP2
1068                 struct _lws_http2_related http2;
1069 #endif
1070                 struct _lws_header_related hdr;
1071                 struct _lws_websocket_related ws;
1072         } u;
1073
1074         /* lifetime members */
1075
1076 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1077         struct lws_io_watcher w_read;
1078 #endif
1079 #if defined(LWS_USE_LIBEV)
1080         struct lws_io_watcher w_write;
1081 #endif
1082         time_t pending_timeout_limit;
1083
1084         /* pointers */
1085
1086         struct lws_context *context;
1087         struct lws *parent; /* points to parent, if any */
1088         struct lws *child_list; /* points to first child */
1089         struct lws *sibling_list; /* subsequent children at same level */
1090 #ifdef LWS_WITH_CGI
1091         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1092 #endif
1093         const struct lws_protocols *protocol;
1094         struct lws *timeout_list;
1095         struct lws **timeout_list_prev;
1096         void *user_space;
1097         /* rxflow handling */
1098         unsigned char *rxflow_buffer;
1099         /* truncated send handling */
1100         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1101 #ifndef LWS_NO_EXTENSIONS
1102         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1103         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1104 #endif
1105 #ifdef LWS_OPENSSL_SUPPORT
1106         SSL *ssl;
1107         BIO *client_bio;
1108         struct lws *pending_read_list_prev, *pending_read_list_next;
1109 #endif
1110 #ifdef LWS_LATENCY
1111         unsigned long action_start;
1112         unsigned long latency_start;
1113 #endif
1114         /* pointer / int */
1115         lws_sockfd_type sock;
1116
1117         /* ints */
1118         int position_in_fds_table;
1119         int rxflow_len;
1120         int rxflow_pos;
1121         unsigned int trunc_alloc_len; /* size of malloc */
1122         unsigned int trunc_offset; /* where we are in terms of spilling */
1123         unsigned int trunc_len; /* how much is buffered */
1124
1125         unsigned int hdr_parsing_completed:1;
1126         unsigned int user_space_externally_allocated:1;
1127         unsigned int socket_is_permanently_unusable:1;
1128         unsigned int rxflow_change_to:2;
1129         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1130 #ifndef LWS_NO_CLIENT
1131         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1132 #endif
1133 #ifndef LWS_NO_EXTENSIONS
1134         unsigned int extension_data_pending:1;
1135 #endif
1136 #ifdef LWS_OPENSSL_SUPPORT
1137         unsigned int use_ssl:2;
1138         unsigned int upgraded:1;
1139 #endif
1140 #ifdef _WIN32
1141         unsigned int sock_send_blocking:1;
1142 #endif
1143 #ifdef LWS_OPENSSL_SUPPORT
1144         unsigned int redirect_to_https:1;
1145 #endif
1146
1147         /* chars */
1148 #ifndef LWS_NO_EXTENSIONS
1149         unsigned char count_act_ext;
1150 #endif
1151         unsigned char ietf_spec_revision;
1152         char mode; /* enum connection_mode */
1153         char state; /* enum lws_connection_states */
1154         char state_pre_close;
1155         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1156         char rx_frame_type; /* enum lws_write_protocol */
1157         char pending_timeout; /* enum pending_timeout */
1158         char pps; /* enum lws_pending_protocol_send */
1159         char tsi; /* thread service index we belong to */
1160 #ifdef LWS_WITH_CGI
1161         char cgi_channel; /* which of stdin/out/err */
1162         char hdr_state;
1163 #endif
1164 };
1165
1166 LWS_EXTERN int log_level;
1167
1168 LWS_EXTERN int
1169 lws_socket_bind(struct lws_context *context, int sockfd, int port,
1170                 const char *iface);
1171
1172 LWS_EXTERN void
1173 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1174
1175 LWS_EXTERN int
1176 remove_wsi_socket_from_fds(struct lws *wsi);
1177 LWS_EXTERN int
1178 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1179
1180 #ifndef LWS_LATENCY
1181 static inline void
1182 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1183             int ret, int completion) {
1184         do {
1185                 (void)context; (void)wsi; (void)action; (void)ret;
1186                 (void)completion;
1187         } while (0);
1188 }
1189 static inline void
1190 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1191         do { (void)context; (void)wsi; } while (0);
1192 }
1193 #else
1194 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1195 extern void
1196 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1197             int ret, int completion);
1198 #endif
1199
1200 LWS_EXTERN void
1201 lws_set_protocol_write_pending(struct lws *wsi,
1202                                enum lws_pending_protocol_send pend);
1203 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1204 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1205
1206 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1207 lws_parse(struct lws *wsi, unsigned char c);
1208
1209 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1210 lws_http_action(struct lws *wsi);
1211
1212 LWS_EXTERN int
1213 lws_b64_selftest(void);
1214
1215 LWS_EXTERN int
1216 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
1217
1218 LWS_EXTERN int
1219 lws_service_flag_pending(struct lws_context *context, int tsi);
1220
1221 #if defined(_WIN32) || defined(MBED_OPERATORS)
1222 LWS_EXTERN struct lws *
1223 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1224
1225 LWS_EXTERN int
1226 insert_wsi(struct lws_context *context, struct lws *wsi);
1227
1228 LWS_EXTERN int
1229 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1230 #else
1231 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1232 #define insert_wsi(A,B)   assert(A->lws_lookup[B->sock] == 0); A->lws_lookup[B->sock]=B
1233 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1234 #endif
1235
1236 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1237 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1238
1239 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1240 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1241
1242
1243 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1244 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1245
1246 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1247 lws_client_connect_2(struct lws *wsi);
1248
1249 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1250 lws_client_reset(struct lws *wsi, int ssl, const char *address, int port,
1251                  const char *path, const char *host);
1252
1253 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1254 lws_create_new_server_wsi(struct lws_context *context);
1255
1256 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1257 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1258
1259 LWS_EXTERN int
1260 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1261
1262 LWS_EXTERN struct lws *
1263 lws_client_connect_via_info2(struct lws *wsi);
1264
1265 /*
1266  * EXTENSIONS
1267  */
1268
1269 #ifndef LWS_NO_EXTENSIONS
1270 LWS_VISIBLE void
1271 lws_context_init_extensions(struct lws_context_creation_info *info,
1272                             struct lws_context *context);
1273 LWS_EXTERN int
1274 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1275                           void *v, size_t len);
1276
1277 LWS_EXTERN int
1278 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1279 LWS_EXTERN int
1280 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1281                     void *arg, int len);
1282
1283 #else
1284 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1285 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1286 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1287 #define lws_issue_raw_ext_access lws_issue_raw
1288 #define lws_context_init_extensions(_a, _b)
1289 #endif
1290
1291 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1292 lws_client_interpret_server_handshake(struct lws *wsi);
1293
1294 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1295 lws_rx_sm(struct lws *wsi, unsigned char c);
1296
1297 LWS_EXTERN void
1298 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1299
1300 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1301 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1302
1303 LWS_EXTERN void
1304 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1305
1306 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1307 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1308                             enum lws_callback_reasons reason, void *user,
1309                             void *in, size_t len);
1310 #ifdef LWS_USE_HTTP2
1311 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1312 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1313 LWS_EXTERN int
1314 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1315                                      unsigned char *buf, int len);
1316 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1317 LWS_EXTERN int
1318 lws_http2_parser(struct lws *wsi, unsigned char c);
1319 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1320                                      struct lws *wsi);
1321 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1322                                      unsigned int sid, unsigned int len,
1323                                      unsigned char *buf);
1324 LWS_EXTERN struct lws *
1325 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1326 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1327                                    unsigned char c);
1328 LWS_EXTERN int
1329 lws_add_http2_header_by_name(struct lws *wsi,
1330                              const unsigned char *name,
1331                              const unsigned char *value, int length,
1332                              unsigned char **p, unsigned char *end);
1333 LWS_EXTERN int
1334 lws_add_http2_header_by_token(struct lws *wsi,
1335                             enum lws_token_indexes token,
1336                             const unsigned char *value, int length,
1337                             unsigned char **p, unsigned char *end);
1338 LWS_EXTERN int
1339 lws_add_http2_header_status(struct lws *wsi,
1340                             unsigned int code, unsigned char **p,
1341                             unsigned char *end);
1342 LWS_EXTERN
1343 void lws_http2_configure_if_upgraded(struct lws *wsi);
1344 #else
1345 #define lws_http2_configure_if_upgraded(x)
1346 #endif
1347
1348 LWS_EXTERN int
1349 lws_plat_set_socket_options(struct lws_context *context, lws_sockfd_type fd);
1350
1351 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1352 lws_header_table_attach(struct lws *wsi, int autoservice);
1353
1354 LWS_EXTERN int
1355 lws_header_table_detach(struct lws *wsi, int autoservice);
1356
1357 LWS_EXTERN void
1358 lws_header_table_reset(struct lws *wsi, int autoservice);
1359
1360 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1361 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1362
1363 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1364 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1365
1366 LWS_EXTERN int
1367 lws_ensure_user_space(struct lws *wsi);
1368
1369 LWS_EXTERN int
1370 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1371
1372 #ifndef LWS_NO_SERVER
1373 int lws_context_init_server(struct lws_context_creation_info *info,
1374                             struct lws_context *context);
1375 LWS_EXTERN int
1376 handshake_0405(struct lws_context *context, struct lws *wsi);
1377 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1378 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1379 LWS_EXTERN void
1380 lws_server_get_canonical_hostname(struct lws_context *context,
1381                                   struct lws_context_creation_info *info);
1382 #else
1383 #define lws_context_init_server(_a, _b) (0)
1384 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1385 #define lws_server_get_canonical_hostname(_a, _b)
1386 #endif
1387
1388 #ifndef LWS_NO_DAEMONIZE
1389 LWS_EXTERN int get_daemonize_pid();
1390 #else
1391 #define get_daemonize_pid() (0)
1392 #endif
1393
1394 #if !defined(MBED_OPERATORS)
1395 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1396 interface_to_sa(struct lws_context *context, const char *ifname,
1397                 struct sockaddr_in *addr, size_t addrlen);
1398 #endif
1399 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1400
1401 enum lws_ssl_capable_status {
1402         LWS_SSL_CAPABLE_ERROR = -1,
1403         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1404 };
1405
1406 #ifndef LWS_OPENSSL_SUPPORT
1407 #define LWS_SSL_ENABLED(context) (0)
1408 #define lws_context_init_server_ssl(_a, _b) (0)
1409 #define lws_ssl_destroy(_a)
1410 #define lws_context_init_http2_ssl(_a)
1411 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1412 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1413 #define lws_ssl_pending lws_ssl_pending_no_ssl
1414 #define lws_server_socket_service_ssl(_b, _c) (0)
1415 #define lws_ssl_close(_a) (0)
1416 #define lws_ssl_context_destroy(_a)
1417 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1418 #else
1419 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1420 LWS_EXTERN int openssl_websocket_private_data_index;
1421 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1422 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1423 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1424 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1425 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1426 lws_ssl_pending(struct lws *wsi);
1427 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1428 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1429 LWS_EXTERN int
1430 lws_ssl_close(struct lws *wsi);
1431 LWS_EXTERN void
1432 lws_ssl_context_destroy(struct lws_context *context);
1433 LWS_VISIBLE void
1434 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1435 #ifndef LWS_NO_SERVER
1436 LWS_EXTERN int
1437 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1438                             struct lws_context *context);
1439 #else
1440 #define lws_context_init_server_ssl(_a, _b) (0)
1441 #endif
1442 LWS_EXTERN void
1443 lws_ssl_destroy(struct lws_context *context);
1444
1445 /* HTTP2-related */
1446
1447 #ifdef LWS_USE_HTTP2
1448 LWS_EXTERN void
1449 lws_context_init_http2_ssl(struct lws_context *context);
1450 #else
1451 #define lws_context_init_http2_ssl(_a)
1452 #endif
1453 #endif
1454
1455 #if LWS_MAX_SMP > 1
1456 static LWS_INLINE void
1457 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1458 {
1459         pthread_mutex_init(&pt->lock, NULL);
1460 }
1461 static LWS_INLINE void
1462 lws_pt_lock(struct lws_context_per_thread *pt)
1463 {
1464         pthread_mutex_lock(&pt->lock);
1465 }
1466
1467 static LWS_INLINE void
1468 lws_pt_unlock(struct lws_context_per_thread *pt)
1469 {
1470         pthread_mutex_unlock(&pt->lock);
1471 }
1472 #else
1473 #define lws_pt_mutex_init(_a) (void)(_a)
1474 #define lws_pt_lock(_a) (void)(_a)
1475 #define lws_pt_unlock(_a) (void)(_a)
1476 #endif
1477
1478 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1479 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1480
1481 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1482 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1483
1484 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1485 lws_ssl_pending_no_ssl(struct lws *wsi);
1486
1487 #ifndef LWS_NO_CLIENT
1488 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1489                                          struct lws *wsi,
1490                                          struct lws_pollfd *pollfd);
1491 #ifdef LWS_OPENSSL_SUPPORT
1492 LWS_EXTERN int
1493 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1494                             struct lws_context *context);
1495 #else
1496         #define lws_context_init_client_ssl(_a, _b) (0)
1497 #endif
1498 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1499 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1500 LWS_EXTERN void
1501 lws_decode_ssl_error(void);
1502 #else
1503 #define lws_context_init_client_ssl(_a, _b) (0)
1504 #define lws_handshake_client(_a, _b, _c) (0)
1505 #endif
1506
1507 LWS_EXTERN int
1508 _lws_rx_flow_control(struct lws *wsi);
1509
1510 LWS_EXTERN int
1511 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1512
1513 #ifndef LWS_NO_SERVER
1514 LWS_EXTERN int
1515 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1516                           struct lws_pollfd *pollfd);
1517 LWS_EXTERN int
1518 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1519 LWS_EXTERN int
1520 _lws_server_listen_accept_flow_control(struct lws *twsi, int on);
1521 #else
1522 #define lws_server_socket_service(_a, _b, _c) (0)
1523 #define lws_handshake_server(_a, _b, _c) (0)
1524 #define _lws_server_listen_accept_flow_control(a, b) (0)
1525 #endif
1526
1527 LWS_EXTERN int
1528 lws_get_addresses(struct lws_context *context, void *ads, char *name,
1529                   int name_len, char *rip, int rip_len);
1530
1531 LWS_EXTERN int
1532 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1533
1534 /*
1535  * custom allocator
1536  */
1537 LWS_EXTERN void *
1538 lws_realloc(void *ptr, size_t size);
1539
1540 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1541 lws_zalloc(size_t size);
1542
1543 #define lws_malloc(S)   lws_realloc(NULL, S)
1544 #define lws_free(P)     lws_realloc(P, 0)
1545 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
1546
1547 /* lws_plat_ */
1548 LWS_EXTERN void
1549 lws_plat_delete_socket_from_fds(struct lws_context *context,
1550                                 struct lws *wsi, int m);
1551 LWS_EXTERN void
1552 lws_plat_insert_socket_into_fds(struct lws_context *context,
1553                                 struct lws *wsi);
1554 LWS_EXTERN void
1555 lws_plat_service_periodic(struct lws_context *context);
1556
1557 LWS_EXTERN int
1558 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1559                        struct lws_pollfd *pfd);
1560 LWS_EXTERN int
1561 lws_plat_context_early_init(void);
1562 LWS_EXTERN void
1563 lws_plat_context_early_destroy(struct lws_context *context);
1564 LWS_EXTERN void
1565 lws_plat_context_late_destroy(struct lws_context *context);
1566 LWS_EXTERN int
1567 lws_poll_listen_fd(struct lws_pollfd *fd);
1568 LWS_EXTERN int
1569 lws_plat_service(struct lws_context *context, int timeout_ms);
1570 LWS_EXTERN LWS_VISIBLE int
1571 lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1572 LWS_EXTERN int
1573 lws_plat_init(struct lws_context *context,
1574               struct lws_context_creation_info *info);
1575 LWS_EXTERN void
1576 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1577 LWS_EXTERN unsigned long long
1578 time_in_microseconds(void);
1579 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1580 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
1581
1582 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1583 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
1584
1585 #ifdef __cplusplus
1586 };
1587 #endif