grpc 0.15.0 → 1.0.0.pre1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of grpc might be problematic. Click here for more details.

Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +127 -159
  3. data/etc/roots.pem +784 -509
  4. data/include/grpc/grpc_posix.h +8 -0
  5. data/include/grpc/impl/codegen/byte_buffer.h +5 -4
  6. data/include/grpc/impl/codegen/grpc_types.h +2 -0
  7. data/include/grpc/impl/codegen/port_platform.h +2 -1
  8. data/include/grpc/module.modulemap +15 -0
  9. data/src/core/ext/census/grpc_filter.c +3 -0
  10. data/src/core/ext/client_config/channel_connectivity.c +4 -3
  11. data/src/core/ext/client_config/client_channel.c +6 -0
  12. data/src/core/ext/client_config/subchannel.c +2 -0
  13. data/src/core/ext/client_config/subchannel_call_holder.c +2 -5
  14. data/src/core/ext/transport/chttp2/server/insecure/server_chttp2.c +2 -1
  15. data/src/core/ext/transport/chttp2/server/secure/server_secure_chttp2.c +2 -1
  16. data/src/core/ext/transport/chttp2/transport/chttp2_transport.c +171 -104
  17. data/src/core/ext/transport/chttp2/transport/internal.h +5 -3
  18. data/src/core/ext/transport/chttp2/transport/parsing.c +4 -3
  19. data/src/core/ext/transport/chttp2/transport/status_conversion.c +8 -2
  20. data/src/core/ext/transport/chttp2/transport/status_conversion.h +1 -1
  21. data/src/core/lib/channel/channel_stack.c +12 -1
  22. data/src/core/lib/channel/channel_stack.h +5 -0
  23. data/src/core/lib/channel/http_client_filter.c +7 -1
  24. data/src/core/lib/debug/trace.c +6 -2
  25. data/src/core/lib/iomgr/error.c +62 -19
  26. data/src/core/lib/iomgr/error.h +10 -6
  27. data/src/core/lib/iomgr/ev_epoll_linux.c +1872 -0
  28. data/src/core/lib/{surface/surface_trace.h → iomgr/ev_epoll_linux.h} +11 -12
  29. data/src/core/lib/iomgr/ev_posix.c +9 -6
  30. data/src/core/lib/iomgr/ev_posix.h +3 -0
  31. data/src/core/lib/iomgr/network_status_tracker.c +121 -0
  32. data/{include/grpc/grpc_zookeeper.h → src/core/lib/iomgr/network_status_tracker.h} +8 -26
  33. data/src/core/lib/iomgr/socket_utils_common_posix.c +22 -0
  34. data/src/core/lib/iomgr/socket_utils_posix.h +3 -0
  35. data/src/core/lib/iomgr/tcp_posix.c +6 -2
  36. data/src/core/lib/iomgr/tcp_server.h +3 -0
  37. data/src/core/lib/iomgr/tcp_server_posix.c +114 -16
  38. data/src/core/lib/iomgr/tcp_server_windows.c +1 -0
  39. data/src/core/lib/iomgr/tcp_windows.c +5 -0
  40. data/src/core/lib/iomgr/udp_server.c +28 -16
  41. data/src/core/lib/iomgr/wakeup_fd_eventfd.c +4 -2
  42. data/src/core/lib/profiling/basic_timers.c +4 -4
  43. data/src/core/lib/security/credentials/composite/composite_credentials.c +4 -3
  44. data/src/core/lib/security/credentials/credentials.c +1 -1
  45. data/src/core/lib/security/credentials/credentials.h +4 -5
  46. data/src/core/lib/security/credentials/fake/fake_credentials.c +2 -2
  47. data/src/core/lib/security/credentials/iam/iam_credentials.c +1 -1
  48. data/src/core/lib/security/credentials/jwt/jwt_credentials.c +7 -6
  49. data/src/core/lib/security/credentials/oauth2/oauth2_credentials.c +6 -4
  50. data/src/core/lib/security/credentials/plugin/plugin_credentials.c +4 -3
  51. data/src/core/lib/security/transport/client_auth_filter.c +10 -7
  52. data/src/core/lib/surface/byte_buffer_reader.c +6 -4
  53. data/src/core/lib/surface/call.c +64 -51
  54. data/src/core/lib/surface/call.h +0 -1
  55. data/src/core/lib/surface/channel.c +10 -8
  56. data/src/core/lib/surface/completion_queue.c +26 -12
  57. data/src/core/lib/surface/completion_queue.h +4 -0
  58. data/src/core/lib/surface/init.c +6 -1
  59. data/src/core/lib/surface/version.c +1 -1
  60. data/src/core/lib/transport/transport.c +62 -29
  61. data/src/core/lib/transport/transport.h +8 -5
  62. data/src/core/lib/transport/transport_op_string.c +14 -3
  63. data/src/ruby/ext/grpc/rb_byte_buffer.c +4 -1
  64. data/src/ruby/ext/grpc/rb_call.c +87 -54
  65. data/src/ruby/ext/grpc/rb_call.h +1 -1
  66. data/src/ruby/ext/grpc/rb_call_credentials.c +1 -30
  67. data/src/ruby/ext/grpc/rb_channel.c +25 -50
  68. data/src/ruby/ext/grpc/rb_channel_credentials.c +1 -31
  69. data/src/ruby/ext/grpc/rb_completion_queue.c +15 -134
  70. data/src/ruby/ext/grpc/rb_completion_queue.h +3 -7
  71. data/src/ruby/ext/grpc/rb_grpc.c +2 -4
  72. data/src/ruby/ext/grpc/rb_grpc_imports.generated.c +2 -0
  73. data/src/ruby/ext/grpc/rb_grpc_imports.generated.h +4 -1
  74. data/src/ruby/ext/grpc/rb_server.c +81 -133
  75. data/src/ruby/ext/grpc/rb_server_credentials.c +4 -33
  76. data/src/ruby/lib/grpc/generic/active_call.rb +40 -55
  77. data/src/ruby/lib/grpc/generic/bidi_call.rb +21 -23
  78. data/src/ruby/lib/grpc/generic/client_stub.rb +20 -15
  79. data/src/ruby/lib/grpc/generic/rpc_server.rb +15 -37
  80. data/src/ruby/lib/grpc/generic/service.rb +1 -1
  81. data/src/ruby/lib/grpc/version.rb +1 -1
  82. data/src/ruby/pb/test/client.rb +25 -7
  83. data/src/ruby/pb/test/server.rb +7 -5
  84. data/src/ruby/spec/call_spec.rb +1 -2
  85. data/src/ruby/spec/channel_spec.rb +2 -3
  86. data/src/ruby/spec/client_server_spec.rb +74 -59
  87. data/src/ruby/spec/generic/active_call_spec.rb +66 -86
  88. data/src/ruby/spec/generic/client_stub_spec.rb +27 -48
  89. data/src/ruby/spec/generic/rpc_server_spec.rb +4 -34
  90. data/src/ruby/spec/pb/health/checker_spec.rb +0 -2
  91. data/src/ruby/spec/server_spec.rb +20 -24
  92. metadata +9 -8
  93. data/src/ruby/spec/completion_queue_spec.rb +0 -42
@@ -384,9 +384,6 @@ struct grpc_chttp2_transport {
384
384
 
385
385
  /** Transport op to be applied post-parsing */
386
386
  grpc_transport_op *post_parsing_op;
387
-
388
- /** Message explaining the reason of dropping connection */
389
- gpr_slice optional_drop_message;
390
387
  };
391
388
 
