write(2)

ИМЯ
write - запись в файловый дескриптор

LIBRARY
Standard C library (libc, -lc)

СИНТАКСИС
#include <unistd.h>

ssize_t write(int fd, const void buf[.count], size_t count);

ОПИСАНИЕ
Вызов write() пишет до count байт из буфера, начиная с buf, в файл, на который ссылается файловый дескриптор fd.

Количество записанных байт может быть меньше чем count если, например, недостаточно места на физическом носителе, или исчерпан отведённый лимит ресурса RLIMIT_FSIZE (см. setrlimit(2)), или вызов был прерван обработчиком сигналов после уже записанных меньше чем count байт. (См. также pipe(7).)

В случае с файлами, разрешающими позиционирование (т.е., к которым можно применить lseek(2), например, обычные файлы), запись производится по текущему файловому смещению, а смещение файла увеличивается на реальное число записанных байт. Если файл был открыт с помощью open(2) с аргументом O_APPEND, то перед записью файловое смещение устанавливается в конец файла. Согласование файлового смещения и операции записи выполняются атомарно.

В POSIX требуется, чтобы read(2), который может быть вызван сразу после write(), возвращал новые данные. Заметим, что не все файловые системы соответствуют стандарту POSIX.

В соответствие с POSIX.1, если count больше SSIZE_MAX, то результат зависит от реализации; смотрите ЗАМЕЧАНИЯ по верхнему пределу в Linux.

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ
On success, the number of bytes written is returned. On error, -1 is returned, and errno is set to indicate the error.

Заметим, что при успешном выполнении write() может передать меньше чем count байт. Такая частичная запись может возникать по нескольким причинам; например, из-за недостаточного количества места на диске, на который пишутся все запрошенные байты или из-за прерывания блокировки write() сокета, канала или подобного обработчиком сигнала после частичной передачи, но до того, как были переданы все запрашиваемый байты. При даже частичной записи вызывающий может запустить другой вызов write() для передачи оставшихся байт. Последующий вызов или передаст остальные байты, или может завершиться ошибкой (например, если переполнен диск).

Если count равен нулю и fd указывает на обычный файл, то write() может вернуть ошибку, если обнаружена одна из перечисленных ниже ошибок. Если ошибок не обнаружено или проверка ошибки не производилась, то возвращается 0 без каких-либо других последствий. Если count равен нулю и fd указывает на отличный от обычного файл, то результат не определён.

ОШИБКИ

EAGAIN
    Файловый дескриптор fd указывает на файл, не являющийся сокетом и помеченный как неблокирующий ввод/вывод (O_NONBLOCK), а запись вызовет блокировку. См. open(2) для дальнейшей информации по флагу O_NONBLOCK.

EAGAIN или EWOULDBLOCK
    Файловый дескриптор fd указывает на сокет, который помечен как неблокирующий ввод/вывод (O_NONBLOCK), а запись вызовет блокировку. По POSIX.1-2001 разрешено возвращать ошибку в обоих случая и не требуется, чтобы эти константы имели одно значение, поэтому переносимые приложения должны проверять обе причины.

EBADF
    Значение fd не является правильным файловым дескриптором или он не открыт для записи.

EDESTADDRREQ
    Значение fd ссылается на сокет дейтаграмм, у которого с помощью connect(2) не назначен адрес другой стороны.

EDQUOT
    Исчерпана пользовательская квота на дисковые блоки файловой системы с файлом, на который указывает fd.

EFAULT
    buf находится за пределами доступного вам адресного пространства.

EFBIG
    Попытка записать в файл, который превышает заданное при реализации ограничение на размер файла или ограничение на размер файла для текущего процесса, или запись в позицию после максимально разрешённого смещения.

EINTR
    Этот вызов был прерван сигналом, перед тем как были записаны какие-либо данные; см signal(7).

EINVAL
    fd присоединён к объекту, который не подходит для записи; или файл был открыт с указанием флага O_DIRECT, или неправильно выравнено адрес в buf, значение count или файловое смещение.

