Модуль 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 — её новое связанное значение.

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

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

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

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

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

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

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

Ожидать завершения одного из дочерних процессов и вернуть его 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 run-time также не завершается.

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

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

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

Изменить приоритет процесса. Целое числовое значение добавляется к значению ``nice'' (большие значения ``nice'' означают меньшие приоритеты). Возвращает новое значение nice.

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

Дескриптор файла для стандартного ввода.

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

Дескриптор файла для стандартной ошибки.

Флаги для функции UnixLabels.openfile.

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

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

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

Очистить буферы файла в диск.

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

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

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

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

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

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

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

Режимы позиционирования для 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, изменения, внесенные в массив, выполняются только в памяти, с использованием копирования при записи изменённых страниц; подлежащий файл не затрагивается.

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

Для автоматического изменения размеров Bigarray до фактического размера файла, основная размерность (то есть первая размерность для массива с C-структурой и последняя размерность для массива с Fortran-структурой) может быть задана как -1. Genarray.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 не может быть проверено, вместо этого проверяется только право на чтение.

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

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

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

Снимает флаг «неблокирующего» режима с данного дескриптора. См. UnixLabels.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» с данного дескриптора. См. UnixLabels.set_close_on_exec.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

open_process_args_in prog args запускает программу prog с аргументами args. Новый процесс выполняется одновременно с текущим процессом. Стандартный вывод нового процесса перенаправляется в канал, который можно прочитать через возвращаемый входной канал.

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

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

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

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

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

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

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

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

Возвращает pid процесса, открытого с помощью UnixLabels.open_process_full или UnixLabels.open_process_args_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 доступен.

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

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

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

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

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

Преобразует время в секундах, возвращаемое функцией UnixLabels.time, в дату и время. Предполагается UTC (Координированное универсальное время), также известное как Гринвичское время. Для выполнения обратного преобразования установите переменную окружения 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 по Гринвичу, 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.

Возвращает эффективную группу ID, под которой работает процесс.

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

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

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

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

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

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

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

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

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

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

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

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

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

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