监听风云之一 Inotify 介绍

安全 应用安全
不知道大家用过 Dropbox 没有,这是国外一款非常好用云盘,你只需要在 Dropbox 中设置好要同步的目录,每当此目录中的文件发生变动时,Dropbox 就会自动把文件同步到云端。

[[397381]]

本文转载自微信公众号「Linux内核那些事」,作者songsong001。转载本文请联系Linux内核那些事公众号。

不知道大家用过 Dropbox 没有,这是国外一款非常好用云盘,你只需要在 Dropbox 中设置好要同步的目录,每当此目录中的文件发生变动时,Dropbox 就会自动把文件同步到云端。

那么,Dorpbox 是怎么知道目录的文件发生了改变呢?答案是,通过 inotfiy 这个系统功能来实现的。

我们主要分为两篇文章来介绍 inotify 这个功能:本篇首先介绍 inotify 的使用方式,而下篇主要介绍 inotify 的实现原理。

inotify 接口们

其实 inotify 的接口比较少,只有3个:inotify_init、inotify_add_watch 和 inotify_rm_watch。下面我们介绍一下这三个接口的作用和原型。

1. inotify_init

inotify_init 函数用于创建一个 inotify 的句柄,可以认为此句柄就是 inotify 的对象。其原型如下:

  1. int inotify_init(void); 

2. inotify_add_watch

创建好 inotify 句柄后,就可以通过调用 inotify_add_watch 函数添加要进行监听的文件或者目录。其原型如下:

  1. int inotify_add_watch(int fd, const char *path, uint32_t mask); 

inotify_add_watch 调用成功后,会返回被监听文件或目录的描述符。下面介绍一下各个参数的意义:

  • fd:就是通过 inotify_init 函数创建的 inotify 句柄。
  • path:要监听的文件或目录的路径。
  • mask:要监听的事件,其事件类型如下:
类型 描述
IN_ACCESS 文件被访问
IN_ATTRIB 文件元数据改变
IN_CLOSE_WRITE 关闭为了写入而打开的文件
IN_CLOSE_NOWRITE 关闭只读方式打开的文件
IN_CREATE 在监听目录内创建了文件/目录
IN_DELETE 在监听目录内删除文件/目录
IN_DELETE_SELF 监听目录/文件本身被删除。
IN_MODIFY 文件被修改
IN_MOVE_SELF 受监控目录/文件本身被移动
IN_MOVED 文件被移
IN_OPEN 文件被打开
IN_ALL_EVENTS 以上所有输出事件的统称

3. inotify_rm_watch

inotify_rm_watch 函数用于删除被监听的文件或目录,其原型如下:

  1. int inotify_rm_watch(int fd, uint32_t wd); 

下面介绍一下各个参数的意义:

  • fd:调用 inotify_init 函数返回的 inotify 句柄。
  • wd:由 inotify_add_watch 函数的返回被监听文件或目录的描述符。

读取变动事件

介绍完 inotify 的接口后,现在通过一个简单的例子来展示怎么使用 inotify。在编写 inotify 的实例前,先介绍一下怎么获取被监听文件或目录的变动事件。inotify 并没有提供特定的接口来获取被监听的文件或目录的变动事件,而是通过通用的 read 函数来读取,我们来看看 read 函数的原型:

  1. int read(int fd, void *events, size_t len); 

下面说说各个参数的意义:

  • fd:由 inotify_init 创建的 inotify 句柄。
  • events:存放变动事件的缓冲区。
  • len:缓冲区的大小。

events 参数用于存放被监听文件或目录的变动事件,一般指定为 inotify_event 结构的数组,inotify_event 结构的定义如下:

  1. struct inotify_event { 
  2.    int         wd;      // 被监控文件或目录的描述符(由inotify_add_watch) 
  3.    uint32_t    mask;    // 变动的事件 
  4.    uint32_t    cookie;  // 比较少使用,可以忽略 
  5.    uint32_t    len;     // name的长度 
  6.    char        name[];  // 用于存放发生变动的文件或目录名称 
  7. }; 

使用实例

现在我们可以使用 inotify 来编写实例了,这个实例主要介绍怎么使用 inotify 监听一个文件或者目录,并且打印其变动事件。

