Модуль Unix

Тип кодов ошибок. Ошибки, определённые стандартом POSIX, а также дополнительные ошибки из UNIX98 и BSD. Все остальные ошибки сопоставляются с EUNKNOWNERR.

Возникает при вызове системных вызовов ниже, если обнаружена ошибка. Первый компонент — код ошибки; второй компонент — имя функции; третий компонент — строковый параметр функции, если он есть, или пустая строка в противном случае.

UnixLabels.Unix_error и Unix.Unix_error — одно и то же исключение, и перехват одного из них приведёт к перехвату другого.

Возвращает строку с описанием заданного кода ошибки.

handle_unix_error f x применяет f к x и возвращает результат. Если возникает исключение Unix.Unix_error, выводится сообщение с описанием ошибки, а программа завершается с кодом 2.

Возвращает окружение процесса в виде массива строк формата «variable=value». Возвращённый массив пуст, если процесс обладает специальными привилегиями.

Возвращает окружение процесса в виде массива строк формата «variable=value». В отличие от Unix.environment, эта функция возвращает непустой массив, даже если процесс обладает специальными привилегиями. Подробнее см. документацию для Unix.unsafe_getenv.

Возвращает значение переменной окружения процесса, если процесс не обладает специальными привилегиями.

Возвращает значение переменной окружения процесса.

В отличие от Unix.getenv, эта функция возвращает значение, даже если процесс обладает специальными привилегиями. Она считается небезопасной, поскольку разработчик программы с setuid или setgid должен позаботиться о том, чтобы вредоносно сформированные переменные окружения не использовались в путях поиска исполняемых файлов, расположениях временных файлов или журналов и тому подобном.

putenv name value задаёт значение переменной окружения процесса. name — имя переменной окружения, а value — новое значение, связанное с ней.

unsetenv name удаляет переменную name из окружения процесса.

Статус завершения процесса. Определения стандартных номеров сигналов см. в Sys.signal.

В Windows: используется только WEXITED (так как межпроцессные сигналы отсутствуют), но с особыми кодами возврата, указывающими на специальные причины завершения. Чтобы расшифровать такие коды возврата ошибок, ищите в документации Windows значения NTSTATUS. В частности, код ошибки STATUS_ACCESS_VIOLATION — это 32-разрядный 0xC0000005: поскольку Int32.of_int 0xC0000005 — это -1073741819, WEXITED -1073741819 является эквивалентом WSIGNALED Sys.sigsegv в Windows.

Флаги для Unix.waitpid.

execv prog args выполняют программу из файла prog с аргументами args и текущим окружением процесса. Обратите внимание: первый аргумент, args.(0), по соглашению является именем файла выполняемой программы, как и Sys.argv.(0). Эти функции execv* никогда не возвращают управление: при успешном выполнении текущая программа заменяется новой.

В Windows: CRT просто создаёт новый процесс и завершает текущий. Это может привести к нежелательным последствиям, например если другой процесс ожидает завершения текущего. Вместо этого рекомендуется использовать Unix.create_process или одну из функций open_process_*.

То же, что и Unix.execv, за исключением того, что третий аргумент задаёт окружение выполняемой программы.

То же, что и Unix.execv, за исключением того, что программа ищется в пути поиска.

То же, что и Unix.execve, за исключением того, что программа ищется в пути поиска.

Создаёт новый процесс. Возвращаемое целое число равно 0 для дочернего процесса и pid дочернего процесса для родительского процесса. Операция завершается ошибкой, если процесс OCaml является многопроцессорным (был создан хотя бы один домен). Кроме того, если был создан хотя бы один поток из модуля Thread, дочерний процесс может оказаться в повреждённом состоянии.

Ожидает завершения одного из дочерних процессов и возвращает его pid и статус завершения.

То же, что и Unix.wait, но ожидает завершения дочернего процесса с заданным pid. Значение pid -1 означает ожидание любого дочернего процесса. Значение pid 0 означает ожидание любого дочернего процесса в той же группе процессов, что и текущий процесс. Отрицательные значения pid обозначают группы процессов. Список параметров указывает, должен ли waitpid немедленно возвращать управление, не дожидаясь завершения, и нужно ли сообщать об остановленных дочерних процессах.

В Windows: ожидание возможно только для заданного PID, но не для любого дочернего процесса.

Выполняет заданную команду, ожидает её завершения и возвращает статус завершения. Строка интерпретируется оболочкой /bin/sh (или командным интерпретатором cmd.exe в Windows), поэтому может содержать перенаправления, кавычки, переменные и т. д. Для корректного экранирования пробелов и специальных символов оболочки в именах файлов или аргументах команды рекомендуется использовать Filename.quote_command. Результат WEXITED 127 означает, что не удалось запустить оболочку.

Немедленно завершает вызывающий процесс, передавая операционной системе заданный код состояния: обычно 0 означает отсутствие ошибок, а небольшое положительное целое число — сбой. В отличие от exit, Unix._exit не выполняет никаких завершающих действий: функции, зарегистрированные с помощью at_exit, не вызываются, каналы ввода-вывода не сбрасываются, а среда выполнения C также не завершается.

