• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *
3  * Copyright 2015-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_SURFACE_COMPLETION_QUEUE_H
20 #define GRPC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H
21 
22 /* Internal API for completion queues */
23 
24 #include <grpc/support/port_platform.h>
25 
26 #include <grpc/grpc.h>
27 
28 #include "src/core/lib/debug/trace.h"
29 #include "src/core/lib/gprpp/manual_constructor.h"
30 #include "src/core/lib/iomgr/pollset.h"
31 
32 /* These trace flags default to 1. The corresponding lines are only traced
33    if grpc_api_trace is also truthy */
34 extern grpc_core::TraceFlag grpc_cq_pluck_trace;
35 extern grpc_core::TraceFlag grpc_trace_operation_failures;
36 extern grpc_core::DebugOnlyTraceFlag grpc_trace_pending_tags;
37 extern grpc_core::DebugOnlyTraceFlag grpc_trace_cq_refcount;
38 
39 typedef struct grpc_cq_completion {
40   grpc_core::ManualConstructor<grpc_core::MultiProducerSingleConsumerQueue>
41       node;
42 
43   /** user supplied tag */
44   void* tag;
45   /** done callback - called when this queue element is no longer
46       needed by the completion queue */
47   void (*done)(void* done_arg, struct grpc_cq_completion* c);
48   void* done_arg;
49   /** next pointer; low bit is used to indicate success or not */
50   uintptr_t next;
51 } grpc_cq_completion;
52 
53 #ifndef NDEBUG
54 void grpc_cq_internal_ref(grpc_completion_queue* cq, const char* reason,
55                           const char* file, int line);
56 void grpc_cq_internal_unref(grpc_completion_queue* cq, const char* reason,
57                             const char* file, int line);
58 #define GRPC_CQ_INTERNAL_REF(cq, reason) \
59   grpc_cq_internal_ref(cq, reason, __FILE__, __LINE__)
60 #define GRPC_CQ_INTERNAL_UNREF(cq, reason) \
61   grpc_cq_internal_unref(cq, reason, __FILE__, __LINE__)
62 #else
63 void grpc_cq_internal_ref(grpc_completion_queue* cq);
64 void grpc_cq_internal_unref(grpc_completion_queue* cq);
65 #define GRPC_CQ_INTERNAL_REF(cq, reason) grpc_cq_internal_ref(cq)
66 #define GRPC_CQ_INTERNAL_UNREF(cq, reason) grpc_cq_internal_unref(cq)
67 #endif
68 
69 /* Initializes global variables used by completion queues */
70 void grpc_cq_global_init();
71 
72 /* Flag that an operation is beginning: the completion channel will not finish
73    shutdown until a corrensponding grpc_cq_end_* call is made.
74    \a tag is currently used only in debug builds. Return true on success, and
75    false if completion_queue has been shutdown. */
76 bool grpc_cq_begin_op(grpc_completion_queue* cq, void* tag);
77 
78 /* Queue a GRPC_OP_COMPLETED operation; tag must correspond to the tag passed to
79    grpc_cq_begin_op */
80 void grpc_cq_end_op(grpc_completion_queue* cq, void* tag, grpc_error* error,
81                     void (*done)(void* done_arg, grpc_cq_completion* storage),
82                     void* done_arg, grpc_cq_completion* storage,
83                     bool internal = false);
84 
85 grpc_pollset* grpc_cq_pollset(grpc_completion_queue* cq);
86 
87 bool grpc_cq_can_listen(grpc_completion_queue* cq);
88 
89 grpc_cq_completion_type grpc_get_cq_completion_type(grpc_completion_queue* cq);
90 
91 int grpc_get_cq_poll_num(grpc_completion_queue* cq);
92 
93 grpc_completion_queue* grpc_completion_queue_create_internal(
94     grpc_cq_completion_type completion_type, grpc_cq_polling_type polling_type,
95     grpc_experimental_completion_queue_functor* shutdown_callback);
96 
97 #endif /* GRPC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H */
98