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