2 Unix SMB/CIFS implementation.
4 Main select loop and event handling - Solaris port implementation.
5 Losely based on the Linux epoll backend.
7 Copyright (C) Jeremy Allison 2013
9 ** NOTE! The following LGPL license applies to the tevent
10 ** library. This does NOT imply that all of Samba is released
13 This library is free software; you can redistribute it and/or
14 modify it under the terms of the GNU Lesser General Public
15 License as published by the Free Software Foundation; either
16 version 3 of the License, or (at your option) any later version.
18 This library is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public
24 License along with this library; if not, see <http://www.gnu.org/licenses/>.
28 #include "system/filesys.h"
29 #include "system/select.h"
31 #include "tevent_internal.h"
32 #include "tevent_util.h"
34 struct port_associate_vals {
35 struct port_associate_vals *prev, *next;
36 struct port_event_context *port_ev;
38 struct tevent_fd *fde;
39 bool associated_event;
42 struct port_event_context {
43 /* a pointer back to the generic event_context */
44 struct tevent_context *ev;
46 /* This is the handle from port_create */
51 /* List of associations. */
52 struct port_associate_vals *po_vals;
55 #define PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION (1<<0)
56 #define PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR (1<<1)
57 #define PORT_ADDITIONAL_FD_FLAG_GOT_ERROR (1<<2)
58 #define PORT_ADDITIONAL_FD_FLAG_HAS_MPX (1<<3)
61 Map from TEVENT_FD_* to POLLIN/POLLOUT
63 static int port_map_flags(uint16_t flags)
66 if (flags & TEVENT_FD_READ) ret |= (POLLIN | POLLERR | POLLHUP);
67 if (flags & TEVENT_FD_WRITE) ret |= (POLLOUT | POLLERR | POLLHUP);
74 static int port_ctx_destructor(struct port_event_context *port_ev)
76 close(port_ev->port_fd);
77 port_ev->port_fd = -1;
84 static int port_init_ctx(struct port_event_context *port_ev)
86 port_ev->port_fd = port_create();
87 if (port_ev->port_fd == -1) {
88 tevent_debug(port_ev->ev, TEVENT_DEBUG_FATAL,
89 "Failed to create port handle.\n");
93 if (!ev_set_close_on_exec(port_ev->port_fd)) {
94 tevent_debug(port_ev->ev, TEVENT_DEBUG_WARNING,
95 "Failed to set close-on-exec, file descriptor may be leaked to children.\n");
98 port_ev->pid = getpid();
99 talloc_set_destructor(port_ev, port_ctx_destructor);
105 Functions to manage the lower level cache of associated events on the port_fd.
108 static int port_associate_vals_destructor(struct port_associate_vals *val)
110 DLIST_REMOVE(val->port_ev->po_vals, val);
111 memset(val, '\0', sizeof(struct port_associate_vals));
116 * TODO: As the port_association is per-fde, it should be possible to store it
117 * directly in fde->additional_data, alongside any multiplexed-fde. That way the
118 * lookup on store and delete would be avoided, and associate_all_events() could
119 * walk the ev->fd_events list.
121 static bool store_port_association(struct port_event_context *port_ev,
122 struct tevent_fd *fde,
125 struct port_associate_vals *val;
127 for (val = port_ev->po_vals; val; val = val->next) {
128 if (val->fde->fd == fde->fd) {
129 /* Association already attached to fd. */
130 if (val->events != events) {
131 val->events = events;
132 val->associated_event = false;
138 val = talloc_zero(port_ev, struct port_associate_vals);
143 val->port_ev = port_ev;
145 val->events = events;
146 val->associated_event = false;
148 DLIST_ADD(port_ev->po_vals, val);
149 talloc_set_destructor(val, port_associate_vals_destructor);
154 static void delete_port_association(struct port_event_context *port_ev,
155 struct tevent_fd *fde)
157 struct port_associate_vals *val;
159 for (val = port_ev->po_vals; val; val = val->next) {
160 if (val->fde == fde) {
161 if (val->associated_event) {
162 (void)port_dissociate(port_ev->port_fd,
172 static int associate_all_events(struct port_event_context *port_ev)
174 struct port_associate_vals *val;
176 for (val = port_ev->po_vals; val; val = val->next) {
178 if (val->associated_event) {
181 ret = port_associate(port_ev->port_fd,
183 (uintptr_t)val->fde->fd,
189 val->associated_event = true;
194 static int port_update_event(struct port_event_context *port_ev, struct tevent_fd *fde);
197 Reopen the port handle when our pid changes.
199 static int port_check_reopen(struct port_event_context *port_ev)
201 struct tevent_fd *fde;
203 if (port_ev->pid == getpid()) {
207 close(port_ev->port_fd);
208 port_ev->port_fd = port_create();
209 if (port_ev->port_fd == -1) {
210 tevent_debug(port_ev->ev, TEVENT_DEBUG_FATAL,
211 "port_create() failed");
215 if (!ev_set_close_on_exec(port_ev->port_fd)) {
216 tevent_debug(port_ev->ev, TEVENT_DEBUG_WARNING,
217 "Failed to set close-on-exec, file descriptor may be leaked to children.\n");
220 port_ev->pid = getpid();
221 for (fde=port_ev->ev->fd_events;fde;fde=fde->next) {
222 fde->additional_flags &= PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
223 if (port_update_event(port_ev, fde) != 0) {
231 * Solaris ports cannot add the same file descriptor twice, once
232 * with read, once with write which is allowed by the tevent backend.
233 * Multiplex the existing fde, flag it as such so we can search for the
234 * correct fde on event triggering.
237 static void port_setup_multiplex_fd(struct port_event_context *port_ev,
238 struct tevent_fd *add_fde,
239 struct tevent_fd *mpx_fde)
242 * Make each fde->additional_data pointers point at each other
243 * so we can look them up from each other. They are now paired.
245 mpx_fde->additional_data = add_fde;
246 add_fde->additional_data = mpx_fde;
248 /* Now flag both fde's as being multiplexed. */
249 mpx_fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_HAS_MPX;
250 add_fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_HAS_MPX;
252 /* We need to keep the GOT_ERROR flag. */
253 if (mpx_fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_GOT_ERROR) {
254 add_fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_GOT_ERROR;
259 Add the port event to the given fd_event,
260 Or modify an existing event.
263 static int port_add_event(struct port_event_context *port_ev, struct tevent_fd *fde)
265 int flags = port_map_flags(fde->flags);
266 struct tevent_fd *mpx_fde = NULL;
268 fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
269 fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR;
271 if (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_MPX) {
273 * This is already a multiplexed fde, we need to include both
274 * flags in the modified event.
276 mpx_fde = talloc_get_type_abort(fde->additional_data,
279 mpx_fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
280 mpx_fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR;
282 flags |= port_map_flags(mpx_fde->flags);
285 * Not (yet) a multiplexed event. See if there
286 * is already an event with the same fd.
288 for (mpx_fde = port_ev->ev->fd_events; mpx_fde; mpx_fde = mpx_fde->next) {
289 if (mpx_fde->fd != fde->fd) {
292 if (mpx_fde == fde) {
299 if (mpx_fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_MPX) {
300 /* Logic error. Can't have more then 2 multiplexed fde's. */
301 tevent_debug(port_ev->ev, TEVENT_DEBUG_FATAL,
302 "multiplex fde for fd[%d] is already multiplexed\n",
306 flags |= port_map_flags(mpx_fde->flags);
310 if (!store_port_association(port_ev,
313 tevent_debug(port_ev->ev, TEVENT_DEBUG_FATAL,
314 "store_port_association failed for fd[%d]\n",
319 /* Note we have an association now. */
320 fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
321 /* Only if we want to read do we tell the event handler about errors. */
322 if (fde->flags & TEVENT_FD_READ) {
323 fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR;
325 if (mpx_fde == NULL) {
328 /* Set up the multiplex pointer. Does no harm if already multiplexed. */
329 port_setup_multiplex_fd(port_ev,
333 mpx_fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
334 /* Only if we want to read do we tell the event handler about errors. */
335 if (mpx_fde->flags & TEVENT_FD_READ) {
336 mpx_fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR;
343 Delete the port association for the given fd_event.
346 static void port_del_event(struct port_event_context *port_ev, struct tevent_fd *fde)
348 struct tevent_fd *mpx_fde = NULL;
350 fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
351 fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR;
353 if (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_MPX) {
355 * This is a multiplexed fde, we need to remove
358 mpx_fde = talloc_get_type_abort(fde->additional_data,
361 mpx_fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
362 mpx_fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR;
363 mpx_fde->additional_data = NULL;
365 fde->additional_data = NULL;
367 delete_port_association(port_ev, fde);
371 Add or remove the port event from the given fd_event
373 static int port_update_event(struct port_event_context *port_ev, struct tevent_fd *fde)
375 bool got_error = (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_GOT_ERROR);
376 bool want_read = (fde->flags & TEVENT_FD_READ);
377 bool want_write = (fde->flags & TEVENT_FD_WRITE);
378 struct tevent_fd *mpx_fde = NULL;
380 if (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_MPX) {
382 * work out what the multiplexed fde wants.
384 mpx_fde = talloc_get_type_abort(fde->additional_data,
386 if (mpx_fde->flags & TEVENT_FD_READ) {
389 if (mpx_fde->flags & TEVENT_FD_WRITE) {
394 if (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION) {
395 /* There's already an association. */
396 if (want_read || (want_write && !got_error)) {
397 return port_add_event(port_ev, fde);
400 * If we want to match the select behavior, we need to remove the port event
401 * when the caller isn't interested in events.
403 port_del_event(port_ev, fde);
407 /* There's no port event attached to the fde. */
408 if (want_read || (want_write && !got_error)) {
409 return port_add_event(port_ev, fde);
415 Cope with port_get returning EPOLLHP|EPOLLERR on an association.
416 Return true if there's nothing else to do, false if this event
417 needs further handling.
420 static bool port_handle_hup_or_err(struct port_event_context *port_ev,
421 struct tevent_fd *fde)
427 fde->additional_flags |= PORT_ADDITIONAL_FD_FLAG_GOT_ERROR;
429 * If we only wait for TEVENT_FD_WRITE, we should not tell the
430 * event handler about it, and remove the port association,
431 * as we only report error when waiting for read events,
432 * to match the select() behavior.
434 if (!(fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_REPORT_ERROR)) {
436 * Do the same as the poll backend and
437 * remove the writable flag.
439 fde->flags &= ~TEVENT_FD_WRITE;
442 /* This has TEVENT_FD_READ set, we're not finished. */
447 Event loop handling using Solaris ports.
449 static int port_event_loop(struct port_event_context *port_ev, struct timeval *tvalp)
453 port_event_t events[MAXEVENTS];
455 uint_t max_events = MAXEVENTS;
459 struct tevent_context *ev = port_ev->ev;
462 ts.tv_sec = tvalp->tv_sec;
463 ts.tv_nsec = tvalp->tv_usec * 1000;
466 if (port_ev->ev->signal_events &&
467 tevent_common_check_signal(ev)) {
472 * Solaris triggers sending the event to the port
473 * at the time the port association is done. Postpone
474 * associating fd's until just before we get the events,
475 * otherwise we can deadlock.
478 if (associate_all_events(port_ev) != 0) {
482 tevent_trace_point_callback(ev, TEVENT_TRACE_BEFORE_WAIT);
483 ret = port_getn(port_ev->port_fd, events, max_events, &nget, &ts);
485 tevent_trace_point_callback(ev, TEVENT_TRACE_AFTER_WAIT);
487 if (ret == -1 && port_errno == EINTR) {
488 if (ev->signal_events) {
489 tevent_common_check_signal(ev);
492 * If no signal handlers we got an unsolicited
493 * signal wakeup. This can happen with epoll
494 * too. Just return and ignore.
499 if (ret == -1 && port_errno == ETIME) {
501 * If errno is set to ETIME it is possible that we still got an event.
502 * In that case we need to go through the processing loop so that we
503 * reassociate the received event with the port or the association will
504 * be lost so check the value of nget is 0 before returning.
507 /* we don't care about a possible delay here */
508 tevent_common_loop_timer_delay(ev);
512 * Set the return value to 0 since we do not actually have an error and we
513 * do have events that need to be processed. This keeps us from getting
514 * caught in the generic error test.
520 tevent_debug(ev, TEVENT_DEBUG_ERROR,
521 "port_get failed (%s)\n",
526 for (i = 0; i < nget; i++) {
527 struct tevent_fd *mpx_fde = NULL;
528 struct tevent_fd *fde = NULL;
530 struct port_associate_vals *val = talloc_get_type(events[i].portev_user,
531 struct port_associate_vals);
533 tevent_debug(ev, TEVENT_DEBUG_ERROR,
534 "port_getn() gave bad data");
538 /* Mark this event as needing to be re-associated. */
539 val->associated_event = false;
543 if (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_MPX) {
545 * Save off the multiplexed event in case we need
546 * to use it to call the handler function.
548 mpx_fde = talloc_get_type_abort(fde->additional_data,
552 if (events[i].portev_events & (POLLHUP|POLLERR)) {
553 bool handled_fde = port_handle_hup_or_err(port_ev, fde);
554 bool handled_mpx = port_handle_hup_or_err(port_ev, mpx_fde);
556 if (handled_fde && handled_mpx) {
557 return port_update_event(port_ev, fde);
562 * If the mpx event was the one that needs
563 * further handling, it's the TEVENT_FD_READ
564 * event so switch over and call that handler.
569 flags |= TEVENT_FD_READ;
572 if (events[i].portev_events & POLLIN) {
573 flags |= TEVENT_FD_READ;
575 if (events[i].portev_events & POLLOUT) {
576 flags |= TEVENT_FD_WRITE;
579 if (flags & TEVENT_FD_WRITE) {
580 if (fde->flags & TEVENT_FD_WRITE) {
583 if (mpx_fde && (mpx_fde->flags & TEVENT_FD_WRITE)) {
589 /* Ensure we got the right fde. */
590 if ((flags & fde->flags) == 0) {
598 * Make sure we only pass the flags
599 * the handler is expecting.
603 return tevent_common_invoke_fd_handler(fde, flags, NULL);
612 create a port_event_context structure.
614 static int port_event_context_init(struct tevent_context *ev)
617 struct port_event_context *port_ev;
620 * We might be called during tevent_re_initialise()
621 * which means we need to free our old additional_data.
623 TALLOC_FREE(ev->additional_data);
625 port_ev = talloc_zero(ev, struct port_event_context);
630 port_ev->port_fd = -1;
631 port_ev->pid = (pid_t)-1;
633 ret = port_init_ctx(port_ev);
635 talloc_free(port_ev);
639 ev->additional_data = port_ev;
646 static int port_event_fd_destructor(struct tevent_fd *fde)
648 struct tevent_context *ev = fde->event_ctx;
649 struct port_event_context *port_ev = NULL;
650 struct tevent_fd *mpx_fde = NULL;
651 int flags = (int)fde->flags;
654 return tevent_common_fd_destructor(fde);
657 port_ev = talloc_get_type_abort(ev->additional_data,
658 struct port_event_context);
660 DLIST_REMOVE(ev->fd_events, fde);
662 if (fde->additional_flags & PORT_ADDITIONAL_FD_FLAG_HAS_MPX) {
663 mpx_fde = talloc_get_type_abort(fde->additional_data,
666 fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_HAS_MPX;
667 mpx_fde->additional_flags &= ~PORT_ADDITIONAL_FD_FLAG_HAS_MPX;
669 fde->additional_data = NULL;
670 mpx_fde->additional_data = NULL;
672 fde->additional_flags &= PORT_ADDITIONAL_FD_FLAG_HAS_ASSOCIATION;
675 (void)port_check_reopen(port_ev);
677 if (mpx_fde != NULL) {
678 (void)port_update_event(port_ev, mpx_fde);
682 (void)port_update_event(port_ev, fde);
685 return tevent_common_fd_destructor(fde);
690 return NULL on failure (memory allocation error)
692 static struct tevent_fd *port_event_add_fd(struct tevent_context *ev, TALLOC_CTX *mem_ctx,
693 int fd, uint16_t flags,
694 tevent_fd_handler_t handler,
696 const char *handler_name,
697 const char *location)
699 struct port_event_context *port_ev =
700 talloc_get_type_abort(ev->additional_data,
701 struct port_event_context);
702 struct tevent_fd *fde;
704 fde = tevent_common_add_fd(ev, mem_ctx, fd, flags,
705 handler, private_data,
706 handler_name, location);
711 talloc_set_destructor(fde, port_event_fd_destructor);
713 if (port_check_reopen(port_ev) != 0) {
718 if (port_update_event(port_ev, fde) != 0) {
727 set the fd event flags
729 static void port_event_set_fd_flags(struct tevent_fd *fde, uint16_t flags)
731 struct tevent_context *ev;
732 struct port_event_context *port_ev;
734 if (fde->flags == flags) {
739 port_ev = talloc_get_type_abort(ev->additional_data,
740 struct port_event_context);
744 (void)port_check_reopen(port_ev);
745 (void)port_update_event(port_ev, fde);
749 do a single event loop using the events defined in ev
751 static int port_event_loop_once(struct tevent_context *ev, const char *location)
753 struct port_event_context *port_ev = talloc_get_type(ev->additional_data,
754 struct port_event_context);
757 if (ev->signal_events &&
758 tevent_common_check_signal(ev)) {
762 if (ev->threaded_contexts != NULL) {
763 tevent_common_threaded_activate_immediate(ev);
766 if (ev->immediate_events &&
767 tevent_common_loop_immediate(ev)) {
771 tval = tevent_common_loop_timer_delay(ev);
772 if (tevent_timeval_is_zero(&tval)) {
776 if (port_check_reopen(port_ev) != 0) {
780 return port_event_loop(port_ev, &tval);
783 static const struct tevent_ops port_event_ops = {
784 .context_init = port_event_context_init,
785 .add_fd = port_event_add_fd,
786 .set_fd_close_fn = tevent_common_fd_set_close_fn,
787 .get_fd_flags = tevent_common_fd_get_flags,
788 .set_fd_flags = port_event_set_fd_flags,
789 .add_timer = tevent_common_add_timer_v2,
790 .schedule_immediate = tevent_common_schedule_immediate,
791 .add_signal = tevent_common_add_signal,
792 .loop_once = port_event_loop_once,
793 .loop_wait = tevent_common_loop_wait,
796 _PRIVATE_ bool tevent_port_init(void)
798 if (!tevent_register_backend("port", &port_event_ops)) {
801 tevent_set_default_backend("port");