Обычно Unix._exit используется после операции Unix.fork, когда в дочернем процессе происходит фатальная ошибка и он должен завершиться. В этом случае предпочтительно не выполнять в дочернем процессе никаких завершающих действий, поскольку они могут помешать аналогичным действиям родительского процесса. Например, дочерний процесс не должен сбрасывать каналы вывода: родительский процесс может сбросить их повторно, что приведёт к дублированию вывода.

Возвращает pid процесса.

Возвращает pid родительского процесса.

Изменяет приоритет процесса. Целочисленный аргумент прибавляется к значению «nice». (Чем выше значение «nice», тем ниже приоритет.) Возвращает новое значение «nice».

Абстрактный тип файловых дескрипторов.

Файловый дескриптор стандартного ввода.

Файловый дескриптор стандартного вывода.

Файловый дескриптор стандартного потока ошибок.

Флаги для Unix.openfile.

Тип прав доступа к файлу; например, 0o640 означает чтение и запись для владельца, чтение для группы и отсутствие прав для остальных

Открывает файл с указанным именем и заданными флагами. Третий аргумент задаёт права доступа к файлу, если он создаётся (см. Unix.umask). Возвращает файловый дескриптор указанного файла.

Закрывает файловый дескриптор.

Сбрасывает буферы файла на диск.

read fd buf pos len считывает len байт из дескриптора fd и помещает их в последовательность байтов buf, начиная с позиции pos в buf. Возвращает фактическое число прочитанных байтов.

То же, что и Unix.read, но данные считываются в bigarray.

write fd buf pos len записывает len байт в дескриптор fd, беря их из последовательности байтов buf, начиная с позиции pos в buff. Возвращает фактическое число записанных байтов. write повторяет операцию записи, пока не будут записаны все байты или не произойдёт ошибка.

То же, что и Unix.write, но данные берутся из bigarray.

То же, что и Unix.write, но предпринимается только одна попытка записи. Поэтому, если возникает ошибка, single_write гарантирует, что данные не были записаны.

То же, что и Unix.write, но данные берутся из строки, а не из последовательности байтов.

То же, что и Unix.single_write, но данные берутся из строки, а не из последовательности байтов.

То же, что и Unix.single_write, но данные берутся из bigarray.

Создаёт канал ввода, читающий из заданного дескриптора. Изначально канал работает в двоичном режиме; для текстового режима используйте set_binary_mode_in ic false. Текстовый режим поддерживается, только если дескриптор относится к файлу или каналу, но не к сокету.

В Windows: set_binary_mode_in всегда завершается ошибкой для каналов, созданных этой функцией.

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

Закрытие канала ic, возвращённого функцией in_channel_of_descr fd с помощью close_in ic, также закрывает базовый дескриптор fd. Нельзя закрывать и канал ic, и дескриптор fd.

Если на одном дескрипторе создано несколько каналов, следует закрыть один из них, но не остальные. Например, пусть дескриптор s подключён к сокету, а каналы ic = in_channel_of_descr s и oc = out_channel_of_descr s работают с ним. Рекомендуемый порядок закрытия — выполнить close_out oc: эта операция сбрасывает буферизованный вывод в сокет, а затем закрывает сокет. Канал ic закрывать не следует; со временем он будет собран сборщиком мусора.

Создаёт канал вывода, записывающий в заданный дескриптор. Изначально канал работает в двоичном режиме; для текстового режима используйте set_binary_mode_out oc false. Текстовый режим поддерживается, только если дескриптор относится к файлу или каналу, но не к сокету.

В Windows: set_binary_mode_out всегда завершается ошибкой для каналов, созданных этой функцией.

Учтите, что каналы вывода буферизуются, поэтому может понадобиться вызвать flush, чтобы гарантировать отправку всех данных в дескриптор. Каналы также хранят копию текущей позиции в файле.

Закрытие канала oc, возвращённого функцией out_channel_of_descr fd с помощью close_out oc, также закрывает базовый дескриптор fd. Нельзя закрывать и канал ic, и дескриптор fd.

Описание порядка закрытия при создании нескольких каналов на одном дескрипторе см. в Unix.in_channel_of_descr.

Возвращает дескриптор, соответствующий каналу ввода.

Возвращает дескриптор, соответствующий каналу вывода.

Режимы позиционирования для Unix.lseek.

Устанавливает текущую позицию файлового дескриптора и возвращает полученное смещение (от начала файла).

Усекает указанный файл до заданного размера.

Усекает файл, соответствующий заданному дескриптору, до заданного размера.

Информация, возвращаемая вызовами Unix.stat.

Возвращает информацию об указанном файле.

То же, что и Unix.stat, но если файл является символической ссылкой, возвращает информацию о самой ссылке.

Возвращает информацию о файле, связанном с указанным дескриптором.

Возвращает true, если указанный файловый дескриптор ссылается на терминал или окно консоли, и false в противном случае.

Отображение файла в память в виде Bigarray. map_file fd kind layout shared dims возвращает Bigarray типа kind, с расположением layout и размерами, заданными в dims. Данные, содержащиеся в этом Bigarray, представляют собой содержимое файла, на который ссылается файловый дескриптор fd (например, ранее открытого с помощью Unix.openfile). Необязательный параметр pos задаёт смещение в байтах в файле для отображаемых данных; по умолчанию оно равно 0 (отображение начинается с начала файла).

