> Linux Reviews > man >

open


  1. open.2.man
  2. open.9.man


1. open.2.man

Manpage of OPEN

OPEN

Section: Руководство программиста Linux (2)
Updated: 2010-09-10
Index Return to Main Contents
 

ИМЯ

open, creat - открывают и, возможно, создают файл или устройство  

ОБЗОР

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

int open(const char *pathname, int flags);
int open(const char *pathname, int flags, mode_t mode);

int creat(const char *pathname, mode_t mode);
 

ОПИСАНИЕ

Получив в pathname имя файла, open() возвращает файловый дескриптор --- небольшое, неотрицательное значение --- для использования в последующих системных вызовах (read(2), write(2), lseek(2), fcntl(2) и т.д.). Файловый дескриптор, возвращаемый при успешном выполнении вызова, будет самым маленьким числом из файловых дескрипторов, которые ещё не открыты процессом.

По умолчанию, новый файловый дескриптор остаётся открытым при вызове execve(2) (т.е., флаг FD_CLOEXEC файлового дескриптора, описанный в fcntl(2), изначально сброшен; для изменения поведения по умолчанию можно использовать флаг O_CLOEXEC (есть только в Linux), он описан ниже). Файловое смещение устанавливается на начало файла (см. lseek(2)).

Вызов open() создаёт новое открытое файловое описание --- запись в системной таблице открытых файлов. В этой записи хранится смещение и флаги состояния файла (изменяются через fcntl(2), операция F_SETFL). Файловый дескриптор является ссылкой на одну из таких записей; с этой ссылкой ничего не происходит при последующем удалении имени файла или переуказании имени на другой файл. Изначально, новое открытое файловое описание не используется разными процессами совместно, но такого общего использования можно достичь, вызвав fork(2).

Параметр flags должен содержать один из следующих режимов доступа: O_RDONLY (только для чтения), O_WRONLY (только для записи) или O_RDWR (для чтения и записи).

Кроме них в flags можно указывать флаги создания и состояния файла, объединяя их битовой операцией ИЛИ. Флаги создания файла: O_CREAT, O_EXCL, O_NOCTTY и O_TRUNC. Флаги состояния файла --- все оставшиеся из перечисленных ниже. Различие между двумя этими группами в том, что флаги состояния можно запросить и (в некоторых случаях) изменить с помощью fcntl(2). Вот полный список флагов создания и состояния файла:

O_APPEND
Файл открывается в режиме добавления. Перед каждым вызовом write(2) файловое смещение устанавливается в конец файла, как если бы это делалось с помощью lseek(2). Флаг O_APPEND может приводить к повреждению файлов в файловой системе NFS, если одновременно добавляют данные в файл несколько процессов. Это происходит из-за того, что NFS не поддерживает добавление в файл, поэтому клиентское ядро имитирует такое поведение, но при этом нельзя избежать состязательности процессов.
O_ASYNC
Включает ввод-вывод, управляемый сигналом: генерирует сигнал (по умолчанию SIGIO, но можно изменить с помощью fcntl(2)), когда становится возможным ввод или вывод для этого файлового дескриптора. Эта возможность доступна только для терминалов, псевдо-терминалов, сокетов, каналов (начиная с Linux 2.6) и FIFO. Подробней см. fcntl(2).
O_CLOEXEC (начиная с Linux 2.6.23)
Устанавливает флаг закрытия-при-exec на новом файловом дескрипторе. Указание данного флага позволяет программе избежать дополнительных операций fcntl(2) F_SETFD для установки флага FD_CLOEXEC. Также, использование этого флага обязательно для некоторых многонитиевых программ, так как использование отдельной операции fcntl(2) F_SETFD для установки флага FD_CLOEXEC недостаточно для избежания состязательности, когда одна нить открывает файловый дескриптор, а в тоже время другая нить может выполнять fork(2) и execve(2).
O_CREAT
Если файл не существует, то он будет создан. Владелец (идентификатор пользователя) файла устанавливается в значение эффективного идентификатора пользователя процесса. Группа (идентификатор группы) устанавливается либо в значение эффективного идентификатора группы процесса, либо в значение идентификатора группы родительского каталога (зависит от типа файловой системы, параметров монтирования и режима родительского каталога, см. например, параметры монтирования bsdgroups и sysvgroups, описанные в mount(8)).