EIO Во время изменения иноды возникла низкоуровневая ошибка ввода/вывода. Эта ошибка может относится к отложенным (write-back) данным предыдущего вызова write(), который выполнялся с другим файловым дескриптором для этого же файла. Начиная с Linux 4.13 ошибки отложенных данных поступают с обещанием, что о них может быть сообщено следующему вызову. Результаты запросов write() будут переданы последующему fsync(2) (независимо от того, сообщалось ли об этом write()). Также EIO может возникать у сетевых файловых систем, когда консультативная блокировка была убрана у дескриптора файла и потеряна. Подробности смотрите в абзаце Потерянные блокировки в fcntl(2).

ENOSPC
    На устройстве, содержащем файл, на который ссылается fd, нет свободного места.

EPERM
    Выполнение операции предотвращено опечатыванием (file seal); смотрите fcntl(2).

EPIPE
    fd ссылается на конвейер или сокет, у которого закрыто чтение. Когда такое случается, пишущий процесс также получит сигнал SIGPIPE. (Таким образом, возвращаемое значение можно будет увидеть только если программа перехватывает, блокирует или игнорирует этот сигнал.)

В зависимости от объекта, на который указывает fd, могут происходить и другие ошибки.

СТАНДАРТЫ
POSIX.1-2008.

ИСТОРИЯ
SVr4, 4.3BSD, POSIX.1-2001.

Согласно SVr4, запись может быть прервана в любом месте (с возвратом EINTR), а не только перед тем как будут записаны какие-либо данные.

ЗАМЕЧАНИЯ
Успешный возврат из вызова write() не даёт никаких гарантий, что данные сохранены на диске. В некоторых файловых системах, включая NFS, даже не гарантируется, что для данных было зарезервировано место. В этом случае некоторые ошибки могут появиться только в будущем write(), fsync(2) или даже close(2). Единственный способ получить гарантированную запись — вызвать fsync(2) после записи всех данных.

Если write() прерван обработчиком сигналов до начала записи, то вызов возвращает ошибку EINTR; если он прерван после начала записи, то вызов считается успешным, и возвращается число записанных байт.

В Linux write() (и похожие системные вызовы) передаст не больше 0x7ffff000 (2 147 479 552) байт, возвращая число байт, переданных на самом деле (это утверждение справедливо как к 32-битным, так и к 64-битным системам).

Возвращаемое значение ошибки при выполнении write() прямого ввода-вывода не означает ошибки записи целиком. Данные могут быть записаны частично, а по смещению в файле, на котором write() остановился, данные должны считаться некорректными.

ДЕФЕКТЫ
В соответствие с POSIX.1-2008/SUSv4 раздел XSI 2.9.7 ("Thread Interactions with Regular File Operations"):

    Следующие функции должны выполняться атомарно по отношению друг к другу, чтобы работать с обычными файлами или символическими ссылками так, как указано в POSIX.1-2008: …

Among the APIs subsequently listed are write() and writev(2). And among the effects that should be atomic across threads (and processes) are updates of the file offset. However, before Linux 3.14, this was not the case: if two processes that share an open file description (see open(2)) perform a write() (or writev(2)) at the same time, then the I/O operations were not atomic with respect to updating the file offset, with the result that the blocks of data output by the two processes might (incorrectly) overlap. This problem was fixed in Linux 3.14.

СМ. ТАКЖЕ
close(2), fcntl(2), fsync(2), ioctl(2), lseek(2), open(2), pwrite(2), read(2), select(2), writev(2), fwrite(3)

ПЕРЕВОД
Русский перевод этой страницы руководства был сделан Azamat Hackimov <azamat.hackimov@gmail.com> и Yuri Kozlov <yuray@komyakino.ru>

Этот перевод является бесплатной документацией; прочитайте Стандартную общественную лицензию GNU версии 3 (https://www.gnu.org/licenses/gpl-3.0.html) или более позднюю, чтобы узнать об условиях авторского права. Мы не несем НИКАКОЙ ОТВЕТСТВЕННОСТИ.

Если вы обнаружите ошибки в переводе этой страницы руководства, пожалуйста, отправьте электронное письмо на man-pages-ru-talks@lists.sourceforge.net.