lib/service.c

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010-2015 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 static int
  25 lws_calllback_as_writeable(struct lws *wsi)
  26 {
  27         int n;
  28
  29         switch (wsi->mode) {
  30         case LWSCM_WS_CLIENT:
  31                 n = LWS_CALLBACK_CLIENT_WRITEABLE;
  32                 break;
  33         case LWSCM_WS_SERVING:
  34                 n = LWS_CALLBACK_SERVER_WRITEABLE;
  35                 break;
  36         default:
  37                 n = LWS_CALLBACK_HTTP_WRITEABLE;
  38                 break;
  39         }
  40         lwsl_debug("%s: %p (user=%p)\n", __func__, wsi, wsi->user_space);
  41         return user_callback_handle_rxflow(wsi->protocol->callback,
  42                                            wsi, (enum lws_callback_reasons) n,
  43                                            wsi->user_space, NULL, 0);
  44 }
  45
  46 int
  47 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd)
  48 {
  49         int write_type = LWS_WRITE_PONG;
  50         struct lws_tokens eff_buf;
  51 #ifdef LWS_USE_HTTP2
  52         struct lws *wsi2;
  53 #endif
  54         int ret, m, n;
  55
  56         /*
  57          * user callback is lowest priority to get these notifications
  58          * actually, since other pending things cannot be disordered
  59          */
  60
  61         /* Priority 1: pending truncated sends are incomplete ws fragments
  62          *             If anything else sent first the protocol would be
  63          *             corrupted.
  64          */
  65         if (wsi->trunc_len) {
  66                 if (lws_issue_raw(wsi, wsi->trunc_alloc + wsi->trunc_offset,
  67                                   wsi->trunc_len) < 0) {
  68                         lwsl_info("%s signalling to close\n", __func__);
  69                         return -1;
  70                 }
  71                 /* leave POLLOUT active either way */
  72                 return 0;
  73         } else
  74                 if (wsi->state == LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE)
  75                         return -1; /* retry closing now */
  76
  77
  78 #ifdef LWS_USE_HTTP2
  79         /* Priority 2: protocol packets
  80          */
  81         if (wsi->pps) {
  82                 lwsl_info("servicing pps %d\n", wsi->pps);
  83                 switch (wsi->pps) {
  84                 case LWS_PPS_HTTP2_MY_SETTINGS:
  85                 case LWS_PPS_HTTP2_ACK_SETTINGS:
  86                         lws_http2_do_pps_send(lws_get_context(wsi), wsi);
  87                         break;
  88                 default:
  89                         break;
  90                 }
  91                 wsi->pps = LWS_PPS_NONE;
  92                 lws_rx_flow_control(wsi, 1);
  93
  94                 return 0; /* leave POLLOUT active */
  95         }
  96 #endif
  97         /* Priority 3: pending control packets (pong or close)
  98          */
  99         if ((wsi->state == LWSS_ESTABLISHED &&
 100              wsi->u.ws.ping_pending_flag) ||
 101             (wsi->state == LWSS_RETURNED_CLOSE_ALREADY &&
 102              wsi->u.ws.payload_is_close)) {
 103
 104                 if (wsi->u.ws.payload_is_close)
 105                         write_type = LWS_WRITE_CLOSE;
 106
 107                 n = lws_write(wsi, &wsi->u.ws.ping_payload_buf[LWS_PRE],
 108                               wsi->u.ws.ping_payload_len, write_type);
 109                 if (n < 0)
 110                         return -1;
 111
 112                 /* well he is sent, mark him done */
 113                 wsi->u.ws.ping_pending_flag = 0;
 114                 if (wsi->u.ws.payload_is_close)
 115                         /* oh... a close frame was it... then we are done */
 116                         return -1;
 117
 118                 /* otherwise for PING, leave POLLOUT active either way */
 119                 return 0;
 120         }
 121
 122         /* Priority 4: if we are closing, not allowed to send more data frags
 123          *             which means user callback or tx ext flush banned now
 124          */
 125         if (wsi->state == LWSS_RETURNED_CLOSE_ALREADY)
 126                 goto user_service;
 127
 128         /* Priority 5: Tx path extension with more to send
 129          *
 130          *             These are handled as new fragments each time around
 131          *             So while we must block new writeable callback to enforce
 132          *             payload ordering, but since they are always complete
 133          *             fragments control packets can interleave OK.
 134          */
 135         if (wsi->state == LWSS_ESTABLISHED && wsi->u.ws.tx_draining_ext) {
 136                 lwsl_ext("SERVICING TX EXT DRAINING\n");
 137                 if (lws_write(wsi, NULL, 0, LWS_WRITE_CONTINUATION) < 0)
 138                         return -1;
 139                 /* leave POLLOUT active */
 140                 return 0;
 141         }
 142
 143         /* Priority 6: user can get the callback
 144          */
 145         m = lws_ext_cb_active(wsi, LWS_EXT_CB_IS_WRITEABLE, NULL, 0);
 146 #ifndef LWS_NO_EXTENSIONS
 147         if (!wsi->extension_data_pending)
 148                 goto user_service;
 149 #endif
 150         /*
 151          * check in on the active extensions, see if they
 152          * had pending stuff to spill... they need to get the
 153          * first look-in otherwise sequence will be disordered
 154          *
 155          * NULL, zero-length eff_buf means just spill pending
 156          */
 157
 158         ret = 1;
 159         while (ret == 1) {
 160
 161                 /* default to nobody has more to spill */
 162
 163                 ret = 0;
 164                 eff_buf.token = NULL;
 165                 eff_buf.token_len = 0;
 166
 167                 /* give every extension a chance to spill */
 168
 169                 m = lws_ext_cb_active(wsi,
 170                                         LWS_EXT_CB_PACKET_TX_PRESEND,
 171                                                &eff_buf, 0);
 172                 if (m < 0) {
 173                         lwsl_err("ext reports fatal error\n");
 174                         return -1;
 175                 }
 176                 if (m)
 177                         /*
 178                          * at least one extension told us he has more
 179                          * to spill, so we will go around again after
 180                          */
 181                         ret = 1;
 182
 183                 /* assuming they gave us something to send, send it */
 184
 185                 if (eff_buf.token_len) {
 186                         n = lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
 187                                           eff_buf.token_len);
 188                         if (n < 0) {
 189                                 lwsl_info("closing from POLLOUT spill\n");
 190                                 return -1;
 191                         }
 192                         /*
 193                          * Keep amount spilled small to minimize chance of this
 194                          */
 195                         if (n != eff_buf.token_len) {
 196                                 lwsl_err("Unable to spill ext %d vs %s\n",
 197                                                           eff_buf.token_len, n);
 198                                 return -1;
 199                         }
 200                 } else
 201                         continue;
 202
 203                 /* no extension has more to spill */
 204
 205                 if (!ret)
 206                         continue;
 207
 208                 /*
 209                  * There's more to spill from an extension, but we just sent
 210                  * something... did that leave the pipe choked?
 211                  */
 212
 213                 if (!lws_send_pipe_choked(wsi))
 214                         /* no we could add more */
 215                         continue;
 216
 217                 lwsl_info("choked in POLLOUT service\n");
 218
 219                 /*
 220                  * Yes, he's choked.  Leave the POLLOUT masked on so we will
 221                  * come back here when he is unchoked.  Don't call the user
 222                  * callback to enforce ordering of spilling, he'll get called
 223                  * when we come back here and there's nothing more to spill.
 224                  */
 225
 226                 return 0;
 227         }
 228 #ifndef LWS_NO_EXTENSIONS
 229         wsi->extension_data_pending = 0;
 230 #endif
 231 user_service:
 232         /* one shot */
 233
 234         if (pollfd)
 235                 if (lws_change_pollfd(wsi, LWS_POLLOUT, 0)) {
 236                         lwsl_info("failed at set pollfd\n");
 237                         return 1;
 238                 }
 239
 240 #ifdef LWS_USE_HTTP2
 241         /*
 242          * we are the 'network wsi' for potentially many muxed child wsi with
 243          * no network connection of their own, who have to use us for all their
 244          * network actions.  So we use a round-robin scheme to share out the
 245          * POLLOUT notifications to our children.
 246          *
 247          * But because any child could exhaust the socket's ability to take
 248          * writes, we can only let one child get notified each time.
 249          *
 250          * In addition children may be closed / deleted / added between POLLOUT
 251          * notifications, so we can't hold pointers
 252          */
 253
 254         if (wsi->mode != LWSCM_HTTP2_SERVING) {
 255                 lwsl_info("%s: non http2\n", __func__);
 256                 goto notify;
 257         }
 258
 259         wsi->u.http2.requested_POLLOUT = 0;
 260         if (!wsi->u.http2.initialized) {
 261                 lwsl_info("pollout on uninitialized http2 conn\n");
 262                 return 0;
 263         }
 264
 265         lwsl_info("%s: doing children\n", __func__);
 266
 267         wsi2 = wsi;
 268         do {
 269                 wsi2 = wsi2->u.http2.next_child_wsi;
 270                 lwsl_info("%s: child %p\n", __func__, wsi2);
 271                 if (!wsi2)
 272                         continue;
 273                 if (!wsi2->u.http2.requested_POLLOUT)
 274                         continue;
 275                 wsi2->u.http2.requested_POLLOUT = 0;
 276                 if (lws_calllback_as_writeable(wsi2)) {
 277                         lwsl_debug("Closing POLLOUT child\n");
 278                         lws_close_free_wsi(wsi2, LWS_CLOSE_STATUS_NOSTATUS);
 279                 }
 280                 wsi2 = wsi;
 281         } while (wsi2 != NULL && !lws_send_pipe_choked(wsi));
 282
 283         lwsl_info("%s: completed\n", __func__);
 284
 285         return 0;
 286 notify:
 287 #endif
 288         return lws_calllback_as_writeable(wsi);
 289 }
 290
 291 int
 292 lws_service_timeout_check(struct lws *wsi, unsigned int sec)
 293 {
 294         struct lws_context_per_thread *pt = &wsi->context->pt[(int)wsi->tsi];
 295
 296         /*
 297          * if extensions want in on it (eg, we are a mux parent)
 298          * give them a chance to service child timeouts
 299          */
 300         if (lws_ext_cb_active(wsi, LWS_EXT_CB_1HZ, NULL, sec) < 0)
 301                 return 0;
 302
 303         if (!wsi->pending_timeout)
 304                 return 0;
 305
 306         /*
 307          * if we went beyond the allowed time, kill the
 308          * connection
 309          */
 310         if ((time_t)sec > wsi->pending_timeout_limit) {
 311 #if LWS_POSIX
 312                 lwsl_notice("wsi %p: TIMEDOUT WAITING on %d (did hdr %d, ah %p, wl %d, pfd events %d)\n",
 313                             (void *)wsi, wsi->pending_timeout,
 314                             wsi->hdr_parsing_completed, wsi->u.hdr.ah,
 315                             pt->ah_wait_list_length,
 316                             pt->fds[wsi->sock].events);
 317 #endif
 318                 /*
 319                  * Since he failed a timeout, he already had a chance to do
 320                  * something and was unable to... that includes situations like
 321                  * half closed connections.  So process this "failed timeout"
 322                  * close as a violent death and don't try to do protocol
 323                  * cleanup like flush partials.
 324                  */
 325                 wsi->socket_is_permanently_unusable = 1;
 326                 lws_close_free_wsi(wsi, LWS_CLOSE_STATUS_NOSTATUS);
 327
 328                 return 1;
 329         }
 330
 331         return 0;
 332 }
 333
 334 int lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len)
 335 {
 336         /* his RX is flowcontrolled, don't send remaining now */
 337         if (wsi->rxflow_buffer) {
 338                 /* rxflow while we were spilling prev rxflow */
 339                 lwsl_info("stalling in existing rxflow buf\n");
 340                 return 1;
 341         }
 342
 343         /* a new rxflow, buffer it and warn caller */
 344         lwsl_info("new rxflow input buffer len %d\n", len - n);
 345         wsi->rxflow_buffer = lws_malloc(len - n);
 346         wsi->rxflow_len = len - n;
 347         wsi->rxflow_pos = 0;
 348         memcpy(wsi->rxflow_buffer, buf + n, len - n);
 349
 350         return 0;
 351 }
 352
 353 /* this is used by the platform service code to stop us waiting for network
 354  * activity in poll() when we have something that already needs service
 355  */
 356
 357 int
 358 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi)
 359 {
 360         struct lws_context_per_thread *pt = &context->pt[tsi];
 361         int n;
 362
 363         /* Figure out if we really want to wait in poll()
 364          * We only need to wait if really nothing already to do and we have
 365          * to wait for something from network
 366          */
 367
 368         /* 1) if we know we are draining rx ext, do not wait in poll */
 369         if (pt->rx_draining_ext_list)
 370                 timeout_ms = 0;
 371
 372 #ifdef LWS_OPENSSL_SUPPORT
 373         /* 2) if we know we have non-network pending data, do not wait in poll */
 374         if (lws_ssl_anybody_has_buffered_read_tsi(context, tsi)) {
 375                 timeout_ms = 0;
 376                 lwsl_err("ssl buffered read\n");
 377         }
 378 #endif
 379
 380         /* 3) if any ah has pending rx, do not wait in poll */
 381         for (n = 0; n < context->max_http_header_pool; n++)
 382                 if (pt->ah_pool[n].rxpos != pt->ah_pool[n].rxlen) {
 383                         /* any ah with pending rx must be attached to someone */
 384                         assert(pt->ah_pool[n].wsi);
 385                         timeout_ms = 0;
 386                         break;
 387                 }
 388
 389         return timeout_ms;
 390 }
 391
 392 /*
 393  * guys that need POLLIN service again without waiting for network action
 394  * can force POLLIN here if not flowcontrolled, so they will get service.
 395  *
 396  * Return nonzero if anybody got their POLLIN faked
 397  */
 398 int
 399 lws_service_flag_pending(struct lws_context *context, int tsi)
 400 {
 401         struct lws_context_per_thread *pt = &context->pt[tsi];
 402 #ifdef LWS_OPENSSL_SUPPORT
 403         struct lws *wsi_next;
 404 #endif
 405         struct lws *wsi;
 406         int forced = 0;
 407         int n;
 408
 409         /* POLLIN faking */
 410
 411         /*
 412          * 1) For all guys with already-available ext data to drain, if they are
 413          * not flowcontrolled, fake their POLLIN status
 414          */
 415         wsi = pt->rx_draining_ext_list;
 416         while (wsi) {
 417                 pt->fds[wsi->position_in_fds_table].revents |=
 418                         pt->fds[wsi->position_in_fds_table].events & LWS_POLLIN;
 419                 if (pt->fds[wsi->position_in_fds_table].revents &
 420                     LWS_POLLIN)
 421                         forced = 1;
 422                 wsi = wsi->u.ws.rx_draining_ext_list;
 423         }
 424
 425 #ifdef LWS_OPENSSL_SUPPORT
 426         /*
 427          * 2) For all guys with buffered SSL read data already saved up, if they
 428          * are not flowcontrolled, fake their POLLIN status so they'll get
 429          * service to use up the buffered incoming data, even though their
 430          * network socket may have nothing
 431          */
 432         wsi = pt->pending_read_list;
 433         while (wsi) {
 434                 wsi_next = wsi->pending_read_list_next;
 435                 pt->fds[wsi->position_in_fds_table].revents |=
 436                         pt->fds[wsi->position_in_fds_table].events & LWS_POLLIN;
 437                 if (pt->fds[wsi->position_in_fds_table].revents & LWS_POLLIN) {
 438                         forced = 1;
 439                         /*
 440                          * he's going to get serviced now, take him off the
 441                          * list of guys with buffered SSL.  If he still has some
 442                          * at the end of the service, he'll get put back on the
 443                          * list then.
 444                          */
 445                         lws_ssl_remove_wsi_from_buffered_list(wsi);
 446                 }
 447
 448                 wsi = wsi_next;
 449         }
 450 #endif
 451         /*
 452          * 3) For any wsi who have an ah with pending RX who did not
 453          * complete their current headers, and are not flowcontrolled,
 454          * fake their POLLIN status so they will be able to drain the
 455          * rx buffered in the ah
 456          */
 457         for (n = 0; n < context->max_http_header_pool; n++)
 458                 if (pt->ah_pool[n].rxpos != pt->ah_pool[n].rxlen &&
 459                     !pt->ah_pool[n].wsi->hdr_parsing_completed) {
 460                         pt->fds[pt->ah_pool[n].wsi->position_in_fds_table].revents |=
 461                                 pt->fds[pt->ah_pool[n].wsi->position_in_fds_table].events &
 462                                         LWS_POLLIN;
 463                         if (pt->fds[pt->ah_pool[n].wsi->position_in_fds_table].revents &
 464                             LWS_POLLIN)
 465                                 forced = 1;
 466                 }
 467
 468         return forced;
 469 }
 470
 471 /**
 472  * lws_service_fd() - Service polled socket with something waiting
 473  * @context:    Websocket context
 474  * @pollfd:     The pollfd entry describing the socket fd and which events
 475  *              happened.
 476  *
 477  *      This function takes a pollfd that has POLLIN or POLLOUT activity and
 478  *      services it according to the state of the associated
 479  *      struct lws.
 480  *
 481  *      The one call deals with all "service" that might happen on a socket
 482  *      including listen accepts, http files as well as websocket protocol.
 483  *
 484  *      If a pollfd says it has something, you can just pass it to
 485  *      lws_service_fd() whether it is a socket handled by lws or not.
 486  *      If it sees it is a lws socket, the traffic will be handled and
 487  *      pollfd->revents will be zeroed now.
 488  *
 489  *      If the socket is foreign to lws, it leaves revents alone.  So you can
 490  *      see if you should service yourself by checking the pollfd revents
 491  *      after letting lws try to service it.
 492  */
 493
 494 LWS_VISIBLE int
 495 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd, int tsi)
 496 {
 497         struct lws_context_per_thread *pt = &context->pt[tsi];
 498         lws_sockfd_type our_fd = 0, tmp_fd;
 499         struct lws_tokens eff_buf;
 500         unsigned int pending = 0;
 501         struct lws *wsi, *wsi1;
 502         char draining_flow = 0;
 503         int timed_out = 0;
 504         time_t now;
 505         int n, m;
 506         int more;
 507
 508         /*
 509          * you can call us with pollfd = NULL to just allow the once-per-second
 510          * global timeout checks; if less than a second since the last check
 511          * it returns immediately then.
 512          */
 513
 514         time(&now);
 515
 516         /* TODO: if using libev, we should probably use timeout watchers... */
 517         if (context->last_timeout_check_s != now) {
 518                 context->last_timeout_check_s = now;
 519
 520                 lws_plat_service_periodic(context);
 521
 522                 /* global timeout check once per second */
 523
 524                 if (pollfd)
 525                         our_fd = pollfd->fd;
 526
 527                 wsi = context->pt[tsi].timeout_list;
 528                 while (wsi) {
 529                         /* we have to take copies, because he may be deleted */
 530                         wsi1 = wsi->timeout_list;
 531                         tmp_fd = wsi->sock;
 532                         if (lws_service_timeout_check(wsi, (unsigned int)now)) {
 533                                 /* he did time out... */
 534                                 if (tmp_fd == our_fd)
 535                                         /* it was the guy we came to service! */
 536                                         timed_out = 1;
 537                                         /* he's gone, no need to mark as handled */
 538                         }
 539                         wsi = wsi1;
 540                 }
 541 #if 0
 542                 {
 543                         char s[300], *p = s;
 544
 545                         for (n = 0; n < context->count_threads; n++)
 546                                 p += sprintf(p, " %7lu (%5d), ",
 547                                              context->pt[n].count_conns,
 548                                              context->pt[n].fds_count);
 549
 550                         lwsl_notice("load: %s\n", s);
 551                 }
 552 #endif
 553         }
 554
 555         /* the socket we came to service timed out, nothing to do */
 556         if (timed_out)
 557                 return 0;
 558
 559         /* just here for timeout management? */
 560         if (!pollfd)
 561                 return 0;
 562
 563         /* no, here to service a socket descriptor */
 564         wsi = wsi_from_fd(context, pollfd->fd);
 565         if (!wsi)
 566                 /* not lws connection ... leave revents alone and return */
 567                 return 0;
 568
 569         /*
 570          * so that caller can tell we handled, past here we need to
 571          * zero down pollfd->revents after handling
 572          */
 573
 574 #if LWS_POSIX
 575
 576         /* handle session socket closed */
 577
 578         if ((!(pollfd->revents & pollfd->events & LWS_POLLIN)) &&
 579             (pollfd->revents & LWS_POLLHUP)) {
 580                 wsi->socket_is_permanently_unusable = 1;
 581                 lwsl_debug("Session Socket %p (fd=%d) dead\n",
 582                                                        (void *)wsi, pollfd->fd);
 583
 584                 goto close_and_handled;
 585         }
 586
 587 #ifdef _WIN32
 588         if (pollfd->revents & LWS_POLLOUT)
 589                 wsi->sock_send_blocking = FALSE;
 590 #endif
 591
 592 #endif
 593
 594         /* okay, what we came here to do... */
 595
 596         switch (wsi->mode) {
 597         case LWSCM_HTTP_SERVING:
 598         case LWSCM_HTTP_SERVING_ACCEPTED:
 599         case LWSCM_SERVER_LISTENER:
 600         case LWSCM_SSL_ACK_PENDING:
 601                 n = lws_server_socket_service(context, wsi, pollfd);
 602                 if (n) /* closed by above */
 603                         return 1;
 604                 pending = lws_ssl_pending(wsi);
 605                 if (pending)
 606                         goto handle_pending;
 607                 goto handled;
 608
 609         case LWSCM_WS_SERVING:
 610         case LWSCM_WS_CLIENT:
 611         case LWSCM_HTTP2_SERVING:
 612
 613                 /* 1: something requested a callback when it was OK to write */
 614
 615                 if ((pollfd->revents & LWS_POLLOUT) &&
 616                     (wsi->state == LWSS_ESTABLISHED ||
 617                      wsi->state == LWSS_HTTP2_ESTABLISHED ||
 618                      wsi->state == LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS ||
 619                      wsi->state == LWSS_RETURNED_CLOSE_ALREADY ||
 620                      wsi->state == LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE) &&
 621                     lws_handle_POLLOUT_event(wsi, pollfd)) {
 622                         if (wsi->state == LWSS_RETURNED_CLOSE_ALREADY)
 623                                 wsi->state = LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE;
 624                         lwsl_info("lws_service_fd: closing\n");
 625                         goto close_and_handled;
 626                 }
 627
 628                 if (wsi->state == LWSS_RETURNED_CLOSE_ALREADY ||
 629                     wsi->state == LWSS_AWAITING_CLOSE_ACK) {
 630                         /*
 631                          * we stopped caring about anything except control
 632                          * packets.  Force flow control off, defeat tx
 633                          * draining.
 634                          */
 635                         lws_rx_flow_control(wsi, 1);
 636                         wsi->u.ws.tx_draining_ext = 0;
 637                 }
 638
 639                 if (wsi->u.ws.tx_draining_ext) {
 640                         /* we cannot deal with new RX until the TX ext
 641                          * path has been drained.  It's because new
 642                          * rx will, eg, crap on the wsi rx buf that
 643                          * may be needed to retain state.
 644                          *
 645                          * TX ext drain path MUST go through event loop
 646                          * to avoid blocking.
 647                          */
 648                         break;
 649                 }
 650
 651                 if (!(wsi->rxflow_change_to & LWS_RXFLOW_ALLOW))
 652                         /* We cannot deal with any kind of new RX
 653                          * because we are RX-flowcontrolled.
 654                          */
 655                         break;
 656
 657                 /* 2: RX Extension needs to be drained
 658                  */
 659
 660                 if (wsi->state == LWSS_ESTABLISHED &&
 661                     wsi->u.ws.rx_draining_ext) {
 662
 663                         lwsl_ext("%s: RX EXT DRAINING: Service\n", __func__);
 664 #ifndef LWS_NO_CLIENT
 665                         if (wsi->mode == LWSCM_WS_CLIENT) {
 666                                 n = lws_client_rx_sm(wsi, 0);
 667                                 if (n < 0)
 668                                         /* we closed wsi */
 669                                         n = 0;
 670                         } else
 671 #endif
 672                                 n = lws_rx_sm(wsi, 0);
 673
 674                         goto handled;
 675                 }
 676
 677                 if (wsi->u.ws.rx_draining_ext)
 678                         /*
 679                          * We have RX EXT content to drain, but can't do it
 680                          * right now.  That means we cannot do anything lower
 681                          * priority either.
 682                          */
 683                         break;
 684
 685                 /* 3: RX Flowcontrol buffer needs to be drained
 686                  */
 687
 688                 if (wsi->rxflow_buffer) {
 689                         lwsl_info("draining rxflow (len %d)\n",
 690                                 wsi->rxflow_len - wsi->rxflow_pos
 691                         );
 692                         /* well, drain it */
 693                         eff_buf.token = (char *)wsi->rxflow_buffer +
 694                                                 wsi->rxflow_pos;
 695                         eff_buf.token_len = wsi->rxflow_len - wsi->rxflow_pos;
 696                         draining_flow = 1;
 697                         goto drain;
 698                 }
 699
 700                 /* 4: any incoming (or ah-stashed incoming rx) data ready?
 701                  * notice if rx flow going off raced poll(), rx flow wins
 702                  */
 703
 704                 if (!(pollfd->revents & pollfd->events & LWS_POLLIN))
 705                         break;
 706 read:
 707
 708                 /* all the union members start with hdr, so even in ws mode
 709                  * we can deal with the ah via u.hdr
 710                  */
 711                 if (wsi->u.hdr.ah) {
 712                         lwsl_err("%s: %p: using inherited ah rx\n", __func__, wsi);
 713                         eff_buf.token_len = wsi->u.hdr.ah->rxlen -
 714                                             wsi->u.hdr.ah->rxpos;
 715                         eff_buf.token = (char *)wsi->u.hdr.ah->rx +
 716                                         wsi->u.hdr.ah->rxpos;
 717                 } else {
 718
 719                         eff_buf.token_len = lws_ssl_capable_read(wsi, pt->serv_buf,
 720                                              pending ? pending : LWS_MAX_SOCKET_IO_BUF);
 721                         switch (eff_buf.token_len) {
 722                         case 0:
 723                                 lwsl_info("service_fd: closing due to 0 length read\n");
 724                                 goto close_and_handled;
 725                         case LWS_SSL_CAPABLE_MORE_SERVICE:
 726                                 lwsl_info("SSL Capable more service\n");
 727                                 n = 0;
 728                                 goto handled;
 729                         case LWS_SSL_CAPABLE_ERROR:
 730                                 lwsl_info("Closing when error\n");
 731                                 goto close_and_handled;
 732                         }
 733
 734                         eff_buf.token = (char *)pt->serv_buf;
 735                 }
 736                 /*
 737                  * give any active extensions a chance to munge the buffer
 738                  * before parse.  We pass in a pointer to an lws_tokens struct
 739                  * prepared with the default buffer and content length that's in
 740                  * there.  Rather than rewrite the default buffer, extensions
 741                  * that expect to grow the buffer can adapt .token to
 742                  * point to their own per-connection buffer in the extension
 743                  * user allocation.  By default with no extensions or no
 744                  * extension callback handling, just the normal input buffer is
 745                  * used then so it is efficient.
 746                  */
 747 drain:
 748                 do {
 749                         more = 0;
 750
 751                         m = lws_ext_cb_active(wsi, LWS_EXT_CB_PACKET_RX_PREPARSE,
 752                                               &eff_buf, 0);
 753                         if (m < 0)
 754                                 goto close_and_handled;
 755                         if (m)
 756                                 more = 1;
 757
 758                         /* service incoming data */
 759
 760                         if (eff_buf.token_len) {
 761                                 /*
 762                                  * if draining from rxflow buffer, not
 763                                  * critical to track what was used since at the
 764                                  * use it bumps wsi->rxflow_pos.  If we come
 765                                  * around again it will pick up from where it
 766                                  * left off.
 767                                  */
 768                                 n = lws_read(wsi, (unsigned char *)eff_buf.token,
 769                                              eff_buf.token_len);
 770                                 if (n < 0) {
 771                                         /* we closed wsi */
 772                                         n = 0;
 773                                         goto handled;
 774                                 }
 775                         }
 776
 777                         eff_buf.token = NULL;
 778                         eff_buf.token_len = 0;
 779                 } while (more);
 780
 781                 if (wsi->u.hdr.ah) {
 782                         lwsl_err("%s: %p: detaching inherited used ah\n", __func__, wsi);
 783                         /* show we used all the pending rx up */
 784                         wsi->u.hdr.ah->rxpos = wsi->u.hdr.ah->rxlen;
 785                         /* we can run the normal ah detach flow despite
 786                          * being in ws union mode, since all union members
 787                          * start with hdr */
 788                         lws_header_table_detach(wsi);
 789                 }
 790
 791                 pending = lws_ssl_pending(wsi);
 792                 if (pending) {
 793 handle_pending:
 794                         pending = pending > LWS_MAX_SOCKET_IO_BUF ?
 795                                         LWS_MAX_SOCKET_IO_BUF : pending;
 796                         goto read;
 797                 }
 798
 799                 if (draining_flow && wsi->rxflow_buffer &&
 800                     wsi->rxflow_pos == wsi->rxflow_len) {
 801                         lwsl_info("flow buffer: drained\n");
 802                         lws_free_set_NULL(wsi->rxflow_buffer);
 803                         /* having drained the rxflow buffer, can rearm POLLIN */
 804 #ifdef LWS_NO_SERVER
 805                         n =
 806 #endif
 807                         _lws_rx_flow_control(wsi);
 808                         /* n ignored, needed for NO_SERVER case */
 809                 }
 810
 811                 break;
 812
 813         default:
 814 #ifdef LWS_NO_CLIENT
 815                 break;
 816 #else
 817                 n = lws_client_socket_service(context, wsi, pollfd);
 818                 if (n)
 819                         return 1;
 820                 goto handled;
 821 #endif
 822         }
 823
 824         n = 0;
 825         goto handled;
 826
 827 close_and_handled:
 828         lwsl_debug("Close and handled\n");
 829         lws_close_free_wsi(wsi, LWS_CLOSE_STATUS_NOSTATUS);
 830         /*
 831          * pollfd may point to something else after the close
 832          * due to pollfd swapping scheme on delete on some platforms
 833          * we can't clear revents now because it'd be the wrong guy's revents
 834          */
 835         return 1;
 836
 837 handled:
 838         pollfd->revents = 0;
 839         return n;
 840 }
 841
 842 LWS_VISIBLE int
 843 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd)
 844 {
 845         return lws_service_fd_tsi(context, pollfd, 0);
 846 }
 847
 848 /**
 849  * lws_service() - Service any pending websocket activity
 850  * @context:    Websocket context
 851  * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
 852  *              service otherwise block and service immediately, returning
 853  *              after the timeout if nothing needed service.
 854  *
 855  *      This function deals with any pending websocket traffic, for three
 856  *      kinds of event.  It handles these events on both server and client
 857  *      types of connection the same.
 858  *
 859  *      1) Accept new connections to our context's server
 860  *
 861  *      2) Call the receive callback for incoming frame data received by
 862  *          server or client connections.
 863  *
 864  *      You need to call this service function periodically to all the above
 865  *      functions to happen; if your application is single-threaded you can
 866  *      just call it in your main event loop.
 867  *
 868  *      Alternatively you can fork a new process that asynchronously handles
 869  *      calling this service in a loop.  In that case you are happy if this
 870  *      call blocks your thread until it needs to take care of something and
 871  *      would call it with a large nonzero timeout.  Your loop then takes no
 872  *      CPU while there is nothing happening.
 873  *
 874  *      If you are calling it in a single-threaded app, you don't want it to
 875  *      wait around blocking other things in your loop from happening, so you
 876  *      would call it with a timeout_ms of 0, so it returns immediately if
 877  *      nothing is pending, or as soon as it services whatever was pending.
 878  */
 879
 880 LWS_VISIBLE int
 881 lws_service(struct lws_context *context, int timeout_ms)
 882 {
 883         return lws_plat_service(context, timeout_ms);
 884 }
 885
 886 LWS_VISIBLE int
 887 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi)
 888 {
 889         return lws_plat_service_tsi(context, timeout_ms, tsi);
 890 }
 891