Если shared имеет значение true, все изменения массива отражаются в файле. Для этого файл fd должен быть открыт с правами на запись. Если shared имеет значение false, изменения массива выполняются только в памяти с использованием копирования при записи изменённых страниц; исходный файл не затрагивается.

Unix.map_file значительно эффективнее, чем чтение всего файла в Bigarray, изменение этого Bigarray и последующая запись.

Чтобы автоматически подогнать размеры Bigarray под фактический размер файла, основное измерение (то есть первое измерение для массива с расположением C и последнее — для массива с расположением Fortran) можно задать как -1. В этом случае Unix.map_file определяет основное измерение по размеру файла. Файл должен содержать целое число подмассивов, определяемых неосновными измерениями; в противном случае возникает исключение Failure.

Если заданы все измерения Bigarray, размер файла сопоставляется с размером Bigarray. Если файл больше Bigarray, в Bigarray отображается только начальная часть файла. Если файл меньше Bigarray, размер файла автоматически увеличивается до размера Bigarray. Для этого необходимы права на запись для fd.

Доступ к элементам массива проверяется на выход за границы, однако границы определяются при первоначальном вызове map_file. Поэтому убедитесь, что никакой другой процесс не изменяет отображённый файл во время обращения к нему, иначе может быть отправлен сигнал SIGBUS. Например, это происходит при уменьшении размера файла.

В случае ошибки проверки аргументов может возникнуть исключение Invalid_argument или Failure.

Удаляет указанный файл.

Если указанный файл является каталогом, возникает исключение:

• EPERM в POSIX-совместимых системах
• EISDIR в Linux версии 2.1.132 или выше
• EACCESS в Windows

rename src dst изменяет имя файла с src на dst, при необходимости перемещая его между каталогами. Если dst уже существует, его содержимое будет заменено содержимым src. В зависимости от операционной системы метаданные dst (права доступа, владелец и т. д.) могут быть как сохранены, так и заменены метаданными src.

link ?follow src dst создаёт жёсткую ссылку с именем dst на файл с именем src.

realpath p — это абсолютный путь к p, полученный путём разрешения всех дополнительных символов /, относительных сегментов пути и символических ссылок.

Флаги для вызова Unix.access.

Изменяет права доступа к указанному файлу.

Изменяет права доступа к открытому файлу.

Изменяет идентификаторы uid владельца и gid группы указанного файла.

Изменяет идентификаторы uid владельца и gid группы открытого файла.

Устанавливает маску создания файлов для процесса и возвращает предыдущее значение маски.

Проверяет, имеет ли процесс указанные права доступа к заданному файлу.

В Windows право на выполнение X_OK проверить нельзя; вместо этого проверяется право на чтение.

Возвращает новый файловый дескриптор, ссылающийся на тот же файл, что и указанный дескриптор. Описание необязательного аргумента cloexec см. в разделе Unix.set_close_on_exec.

dup2 src dst дублирует src в dst, закрывая dst, если он уже открыт. Описание необязательного аргумента cloexec см. в разделе Unix.set_close_on_exec.

Устанавливает для указанного дескриптора флаг «неблокирующего» режима. Если этот флаг установлен, чтение из дескриптора, для которого временно нет доступных данных, вызывает ошибку EAGAIN или EWOULDBLOCK вместо блокировки; запись в дескриптор, в котором временно нет места для записи, также вызывает ошибку EAGAIN или EWOULDBLOCK.

Сбрасывает флаг «неблокирующего» режима для указанного дескриптора. См. Unix.set_nonblock.

Устанавливает для указанного дескриптора флаг ``close-on-exec''. Дескриптор с этим флагом автоматически закрывается, когда текущий процесс запускает другую программу с помощью одной из функций exec, create_process и open_process.

Передача внешней программе файловых дескрипторов, открытых, например, для закрытого файла, часто создаёт уязвимость безопасности: программа получает доступ к закрытому файлу и может использовать его во вред. Поэтому настоятельно рекомендуется устанавливать флаг ``close-on-exec'' для всех файловых дескрипторов, за исключением редких случаев, когда дескриптор действительно необходимо передать другой программе.

Лучший способ установить для файлового дескриптора флаг ``close-on-exec'' — создать его сразу в этом состоянии. Для этого функция openfile имеет флаги O_CLOEXEC и O_KEEPEXEC, позволяющие принудительно включить режим ``close-on-exec'' или ``keep-on-exec'' соответственно. Все остальные операции модуля Unix, создающие файловые дескрипторы, принимают необязательный аргумент ?cloexec:bool, указывающий, следует ли создать дескриптор в режиме ``close-on-exec'' (если указано ~cloexec:true) или в режиме ``keep-on-exec'' (если указано ~cloexec:false). По историческим причинам, если необязательный аргумент cloexec не указан, дескрипторы по умолчанию создаются в режиме ``keep-on-exec''. Это небезопасное значение по умолчанию, поэтому настоятельно рекомендуется явно передавать аргументы cloexec операциям, создающим файловые дескрипторы.

