lib/private-libwebsockets.h

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