mirror of https://github.com/grpc/grpc.git
Merge pull request #10501 from ctiller/epex2
Split event notification out of ev_epoll_linux.cpull/10507/head
Craig Tiller
8 years ago
committed by
GitHub
commit
6b99d80410
28 changed files with 404 additions and 220 deletions
@ -0,0 +1,238 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2017, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#include "src/core/lib/iomgr/lockfree_event.h" |
||||
|
||||
#include <grpc/support/log.h> |
||||
|
||||
/* 'state' holds the to call when the fd is readable or writable respectively.
|
||||
It can contain one of the following values: |
||||
CLOSURE_READY : The fd has an I/O event of interest but there is no |
||||
closure yet to execute |
||||
|
||||
CLOSURE_NOT_READY : The fd has no I/O event of interest |
||||
|
||||
closure ptr : The closure to be executed when the fd has an I/O |
||||
event of interest |
||||
|
||||
shutdown_error | FD_SHUTDOWN_BIT : |
||||
'shutdown_error' field ORed with FD_SHUTDOWN_BIT. |
||||
This indicates that the fd is shutdown. Since all |
||||
memory allocations are word-aligned, the lower two |
||||
bits of the shutdown_error pointer are always 0. So |
||||
it is safe to OR these with FD_SHUTDOWN_BIT |
||||
|
||||
Valid state transitions: |
||||
|
||||
<closure ptr> <-----3------ CLOSURE_NOT_READY ----1----> CLOSURE_READY |
||||
| | ^ | ^ | | |
||||
| | | | | | | |
||||
| +--------------4----------+ 6 +---------2---------------+ | |
||||
| | | |
||||
| v | |
||||
+-----5-------> [shutdown_error | FD_SHUTDOWN_BIT] <----7---------+ |
||||
|
||||
For 1, 4 : See grpc_lfev_set_ready() function |
||||
For 2, 3 : See grpc_lfev_notify_on() function |
||||
For 5,6,7: See grpc_lfev_set_shutdown() function */ |
||||
|
||||
#define CLOSURE_NOT_READY ((gpr_atm)0) |
||||
#define CLOSURE_READY ((gpr_atm)2) |
||||
|
||||
#define FD_SHUTDOWN_BIT ((gpr_atm)1) |
||||
|
||||
void grpc_lfev_init(gpr_atm *state) { |
||||
gpr_atm_no_barrier_store(state, CLOSURE_NOT_READY); |
||||
} |
||||
|
||||
void grpc_lfev_destroy(gpr_atm *state) { |
||||
gpr_atm curr = gpr_atm_no_barrier_load(state); |
||||
if (curr & FD_SHUTDOWN_BIT) { |
||||
GRPC_ERROR_UNREF((grpc_error *)(curr & ~FD_SHUTDOWN_BIT)); |
||||
} else { |
||||
GPR_ASSERT(curr == CLOSURE_NOT_READY || curr == CLOSURE_READY); |
||||
} |
||||
} |
||||
|
||||
bool grpc_lfev_is_shutdown(gpr_atm *state) { |
||||
gpr_atm curr = gpr_atm_no_barrier_load(state); |
||||
return (curr & FD_SHUTDOWN_BIT) != 0; |
||||
} |
||||
|
||||
void grpc_lfev_notify_on(grpc_exec_ctx *exec_ctx, gpr_atm *state, |
||||
grpc_closure *closure) { |
||||
while (true) { |
||||
gpr_atm curr = gpr_atm_no_barrier_load(state); |
||||
switch (curr) { |
||||
case CLOSURE_NOT_READY: { |
||||
/* CLOSURE_NOT_READY -> <closure>.
|
||||
|
||||
We're guaranteed by API that there's an acquire barrier before here, |
||||
so there's no need to double-dip and this can be a release-only. |
||||
|
||||
The release itself pairs with the acquire half of a set_ready full |
||||
barrier. */ |
||||
if (gpr_atm_rel_cas(state, CLOSURE_NOT_READY, (gpr_atm)closure)) { |
||||
return; /* Successful. Return */ |
||||
} |
||||
|
||||
break; /* retry */ |
||||
} |
||||
|
||||
case CLOSURE_READY: { |
||||
/* Change the state to CLOSURE_NOT_READY. Schedule the closure if
|
||||
successful. If not, the state most likely transitioned to shutdown. |
||||
We should retry. |
||||
|
||||
This can be a no-barrier cas since the state is being transitioned to |
||||
CLOSURE_NOT_READY; set_ready and set_shutdown do not schedule any |
||||
closure when transitioning out of CLOSURE_NO_READY state (i.e there |
||||
is no other code that needs to 'happen-after' this) */ |
||||
if (gpr_atm_no_barrier_cas(state, CLOSURE_READY, CLOSURE_NOT_READY)) { |
||||
grpc_closure_sched(exec_ctx, closure, GRPC_ERROR_NONE); |
||||
return; /* Successful. Return */ |
||||
} |
||||
|
||||
break; /* retry */ |
||||
} |
||||
|
||||
default: { |
||||
/* 'curr' is either a closure or the fd is shutdown(in which case 'curr'
|
||||
contains a pointer to the shutdown-error). If the fd is shutdown, |
||||
schedule the closure with the shutdown error */ |
||||
if ((curr & FD_SHUTDOWN_BIT) > 0) { |
||||
grpc_error *shutdown_err = (grpc_error *)(curr & ~FD_SHUTDOWN_BIT); |
||||
grpc_closure_sched(exec_ctx, closure, |
||||
GRPC_ERROR_CREATE_REFERENCING_FROM_STATIC_STRING( |
||||
"FD Shutdown", &shutdown_err, 1)); |
||||
return; |
||||
} |
||||
|
||||
/* There is already a closure!. This indicates a bug in the code */ |
||||
gpr_log(GPR_ERROR, |
||||
"notify_on called with a previous callback still pending"); |
||||
abort(); |
||||
} |
||||
} |
||||
} |
||||
|
||||
GPR_UNREACHABLE_CODE(return ); |
||||
} |
||||
|
||||
bool grpc_lfev_set_shutdown(grpc_exec_ctx *exec_ctx, gpr_atm *state, |
||||
grpc_error *shutdown_err) { |
||||
gpr_atm new_state = (gpr_atm)shutdown_err | FD_SHUTDOWN_BIT; |
||||
|
||||
while (true) { |
||||
gpr_atm curr = gpr_atm_no_barrier_load(state); |
||||
switch (curr) { |
||||
case CLOSURE_READY: |
||||
case CLOSURE_NOT_READY: |
||||
/* Need a full barrier here so that the initial load in notify_on
|
||||
doesn't need a barrier */ |
||||
if (gpr_atm_full_cas(state, curr, new_state)) { |
||||
return true; /* early out */ |
||||
} |
||||
break; /* retry */ |
||||
|
||||
default: { |
||||
/* 'curr' is either a closure or the fd is already shutdown */ |
||||
|
||||
/* If fd is already shutdown, we are done */ |
||||
if ((curr & FD_SHUTDOWN_BIT) > 0) { |
||||
GRPC_ERROR_UNREF(shutdown_err); |
||||
return false; |
||||
} |
||||
|
||||
/* Fd is not shutdown. Schedule the closure and move the state to
|
||||
shutdown state. |
||||
Needs an acquire to pair with setting the closure (and get a |
||||
happens-after on that edge), and a release to pair with anything |
||||
loading the shutdown state. */ |
||||
if (gpr_atm_full_cas(state, curr, new_state)) { |
||||
grpc_closure_sched(exec_ctx, (grpc_closure *)curr, |
||||
GRPC_ERROR_CREATE_REFERENCING_FROM_STATIC_STRING( |
||||
"FD Shutdown", &shutdown_err, 1)); |
||||
return true; |
||||
} |
||||
|
||||
/* 'curr' was a closure but now changed to a different state. We will
|
||||
have to retry */ |
||||
break; |
||||
} |
||||
} |
||||
} |
||||
|
||||
GPR_UNREACHABLE_CODE(return false); |
||||
} |
||||
|
||||
void grpc_lfev_set_ready(grpc_exec_ctx *exec_ctx, gpr_atm *state) { |
||||
while (true) { |
||||
gpr_atm curr = gpr_atm_no_barrier_load(state); |
||||
|
||||
switch (curr) { |
||||
case CLOSURE_READY: { |
||||
/* Already ready. We are done here */ |
||||
return; |
||||
} |
||||
|
||||
case CLOSURE_NOT_READY: { |
||||
/* No barrier required as we're transitioning to a state that does not
|
||||
involve a closure */ |
||||
if (gpr_atm_no_barrier_cas(state, CLOSURE_NOT_READY, CLOSURE_READY)) { |
||||
return; /* early out */ |
||||
} |
||||
break; /* retry */ |
||||
} |
||||
|
||||
default: { |
||||
/* 'curr' is either a closure or the fd is shutdown */ |
||||
if ((curr & FD_SHUTDOWN_BIT) > 0) { |
||||
/* The fd is shutdown. Do nothing */ |
||||
return; |
||||
} |
||||
/* Full cas: acquire pairs with this cas' release in the event of a
|
||||
spurious set_ready; release pairs with this or the acquire in |
||||
notify_on (or set_shutdown) */ |
||||
else if (gpr_atm_full_cas(state, curr, CLOSURE_NOT_READY)) { |
||||
grpc_closure_sched(exec_ctx, (grpc_closure *)curr, GRPC_ERROR_NONE); |
||||
return; |
||||
} |
||||
/* else the state changed again (only possible by either a racing
|
||||
set_ready or set_shutdown functions. In both these cases, the closure |
||||
would have been scheduled for execution. So we are done here */ |
||||
return; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,54 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2017, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_IOMGR_LOCKFREE_EVENT_H |
||||
#define GRPC_CORE_LIB_IOMGR_LOCKFREE_EVENT_H |
||||
|
||||
/* Lock free event notification for file descriptors */ |
||||
|
||||
#include <grpc/support/atm.h> |
||||
|
||||
#include "src/core/lib/iomgr/exec_ctx.h" |
||||
|
||||
void grpc_lfev_init(gpr_atm *state); |
||||
void grpc_lfev_destroy(gpr_atm *state); |
||||
bool grpc_lfev_is_shutdown(gpr_atm *state); |
||||
|
||||
void grpc_lfev_notify_on(grpc_exec_ctx *exec_ctx, gpr_atm *state, |
||||
grpc_closure *closure); |
||||
/* Returns true on first successful shutdown */ |
||||
bool grpc_lfev_set_shutdown(grpc_exec_ctx *exec_ctx, gpr_atm *state, |
||||
grpc_error *shutdown_err); |
||||
void grpc_lfev_set_ready(grpc_exec_ctx *exec_ctx, gpr_atm *state); |
||||
|
||||
#endif /* GRPC_CORE_LIB_IOMGR_LOCKFREE_EVENT_H */ |
||||
Loading…
Reference in new issue