В аргументе mode указываются права использования, которые используются при создании нового файла. Этот параметр должен указываться, если в flags устанавливается O_CREAT; если O_CREAT не задан, то mode игнорируется. Эффективные права изменяются согласно umask процесса как обычно: права созданного файла будут установлены согласно (mode &~umask). Заметим, что этот режим будет учтён только при последующих обращениях к созданному файлу; вызов open(), создающий файл только для чтения, может вернуть файловый дескриптор доступный на чтение и запись.

Символьные константы, используемые в mode:

S_IRWXU
00700 пользователь (владелец файла) имеет права на чтение, запись и выполнение файла
S_IRUSR
00400 пользователь имеет права на чтение файла
S_IWUSR
00200 пользователь имеет права на запись в файл
S_IXUSR
00100 пользователь имеет права на выполнение файла
S_IRWXG
00070 группа имеет права на чтение, запись и выполнение файла
S_IRGRP
00040 группа имеет права на чтение файла
S_IWGRP
00020 группа имеет права на запись в файл
S_IXGRP
00010 группа имеет права на выполнение файла
S_IRWXO
00007 все остальные имеют права на чтение, запись и выполнение файла
S_IROTH
00004 все остальные имеют права на чтение файла
S_IWOTH
00002 все остальные имеют права на запись в файл
S_IXOTH
00001 все остальные имеют права на выполнение файла
O_DIRECT (начиная с Linux 2.4.10)
Попытаться минимизировать влияние кэширования ввода-вывода при чтении и записи в файл. Обычно, это ухудшает производительность, но полезно для особых случаев, например, когда приложение выполняет кэширование самостоятельно. Файловый ввод-вывод выполняется непосредственно в/из буферов пространства пользователя. При флаге O_DIRECT предпринимаются все усилия для синхронной передачи данных, но это не гарантирует, как с O_SYNC, передачу данных и необходимых метаданных. Чтобы гарантировать синхронный ввод-вывод вместе с O_DIRECT нужно использовать O_SYNC. Дальнейшее описание смотрите далее в разделе ЗАМЕЧАНИЯ.

Семантически похожий интерфейс (но устаревший) для блочных устройств описан в raw(8).

O_DIRECTORY
Если pathname не является каталогом, то завершить вызов с ошибкой. Этот флаг используется только в Linux и был добавлен в ядро версии 2.1.126, чтобы избежать проблем с "отказом в обслуживании", если opendir(3) был вызван для канала FIFO или ленточного устройства. Этот флаг не следует использовать вне реализации opendir(3).
O_EXCL
Гарантирует, что вызов создаст файл: если этот флаг указан вместе с O_CREAT и pathname уже существует, то open() завершится с ошибкой. Поведение с O_EXCL, но без O_CREAT не определено.

При использовании обоих флагов символьные ссылки не поддерживаются: если pathname является символьной ссылкой, то open() завершается с ошибкой независимо от того, куда указывает ссылка.

Флаг O_EXCL поддерживается для NFS только, если используется NFSv3 или новее с ядром 2.6 или новее. В средах, где в NFS нет поддержки O_EXCL, программы, которые полагаются на это для выполнения задач блокировок, будут создавать состязательность процессов. Переносимым программам, которым нужно произвести атомарную блокировку файла с помощь файла блокировки, необходимо избегать зависимости от поддержки в NFS флага O_EXCL. В качестве решения можно создать уникальный файл в той же файловой системе (например, добавив имя узла и PID в название), чтобы создать ссылку на файл блокировки с помощью link(2). Если link(2) возвращает 0, то блокировка выполнена. В противном случае используйте stat(2), чтобы убедиться, что количество ссылок на уникальный файл возросло до двух. Это также означает, что блокировка была успешной.

