lib/libwebsockets.c

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010-2014 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 "private-libwebsockets.h"
  23
  24 int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
  25 static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
  26
  27 static const char * const log_level_names[] = {
  28         "ERR",
  29         "WARN",
  30         "NOTICE",
  31         "INFO",
  32         "DEBUG",
  33         "PARSER",
  34         "HEADER",
  35         "EXTENSION",
  36         "CLIENT",
  37         "LATENCY",
  38 };
  39
  40 void
  41 lws_free_wsi(struct libwebsocket *wsi)
  42 {
  43         if (!wsi)
  44                 return;
  45
  46         /* Protocol user data may be allocated either internally by lws
  47          * or by specified the user. Important we don't free external user data */
  48         if (wsi->protocol && wsi->protocol->per_session_data_size
  49                 && wsi->user_space && !wsi->user_space_externally_allocated) {
  50                 lws_free(wsi->user_space);
  51         }
  52
  53         lws_free2(wsi->rxflow_buffer);
  54         lws_free2(wsi->truncated_send_malloc);
  55
  56         // TODO: Probably should handle the union structs in wsi->u here depending
  57         //       on connection mode as well. Too spaghetti for me to follow however...
  58
  59         lws_free_header_table(wsi);
  60         lws_free(wsi);
  61 }
  62
  63 void
  64 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
  65                          struct libwebsocket *wsi, enum lws_close_status reason)
  66 {
  67         int n, m, ret;
  68         int old_state;
  69         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
  70                                                   LWS_SEND_BUFFER_POST_PADDING];
  71         struct lws_tokens eff_buf;
  72
  73         if (!wsi)
  74                 return;
  75
  76         old_state = wsi->state;
  77
  78         if (wsi->socket_is_permanently_unusable ||
  79             reason == LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY)
  80                 goto just_kill_connection;
  81
  82         switch (old_state) {
  83         case WSI_STATE_DEAD_SOCKET:
  84                 return;
  85
  86         /* we tried the polite way... */
  87         case WSI_STATE_AWAITING_CLOSE_ACK:
  88                 goto just_kill_connection;
  89
  90         case WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE:
  91                 if (wsi->truncated_send_len) {
  92                         libwebsocket_callback_on_writable(context, wsi);
  93                         return;
  94                 }
  95                 lwsl_info("wsi %p completed WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE\n", wsi);
  96                 goto just_kill_connection;
  97         default:
  98                 if (wsi->truncated_send_len) {
  99                         lwsl_info("wsi %p entering WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE\n", wsi);
 100                         wsi->state = WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE;
 101                         libwebsocket_set_timeout(wsi, PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE, 5);
 102                         return;
 103                 }
 104                 break;
 105         }
 106
 107         wsi->u.ws.close_reason = reason;
 108
 109         if (wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT ||
 110                         wsi->mode == LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE) {
 111
 112                 context->protocols[0].callback(context, wsi,
 113                         LWS_CALLBACK_CLIENT_CONNECTION_ERROR, wsi->user_space, NULL, 0);
 114
 115                 goto just_kill_connection;
 116         }
 117
 118         if (wsi->mode == LWS_CONNMODE_HTTP_SERVING)
 119                 context->protocols[0].callback(context, wsi,
 120                         LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0);
 121
 122         if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
 123                 if (wsi->u.http.fd != LWS_INVALID_FILE) {
 124                         // TODO: If we're just closing with LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY this file descriptor might leak?
 125                         lwsl_debug("closing http file\n");
 126                         compatible_file_close(wsi->u.http.fd);
 127                         wsi->u.http.fd = LWS_INVALID_FILE;
 128                         context->protocols[0].callback(context, wsi,
 129                                 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0);
 130                 }
 131         }
 132
 133         /*
 134          * are his extensions okay with him closing?  Eg he might be a mux
 135          * parent and just his ch1 aspect is closing?
 136          */
 137
 138         if (lws_ext_callback_for_each_active(wsi,
 139                       LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE, NULL, 0) > 0) {
 140                 lwsl_ext("extension vetoed close\n");
 141                 return;
 142         }
 143
 144         /*
 145          * flush any tx pending from extensions, since we may send close packet
 146          * if there are problems with send, just nuke the connection
 147          */
 148
 149         do {
 150                 ret = 0;
 151                 eff_buf.token = NULL;
 152                 eff_buf.token_len = 0;
 153
 154                 /* show every extension the new incoming data */
 155
 156                 m = lws_ext_callback_for_each_active(wsi,
 157                           LWS_EXT_CALLBACK_FLUSH_PENDING_TX, &eff_buf, 0);
 158                 if (m < 0) {
 159                         lwsl_ext("Extension reports fatal error\n");
 160                         goto just_kill_connection;
 161                 }
 162                 if (m)
 163                         /*
 164                          * at least one extension told us he has more
 165                          * to spill, so we will go around again after
 166                          */
 167                         ret = 1;
 168
 169                 /* assuming they left us something to send, send it */
 170
 171                 if (eff_buf.token_len)
 172                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
 173                                       eff_buf.token_len) != eff_buf.token_len) {
 174                                 lwsl_debug("close: ext spill failed\n");
 175                                 goto just_kill_connection;
 176                         }
 177         } while (ret);
 178
 179         /*
 180          * signal we are closing, libwebsocket_write will
 181          * add any necessary version-specific stuff.  If the write fails,
 182          * no worries we are closing anyway.  If we didn't initiate this
 183          * close, then our state has been changed to
 184          * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
 185          *
 186          * Likewise if it's a second call to close this connection after we
 187          * sent the close indication to the peer already, we are in state
 188          * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
 189          */
 190
 191         if (old_state == WSI_STATE_ESTABLISHED &&
 192             reason != LWS_CLOSE_STATUS_NOSTATUS &&
 193             reason != LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY) {
 194
 195                 lwsl_debug("sending close indication...\n");
 196
 197                 /* make valgrind happy */
 198                 memset(buf, 0, sizeof(buf));
 199                 n = libwebsocket_write(wsi,
 200                                 &buf[LWS_SEND_BUFFER_PRE_PADDING + 2],
 201                                                             0, LWS_WRITE_CLOSE);
 202                 if (n >= 0) {
 203                         /*
 204                          * we have sent a nice protocol level indication we
 205                          * now wish to close, we should not send anything more
 206                          */
 207
 208                         wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
 209
 210                         /*
 211                          * ...and we should wait for a reply for a bit
 212                          * out of politeness
 213                          */
 214
 215                         libwebsocket_set_timeout(wsi,
 216                                                   PENDING_TIMEOUT_CLOSE_ACK, 1);
 217
 218                         lwsl_debug("sent close indication, awaiting ack\n");
 219
 220                         return;
 221                 }
 222
 223                 lwsl_info("close: sending close packet failed, hanging up\n");
 224
 225                 /* else, the send failed and we should just hang up */
 226         }
 227
 228 just_kill_connection:
 229
 230         lwsl_debug("close: just_kill_connection\n");
 231
 232         /*
 233          * we won't be servicing or receiving anything further from this guy
 234          * delete socket from the internal poll list if still present
 235          */
 236
 237         lws_ssl_remove_wsi_from_buffered_list(context, wsi);
 238
 239         remove_wsi_socket_from_fds(context, wsi);
 240
 241         wsi->state = WSI_STATE_DEAD_SOCKET;
 242
 243         lws_free2(wsi->rxflow_buffer);
 244         lws_free_header_table(wsi);
 245
 246         if ((old_state == WSI_STATE_ESTABLISHED ||
 247              wsi->mode == LWS_CONNMODE_WS_SERVING ||
 248              wsi->mode == LWS_CONNMODE_WS_CLIENT)) {
 249
 250                 lws_free2(wsi->u.ws.rx_user_buffer);
 251
 252                 if (wsi->truncated_send_malloc) {
 253                         /* not going to be completed... nuke it */
 254                         lws_free2(wsi->truncated_send_malloc);
 255                         wsi->truncated_send_len = 0;
 256                 }
 257                 if (wsi->u.ws.ping_payload_buf) {
 258                         lws_free2(wsi->u.ws.ping_payload_buf);
 259                         wsi->u.ws.ping_payload_alloc = 0;
 260                         wsi->u.ws.ping_payload_len = 0;
 261                         wsi->u.ws.ping_pending_flag = 0;
 262                 }
 263         }
 264
 265         /* tell the user it's all over for this guy */
 266
 267         if (wsi->protocol && wsi->protocol->callback &&
 268                         ((old_state == WSI_STATE_ESTABLISHED) ||
 269                          (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
 270                          (old_state == WSI_STATE_AWAITING_CLOSE_ACK) ||
 271                          (old_state == WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE))) {
 272                 lwsl_debug("calling back CLOSED\n");
 273                 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
 274                                                       wsi->user_space, NULL, 0);
 275         } else if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
 276                 lwsl_debug("calling back CLOSED_HTTP\n");
 277                 context->protocols[0].callback(context, wsi,
 278                         LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0 );
 279         } else if (wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY ||
 280                    wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT) {
 281                 lwsl_debug("Connection closed before server reply\n");
 282                 context->protocols[0].callback(context, wsi,
 283                                 LWS_CALLBACK_CLIENT_CONNECTION_ERROR,
 284                                 wsi->user_space, NULL, 0 );
 285         } else
 286                 lwsl_debug("not calling back closed mode=%d state=%d\n",
 287                            wsi->mode, old_state);
 288
 289         /* deallocate any active extension contexts */
 290
 291         if (lws_ext_callback_for_each_active(wsi, LWS_EXT_CALLBACK_DESTROY, NULL, 0) < 0)
 292                 lwsl_warn("extension destruction failed\n");
 293 #ifndef LWS_NO_EXTENSIONS
 294         for (n = 0; n < wsi->count_active_extensions; n++)
 295                 lws_free(wsi->active_extensions_user[n]);
 296 #endif
 297         /*
 298          * inform all extensions in case they tracked this guy out of band
 299          * even though not active on him specifically
 300          */
 301         if (lws_ext_callback_for_each_extension_type(context, wsi,
 302                        LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING, NULL, 0) < 0)
 303                 lwsl_warn("ext destroy wsi failed\n");
 304
 305 /*      lwsl_info("closing fd=%d\n", wsi->sock); */
 306
 307         if (!lws_ssl_close(wsi) && wsi->sock >= 0) {
 308                 n = shutdown(wsi->sock, SHUT_RDWR);
 309                 if (n)
 310                         lwsl_debug("closing: shutdown ret %d\n", LWS_ERRNO);
 311
 312                 n = compatible_close(wsi->sock);
 313                 if (n)
 314                         lwsl_debug("closing: close ret %d\n", LWS_ERRNO);
 315         }
 316
 317         /* outermost destroy notification for wsi (user_space still intact) */
 318         context->protocols[0].callback(context, wsi,
 319                         LWS_CALLBACK_WSI_DESTROY, wsi->user_space, NULL, 0);
 320
 321         lws_free_wsi(wsi);
 322 }
 323
 324 LWS_VISIBLE int
 325 libwebsockets_get_addresses(struct libwebsocket_context *context,
 326                             void *ads, char *name, int name_len,
 327                             char *rip, int rip_len)
 328 {
 329         struct addrinfo ai, *res;
 330         void *p = NULL;
 331
 332         rip[0] = '\0';
 333         name[0] = '\0';
 334
 335 #ifdef LWS_USE_IPV6
 336         if (LWS_IPV6_ENABLED(context)) {
 337                 if (!lws_plat_inet_ntop(AF_INET6, &((struct sockaddr_in6 *)ads)->sin6_addr, rip, rip_len)) {
 338                         lwsl_err("inet_ntop", strerror(LWS_ERRNO));
 339                         return -1;
 340                 }
 341
 342                 // Strip off the IPv4 to IPv6 header if one exists
 343                 if (strncmp(rip, "::ffff:", 7) == 0)
 344                         memmove(rip, rip + 7, strlen(rip) - 6);
 345
 346                 getnameinfo((struct sockaddr *)ads,
 347                                 sizeof(struct sockaddr_in6), name,
 348                                                         name_len, NULL, 0, 0);
 349
 350                 return 0;
 351         } else
 352 #endif
 353         {
 354                 memset(&ai, 0, sizeof ai);
 355                 ai.ai_family = PF_UNSPEC;
 356                 ai.ai_socktype = SOCK_STREAM;
 357                 ai.ai_flags = AI_CANONNAME;
 358
 359                 if (getnameinfo((struct sockaddr *)ads,
 360                                 sizeof(struct sockaddr_in),
 361                                 name, name_len, NULL, 0, 0))
 362                         return -1;
 363
 364                 if (!rip)
 365                         return 0;
 366
 367                 if (getaddrinfo(name, NULL, &ai, &res))
 368                         return -1;
 369
 370                 while (!p && res) {
 371                         switch (res->ai_family) {
 372                         case AF_INET:
 373                                 p = &((struct sockaddr_in *)res->ai_addr)->sin_addr;
 374                                 break;
 375                         }
 376
 377                         res = res->ai_next;
 378                 }
 379         }
 380
 381         if (!p)
 382                 return -1;
 383
 384         lws_plat_inet_ntop(AF_INET, p, rip, rip_len);
 385
 386         return 0;
 387 }
 388
 389 /**
 390  * libwebsockets_get_peer_addresses() - Get client address information
 391  * @context:    Libwebsockets context
 392  * @wsi:        Local struct libwebsocket associated with
 393  * @fd:         Connection socket descriptor
 394  * @name:       Buffer to take client address name
 395  * @name_len:   Length of client address name buffer
 396  * @rip:        Buffer to take client address IP dotted quad
 397  * @rip_len:    Length of client address IP buffer
 398  *
 399  *      This function fills in @name and @rip with the name and IP of
 400  *      the client connected with socket descriptor @fd.  Names may be
 401  *      truncated if there is not enough room.  If either cannot be
 402  *      determined, they will be returned as valid zero-length strings.
 403  */
 404
 405 LWS_VISIBLE void
 406 libwebsockets_get_peer_addresses(struct libwebsocket_context *context,
 407         struct libwebsocket *wsi, int fd, char *name, int name_len,
 408                                         char *rip, int rip_len)
 409 {
 410         socklen_t len;
 411 #ifdef LWS_USE_IPV6
 412         struct sockaddr_in6 sin6;
 413 #endif
 414         struct sockaddr_in sin4;
 415         int ret = -1;
 416         void *p;
 417
 418         rip[0] = '\0';
 419         name[0] = '\0';
 420
 421         lws_latency_pre(context, wsi);
 422
 423 #ifdef LWS_USE_IPV6
 424         if (LWS_IPV6_ENABLED(context)) {
 425                 len = sizeof(sin6);
 426                 p = &sin6;
 427         } else
 428 #endif
 429         {
 430                 len = sizeof(sin4);
 431                 p = &sin4;
 432         }
 433
 434         if (getpeername(fd, p, &len) < 0) {
 435                 lwsl_warn("getpeername: %s\n", strerror(LWS_ERRNO));
 436                 goto bail;
 437         }
 438
 439         ret = libwebsockets_get_addresses(context, p, name, name_len, rip, rip_len);
 440
 441 bail:
 442         lws_latency(context, wsi, "libwebsockets_get_peer_addresses", ret, 1);
 443 }
 444
 445 /**
 446  * libwebsocket_context_user() - get the user data associated with the context
 447  * @context: Websocket context
 448  *
 449  *      This returns the optional user allocation that can be attached to
 450  *      the context the sockets live in at context_create time.  It's a way
 451  *      to let all sockets serviced in the same context share data without
 452  *      using globals statics in the user code.
 453  */
 454 LWS_EXTERN void *
 455 libwebsocket_context_user(struct libwebsocket_context *context)
 456 {
 457         return context->user_space;
 458 }
 459
 460
 461 /**
 462  * libwebsocket_callback_all_protocol() - Callback all connections using
 463  *                              the given protocol with the given reason
 464  *
 465  * @protocol:   Protocol whose connections will get callbacks
 466  * @reason:     Callback reason index
 467  */
 468
 469 LWS_VISIBLE int
 470 libwebsocket_callback_all_protocol(
 471                 const struct libwebsocket_protocols *protocol, int reason)
 472 {
 473         struct libwebsocket_context *context = protocol->owning_server;
 474         int n;
 475         struct libwebsocket *wsi;
 476
 477         for (n = 0; n < context->fds_count; n++) {
 478                 wsi = wsi_from_fd(context, context->fds[n].fd);
 479                 if (!wsi)
 480                         continue;
 481                 if (wsi->protocol == protocol)
 482                         protocol->callback(context, wsi,
 483                                         reason, wsi->user_space, NULL, 0);
 484         }
 485
 486         return 0;
 487 }
 488
 489 /**
 490  * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
 491  *
 492  * You will not need this unless you are doing something special
 493  *
 494  * @wsi:        Websocket connection instance
 495  * @reason:     timeout reason
 496  * @secs:       how many seconds
 497  */
 498
 499 LWS_VISIBLE void
 500 libwebsocket_set_timeout(struct libwebsocket *wsi,
 501                                           enum pending_timeout reason, int secs)
 502 {
 503         time_t now;
 504
 505         time(&now);
 506
 507         wsi->pending_timeout_limit = now + secs;
 508         wsi->pending_timeout = reason;
 509 }
 510
 511
 512 /**
 513  * libwebsocket_get_socket_fd() - returns the socket file descriptor
 514  *
 515  * You will not need this unless you are doing something special
 516  *
 517  * @wsi:        Websocket connection instance
 518  */
 519
 520 LWS_VISIBLE int
 521 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
 522 {
 523         return wsi->sock;
 524 }
 525
 526 #ifdef LWS_LATENCY
 527 void
 528 lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi,
 529                                      const char *action, int ret, int completed)
 530 {
 531         unsigned long long u;
 532         char buf[256];
 533
 534         u = time_in_microseconds();
 535
 536         if (!action) {
 537                 wsi->latency_start = u;
 538                 if (!wsi->action_start)
 539                         wsi->action_start = u;
 540                 return;
 541         }
 542         if (completed) {
 543                 if (wsi->action_start == wsi->latency_start)
 544                         sprintf(buf,
 545                           "Completion first try lat %lluus: %p: ret %d: %s\n",
 546                                         u - wsi->latency_start,
 547                                                       (void *)wsi, ret, action);
 548                 else
 549                         sprintf(buf,
 550                           "Completion %lluus: lat %lluus: %p: ret %d: %s\n",
 551                                 u - wsi->action_start,
 552                                         u - wsi->latency_start,
 553                                                       (void *)wsi, ret, action);
 554                 wsi->action_start = 0;
 555         } else
 556                 sprintf(buf, "lat %lluus: %p: ret %d: %s\n",
 557                               u - wsi->latency_start, (void *)wsi, ret, action);
 558
 559         if (u - wsi->latency_start > context->worst_latency) {
 560                 context->worst_latency = u - wsi->latency_start;
 561                 strcpy(context->worst_latency_info, buf);
 562         }
 563         lwsl_latency("%s", buf);
 564 }
 565 #endif
 566
 567
 568
 569 /**
 570  * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
 571  *                              received packets.
 572  *
 573  * If the output side of a server process becomes choked, this allows flow
 574  * control for the input side.
 575  *
 576  * @wsi:        Websocket connection instance to get callback for
 577  * @enable:     0 = disable read servicing for this connection, 1 = enable
 578  */
 579
 580 LWS_VISIBLE int
 581 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
 582 {
 583         if (enable == (wsi->rxflow_change_to & LWS_RXFLOW_ALLOW))
 584                 return 0;
 585
 586         lwsl_info("libwebsocket_rx_flow_control(0x%p, %d)\n", wsi, enable);
 587         wsi->rxflow_change_to = LWS_RXFLOW_PENDING_CHANGE | !!enable;
 588
 589         return 0;
 590 }
 591
 592 /**
 593  * libwebsocket_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
 594  *
 595  * When the user server code realizes it can accept more input, it can
 596  * call this to have the RX flow restriction removed from all connections using
 597  * the given protocol.
 598  *
 599  * @protocol:   all connections using this protocol will be allowed to receive
 600  */
 601
 602 LWS_VISIBLE void
 603 libwebsocket_rx_flow_allow_all_protocol(
 604                                 const struct libwebsocket_protocols *protocol)
 605 {
 606         struct libwebsocket_context *context = protocol->owning_server;
 607         int n;
 608         struct libwebsocket *wsi;
 609
 610         for (n = 0; n < context->fds_count; n++) {
 611                 wsi = wsi_from_fd(context, context->fds[n].fd);
 612                 if (!wsi)
 613                         continue;
 614                 if (wsi->protocol == protocol)
 615                         libwebsocket_rx_flow_control(wsi, LWS_RXFLOW_ALLOW);
 616         }
 617 }
 618
 619
 620 /**
 621  * libwebsocket_canonical_hostname() - returns this host's hostname
 622  *
 623  * This is typically used by client code to fill in the host parameter
 624  * when making a client connection.  You can only call it after the context
 625  * has been created.
 626  *
 627  * @context:    Websocket context
 628  */
 629 LWS_VISIBLE extern const char *
 630 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
 631 {
 632         return (const char *)context->canonical_hostname;
 633 }
 634
 635 int user_callback_handle_rxflow(callback_function callback_function,
 636                 struct libwebsocket_context *context,
 637                         struct libwebsocket *wsi,
 638                          enum libwebsocket_callback_reasons reason, void *user,
 639                                                           void *in, size_t len)
 640 {
 641         int n;
 642
 643         n = callback_function(context, wsi, reason, user, in, len);
 644         if (!n)
 645                 n = _libwebsocket_rx_flow_control(wsi);
 646
 647         return n;
 648 }
 649
 650
 651 /**
 652  * libwebsocket_set_proxy() - Setups proxy to libwebsocket_context.
 653  * @context:    pointer to struct libwebsocket_context you want set proxy to
 654  * @proxy: pointer to c string containing proxy in format address:port
 655  *
 656  * Returns 0 if proxy string was parsed and proxy was setup.
 657  * Returns -1 if @proxy is NULL or has incorrect format.
 658  *
 659  * This is only required if your OS does not provide the http_proxy
 660  * environment variable (eg, OSX)
 661  *
 662  *   IMPORTANT! You should call this function right after creation of the
 663  *   libwebsocket_context and before call to connect. If you call this
 664  *   function after connect behavior is undefined.
 665  *   This function will override proxy settings made on libwebsocket_context
 666  *   creation with genenv() call.
 667  */
 668
 669 LWS_VISIBLE int
 670 libwebsocket_set_proxy(struct libwebsocket_context *context, const char *proxy)
 671 {
 672         char *p;
 673
 674         if (!proxy)
 675                 return -1;
 676
 677         strncpy(context->http_proxy_address, proxy,
 678                                 sizeof(context->http_proxy_address) - 1);
 679         context->http_proxy_address[
 680                                 sizeof(context->http_proxy_address) - 1] = '\0';
 681
 682         p = strchr(context->http_proxy_address, ':');
 683         if (!p) {
 684                 lwsl_err("http_proxy needs to be ads:port\n");
 685
 686                 return -1;
 687         }
 688         *p = '\0';
 689         context->http_proxy_port = atoi(p + 1);
 690
 691         lwsl_notice(" Proxy %s:%u\n", context->http_proxy_address,
 692                                                 context->http_proxy_port);
 693
 694         return 0;
 695 }
 696
 697 /**
 698  * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
 699  *                                connection.
 700  * @wsi:        pointer to struct websocket you want to know the protocol of
 701  *
 702  *
 703  *      Some apis can act on all live connections of a given protocol,
 704  *      this is how you can get a pointer to the active protocol if needed.
 705  */
 706
 707 LWS_VISIBLE const struct libwebsocket_protocols *
 708 libwebsockets_get_protocol(struct libwebsocket *wsi)
 709 {
 710         return wsi->protocol;
 711 }
 712
 713 LWS_VISIBLE int
 714 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
 715 {
 716         return wsi->u.ws.final;
 717 }
 718
 719 LWS_VISIBLE unsigned char
 720 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
 721 {
 722         return wsi->u.ws.rsv;
 723 }
 724
 725 int
 726 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
 727 {
 728         lwsl_info("%s: %p protocol %p\n", __func__, wsi, wsi->protocol);
 729         if (!wsi->protocol)
 730                 return 1;
 731
 732         /* allocate the per-connection user memory (if any) */
 733
 734         if (wsi->protocol->per_session_data_size && !wsi->user_space) {
 735                 wsi->user_space = lws_zalloc(wsi->protocol->per_session_data_size);
 736                 if (wsi->user_space  == NULL) {
 737                         lwsl_err("Out of memory for conn user space\n");
 738                         return 1;
 739                 }
 740         } else
 741                 lwsl_info("%s: %p protocol pss %u, user_space=%d\n", __func__, wsi, wsi->protocol->per_session_data_size, wsi->user_space);
 742         return 0;
 743 }
 744
 745 LWS_VISIBLE void lwsl_emit_stderr(int level, const char *line)
 746 {
 747         char buf[300];
 748         unsigned long long now;
 749         int n;
 750
 751         buf[0] = '\0';
 752         for (n = 0; n < LLL_COUNT; n++)
 753                 if (level == (1 << n)) {
 754                         now = time_in_microseconds() / 100;
 755                         sprintf(buf, "[%llu:%04d] %s: ", (unsigned long long) now / 10000,
 756                                 (int)(now % 10000), log_level_names[n]);
 757                         break;
 758                 }
 759
 760         fprintf(stderr, "%s%s", buf, line);
 761 }
 762
 763
 764 LWS_VISIBLE void _lws_logv(int filter, const char *format, va_list vl)
 765 {
 766         char buf[256];
 767
 768         if (!(log_level & filter))
 769                 return;
 770
 771         vsnprintf(buf, sizeof(buf), format, vl);
 772         buf[sizeof(buf) - 1] = '\0';
 773
 774         lwsl_emit(filter, buf);
 775 }
 776
 777 LWS_VISIBLE void _lws_log(int filter, const char *format, ...)
 778 {
 779         va_list ap;
 780
 781         va_start(ap, format);
 782         _lws_logv(filter, format, ap);
 783         va_end(ap);
 784 }
 785
 786 /**
 787  * lws_set_log_level() - Set the logging bitfield
 788  * @level:      OR together the LLL_ debug contexts you want output from
 789  * @log_emit_function:  NULL to leave it as it is, or a user-supplied
 790  *                      function to perform log string emission instead of
 791  *                      the default stderr one.
 792  *
 793  *      log level defaults to "err", "warn" and "notice" contexts enabled and
 794  *      emission on stderr.
 795  */
 796
 797 LWS_VISIBLE void lws_set_log_level(int level, void (*log_emit_function)(int level,
 798                                                               const char *line))
 799 {
 800         log_level = level;
 801         if (log_emit_function)
 802                 lwsl_emit = log_emit_function;
 803 }
 804
 805 /**
 806  * lws_use_ssl() - Find out if connection is using SSL
 807  * @wsi:        websocket connection to check
 808  *
 809  *      Returns 0 if the connection is not using SSL, 1 if using SSL and
 810  *      using verified cert, and 2 if using SSL but the cert was not
 811  *      checked (appears for client wsi told to skip check on connection)
 812  */
 813 LWS_VISIBLE int
 814 lws_is_ssl(struct libwebsocket *wsi)
 815 {
 816 #ifdef LWS_OPENSSL_SUPPORT
 817         return wsi->use_ssl;
 818 #else
 819         return 0;
 820 #endif
 821 }
 822
 823 /**
 824  * lws_partial_buffered() - find out if lws buffered the last write
 825  * @wsi:        websocket connection to check
 826  *
 827  * Returns 1 if you cannot use libwebsocket_write because the last
 828  * write on this connection is still buffered, and can't be cleared without
 829  * returning to the service loop and waiting for the connection to be
 830  * writeable again.
 831  *
 832  * If you will try to do >1 libwebsocket_write call inside a single
 833  * WRITEABLE callback, you must check this after every write and bail if
 834  * set, ask for a new writeable callback and continue writing from there.
 835  *
 836  * This is never set at the start of a writeable callback, but any write
 837  * may set it.
 838  */
 839
 840 LWS_VISIBLE int
 841 lws_partial_buffered(struct libwebsocket *wsi)
 842 {
 843         return !!wsi->truncated_send_len;
 844 }
 845
 846 void lws_set_protocol_write_pending(struct libwebsocket_context *context,
 847                                     struct libwebsocket *wsi,
 848                                     enum lws_pending_protocol_send pend)
 849 {
 850         lwsl_info("setting pps %d\n", pend);
 851
 852         if (wsi->pps)
 853                 lwsl_err("pps overwrite\n");
 854         wsi->pps = pend;
 855         libwebsocket_rx_flow_control(wsi, 0);
 856         libwebsocket_callback_on_writable(context, wsi);
 857 }
 858
 859 LWS_VISIBLE size_t
 860 lws_get_peer_write_allowance(struct libwebsocket *wsi)
 861 {
 862 #ifdef LWS_USE_HTTP2
 863         /* only if we are using HTTP2 on this connection */
 864         if (wsi->mode != LWS_CONNMODE_HTTP2_SERVING)
 865                 return -1;
 866         /* user is only interested in how much he can send, or that he can't  */
 867         if (wsi->u.http2.tx_credit <= 0)
 868                 return 0;
 869
 870         return wsi->u.http2.tx_credit;
 871 #else
 872         return -1;
 873 #endif
 874 }
 875
 876 LWS_VISIBLE void
 877 lws_union_transition(struct libwebsocket *wsi, enum connection_mode mode)
 878 {
 879         memset(&wsi->u, 0, sizeof(wsi->u));
 880         wsi->mode = mode;
 881 }