1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-16 00:00:07 +01:00
libwebsockets/lib/event-libs/libevent/libevent.c

519 lines
13 KiB
C
Raw Normal View History

/*
* libwebsockets - small server side websockets and web server implementation
*
* Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#include "private-lib-core.h"
#include "private-lib-event-libs-libevent.h"
#define pt_to_priv_event(_pt) ((struct lws_pt_eventlibs_libevent *)(_pt)->evlib_pt)
#define wsi_to_priv_event(_w) ((struct lws_wsi_eventlibs_libevent *)(_w)->evlib_wsi)
static void
lws_event_hrtimer_cb(int fd, short event, void *p)
{
struct lws_context_per_thread *pt = (struct lws_context_per_thread *)p;
struct lws_pt_eventlibs_libevent *ptpr = pt_to_priv_event(pt);
struct timeval tv;
lws_usec_t us;
lws_pt_lock(pt, __func__);
us = __lws_sul_service_ripe(pt->pt_sul_owner, LWS_COUNT_PT_SUL_OWNERS,
lws_now_usecs());
if (us) {
tv.tv_sec = us / LWS_US_PER_SEC;
tv.tv_usec = us - (tv.tv_sec * LWS_US_PER_SEC);
evtimer_add(ptpr->hrtimer, &tv);
}
lws_pt_unlock(pt);
}
static void
lws_event_idle_timer_cb(int fd, short event, void *p)
{
struct lws_context_per_thread *pt = (struct lws_context_per_thread *)p;
struct lws_pt_eventlibs_libevent *ptpr = pt_to_priv_event(pt);
struct timeval tv;
lws_usec_t us;
if (pt->is_destroyed)
return;
lws_service_do_ripe_rxflow(pt);
/*
* is there anybody with pending stuff that needs service forcing?
*/
if (!lws_service_adjust_timeout(pt->context, 1, pt->tid)) {
/* -1 timeout means just do forced service */
_lws_plat_service_forced_tsi(pt->context, pt->tid);
/* still somebody left who wants forced service? */
if (!lws_service_adjust_timeout(pt->context, 1, pt->tid)) {
/* yes... come back again later */
tv.tv_sec = 0;
tv.tv_usec = 1000;
evtimer_add(ptpr->idle_timer, &tv);
return;
}
}
lwsl_debug("%s: wait\n", __func__);
/* account for hrtimer */
lws_pt_lock(pt, __func__);
us = __lws_sul_service_ripe(pt->pt_sul_owner, LWS_COUNT_PT_SUL_OWNERS,
lws_now_usecs());
if (us) {
tv.tv_sec = us / LWS_US_PER_SEC;
tv.tv_usec = us - (tv.tv_sec * LWS_US_PER_SEC);
evtimer_add(ptpr->hrtimer, &tv);
}
lws_pt_unlock(pt);
if (pt->destroy_self)
lws_context_destroy(pt->context);
}
static void
lws_event_cb(evutil_socket_t sock_fd, short revents, void *ctx)
{
struct lws_signal_watcher_libevent *lws_io =
(struct lws_signal_watcher_libevent *)ctx;
2017-09-23 12:55:21 +08:00
struct lws_context *context = lws_io->context;
struct lws_context_per_thread *pt;
2017-09-23 12:55:21 +08:00
struct lws_pollfd eventfd;
struct timeval tv;
struct lws *wsi;
2017-09-23 12:55:21 +08:00
if (revents & EV_TIMEOUT)
return;
/* !!! EV_CLOSED doesn't exist in libevent2 */
#if LIBEVENT_VERSION_NUMBER < 0x02000000
2017-09-23 12:55:21 +08:00
if (revents & EV_CLOSED) {
event_del(lws_io->event.watcher);
event_free(lws_io->event.watcher);
2017-09-23 12:55:21 +08:00
return;
}
#endif
2017-09-23 12:55:21 +08:00
eventfd.fd = sock_fd;
eventfd.events = 0;
eventfd.revents = 0;
if (revents & EV_READ) {
eventfd.events |= LWS_POLLIN;
eventfd.revents |= LWS_POLLIN;
}
if (revents & EV_WRITE) {
eventfd.events |= LWS_POLLOUT;
eventfd.revents |= LWS_POLLOUT;
}
wsi = wsi_from_fd(context, sock_fd);
if (!wsi)
2019-03-21 09:27:45 +08:00
return;
pt = &context->pt[(int)wsi->tsi];
if (pt->is_destroyed)
return;
lws_service_fd_tsi(context, &eventfd, wsi->tsi);
if (pt->destroy_self) {
2020-03-10 19:13:43 +00:00
lwsl_notice("%s: pt destroy self coming true\n", __func__);
lws_context_destroy(pt->context);
return;
}
/* set the idle timer for 1ms ahead */
tv.tv_sec = 0;
tv.tv_usec = 1000;
evtimer_add(pt_to_priv_event(pt)->idle_timer, &tv);
}
2020-01-02 08:32:23 +00:00
void
lws_event_sigint_cb(evutil_socket_t sock_fd, short revents, void *ctx)
{
2017-09-23 12:55:21 +08:00
struct lws_context_per_thread *pt = ctx;
struct event *signal = pt_to_priv_event(pt)->w_sigint.watcher;
2017-09-23 12:55:21 +08:00
if (pt->context->eventlib_signal_cb) {
pt->context->eventlib_signal_cb((void *)(lws_intptr_t)sock_fd,
event_get_signal(signal));
return;
}
if (!pt->event_loop_foreign)
event_base_loopbreak(pt_to_priv_event(pt)->io_loop);
}
static int
elops_init_pt_event(struct lws_context *context, void *_loop, int tsi)
{
2017-09-23 12:55:21 +08:00
struct lws_vhost *vh = context->vhost_list;
struct event_base *loop = (struct event_base *)_loop;
struct lws_context_per_thread *pt = &context->pt[tsi];
struct lws_pt_eventlibs_libevent *ptpr = pt_to_priv_event(pt);
2017-09-23 12:55:21 +08:00
lwsl_info("%s: loop %p\n", __func__, _loop);
2017-09-23 12:55:21 +08:00
if (!loop)
loop = event_base_new();
else
context->pt[tsi].event_loop_foreign = 1;
if (!loop) {
lwsl_err("%s: creating event base failed\n", __func__);
return -1;
2017-09-23 12:55:21 +08:00
}
ptpr->io_loop = loop;
2017-09-23 12:55:21 +08:00
/*
* Initialize all events with the listening sockets
* and register a callback for read operations
*/
while (vh) {
if (vh->lserv_wsi) {
struct lws_io_watcher_libevent *w_read =
&(wsi_to_priv_event(vh->lserv_wsi)->w_read);
w_read->context = context;
w_read->watcher = event_new(
2017-09-23 12:55:21 +08:00
loop, vh->lserv_wsi->desc.sockfd,
(EV_READ | EV_PERSIST), lws_event_cb,
w_read);
event_add(w_read->watcher, NULL);
w_read->set = 1;
2017-09-23 12:55:21 +08:00
}
vh = vh->vhost_next;
}
/* static event loop objects */
ptpr->hrtimer = event_new(loop, -1, EV_PERSIST,
lws_event_hrtimer_cb, pt);
ptpr->idle_timer = event_new(loop, -1, 0,
lws_event_idle_timer_cb, pt);
/* Register the signal watcher unless it's a foreign loop */
if (pt->event_loop_foreign)
2017-09-23 12:55:21 +08:00
return 0;
ptpr->w_sigint.watcher = evsignal_new(loop, SIGINT,
lws_event_sigint_cb, pt);
event_add(ptpr->w_sigint.watcher, NULL);
2017-09-23 12:55:21 +08:00
return 0;
}
static int
elops_init_context_event(struct lws_context *context,
const struct lws_context_creation_info *info)
{
int n;
2017-09-23 12:55:21 +08:00
context->eventlib_signal_cb = info->signal_cb;
2017-09-23 12:55:21 +08:00
for (n = 0; n < context->count_threads; n++)
pt_to_priv_event(&context->pt[n])->w_sigint.context = context;
2017-09-23 12:55:21 +08:00
return 0;
}
static int
elops_accept_event(struct lws *wsi)
{
struct lws_context *context = lws_get_context(wsi);
2017-09-23 12:55:21 +08:00
struct lws_context_per_thread *pt;
struct lws_pt_eventlibs_libevent *ptpr;
struct lws_wsi_eventlibs_libevent *wpr = wsi_to_priv_event(wsi);
2017-09-23 12:55:21 +08:00
int fd;
wpr->w_read.context = context;
wpr->w_write.context = context;
2017-09-23 12:55:21 +08:00
// Initialize the event
pt = &context->pt[(int)wsi->tsi];
ptpr = pt_to_priv_event(pt);
2017-09-23 12:55:21 +08:00
if (wsi->role_ops->file_handle)
fd = wsi->desc.filefd;
2017-09-23 12:55:21 +08:00
else
fd = wsi->desc.sockfd;
wpr->w_read.watcher = event_new(ptpr->io_loop, fd,
(EV_READ | EV_PERSIST), lws_event_cb, &wpr->w_read);
wpr->w_write.watcher = event_new(ptpr->io_loop, fd,
(EV_WRITE | EV_PERSIST), lws_event_cb, &wpr->w_write);
return 0;
}
static void
elops_io_event(struct lws *wsi, int flags)
{
fakewsi: replace with smaller substructure Currently we always reserve a fakewsi per pt so events that don't have a related actual wsi, like vhost-protocol-init or vhost cert init via protocol callback can make callbacks that look reasonable to user protocol handler code expecting a valid wsi every time. This patch splits out stuff that user callbacks often unconditionally expect to be in a wsi, like context pointer, vhost pointer etc into a substructure, which is composed into struct lws at the top of it. Internal references (struct lws is opaque, so there are only internal references) are all updated to go via the substructre, the compiler should make that a NOP. Helpers are added when fakewsi is used and referenced. If not PLAT_FREERTOS, we continue to provide a full fakewsi in the pt as before, although the helpers improve consistency by zeroing down the substructure. There is a huge amount of user code out there over the last 10 years that did not always have the minimal examples to follow, some of it does some unexpected things. If it is PLAT_FREERTOS, that is a newer thing in lws and users have the benefit of being able to follow the minimal examples' approach. For PLAT_FREERTOS we don't reserve the fakewsi in the pt any more, saving around 800 bytes. The helpers then create a struct lws_a (the substructure) on the stack, zero it down (but it is only like 4 pointers) and prepare it with whatever we know like the context. Then we cast it to a struct lws * and use it in the user protocol handler call. In this case, the remainder of the struct lws is undefined. However the amount of old protocol handlers that might touch things outside of the substructure in PLAT_FREERTOS is very limited compared to legacy lws user code and the saving is significant on constrained devices. User handlers should not be touching everything in a wsi every time anyway, there are several cases where there is no valid wsi to do the call with. Dereference of things outside the substructure should only happen when the callback reason shows there is a valid wsi bound to the activity (as in all the minimal examples).
2020-07-19 08:33:46 +01:00
struct lws_context_per_thread *pt = &wsi->a.context->pt[(int)wsi->tsi];
struct lws_pt_eventlibs_libevent *ptpr = pt_to_priv_event(pt);
struct lws_wsi_eventlibs_libevent *wpr = wsi_to_priv_event(wsi);
2017-09-23 12:55:21 +08:00
if (!ptpr->io_loop || wsi->a.context->being_destroyed ||
pt->is_destroyed)
2017-09-23 12:55:21 +08:00
return;
assert((flags & (LWS_EV_START | LWS_EV_STOP)) &&
(flags & (LWS_EV_READ | LWS_EV_WRITE)));
if (flags & LWS_EV_START) {
if ((flags & LWS_EV_WRITE) && !wpr->w_write.set) {
event_add(wpr->w_write.watcher, NULL);
wpr->w_write.set = 1;
}
if ((flags & LWS_EV_READ) && !wpr->w_read.set) {
event_add(wpr->w_read.watcher, NULL);
wpr->w_read.set = 1;
}
2017-09-23 12:55:21 +08:00
} else {
if ((flags & LWS_EV_WRITE) && wpr->w_write.set) {
event_del(wpr->w_write.watcher);
wpr->w_write.set = 0;
}
2017-09-23 12:55:21 +08:00
if ((flags & LWS_EV_READ) && wpr->w_read.set) {
event_del(wpr->w_read.watcher);
wpr->w_read.set = 0;
}
2017-09-23 12:55:21 +08:00
}
}
static void
elops_run_pt_event(struct lws_context *context, int tsi)
{
/* Run / Dispatch the event_base loop */
if (pt_to_priv_event(&context->pt[tsi])->io_loop)
event_base_dispatch(
pt_to_priv_event(&context->pt[tsi])->io_loop);
}
2017-09-23 12:55:21 +08:00
static void
elops_destroy_pt_event(struct lws_context *context, int tsi)
{
struct lws_context_per_thread *pt = &context->pt[tsi];
struct lws_pt_eventlibs_libevent *ptpr = pt_to_priv_event(pt);
struct lws_vhost *vh = context->vhost_list;
lwsl_info("%s\n", __func__);
if (!ptpr->io_loop)
return;
/*
* Free all events with the listening sockets
*/
while (vh) {
if (vh->lserv_wsi) {
struct lws_wsi_eventlibs_libevent *w =
wsi_to_priv_event(vh->lserv_wsi);
event_free(w->w_read.watcher);
w->w_read.watcher = NULL;
event_free(w->w_write.watcher);
w->w_write.watcher = NULL;
}
vh = vh->vhost_next;
}
event_free(ptpr->hrtimer);
event_free(ptpr->idle_timer);
if (!pt->event_loop_foreign) {
event_del(ptpr->w_sigint.watcher);
event_free(ptpr->w_sigint.watcher);
event_base_loopexit(ptpr->io_loop, NULL);
2020-03-10 19:13:43 +00:00
// event_base_free(pt->event.io_loop);
// pt->event.io_loop = NULL;
lwsl_notice("%s: set to exit loop\n", __func__);
}
}
static void
elops_destroy_wsi_event(struct lws *wsi)
{
struct lws_context_per_thread *pt;
struct lws_wsi_eventlibs_libevent *w;
if (!wsi)
return;
fakewsi: replace with smaller substructure Currently we always reserve a fakewsi per pt so events that don't have a related actual wsi, like vhost-protocol-init or vhost cert init via protocol callback can make callbacks that look reasonable to user protocol handler code expecting a valid wsi every time. This patch splits out stuff that user callbacks often unconditionally expect to be in a wsi, like context pointer, vhost pointer etc into a substructure, which is composed into struct lws at the top of it. Internal references (struct lws is opaque, so there are only internal references) are all updated to go via the substructre, the compiler should make that a NOP. Helpers are added when fakewsi is used and referenced. If not PLAT_FREERTOS, we continue to provide a full fakewsi in the pt as before, although the helpers improve consistency by zeroing down the substructure. There is a huge amount of user code out there over the last 10 years that did not always have the minimal examples to follow, some of it does some unexpected things. If it is PLAT_FREERTOS, that is a newer thing in lws and users have the benefit of being able to follow the minimal examples' approach. For PLAT_FREERTOS we don't reserve the fakewsi in the pt any more, saving around 800 bytes. The helpers then create a struct lws_a (the substructure) on the stack, zero it down (but it is only like 4 pointers) and prepare it with whatever we know like the context. Then we cast it to a struct lws * and use it in the user protocol handler call. In this case, the remainder of the struct lws is undefined. However the amount of old protocol handlers that might touch things outside of the substructure in PLAT_FREERTOS is very limited compared to legacy lws user code and the saving is significant on constrained devices. User handlers should not be touching everything in a wsi every time anyway, there are several cases where there is no valid wsi to do the call with. Dereference of things outside the substructure should only happen when the callback reason shows there is a valid wsi bound to the activity (as in all the minimal examples).
2020-07-19 08:33:46 +01:00
pt = &wsi->a.context->pt[(int)wsi->tsi];
if (pt->is_destroyed)
return;
w = wsi_to_priv_event(wsi);
if (w->w_read.watcher) {
event_free(w->w_read.watcher);
w->w_read.watcher = NULL;
}
if (w->w_write.watcher) {
event_free(w->w_write.watcher);
w->w_write.watcher = NULL;
}
}
static int
elops_wsi_logical_close_event(struct lws *wsi)
{
elops_destroy_wsi_event(wsi);
return 0;
}
static int
elops_init_vhost_listen_wsi_event(struct lws *wsi)
{
struct lws_context_per_thread *pt;
struct lws_pt_eventlibs_libevent *ptpr;
struct lws_wsi_eventlibs_libevent *w;
int fd;
if (!wsi) {
assert(0);
return 0;
}
w = wsi_to_priv_event(wsi);
w->w_read.context = wsi->a.context;
w->w_write.context = wsi->a.context;
fakewsi: replace with smaller substructure Currently we always reserve a fakewsi per pt so events that don't have a related actual wsi, like vhost-protocol-init or vhost cert init via protocol callback can make callbacks that look reasonable to user protocol handler code expecting a valid wsi every time. This patch splits out stuff that user callbacks often unconditionally expect to be in a wsi, like context pointer, vhost pointer etc into a substructure, which is composed into struct lws at the top of it. Internal references (struct lws is opaque, so there are only internal references) are all updated to go via the substructre, the compiler should make that a NOP. Helpers are added when fakewsi is used and referenced. If not PLAT_FREERTOS, we continue to provide a full fakewsi in the pt as before, although the helpers improve consistency by zeroing down the substructure. There is a huge amount of user code out there over the last 10 years that did not always have the minimal examples to follow, some of it does some unexpected things. If it is PLAT_FREERTOS, that is a newer thing in lws and users have the benefit of being able to follow the minimal examples' approach. For PLAT_FREERTOS we don't reserve the fakewsi in the pt any more, saving around 800 bytes. The helpers then create a struct lws_a (the substructure) on the stack, zero it down (but it is only like 4 pointers) and prepare it with whatever we know like the context. Then we cast it to a struct lws * and use it in the user protocol handler call. In this case, the remainder of the struct lws is undefined. However the amount of old protocol handlers that might touch things outside of the substructure in PLAT_FREERTOS is very limited compared to legacy lws user code and the saving is significant on constrained devices. User handlers should not be touching everything in a wsi every time anyway, there are several cases where there is no valid wsi to do the call with. Dereference of things outside the substructure should only happen when the callback reason shows there is a valid wsi bound to the activity (as in all the minimal examples).
2020-07-19 08:33:46 +01:00
pt = &wsi->a.context->pt[(int)wsi->tsi];
ptpr = pt_to_priv_event(pt);
if (wsi->role_ops->file_handle)
fd = wsi->desc.filefd;
else
fd = wsi->desc.sockfd;
w->w_read.watcher = event_new(ptpr->io_loop, fd, (EV_READ | EV_PERSIST),
lws_event_cb, &w->w_read);
w->w_write.watcher = event_new(ptpr->io_loop, fd,
(EV_WRITE | EV_PERSIST),
lws_event_cb, &w->w_write);
elops_io_event(wsi, LWS_EV_START | LWS_EV_READ);
return 0;
}
static int
elops_destroy_context2_event(struct lws_context *context)
{
struct lws_context_per_thread *pt;
struct lws_pt_eventlibs_libevent *ptpr;
int n, m;
2019-03-21 09:27:45 +08:00
lwsl_debug("%s: in\n", __func__);
for (n = 0; n < context->count_threads; n++) {
int budget = 1000;
pt = &context->pt[n];
ptpr = pt_to_priv_event(pt);
/* only for internal loops... */
if (pt->event_loop_foreign || !ptpr->io_loop)
continue;
if (!context->finalize_destroy_after_internal_loops_stopped) {
event_base_loopexit(ptpr->io_loop, NULL);
continue;
}
while (budget-- &&
(m = event_base_loop(ptpr->io_loop, EVLOOP_NONBLOCK)))
;
#if 0
if (m) {
lwsl_err("%s: tsi %d: NOT everything closed\n",
__func__, n);
event_base_dump_events(ptpr->io_loop, stderr);
} else
lwsl_debug("%s: %d: everything closed OK\n", __func__, n);
#endif
2020-03-10 19:13:43 +00:00
lwsl_err("%s: event_base_free\n", __func__);
event_base_free(ptpr->io_loop);
ptpr->io_loop = NULL;
}
2019-03-21 09:27:45 +08:00
lwsl_debug("%s: out\n", __func__);
return 0;
}
static const struct lws_event_loop_ops event_loop_ops_event = {
/* name */ "libevent",
/* init_context */ elops_init_context_event,
/* destroy_context1 */ NULL,
/* destroy_context2 */ elops_destroy_context2_event,
/* init_vhost_listen_wsi */ elops_init_vhost_listen_wsi_event,
/* init_pt */ elops_init_pt_event,
/* wsi_logical_close */ elops_wsi_logical_close_event,
/* check_client_connect_ok */ NULL,
/* close_handle_manually */ NULL,
/* accept */ elops_accept_event,
/* io */ elops_io_event,
/* run_pt */ elops_run_pt_event,
/* destroy_pt */ elops_destroy_pt_event,
/* destroy wsi */ elops_destroy_wsi_event,
/* flags */ 0,
/* evlib_size_ctx */ 0,
/* evlib_size_pt */ sizeof(struct lws_pt_eventlibs_libevent),
/* evlib_size_vh */ 0,
/* evlib_size_wsi */ sizeof(struct lws_wsi_eventlibs_libevent),
};
#if defined(LWS_WITH_EVLIB_PLUGINS)
LWS_VISIBLE
#endif
const lws_plugin_evlib_t evlib_event = {
.hdr = {
"libevent event loop",
"lws_evlib_plugin",
LWS_PLUGIN_API_MAGIC
},
.ops = &event_loop_ops_event
};