24f24cee9bb59adfb48d67c280226aead3239ce5
[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         uv_close(handle, lws_uv_close_cb);
262 }
263
264 void
265 lws_libuv_destroyloop(struct lws_context *context, int tsi)
266 {
267         struct lws_context_per_thread *pt = &context->pt[tsi];
268 //      struct lws_context *ctx;
269         int m, budget = 100, ns;
270
271         if (!lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV))
272                 return;
273
274         if (!pt->io_loop_uv)
275                 return;
276
277         lwsl_notice("%s: closing signals + timers context %p\n", __func__, context);
278
279         if (context->use_ev_sigint) {
280                 uv_signal_stop(&pt->w_sigint.uv_watcher);
281
282                 ns = ARRAY_SIZE(sigs);
283                 if (lws_check_opt(context->options, LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN))
284                         ns = 2;
285
286                 for (m = 0; m < ns; m++) {
287                         uv_signal_stop(&pt->signals[m]);
288                         uv_close((uv_handle_t *)&pt->signals[m], lws_uv_close_cb);
289                 }
290         }
291
292         uv_timer_stop(&pt->uv_timeout_watcher);
293         uv_close((uv_handle_t *)&pt->uv_timeout_watcher, lws_uv_close_cb);
294
295         uv_idle_stop(&pt->uv_idle);
296         uv_close((uv_handle_t *)&pt->uv_idle, lws_uv_close_cb);
297
298         if (pt->ev_loop_foreign)
299                 return;
300
301         while (budget-- && uv_run(pt->io_loop_uv, UV_RUN_NOWAIT))
302                 ;
303
304         lwsl_notice("%s: closing all loop handles context %p\n", __func__, context);
305
306         uv_stop(pt->io_loop_uv);
307
308         uv_walk(pt->io_loop_uv, lws_uv_walk_cb, NULL);
309
310         while (uv_run(pt->io_loop_uv, UV_RUN_NOWAIT))
311                 ;
312 #if UV_VERSION_MAJOR > 0
313         m = uv_loop_close(pt->io_loop_uv);
314         if (m == UV_EBUSY)
315                 lwsl_err("%s: uv_loop_close: UV_EBUSY\n", __func__);
316 #endif
317         lws_free(pt->io_loop_uv);
318 }
319
320 void
321 lws_libuv_accept(struct lws *wsi, lws_sock_file_fd_type desc)
322 {
323         struct lws_context *context = lws_get_context(wsi);
324         struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi];
325
326         if (!LWS_LIBUV_ENABLED(context))
327                 return;
328
329         lwsl_debug("%s: new wsi %p\n", __func__, wsi);
330
331         wsi->w_read.context = context;
332         if (wsi->mode == LWSCM_RAW_FILEDESC)
333                 uv_poll_init(pt->io_loop_uv, &wsi->w_read.uv_watcher,
334                              desc.filefd);
335         else
336                 uv_poll_init_socket(pt->io_loop_uv, &wsi->w_read.uv_watcher,
337                                     desc.sockfd);
338 }
339
340 void
341 lws_libuv_io(struct lws *wsi, int flags)
342 {
343         struct lws_context *context = lws_get_context(wsi);
344         struct lws_context_per_thread *pt = &wsi->context->pt[(int)wsi->tsi];
345 #if defined(WIN32) || defined(_WIN32)
346         int current_events = wsi->w_read.uv_watcher.events &
347                              (UV_READABLE | UV_WRITABLE);
348 #else
349         int current_events = wsi->w_read.uv_watcher.io_watcher.pevents &
350                              (UV_READABLE | UV_WRITABLE);
351 #endif
352         struct lws_io_watcher *w = &wsi->w_read;
353
354         if (!LWS_LIBUV_ENABLED(context))
355                 return;
356
357         // lwsl_notice("%s: wsi: %p, flags:0x%x\n", __func__, wsi, flags);
358
359         // w->context is set after the loop is initialized
360
361         if (!pt->io_loop_uv || !w->context) {
362                 lwsl_info("%s: no io loop yet\n", __func__);
363                 return;
364         }
365
366         if (!((flags & (LWS_EV_START | LWS_EV_STOP)) &&
367               (flags & (LWS_EV_READ | LWS_EV_WRITE)))) {
368                 lwsl_err("%s: assert: flags %d", __func__, flags);
369                 assert(0);
370         }
371
372         if (flags & LWS_EV_START) {
373                 if (flags & LWS_EV_WRITE)
374                         current_events |= UV_WRITABLE;
375
376                 if (flags & LWS_EV_READ)
377                         current_events |= UV_READABLE;
378
379                 uv_poll_start(&w->uv_watcher, current_events, lws_io_cb);
380         } else {
381                 if (flags & LWS_EV_WRITE)
382                         current_events &= ~UV_WRITABLE;
383
384                 if (flags & LWS_EV_READ)
385                         current_events &= ~UV_READABLE;
386
387                 if (!(current_events & (UV_READABLE | UV_WRITABLE)))
388                         uv_poll_stop(&w->uv_watcher);
389                 else
390                         uv_poll_start(&w->uv_watcher, current_events,
391                                       lws_io_cb);
392         }
393 }
394
395 int
396 lws_libuv_init_fd_table(struct lws_context *context)
397 {
398         int n;
399
400         if (!LWS_LIBUV_ENABLED(context))
401                 return 0;
402
403         for (n = 0; n < context->count_threads; n++)
404                 context->pt[n].w_sigint.context = context;
405
406         return 1;
407 }
408
409 LWS_VISIBLE void
410 lws_libuv_run(const struct lws_context *context, int tsi)
411 {
412         if (context->pt[tsi].io_loop_uv && LWS_LIBUV_ENABLED(context))
413                 uv_run(context->pt[tsi].io_loop_uv, 0);
414 }
415
416 LWS_VISIBLE void
417 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi)
418 {
419         if (context->pt[tsi].io_loop_uv && LWS_LIBUV_ENABLED(context))
420                 uv_stop(context->pt[tsi].io_loop_uv);
421 }
422
423 static void
424 lws_libuv_kill(const struct lws_context *context)
425 {
426         int n;
427
428         lwsl_notice("%s\n", __func__);
429
430         for (n = 0; n < context->count_threads; n++)
431                 if (context->pt[n].io_loop_uv &&
432                     LWS_LIBUV_ENABLED(context) )//&&
433                     //!context->pt[n].ev_loop_foreign)
434                         uv_stop(context->pt[n].io_loop_uv);
435 }
436
437 /*
438  * This does not actually stop the event loop.  The reason is we have to pass
439  * libuv handle closures through its event loop.  So this tries to close all
440  * wsi, and set a flag; when all the wsi closures are finalized then we
441  * actually stop the libuv event loops.
442  */
443
444 LWS_VISIBLE void
445 lws_libuv_stop(struct lws_context *context)
446 {
447         struct lws_context_per_thread *pt;
448         int n, m;
449
450         if (context->requested_kill)
451                 return;
452
453         context->requested_kill = 1;
454
455         m = context->count_threads;
456         context->being_destroyed = 1;
457
458         while (m--) {
459                 pt = &context->pt[m];
460
461                 for (n = 0; (unsigned int)n < context->pt[m].fds_count; n++) {
462                         struct lws *wsi = wsi_from_fd(context, pt->fds[n].fd);
463
464                         if (!wsi)
465                                 continue;
466                         lws_close_free_wsi(wsi,
467                                 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY
468                                 /* no protocol close */);
469                         n--;
470                 }
471         }
472
473         lwsl_info("%s: feels everything closed\n", __func__);
474         if (context->count_wsi_allocated == 0)
475                 lws_libuv_kill(context);
476 }
477
478 LWS_VISIBLE uv_loop_t *
479 lws_uv_getloop(struct lws_context *context, int tsi)
480 {
481         if (context->pt[tsi].io_loop_uv && LWS_LIBUV_ENABLED(context))
482                 return context->pt[tsi].io_loop_uv;
483
484         return NULL;
485 }
486
487 static void
488 lws_libuv_closewsi(uv_handle_t* handle)
489 {
490         struct lws *n = NULL, *wsi = (struct lws *)(((char *)handle) -
491                           (char *)(&n->w_read.uv_watcher));
492         struct lws_context *context = lws_get_context(wsi);
493         int lspd = 0;
494
495         if (wsi->mode == LWSCM_SERVER_LISTENER &&
496             wsi->context->deprecated) {
497                 lspd = 1;
498                 context->deprecation_pending_listen_close_count--;
499                 if (!context->deprecation_pending_listen_close_count)
500                         lspd = 2;
501         }
502
503         lws_close_free_wsi_final(wsi);
504
505         if (lspd == 2 && context->deprecation_cb) {
506                 lwsl_notice("calling deprecation callback\n");
507                 context->deprecation_cb();
508         }
509
510         //lwsl_notice("%s: ctx %p: wsi left %d\n", __func__, context, context->count_wsi_allocated);
511
512         if (context->requested_kill && context->count_wsi_allocated == 0)
513                 lws_libuv_kill(context);
514 }
515
516 void
517 lws_libuv_closehandle(struct lws *wsi)
518 {
519         struct lws_context *context = lws_get_context(wsi);
520
521         /* required to defer actual deletion until libuv has processed it */
522
523         uv_close((uv_handle_t*)&wsi->w_read.uv_watcher, lws_libuv_closewsi);
524
525         if (context->requested_kill && context->count_wsi_allocated == 0)
526                 lws_libuv_kill(context);
527 }
528
529 #if defined(LWS_WITH_PLUGINS) && (UV_VERSION_MAJOR > 0)
530
531 LWS_VISIBLE int
532 lws_plat_plugins_init(struct lws_context *context, const char * const *d)
533 {
534         struct lws_plugin_capability lcaps;
535         struct lws_plugin *plugin;
536         lws_plugin_init_func initfunc;
537         int m, ret = 0;
538         void *v;
539         uv_dirent_t dent;
540         uv_fs_t req;
541         char path[256];
542         uv_loop_t loop;
543         uv_lib_t lib;
544
545         lib.errmsg = NULL;
546         lib.handle = NULL;
547
548         uv_loop_init(&loop);
549
550         lwsl_notice("  Plugins:\n");
551
552         while (d && *d) {
553
554                 lwsl_notice("  Scanning %s\n", *d);
555                 m =uv_fs_scandir(&loop, &req, *d, 0, NULL);
556                 if (m < 1) {
557                         lwsl_err("Scandir on %s failed\n", *d);
558                         return 1;
559                 }
560
561                 while (uv_fs_scandir_next(&req, &dent) != UV_EOF) {
562                         if (strlen(dent.name) < 7)
563                                 continue;
564
565                         lwsl_notice("   %s\n", dent.name);
566
567                         lws_snprintf(path, sizeof(path) - 1, "%s/%s", *d, dent.name);
568                         if (uv_dlopen(path, &lib)) {
569                                 uv_dlerror(&lib);
570                                 lwsl_err("Error loading DSO: %s\n", lib.errmsg);
571                                 goto bail;
572                         }
573                         /* we could open it, can we get his init function? */
574 #if !defined(WIN32)
575                         m = lws_snprintf(path, sizeof(path) - 1, "init_%s",
576                                      dent.name + 3 /* snip lib... */);
577                         path[m - 3] = '\0'; /* snip the .so */
578 #else
579                         m = lws_snprintf(path, sizeof(path) - 1, "init_%s",
580                                      dent.name);
581                         path[m - 4] = '\0'; /* snip the .dll */
582 #endif
583                         if (uv_dlsym(&lib, path, &v)) {
584                                 uv_dlerror(&lib);
585                                 lwsl_err("Failed to get init on %s: %s",
586                                                 dent.name, lib.errmsg);
587                                 goto bail;
588                         }
589                         initfunc = (lws_plugin_init_func)v;
590                         lcaps.api_magic = LWS_PLUGIN_API_MAGIC;
591                         m = initfunc(context, &lcaps);
592                         if (m) {
593                                 lwsl_err("Initializing %s failed %d\n", dent.name, m);
594                                 goto skip;
595                         }
596
597                         plugin = lws_malloc(sizeof(*plugin));
598                         if (!plugin) {
599                                 lwsl_err("OOM\n");
600                                 goto bail;
601                         }
602                         plugin->list = context->plugin_list;
603                         context->plugin_list = plugin;
604                         strncpy(plugin->name, dent.name, sizeof(plugin->name) - 1);
605                         plugin->name[sizeof(plugin->name) - 1] = '\0';
606                         plugin->lib = lib;
607                         plugin->caps = lcaps;
608                         context->plugin_protocol_count += lcaps.count_protocols;
609                         context->plugin_extension_count += lcaps.count_extensions;
610
611                         continue;
612
613 skip:
614                         uv_dlclose(&lib);
615                 }
616 bail:
617                 uv_fs_req_cleanup(&req);
618                 d++;
619         }
620
621         uv_run(&loop, UV_RUN_NOWAIT);
622         uv_loop_close(&loop);
623
624         return ret;
625
626 }
627
628 LWS_VISIBLE int
629 lws_plat_plugins_destroy(struct lws_context *context)
630 {
631         struct lws_plugin *plugin = context->plugin_list, *p;
632         lws_plugin_destroy_func func;
633         char path[256];
634         void *v;
635         int m;
636
637         if (!plugin)
638                 return 0;
639
640         // lwsl_notice("%s\n", __func__);
641
642         while (plugin) {
643                 p = plugin;
644 #if !defined(WIN32)
645                 m = lws_snprintf(path, sizeof(path) - 1, "destroy_%s", plugin->name + 3);
646                 path[m - 3] = '\0';
647 #else
648                 m = lws_snprintf(path, sizeof(path) - 1, "destroy_%s", plugin->name);
649                 path[m - 4] = '\0';
650 #endif
651
652                 if (uv_dlsym(&plugin->lib, path, &v)) {
653                         uv_dlerror(&plugin->lib);
654                         lwsl_err("Failed to get init on %s: %s",
655                                         plugin->name, plugin->lib.errmsg);
656                 } else {
657                         func = (lws_plugin_destroy_func)v;
658                         m = func(context);
659                         if (m)
660                                 lwsl_err("Destroying %s failed %d\n",
661                                                 plugin->name, m);
662                 }
663
664                 uv_dlclose(&p->lib);
665                 plugin = p->list;
666                 p->list = NULL;
667                 free(p);
668         }
669
670         context->plugin_list = NULL;
671
672         return 0;
673 }
674
675 #endif
676