1 /* 2 * 3 * Copyright 2016 gRPC authors. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 19 #ifndef GRPC_CORE_LIB_IOMGR_COMBINER_H 20 #define GRPC_CORE_LIB_IOMGR_COMBINER_H 21 22 #include <grpc/support/port_platform.h> 23 24 #include <stddef.h> 25 26 #include <grpc/support/atm.h> 27 28 #include "src/core/lib/debug/trace.h" 29 #include "src/core/lib/iomgr/exec_ctx.h" 30 31 namespace grpc_core { 32 // TODO(yashkt) : Remove this class and replace it with a class that does not 33 // use ExecCtx 34 class Combiner { 35 public: 36 void Run(grpc_closure* closure, grpc_error_handle error); 37 // TODO(yashkt) : Remove this method 38 void FinallyRun(grpc_closure* closure, grpc_error_handle error); 39 Combiner* next_combiner_on_this_exec_ctx = nullptr; 40 MultiProducerSingleConsumerQueue queue; 41 // either: 42 // a pointer to the initiating exec ctx if that is the only exec_ctx that has 43 // ever queued to this combiner, or NULL. If this is non-null, it's not 44 // dereferencable (since the initiating exec_ctx may have gone out of scope) 45 gpr_atm initiating_exec_ctx_or_null; 46 // state is: 47 // lower bit - zero if orphaned (STATE_UNORPHANED) 48 // other bits - number of items queued on the lock (STATE_ELEM_COUNT_LOW_BIT) 49 gpr_atm state; 50 bool time_to_execute_final_list = false; 51 grpc_closure_list final_list; 52 grpc_closure offload; 53 gpr_refcount refs; 54 }; 55 } // namespace grpc_core 56 57 // Provides serialized access to some resource. 58 // Each action queued on a combiner is executed serially in a borrowed thread. 59 // The actual thread executing actions may change over time (but there will only 60 // ever be one at a time). 61 62 // Initialize the lock, with an optional workqueue to shift load to when 63 // necessary 64 grpc_core::Combiner* grpc_combiner_create(void); 65 66 #ifndef NDEBUG 67 #define GRPC_COMBINER_DEBUG_ARGS \ 68 , const char *file, int line, const char *reason 69 #define GRPC_COMBINER_REF(combiner, reason) \ 70 grpc_combiner_ref((combiner), __FILE__, __LINE__, (reason)) 71 #define GRPC_COMBINER_UNREF(combiner, reason) \ 72 grpc_combiner_unref((combiner), __FILE__, __LINE__, (reason)) 73 #else 74 #define GRPC_COMBINER_DEBUG_ARGS 75 #define GRPC_COMBINER_REF(combiner, reason) grpc_combiner_ref((combiner)) 76 #define GRPC_COMBINER_UNREF(combiner, reason) grpc_combiner_unref((combiner)) 77 #endif 78 79 // Ref/unref the lock, for when we're sharing the lock ownership 80 // Prefer to use the macros above 81 grpc_core::Combiner* grpc_combiner_ref( 82 grpc_core::Combiner* lock GRPC_COMBINER_DEBUG_ARGS); 83 void grpc_combiner_unref(grpc_core::Combiner* lock GRPC_COMBINER_DEBUG_ARGS); 84 85 bool grpc_combiner_continue_exec_ctx(); 86 87 extern grpc_core::DebugOnlyTraceFlag grpc_combiner_trace; 88 89 #endif /* GRPC_CORE_LIB_IOMGR_COMBINER_H */ 90