Необязательные аргументы cloexec и флаг O_KEEPEXEC появились в OCaml 4.05. Ранее обычно создавали файловые дескрипторы в режиме ``keep-on-exec'' по умолчанию, а затем вызывали set_close_on_exec для только что созданных дескрипторов. Это менее безопасно, чем создание дескриптора в режиме ``close-on-exec'', поскольку в многопоточных программах между созданием файлового дескриптора и завершением set_close_on_exec существует уязвимый промежуток времени. Если в этот промежуток другой поток запускает другую программу, дескриптор будет передан ей, поскольку он всё ещё находится в режиме ``keep-on-exec''.

Что касается гарантий атомарности, предоставляемых ~cloexec:true или использованием флага O_CLOEXEC: на всех платформах гарантируется, что одновременно выполняющийся поток Caml не сможет передать дескриптор другой программе, запустив её. В Linux эта гарантия распространяется и на одновременно выполняющиеся потоки C. По состоянию на февраль 2017 года в других операционных системах отсутствуют необходимые системные вызовы, поэтому сохраняется уязвимый промежуток времени, в течение которого поток C может увидеть только что созданный файловый дескриптор в режиме ``keep-on-exec''.

Сбрасывает флаг ``close-on-exec'' для указанного дескриптора. См. Unix.set_close_on_exec.

Создаёт каталог с указанными правами доступа (см. Unix.umask).

Удаляет пустой каталог.

Изменяет рабочий каталог процесса.

Возвращает имя текущего рабочего каталога.

Изменяет корневой каталог процесса.

Тип дескрипторов открытых каталогов.

Открывает дескриптор каталога

Возвращает следующую запись в каталоге.

Перемещает дескриптор в начало каталога

Закрывает дескриптор каталога.

Создаёт канал. Первый компонент результата открыт для чтения — это выход канала. Второй компонент открыт для записи — это вход канала. Описание необязательного аргумента cloexec см. в разделе Unix.set_close_on_exec.

Создаёт именованный канал с указанными правами доступа (см. Unix.umask).

create_process prog args stdin stdout stderr создаёт новый процесс, выполняющий программу из файла prog с аргументами args. Обратите внимание: по соглашению первый аргумент, args.(0), — это имя файла выполняемой программы, как и Sys.argv.(0). Идентификатор процесса (pid) нового процесса возвращается сразу; новый процесс выполняется параллельно с текущим. Стандартные ввод и вывод нового процесса подключаются к дескрипторам stdin, stdout и stderr. Например, передача Unix.stdout для stdout отменяет перенаправление и заставляет новый процесс использовать тот же стандартный вывод, что и текущий процесс. Исполняемый файл prog ищется в путях поиска. Новый процесс получает ту же среду, что и текущий процесс.

create_process_env prog args env stdin stdout stderr работает так же, как Unix.create_process, за исключением того, что дополнительный аргумент env задаёт среду, передаваемую программе.

Высокоуровневое управление каналами и процессами. Эта функция запускает указанную команду параллельно с программой. Стандартный вывод команды перенаправляется в канал, который можно читать через возвращаемый входной канал. Команда интерпретируется оболочкой /bin/sh (или cmd.exe в Windows); см. Unix.system. Функцию Filename.quote_command можно использовать для экранирования команды и её аргументов в соответствии с используемой оболочкой. Если команду не требуется запускать через оболочку, в качестве более надёжной и эффективной альтернативы Unix.open_process_in можно использовать Unix.open_process_args_in.

То же, что и Unix.open_process_in, но стандартный ввод команды перенаправляется в канал. Данные, записанные в возвращаемый выходной канал, передаются на стандартный ввод команды. Внимание: запись в выходные каналы буферизуется, поэтому своевременно вызывайте flush, чтобы обеспечить правильную синхронизацию. Если команду не требуется запускать через оболочку, вместо Unix.open_process_out можно использовать Unix.open_process_args_out.

То же, что и Unix.open_process_out, но стандартные ввод и вывод команды перенаправляются в каналы, подключённые к двум возвращаемым каналам. Входной канал подключён к выводу команды, а выходной — к её вводу. Если команду не требуется запускать через оболочку, вместо Unix.open_process можно использовать Unix.open_process_args.

Аналогично Unix.open_process, но второй аргумент задаёт среду, передаваемую команде. Результатом является кортеж из трёх каналов, подключённых соответственно к стандартному выводу, стандартному вводу и стандартному потоку ошибок команды. Если команду не требуется запускать через оболочку, вместо Unix.open_process_full можно использовать Unix.open_process_args_full.

open_process_args prog args запускает программу prog с аргументами args. Обратите внимание: по соглашению первый аргумент, args.(0), — это имя файла выполняемой программы, как и Sys.argv.(0). Новый процесс выполняется параллельно с текущим. Стандартные ввод и вывод нового процесса перенаправляются в каналы, из которых можно читать и в которые можно записывать через возвращаемые каналы. Входной канал подключён к выводу программы, а выходной — к её вводу.

Внимание: запись в выходные каналы буферизуется, поэтому своевременно вызывайте flush, чтобы обеспечить правильную синхронизацию.

Исполняемый файл prog ищется в путях поиска. Это поведение изменилось в версии 4.12; ранее prog искался только в текущем каталоге.