O_LARGEFILE
(LFS) Позволяет открывать файлы, чей размер нельзя представить типом off_t (но можно представить типом off64_t). Для получения этого определения должен быть указан макрос _LARGEFILE64_SOURCE (до включения какого-либо заголовочного файла). Установка макроса теста возможностей _FILE_OFFSET_BITS в значение 64 (вместо использования O_LARGEFILE) является предпочтительным способом получения метода доступа к большим файлам на 32-битных системах (см. feature_test_macros(7)).
O_NOATIME (начиная с Linux 2.6.8)
Не обновлять время последнего доступа к файлу (st_atime в inode) при его чтении read(2). Этот флаг предназначен для использования в программах индексирования и резервного копирования; он позволяет значительно сократить количество обращений к диску. Флаг может быть не эффективен на некоторых файловых системах. Например, на NFS, где запись времени доступа выполняется сервером.
O_NOCTTY
Если pathname указывает на терминальное устройство (см. tty(4)), то оно не станет управляющим терминалом процесса, даже если процесс такового не имеет.
O_NOFOLLOW
Если pathname является символьной ссылкой, то открытие завершится неудачно. Это расширение FreeBSD, которое было добавлено в Linux версии 2.1.126. Все прочие символьные ссылки в имени будут обработаны как обычно.
O_NONBLOCK или O_NDELAY
Если возможно, файл открывается в неблокирующем режиме. Ни open(), ни другие последующие операции над возвращаемым дескриптором файла не заставят вызывающий процесс ждать. Для работы с каналами FIFO также смотрите fifo(7). Обсуждение влияния O_NONBLOCK в сочетании с обязательной файловой блокировкой или арендой (lease) смотрите в fcntl(2).
O_SYNC
Файл открывается в режиме синхронного ввода-вывода. Все вызовы write(2) для соответствующего дескриптора файла блокируют вызывающий процесс до тех пор, пока данные не будут физически записаны. Однако, прочитайте раздел ЗАМЕЧАНИЯ.
O_TRUNC
Если файл уже существует и является обычным файлом и режим открытия позволяет записывать в этот файл (т.е. установлен флаг O_RDWR или O_WRONLY), то его длина будет урезана до нуля. Если файл является FIFO или терминальным устройством, то этот флаг игнорируется. В других случаях действие флага O_TRUNC не определено.

Некоторые из этих необязательных флагов могут быть изменены с помощью fcntl(2) после открытия файла.

Вызов creat() эквивалентен open() с flags, имеющим значение O_CREAT|O_WRONLY|O_TRUNC.  

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ

open() и creat() возвращают новый дескриптор файла или -1 в случае ошибки (в этом случае errno устанавливается в соответствующее значение).  

ОШИБКИ

EACCES
Запрошенный доступ к файлу не разрешён, или один из каталогов в pathname не позволяет поиск, файл ещё не существует, или доступ для записи в родительский каталог не разрешён. (См. также path_resolution(7).)
EEXIST
pathname уже существует, то были указаны O_CREAT и O_EXCL.
EFAULT
Аргумент pathname указывает за пределы доступного адресного пространства.
EFBIG
Смотрите EOVERFLOW.
EINTR
При блокирующем ожидании завершения открытия медленного устройства (например, FIFO; см. fifo(7)), вызов был прерван обработчиком сигнала; смотрите signal(7).
EISDIR
pathname указывает на каталог и тип доступа подразумевает запись ( то есть установлен флаг O_WRONLY или O_RDWR).
ELOOP
Слишком много символьных ссылок пройдено при разрешении pathname, или задан O_NOFOLLOW, но pathname является символьной ссылкой.
EMFILE
Процесс уже открыл максимально допустимое количество файлов.
ENAMETOOLONG
pathname слишком длинен.
ENFILE
Достигнуто максимальное количество открытых файлов в системе.
ENODEV
pathname ссылается на специальный файл устройства, но соответствующего устройства не существует. (Это ошибка в ядре Linux: должно возвращаться ENXIO).
ENOENT
Флаг O_CREAT не задан и файл с таким именем не существует, или же не существует один из каталогов в pathname, или имеется повисшая символьная ссылка.
ENOMEM
Недостаточное количество памяти ядра.
ENOSPC
Файл pathname должен быть создан, но на устройстве его содержащем нет места для нового файла.
ENOTDIR
Компонент, который обозначен как каталог в pathname, таковым не является, или был указан флаг O_DIRECTORY, но pathname не является каталогом.
ENXIO
Указаны флаги O_NONBLOCK | O_WRONLY, файл является каналом FIFO, но нет процесса, который открыл этот канал для чтения. Возможно также, что файл является специальным файлом устройства, но соответствующее устройство не существует.
EOVERFLOW
pathname ссылается на обычный файл, который слишком велик для открытия. Обычно, это случается когда приложение, скомпилированное на 32-битной платформе без -D_FILE_OFFSET_BITS=64, пытается открыть файл размером более (2<<31)-1 бит; смотрите также описание O_LARGEFILE ранее. Эта ошибка определена в POSIX.1-2001; в ядрах до версии 2.6.24 Linux в этом случае выдавал ошибку EFBIG.
EPERM
Задан флаг O_NOATIME, но эффективный ID пользователя вызывающего процесса не совпадает с владельцем файла и вызывающий не имеет прав (CAP_FOWNER).
EROFS
pathname указывает на файл на файловой системе, доступной только на чтение, но запрашивается доступ на запись.
ETXTBSY
pathname указывает на исполняемый файл, который запущен в данный момент, но запрашивается доступ на запись.
EWOULDBLOCK
Указан флаг O_NONBLOCK, но несовместимая аренда (lease) удерживает файл (смотрите fcntl(2)).
 

