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

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

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

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

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

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

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

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

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

Ожидать, пока один из дочерних процессов умрёт, и возвратить его pid и статус завершения.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Аналогично UnixLabels.read, но считывает данные в bigarray.

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

Аналогично UnixLabels.write, но считывает данные из bigarray.

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

Аналогично UnixLabels.write, но считывает данные из строки, а не последовательности байтов.

Аналогично UnixLabels.single_write, но считывает данные из строки, а не последовательности байтов.

Аналогично UnixLabels.single_write, но считывает данные из bigarray.

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

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

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

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

Если несколько каналов созданы на одном дескрипторе, один из каналов должен быть закрыт, но не другие. Рассмотрим, например, дескриптор s подключенный к сокету и два канала ic = in_channel_of_descr s и oc = out_channel_of_descr s. Рекомендуемый протокол закрытия - выполнить close_out oc, который сбрасывает буферизованный вывод в сокет, а затем закрывает сокет. Канал ic не должен быть закрыт и будет собран сборщиком мусора.

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

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

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

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

См. Unix.in_channel_of_descr для обсуждения протокола закрытия, когда несколько каналов созданы на одном дескрипторе.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 prog args запускает программу prog с аргументами args. Обратите внимание, что первый аргумент, args.(0), по соглашению является именем файла исполняемой программы, так же как и Sys.argv.(0). Новый процесс выполняется параллельно с текущим процессом. Стандартный ввод и вывод нового процесса перенаправляются в каналы, которые можно соответственно читать и записывать через возвращаемые каналы. Входной канал подключен к выводу программы, а выходной канал – к вводу программы.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

При загрузке версии systhreads модуля Thread, эта функция перенаправляется на 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.

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

В 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 для возобновления ввода.

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