objective-c - NSTask 竞争条件与 ReadabilityHandler block

Question

基本设置

我使用 NSTask 来运行优化图像的进程。此过程将输出数据写入stdout。我使用 NSTask 的 readabilityHandler 属性来捕获该数据。这是简短的设置:

NSTask *task = [[NSTask alloc] init];
[task setArguments:arguments];  // arguments defined above
                   
NSPipe *errorPipe = [NSPipe pipe];
[task setStandardError:errorPipe];
NSFileHandle *errorFileHandle = [errorPipe fileHandleForReading];
                   
NSPipe *outputPipe = [NSPipe pipe];
[task setStandardOutput:outputPipe];
NSFileHandle *outputFileHandle = [outputPipe fileHandleForReading];
                   
NSMutableData *outputData = [[NSMutableData alloc] init];
NSMutableData *errorOutputData = [[NSMutableData alloc] init];
                   
outputFileHandle.readabilityHandler = ^void(NSFileHandle *handle) { 
      NSLog(@"Appending data for %@", inputPath.lastPathComponent); 
      [outputData appendData:handle.availableData]; 
};

errorFileHandle.readabilityHandler = ^void(NSFileHandle *handle) { 
       [errorOutputData appendData:handle.availableData]; 
};

然后我像这样调用 NSTask:

[task setLaunchPath:_pathToJPEGOptim];
[task launch];
[task waitUntilExit];

(这一切都是在后台调度队列上完成的)。接下来我检查 NSTask 的返回值:

if ([task terminationStatus] == 0)
{
    newSize = outputData.length;
                           
    if (newSize <= 0)
    {
        NSString *errorString = [[NSString alloc] initWithData:errorOutputData encoding:NSUTF8StringEncoding];
        NSLog(@"ERROR string: %@", errorString);
    }

    // Truncated for brevity...
}

<小时/>

问题

大约 98% 的情况下，这都可以完美地工作。但是，-waitUntilExit 似乎可以在 readabilityHandler block 运行之前触发。以下屏幕截图显示可读性处理程序在任务退出后正在运行:

所以这显然是运行 readabilityHandler 的调度队列和我触发 NSTask 的调度队列之间的竞争条件。我的问题是:我到底如何确定 readabilityHandler 已完成？如果当 NSTask 告诉我它已经完成时，它可能还没有完成，我该如何克服这个竞争条件？

<小时/>

注意:

我知道 NSTask 有一个可选的 completionHandler block 。但文档指出，在 -waitUntilExit 返回之前，不保证该 block 运行，这意味着它甚至可以比 -waitUntilExit 更快地开始运行。这将使竞争条件更有可能发生。

Answer 1

更新:现代 macOS:

availableData 不再存在我在下面描述的问题。我不确定它们是什么时候解决的，但至少蒙特雷工作正常。下面描述的方法适用于旧版本的 macOS。

此外，随着现代 Swift 并发系统的到位和“线程总是可以前进”的新范式，使用如下所示的信号量应该是最后的手段。如果可以，请使用 NSTask 的 completionHandler API。我没有正式保证可读性处理程序将在调用completionHandler之前完成，但它们在实践中似乎是这样，至少在现代macOS上是这样。您的里程可能会有所不同。

<小时/>

旧建议:

好吧，经过多次尝试和错误，这是正确的处理方法:

1。不要使用-AvailableData

在可读性处理程序 block 中，请勿使用 -availableData 方法。这会产生奇怪的副作用，有时不会捕获所有可用数据，并且会干扰系统尝试使用空 NSData 对象调用处理程序以发出管道关闭信号，因为 -availableData 会阻塞直到数据确实可用。

2。使用-readDataOfLength:

相反，请在可读性处理程序 block 中使用-readDataOfLength:NSUIntegerMax。通过这种方法，处理程序可以正确接收一个空的 NSData 对象，您可以使用该对象来检测管道的关闭并发出信号量信号。

3。当心 macOS 10.12!

Apple 在 10.13 中修复了一个绝对重要的错误:在旧版本的 macOS 上，如果没有数据可读取，则永远不会调用可读性处理程序。也就是说，它们永远不会被调用为零长度数据来表明它们已完成。这会导致使用信号量方法永久挂起，因为信号量永远不会增加。为了解决这个问题，我测试了 macOS 10.12 或更低版本，如果我在旧操作系统上运行，我会使用对dispatch_semaphore_wait()的单个调用，该调用与 NSTask 的completionHandler block 中对dispatch_semaphore_signal()的单个调用配对。我让完成 block 休眠 0.2 秒，以允许处理程序执行。这显然是一个极其丑陋的黑客行为，但它确实有效。如果我使用的是 10.13 以上版本，我有不同的可读性处理程序来发出信号量信号(一次来自错误处理程序，一次来自正常输出处理程序)，并且我仍然从completionHandler block 发出信号量信号。在我启动任务后，这些与对dispatch_semaphore_wait()的3次调用配对。在这种情况下，完成 block 中不需要延迟，因为当 fileHandle 完成时，macOS 正确地调用具有零长度数据的可读性处理程序。

<小时/>

示例:

(注意:假设内容的定义与我原来的问题示例中相同。为了便于阅读，已缩短此代码。)

// Create the semaphore
dispatch_semaphore_t sema = dispatch_semaphore_create(0);

// Define a handler to collect output data from our NSTask
outputFileHandle.readabilityHandler = ^void(NSFileHandle *handle)
{
    // DO NOT use -availableData in these handlers.
    NSData *newData = [handle readDataOfLength:NSUIntegerMax];
    if (newData.length == 0) 
    {
        // end of data signal is an empty data object.
        outputFileHandle.readabilityHandler = nil;
        dispatch_semaphore_signal(sema);
    } 
    else 
    {
       [outputData appendData:newData];
    }
};

// Repeat the above for the 'errorFileHandle' readabilityHandler.


[task launch];
  
// two calls to wait because we are going to signal the semaphore once when
// our 'outputFileHandle' pipe closes and once when our 'errorFileHandle' pipe closes                     
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);

// ... do stuff when the task is done AND the pipes have finished handling data.

// After doing stuff, release the semaphore
dispatch_release(sema);
sema = NULL;