СООТВЕТСТВИЕ СТАНДАРТАМ

SVr4, 4.3BSD, POSIX.1-2001. Флаги O_DIRECTORY, O_NOATIME и O_NOFOLLOW есть только в Linux, и для их определения может потребоваться задать _GNU_SOURCE (до включения какого-либо заголовочного файла).

Флаг O_CLOEXEC не определён в POSIX.1-2001, но есть в POSIX.1-2008.

Флаг O_DIRECT не определён в POSIX; для его определения задайте _GNU_SOURCE (до включения какого-либо заголовочного файла).  

ЗАМЕЧАНИЯ

В Linux флаг O_NONBLOCK указывает, что файл нужно открыть, но не обязательно будет производиться чтение или запись. Обычно это указывается для открытия устройства, чтобы получить его файловый дескриптор для использования в ioctl(2).

В отличие от других значений, указываемых в flags, значения режима доступа O_RDONLY, O_WRONLY и O_RDWR, не определяются отдельными битами. Точнее, они задаются двумя первыми битами flags, и имеют значения 0, 1 и 2, соответственно. Другими словами, комбинация O_RDONLY | O_WRONLY приводит к логической ошибке и точно не работает как O_RDWR. В Linux зарезервирован специальный нестандартный режим доступа 3 (11 двоичное) в flags, при котором: проверяются права на чтение и запись к файлу и возвращается дескриптор, который не может использоваться для чтения или записи. Данный нестандартный режим доступа используется некоторыми драйверами Linux для получения дескриптора, который будет использоваться в ioctl(2) только для специальных операций с устройством.

Результат работы комбинации флагов O_RDONLY | O_TRUNC в разных реализациях разный (нигде не определён). Во многих системах файл усекается.

В протоколе, по которому работает NFS, существует множество недоработок, оказывающих влияние на многое, в том числе на работу с O_SYNC и O_NDELAY.

В POSIX представлено три различных варианта синхронизированного ввода-вывода, соответствующих флагам O_SYNC, O_DSYNC и O_RSYNC. На данный момент (2.6.31) в Linux реализован только O_SYNC, но glibc проецирует O_DSYNC и O_RSYNC в то же числовое значение что и O_SYNC. В большинстве файловых систем Linux, на самом деле, не реализована семантика POSIX O_SYNC, которая требует записи всех обновлённых метаданных на диск до возврата в пространство пользователя, а только семантика O_DSYNC, по которой до возврата из вызова должны быть реально записаны только данные файла и метаданные, необходимые для их получения.

Заметим, что open() может открывать специальные файлы устройств, но creat() не может их создавать; вместо этого используйте mknod(2).

В файловых системах NFS с включённым проецированием UID, open() может вернуть файловый дескриптор, но, например, запросы read(2) будут отклонены с ошибкой EACCES. Это происходит из-за того, что клиент выполняет open() проверяя одни права, но сервер выполняет проецирование UID только при запросах чтения и записи.

Если файл только что был создан, его поля st_atime, st_ctime, st_mtime (время последнего доступа, последней смены состояния и последнего изменения, соответственно; см. stat(2)) устанавливаются в значение текущего времени, и оно совпадает с полями st_ctime и st_mtime родительского каталога. Или же, если файл изменяется из-за установленного флага O_TRUNC, то его поля st_ctime и st_mtime устанавливаются в значение текущего времени.  

O_DIRECT

Флаг O_DIRECT может накладывать ограничения по выравниванию на длину и адрес буфера пользовательского пространства и смещения файла при вводе-выводе. В Linux ограничения по выравниванию различны у разных файловых систем и версий ядра, и даже могут отсутствовать. Однако сейчас не существует независимого от файловой системы интерфейса приложения для выявления этих ограничений на определённый файл или файловую систему. Некоторые файловые системы предоставляют свои собственные интерфейсы для этого, например, операция XFS_IOC_DIOINFO в xfsctl(3).

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

