【实战技巧】使用inotify实现实时文件监控

简介: `inotify`是Linux内核提供的文件系统监控机制,用于实时捕获文件和目录的创建、删除、移动和修改等事件。通过`inotify_init`初始化,`inotify_add_watch`添加监视点,如`. IN_ACCESS`, `. IN_MODIFY`等,及`inotify_rm_watch`移除监视。示例代码展示了监听指定路径下文件修改事件,当事件发生时打印信息。使用`inotify`能高效地构建实时应用,如文件同步和日志监控,简化系统编程。

【实战技巧】使用inotify实现实时文件监控

开篇

  之前阅读《Linux系统编程》时,留意到了一个Linux原生接口inotify。它能够监控文件的移动、读取、写入和删除等操作。今天利用空闲时间,简单研究了一下如何使用这个接口,并在这里记录下来,方便将来需要查询和参考。

概述

inotify 是 Linux 内核提供的一种文件系统事件监控机制,允许用户空间程序监视文件或目录的各种操作。
  通过注册监听事件,程序可以实时捕获文件的创建、删除、移动和修改等操作,无需轮询,极大地提高了效率和实时性。inotify 提供了一种高效的方式来构建实时文件同步、监控日志变更和自动化任务等应用,是现代 Linux 系统编程中不可或缺的一部分。

基础接口

  • int inotify_init(void) / int inotify_init1(int flags)
原型 int inotify_init(void)
功能 初始化一个新的 inotify 实例,并返回一个新的文件描述符,用于后续的操作。
参数 flags:
  IN_CLOEXEC: 在执行 execve() 后关闭文件描述符(FD_CLOEXEC)。
  IN_NONBLOCK:在新的文件描述符上设置 O_NONBLOCK 文件状态标志。使用这个标志可以避免额外调用 fcntl(2) 来达到同样的效果。
返回值 成功:返回一个新的文件描述符,用于标识 inotify 实例。
失败:返回 -1,并设置 errno 来指示错误类型。
  • int inotify_add_watch(int fd, const char *pathname, uint32_t mask)
原型 int inotify_add_watch(int fd, const char *pathname, uint32_t mask)
功能 向指定的 inotify 实例中添加一个新的文件或目录的监视,并指定要监视的事件类型。
参数 fd
  inotify_init 返回的文件描述符,标识要添加监视的 inotify 实例。
pathname:要监视的文件或目录的路径名。
mask:要监视的事件类型的位掩码,可以是以下之一或多个值的按位或组合:
  IN_ACCESS:文件被访问。
  IN_MODIFY:文件被修改。
  IN_ATTRIB:文件属性被修改。
  IN_CLOSE_WRITE:可写文件被关闭。
  IN_CLOSE_NOWRITE:不可写文件被关闭等。
返回值 成功:返回一个新的监视描述符,用于标识此次监视。
失败:返回 -1,并设置 errno 来指示错误类型。
  • int inotify_rm_watch(int fd, int wd)
原型 int inotify_rm_watch(int fd, int wd)
功能 从 inotify 实例中移除先前添加的监视。
参数 fd:inotify_init 返回的文件描述符,标识要移除监视的 inotify 实例。
wd:要移除的监视描述符,即调用 inotify_add_watch 返回的监视描述符。
返回值 成功:返回 0。
失败:返回 -1,并设置 errno 来指示错误类型。

源码示例

  • 需求: 实现监听指定路径下文件的修改事件,在事件发生时实时打印。
  • 实现: inotify接口使用起来比较简单,大致分为三个步骤:
    inotify初始化
    ② 增加监视对象以及监听类型
    ③ 等待事件触发,可以结合I/O复用。

整理流程比较简单,这里简单列举一下事件触发响应和测试流程示例:

  • 事件触发响应流程
    简单展示 inotify 阻塞模式的使用示例,阻塞等待事件触发,并及时处理。

    int InotifyManager::WaitForEvents() {
      const int bufferSize = 1024; // 根据实际需求调整缓冲区大小
      char buffer[bufferSize];
    
      ssize_t numRead = read(inotifyFd, buffer, bufferSize);
      if (numRead == -1) {
          if (errno != EAGAIN) {
              std::cerr << "Error reading from inotify: " << strerror(errno) << std::endl;
              return -1;
          }
          return 0;
      }
    
      // 处理所有事件
      int offset = 0;
      while (offset < numRead) {
          struct inotify_event* event = reinterpret_cast<struct inotify_event*>(&buffer[offset]);
          if (event->len > 0) {
              std::cout << "Inotify event: " << event->name;
              if (event->mask & IN_CREATE)
                  std::cout << " created";
              if (event->mask & IN_DELETE)
                  std::cout << " deleted";
              std::cout << std::endl;
          }
          offset += sizeof(struct inotify_event) + event->len;
      }
    
      return 0;
    }
    
  • 测试代码
    循环等待inotify事件,由于是阻塞模式,不会导致空转。

    int main() {
      InotifyManager inotifyManager;
    
      // 监听当前目录下的文件创建和删除事件
      inotifyManager.AddWatch(".", IN_CREATE | IN_DELETE);
    
      while (true) {
          // 等待并处理事件
          inotifyManager.WaitForEvents();
      }
    
      return 0;
    }
    

