[[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 的對象。其原型如下：

int inotify_init(void); 

2. inotify_add_watch

創建好 inotify 句柄后，就可以通過調用 inotify_add_watch 函數添加要進行監聽的文件或者目錄。其原型如下：

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

inotify_add_watch 調用成功后，會返回被監聽文件或目錄的描述符。下面介紹一下各個參數的意義：

• fd：就是通過 inotify_init 函數創建的 inotify 句柄。
• path：要監聽的文件或目錄的路徑。
• mask：要監聽的事件，其事件類型如下：

3. inotify_rm_watch

inotify_rm_watch 函數用于刪除被監聽的文件或目錄，其原型如下：

int inotify_rm_watch(int fd, uint32_t wd); 

下面介紹一下各個參數的意義：

• fd：調用 inotify_init 函數返回的 inotify 句柄。
• wd：由 inotify_add_watch 函數的返回被監聽文件或目錄的描述符。

讀取變動事件

介紹完 inotify 的接口后，現在通過一個簡單的例子來展示怎么使用 inotify。在編寫 inotify 的實例前，先介紹一下怎么獲取被監聽文件或目錄的變動事件。inotify 并沒有提供特定的接口來獲取被監聽的文件或目錄的變動事件，而是通過通用的 read 函數來讀取，我們來看看 read 函數的原型：

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

下面說說各個參數的意義：

• fd：由 inotify_init 創建的 inotify 句柄。
• events：存放變動事件的緩沖區。
• len：緩沖區的大小。

events 參數用于存放被監聽文件或目錄的變動事件，一般指定為 inotify_event 結構的數組，inotify_event 結構的定義如下：

struct inotify_event { 
   int         wd;      // 被監控文件或目錄的描述符(由inotify_add_watch) 
   uint32_t    mask;    // 變動的事件 
   uint32_t    cookie;  // 比較少使用，可以忽略 
   uint32_t    len;     // name的長度 
   char        name[];  // 用于存放發生變動的文件或目錄名稱 
}; 

使用實例

現在我們可以使用 inotify 來編寫實例了，這個實例主要介紹怎么使用 inotify 監聽一個文件或者目錄，并且打印其變動事件。

實現代碼如下：

#include <stdio.h> 
#include <string.h> 
#include <stdlib.h> 
#include <sys/inotify.h>  // 引入 inotify 的頭文件 
 
/* 
* 用于打印發生的事件 
*/ 
void display_event(const char *base, struct inotify_event *event) 
{ 
   char *operate; 
   int mask = event->mask; 
 
   if (mask & IN_ACCESS)        operate = "ACCESS"; 
   if (mask & IN_ATTRIB)        operate = "ATTRIB"; 
   if (mask & IN_CLOSE_WRITE)   operate = "CLOSE_WRITE"; 
   if (mask & IN_CLOSE_NOWRITE) operate = "CLOSE_NOWRITE"; 
   if (mask & IN_CREATE)        operate = "CREATE"; 
   if (mask & IN_DELETE_SELF)   operate = "DELETE_SELF"; 
   if (mask & IN_MODIFY)        operate = "MODIFY"; 
   if (mask & IN_MOVE_SELF)     operate = "MOVE_SELF"; 
   if (mask & IN_MOVED_FROM)    operate = "MOVED_FROM"; 
   if (mask & IN_MOVED_TO)      operate = "MOVED_TO"; 
   if (mask & IN_OPEN)          operate = "OPEN"; 
   if (mask & IN_IGNORED)       operate = "IGNORED"; 
   if (mask & IN_DELETE)        operate = "DELETE"; 
   if (mask & IN_UNMOUNT)       operate = "UNMOUNT"; 
 
   printf("%s/%s: %s\n", base, event->name, operate); 
} 
 
#define EVENTS_BUF_SIZE 4096 
 
int main(int argc, char const *argv[]) 
{ 
   int fd; 
   int nbytes, offset; 
   char events[EVENTS_BUF_SIZE]; 
   struct inotify_event *event; 
 
   fd = inotify_init(); // 創建 inotify 句柄 
   if (fd < 0) { 
       printf("Failed to initalize inotify\n"); 
       return -1; 
  } 
 
   // 從命令行參數獲取要監聽的文件或目錄路徑 
   // 添加要監聽的文件或者目錄, 監聽所有事件 
   if (inotify_add_watch(fd, argv[1], IN_ALL_EVENTS) == -1) { 
       printf("Failed to add file or directory watch\n"); 
       return -1; 
  } 
 
   for (;;) { 
       memset(events, 0, sizeof(events)); 
 
       // 讀取發生的事件 
       nbytes = read(fd, events, sizeof(events)); 
       if (nbytes <= 0) { 
           printf("Failed to read events\n"); 
           continue; 
      } 
 
       // 開始打印發生的事件 
       for (offset = 0; offset < nbytes; ) { 
           event = (struct inotify_event *)&events[offset]; // 獲取變動事件的指針 
 
           display_event(argv[1], event); 
 
           offset += sizeof(struct inotify_event) + event->len; // 獲取下一個變動事件的偏移量 
      } 
  } 
 
   return 0; 
} 

上面的實例邏輯比較簡單，主要步驟如下：

• 調用 inotify_init 函數創建一個 inotify 句柄。
• 從命令行中獲取要監聽的文件或目錄路徑，并且通過 inotify_add_watch 函數把其添加到 inotify 中進行監聽。
• 在一個無限循環中，通過 read 函數讀取被監聽的文件或目錄的變動事件，并且通過調用 display_event 函數打印事件。

上面實例比較難懂的就是從 events 參數中獲取變動事件的指針，我們可以通過下面這幅圖來理清獲取變動事件指針的邏輯：

通過上圖，就比較容易理解怎么從 events 緩沖區中獲取到變動事件的指針了。

最后，來看看我們編寫的實例的效果動畫：

總結

本文主要介紹 inotify 的使用，在下一篇文章中，我們將會介紹 inotify 的原理和實現，敬請期待(當然對 inotify 的實現沒興趣的就不用期待了...)。