Флаг O_DIRECT появился в SGI IRIX, где ограничения на выравнивание подобны Linux 2.4. В IRIX также есть вызов fcntl(2) для запроса значений соответствующего выравнивания и размеров. В FreeBSD 4.x появился флаг с таким же именем, но без ограничений на выравнивание.

Поддержка O_DIRECT добавлена в ядро Linux версии 2.4.10. Более старые ядра Linux просто игнорируют этот флаг. В некоторых файловых системах этот флаг может быть не реализован и open() завершится с ошибкой EINVAL при его использовании.

Приложения должны избегать смешивания O_DIRECT и обычных операций ввода-вывода в один файл и особенно перекрывать байтовые области. Даже когда файловая система правильно обрабатывает проблемы с когерентностью в такой ситуации, общая пропускная способность ввода-вывода, вероятно, будет медленнее чем при использовании какого-то одного из этих режимов отдельно. Аналогично приложения должны избегать смешивания mmap(2) и прямого ввода-вывода для одинаковых файлов.

Поведение O_DIRECT на NFS отличается от локальных файловых систем. Старые ядра и ядра, настроенные определёнными способами, могут не поддерживать такую комбинацию. Протокол NFS не поддерживает передачу флага на сервер, поэтому ввод-вывод с O_DIRECT будет пропускать кэширование страниц только на клиенте; сервер всё равно может выполнить кэширование ввода-вывода. Клиент просит сервер выполнять операции ввода-вывода синхронно для сохранения синхронной семантики O_DIRECT. Некоторые серверы будут выполнять это плохо при определённых условиях, особенно если размер данных ввода-вывод невелик. Некоторые серверы также могут быть настроены на отправку ложного ответа клиентам о том, что ввод-вывод произведён на носитель; это позволяет избежать потери производительности, но есть риск потери целостности данных в случае проблем с электропитанием сервера. В Linux клиент NFS не устанавливает ограничений по выравниванию при вводе-выводе с O_DIRECT.

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

"The thing that has always disturbed me about O_DIRECT is that the whole interface is just stupid, and was probably designed by a deranged monkey on some serious mind-controlling substances." --- LinusМеня всегда беспокоило кое-что относительно O_DIRECT --- то, что вообще в целом этот интерфейс просто идиотичен. Создается впечатление, что он как-бы был создан сумасшедшей обезьяной под веществами.)
 

ДЕФЕКТЫ

На данный момент невозможно включить сигнальное управление вводом-выводом, указав O_ASYNC при вызове open(); чтобы установить этот флаг используйте fcntl(2).  

СМОТРИТЕ ТАКЖЕ

chmod(2), chown(2), close(2), dup(2), fcntl(2), link(2), lseek(2), mknod(2), mmap(2), mount(2), openat(2), read(2), socket(2), stat(2), umask(2), unlink(2), write(2), fopen(3), feature_test_macros(7), fifo(7), path_resolution(7), symlink(7)


 

Index

ИМЯ
ОБЗОР
ОПИСАНИЕ
ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ
ОШИБКИ
СООТВЕТСТВИЕ СТАНДАРТАМ
ЗАМЕЧАНИЯ
O_DIRECT
ДЕФЕКТЫ
СМОТРИТЕ ТАКЖЕ

This document was created by man2html using the manual pages.
Time: 17:41:33 GMT, October 23, 2013

2. open.9.man

Manpage of open

open

Section: Tcl Built-In Commands (n)
Updated: 8.3
Index Return to Main Contents



 

NAME

open - Open a file-based or command pipeline channel  

SYNOPSIS

open fileName
open fileName access
open fileName access permissions




 

DESCRIPTION

This command opens a file, serial port, or command pipeline and returns a channel identifier that may be used in future invocations of commands like read, puts, and close. If the first character of fileName is not | then the command opens a file: fileName gives the name of the file to open, and it must conform to the conventions described in the filename manual entry.

The access argument, if present, indicates the way in which the file (or command pipeline) is to be accessed. In the first form access may have any of the following values:

r
Open the file for reading only; the file must already exist. This is the default value if access is not specified.
r+
Open the file for both reading and writing; the file must already exist.
w
Open the file for writing only. Truncate it if it exists. If it does not exist, create a new file.
w+
Open the file for reading and writing. Truncate it if it exists. If it does not exist, create a new file.
a
Open the file for writing only. If the file does not exist, create a new empty file. Set the file pointer to the end of the file prior to each write.
a+
Open the file for reading and writing. If the file does not exist, create a new empty file. Set the initial access position to the end of the file.