实现代码如下:

  1. #include <stdio.h> 
  2. #include <string.h> 
  3. #include <stdlib.h> 
  4. #include <sys/inotify.h>  // 引入 inotify 的头文件 
  5.  
  6. /* 
  7. * 用于打印发生的事件 
  8. */ 
  9. void display_event(const char *base, struct inotify_event *event) 
  10.    char *operate; 
  11.    int mask = event->mask; 
  12.  
  13.    if (mask & IN_ACCESS)        operate = "ACCESS"
  14.    if (mask & IN_ATTRIB)        operate = "ATTRIB"
  15.    if (mask & IN_CLOSE_WRITE)   operate = "CLOSE_WRITE"
  16.    if (mask & IN_CLOSE_NOWRITE) operate = "CLOSE_NOWRITE"
  17.    if (mask & IN_CREATE)        operate = "CREATE"
  18.    if (mask & IN_DELETE_SELF)   operate = "DELETE_SELF"
  19.    if (mask & IN_MODIFY)        operate = "MODIFY"
  20.    if (mask & IN_MOVE_SELF)     operate = "MOVE_SELF"
  21.    if (mask & IN_MOVED_FROM)    operate = "MOVED_FROM"
  22.    if (mask & IN_MOVED_TO)      operate = "MOVED_TO"
  23.    if (mask & IN_OPEN)          operate = "OPEN"
  24.    if (mask & IN_IGNORED)       operate = "IGNORED"
  25.    if (mask & IN_DELETE)        operate = "DELETE"
  26.    if (mask & IN_UNMOUNT)       operate = "UNMOUNT"
  27.  
  28.    printf("%s/%s: %s\n", base, event->name, operate); 
  29.  
  30. #define EVENTS_BUF_SIZE 4096 
  31.  
  32. int main(int argc, char const *argv[]) 
  33.    int fd; 
  34.    int nbytes, offset; 
  35.    char events[EVENTS_BUF_SIZE]; 
  36.    struct inotify_event *event; 
  37.  
  38.    fd = inotify_init(); // 创建 inotify 句柄 
  39.    if (fd < 0) { 
  40.        printf("Failed to initalize inotify\n"); 
  41.        return -1; 
  42.   } 
  43.  
  44.    // 从命令行参数获取要监听的文件或目录路径 
  45.    // 添加要监听的文件或者目录, 监听所有事件 
  46.    if (inotify_add_watch(fd, argv[1], IN_ALL_EVENTS) == -1) { 
  47.        printf("Failed to add file or directory watch\n"); 
  48.        return -1; 
  49.   } 
  50.  
  51.    for (;;) { 
  52.        memset(events, 0, sizeof(events)); 
  53.  
  54.        // 读取发生的事件 
  55.        nbytes = read(fd, events, sizeof(events)); 
  56.        if (nbytes <= 0) { 
  57.            printf("Failed to read events\n"); 
  58.            continue
  59.       } 
  60.  
  61.        // 开始打印发生的事件 
  62.        for (offset = 0; offset < nbytes; ) { 
  63.            event = (struct inotify_event *)&events[offset]; // 获取变动事件的指针 
  64.  
  65.            display_event(argv[1], event); 
  66.  
  67.            offset += sizeof(struct inotify_event) + event->len; // 获取下一个变动事件的偏移量 
  68.       } 
  69.   } 
  70.  
  71.    return 0; 

上面的实例逻辑比较简单,主要步骤如下:

  • 调用 inotify_init 函数创建一个 inotify 句柄。
  • 从命令行中获取要监听的文件或目录路径,并且通过 inotify_add_watch 函数把其添加到 inotify 中进行监听。
  • 在一个无限循环中,通过 read 函数读取被监听的文件或目录的变动事件,并且通过调用 display_event 函数打印事件。

上面实例比较难懂的就是从 events 参数中获取变动事件的指针,我们可以通过下面这幅图来理清获取变动事件指针的逻辑:

通过上图,就比较容易理解怎么从 events 缓冲区中获取到变动事件的指针了。

最后,来看看我们编写的实例的效果动画:

总结

 

本文主要介绍 inotify 的使用,在下一篇文章中,我们将会介绍 inotify 的原理和实现,敬请期待(当然对 inotify 的实现没兴趣的就不用期待了...)。

 

责任编辑:武晓燕 来源: Linux内核那些事
相关推荐

2021-05-27 09:57:55

Inotify监控系统

2017-02-27 14:09:45

HTTPAPI网关Kong

2009-08-18 17:53:08

思科认证介绍思科培训

2023-01-31 08:34:19

2019-10-28 11:11:52

戴尔

2023-05-05 21:51:47

窃听信息泄露

2021-04-30 17:02:52

coredump内核故障

2021-08-23 14:36:26

coredump

2022-11-27 23:37:34

Go模式Workspaces

2023-09-04 17:48:06

2023-11-30 07:45:11

useEffectReact

2021-06-03 19:55:55

MySQ查询优化

2010-01-28 14:01:32

Android监听通话

2012-11-30 11:00:54

2011-08-19 08:56:34

JavaJava风云

2021-02-04 15:08:37

Vue渐进式框架

2010-12-14 18:50:23

微软

2021-11-30 07:02:10

虚拟化Linux 中断

2021-04-21 21:09:36

缓存系统高可用

2011-04-25 11:18:39

Ajax
点赞
收藏

51CTO技术栈公众号