GRPC C++  1.26.0
core_codegen_interface.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015 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 GRPCPP_IMPL_CODEGEN_CORE_CODEGEN_INTERFACE_H
20 #define GRPCPP_IMPL_CODEGEN_CORE_CODEGEN_INTERFACE_H
21 
25 #include <grpc/impl/codegen/sync.h>
28 
29 namespace grpc {
30 
39  public:
40  virtual ~CoreCodegenInterface() = default;
41 
43  virtual void assert_fail(const char* failed_assertion, const char* file,
44  int line) = 0;
45 
46  virtual const grpc_completion_queue_factory*
48  const grpc_completion_queue_attributes* attributes) = 0;
50  const grpc_completion_queue_factory* factory,
51  const grpc_completion_queue_attributes* attributes, void* reserved) = 0;
53  void* reserved) = 0;
55  void* reserved) = 0;
59  void* tag,
60  gpr_timespec deadline,
61  void* reserved) = 0;
62 
63  virtual void* gpr_malloc(size_t size) = 0;
64  virtual void gpr_free(void* p) = 0;
65 
66  // These are only to be used to fix edge cases involving grpc_init and
67  // grpc_shutdown. Calling grpc_init from the codegen interface before
68  // the real grpc_init is called will cause a crash, so if you use this
69  // function, ensure that it is not the first call to grpc_init.
70  virtual void grpc_init() = 0;
71  virtual void grpc_shutdown() = 0;
72 
73  virtual void gpr_mu_init(gpr_mu* mu) = 0;
74  virtual void gpr_mu_destroy(gpr_mu* mu) = 0;
75  virtual void gpr_mu_lock(gpr_mu* mu) = 0;
76  virtual void gpr_mu_unlock(gpr_mu* mu) = 0;
77  virtual void gpr_cv_init(gpr_cv* cv) = 0;
78  virtual void gpr_cv_destroy(gpr_cv* cv) = 0;
79  virtual int gpr_cv_wait(gpr_cv* cv, gpr_mu* mu,
80  gpr_timespec abs_deadline) = 0;
81  virtual void gpr_cv_signal(gpr_cv* cv) = 0;
82  virtual void gpr_cv_broadcast(gpr_cv* cv) = 0;
83 
85  virtual void grpc_byte_buffer_destroy(grpc_byte_buffer* bb) = 0;
86  virtual size_t grpc_byte_buffer_length(grpc_byte_buffer* bb)
88 
90  grpc_byte_buffer* buffer)
91  GRPC_MUST_USE_RESULT = 0;
93  grpc_byte_buffer_reader* reader) = 0;
95  grpc_slice* slice) = 0;
97  grpc_slice** slice) = 0;
98 
100  size_t nslices) = 0;
101  virtual grpc_slice grpc_slice_new_with_user_data(void* p, size_t len,
102  void (*destroy)(void*),
103  void* user_data) = 0;
104  virtual grpc_slice grpc_slice_new_with_len(void* p, size_t len,
105  void (*destroy)(void*,
106  size_t)) = 0;
108  const grpc_op* ops, size_t nops,
109  void* tag, void* reserved) = 0;
111  grpc_status_code status,
112  const char* description,
113  void* reserved) = 0;
114  virtual void grpc_call_ref(grpc_call* call) = 0;
115  virtual void grpc_call_unref(grpc_call* call) = 0;
116  virtual void* grpc_call_arena_alloc(grpc_call* call, size_t length) = 0;
117  virtual const char* grpc_call_error_to_string(grpc_call_error error) = 0;
118  virtual grpc_slice grpc_empty_slice() = 0;
119  virtual grpc_slice grpc_slice_malloc(size_t length) = 0;
120  virtual void grpc_slice_unref(grpc_slice slice) = 0;
121  virtual grpc_slice grpc_slice_ref(grpc_slice slice) = 0;
122  virtual grpc_slice grpc_slice_split_tail(grpc_slice* s, size_t split) = 0;
123  virtual grpc_slice grpc_slice_split_head(grpc_slice* s, size_t split) = 0;
124  virtual grpc_slice grpc_slice_sub(grpc_slice s, size_t begin, size_t end) = 0;
125  virtual void grpc_slice_buffer_add(grpc_slice_buffer* sb,
126  grpc_slice slice) = 0;
127  virtual void grpc_slice_buffer_pop(grpc_slice_buffer* sb) = 0;
128  virtual grpc_slice grpc_slice_from_static_buffer(const void* buffer,
129  size_t length) = 0;
130  virtual grpc_slice grpc_slice_from_copied_buffer(const void* buffer,
131  size_t length) = 0;
132 
133  virtual void grpc_metadata_array_init(grpc_metadata_array* array) = 0;
134  virtual void grpc_metadata_array_destroy(grpc_metadata_array* array) = 0;
135 
136  virtual const Status& ok() = 0;
137  virtual const Status& cancelled() = 0;
138 
139  virtual gpr_timespec gpr_inf_future(gpr_clock_type type) = 0;
140  virtual gpr_timespec gpr_time_0(gpr_clock_type type) = 0;
141 };
142 
144 
146 #define GPR_CODEGEN_ASSERT(x) \
147  do { \
148  if (GPR_UNLIKELY(!(x))) { \
149  grpc::g_core_codegen_interface->assert_fail(#x, __FILE__, __LINE__); \
150  } \
151  } while (0)
152 
154 #ifndef NDEBUG
155 #define GPR_CODEGEN_DEBUG_ASSERT(x) GPR_CODEGEN_ASSERT(x)
156 #else
157 #define GPR_CODEGEN_DEBUG_ASSERT(x) \
158  do { \
159  } while (0)
160 #endif
161 
162 } // namespace grpc
163 
164 #endif // GRPCPP_IMPL_CODEGEN_CORE_CODEGEN_INTERFACE_H
struct grpc_call grpc_call
A Call represents an RPC.
Definition: grpc_types.h:70
virtual void grpc_slice_buffer_pop(grpc_slice_buffer *sb)=0
virtual const grpc_completion_queue_factory * grpc_completion_queue_factory_lookup(const grpc_completion_queue_attributes *attributes)=0
virtual grpc_slice grpc_slice_sub(grpc_slice s, size_t begin, size_t end)=0
grpc_status_code
Definition: status.h:26
virtual void gpr_mu_unlock(gpr_mu *mu)=0
virtual grpc_slice grpc_slice_malloc(size_t length)=0
virtual void grpc_completion_queue_shutdown(grpc_completion_queue *cq)=0
virtual void grpc_init()=0
virtual void grpc_call_ref(grpc_call *call)=0
struct grpc_completion_queue_factory grpc_completion_queue_factory
The completion queue factory structure is opaque to the callers of grpc.
Definition: grpc_types.h:762
virtual gpr_timespec gpr_inf_future(gpr_clock_type type)=0
virtual void grpc_metadata_array_destroy(grpc_metadata_array *array)=0
virtual void gpr_cv_init(gpr_cv *cv)=0
virtual void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader)=0
virtual grpc_slice grpc_slice_new_with_user_data(void *p, size_t len, void(*destroy)(void *), void *user_data)=0
virtual grpc_slice grpc_slice_from_copied_buffer(const void *buffer, size_t length)=0
The result of an operation.
Definition: grpc_types.h:514
virtual grpc_slice grpc_empty_slice()=0
virtual void gpr_cv_signal(gpr_cv *cv)=0
A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1]. ...
Definition: slice.h:60
virtual grpc_completion_queue * grpc_completion_queue_create_for_pluck(void *reserved)=0
virtual void grpc_call_unref(grpc_call *call)=0
virtual const Status & cancelled()=0
virtual void gpr_cv_broadcast(gpr_cv *cv)=0
Definition: grpc_types.h:40
Definition: grpc_types.h:529
virtual void gpr_mu_destroy(gpr_mu *mu)=0
Represents an expandable array of slices, to be interpreted as a single item.
Definition: slice.h:78
virtual void grpc_completion_queue_destroy(grpc_completion_queue *cq)=0
Definition: grpc_types.h:742
grpc_call_error
Result of a grpc call.
Definition: grpc_types.h:407
virtual int gpr_cv_wait(gpr_cv *cv, gpr_mu *mu, gpr_timespec abs_deadline)=0
virtual void grpc_byte_buffer_destroy(grpc_byte_buffer *bb)=0
pthread_cond_t gpr_cv
Definition: sync_posix.h:46
Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments) ...
Definition: grpc_types.h:590
virtual grpc_slice grpc_slice_from_static_buffer(const void *buffer, size_t length)=0
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...
Definition: alarm.h:24
Definition: sync_windows.h:26
virtual grpc_completion_queue * grpc_completion_queue_create(const grpc_completion_queue_factory *factory, const grpc_completion_queue_attributes *attributes, void *reserved)=0
virtual void gpr_mu_lock(gpr_mu *mu)=0
virtual void assert_fail(const char *failed_assertion, const char *file, int line)=0
Upon a failed assertion, log the error.
CoreCodegenInterface * g_core_codegen_interface
Definition: completion_queue_impl.h:90
virtual grpc_byte_buffer * grpc_raw_byte_buffer_create(grpc_slice *slice, size_t nslices)=0
#define GRPC_MUST_USE_RESULT
Definition: port_platform.h:570
virtual grpc_byte_buffer * grpc_byte_buffer_copy(grpc_byte_buffer *bb)=0
virtual void gpr_cv_destroy(gpr_cv *cv)=0
virtual grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, size_t nops, void *tag, void *reserved)=0
virtual grpc_slice grpc_slice_ref(grpc_slice slice)=0
virtual void * grpc_call_arena_alloc(grpc_call *call, size_t length)=0
virtual grpc_slice grpc_slice_split_tail(grpc_slice *s, size_t split)=0
virtual grpc_slice grpc_slice_new_with_len(void *p, size_t len, void(*destroy)(void *, size_t))=0
virtual void grpc_slice_unref(grpc_slice slice)=0
virtual void gpr_mu_init(gpr_mu *mu)=0
virtual int grpc_byte_buffer_reader_peek(grpc_byte_buffer_reader *reader, grpc_slice **slice)=0
virtual void grpc_shutdown()=0
virtual ~CoreCodegenInterface()=default
virtual void grpc_slice_buffer_add(grpc_slice_buffer *sb, grpc_slice slice)=0
Interface between the codegen library and the minimal subset of core features required by the generat...
Definition: core_codegen_interface.h:38
Did it work? If it didn&#39;t, why?
Definition: status.h:31
Analogous to struct timespec.
Definition: gpr_types.h:47
virtual const Status & ok()=0
gpr_clock_type
The clocks we support.
Definition: gpr_types.h:31
virtual int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader, grpc_slice *slice)=0
virtual const char * grpc_call_error_to_string(grpc_call_error error)=0
virtual void grpc_metadata_array_init(grpc_metadata_array *array)=0
Definition: byte_buffer_reader.h:28
virtual void gpr_free(void *p)=0
virtual int grpc_byte_buffer_reader_init(grpc_byte_buffer_reader *reader, grpc_byte_buffer *buffer) GRPC_MUST_USE_RESULT=0
struct grpc_completion_queue grpc_completion_queue
Completion Queues enable notification of the completion of asynchronous actions.
Definition: grpc_types.h:56
virtual gpr_timespec gpr_time_0(gpr_clock_type type)=0
virtual grpc_slice grpc_slice_split_head(grpc_slice *s, size_t split)=0
virtual size_t grpc_byte_buffer_length(grpc_byte_buffer *bb) GRPC_MUST_USE_RESULT=0
virtual grpc_call_error grpc_call_cancel_with_status(grpc_call *call, grpc_status_code status, const char *description, void *reserved)=0
virtual grpc_event grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, gpr_timespec deadline, void *reserved)=0
virtual grpc_completion_queue * grpc_completion_queue_create_for_next(void *reserved)=0
virtual void * gpr_malloc(size_t size)=0