All of the legal access values above may have the character b added as the second or third character in the value to indicate that the opened channel should be configured with the -translation binary option, making the channel suitable for reading or writing of binary data.

In the second form, access consists of a list of any of the following flags, all of which have the standard POSIX meanings. One of the flags must be either RDONLY, WRONLY or RDWR.

RDONLY
Open the file for reading only.
WRONLY
Open the file for writing only.
RDWR
Open the file for both reading and writing.
APPEND
Set the file pointer to the end of the file prior to each write.
BINARY
Configure the opened channel with the -translation binary option.
CREAT
Create the file if it does not already exist (without this flag it is an error for the file not to exist).
EXCL
If CREAT is also specified, an error is returned if the file already exists.
NOCTTY
If the file is a terminal device, this flag prevents the file from becoming the controlling terminal of the process.
NONBLOCK
Prevents the process from blocking while opening the file, and possibly in subsequent I/O operations. The exact behavior of this flag is system- and device-dependent; its use is discouraged (it is better to use the fconfigure command to put a file in nonblocking mode). For details refer to your system documentation on the open system call's O_NONBLOCK flag.
TRUNC
If the file exists it is truncated to zero length.

If a new file is created as part of opening it, permissions (an integer) is used to set the permissions for the new file in conjunction with the process's file mode creation mask. Permissions defaults to 0666.  

COMMAND PIPELINES

If the first character of fileName is ``|'' then the remaining characters of fileName are treated as a list of arguments that describe a command pipeline to invoke, in the same style as the arguments for exec. In this case, the channel identifier returned by open may be used to write to the command's input pipe or read from its output pipe, depending on the value of access. If write-only access is used (e.g. access is w), then standard output for the pipeline is directed to the current standard output unless overridden by the command. If read-only access is used (e.g. access is r), standard input for the pipeline is taken from the current standard input unless overridden by the command. The id of the spawned process is accessible through the pid command, using the channel id returned by open as argument.

If the command (or one of the commands) executed in the command pipeline returns an error (according to the definition in exec), a Tcl error is generated when close is called on the channel unless the pipeline is in non-blocking mode then no exit status is returned (a silent close with -blocking 0).

It is often useful to use the fileevent command with pipelines so other processing may happen at the same time as running the command in the background.  

SERIAL COMMUNICATIONS

If fileName refers to a serial port, then the specified serial port is opened and initialized in a platform-dependent manner. Acceptable values for the fileName to use to open a serial port are described in the PORTABILITY ISSUES section.

The fconfigure command can be used to query and set additional configuration options specific to serial ports (where supported):

-mode baud,parity,data,stop
This option is a set of 4 comma-separated values: the baud rate, parity, number of data bits, and number of stop bits for this serial port. The baud rate is a simple integer that specifies the connection speed. Parity is one of the following letters: n, o, e, m, s; respectively signifying the parity options of ``none'', ``odd'', ``even'', ``mark'', or ``space''. Data is the number of data bits and should be an integer from 5 to 8, while stop is the number of stop bits and should be the integer 1 or 2.
-handshake type
(Windows and Unix). This option is used to setup automatic handshake control. Note that not all handshake types maybe supported by your operating system. The type parameter is case-independent.

If type is none then any handshake is switched off. rtscts activates hardware handshake. Hardware handshake signals are described below. For software handshake xonxoff the handshake characters can be redefined with -xchar. An additional hardware handshake dtrdsr is available only under Windows. There is no default handshake configuration, the initial value depends on your operating system settings. The -handshake option cannot be queried.

