Linux inotify使用
简介
inotify是linux上提供的文件系统监视机制, 前身是dnotify. 可以用来监视文件/目录. 如文件/目录的修改, 删除等. 前身是dnotify
为什么inotify取代了dnotify?
- inotify使用一个文件描述符, dnotify需要为每一个受监控的目录打开一个fd, 当监控数量变多, dnotify会消耗大量资源, 并且进程也存在最大描述符限制.
- 在可移动媒体相关: inotify的fd可以通过syscall获得, 并且不会和设备/文件相关联, dnotify的fd会锁定目录, 导致设备无法卸载(比如关联了移动设备, 除非你关掉fd, 否则你无法从你的设备上卸载移动设备), 如果使用inotify监控被卸载文件系统上的文件, 当你卸载设备时, inotify的watch会被自动移除, 并且使用者会收到一个umount事件.
- inotify使用fd作为基本接口, 意味着我们可以在其上使用select/epoll来更好的监控, but, dnotify使用SIGIO(我也不懂).
API
inotify_init
创建实例, 返回值为创建的文件描述符.
#include <sys/inotify.h>
int inotify_init(void);
int inotify_init1(int flags);
inotify_add_watch
上面实例创建的文件描述符关联一个独立的队列, 文件系统的变化被叫做"watch"的来管理, 每一个watch包含目标, 和事件掩码, 目标可以是文件/目录. 掩码代表希望关注的事件,
#include <sys/inotify.h>
int inotify_add_watch(int fd, const char *pathname, uint32_t mask);
fd为创建的inotify文件描述符, 即inotify_init的返回值, pathname为你想关联的目录/文件, mask是事件掩码, 范围值是被称为"wd"的watch描述符, 他关联着对应的文件/目录
inotify_rm_watch
下面的函数用于删除一个watch
#include <sys/inotify.h>
int inotify_rm_watch(int fd, int wd);
fd为文件描述符, wd为watch描述符, 成功返回0 , 失败返回-1, 并且设置errno.
事件掩码
- IN_ACCESS:文件 被访问时 触发事件,例如 read,execve
- IN_ATTRIB:文件属性 发生变化 触发事件。例如 权限 chmod,时间戳 setxattr,链接数 link 等
- IN_CLOSE_WRITE:一个文件被打开 写入操作结束,文件被关闭时 触发事件
- IN_CLOSE_NOWRITE:一个文件被打开 没有任何写操作,文件被关闭时 触发事件
- IN_CREATE:在监控列表下 创建一个文件或目录 时 触发事件,例如 open O_CREAT,mkdir 等
- IN_DELETE:在监控列表下 文件或目录 被删除时 触发事件
- IN_DELETE_SELF:监控文件或目录 本身被删除时 触发事件,而且,如果一个文件或目录被移到其它地方,比如使用 mv 命令,也会触发该事件,因为 mv 命令本质上是拷贝一份当前文件,然后删除当前文件的操作。此时监控终止,并且将收到一个 IN_IGNORED 事件。
- IN_MODIFY:文件 被修改时 触发事件,例如:有写操作(write)或者文件内容被清空(truncate)操作。不过需要注意的是,IN_MODIFY 可能会连续触发多次。
- IN_MODIFY_SELF:所监控的文件或目录本身 发生移动时 触发事件
- IN_MOVED_FROM:将文件或目录 移除 监控列表 触发事件
- IN_MOVED_TO:将文件或目录 移入 监控列表 触发事件
- IN_OPEN:文件被打开 触发事件
- IN_ALL_EVENTS:监控所有事件
- IN_MOVE:IN_MOVED_FROM | IN_MOVED_TO 事件的统称
存储事件消息的结构体
可以通过read()系统调用 来获取从inotify中发生了哪些事情, 如果read时还没有发生任何事件, 则read阻塞, 直至有事件发生. read返回的buf里面包含一个或多个以下的结构体
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 */
};
内核限制
max_queued_events: 队列中最大的event数量, 超过这个值的事件会被丢弃, 但是会触发IN_Q_OVERFLOW
/proc/sys/fs/inotify/max_user_instances:指定了每一个real user(用户)ID可以创建的instances数量
/proc/sys/fs/inotify/max_user_watches: 每个inotify_instace相关联的最大watch数量, 也就是最多可以监控多少目录/文件
代码示例
#include <cstdio>
#include <cstdlib>
#include <errno.h>
#include <unistd.h>
#include <sys/inotify.h>
void init(char **argv) {
int fd = inotify_init();
int wd = inotify_add_watch(fd, argv[1], IN_ALL_EVENTS);
const struct inotify_event *e;
char buf[4096];
ssize_t len;
while(1) {
len = read(fd, buf, sizeof buf);
if(len == -1 && errno != EAGAIN) {
perror("read");
exit(EXIT_FAILURE);
}
if(len <= 0) break;
char *ptr;
for(ptr = buf; ptr < buf+len; ptr += sizeof(struct inotify_event) + e->len) {
e = (const struct inotify_event*)ptr;
if(e->mask & IN_OPEN) printf("IN_OPEN\n");
if(e->mask & IN_CLOSE_NOWRITE) printf("IN_CLOSE_NOWRITE\n");
if(e->mask & IN_CLOSE_WRITE) printf("IN_CLOSE_WRITE\n");
if(e->len) printf("filename is :%s\n", e->name);
if(e->mask & IN_ISDIR) printf("is Directory\n");
else printf("is file\n");
}
}
}
int main(int argc, char** argv) {
if(argc < 2) {
fprintf(stderr, "Usage: input a filename/dir\n");
return -1;
}
init(argv);
}