should LOCK_EX on both read & write be atomic?

by

Since this answer is long, here’s the summary: No, file_get_contents() is not atomic as it does not respect advisory locks.

About file locks in PHP:

In PHP, while on a *nix platform, filesystem locking is advisory only. Per the docs (Emphasis mine):

PHP supports a portable way of locking complete files in an advisory way (which means all accessing programs have to use the same way of locking or it will not work). By default, this function will block until the requested lock is acquired; this may be controlled (on non-Windows platforms) with the LOCK_NB option documented below.

So, as long as all of the processes that are accessing the file use this method of locking, you’re fine.

However, if you’re writing a static HTML file with a sane webserver, the lock will be ignored. In the middle of the write, if a request comes in, Apache will serve the partially written file. The locks will have no effect on the other process reading the lock.

The only real exception is if you use the special mount option of -o mand on the filesystem to enable mandatory locking (but that’s not really used much, and can have a performance penalty).

Have a read on File Locking for some more information. Namely the section under Unix:

This means that cooperating processes may use locks to coordinate access to a file among themselves, but programs are also free to ignore locks and access the file in any way they choose to.

So, in conclusion, using LOCK_EX will create an advisory lock on the file. Any attempt to read the file will block only if the reader respects and/or checks for the lock. If they do not, the lock will be ignored (since it can be).

Try it out. In one process:

file_put_contents('test.txt', 'Foo bar');
$f = fopen('test.txt', 'a+');
if (flock($f, LOCK_EX)) {
    sleep(10);
    fseek($f, 0);
    var_dump(fgets($f, 4048));
    flock($f, LOCK_UN);
}
fclose($f);

And while it’s sleeping, call this:

$f = fopen('test.txt', 'a+');
fwrite($f, 'foobar');
fclose($f);

The output will be foobar…

About file_get_contents specifically:

To your other specific question, first off, there is no LOCK_EX parameter to file_get_contents. So you can’t pass that in.

Now, looking at the source code, we can see the function file_get_contents defined on line 521. There are no calls to the internal function php_stream_lock as there are when you pass file_put_contents('file', 'txt', LOCK_EX); defined on line 589 of the same file.

So, let’s test it, shall we:

In file1.php:

file_put_contents('test.txt', 'Foo bar');
$f = fopen('test.txt', 'a+');
if (flock($f, LOCK_EX)) {
    sleep(10);
    fseek($f, 0);
    var_dump(fgets($f, 4048));
    flock($f, LOCK_UN);
}
fclose($f);

In file2.php:

var_dump(file_get_contents('test.txt'));

When run, file2.php returns immediately. So no, it doesn’t appear that file_get_contents respects file locks at all…

More Related Contents:

  1. PHP & Sessions: Is there any way to disable PHP session locking?
  2. file locking in php
  3. Read and write to a file while keeping lock
  4. Changing the source php [closed]
  5. PDOException “could not find driver”
  6. Remove a child with a specific attribute, in SimpleXML for PHP
  7. How to debug in WooCommerce 3+
  8. Trying to get property of non-object – Laravel 5
  9. PHP: exceptions vs errors?
  10. PHP Header redirect not working [duplicate]
  11. Using Mysqli bind_param with date and time columns?
  12. Setting environment variables for accessing in PHP when using Apache
  13. Can you create instance properties dynamically in PHP?
  14. Convert ASCII TO UTF-8 Encoding
  15. How do I insert multiple checkbox values into a table?
  16. Trim unicode whitespace in PHP 5.2
  17. Can I “Mock” time in PHPUnit?
  18. Apache Mod Rewrite For Laravel
  19. What is normalized UTF-8 all about?
  20. Who Add “_” Single Underscore Query Parameter?
  21. Mail returns false
  22. PDO returning incorrect, but duplicate, data. Key’s not in database.
  23. How can I use break or continue within for loop in Twig template?
  24. How can i take an array, divide it by two and create two lists?
  25. Forcing fputcsv to Use Enclosure For *all* Fields
  26. Sending POST parameters with Postman doesn’t work, but sending GET parameters does
  27. If you create a variable inside a if statement is it available outside the if statement?
  28. How to stop GD2 from washing away the colors upon resizing images?
  29. How to use Imagick to merge and mask images?
  30. Merge two PNG images with PHP GD library

Leave a Comment