Новый процесс получает ту же среду, что и текущий процесс.

То же, что и Unix.open_process_args, но перенаправляется только стандартный вывод нового процесса.

То же, что и Unix.open_process_args, но перенаправляется только стандартный ввод нового процесса.

Аналогично Unix.open_process_args, но третий аргумент задаёт среду, передаваемую новому процессу. Результатом является кортеж из трёх каналов, подключённых соответственно к стандартному выводу, стандартному вводу и стандартному потоку ошибок программы.

Возвращает PID процесса, открытого с помощью Unix.open_process_args_in, или PID оболочки, открытой с помощью Unix.open_process_in.

Возвращает PID процесса, открытого с помощью Unix.open_process_args_out, или PID оболочки, открытой с помощью Unix.open_process_out.

Возвращает PID процесса, открытого с помощью Unix.open_process_args, или PID оболочки, открытой с помощью Unix.open_process_args.

Возвращает PID процесса, открытого с помощью Unix.open_process_args_full, или PID оболочки, открытой с помощью Unix.open_process_full.

Закрывает каналы, открытые с помощью Unix.open_process_in, ожидает завершения связанной команды и возвращает её статус завершения.

Закрывает каналы, открытые с помощью Unix.open_process_out, ожидает завершения связанной команды и возвращает её статус завершения.

Закрывает каналы, открытые с помощью Unix.open_process, ожидает завершения связанной команды и возвращает её статус завершения.

Закрывает каналы, открытые с помощью Unix.open_process_full, ожидает завершения связанной команды и возвращает её статус завершения.

symlink ?to_dir src dst создаёт файл dst в виде символической ссылки на файл src. В Windows параметр ~to_dir указывает, ведёт ли символическая ссылка на каталог или файл; если он не задан, symlink проверяет src с помощью stat и выбирает подходящий вариант. Если src не существует, предполагается false (поэтому в новом коде рекомендуется указывать параметр ~to_dir). В Unix параметр ~to_dir игнорируется.

Символические ссылки Windows доступны начиная с Windows Vista. Между символическими ссылками Windows и их аналогами в POSIX есть несколько важных различий.

В Windows существуют два вида символических ссылок: на каталог и обычные, указывающие, ведёт ли символическая ссылка на каталог или файл. Тип должен быть указан верно: символьную ссылку на каталог, фактически ведущую на файл, нельзя выбрать с помощью chdir, а символьную ссылку на файл, фактически ведущую на каталог, нельзя прочитать или изменить (обратите внимание, что уровень эмуляции Cygwin игнорирует это различие).

При создании символических ссылок на существующие целевые объекты это различие не имеет значения, и symlink автоматически создаёт ссылку нужного типа. Различие важно при создании символической ссылки на несуществующий целевой объект.

Ещё один нюанс: по умолчанию создание символических ссылок требует привилегий. Администраторы должны запускать процесс с повышенными правами (или с отключённым UAC). Обычным учётным записям по умолчанию необходимо предоставить привилегию SeCreateSymbolicLinkPrivilege с помощью локальной политики безопасности (secpol.msc) или Active Directory.

Функцию Unix.has_symlink можно использовать, чтобы проверить, может ли процесс создавать символические ссылки.

Возвращает true, если пользователь может создавать символические ссылки. В Windows это означает, что пользователь не только имеет привилегию SeCreateSymbolicLinkPrivilege, но и, если необходимо, запускает процесс с повышенными правами. На других платформах это просто указывает на доступность системного вызова создания символической ссылки.

Читает содержимое символической ссылки.

Ожидает, пока на некоторых каналах не станут возможны операции ввода-вывода. Три аргумента-списка задают дескрипторы, готовность которых проверяется соответственно для чтения (первый аргумент), записи (второй аргумент) и исключительных ситуаций (третий аргумент). Четвёртый аргумент задаёт максимальное время ожидания в секундах; отрицательное значение означает отсутствие тайм-аута (неограниченное ожидание). Результат состоит из трёх наборов дескрипторов: готовых для чтения (первый элемент), готовых для записи (второй элемент) и тех, для которых ожидается исключительная ситуация (третий элемент).

В Windows, если один из списков дескрипторов содержит больше FD_SETSIZE элементов (по умолчанию 64) или используется хотя бы один файловый дескриптор, не являющийся сокетом, максимальное время ожидания ограничивается 2³² миллисекундами.

Команды для Unix.lockf.

lockf fd mode len блокирует область файла, открытого как fd. Область начинается с текущей позиции чтения/записи для fd (установленной с помощью Unix.lseek) и продолжается на len байт вперёд, если len положительно, на len байт назад, если len отрицательно, или до конца файла, если len равно нулю. Блокировка записи не позволяет другим процессам устанавливать блокировки чтения или записи на эту область. Блокировка чтения не позволяет другим процессам устанавливать блокировку записи на эту область, но разрешает им устанавливать блокировки чтения.

