ИМЯ¶

sendfile - производит обмен данными между дескрипторами файлов

БИБЛИОТЕКА¶

Стандартная библиотека языка C (libc, -lc)

СИНТАКСИС¶

#include <sys/sendfile.h>

ssize_t sendfile(int out_fd, int in_fd, off_t *_Nullable offset,
                 size_t count);

ОПИСАНИЕ¶

Вызов sendfile() копирует данные из одного файлового дескриптора в другой. Так как копирование производится в ядре, использование sendfile() более эффективно чем комбинация read(2) и write(2), в которой требуется скопировать данные в и из пользовательского пространства.

В in_fd должен указываться файловый дескриптор, открытый для чтения, а в out_fd должен указываться файловый дескриптор, открытый для записи.

Если значение offset не равно NULL, то оно указывает на переменную, содержащую файловое смещение с которого sendfile() начнёт чтение данных из in_fd. При завершении sendfile() значение этой переменной будет содержать смещение следующего байта после последнего прочитанного. Если значение offset не равно NULL, то sendfile() не изменяет файловое смещение in_fd; иначе файловое смещение изменяется для отражения количества прочитанных из in_fd байт.

Если значение offset равно NULL, то данные будут прочитаны из in_fd начиная с файлового смещения, и по окончании работы вызова файловое смещение будет обновлено.

В count содержится количество байт, копируемых между файловыми дескрипторами.

The in_fd argument must correspond to a file which supports mmap(2)-like operations (i.e., it cannot be a socket). Except since Linux 5.12 and if out_fd is a pipe, in which case sendfile() desugars to a splice(2) and its restrictions apply.

Before Linux 2.6.33, out_fd must refer to a socket. Since Linux 2.6.33 it can be any file. If it's seekable, then sendfile() changes the file offset appropriately.

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ¶

Если пересылка прошла успешно, то возвращается количество записанных в out_fd байт. Заметим, что при успешном выполнении вызов sendfile() может записать меньше байт, чем запрашивалось; вызывающий должен быть готов повторить вызов, если останутся не отправленные байты. Также смотрите ЗАМЕЧАНИЯ.

В случае ошибки возвращается -1, а errno устанавливается в значение ошибки.

ОШИБКИ¶

EAGAIN

Был выбран неблокирующий ввод-вывод с помощью O_NONBLOCK, но запись привела бы блокировке.

EBADF

Входной файл не открыт для чтения или выходной файл не открыт для записи.

EFAULT

Неправильный адрес.

EINVAL

Неправильный или заблокированный дескриптор, или для in_fd недоступна операция типа mmap(2) или значение count отрицательно.

EINVAL

У out_fd установлен флаг O_APPEND. Пока это не поддерживается в sendfile().

EIO

Неизвестная ошибка при чтении in_fd.

ENOMEM

Не хватает памяти для чтения in_fd.

EOVERFLOW

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

ESPIPE

offset is not NULL but the input file is not seekable.

ВЕРСИИ¶

В других системах UNIX вызов sendfile() реализован с другими семантиками и прототипами. Не должен использоваться в переносимых программах.

СТАНДАРТЫ¶

None.

ИСТОРИЯ¶

Linux 2.2, glibc 2.1.

В Linux 2.4 и более ранних, значение out_fd может также указывать на обычный файл; эта возможность была удалена в ядрах Linux 2.6.x, но возвращена в 2.6.33.

Первоначальная версия Linux sendfile() не была приспособлена для работы с большими файловыми смещениями. В последствии в Linux 2.4 был добавлен вызов sendfile64() с более широким диапазоном значений аргумента offset. В glibc sendfile() представляет собой обёрточную функцию, которая делает незаметным разницу между версиями ядер.

ПРИМЕЧАНИЯ¶

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

Если вы планируете использовать sendfile() для отправки файлов через сокет TCP и вам нужно послать некоторые заголовочные данные перед содержимым файла, то обратите внимание на параметр TCP_CORK, описанный в tcp(7), он поможет минимизировать количество пакетов и оптимизировать производительность.

Applications may wish to fall back to read(2) and write(2) in the case where sendfile() fails with EINVAL or ENOSYS.

Если out_fd ссылается на сокет или канал с поддержкой нулевого копирования, то вызывающие должны гарантировать, что переданные части файла, указываемого in_fd, останутся неизменёнными до тех пор, пока читающий на другом конце out_fd не закончит обрабатывать переданные данные.

Специальный вызов Linux splice(2) поддерживает пересылку данных между произвольными файловыми дескрипторами, представляющими сокеты (один или оба).

СМОТРИТЕ ТАКЖЕ¶

copy_file_range(2), mmap(2), open(2), socket(2), splice(2)

ПЕРЕВОД¶

Русский перевод этой страницы руководства разработал(и) Alexander Golubev <fatzer2@gmail.com>, Azamat Hackimov <azamat.hackimov@gmail.com>, Hotellook, Nikita <zxcvbnm3230@mail.ru>, Spiros Georgaras <sng@hellug.gr>, Vladislav <ivladislavefimov@gmail.com>, Yuri Kozlov <yuray@komyakino.ru> и Иван Павлов <pavia00@gmail.com>

Этот перевод является свободной программной документацией; он распространяется на условиях общедоступной лицензии GNU (GNU General Public License - GPL, https://www.gnu.org/licenses/gpl-3.0.html версии 3 или более поздней) в отношении авторского права, но БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ.

Если вы обнаружите какие-либо ошибки в переводе этой страницы руководства, пожалуйста, сообщите об этом разработчику(ам) по его(их) адресу(ам) электронной почты или по адресу списка рассылки русских переводчиков.