监听风云之一 Inotify 介绍

本文转载自微信公众号「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.

2. inotify_add_watch

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

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

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); 
    2.

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

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

读取变动事件

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

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

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

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

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

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

使用实例

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

实现代码如下：

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

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

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

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

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

最后，来看看我们编写的实例的效果动画：

总结

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

网站栏目：监听风云之一 Inotify 介绍
转载源于：http://www.shufengxianlan.com/qtweb/news16/143366.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

网站内链知识

分类信息网站

泸州网站建设　　 　瑞杰管理　　 　php主机　　 　商城网站　　 　正泰动物　　 　成都网站制作　　 　网站设计制作　　 　温江做网站公司　　 　成都展柜厂　　 　重庆托管服务器　　 　腾讯云免备案主机　　 　内江服务器托管　　 　响应式建站　　 　成都网站制作　　 　内江智速网站建设　　 　重庆网站设计　　 　域名注册　　 　安防网站建设方案　　 　企业网站设计　　 　香港虚拟主机空间