Команды F_LOCK и F_TLOCK пытаются установить блокировку записи для указанной области. Команды F_RLOCK и F_TRLOCK пытаются установить блокировку чтения для указанной области. Если одна или несколько блокировок, установленных другим процессом, не позволяют текущему процессу получить блокировку, F_LOCK и F_RLOCK ожидают снятия этих блокировок, а F_TLOCK и F_TRLOCK немедленно завершаются с исключением. Команда F_ULOCK снимает все блокировки, установленные текущим процессом для указанной области. Наконец, команда F_TEST проверяет, можно ли установить блокировку записи для указанной области, не устанавливая её. При успехе она сразу возвращает управление, иначе завершается ошибкой.

Поведение при попытке процесса заблокировать область файла, уже заблокированную этим же процессом, зависит от операционной системы. В POSIX-совместимых системах вторая операция блокировки завершается успешно и может повысить уже существующую блокировку чтения до блокировки записи. В Windows вторая операция блокировки будет ожидать или завершится ошибкой.

kill pid signal отправляет сигнал с номером signal процессу с идентификатором pid.

В Windows эмулируется только сигнал Sys.sigkill, в результате чего принимающий процесс завершается с кодом ERROR_PROCESS_ABORTED (1067). До OCaml 5.5 принимающий процесс завершался с кодом 0.

sigprocmask mode sigs изменяет набор заблокированных сигналов. Если mode равен SIG_SETMASK, набор заблокированных сигналов заменяется сигналами из списка sigs. Если mode равен SIG_BLOCK, сигналы из sigs добавляются в набор заблокированных сигналов. Если mode равен SIG_UNBLOCK, сигналы из sigs удаляются из набора заблокированных сигналов. sigprocmask возвращает набор сигналов, заблокированных ранее.

У каждого домена и каждого потока, если загружен модуль Thread, есть собственная маска сигналов. sigprocmask изменяет только маску текущего домена или потока.

Возвращает набор заблокированных сигналов, ожидающих обработки в данный момент.

sigsuspend sigs атомарно устанавливает набор заблокированных сигналов в значение sigs и ожидает получения незаблокированного сигнала, для которого не задано игнорирование. При возврате набор заблокированных сигналов восстанавливается до исходного значения.

Ожидает получения незаблокированного сигнала, для которого не задано игнорирование.

sigwait sigs ожидает, пока один из сигналов в списке sigs не станет ожидающим обработки. Затем функция удаляет этот сигнал из набора ожидающих сигналов и возвращает его номер. Обработчики сигналов, назначенные сигналам из sigs, вызваны не будут. Предполагается, что сигналы sigs заблокированы до вызова sigwait.

Время выполнения процесса (процессорное время).

Тип, представляющий календарную дату и местное время.

Возвращает текущее время в секундах с 00:00:00 GMT 1 января 1970 года.

То же, что Unix.time, но с точностью лучше одной секунды.

Преобразует время в секундах, возвращаемое функцией Unix.time, в дату и время. Используется UTC (всемирное координированное время), также известное как GMT. Для обратного преобразования задайте для переменной окружения TZ значение "UTC", используйте Unix.mktime, а затем восстановите исходное значение TZ.

Преобразует время в секундах, возвращаемое функцией Unix.time, в дату и время. Используется местный часовой пояс. Функция для обратного преобразования — Unix.mktime.

Преобразует дату и время, заданные аргументом tm, во время в секундах, возвращаемое функцией Unix.time. Поля tm_isdst, tm_wday и tm_yday записи tm игнорируются. Также возвращает нормализованную копию заданной записи tm, в которой поля tm_wday, tm_yday и tm_isdst пересчитаны по остальным полям, а остальные поля нормализованы (например, 40 октября преобразуется в 9 ноября). Аргумент tm интерпретируется в местном часовом поясе.

Планирует отправку сигнала SIGALRM через заданное число секунд.

Приостанавливает выполнение на заданное число секунд.

Приостанавливает выполнение на заданное число секунд. Как и sleep, но поддерживает дробные значения секунд.

Возвращает время выполнения процесса.

В Windows реализовано частично: время дочерних процессов не учитывается.

Устанавливает время последнего доступа (второй аргумент) и время последнего изменения (третий аргумент) файла. Время задаётся в секундах с 00:00:00 GMT 1 января 1970 года. Если оба значения равны 0.0, время последнего доступа и последнего изменения устанавливаются на текущее время.

Три вида интервальных таймеров.

Тип, описывающий состояние интервального таймера

Возвращает текущее состояние заданного интервального таймера.

setitimer t s устанавливает интервальный таймер t и возвращает его предыдущее состояние. Аргумент s интерпретируется следующим образом: s.it_value, если не равен нулю, задаёт время до следующего срабатывания таймера; s.it_interval, если не равен нулю, задаёт значение, которое будет установлено в it_value при срабатывании таймера. Если установить s.it_value в ноль, таймер отключается. Если установить s.it_interval в ноль, таймер отключится после следующего срабатывания.

Возвращает идентификатор пользователя, от имени которого выполняется процесс.

В Windows всегда возвращает 1.

Возвращает эффективный идентификатор пользователя, от имени которого выполняется процесс.

В Windows всегда возвращает 1.

Устанавливает реальный и эффективный идентификаторы пользователя для процесса.

Возвращает идентификатор группы пользователя, от имени которого выполняется процесс.

В Windows всегда возвращает 1.

