Linux 文件操作监控inotify功能及实现原理

1. inotify主要功能

它是一个内核用于通知用户空间程序文件系统变化的机制。

众所周知，Linux 桌面系统与 MAC 或 Windows 相比有许多不如人意的地方，为了改善这种状况，开源社区提出用户态需要内核提供一些机制，以便用户态能够及时地得知内核或底层硬件设备发生了什么，从而能够更好地管理设备，给用户提供更好的服务，如hotplug、udev和 inotify 就是这种需求催生的。Hotplug 是一种内核向用户态应用通报关于热插拔设备一些事件发生的机制，桌面系统能够利用它对设备进行有效的管理，udev动态地维护 /dev 下的设备文件，inotify 是一种文件系统的变化通知机制，如文件增加、删除等事件可以立刻让用户态得知，该机制是著名的桌面搜索引擎项目beagle 引入的，并在Gamin 等项目中被应用。
缺点只能单独监控一个目录或文件，不能监控目录下的所有子目录，想要监控子目录必须得自己通过递归的方法将所有目录都添加到监控中去

2.用户接口

在用户态，inotify 通过三个系统调用和在返回的文件描述符上的文件I/ 操作来使用，使用inotify 的第一步是创建inotify 实例：

    每一个 inotify 实例对应一个独立的排序的队列。

    文件系统的变化事件被称做 watches 的一个对象管理，每一个 watch 是一个二元组（目标，事件掩码），目标可以是文件或目录，事件掩码表示应用希望关注的inotify 事件，每一个位对应一个inotify 事件。Watch对象通过 watch描述符引用，watches 通过文件或目录的路径名来添加。目录watches 将返回在该目录下的所有文件上面发生的事件。

    下面函数用于添加一个 watch：

 

    fd 是inotify_init() 返回的文件描述符，path是被监视的目标的路径名（即文件名或目录名），mask是事件掩码, 在头文件 linux/inotify.h中定义了每一位代表的事件。可以使用同样的方式来修改事件掩码，即改变希望被通知的inotify事件。Wd 是 watch 描述符。

    下面的函数用于删除一个 watch：

    fd 是 inotify_init() 返回的文件描述符，wd 是 inotify_add_watch() 返回的 watch 描述符。Ret 是函数的返回值。

 

    文件事件用一个 inotify_event 结构表示，它通过由 inotify_init() 返回的文件描述符使用通常文件读取函数 read 来获得

    结构中的 wd 为被监视目标的 watch 描述符，mask 为事件掩码，len 为 name字符串的长度，name 为被监视目标的路径名，该结构的 name 字段为一个桩，它只是为了用户方面引用文件名，文件名是变长的，它实际紧跟在该结构的后面，文件名将被 0 填充以使下一个事件结构能够 4 字节对齐。注意，len 也把填充字节数统计在内。

 

    通过 read 调用可以一次获得多个事件，只要提供的 buf 足够大。

    buf 是一个inotify_event 结构的数组指针，BUF_LEN指定要读取的总长度，buf大小至少要不小于BUF_LEN，该调用返回的事件数取决于BUF_LEN 以及事件中文件名的长度。Len为实际读去的字节数，即获得的事件的总长度。

    可以在函数inotify_init() 返回的文件描述符fd 上使用 select()或poll(), 也可以在 fd 上使用 ioctl 命令 FIONREAD来得到当前队列的长度。close(fd)将删除所有添加到 fd 中的 watch 并做必要的清理。

3. 内核实现原理

 在内核中，每一个 inotify 实例对应一个inotify_device 结构：

    d_list 指向所有inotify_device 组成的列表的，i_list指向所有被监视 inode 组成的列表，count 是引用计数，dev 指向该 watch 所在的 inotify 实例对应的inotify_device 结构，inode指向该 watch 要监视的 inode，wd 是分配给该 watch 的描述符，mask 是该 watch 的事件掩码，表示它对哪些文件系统事件感兴趣。

    结构inotify_device 在用户态调用inotify_init（）时创建，当关闭inotify_init（）返回的文件描述符时将被释放。结构inotify_watch 在用户态调用inotify_add_watch（）时创建，在用户态调用inotify_rm_watch（）或 close（fd）时被释放。

    无论是目录还是文件，在内核中都对应一个inode 结构，inotify系统在 inode 结构中增加了两个字段：

    d_list 指向所有inotify_device 组成的列表的，i_list指向所有被监视 inode 组成的列表，count 是引用计数，dev 指向该 watch 所在的 inotify 实例对应的inotify_device 结构，inode指向该 watch 要监视的 inode，wd 是分配给该 watch 的描述符，mask 是该 watch 的事件掩码，表示它对哪些文件系统事件感兴趣。

    结构inotify_device 在用户态调用inotify_init（）时创建，当关闭inotify_init（）返回的文件描述符时将被释放。结构inotify_watch 在用户态调用inotify_add_watch（）时创建，在用户态调用inotify_rm_watch（）或 close（fd）时被释放。

    无论是目录还是文件，在内核中都对应一个inode 结构，inotify系统在 inode 结构中增加了两个字段：

   inotify_watches 是在被监视目标上的watch 列表，每当用户调用inotify_add_watch（）时，内核就为添加的watch 创建一个inotify_watch 结构，并把它插入到被监视目标对应的inode 的inotify_watches 列表。inotify_sem用于同步对inotify_watches 列表的访问。当文件系统发生第一部分提到的事件之一时，相应的文件系统代码将显示调用fsnotify_*来把相应的事件报告给inotify 系统，其中*号就是相应的事件名，目前实现包括：

   fsnotify_move，文件从一个目录移动到另一个目录fsnotify_nameremove，文件从目录中删除fsnotify_inoderemove，自删除fsnotify_create，创建新文件fsnotify_mkdir，创建新目录fsnotify_access，文件被读fsnotify_modify，文件被写fsnotify_open，文件被打开fsnotify_close，文件被关闭fsnotify_xattr，文件的扩展属性被修改fsnotify_change，文件被修改或原数据被修改有一个例外情况，就是inotify_unmount_inodes，它会在文件系统被umount 时调用来通知umount 事件给inotify 系统。

    以上提到的通知函数最后都调用inotify_inode_queue_event（inotify_unmount_inodes直接调用inotify_dev_queue_event ），该函数首先判断对应的inode是否被监视，这通过查看inotify_watches 列表是否为空来实现，如果发现inode 没有被监视，什么也不做，立刻返回，反之，遍历inotify_watches 列表，看是否当前的文件操作事件被某个watch 监视，如果是，调用inotify_dev_queue_event，否则，返回。函数inotify_dev_queue_event首先判断该事件是否是上一个事件的重复，如果是就丢弃该事件并返回，否则，它判断是否inotify 实例即inotify_device 的事件队列是否溢出，如果溢出，产生一个溢出事件，否则产生一个当前的文件操作事件，这些事件通过kernel_event构建，kernel_event将创建一个inotify_kernel_event 结构，然后把该结构插入到对应的inotify_device 的events 事件列表，然后唤醒等待在inotify_device结构中的 wq 指向的等待队列。想监视文件系统事件的用户态进程在inotify实例（即inotify_init（）返回的文件描述符）上调用 read 时但没有事件时就挂在等待队列wq 上。