Linux inotify功能及实现原理

1. inotify主要功能

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

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

2. 用户接口

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

1. int fd = inotify_init (); 

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

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

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

1. int wd = inotify_add_watch (fd, path, mask); 

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

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

1. int ret = inotify_rm_watch (fd, wd); 

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

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

1. struct inotify_event { 
2.         __s32           wd;             /* watch descriptor */ 
3.         __u32           mask;           /* watch mask */ 
4.         __u32           cookie;         /* cookie to synchronize two events */ 
5.         __u32           len;            /* length (including nulls) of name */ 
6.         char            name[0];        /* stub for possible name */ 
7. };  

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

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

1. size_t len = read (fd, buf, BUF_LEN); 

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

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

1. int inotify_init (void); 
2.  
3. int inotify_add_watch (int fd, const char *path, __u32 mask); 
4.  
5. int inotify_rm_watch (int fd, __u32 mask);  

3. 内核实现原理

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

1. struct inotify_device { 
2.  
3. wait_queue_head_t wq; /* wait queue for i/o */ 
4.  
5. struct idr idr; /* idr mapping wd -> watch */ 
6.  
7. struct semaphore sem; /* protects this bad boy */ 
8.  
9. struct list_head events; /* list of queued events */ 
10.  
11. struct list_head watches; /* list of watches */ 
12.  
13. atomic_t count; /* reference count */ 
14.  
15. struct user_struct *user; /* user who opened this dev */ 
16.  
17. unsigned int queue_size; /* size of the queue (bytes) */ 
18.  
19. unsigned int event_count; /* number of pending events */ 
20.  
21. unsigned int max_events; /* maximum number of events */ 
22.  
23. u32 last_wd; /* the last wd allocated */ 
24.  
25. };  

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 结构中增加了两个字段：

1. struct inotify_watch { 
2.  
3. struct list_head d_list; /* entry in inotify_device's list */ 
4.  
5. struct list_head i_list; /* entry in inode's list */ 
6.  
7. atomic_t count; /* reference count */ 
8.  
9. struct inotify_device *dev; /* associated device */ 
10.  
11. struct inode *inode; /* associated inode */ 
12.  
13. s32 wd; /* watch descriptor */ 
14.  
15. u32 mask; /* event mask for this watch */ 
16.  
17. };  

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 结构中增加了两个字段：

1. #ifdef CONFIG_INOTIFY 
2.  
3. struct list_head inotify_watches; /* watches on this inode */ 
4.  
5. struct semaphore inotify_sem; /* protects the watches list */ 
6.  
7. #endif  

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 上。

4. 使用示例

下面是一个使用 inotify 来监视文件系统事件的例子：

1. #include  
2. #include  
3. #include  
4.  
5. _syscall0(int, inotify_init) 
6. _syscall3(int, inotify_add_watch, int, fd, const char *, path, __u32, mask) 
7. _syscall2(int, inotify_rm_watch, int, fd, __u32, mask) 
8.  
9. char * monitored_files[] = { 
10.     "./tmp_file", 
11.     "./tmp_dir", 
12.     "/mnt/sda3/windows_file" 
13. }; 
14.  
15. struct wd_name { 
16.     int wd; 
17.     char * name; 
18. }; 
19.  
20. #define WD_NUM 3 
21. struct wd_name wd_array[WD_NUM]; 
22.  
23. char * event_array[] = { 
24.     "File was accessed", 
25.     "File was modified", 
26.     "File attributes were changed", 
27.     "writtable file closed", 
28.     "Unwrittable file closed", 
29.     "File was opened", 
30.     "File was moved from X", 
31.     "File was moved to Y", 
32.     "Subfile was created", 
33.     "Subfile was deleted", 
34.     "Self was deleted", 
35.     "Self was moved", 
36.     "", 
37.     "Backing fs was unmounted", 
38.     "Event queued overflowed", 
39.     "File was ignored" 
40. }; 
41. #define EVENT_NUM 16 
42. #define MAX_BUF_SIZE 1024 
43.      
44. int main(void) 
45. { 
46.     int fd; 
47.     int wd; 
48.     char buffer[1024]; 
49.     char * offset = NULL; 
50.     struct inotify_event * event; 
51.     int len, tmp_len; 
52.     char strbuf[16]; 
53.     int i = 0; 
54.      
55.     fd = inotify_init(); 
56.     if (fd < 0) { 
57.         printf("Fail to initialize inotify.\n"); 
58.         exit(-1); 
59.     } 
60.  
61.     for (i=0; i<WD_NUM; wd="inotify_add_watch(fd," add (event- if { len) < buffer) - *)event (((char while *)buffer; inotify_event event len); len='%d.\n",' happens, printf(?Some offset="buffer;" MAX_BUF_SIZE)) buffer, while(len="read(fd," } wd_array[i].wd="wd;" exit(-1); wd_array[i].name); %s.\n?, for watch printf(?Can?t 0) (wd IN_ALL_EVENTS); wd_array[i].name, wd_array[i].name="monitored_files[i];" i++)>mask & IN_ISDIR) { 
62.                 memcpy(strbuf, "Direcotory", 11); 
63.             } 
64.             else { 
65.                 memcpy(strbuf, "File", 5); 
66.             } 
67.             printf("Object type: %s\n", strbuf); 
68.             for (i=0; iwd != wd_array[i].wd) continue; 
69.                 printf("Object name: %s\n", wd_array[i].name); 
70.                 break; 
71.             } 
72.             printf("Event mask: %08X\n", event->mask); 
73.             for (i=0; imask & (1<len; 
74.             event = (struct inotify_event *)(offset + tmp_len);  
75.             offset += tmp_len; 
76.         } 
77.     } 
78. }  

原文发布时间为：2017-10-11

本文作者:佚名

本文来自云栖社区合作伙伴“51CTO”，了解相关信息可以关注。