/* * * Copyright 2016 gRPC authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ #include #include #include "src/core/lib/iomgr/port.h" #ifdef GRPC_POSIX_SOCKET_EV_POLL #include #include #include #include #include #include #include #include #include "absl/strings/str_cat.h" #include #include #include "src/core/lib/debug/stats.h" #include "src/core/lib/debug/stats_data.h" #include "src/core/lib/gpr/useful.h" #include "src/core/lib/gprpp/thd.h" #include "src/core/lib/iomgr/block_annotate.h" #include "src/core/lib/iomgr/ev_poll_posix.h" #include "src/core/lib/iomgr/iomgr_internal.h" #include "src/core/lib/iomgr/wakeup_fd_posix.h" #define GRPC_POLLSET_KICK_BROADCAST ((grpc_pollset_worker*)1) /******************************************************************************* * FD declarations */ typedef struct grpc_fd_watcher { struct grpc_fd_watcher* next; struct grpc_fd_watcher* prev; grpc_pollset* pollset; grpc_pollset_worker* worker; grpc_fd* fd; } grpc_fd_watcher; typedef struct grpc_cached_wakeup_fd grpc_cached_wakeup_fd; /* Only used when GRPC_ENABLE_FORK_SUPPORT=1 */ struct grpc_fork_fd_list { /* Only one of fd or cached_wakeup_fd will be set. The unused field will be set to nullptr. */ grpc_fd* fd; grpc_cached_wakeup_fd* cached_wakeup_fd; grpc_fork_fd_list* next; grpc_fork_fd_list* prev; }; struct grpc_fd { int fd; /* refst format: bit0: 1=active/0=orphaned bit1-n: refcount meaning that mostly we ref by two to avoid altering the orphaned bit, and just unref by 1 when we're ready to flag the object as orphaned */ gpr_atm refst; gpr_mu mu; int shutdown; int closed; int released; gpr_atm pollhup; grpc_error_handle shutdown_error; /* The watcher list. The following watcher related fields are protected by watcher_mu. An fd_watcher is an ephemeral object created when an fd wants to begin polling, and destroyed after the poll. It denotes the fd's interest in whether to read poll or write poll or both or neither on this fd. If a watcher is asked to poll for reads or writes, the read_watcher or write_watcher fields are set respectively. A watcher may be asked to poll for both, in which case both fields will be set. read_watcher and write_watcher may be NULL if no watcher has been asked to poll for reads or writes. If an fd_watcher is not asked to poll for reads or writes, it's added to a linked list of inactive watchers, rooted at inactive_watcher_root. If at a later time there becomes need of a poller to poll, one of the inactive pollers may be kicked out of their poll loops to take that responsibility. */ grpc_fd_watcher inactive_watcher_root; grpc_fd_watcher* read_watcher; grpc_fd_watcher* write_watcher; grpc_closure* read_closure; grpc_closure* write_closure; grpc_closure* on_done_closure; grpc_iomgr_object iomgr_object; /* Only used when GRPC_ENABLE_FORK_SUPPORT=1 */ grpc_fork_fd_list* fork_fd_list; }; /* True when GRPC_ENABLE_FORK_SUPPORT=1. */ static bool track_fds_for_fork = false; /* Only used when GRPC_ENABLE_FORK_SUPPORT=1 */ static grpc_fork_fd_list* fork_fd_list_head = nullptr; static gpr_mu fork_fd_list_mu; /* Begin polling on an fd. Registers that the given pollset is interested in this fd - so that if read or writability interest changes, the pollset can be kicked to pick up that new interest. Return value is: (fd_needs_read? read_mask : 0) | (fd_needs_write? write_mask : 0) i.e. a combination of read_mask and write_mask determined by the fd's current interest in said events. Polling strategies that do not need to alter their behavior depending on the fd's current interest (such as epoll) do not need to call this function. MUST NOT be called with a pollset lock taken */ static uint32_t fd_begin_poll(grpc_fd* fd, grpc_pollset* pollset, grpc_pollset_worker* worker, uint32_t read_mask, uint32_t write_mask, grpc_fd_watcher* watcher); /* Complete polling previously started with fd_begin_poll MUST NOT be called with a pollset lock taken if got_read or got_write are 1, also does the become_{readable,writable} as appropriate. */ static void fd_end_poll(grpc_fd_watcher* watcher, int got_read, int got_write); /* Return 1 if this fd is orphaned, 0 otherwise */ static bool fd_is_orphaned(grpc_fd* fd); #ifndef NDEBUG static void fd_ref(grpc_fd* fd, const char* reason, const char* file, int line); static void fd_unref(grpc_fd* fd, const char* reason, const char* file, int line); #define GRPC_FD_REF(fd, reason) fd_ref(fd, reason, __FILE__, __LINE__) #define GRPC_FD_UNREF(fd, reason) fd_unref(fd, reason, __FILE__, __LINE__) #else static void fd_ref(grpc_fd* fd); static void fd_unref(grpc_fd* fd); #define GRPC_FD_REF(fd, reason) fd_ref(fd) #define GRPC_FD_UNREF(fd, reason) fd_unref(fd) #endif #define CLOSURE_NOT_READY ((grpc_closure*)0) #define CLOSURE_READY ((grpc_closure*)1) /******************************************************************************* * pollset declarations */ typedef struct grpc_cached_wakeup_fd { grpc_wakeup_fd fd; struct grpc_cached_wakeup_fd* next; /* Only used when GRPC_ENABLE_FORK_SUPPORT=1 */ grpc_fork_fd_list* fork_fd_list; } grpc_cached_wakeup_fd; struct grpc_pollset_worker { grpc_cached_wakeup_fd* wakeup_fd; int reevaluate_polling_on_wakeup; int kicked_specifically; struct grpc_pollset_worker* next; struct grpc_pollset_worker* prev; }; struct grpc_pollset { gpr_mu mu; grpc_pollset_worker root_worker; int shutting_down; int called_shutdown; int kicked_without_pollers; grpc_closure* shutdown_done; int pollset_set_count; /* all polled fds */ size_t fd_count; size_t fd_capacity; grpc_fd** fds; /* Local cache of eventfds for workers */ grpc_cached_wakeup_fd* local_wakeup_cache; }; /* Add an fd to a pollset */ static void pollset_add_fd(grpc_pollset* pollset, struct grpc_fd* fd); static void pollset_set_add_fd(grpc_pollset_set* pollset_set, grpc_fd* fd); /* Convert a timespec to milliseconds: - very small or negative poll times are clamped to zero to do a non-blocking poll (which becomes spin polling) - other small values are rounded up to one millisecond - longer than a millisecond polls are rounded up to the next nearest millisecond to avoid spinning - infinite timeouts are converted to -1 */ static int poll_deadline_to_millis_timeout(grpc_core::Timestamp deadline); /* Allow kick to wakeup the currently polling worker */ #define GRPC_POLLSET_CAN_KICK_SELF 1 /* Force the wakee to repoll when awoken */ #define GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP 2 /* As per pollset_kick, with an extended set of flags (defined above) -- mostly for fd_posix's use. */ static grpc_error_handle pollset_kick_ext(grpc_pollset* p, grpc_pollset_worker* specific_worker, uint32_t flags) GRPC_MUST_USE_RESULT; /* Return 1 if the pollset has active threads in pollset_work (pollset must * be locked) */ static bool pollset_has_workers(grpc_pollset* pollset); /******************************************************************************* * pollset_set definitions */ struct grpc_pollset_set { gpr_mu mu; size_t pollset_count; size_t pollset_capacity; grpc_pollset** pollsets; size_t pollset_set_count; size_t pollset_set_capacity; struct grpc_pollset_set** pollset_sets; size_t fd_count; size_t fd_capacity; grpc_fd** fds; }; /******************************************************************************* * functions to track opened fds. No-ops unless track_fds_for_fork is true. */ static void fork_fd_list_remove_node(grpc_fork_fd_list* node) { if (track_fds_for_fork) { gpr_mu_lock(&fork_fd_list_mu); if (fork_fd_list_head == node) { fork_fd_list_head = node->next; } if (node->prev != nullptr) { node->prev->next = node->next; } if (node->next != nullptr) { node->next->prev = node->prev; } gpr_free(node); gpr_mu_unlock(&fork_fd_list_mu); } } static void fork_fd_list_add_node(grpc_fork_fd_list* node) { gpr_mu_lock(&fork_fd_list_mu); node->next = fork_fd_list_head; node->prev = nullptr; if (fork_fd_list_head != nullptr) { fork_fd_list_head->prev = node; } fork_fd_list_head = node; gpr_mu_unlock(&fork_fd_list_mu); } static void fork_fd_list_add_grpc_fd(grpc_fd* fd) { if (track_fds_for_fork) { fd->fork_fd_list = static_cast(gpr_malloc(sizeof(grpc_fork_fd_list))); fd->fork_fd_list->fd = fd; fd->fork_fd_list->cached_wakeup_fd = nullptr; fork_fd_list_add_node(fd->fork_fd_list); } } static void fork_fd_list_add_wakeup_fd(grpc_cached_wakeup_fd* fd) { if (track_fds_for_fork) { fd->fork_fd_list = static_cast(gpr_malloc(sizeof(grpc_fork_fd_list))); fd->fork_fd_list->cached_wakeup_fd = fd; fd->fork_fd_list->fd = nullptr; fork_fd_list_add_node(fd->fork_fd_list); } } /******************************************************************************* * fd_posix.c */ #ifndef NDEBUG #define REF_BY(fd, n, reason) ref_by(fd, n, reason, __FILE__, __LINE__) #define UNREF_BY(fd, n, reason) unref_by(fd, n, reason, __FILE__, __LINE__) static void ref_by(grpc_fd* fd, int n, const char* reason, const char* file, int line) { if (GRPC_TRACE_FLAG_ENABLED(grpc_trace_fd_refcount)) { gpr_log(GPR_DEBUG, "FD %d %p ref %d %" PRIdPTR " -> %" PRIdPTR " [%s; %s:%d]", fd->fd, fd, n, gpr_atm_no_barrier_load(&fd->refst), gpr_atm_no_barrier_load(&fd->refst) + n, reason, file, line); } #else #define REF_BY(fd, n, reason) \ do { \ ref_by(fd, n); \ (void)(reason); \ } while (0) #define UNREF_BY(fd, n, reason) \ do { \ unref_by(fd, n); \ (void)(reason); \ } while (0) static void ref_by(grpc_fd* fd, int n) { #endif GPR_ASSERT(gpr_atm_no_barrier_fetch_add(&fd->refst, n) > 0); } #ifndef NDEBUG static void unref_by(grpc_fd* fd, int n, const char* reason, const char* file, int line) { if (GRPC_TRACE_FLAG_ENABLED(grpc_trace_fd_refcount)) { gpr_log(GPR_DEBUG, "FD %d %p unref %d %" PRIdPTR " -> %" PRIdPTR " [%s; %s:%d]", fd->fd, fd, n, gpr_atm_no_barrier_load(&fd->refst), gpr_atm_no_barrier_load(&fd->refst) - n, reason, file, line); } #else static void unref_by(grpc_fd* fd, int n) { #endif gpr_atm old = gpr_atm_full_fetch_add(&fd->refst, -n); if (old == n) { gpr_mu_destroy(&fd->mu); grpc_iomgr_unregister_object(&fd->iomgr_object); fork_fd_list_remove_node(fd->fork_fd_list); if (fd->shutdown) { } fd->shutdown_error.~Status(); gpr_free(fd); } else { GPR_ASSERT(old > n); } } static grpc_fd* fd_create(int fd, const char* name, bool track_err) { // Avoid unused-parameter warning for debug-only parameter (void)track_err; GPR_DEBUG_ASSERT(track_err == false); grpc_fd* r = static_cast(gpr_malloc(sizeof(*r))); gpr_mu_init(&r->mu); gpr_atm_rel_store(&r->refst, 1); r->shutdown = 0; new (&r->shutdown_error) absl::Status(); r->read_closure = CLOSURE_NOT_READY; r->write_closure = CLOSURE_NOT_READY; r->fd = fd; r->inactive_watcher_root.next = r->inactive_watcher_root.prev = &r->inactive_watcher_root; r->read_watcher = r->write_watcher = nullptr; r->on_done_closure = nullptr; r->closed = 0; r->released = 0; gpr_atm_no_barrier_store(&r->pollhup, 0); std::string name2 = absl::StrCat(name, " fd=", fd); grpc_iomgr_register_object(&r->iomgr_object, name2.c_str()); fork_fd_list_add_grpc_fd(r); return r; } static bool fd_is_orphaned(grpc_fd* fd) { return (gpr_atm_acq_load(&fd->refst) & 1) == 0; } static grpc_error_handle pollset_kick_locked(grpc_fd_watcher* watcher) { gpr_mu_lock(&watcher->pollset->mu); GPR_ASSERT(watcher->worker); grpc_error_handle err = pollset_kick_ext(watcher->pollset, watcher->worker, GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP); gpr_mu_unlock(&watcher->pollset->mu); return err; } static void maybe_wake_one_watcher_locked(grpc_fd* fd) { if (fd->inactive_watcher_root.next != &fd->inactive_watcher_root) { (void)pollset_kick_locked(fd->inactive_watcher_root.next); } else if (fd->read_watcher) { (void)pollset_kick_locked(fd->read_watcher); } else if (fd->write_watcher) { (void)pollset_kick_locked(fd->write_watcher); } } static void wake_all_watchers_locked(grpc_fd* fd) { grpc_fd_watcher* watcher; for (watcher = fd->inactive_watcher_root.next; watcher != &fd->inactive_watcher_root; watcher = watcher->next) { (void)pollset_kick_locked(watcher); } if (fd->read_watcher) { (void)pollset_kick_locked(fd->read_watcher); } if (fd->write_watcher && fd->write_watcher != fd->read_watcher) { (void)pollset_kick_locked(fd->write_watcher); } } static int has_watchers(grpc_fd* fd) { return fd->read_watcher != nullptr || fd->write_watcher != nullptr || fd->inactive_watcher_root.next != &fd->inactive_watcher_root; } static void close_fd_locked(grpc_fd* fd) { fd->closed = 1; if (!fd->released) { close(fd->fd); } grpc_core::ExecCtx::Run(DEBUG_LOCATION, fd->on_done_closure, absl::OkStatus()); } static int fd_wrapped_fd(grpc_fd* fd) { if (fd->released || fd->closed) { return -1; } else { return fd->fd; } } static void fd_orphan(grpc_fd* fd, grpc_closure* on_done, int* release_fd, const char* reason) { fd->on_done_closure = on_done; fd->released = release_fd != nullptr; if (release_fd != nullptr) { *release_fd = fd->fd; fd->released = true; } gpr_mu_lock(&fd->mu); REF_BY(fd, 1, reason); /* remove active status, but keep referenced */ if (!has_watchers(fd)) { close_fd_locked(fd); } else { wake_all_watchers_locked(fd); } gpr_mu_unlock(&fd->mu); UNREF_BY(fd, 2, reason); /* drop the reference */ } /* increment refcount by two to avoid changing the orphan bit */ #ifndef NDEBUG static void fd_ref(grpc_fd* fd, const char* reason, const char* file, int line) { ref_by(fd, 2, reason, file, line); } static void fd_unref(grpc_fd* fd, const char* reason, const char* file, int line) { unref_by(fd, 2, reason, file, line); } #else static void fd_ref(grpc_fd* fd) { ref_by(fd, 2); } static void fd_unref(grpc_fd* fd) { unref_by(fd, 2); } #endif static grpc_error_handle fd_shutdown_error(grpc_fd* fd) { if (!fd->shutdown) { return absl::OkStatus(); } else { return grpc_error_set_int( GRPC_ERROR_CREATE_REFERENCING("FD shutdown", &fd->shutdown_error, 1), grpc_core::StatusIntProperty::kRpcStatus, GRPC_STATUS_UNAVAILABLE); } } static void notify_on_locked(grpc_fd* fd, grpc_closure** st, grpc_closure* closure) { if (fd->shutdown || gpr_atm_no_barrier_load(&fd->pollhup)) { grpc_core::ExecCtx::Run( DEBUG_LOCATION, closure, grpc_error_set_int(GRPC_ERROR_CREATE("FD shutdown"), grpc_core::StatusIntProperty::kRpcStatus, GRPC_STATUS_UNAVAILABLE)); } else if (*st == CLOSURE_NOT_READY) { /* not ready ==> switch to a waiting state by setting the closure */ *st = closure; } else if (*st == CLOSURE_READY) { /* already ready ==> queue the closure to run immediately */ *st = CLOSURE_NOT_READY; grpc_core::ExecCtx::Run(DEBUG_LOCATION, closure, fd_shutdown_error(fd)); maybe_wake_one_watcher_locked(fd); } else { /* upcallptr was set to a different closure. This is an error! */ gpr_log(GPR_ERROR, "User called a notify_on function with a previous callback still " "pending"); abort(); } } /* returns 1 if state becomes not ready */ static int set_ready_locked(grpc_fd* fd, grpc_closure** st) { if (*st == CLOSURE_READY) { /* duplicate ready ==> ignore */ return 0; } else if (*st == CLOSURE_NOT_READY) { /* not ready, and not waiting ==> flag ready */ *st = CLOSURE_READY; return 0; } else { /* waiting ==> queue closure */ grpc_core::ExecCtx::Run(DEBUG_LOCATION, *st, fd_shutdown_error(fd)); *st = CLOSURE_NOT_READY; return 1; } } static void fd_shutdown(grpc_fd* fd, grpc_error_handle why) { gpr_mu_lock(&fd->mu); /* only shutdown once */ if (!fd->shutdown) { fd->shutdown = 1; fd->shutdown_error = why; /* signal read/write closed to OS so that future operations fail */ shutdown(fd->fd, SHUT_RDWR); set_ready_locked(fd, &fd->read_closure); set_ready_locked(fd, &fd->write_closure); } gpr_mu_unlock(&fd->mu); } static bool fd_is_shutdown(grpc_fd* fd) { gpr_mu_lock(&fd->mu); bool r = fd->shutdown; gpr_mu_unlock(&fd->mu); return r; } static void fd_notify_on_read(grpc_fd* fd, grpc_closure* closure) { gpr_mu_lock(&fd->mu); notify_on_locked(fd, &fd->read_closure, closure); gpr_mu_unlock(&fd->mu); } static void fd_notify_on_write(grpc_fd* fd, grpc_closure* closure) { gpr_mu_lock(&fd->mu); notify_on_locked(fd, &fd->write_closure, closure); gpr_mu_unlock(&fd->mu); } static void fd_notify_on_error(grpc_fd* /*fd*/, grpc_closure* closure) { if (GRPC_TRACE_FLAG_ENABLED(grpc_polling_trace)) { gpr_log(GPR_ERROR, "Polling engine does not support tracking errors."); } grpc_core::ExecCtx::Run(DEBUG_LOCATION, closure, absl::CancelledError()); } static void fd_set_readable(grpc_fd* fd) { gpr_mu_lock(&fd->mu); set_ready_locked(fd, &fd->read_closure); gpr_mu_unlock(&fd->mu); } static void fd_set_writable(grpc_fd* fd) { gpr_mu_lock(&fd->mu); set_ready_locked(fd, &fd->write_closure); gpr_mu_unlock(&fd->mu); } static void fd_set_error(grpc_fd* /*fd*/) { if (GRPC_TRACE_FLAG_ENABLED(grpc_polling_trace)) { gpr_log(GPR_ERROR, "Polling engine does not support tracking errors."); } } static uint32_t fd_begin_poll(grpc_fd* fd, grpc_pollset* pollset, grpc_pollset_worker* worker, uint32_t read_mask, uint32_t write_mask, grpc_fd_watcher* watcher) { uint32_t mask = 0; grpc_closure* cur; int requested; /* keep track of pollers that have requested our events, in case they change */ GRPC_FD_REF(fd, "poll"); gpr_mu_lock(&fd->mu); /* if we are shutdown, then don't add to the watcher set */ if (fd->shutdown) { watcher->pollset = nullptr; watcher->worker = nullptr; gpr_mu_unlock(&fd->mu); GRPC_FD_UNREF(fd, "poll"); return 0; } /* if there is nobody polling for read, but we need to, then start doing so */ cur = fd->read_closure; requested = cur != CLOSURE_READY; if (read_mask && fd->read_watcher == nullptr && requested) { fd->read_watcher = watcher; mask |= read_mask; } /* if there is nobody polling for write, but we need to, then start doing so */ cur = fd->write_closure; requested = cur != CLOSURE_READY; if (write_mask && fd->write_watcher == nullptr && requested) { fd->write_watcher = watcher; mask |= write_mask; } /* if not polling, remember this watcher in case we need someone to later */ if (mask == 0 && worker != nullptr) { watcher->next = &fd->inactive_watcher_root; watcher->prev = watcher->next->prev; watcher->next->prev = watcher->prev->next = watcher; } watcher->pollset = pollset; watcher->worker = worker; watcher->fd = fd; gpr_mu_unlock(&fd->mu); return mask; } static void fd_end_poll(grpc_fd_watcher* watcher, int got_read, int got_write) { int was_polling = 0; int kick = 0; grpc_fd* fd = watcher->fd; if (fd == nullptr) { return; } gpr_mu_lock(&fd->mu); if (watcher->pollset == nullptr) { watcher->fd = nullptr; gpr_mu_unlock(&fd->mu); GRPC_FD_UNREF(fd, "multipoller_start"); return; } if (watcher == fd->read_watcher) { /* remove read watcher, kick if we still need a read */ was_polling = 1; if (!got_read) { kick = 1; } fd->read_watcher = nullptr; } if (watcher == fd->write_watcher) { /* remove write watcher, kick if we still need a write */ was_polling = 1; if (!got_write) { kick = 1; } fd->write_watcher = nullptr; } if (!was_polling && watcher->worker != nullptr) { /* remove from inactive list */ watcher->next->prev = watcher->prev; watcher->prev->next = watcher->next; } if (got_read) { if (set_ready_locked(fd, &fd->read_closure)) { kick = 1; } } if (got_write) { if (set_ready_locked(fd, &fd->write_closure)) { kick = 1; } } if (kick) { maybe_wake_one_watcher_locked(fd); } if (fd_is_orphaned(fd) && !has_watchers(fd) && !fd->closed) { close_fd_locked(fd); } gpr_mu_unlock(&fd->mu); GRPC_FD_UNREF(fd, "poll"); } /******************************************************************************* * pollset_posix.c */ static thread_local grpc_pollset* g_current_thread_poller; static thread_local grpc_pollset_worker* g_current_thread_worker; static void remove_worker(grpc_pollset* /*p*/, grpc_pollset_worker* worker) { worker->prev->next = worker->next; worker->next->prev = worker->prev; } static bool pollset_has_workers(grpc_pollset* p) { return p->root_worker.next != &p->root_worker; } static bool pollset_in_pollset_sets(grpc_pollset* p) { return p->pollset_set_count; } static bool pollset_has_observers(grpc_pollset* p) { return pollset_has_workers(p) || pollset_in_pollset_sets(p); } static grpc_pollset_worker* pop_front_worker(grpc_pollset* p) { if (pollset_has_workers(p)) { grpc_pollset_worker* w = p->root_worker.next; remove_worker(p, w); return w; } else { return nullptr; } } static void push_back_worker(grpc_pollset* p, grpc_pollset_worker* worker) { worker->next = &p->root_worker; worker->prev = worker->next->prev; worker->prev->next = worker->next->prev = worker; } static void push_front_worker(grpc_pollset* p, grpc_pollset_worker* worker) { worker->prev = &p->root_worker; worker->next = worker->prev->next; worker->prev->next = worker->next->prev = worker; } static void kick_append_error(grpc_error_handle* composite, grpc_error_handle error) { if (error.ok()) return; if (composite->ok()) { *composite = GRPC_ERROR_CREATE("Kick Failure"); } *composite = grpc_error_add_child(*composite, error); } static grpc_error_handle pollset_kick_ext(grpc_pollset* p, grpc_pollset_worker* specific_worker, uint32_t flags) { grpc_error_handle error; /* pollset->mu already held */ if (specific_worker != nullptr) { if (specific_worker == GRPC_POLLSET_KICK_BROADCAST) { GPR_ASSERT((flags & GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP) == 0); for (specific_worker = p->root_worker.next; specific_worker != &p->root_worker; specific_worker = specific_worker->next) { kick_append_error( &error, grpc_wakeup_fd_wakeup(&specific_worker->wakeup_fd->fd)); } p->kicked_without_pollers = true; } else if (g_current_thread_worker != specific_worker) { if ((flags & GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP) != 0) { specific_worker->reevaluate_polling_on_wakeup = true; } specific_worker->kicked_specifically = true; kick_append_error(&error, grpc_wakeup_fd_wakeup(&specific_worker->wakeup_fd->fd)); } else if ((flags & GRPC_POLLSET_CAN_KICK_SELF) != 0) { if ((flags & GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP) != 0) { specific_worker->reevaluate_polling_on_wakeup = true; } specific_worker->kicked_specifically = true; kick_append_error(&error, grpc_wakeup_fd_wakeup(&specific_worker->wakeup_fd->fd)); } } else if (g_current_thread_poller != p) { GPR_ASSERT((flags & GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP) == 0); specific_worker = pop_front_worker(p); if (specific_worker != nullptr) { if (g_current_thread_worker == specific_worker) { push_back_worker(p, specific_worker); specific_worker = pop_front_worker(p); if ((flags & GRPC_POLLSET_CAN_KICK_SELF) == 0 && g_current_thread_worker == specific_worker) { push_back_worker(p, specific_worker); specific_worker = nullptr; } } if (specific_worker != nullptr) { push_back_worker(p, specific_worker); kick_append_error( &error, grpc_wakeup_fd_wakeup(&specific_worker->wakeup_fd->fd)); } } else { p->kicked_without_pollers = true; } } GRPC_LOG_IF_ERROR("pollset_kick_ext", error); return error; } static grpc_error_handle pollset_kick(grpc_pollset* p, grpc_pollset_worker* specific_worker) { return pollset_kick_ext(p, specific_worker, 0); } /* global state management */ static grpc_error_handle pollset_global_init(void) { return absl::OkStatus(); } /* main interface */ static void pollset_init(grpc_pollset* pollset, gpr_mu** mu) { gpr_mu_init(&pollset->mu); *mu = &pollset->mu; pollset->root_worker.next = pollset->root_worker.prev = &pollset->root_worker; pollset->shutting_down = 0; pollset->called_shutdown = 0; pollset->kicked_without_pollers = 0; pollset->local_wakeup_cache = nullptr; pollset->kicked_without_pollers = 0; pollset->fd_count = 0; pollset->fd_capacity = 0; pollset->fds = nullptr; pollset->pollset_set_count = 0; } static void pollset_destroy(grpc_pollset* pollset) { GPR_ASSERT(!pollset_has_workers(pollset)); while (pollset->local_wakeup_cache) { grpc_cached_wakeup_fd* next = pollset->local_wakeup_cache->next; fork_fd_list_remove_node(pollset->local_wakeup_cache->fork_fd_list); grpc_wakeup_fd_destroy(&pollset->local_wakeup_cache->fd); gpr_free(pollset->local_wakeup_cache); pollset->local_wakeup_cache = next; } gpr_free(pollset->fds); gpr_mu_destroy(&pollset->mu); } static void pollset_add_fd(grpc_pollset* pollset, grpc_fd* fd) { gpr_mu_lock(&pollset->mu); size_t i; /* TODO(ctiller): this is O(num_fds^2); maybe switch to a hash set here */ for (i = 0; i < pollset->fd_count; i++) { if (pollset->fds[i] == fd) goto exit; } if (pollset->fd_count == pollset->fd_capacity) { pollset->fd_capacity = std::max(pollset->fd_capacity + 8, pollset->fd_count * 3 / 2); pollset->fds = static_cast( gpr_realloc(pollset->fds, sizeof(grpc_fd*) * pollset->fd_capacity)); } pollset->fds[pollset->fd_count++] = fd; GRPC_FD_REF(fd, "multipoller"); (void)pollset_kick(pollset, nullptr); exit: gpr_mu_unlock(&pollset->mu); } static void finish_shutdown(grpc_pollset* pollset) { size_t i; for (i = 0; i < pollset->fd_count; i++) { GRPC_FD_UNREF(pollset->fds[i], "multipoller"); } pollset->fd_count = 0; grpc_core::ExecCtx::Run(DEBUG_LOCATION, pollset->shutdown_done, absl::OkStatus()); } static void work_combine_error(grpc_error_handle* composite, grpc_error_handle error) { if (error.ok()) return; if (composite->ok()) { *composite = GRPC_ERROR_CREATE("pollset_work"); } *composite = grpc_error_add_child(*composite, error); } static grpc_error_handle pollset_work(grpc_pollset* pollset, grpc_pollset_worker** worker_hdl, grpc_core::Timestamp deadline) { grpc_pollset_worker worker; if (worker_hdl) *worker_hdl = &worker; grpc_error_handle error; /* Avoid malloc for small number of elements. */ enum { inline_elements = 96 }; struct pollfd pollfd_space[inline_elements]; struct grpc_fd_watcher watcher_space[inline_elements]; /* pollset->mu already held */ int added_worker = 0; int locked = 1; int queued_work = 0; int keep_polling = 0; /* this must happen before we (potentially) drop pollset->mu */ worker.next = worker.prev = nullptr; worker.reevaluate_polling_on_wakeup = 0; if (pollset->local_wakeup_cache != nullptr) { worker.wakeup_fd = pollset->local_wakeup_cache; pollset->local_wakeup_cache = worker.wakeup_fd->next; } else { worker.wakeup_fd = static_cast( gpr_malloc(sizeof(*worker.wakeup_fd))); error = grpc_wakeup_fd_init(&worker.wakeup_fd->fd); fork_fd_list_add_wakeup_fd(worker.wakeup_fd); if (!error.ok()) { GRPC_LOG_IF_ERROR("pollset_work", error); return error; } } worker.kicked_specifically = 0; /* If we're shutting down then we don't execute any extended work */ if (pollset->shutting_down) { goto done; } /* Start polling, and keep doing so while we're being asked to re-evaluate our pollers (this allows poll() based pollers to ensure they don't miss wakeups) */ keep_polling = 1; g_current_thread_poller = pollset; while (keep_polling) { keep_polling = 0; if (!pollset->kicked_without_pollers || deadline <= grpc_core::Timestamp::Now()) { if (!added_worker) { push_front_worker(pollset, &worker); added_worker = 1; g_current_thread_worker = &worker; } #define POLLOUT_CHECK (POLLOUT | POLLHUP | POLLERR) #define POLLIN_CHECK (POLLIN | POLLHUP | POLLERR) int timeout; int r; size_t i, fd_count; nfds_t pfd_count; grpc_fd_watcher* watchers; struct pollfd* pfds; timeout = poll_deadline_to_millis_timeout(deadline); if (pollset->fd_count + 2 <= inline_elements) { pfds = pollfd_space; watchers = watcher_space; } else { /* Allocate one buffer to hold both pfds and watchers arrays */ const size_t pfd_size = sizeof(*pfds) * (pollset->fd_count + 2); const size_t watch_size = sizeof(*watchers) * (pollset->fd_count + 2); void* buf = gpr_malloc(pfd_size + watch_size); pfds = static_cast(buf); watchers = static_cast( static_cast((static_cast(buf) + pfd_size))); } fd_count = 0; pfd_count = 1; pfds[0].fd = GRPC_WAKEUP_FD_GET_READ_FD(&worker.wakeup_fd->fd); pfds[0].events = POLLIN; pfds[0].revents = 0; for (i = 0; i < pollset->fd_count; i++) { if (fd_is_orphaned(pollset->fds[i]) || gpr_atm_no_barrier_load(&pollset->fds[i]->pollhup) == 1) { GRPC_FD_UNREF(pollset->fds[i], "multipoller"); } else { pollset->fds[fd_count++] = pollset->fds[i]; watchers[pfd_count].fd = pollset->fds[i]; GRPC_FD_REF(watchers[pfd_count].fd, "multipoller_start"); pfds[pfd_count].fd = pollset->fds[i]->fd; pfds[pfd_count].revents = 0; pfd_count++; } } pollset->fd_count = fd_count; gpr_mu_unlock(&pollset->mu); for (i = 1; i < pfd_count; i++) { grpc_fd* fd = watchers[i].fd; pfds[i].events = static_cast( fd_begin_poll(fd, pollset, &worker, POLLIN, POLLOUT, &watchers[i])); if (watchers[i].pollset != nullptr) { GRPC_FD_UNREF(fd, "multipoller_start"); } } /* TODO(vpai): Consider first doing a 0 timeout poll here to avoid even going into the blocking annotation if possible */ GRPC_SCHEDULING_START_BLOCKING_REGION; r = grpc_poll_function(pfds, pfd_count, timeout); GRPC_SCHEDULING_END_BLOCKING_REGION; if (GRPC_TRACE_FLAG_ENABLED(grpc_polling_trace)) { gpr_log(GPR_INFO, "%p poll=%d", pollset, r); } if (r < 0) { if (errno != EINTR) { work_combine_error(&error, GRPC_OS_ERROR(errno, "poll")); } for (i = 1; i < pfd_count; i++) { if (watchers[i].pollset == nullptr) { fd_end_poll(&watchers[i], 0, 0); } else { // Wake up all the file descriptors, if we have an invalid one // we can identify it on the next pollset_work() fd_end_poll(&watchers[i], 1, 1); } } } else if (r == 0) { for (i = 1; i < pfd_count; i++) { fd_end_poll(&watchers[i], 0, 0); } } else { if (pfds[0].revents & POLLIN_CHECK) { if (GRPC_TRACE_FLAG_ENABLED(grpc_polling_trace)) { gpr_log(GPR_INFO, "%p: got_wakeup", pollset); } work_combine_error( &error, grpc_wakeup_fd_consume_wakeup(&worker.wakeup_fd->fd)); } for (i = 1; i < pfd_count; i++) { if (watchers[i].pollset == nullptr) { grpc_fd* fd = watchers[i].fd; if (pfds[i].revents & POLLHUP) { gpr_atm_no_barrier_store(&fd->pollhup, 1); } fd_end_poll(&watchers[i], 0, 0); } else { if (GRPC_TRACE_FLAG_ENABLED(grpc_polling_trace)) { gpr_log(GPR_INFO, "%p got_event: %d r:%d w:%d [%d]", pollset, pfds[i].fd, (pfds[i].revents & POLLIN_CHECK) != 0, (pfds[i].revents & POLLOUT_CHECK) != 0, pfds[i].revents); } /* This is a mitigation to prevent poll() from spinning on a ** POLLHUP https://github.com/grpc/grpc/pull/13665 */ if (pfds[i].revents & POLLHUP) { gpr_atm_no_barrier_store(&watchers[i].fd->pollhup, 1); } fd_end_poll(&watchers[i], pfds[i].revents & POLLIN_CHECK, pfds[i].revents & POLLOUT_CHECK); } } } if (pfds != pollfd_space) { /* pfds and watchers are in the same memory block pointed to by pfds */ gpr_free(pfds); } locked = 0; } else { pollset->kicked_without_pollers = 0; } /* Finished execution - start cleaning up. Note that we may arrive here from outside the enclosing while() loop. In that case we won't loop though as we haven't added worker to the worker list, which means nobody could ask us to re-evaluate polling). */ done: if (!locked) { queued_work |= grpc_core::ExecCtx::Get()->Flush(); gpr_mu_lock(&pollset->mu); locked = 1; } /* If we're forced to re-evaluate polling (via pollset_kick with GRPC_POLLSET_REEVALUATE_POLLING_ON_WAKEUP) then we land here and force a loop */ if (worker.reevaluate_polling_on_wakeup && error.ok()) { worker.reevaluate_polling_on_wakeup = 0; pollset->kicked_without_pollers = 0; if (queued_work || worker.kicked_specifically) { /* If there's queued work on the list, then set the deadline to be immediate so we get back out of the polling loop quickly */ deadline = grpc_core::Timestamp(); } keep_polling = 1; } } g_current_thread_poller = nullptr; if (added_worker) { remove_worker(pollset, &worker); g_current_thread_worker = nullptr; } /* release wakeup fd to the local pool */ worker.wakeup_fd->next = pollset->local_wakeup_cache; pollset->local_wakeup_cache = worker.wakeup_fd; /* check shutdown conditions */ if (pollset->shutting_down) { if (pollset_has_workers(pollset)) { (void)pollset_kick(pollset, nullptr); } else if (!pollset->called_shutdown && !pollset_has_observers(pollset)) { pollset->called_shutdown = 1; gpr_mu_unlock(&pollset->mu); finish_shutdown(pollset); grpc_core::ExecCtx::Get()->Flush(); /* Continuing to access pollset here is safe -- it is the caller's * responsibility to not destroy when it has outstanding calls to * pollset_work. * TODO(dklempner): Can we refactor the shutdown logic to avoid this? */ gpr_mu_lock(&pollset->mu); } } if (worker_hdl) *worker_hdl = nullptr; GRPC_LOG_IF_ERROR("pollset_work", error); return error; } static void pollset_shutdown(grpc_pollset* pollset, grpc_closure* closure) { GPR_ASSERT(!pollset->shutting_down); pollset->shutting_down = 1; pollset->shutdown_done = closure; (void)pollset_kick(pollset, GRPC_POLLSET_KICK_BROADCAST); if (!pollset->called_shutdown && !pollset_has_observers(pollset)) { pollset->called_shutdown = 1; finish_shutdown(pollset); } } static int poll_deadline_to_millis_timeout(grpc_core::Timestamp deadline) { if (deadline == grpc_core::Timestamp::InfFuture()) return -1; if (deadline.is_process_epoch()) return 0; int64_t n = (deadline - grpc_core::Timestamp::Now()).millis(); if (n < 0) return 0; if (n > INT_MAX) return -1; return static_cast(n); } /******************************************************************************* * pollset_set_posix.c */ static grpc_pollset_set* pollset_set_create(void) { grpc_pollset_set* pollset_set = static_cast(gpr_zalloc(sizeof(*pollset_set))); gpr_mu_init(&pollset_set->mu); return pollset_set; } static void pollset_set_destroy(grpc_pollset_set* pollset_set) { size_t i; gpr_mu_destroy(&pollset_set->mu); for (i = 0; i < pollset_set->fd_count; i++) { GRPC_FD_UNREF(pollset_set->fds[i], "pollset_set"); } for (i = 0; i < pollset_set->pollset_count; i++) { grpc_pollset* pollset = pollset_set->pollsets[i]; gpr_mu_lock(&pollset->mu); pollset->pollset_set_count--; /* check shutdown */ if (pollset->shutting_down && !pollset->called_shutdown && !pollset_has_observers(pollset)) { pollset->called_shutdown = 1; gpr_mu_unlock(&pollset->mu); finish_shutdown(pollset); } else { gpr_mu_unlock(&pollset->mu); } } gpr_free(pollset_set->pollsets); gpr_free(pollset_set->pollset_sets); gpr_free(pollset_set->fds); gpr_free(pollset_set); } static void pollset_set_add_pollset(grpc_pollset_set* pollset_set, grpc_pollset* pollset) { size_t i, j; gpr_mu_lock(&pollset->mu); pollset->pollset_set_count++; gpr_mu_unlock(&pollset->mu); gpr_mu_lock(&pollset_set->mu); if (pollset_set->pollset_count == pollset_set->pollset_capacity) { pollset_set->pollset_capacity = std::max(size_t(8), 2 * pollset_set->pollset_capacity); pollset_set->pollsets = static_cast(gpr_realloc( pollset_set->pollsets, pollset_set->pollset_capacity * sizeof(*pollset_set->pollsets))); } pollset_set->pollsets[pollset_set->pollset_count++] = pollset; for (i = 0, j = 0; i < pollset_set->fd_count; i++) { if (fd_is_orphaned(pollset_set->fds[i])) { GRPC_FD_UNREF(pollset_set->fds[i], "pollset_set"); } else { pollset_add_fd(pollset, pollset_set->fds[i]); pollset_set->fds[j++] = pollset_set->fds[i]; } } pollset_set->fd_count = j; gpr_mu_unlock(&pollset_set->mu); } static void pollset_set_del_pollset(grpc_pollset_set* pollset_set, grpc_pollset* pollset) { size_t i; gpr_mu_lock(&pollset_set->mu); for (i = 0; i < pollset_set->pollset_count; i++) { if (pollset_set->pollsets[i] == pollset) { pollset_set->pollset_count--; std::swap(pollset_set->pollsets[i], pollset_set->pollsets[pollset_set->pollset_count]); break; } } gpr_mu_unlock(&pollset_set->mu); gpr_mu_lock(&pollset->mu); pollset->pollset_set_count--; /* check shutdown */ if (pollset->shutting_down && !pollset->called_shutdown && !pollset_has_observers(pollset)) { pollset->called_shutdown = 1; gpr_mu_unlock(&pollset->mu); finish_shutdown(pollset); } else { gpr_mu_unlock(&pollset->mu); } } static void pollset_set_add_pollset_set(grpc_pollset_set* bag, grpc_pollset_set* item) { size_t i, j; gpr_mu_lock(&bag->mu); if (bag->pollset_set_count == bag->pollset_set_capacity) { bag->pollset_set_capacity = std::max(size_t(8), 2 * bag->pollset_set_capacity); bag->pollset_sets = static_cast( gpr_realloc(bag->pollset_sets, bag->pollset_set_capacity * sizeof(*bag->pollset_sets))); } bag->pollset_sets[bag->pollset_set_count++] = item; for (i = 0, j = 0; i < bag->fd_count; i++) { if (fd_is_orphaned(bag->fds[i])) { GRPC_FD_UNREF(bag->fds[i], "pollset_set"); } else { pollset_set_add_fd(item, bag->fds[i]); bag->fds[j++] = bag->fds[i]; } } bag->fd_count = j; gpr_mu_unlock(&bag->mu); } static void pollset_set_del_pollset_set(grpc_pollset_set* bag, grpc_pollset_set* item) { size_t i; gpr_mu_lock(&bag->mu); for (i = 0; i < bag->pollset_set_count; i++) { if (bag->pollset_sets[i] == item) { bag->pollset_set_count--; std::swap(bag->pollset_sets[i], bag->pollset_sets[bag->pollset_set_count]); break; } } gpr_mu_unlock(&bag->mu); } static void pollset_set_add_fd(grpc_pollset_set* pollset_set, grpc_fd* fd) { size_t i; gpr_mu_lock(&pollset_set->mu); if (pollset_set->fd_count == pollset_set->fd_capacity) { pollset_set->fd_capacity = std::max(size_t(8), 2 * pollset_set->fd_capacity); pollset_set->fds = static_cast( gpr_realloc(pollset_set->fds, pollset_set->fd_capacity * sizeof(*pollset_set->fds))); } GRPC_FD_REF(fd, "pollset_set"); pollset_set->fds[pollset_set->fd_count++] = fd; for (i = 0; i < pollset_set->pollset_count; i++) { pollset_add_fd(pollset_set->pollsets[i], fd); } for (i = 0; i < pollset_set->pollset_set_count; i++) { pollset_set_add_fd(pollset_set->pollset_sets[i], fd); } gpr_mu_unlock(&pollset_set->mu); } static void pollset_set_del_fd(grpc_pollset_set* pollset_set, grpc_fd* fd) { size_t i; gpr_mu_lock(&pollset_set->mu); for (i = 0; i < pollset_set->fd_count; i++) { if (pollset_set->fds[i] == fd) { pollset_set->fd_count--; std::swap(pollset_set->fds[i], pollset_set->fds[pollset_set->fd_count]); GRPC_FD_UNREF(fd, "pollset_set"); break; } } for (i = 0; i < pollset_set->pollset_set_count; i++) { pollset_set_del_fd(pollset_set->pollset_sets[i], fd); } gpr_mu_unlock(&pollset_set->mu); } /******************************************************************************* * event engine binding */ static bool is_any_background_poller_thread(void) { return false; } static void shutdown_background_closure(void) {} static bool add_closure_to_background_poller(grpc_closure* /*closure*/, grpc_error_handle /*error*/) { return false; } /* Called by the child process's post-fork handler to close open fds, including * worker wakeup fds. This allows gRPC to shutdown in the child process without * interfering with connections or RPCs ongoing in the parent. */ static void reset_event_manager_on_fork() { gpr_mu_lock(&fork_fd_list_mu); while (fork_fd_list_head != nullptr) { if (fork_fd_list_head->fd != nullptr) { if (!fork_fd_list_head->fd->closed) { close(fork_fd_list_head->fd->fd); } fork_fd_list_head->fd->fd = -1; } else { close(fork_fd_list_head->cached_wakeup_fd->fd.read_fd); fork_fd_list_head->cached_wakeup_fd->fd.read_fd = -1; close(fork_fd_list_head->cached_wakeup_fd->fd.write_fd); fork_fd_list_head->cached_wakeup_fd->fd.write_fd = -1; } fork_fd_list_head = fork_fd_list_head->next; } gpr_mu_unlock(&fork_fd_list_mu); } const grpc_event_engine_vtable grpc_ev_poll_posix = { sizeof(grpc_pollset), false, false, fd_create, fd_wrapped_fd, fd_orphan, fd_shutdown, fd_notify_on_read, fd_notify_on_write, fd_notify_on_error, fd_set_readable, fd_set_writable, fd_set_error, fd_is_shutdown, pollset_init, pollset_shutdown, pollset_destroy, pollset_work, pollset_kick, pollset_add_fd, pollset_set_create, pollset_set_destroy, pollset_set_add_pollset, pollset_set_del_pollset, pollset_set_add_pollset_set, pollset_set_del_pollset_set, pollset_set_add_fd, pollset_set_del_fd, is_any_background_poller_thread, /* name = */ "poll", /* check_engine_available = */ [](bool) { if (!grpc_has_wakeup_fd()) { gpr_log(GPR_ERROR, "Skipping poll because of no wakeup fd."); return false; } if (!GRPC_LOG_IF_ERROR("pollset_global_init", pollset_global_init())) { return false; } if (grpc_core::Fork::Enabled()) { track_fds_for_fork = true; gpr_mu_init(&fork_fd_list_mu); grpc_core::Fork::SetResetChildPollingEngineFunc( reset_event_manager_on_fork); } return true; }, /* init_engine = */ []() {}, /* shutdown_engine = */ shutdown_background_closure, []() {}, add_closure_to_background_poller, }; namespace { grpc_poll_function_type real_poll_function; int phony_poll(struct pollfd fds[], nfds_t nfds, int timeout) { if (timeout == 0) { return real_poll_function(fds, nfds, 0); } else { gpr_log(GPR_ERROR, "Attempted a blocking poll when declared non-polling."); GPR_ASSERT(false); return -1; } } } // namespace const grpc_event_engine_vtable grpc_ev_none_posix = []() { grpc_event_engine_vtable v = grpc_ev_poll_posix; v.check_engine_available = [](bool explicit_request) { if (!explicit_request) return false; // return the simplest engine as a phony but also override the poller if (!grpc_ev_poll_posix.check_engine_available(explicit_request)) { return false; } real_poll_function = grpc_poll_function; grpc_poll_function = phony_poll; return true; }; v.name = "none"; v.init_engine = []() {}; v.shutdown_engine = []() {}; return v; }(); #endif /* GRPC_POSIX_SOCKET_EV_POLL */