Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Robbie Shade | cdc182e | 2016-01-29 09:39:57 -0500 | [diff] [blame] | 3 | * Copyright 2015-2016, Google Inc. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 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 | |
Craig Tiller | 9a4dddd | 2016-03-25 17:08:13 -0700 | [diff] [blame] | 34 | #ifndef GRPC_CORE_LIB_TRANSPORT_TRANSPORT_H |
| 35 | #define GRPC_CORE_LIB_TRANSPORT_TRANSPORT_H |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 36 | |
| 37 | #include <stddef.h> |
| 38 | |
Craig Tiller | 9533d04 | 2016-03-25 17:11:06 -0700 | [diff] [blame^] | 39 | #include "src/core/lib/channel/context.h" |
| 40 | #include "src/core/lib/iomgr/pollset.h" |
| 41 | #include "src/core/lib/iomgr/pollset_set.h" |
| 42 | #include "src/core/lib/transport/byte_stream.h" |
| 43 | #include "src/core/lib/transport/metadata_batch.h" |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 44 | |
| 45 | /* forward declarations */ |
| 46 | typedef struct grpc_transport grpc_transport; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 47 | |
| 48 | /* grpc_stream doesn't actually exist. It's used as a typesafe |
| 49 | opaque pointer for whatever data the transport wants to track |
| 50 | for a stream. */ |
| 51 | typedef struct grpc_stream grpc_stream; |
| 52 | |
Craig Tiller | 54914ee | 2015-12-01 06:23:44 -0800 | [diff] [blame] | 53 | /*#define GRPC_STREAM_REFCOUNT_DEBUG*/ |
Craig Tiller | 4861304 | 2015-11-29 14:45:11 -0800 | [diff] [blame] | 54 | |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 55 | typedef struct grpc_stream_refcount { |
| 56 | gpr_refcount refs; |
| 57 | grpc_closure destroy; |
Craig Tiller | 27e5aa4 | 2015-11-24 16:28:54 -0800 | [diff] [blame] | 58 | #ifdef GRPC_STREAM_REFCOUNT_DEBUG |
| 59 | const char *object_type; |
| 60 | #endif |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 61 | } grpc_stream_refcount; |
| 62 | |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 63 | #ifdef GRPC_STREAM_REFCOUNT_DEBUG |
Craig Tiller | 27e5aa4 | 2015-11-24 16:28:54 -0800 | [diff] [blame] | 64 | void grpc_stream_ref_init(grpc_stream_refcount *refcount, int initial_refs, |
| 65 | grpc_iomgr_cb_func cb, void *cb_arg, |
| 66 | const char *object_type); |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 67 | void grpc_stream_ref(grpc_stream_refcount *refcount, const char *reason); |
| 68 | void grpc_stream_unref(grpc_exec_ctx *exec_ctx, grpc_stream_refcount *refcount, |
| 69 | const char *reason); |
Craig Tiller | 27e5aa4 | 2015-11-24 16:28:54 -0800 | [diff] [blame] | 70 | #define GRPC_STREAM_REF_INIT(rc, ir, cb, cb_arg, objtype) \ |
| 71 | grpc_stream_ref_init(rc, ir, cb, cb_arg, objtype) |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 72 | #else |
Craig Tiller | 27e5aa4 | 2015-11-24 16:28:54 -0800 | [diff] [blame] | 73 | void grpc_stream_ref_init(grpc_stream_refcount *refcount, int initial_refs, |
| 74 | grpc_iomgr_cb_func cb, void *cb_arg); |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 75 | void grpc_stream_ref(grpc_stream_refcount *refcount); |
| 76 | void grpc_stream_unref(grpc_exec_ctx *exec_ctx, grpc_stream_refcount *refcount); |
Craig Tiller | 27e5aa4 | 2015-11-24 16:28:54 -0800 | [diff] [blame] | 77 | #define GRPC_STREAM_REF_INIT(rc, ir, cb, cb_arg, objtype) \ |
| 78 | grpc_stream_ref_init(rc, ir, cb, cb_arg) |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 79 | #endif |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 80 | |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 81 | /* Transport stream op: a set of operations to perform on a transport |
| 82 | against a single stream */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 83 | typedef struct grpc_transport_stream_op { |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 84 | /** Send initial metadata to the peer, from the provided metadata batch. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 85 | grpc_metadata_batch *send_initial_metadata; |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 86 | |
| 87 | /** Send trailing metadata to the peer, from the provided metadata batch. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 88 | grpc_metadata_batch *send_trailing_metadata; |
Craig Tiller | 5dde66e | 2015-06-02 09:05:23 -0700 | [diff] [blame] | 89 | |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 90 | /** Send message data to the peer, from the provided byte stream. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 91 | grpc_byte_stream *send_message; |
Craig Tiller | 3f2c221 | 2015-04-23 07:56:33 -0700 | [diff] [blame] | 92 | |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 93 | /** Receive initial metadata from the stream, into provided metadata batch. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 94 | grpc_metadata_batch *recv_initial_metadata; |
Craig Tiller | a44cbfc | 2016-02-03 16:02:49 -0800 | [diff] [blame] | 95 | /** Should be enqueued when initial metadata is ready to be processed. */ |
| 96 | grpc_closure *recv_initial_metadata_ready; |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 97 | |
| 98 | /** Receive message data from the stream, into provided byte stream. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 99 | grpc_byte_stream **recv_message; |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 100 | /** Should be enqueued when one message is ready to be processed. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 101 | grpc_closure *recv_message_ready; |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 102 | |
Robbie Shade | cdc182e | 2016-01-29 09:39:57 -0500 | [diff] [blame] | 103 | /** Receive trailing metadata from the stream, into provided metadata batch. |
| 104 | */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 105 | grpc_metadata_batch *recv_trailing_metadata; |
Craig Tiller | 3f2c221 | 2015-04-23 07:56:33 -0700 | [diff] [blame] | 106 | |
Robbie Shade | 9891e8f | 2016-01-25 13:19:32 -0500 | [diff] [blame] | 107 | /** Should be enqueued when all requested operations (excluding recv_message |
Craig Tiller | a44cbfc | 2016-02-03 16:02:49 -0800 | [diff] [blame] | 108 | and recv_initial_metadata which have their own closures) in a given batch |
| 109 | have been completed. */ |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 110 | grpc_closure *on_complete; |
Craig Tiller | 3f2c221 | 2015-04-23 07:56:33 -0700 | [diff] [blame] | 111 | |
Craig Tiller | 45ce927 | 2015-07-31 11:22:35 -0700 | [diff] [blame] | 112 | /** If != GRPC_STATUS_OK, cancel this stream */ |
Craig Tiller | 3f2c221 | 2015-04-23 07:56:33 -0700 | [diff] [blame] | 113 | grpc_status_code cancel_with_status; |
Craig Tiller | 935cf42 | 2015-05-01 14:10:46 -0700 | [diff] [blame] | 114 | |
Craig Tiller | 45ce927 | 2015-07-31 11:22:35 -0700 | [diff] [blame] | 115 | /** If != GRPC_STATUS_OK, send grpc-status, grpc-message, and close this |
| 116 | stream for both reading and writing */ |
| 117 | grpc_status_code close_with_status; |
| 118 | gpr_slice *optional_close_message; |
| 119 | |
Craig Tiller | 935cf42 | 2015-05-01 14:10:46 -0700 | [diff] [blame] | 120 | /* Indexes correspond to grpc_context_index enum values */ |
Julien Boeuf | 83b0297 | 2015-05-20 22:50:34 -0700 | [diff] [blame] | 121 | grpc_call_context_element *context; |
Craig Tiller | b7959a0 | 2015-06-25 08:50:54 -0700 | [diff] [blame] | 122 | } grpc_transport_stream_op; |
Craig Tiller | 3f2c221 | 2015-04-23 07:56:33 -0700 | [diff] [blame] | 123 | |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 124 | /** Transport op: a set of operations to perform on a transport as a whole */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 125 | typedef struct grpc_transport_op { |
Craig Tiller | 1bd9ea4 | 2016-03-03 21:09:31 -0800 | [diff] [blame] | 126 | /** Called when processing of this op is done. */ |
Craig Tiller | 3382511 | 2015-09-18 07:44:19 -0700 | [diff] [blame] | 127 | grpc_closure *on_consumed; |
Craig Tiller | b5585d4 | 2015-11-17 07:18:31 -0800 | [diff] [blame] | 128 | /** connectivity monitoring - set connectivity_state to NULL to unsubscribe */ |
Craig Tiller | 3382511 | 2015-09-18 07:44:19 -0700 | [diff] [blame] | 129 | grpc_closure *on_connectivity_state_change; |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 130 | grpc_connectivity_state *connectivity_state; |
| 131 | /** should the transport be disconnected */ |
| 132 | int disconnect; |
Craig Tiller | 9188d7a | 2015-07-05 12:44:37 -0700 | [diff] [blame] | 133 | /** should we send a goaway? |
| 134 | after a goaway is sent, once there are no more active calls on |
| 135 | the transport, the transport should disconnect */ |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 136 | int send_goaway; |
| 137 | /** what should the goaway contain? */ |
| 138 | grpc_status_code goaway_status; |
| 139 | gpr_slice *goaway_message; |
| 140 | /** set the callback for accepting new streams; |
Craig Tiller | 389297d | 2016-03-03 21:02:54 -0800 | [diff] [blame] | 141 | this is a permanent callback, unlike the other one-shot closures. |
| 142 | If true, the callback is set to set_accept_stream_fn, with its |
| 143 | user_data argument set to set_accept_stream_user_data */ |
Craig Tiller | d7f12e3 | 2016-03-03 10:08:31 -0800 | [diff] [blame] | 144 | bool set_accept_stream; |
| 145 | void (*set_accept_stream_fn)(grpc_exec_ctx *exec_ctx, void *user_data, |
| 146 | grpc_transport *transport, |
| 147 | const void *server_data); |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 148 | void *set_accept_stream_user_data; |
| 149 | /** add this transport to a pollset */ |
| 150 | grpc_pollset *bind_pollset; |
Craig Tiller | 1ada6ad | 2015-07-16 16:19:14 -0700 | [diff] [blame] | 151 | /** add this transport to a pollset_set */ |
| 152 | grpc_pollset_set *bind_pollset_set; |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 153 | /** send a ping, call this back if not NULL */ |
Craig Tiller | 3382511 | 2015-09-18 07:44:19 -0700 | [diff] [blame] | 154 | grpc_closure *send_ping; |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 155 | } grpc_transport_op; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 156 | |
| 157 | /* Returns the amount of memory required to store a grpc_stream for this |
| 158 | transport */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 159 | size_t grpc_transport_stream_size(grpc_transport *transport); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 160 | |
| 161 | /* Initialize transport data for a stream. |
| 162 | |
| 163 | Returns 0 on success, any other (transport-defined) value for failure. |
| 164 | |
| 165 | Arguments: |
| 166 | transport - the transport on which to create this stream |
| 167 | stream - a pointer to uninitialized memory to initialize |
| 168 | server_data - either NULL for a client initiated stream, or a pointer |
| 169 | supplied from the accept_stream callback function */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 170 | int grpc_transport_init_stream(grpc_exec_ctx *exec_ctx, |
| 171 | grpc_transport *transport, grpc_stream *stream, |
Craig Tiller | 9d35a1f | 2015-11-02 14:16:12 -0800 | [diff] [blame] | 172 | grpc_stream_refcount *refcount, |
| 173 | const void *server_data); |
| 174 | |
| 175 | void grpc_transport_set_pollset(grpc_exec_ctx *exec_ctx, |
| 176 | grpc_transport *transport, grpc_stream *stream, |
| 177 | grpc_pollset *pollset); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 178 | |
| 179 | /* Destroy transport data for a stream. |
| 180 | |
| 181 | Requires: a recv_batch with final_state == GRPC_STREAM_CLOSED has been |
| 182 | received by the up-layer. Must not be called in the same call stack as |
| 183 | recv_frame. |
| 184 | |
| 185 | Arguments: |
| 186 | transport - the transport on which to create this stream |
| 187 | stream - the grpc_stream to destroy (memory is still owned by the |
| 188 | caller, but any child memory must be cleaned up) */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 189 | void grpc_transport_destroy_stream(grpc_exec_ctx *exec_ctx, |
| 190 | grpc_transport *transport, |
| 191 | grpc_stream *stream); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 192 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 193 | void grpc_transport_stream_op_finish_with_failure(grpc_exec_ctx *exec_ctx, |
| 194 | grpc_transport_stream_op *op); |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 195 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 196 | void grpc_transport_stream_op_add_cancellation(grpc_transport_stream_op *op, |
| 197 | grpc_status_code status); |
Craig Tiller | 45ce927 | 2015-07-31 11:22:35 -0700 | [diff] [blame] | 198 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 199 | void grpc_transport_stream_op_add_close(grpc_transport_stream_op *op, |
| 200 | grpc_status_code status, |
| 201 | gpr_slice *optional_message); |
Craig Tiller | 2ea37fd | 2015-04-24 13:03:49 -0700 | [diff] [blame] | 202 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 203 | char *grpc_transport_stream_op_string(grpc_transport_stream_op *op); |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 204 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 205 | /* Send a batch of operations on a transport |
| 206 | |
| 207 | Takes ownership of any objects contained in ops. |
| 208 | |
| 209 | Arguments: |
| 210 | transport - the transport on which to initiate the stream |
| 211 | stream - the stream on which to send the operations. This must be |
| 212 | non-NULL and previously initialized by the same transport. |
Craig Tiller | b7959a0 | 2015-06-25 08:50:54 -0700 | [diff] [blame] | 213 | op - a grpc_transport_stream_op specifying the op to perform */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 214 | void grpc_transport_perform_stream_op(grpc_exec_ctx *exec_ctx, |
| 215 | grpc_transport *transport, |
| 216 | grpc_stream *stream, |
| 217 | grpc_transport_stream_op *op); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 218 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 219 | void grpc_transport_perform_op(grpc_exec_ctx *exec_ctx, |
| 220 | grpc_transport *transport, |
| 221 | grpc_transport_op *op); |
Craig Tiller | 3f47542 | 2015-06-25 10:43:05 -0700 | [diff] [blame] | 222 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 223 | /* Send a ping on a transport |
| 224 | |
Craig Tiller | 4aa71a1 | 2015-06-15 13:00:55 -0700 | [diff] [blame] | 225 | Calls cb with user data when a response is received. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 226 | void grpc_transport_ping(grpc_transport *transport, grpc_closure *cb); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 227 | |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 228 | /* Advise peer of pending connection termination. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 229 | void grpc_transport_goaway(grpc_transport *transport, grpc_status_code status, |
| 230 | gpr_slice debug_data); |
nnoble | 0c475f0 | 2014-12-05 15:37:39 -0800 | [diff] [blame] | 231 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 232 | /* Close a transport. Aborts all open streams. */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 233 | void grpc_transport_close(grpc_transport *transport); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 234 | |
| 235 | /* Destroy the transport */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 236 | void grpc_transport_destroy(grpc_exec_ctx *exec_ctx, grpc_transport *transport); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 237 | |
Craig Tiller | 1b22b9d | 2015-07-20 13:42:22 -0700 | [diff] [blame] | 238 | /* Get the transports peer */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 239 | char *grpc_transport_get_peer(grpc_exec_ctx *exec_ctx, |
| 240 | grpc_transport *transport); |
Craig Tiller | 1b22b9d | 2015-07-20 13:42:22 -0700 | [diff] [blame] | 241 | |
Craig Tiller | 9a4dddd | 2016-03-25 17:08:13 -0700 | [diff] [blame] | 242 | #endif /* GRPC_CORE_LIB_TRANSPORT_TRANSPORT_H */ |