Модуль Unix

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

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

UnixLabels.Unix_error и Unix.Unix_error одинаковы, и перехват одной из них перехватывает и другую.

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

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

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

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

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

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

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

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

Код завершения процесса. См. модуль Sys для определений стандартных номеров сигналов. Обратите внимание, что они не являются числами, используемыми ОС.

В Windows: используется только WEXITED (так как нет межпроцессных сигналов), но с определенными кодами возврата для указания особых причин завершения. Ищите значения NTSTATUS в документации Windows, чтобы расшифровать такие коды возврата ошибок. В частности, код ошибки 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.

Доступы к массивам проверяются на границах, но границы определяются начальным вызовом Unix.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.

Изменение разрешений указанного файла.

Изменение разрешений открытого файла.

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

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

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

Проверка наличия у процесса указанных разрешений на указанный файл.

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

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

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

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

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

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

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

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

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

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

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

Создать директорию с заданными разрешениями (см. Unix.umask).

Удалить пустую директорию.

Изменить текущую директорию процесса.

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

Изменить корневую директорию процесса.

Тип дескрипторов открытых директорий.

Открыть дескриптор директории

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

Переместить дескриптор к началу директории

Закрыть дескриптор директории.

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

Создать именованный канал с заданными разрешениями (см. Unix.umask).

create_process prog args stdin stdout stderr создает новый процесс, который выполняет программу в файле prog, с аргументами args. Обратите внимание, что первый аргумент, args.(0), по соглашению является именем файла исполняемой программы, как и в Sys.argv.(0). ИД нового процесса возвращается немедленно; новый процесс выполняется параллельно с текущим процессом. Стандартный ввод и выводы нового процесса подключены к дескрипторам 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_args_in в качестве более надёжной и эффективной альтернативы Unix.open_process_in.

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

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

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

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

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

Исполняемый файл prog ищется в переменной PATH. Это поведение изменилось в версии 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, но он также запущен с повышенными правами, если это необходимо. На других платформах это просто указывает на доступность системного вызова symlink.

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

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

Команды для 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 процессу с id pid.

В Windows: эмулируется только сигнал Sys.sigkill.

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

При загрузке модуля Thread в версии systhreads эта функция перенаправляется на Thread.sigmask. То есть, sigprocmask изменяет только маску текущей нити.

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

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

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

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

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

Возвращает текущее время с 00:00:00 по Гринвичу, 1 января 1970 года, в секундах.

То же, что и Unix.time, но с разрешением лучше, чем 1 секунда.

Преобразует время в секундах, возвращаемое 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 через заданное количество секунд.

• Вызывает Invalid_argument в Windows

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

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

• С 4.03 (4.12 в UnixLabels)

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

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

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

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

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

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

• Вызывает Invalid_argument в Windows

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

• Вызывает Invalid_argument в Windows

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

В 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, представляющий все интернет-адреса, которыми обладает хост-машина.

Является ли данный 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 выбирает протокол по умолчанию для данного типа сокетов. Смотрите Unix.set_close_on_exec для документации по cloexec необязательному аргументу.

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

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

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

Связать сокет с адресом.

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

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

Тип команд для 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 может быть задано как пустая строка; в этом случае используется адрес «любой» или «обратный» адрес, в зависимости от того, содержит ли 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 для возобновления ввода.

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