2 * Copyright (c) 2016 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
26 #import "keychain/ckks/CKKSResultOperation.h"
27 #import "keychain/ckks/NSOperationCategories.h"
28 #import "keychain/ckks/CKKSCondition.h"
29 #import "keychain/categories/NSError+UsefulConstructors.h"
30 #import "keychain/ot/ObjCImprovements.h"
31 #import "keychain/ckks/CKKS.h"
33 @interface CKKSResultOperation()
34 @property NSMutableArray<CKKSResultOperation*>* successDependencies;
35 @property bool timeoutCanOccur;
36 @property dispatch_queue_t timeoutQueue;
37 @property void (^finishingBlock)(void);
40 @implementation CKKSResultOperation
41 - (instancetype)init {
42 if(self = [super init]) {
45 _successDependencies = [[NSMutableArray alloc] init];
46 _timeoutCanOccur = true;
47 _timeoutQueue = dispatch_queue_create("result-operation-timeout", DISPATCH_QUEUE_SERIAL_WITH_AUTORELEASE_POOL);
48 _completionHandlerDidRunCondition = [[CKKSCondition alloc] init];
50 _finishingBlock = ^(void) {
52 self.finishDate = [NSDate dateWithTimeIntervalSinceNow:0];
54 self.completionBlock = ^{}; // our _finishing block gets added in the method override
59 - (NSString*)operationStateString {
60 return ([self isFinished] ? [NSString stringWithFormat:@"finished %@", self.finishDate] :
61 [self isCancelled] ? @"cancelled" :
62 [self isExecuting] ? @"executing" :
63 [self isReady] ? @"ready" :
68 - (NSString*)description {
69 static __thread unsigned __descriptionRecursion = 0;
70 NSString* state = [self operationStateString];
71 NSString *desc = NULL;
73 __descriptionRecursion++;
74 if(__descriptionRecursion > 10) {
75 desc = [NSString stringWithFormat: @"<%@: %@ recursion>", [self selfname], state];
76 } else if(self.error) {
77 desc = [NSString stringWithFormat: @"<%@: %@ error:%@>", [self selfname], state, self.error];
79 desc = [NSString stringWithFormat: @"<%@: %@%@>", [self selfname], state, [self pendingDependenciesString:@" dep:"]];
81 __descriptionRecursion--;
85 - (NSString*)debugDescription {
86 return [self description];
89 - (void)setCompletionBlock:(void (^)(void))completionBlock
92 [super setCompletionBlock:^(void) {
95 ckkserror_global("resultoperation", "completion handler called on deallocated operation instance");
96 completionBlock(); // go ahead and still behave as things would if this method override were not here
100 self.finishingBlock();
102 [self.completionHandlerDidRunCondition fulfill];
104 for (NSOperation *op in self.dependencies) {
105 [self removeDependency:op];
111 if(![self allDependentsSuccessful]) {
112 secdebug("ckksresultoperation", "Not running due to some failed dependent: %@", self.error);
115 [self invalidateTimeout];
122 - (void)invalidateTimeout {
123 dispatch_sync(self.timeoutQueue, ^{
124 if(![self isCancelled]) {
125 self.timeoutCanOccur = false;
130 - (NSError* _Nullable)dependenciesDescriptionError {
131 NSError* underlyingReason = nil;
132 NSArray* dependencies = [self.dependencies copy];
133 dependencies = [dependencies objectsAtIndexes: [dependencies indexesOfObjectsPassingTest: ^BOOL (id obj,
136 return [obj isFinished] ? NO : YES;
139 for(NSOperation* dependency in dependencies) {
140 if([dependency isKindOfClass:[CKKSResultOperation class]]) {
141 CKKSResultOperation* ro = (CKKSResultOperation*)dependency;
142 underlyingReason = [ro descriptionError] ?: underlyingReason;
146 return underlyingReason;
149 // Returns, for this CKKSResultOperation, an error describing this operation or its dependents.
150 // Used mainly by other CKKSResultOperations who time out waiting for this operation to start/complete.
151 - (NSError* _Nullable)descriptionError {
152 static __thread unsigned __descriptionRecursion = 0;
154 NSError* result = nil;
156 __descriptionRecursion += 1;
158 if(self.descriptionErrorCode != 0) {
159 result = [NSError errorWithDomain:CKKSResultDescriptionErrorDomain
160 code:self.descriptionErrorCode
162 } else if(__descriptionRecursion > 10) {
163 result = [NSError errorWithDomain:CKKSResultDescriptionErrorDomain
165 description:@"Excess recursion"];
167 result = [self dependenciesDescriptionError];
170 __descriptionRecursion -= 1;
175 - (NSError*)_onqueueTimeoutError {
176 dispatch_assert_queue(self.timeoutQueue);
177 // Find if any of our dependencies are CKKSResultOperations with a custom reason for existing
179 NSError* underlyingReason = [self descriptionError];
181 NSError* error = [NSError errorWithDomain:CKKSResultErrorDomain
182 code:CKKSResultTimedOut
183 description:[NSString stringWithFormat:@"Operation(%@) timed out waiting to start for [%@]",
185 [self pendingDependenciesString:@""]]
186 underlying:underlyingReason];
190 - (instancetype)timeout:(dispatch_time_t)timeout {
192 dispatch_after(dispatch_time(DISPATCH_TIME_NOW, timeout), self.timeoutQueue, ^{
194 if(self.timeoutCanOccur) {
195 self.error = [self _onqueueTimeoutError];
196 self.timeoutCanOccur = false;
204 - (void)addSuccessDependency:(CKKSResultOperation *)operation {
205 [self addNullableSuccessDependency:operation];
208 - (void)addNullableSuccessDependency:(CKKSResultOperation *)operation {
212 @synchronized(self) {
213 [self.successDependencies addObject: operation];
214 [self addDependency: operation];
218 - (bool)allDependentsSuccessful {
219 return [self allSuccessful: self.successDependencies];
222 - (bool)allSuccessful: (NSArray<CKKSResultOperation*>*) operations {
223 @synchronized(self) {
226 bool finished = true; // all dependents must be finished
227 bool cancelled = false; // no dependents can be cancelled
228 bool failed = false; // no dependents can have failed
229 NSMutableArray<NSOperation*>* cancelledSuboperations = [NSMutableArray array];
231 for(CKKSResultOperation* op in operations) {
232 finished &= !!([op isFinished]);
233 cancelled |= !!([op isCancelled]);
234 failed |= (op.error != nil);
236 if([op isCancelled]) {
237 [cancelledSuboperations addObject:op];
240 // TODO: combine suberrors
241 if(op.error != nil) {
242 if([op.error.domain isEqual: CKKSResultErrorDomain] && op.error.code == CKKSResultSubresultError) {
243 // Already a subresult, just copy it on in
244 self.error = op.error;
246 self.error = [NSError errorWithDomain:CKKSResultErrorDomain
247 code:CKKSResultSubresultError
248 description:@"Success-dependent operation failed"
249 underlying:op.error];
254 result = finished && !( cancelled || failed );
256 if(!result && self.error == nil) {
257 self.error = [NSError errorWithDomain:CKKSResultErrorDomain code: CKKSResultSubresultCancelled userInfo:@{NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Operation (%@) cancelled", cancelledSuboperations]}];
263 + (CKKSResultOperation*)operationWithBlock:(void (^)(void))block {
264 CKKSResultOperation* op = [[self alloc] init];
265 [op addExecutionBlock: block];
269 + (instancetype)named:(NSString*)name withBlock:(void(^)(void)) block {
270 CKKSResultOperation* blockOp = [self operationWithBlock: block];
275 + (instancetype)named:(NSString*)name withBlockTakingSelf:(void(^)(CKKSResultOperation* op))block
277 CKKSResultOperation* op = [[self alloc] init];
278 __weak __typeof(op) weakOp = op;
279 [op addExecutionBlock:^{
280 __strong __typeof(op) strongOp = weakOp;