二、结构及事件介绍
当有事件发生时,notify文件描述符会变为可读,调用read()可以读取发生的事件,事件的描述结构为inotify_event结构体,定义如下:
struct inotify_event {
int wd; /* Watch descriptor */
uint32_t mask; /* Mask of events */
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是inotify标识符,inotify_add_watch()的返回值;mask就是发生的事件掩码;cookie这个好像只在rename中使用,这里不关心;len是name的长度,包括空字符,name是引发事件的文件名,不包括路径。
首先说明inotify_event的长度问题,从定义中可以看出name的长度是可变的,所以一个事件对应的长度应该是sizeof(struct inotify_event)+len。
还有一个问题要特别说明,在read()的时候如果指定的缓冲区长度小于一个事件的长度(即sizeof(struct inotify_event)+len),这时内核会返回EINVAL错误。估计很多人都以为是ENOSPC错误,但是程序中实际会返回EINVAL错误,当然个人也以为返回ENOSPC会好一些。看了下2.6.32的内核代码,这个错误是在inotify_read()调用的get_one_event()函数中返回的,代码如下:
static struct fsnotify_event *get_one_event(struct fsnotify_group *group,
size_t count)
{
size_t event_size = sizeof(struct inotify_event);
struct fsnotify_event *event;
if (fsnotify_notify_queue_is_empty(group))
return NULL;
event = fsnotify_peek_notify_event(group);
if (event->name_len)
event_size += roundup(event->name_len + 1, event_size);
if (event_size > count)
return ERR_PTR(-EINVAL);
/* held the notification_mutex the whole time, so this is the
* same event we peeked above */
fsnotify_remove_notify_event(group);
return event;
}
所以在调用read从inotify文件描述符读取事件时一定要保证你的缓冲区的大小至少为sizeof(struct inotify_event)+NAME_MAX+1,其中NAME_MAX是文件名的最大值,linux下默认为255.
接下来介绍inotify中的事件,及mask的取值。下面的这些宏代表不同的事件,这些值在inotify_add_watch()中的mask参数和inotify_event结构中的mask成员中都可以使用,如下所示:
IN_ACCESS: 文件被访问
IN_ATTRIB:元数据被改变,例如权限、时间戳、扩展属性、链接数、UID、GID等
IN_CLOSE_WRITE:关闭打开写的文件
IN_CLOSE_NOWRITE: 和IN_CLOSE_WRITE刚好相反,关闭不是打开写的文件
IN_CREATE:这个是用于目录,在监控的目录中创建目录或文件时发生
IN_DELETE:这个也是用于目录,在监控的目录中删除目录或文件时发生
IN_DELETE_SELF:监控的目录或文件本身被删除
IN_MODIFY:文件被修改,这种事件会用到inotify_event中的cookie。
IN_MOVE_SELF:监控的文件或目录本身被移动
IN_MOVE_FROM: 从监控的目录中移出文件
IN_MOVE_TO:向监控的目录中移入文件
IN_OPEN: 文件被打开
(注:linuxi下都可以抽象为文件,如果没有特别说明,文件可以指普通文件或目录)。
inotify还为我们定义了一个IN_ALL_EVENTS宏,这个宏包含了上面提到的所有事件,这个宏在调用inotify_add_watch()中使用。
下面的这些bit位只在调用inotify_add_watch()中会用到:
IN_DONT_FOLLOW:如果监控的文件时一个符号链接,只监控符号链接本身,而不是链接指向的文件
IN_MASK_ADD:对已监控的文件增加要监控的的事件(不是替换原先的掩码)
IN_ONESHOT:只监控指定的文件一次,事件发生后从监控列表移除
IN_ONLYDIR:如果监控的是一个目录,只监控目录本身(待定)
下面的这些bit位可能在read()读取到的事件中设置:
IN_IGNORED:监控被显式移除(调用inotify_rm_watch()),或者自动移除(文件被删除或者文件系统被卸载)
IN_ISDIR:引发事件的是一个目录
IN_Q_OVERFLOW:事件队列溢出(这种情况下inotify_event结构中的wd为-1)
IN_UMOUNT:包含监控对象的文件系统被卸载
inotify的资源限制可以通过/proc文件系统来修改,涉及的接口有:
/proc/sys/fs/inotify/max_queued_events:指定每个inotify实例的事件队列的最大长度,即可以缓存的事件个数
/proc/sys/fs/inotify/max_user_instances:每个用户可以创建的inotify实例的个数
/proc/sys/fs/inotify/max_user_watches:每个用户可以监控的文件的上限