Возвращает эффективный идентификатор группы, от имени которой выполняется процесс.

В Windows всегда возвращает 1.

Устанавливает реальный и эффективный идентификаторы группы для процесса.

Возвращает список групп, в которые входит пользователь, от имени которого выполняется процесс.

В Windows всегда возвращает [|1|].

setgroups groups устанавливает дополнительные идентификаторы групп для вызывающего процесса. Для этого требуются соответствующие привилегии.

initgroups user group инициализирует список доступа к группам, считывая базу данных групп /etc/group и используя все группы, в которые входит user. В список также добавляется дополнительная группа group.

Структура записей в базе данных passwd.

Структура записей в базе данных groups.

Возвращает имя пользователя, запустившего процесс.

Находит запись в passwd с указанным именем.

Находит запись в group с указанным именем.

Находит запись в passwd с указанным идентификатором пользователя.

Находит запись в group с указанным идентификатором группы.

Абстрактный тип интернет-адресов.

Преобразует печатное представление интернет-адреса во внутреннее представление. Аргумент-строка состоит из 4 чисел, разделённых точками (XXX.YYY.ZZZ.TTT), для адресов IPv4 и не более чем из 8 чисел, разделённых двоеточиями, для адресов IPv6.

Возвращает печатное представление указанного интернет-адреса. Описание печатного представления см. в Unix.inet_addr_of_string.

Специальный адрес IPv4, предназначенный только для использования с bind и обозначающий все интернет-адреса, которыми обладает хост-компьютер.

Специальный адрес IPv4, обозначающий хост-компьютер (127.0.0.1).

Специальный адрес IPv6, предназначенный только для использования с bind и обозначающий все интернет-адреса, которыми обладает хост-компьютер.

Специальный адрес IPv6, обозначающий хост-компьютер (::1).

Является ли указанный inet_addr адресом IPv6.

Тип доменов сокетов. Не все платформы поддерживают сокеты IPv6 (тип PF_INET6).

В Windows: PF_UNIX поддерживается начиная с версии 4.14.0 в Windows 10 1803 и более поздних версиях.

Типы сокетов, определяющие семантику обмена данными. SOCK_SEQPACKET включён для полноты, но редко поддерживается операционной системой и требует системных вызовов, недоступных в этой библиотеке.

Тип адресов сокетов. ADDR_UNIX name — это адрес сокета в домене Unix; name — имя файла в файловой системе. ADDR_INET(addr,port) — это адрес сокета в интернет-домене; addr — интернет-адрес компьютера, а port — номер порта.

Создаёт новый сокет в указанном домене и с указанным типом. Третий аргумент задаёт тип протокола; значение 0 выбирает протокол по умолчанию для сокетов этого типа. Описание необязательного аргумента cloexec см. в Unix.set_close_on_exec.

Возвращает домен сокета, соответствующий указанному адресу сокета.

Создаёт пару неименованных сокетов, соединённых друг с другом. Описание необязательного аргумента cloexec см. в Unix.set_close_on_exec.

Принимает соединения на указанном сокете. Возвращённый дескриптор — это сокет, соединённый с клиентом; возвращённый адрес — адрес подключившегося клиента. Описание необязательного аргумента cloexec см. в Unix.set_close_on_exec.

Привязывает сокет к адресу.

Подключает сокет к адресу.

Настраивает сокет для приёма запросов на соединение. Целочисленный аргумент задаёт максимальное число ожидающих запросов.

Тип команд для shutdown.

Завершает соединение сокета. Если в качестве второго аргумента указать SHUTDOWN_SEND, чтение на другом конце соединения будет возвращать состояние конца файла. Значение SHUTDOWN_RECEIVE приводит к тому, что запись на другом конце соединения будет возвращать состояние закрытого канала (сигнал SIGPIPE).

Возвращает адрес указанного сокета.

Возвращает адрес хоста, подключённого к указанному сокету.

Флаги для функций Unix.recv, Unix.recvfrom, Unix.send и Unix.sendto.

Получает данные из подключённого сокета.

Получает данные из неподключённого сокета.

Отправляет данные через подключённый сокет.

То же, что и send, но получает данные из строки, а не из последовательности байтов.

Отправляет данные через неподключённый сокет.

То же, что и sendto, но получает данные из строки, а не из последовательности байтов.

Параметры сокета, значения которых можно получить с помощью Unix.getsockopt и изменить с помощью Unix.setsockopt. Значения этих параметров имеют булев тип (true/false).

Параметры сокета, значения которых можно получить с помощью Unix.getsockopt_int и изменить с помощью Unix.setsockopt_int. Значения этих параметров имеют целочисленный тип.

Параметры сокета, значения которых можно получить с помощью Unix.getsockopt_optint и изменить с помощью Unix.setsockopt_optint. Значения этих параметров имеют тип int option; значение None означает «отключено».

Параметры сокета, значения которых можно получить с помощью Unix.getsockopt_float и изменить с помощью Unix.setsockopt_float. Значения этих параметров — числа с плавающей точкой, задающие время в секундах. Значение 0 означает бесконечный тайм-аут.

Возвращает текущее значение параметра указанного сокета, имеющего булев тип.

Устанавливает или сбрасывает параметр указанного сокета, имеющий булев тип.