-queue
(Windows and Unix). The -queue option can only be queried. It returns a list of two integers representing the current number of bytes in the input and output queue respectively.
-timeout msec
(Windows and Unix). This option is used to set the timeout for blocking read operations. It specifies the maximum interval between the reception of two bytes in milliseconds. For Unix systems the granularity is 100 milliseconds. The -timeout option does not affect write operations or nonblocking reads. This option cannot be queried.
-ttycontrol {signal boolean signal boolean ...}
(Windows and Unix). This option is used to setup the handshake output lines (see below) permanently or to send a BREAK over the serial line. The signal names are case-independent. {RTS 1 DTR 0} sets the RTS output to high and the DTR output to low. The BREAK condition (see below) is enabled and disabled with {BREAK 1} and {BREAK 0} respectively. It is not a good idea to change the RTS (or DTR) signal with active hardware handshake rtscts (or dtrdsr). The result is unpredictable. The -ttycontrol option cannot be queried.
-ttystatus
(Windows and Unix). The -ttystatus option can only be queried. It returns the current modem status and handshake input signals (see below). The result is a list of signal,value pairs with a fixed order, e.g. {CTS 1 DSR 0 RING 1 DCD 0}. The signal names are returned upper case.
-xchar {xonChar xoffChar}
(Windows and Unix). This option is used to query or change the software handshake characters. Normally the operating system default should be DC1 (0x11) and DC3 (0x13) representing the ASCII standard XON and XOFF characters.
-pollinterval msec
(Windows only). This option is used to set the maximum time between polling for fileevents. This affects the time interval between checking for events throughout the Tcl interpreter (the smallest value always wins). Use this option only if you want to poll the serial port more or less often than 10 msec (the default).
-sysbuffer inSize
-sysbuffer {inSize outSize}
(Windows only). This option is used to change the size of Windows system buffers for a serial channel. Especially at higher communication rates the default input buffer size of 4096 bytes can overrun for latent systems. The first form specifies the input buffer size, in the second form both input and output buffers are defined.
-lasterror
(Windows only). This option is query only. In case of a serial communication error, read or puts returns a general Tcl file I/O error. fconfigure -lasterror can be called to get a list of error details. See below for an explanation of the various error codes.
 

SERIAL PORT SIGNALS

RS-232 is the most commonly used standard electrical interface for serial communications. A negative voltage (-3V..-12V) define a mark (on=1) bit and a positive voltage (+3..+12V) define a space (off=0) bit (RS-232C). The following signals are specified for incoming and outgoing data, status lines and handshaking. Here we are using the terms workstation for your computer and modem for the external device, because some signal names (DCD, RI) come from modems. Of course your external device may use these signal lines for other purposes.

TXD(output)
Transmitted Data: Outgoing serial data.
RXD(input)
Received Data:Incoming serial data.
RTS(output)
Request To Send: This hardware handshake line informs the modem that your workstation is ready to receive data. Your workstation may automatically reset this signal to indicate that the input buffer is full.
CTS(input)
Clear To Send: The complement to RTS. Indicates that the modem is ready to receive data.
DTR(output)
Data Terminal Ready: This signal tells the modem that the workstation is ready to establish a link. DTR is often enabled automatically whenever a serial port is opened.
DSR(input)
Data Set Ready: The complement to DTR. Tells the workstation that the modem is ready to establish a link.
DCD(input)
Data Carrier Detect: This line becomes active when a modem detects a ``Carrier'' signal.
RI(input)
Ring Indicator: Goes active when the modem detects an incoming call.
BREAK
A BREAK condition is not a hardware signal line, but a logical zero on the TXD or RXD lines for a long period of time, usually 250 to 500 milliseconds. Normally a receive or transmit data signal stays at the mark (on=1) voltage until the next character is transferred. A BREAK is sometimes used to reset the communications line or change the operating mode of communications hardware.
 

ERROR CODES (Windows only)

A lot of different errors may occur during serial read operations or during event polling in background. The external device may have been switched off, the data lines may be noisy, system buffers may overrun or your mode settings may be wrong. That is why a reliable software should always catch serial read operations. In cases of an error Tcl returns a general file I/O error. Then fconfigure -lasterror may help to locate the problem. The following error codes may be returned.

RXOVER
Windows input buffer overrun. The data comes faster than your scripts reads it or your system is overloaded. Use fconfigure -sysbuffer to avoid a temporary bottleneck and/or make your script faster.
TXFULL
Windows output buffer overrun. Complement to RXOVER. This error should practically not happen, because Tcl cares about the output buffer status.
OVERRUN
UART buffer overrun (hardware) with data lost. The data comes faster than the system driver receives it. Check your advanced serial port settings to enable the FIFO (16550) buffer and/or setup a lower(1) interrupt threshold value.
RXPARITY
A parity error has been detected by your UART. Wrong parity settings with fconfigure -mode or a noisy data line (RXD) may cause this error.
FRAME
A stop-bit error has been detected by your UART. Wrong mode settings with fconfigure -mode or a noisy data line (RXD) may cause this error.
BREAK
A BREAK condition has been detected by your UART (see above).
 

