Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 1 | :mod:`fcntl` --- The ``fcntl`` and ``ioctl`` system calls |
| 2 | ========================================================= |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
| 4 | .. module:: fcntl |
| 5 | :platform: Unix |
| 6 | :synopsis: The fcntl() and ioctl() system calls. |
| 7 | .. sectionauthor:: Jaap Vermeulen |
| 8 | |
| 9 | |
| 10 | .. index:: |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 11 | pair: UNIX; file control |
| 12 | pair: UNIX; I/O control |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 13 | |
| 14 | This module performs file control and I/O control on file descriptors. It is an |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 15 | interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 16 | |
| 17 | All functions in this module take a file descriptor *fd* as their first |
| 18 | argument. This can be an integer file descriptor, such as returned by |
Benjamin Peterson | 4f5e298 | 2010-09-10 18:50:38 +0000 | [diff] [blame] | 19 | ``sys.stdin.fileno()``, or a :class:`io.IOBase` object, such as ``sys.stdin`` |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 20 | itself, which provides a :meth:`~io.IOBase.fileno` that returns a genuine file |
| 21 | descriptor. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 22 | |
Antoine Pitrou | 62ab10a0 | 2011-10-12 20:10:51 +0200 | [diff] [blame] | 23 | .. versionchanged:: 3.3 |
| 24 | Operations in this module used to raise a :exc:`IOError` where they now |
| 25 | raise a :exc:`OSError`. |
| 26 | |
| 27 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 28 | The module defines the following functions: |
| 29 | |
| 30 | |
| 31 | .. function:: fcntl(fd, op[, arg]) |
| 32 | |
R David Murray | d5a2f0b | 2013-11-07 10:51:07 -0500 | [diff] [blame] | 33 | Perform the operation *op* on file descriptor *fd* (file objects providing |
| 34 | a :meth:`~io.IOBase.fileno` method are accepted as well). The values used |
| 35 | for *op* are operating system dependent, and are available as constants |
| 36 | in the :mod:`fcntl` module, using the same names as used in the relevant C |
| 37 | header files. The argument *arg* is optional, and defaults to the integer |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 38 | value ``0``. When present, it can either be an integer value, or a string. |
| 39 | With the argument missing or an integer value, the return value of this function |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 40 | is the integer return value of the C :c:func:`fcntl` call. When the argument is |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 41 | a string it represents a binary structure, e.g. created by :func:`struct.pack`. |
| 42 | The binary data is copied to a buffer whose address is passed to the C |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 43 | :c:func:`fcntl` call. The return value after a successful call is the contents |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 44 | of the buffer, converted to a string object. The length of the returned string |
| 45 | will be the same as the length of the *arg* argument. This is limited to 1024 |
| 46 | bytes. If the information returned in the buffer by the operating system is |
| 47 | larger than 1024 bytes, this is most likely to result in a segmentation |
| 48 | violation or a more subtle data corruption. |
| 49 | |
Antoine Pitrou | 62ab10a0 | 2011-10-12 20:10:51 +0200 | [diff] [blame] | 50 | If the :c:func:`fcntl` fails, an :exc:`OSError` is raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 51 | |
| 52 | |
| 53 | .. function:: ioctl(fd, op[, arg[, mutate_flag]]) |
| 54 | |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 55 | This function is identical to the :func:`~fcntl.fcntl` function, except |
| 56 | that the argument handling is even more complicated. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 57 | |
Christian Heimes | e25f35e | 2008-03-20 10:49:03 +0000 | [diff] [blame] | 58 | The op parameter is limited to values that can fit in 32-bits. |
R David Murray | d5a2f0b | 2013-11-07 10:51:07 -0500 | [diff] [blame] | 59 | Additional constants of interest for use as the *op* argument can be |
| 60 | found in the :mod:`termios` module, under the same names as used in |
| 61 | the relevant C header files. |
Christian Heimes | e25f35e | 2008-03-20 10:49:03 +0000 | [diff] [blame] | 62 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 63 | The parameter *arg* can be one of an integer, absent (treated identically to the |
| 64 | integer ``0``), an object supporting the read-only buffer interface (most likely |
| 65 | a plain Python string) or an object supporting the read-write buffer interface. |
| 66 | |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 67 | In all but the last case, behaviour is as for the :func:`~fcntl.fcntl` |
| 68 | function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 69 | |
| 70 | If a mutable buffer is passed, then the behaviour is determined by the value of |
| 71 | the *mutate_flag* parameter. |
| 72 | |
| 73 | If it is false, the buffer's mutability is ignored and behaviour is as for a |
| 74 | read-only buffer, except that the 1024 byte limit mentioned above is avoided -- |
| 75 | so long as the buffer you pass is as least as long as what the operating system |
| 76 | wants to put there, things should work. |
| 77 | |
Georg Brandl | 71515ca | 2009-05-17 12:29:12 +0000 | [diff] [blame] | 78 | If *mutate_flag* is true (the default), then the buffer is (in effect) passed |
| 79 | to the underlying :func:`ioctl` system call, the latter's return code is |
| 80 | passed back to the calling Python, and the buffer's new contents reflect the |
| 81 | action of the :func:`ioctl`. This is a slight simplification, because if the |
| 82 | supplied buffer is less than 1024 bytes long it is first copied into a static |
| 83 | buffer 1024 bytes long which is then passed to :func:`ioctl` and copied back |
| 84 | into the supplied buffer. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 85 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 86 | An example:: |
| 87 | |
| 88 | >>> import array, fcntl, struct, termios, os |
| 89 | >>> os.getpgrp() |
| 90 | 13341 |
| 91 | >>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, " "))[0] |
| 92 | 13341 |
| 93 | >>> buf = array.array('h', [0]) |
| 94 | >>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1) |
| 95 | 0 |
| 96 | >>> buf |
| 97 | array('h', [13341]) |
| 98 | |
| 99 | |
| 100 | .. function:: flock(fd, op) |
| 101 | |
| 102 | Perform the lock operation *op* on file descriptor *fd* (file objects providing |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 103 | a :meth:`~io.IOBase.fileno` method are accepted as well). See the Unix manual |
Georg Brandl | ec80688 | 2009-06-04 10:23:20 +0000 | [diff] [blame] | 104 | :manpage:`flock(2)` for details. (On some systems, this function is emulated |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 105 | using :c:func:`fcntl`.) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 106 | |
| 107 | |
| 108 | .. function:: lockf(fd, operation, [length, [start, [whence]]]) |
| 109 | |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 110 | This is essentially a wrapper around the :func:`~fcntl.fcntl` locking calls. |
| 111 | *fd* is the file descriptor of the file to lock or unlock, and *operation* |
| 112 | is one of the following values: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 113 | |
| 114 | * :const:`LOCK_UN` -- unlock |
| 115 | * :const:`LOCK_SH` -- acquire a shared lock |
| 116 | * :const:`LOCK_EX` -- acquire an exclusive lock |
| 117 | |
| 118 | When *operation* is :const:`LOCK_SH` or :const:`LOCK_EX`, it can also be |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 119 | bitwise ORed with :const:`LOCK_NB` to avoid blocking on lock acquisition. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 120 | If :const:`LOCK_NB` is used and the lock cannot be acquired, an |
Antoine Pitrou | 62ab10a0 | 2011-10-12 20:10:51 +0200 | [diff] [blame] | 121 | :exc:`OSError` will be raised and the exception will have an *errno* |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 122 | attribute set to :const:`EACCES` or :const:`EAGAIN` (depending on the |
| 123 | operating system; for portability, check for both values). On at least some |
| 124 | systems, :const:`LOCK_EX` can only be used if the file descriptor refers to a |
| 125 | file opened for writing. |
| 126 | |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 127 | *length* is the number of bytes to lock, *start* is the byte offset at |
| 128 | which the lock starts, relative to *whence*, and *whence* is as with |
| 129 | :func:`io.IOBase.seek`, specifically: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 130 | |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 131 | * :const:`0` -- relative to the start of the file (:data:`os.SEEK_SET`) |
| 132 | * :const:`1` -- relative to the current buffer position (:data:`os.SEEK_CUR`) |
| 133 | * :const:`2` -- relative to the end of the file (:data:`os.SEEK_END`) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 134 | |
| 135 | The default for *start* is 0, which means to start at the beginning of the file. |
| 136 | The default for *length* is 0 which means to lock to the end of the file. The |
| 137 | default for *whence* is also 0. |
| 138 | |
| 139 | Examples (all on a SVR4 compliant system):: |
| 140 | |
| 141 | import struct, fcntl, os |
| 142 | |
| 143 | f = open(...) |
| 144 | rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY) |
| 145 | |
| 146 | lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0) |
| 147 | rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata) |
| 148 | |
| 149 | Note that in the first example the return value variable *rv* will hold an |
| 150 | integer value; in the second example it will hold a string value. The structure |
| 151 | lay-out for the *lockdata* variable is system dependent --- therefore using the |
| 152 | :func:`flock` call may be better. |
| 153 | |
| 154 | |
| 155 | .. seealso:: |
| 156 | |
| 157 | Module :mod:`os` |
Serhiy Storchaka | 926099d | 2013-10-09 14:20:22 +0300 | [diff] [blame] | 158 | If the locking flags :data:`~os.O_SHLOCK` and :data:`~os.O_EXLOCK` are |
| 159 | present in the :mod:`os` module (on BSD only), the :func:`os.open` |
| 160 | function provides an alternative to the :func:`lockf` and :func:`flock` |
| 161 | functions. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 162 | |