e295ee3254d03ab276c277829569a3cf8a2d1a52
[platform/upstream/libwebsockets.git] / lib / libuv.c
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 "private-libwebsockets.h"
23
24 void
25 lws_feature_status_libuv(struct lws_context_creation_info *info)
26 {
27         if (lws_check_opt(info->options, LWS_SERVER_OPTION_LIBUV))
28                 lwsl_notice("libuv support compiled in and enabled\n");
29         else
30                 lwsl_notice("libuv support compiled in but disabled\n");
31 }
32
33 static void
34 lws_uv_idle(uv_idle_t *handle
35 #if UV_VERSION_MAJOR == 0
36                 , int status
37 #endif
38 )
39 {
40         struct lws_context_per_thread *pt = lws_container_of(handle,
41                                         struct lws_context_per_thread, uv_idle);
42
43 //      lwsl_debug("%s\n", __func__);
44
45         /*
46          * is there anybody with pending stuff that needs service forcing?
47          */
48         if (!lws_service_adjust_timeout(pt->context, 1, pt->tid)) {
49                 /* -1 timeout means just do forced service */
50                 _lws_plat_service_tsi(pt->context, -1, pt->tid);
51                 /* still somebody left who wants forced service? */
52                 if (!lws_service_adjust_timeout(pt->context, 1, pt->tid))
53                         /* yes... come back again later */
54 //                      lwsl_debug("%s: done again\n", __func__);
55                 return;
56         }
57
58         /* there is nobody who needs service forcing, shut down idle */
59         uv_idle_stop(handle);
60
61         //lwsl_debug("%s: done stop\n", __func__);
62 }
63
64 static void
65 lws_io_cb(uv_poll_t *watcher, int status, int revents)
66 {
67         struct lws_io_watcher *lws_io = lws_container_of(watcher,
68                                         struct lws_io_watcher, uv_watcher);
69         struct lws *wsi = lws_container_of(lws_io, struct lws, w_read);
70         struct lws_context *context = wsi->context;
71         struct lws_pollfd eventfd;
72
73 #if defined(WIN32) || defined(_WIN32)
74         eventfd.fd = watcher->socket;
75 #else
76         eventfd.fd = watcher->io_watcher.fd;
77 #endif
78         eventfd.events = 0;
79         eventfd.revents = 0;
80
81         if (status < 0) {
82                 /* at this point status will be an UV error, like UV_EBADF,
83                 we treat all errors as LWS_POLLHUP */
84
85                 /* you might want to return; instead of servicing the fd in some cases */
86                 if (status == UV_EAGAIN)
87                         return;
88
89                 eventfd.events |= LWS_POLLHUP;
90                 eventfd.revents |= LWS_POLLHUP;
91         } else {
92                 if (revents & UV_READABLE) {
93                         eventfd.events |= LWS_POLLIN;
94                         eventfd.revents |= LWS_POLLIN;
95                 }
96                 if (revents & UV_WRITABLE) {
97                         eventfd.events |= LWS_POLLOUT;
98                         eventfd.revents |= LWS_POLLOUT;
99                 }
100         }
101         lws_service_fd(context, &eventfd);
102
103         uv_idle_start(&context->pt[(int)wsi->tsi].uv_idle, lws_uv_idle);
104 }
105
106 LWS_VISIBLE void
107 lws_uv_sigint_cb(uv_signal_t *watcher, int signum)
108 {
109         lwsl_err("internal signal handler caught signal %d\n", signum);
110         lws_libuv_stop(watcher->data);
111 }
112
113 LWS_VISIBLE int
114 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
115                   uv_signal_cb cb)
116 {
117         context->use_ev_sigint = use_uv_sigint;
118         if (cb)
119                 context->lws_uv_sigint_cb = cb;
120         else
121                 context->lws_uv_sigint_cb = &lws_uv_sigint_cb;
122
123         return 0;
124 }
125
126 static void
127 lws_uv_timeout_cb(uv_timer_t *timer
128 #if UV_VERSION_MAJOR == 0
129                 , int status
130 #endif
131 )
132 {
133         struct lws_context_per_thread *pt = lws_container_of(timer,
134                         struct lws_context_per_thread, uv_timeout_watcher);
135
136         if (pt->context->requested_kill)
137                 return;
138
139         lwsl_debug("%s\n", __func__);
140
141         lws_service_fd_tsi(pt->context, NULL, pt->tid);
142 }
143
144 static const int sigs[] = { SIGINT, SIGTERM, SIGSEGV, SIGFPE, SIGHUP };
145
146 int
147 lws_uv_initvhost(struct lws_vhost* vh, struct lws* wsi)
148 {
149         struct lws_context_per_thread *pt;
150         int n;
151
152         if (!LWS_LIBUV_ENABLED(vh->context))
153                 return 0;
154         if (!wsi)
155                 wsi = vh->lserv_wsi;
156         if (!wsi)
157                 return 0;
158         if (wsi->w_read.context)
159                 return 0;
160
161         pt = &vh->context->pt[(int)wsi->tsi];
162         if (!pt->io_loop_uv)
163                 return 0;
164
165         wsi->w_read.context = vh->context;
166         n = uv_poll_init_socket(pt->io_loop_uv,
167                                 &wsi->w_read.uv_watcher, wsi->desc.sockfd);
168         if (n) {
169                 lwsl_err("uv_poll_init failed %d, sockfd=%p\n",
170                                  n, (void *)(long)wsi->desc.sockfd);
171
172                 return -1;
173         }
174         lws_libuv_io(wsi, LWS_EV_START | LWS_EV_READ);
175
176         return 0;
177 }
178
179 /*
180  * This needs to be called after vhosts have been defined.
181  *
182  * If later, after server start, another vhost is added, this must be
183  * called again to bind the vhost
184  */
185
186 LWS_VISIBLE int
187 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi)
188 {
189         struct lws_context_per_thread *pt = &context->pt[tsi];
190         struct lws_vhost *vh = context->vhost_list;
191         int status = 0, n, ns, first = 1;
192
193         if (!pt->io_loop_uv) {
194                 if (!loop) {
195                         loop = lws_malloc(sizeof(*loop));
196                         if (!loop) {
197                                 lwsl_err("OOM\n");
198                                 return -1;
199                         }
200         #if UV_VERSION_MAJOR > 0
201                         uv_loop_init(loop);
202         #else
203                         lwsl_err("This libuv is too old to work...\n");
204                         return 1;
205         #endif
206                         pt->ev_loop_foreign = 0;
207                 } else {
208                         lwsl_notice(" Using foreign event loop...\n");
209                         pt->ev_loop_foreign = 1;
210                 }
211
212                 pt->io_loop_uv = loop;
213                 uv_idle_init(loop, &pt->uv_idle);
214
215                 ns = ARRAY_SIZE(sigs);
216                 if (lws_check_opt(context->options,
217                                   LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN))
218                         ns = 2;
219
220                 if (pt->context->use_ev_sigint) {
221                         assert(ns <= ARRAY_SIZE(pt->signals));
222                         for (n = 0; n < ns; n++) {
223                                 uv_signal_init(loop, &pt->signals[n]);
224                                 pt->signals[n].data = pt->context;
225                                 uv_signal_start(&pt->signals[n],
226                                                 context->lws_uv_sigint_cb, sigs[n]);
227                         }
228                 }
229         } else
230                 first = 0;
231
232         /*
233          * Initialize the accept wsi read watcher with all the listening sockets
234          * and register a callback for read operations
235          *
236          * We have to do it here because the uv loop(s) are not
237          * initialized until after context creation.
238          */
239         while (vh) {
240                 if (lws_uv_initvhost(vh, vh->lserv_wsi) == -1)
241                         return -1;
242                 vh = vh->vhost_next;
243         }
244
245         if (first) {
246                 uv_timer_init(pt->io_loop_uv, &pt->uv_timeout_watcher);
247                 uv_timer_start(&pt->uv_timeout_watcher, lws_uv_timeout_cb,
248                                10, 1000);
249         }
250
251         return status;
252 }
253
254 static void lws_uv_close_cb(uv_handle_t *handle)
255 {
256         //lwsl_err("%s: handle %p\n", __func__, handle);
257 }
258
259 static void lws_uv_walk_cb(uv_handle_t *handle, void *arg)
260 {
261         if (!uv_is_closing(handle))
262                 uv_close(handle, lws_uv_close_cb);
263 }
264
265 void
266 lws_libuv_destroyloop(struct lws_context *context, int tsi)
267 {
268         struct lws_context_per_thread *pt = &context->pt[tsi];
269 //      struct lws_context *ctx;
270         int m, budget = 100, ns;
271
272         if (!lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV))
273                 return;
274
275         if (!pt->io_loop_uv)
276                 return;
277
278         lwsl_notice("%s: closing signals + timers context %p\n", __func__, context);
279
280         if (context->use_ev_sigint) {
281                 uv_signal_stop(&pt->w_sigint.uv_watcher);
282
283                 ns = ARRAY_SIZE(sigs);
284                 if (lws_check_opt(context->options, LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN))
285                         ns = 2;
286
287                 for (m = 0; m < ns; m++) {
288                         uv_signal_stop(&pt->signals[m]);
289                         uv_close((uv_handle_t *)&pt->signals[m], lws_uv_close_cb);
290                 }
291         }
292
293         uv_timer_stop(&pt->uv_timeout_watcher);
294         uv_close((uv_handle_t *)&pt->uv_timeout_watcher, lws_uv_close_cb);
295
296         uv_idle_stop(&pt->uv_idle);
297         uv_close((uv_handle_t *)&pt->uv_idle, lws_uv_close_cb);
298
299         if (pt->ev_loop_foreign)
300                 return;
301
302         while (budget-- && uv_run(pt->io_loop_uv, UV_RUN_NOWAIT))
303                 ;
304
305         lwsl_notice("%s: closing all loop handles context %p\n", __func__, context);
306
307         uv_stop(pt->io_loop_uv);
308
309         uv_walk(pt->io_loop_uv, lws_uv_walk_cb, NULL);
310
311         while (uv_run(pt->io_loop_uv, UV_RUN_NOWAIT))
312                 ;
313 #if UV_VERSION_MAJOR > 0
314         m = uv_loop_close(pt->io_loop_uv);
315         if (m == UV_EBUSY)
316                 lwsl_err("%s: uv_loop_close: UV_EBUSY\n", __func__);
317 #endif
318         lws_free(pt->io_loop_uv);
319 }
320
321 void
322 lws_libuv_accept(struct lws *wsi, lws_sock_file_fd_type desc)
323 {
324         struct lws_context *context = lws_get_context(wsi);
325         struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi];
326
327         if (!LWS_LIBUV_ENABLED(context))
328                 return;
329
330         lwsl_debug("%s: new wsi %p\n", __func__, wsi);
331
332         wsi->w_read.context = context;
333         if (wsi->mode == LWSCM_RAW_FILEDESC)
334                 uv_poll_init(pt->io_loop_uv, &wsi->w_read.uv_watcher,
335                              (int)desc.filefd);
336         else
337                 uv_poll_init_socket(pt->io_loop_uv, &wsi->w_read.uv_watcher,
338                                     desc.sockfd);
339 }
340
341 void
342 lws_libuv_io(struct lws *wsi, int flags)
343 {
344         struct lws_context *context = lws_get_context(wsi);
345         struct lws_context_per_thread *pt = &wsi->context->pt[(int)wsi->tsi];
346 #if defined(WIN32) || defined(_WIN32)
347         int current_events = wsi->w_read.uv_watcher.events &
348                              (UV_READABLE | UV_WRITABLE);
349 #else
350         int current_events = wsi->w_read.uv_watcher.io_watcher.pevents &
351                              (UV_READABLE | UV_WRITABLE);
352 #endif
353         struct lws_io_watcher *w = &wsi->w_read;
354
355         if (!LWS_LIBUV_ENABLED(context))
356                 return;
357
358         // lwsl_notice("%s: wsi: %p, flags:0x%x\n", __func__, wsi, flags);
359
360         // w->context is set after the loop is initialized
361
362         if (!pt->io_loop_uv || !w->context) {
363                 lwsl_info("%s: no io loop yet\n", __func__);
364                 return;
365         }
366
367         if (!((flags & (LWS_EV_START | LWS_EV_STOP)) &&
368               (flags & (LWS_EV_READ | LWS_EV_WRITE)))) {
369                 lwsl_err("%s: assert: flags %d", __func__, flags);
370                 assert(0);
371         }
372
373         if (flags & LWS_EV_START) {
374                 if (flags & LWS_EV_WRITE)
375                         current_events |= UV_WRITABLE;
376
377                 if (flags & LWS_EV_READ)
378                         current_events |= UV_READABLE;
379
380                 uv_poll_start(&w->uv_watcher, current_events, lws_io_cb);
381         } else {
382                 if (flags & LWS_EV_WRITE)
383                         current_events &= ~UV_WRITABLE;
384
385                 if (flags & LWS_EV_READ)
386                         current_events &= ~UV_READABLE;
387
388                 if (!(current_events & (UV_READABLE | UV_WRITABLE)))
389                         uv_poll_stop(&w->uv_watcher);
390                 else
391                         uv_poll_start(&w->uv_watcher, current_events,
392                                       lws_io_cb);
393         }
394 }
395
396 int
397 lws_libuv_init_fd_table(struct lws_context *context)
398 {
399         int n;
400
401         if (!LWS_LIBUV_ENABLED(context))
402                 return 0;
403
404         for (n = 0; n < context->count_threads; n++)
405                 context->pt[n].w_sigint.context = context;
406
407         return 1;
408 }
409
410 LWS_VISIBLE void
411 lws_libuv_run(const struct lws_context *context, int tsi)
412 {
413         if (context->pt[tsi].io_loop_uv && LWS_LIBUV_ENABLED(context))
414                 uv_run(context->pt[tsi].io_loop_uv, 0);
415 }
416
417 LWS_VISIBLE void
418 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi)
419 {
420         if (context->pt[tsi].io_loop_uv && LWS_LIBUV_ENABLED(context))
421                 uv_stop(context->pt[tsi].io_loop_uv);
422 }
423
424 static void
425 lws_libuv_kill(const struct lws_context *context)
426 {
427         int n;
428
429         lwsl_notice("%s\n", __func__);
430
431         for (n = 0; n < context->count_threads; n++)
432                 if (context->pt[n].io_loop_uv &&
433                     LWS_LIBUV_ENABLED(context) )//&&
434                     //!context->pt[n].ev_loop_foreign)
435                         uv_stop(context->pt[n].io_loop_uv);
436 }
437
438 /*
439  * This does not actually stop the event loop.  The reason is we have to pass
440  * libuv handle closures through its event loop.  So this tries to close all
441  * wsi, and set a flag; when all the wsi closures are finalized then we
442  * actually stop the libuv event loops.
443  */
444
445 LWS_VISIBLE void
446 lws_libuv_stop(struct lws_context *context)
447 {
448         struct lws_context_per_thread *pt;
449         int n, m;
450
451         if (context->requested_kill)
452                 return;
453
454         context->requested_kill = 1;
455
456         m = context->count_threads;
457         context->being_destroyed = 1;
458
459         while (m--) {
460                 pt = &context->pt[m];
461
462                 for (n = 0; (unsigned int)n < context->pt[m].fds_count; n++) {
463                         struct lws *wsi = wsi_from_fd(context, pt->fds[n].fd);
464
465                         if (!wsi)
466                                 continue;
467                         lws_close_free_wsi(wsi,
468                                 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY
469                                 /* no protocol close */);
470                         n--;
471                 }
472         }
473
474         lwsl_info("%s: feels everything closed\n", __func__);
475         if (context->count_wsi_allocated == 0)
476                 lws_libuv_kill(context);
477 }
478
479 LWS_VISIBLE uv_loop_t *
480 lws_uv_getloop(struct lws_context *context, int tsi)
481 {
482         if (context->pt[tsi].io_loop_uv && LWS_LIBUV_ENABLED(context))
483                 return context->pt[tsi].io_loop_uv;
484
485         return NULL;
486 }
487
488 static void
489 lws_libuv_closewsi(uv_handle_t* handle)
490 {
491         struct lws *n = NULL, *wsi = (struct lws *)(((char *)handle) -
492                           (char *)(&n->w_read.uv_watcher));
493         struct lws_context *context = lws_get_context(wsi);
494         int lspd = 0;
495
496         if (wsi->mode == LWSCM_SERVER_LISTENER &&
497             wsi->context->deprecated) {
498                 lspd = 1;
499                 context->deprecation_pending_listen_close_count--;
500                 if (!context->deprecation_pending_listen_close_count)
501                         lspd = 2;
502         }
503
504         lws_close_free_wsi_final(wsi);
505
506         if (lspd == 2 && context->deprecation_cb) {
507                 lwsl_notice("calling deprecation callback\n");
508                 context->deprecation_cb();
509         }
510
511         //lwsl_notice("%s: ctx %p: wsi left %d\n", __func__, context, context->count_wsi_allocated);
512
513         if (context->requested_kill && context->count_wsi_allocated == 0)
514                 lws_libuv_kill(context);
515 }
516
517 void
518 lws_libuv_closehandle(struct lws *wsi)
519 {
520         struct lws_context *context = lws_get_context(wsi);
521
522         /* required to defer actual deletion until libuv has processed it */
523
524         uv_close((uv_handle_t*)&wsi->w_read.uv_watcher, lws_libuv_closewsi);
525
526         if (context->requested_kill && context->count_wsi_allocated == 0)
527                 lws_libuv_kill(context);
528 }
529
530 #if defined(LWS_WITH_PLUGINS) && (UV_VERSION_MAJOR > 0)
531
532 LWS_VISIBLE int
533 lws_plat_plugins_init(struct lws_context *context, const char * const *d)
534 {
535         struct lws_plugin_capability lcaps;
536         struct lws_plugin *plugin;
537         lws_plugin_init_func initfunc;
538         int m, ret = 0;
539         void *v;
540         uv_dirent_t dent;
541         uv_fs_t req;
542         char path[256];
543         uv_loop_t loop;
544         uv_lib_t lib;
545         int pofs = 0;
546
547 #if  defined(__MINGW32__) || !defined(WIN32)
548         pofs = 3;
549 #endif
550
551         lib.errmsg = NULL;
552         lib.handle = NULL;
553
554         uv_loop_init(&loop);
555
556         lwsl_notice("  Plugins:\n");
557
558         while (d && *d) {
559
560                 lwsl_notice("  Scanning %s\n", *d);
561                 m =uv_fs_scandir(&loop, &req, *d, 0, NULL);
562                 if (m < 1) {
563                         lwsl_err("Scandir on %s failed\n", *d);
564                         return 1;
565                 }
566
567                 while (uv_fs_scandir_next(&req, &dent) != UV_EOF) {
568                         if (strlen(dent.name) < 7)
569                                 continue;
570
571                         lwsl_notice("   %s\n", dent.name);
572
573                         lws_snprintf(path, sizeof(path) - 1, "%s/%s", *d, dent.name);
574                         if (uv_dlopen(path, &lib)) {
575                                 uv_dlerror(&lib);
576                                 lwsl_err("Error loading DSO: %s\n", lib.errmsg);
577                                 goto bail;
578                         }
579
580                         /* we could open it, can we get his init function? */
581
582 #if !defined(WIN32) && !defined(__MINGW32__)
583                         m = lws_snprintf(path, sizeof(path) - 1, "init_%s",
584                                      dent.name + pofs /* snip lib... */);
585                         path[m - 3] = '\0'; /* snip the .so */
586 #else
587                         m = lws_snprintf(path, sizeof(path) - 1, "init_%s",
588                                      dent.name + pofs);
589                         path[m - 4] = '\0'; /* snip the .dll */
590 #endif
591                         if (uv_dlsym(&lib, path, &v)) {
592                                 uv_dlerror(&lib);
593                                 lwsl_err("Failed to get %s on %s: %s", path,
594                                                 dent.name, lib.errmsg);
595                                 goto bail;
596                         }
597                         initfunc = (lws_plugin_init_func)v;
598                         lcaps.api_magic = LWS_PLUGIN_API_MAGIC;
599                         m = initfunc(context, &lcaps);
600                         if (m) {
601                                 lwsl_err("Initializing %s failed %d\n", dent.name, m);
602                                 goto skip;
603                         }
604
605                         plugin = lws_malloc(sizeof(*plugin));
606                         if (!plugin) {
607                                 lwsl_err("OOM\n");
608                                 goto bail;
609                         }
610                         plugin->list = context->plugin_list;
611                         context->plugin_list = plugin;
612                         strncpy(plugin->name, dent.name, sizeof(plugin->name) - 1);
613                         plugin->name[sizeof(plugin->name) - 1] = '\0';
614                         plugin->lib = lib;
615                         plugin->caps = lcaps;
616                         context->plugin_protocol_count += lcaps.count_protocols;
617                         context->plugin_extension_count += lcaps.count_extensions;
618
619                         continue;
620
621 skip:
622                         uv_dlclose(&lib);
623                 }
624 bail:
625                 uv_fs_req_cleanup(&req);
626                 d++;
627         }
628
629         uv_run(&loop, UV_RUN_NOWAIT);
630         uv_loop_close(&loop);
631
632         return ret;
633
634 }
635
636 LWS_VISIBLE int
637 lws_plat_plugins_destroy(struct lws_context *context)
638 {
639         struct lws_plugin *plugin = context->plugin_list, *p;
640         lws_plugin_destroy_func func;
641         char path[256];
642         void *v;
643         int m;
644         int pofs = 0;
645
646 #if  defined(__MINGW32__) || !defined(WIN32)
647         pofs = 3;
648 #endif
649
650         if (!plugin)
651                 return 0;
652
653         // lwsl_notice("%s\n", __func__);
654
655         while (plugin) {
656                 p = plugin;
657
658 #if !defined(WIN32) && !defined(__MINGW32__)
659                 m = lws_snprintf(path, sizeof(path) - 1, "destroy_%s", plugin->name + pofs);
660                 path[m - 3] = '\0';
661 #else
662                 m = lws_snprintf(path, sizeof(path) - 1, "destroy_%s", plugin->name + pofs);
663                 path[m - 4] = '\0';
664 #endif
665
666                 if (uv_dlsym(&plugin->lib, path, &v)) {
667                         uv_dlerror(&plugin->lib);
668                         lwsl_err("Failed to get %s on %s: %s", path,
669                                         plugin->name, plugin->lib.errmsg);
670                 } else {
671                         func = (lws_plugin_destroy_func)v;
672                         m = func(context);
673                         if (m)
674                                 lwsl_err("Destroying %s failed %d\n",
675                                                 plugin->name, m);
676                 }
677
678                 uv_dlclose(&p->lib);
679                 plugin = p->list;
680                 p->list = NULL;
681                 free(p);
682         }
683
684         context->plugin_list = NULL;
685
686         return 0;
687 }
688
689 #endif
690