Maison  >  Article  >  Tutoriel système  >  Explication détaillée de la fonction Linux inotify et du principe de mise en œuvre

Explication détaillée de la fonction Linux inotify et du principe de mise en œuvre

PHPz
PHPzavant
2024-02-13 19:45:301035parcourir

详解Linux inotify功能及实现原理

1. Principales fonctions d'inotify

Par rapport à MAC ou Windows, le système de bureau Linux doit encore être amélioré sur certains aspects. Afin d'améliorer cette situation, la communauté open source a proposé certains mécanismes permettant au mode utilisateur de connaître en temps opportun les modifications apportées au noyau ou aux périphériques matériels sous-jacents, afin de mieux gérer les périphériques et de fournir de meilleurs services. Parmi eux, le hotplug est un mécanisme permettant au noyau d'informer les applications en mode utilisateur des événements concernant les périphériques hot-plug, ce qui peut aider les systèmes de bureau à gérer efficacement les périphériques. udev conserve dynamiquement les fichiers de périphérique sous /dev, tandis qu'inotify est un mécanisme de notification des modifications du système de fichiers qui peut rapidement notifier les modifications du système de fichiers en mode utilisateur, telles que les ajouts, les suppressions de fichiers et d'autres événements. Ce mécanisme a été utilisé à l'origine par le célèbre Il a été introduit. par le projet de moteur de recherche de bureau beagle et a été largement utilisé dans des projets tels que Gamin. Il convient de noter qu'inotify est un mécanisme du noyau utilisé pour informer les programmes de l'espace utilisateur des modifications du système de fichiers.

2. Interface utilisateur

En mode utilisateur, inotify est utilisé via trois appels système et opérations d'E/S sur le descripteur de fichier renvoyé. La première étape pour utiliser inotify est de créer une instance inotify :

 int fd = inotify_init ();        

Chaque instance inotify correspond à une file d'attente triée indépendante.

L'événement de changement de système de fichiers est un objet de gestion appelé montres. Chaque montre est un tuple (cible, masque d'événement). La cible peut être un fichier ou un répertoire. Le masque d'événement représente l'événement inotify auquel l'application souhaite prêter attention. Chaque bit de surveillance correspond à un événement inotify. Les objets de surveillance sont référencés par des descripteurs de surveillance et les surveillances sont ajoutées par le chemin d'accès d'un fichier ou d'un répertoire. Les surveillances de répertoire renverront les événements survenus sur tous les fichiers de ce répertoire.

La fonction suivante permet d'ajouter une montre :

int wd = inotify_add_watch (fd, path, mask);        