PORTABILITY ISSUES

Windows (all versions)
Valid values for fileName to open a serial port are of the form comX:, where X is a number, generally from 1 to 4. This notation only works for serial ports from 1 to 9, if the system happens to have more than four. An attempt to open a serial port that does not exist or has a number greater than 9 will fail. An alternate form of opening serial ports is to use the filename \\.\comX, where X is any number that corresponds to a serial port; please note that this method is considerably slower on Windows 95 and Windows 98.
Windows NT
When running Tcl interactively, there may be some strange interactions between the real console, if one is present, and a command pipeline that uses standard input or output. If a command pipeline is opened for reading, some of the lines entered at the console will be sent to the command pipeline and some will be sent to the Tcl evaluator. If a command pipeline is opened for writing, keystrokes entered into the console are not visible until the pipe is closed. This behavior occurs whether the command pipeline is executing 16-bit or 32-bit applications. These problems only occur because both Tcl and the child application are competing for the console at the same time. If the command pipeline is started from a script, so that Tcl is not accessing the console, or if the command pipeline does not use standard input or output, but is redirected from or to a file, then the above problems do not occur.
Windows 95
A command pipeline that executes a 16-bit DOS application cannot be opened for both reading and writing, since 16-bit DOS applications that receive standard input from a pipe and send standard output to a pipe run synchronously. Command pipelines that do not execute 16-bit DOS applications run asynchronously and can be opened for both reading and writing.

When running Tcl interactively, there may be some strange interactions between the real console, if one is present, and a command pipeline that uses standard input or output. If a command pipeline is opened for reading from a 32-bit application, some of the keystrokes entered at the console will be sent to the command pipeline and some will be sent to the Tcl evaluator. If a command pipeline is opened for writing to a 32-bit application, no output is visible on the console until the pipe is closed. These problems only occur because both Tcl and the child application are competing for the console at the same time. If the command pipeline is started from a script, so that Tcl is not accessing the console, or if the command pipeline does not use standard input or output, but is redirected from or to a file, then the above problems do not occur.

Whether or not Tcl is running interactively, if a command pipeline is opened for reading from a 16-bit DOS application, the call to open will not return until end-of-file has been received from the command pipeline's standard output. If a command pipeline is opened for writing to a 16-bit DOS application, no data will be sent to the command pipeline's standard output until the pipe is actually closed. This problem occurs because 16-bit DOS applications are run synchronously, as described above.

Unix       
Valid values for fileName to open a serial port are generally of the form /dev/ttyX, where X is a or b, but the name of any pseudo-file that maps to a serial port may be used. Advanced configuration options are only supported for serial ports when Tcl is built to use the POSIX serial interface.

When running Tcl interactively, there may be some strange interactions between the console, if one is present, and a command pipeline that uses standard input. If a command pipeline is opened for reading, some of the lines entered at the console will be sent to the command pipeline and some will be sent to the Tcl evaluator. This problem only occurs because both Tcl and the child application are competing for the console at the same time. If the command pipeline is started from a script, so that Tcl is not accessing the console, or if the command pipeline does not use standard input, but is redirected from a file, then the above problem does not occur.

See the PORTABILITY ISSUES section of the exec command for additional information not specific to command pipelines about executing applications on the various platforms  

EXAMPLE

Open a command pipeline and catch any errors:

set fl [open "| ls this_file_does_not_exist"]
set data [read $fl]
if {[catch {close $fl} err]} {
    puts "ls command failed: $err"
}

 

SEE ALSO

file(n), close(n), filename(n), fconfigure(n), gets(n), read(n), puts(n), exec(n), pid(n), fopen(3)  

KEYWORDS

access mode, append, create, file, non-blocking, open, permissions, pipeline, process, serial


 

Index

NAME
SYNOPSIS
DESCRIPTION
COMMAND PIPELINES
SERIAL COMMUNICATIONS
SERIAL PORT SIGNALS
ERROR CODES (Windows only)
PORTABILITY ISSUES
EXAMPLE
SEE ALSO
KEYWORDS

This document was created by man2html using the manual pages.
Time: 17:41:33 GMT, October 23, 2013

SVENSKA - SVENSKA - SVENSKA - cs - da - SVENSKA - SVENSKA - SVENSKA - SVENSKA - ja - nl - pl - ro - zh_CN