/* * * Copyright 2015 gRPC authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ #import "GRPCCall.h" #import "GRPCCall+OAuth2.h" #import #import #import #import #include #include #import "GRPCCallOptions.h" #import "private/GRPCHost.h" #import "private/GRPCConnectivityMonitor.h" #import "private/GRPCRequestHeaders.h" #import "private/GRPCWrappedCall.h" #import "private/NSData+GRPC.h" #import "private/NSDictionary+GRPC.h" #import "private/NSError+GRPC.h" // At most 6 ops can be in an op batch for a client: SEND_INITIAL_METADATA, // SEND_MESSAGE, SEND_CLOSE_FROM_CLIENT, RECV_INITIAL_METADATA, RECV_MESSAGE, // and RECV_STATUS_ON_CLIENT. NSInteger kMaxClientBatch = 6; NSString *const kGRPCHeadersKey = @"io.grpc.HeadersKey"; NSString *const kGRPCTrailersKey = @"io.grpc.TrailersKey"; static NSMutableDictionary *callFlags; static NSString *const kAuthorizationHeader = @"authorization"; static NSString *const kBearerPrefix = @"Bearer "; const char *kCFStreamVarName = "grpc_cfstream"; @interface GRPCCall () // Make them read-write. @property(atomic, strong) NSDictionary *responseHeaders; @property(atomic, strong) NSDictionary *responseTrailers; @property(atomic) BOOL isWaitingForToken; - (instancetype)initWithHost:(NSString *)host path:(NSString *)path callSafety:(GRPCCallSafety)safety requestsWriter:(GRXWriter *)requestsWriter callOptions:(GRPCCallOptions *)callOptions; @end @implementation GRPCRequestOptions - (instancetype)initWithHost:(NSString *)host path:(NSString *)path safety:(GRPCCallSafety)safety { if ((self = [super init])) { _host = host; _path = path; _safety = safety; } return self; } - (id)copyWithZone:(NSZone *)zone { GRPCRequestOptions *request = [[GRPCRequestOptions alloc] initWithHost:[_host copy] path:[_path copy] safety:_safety]; return request; } @end @implementation GRPCCall2 { GRPCCallOptions *_callOptions; id _handler; GRPCCall *_call; BOOL _initialMetadataPublished; GRXBufferedPipe *_pipe; dispatch_queue_t _dispatchQueue; } - (instancetype)initWithRequestOptions:(GRPCRequestOptions *)requestOptions handler:(id)handler callOptions:(GRPCCallOptions *)callOptions { if (!requestOptions || !requestOptions.host || !requestOptions.path) { [NSException raise:NSInvalidArgumentException format:@"Neither host nor path can be nil."]; } if ((self = [super init])) { _requestOptions = [requestOptions copy]; _callOptions = [callOptions copy]; _handler = handler; _initialMetadataPublished = NO; _pipe = [GRXBufferedPipe pipe]; _dispatchQueue = dispatch_queue_create(NULL, DISPATCH_QUEUE_SERIAL); } return self; } - (instancetype)initWithRequestOptions:(GRPCRequestOptions *)requestOptions handler:(id)handler { return [self initWithRequestOptions:requestOptions handler:handler callOptions:nil]; } - (void)start { dispatch_async(_dispatchQueue, ^{ if (!self->_callOptions) { self->_callOptions = [[GRPCCallOptions alloc] init]; } self->_call = [[GRPCCall alloc] initWithHost:self->_requestOptions.host path:self->_requestOptions.path callSafety:self->_requestOptions.safety requestsWriter:self->_pipe callOptions:self->_callOptions]; if (self->_callOptions.initialMetadata) { [self->_call.requestHeaders addEntriesFromDictionary:self->_callOptions.initialMetadata]; } id responseWriteable = [[GRXWriteable alloc] initWithValueHandler:^(id value) { dispatch_async(self->_dispatchQueue, ^{ if (self->_handler) { id handler = self->_handler; NSDictionary *headers = nil; if (!self->_initialMetadataPublished) { headers = self->_call.responseHeaders; self->_initialMetadataPublished = YES; } if (headers) { dispatch_async(handler.dispatchQueue, ^{ [handler receivedInitialMetadata:headers]; }); } if (value) { dispatch_async(handler.dispatchQueue, ^{ [handler receivedMessage:value]; }); } } }); } completionHandler:^(NSError *errorOrNil) { dispatch_async(self->_dispatchQueue, ^{ if (self->_handler) { id handler = self->_handler; NSDictionary *headers = nil; if (!self->_initialMetadataPublished) { headers = self->_call.responseHeaders; self->_initialMetadataPublished = YES; } if (headers) { dispatch_async(handler.dispatchQueue, ^{ [handler receivedInitialMetadata:headers]; }); } dispatch_async(handler.dispatchQueue, ^{ [handler closedWithTrailingMetadata:self->_call.responseTrailers error:errorOrNil]; }); } }); }]; [self->_call startWithWriteable:responseWriteable]; }); } - (void)cancel { dispatch_async(_dispatchQueue, ^{ if (self->_call) { [self->_call cancel]; self->_call = nil; } if (self->_handler) { id handler = self->_handler; dispatch_async(handler.dispatchQueue, ^{ [handler closedWithTrailingMetadata:nil error:[NSError errorWithDomain:kGRPCErrorDomain code:GRPCErrorCodeCancelled userInfo:@{ NSLocalizedDescriptionKey : @"Canceled by app" }]]; }); self->_handler = nil; } }); } - (void)writeWithData:(NSData *)data { dispatch_async(_dispatchQueue, ^{ [self->_pipe writeValue:data]; }); } - (void)finish { dispatch_async(_dispatchQueue, ^{ if (self->_call) { [self->_pipe writesFinishedWithError:nil]; } }); } @end // The following methods of a C gRPC call object aren't reentrant, and thus // calls to them must be serialized: // - start_batch // - destroy // // start_batch with a SEND_MESSAGE argument can only be called after the // OP_COMPLETE event for any previous write is received. This is achieved by // pausing the requests writer immediately every time it writes a value, and // resuming it again when OP_COMPLETE is received. // // Similarly, start_batch with a RECV_MESSAGE argument can only be called after // the OP_COMPLETE event for any previous read is received.This is easier to // enforce, as we're writing the received messages into the writeable: // start_batch is enqueued once upon receiving the OP_COMPLETE event for the // RECV_METADATA batch, and then once after receiving each OP_COMPLETE event for // each RECV_MESSAGE batch. @implementation GRPCCall { dispatch_queue_t _callQueue; NSString *_host; NSString *_path; GRPCCallSafety _callSafety; GRPCCallOptions *_callOptions; GRPCWrappedCall *_wrappedCall; GRPCConnectivityMonitor *_connectivityMonitor; // The C gRPC library has less guarantees on the ordering of events than we // do. Particularly, in the face of errors, there's no ordering guarantee at // all. This wrapper over our actual writeable ensures thread-safety and // correct ordering. GRXConcurrentWriteable *_responseWriteable; // The network thread wants the requestWriter to resume (when the server is ready for more input), // or to stop (on errors), concurrently with user threads that want to start it, pause it or stop // it. Because a writer isn't thread-safe, we'll synchronize those operations on it. // We don't use a dispatch queue for that purpose, because the writer can call writeValue: or // writesFinishedWithError: on this GRPCCall as part of those operations. We want to be able to // pause the writer immediately on writeValue:, so we need our locking to be recursive. GRXWriter *_requestWriter; // To create a retain cycle when a call is started, up until it finishes. See // |startWithWriteable:| and |finishWithError:|. This saves users from having to retain a // reference to the call object if all they're interested in is the handler being executed when // the response arrives. GRPCCall *_retainSelf; GRPCRequestHeaders *_requestHeaders; // In the case that the call is a unary call (i.e. the writer to GRPCCall is of type // GRXImmediateSingleWriter), GRPCCall will delay sending ops (not send them to C core // immediately) and buffer them into a batch _unaryOpBatch. The batch is sent to C core when // the SendClose op is added. BOOL _unaryCall; NSMutableArray *_unaryOpBatch; // The dispatch queue to be used for enqueuing responses to user. Defaulted to the main dispatch // queue dispatch_queue_t _responseQueue; // Whether the call is finished. If it is, should not call finishWithError again. BOOL _finished; // The OAuth2 token fetched from a token provider. NSString *_fetchedOauth2AccessToken; } @synthesize state = _state; + (void)initialize { // Guarantees the code in {} block is invoked only once. See ref at: // https://developer.apple.com/documentation/objectivec/nsobject/1418639-initialize?language=objc if (self == [GRPCCall self]) { grpc_init(); callFlags = [NSMutableDictionary dictionary]; } } + (void)setCallSafety:(GRPCCallSafety)callSafety host:(NSString *)host path:(NSString *)path { NSString *hostAndPath = [NSString stringWithFormat:@"%@/%@", host, path]; switch (callSafety) { case GRPCCallSafetyDefault: callFlags[hostAndPath] = @0; break; case GRPCCallSafetyIdempotentRequest: callFlags[hostAndPath] = @GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST; break; case GRPCCallSafetyCacheableRequest: callFlags[hostAndPath] = @GRPC_INITIAL_METADATA_CACHEABLE_REQUEST; break; default: break; } } + (uint32_t)callFlagsForHost:(NSString *)host path:(NSString *)path { NSString *hostAndPath = [NSString stringWithFormat:@"%@/%@", host, path]; return [callFlags[hostAndPath] intValue]; } - (instancetype)init { return [self initWithHost:nil path:nil requestsWriter:nil]; } // Designated initializer - (instancetype)initWithHost:(NSString *)host path:(NSString *)path requestsWriter:(GRXWriter *)requestWriter { return [self initWithHost:host path:path callSafety:GRPCCallSafetyDefault requestsWriter:requestWriter callOptions:nil]; } - (instancetype)initWithHost:(NSString *)host path:(NSString *)path callSafety:(GRPCCallSafety)safety requestsWriter:(GRXWriter *)requestWriter callOptions:(GRPCCallOptions *)callOptions { if (!host || !path) { [NSException raise:NSInvalidArgumentException format:@"Neither host nor path can be nil."]; } if (requestWriter.state != GRXWriterStateNotStarted) { [NSException raise:NSInvalidArgumentException format:@"The requests writer can't be already started."]; } if ((self = [super init])) { _host = [host copy]; _path = [path copy]; _callSafety = safety; _callOptions = [callOptions copy]; // Serial queue to invoke the non-reentrant methods of the grpc_call object. _callQueue = dispatch_queue_create("io.grpc.call", NULL); _requestWriter = requestWriter; _requestHeaders = [[GRPCRequestHeaders alloc] initWithCall:self]; if ([requestWriter isKindOfClass:[GRXImmediateSingleWriter class]]) { _unaryCall = YES; _unaryOpBatch = [NSMutableArray arrayWithCapacity:kMaxClientBatch]; } _responseQueue = dispatch_get_main_queue(); } return self; } - (void)setResponseDispatchQueue:(dispatch_queue_t)queue { if (_state != GRXWriterStateNotStarted) { return; } _responseQueue = queue; } #pragma mark Finish - (void)finishWithError:(NSError *)errorOrNil { @synchronized(self) { _state = GRXWriterStateFinished; } // If there were still request messages coming, stop them. @synchronized(_requestWriter) { _requestWriter.state = GRXWriterStateFinished; } if (errorOrNil) { [_responseWriteable cancelWithError:errorOrNil]; } else { [_responseWriteable enqueueSuccessfulCompletion]; } // Connectivity monitor is not required for CFStream char *enableCFStream = getenv(kCFStreamVarName); if (enableCFStream == nil || enableCFStream[0] != '1') { [GRPCConnectivityMonitor unregisterObserver:self]; } // If the call isn't retained anywhere else, it can be deallocated now. _retainSelf = nil; } - (void)cancelCall { // Can be called from any thread, any number of times. [_wrappedCall cancel]; } - (void)cancel { if (!self.isWaitingForToken) { [self cancelCall]; } else { self.isWaitingForToken = NO; } [self maybeFinishWithError:[NSError errorWithDomain:kGRPCErrorDomain code:GRPCErrorCodeCancelled userInfo:@{NSLocalizedDescriptionKey : @"Canceled by app"}]]; } - (void)maybeFinishWithError:(NSError *)errorOrNil { BOOL toFinish = NO; @synchronized(self) { if (_finished == NO) { _finished = YES; toFinish = YES; } } if (toFinish == YES) { [self finishWithError:errorOrNil]; } } - (void)dealloc { __block GRPCWrappedCall *wrappedCall = _wrappedCall; dispatch_async(_callQueue, ^{ wrappedCall = nil; }); } #pragma mark Read messages // Only called from the call queue. // The handler will be called from the network queue. - (void)startReadWithHandler:(void (^)(grpc_byte_buffer *))handler { // TODO(jcanizales): Add error handlers for async failures [_wrappedCall startBatchWithOperations:@[ [[GRPCOpRecvMessage alloc] initWithHandler:handler] ]]; } // Called initially from the network queue once response headers are received, // then "recursively" from the responseWriteable queue after each response from the // server has been written. // If the call is currently paused, this is a noop. Restarting the call will invoke this // method. // TODO(jcanizales): Rename to readResponseIfNotPaused. - (void)startNextRead { @synchronized(self) { if (self.state == GRXWriterStatePaused) { return; } } dispatch_async(_callQueue, ^{ __weak GRPCCall *weakSelf = self; __weak GRXConcurrentWriteable *weakWriteable = self->_responseWriteable; [self startReadWithHandler:^(grpc_byte_buffer *message) { __strong GRPCCall *strongSelf = weakSelf; __strong GRXConcurrentWriteable *strongWriteable = weakWriteable; if (message == NULL) { // No more messages from the server return; } NSData *data = [NSData grpc_dataWithByteBuffer:message]; grpc_byte_buffer_destroy(message); if (!data) { // The app doesn't have enough memory to hold the server response. We // don't want to throw, because the app shouldn't crash for a behavior // that's on the hands of any server to have. Instead we finish and ask // the server to cancel. [strongSelf cancelCall]; [strongSelf maybeFinishWithError:[NSError errorWithDomain:kGRPCErrorDomain code:GRPCErrorCodeResourceExhausted userInfo:@{ NSLocalizedDescriptionKey : @"Client does not have enough memory to " @"hold the server response." }]]; return; } [strongWriteable enqueueValue:data completionHandler:^{ [strongSelf startNextRead]; }]; }]; }); } #pragma mark Send headers - (void)sendHeaders { // TODO (mxyan): Remove after deprecated methods are removed uint32_t callSafetyFlags; switch (_callSafety) { case GRPCCallSafetyDefault: callSafetyFlags = 0; break; case GRPCCallSafetyIdempotentRequest: callSafetyFlags = GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST; break; case GRPCCallSafetyCacheableRequest: callSafetyFlags = GRPC_INITIAL_METADATA_CACHEABLE_REQUEST; break; default: [NSException raise:NSInvalidArgumentException format:@"Invalid call safety value."]; } uint32_t callFlag = callSafetyFlags; NSMutableDictionary *headers = _requestHeaders; if (_fetchedOauth2AccessToken != nil) { headers[@"authorization"] = [kBearerPrefix stringByAppendingString:_fetchedOauth2AccessToken]; } else if (_callOptions.oauth2AccessToken != nil) { headers[@"authorization"] = [kBearerPrefix stringByAppendingString:_callOptions.oauth2AccessToken]; } // TODO(jcanizales): Add error handlers for async failures GRPCOpSendMetadata *op = [[GRPCOpSendMetadata alloc] initWithMetadata:headers flags:callFlag handler:nil]; // No clean-up needed after SEND_INITIAL_METADATA if (!_unaryCall) { [_wrappedCall startBatchWithOperations:@[ op ]]; } else { [_unaryOpBatch addObject:op]; } } #pragma mark GRXWriteable implementation // Only called from the call queue. The error handler will be called from the // network queue if the write didn't succeed. // If the call is a unary call, parameter \a errorHandler will be ignored and // the error handler of GRPCOpSendClose will be executed in case of error. - (void)writeMessage:(NSData *)message withErrorHandler:(void (^)(void))errorHandler { __weak GRPCCall *weakSelf = self; void (^resumingHandler)(void) = ^{ // Resume the request writer. GRPCCall *strongSelf = weakSelf; if (strongSelf) { @synchronized(strongSelf->_requestWriter) { strongSelf->_requestWriter.state = GRXWriterStateStarted; } } }; GRPCOpSendMessage *op = [[GRPCOpSendMessage alloc] initWithMessage:message handler:resumingHandler]; if (!_unaryCall) { [_wrappedCall startBatchWithOperations:@[ op ] errorHandler:errorHandler]; } else { // Ignored errorHandler since it is the same as the one for GRPCOpSendClose. // TODO (mxyan): unify the error handlers of all Ops into a single closure. [_unaryOpBatch addObject:op]; } } - (void)writeValue:(id)value { // TODO(jcanizales): Throw/assert if value isn't NSData. // Pause the input and only resume it when the C layer notifies us that writes // can proceed. @synchronized(_requestWriter) { _requestWriter.state = GRXWriterStatePaused; } dispatch_async(_callQueue, ^{ // Write error is not processed here. It is handled by op batch of GRPC_OP_RECV_STATUS_ON_CLIENT [self writeMessage:value withErrorHandler:nil]; }); } // Only called from the call queue. The error handler will be called from the // network queue if the requests stream couldn't be closed successfully. - (void)finishRequestWithErrorHandler:(void (^)(void))errorHandler { if (!_unaryCall) { [_wrappedCall startBatchWithOperations:@[ [[GRPCOpSendClose alloc] init] ] errorHandler:errorHandler]; } else { [_unaryOpBatch addObject:[[GRPCOpSendClose alloc] init]]; [_wrappedCall startBatchWithOperations:_unaryOpBatch errorHandler:errorHandler]; } } - (void)writesFinishedWithError:(NSError *)errorOrNil { if (errorOrNil) { [self cancel]; } else { dispatch_async(_callQueue, ^{ // EOS error is not processed here. It is handled by op batch of GRPC_OP_RECV_STATUS_ON_CLIENT [self finishRequestWithErrorHandler:nil]; }); } } #pragma mark Invoke // Both handlers will eventually be called, from the network queue. Writes can start immediately // after this. // The first one (headersHandler), when the response headers are received. // The second one (completionHandler), whenever the RPC finishes for any reason. - (void)invokeCallWithHeadersHandler:(void (^)(NSDictionary *))headersHandler completionHandler:(void (^)(NSError *, NSDictionary *))completionHandler { // TODO(jcanizales): Add error handlers for async failures [_wrappedCall startBatchWithOperations:@[ [[GRPCOpRecvMetadata alloc] initWithHandler:headersHandler] ]]; [_wrappedCall startBatchWithOperations:@[ [[GRPCOpRecvStatus alloc] initWithHandler:completionHandler] ]]; } - (void)invokeCall { __weak GRPCCall *weakSelf = self; [self invokeCallWithHeadersHandler:^(NSDictionary *headers) { // Response headers received. __strong GRPCCall *strongSelf = weakSelf; if (strongSelf) { strongSelf.responseHeaders = headers; [strongSelf startNextRead]; } } completionHandler:^(NSError *error, NSDictionary *trailers) { __strong GRPCCall *strongSelf = weakSelf; if (strongSelf) { strongSelf.responseTrailers = trailers; if (error) { NSMutableDictionary *userInfo = [NSMutableDictionary dictionary]; if (error.userInfo) { [userInfo addEntriesFromDictionary:error.userInfo]; } userInfo[kGRPCTrailersKey] = strongSelf.responseTrailers; // TODO(jcanizales): The C gRPC library doesn't guarantee that the headers block will be // called before this one, so an error might end up with trailers but no headers. We // shouldn't call finishWithError until ater both blocks are called. It is also when // this is done that we can provide a merged view of response headers and trailers in a // thread-safe way. if (strongSelf.responseHeaders) { userInfo[kGRPCHeadersKey] = strongSelf.responseHeaders; } error = [NSError errorWithDomain:error.domain code:error.code userInfo:userInfo]; } [strongSelf maybeFinishWithError:error]; } }]; // Now that the RPC has been initiated, request writes can start. @synchronized(_requestWriter) { [_requestWriter startWithWriteable:self]; } } #pragma mark GRXWriter implementation - (void)startCallWithWriteable:(id)writeable { _responseWriteable = [[GRXConcurrentWriteable alloc] initWithWriteable:writeable dispatchQueue:_responseQueue]; _wrappedCall = [[GRPCWrappedCall alloc] initWithHost:_host path:_path callOptions:_callOptions]; NSAssert(_wrappedCall, @"Error allocating RPC objects. Low memory?"); [self sendHeaders]; [self invokeCall]; // Connectivity monitor is not required for CFStream char *enableCFStream = getenv(kCFStreamVarName); if (enableCFStream == nil || enableCFStream[0] != '1') { [GRPCConnectivityMonitor registerObserver:self selector:@selector(connectivityChanged:)]; } } - (void)startWithWriteable:(id)writeable { @synchronized(self) { _state = GRXWriterStateStarted; } // Create a retain cycle so that this instance lives until the RPC finishes (or is cancelled). // This makes RPCs in which the call isn't externally retained possible (as long as it is started // before being autoreleased). // Care is taken not to retain self strongly in any of the blocks used in this implementation, so // that the life of the instance is determined by this retain cycle. _retainSelf = self; if (_callOptions == nil) { GRPCMutableCallOptions *callOptions; if ([GRPCHost isHostConfigured:_host]) { GRPCHost *hostConfig = [GRPCHost hostWithAddress:_host]; callOptions = hostConfig.callOptions; } else { callOptions = [[GRPCMutableCallOptions alloc] init]; } if (_serverName != nil) { callOptions.serverAuthority = _serverName; } if (_timeout != 0) { callOptions.timeout = _timeout; } uint32_t callFlags = [GRPCCall callFlagsForHost:_host path:_path]; if (callFlags != 0) { if (callFlags == GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST) { _callSafety = GRPCCallSafetyIdempotentRequest; } else if (callFlags == GRPC_INITIAL_METADATA_CACHEABLE_REQUEST) { _callSafety = GRPCCallSafetyCacheableRequest; } } id tokenProvider = self.tokenProvider; if (tokenProvider != nil) { callOptions.authTokenProvider = tokenProvider; } _callOptions = callOptions; } if (_callOptions.authTokenProvider != nil) { self.isWaitingForToken = YES; __weak typeof(self) weakSelf = self; [self.tokenProvider getTokenWithHandler:^(NSString *token) { typeof(self) strongSelf = weakSelf; if (strongSelf && strongSelf.isWaitingForToken) { if (token) { strongSelf->_fetchedOauth2AccessToken = token; } [strongSelf startCallWithWriteable:writeable]; strongSelf.isWaitingForToken = NO; } }]; } else { [self startCallWithWriteable:writeable]; } } - (void)setState:(GRXWriterState)newState { @synchronized(self) { // Manual transitions are only allowed from the started or paused states. if (_state == GRXWriterStateNotStarted || _state == GRXWriterStateFinished) { return; } switch (newState) { case GRXWriterStateFinished: _state = newState; // Per GRXWriter's contract, setting the state to Finished manually // means one doesn't wish the writeable to be messaged anymore. [_responseWriteable cancelSilently]; _responseWriteable = nil; return; case GRXWriterStatePaused: _state = newState; return; case GRXWriterStateStarted: if (_state == GRXWriterStatePaused) { _state = newState; [self startNextRead]; } return; case GRXWriterStateNotStarted: return; } } } - (void)connectivityChanged:(NSNotification *)note { // Cancel underlying call upon this notification __strong GRPCCall *strongSelf = self; if (strongSelf) { [self cancelCall]; [self maybeFinishWithError:[NSError errorWithDomain:kGRPCErrorDomain code:GRPCErrorCodeUnavailable userInfo:@{ NSLocalizedDescriptionKey : @"Connectivity lost." }]]; } } @end