Модуль UnixLabels

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

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

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

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

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

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

Возвращает окружение процесса в виде массива строк формата ``переменная=значение''. В отличие от UnixLabels.environment, эта функция возвращает непустой массив, даже если процесс обладает особыми привилегиями. Дополнительные сведения см. в документации к UnixLabels.unsafe_getenv.

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

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

В отличие от UnixLabels.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 является эквивалентом Windows для WSIGNALED Sys.sigsegv.

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

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

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

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

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

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

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

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

То же, что и UnixLabels.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

То же, что и UnixLabels.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Чтобы автоматически подстроить размерности Bigarray под фактический размер файла, старшую размерность (то есть первую размерность для массива с расположением C и последнюю — для массива с расположением Fortran) можно задать как -1. В этом случае UnixLabels.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, полученный путем разрешения всех дополнительных символов /, относительных компонентов пути и символических ссылок.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Необязательные аргументы cloexec и флаг O_KEEPEXEC появились в OCaml 4.05. Ранее обычно файловые дескрипторы создавались в режиме по умолчанию «сохранить при выполнении», а затем для только что созданных дескрипторов вызывалась функция set_close_on_exec. Это менее безопасно, чем создание дескриптора в режиме «закрыть при выполнении», поскольку в многопоточных программах существует окно уязвимости между созданием дескриптора и завершением set_close_on_exec. Если в это время другая нить запустит другую программу, дескриптор утечет, поскольку он все еще находится в режиме «сохранить при выполнении».

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

Сбрасывает для указанного дескриптора флаг «закрыть при выполнении». См. UnixLabels.set_close_on_exec.

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

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

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

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

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

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

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

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

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

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

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

Создает именованный канал с указанными правами доступа (см. UnixLabels.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 работает так же, как UnixLabels.create_process, за исключением того, что дополнительный аргумент env задает среду, передаваемую программе.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Закрывает каналы, открытые с помощью UnixLabels.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.

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

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

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

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

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

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

lockf fd ~mode ~len устанавливает блокировку области файла, открытого как fd. Область начинается с текущей позиции чтения/записи для fd (устанавливаемой с помощью UnixLabels.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 года.

То же, что и UnixLabels.time, но с точностью выше одной секунды.

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

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

Преобразует дату и время, заданные аргументом tm, во время в секундах, возвращаемое функцией UnixLabels.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.

Возвращает печатное представление указанного интернет-адреса. Описание печатного представления см. в UnixLabels.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 см. в UnixLabels.set_close_on_exec.

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

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

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

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

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

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

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

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

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

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

Флаги для UnixLabels.recv, UnixLabels.recvfrom, UnixLabels.send и UnixLabels.sendto.

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

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

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

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

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

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

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

Параметры сокета, которые можно получить с помощью UnixLabels.getsockopt_int и изменить с помощью UnixLabels.setsockopt_int. Эти параметры имеют целочисленное значение.

Параметры сокета, которые можно получить с помощью UnixLabels.getsockopt_optint и изменить с помощью UnixLabels.setsockopt_optint. Эти параметры имеют значение типа int option, где None означает «отключено».

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

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

Устанавливает или сбрасывает параметр с булевым значением для указанного сокета.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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