То же, что и Unix.getsockopt, для параметра сокета с целочисленным значением.

То же, что и Unix.setsockopt, для параметра сокета с целочисленным значением.

То же, что и Unix.getsockopt, для параметра сокета, значение которого имеет тип int option.

То же, что и Unix.setsockopt, для параметра сокета, значение которого имеет тип int option.

То же, что и Unix.getsockopt, для параметра сокета со значением типа «число с плавающей точкой».

То же, что и Unix.setsockopt, для параметра сокета со значением типа «число с плавающей точкой».

Возвращает состояние ошибки, связанное с указанным сокетом, и сбрасывает его.

Подключается к серверу по указанному адресу. Возвращает пару буферизованных каналов, соединённых с сервером. Не забывайте своевременно вызывать flush для канала вывода, чтобы обеспечить правильную синхронизацию.

Два канала, возвращаемые функцией open_connection, используют общий дескриптор сокета. Поэтому по завершении соединения следует вызвать close_out для канала вывода, что также закроет базовый сокет. Не вызывайте close_in для канала ввода; сборщик мусора закроет его позднее.

«Завершает» соединение, установленное с помощью Unix.open_connection; то есть передаёт состояние конца файла серверу, который читает данные на другом конце соединения. Это не закрывает сокет и каналы, используемые соединением. О том, как закрыть их после завершения соединения, см. Unix.open_connection.

Запускает сервер по указанному адресу. Функция, переданная в качестве первого аргумента, вызывается для каждого соединения и получает два буферизованных канала, соединённых с клиентом. Для каждого соединения создаётся новый процесс. Функция Unix.establish_server не возвращает управление обычным образом.

Два канала, переданные функции, используют общий дескриптор сокета. Функции не нужно закрывать каналы, так как они закрываются автоматически при её возврате. Если функция предпочитает закрывать каналы явно, ей следует закрыть канал вывода с помощью close_out, а канал ввода оставить открытым по причинам, описанным в Unix.in_channel_of_descr.

Структура записей в базе данных hosts.

Структура записей в базе данных protocols.

Структура записей в базе данных services.

Возвращает имя локального узла.

Ищет запись в hosts с указанным именем.

Ищет запись в hosts с указанным адресом.

Ищет запись в protocols с указанным именем.

Ищет запись в protocols с указанным номером протокола.

Ищет запись в services с указанным именем.

Ищет запись в services с указанным номером службы.

Информация об адресе, возвращаемая функцией Unix.getaddrinfo.

Параметры для Unix.getaddrinfo.

getaddrinfo host service opts возвращает список записей Unix.addr_info, описывающих параметры сокета и адреса, подходящие для связи с указанным узлом и службой. Пустой список возвращается, если имена узла или службы неизвестны либо ограничения, заданные в opts, не могут быть выполнены.

host — это имя узла или строковое представление IP-адреса. host можно задать пустой строкой; в этом случае используется адрес «любой» или адрес «loopback» в зависимости от того, содержит ли opts значение AI_PASSIVE. service — это имя службы или строковое представление номера порта. service можно задать пустой строкой; в этом случае поле порта возвращаемых адресов устанавливается в 0. opts — это, возможно, пустой список параметров, позволяющий вызывающей стороне задать определённый домен сокета (например, только IPv6 или только IPv4) либо определённый тип сокета (например, только TCP или только UDP).

Информация об узле и службе, возвращаемая функцией Unix.getnameinfo.

Параметры для Unix.getnameinfo.

getnameinfo addr opts возвращает имя узла и имя службы, соответствующие адресу сокета addr. opts — это, возможно, пустой список параметров, определяющих способ получения этих имён.

Возвращает состояние терминала, соответствующего указанному файловому дескриптору.

Установить состояние терминала, на который ссылается указанный файловый дескриптор. Второй аргумент указывает, когда вступает в силу изменение состояния: немедленно (TCSANOW), после передачи всех ожидающих вывода данных (TCSADRAIN) или после очистки всех полученных, но ещё не прочитанных входных данных (TCSAFLUSH). При изменении параметров вывода рекомендуется использовать TCSADRAIN; при изменении параметров ввода — TCSAFLUSH.

Отправить сигнал прерывания по указанному файловому дескриптору. Второй аргумент задаёт длительность сигнала в единицах по 0,1 с; значение 0 означает стандартную длительность (0,25 с).

Ожидать, пока все данные, записанные по указанному файловому дескриптору, не будут переданы.

Отбросить данные, записанные по указанному файловому дескриптору, но ещё не переданные, или полученные, но ещё не прочитанные данные — в зависимости от второго аргумента: TCIFLUSH очищает полученные, но не прочитанные данные, TCOFLUSH очищает записанные, но не переданные данные, а TCIOFLUSH очищает оба типа данных.

Приостановить или возобновить приём либо передачу данных по указанному файловому дескриптору в зависимости от второго аргумента: TCOOFF приостанавливает вывод, TCOON возобновляет вывод, TCIOFF передаёт символ STOP для приостановки ввода, а TCION передаёт символ START для возобновления ввода.

Поместить вызывающий процесс в новый сеанс и отсоединить его от управляющего терминала.