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
  42 #if defined(LWS_WITH_ESP32)
  43 #define MSG_NOSIGNAL 0
  44 #define SOMAXCONN 3
  45 #endif
  46
  47 #if defined(LWS_WITH_ESP8266)
  48 #include <user_interface.h>
  49 #define assert(n)
  50
  51 /* rom-provided stdc functions for free, ensure use these instead of libc ones */
  52
  53 int ets_vsprintf(char *str, const char *format, va_list argptr);
  54 int ets_vsnprintf(char *buffer, size_t sizeOfBuffer,  const char *format, va_list argptr);
  55 int ets_snprintf(char *str, size_t size, const char *format, ...);
  56 int ets_sprintf(char *str, const char *format, ...);
  57 int os_printf_plus(const char *format, ...);
  58 #undef malloc
  59 #undef realloc
  60 #undef free
  61 void *pvPortMalloc(size_t s, const char *f, int line);
  62 #define malloc(s) pvPortMalloc(s, "", 0)
  63 void *pvPortRealloc(void *p, size_t s, const char *f, int line);
  64 #define realloc(p, s) pvPortRealloc(p, s, "", 0)
  65 void vPortFree(void *p, const char *f, int line);
  66 #define free(p) vPortFree(p, "", 0)
  67 #undef memcpy
  68 void *ets_memcpy(void *dest, const void *src, size_t n);
  69 #define memcpy ets_memcpy
  70 void *ets_memset(void *dest, int v, size_t n);
  71 #define memset ets_memset
  72 char *ets_strcpy(char *dest, const char *src);
  73 #define strcpy ets_strcpy
  74 char *ets_strncpy(char *dest, const char *src, size_t n);
  75 #define strncpy ets_strncpy
  76 char *ets_strstr(const char *haystack, const char *needle);
  77 #define strstr ets_strstr
  78 int ets_strcmp(const char *s1, const char *s2);
  79 int ets_strncmp(const char *s1, const char *s2, size_t n);
  80 #define strcmp ets_strcmp
  81 #define strncmp ets_strncmp
  82 size_t ets_strlen(const char *s);
  83 #define strlen ets_strlen
  84 void *ets_memmove(void *dest, const void *src, size_t n);
  85 #define memmove ets_memmove
  86 char *ets_strchr(const char *s, int c);
  87 #define strchr_ets_strchr
  88 #undef _DEBUG
  89 #include <osapi.h>
  90
  91 #else
  92 #define STORE_IN_ROM
  93 #include <assert.h>
  94 #endif
  95 #if LWS_MAX_SMP > 1
  96 #include <pthread.h>
  97 #endif
  98
  99 #ifdef LWS_HAVE_SYS_STAT_H
 100 #include <sys/stat.h>
 101 #endif
 102
 103 #if defined(WIN32) || defined(_WIN32)
 104 #if (WINVER < 0x0501)
 105 #undef WINVER
 106 #undef _WIN32_WINNT
 107 #define WINVER 0x0501
 108 #define _WIN32_WINNT WINVER
 109 #endif
 110 #define LWS_NO_DAEMONIZE
 111 #define LWS_ERRNO WSAGetLastError()
 112 #define LWS_EAGAIN WSAEWOULDBLOCK
 113 #define LWS_EALREADY WSAEALREADY
 114 #define LWS_EINPROGRESS WSAEINPROGRESS
 115 #define LWS_EINTR WSAEINTR
 116 #define LWS_EISCONN WSAEISCONN
 117 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
 118 #define MSG_NOSIGNAL 0
 119 #define SHUT_RDWR SD_BOTH
 120 #define SOL_TCP IPPROTO_TCP
 121 #define SHUT_WR SD_SEND
 122
 123 #define compatible_close(fd) closesocket(fd)
 124 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
 125 #define lws_socket_is_valid(x) (!!x)
 126 #define LWS_SOCK_INVALID 0
 127 #include <winsock2.h>
 128 #include <ws2tcpip.h>
 129 #include <windows.h>
 130 #include <tchar.h>
 131 #ifdef LWS_HAVE_IN6ADDR_H
 132 #include <in6addr.h>
 133 #endif
 134 #include <mstcpip.h>
 135 #include <io.h>
 136
 137 #ifndef __func__
 138 #define __func__ __FUNCTION__
 139 #endif
 140
 141 #ifdef LWS_HAVE__VSNPRINTF
 142 #define vsnprintf _vsnprintf
 143 #endif
 144
 145 /* we don't have an implementation for this on windows... */
 146 int kill(int pid, int sig);
 147 int fork(void);
 148 #ifndef SIGINT
 149 #define SIGINT 2
 150 #endif
 151
 152 #else /* not windows --> */
 153
 154 #include <fcntl.h>
 155 #include <strings.h>
 156 #include <unistd.h>
 157 #include <sys/types.h>
 158
 159 #ifndef __cplusplus
 160 #include <errno.h>
 161 #endif
 162 #include <netdb.h>
 163 #include <signal.h>
 164 #ifdef LWS_WITH_ESP8266
 165 #include <sockets.h>
 166 #define vsnprintf ets_vsnprintf
 167 #define snprintf ets_snprintf
 168 #define sprintf ets_sprintf
 169
 170 int kill(int pid, int sig);
 171
 172 #else
 173 #include <sys/socket.h>
 174 #endif
 175 #ifdef LWS_WITH_HTTP_PROXY
 176 #include <hubbub/hubbub.h>
 177 #include <hubbub/parser.h>
 178 #endif
 179 #if defined(LWS_BUILTIN_GETIFADDRS)
 180  #include <getifaddrs.h>
 181 #else
 182  #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
 183  #include <ifaddrs.h>
 184  #endif
 185 #endif
 186 #if defined (__ANDROID__)
 187 #include <syslog.h>
 188 #include <sys/resource.h>
 189 #elif defined (__sun)
 190 #include <syslog.h>
 191 #else
 192 #if !defined(LWS_WITH_ESP8266)  && !defined(LWS_WITH_ESP32)
 193 #include <sys/syslog.h>
 194 #endif
 195 #endif
 196 #include <netdb.h>
 197 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
 198 #include <sys/mman.h>
 199 #include <sys/un.h>
 200 #include <netinet/in.h>
 201 #include <netinet/tcp.h>
 202 #include <arpa/inet.h>
 203 #include <poll.h>
 204 #endif
 205 #ifdef LWS_USE_LIBEV
 206 #include <ev.h>
 207 #endif
 208 #ifdef LWS_USE_LIBUV
 209 #include <uv.h>
 210 #endif
 211 #ifdef LWS_USE_LIBEVENT
 212 #include <event2/event.h>
 213 #endif
 214
 215 #ifndef LWS_NO_FORK
 216 #ifdef LWS_HAVE_SYS_PRCTL_H
 217 #include <sys/prctl.h>
 218 #endif
 219 #endif
 220
 221 #include <sys/time.h>
 222
 223 #define LWS_ERRNO errno
 224 #define LWS_EAGAIN EAGAIN
 225 #define LWS_EALREADY EALREADY
 226 #define LWS_EINPROGRESS EINPROGRESS
 227 #define LWS_EINTR EINTR
 228 #define LWS_EISCONN EISCONN
 229 #define LWS_EWOULDBLOCK EWOULDBLOCK
 230
 231 #define lws_set_blocking_send(wsi)
 232
 233 #if defined(LWS_WITH_ESP8266)
 234 #define lws_socket_is_valid(x) ((x) != NULL)
 235 #define LWS_SOCK_INVALID (NULL)
 236 struct lws;
 237 const char *
 238 lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
 239 #else
 240 #define lws_socket_is_valid(x) (x >= 0)
 241 #define LWS_SOCK_INVALID (-1)
 242 #endif
 243 #endif
 244
 245 #ifndef LWS_HAVE_BZERO
 246 #ifndef bzero
 247 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
 248 #endif
 249 #endif
 250
 251 #ifndef LWS_HAVE_STRERROR
 252 #define strerror(x) ""
 253 #endif
 254
 255 #ifdef LWS_OPENSSL_SUPPORT
 256
 257 #ifdef USE_WOLFSSL
 258 #ifdef USE_OLD_CYASSL
 259 #include <cyassl/openssl/ssl.h>
 260 #include <cyassl/error-ssl.h>
 261 #else
 262 #include <wolfssl/openssl/ssl.h>
 263 #include <wolfssl/error-ssl.h>
 264 #define OPENSSL_NO_TLSEXT
 265 #endif /* not USE_OLD_CYASSL */
 266 #else
 267 #include <openssl/ssl.h>
 268 #if !defined(LWS_WITH_ESP32)
 269 #include <openssl/evp.h>
 270 #include <openssl/err.h>
 271 #include <openssl/md5.h>
 272 #include <openssl/sha.h>
 273 #ifdef LWS_HAVE_OPENSSL_ECDH_H
 274 #include <openssl/ecdh.h>
 275 #endif
 276 #include <openssl/x509v3.h>
 277 #endif
 278 #if (OPENSSL_VERSION_NUMBER < 0x0009080afL)
 279 /* later openssl defines this to negate the presence of tlsext... but it was only
 280  * introduced at 0.9.8j.  Earlier versions don't know it exists so don't
 281  * define it... making it look like the feature exists...
 282  */
 283 #define OPENSSL_NO_TLSEXT
 284 #endif
 285 #endif /* not USE_WOLFSSL */
 286 #endif
 287
 288 #include "libwebsockets.h"
 289 #if defined(WIN32) || defined(_WIN32)
 290 #else
 291 static inline int compatible_close(int fd) { return close(fd); }
 292 #endif
 293
 294 #if defined(WIN32) || defined(_WIN32)
 295 #include <gettimeofday.h>
 296 #endif
 297
 298 #if defined(LWS_WITH_ESP8266)
 299 #undef compatible_close
 300 #define compatible_close(fd) { fd->state=ESPCONN_CLOSE; espconn_delete(fd); }
 301 lws_sockfd_type
 302 esp8266_create_tcp_stream_socket(void);
 303 void
 304 esp8266_tcp_stream_bind(lws_sockfd_type fd, int port, struct lws *wsi);
 305 #ifndef BIG_ENDIAN
 306 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 307 #endif
 308 #ifndef LITTLE_ENDIAN
 309 #define LITTLE_ENDIAN 1234
 310 #endif
 311 #ifndef BYTE_ORDER
 312 #define BYTE_ORDER LITTLE_ENDIAN
 313 #endif
 314 #endif
 315
 316
 317 #if defined(WIN32) || defined(_WIN32)
 318
 319 #ifndef BIG_ENDIAN
 320 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 321 #endif
 322 #ifndef LITTLE_ENDIAN
 323 #define LITTLE_ENDIAN 1234
 324 #endif
 325 #ifndef BYTE_ORDER
 326 #define BYTE_ORDER LITTLE_ENDIAN
 327 #endif
 328 #ifndef u_int64_t
 329 typedef unsigned __int64 u_int64_t;
 330 #endif
 331
 332 #undef __P
 333 #ifndef __P
 334 #if __STDC__
 335 #define __P(protos) protos
 336 #else
 337 #define __P(protos) ()
 338 #endif
 339 #endif
 340
 341 #else
 342
 343 #include <sys/stat.h>
 344 #include <sys/time.h>
 345
 346 #if defined(__APPLE__)
 347 #include <machine/endian.h>
 348 #elif defined(__FreeBSD__)
 349 #include <sys/endian.h>
 350 #elif defined(__linux__)
 351 #include <endian.h>
 352 #endif
 353
 354 #ifdef __cplusplus
 355 extern "C" {
 356 #endif
 357
 358 #if defined(__QNX__)
 359         #include <gulliver.h>
 360         #if defined(__LITTLEENDIAN__)
 361                 #define BYTE_ORDER __LITTLEENDIAN__
 362                 #define LITTLE_ENDIAN __LITTLEENDIAN__
 363                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
 364         #endif
 365         #if defined(__BIGENDIAN__)
 366                 #define BYTE_ORDER __BIGENDIAN__
 367                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
 368                 #define BIG_ENDIAN __BIGENDIAN__
 369         #endif
 370 #endif
 371
 372 #if defined(__sun) && defined(__GNUC__)
 373
 374 #include <arpa/nameser_compat.h>
 375
 376 #if !defined (BYTE_ORDER)
 377 # define BYTE_ORDER __BYTE_ORDER__
 378 #endif
 379
 380 #if !defined(LITTLE_ENDIAN)
 381 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
 382 #endif
 383
 384 #if !defined(BIG_ENDIAN)
 385 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
 386 #endif
 387
 388 #endif /* sun + GNUC */
 389
 390 #if !defined(BYTE_ORDER)
 391 # define BYTE_ORDER __BYTE_ORDER
 392 #endif
 393 #if !defined(LITTLE_ENDIAN)
 394 # define LITTLE_ENDIAN __LITTLE_ENDIAN
 395 #endif
 396 #if !defined(BIG_ENDIAN)
 397 # define BIG_ENDIAN __BIG_ENDIAN
 398 #endif
 399
 400 #endif
 401
 402 /*
 403  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 404  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 405  */
 406 #ifdef __APPLE__
 407 #define MSG_NOSIGNAL SO_NOSIGPIPE
 408 #endif
 409
 410 /*
 411  * Solaris 11.X only supports POSIX 2001, MSG_NOSIGNAL appears in
 412  * POSIX 2008.
 413  */
 414 #ifdef __sun
 415 #define MSG_NOSIGNAL 0
 416 #endif
 417
 418 #ifdef _WIN32
 419 #ifndef FD_HASHTABLE_MODULUS
 420 #define FD_HASHTABLE_MODULUS 32
 421 #endif
 422 #endif
 423
 424 #ifndef LWS_DEF_HEADER_LEN
 425 #define LWS_DEF_HEADER_LEN 4096
 426 #endif
 427 #ifndef LWS_DEF_HEADER_POOL
 428 #define LWS_DEF_HEADER_POOL 4
 429 #endif
 430 #ifndef LWS_MAX_PROTOCOLS
 431 #define LWS_MAX_PROTOCOLS 5
 432 #endif
 433 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
 434 #define LWS_MAX_EXTENSIONS_ACTIVE 2
 435 #endif
 436 #ifndef LWS_MAX_EXT_OFFERS
 437 #define LWS_MAX_EXT_OFFERS 8
 438 #endif
 439 #ifndef SPEC_LATEST_SUPPORTED
 440 #define SPEC_LATEST_SUPPORTED 13
 441 #endif
 442 #ifndef AWAITING_TIMEOUT
 443 #define AWAITING_TIMEOUT 20
 444 #endif
 445 #ifndef CIPHERS_LIST_STRING
 446 #define CIPHERS_LIST_STRING "DEFAULT"
 447 #endif
 448 #ifndef LWS_SOMAXCONN
 449 #define LWS_SOMAXCONN SOMAXCONN
 450 #endif
 451
 452 #define MAX_WEBSOCKET_04_KEY_LEN 128
 453
 454 #ifndef SYSTEM_RANDOM_FILEPATH
 455 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
 456 #endif
 457
 458 enum lws_websocket_opcodes_07 {
 459         LWSWSOPC_CONTINUATION = 0,
 460         LWSWSOPC_TEXT_FRAME = 1,
 461         LWSWSOPC_BINARY_FRAME = 2,
 462
 463         LWSWSOPC_NOSPEC__MUX = 7,
 464
 465         /* control extensions 8+ */
 466
 467         LWSWSOPC_CLOSE = 8,
 468         LWSWSOPC_PING = 9,
 469         LWSWSOPC_PONG = 0xa,
 470 };
 471
 472
 473 enum lws_connection_states {
 474         LWSS_HTTP,
 475         LWSS_HTTP_ISSUING_FILE,
 476         LWSS_HTTP_HEADERS,
 477         LWSS_HTTP_BODY,
 478         LWSS_DEAD_SOCKET,
 479         LWSS_ESTABLISHED,
 480         LWSS_CLIENT_HTTP_ESTABLISHED,
 481         LWSS_CLIENT_UNCONNECTED,
 482         LWSS_RETURNED_CLOSE_ALREADY,
 483         LWSS_AWAITING_CLOSE_ACK,
 484         LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
 485         LWSS_SHUTDOWN,
 486
 487         LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
 488         LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
 489         LWSS_HTTP2_ESTABLISHED,
 490
 491         LWSS_CGI,
 492 };
 493
 494 enum http_version {
 495         HTTP_VERSION_1_0,
 496         HTTP_VERSION_1_1,
 497         HTTP_VERSION_2
 498 };
 499
 500 enum http_connection_type {
 501         HTTP_CONNECTION_CLOSE,
 502         HTTP_CONNECTION_KEEP_ALIVE
 503 };
 504
 505 enum lws_pending_protocol_send {
 506         LWS_PPS_NONE,
 507         LWS_PPS_HTTP2_MY_SETTINGS,
 508         LWS_PPS_HTTP2_ACK_SETTINGS,
 509         LWS_PPS_HTTP2_PONG,
 510 };
 511
 512 enum lws_rx_parse_state {
 513         LWS_RXPS_NEW,
 514
 515         LWS_RXPS_04_mask_1,
 516         LWS_RXPS_04_mask_2,
 517         LWS_RXPS_04_mask_3,
 518
 519         LWS_RXPS_04_FRAME_HDR_1,
 520         LWS_RXPS_04_FRAME_HDR_LEN,
 521         LWS_RXPS_04_FRAME_HDR_LEN16_2,
 522         LWS_RXPS_04_FRAME_HDR_LEN16_1,
 523         LWS_RXPS_04_FRAME_HDR_LEN64_8,
 524         LWS_RXPS_04_FRAME_HDR_LEN64_7,
 525         LWS_RXPS_04_FRAME_HDR_LEN64_6,
 526         LWS_RXPS_04_FRAME_HDR_LEN64_5,
 527         LWS_RXPS_04_FRAME_HDR_LEN64_4,
 528         LWS_RXPS_04_FRAME_HDR_LEN64_3,
 529         LWS_RXPS_04_FRAME_HDR_LEN64_2,
 530         LWS_RXPS_04_FRAME_HDR_LEN64_1,
 531
 532         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
 533         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
 534         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
 535         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
 536
 537         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
 538 };
 539
 540 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
 541
 542 enum connection_mode {
 543         LWSCM_HTTP_SERVING,
 544         LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 545         LWSCM_PRE_WS_SERVING_ACCEPT,
 546
 547         LWSCM_WS_SERVING,
 548         LWSCM_WS_CLIENT,
 549
 550         LWSCM_HTTP2_SERVING,
 551
 552         /* transient, ssl delay hiding */
 553         LWSCM_SSL_ACK_PENDING,
 554         LWSCM_SSL_INIT,
 555         /* as above, but complete into LWSCM_RAW */
 556         LWSCM_SSL_ACK_PENDING_RAW,
 557         LWSCM_SSL_INIT_RAW,
 558
 559         /* special internal types */
 560         LWSCM_SERVER_LISTENER,
 561         LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
 562         LWSCM_RAW, /* raw with bulk handling */
 563         LWSCM_RAW_FILEDESC, /* raw without bulk handling */
 564
 565         /* HTTP Client related */
 566         LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
 567         LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
 568         LWSCM_WSCL_WAITING_CONNECT,
 569         LWSCM_WSCL_WAITING_PROXY_REPLY,
 570         LWSCM_WSCL_ISSUE_HANDSHAKE,
 571         LWSCM_WSCL_ISSUE_HANDSHAKE2,
 572         LWSCM_WSCL_ISSUE_HTTP_BODY,
 573         LWSCM_WSCL_WAITING_SSL,
 574         LWSCM_WSCL_WAITING_SERVER_REPLY,
 575         LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
 576         LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
 577
 578         /****** add new things just above ---^ ******/
 579
 580
 581 };
 582
 583 enum {
 584         LWS_RXFLOW_ALLOW = (1 << 0),
 585         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 586 };
 587
 588 /* this is not usable directly by user code any more, lws_close_reason() */
 589 #define LWS_WRITE_CLOSE 4
 590
 591 struct lws_protocols;
 592 struct lws;
 593
 594 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 595
 596 struct lws_io_watcher {
 597 #ifdef LWS_USE_LIBEV
 598         ev_io ev_watcher;
 599 #endif
 600 #ifdef LWS_USE_LIBUV
 601         uv_poll_t uv_watcher;
 602 #endif
 603 #ifdef LWS_USE_LIBEVENT
 604         struct event *event_watcher;
 605 #endif
 606         struct lws_context *context;
 607 };
 608
 609 struct lws_signal_watcher {
 610 #ifdef LWS_USE_LIBEV
 611         ev_signal ev_watcher;
 612 #endif
 613 #ifdef LWS_USE_LIBUV
 614         uv_signal_t uv_watcher;
 615 #endif
 616 #ifdef LWS_USE_LIBEVENT
 617         struct event *event_watcher;
 618 #endif
 619         struct lws_context *context;
 620 };
 621 #endif
 622
 623 #ifdef _WIN32
 624 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
 625 struct lws_fd_hashtable {
 626         struct lws **wsi;
 627         int length;
 628 };
 629 #endif
 630
 631 /*
 632  * This is totally opaque to code using the library.  It's exported as a
 633  * forward-reference pointer-only declaration; the user can use the pointer with
 634  * other APIs to get information out of it.
 635  */
 636
 637 struct lws_fragments {
 638         unsigned int offset;
 639         unsigned short len;
 640         unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
 641 };
 642
 643 /*
 644  * these are assigned from a pool held in the context.
 645  * Both client and server mode uses them for http header analysis
 646  */
 647
 648 struct allocated_headers {
 649         struct lws *wsi; /* owner */
 650         char *data; /* prepared by context init to point to dedicated storage */
 651         /*
 652          * the randomly ordered fragments, indexed by frag_index and
 653          * lws_fragments->nfrag for continuation.
 654          */
 655         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 656         time_t assigned;
 657         /*
 658          * for each recognized token, frag_index says which frag[] his data
 659          * starts in (0 means the token did not appear)
 660          * the actual header data gets dumped as it comes in, into data[]
 661          */
 662         unsigned char frag_index[WSI_TOKEN_COUNT];
 663         unsigned char rx[2048];
 664
 665         unsigned int rxpos;
 666         unsigned int rxlen;
 667         unsigned int pos;
 668
 669         unsigned int http_response;
 670
 671 #ifndef LWS_NO_CLIENT
 672         char initial_handshake_hash_base64[30];
 673 #endif
 674
 675         unsigned char in_use;
 676         unsigned char nfrag;
 677 };
 678
 679 /*
 680  * so we can have n connections being serviced simultaneously,
 681  * these things need to be isolated per-thread.
 682  */
 683
 684 struct lws_context_per_thread {
 685 #if LWS_MAX_SMP > 1
 686         pthread_mutex_t lock;
 687 #endif
 688         struct lws_pollfd *fds;
 689 #if defined(LWS_WITH_ESP8266)
 690         struct lws **lws_vs_fds_index;
 691 #endif
 692         struct lws *rx_draining_ext_list;
 693         struct lws *tx_draining_ext_list;
 694         struct lws *timeout_list;
 695 #if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 696         struct lws_context *context;
 697 #endif
 698 #ifdef LWS_WITH_CGI
 699         struct lws_cgi *cgi_list;
 700 #endif
 701         void *http_header_data;
 702         struct allocated_headers *ah_pool;
 703         struct lws *ah_wait_list;
 704         int ah_wait_list_length;
 705 #ifdef LWS_OPENSSL_SUPPORT
 706         struct lws *pending_read_list; /* linked list */
 707 #endif
 708 #if defined(LWS_USE_LIBEV)
 709         struct ev_loop *io_loop_ev;
 710 #endif
 711 #if defined(LWS_USE_LIBUV)
 712         uv_loop_t *io_loop_uv;
 713         uv_signal_t signals[8];
 714         uv_timer_t uv_timeout_watcher;
 715         uv_idle_t uv_idle;
 716 #endif
 717 #if defined(LWS_USE_LIBEVENT)
 718         struct event_base *io_loop_event_base;
 719 #endif
 720 #if defined(LWS_USE_LIBEV)
 721         struct lws_io_watcher w_accept;
 722 #endif
 723 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 724         struct lws_signal_watcher w_sigint;
 725         unsigned char ev_loop_foreign:1;
 726 #endif
 727
 728         unsigned long count_conns;
 729         /*
 730          * usable by anything in the service code, but only if the scope
 731          * does not last longer than the service action (since next service
 732          * of any socket can likewise use it and overwrite)
 733          */
 734         unsigned char *serv_buf;
 735 #ifdef _WIN32
 736         WSAEVENT *events;
 737 #else
 738         lws_sockfd_type dummy_pipe_fds[2];
 739 #endif
 740         unsigned int fds_count;
 741
 742         short ah_count_in_use;
 743         unsigned char tid;
 744         unsigned char lock_depth;
 745 };
 746
 747 struct lws_conn_stats {
 748         unsigned long long rx, tx;
 749         unsigned long conn, trans, ws_upg, http2_upg, rejected;
 750 };
 751
 752 void
 753 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
 754
 755 /*
 756  * virtual host -related context information
 757  *   vhostwide SSL context
 758  *   vhostwide proxy
 759  *
 760  * hierarchy:
 761  *
 762  * context -> vhost -> wsi
 763  *
 764  * incoming connection non-SSL vhost binding:
 765  *
 766  *    listen socket -> wsi -> select vhost after first headers
 767  *
 768  * incoming connection SSL vhost binding:
 769  *
 770  *    SSL SNI -> wsi -> bind after SSL negotiation
 771  */
 772
 773 struct lws_vhost {
 774 #if !defined(LWS_WITH_ESP8266)
 775         char http_proxy_address[128];
 776         char proxy_basic_auth_token[128];
 777 #endif
 778 #if defined(LWS_WITH_ESP8266)
 779         /* listen sockets need a place to hang their hat */
 780         esp_tcp tcp;
 781 #endif
 782         struct lws_conn_stats conn_stats;
 783         struct lws_context *context;
 784         struct lws_vhost *vhost_next;
 785         const struct lws_http_mount *mount_list;
 786         struct lws *lserv_wsi;
 787         const char *name;
 788         const char *iface;
 789         const struct lws_protocols *protocols;
 790         void **protocol_vh_privs;
 791         const struct lws_protocol_vhost_options *pvo;
 792         const struct lws_protocol_vhost_options *headers;
 793         struct lws **same_vh_protocol_list;
 794 #ifdef LWS_OPENSSL_SUPPORT
 795         SSL_CTX *ssl_ctx;
 796         SSL_CTX *ssl_client_ctx;
 797 #endif
 798 #ifndef LWS_NO_EXTENSIONS
 799         const struct lws_extension *extensions;
 800 #endif
 801
 802         int listen_port;
 803         unsigned int http_proxy_port;
 804         unsigned int options;
 805         int count_protocols;
 806         int ka_time;
 807         int ka_probes;
 808         int ka_interval;
 809         int keepalive_timeout;
 810 #ifdef LWS_WITH_ACCESS_LOG
 811         int log_fd;
 812 #endif
 813
 814 #ifdef LWS_OPENSSL_SUPPORT
 815         int use_ssl;
 816         int allow_non_ssl_on_ssl_port;
 817         unsigned int user_supplied_ssl_ctx:1;
 818 #endif
 819
 820         unsigned int created_vhost_protocols:1;
 821
 822         unsigned char default_protocol_index;
 823         unsigned char raw_protocol_index;
 824 };
 825
 826 /*
 827  * the rest is managed per-context, that includes
 828  *
 829  *  - processwide single fd -> wsi lookup
 830  *  - contextwide headers pool
 831  */
 832
 833 struct lws_context {
 834         time_t last_timeout_check_s;
 835         time_t last_ws_ping_pong_check_s;
 836         time_t time_up;
 837         const struct lws_plat_file_ops *fops;
 838         struct lws_plat_file_ops fops_platform;
 839 #if defined(LWS_WITH_ZIP_FOPS)
 840         struct lws_plat_file_ops fops_zip;
 841 #endif
 842         struct lws_context_per_thread pt[LWS_MAX_SMP];
 843         struct lws_conn_stats conn_stats;
 844 #ifdef _WIN32
 845 /* different implementation between unix and windows */
 846         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
 847 #else
 848 #if defined(LWS_WITH_ESP8266)
 849         struct espconn **connpool; /* .reverse points to the wsi */
 850         void *rxd;
 851         int rxd_len;
 852         os_timer_t to_timer;
 853 #else
 854         struct lws **lws_lookup;  /* fd to wsi */
 855 #endif
 856 #endif
 857         struct lws_vhost *vhost_list;
 858         struct lws_plugin *plugin_list;
 859
 860         void *external_baggage_free_on_destroy;
 861         const struct lws_token_limits *token_limits;
 862         void *user_space;
 863         const char *server_string;
 864         const struct lws_protocol_vhost_options *reject_service_keywords;
 865         lws_reload_func deprecation_cb;
 866
 867 #if defined(LWS_USE_LIBEV)
 868         lws_ev_signal_cb_t * lws_ev_sigint_cb;
 869 #endif
 870 #if defined(LWS_USE_LIBUV)
 871         uv_signal_cb lws_uv_sigint_cb;
 872 #endif
 873 #if defined(LWS_USE_LIBEVENT)
 874         lws_event_signal_cb_t * lws_event_sigint_cb;
 875 #endif
 876         char canonical_hostname[128];
 877 #ifdef LWS_LATENCY
 878         unsigned long worst_latency;
 879         char worst_latency_info[256];
 880 #endif
 881
 882 #if defined(LWS_WITH_STATS)
 883         uint64_t lws_stats[LWSSTATS_SIZE];
 884         uint64_t last_dump;
 885         int updated;
 886 #endif
 887
 888         int max_fds;
 889 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 890         int use_ev_sigint;
 891 #endif
 892         int started_with_parent;
 893         int uid, gid;
 894
 895         int fd_random;
 896 #ifdef LWS_OPENSSL_SUPPORT
 897 #define lws_ssl_anybody_has_buffered_read(w) \
 898                 (w->vhost->use_ssl && \
 899                  w->context->pt[(int)w->tsi].pending_read_list)
 900 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
 901                 (/*c->use_ssl && */ \
 902                  c->pt[(int)t].pending_read_list)
 903 #else
 904 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
 905 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
 906 #endif
 907         int count_wsi_allocated;
 908         int count_cgi_spawned;
 909         unsigned int options;
 910         unsigned int fd_limit_per_thread;
 911         unsigned int timeout_secs;
 912         unsigned int pt_serv_buf_size;
 913         int max_http_header_data;
 914         int simultaneous_ssl_restriction;
 915         int simultaneous_ssl;
 916
 917         unsigned int deprecated:1;
 918         unsigned int being_destroyed:1;
 919         unsigned int being_destroyed1:1;
 920         unsigned int requested_kill:1;
 921         unsigned int protocol_init_done:1;
 922
 923         /*
 924          * set to the Thread ID that's doing the service loop just before entry
 925          * to poll indicates service thread likely idling in poll()
 926          * volatile because other threads may check it as part of processing
 927          * for pollfd event change.
 928          */
 929         volatile int service_tid;
 930         int service_tid_detected;
 931
 932         short max_http_header_pool;
 933         short count_threads;
 934         short plugin_protocol_count;
 935         short plugin_extension_count;
 936         short server_string_len;
 937         unsigned short ws_ping_pong_interval;
 938         unsigned short deprecation_pending_listen_close_count;
 939         uint8_t max_fi;
 940 };
 941
 942 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
 943 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
 944
 945 LWS_EXTERN void
 946 lws_close_free_wsi_final(struct lws *wsi);
 947 LWS_EXTERN void
 948 lws_libuv_closehandle(struct lws *wsi);
 949
 950 LWS_VISIBLE LWS_EXTERN int
 951 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
 952
 953 LWS_VISIBLE LWS_EXTERN int
 954 lws_plat_plugins_destroy(struct lws_context * context);
 955
 956 LWS_EXTERN void
 957 lws_restart_ws_ping_pong_timer(struct lws *wsi);
 958
 959 struct lws *
 960 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
 961
 962
 963 enum {
 964         LWS_EV_READ = (1 << 0),
 965         LWS_EV_WRITE = (1 << 1),
 966         LWS_EV_START = (1 << 2),
 967         LWS_EV_STOP = (1 << 3),
 968
 969         LWS_EV_PREPARE_DELETION = (1 << 31),
 970 };
 971
 972 #if defined(LWS_USE_LIBEV)
 973 LWS_EXTERN void
 974 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
 975 LWS_EXTERN void
 976 lws_libev_io(struct lws *wsi, int flags);
 977 LWS_EXTERN int
 978 lws_libev_init_fd_table(struct lws_context *context);
 979 LWS_EXTERN void
 980 lws_libev_destroyloop(struct lws_context *context, int tsi);
 981 LWS_EXTERN void
 982 lws_libev_run(const struct lws_context *context, int tsi);
 983 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
 984 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
 985 #else
 986 #define lws_libev_accept(_a, _b) ((void) 0)
 987 #define lws_libev_io(_a, _b) ((void) 0)
 988 #define lws_libev_init_fd_table(_a) (0)
 989 #define lws_libev_run(_a, _b) ((void) 0)
 990 #define lws_libev_destroyloop(_a, _b) ((void) 0)
 991 #define LWS_LIBEV_ENABLED(context) (0)
 992 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
 993 #define lws_feature_status_libev(_a) \
 994                         lwsl_notice("libev support not compiled in\n")
 995 #else
 996 #define lws_feature_status_libev(_a)
 997 #endif
 998 #endif
 999
1000 #if defined(LWS_USE_LIBUV)
1001 LWS_EXTERN void
1002 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1003 LWS_EXTERN void
1004 lws_libuv_io(struct lws *wsi, int flags);
1005 LWS_EXTERN int
1006 lws_libuv_init_fd_table(struct lws_context *context);
1007 LWS_EXTERN void
1008 lws_libuv_run(const struct lws_context *context, int tsi);
1009 LWS_EXTERN void
1010 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1011 LWS_EXTERN int
1012 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1013 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1014 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1015 #else
1016 #define lws_libuv_accept(_a, _b) ((void) 0)
1017 #define lws_libuv_io(_a, _b) ((void) 0)
1018 #define lws_libuv_init_fd_table(_a) (0)
1019 #define lws_libuv_run(_a, _b) ((void) 0)
1020 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1021 #define LWS_LIBUV_ENABLED(context) (0)
1022 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1023 #define lws_feature_status_libuv(_a) \
1024                         lwsl_notice("libuv support not compiled in\n")
1025 #else
1026 #define lws_feature_status_libuv(_a)
1027 #endif
1028 #endif
1029
1030 #if defined(LWS_USE_LIBEVENT)
1031 LWS_EXTERN void
1032 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1033 LWS_EXTERN void
1034 lws_libevent_io(struct lws *wsi, int flags);
1035 LWS_EXTERN int
1036 lws_libevent_init_fd_table(struct lws_context *context);
1037 LWS_EXTERN void
1038 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1039 LWS_EXTERN void
1040 lws_libevent_run(const struct lws_context *context, int tsi);
1041 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1042 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1043 #else
1044 #define lws_libevent_accept(_a, _b) ((void) 0)
1045 #define lws_libevent_io(_a, _b) ((void) 0)
1046 #define lws_libevent_init_fd_table(_a) (0)
1047 #define lws_libevent_run(_a, _b) ((void) 0)
1048 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1049 #define LWS_LIBEVENT_ENABLED(context) (0)
1050 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1051 #define lws_feature_status_libevent(_a) \
1052                         lwsl_notice("libevent support not compiled in\n")
1053 #else
1054 #define lws_feature_status_libevent(_a)
1055 #endif
1056 #endif
1057
1058
1059 #ifdef LWS_USE_IPV6
1060 #define LWS_IPV6_ENABLED(vh) \
1061         (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1062          !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1063 #else
1064 #define LWS_IPV6_ENABLED(context) (0)
1065 #endif
1066
1067 #ifdef LWS_USE_UNIX_SOCK
1068 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1069         (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1070 #else
1071 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1072 #endif
1073 enum uri_path_states {
1074         URIPS_IDLE,
1075         URIPS_SEEN_SLASH,
1076         URIPS_SEEN_SLASH_DOT,
1077         URIPS_SEEN_SLASH_DOT_DOT,
1078 };
1079
1080 enum uri_esc_states {
1081         URIES_IDLE,
1082         URIES_SEEN_PERCENT,
1083         URIES_SEEN_PERCENT_H1,
1084 };
1085
1086 /* notice that these union members:
1087  *
1088  *  hdr
1089  *  http
1090  *  http2
1091  *
1092  * all have a pointer to allocated_headers struct as their first member.
1093  *
1094  * It means for allocated_headers access, the three union paths can all be
1095  * used interchangeably to access the same data
1096  */
1097
1098
1099 #ifndef LWS_NO_CLIENT
1100 struct client_info_stash {
1101         char address[256];
1102         char path[4096];
1103         char host[256];
1104         char origin[256];
1105         char protocol[256];
1106         char method[16];
1107 };
1108 #endif
1109
1110 struct _lws_header_related {
1111         /* MUST be first in struct */
1112         struct allocated_headers *ah;
1113         struct lws *ah_wait_list;
1114         unsigned char *preamble_rx;
1115 #ifndef LWS_NO_CLIENT
1116         struct client_info_stash *stash;
1117 #endif
1118         unsigned int preamble_rx_len;
1119         enum uri_path_states ups;
1120         enum uri_esc_states ues;
1121         short lextable_pos;
1122         unsigned int current_token_limit;
1123
1124         char esc_stash;
1125         char post_literal_equal;
1126         unsigned char parser_state; /* enum lws_token_indexes */
1127 };
1128
1129 #if defined(LWS_WITH_RANGES)
1130 enum range_states {
1131         LWSRS_NO_ACTIVE_RANGE,
1132         LWSRS_BYTES_EQ,
1133         LWSRS_FIRST,
1134         LWSRS_STARTING,
1135         LWSRS_ENDING,
1136         LWSRS_COMPLETED,
1137         LWSRS_SYNTAX,
1138 };
1139
1140 struct lws_range_parsing {
1141         unsigned long long start, end, extent, agg, budget;
1142         const char buf[128];
1143         int pos;
1144         enum range_states state;
1145         char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1146 };
1147
1148 int
1149 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1150 int
1151 lws_ranges_next(struct lws_range_parsing *rp);
1152 void
1153 lws_ranges_reset(struct lws_range_parsing *rp);
1154 #endif
1155
1156 struct _lws_http_mode_related {
1157         /* MUST be first in struct */
1158         struct allocated_headers *ah; /* mirroring  _lws_header_related */
1159         struct lws *ah_wait_list;
1160         unsigned char *preamble_rx;
1161 #ifndef LWS_NO_CLIENT
1162         struct client_info_stash *stash;
1163 #endif
1164         unsigned int preamble_rx_len;
1165         struct lws *new_wsi_list;
1166         lws_filepos_t filepos;
1167         lws_filepos_t filelen;
1168         lws_fop_fd_t fop_fd;
1169
1170 #if defined(LWS_WITH_RANGES)
1171         struct lws_range_parsing range;
1172         char multipart_content_type[64];
1173 #endif
1174
1175         enum http_version request_version;
1176         enum http_connection_type connection_type;
1177         unsigned int content_length;
1178         unsigned int content_remain;
1179 };
1180
1181 #ifdef LWS_USE_HTTP2
1182
1183 enum lws_http2_settings {
1184         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1185         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1186         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1187         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1188         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1189         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1190
1191         LWS_HTTP2_SETTINGS__COUNT /* always last */
1192 };
1193
1194 enum lws_http2_wellknown_frame_types {
1195         LWS_HTTP2_FRAME_TYPE_DATA,
1196         LWS_HTTP2_FRAME_TYPE_HEADERS,
1197         LWS_HTTP2_FRAME_TYPE_PRIORITY,
1198         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1199         LWS_HTTP2_FRAME_TYPE_SETTINGS,
1200         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1201         LWS_HTTP2_FRAME_TYPE_PING,
1202         LWS_HTTP2_FRAME_TYPE_GOAWAY,
1203         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1204         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1205
1206         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1207 };
1208
1209 enum lws_http2_flags {
1210         LWS_HTTP2_FLAG_END_STREAM = 1,
1211         LWS_HTTP2_FLAG_END_HEADERS = 4,
1212         LWS_HTTP2_FLAG_PADDED = 8,
1213         LWS_HTTP2_FLAG_PRIORITY = 0x20,
1214
1215         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1216 };
1217
1218 #define LWS_HTTP2_STREAM_ID_MASTER 0
1219 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1220 #define LWS_HTTP2_SETTINGS_LENGTH 6
1221
1222 struct http2_settings {
1223         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1224 };
1225
1226 enum http2_hpack_state {
1227
1228         /* optional before first header block */
1229         HPKS_OPT_PADDING,
1230         HKPS_OPT_E_DEPENDENCY,
1231         HKPS_OPT_WEIGHT,
1232
1233         /* header block */
1234         HPKS_TYPE,
1235
1236         HPKS_IDX_EXT,
1237
1238         HPKS_HLEN,
1239         HPKS_HLEN_EXT,
1240
1241         HPKS_DATA,
1242
1243         /* optional after last header block */
1244         HKPS_OPT_DISCARD_PADDING,
1245 };
1246
1247 enum http2_hpack_type {
1248         HPKT_INDEXED_HDR_7,
1249         HPKT_INDEXED_HDR_6_VALUE_INCR,
1250         HPKT_LITERAL_HDR_VALUE_INCR,
1251         HPKT_INDEXED_HDR_4_VALUE,
1252         HPKT_LITERAL_HDR_VALUE,
1253         HPKT_SIZE_5
1254 };
1255
1256 struct hpack_dt_entry {
1257         int token; /* additions that don't map to a token are ignored */
1258         int arg_offset;
1259         int arg_len;
1260 };
1261
1262 struct hpack_dynamic_table {
1263         struct hpack_dt_entry *entries;
1264         char *args;
1265         int pos;
1266         int next;
1267         int num_entries;
1268         int args_length;
1269 };
1270
1271 struct _lws_http2_related {
1272         /*
1273          * having this first lets us also re-use all HTTP union code
1274          * and in turn, http_mode_related has allocated headers in right
1275          * place so we can use the header apis on the wsi directly still
1276          */
1277         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1278
1279         struct http2_settings my_settings;
1280         struct http2_settings peer_settings;
1281
1282         struct lws *parent_wsi;
1283         struct lws *next_child_wsi;
1284
1285         struct hpack_dynamic_table *hpack_dyn_table;
1286         struct lws *stream_wsi;
1287         unsigned char ping_payload[8];
1288         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1289
1290         unsigned int count;
1291         unsigned int length;
1292         unsigned int stream_id;
1293         enum http2_hpack_state hpack;
1294         enum http2_hpack_type hpack_type;
1295         unsigned int header_index;
1296         unsigned int hpack_len;
1297         unsigned int hpack_e_dep;
1298         int tx_credit;
1299         unsigned int my_stream_id;
1300         unsigned int child_count;
1301         int my_priority;
1302
1303         unsigned int END_STREAM:1;
1304         unsigned int END_HEADERS:1;
1305         unsigned int send_END_STREAM:1;
1306         unsigned int GOING_AWAY;
1307         unsigned int requested_POLLOUT:1;
1308         unsigned int waiting_tx_credit:1;
1309         unsigned int huff:1;
1310         unsigned int value:1;
1311
1312         unsigned short round_robin_POLLOUT;
1313         unsigned short count_POLLOUT_children;
1314         unsigned short hpack_pos;
1315
1316         unsigned char type;
1317         unsigned char flags;
1318         unsigned char frame_state;
1319         unsigned char padding;
1320         unsigned char hpack_m;
1321         unsigned char initialized;
1322 };
1323
1324 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1325
1326 #endif
1327
1328 struct _lws_websocket_related {
1329         /* cheapest way to deal with ah overlap with ws union transition */
1330         struct _lws_header_related hdr;
1331         char *rx_ubuf;
1332         unsigned int rx_ubuf_alloc;
1333         struct lws *rx_draining_ext_list;
1334         struct lws *tx_draining_ext_list;
1335         time_t time_next_ping_check;
1336         size_t rx_packet_length;
1337         unsigned int rx_ubuf_head;
1338         unsigned char mask[4];
1339         /* Also used for close content... control opcode == < 128 */
1340         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1341
1342         unsigned char ping_payload_len;
1343         unsigned char mask_idx;
1344         unsigned char opcode;
1345         unsigned char rsv;
1346         unsigned char rsv_first_msg;
1347         /* zero if no info, or length including 2-byte close code */
1348         unsigned char close_in_ping_buffer_len;
1349         unsigned char utf8;
1350         unsigned char stashed_write_type;
1351         unsigned char tx_draining_stashed_wp;
1352
1353         unsigned int final:1;
1354         unsigned int frame_is_binary:1;
1355         unsigned int all_zero_nonce:1;
1356         unsigned int this_frame_masked:1;
1357         unsigned int inside_frame:1; /* next write will be more of frame */
1358         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1359         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1360         unsigned int ping_pending_flag:1;
1361         unsigned int continuation_possible:1;
1362         unsigned int owed_a_fin:1;
1363         unsigned int check_utf8:1;
1364         unsigned int defeat_check_utf8:1;
1365         unsigned int pmce_compressed_message:1;
1366         unsigned int stashed_write_pending:1;
1367         unsigned int rx_draining_ext:1;
1368         unsigned int tx_draining_ext:1;
1369         unsigned int send_check_ping:1;
1370 };
1371
1372 #ifdef LWS_WITH_CGI
1373
1374 /* wsi who is master of the cgi points to an lws_cgi */
1375
1376 struct lws_cgi {
1377         struct lws_cgi *cgi_list;
1378         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1379         struct lws *wsi; /* owner */
1380         unsigned long content_length;
1381         unsigned long content_length_seen;
1382         int pipe_fds[3][2];
1383         int pid;
1384
1385         unsigned int being_closed:1;
1386
1387         unsigned char chunked_grace;
1388 };
1389 #endif
1390
1391 signed char char_to_hex(const char c);
1392
1393 #ifndef LWS_NO_CLIENT
1394 enum lws_chunk_parser {
1395         ELCP_HEX,
1396         ELCP_CR,
1397         ELCP_CONTENT,
1398         ELCP_POST_CR,
1399         ELCP_POST_LF,
1400 };
1401 #endif
1402
1403 struct lws_rewrite;
1404
1405 #ifdef LWS_WITH_ACCESS_LOG
1406 struct lws_access_log {
1407         char *header_log;
1408         char *user_agent;
1409         unsigned long sent;
1410         int response;
1411 };
1412 #endif
1413
1414 struct lws {
1415
1416         /* structs */
1417         /* members with mutually exclusive lifetimes are unionized */
1418
1419         union u {
1420                 struct _lws_http_mode_related http;
1421 #ifdef LWS_USE_HTTP2
1422                 struct _lws_http2_related http2;
1423 #endif
1424                 struct _lws_header_related hdr;
1425                 struct _lws_websocket_related ws;
1426         } u;
1427
1428         /* lifetime members */
1429
1430 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1431         struct lws_io_watcher w_read;
1432 #endif
1433 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1434         struct lws_io_watcher w_write;
1435 #endif
1436         time_t pending_timeout_limit;
1437
1438         /* pointers */
1439
1440         struct lws_context *context;
1441         struct lws_vhost *vhost;
1442         struct lws *parent; /* points to parent, if any */
1443         struct lws *child_list; /* points to first child */
1444         struct lws *sibling_list; /* subsequent children at same level */
1445 #ifdef LWS_WITH_CGI
1446         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1447 #endif
1448         const struct lws_protocols *protocol;
1449         struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1450         struct lws *timeout_list;
1451         struct lws **timeout_list_prev;
1452 #ifdef LWS_WITH_ACCESS_LOG
1453         struct lws_access_log access_log;
1454 #endif
1455         void *user_space;
1456         /* rxflow handling */
1457         unsigned char *rxflow_buffer;
1458         /* truncated send handling */
1459         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1460
1461 #if defined (LWS_WITH_ESP8266)
1462         void *premature_rx;
1463         unsigned short prem_rx_size, prem_rx_pos;
1464 #endif
1465
1466 #ifndef LWS_NO_EXTENSIONS
1467         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1468         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1469 #endif
1470 #ifdef LWS_OPENSSL_SUPPORT
1471         SSL *ssl;
1472         BIO *client_bio;
1473         struct lws *pending_read_list_prev, *pending_read_list_next;
1474 #if defined(LWS_WITH_STATS)
1475         uint64_t accept_start_us;
1476 #endif
1477 #endif
1478 #ifdef LWS_WITH_HTTP_PROXY
1479         struct lws_rewrite *rw;
1480 #endif
1481 #ifdef LWS_LATENCY
1482         unsigned long action_start;
1483         unsigned long latency_start;
1484 #endif
1485         lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1486 #if defined(LWS_WITH_STATS)
1487         uint64_t active_writable_req_us;
1488 #endif
1489         /* ints */
1490         int position_in_fds_table;
1491         int rxflow_len;
1492         int rxflow_pos;
1493         unsigned int trunc_alloc_len; /* size of malloc */
1494         unsigned int trunc_offset; /* where we are in terms of spilling */
1495         unsigned int trunc_len; /* how much is buffered */
1496 #ifndef LWS_NO_CLIENT
1497         int chunk_remaining;
1498 #endif
1499         unsigned int cache_secs;
1500
1501         unsigned int hdr_parsing_completed:1;
1502         unsigned int http2_substream:1;
1503         unsigned int listener:1;
1504         unsigned int user_space_externally_allocated:1;
1505         unsigned int socket_is_permanently_unusable:1;
1506         unsigned int rxflow_change_to:2;
1507         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1508         unsigned int conn_stat_done:1;
1509         unsigned int cache_reuse:1;
1510         unsigned int cache_revalidate:1;
1511         unsigned int cache_intermediaries:1;
1512         unsigned int favoured_pollin:1;
1513         unsigned int sending_chunked:1;
1514         unsigned int already_did_cce:1;
1515         unsigned int told_user_closed:1;
1516
1517 #if defined(LWS_WITH_ESP8266)
1518         unsigned int pending_send_completion:3;
1519         unsigned int close_is_pending_send_completion:1;
1520 #endif
1521 #ifdef LWS_WITH_ACCESS_LOG
1522         unsigned int access_log_pending:1;
1523 #endif
1524 #ifndef LWS_NO_CLIENT
1525         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1526         unsigned int chunked:1; /* if the clientside connection is chunked */
1527         unsigned int client_rx_avail:1;
1528         unsigned int client_http_body_pending:1;
1529 #endif
1530 #ifdef LWS_WITH_HTTP_PROXY
1531         unsigned int perform_rewrite:1;
1532 #endif
1533 #ifndef LWS_NO_EXTENSIONS
1534         unsigned int extension_data_pending:1;
1535 #endif
1536 #ifdef LWS_OPENSSL_SUPPORT
1537         unsigned int use_ssl:4;
1538 #endif
1539 #ifdef _WIN32
1540         unsigned int sock_send_blocking:1;
1541 #endif
1542 #ifdef LWS_OPENSSL_SUPPORT
1543         unsigned int redirect_to_https:1;
1544 #endif
1545
1546         /* volatile to make sure code is aware other thread can change */
1547         volatile unsigned int handling_pollout:1;
1548         volatile unsigned int leave_pollout_active:1;
1549
1550 #ifndef LWS_NO_CLIENT
1551         unsigned short c_port;
1552 #endif
1553
1554         /* chars */
1555 #ifndef LWS_NO_EXTENSIONS
1556         unsigned char count_act_ext;
1557 #endif
1558         unsigned char ietf_spec_revision;
1559         char mode; /* enum connection_mode */
1560         char state; /* enum lws_connection_states */
1561         char state_pre_close;
1562         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1563         char rx_frame_type; /* enum lws_write_protocol */
1564         char pending_timeout; /* enum pending_timeout */
1565         char pps; /* enum lws_pending_protocol_send */
1566         char tsi; /* thread service index we belong to */
1567         char protocol_interpret_idx;
1568         char redirects;
1569 #ifdef LWS_WITH_CGI
1570         char cgi_channel; /* which of stdin/out/err */
1571         char hdr_state;
1572 #endif
1573 #ifndef LWS_NO_CLIENT
1574         char chunk_parser; /* enum lws_chunk_parser */
1575 #endif
1576 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1577         char reason_bf; /* internal writeable callback reason bitfield */
1578 #endif
1579 };
1580
1581 LWS_EXTERN int log_level;
1582
1583 LWS_EXTERN int
1584 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1585                 const char *iface);
1586
1587 LWS_EXTERN void
1588 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1589
1590 LWS_EXTERN int
1591 remove_wsi_socket_from_fds(struct lws *wsi);
1592 LWS_EXTERN int
1593 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1594
1595 #ifndef LWS_LATENCY
1596 static inline void
1597 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1598             int ret, int completion) {
1599         do {
1600                 (void)context; (void)wsi; (void)action; (void)ret;
1601                 (void)completion;
1602         } while (0);
1603 }
1604 static inline void
1605 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1606         do { (void)context; (void)wsi; } while (0);
1607 }
1608 #else
1609 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1610 extern void
1611 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1612             int ret, int completion);
1613 #endif
1614
1615 LWS_EXTERN void
1616 lws_set_protocol_write_pending(struct lws *wsi,
1617                                enum lws_pending_protocol_send pend);
1618 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1619 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1620
1621 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1622 lws_parse(struct lws *wsi, unsigned char c);
1623
1624 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1625 lws_http_action(struct lws *wsi);
1626
1627 LWS_EXTERN int
1628 lws_b64_selftest(void);
1629
1630 LWS_EXTERN int
1631 lws_service_flag_pending(struct lws_context *context, int tsi);
1632
1633 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1634 LWS_EXTERN struct lws *
1635 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1636
1637 LWS_EXTERN int
1638 insert_wsi(struct lws_context *context, struct lws *wsi);
1639
1640 LWS_EXTERN int
1641 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1642 #else
1643 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1644 #define insert_wsi(A,B)   assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1645 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1646 #endif
1647
1648 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1649 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1650
1651 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1652 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1653
1654
1655 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1656 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1657
1658 LWS_EXTERN void
1659 lws_remove_from_timeout_list(struct lws *wsi);
1660
1661 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1662 lws_client_connect_2(struct lws *wsi);
1663
1664 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1665 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1666                  const char *path, const char *host);
1667
1668 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1669 lws_create_new_server_wsi(struct lws_vhost *vhost);
1670
1671 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1672 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1673
1674 LWS_EXTERN int
1675 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1676
1677 LWS_EXTERN struct lws *
1678 lws_client_connect_via_info2(struct lws *wsi);
1679
1680 /*
1681  * EXTENSIONS
1682  */
1683
1684 #ifndef LWS_NO_EXTENSIONS
1685 LWS_VISIBLE void
1686 lws_context_init_extensions(struct lws_context_creation_info *info,
1687                             struct lws_context *context);
1688 LWS_EXTERN int
1689 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1690                           void *v, size_t len);
1691
1692 LWS_EXTERN int
1693 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1694 LWS_EXTERN int
1695 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1696                     void *arg, int len);
1697
1698 #else
1699 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1700 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1701 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1702 #define lws_issue_raw_ext_access lws_issue_raw
1703 #define lws_context_init_extensions(_a, _b)
1704 #endif
1705
1706 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1707 lws_client_interpret_server_handshake(struct lws *wsi);
1708
1709 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1710 lws_rx_sm(struct lws *wsi, unsigned char c);
1711
1712 LWS_EXTERN int
1713 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1714
1715 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1716 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1717
1718 LWS_EXTERN void
1719 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1720
1721 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1722 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1723                             enum lws_callback_reasons reason, void *user,
1724                             void *in, size_t len);
1725 #ifdef LWS_USE_HTTP2
1726 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1727 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1728 LWS_EXTERN int
1729 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1730                                      unsigned char *buf, int len);
1731 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1732 LWS_EXTERN int
1733 lws_http2_parser(struct lws *wsi, unsigned char c);
1734 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1735                                      struct lws *wsi);
1736 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1737                                      unsigned int sid, unsigned int len,
1738                                      unsigned char *buf);
1739 LWS_EXTERN struct lws *
1740 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1741 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1742                                    unsigned char c);
1743 LWS_EXTERN int
1744 lws_add_http2_header_by_name(struct lws *wsi,
1745                              const unsigned char *name,
1746                              const unsigned char *value, int length,
1747                              unsigned char **p, unsigned char *end);
1748 LWS_EXTERN int
1749 lws_add_http2_header_by_token(struct lws *wsi,
1750                             enum lws_token_indexes token,
1751                             const unsigned char *value, int length,
1752                             unsigned char **p, unsigned char *end);
1753 LWS_EXTERN int
1754 lws_add_http2_header_status(struct lws *wsi,
1755                             unsigned int code, unsigned char **p,
1756                             unsigned char *end);
1757 LWS_EXTERN
1758 void lws_http2_configure_if_upgraded(struct lws *wsi);
1759 #else
1760 #define lws_http2_configure_if_upgraded(x)
1761 #endif
1762
1763 LWS_EXTERN int
1764 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1765
1766 LWS_EXTERN int
1767 lws_plat_check_connection_error(struct lws *wsi);
1768
1769 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1770 lws_header_table_attach(struct lws *wsi, int autoservice);
1771
1772 LWS_EXTERN int
1773 lws_header_table_detach(struct lws *wsi, int autoservice);
1774
1775 LWS_EXTERN void
1776 lws_header_table_reset(struct lws *wsi, int autoservice);
1777 void
1778 _lws_header_table_reset(struct allocated_headers *ah);
1779
1780 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1781 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1782
1783 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1784 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1785
1786 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1787 lws_ensure_user_space(struct lws *wsi);
1788
1789 LWS_EXTERN int
1790 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1791
1792 #ifndef LWS_NO_SERVER
1793 int lws_context_init_server(struct lws_context_creation_info *info,
1794                             struct lws_vhost *vhost);
1795 LWS_EXTERN struct lws_vhost *
1796 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1797 LWS_EXTERN int
1798 handshake_0405(struct lws_context *context, struct lws *wsi);
1799 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1800 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1801 LWS_EXTERN void
1802 lws_server_get_canonical_hostname(struct lws_context *context,
1803                                   struct lws_context_creation_info *info);
1804 #else
1805 #define lws_context_init_server(_a, _b) (0)
1806 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1807 #define lws_server_get_canonical_hostname(_a, _b)
1808 #endif
1809
1810 #ifndef LWS_NO_DAEMONIZE
1811 LWS_EXTERN int get_daemonize_pid();
1812 #else
1813 #define get_daemonize_pid() (0)
1814 #endif
1815
1816 #if !defined(LWS_WITH_ESP8266)
1817 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1818 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1819                 struct sockaddr_in *addr, size_t addrlen);
1820 #endif
1821 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1822
1823 enum lws_ssl_capable_status {
1824         LWS_SSL_CAPABLE_ERROR = -1,
1825         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1826 };
1827
1828 #ifndef LWS_OPENSSL_SUPPORT
1829 #define LWS_SSL_ENABLED(context) (0)
1830 #define lws_context_init_server_ssl(_a, _b) (0)
1831 #define lws_ssl_destroy(_a)
1832 #define lws_context_init_http2_ssl(_a)
1833 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1834 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1835 #define lws_ssl_pending lws_ssl_pending_no_ssl
1836 #define lws_server_socket_service_ssl(_b, _c) (0)
1837 #define lws_ssl_close(_a) (0)
1838 #define lws_ssl_context_destroy(_a)
1839 #define lws_ssl_SSL_CTX_destroy(_a)
1840 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1841 #define lws_context_init_ssl_library(_a)
1842 #else
1843 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1844 LWS_EXTERN int openssl_websocket_private_data_index;
1845 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1846 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1847 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1848 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1849 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1850 lws_ssl_pending(struct lws *wsi);
1851 LWS_EXTERN int
1852 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1853 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1854 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1855 LWS_EXTERN int
1856 lws_ssl_close(struct lws *wsi);
1857 LWS_EXTERN void
1858 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1859 LWS_EXTERN void
1860 lws_ssl_context_destroy(struct lws_context *context);
1861 LWS_VISIBLE void
1862 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1863 LWS_EXTERN int
1864 lws_ssl_client_bio_create(struct lws *wsi);
1865 LWS_EXTERN int
1866 lws_ssl_client_connect1(struct lws *wsi);
1867 LWS_EXTERN int
1868 lws_ssl_client_connect2(struct lws *wsi);
1869 LWS_EXTERN void
1870 lws_ssl_elaborate_error(void);
1871 #ifndef LWS_NO_SERVER
1872 LWS_EXTERN int
1873 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1874                             struct lws_vhost *vhost);
1875 #else
1876 #define lws_context_init_server_ssl(_a, _b) (0)
1877 #endif
1878 LWS_EXTERN void
1879 lws_ssl_destroy(struct lws_vhost *vhost);
1880 /* HTTP2-related */
1881
1882 #ifdef LWS_USE_HTTP2
1883 LWS_EXTERN void
1884 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1885 #else
1886 #define lws_context_init_http2_ssl(_a)
1887 #endif
1888 #endif
1889
1890 #if LWS_MAX_SMP > 1
1891 static LWS_INLINE void
1892 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1893 {
1894         pthread_mutex_init(&pt->lock, NULL);
1895 }
1896
1897 static LWS_INLINE void
1898 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
1899 {
1900         pthread_mutex_destroy(&pt->lock);
1901 }
1902
1903 static LWS_INLINE void
1904 lws_pt_lock(struct lws_context_per_thread *pt)
1905 {
1906         if (!pt->lock_depth++)
1907                 pthread_mutex_lock(&pt->lock);
1908 }
1909
1910 static LWS_INLINE void
1911 lws_pt_unlock(struct lws_context_per_thread *pt)
1912 {
1913         if (!(--pt->lock_depth))
1914                 pthread_mutex_unlock(&pt->lock);
1915 }
1916 #else
1917 #define lws_pt_mutex_init(_a) (void)(_a)
1918 #define lws_pt_mutex_destroy(_a) (void)(_a)
1919 #define lws_pt_lock(_a) (void)(_a)
1920 #define lws_pt_unlock(_a) (void)(_a)
1921 #endif
1922
1923 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1924 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1925
1926 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1927 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1928
1929 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1930 lws_ssl_pending_no_ssl(struct lws *wsi);
1931
1932 #ifdef LWS_WITH_HTTP_PROXY
1933 struct lws_rewrite {
1934         hubbub_parser *parser;
1935         hubbub_parser_optparams params;
1936         const char *from, *to;
1937         int from_len, to_len;
1938         unsigned char *p, *end;
1939         struct lws *wsi;
1940 };
1941 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1942 {
1943         if (s->len != len)
1944                 return 1;
1945
1946         return strncmp((const char *)s->ptr, p, len);
1947 }
1948 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1949 LWS_EXTERN struct lws_rewrite *
1950 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1951 LWS_EXTERN void
1952 lws_rewrite_destroy(struct lws_rewrite *r);
1953 LWS_EXTERN int
1954 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1955 #endif
1956
1957 #ifndef LWS_NO_CLIENT
1958 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1959                                          struct lws *wsi,
1960                                          struct lws_pollfd *pollfd);
1961 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1962 lws_http_transaction_completed_client(struct lws *wsi);
1963 #ifdef LWS_OPENSSL_SUPPORT
1964 LWS_EXTERN int
1965 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1966                             struct lws_vhost *vhost);
1967 #else
1968         #define lws_context_init_client_ssl(_a, _b) (0)
1969 #endif
1970 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1971 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1972 LWS_EXTERN void
1973 lws_decode_ssl_error(void);
1974 #else
1975 #define lws_context_init_client_ssl(_a, _b) (0)
1976 #define lws_handshake_client(_a, _b, _c) (0)
1977 #endif
1978
1979 LWS_EXTERN int
1980 _lws_rx_flow_control(struct lws *wsi);
1981
1982 LWS_EXTERN int
1983 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1984
1985 #ifndef LWS_NO_SERVER
1986 LWS_EXTERN int
1987 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1988                           struct lws_pollfd *pollfd);
1989 LWS_EXTERN int
1990 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1991 #else
1992 #define lws_server_socket_service(_a, _b, _c) (0)
1993 #define lws_handshake_server(_a, _b, _c) (0)
1994 #endif
1995
1996 #ifdef LWS_WITH_ACCESS_LOG
1997 LWS_EXTERN int
1998 lws_access_log(struct lws *wsi);
1999 #else
2000 #define lws_access_log(_a)
2001 #endif
2002
2003 LWS_EXTERN int
2004 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2005
2006 int
2007 lws_protocol_init(struct lws_context *context);
2008
2009 int
2010 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2011
2012 const struct lws_http_mount *
2013 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2014
2015 /*
2016  * custom allocator
2017  */
2018 LWS_EXTERN void *
2019 lws_realloc(void *ptr, size_t size);
2020
2021 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2022 lws_zalloc(size_t size);
2023
2024 #ifdef LWS_PLAT_OPTEE
2025 void *lws_malloc(size_t size);
2026 void lws_free(void *p);
2027 #define lws_free_set_NULL(P)    do { lws_free(P); (P) = NULL; } while(0)
2028 #else
2029 #define lws_malloc(S)   lws_realloc(NULL, S)
2030 #define lws_free(P)     lws_realloc(P, 0)
2031 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
2032 #endif
2033
2034 const struct lws_plat_file_ops *
2035 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2036                     const char **vpath);
2037
2038 /* lws_plat_ */
2039 LWS_EXTERN void
2040 lws_plat_delete_socket_from_fds(struct lws_context *context,
2041                                 struct lws *wsi, int m);
2042 LWS_EXTERN void
2043 lws_plat_insert_socket_into_fds(struct lws_context *context,
2044                                 struct lws *wsi);
2045 LWS_EXTERN void
2046 lws_plat_service_periodic(struct lws_context *context);
2047
2048 LWS_EXTERN int
2049 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2050                        struct lws_pollfd *pfd);
2051 LWS_EXTERN void
2052 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2053 LWS_EXTERN void
2054 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2055 LWS_EXTERN int
2056 lws_plat_context_early_init(void);
2057 LWS_EXTERN void
2058 lws_plat_context_early_destroy(struct lws_context *context);
2059 LWS_EXTERN void
2060 lws_plat_context_late_destroy(struct lws_context *context);
2061 LWS_EXTERN int
2062 lws_poll_listen_fd(struct lws_pollfd *fd);
2063 LWS_EXTERN int
2064 lws_plat_service(struct lws_context *context, int timeout_ms);
2065 LWS_EXTERN LWS_VISIBLE int
2066 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2067 LWS_EXTERN int
2068 lws_plat_init(struct lws_context *context,
2069               struct lws_context_creation_info *info);
2070 LWS_EXTERN void
2071 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2072 LWS_EXTERN unsigned long long
2073 time_in_microseconds(void);
2074 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2075 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2076
2077 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2078 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2079 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2080                                 lws_filepos_t *amount);
2081 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2082                lws_filepos_t *amount);
2083
2084 LWS_EXTERN void
2085 lws_same_vh_protocol_remove(struct lws *wsi);
2086 LWS_EXTERN void
2087 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2088
2089 #if defined(LWS_WITH_STATS)
2090 void
2091 lws_stats_atomic_bump(struct lws_context * context,
2092                 struct lws_context_per_thread *pt, int index, uint64_t bump);
2093 void
2094 lws_stats_atomic_max(struct lws_context * context,
2095                 struct lws_context_per_thread *pt, int index, uint64_t val);
2096 #else
2097 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2098                 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2099         (void)context; (void)pt; (void)index; (void)bump; return 0; }
2100 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2101                 struct lws_context_per_thread *pt, int index, uint64_t val) {
2102         (void)context; (void)pt; (void)index; (void)val; return 0; }
2103 #endif
2104
2105 #ifdef __cplusplus
2106 };
2107 #endif