1 /*
2 *
3 * Copyright 2018 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 #include <grpc/support/port_platform.h>
20
21 #include "src/core/lib/iomgr/port.h"
22
23 #include <limits.h>
24 #include <string.h>
25
26 #include <grpc/slice_buffer.h>
27
28 #include <grpc/support/alloc.h>
29 #include <grpc/support/log.h>
30 #include <grpc/support/string_util.h>
31
32 #include "src/core/lib/iomgr/error.h"
33 #include "src/core/lib/iomgr/iomgr_custom.h"
34 #include "src/core/lib/iomgr/resource_quota.h"
35 #include "src/core/lib/iomgr/tcp_client.h"
36 #include "src/core/lib/iomgr/tcp_custom.h"
37 #include "src/core/lib/iomgr/tcp_server.h"
38 #include "src/core/lib/slice/slice_internal.h"
39 #include "src/core/lib/slice/slice_string_helpers.h"
40
41 #define GRPC_TCP_DEFAULT_READ_SLICE_SIZE 8192
42
43 extern grpc_core::TraceFlag grpc_tcp_trace;
44
45 grpc_socket_vtable* grpc_custom_socket_vtable = nullptr;
46 extern grpc_tcp_server_vtable custom_tcp_server_vtable;
47 extern grpc_tcp_client_vtable custom_tcp_client_vtable;
48
grpc_custom_endpoint_init(grpc_socket_vtable * impl)49 void grpc_custom_endpoint_init(grpc_socket_vtable* impl) {
50 grpc_custom_socket_vtable = impl;
51 grpc_set_tcp_client_impl(&custom_tcp_client_vtable);
52 grpc_set_tcp_server_impl(&custom_tcp_server_vtable);
53 }
54
55 typedef struct {
56 grpc_endpoint base;
57 gpr_refcount refcount;
58 grpc_custom_socket* socket;
59
60 grpc_closure* read_cb;
61 grpc_closure* write_cb;
62
63 grpc_slice_buffer* read_slices;
64 grpc_slice_buffer* write_slices;
65
66 grpc_resource_user* resource_user;
67 grpc_resource_user_slice_allocator slice_allocator;
68
69 bool shutting_down;
70
71 char* peer_string;
72 } custom_tcp_endpoint;
73
tcp_free(grpc_custom_socket * s)74 static void tcp_free(grpc_custom_socket* s) {
75 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)s->endpoint;
76 grpc_resource_user_unref(tcp->resource_user);
77 gpr_free(tcp->peer_string);
78 gpr_free(tcp);
79 s->refs--;
80 if (s->refs == 0) {
81 grpc_custom_socket_vtable->destroy(s);
82 gpr_free(s);
83 }
84 }
85
86 #ifndef NDEBUG
87 #define TCP_UNREF(tcp, reason) tcp_unref((tcp), (reason), __FILE__, __LINE__)
88 #define TCP_REF(tcp, reason) tcp_ref((tcp), (reason), __FILE__, __LINE__)
tcp_unref(custom_tcp_endpoint * tcp,const char * reason,const char * file,int line)89 static void tcp_unref(custom_tcp_endpoint* tcp, const char* reason,
90 const char* file, int line) {
91 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
92 gpr_atm val = gpr_atm_no_barrier_load(&tcp->refcount.count);
93 gpr_log(file, line, GPR_LOG_SEVERITY_ERROR,
94 "TCP unref %p : %s %" PRIdPTR " -> %" PRIdPTR, tcp->socket, reason,
95 val, val - 1);
96 }
97 if (gpr_unref(&tcp->refcount)) {
98 tcp_free(tcp->socket);
99 }
100 }
101
tcp_ref(custom_tcp_endpoint * tcp,const char * reason,const char * file,int line)102 static void tcp_ref(custom_tcp_endpoint* tcp, const char* reason,
103 const char* file, int line) {
104 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
105 gpr_atm val = gpr_atm_no_barrier_load(&tcp->refcount.count);
106 gpr_log(file, line, GPR_LOG_SEVERITY_ERROR,
107 "TCP ref %p : %s %" PRIdPTR " -> %" PRIdPTR, tcp->socket, reason,
108 val, val + 1);
109 }
110 gpr_ref(&tcp->refcount);
111 }
112 #else
113 #define TCP_UNREF(tcp, reason) tcp_unref((tcp))
114 #define TCP_REF(tcp, reason) tcp_ref((tcp))
tcp_unref(custom_tcp_endpoint * tcp)115 static void tcp_unref(custom_tcp_endpoint* tcp) {
116 if (gpr_unref(&tcp->refcount)) {
117 tcp_free(tcp->socket);
118 }
119 }
120
tcp_ref(custom_tcp_endpoint * tcp)121 static void tcp_ref(custom_tcp_endpoint* tcp) { gpr_ref(&tcp->refcount); }
122 #endif
123
call_read_cb(custom_tcp_endpoint * tcp,grpc_error * error)124 static void call_read_cb(custom_tcp_endpoint* tcp, grpc_error* error) {
125 grpc_closure* cb = tcp->read_cb;
126 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
127 gpr_log(GPR_INFO, "TCP:%p call_cb %p %p:%p", tcp->socket, cb, cb->cb,
128 cb->cb_arg);
129 size_t i;
130 const char* str = grpc_error_string(error);
131 gpr_log(GPR_INFO, "read: error=%s", str);
132
133 for (i = 0; i < tcp->read_slices->count; i++) {
134 char* dump = grpc_dump_slice(tcp->read_slices->slices[i],
135 GPR_DUMP_HEX | GPR_DUMP_ASCII);
136 gpr_log(GPR_INFO, "READ %p (peer=%s): %s", tcp, tcp->peer_string, dump);
137 gpr_free(dump);
138 }
139 }
140 TCP_UNREF(tcp, "read");
141 tcp->read_slices = nullptr;
142 tcp->read_cb = nullptr;
143 GRPC_CLOSURE_SCHED(cb, error);
144 }
145
custom_read_callback(grpc_custom_socket * socket,size_t nread,grpc_error * error)146 static void custom_read_callback(grpc_custom_socket* socket, size_t nread,
147 grpc_error* error) {
148 grpc_core::ExecCtx exec_ctx;
149 grpc_slice_buffer garbage;
150 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)socket->endpoint;
151 if (error == GRPC_ERROR_NONE && nread == 0) {
152 error = GRPC_ERROR_CREATE_FROM_STATIC_STRING("EOF");
153 }
154 if (error == GRPC_ERROR_NONE) {
155 // Successful read
156 if ((size_t)nread < tcp->read_slices->length) {
157 /* TODO(murgatroid99): Instead of discarding the unused part of the read
158 * buffer, reuse it as the next read buffer. */
159 grpc_slice_buffer_init(&garbage);
160 grpc_slice_buffer_trim_end(
161 tcp->read_slices, tcp->read_slices->length - (size_t)nread, &garbage);
162 grpc_slice_buffer_reset_and_unref_internal(&garbage);
163 }
164 } else {
165 grpc_slice_buffer_reset_and_unref_internal(tcp->read_slices);
166 }
167 call_read_cb(tcp, error);
168 }
169
tcp_read_allocation_done(void * tcpp,grpc_error * error)170 static void tcp_read_allocation_done(void* tcpp, grpc_error* error) {
171 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)tcpp;
172 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
173 gpr_log(GPR_INFO, "TCP:%p read_allocation_done: %s", tcp->socket,
174 grpc_error_string(error));
175 }
176 if (error == GRPC_ERROR_NONE) {
177 /* Before calling read, we allocate a buffer with exactly one slice
178 * to tcp->read_slices and wait for the callback indicating that the
179 * allocation was successful. So slices[0] should always exist here */
180 char* buffer = (char*)GRPC_SLICE_START_PTR(tcp->read_slices->slices[0]);
181 size_t len = GRPC_SLICE_LENGTH(tcp->read_slices->slices[0]);
182 grpc_custom_socket_vtable->read(tcp->socket, buffer, len,
183 custom_read_callback);
184 } else {
185 grpc_slice_buffer_reset_and_unref_internal(tcp->read_slices);
186 call_read_cb(tcp, GRPC_ERROR_REF(error));
187 }
188 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
189 const char* str = grpc_error_string(error);
190 gpr_log(GPR_INFO, "Initiating read on %p: error=%s", tcp->socket, str);
191 }
192 }
193
endpoint_read(grpc_endpoint * ep,grpc_slice_buffer * read_slices,grpc_closure * cb,bool urgent)194 static void endpoint_read(grpc_endpoint* ep, grpc_slice_buffer* read_slices,
195 grpc_closure* cb, bool urgent) {
196 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)ep;
197 GRPC_CUSTOM_IOMGR_ASSERT_SAME_THREAD();
198 GPR_ASSERT(tcp->read_cb == nullptr);
199 tcp->read_cb = cb;
200 tcp->read_slices = read_slices;
201 grpc_slice_buffer_reset_and_unref_internal(read_slices);
202 TCP_REF(tcp, "read");
203 grpc_resource_user_alloc_slices(&tcp->slice_allocator,
204 GRPC_TCP_DEFAULT_READ_SLICE_SIZE, 1,
205 tcp->read_slices);
206 }
207
custom_write_callback(grpc_custom_socket * socket,grpc_error * error)208 static void custom_write_callback(grpc_custom_socket* socket,
209 grpc_error* error) {
210 grpc_core::ExecCtx exec_ctx;
211 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)socket->endpoint;
212 grpc_closure* cb = tcp->write_cb;
213 tcp->write_cb = nullptr;
214 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
215 const char* str = grpc_error_string(error);
216 gpr_log(GPR_INFO, "write complete on %p: error=%s", tcp->socket, str);
217 }
218 TCP_UNREF(tcp, "write");
219 GRPC_CLOSURE_SCHED(cb, error);
220 }
221
endpoint_write(grpc_endpoint * ep,grpc_slice_buffer * write_slices,grpc_closure * cb,void * arg)222 static void endpoint_write(grpc_endpoint* ep, grpc_slice_buffer* write_slices,
223 grpc_closure* cb, void* arg) {
224 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)ep;
225 GRPC_CUSTOM_IOMGR_ASSERT_SAME_THREAD();
226
227 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
228 size_t j;
229
230 for (j = 0; j < write_slices->count; j++) {
231 char* data = grpc_dump_slice(write_slices->slices[j],
232 GPR_DUMP_HEX | GPR_DUMP_ASCII);
233 gpr_log(GPR_INFO, "WRITE %p (peer=%s): %s", tcp->socket, tcp->peer_string,
234 data);
235 gpr_free(data);
236 }
237 }
238
239 if (tcp->shutting_down) {
240 GRPC_CLOSURE_SCHED(cb, GRPC_ERROR_CREATE_FROM_STATIC_STRING(
241 "TCP socket is shutting down"));
242 return;
243 }
244
245 GPR_ASSERT(tcp->write_cb == nullptr);
246 tcp->write_slices = write_slices;
247 GPR_ASSERT(tcp->write_slices->count <= UINT_MAX);
248 if (tcp->write_slices->count == 0) {
249 // No slices means we don't have to do anything,
250 // and libuv doesn't like empty writes
251 GRPC_CLOSURE_SCHED(cb, GRPC_ERROR_NONE);
252 return;
253 }
254 tcp->write_cb = cb;
255 TCP_REF(tcp, "write");
256 grpc_custom_socket_vtable->write(tcp->socket, tcp->write_slices,
257 custom_write_callback);
258 }
259
endpoint_add_to_pollset(grpc_endpoint * ep,grpc_pollset * pollset)260 static void endpoint_add_to_pollset(grpc_endpoint* ep, grpc_pollset* pollset) {
261 // No-op. We're ignoring pollsets currently
262 (void)ep;
263 (void)pollset;
264 }
265
endpoint_add_to_pollset_set(grpc_endpoint * ep,grpc_pollset_set * pollset)266 static void endpoint_add_to_pollset_set(grpc_endpoint* ep,
267 grpc_pollset_set* pollset) {
268 // No-op. We're ignoring pollsets currently
269 (void)ep;
270 (void)pollset;
271 }
272
endpoint_delete_from_pollset_set(grpc_endpoint * ep,grpc_pollset_set * pollset)273 static void endpoint_delete_from_pollset_set(grpc_endpoint* ep,
274 grpc_pollset_set* pollset) {
275 // No-op. We're ignoring pollsets currently
276 (void)ep;
277 (void)pollset;
278 }
279
endpoint_shutdown(grpc_endpoint * ep,grpc_error * why)280 static void endpoint_shutdown(grpc_endpoint* ep, grpc_error* why) {
281 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)ep;
282 if (!tcp->shutting_down) {
283 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
284 const char* str = grpc_error_string(why);
285 gpr_log(GPR_INFO, "TCP %p shutdown why=%s", tcp->socket, str);
286 }
287 tcp->shutting_down = true;
288 // GRPC_CLOSURE_SCHED(tcp->read_cb, GRPC_ERROR_REF(why));
289 // GRPC_CLOSURE_SCHED(tcp->write_cb, GRPC_ERROR_REF(why));
290 // tcp->read_cb = nullptr;
291 // tcp->write_cb = nullptr;
292 grpc_resource_user_shutdown(tcp->resource_user);
293 grpc_custom_socket_vtable->shutdown(tcp->socket);
294 }
295 GRPC_ERROR_UNREF(why);
296 }
297
custom_close_callback(grpc_custom_socket * socket)298 static void custom_close_callback(grpc_custom_socket* socket) {
299 socket->refs--;
300 if (socket->refs == 0) {
301 grpc_custom_socket_vtable->destroy(socket);
302 gpr_free(socket);
303 } else if (socket->endpoint) {
304 grpc_core::ExecCtx exec_ctx;
305 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)socket->endpoint;
306 TCP_UNREF(tcp, "destroy");
307 }
308 }
309
endpoint_destroy(grpc_endpoint * ep)310 static void endpoint_destroy(grpc_endpoint* ep) {
311 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)ep;
312 grpc_custom_socket_vtable->close(tcp->socket, custom_close_callback);
313 }
314
endpoint_get_peer(grpc_endpoint * ep)315 static char* endpoint_get_peer(grpc_endpoint* ep) {
316 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)ep;
317 return gpr_strdup(tcp->peer_string);
318 }
319
endpoint_get_resource_user(grpc_endpoint * ep)320 static grpc_resource_user* endpoint_get_resource_user(grpc_endpoint* ep) {
321 custom_tcp_endpoint* tcp = (custom_tcp_endpoint*)ep;
322 return tcp->resource_user;
323 }
324
endpoint_get_fd(grpc_endpoint * ep)325 static int endpoint_get_fd(grpc_endpoint* ep) { return -1; }
326
endpoint_can_track_err(grpc_endpoint * ep)327 static bool endpoint_can_track_err(grpc_endpoint* ep) { return false; }
328
329 static grpc_endpoint_vtable vtable = {endpoint_read,
330 endpoint_write,
331 endpoint_add_to_pollset,
332 endpoint_add_to_pollset_set,
333 endpoint_delete_from_pollset_set,
334 endpoint_shutdown,
335 endpoint_destroy,
336 endpoint_get_resource_user,
337 endpoint_get_peer,
338 endpoint_get_fd,
339 endpoint_can_track_err};
340
custom_tcp_endpoint_create(grpc_custom_socket * socket,grpc_resource_quota * resource_quota,char * peer_string)341 grpc_endpoint* custom_tcp_endpoint_create(grpc_custom_socket* socket,
342 grpc_resource_quota* resource_quota,
343 char* peer_string) {
344 custom_tcp_endpoint* tcp =
345 (custom_tcp_endpoint*)gpr_malloc(sizeof(custom_tcp_endpoint));
346 grpc_core::ExecCtx exec_ctx;
347
348 if (GRPC_TRACE_FLAG_ENABLED(grpc_tcp_trace)) {
349 gpr_log(GPR_INFO, "Creating TCP endpoint %p", socket);
350 }
351 memset(tcp, 0, sizeof(custom_tcp_endpoint));
352 socket->refs++;
353 socket->endpoint = (grpc_endpoint*)tcp;
354 tcp->socket = socket;
355 tcp->base.vtable = &vtable;
356 gpr_ref_init(&tcp->refcount, 1);
357 tcp->peer_string = gpr_strdup(peer_string);
358 tcp->shutting_down = false;
359 tcp->resource_user = grpc_resource_user_create(resource_quota, peer_string);
360 grpc_resource_user_slice_allocator_init(
361 &tcp->slice_allocator, tcp->resource_user, tcp_read_allocation_done, tcp);
362
363 return &tcp->base;
364 }
365