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)