36.10. fcntl — fcntl 和 ioctl 系统调用 — Python 文档

来自菜鸟教程
Python/docs/2.7/library/fcntl
跳转至:导航、​搜索

36.10. fcntl - 这fcntl和ioctl系统调用

该模块对文件描述符执行文件控制和 I/O 控制。 它是 fcntl()ioctl() Unix 例程的接口。 有关这些调用的完整说明,请参阅 fcntl(2)ioctl(2) Unix 手册页。

该模块中的所有函数都将文件描述符 fd 作为它们的第一个参数。 这可以是一个整数文件描述符,例如由 sys.stdin.fileno() 返回,也可以是一个文件对象,例如 sys.stdin 本身,它提供了一个 fileno(),它返回一个真正的文件描述符。

该模块定义了以下功能:

fcntl.fcntl(fd, op[, arg])

对文件描述符 fd 执行操作 op(也接受提供 fileno() 方法的文件对象)。 用于 op 的值取决于操作系统,并且在 fcntl 模块中作为常量提供,使用与相关 C 头文件中使用的名称相同的名称。 参数 arg 是可选的,默认为整数值 0。 如果存在,它可以是整数值或字符串。 缺少参数或整数值时,此函数的返回值是 C fcntl() 调用的整数返回值。 当参数是一个字符串时,它表示一个二进制结构,例如 由 struct.pack() 创建。 二进制数据被复制到一个缓冲区,其地址被传递给 C fcntl() 调用。 调用成功后的返回值是缓冲区的内容,转换为字符串对象。 返回字符串的长度将与 arg 参数的长度相同。 这被限制为 1024 字节。 如果操作系统在缓冲区中返回的信息大于 1024 字节,这很可能导致分段违规或更细微的数据损坏。

如果 fcntl() 失败,则会引发 IOError

fcntl.ioctl(fd, op[, arg[, mutate_flag]])

该函数与 fcntl() 函数相同,不同之处在于操作通常在库模块 termios 中定义,并且参数处理更加复杂。

op 参数仅限于可以容纳 32 位的值。 可以在 termios 模块中找到用作 op 参数的其他感兴趣的常量,其名称与相关 C 头文件中使用的名称相同。

参数 arg 可以是整数、不存在(与整数 0 相同对待)、支持只读缓冲区接口的对象(很可能是纯 Python 字符串)或支持读写缓冲区接口的对象。

除了最后一种情况外,所有行为都与 fcntl() 函数相同。

如果传递了可变缓冲区,则行为由 mutate_flag 参数的值决定。

如果为 false,则缓冲区的可变性将被忽略,行为与只读缓冲区相同,只是避免了上面提到的 1024 字节限制——只要你传递的缓冲区至少与操作系统想要的一样长放在那里,事情应该工作。

如果 mutate_flag 为真,则缓冲区(实际上)传递给底层 ioctl() 系统调用,后者的返回代码传递回调用 Python,缓冲区的新内容反映了 ioctl() 的操作。 这是一个轻微的简化,因为如果提供的缓冲区长度小于 1024 字节,则首先将其复制到 1024 字节长的静态缓冲区中,然后将其传递给 ioctl() 并复制回提供的缓冲区中。

如果未提供 mutate_flag,则从 Python 2.5 开始,它默认为 true,这是从 2.3 和 2.4 版本的更改。 如果版本可移植性是优先事项,则明确提供参数。

如果 ioctl() 失败,则会引发 IOError 异常。

一个例子:

>>> import array, fcntl, struct, termios, os
>>> os.getpgrp()
13341
>>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0]
13341
>>> buf = array.array('h', [0])
>>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1)
0
>>> buf
array('h', [13341])
fcntl.flock(fd, op)

对文件描述符 fd 执行锁定操作 op(也接受提供 fileno() 方法的文件对象)。 有关详细信息,请参阅 Unix 手册 flock(2)。 (在某些系统上,使用 fcntl() 模拟此功能。)

如果 flock() 失败,则会引发 IOError 异常。

fcntl.lockf(fd, operation[, length[, start[, whence]]])

这本质上是对 fcntl() 锁定调用的封装。 fd 是要锁定或解锁的文件的文件描述符,operation 是以下值之一:

  • LOCK_UN – 解锁

  • LOCK_SH – 获取共享锁

  • LOCK_EX – 获取排他锁

操作LOCK_SHLOCK_EX时,也可以与LOCK_NB进行按位或运算,避免锁获取阻塞。 如果使用 LOCK_NB 并且无法获取锁,则会引发 IOError 并且异常会将 errno 属性设置为 EACCES 或 [ X158X](取决于操作系统;为了可移植性,请检查两个值)。 至少在某些系统上,LOCK_EX 只能在文件描述符引用为写入而打开的文件时使用。

length 是要锁定的字节数,start 是锁定开始的字节偏移量,相对于 whencewhenceio.IOBase.seek() 一样,特别是:

start 的默认值为 0,表示从文件的开头开始。 length 的默认值为 0,表示锁定到文件末尾。 whence 的默认值也是 0。

示例(均在 SVR4 兼容系统上):

import struct, fcntl, os

f = open(...)
rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)

lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0)
rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)

请注意,在第一个示例中,返回值变量 rv 将保存一个整数值; 在第二个示例中,它将保存一个字符串值。 lockdata 变量的结构布局取决于系统——因此使用 flock() 调用可能更好。

也可以看看

模块 os
如果锁定标志 O_SHLOCKO_EXLOCK 存在于 os 模块中(仅在 BSD 上),则 os.open() 函数提供了 lockf()flock() 函数的替代方法。