效果验证

  • 验证流程:
    ① 左边窗口执行监听程序。
    ② 右边窗口先后执行创建和删除hello文件。
  • 验证效果:
      监听程序能够及时打印出对应创建和删除事件。
    验证.png

总结

  • 从使用流程来看,inotify用起来比较简单,只需要初始化、添加事件和读取事件即可。
  • inotify 句柄也可以通过 I/O 多路复用(如 epoll/select/poll)进行监听,实现事件的及时响应。
  • inotify 使用场景也比较多,例如界面实时刷新显示文件;监听配置文件变更动态加载配置;作为调试手段,模拟外部事件触发内部响应以及记录一些敏感文件的修改记录等等。
  • 了解这种原生接口,以后如果有需求,能够让实现多一种方式,同时减少开发中的复杂性和时间成本,或许也能够少走一些“弯路”。
相关文章
|
监控 关系型数据库 Linux
|
Ubuntu Linux
在Linux中如何解压 .xz 和 tar.xz 文件?
【4月更文挑战第17天】
13258 6
在Linux中如何解压 .xz 和 tar.xz 文件?
|
自然语言处理 安全 C++
【C++ 格式化输出 】C++20 现代C++格式化:拥抱std--format简化你的代码
【C++ 格式化输出 】C++20 现代C++格式化:拥抱std--format简化你的代码
10042 4
|
缓存 Linux 开发工具
CentOS 7- 配置阿里镜像源
阿里镜像官方地址http://mirrors.aliyun.com/ 1、点击官方提供的相应系统的帮助 :2、查看不同版本的系统操作: 下载源1、安装wget yum install -y wget2、下载CentOS 7的repo文件wget -O /etc/yum.
267061 0
|
人工智能 NoSQL C语言
程序又崩了?一招精准定位段错误!
在C/C++开发中,程序崩溃(如段错误)是常见问题,但快速定位崩溃原因却颇具挑战。本文介绍了一种精准定位崩溃问题的方法:通过捕获异常信号(如SIGSEGV),结合`backtrace()`和`abi::__cxa_demangle()`打印堆栈信息,从而快速定位问题接口。相比增加日志或生成coredump文件,此方法更高效且无副作用。实现时需注意编译选项(如`-O0 -g -rdynamic`)以保留符号信息,并处理C++名称修饰问题。
708 0
|
11月前
|
关系型数据库 Linux 数据库
PostgreSQL 入门指南:安装、配置与基本命令
本文从零开始,详细介绍如何在 Windows、Linux 和 macOS 上安装和配置 PostgreSQL,涵盖30+个实操代码示例。内容包括安装步骤、配置远程访问和用户权限、基础数据库操作命令(如创建表、插入和查询数据),以及常见问题的解决方案。通过学习,你将掌握 PostgreSQL 的基本使用方法,并为后续深入学习打下坚实基础。
12678 1
|
存储 持续交付 虚拟化
|
应用服务中间件 网络安全 nginx
轻松上手Nginx Proxy Manager:安装、配置与实战
Nginx Proxy Manager (NPM) 是一款基于 Nginx 的反向代理管理工具,提供直观的 Web 界面,方便用户配置和管理反向代理、SSL 证书等。本文档介绍了 NPM 的安装步骤,包括 Docker 和 Docker Compose 的安装、Docker Compose 文件的创建与配置、启动服务、访问 Web 管理界面、基本使用方法以及如何申请和配置 SSL 证书,帮助用户快速上手 NPM。
12165 1
|
安全 Docker 容器
Docker中运行容器时Operation not permitted报错问题解决
【10月更文挑战第2天】Docker中运行容器时Operation not permitted报错问题解决
6247 4
|
存储 安全 Linux
Dockerfile 中的 volume 与 docker run -v 的区别
Dockerfile 中的 volume 与 docker run -v 的区别
2895 0

热门文章

最新文章