Модуль 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 для определений стандартных номеров сигналов. Обратите внимание, что они не являются номерами, используемыми ОС.

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

execv prog args выполнить программу в файле prog, с аргументами args, и текущей средой процесса. Эти execv* функции никогда не возвращаются: при успехе текущая программа заменяется новой.

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

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

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

Создать новый процесс. Возвращаемое целое число равно 0 для дочернего процесса и pid дочернего процесса для родительского процесса.

Ожидать, пока один из дочерних процессов завершится, и вернуть его 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. Возвращает количество фактически прочитанных байтов.

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

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

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

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

Создать канал ввода, читающий из заданного дескриптора. Канал изначально в двоичном режиме; используйте 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
• EISDIR на 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 нельзя проверить, вместо этого проверяется только разрешение на чтение.

Возвращает новый дескриптор файла, ссылающийся на тот же файл, что и заданный дескриптор. См. 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», потому что в многопоточных программах существует окно уязвимости между временем создания дескриптора файла и временем завершения ~cloexec:true. Если другой поток запускает другую программу в течение этого окна, дескриптор утечет, поскольку он все еще находится в режиме «сохранить при 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. ID нового процесса возвращается немедленно; новый процесс выполняется одновременно с текущим процессом. Стандартный ввод и выводы нового процесса подключены к дескрипторам 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_in prog args запускает программу prog с аргументами args. Новый процесс выполняется параллельно с текущим. Стандартный вывод нового процесса перенаправляется в канал, который можно читать через возвращаемый входной канал.

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

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

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

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

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

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

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

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

Возвращает pid процесса, открытого с помощью Unix.open_process_full или Unix.open_process_args_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_RLOCK пытаются установить блокировку на запись в указанной области. Команды F_TLOCK и 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.0 (4.12.0 в 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).

Является ли данный 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 для возобновления ввода.

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