fcntl() - Unix，Linux系统调用

名称

fcntl - 操作文件描述符

概要

#include <unistd.h> 
#include <fcntl.h> 

int fcntl(int fd, int cmd); 
int fcntl(int fd, int cmd, long arg); 
int fcntl(int fd, int cmd, struct flock *lock); 

描述

fcntl() 对打开的文件描述符 fd 执行以下描述的操作之一。操作由 cmd 确定。

复制文件描述符

文件描述符标志

以下命令操作与文件描述符关联的标志。目前，只定义了一个这样的标志：FD_CLOEXEC，即关闭执行标志。如果FD_CLOEXEC 位为 0，则文件描述符将在execve(2) 中保持打开状态，否则它将被关闭。

文件状态标志

每个打开的文件描述符都有一些关联的状态标志，由open(2) 初始化，并可能由fcntl(2) 修改。复制的文件描述符（由dup()、fcntl(F_DUPFD)、fork() 等创建）引用相同的文件描述符，因此共享相同的文件状态标志。

文件状态标志及其语义在open(2) 中进行了描述。

建议锁

F_GETLK、F_SETLK 和F_SETLKW 用于获取、释放和测试记录锁（也称为文件段锁或文件区域锁）的存在。第三个参数 lock 是指向至少具有以下字段（顺序未指定）的结构体的指针。

struct flock {
    ...
    short l_type;    /* Type of lock: F_RDLCK,
                        F_WRLCK, F_UNLCK */
    short l_whence;  /* How to interpret l_start:
                        SEEK_SET, SEEK_CUR, SEEK_END */
    off_t l_start;   /* Starting offset for lock */
    off_t l_len;     /* Number of bytes to lock */
    pid_t l_pid;     /* PID of process blocking our lock
                        (F_GETLK only) */
    ...
};

此结构体的 l_whence、l_start 和 l_len 字段指定我们希望锁定的字节范围。l_start 是锁定的起始偏移量，相对于以下任何一个进行解释：文件的开头（如果 l_whence 为SEEK_SET）；当前文件偏移量（如果 l_whence 为SEEK_CUR）；或文件的结尾（如果 l_whence 为SEEK_END）。在最后两种情况下，只要偏移量不位于文件的开头之前，l_start 可以为负数。l_len 是一个非负整数（但请参见下面的注释），指定要锁定的字节数。可以锁定文件末尾之后的字节，但不能锁定文件开头之前的字节。将 l_len 指定为 0 具有特殊含义：锁定从 l_whence 和 l_start 指定的位置开始到文件结尾的所有字节，无论文件增长多大。

l_type 字段可以用于在文件上放置读锁（F_RDLCK）或写锁（F_WRLCK）。任何数量的进程都可以在文件区域上持有读锁（共享锁），但只有一个进程可以持有写锁（独占锁）。独占锁排斥所有其他锁，包括共享锁和独占锁。单个进程只能在一个文件区域上持有锁的一种类型；如果将新的锁应用于已锁定的区域，则现有锁将转换为新的锁类型。（如果新锁指定的字节范围与现有锁的范围不完全一致，则此类转换可能涉及拆分、缩小或与现有锁合并。）

为了放置读锁，fd 必须以读取模式打开。为了放置写锁，fd 必须以写入模式打开。要放置两种类型的锁，请以读写模式打开文件。

记录锁除了通过显式的F_UNLCK删除外，还会在进程终止或关闭任何引用持有锁的文件的文件描述符时自动释放。这很糟糕：这意味着进程可能会丢失对诸如 /etc/passwd 或 /etc/mtab 等文件上的锁，因为某些库函数决定打开、读取和关闭它。

记录锁不会被通过fork(2) 创建的子进程继承，但会保留在execve(2) 中。

由于stdio(3) 库执行了缓冲，因此应避免在该包中的例程中使用记录锁定；而应该使用read(2) 和write(2)。

强制锁定

建议锁不会被强制执行，仅在合作进程之间有用。

强制锁对所有进程强制执行。如果进程试图对具有不兼容强制锁的文件区域执行不兼容的访问（例如，read(2) 或write(2)），则结果取决于其打开的文件描述符是否启用了O_NONBLOCK标志。如果未启用O_NONBLOCK标志，则系统调用将被阻塞，直到锁被移除或转换为与访问兼容的模式。如果启用了O_NONBLOCK标志，则系统调用将失败，并出现EAGAIN或EWOULDBLOCK错误。

要使用强制锁，必须在包含要锁定的文件的系统和文件本身上启用强制锁定。使用mount(8) 的“-o mand”选项或mount(2) 的MS_MANDLOCK标志可以在文件系统上启用强制锁定。通过禁用文件的组执行权限并启用设置组 ID 权限位（请参见chmod(1) 和chmod(2)）可以在文件上启用强制锁定。

