inotify有哪些API接口可以使用

Linux inotify 机制详解：实现文件系统实时监控的核心技术

在Linux操作系统环境下，若需实时捕获文件或目录的动态变化——例如文件创建、内容修改、属性更新或删除操作——内核提供的inotify（inode notify）机制是实现这一需求的权威解决方案。它相当于为文件系统安装了一个高效的“事件监听引擎”，使得应用程序能够即时感知并响应各类文件事件。下图系统性地展示了inotify的核心API接口及其相互关系：

下面，我们将对这些API进行逐一剖析，阐述它们如何协同构建一套稳定、高效的文件系统监控体系。

1. inotify_init()：初始化监控实例

一切监控操作始于创建一个inotify实例。inotify_init()函数负责完成此任务，它在内核中初始化一个inotify实例，并返回一个与之关联的文件描述符。此描述符是后续所有监控操作的枢纽。调用成功则返回一个有效的文件描述符；若返回-1，则表明初始化失败，通常需要检查系统资源限制（如打开文件数上限）或调用进程的权限。

2. inotify_init1(int flags)：支持附加标志的初始化

这是inotify_init()的增强版本，额外接受一个flags参数，允许在初始化时设置特定的行为标志。例如，传递IN_NONBLOCK标志可使得返回的文件描述符立即处于非阻塞模式，这对于基于事件循环或异步I/O的编程模型尤为便利。其返回值语义与inotify_init()完全相同。

3. inotify_add_watch(int fd, const char *path, uint32_t mask)：添加监控目标与事件

实例创建后，需指定监控的具体目标路径及关心的事件类型。这正是inotify_add_watch函数的核心功能。

• fd：由inotify_init或inotify_init1返回的文件描述符，标识要操作的监控实例。
• path：指向待监控文件或目录路径的字符串，通常需为绝对路径。
• mask：事件掩码，通过位或运算符组合多种事件标志，以精确定义监控范围。常用标志包括IN_CREATE（文件/目录创建）、IN_DELETE（删除）、IN_MODIFY（内容修改）、IN_ATTRIB（元数据变更）等。

函数成功执行后，会返回一个唯一的监控描述符（Watch Descriptor），用于标识该监控项；失败则返回-1。

4. read(int fd, struct inotify_event *event, size_t len)：读取监控事件

配置好监控后，内核会将发生在监控目标上的事件放入与文件描述符关联的队列中。应用程序通过标准的read系统调用从该描述符读取事件（inotify实例本身是一个可读的文件描述符）。

• fd：inotify实例的文件描述符。
• event：指向用户提供的缓冲区，用于接收inotify_event结构体数据。
• len：缓冲区的长度，应足够容纳至少一个完整的事件结构及可能的文件名。

调用成功返回实际读取的字节数；失败返回-1。需要注意的是，一次read调用可能返回多个事件，应用程序需循环解析缓冲区中的数据。

5. inotify_rm_watch(int fd, int wd)：移除监控项

当不再需要监控某个特定路径时，应调用此函数移除对应的监控项以释放内核资源。

• fd：inotify实例的文件描述符。
• wd：要移除的监控描述符，即inotify_add_watch成功时的返回值。

移除成功返回0，失败返回-1。

6. close(int fd)：关闭监控实例

所有监控任务结束后，应使用close系统调用关闭inotify文件描述符。这是一个必要的资源清理步骤，会释放内核中与该实例相关的所有资源（包括所有未移除的监控项）。参数为待关闭的文件描述符fd，成功返回0，失败返回-1。

inotify_event 结构体：事件详情解析

inotify_event结构体是传递事件信息的数据载体，其定义如下：

struct inotify_event {
int wd; /* Watch descriptor */
uint32_t mask;/* Mask describing event */
uint32_t cookie;/* Unique cookie associating related events (for rename(2)) */
uint32_t len; /* Size of name field */
char name[];/* Optional null-terminated name */
};

各字段含义详解：

• wd：触发此事件的监控描述符，用于关联到具体的监控路径。
• mask：详细的事件类型掩码，标识具体发生了什么操作（如IN_CREATE、IN_MODIFY）。
• cookie：用于关联多个相关事件的唯一标识符。典型应用是文件重命名操作（rename），会生成一对分别对应旧名称移除和新名称创建的、具有相同cookie值的事件。
• len：紧随结构体后的name字段的实际长度（字节数）。
• name：一个柔性数组，存放触发事件的文件或目录的名称。注意：当监控的是一个目录时，此字段为目录内发生变化的子项名称；若监控的是单个文件，且事件不涉及路径名，则此字段可能为空（len为0）。

实战示例：监控目录文件变化

结合上述API，以下C语言示例程序演示了如何监控指定目录下的文件创建、删除和修改事件：

#include 
#include 
#include 
#include 
#include 

#define EVENT_SIZE( sizeof (struct inotify_event) )
#define BUF_LEN ( 1024 * ( EVENT_SIZE + 16 ) )

int main(int argc, char **argv) {
int length, i = 0;
int fd;
int wd;
char buffer[BUF_LEN];

fd = inotify_init();
if (fd < 0) {
perror("inotify_init");
}

wd = inotify_add_watch(fd, "/path/to/directory", IN_CREATE | IN_DELETE | IN_MODIFY);
if (wd < 0) {
perror("inotify_add_watch");
}

length = read(fd, buffer, BUF_LEN);
if (length < 0) {
perror("read");
}

while (i < length) {
struct inotify_event *event = (struct inotify_event *) &buffer[i];
if (event->len) {
if (event->mask & IN_CREATE) {
printf("File %s was created.\n", event->name);
}
if (event->mask & IN_DELETE) {
printf("File %s was deleted.\n", event->name);
}
if (event->mask & IN_MODIFY) {
printf("File %s was modified.\n", event->name);
}
}
i += EVENT_SIZE + event->len;
}

(void) inotify_rm_watch(fd, wd);
(void) close(fd);
return 0;
}

使用时，请将代码中的/path/to/directory替换为实际需要监控的目录绝对路径，并可灵活调整inotify_add_watch中的事件掩码以监控不同事件类型。编译运行此程序，即可在终端实时查看目标目录下的文件变动日志。