PHP 和 C 边缘情况之间的flock()

Question

我有一个 PHP 脚本，它在 Linux 中接收发票并将其保存为文件。之后，一个基于 C++ 无限循环的程序读取每一个并进行一些处理。我希望后者安全地读取每个文件（仅在完全写入之后）。

PHP端代码简化：

file_put_contents("sampleDir/invoice.xml", "contents", LOCK_EX)

在 C++ 方面（使用 C 文件系统 API），我必须首先注意我想保留一个代码，该代码删除指定发票文件夹中的空文件，作为正确处理边缘情况的一种手段从其他来源（不是 PHP 脚本）创建的空文件。

现在，还有一个 C++ 端代码简化：

FILE* pInvoiceFile = fopen("sampleDir/invoice.xml", "r");

if (pInvoiceFile != NULL)
{
    if (flock(pInvoiceFile->_fileno, LOCK_SH) == 0)
    {
        struct stat fileStat;
        fstat(pInvoiceFile->_fileno, &fileStat);
        string invoice;
        invoice.resize(fileStat.st_size);

        if (fread((char*)invoice.data(), 1, fileStat.st_size, pInvoiceFile) < 1)
        {
            remove("sampleDir/invoice.xml"); // Edge case resolution
        }

        flock(pInvoiceFile->_fileno, LOCK_UN);
    }
}

fclose(pInvoiceFile);

如您所见，总结的关键概念是LOCK_EX 和LOCK_SH 标志的合作。

我的问题是，虽然这种集成工作正常，但昨天我注意到为不应为空的发票执行的边缘案例，因此它被 C++ 程序删除。

file_put_contents 上的 PHP 手册提到了 LOCK_EX 标志的以下内容：

在继续写入时获取文件的排他锁。换句话说，flock() 调用发生在fopen() 调用和fwrite() 调用 之间。这与模式为 "x" 的 fopen() 调用不同。

• 在file_put_contents 调用fopen 之前没有建立LOCK_EX 是否会导致问题作为竞争条件？如果是这样，在保留边缘案例删除代码的同时可以做些什么来解决这个问题？
• 否则，我可能做错了什么吗？

Answer 1

您的代码假设file_put_contents() 操作是原子操作，并且使用FLOCK_EX 和FLOCK_SH 足以确保两个程序之间不会发生竞争条件。 This is not the case.

正如您从 PHP 文档中看到的那样，FLOCK_EX 在打开文件后 应用。这很重要，因为它为 C++ 程序成功打开文件并用FLOCK_SH 锁定它留下了很短的时间窗口。此时该文件已被 PHP 完成的 fopen() 截断，它是空的。

最有可能发生的是：

1. PHP 代码打开文件以进行写入、截断并有效清除其内容。
2. C++ 代码打开文件进行读取。
3. C++ 代码请求文件上的共享锁：已授予锁。
4. PHP 代码请求文件的排他锁：调用阻塞，等待锁可用。
5. C++ 代码读取文件内容：无，文件为空。
6. C++ 代码删除文件。
7. C++ 代码释放共享锁。
8. PHP 代码获取排他锁。
9. PHP 代码写入文件：数据未到达磁盘，因为与打开的文件描述符关联的 inode 不再存在。
10. 您实际上没有任何文件并且数据丢失。

您的代码的问题在于，您从两个不同的程序对文件执行的操作不是原子的，并且您获取锁的方式无助于确保它们不会重叠。

在符合 POSIX 的系统上保证此类操作的原子性的唯一合理方法是利用 rename(2) 的原子性：

如果newpath 已经存在，它将被自动替换，因此尝试访问newpath 的另一个进程不会发现它丢失。

如果newpath 存在但由于某种原因操作失败，rename() 保证保留newpath 的实例。

在这种情况下，您应该使用等效的rename() PHP 函数。这是保证对文件进行原子更新的最简单方法。

我的建议如下：

• PHP 代码：

  $tmpfname = tempnam("/tmp", "myprefix");     // Create a temporary file.
  file_put_contents($tmpfname, "contents");    // Write to the temporary file.
  rename($tmpfname, "sampleDir/invoice.xml");  // Atomically replace the contents of invoice.xml by renaming the file.
  
  // TODO: check for errors in all the above calls, most importantly tempnam().
  

• C++ 代码：

  FILE* pInvoiceFile = fopen("sampleDir/invoice.xml", "r");
  
  if (pInvoiceFile != NULL)
  {
      struct stat fileStat;
      fstat(fileno(pInvoiceFile), &fileStat);
  
      string invoice;
      invoice.resize(fileStat.st_size);
  
      size_t n = fread(&invoice[0], 1, fileStat.st_size, pInvoiceFile);
      fclose(pInvoiceFile);
  
      if (n == 0)
          remove("sampleDir/invoice.xml");
  }
  

这样，C++ 程序要么总是看到旧版本的文件（如果 fopen() 出现在 PHP 的 rename() 之前），要么看到新版本的文件（如果 fopen() 出现在之后），但它会永远不会看到不一致的文件版本。