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 #include <grpc/impl/codegen/byte_buffer.h> 23 #include <grpc/impl/codegen/byte_buffer_reader.h> 24 #include <grpc/impl/codegen/grpc_types.h> 25 #include <grpc/impl/codegen/sync.h> 26 #include <grpcpp/impl/codegen/config.h> 27 #include <grpcpp/impl/codegen/status.h> 28 29 namespace grpc { 30 31 /// Interface between the codegen library and the minimal subset of core 32 /// features required by the generated code. 33 /// 34 /// All undocumented methods are simply forwarding the call to their namesakes. 35 /// Please refer to their corresponding documentation for details. 36 /// 37 /// \warning This interface should be considered internal and private. 38 class CoreCodegenInterface { 39 public: 40 virtual ~CoreCodegenInterface() = default; 41 42 /// Upon a failed assertion, log the error. 43 virtual void assert_fail(const char* failed_assertion, const char* file, 44 int line) = 0; 45 46 virtual const grpc_completion_queue_factory* 47 grpc_completion_queue_factory_lookup( 48 const grpc_completion_queue_attributes* attributes) = 0; 49 virtual grpc_completion_queue* grpc_completion_queue_create( 50 const grpc_completion_queue_factory* factory, 51 const grpc_completion_queue_attributes* attributes, void* reserved) = 0; 52 virtual grpc_completion_queue* grpc_completion_queue_create_for_next( 53 void* reserved) = 0; 54 virtual grpc_completion_queue* grpc_completion_queue_create_for_pluck( 55 void* reserved) = 0; 56 virtual void grpc_completion_queue_shutdown(grpc_completion_queue* cq) = 0; 57 virtual void grpc_completion_queue_destroy(grpc_completion_queue* cq) = 0; 58 virtual grpc_event grpc_completion_queue_pluck(grpc_completion_queue* cq, 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 84 virtual grpc_byte_buffer* grpc_byte_buffer_copy(grpc_byte_buffer* bb) = 0; 85 virtual void grpc_byte_buffer_destroy(grpc_byte_buffer* bb) = 0; 86 virtual size_t grpc_byte_buffer_length(grpc_byte_buffer* bb) 87 GRPC_MUST_USE_RESULT = 0; 88 89 virtual int grpc_byte_buffer_reader_init(grpc_byte_buffer_reader* reader, 90 grpc_byte_buffer* buffer) 91 GRPC_MUST_USE_RESULT = 0; 92 virtual void grpc_byte_buffer_reader_destroy( 93 grpc_byte_buffer_reader* reader) = 0; 94 virtual int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader* reader, 95 grpc_slice* slice) = 0; 96 virtual int grpc_byte_buffer_reader_peek(grpc_byte_buffer_reader* reader, 97 grpc_slice** slice) = 0; 98 99 virtual grpc_byte_buffer* grpc_raw_byte_buffer_create(grpc_slice* slice, 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; 107 virtual grpc_call_error grpc_call_start_batch(grpc_call* call, 108 const grpc_op* ops, size_t nops, 109 void* tag, void* reserved) = 0; 110 virtual grpc_call_error grpc_call_cancel_with_status(grpc_call* call, 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 143 extern CoreCodegenInterface* g_core_codegen_interface; 144 145 /// Codegen specific version of \a GPR_ASSERT. 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 153 /// Codegen specific version of \a GPR_DEBUG_ASSERT. 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 165