LinuxInotify详解和使⽤
适⽤场景:
Inotify 反应灵敏,⽤法⾮常简单,并且⽐ cron 任务的繁忙轮询⾼效得多
⽇志采集系统中,⽇志⽂件的改动。
⽂件系统中⽂件或者⽬录是否变动。
监控ftp服务器收到的⽂件,(这种情况可以监控mask的写关闭事件IN_CLOSE_WRITE,这样可以防⽌⽂件没有写完就处理数据)
接⼝函数
inotify是⼀种强⼤的、细粒度的、异步的⽂件系统事件监控机制,linux内核从2.6.13起,加⼊了inotify⽀持,通过Inotify可以监控⽂件系统添加、删除、移动、修改等各种事件,利⽤这个内核接⼝,第三⽅软件就可以监控⽂件系统下⽂件的各种变化情况。Inotify可⽤于检测单个⽂件,也可以检测整个⽬录。当检测的对象是⼀个⽬录的时候,⽬录本⾝和⽬录⾥的内容都会成为检测的对象。可以使⽤select、poll、epoll这些接⼝来监听,当有事件发⽣是,inotify⽂件描述符会可读。
此种机制的出现的⽬的是当内核空间发⽣某种事件之后,可以⽴即通知到⽤户空间。⽅便⽤户做出具体的操作。
Inotify API 接⼝函数
int fd = inotify_init(void)
int inotify_init1(int flags);
每⼀个 inotify 实例对应⼀个独⽴的排序的队列。
⽤于创建⼀个inotify的实例,然后返回inotify事件队列的⽂件描述符。 同样内核也提供了inotify_init1()中多了⼀个参数flags,⽤来在初始化时设置inotify⽂件描述符的属性。flags中可以设置的标志有两个:IN_NONBLOCK和IN_CLOEXEC。这两个标志不难理解,前⼀个是⽤来将inotify⽂件描述设置为⾮阻塞状态,后⼀个是设置close-on-exec(FD_CLOEXEC)标志。通过使⽤这两个标志就避免在创建inotify⽂件描述后再调⽤fcntl()的消耗了,代码看起来也会简洁⼀些。inotify_init1(int flags)接⼝函数,当flag等于0的时候,该函数等价于inotify_init(void)函数。
int wd = inotify_add_watch(int fd, const char* pathname, uint32_t mask)
该函数⽤于添加“watch list”,也就是检测列表。 可以是⼀个新的watch,也可以是⼀个已经存在的watch。其中fd就是inotify_init的返回值,pathname是要检测⽬录或者⽂件的路径,mask就是要检测的事件类型。该函数成功返回的是⼀个unique的watch描述符。返回值是⼀个inotify标识,注意不要和inotify_init()的返回值搞混淆了。inotify_init()的返回值是在读取事件、注册监听⽂件时使⽤,⽽
inotify_add_watch()的返回值⽤来判断返回的事件属于哪个监听的⽂件(后⾯介绍inotify_event结构时会看到),以及移除监听⽂件时使⽤。
int inotify_rm_watch(int fd, int wd)
⽤于从watch list种移除检测的对象。
数据结构
内核使⽤struct inotify_event代表⼀个⽂件事件。当检测的⽂件对象发⽣变化时,使⽤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: 就是检测的对象的watch descriptor
.mask: 检测事件的mask
.cookie: 和rename事件相关。
.len: name字段的长度。
.name: 检测对象的name。
可以看到name字段的长度是0,也就是变长的。因为检测的对象的name不定,使⽤变长可以⽅便记录检测对象的name。
mask有关检测的事件类型分为好⼏种,如下:
IN_ACCESS File was accessed (read) (*).
IN_ATTRIB Metadata changed, e.g., permissions, timestamps, extended
attributes, link count (since Linux 2.6.25), UID, GID, etc.(*).
IN_CLOSE_WRITE File opened for writing was closed (*).
IN_CLOSE_NOWRITE File not opened for writing was closed (*).
IN_CREATE File/directory created in watched directory (*).
IN_DELETE File/directory deleted from watched directory (*).
IN_DELETE_SELF Watched file/directory was itself deleted.
IN_MODIFY File was modified (*).
IN_MOVE_SELF Watched file/directory was itself moved.
IN_MOVED_FROM File moved out of watched directory (*).
IN_MOVED_TO File moved into watched directory (*).
IN_OPEN File was opened (*).
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_MOVED_FROM: 从监控的⽬录中移出⽂件
IN_MOVED_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)
实例:1、
#include <sys/inotify.h>
#include <unistd.h>
#include <string.h>
#include <stdio.h>
/*
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
};
*/
int watch_inotify_events(int fd)
{
char event_buf[512];
int ret;
int event_pos = 0;
int event_size = 0;
struct inotify_event *event;
/*读事件是否发⽣,没有发⽣就会阻塞*/
ret = read(fd, event_buf, sizeof(event_buf));
/*如果read的返回值,⼩于inotify_event⼤⼩出现错误*/
if(ret < (int)sizeof(struct inotify_event))
{
printf("counld not get event!\n");
return -1;
}
/*因为read的返回值存在⼀个或者多个inotify_event对象,需要⼀个⼀个取出来处理*/
while( ret >= (int)sizeof(struct inotify_event) )
{
{
event = (struct inotify_event*)(event_buf + event_pos);
if(event->len)
{
if(event->mask & IN_CREATE)
{
printf("create file: %s\n",event->name);write的返回值
}
else
{
printf("delete file: %s\n",event->name);
}
}
/*event_size就是⼀个事件的真正⼤⼩*/
event_size = sizeof(struct inotify_event) + event->len;
ret -= event_size;
event_pos += event_size;
}
return 0;
}
int main(int argc, char** argv)
{
int InotifyFd;
int ret;
if (argc != 2)
{
printf("Usage: %s <dir>\n", argv[0]);
return -1;
}
/
*inotify初始化*/
InotifyFd = inotify_init();
if( InotifyFd == -1)
{
printf("inotify_init error!\n");
return -1;
}
/*添加watch对象*/
ret = inotify_add_watch(InotifyFd, argv[1], IN_CREATE | IN_DELETE);
/*处理事件*/
watch_inotify_events(InotifyFd);
/
*删除inotify的watch对象*/
if ( inotify_rm_watch(InotifyFd, ret) == -1)
{
printf("notify_rm_watch error!\n");
return -1;
}
/*关闭inotify描述符*/
/*关闭inotify描述符*/
close(InotifyFd);
return 0;
}
实例2 使⽤epoll + inotify监控⽂件
#include <sys/epoll.h>
#include <fcntl.h>
#include <stdio.h>
#include <errno.h>
#include <stdlib.h>
#include <sys/inotify.h>
#define EVENT_SIZE ( sizeof (struct inotify_event) )
#define BUF_LEN ( 1024 * ( EVENT_SIZE + 16 ) )
int
main (int argc, char *argv[])
{
int i, epfd, nfds, fd;
int wd;
int length;
char buffer[BUF_LEN];
struct epoll_event ev, events[20];
epfd = epoll_create (256);
fd = inotify_init ();
wd = inotify_add_watch (fd, "/home/cc/tmp",
IN_MODIFY | IN_CREATE | IN_DELETE);
ev.data.fd = fd;
ev.events = EPOLLIN | EPOLLET;
epoll_ctl (epfd, EPOLL_CTL_ADD, fd, &ev);
for (;;)
{
nfds = epoll_wait (epfd, events, 20, 500);
for (i = 0; i < nfds; ++i)
{
if (events[i].data.fd == fd)
{
length = read (fd, buffer, BUF_LEN);
if (length < 0)
{
perror ("read");
}
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论