392
389
  typedef struct {
@@ -439,6 +436,9 @@ typedef struct {
439
436
  bool seen_error;
440
437
  bool exceeded_metadata_size;
441
438
 
439
+ /** the error that resulted in this stream being removed */
440
+ grpc_error *removal_error;
441
+
442
442
  bool published_initial_metadata;
443
443
  bool published_trailing_metadata;
444
444
  bool final_metadata_requested;
@@ -447,6 +447,8 @@ typedef struct {
447
447
  grpc_chttp2_incoming_metadata_buffer received_trailing_metadata;
448
448
 
449
449
  grpc_chttp2_incoming_frame_queue incoming_frames;
450
+
451
+ gpr_timespec deadline;
450
452
  } grpc_chttp2_stream_global;
451
453
 
452
454
  typedef struct {
@@ -236,9 +236,10 @@ void grpc_chttp2_publish_reads(
236
236
  GRPC_ERROR_INT_HTTP2_ERROR, &reason);
237
237
  if (has_reason && reason != GRPC_CHTTP2_NO_ERROR) {
238
238
  grpc_status_code status_code =
239
- has_reason ? grpc_chttp2_http2_error_to_grpc_status(
240
- (grpc_chttp2_error_code)reason)
241
- : GRPC_STATUS_INTERNAL;
239
+ has_reason
240
+ ? grpc_chttp2_http2_error_to_grpc_status(
241
+ (grpc_chttp2_error_code)reason, stream_global->deadline)
242
+ : GRPC_STATUS_INTERNAL;
242
243
  const char *status_details =
243
244
  grpc_error_string(stream_parsing->forced_close_error);
244
245
  gpr_slice slice_details = gpr_slice_from_copied_string(status_details);
@@ -39,6 +39,8 @@ int grpc_chttp2_grpc_status_to_http2_error(grpc_status_code status) {
39
39
  return GRPC_CHTTP2_NO_ERROR;
40
40
  case GRPC_STATUS_CANCELLED:
41
41
  return GRPC_CHTTP2_CANCEL;
42
+ case GRPC_STATUS_DEADLINE_EXCEEDED:
43
+ return GRPC_CHTTP2_CANCEL;
42
44
  case GRPC_STATUS_RESOURCE_EXHAUSTED:
43
45
  return GRPC_CHTTP2_ENHANCE_YOUR_CALM;
44
46
  case GRPC_STATUS_PERMISSION_DENIED:
@@ -51,13 +53,17 @@ int grpc_chttp2_grpc_status_to_http2_error(grpc_status_code status) {
51
53
  }
52
54
 
53
55
  grpc_status_code grpc_chttp2_http2_error_to_grpc_status(
54
- grpc_chttp2_error_code error) {
56
+ grpc_chttp2_error_code error, gpr_timespec deadline) {
55
57
  switch (error) {
56
58
  case GRPC_CHTTP2_NO_ERROR:
57
59
  /* should never be received */
58
60
  return GRPC_STATUS_INTERNAL;
59
61
  case GRPC_CHTTP2_CANCEL:
60
- return GRPC_STATUS_CANCELLED;
62
+ /* http2 cancel translates to STATUS_CANCELLED iff deadline hasn't been
63
+ * exceeded */
64
+ return gpr_time_cmp(gpr_now(deadline.clock_type), deadline) >= 0
65
+ ? GRPC_STATUS_DEADLINE_EXCEEDED
66
+ : GRPC_STATUS_CANCELLED;
61
67
  case GRPC_CHTTP2_ENHANCE_YOUR_CALM:
62
68
  return GRPC_STATUS_RESOURCE_EXHAUSTED;
63
69
  case GRPC_CHTTP2_INADEQUATE_SECURITY:
@@ -41,7 +41,7 @@
41
41
  grpc_chttp2_error_code grpc_chttp2_grpc_status_to_http2_error(
42
42
  grpc_status_code status);
43
43
  grpc_status_code grpc_chttp2_http2_error_to_grpc_status(
44
- grpc_chttp2_error_code error);
44
+ grpc_chttp2_error_code error, gpr_timespec deadline);
45
45
 
46
46
  /* Conversion of HTTP status codes (:status) to grpc status codes */
47
47
  grpc_status_code grpc_chttp2_http2_status_to_grpc_status(int status);
@@ -263,6 +263,17 @@ void grpc_call_element_send_cancel(grpc_exec_ctx *exec_ctx,
263
263
  grpc_call_element *cur_elem) {
264
264
  grpc_transport_stream_op op;
265
265
  memset(&op, 0, sizeof(op));
266
- op.cancel_with_status = GRPC_STATUS_CANCELLED;
266
+ op.cancel_error = GRPC_ERROR_CANCELLED;
267
+ grpc_call_next_op(exec_ctx, cur_elem, &op);
268
+ }
269
+
270
+ void grpc_call_element_send_cancel_with_message(grpc_exec_ctx *exec_ctx,
271
+ grpc_call_element *cur_elem,
272
+ grpc_status_code status,
273
+ gpr_slice *optional_message) {
274
+ grpc_transport_stream_op op;
275
+ memset(&op, 0, sizeof(op));
276
+ grpc_transport_stream_op_add_cancellation_with_message(&op, status,
277
+ optional_message);
267
278
  grpc_call_next_op(exec_ctx, cur_elem, &op);
268
279
  }
@@ -273,6 +273,11 @@ void grpc_call_log_op(char *file, int line, gpr_log_severity severity,
273
273
  void grpc_call_element_send_cancel(grpc_exec_ctx *exec_ctx,
274
274
  grpc_call_element *cur_elem);
275
275
 
276
+ void grpc_call_element_send_cancel_with_message(grpc_exec_ctx *exec_ctx,
277
+ grpc_call_element *cur_elem,
278
+ grpc_status_code status,
279
+ gpr_slice *optional_message);
280
+
276
281
  extern int grpc_trace_channel;
277
282
 
278
283
  #define GRPC_CALL_LOG_OP(sev, elem, op) \
@@ -76,7 +76,13 @@ static grpc_mdelem *client_recv_filter(void *user_data, grpc_mdelem *md) {
76
76
  if (md == GRPC_MDELEM_STATUS_200) {
77
77
  return NULL;
78
78
  } else if (md->key == GRPC_MDSTR_STATUS) {
79
- grpc_call_element_send_cancel(a->exec_ctx, a->elem);
79
+ char *message_string;
80
+ gpr_asprintf(&message_string, "Received http2 header with status: %s",
81
+ grpc_mdstr_as_c_string(md->value));
82
+ gpr_slice message = gpr_slice_from_copied_string(message_string);
83
+ gpr_free(message_string);
84
+ grpc_call_element_send_cancel_with_message(a->exec_ctx, a->elem,
85
+ GRPC_STATUS_CANCELLED, &message);
80
86
  return NULL;
81
87
  } else if (md == GRPC_MDELEM_CONTENT_TYPE_APPLICATION_SLASH_GRPC) {
82
88
  return NULL;
@@ -88,7 +88,11 @@ static void parse(const char *s) {
88
88
  split(s, &strings, &nstrings);
89
89
 
90
90
  for (i = 0; i < nstrings; i++) {
91
- grpc_tracer_set_enabled(strings[i], 1);
91
+ if (strings[i][0] == '-') {
92
+ grpc_tracer_set_enabled(strings[i] + 1, 0);
93
+ } else {
94
+ grpc_tracer_set_enabled(strings[i], 1);
95
+ }
92
96
  }
93
97
 
94
98
  for (i = 0; i < nstrings; i++) {
@@ -117,7 +121,7 @@ int grpc_tracer_set_enabled(const char *name, int enabled) {
117
121
  tracer *t;
118
122
  if (0 == strcmp(name, "all")) {
119
123
  for (t = tracers; t; t = t->next) {
120
- *t->flag = 1;
124
+ *t->flag = enabled;
121
125
  }
122
126
  } else {
123
127
  int found = 0;
@@ -37,6 +37,7 @@
37
37
  #include <stdbool.h>
38
38
  #include <string.h>
39
39
 
40
+ #include <grpc/status.h>
40
41
  #include <grpc/support/alloc.h>
41
42
  #include <grpc/support/avl.h>
42
43
  #include <grpc/support/log.h>
@@ -47,6 +48,8 @@
47
48
  #include <grpc/support/log_windows.h>
48
49
  #endif
49
50
 
51
+ #include "src/core/lib/profiling/timers.h"
52
+
50
53
  static void destroy_integer(void *key) {}
51
54
 
52
55
  static void *copy_integer(void *key) { return key; }
@@ -115,6 +118,8 @@ static const char *error_int_name(grpc_error_ints key) {
115
118
  return "wsa_error";
116
119
  case GRPC_ERROR_INT_HTTP_STATUS:
117
120
  return "http_status";
121
+ case GRPC_ERROR_INT_LIMIT:
122
+ return "limit";
118
123
  }
119
124
  GPR_UNREACHABLE_CODE(return "unknown");
120
125
  }
@@ -169,8 +174,8 @@ static bool is_special(grpc_error *err) {
169
174
  grpc_error *grpc_error_ref(grpc_error *err, const char *file, int line,
170
175
  const char *func) {
171
176
  if (is_special(err)) return err;
172
- gpr_log(GPR_DEBUG, "%p: %d -> %d [%s:%d %s]", err, err->refs.count,
173
- err->refs.count + 1, file, line, func);
177
+ gpr_log(GPR_DEBUG, "%p: %" PRIdPTR " -> %" PRIdPTR " [%s:%d %s]", err,
178
+ err->refs.count, err->refs.count + 1, file, line, func);
174
179
  gpr_ref(&err->refs);
175
180
  return err;
176
181
  }
@@ -195,8 +200,8 @@ static void error_destroy(grpc_error *err) {
195
200
  void grpc_error_unref(grpc_error *err, const char *file, int line,
196
201
  const char *func) {
197
202
  if (is_special(err)) return;
198
- gpr_log(GPR_DEBUG, "%p: %d -> %d [%s:%d %s]", err, err->refs.count,
199
- err->refs.count - 1, file, line, func);
203
+ gpr_log(GPR_DEBUG, "%p: %" PRIdPTR " -> %" PRIdPTR " [%s:%d %s]", err,
204
+ err->refs.count, err->refs.count - 1, file, line, func);
200
205
  if (gpr_unref(&err->refs)) {
201
206
  error_destroy(err);
202
207
  }
@@ -213,6 +218,7 @@ void grpc_error_unref(grpc_error *err) {
213
218
  grpc_error *grpc_error_create(const char *file, int line, const char *desc,
214
219
  grpc_error **referencing,
215
220
  size_t num_referencing) {
221
+ GPR_TIMER_BEGIN("grpc_error_create", 0);
216
222
  grpc_error *err = gpr_malloc(sizeof(*err));
217
223
  if (err == NULL) { // TODO(ctiller): make gpr_malloc return NULL
218
224
  return GRPC_ERROR_OOM;
@@ -238,57 +244,91 @@ grpc_error *grpc_error_create(const char *file, int line, const char *desc,
238
244
  (void *)(uintptr_t)GRPC_ERROR_TIME_CREATED,
239
245
  box_time(gpr_now(GPR_CLOCK_REALTIME)));
240
246
  gpr_ref_init(&err->refs, 1);
247
+ GPR_TIMER_END("grpc_error_create", 0);
241
248
  return err;
242
249
  }
243
250
 
244
251
  static grpc_error *copy_error_and_unref(grpc_error *in) {
252
+ GPR_TIMER_BEGIN("copy_error_and_unref", 0);
253
+ grpc_error *out;
245
254
  if (is_special(in)) {
246
- if (in == GRPC_ERROR_NONE) return GRPC_ERROR_CREATE("no error");
247
- if (in == GRPC_ERROR_OOM) return GRPC_ERROR_CREATE("oom");
248
- if (in == GRPC_ERROR_CANCELLED) return GRPC_ERROR_CREATE("cancelled");
249
- return GRPC_ERROR_CREATE("unknown");
250
- }
251
- grpc_error *out = gpr_malloc(sizeof(*out));
255
+ if (in == GRPC_ERROR_NONE)
256
+ out = GRPC_ERROR_CREATE("no error");
257
+ else if (in == GRPC_ERROR_OOM)
258
+ out = GRPC_ERROR_CREATE("oom");
259
+ else if (in == GRPC_ERROR_CANCELLED)
260
+ out =
261
+ grpc_error_set_int(GRPC_ERROR_CREATE("cancelled"),
262
+ GRPC_ERROR_INT_GRPC_STATUS, GRPC_STATUS_CANCELLED);
263
+ else
264
+ out = GRPC_ERROR_CREATE("unknown");
265
+ } else {
266
+ out = gpr_malloc(sizeof(*out));
252
267
  #ifdef GRPC_ERROR_REFCOUNT_DEBUG
253
- gpr_log(GPR_DEBUG, "%p create copying", out);
268
+ gpr_log(GPR_DEBUG, "%p create copying", out);
254
269
  #endif
255
- out->ints = gpr_avl_ref(in->ints);
256
- out->strs = gpr_avl_ref(in->strs);
257
- out->errs = gpr_avl_ref(in->errs);
258
- out->times = gpr_avl_ref(in->times);
259
- out->next_err = in->next_err;
260
- gpr_ref_init(&out->refs, 1);
261
- GRPC_ERROR_UNREF(in);
270
+ out->ints = gpr_avl_ref(in->ints);
271
+ out->strs = gpr_avl_ref(in->strs);
272
+ out->errs = gpr_avl_ref(in->errs);
273
+ out->times = gpr_avl_ref(in->times);
274
+ out->next_err = in->next_err;
275
+ gpr_ref_init(&out->refs, 1);
276
+ GRPC_ERROR_UNREF(in);
277
+ }
278
+ GPR_TIMER_END("copy_error_and_unref", 0);
262
279
  return out;
263
280
  }
264
281
 
265
282
  grpc_error *grpc_error_set_int(grpc_error *src, grpc_error_ints which,
266
283
  intptr_t value) {
284
+ GPR_TIMER_BEGIN("grpc_error_set_int", 0);
267
285
  grpc_error *new = copy_error_and_unref(src);
268
286
  new->ints = gpr_avl_add(new->ints, (void *)(uintptr_t)which, (void *)value);
287
+ GPR_TIMER_END("grpc_error_set_int", 0);
269
288
  return new;
270
289
  }
271
290
 
272
291
  bool grpc_error_get_int(grpc_error *err, grpc_error_ints which, intptr_t *p) {
292
+ GPR_TIMER_BEGIN("grpc_error_get_int", 0);
273
293
  void *pp;
294
+ if (is_special(err)) {
295
+ if (err == GRPC_ERROR_CANCELLED && which == GRPC_ERROR_INT_GRPC_STATUS) {
296
+ *p = GRPC_STATUS_CANCELLED;
297
+ GPR_TIMER_END("grpc_error_get_int", 0);
298
+ return true;
299
+ }
300
+ GPR_TIMER_END("grpc_error_get_int", 0);
301
+ return false;
302
+ }
274
303
  if (gpr_avl_maybe_get(err->ints, (void *)(uintptr_t)which, &pp)) {
275
304
  if (p != NULL) *p = (intptr_t)pp;
305
+ GPR_TIMER_END("grpc_error_get_int", 0);
276
306
  return true;
277
307
  }
308
+ GPR_TIMER_END("grpc_error_get_int", 0);
278
309
  return false;
279
310
  }
280
311
 
281
312
  grpc_error *grpc_error_set_str(grpc_error *src, grpc_error_strs which,
282
313
  const char *value) {
314
+ GPR_TIMER_BEGIN("grpc_error_set_str", 0);
283
315
  grpc_error *new = copy_error_and_unref(src);
284
316
  new->strs =
285
317
  gpr_avl_add(new->strs, (void *)(uintptr_t)which, gpr_strdup(value));
318
+ GPR_TIMER_END("grpc_error_set_str", 0);
286
319
  return new;
287
320
  }
288
321
 
322
+ const char *grpc_error_get_str(grpc_error *err, grpc_error_strs which) {
323
+ if (is_special(err)) return NULL;
324
+ return gpr_avl_get(err->strs, (void *)(uintptr_t)which);
325
+ }
326
+
289
327
  grpc_error *grpc_error_add_child(grpc_error *src, grpc_error *child) {
328
+ GPR_TIMER_BEGIN("grpc_error_add_child", 0);
290
329
  grpc_error *new = copy_error_and_unref(src);
291
330
  new->errs = gpr_avl_add(new->errs, (void *)(new->next_err++), child);
331
+ GPR_TIMER_END("grpc_error_add_child", 0);
292
332
  return new;
293
333
  }
294
334
 
@@ -480,6 +520,7 @@ void grpc_error_free_string(const char *str) {
480
520
  }
481
521
 
482
522
  const char *grpc_error_string(grpc_error *err) {
523
+ GPR_TIMER_BEGIN("grpc_error_string", 0);
483
524
  if (err == GRPC_ERROR_NONE) return no_error_string;
484
525
  if (err == GRPC_ERROR_OOM) return oom_error_string;
485
526
  if (err == GRPC_ERROR_CANCELLED) return cancelled_error_string;
@@ -496,7 +537,9 @@ const char *grpc_error_string(grpc_error *err) {
496
537
 
497
538
  qsort(kvs.kvs, kvs.num_kvs, sizeof(kv_pair), cmp_kvs);
498
539
 
499
- return finish_kvs(&kvs);
540
+ const char *out = finish_kvs(&kvs);
541
+ GPR_TIMER_END("grpc_error_string", 0);
542
+ return out;
500
543
  }
501
544
 
502
545
  grpc_error *grpc_os_error(const char *file, int line, int err,
@@ -92,6 +92,8 @@ typedef enum {
92
92
  GRPC_ERROR_INT_FD,
93
93
  /// HTTP status (i.e. 404)
94
94
  GRPC_ERROR_INT_HTTP_STATUS,
95
+ /// context sensitive limit associated with the error
96
+ GRPC_ERROR_INT_LIMIT,
95
97
  } grpc_error_ints;
96
98
 
97
99
  typedef enum {
@@ -163,23 +165,25 @@ void grpc_error_unref(grpc_error *err);
163
165
  #endif
164
166
 
165
167
  grpc_error *grpc_error_set_int(grpc_error *src, grpc_error_ints which,
166
- intptr_t value);
168
+ intptr_t value) GRPC_MUST_USE_RESULT;
167
169
  bool grpc_error_get_int(grpc_error *error, grpc_error_ints which, intptr_t *p);
168
170
  grpc_error *grpc_error_set_time(grpc_error *src, grpc_error_times which,
169
- gpr_timespec value);
171
+ gpr_timespec value) GRPC_MUST_USE_RESULT;
170
172
  grpc_error *grpc_error_set_str(grpc_error *src, grpc_error_strs which,
171
- const char *value);
173
+ const char *value) GRPC_MUST_USE_RESULT;
174
+ const char *grpc_error_get_str(grpc_error *error, grpc_error_strs which);
172
175
  /// Add a child error: an error that is believed to have contributed to this
173
176
  /// error occurring. Allows root causing high level errors from lower level
174
177
  /// errors that contributed to them.
175
- grpc_error *grpc_error_add_child(grpc_error *src, grpc_error *child);
178
+ grpc_error *grpc_error_add_child(grpc_error *src,
179
+ grpc_error *child) GRPC_MUST_USE_RESULT;
176
180
  grpc_error *grpc_os_error(const char *file, int line, int err,
177
- const char *call_name);
181
+ const char *call_name) GRPC_MUST_USE_RESULT;
178
182
  /// create an error associated with errno!=0 (an 'operating system' error)
179
183
  #define GRPC_OS_ERROR(err, call_name) \
180
184
  grpc_os_error(__FILE__, __LINE__, err, call_name)
181
185
  grpc_error *grpc_wsa_error(const char *file, int line, int err,
182
- const char *call_name);
186
+ const char *call_name) GRPC_MUST_USE_RESULT;
183
187
  /// windows only: create an error associated with WSAGetLastError()!=0
184
188
  #define GRPC_WSA_ERROR(err, call_name) \
185
189
  grpc_wsa_error(__FILE__, __LINE__, err, call_name)
@@ -0,0 +1,1872 @@
1
+ /*
2
+ *
3
+ * Copyright 2016, Google Inc.
4
+ * All rights reserved.
5
+ *
6
+ * Redistribution and use in source and binary forms, with or without
7
+ * modification, are permitted provided that the following conditions are
8
+ * met:
9
+ *
10
+ * * Redistributions of source code must retain the above copyright
11
+ * notice, this list of conditions and the following disclaimer.
12
+ * * Redistributions in binary form must reproduce the above
13
+ * copyright notice, this list of conditions and the following disclaimer
14
+ * in the documentation and/or other materials provided with the
15
+ * distribution.
16
+ * * Neither the name of Google Inc. nor the names of its
17
+ * contributors may be used to endorse or promote products derived from
18
+ * this software without specific prior written permission.
19
+ *
20
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
+ *
32
+ */
33
+
34
+ #include <grpc/grpc_posix.h>
35
+ #include <grpc/support/port_platform.h>
36
+
37
+ /* This polling engine is only relevant on linux kernels supporting epoll() */
38
+ #ifdef GPR_LINUX_EPOLL
39
+
40
+ #include "src/core/lib/iomgr/ev_epoll_linux.h"
41
+
42
+ #include <assert.h>
43
+ #include <errno.h>
44
+ #include <poll.h>
45
+ #include <signal.h>
46
+ #include <string.h>
47
+ #include <sys/epoll.h>
48
+ #include <sys/socket.h>
49
+ #include <unistd.h>
50
+
51
+ #include <grpc/support/alloc.h>
52
+ #include <grpc/support/log.h>
53
+ #include <grpc/support/string_util.h>
54
+ #include <grpc/support/tls.h>
55
+ #include <grpc/support/useful.h>
56
+
57
+ #include "src/core/lib/iomgr/ev_posix.h"
58
+ #include "src/core/lib/iomgr/iomgr_internal.h"
59
+ #include "src/core/lib/iomgr/wakeup_fd_posix.h"
60
+ #include "src/core/lib/profiling/timers.h"
61
+ #include "src/core/lib/support/block_annotate.h"
62
+
63
+ /* TODO: sreek - Move this to init.c and initialize this like other tracers. */
64
+ static int grpc_polling_trace = 0; /* Disabled by default */
65
+ #define GRPC_POLLING_TRACE(fmt, ...) \
66
+ if (grpc_polling_trace) { \
67
+ gpr_log(GPR_INFO, (fmt), __VA_ARGS__); \
68
+ }
69
+
70
+ static int grpc_wakeup_signal = -1;
71
+ static bool is_grpc_wakeup_signal_initialized = false;
72
+
73
+ /* Implements the function defined in grpc_posix.h. This function might be
74
+ * called before even calling grpc_init() to set either a different signal to
75
+ * use. If signum == -1, then the use of signals is disabled */
76
+ void grpc_use_signal(int signum) {
77
+ grpc_wakeup_signal = signum;
78
+ is_grpc_wakeup_signal_initialized = true;
79
+
80
+ if (grpc_wakeup_signal < 0) {
81
+ gpr_log(GPR_INFO,
82
+ "Use of signals is disabled. Epoll engine will not be used");
83
+ } else {
84
+ gpr_log(GPR_INFO, "epoll engine will be using signal: %d",
85
+ grpc_wakeup_signal);
86
+ }
87
+ }
88
+
89
+ struct polling_island;
90
+
91
+ /*******************************************************************************
92
+ * Fd Declarations
93
+ */
94
+ struct grpc_fd {
95
+ int fd;
96
+ /* refst format:
97
+ bit 0 : 1=Active / 0=Orphaned
98
+ bits 1-n : refcount
99
+ Ref/Unref by two to avoid altering the orphaned bit */
100
+ gpr_atm refst;
101
+
102
+ gpr_mu mu;
103
+
104
+ /* Indicates that the fd is shutdown and that any pending read/write closures
105
+ should fail */
106
+ bool shutdown;
107
+
108
+ /* The fd is either closed or we relinquished control of it. In either cases,
109
+ this indicates that the 'fd' on this structure is no longer valid */
110
+ bool orphaned;
111
+
112
+ /* TODO: sreek - Move this to a lockfree implementation */
113
+ grpc_closure *read_closure;
114
+ grpc_closure *write_closure;
115
+
116
+ /* The polling island to which this fd belongs to and the mutex protecting the
117
+ the field */
118
+ gpr_mu pi_mu;
119
+ struct polling_island *polling_island;
120
+
121
+ struct grpc_fd *freelist_next;
122
+ grpc_closure *on_done_closure;
123
+
124
+ /* The pollset that last noticed that the fd is readable */
125
+ grpc_pollset *read_notifier_pollset;
126
+
127
+ grpc_iomgr_object iomgr_object;
128
+ };
129
+
130
+ /* Reference counting for fds */
131
+ // #define GRPC_FD_REF_COUNT_DEBUG
132
+ #ifdef GRPC_FD_REF_COUNT_DEBUG
133
+ static void fd_ref(grpc_fd *fd, const char *reason, const char *file, int line);
134
+ static void fd_unref(grpc_fd *fd, const char *reason, const char *file,
135
+ int line);
136
+ #define GRPC_FD_REF(fd, reason) fd_ref(fd, reason, __FILE__, __LINE__)
137
+ #define GRPC_FD_UNREF(fd, reason) fd_unref(fd, reason, __FILE__, __LINE__)
138
+ #else
139
+ static void fd_ref(grpc_fd *fd);
140
+ static void fd_unref(grpc_fd *fd);
141
+ #define GRPC_FD_REF(fd, reason) fd_ref(fd)
142
+ #define GRPC_FD_UNREF(fd, reason) fd_unref(fd)
143
+ #endif
144
+
145
+ static void fd_global_init(void);
146
+ static void fd_global_shutdown(void);
147
+
148
+ #define CLOSURE_NOT_READY ((grpc_closure *)0)
149
+ #define CLOSURE_READY ((grpc_closure *)1)
150
+
151
+ /*******************************************************************************
152
+ * Polling island Declarations
153
+ */
154
+
155
+ // #define GRPC_PI_REF_COUNT_DEBUG
156
+ #ifdef GRPC_PI_REF_COUNT_DEBUG
157
+
158
+ #define PI_ADD_REF(p, r) pi_add_ref_dbg((p), (r), __FILE__, __LINE__)
159
+ #define PI_UNREF(p, r) pi_unref_dbg((p), (r), __FILE__, __LINE__)
160
+
161
+ #else /* defined(GRPC_PI_REF_COUNT_DEBUG) */
162
+
163
+ #define PI_ADD_REF(p, r) pi_add_ref((p))
164
+ #define PI_UNREF(p, r) pi_unref((p))
165
+
166
+ #endif /* !defined(GPRC_PI_REF_COUNT_DEBUG) */
167
+
168
+ typedef struct polling_island {
169
+ gpr_mu mu;
170
+ /* Ref count. Use PI_ADD_REF() and PI_UNREF() macros to increment/decrement
171
+ the refcount.
172
+ Once the ref count becomes zero, this structure is destroyed which means
173
+ we should ensure that there is never a scenario where a PI_ADD_REF() is
174
+ racing with a PI_UNREF() that just made the ref_count zero. */
175
+ gpr_refcount ref_count;
176
+
177
+ /* Pointer to the polling_island this merged into.
178
+ * merged_to value is only set once in polling_island's lifetime (and that too
179
+ * only if the island is merged with another island). Because of this, we can
180
+ * use gpr_atm type here so that we can do atomic access on this and reduce
181
+ * lock contention on 'mu' mutex.
182
+ *
183
+ * Note that if this field is not NULL (i.e not 0), all the remaining fields
184
+ * (except mu and ref_count) are invalid and must be ignored. */
185
+ gpr_atm merged_to;
186
+
187
+ /* The fd of the underlying epoll set */
188
+ int epoll_fd;
189
+
190
+ /* The file descriptors in the epoll set */
191
+ size_t fd_cnt;
192
+ size_t fd_capacity;
193
+ grpc_fd **fds;
194
+
195
+ /* Polling islands that are no longer needed are kept in a freelist so that
196
+ they can be reused. This field points to the next polling island in the
197
+ free list */
198
+ struct polling_island *next_free;
199
+ } polling_island;
200
+
201
+ /*******************************************************************************
202
+ * Pollset Declarations
203
+ */
204
+ struct grpc_pollset_worker {
205
+ /* Thread id of this worker */
206
+ pthread_t pt_id;
207
+
208
+ /* Used to prevent a worker from getting kicked multiple times */
209
+ gpr_atm is_kicked;
210
+ struct grpc_pollset_worker *next;
211
+ struct grpc_pollset_worker *prev;
212
+ };
213
+
214
+ struct grpc_pollset {
215
+ gpr_mu mu;
216
+ grpc_pollset_worker root_worker;
217
+ bool kicked_without_pollers;
218
+
219
+ bool shutting_down; /* Is the pollset shutting down ? */
220
+ bool finish_shutdown_called; /* Is the 'finish_shutdown_locked()' called ? */
221
+ grpc_closure *shutdown_done; /* Called after after shutdown is complete */
222
+
223
+ /* The polling island to which this pollset belongs to */
224
+ struct polling_island *polling_island;
225
+ };
226
+
227
+ /*******************************************************************************
228
+ * Pollset-set Declarations
229
+ */
230
+ /* TODO: sreek - Change the pollset_set implementation such that a pollset_set
231
+ * directly points to a polling_island (and adding an fd/pollset/pollset_set to
232
+ * the current pollset_set would result in polling island merges. This would
233
+ * remove the need to maintain fd_count here. This will also significantly
234
+ * simplify the grpc_fd structure since we would no longer need to explicitly
235
+ * maintain the orphaned state */
236
+ struct grpc_pollset_set {
237
+ gpr_mu mu;
238
+
239
+ size_t pollset_count;
240
+ size_t pollset_capacity;
241
+ grpc_pollset **pollsets;
242
+
243
+ size_t pollset_set_count;
244
+ size_t pollset_set_capacity;
245
+ struct grpc_pollset_set **pollset_sets;
246
+
247
+ size_t fd_count;
248
+ size_t fd_capacity;
249
+ grpc_fd **fds;
250
+ };
251
+
252
+ /*******************************************************************************
253
+ * Common helpers
254
+ */
255
+
256
+ static void append_error(grpc_error **composite, grpc_error *error,
257
+ const char *desc) {
258
+ if (error == GRPC_ERROR_NONE) return;
259
+ if (*composite == GRPC_ERROR_NONE) {
260
+ *composite = GRPC_ERROR_CREATE(desc);
261
+ }
262
+ *composite = grpc_error_add_child(*composite, error);
263
+ }
264
+
265
+ /*******************************************************************************
266
+ * Polling island Definitions
267
+ */
268
+
269
+ /* The wakeup fd that is used to wake up all threads in a Polling island. This
270
+ is useful in the polling island merge operation where we need to wakeup all
271
+ the threads currently polling the smaller polling island (so that they can
272
+ start polling the new/merged polling island)
273
+
274
+ NOTE: This fd is initialized to be readable and MUST NOT be consumed i.e the
275
+ threads that woke up MUST NOT call grpc_wakeup_fd_consume_wakeup() */
276
+ static grpc_wakeup_fd polling_island_wakeup_fd;
277
+
278
+ /* Polling island freelist */
279
+ static gpr_mu g_pi_freelist_mu;
280
+ static polling_island *g_pi_freelist = NULL;
281
+
282
+ static void polling_island_delete(); /* Forward declaration */
283
+
284
+ #ifdef GRPC_TSAN
285
+ /* Currently TSAN may incorrectly flag data races between epoll_ctl and
286
+ epoll_wait for any grpc_fd structs that are added to the epoll set via
287
+ epoll_ctl and are returned (within a very short window) via epoll_wait().
288
+
289
+ To work-around this race, we establish a happens-before relation between
290
+ the code just-before epoll_ctl() and the code after epoll_wait() by using
291
+ this atomic */
292
+ gpr_atm g_epoll_sync;
293
+ #endif /* defined(GRPC_TSAN) */
294
+
295
+ #ifdef GRPC_PI_REF_COUNT_DEBUG
296
+ void pi_add_ref(polling_island *pi);
297
+ void pi_unref(polling_island *pi);
298
+
299
+ void pi_add_ref_dbg(polling_island *pi, char *reason, char *file, int line) {
300
+ long old_cnt = gpr_atm_acq_load(&(pi->ref_count.count));
301
+ pi_add_ref(pi);
302
+ gpr_log(GPR_DEBUG, "Add ref pi: %p, old: %ld -> new:%ld (%s) - (%s, %d)",
303
+ (void *)pi, old_cnt, old_cnt + 1, reason, file, line);
304
+ }
305
+
306
+ void pi_unref_dbg(polling_island *pi, char *reason, char *file, int line) {
307
+ long old_cnt = gpr_atm_acq_load(&(pi->ref_count.count));
308
+ pi_unref(pi);
309
+ gpr_log(GPR_DEBUG, "Unref pi: %p, old:%ld -> new:%ld (%s) - (%s, %d)",
310
+ (void *)pi, old_cnt, (old_cnt - 1), reason, file, line);
311
+ }
312
+ #endif
313
+
314
+ void pi_add_ref(polling_island *pi) { gpr_ref(&pi->ref_count); }
315
+
316
+ void pi_unref(polling_island *pi) {
317
+ /* If ref count went to zero, delete the polling island.
318
+ Note that this deletion not be done under a lock. Once the ref count goes
319
+ to zero, we are guaranteed that no one else holds a reference to the
320
+ polling island (and that there is no racing pi_add_ref() call either).
321
+
322
+ Also, if we are deleting the polling island and the merged_to field is
323
+ non-empty, we should remove a ref to the merged_to polling island
324
+ */
325
+ if (gpr_unref(&pi->ref_count)) {
326
+ polling_island *next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
327
+ polling_island_delete(pi);
328
+ if (next != NULL) {
329
+ PI_UNREF(next, "pi_delete"); /* Recursive call */
330
+ }
331
+ }
332
+ }
333
+
334
+ /* The caller is expected to hold pi->mu lock before calling this function */
335
+ static void polling_island_add_fds_locked(polling_island *pi, grpc_fd **fds,
336
+ size_t fd_count, bool add_fd_refs,
337
+ grpc_error **error) {
338
+ int err;
339
+ size_t i;
340
+ struct epoll_event ev;
341
+ char *err_msg;
342
+ const char *err_desc = "polling_island_add_fds";
343
+
344
+ #ifdef GRPC_TSAN
345
+ /* See the definition of g_epoll_sync for more context */
346
+ gpr_atm_rel_store(&g_epoll_sync, (gpr_atm)0);
347
+ #endif /* defined(GRPC_TSAN) */
348
+
349
+ for (i = 0; i < fd_count; i++) {
350
+ ev.events = (uint32_t)(EPOLLIN | EPOLLOUT | EPOLLET);
351
+ ev.data.ptr = fds[i];
352
+ err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_ADD, fds[i]->fd, &ev);
353
+
354
+ if (err < 0) {
355
+ if (errno != EEXIST) {
356
+ gpr_asprintf(
357
+ &err_msg,
358
+ "epoll_ctl (epoll_fd: %d) add fd: %d failed with error: %d (%s)",
359
+ pi->epoll_fd, fds[i]->fd, errno, strerror(errno));
360
+ append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
361
+ gpr_free(err_msg);
362
+ }
363
+
364
+ continue;
365
+ }
366
+
367
+ if (pi->fd_cnt == pi->fd_capacity) {
368
+ pi->fd_capacity = GPR_MAX(pi->fd_capacity + 8, pi->fd_cnt * 3 / 2);
369
+ pi->fds = gpr_realloc(pi->fds, sizeof(grpc_fd *) * pi->fd_capacity);
370
+ }
371
+
372
+ pi->fds[pi->fd_cnt++] = fds[i];
373
+ if (add_fd_refs) {
374
+ GRPC_FD_REF(fds[i], "polling_island");
375
+ }
376
+ }
377
+ }
378
+
379
+ /* The caller is expected to hold pi->mu before calling this */
380
+ static void polling_island_add_wakeup_fd_locked(polling_island *pi,
381
+ grpc_wakeup_fd *wakeup_fd,
382
+ grpc_error **error) {
383
+ struct epoll_event ev;
384
+ int err;
385
+ char *err_msg;
386
+ const char *err_desc = "polling_island_add_wakeup_fd";
387
+
388
+ ev.events = (uint32_t)(EPOLLIN | EPOLLET);
389
+ ev.data.ptr = wakeup_fd;
390
+ err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_ADD,
391
+ GRPC_WAKEUP_FD_GET_READ_FD(wakeup_fd), &ev);
392
+ if (err < 0 && errno != EEXIST) {
393
+ gpr_asprintf(&err_msg,
394
+ "epoll_ctl (epoll_fd: %d) add wakeup fd: %d failed with "
395
+ "error: %d (%s)",
396
+ pi->epoll_fd,
397
+ GRPC_WAKEUP_FD_GET_READ_FD(&grpc_global_wakeup_fd), errno,
398
+ strerror(errno));
399
+ append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
400
+ gpr_free(err_msg);
401
+ }
402
+ }
403
+
404
+ /* The caller is expected to hold pi->mu lock before calling this function */
405
+ static void polling_island_remove_all_fds_locked(polling_island *pi,
406
+ bool remove_fd_refs,
407
+ grpc_error **error) {
408
+ int err;
409
+ size_t i;
410
+ char *err_msg;
411
+ const char *err_desc = "polling_island_remove_fds";
412
+
413
+ for (i = 0; i < pi->fd_cnt; i++) {
414
+ err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_DEL, pi->fds[i]->fd, NULL);
415
+ if (err < 0 && errno != ENOENT) {
416
+ gpr_asprintf(&err_msg,
417
+ "epoll_ctl (epoll_fd: %d) delete fds[%zu]: %d failed with "
418
+ "error: %d (%s)",
419
+ pi->epoll_fd, i, pi->fds[i]->fd, errno, strerror(errno));
420
+ append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
421
+ gpr_free(err_msg);
422
+ }
423
+
424
+ if (remove_fd_refs) {
425
+ GRPC_FD_UNREF(pi->fds[i], "polling_island");
426
+ }
427
+ }
428
+
429
+ pi->fd_cnt = 0;
430
+ }
431
+
432
+ /* The caller is expected to hold pi->mu lock before calling this function */
433
+ static void polling_island_remove_fd_locked(polling_island *pi, grpc_fd *fd,
434
+ bool is_fd_closed,
435
+ grpc_error **error) {
436
+ int err;
437
+ size_t i;
438
+ char *err_msg;
439
+ const char *err_desc = "polling_island_remove_fd";
440
+
441
+ /* If fd is already closed, then it would have been automatically been removed
442
+ from the epoll set */
443
+ if (!is_fd_closed) {
444
+ err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_DEL, fd->fd, NULL);
445
+ if (err < 0 && errno != ENOENT) {
446
+ gpr_asprintf(
447
+ &err_msg,
448
+ "epoll_ctl (epoll_fd: %d) del fd: %d failed with error: %d (%s)",
449
+ pi->epoll_fd, fd->fd, errno, strerror(errno));
450
+ append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
451
+ gpr_free(err_msg);
452
+ }
453
+ }
454
+
455
+ for (i = 0; i < pi->fd_cnt; i++) {
456
+ if (pi->fds[i] == fd) {
457
+ pi->fds[i] = pi->fds[--pi->fd_cnt];
458
+ GRPC_FD_UNREF(fd, "polling_island");
459
+ break;
460
+ }
461
+ }
462
+ }
463
+
464
+ /* Might return NULL in case of an error */
465
+ static polling_island *polling_island_create(grpc_fd *initial_fd,
466
+ grpc_error **error) {
467
+ polling_island *pi = NULL;
468
+ char *err_msg;
469
+ const char *err_desc = "polling_island_create";
470
+
471
+ /* Try to get one from the polling island freelist */
472
+ gpr_mu_lock(&g_pi_freelist_mu);
473
+ if (g_pi_freelist != NULL) {
474
+ pi = g_pi_freelist;
475
+ g_pi_freelist = g_pi_freelist->next_free;
476
+ pi->next_free = NULL;
477
+ }
478
+ gpr_mu_unlock(&g_pi_freelist_mu);
479
+
480
+ /* Create new polling island if we could not get one from the free list */
481
+ if (pi == NULL) {
482
+ pi = gpr_malloc(sizeof(*pi));
483
+ gpr_mu_init(&pi->mu);
484
+ pi->fd_cnt = 0;
485
+ pi->fd_capacity = 0;
486
+ pi->fds = NULL;
487
+ }
488
+
489
+ gpr_ref_init(&pi->ref_count, 0);
490
+ gpr_atm_rel_store(&pi->merged_to, (gpr_atm)NULL);
491
+
492
+ pi->epoll_fd = epoll_create1(EPOLL_CLOEXEC);
493
+
494
+ if (pi->epoll_fd < 0) {
495
+ gpr_asprintf(&err_msg, "epoll_create1 failed with error %d (%s)", errno,
496
+ strerror(errno));
497
+ append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
498
+ gpr_free(err_msg);
499
+ } else {
500
+ polling_island_add_wakeup_fd_locked(pi, &grpc_global_wakeup_fd, error);
501
+ pi->next_free = NULL;
502
+
503
+ if (initial_fd != NULL) {
504
+ /* Lock the polling island here just in case we got this structure from
505
+ the freelist and the polling island lock was not released yet (by the
506
+ code that adds the polling island to the freelist) */
507
+ gpr_mu_lock(&pi->mu);
508
+ polling_island_add_fds_locked(pi, &initial_fd, 1, true, error);
509
+ gpr_mu_unlock(&pi->mu);
510
+ }
511
+ }
512
+
513
+ return pi;
514
+ }
515
+
516
+ static void polling_island_delete(polling_island *pi) {
517
+ GPR_ASSERT(pi->fd_cnt == 0);
518
+
519
+ gpr_atm_rel_store(&pi->merged_to, (gpr_atm)NULL);
520
+
521
+ close(pi->epoll_fd);
522
+ pi->epoll_fd = -1;
523
+
524
+ gpr_mu_lock(&g_pi_freelist_mu);
525
+ pi->next_free = g_pi_freelist;
526
+ g_pi_freelist = pi;
527
+ gpr_mu_unlock(&g_pi_freelist_mu);
528
+ }
529
+
530
+ /* Attempts to gets the last polling island in the linked list (liked by the
531
+ * 'merged_to' field). Since this does not lock the polling island, there are no
532
+ * guarantees that the island returned is the last island */
533
+ static polling_island *polling_island_maybe_get_latest(polling_island *pi) {
534
+ polling_island *next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
535
+ while (next != NULL) {
536
+ pi = next;
537
+ next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
538
+ }
539
+
540
+ return pi;
541
+ }
542
+
543
+ /* Gets the lock on the *latest* polling island i.e the last polling island in
544
+ the linked list (linked by the 'merged_to' field). Call gpr_mu_unlock on the
545
+ returned polling island's mu.
546
+ Usage: To lock/unlock polling island "pi", do the following:
547
+ polling_island *pi_latest = polling_island_lock(pi);
548
+ ...
549
+ ... critical section ..
550
+ ...
551
+ gpr_mu_unlock(&pi_latest->mu); // NOTE: use pi_latest->mu. NOT pi->mu */
552
+ static polling_island *polling_island_lock(polling_island *pi) {
553
+ polling_island *next = NULL;
554
+
555
+ while (true) {
556
+ next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
557
+ if (next == NULL) {
558
+ /* Looks like 'pi' is the last node in the linked list but unless we check
559
+ this by holding the pi->mu lock, we cannot be sure (i.e without the
560
+ pi->mu lock, we don't prevent island merges).
561
+ To be absolutely sure, check once more by holding the pi->mu lock */
562
+ gpr_mu_lock(&pi->mu);
563
+ next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
564
+ if (next == NULL) {
565
+ /* pi is infact the last node and we have the pi->mu lock. we're done */
566
+ break;
567
+ }
568
+
569
+ /* pi->merged_to is not NULL i.e pi isn't the last node anymore. pi->mu
570
+ * isn't the lock we are interested in. Continue traversing the list */
571
+ gpr_mu_unlock(&pi->mu);
572
+ }
573
+
574
+ pi = next;
575
+ }
576
+
577
+ return pi;
578
+ }
579
+
580
+ /* Gets the lock on the *latest* polling islands in the linked lists pointed by
581
+ *p and *q (and also updates *p and *q to point to the latest polling islands)
582
+
583
+ This function is needed because calling the following block of code to obtain
584
+ locks on polling islands (*p and *q) is prone to deadlocks.
585
+ {
586
+ polling_island_lock(*p, true);
587
+ polling_island_lock(*q, true);
588
+ }
589
+
590
+ Usage/example:
591
+ polling_island *p1;
592
+ polling_island *p2;
593
+ ..
594
+ polling_island_lock_pair(&p1, &p2);
595
+ ..
596
+ .. Critical section with both p1 and p2 locked
597
+ ..
598
+ // Release locks: Always call polling_island_unlock_pair() to release locks
599
+ polling_island_unlock_pair(p1, p2);
600
+ */
601
+ static void polling_island_lock_pair(polling_island **p, polling_island **q) {
602
+ polling_island *pi_1 = *p;
603
+ polling_island *pi_2 = *q;
604
+ polling_island *next_1 = NULL;
605
+ polling_island *next_2 = NULL;
606
+
607
+ /* The algorithm is simple:
608
+ - Go to the last polling islands in the linked lists *pi_1 and *pi_2 (and
609
+ keep updating pi_1 and pi_2)
610
+ - Then obtain locks on the islands by following a lock order rule of
611
+ locking polling_island with lower address first
612
+ Special case: Before obtaining the locks, check if pi_1 and pi_2 are
613
+ pointing to the same island. If that is the case, we can just call
614
+ polling_island_lock()
615
+ - After obtaining both the locks, double check that the polling islands
616
+ are still the last polling islands in their respective linked lists
617
+ (this is because there might have been polling island merges before
618
+ we got the lock)
619
+ - If the polling islands are the last islands, we are done. If not,
620
+ release the locks and continue the process from the first step */
621
+ while (true) {
622
+ next_1 = (polling_island *)gpr_atm_acq_load(&pi_1->merged_to);
623
+ while (next_1 != NULL) {
624
+ pi_1 = next_1;
625
+ next_1 = (polling_island *)gpr_atm_acq_load(&pi_1->merged_to);
626
+ }
627
+
628
+ next_2 = (polling_island *)gpr_atm_acq_load(&pi_2->merged_to);
629
+ while (next_2 != NULL) {
630
+ pi_2 = next_2;
631
+ next_2 = (polling_island *)gpr_atm_acq_load(&pi_2->merged_to);
632
+ }
633
+
634
+ if (pi_1 == pi_2) {
635
+ pi_1 = pi_2 = polling_island_lock(pi_1);
636
+ break;
637
+ }
638
+
639
+ if (pi_1 < pi_2) {
640
+ gpr_mu_lock(&pi_1->mu);
641
+ gpr_mu_lock(&pi_2->mu);
642
+ } else {
643
+ gpr_mu_lock(&pi_2->mu);
644
+ gpr_mu_lock(&pi_1->mu);
645
+ }
646
+
647
+ next_1 = (polling_island *)gpr_atm_acq_load(&pi_1->merged_to);
648
+ next_2 = (polling_island *)gpr_atm_acq_load(&pi_2->merged_to);
649
+ if (next_1 == NULL && next_2 == NULL) {
650
+ break;
651
+ }
652
+
653
+ gpr_mu_unlock(&pi_1->mu);
654
+ gpr_mu_unlock(&pi_2->mu);
655
+ }
656
+
657
+ *p = pi_1;
658
+ *q = pi_2;
659
+ }
660
+
661
+ static void polling_island_unlock_pair(polling_island *p, polling_island *q) {
662
+ if (p == q) {
663
+ gpr_mu_unlock(&p->mu);
664
+ } else {
665
+ gpr_mu_unlock(&p->mu);
666
+ gpr_mu_unlock(&q->mu);
667
+ }
668
+ }
669
+
670
+ static polling_island *polling_island_merge(polling_island *p,
671
+ polling_island *q,
672
+ grpc_error **error) {
673
+ /* Get locks on both the polling islands */
674
+ polling_island_lock_pair(&p, &q);
675
+
676
+ if (p != q) {
677
+ /* Make sure that p points to the polling island with fewer fds than q */
678
+ if (p->fd_cnt > q->fd_cnt) {
679
+ GPR_SWAP(polling_island *, p, q);
680
+ }
681
+
682
+ /* Merge p with q i.e move all the fds from p (The one with fewer fds) to q
683
+ Note that the refcounts on the fds being moved will not change here.
684
+ This is why the last param in the following two functions is 'false') */
685
+ polling_island_add_fds_locked(q, p->fds, p->fd_cnt, false, error);
686
+ polling_island_remove_all_fds_locked(p, false, error);
687
+
688
+ /* Wakeup all the pollers (if any) on p so that they pickup this change */
689
+ polling_island_add_wakeup_fd_locked(p, &polling_island_wakeup_fd, error);
690
+
691
+ /* Add the 'merged_to' link from p --> q */
692
+ gpr_atm_rel_store(&p->merged_to, (gpr_atm)q);
693
+ PI_ADD_REF(q, "pi_merge"); /* To account for the new incoming ref from p */
694
+ }
695
+ /* else if p == q, nothing needs to be done */
696
+
697
+ polling_island_unlock_pair(p, q);
698
+
699
+ /* Return the merged polling island (Note that no merge would have happened
700
+ if p == q which is ok) */
701
+ return q;
702
+ }
703
+
704
+ static grpc_error *polling_island_global_init() {
705
+ grpc_error *error = GRPC_ERROR_NONE;
706
+
707
+ gpr_mu_init(&g_pi_freelist_mu);
708
+ g_pi_freelist = NULL;
709
+
710
+ error = grpc_wakeup_fd_init(&polling_island_wakeup_fd);
711
+ if (error == GRPC_ERROR_NONE) {
712
+ error = grpc_wakeup_fd_wakeup(&polling_island_wakeup_fd);
713
+ }
714
+
715
+ return error;
716
+ }
717
+
718
+ static void polling_island_global_shutdown() {
719
+ polling_island *next;
720
+ gpr_mu_lock(&g_pi_freelist_mu);
721
+ gpr_mu_unlock(&g_pi_freelist_mu);
722
+ while (g_pi_freelist != NULL) {
723
+ next = g_pi_freelist->next_free;
724
+ gpr_mu_destroy(&g_pi_freelist->mu);
725
+ gpr_free(g_pi_freelist->fds);
726
+ gpr_free(g_pi_freelist);
727
+ g_pi_freelist = next;
728
+ }
729
+ gpr_mu_destroy(&g_pi_freelist_mu);
730
+
731
+ grpc_wakeup_fd_destroy(&polling_island_wakeup_fd);
732
+ }
733
+
734
+ /*******************************************************************************
735
+ * Fd Definitions
736
+ */
737
+
738
+ /* We need to keep a freelist not because of any concerns of malloc performance
739
+ * but instead so that implementations with multiple threads in (for example)
740
+ * epoll_wait deal with the race between pollset removal and incoming poll
741
+ * notifications.
742
+ *
743
+ * The problem is that the poller ultimately holds a reference to this
744
+ * object, so it is very difficult to know when is safe to free it, at least
745
+ * without some expensive synchronization.
746
+ *
747
+ * If we keep the object freelisted, in the worst case losing this race just
748
+ * becomes a spurious read notification on a reused fd.
749
+ */
750
+
751
+ /* The alarm system needs to be able to wakeup 'some poller' sometimes
752
+ * (specifically when a new alarm needs to be triggered earlier than the next
753
+ * alarm 'epoch'). This wakeup_fd gives us something to alert on when such a
754
+ * case occurs. */
755
+
756
+ /* TODO: sreek: Right now, this wakes up all pollers. In future we should make
757
+ * sure to wake up one polling thread (which can wake up other threads if
758
+ * needed) */
759
+ grpc_wakeup_fd grpc_global_wakeup_fd;
760
+
761
+ static grpc_fd *fd_freelist = NULL;
762
+ static gpr_mu fd_freelist_mu;
763
+
764
+ #ifdef GRPC_FD_REF_COUNT_DEBUG
765
+ #define REF_BY(fd, n, reason) ref_by(fd, n, reason, __FILE__, __LINE__)
766
+ #define UNREF_BY(fd, n, reason) unref_by(fd, n, reason, __FILE__, __LINE__)
767
+ static void ref_by(grpc_fd *fd, int n, const char *reason, const char *file,
768
+ int line) {
769
+ gpr_log(GPR_DEBUG, "FD %d %p ref %d %ld -> %ld [%s; %s:%d]", fd->fd,
770
+ (void *)fd, n, gpr_atm_no_barrier_load(&fd->refst),
771
+ gpr_atm_no_barrier_load(&fd->refst) + n, reason, file, line);
772
+ #else
773
+ #define REF_BY(fd, n, reason) ref_by(fd, n)
774
+ #define UNREF_BY(fd, n, reason) unref_by(fd, n)
775
+ static void ref_by(grpc_fd *fd, int n) {
776
+ #endif
777
+ GPR_ASSERT(gpr_atm_no_barrier_fetch_add(&fd->refst, n) > 0);
778
+ }
779
+
780
+ #ifdef GRPC_FD_REF_COUNT_DEBUG
781
+ static void unref_by(grpc_fd *fd, int n, const char *reason, const char *file,
782
+ int line) {
783
+ gpr_atm old;
784
+ gpr_log(GPR_DEBUG, "FD %d %p unref %d %ld -> %ld [%s; %s:%d]", fd->fd,
785
+ (void *)fd, n, gpr_atm_no_barrier_load(&fd->refst),
786
+ gpr_atm_no_barrier_load(&fd->refst) - n, reason, file, line);
787
+ #else
788
+ static void unref_by(grpc_fd *fd, int n) {
789
+ gpr_atm old;
790
+ #endif
791
+ old = gpr_atm_full_fetch_add(&fd->refst, -n);
792
+ if (old == n) {
793
+ /* Add the fd to the freelist */
794
+ gpr_mu_lock(&fd_freelist_mu);
795
+ fd->freelist_next = fd_freelist;
796
+ fd_freelist = fd;
797
+ grpc_iomgr_unregister_object(&fd->iomgr_object);
798
+
799
+ gpr_mu_unlock(&fd_freelist_mu);
800
+ } else {
801
+ GPR_ASSERT(old > n);
802
+ }
803
+ }
804
+
805
+ /* Increment refcount by two to avoid changing the orphan bit */
806
+ #ifdef GRPC_FD_REF_COUNT_DEBUG
807
+ static void fd_ref(grpc_fd *fd, const char *reason, const char *file,
808
+ int line) {
809
+ ref_by(fd, 2, reason, file, line);
810
+ }
811
+
812
+ static void fd_unref(grpc_fd *fd, const char *reason, const char *file,
813
+ int line) {
814
+ unref_by(fd, 2, reason, file, line);
815
+ }
816
+ #else
817
+ static void fd_ref(grpc_fd *fd) { ref_by(fd, 2); }
818
+ static void fd_unref(grpc_fd *fd) { unref_by(fd, 2); }
819
+ #endif
820
+
821
+ static void fd_global_init(void) { gpr_mu_init(&fd_freelist_mu); }
822
+
823
+ static void fd_global_shutdown(void) {
824
+ gpr_mu_lock(&fd_freelist_mu);
825
+ gpr_mu_unlock(&fd_freelist_mu);
826
+ while (fd_freelist != NULL) {
827
+ grpc_fd *fd = fd_freelist;
828
+ fd_freelist = fd_freelist->freelist_next;
829
+ gpr_mu_destroy(&fd->mu);
830
+ gpr_free(fd);
831
+ }
832
+ gpr_mu_destroy(&fd_freelist_mu);
833
+ }
834
+
835
+ static grpc_fd *fd_create(int fd, const char *name) {
836
+ grpc_fd *new_fd = NULL;
837
+
838
+ gpr_mu_lock(&fd_freelist_mu);
839
+ if (fd_freelist != NULL) {
840
+ new_fd = fd_freelist;
841
+ fd_freelist = fd_freelist->freelist_next;
842
+ }
843
+ gpr_mu_unlock(&fd_freelist_mu);
844
+
845
+ if (new_fd == NULL) {
846
+ new_fd = gpr_malloc(sizeof(grpc_fd));
847
+ gpr_mu_init(&new_fd->mu);
848
+ gpr_mu_init(&new_fd->pi_mu);
849
+ }
850
+
851
+ /* Note: It is not really needed to get the new_fd->mu lock here. If this is a
852
+ newly created fd (or an fd we got from the freelist), no one else would be
853
+ holding a lock to it anyway. */
854
+ gpr_mu_lock(&new_fd->mu);
855
+
856
+ gpr_atm_rel_store(&new_fd->refst, (gpr_atm)1);
857
+ new_fd->fd = fd;
858
+ new_fd->shutdown = false;
859
+ new_fd->orphaned = false;
860
+ new_fd->read_closure = CLOSURE_NOT_READY;
861
+ new_fd->write_closure = CLOSURE_NOT_READY;
862
+ new_fd->polling_island = NULL;
863
+ new_fd->freelist_next = NULL;
864
+ new_fd->on_done_closure = NULL;
865
+ new_fd->read_notifier_pollset = NULL;
866
+
867
+ gpr_mu_unlock(&new_fd->mu);
868
+
869
+ char *fd_name;
870
+ gpr_asprintf(&fd_name, "%s fd=%d", name, fd);
871
+ grpc_iomgr_register_object(&new_fd->iomgr_object, fd_name);
872
+ #ifdef GRPC_FD_REF_COUNT_DEBUG
873
+ gpr_log(GPR_DEBUG, "FD %d %p create %s", fd, (void *)new_fd, fd_name);
874
+ #endif
875
+ gpr_free(fd_name);
876
+ return new_fd;
877
+ }
878
+
879
+ static bool fd_is_orphaned(grpc_fd *fd) {
880
+ return (gpr_atm_acq_load(&fd->refst) & 1) == 0;
881
+ }
882
+
883
+ static int fd_wrapped_fd(grpc_fd *fd) {
884
+ int ret_fd = -1;
885
+ gpr_mu_lock(&fd->mu);
886
+ if (!fd->orphaned) {
887
+ ret_fd = fd->fd;
888
+ }
889
+ gpr_mu_unlock(&fd->mu);
890
+
891
+ return ret_fd;
892
+ }
893
+
894
+ static void fd_orphan(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
895
+ grpc_closure *on_done, int *release_fd,
896
+ const char *reason) {
897
+ bool is_fd_closed = false;
898
+ grpc_error *error = GRPC_ERROR_NONE;
899
+
900
+ gpr_mu_lock(&fd->mu);
901
+ fd->on_done_closure = on_done;
902
+
903
+ /* If release_fd is not NULL, we should be relinquishing control of the file
904
+ descriptor fd->fd (but we still own the grpc_fd structure). */
905
+ if (release_fd != NULL) {
906
+ *release_fd = fd->fd;
907
+ } else {
908
+ close(fd->fd);
909
+ is_fd_closed = true;
910
+ }
911
+
912
+ fd->orphaned = true;
913
+
914
+ /* Remove the active status but keep referenced. We want this grpc_fd struct
915
+ to be alive (and not added to freelist) until the end of this function */
916
+ REF_BY(fd, 1, reason);
917
+
918
+ /* Remove the fd from the polling island:
919
+ - Get a lock on the latest polling island (i.e the last island in the
920
+ linked list pointed by fd->polling_island). This is the island that
921
+ would actually contain the fd
922
+ - Remove the fd from the latest polling island
923
+ - Unlock the latest polling island
924
+ - Set fd->polling_island to NULL (but remove the ref on the polling island
925
+ before doing this.) */
926
+ gpr_mu_lock(&fd->pi_mu);
927
+ if (fd->polling_island != NULL) {
928
+ polling_island *pi_latest = polling_island_lock(fd->polling_island);
929
+ polling_island_remove_fd_locked(pi_latest, fd, is_fd_closed, &error);
930
+ gpr_mu_unlock(&pi_latest->mu);
931
+
932
+ PI_UNREF(fd->polling_island, "fd_orphan");
933
+ fd->polling_island = NULL;
934
+ }
935
+ gpr_mu_unlock(&fd->pi_mu);
936
+
937
+ grpc_exec_ctx_sched(exec_ctx, fd->on_done_closure, error, NULL);
938
+
939
+ gpr_mu_unlock(&fd->mu);
940
+ UNREF_BY(fd, 2, reason); /* Drop the reference */
941
+ GRPC_LOG_IF_ERROR("fd_orphan", GRPC_ERROR_REF(error));
942
+ }
943
+
944
+ static grpc_error *fd_shutdown_error(bool shutdown) {
945
+ if (!shutdown) {
946
+ return GRPC_ERROR_NONE;
947
+ } else {
948
+ return GRPC_ERROR_CREATE("FD shutdown");
949
+ }
950
+ }
951
+
952
+ static void notify_on_locked(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
953
+ grpc_closure **st, grpc_closure *closure) {
954
+ if (fd->shutdown) {
955
+ grpc_exec_ctx_sched(exec_ctx, closure, GRPC_ERROR_CREATE("FD shutdown"),
956
+ NULL);
957
+ } else if (*st == CLOSURE_NOT_READY) {
958
+ /* not ready ==> switch to a waiting state by setting the closure */
959
+ *st = closure;
960
+ } else if (*st == CLOSURE_READY) {
961
+ /* already ready ==> queue the closure to run immediately */
962
+ *st = CLOSURE_NOT_READY;
963
+ grpc_exec_ctx_sched(exec_ctx, closure, fd_shutdown_error(fd->shutdown),
964
+ NULL);
965
+ } else {
966
+ /* upcallptr was set to a different closure. This is an error! */
967
+ gpr_log(GPR_ERROR,
968
+ "User called a notify_on function with a previous callback still "
969
+ "pending");
970
+ abort();
971
+ }
972
+ }
973
+
974
+ /* returns 1 if state becomes not ready */
975
+ static int set_ready_locked(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
976
+ grpc_closure **st) {
977
+ if (*st == CLOSURE_READY) {
978
+ /* duplicate ready ==> ignore */
979
+ return 0;
980
+ } else if (*st == CLOSURE_NOT_READY) {
981
+ /* not ready, and not waiting ==> flag ready */
982
+ *st = CLOSURE_READY;
983
+ return 0;
984
+ } else {
985
+ /* waiting ==> queue closure */
986
+ grpc_exec_ctx_sched(exec_ctx, *st, fd_shutdown_error(fd->shutdown), NULL);
987
+ *st = CLOSURE_NOT_READY;
988
+ return 1;
989
+ }
990
+ }
991
+
992
+ static grpc_pollset *fd_get_read_notifier_pollset(grpc_exec_ctx *exec_ctx,
993
+ grpc_fd *fd) {
994
+ grpc_pollset *notifier = NULL;
995
+
996
+ gpr_mu_lock(&fd->mu);
997
+ notifier = fd->read_notifier_pollset;
998
+ gpr_mu_unlock(&fd->mu);
999
+
1000
+ return notifier;
1001
+ }
1002
+
1003
+ static bool fd_is_shutdown(grpc_fd *fd) {
1004
+ gpr_mu_lock(&fd->mu);
1005
+ const bool r = fd->shutdown;
1006
+ gpr_mu_unlock(&fd->mu);
1007
+ return r;
1008
+ }
1009
+
1010
+ /* Might be called multiple times */
1011
+ static void fd_shutdown(grpc_exec_ctx *exec_ctx, grpc_fd *fd) {
1012
+ gpr_mu_lock(&fd->mu);
1013
+ /* Do the actual shutdown only once */
1014
+ if (!fd->shutdown) {
1015
+ fd->shutdown = true;
1016
+
1017
+ shutdown(fd->fd, SHUT_RDWR);
1018
+ /* Flush any pending read and write closures. Since fd->shutdown is 'true'
1019
+ at this point, the closures would be called with 'success = false' */
1020
+ set_ready_locked(exec_ctx, fd, &fd->read_closure);
1021
+ set_ready_locked(exec_ctx, fd, &fd->write_closure);
1022
+ }
1023
+ gpr_mu_unlock(&fd->mu);
1024
+ }
1025
+
1026
+ static void fd_notify_on_read(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1027
+ grpc_closure *closure) {
1028
+ gpr_mu_lock(&fd->mu);
1029
+ notify_on_locked(exec_ctx, fd, &fd->read_closure, closure);
1030
+ gpr_mu_unlock(&fd->mu);
1031
+ }
1032
+
1033
+ static void fd_notify_on_write(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1034
+ grpc_closure *closure) {
1035
+ gpr_mu_lock(&fd->mu);
1036
+ notify_on_locked(exec_ctx, fd, &fd->write_closure, closure);
1037
+ gpr_mu_unlock(&fd->mu);
1038
+ }
1039
+
1040
+ /*******************************************************************************
1041
+ * Pollset Definitions
1042
+ */
1043
+ GPR_TLS_DECL(g_current_thread_pollset);
1044
+ GPR_TLS_DECL(g_current_thread_worker);
1045
+ static __thread bool g_initialized_sigmask;
1046
+ static __thread sigset_t g_orig_sigmask;
1047
+
1048
+ static void sig_handler(int sig_num) {
1049
+ #ifdef GRPC_EPOLL_DEBUG
1050
+ gpr_log(GPR_INFO, "Received signal %d", sig_num);
1051
+ #endif
1052
+ }
1053
+
1054
+ static void poller_kick_init() { signal(grpc_wakeup_signal, sig_handler); }
1055
+
1056
+ /* Global state management */
1057
+ static grpc_error *pollset_global_init(void) {
1058
+ gpr_tls_init(&g_current_thread_pollset);
1059
+ gpr_tls_init(&g_current_thread_worker);
1060
+ poller_kick_init();
1061
+ return grpc_wakeup_fd_init(&grpc_global_wakeup_fd);
1062
+ }
1063
+
1064
+ static void pollset_global_shutdown(void) {
1065
+ grpc_wakeup_fd_destroy(&grpc_global_wakeup_fd);
1066
+ gpr_tls_destroy(&g_current_thread_pollset);
1067
+ gpr_tls_destroy(&g_current_thread_worker);
1068
+ }
1069
+
1070
+ static grpc_error *pollset_worker_kick(grpc_pollset_worker *worker) {
1071
+ grpc_error *err = GRPC_ERROR_NONE;
1072
+
1073
+ /* Kick the worker only if it was not already kicked */
1074
+ if (gpr_atm_no_barrier_cas(&worker->is_kicked, (gpr_atm)0, (gpr_atm)1)) {
1075
+ GRPC_POLLING_TRACE(
1076
+ "pollset_worker_kick: Kicking worker: %p (thread id: %ld)",
1077
+ (void *)worker, worker->pt_id);
1078
+ int err_num = pthread_kill(worker->pt_id, grpc_wakeup_signal);
1079
+ if (err_num != 0) {
1080
+ err = GRPC_OS_ERROR(err_num, "pthread_kill");
1081
+ }
1082
+ }
1083
+ return err;
1084
+ }
1085
+
1086
+ /* Return 1 if the pollset has active threads in pollset_work (pollset must
1087
+ * be locked) */
1088
+ static int pollset_has_workers(grpc_pollset *p) {
1089
+ return p->root_worker.next != &p->root_worker;
1090
+ }
1091
+
1092
+ static void remove_worker(grpc_pollset *p, grpc_pollset_worker *worker) {
1093
+ worker->prev->next = worker->next;
1094
+ worker->next->prev = worker->prev;
1095
+ }
1096
+
1097
+ static grpc_pollset_worker *pop_front_worker(grpc_pollset *p) {
1098
+ if (pollset_has_workers(p)) {
1099
+ grpc_pollset_worker *w = p->root_worker.next;
1100
+ remove_worker(p, w);
1101
+ return w;
1102
+ } else {
1103
+ return NULL;
1104
+ }
1105
+ }
1106
+
1107
+ static void push_back_worker(grpc_pollset *p, grpc_pollset_worker *worker) {
1108
+ worker->next = &p->root_worker;
1109
+ worker->prev = worker->next->prev;
1110
+ worker->prev->next = worker->next->prev = worker;
1111
+ }
1112
+
1113
+ static void push_front_worker(grpc_pollset *p, grpc_pollset_worker *worker) {
1114
+ worker->prev = &p->root_worker;
1115
+ worker->next = worker->prev->next;
1116
+ worker->prev->next = worker->next->prev = worker;
1117
+ }
1118
+
1119
+ /* p->mu must be held before calling this function */
1120
+ static grpc_error *pollset_kick(grpc_pollset *p,
1121
+ grpc_pollset_worker *specific_worker) {
1122
+ GPR_TIMER_BEGIN("pollset_kick", 0);
1123
+ grpc_error *error = GRPC_ERROR_NONE;
1124
+ const char *err_desc = "Kick Failure";
1125
+ grpc_pollset_worker *worker = specific_worker;
1126
+ if (worker != NULL) {
1127
+ if (worker == GRPC_POLLSET_KICK_BROADCAST) {
1128
+ if (pollset_has_workers(p)) {
1129
+ GPR_TIMER_BEGIN("pollset_kick.broadcast", 0);
1130
+ for (worker = p->root_worker.next; worker != &p->root_worker;
1131
+ worker = worker->next) {
1132
+ if (gpr_tls_get(&g_current_thread_worker) != (intptr_t)worker) {
1133
+ append_error(&error, pollset_worker_kick(worker), err_desc);
1134
+ }
1135
+ }
1136
+ GPR_TIMER_END("pollset_kick.broadcast", 0);
1137
+ } else {
1138
+ p->kicked_without_pollers = true;
1139
+ }
1140
+ } else {
1141
+ GPR_TIMER_MARK("kicked_specifically", 0);
1142
+ if (gpr_tls_get(&g_current_thread_worker) != (intptr_t)worker) {
1143
+ append_error(&error, pollset_worker_kick(worker), err_desc);
1144
+ }
1145
+ }
1146
+ } else if (gpr_tls_get(&g_current_thread_pollset) != (intptr_t)p) {
1147
+ /* Since worker == NULL, it means that we can kick "any" worker on this
1148
+ pollset 'p'. If 'p' happens to be the same pollset this thread is
1149
+ currently polling (i.e in pollset_work() function), then there is no need
1150
+ to kick any other worker since the current thread can just absorb the
1151
+ kick. This is the reason why we enter this case only when
1152
+ g_current_thread_pollset is != p */
1153
+
1154
+ GPR_TIMER_MARK("kick_anonymous", 0);
1155
+ worker = pop_front_worker(p);
1156
+ if (worker != NULL) {
1157
+ GPR_TIMER_MARK("finally_kick", 0);
1158
+ push_back_worker(p, worker);
1159
+ append_error(&error, pollset_worker_kick(worker), err_desc);
1160
+ } else {
1161
+ GPR_TIMER_MARK("kicked_no_pollers", 0);
1162
+ p->kicked_without_pollers = true;
1163
+ }
1164
+ }
1165
+
1166
+ GPR_TIMER_END("pollset_kick", 0);
1167
+ GRPC_LOG_IF_ERROR("pollset_kick", GRPC_ERROR_REF(error));
1168
+ return error;
1169
+ }
1170
+
1171
+ static grpc_error *kick_poller(void) {
1172
+ return grpc_wakeup_fd_wakeup(&grpc_global_wakeup_fd);
1173
+ }
1174
+
1175
+ static void pollset_init(grpc_pollset *pollset, gpr_mu **mu) {
1176
+ gpr_mu_init(&pollset->mu);
1177
+ *mu = &pollset->mu;
1178
+
1179
+ pollset->root_worker.next = pollset->root_worker.prev = &pollset->root_worker;
1180
+ pollset->kicked_without_pollers = false;
1181
+
1182
+ pollset->shutting_down = false;
1183
+ pollset->finish_shutdown_called = false;
1184
+ pollset->shutdown_done = NULL;
1185
+
1186
+ pollset->polling_island = NULL;
1187
+ }
1188
+
1189
+ /* Convert a timespec to milliseconds:
1190
+ - Very small or negative poll times are clamped to zero to do a non-blocking
1191
+ poll (which becomes spin polling)
1192
+ - Other small values are rounded up to one millisecond
1193
+ - Longer than a millisecond polls are rounded up to the next nearest
1194
+ millisecond to avoid spinning
1195
+ - Infinite timeouts are converted to -1 */
1196
+ static int poll_deadline_to_millis_timeout(gpr_timespec deadline,
1197
+ gpr_timespec now) {
1198
+ gpr_timespec timeout;
1199
+ static const int64_t max_spin_polling_us = 10;
1200
+ if (gpr_time_cmp(deadline, gpr_inf_future(deadline.clock_type)) == 0) {
1201
+ return -1;
1202
+ }
1203
+
1204
+ if (gpr_time_cmp(deadline, gpr_time_add(now, gpr_time_from_micros(
1205
+ max_spin_polling_us,
1206
+ GPR_TIMESPAN))) <= 0) {
1207
+ return 0;
1208
+ }
1209
+ timeout = gpr_time_sub(deadline, now);
1210
+ return gpr_time_to_millis(gpr_time_add(
1211
+ timeout, gpr_time_from_nanos(GPR_NS_PER_MS - 1, GPR_TIMESPAN)));
1212
+ }
1213
+
1214
+ static void fd_become_readable(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1215
+ grpc_pollset *notifier) {
1216
+ /* Need the fd->mu since we might be racing with fd_notify_on_read */
1217
+ gpr_mu_lock(&fd->mu);
1218
+ set_ready_locked(exec_ctx, fd, &fd->read_closure);
1219
+ fd->read_notifier_pollset = notifier;
1220
+ gpr_mu_unlock(&fd->mu);
1221
+ }
1222
+
1223
+ static void fd_become_writable(grpc_exec_ctx *exec_ctx, grpc_fd *fd) {
1224
+ /* Need the fd->mu since we might be racing with fd_notify_on_write */
1225
+ gpr_mu_lock(&fd->mu);
1226
+ set_ready_locked(exec_ctx, fd, &fd->write_closure);
1227
+ gpr_mu_unlock(&fd->mu);
1228
+ }
1229
+
1230
+ static void pollset_release_polling_island(grpc_pollset *ps, char *reason) {
1231
+ if (ps->polling_island != NULL) {
1232
+ PI_UNREF(ps->polling_island, reason);
1233
+ }
1234
+ ps->polling_island = NULL;
1235
+ }
1236
+
1237
+ static void finish_shutdown_locked(grpc_exec_ctx *exec_ctx,
1238
+ grpc_pollset *pollset) {
1239
+ /* The pollset cannot have any workers if we are at this stage */
1240
+ GPR_ASSERT(!pollset_has_workers(pollset));
1241
+
1242
+ pollset->finish_shutdown_called = true;
1243
+
1244
+ /* Release the ref and set pollset->polling_island to NULL */
1245
+ pollset_release_polling_island(pollset, "ps_shutdown");
1246
+ grpc_exec_ctx_sched(exec_ctx, pollset->shutdown_done, GRPC_ERROR_NONE, NULL);
1247
+ }
1248
+
1249
+ /* pollset->mu lock must be held by the caller before calling this */
1250
+ static void pollset_shutdown(grpc_exec_ctx *exec_ctx, grpc_pollset *pollset,
1251
+ grpc_closure *closure) {
1252
+ GPR_TIMER_BEGIN("pollset_shutdown", 0);
1253
+ GPR_ASSERT(!pollset->shutting_down);
1254
+ pollset->shutting_down = true;
1255
+ pollset->shutdown_done = closure;
1256
+ pollset_kick(pollset, GRPC_POLLSET_KICK_BROADCAST);
1257
+
1258
+ /* If the pollset has any workers, we cannot call finish_shutdown_locked()
1259
+ because it would release the underlying polling island. In such a case, we
1260
+ let the last worker call finish_shutdown_locked() from pollset_work() */
1261
+ if (!pollset_has_workers(pollset)) {
1262
+ GPR_ASSERT(!pollset->finish_shutdown_called);
1263
+ GPR_TIMER_MARK("pollset_shutdown.finish_shutdown_locked", 0);
1264
+ finish_shutdown_locked(exec_ctx, pollset);
1265
+ }
1266
+ GPR_TIMER_END("pollset_shutdown", 0);
1267
+ }
1268
+
1269
+ /* pollset_shutdown is guaranteed to be called before pollset_destroy. So other
1270
+ * than destroying the mutexes, there is nothing special that needs to be done
1271
+ * here */
1272
+ static void pollset_destroy(grpc_pollset *pollset) {
1273
+ GPR_ASSERT(!pollset_has_workers(pollset));
1274
+ gpr_mu_destroy(&pollset->mu);
1275
+ }
1276
+
1277
+ static void pollset_reset(grpc_pollset *pollset) {
1278
+ GPR_ASSERT(pollset->shutting_down);
1279
+ GPR_ASSERT(!pollset_has_workers(pollset));
1280
+ pollset->shutting_down = false;
1281
+ pollset->finish_shutdown_called = false;
1282
+ pollset->kicked_without_pollers = false;
1283
+ pollset->shutdown_done = NULL;
1284
+ pollset_release_polling_island(pollset, "ps_reset");
1285
+ }
1286
+
1287
+ #define GRPC_EPOLL_MAX_EVENTS 1000
1288
+ /* Note: sig_mask contains the signal mask to use *during* epoll_wait() */
1289
+ static void pollset_work_and_unlock(grpc_exec_ctx *exec_ctx,
1290
+ grpc_pollset *pollset,
1291
+ grpc_pollset_worker *worker, int timeout_ms,
1292
+ sigset_t *sig_mask, grpc_error **error) {
1293
+ struct epoll_event ep_ev[GRPC_EPOLL_MAX_EVENTS];
1294
+ int epoll_fd = -1;
1295
+ int ep_rv;
1296
+ polling_island *pi = NULL;
1297
+ char *err_msg;
1298
+ const char *err_desc = "pollset_work_and_unlock";
1299
+ GPR_TIMER_BEGIN("pollset_work_and_unlock", 0);
1300
+
1301
+ /* We need to get the epoll_fd to wait on. The epoll_fd is in inside the
1302
+ latest polling island pointed by pollset->polling_island.
1303
+
1304
+ Since epoll_fd is immutable, we can read it without obtaining the polling
1305
+ island lock. There is however a possibility that the polling island (from
1306
+ which we got the epoll_fd) got merged with another island while we are
1307
+ in this function. This is still okay because in such a case, we will wakeup
1308
+ right-away from epoll_wait() and pick up the latest polling_island the next
1309
+ this function (i.e pollset_work_and_unlock()) is called */
1310
+
1311
+ if (pollset->polling_island == NULL) {
1312
+ pollset->polling_island = polling_island_create(NULL, error);
1313
+ if (pollset->polling_island == NULL) {
1314
+ GPR_TIMER_END("pollset_work_and_unlock", 0);
1315
+ return; /* Fatal error. We cannot continue */
1316
+ }
1317
+
1318
+ PI_ADD_REF(pollset->polling_island, "ps");
1319
+ GRPC_POLLING_TRACE("pollset_work: pollset: %p created new pi: %p",
1320
+ (void *)pollset, (void *)pollset->polling_island);
1321
+ }
1322
+
1323
+ pi = polling_island_maybe_get_latest(pollset->polling_island);
1324
+ epoll_fd = pi->epoll_fd;
1325
+
1326
+ /* Update the pollset->polling_island since the island being pointed by
1327
+ pollset->polling_island maybe older than the one pointed by pi) */
1328
+ if (pollset->polling_island != pi) {
1329
+ /* Always do PI_ADD_REF before PI_UNREF because PI_UNREF may cause the
1330
+ polling island to be deleted */
1331
+ PI_ADD_REF(pi, "ps");
1332
+ PI_UNREF(pollset->polling_island, "ps");
1333
+ pollset->polling_island = pi;
1334
+ }
1335
+
1336
+ /* Add an extra ref so that the island does not get destroyed (which means
1337
+ the epoll_fd won't be closed) while we are are doing an epoll_wait() on the
1338
+ epoll_fd */
1339
+ PI_ADD_REF(pi, "ps_work");
1340
+ gpr_mu_unlock(&pollset->mu);
1341
+
1342
+ do {
1343
+ ep_rv = epoll_pwait(epoll_fd, ep_ev, GRPC_EPOLL_MAX_EVENTS, timeout_ms,
1344
+ sig_mask);
1345
+ if (ep_rv < 0) {
1346
+ if (errno != EINTR) {
1347
+ gpr_asprintf(&err_msg,
1348
+ "epoll_wait() epoll fd: %d failed with error: %d (%s)",
1349
+ epoll_fd, errno, strerror(errno));
1350
+ append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
1351
+ } else {
1352
+ /* We were interrupted. Save an interation by doing a zero timeout
1353
+ epoll_wait to see if there are any other events of interest */
1354
+ GRPC_POLLING_TRACE(
1355
+ "pollset_work: pollset: %p, worker: %p received kick",
1356
+ (void *)pollset, (void *)worker);
1357
+ ep_rv = epoll_wait(epoll_fd, ep_ev, GRPC_EPOLL_MAX_EVENTS, 0);
1358
+ }
1359
+ }
1360
+
1361
+ #ifdef GRPC_TSAN
1362
+ /* See the definition of g_poll_sync for more details */
1363
+ gpr_atm_acq_load(&g_epoll_sync);
1364
+ #endif /* defined(GRPC_TSAN) */
1365
+
1366
+ for (int i = 0; i < ep_rv; ++i) {
1367
+ void *data_ptr = ep_ev[i].data.ptr;
1368
+ if (data_ptr == &grpc_global_wakeup_fd) {
1369
+ append_error(error,
1370
+ grpc_wakeup_fd_consume_wakeup(&grpc_global_wakeup_fd),
1371
+ err_desc);
1372
+ } else if (data_ptr == &polling_island_wakeup_fd) {
1373
+ GRPC_POLLING_TRACE(
1374
+ "pollset_work: pollset: %p, worker: %p polling island (epoll_fd: "
1375
+ "%d) got merged",
1376
+ (void *)pollset, (void *)worker, epoll_fd);
1377
+ /* This means that our polling island is merged with a different
1378
+ island. We do not have to do anything here since the subsequent call
1379
+ to the function pollset_work_and_unlock() will pick up the correct
1380
+ epoll_fd */
1381
+ } else {
1382
+ grpc_fd *fd = data_ptr;
1383
+ int cancel = ep_ev[i].events & (EPOLLERR | EPOLLHUP);
1384
+ int read_ev = ep_ev[i].events & (EPOLLIN | EPOLLPRI);
1385
+ int write_ev = ep_ev[i].events & EPOLLOUT;
1386
+ if (read_ev || cancel) {
1387
+ fd_become_readable(exec_ctx, fd, pollset);
1388
+ }
1389
+ if (write_ev || cancel) {
1390
+ fd_become_writable(exec_ctx, fd);
1391
+ }
1392
+ }
1393
+ }
1394
+ } while (ep_rv == GRPC_EPOLL_MAX_EVENTS);
1395
+
1396
+ GPR_ASSERT(pi != NULL);
1397
+
1398
+ /* Before leaving, release the extra ref we added to the polling island. It
1399
+ is important to use "pi" here (i.e our old copy of pollset->polling_island
1400
+ that we got before releasing the polling island lock). This is because
1401
+ pollset->polling_island pointer might get udpated in other parts of the
1402
+ code when there is an island merge while we are doing epoll_wait() above */
1403
+ PI_UNREF(pi, "ps_work");
1404
+
1405
+ GPR_TIMER_END("pollset_work_and_unlock", 0);
1406
+ }
1407
+
1408
+ /* pollset->mu lock must be held by the caller before calling this.
1409
+ The function pollset_work() may temporarily release the lock (pollset->mu)
1410
+ during the course of its execution but it will always re-acquire the lock and
1411
+ ensure that it is held by the time the function returns */
1412
+ static grpc_error *pollset_work(grpc_exec_ctx *exec_ctx, grpc_pollset *pollset,
1413
+ grpc_pollset_worker **worker_hdl,
1414
+ gpr_timespec now, gpr_timespec deadline) {
1415
+ GPR_TIMER_BEGIN("pollset_work", 0);
1416
+ grpc_error *error = GRPC_ERROR_NONE;
1417
+ int timeout_ms = poll_deadline_to_millis_timeout(deadline, now);
1418
+
1419
+ sigset_t new_mask;
1420
+
1421
+ grpc_pollset_worker worker;
1422
+ worker.next = worker.prev = NULL;
1423
+ worker.pt_id = pthread_self();
1424
+ gpr_atm_no_barrier_store(&worker.is_kicked, (gpr_atm)0);
1425
+
1426
+ *worker_hdl = &worker;
1427
+
1428
+ gpr_tls_set(&g_current_thread_pollset, (intptr_t)pollset);
1429
+ gpr_tls_set(&g_current_thread_worker, (intptr_t)&worker);
1430
+
1431
+ if (pollset->kicked_without_pollers) {
1432
+ /* If the pollset was kicked without pollers, pretend that the current
1433
+ worker got the kick and skip polling. A kick indicates that there is some
1434
+ work that needs attention like an event on the completion queue or an
1435
+ alarm */
1436
+ GPR_TIMER_MARK("pollset_work.kicked_without_pollers", 0);
1437
+ pollset->kicked_without_pollers = 0;
1438
+ } else if (!pollset->shutting_down) {
1439
+ /* We use the posix-signal with number 'grpc_wakeup_signal' for waking up
1440
+ (i.e 'kicking') a worker in the pollset. A 'kick' is a way to inform the
1441
+ worker that there is some pending work that needs immediate attention
1442
+ (like an event on the completion queue, or a polling island merge that
1443
+ results in a new epoll-fd to wait on) and that the worker should not
1444
+ spend time waiting in epoll_pwait().
1445
+
1446
+ A worker can be kicked anytime from the point it is added to the pollset
1447
+ via push_front_worker() (or push_back_worker()) to the point it is
1448
+ removed via remove_worker().
1449
+ If the worker is kicked before/during it calls epoll_pwait(), it should
1450
+ immediately exit from epoll_wait(). If the worker is kicked after it
1451
+ returns from epoll_wait(), then nothing really needs to be done.
1452
+
1453
+ To accomplish this, we mask 'grpc_wakeup_signal' on this thread at all
1454
+ times *except* when it is in epoll_pwait(). This way, the worker never
1455
+ misses acting on a kick */
1456
+
1457
+ if (!g_initialized_sigmask) {
1458
+ sigemptyset(&new_mask);
1459
+ sigaddset(&new_mask, grpc_wakeup_signal);
1460
+ pthread_sigmask(SIG_BLOCK, &new_mask, &g_orig_sigmask);
1461
+ sigdelset(&g_orig_sigmask, grpc_wakeup_signal);
1462
+ g_initialized_sigmask = true;
1463
+ /* new_mask: The new thread mask which blocks 'grpc_wakeup_signal'.
1464
+ This is the mask used at all times *except during
1465
+ epoll_wait()*"
1466
+ g_orig_sigmask: The thread mask which allows 'grpc_wakeup_signal' and
1467
+ this is the mask to use *during epoll_wait()*
1468
+
1469
+ The new_mask is set on the worker before it is added to the pollset
1470
+ (i.e before it can be kicked) */
1471
+ }
1472
+
1473
+ push_front_worker(pollset, &worker); /* Add worker to pollset */
1474
+
1475
+ pollset_work_and_unlock(exec_ctx, pollset, &worker, timeout_ms,
1476
+ &g_orig_sigmask, &error);
1477
+ grpc_exec_ctx_flush(exec_ctx);
1478
+
1479
+ gpr_mu_lock(&pollset->mu);
1480
+
1481
+ /* Note: There is no need to reset worker.is_kicked to 0 since we are no
1482
+ longer going to use this worker */
1483
+ remove_worker(pollset, &worker);
1484
+ }
1485
+
1486
+ /* If we are the last worker on the pollset (i.e pollset_has_workers() is
1487
+ false at this point) and the pollset is shutting down, we may have to
1488
+ finish the shutdown process by calling finish_shutdown_locked().
1489
+ See pollset_shutdown() for more details.
1490
+
1491
+ Note: Continuing to access pollset here is safe; it is the caller's
1492
+ responsibility to not destroy a pollset when it has outstanding calls to
1493
+ pollset_work() */
1494
+ if (pollset->shutting_down && !pollset_has_workers(pollset) &&
1495
+ !pollset->finish_shutdown_called) {
1496
+ GPR_TIMER_MARK("pollset_work.finish_shutdown_locked", 0);
1497
+ finish_shutdown_locked(exec_ctx, pollset);
1498
+
1499
+ gpr_mu_unlock(&pollset->mu);
1500
+ grpc_exec_ctx_flush(exec_ctx);
1501
+ gpr_mu_lock(&pollset->mu);
1502
+ }
1503
+
1504
+ *worker_hdl = NULL;
1505
+
1506
+ gpr_tls_set(&g_current_thread_pollset, (intptr_t)0);
1507
+ gpr_tls_set(&g_current_thread_worker, (intptr_t)0);
1508
+
1509
+ GPR_TIMER_END("pollset_work", 0);
1510
+
1511
+ GRPC_LOG_IF_ERROR("pollset_work", GRPC_ERROR_REF(error));
1512
+ return error;
1513
+ }
1514
+
1515
+ static void pollset_add_fd(grpc_exec_ctx *exec_ctx, grpc_pollset *pollset,
1516
+ grpc_fd *fd) {
1517
+ grpc_error *error = GRPC_ERROR_NONE;
1518
+
1519
+ gpr_mu_lock(&pollset->mu);
1520
+ gpr_mu_lock(&fd->pi_mu);
1521
+
1522
+ polling_island *pi_new = NULL;
1523
+
1524
+ /* 1) If fd->polling_island and pollset->polling_island are both non-NULL and
1525
+ * equal, do nothing.
1526
+ * 2) If fd->polling_island and pollset->polling_island are both NULL, create
1527
+ * a new polling island (with a refcount of 2) and make the polling_island
1528
+ * fields in both fd and pollset to point to the new island
1529
+ * 3) If one of fd->polling_island or pollset->polling_island is NULL, update
1530
+ * the NULL polling_island field to point to the non-NULL polling_island
1531
+ * field (ensure that the refcount on the polling island is incremented by
1532
+ * 1 to account for the newly added reference)
1533
+ * 4) Finally, if fd->polling_island and pollset->polling_island are non-NULL
1534
+ * and different, merge both the polling islands and update the
1535
+ * polling_island fields in both fd and pollset to point to the merged
1536
+ * polling island.
1537
+ */
1538
+ if (fd->polling_island == pollset->polling_island) {
1539
+ pi_new = fd->polling_island;
1540
+ if (pi_new == NULL) {
1541
+ pi_new = polling_island_create(fd, &error);
1542
+
1543
+ GRPC_POLLING_TRACE(
1544
+ "pollset_add_fd: Created new polling island. pi_new: %p (fd: %d, "
1545
+ "pollset: %p)",
1546
+ (void *)pi_new, fd->fd, (void *)pollset);
1547
+ }
1548
+ } else if (fd->polling_island == NULL) {
1549
+ pi_new = polling_island_lock(pollset->polling_island);
1550
+ polling_island_add_fds_locked(pi_new, &fd, 1, true, &error);
1551
+ gpr_mu_unlock(&pi_new->mu);
1552
+
1553
+ GRPC_POLLING_TRACE(
1554
+ "pollset_add_fd: fd->pi was NULL. pi_new: %p (fd: %d, pollset: %p, "
1555
+ "pollset->pi: %p)",
1556
+ (void *)pi_new, fd->fd, (void *)pollset,
1557
+ (void *)pollset->polling_island);
1558
+ } else if (pollset->polling_island == NULL) {
1559
+ pi_new = polling_island_lock(fd->polling_island);
1560
+ gpr_mu_unlock(&pi_new->mu);
1561
+
1562
+ GRPC_POLLING_TRACE(
1563
+ "pollset_add_fd: pollset->pi was NULL. pi_new: %p (fd: %d, pollset: "
1564
+ "%p, fd->pi: %p",
1565
+ (void *)pi_new, fd->fd, (void *)pollset, (void *)fd->polling_island);
1566
+ } else {
1567
+ pi_new = polling_island_merge(fd->polling_island, pollset->polling_island,
1568
+ &error);
1569
+ GRPC_POLLING_TRACE(
1570
+ "pollset_add_fd: polling islands merged. pi_new: %p (fd: %d, pollset: "
1571
+ "%p, fd->pi: %p, pollset->pi: %p)",
1572
+ (void *)pi_new, fd->fd, (void *)pollset, (void *)fd->polling_island,
1573
+ (void *)pollset->polling_island);
1574
+ }
1575
+
1576
+ /* At this point, pi_new is the polling island that both fd->polling_island
1577
+ and pollset->polling_island must be pointing to */
1578
+
1579
+ if (fd->polling_island != pi_new) {
1580
+ PI_ADD_REF(pi_new, "fd");
1581
+ if (fd->polling_island != NULL) {
1582
+ PI_UNREF(fd->polling_island, "fd");
1583
+ }
1584
+ fd->polling_island = pi_new;
1585
+ }
1586
+
1587
+ if (pollset->polling_island != pi_new) {
1588
+ PI_ADD_REF(pi_new, "ps");
1589
+ if (pollset->polling_island != NULL) {
1590
+ PI_UNREF(pollset->polling_island, "ps");
1591
+ }
1592
+ pollset->polling_island = pi_new;
1593
+ }
1594
+
1595
+ gpr_mu_unlock(&fd->pi_mu);
1596
+ gpr_mu_unlock(&pollset->mu);
1597
+ }
1598
+
1599
+ /*******************************************************************************
1600
+ * Pollset-set Definitions
1601
+ */
1602
+
1603
+ static grpc_pollset_set *pollset_set_create(void) {
1604
+ grpc_pollset_set *pollset_set = gpr_malloc(sizeof(*pollset_set));
1605
+ memset(pollset_set, 0, sizeof(*pollset_set));
1606
+ gpr_mu_init(&pollset_set->mu);
1607
+ return pollset_set;
1608
+ }
1609
+
1610
+ static void pollset_set_destroy(grpc_pollset_set *pollset_set) {
1611
+ size_t i;
1612
+ gpr_mu_destroy(&pollset_set->mu);
1613
+ for (i = 0; i < pollset_set->fd_count; i++) {
1614
+ GRPC_FD_UNREF(pollset_set->fds[i], "pollset_set");
1615
+ }
1616
+ gpr_free(pollset_set->pollsets);
1617
+ gpr_free(pollset_set->pollset_sets);
1618
+ gpr_free(pollset_set->fds);
1619
+ gpr_free(pollset_set);
1620
+ }
1621
+
1622
+ static void pollset_set_add_fd(grpc_exec_ctx *exec_ctx,
1623
+ grpc_pollset_set *pollset_set, grpc_fd *fd) {
1624
+ size_t i;
1625
+ gpr_mu_lock(&pollset_set->mu);
1626
+ if (pollset_set->fd_count == pollset_set->fd_capacity) {
1627
+ pollset_set->fd_capacity = GPR_MAX(8, 2 * pollset_set->fd_capacity);
1628
+ pollset_set->fds = gpr_realloc(
1629
+ pollset_set->fds, pollset_set->fd_capacity * sizeof(*pollset_set->fds));
1630
+ }
1631
+ GRPC_FD_REF(fd, "pollset_set");
1632
+ pollset_set->fds[pollset_set->fd_count++] = fd;
1633
+ for (i = 0; i < pollset_set->pollset_count; i++) {
1634
+ pollset_add_fd(exec_ctx, pollset_set->pollsets[i], fd);
1635
+ }
1636
+ for (i = 0; i < pollset_set->pollset_set_count; i++) {
1637
+ pollset_set_add_fd(exec_ctx, pollset_set->pollset_sets[i], fd);
1638
+ }
1639
+ gpr_mu_unlock(&pollset_set->mu);
1640
+ }
1641
+
1642
+ static void pollset_set_del_fd(grpc_exec_ctx *exec_ctx,
1643
+ grpc_pollset_set *pollset_set, grpc_fd *fd) {
1644
+ size_t i;
1645
+ gpr_mu_lock(&pollset_set->mu);
1646
+ for (i = 0; i < pollset_set->fd_count; i++) {
1647
+ if (pollset_set->fds[i] == fd) {
1648
+ pollset_set->fd_count--;
1649
+ GPR_SWAP(grpc_fd *, pollset_set->fds[i],
1650
+ pollset_set->fds[pollset_set->fd_count]);
1651
+ GRPC_FD_UNREF(fd, "pollset_set");
1652
+ break;
1653
+ }
1654
+ }
1655
+ for (i = 0; i < pollset_set->pollset_set_count; i++) {
1656
+ pollset_set_del_fd(exec_ctx, pollset_set->pollset_sets[i], fd);
1657
+ }
1658
+ gpr_mu_unlock(&pollset_set->mu);
1659
+ }
1660
+
1661
+ static void pollset_set_add_pollset(grpc_exec_ctx *exec_ctx,
1662
+ grpc_pollset_set *pollset_set,
1663
+ grpc_pollset *pollset) {
1664
+ size_t i, j;
1665
+ gpr_mu_lock(&pollset_set->mu);
1666
+ if (pollset_set->pollset_count == pollset_set->pollset_capacity) {
1667
+ pollset_set->pollset_capacity =
1668
+ GPR_MAX(8, 2 * pollset_set->pollset_capacity);
1669
+ pollset_set->pollsets =
1670
+ gpr_realloc(pollset_set->pollsets, pollset_set->pollset_capacity *
1671
+ sizeof(*pollset_set->pollsets));
1672
+ }
1673
+ pollset_set->pollsets[pollset_set->pollset_count++] = pollset;
1674
+ for (i = 0, j = 0; i < pollset_set->fd_count; i++) {
1675
+ if (fd_is_orphaned(pollset_set->fds[i])) {
1676
+ GRPC_FD_UNREF(pollset_set->fds[i], "pollset_set");
1677
+ } else {
1678
+ pollset_add_fd(exec_ctx, pollset, pollset_set->fds[i]);
1679
+ pollset_set->fds[j++] = pollset_set->fds[i];
1680
+ }
1681
+ }
1682
+ pollset_set->fd_count = j;
1683
+ gpr_mu_unlock(&pollset_set->mu);
1684
+ }
1685
+
1686
+ static void pollset_set_del_pollset(grpc_exec_ctx *exec_ctx,
1687
+ grpc_pollset_set *pollset_set,
1688
+ grpc_pollset *pollset) {
1689
+ size_t i;
1690
+ gpr_mu_lock(&pollset_set->mu);
1691
+ for (i = 0; i < pollset_set->pollset_count; i++) {
1692
+ if (pollset_set->pollsets[i] == pollset) {
1693
+ pollset_set->pollset_count--;
1694
+ GPR_SWAP(grpc_pollset *, pollset_set->pollsets[i],
1695
+ pollset_set->pollsets[pollset_set->pollset_count]);
1696
+ break;
1697
+ }
1698
+ }
1699
+ gpr_mu_unlock(&pollset_set->mu);
1700
+ }
1701
+
1702
+ static void pollset_set_add_pollset_set(grpc_exec_ctx *exec_ctx,
1703
+ grpc_pollset_set *bag,
1704
+ grpc_pollset_set *item) {
1705
+ size_t i, j;
1706
+ gpr_mu_lock(&bag->mu);
1707
+ if (bag->pollset_set_count == bag->pollset_set_capacity) {
1708
+ bag->pollset_set_capacity = GPR_MAX(8, 2 * bag->pollset_set_capacity);
1709
+ bag->pollset_sets =
1710
+ gpr_realloc(bag->pollset_sets,
1711
+ bag->pollset_set_capacity * sizeof(*bag->pollset_sets));
1712
+ }
1713
+ bag->pollset_sets[bag->pollset_set_count++] = item;
1714
+ for (i = 0, j = 0; i < bag->fd_count; i++) {
1715
+ if (fd_is_orphaned(bag->fds[i])) {
1716
+ GRPC_FD_UNREF(bag->fds[i], "pollset_set");
1717
+ } else {
1718
+ pollset_set_add_fd(exec_ctx, item, bag->fds[i]);
1719
+ bag->fds[j++] = bag->fds[i];
1720
+ }
1721
+ }
1722
+ bag->fd_count = j;
1723
+ gpr_mu_unlock(&bag->mu);
1724
+ }
1725
+
1726
+ static void pollset_set_del_pollset_set(grpc_exec_ctx *exec_ctx,
1727
+ grpc_pollset_set *bag,
1728
+ grpc_pollset_set *item) {
1729
+ size_t i;
1730
+ gpr_mu_lock(&bag->mu);
1731
+ for (i = 0; i < bag->pollset_set_count; i++) {
1732
+ if (bag->pollset_sets[i] == item) {
1733
+ bag->pollset_set_count--;
1734
+ GPR_SWAP(grpc_pollset_set *, bag->pollset_sets[i],
1735
+ bag->pollset_sets[bag->pollset_set_count]);
1736
+ break;
1737
+ }
1738
+ }
1739
+ gpr_mu_unlock(&bag->mu);
1740
+ }
1741
+
1742
+ /* Test helper functions
1743
+ * */
1744
+ void *grpc_fd_get_polling_island(grpc_fd *fd) {
1745
+ polling_island *pi;
1746
+
1747
+ gpr_mu_lock(&fd->pi_mu);
1748
+ pi = fd->polling_island;
1749
+ gpr_mu_unlock(&fd->pi_mu);
1750
+
1751
+ return pi;
1752
+ }
1753
+
1754
+ void *grpc_pollset_get_polling_island(grpc_pollset *ps) {
1755
+ polling_island *pi;
1756
+
1757
+ gpr_mu_lock(&ps->mu);
1758
+ pi = ps->polling_island;
1759
+ gpr_mu_unlock(&ps->mu);
1760
+
1761
+ return pi;
1762
+ }
1763
+
1764
+ bool grpc_are_polling_islands_equal(void *p, void *q) {
1765
+ polling_island *p1 = p;
1766
+ polling_island *p2 = q;
1767
+
1768
+ /* Note: polling_island_lock_pair() may change p1 and p2 to point to the
1769
+ latest polling islands in their respective linked lists */
1770
+ polling_island_lock_pair(&p1, &p2);
1771
+ polling_island_unlock_pair(p1, p2);
1772
+
1773
+ return p1 == p2;
1774
+ }
1775
+
1776
+ /*******************************************************************************
1777
+ * Event engine binding
1778
+ */
1779
+
1780
+ static void shutdown_engine(void) {
1781
+ fd_global_shutdown();
1782
+ pollset_global_shutdown();
1783
+ polling_island_global_shutdown();
1784
+ }
1785
+
1786
+ static const grpc_event_engine_vtable vtable = {
1787
+ .pollset_size = sizeof(grpc_pollset),
1788
+
1789
+ .fd_create = fd_create,
1790
+ .fd_wrapped_fd = fd_wrapped_fd,
1791
+ .fd_orphan = fd_orphan,
1792
+ .fd_shutdown = fd_shutdown,
1793
+ .fd_is_shutdown = fd_is_shutdown,
1794
+ .fd_notify_on_read = fd_notify_on_read,
1795
+ .fd_notify_on_write = fd_notify_on_write,
1796
+ .fd_get_read_notifier_pollset = fd_get_read_notifier_pollset,
1797
+
1798
+ .pollset_init = pollset_init,
1799
+ .pollset_shutdown = pollset_shutdown,
1800
+ .pollset_reset = pollset_reset,
1801
+ .pollset_destroy = pollset_destroy,
1802
+ .pollset_work = pollset_work,
1803
+ .pollset_kick = pollset_kick,
1804
+ .pollset_add_fd = pollset_add_fd,
1805
+
1806
+ .pollset_set_create = pollset_set_create,
1807
+ .pollset_set_destroy = pollset_set_destroy,
1808
+ .pollset_set_add_pollset = pollset_set_add_pollset,
1809
+ .pollset_set_del_pollset = pollset_set_del_pollset,
1810
+ .pollset_set_add_pollset_set = pollset_set_add_pollset_set,
1811
+ .pollset_set_del_pollset_set = pollset_set_del_pollset_set,
1812
+ .pollset_set_add_fd = pollset_set_add_fd,
1813
+ .pollset_set_del_fd = pollset_set_del_fd,
1814
+
1815
+ .kick_poller = kick_poller,
1816
+
1817
+ .shutdown_engine = shutdown_engine,
1818
+ };
1819
+
1820
+ /* It is possible that GLIBC has epoll but the underlying kernel doesn't.
1821
+ * Create a dummy epoll_fd to make sure epoll support is available */
1822
+ static bool is_epoll_available() {
1823
+ int fd = epoll_create1(EPOLL_CLOEXEC);
1824
+ if (fd < 0) {
1825
+ gpr_log(
1826
+ GPR_ERROR,
1827
+ "epoll_create1 failed with error: %d. Not using epoll polling engine",
1828
+ fd);
1829
+ return false;
1830
+ }
1831
+ close(fd);
1832
+ return true;
1833
+ }
1834
+
1835
+ const grpc_event_engine_vtable *grpc_init_epoll_linux(void) {
1836
+ /* If use of signals is disabled, we cannot use epoll engine*/
1837
+ if (is_grpc_wakeup_signal_initialized && grpc_wakeup_signal < 0) {
1838
+ return NULL;
1839
+ }
1840
+
1841
+ if (!is_epoll_available()) {
1842
+ return NULL;
1843
+ }
1844
+
1845
+ if (!is_grpc_wakeup_signal_initialized) {
1846
+ grpc_use_signal(SIGRTMIN + 2);
1847
+ }
1848
+
1849
+ fd_global_init();
1850
+
1851
+ if (!GRPC_LOG_IF_ERROR("pollset_global_init", pollset_global_init())) {
1852
+ return NULL;
1853
+ }
1854
+
1855
+ if (!GRPC_LOG_IF_ERROR("polling_island_global_init",
1856
+ polling_island_global_init())) {
1857
+ return NULL;
1858
+ }
1859
+
1860
+ return &vtable;
1861
+ }
1862
+
1863
+ #else /* defined(GPR_LINUX_EPOLL) */
1864
+ #if defined(GPR_POSIX_SOCKET)
1865
+ #include "src/core/lib/iomgr/ev_posix.h"
1866
+ /* If GPR_LINUX_EPOLL is not defined, it means epoll is not available. Return
1867
+ * NULL */
1868
+ const grpc_event_engine_vtable *grpc_init_epoll_linux(void) { return NULL; }
1869
+ #endif /* defined(GPR_POSIX_SOCKET) */
1870
+
1871
+ void grpc_use_signal(int signum) {}
1872
+ #endif /* !defined(GPR_LINUX_EPOLL) */