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
22// IWYU pragma: private
23
24#include <grpc/impl/codegen/byte_buffer.h>
25#include <grpc/impl/codegen/byte_buffer_reader.h>
26#include <grpc/impl/codegen/grpc_types.h>
27#include <grpc/impl/codegen/sync.h>
28#include <grpcpp/impl/codegen/config.h>
29#include <grpcpp/impl/codegen/status.h>
30
31namespace grpc {
32
33/// Interface between the codegen library and the minimal subset of core
34/// features required by the generated code.
35///
36/// All undocumented methods are simply forwarding the call to their namesakes.
37/// Please refer to their corresponding documentation for details.
38///
39/// \warning This interface should be considered internal and private.
40class CoreCodegenInterface {
41 public:
42 virtual ~CoreCodegenInterface() = default;
43
44 /// Upon a failed assertion, log the error.
45 virtual void assert_fail(const char* failed_assertion, const char* file,
46 int line) = 0;
47
48 virtual const grpc_completion_queue_factory*
49 grpc_completion_queue_factory_lookup(
50 const grpc_completion_queue_attributes* attributes) = 0;
51 virtual grpc_completion_queue* grpc_completion_queue_create(
52 const grpc_completion_queue_factory* factory,
53 const grpc_completion_queue_attributes* attributes, void* reserved) = 0;
54 virtual grpc_completion_queue* grpc_completion_queue_create_for_next(
55 void* reserved) = 0;
56 virtual grpc_completion_queue* grpc_completion_queue_create_for_pluck(
57 void* reserved) = 0;
58 virtual void grpc_completion_queue_shutdown(grpc_completion_queue* cq) = 0;
59 virtual void grpc_completion_queue_destroy(grpc_completion_queue* cq) = 0;
60 virtual grpc_event grpc_completion_queue_pluck(grpc_completion_queue* cq,
61 void* tag,
62 gpr_timespec deadline,
63 void* reserved) = 0;
64
65 virtual void* gpr_malloc(size_t size) = 0;
66 virtual void gpr_free(void* p) = 0;
67
68 // These are only to be used to fix edge cases involving grpc_init and
69 // grpc_shutdown. Calling grpc_init from the codegen interface before
70 // the real grpc_init is called will cause a crash, so if you use this
71 // function, ensure that it is not the first call to grpc_init.
72 virtual void grpc_init() = 0;
73 virtual void grpc_shutdown() = 0;
74
75 virtual void gpr_mu_init(gpr_mu* mu) = 0;
76 virtual void gpr_mu_destroy(gpr_mu* mu) = 0;
77 virtual void gpr_mu_lock(gpr_mu* mu) = 0;
78 virtual void gpr_mu_unlock(gpr_mu* mu) = 0;
79 virtual void gpr_cv_init(gpr_cv* cv) = 0;
80 virtual void gpr_cv_destroy(gpr_cv* cv) = 0;
81 virtual int gpr_cv_wait(gpr_cv* cv, gpr_mu* mu,
82 gpr_timespec abs_deadline) = 0;
83 virtual void gpr_cv_signal(gpr_cv* cv) = 0;
84 virtual void gpr_cv_broadcast(gpr_cv* cv) = 0;
85
86 virtual grpc_byte_buffer* grpc_byte_buffer_copy(grpc_byte_buffer* bb) = 0;
87 virtual void grpc_byte_buffer_destroy(grpc_byte_buffer* bb) = 0;
88 virtual size_t grpc_byte_buffer_length(grpc_byte_buffer* bb)
89 GRPC_MUST_USE_RESULT = 0;
90
91 virtual int grpc_byte_buffer_reader_init(grpc_byte_buffer_reader* reader,
92 grpc_byte_buffer* buffer)
93 GRPC_MUST_USE_RESULT = 0;
94 virtual void grpc_byte_buffer_reader_destroy(
95 grpc_byte_buffer_reader* reader) = 0;
96 virtual int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader* reader,
97 grpc_slice* slice) = 0;
98 virtual int grpc_byte_buffer_reader_peek(grpc_byte_buffer_reader* reader,
99 grpc_slice** slice) = 0;
100
101 virtual grpc_byte_buffer* grpc_raw_byte_buffer_create(grpc_slice* slice,
102 size_t nslices) = 0;
103 virtual grpc_slice grpc_slice_new_with_user_data(void* p, size_t len,
104 void (*destroy)(void*),
105 void* user_data) = 0;
106 virtual grpc_slice grpc_slice_new_with_len(void* p, size_t len,
107 void (*destroy)(void*,
108 size_t)) = 0;
109 virtual grpc_call_error grpc_call_start_batch(grpc_call* call,
110 const grpc_op* ops, size_t nops,
111 void* tag, void* reserved) = 0;
112 virtual grpc_call_error grpc_call_cancel_with_status(grpc_call* call,
113 grpc_status_code status,
114 const char* description,
115 void* reserved) = 0;
116 virtual int grpc_call_failed_before_recv_message(const grpc_call* c) = 0;
117 virtual void grpc_call_ref(grpc_call* call) = 0;
118 virtual void grpc_call_unref(grpc_call* call) = 0;
119 virtual void* grpc_call_arena_alloc(grpc_call* call, size_t length) = 0;
120 virtual const char* grpc_call_error_to_string(grpc_call_error error) = 0;
121 virtual grpc_slice grpc_empty_slice() = 0;
122 virtual grpc_slice grpc_slice_malloc(size_t length) = 0;
123 virtual void grpc_slice_unref(grpc_slice slice) = 0;
124 virtual grpc_slice grpc_slice_ref(grpc_slice slice) = 0;
125 virtual grpc_slice grpc_slice_split_tail(grpc_slice* s, size_t split) = 0;
126 virtual grpc_slice grpc_slice_split_head(grpc_slice* s, size_t split) = 0;
127 virtual grpc_slice grpc_slice_sub(grpc_slice s, size_t begin, size_t end) = 0;
128 virtual void grpc_slice_buffer_add(grpc_slice_buffer* sb,
129 grpc_slice slice) = 0;
130 virtual void grpc_slice_buffer_add_indexed(grpc_slice_buffer* sb,
131 grpc_slice slice) = 0;
132 virtual void grpc_slice_buffer_pop(grpc_slice_buffer* sb) = 0;
133 virtual grpc_slice grpc_slice_from_static_buffer(const void* buffer,
134 size_t length) = 0;
135 virtual grpc_slice grpc_slice_from_copied_buffer(const void* buffer,
136 size_t length) = 0;
137
138 virtual void grpc_metadata_array_init(grpc_metadata_array* array) = 0;
139 virtual void grpc_metadata_array_destroy(grpc_metadata_array* array) = 0;
140
141 virtual const Status& ok() = 0;
142 virtual const Status& cancelled() = 0;
143
144 virtual gpr_timespec gpr_inf_future(gpr_clock_type type) = 0;
145 virtual gpr_timespec gpr_time_0(gpr_clock_type type) = 0;
146};
147
148extern CoreCodegenInterface* g_core_codegen_interface;
149
150/// Codegen specific version of \a GPR_ASSERT.
151#define GPR_CODEGEN_ASSERT(x) \
152 do { \
153 if (GPR_UNLIKELY(!(x))) { \
154 grpc::g_core_codegen_interface->assert_fail(#x, __FILE__, __LINE__); \
155 } \
156 } while (0)
157
158/// Codegen specific version of \a GPR_DEBUG_ASSERT.
159#ifndef NDEBUG
160#define GPR_CODEGEN_DEBUG_ASSERT(x) GPR_CODEGEN_ASSERT(x)
161#else
162#define GPR_CODEGEN_DEBUG_ASSERT(x) \
163 do { \
164 } while (0)
165#endif
166
167} // namespace grpc
168
169#endif // GRPCPP_IMPL_CODEGEN_CORE_CODEGEN_INTERFACE_H
170

source code of include/grpcpp/impl/codegen/core_codegen_interface.h