监控文件事件

有时应用程序需要对某个文件或目录进行监控，以便判断是否发生了特定事件，比如文件删除、新增、修改等。典型例子就是文件管理应用。Linux自内核2.6.13起提供inotify机制供应用程序监控文件事件。

1、概述

使用inotify API有以下关键步骤：

1. 使用inotify_init()创建一个inotify实例，返回的文件描述符用于后续操作中指代该实例。

2. 使用inotify_add_watch向inotify实例的监控列表添加条目，即添加应用感兴趣的文件或目录。每个监控项包含一个路径名及相关的位掩码，位掩码指明所要监控的事件。inotify_add_watch将返回一个监控描述符，用于后续操作指代该监控项（inotify_rm_watch移除监控项）。

3. 应用需要对inotify文件描述符执行read()操作以获取事件通知，read()调用会返回一个或多个inotify_event结构，记录了所发生的事件。

4. 应用结束时关闭inotify描述符，这会自动清除与inotify实例相关的所有监控项。

  inotify可用于监控文件或目录。监控目录时，与路径自身及其所含文件相关的事件都会通知应用程序。

  inofity为非递归的，若想监控目录下整个目录树，需要对目录树下每个目录发起inotify_add_watch调用。

2、API

#include <sys/inotify.h>

int inotify_init(void);

int inotify_add_watch(int fd, const char *pathname, uint32_t mask);

int inotify_rm _watch(int fd, uint32_t wd);

3、inotify事件

  使用inotify_add_watch添加、修改监控项时，位掩码参数mask标识了针对 给定路径名要监控的事件。下表中“in”列列出了可以mask中定义的事件位。

位值	In	Out	描述
IN_ACCESS	*	*	文件被访问(read)
IN_ATTRIB	*	*	文件元数据改变
IN_CLOSE_WRITE	*	*	关闭为了写入而打开的文件
IN_CLOSE_NOWRITE	*	*	关闭以只读方式打开的文件
IN_CREATE	*	*	在受监控目录内创建了文件/目录
IN_DELETE	*	*	在受监控目录内删除了文件/目录
IN_DELETE_SELF	*	*	删除受监控目录/文件本身
IN_MODIFY	*	*	文件被修改
IN_MOVE_SELF	*	*	移动受监控目录/文件本身
IN_MOVED_FROM	*	*	文件移出受监控目录之外
IN_MOVED_TO	*	*	将文件移入受监控目录
IN_OPEN	*	*	文件被打开
IN_ALL_EVENTS	*		以上所有输出事件的统称
IN_MOVE	*		IN_MOVED_FORM/IN_MOVED_TO事件统称
IN_CLOSE	*		IN_CLOSE_WRITE/IN_CLOSE_NOWRITE事件统称
IN_DONT_FOLLOW	*		不对符号链接解引用
IN_MASK_ADD	*		将事件追加到当前掩码
IN_ONESHOT	*		只监控一个事件
IN_ONLYDIR	*		pathname不为目录时会失败
IN_IGNORED		*	监控项为内核或应用所移除
IN_ISDIR		*	name中所返回的文件为路径
IN_Q_OVERFLOW		*	事件队列溢出
IN_UNMOUNT		*	包含对象的文件系统遭卸载

4、读取inotify事件

  在监控列表中添加监控项后，应用程序可用read从inotify文件描述符中读取事件，以判定发生了哪些事件。若读取时还没有事件发生，read将阻塞直到事件发生（除非设置O_NONBLOCK标志）。

  事件发生后，每次调用read会返回一个缓冲区，包含一个或多个如下类型的结构：

struct inotify_event {
    int wd;  //Watch descriptor on which event occurred
    uint32_t mask;  //Bits describing event that occurred
    uint32_t cookie;  //Cookie for related events(for rename())
    uint32_t len;  //Size of 'name' field
    char name[];  //Optional null-terminated filename
}

5、sample code

#include <sys/inotify.h>
#include <limits.h>
#include <stdio.h>
#include <unistd.h>

#define BUF_LEN (10 * (sizeof(struct inotify_event) + NAME_MAX + 1))
static int index = 1;
void displayInotifyEvent(struct inotify_event *event)
{
    printf("%d. ", index++);
    if(event->mask & IN_ACCESS)        printf("mask = IN_ACCESS  ");
    if(event->mask & IN_ATTRIB)        printf("mask = IN_ATTRIB  ");
    if(event->mask & IN_CLOSE_NOWRITE) printf("mask = IN_CLOSE_NOWRITE  ");
    if(event->mask & IN_CLOSE_WRITE)   printf("mask = IN_CLOSE_WRITE  ");
    if(event->mask & IN_CREATE)        printf("mask = IN_CREATE  ");
    if(event->mask & IN_DELETE)        printf("mask = IN_DELETE  ");
    if(event->mask & IN_DELETE_SELF)   printf("mask = IN_DELETE_SELF  ");
    if(event->mask & IN_IGNORED)       printf("mask = IN_IGNORED  ");
    if(event->mask & IN_ISDIR)         printf("mask = IN_ISDIR  ");
    if(event->mask & IN_MODIFY)        printf("mask = IN_MODIFY  ");
    if(event->mask & IN_MOVE_SELF)     printf("mask = IN_MOVE_SELF  ");
    if(event->mask & IN_MOVED_FROM)    printf("mask = IN_MOVED_FROM  ");
    if(event->mask & IN_MOVED_TO)      printf("mask = IN_MOVED_TO  ");
    if(event->mask & IN_OPEN)          printf("mask = IN_OPEN");
    if(event->mask & IN_Q_OVERFLOW)    printf("mask = IN_Q_OVERFLOW  ");
    if(event->mask & IN_UNMOUNT)       printf("mask = IN_UNMOUNT  ");

    if(event->len > 0)
    {
        printf("name = %s\n", event->name);
    }
    else 
    {
        printf("\n");
    }
}

int main(int argc, char *argv[])
{
    char buf[BUF_LEN];
    struct inotify_event *event;

    if(argc < 2)
    {
        printf("Usage: %s pathname.\n", argv[0]);
        return 0;
    }

    int inotifyFd = inotify_init();
    if(inotifyFd == -1)
    {
        printf("inotify_init failed.\n");
        return 0;
    }

    int wd = inotify_add_watch(inotifyFd, argv[1], IN_ALL_EVENTS);
    if(wd == -1)
    {
        printf("inotify_add_watch failed.\n");
        return 0;
    }

    for(;;)
    {
        int numRead = read(inotifyFd, buf, BUF_LEN);
        if(numRead == 0)
        {
            printf("read from inotify fd return 0.\n");
            return 0;
        }

        char *p = NULL;
        for(p = buf; p < buf + numRead;)
        {
            event = (struct inotify_event*)p;
            displayInotifyEvent(event);
            p += sizeof(struct inotify_event) + event->len;
        }
    }

    return 0;
}

运行结果：