lib/pollfd.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
  25 insert_wsi_socket_into_fds(struct lws_context *context,
  26                                                        struct lws *wsi)
  27 {
  28         struct lws_pollargs pa = { wsi->sock, LWS_POLLIN, 0 };
  29
  30         if (context->fds_count >= context->max_fds) {
  31                 lwsl_err("Too many fds (%d)\n", context->max_fds);
  32                 return 1;
  33         }
  34
  35 #if !defined(_WIN32) && !defined(MBED_OPERATORS)
  36         if (wsi->sock >= context->max_fds) {
  37                 lwsl_err("Socket fd %d is too high (%d)\n",
  38                                                 wsi->sock, context->max_fds);
  39                 return 1;
  40         }
  41 #endif
  42
  43         assert(wsi);
  44         assert(lws_socket_is_valid(wsi->sock));
  45
  46 //      lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n",
  47 //                                          wsi, wsi->sock, context->fds_count);
  48
  49         if (context->protocols[0].callback(context, wsi,
  50             LWS_CALLBACK_LOCK_POLL, wsi->user_space, (void *) &pa, 1))
  51                 return -1;
  52
  53         insert_wsi(context, wsi);
  54         wsi->position_in_fds_table = context->fds_count;
  55         context->fds[context->fds_count].fd = wsi->sock;
  56         context->fds[context->fds_count].events = LWS_POLLIN;
  57
  58         lws_plat_insert_socket_into_fds(context, wsi);
  59
  60         /* external POLL support via protocol 0 */
  61         if (context->protocols[0].callback(context, wsi,
  62             LWS_CALLBACK_ADD_POLL_FD, wsi->user_space, (void *) &pa, 0))
  63                 return -1;
  64
  65         if (context->protocols[0].callback(context, wsi,
  66             LWS_CALLBACK_UNLOCK_POLL, wsi->user_space, (void *)&pa, 1))
  67                 return -1;
  68
  69         return 0;
  70 }
  71
  72 int
  73 remove_wsi_socket_from_fds(struct lws *wsi)
  74 {
  75         int m;
  76         struct lws_pollargs pa = { wsi->sock, 0, 0 };
  77         struct lws_context *context = wsi->context;
  78
  79         lws_libev_io(wsi, LWS_EV_STOP | LWS_EV_READ | LWS_EV_WRITE);
  80
  81         --context->fds_count;
  82
  83 #if !defined(_WIN32) && !defined(MBED_OPERATORS)
  84         if (wsi->sock > context->max_fds) {
  85                 lwsl_err("Socket fd %d too high (%d)\n",
  86                                                    wsi->sock, context->max_fds);
  87                 return 1;
  88         }
  89 #endif
  90
  91         lwsl_info("%s: wsi=%p, sock=%d, fds pos=%d\n", __func__,
  92                                     wsi, wsi->sock, wsi->position_in_fds_table);
  93
  94         if (context->protocols[0].callback(context, wsi,
  95             LWS_CALLBACK_LOCK_POLL, wsi->user_space, (void *)&pa, 1))
  96                 return -1;
  97
  98         m = wsi->position_in_fds_table; /* replace the contents for this */
  99
 100         /* have the last guy take up the vacant slot */
 101         context->fds[m] = context->fds[context->fds_count];
 102
 103         lws_plat_delete_socket_from_fds(context, wsi, m);
 104
 105         /*
 106          * end guy's fds_lookup entry remains unchanged
 107          * (still same fd pointing to same wsi)
 108          */
 109         /* end guy's "position in fds table" changed */
 110         wsi_from_fd(context,context->fds[context->fds_count].fd)->
 111                                         position_in_fds_table = m;
 112         /* deletion guy's lws_lookup entry needs nuking */
 113         delete_from_fd(context,wsi->sock);
 114         /* removed wsi has no position any more */
 115         wsi->position_in_fds_table = -1;
 116
 117         /* remove also from external POLL support via protocol 0 */
 118         if (lws_socket_is_valid(wsi->sock)) {
 119                 if (context->protocols[0].callback(context, wsi,
 120                     LWS_CALLBACK_DEL_POLL_FD, wsi->user_space,
 121                     (void *) &pa, 0))
 122                         return -1;
 123         }
 124         if (context->protocols[0].callback(context, wsi,
 125                                        LWS_CALLBACK_UNLOCK_POLL,
 126                                        wsi->user_space, (void *) &pa, 1))
 127                 return -1;
 128
 129         return 0;
 130 }
 131
 132 int
 133 lws_change_pollfd(struct lws *wsi, int _and, int _or)
 134 {
 135         struct lws_context *context;
 136         int tid;
 137         int sampled_tid;
 138         struct lws_pollfd *pfd;
 139         struct lws_pollargs pa;
 140         int pa_events = 1;
 141
 142         if (!wsi || !wsi->protocol || wsi->position_in_fds_table < 0)
 143                 return 1;
 144
 145         context = lws_get_ctx(wsi);
 146         if (!context)
 147                 return 1;
 148
 149         pfd = &context->fds[wsi->position_in_fds_table];
 150         pa.fd = wsi->sock;
 151
 152         if (context->protocols[0].callback(context, wsi,
 153             LWS_CALLBACK_LOCK_POLL, wsi->user_space,  (void *) &pa, 0))
 154                 return -1;
 155
 156         pa.prev_events = pfd->events;
 157         pa.events = pfd->events = (pfd->events & ~_and) | _or;
 158
 159         if (context->protocols[0].callback(context, wsi,
 160                         LWS_CALLBACK_CHANGE_MODE_POLL_FD,
 161                                 wsi->user_space, (void *) &pa, 0))
 162                 return -1;
 163
 164         /*
 165          * if we changed something in this pollfd...
 166          *   ... and we're running in a different thread context
 167          *     than the service thread...
 168          *       ... and the service thread is waiting ...
 169          *         then cancel it to force a restart with our changed events
 170          */
 171 #if LWS_POSIX
 172         pa_events = (pa.prev_events != pa.events);
 173 #endif
 174         if (pa_events)
 175         {
 176
 177                 if (lws_plat_change_pollfd(context, wsi, pfd)) {
 178                         lwsl_info("%s failed\n", __func__);
 179                         return 1;
 180                 }
 181
 182                 sampled_tid = context->service_tid;
 183                 if (sampled_tid) {
 184                         tid = context->protocols[0].callback(context, NULL,
 185                                      LWS_CALLBACK_GET_THREAD_ID, NULL, NULL, 0);
 186                         if (tid == -1)
 187                                 return -1;
 188                         if (tid != sampled_tid)
 189                                 lws_cancel_service(context);
 190                 }
 191         }
 192
 193         if (context->protocols[0].callback(context, wsi,
 194             LWS_CALLBACK_UNLOCK_POLL, wsi->user_space, (void *) &pa, 0))
 195                 return -1;
 196
 197         return 0;
 198 }
 199
 200
 201 /**
 202  * lws_callback_on_writable() - Request a callback when this socket
 203  *                                       becomes able to be written to without
 204  *                                       blocking
 205  *
 206  * @context:    libwebsockets context
 207  * @wsi:        Websocket connection instance to get callback for
 208  */
 209
 210 LWS_VISIBLE int
 211 lws_callback_on_writable(struct lws *wsi)
 212 {
 213 #ifdef LWS_USE_HTTP2
 214         struct lws *network_wsi, *wsi2;
 215         int already;
 216
 217         lwsl_info("%s: %p\n", __func__, wsi);
 218
 219         if (wsi->mode != LWS_CONNMODE_HTTP2_SERVING)
 220                 goto network_sock;
 221
 222         if (wsi->u.http2.requested_POLLOUT) {
 223                 lwsl_info("already pending writable\n");
 224                 return 1;
 225         }
 226
 227         if (wsi->u.http2.tx_credit <= 0) {
 228                 /*
 229                  * other side is not able to cope with us sending
 230                  * anything so no matter if we have POLLOUT on our side.
 231                  *
 232                  * Delay waiting for our POLLOUT until peer indicates he has
 233                  * space for more using tx window command in http2 layer
 234                  */
 235                 lwsl_info("%s: %p: waiting_tx_credit (%d)\n", __func__, wsi, wsi->u.http2.tx_credit);
 236                 wsi->u.http2.waiting_tx_credit = 1;
 237                 return 0;
 238         }
 239
 240         network_wsi = lws_http2_get_network_wsi(wsi);
 241         already = network_wsi->u.http2.requested_POLLOUT;
 242
 243         /* mark everybody above him as requesting pollout */
 244
 245         wsi2 = wsi;
 246         while (wsi2) {
 247                 wsi2->u.http2.requested_POLLOUT = 1;
 248                 lwsl_info("mark %p pending writable\n", wsi2);
 249                 wsi2 = wsi2->u.http2.parent_wsi;
 250         }
 251
 252         /* for network action, act only on the network wsi */
 253
 254         wsi = network_wsi;
 255         if (already)
 256                 return 1;
 257 network_sock:
 258 #endif
 259
 260         if (lws_ext_callback_for_each_active(wsi,
 261                                 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE, NULL, 0))
 262                 return 1;
 263
 264         if (wsi->position_in_fds_table < 0) {
 265                 lwsl_err("%s: failed to find socket %d\n", __func__, wsi->sock);
 266                 return -1;
 267         }
 268
 269         if (lws_change_pollfd(wsi, 0, LWS_POLLOUT))
 270                 return -1;
 271
 272         lws_libev_io(wsi, LWS_EV_START | LWS_EV_WRITE);
 273
 274         return 1;
 275 }
 276
 277 /**
 278  * lws_callback_on_writable_all_protocol() - Request a callback for
 279  *                      all connections using the given protocol when it
 280  *                      becomes possible to write to each socket without
 281  *                      blocking in turn.
 282  *
 283  * @protocol:   Protocol whose connections will get callbacks
 284  */
 285
 286 LWS_VISIBLE int
 287 lws_callback_on_writable_all_protocol(const struct lws_context *context,
 288                                   const struct lws_protocols *protocol)
 289 {
 290         int n;
 291         struct lws *wsi;
 292
 293         for (n = 0; n < context->fds_count; n++) {
 294                 wsi = wsi_from_fd(context,context->fds[n].fd);
 295                 if (!wsi)
 296                         continue;
 297                 if (wsi->protocol == protocol)
 298                         lws_callback_on_writable(wsi);
 299         }
 300
 301         return 0;
 302 }