fd est le descripteur de fichier renvoyé par inotify_init(), path est le nom du chemin de la cible surveillée (c'est-à-dire le nom du fichier ou du répertoire), mask est le masque d'événement, chaque bit est défini dans le fichier d'en-tête événements linux/inotify.h représentée. Le masque d'événement peut être modifié de la même manière en changeant les événements inotify dont vous souhaitez être averti. Wd est le descripteur de la montre.

La fonction suivante permet de supprimer une montre :

int ret = inotify_rm_watch (fd, wd);        

fd est le descripteur de fichier renvoyé par inotify_init(), wd est le descripteur de surveillance renvoyé par inotify_add_watch(). Ret est la valeur de retour de la fonction.

Les événements de fichiers sont représentés par une structure inotify_event, qui est obtenue en utilisant la fonction habituelle de lecture de fichiers lue via le descripteur de fichier renvoyé par inotify_init()

           int inotify_init (void);
        int inotify_add_watch (int fd, const char *path, __u32 mask);
        int inotify_rm_watch (int fd, __u32 mask);
        

wd dans la structure est le descripteur de surveillance de la cible surveillée, mask est le masque d'événement, len est la longueur de la chaîne de nom, name est le nom du chemin de la cible surveillée, le champ de nom de la structure est un stub, il est réservé à l'utilisateur. L'aspect fait référence au nom du fichier, qui est de longueur variable et qui suit en fait la structure. Le nom du fichier sera complété par des zéros pour permettre à la structure d'événement suivante d'être alignée sur 4 octets. Notez que len ​​compte également les octets de remplissage.

Plusieurs événements peuvent être obtenus en même temps via l'appel de lecture, à condition que le buf fourni soit suffisamment grand.

size_t len = read (fd, buf, BUF_LEN);        

buf est un pointeur de tableau de la structure inotify_event. BUF_LEN spécifie la longueur totale à lire. La taille de buf doit être au moins inférieure à BUF_LEN. Le nombre d'événements renvoyés par cet appel dépend de BUF_LEN et de la longueur du fichier. nom dans l'événement. Len est le nombre d'octets réellement lus, c'est-à-dire la longueur totale de l'événement obtenu.

Vous pouvez utiliser select() ou poll() sur le descripteur de fichier fd renvoyé par la fonction inotify_init(), ou vous pouvez utiliser la commande ioctl FIONREAD sur fd pour obtenir la longueur de la file d'attente actuelle. close(fd) supprimera toutes les montres ajoutées à fd et effectuera le nettoyage nécessaire.

           int inotify_init (void);
        int inotify_add_watch (int fd, const char *path, __u32 mask);
        int inotify_rm_watch (int fd, __u32 mask);
        

3. Principe de mise en œuvre du noyau

Dans le noyau, chaque instance inotify correspond à une structure inotify_device :

struct inotify_device {
        wait_queue_head_t       wq;             /* wait queue for i/o */
        struct idr              idr;            /* idr mapping wd -> watch */
        struct semaphore        sem;            /* protects this bad boy */
        struct list_head        events;         /* list of queued events */
        struct list_head        watches;        /* list of watches */
        atomic_t                count;          /* reference count */
        struct user_struct      *user;          /* user who opened this dev */
        unsigned int            queue_size;     /* size of the queue (bytes) */
        unsigned int            event_count;    /* number of pending events */
        unsigned int            max_events;     /* maximum number of events */
        u32                     last_wd;        /* the last wd allocated */
};

d_list pointe vers la liste de tous les inotify_device, i_list pointe vers la liste de tous les inodes surveillés, count est le décompte de référence, dev pointe vers la structure inotify_device correspondant à l'instance inotify où se trouve la montre, inode pointe vers l'inode à être surveillé par la surveillance, et wd est l'allocation. Étant donné le descripteur de la surveillance, mask est le masque d'événement de la surveillance, indiquant les événements du système de fichiers qui l'intéressent.

结构 inotify_device 在用户态调用 inotify_init() 时创建,当关闭 inotify_init()返回的文件描述符时将被释放。结构 inotify_watch 在用户态调用 inotify_add_watch()时创建,在用户态调用 inotify_rm_watch() 或 close(fd) 时被释放。

无论是目录还是文件,在内核中都对应一个 inode 结构,inotify 系统在 inode 结构中增加了两个字段:

struct inotify_watch {
        struct list_head        d_list; /* entry in inotify_device's list */
        struct list_head        i_list; /* entry in inode's list */
        atomic_t                count;  /* reference count */
        struct inotify_device   *dev;   /* associated device */
        struct inode            *inode; /* associated inode */
        s32                     wd;     /* watch descriptor */
        u32                     mask;   /* event mask for this watch */
};

d_list 指向所有 inotify_device 组成的列表的,i_list 指向所有被监视 inode 组成的列表,count 是引用计数,dev 指向该 watch 所在的 inotify 实例对应的 inotify_device 结构,inode 指向该 watch 要监视的 inode,wd 是分配给该 watch 的描述符,mask 是该 watch 的事件掩码,表示它对哪些文件系统事件感兴趣。

结构 inotify_device 在用户态调用 inotify_init() 时创建,当关闭 inotify_init()返回的文件描述符时将被释放。结构 inotify_watch 在用户态调用 inotify_add_watch()时创建,在用户态调用 inotify_rm_watch() 或 close(fd) 时被释放。

无论是目录还是文件,在内核中都对应一个 inode 结构,inotify 系统在 inode 结构中增加了两个字段:

#ifdef CONFIG_INOTIFY
 struct list_head inotify_watches; /* watches on this inode */
 struct semaphore inotify_sem; /* protects the watches list */
#endif

inotify_watches 是在被监视目标上的 watch 列表,每当用户调用 inotify_add_watch()时,内核就为添加的 watch 创建一个 inotify_watch 结构,并把它插入到被监视目标对应的 inode 的 inotify_watches 列表。inotify_sem 用于同步对 inotify_watches 列表的访问。当文件系统发生第一部分提到的事件之一时,相应的文件系统代码将显示调用fsnotify_* 来把相应的事件报告给 inotify 系统,其中*号就是相应的事件名,目前实现包括:

fsnotify_move,文件从一个目录移动到另一个目录fsnotify_nameremove,文件从目录中删除fsnotify_inoderemove,自删除fsnotify_create,创建新文件fsnotify_mkdir,创建新目录fsnotify_access,文件被读fsnotify_modify,文件被写fsnotify_open,文件被打开fsnotify_close,文件被关闭fsnotify_xattr,文件的扩展属性被修改fsnotify_change,文件被修改或原数据被修改有一个例外情况,就是 inotify_unmount_inodes,它会在文件系统被 umount 时调用来通知 umount 事件给 inotify 系统。

以上提到的通知函数最后都调用 inotify_inode_queue_event(inotify_unmount_inodes直接调用 inotify_dev_queue_event ),该函数首先判断对应的inode是否被监视,这通过查看 inotify_watches 列表是否为空来实现,如果发现 inode 没有被监视,什么也不做,立刻返回,反之,遍历 inotify_watches 列表,看是否当前的文件操作事件被某个 watch 监视,如果是,调用 inotify_dev_queue_event,否则,返回。函数inotify_dev_queue_event 首先判断该事件是否是上一个事件的重复,如果是就丢弃该事件并返回,否则,它判断是否 inotify 实例即 inotify_device 的事件队列是否溢出,如果溢出,产生一个溢出事件,否则产生一个当前的文件操作事件,这些事件通过kernel_event 构建,kernel_event 将创建一个 inotify_kernel_event 结构,然后把该结构插入到对应的 inotify_device 的 events 事件列表,然后唤醒等待在inotify_device 结构中的 wq 指向的等待队列。想监视文件系统事件的用户态进程在inotify 实例(即 inotify_init() 返回的文件描述符)上调用 read 时但没有事件时就挂在等待队列 wq 上。

4. 使用示例

下面是一个使用 inotify 来监视文件系统事件的例子:

#include 
#include 
#include 

_syscall0(int, inotify_init)
_syscall3(int, inotify_add_watch, int, fd, const char *, path, __u32, mask)
_syscall2(int, inotify_rm_watch, int, fd, __u32, mask)

char * monitored_files[] = {
 "./tmp_file",
 "./tmp_dir",
 "/mnt/sda3/windows_file"
};

struct wd_name {
 int wd;
 char * name;
};

#define WD_NUM 3
struct wd_name wd_array[WD_NUM];

char * event_array[] = {
 "File was accessed",
 "File was modified",
 "File attributes were changed",
 "writtable file closed",
 "Unwrittable file closed",
 "File was opened",
 "File was moved from X",
 "File was moved to Y",
 "Subfile was created",
 "Subfile was deleted",
 "Self was deleted",
 "Self was moved",
 "",
 "Backing fs was unmounted",
 "Event queued overflowed",
 "File was ignored"
};
#define EVENT_NUM 16
#define MAX_BUF_SIZE 1024
 
int main(void)
{
 int fd;
 int wd;
 char buffer[1024];
 char * offset = NULL;
 struct inotify_event * event;
 int len, tmp_len;
 char strbuf[16];
 int i = 0;
 
 fd = inotify_init();
 if (fd printf("Fail to initialize inotify.\n");
  exit(-1);
 }

 for (i=0; i"inotify_add_watch(fd," add (event- if { len) while *)buffer; inotify_event event len); len='%d.\n",' happens, printf(?Some offset="buffer;" MAX_BUF_SIZE)) buffer, while(len="read(fd," } wd_array[i].wd="wd;" exit(-1); wd_array[i].name); %s.\n?, for watch printf(?Can?t 0) (wd IN_ALL_EVENTS); wd_array[i].name, wd_array[i].name="monitored_files[i];" i++)>mask & IN_ISDIR) {
    memcpy(strbuf, "Direcotory", 11);
   }
   else {
    memcpy(strbuf, "File", 5);
   }
   printf("Object type: %s\n", strbuf);
   for (i=0; iwd != wd_array[i].wd) continue;
    printf("Object name: %s\n", wd_array[i].name);
    break;
   }
   printf("Event mask: %08X\n", event->mask);
   for (i=0; imask & (1

显示详细信息

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Cet article est reproduit dans:. en cas de violation, veuillez contacter admin@php.cn Supprimer