Linux下监测目录或文件的变化---inotify

标签: linux 目录 文件 | 发表时间:2013-03-16 15:15 | 作者:moonvs2010
出处:http://blog.csdn.net

  inotify是用来监视文件系统事件的机制,在linux 2.6.13内核中引入。该机制可以用来监视文件和目录,当文件或目录发生变化时,内核会将文件或目录的变化发送给inotify文件描述符,在应用层只需调用read()就可以读取这些事件,非常的方便。更好的是,inotify文件描述符还可以使用select、poll、epoll这些接口来监听,当有事件发生是,inotify文件描述符会可读。

 一、接口介绍

1、inotify_init()

  定义如下:

       #include <sys/inotify.h>

       int inotify_init(void);
       int inotify_init1(int flags);

  inotify_init()用来初始化一个新的inotify实例,并返回一个文件描述符。这个描述符在inotify_add_watch()中会用到,发生的事件也是从这个描述中读取。

  除了这个接口外,还有一个相同功能的接口inotify_init1()。inotify_init1()中多了一个参数flags,用来在初始化时设置inotify文件描述符的属性。flags中可以设置的标志有两个:IN_NONBLOCK和IN_CLOEXEC。这两个标志不难理解,前一个是用来将inotify文件描述设置为非阻塞状态,后一个是设置close-on-exec(FD_CLOEXEC)标志。通过使用这两个标志就避免在创建inotify文件描述后再调用fcntl()的消耗了,代码看起来也会简洁一些。

2、inotify_add_watch()

  定义如下:

       #include <sys/inotify.h>

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

 其中fd是inotify文件描述符,inotify_init()的返回值;pathname是要监听的文件的路径;mask是指定要监视哪些事件,在后面具体介绍。

  inotify_add_watch()用于将要监视的文件或目录添加到inotify中,返回值是一个inotify标识,注意不要和inotify_init()的返回值搞混淆了。inotify_init()的返回值是在读取事件、注册监听文件时使用,而inotify_add_watch()的返回值用来判断返回的事件属于哪个监听的文件(后面介绍inotify_event结构时会看到),以及移除监听文件时使用。

  3、inotify_rm_watch()

  定义如下:

       #include <sys/inotify.h>

       int inotify_rm_watch(int fd, uint32_t wd);
  inotify_rm_watch()用于移除对某个文件的监听,其中fd是inotify文件描述符,由inotify_init()返回;wd是inotify标识,由inotify_add_watch()返回。

二、结构及事件介绍
  当有事件发生时,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:每个用户可以监控的文件的上限


参考资料:

1、man手册,命令:man inotify

2、 http://www.ibm.com/developerworks/cn/linux/l-inotifynew/index.html

作者:moonvs2010 发表于2013-3-16 15:15:41 原文链接
阅读:77 评论:0 查看评论

相关 [linux 目录 文件] 推荐:

Linux下监测目录或文件的变化---inotify

- - CSDN博客研发管理推荐文章
  inotify是用来监视文件系统事件的机制,在linux 2.6.13内核中引入. 该机制可以用来监视文件和目录,当文件或目录发生变化时,内核会将文件或目录的变化发送给inotify文件描述符,在应用层只需调用read()就可以读取这些事件,非常的方便. 更好的是,inotify文件描述符还可以使用select、poll、epoll这些接口来监听,当有事件发生是,inotify文件描述符会可读.

Linux 文件结构

- Shiina Luce - OSMSG
想了解 Linux 文件系统树形结构,却又不愿翻阅 FHS 的朋友,可以参考 skill2die4 制作的这张简图. 此图算是 FHS 的图形化版本,简要的说明了 Linux 系统中各个目录的用途及层级关系,适合初学者使用参考. 不过其中较新的如 /run 目录并未在其中出现. 做为参考,这是 Fedora 16 Beta i686 上的文件结构:.

Linux 2.6 中的文件锁

- Mountain - 小程序员的草稿箱
在多任务操作系统环境中,如果一个进程尝试对正在被其他进程读取的文件进行写操作,可能会导致正在进行读操作的进程读取到一些被破坏或者不完整的数据;如果两个进程并发对同一个文件进行写操作,可能会导致该文件遭到破坏. 因此,为了避免发生这种问题,必须要采用某种机制来解决多个进程并发访问同一个文件时所面临的同步问题,由此而产生了文件加锁方面的技术.

Linux 文件结构 — LinuxTOY

- oak - linuxtoy.org
想了解 Linux 文件系统树形结构,却又不愿翻阅 FHS 的朋友,可以参考 skill2die4 制作的这张简图. 此图算是 FHS 的图形化版本,简要的说明了 Linux 系统中各个目录的用途及层级关系,适合初学者使用参考. 不过其中较新的如 /run 目录并未在其中出现.

linux下的文件系统选型

- Michael - shell&#39;s home
    贝壳原来一直认为文件系统可以随便选,结果最近吃了两次苦头. 一个是btrfs对虚拟机支持不良,另一个是特定情况下xfs性能比ext3高20倍. 痛定思痛,打算列一下文件系统选型的方法和依据,欢迎拍砖.     下面我列一下纳入参考的文件系统,当然,ntfs就不要出来搞基了,玩嵌入式/光盘live之类的朋友也不要来凑热闹了阿.

linux文件操作之系统调用

- L - 博客园-首页原创精华区
    在linux中,一切都是文件,文件为操作系统服务和设备提供了一个简单而统一的接口,这就意味者程序可以像使用文件那样使用各种设备. 大多数情况下对于文件的操作只用到open,write,lseek,read,close五个系统调用. 本文通过一个简单的例子来介绍这五个调用及关联内容.   这是一个简单的读写文件的例子,先创建一个文本文件,写入一些内容,再把文本内容输出到标准输出,下面开始分析这个例子:.

Linux 下的文件系统选型

- 桔子 - python.cn(jobs, news)
贝壳原来一直认为文件系统可以随便选,结果最近吃了两次苦头. 一个是btrfs对虚拟机支持不良,另一个是特定情况下xfs性能比ext3高20倍. 痛定思痛,打算列一下文件系统选型的方法和依据,欢迎拍砖. 下面我列一下纳入参考的文件系统,当然,ntfs就不要出来搞基了,玩嵌入式/光盘live之类的朋友也不要来凑热闹了阿.

Linux的proc文件系统详解

- - 博客园_iTech's Blog
Linux系统上的/proc目录是一种文件系统,即proc文件系统. 与其它常见的文件系统不同的是,/proc是一种伪文件系统(也即虚拟文件系统),存储的是当前内核运行状态的一系列特殊文件,用户可以通过这些文件查看有关系统硬件及当前正在运行进程的信息,甚至可以通过更改其中某些文件来改变内核的运行状态.

linux nohup.out文件过大解决方法

- - 孟飞阳的博客
先说一下 Linux重定向:. 0、1和2分别表示标准输入、标准输出和标准错误信息输出,可以用来指定需要重定向的标准输入或输出. 在一般使用时,默认的是标准输出,既1.当我们需要特殊用途时,可以使用其他标号. 例如,将某个程序的错误信息输出到log文件中:./program 2>log. 这样标准输出还是在屏幕上,但是错误信息会输出到log文件中.