管理信号

F_GETOWN、F_SETOWN、F_GETSIG 和F_SETSIG 用于管理 I/O 可用性信号

使用这些机制，程序可以实现完全异步的 I/O，而无需大多数时候使用select(2) 或poll(2)。

O_ASYNC、F_GETOWN、F_SETOWN 的使用特定于 BSD 和 Linux。F_GETSIG 和F_SETSIG 是 Linux 特定的。POSIX 具有异步 I/O 和aio_sigevent 结构来实现类似的功能；这些功能也作为 GNU C 库 (Glibc) 的一部分在 Linux 中可用。

租约

当进程（“租约破坏者”）执行与通过F_SETLEASE 建立的租约冲突的open() 或truncate() 时，系统调用将被内核阻塞，并且内核通过向其发送信号（默认情况下为 SIGIO）来通知租约持有者。租约持有者应该响应收到此信号，执行准备让另一个进程访问文件所需的任何清理工作（例如，刷新缓存缓冲区），然后删除或降低其租约。通过执行指定arg 为F_UNLCK 的F_SETLEASE 命令来删除租约。如果我们当前在文件上持有写入租约，并且租约破坏者正在打开文件以进行读取，那么将租约降低到读取租约就足够了。这是通过执行指定arg 为F_RDLCK 的F_SETLEASE 命令来完成的。

如果租约持有者未能在/proc/sys/fs/lease-break-time中指定的时间（秒）内降低或删除租约，则内核将强制删除或降低租约持有者的租约。

一旦租约被自愿或强制删除或降低，并且假设租约破坏者尚未取消其系统调用的阻塞，内核就会允许租约破坏者的系统调用继续进行。

如果租约破坏者的阻塞open() 或truncate() 被信号处理程序中断，则系统调用将失败并出现EINTR错误，但其他步骤仍按上述说明进行。如果租约破坏者在open() 或truncate() 中被阻塞时被信号杀死，则其他步骤仍按上述说明进行。如果租约破坏者在调用open() 时指定了O_NONBLOCK标志，则调用将立即失败并出现EWOULDBLOCK错误，但其他步骤仍按上述说明进行。

用于通知租约持有者的默认信号是 SIGIO，但这可以使用fcntl() 的F_SETSIG 命令更改。如果执行了F_SETSIG 命令（甚至指定 SIGIO 的命令），并且使用 SA_SIGINFO 建立了信号处理程序，则处理程序将接收siginfo_t 结构作为其第二个参数，并且此参数的si_fd 字段将保存已被另一个进程访问的租约文件的描述符。（如果调用者对多个文件持有租约，这将很有用。）

文件和目录更改通知 (dnotify)

返回值

对于成功的调用，返回值取决于操作

发生错误时，返回 -1，并相应地设置errno。

错误

注释

dup2()返回的错误与F_DUPFD返回的错误不同。

自内核2.0以来，flock(2)和fcntl(2)放置的锁的类型之间没有交互。

POSIX.1-2001允许l_len为负数。（如果是负数，则锁描述的区间覆盖从l_start+l_len到l_start-1的字节。）Linux从Linux 2.4.21和2.5.49开始支持此功能。

一些系统在struct flock中具有更多字段，例如l_sysid。显然，如果持有锁的进程可能位于不同的机器上，则仅l_pid将不太有用。

错误

某些架构（特别是x86）上的Linux系统调用约定存在一个限制，这意味着如果F_GETOWN返回的（负）进程组ID落在-1到-4095的范围内，则glibc会错误地将其解释为系统调用中的错误；也就是说，fcntl()的返回值将为-1，而errno将包含（正）进程组ID。

在Linux 2.4及更早版本中，当非特权进程使用F_SETOWN将套接字文件描述符的所有者指定为调用者以外的进程（组）时，可能会出现错误。在这种情况下，fcntl()可能会返回-1，并将errno设置为EPERM，即使所有者进程（组）是调用者有权向其发送信号的进程（组）。尽管返回此错误，但文件描述符所有者已设置，并且信号将发送到所有者。

符合标准

SVr4, 4.3BSD, POSIX.1-2001。只有F_DUPFD、F_GETFD、F_SETFD、F_GETFL、F_SETFL、F_GETLK、F_SETLK、F_SETLKW、F_GETOWN和F_SETOWN操作在POSIX.1-2001中指定。

F_GETSIG、F_SETSIG、F_NOTIFY、F_GETLEASE和F_SETLEASE是Linux特有的。（定义_GNU_SOURCE宏以获得这些定义。）

另请参见

• dup2 (2)

• flock (2)

• open (2)

• socket (2)