# irq_toolkit

**Repository Path**: elimuzi/irq_toolkit

## Basic Information

- **Project Name**: irq_toolkit
- **Description**: IRQ 综合分析与绑核工具: 中断绑定/RPS/队列调整/perf 软中断下钻/健康体检/sosreport 离线分析/持久化与回退
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-13
- **Last Updated**: 2026-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# kirqkit

IRQ 亲和性管理与性能分析工具套件

## 概述

kirqkit 是一款用于 Linux 系统中断请求（IRQ）亲和性管理的工具，支持在线实时分析与离线 sosreport 快照分析。主要功能包括 IRQ 绑核、健康检查、热点分析、RPS/RFS 软中断分流配置及持久化管理。

## 功能特性

- **多模式支持**: 在线实时分析 / 离线 sosreport 快照分析
- **智能绑核**: 自动 NUMA 感知、CPU 对齐、锚点计算
- **IRQ 分类**: 数据面 / RDMA / 管理面 自动识别
- **健康检查**: 一键体检 IRQ 分布均衡性
- **热点分析**: 定位中断热点 CPU 及关联 IRQ
- **RPS/RFS 配置**: 软中断分流自动配置
- **持久化**: 开机自动重放绑核策略
- **快照回滚**: 支持变更历史回滚

## 快速开始

```bash
# 查看网卡 IRQ 绑定
kirqkit show enp125s0f0

# 自动绑定到 NUMA 0
kirqkit set-node enp125s0f0 -n 0

# 健康检查
kirqkit health-check

# 查看软中断分布
kirqkit softirq

# 配置 RPS（单队列虚拟机）
kirqkit set-rps enp125s0f0 --count 4

# 生成 HTML 报告
kirqkit report
```

## 子命令

| 子命令 | 说明 |
|--------|------|
| `show` | 查看当前绑定 |
| `hints` | 查看驱动建议的 affinity_hint |
| `list-irq` | 按分类列出 IRQ |
| `set-cpulist` | 按指定 CPU 列表绑定 |
| `set-node` | 按 NUMA 节点绑定 |
| `set-auto` | 自动分配 |
| `softirq` | 软中断使用分析 |
| `irq-cpu-map` | 硬中断 CPU 分布分析 |
| `irqtop` | 类 top 交互监控 |
| `topology` | IRQ 拓扑全景 |
| `health-check` | IRQ 健康体检 |
| `analyze-hotspot` | 中断热点关联分析 |
| `diff` | 两个 sosreport 快照对比 |
| `recommend` | 智能绑核建议 |
| `verify` | 绑核后校验 |
| `report` | 汇总 HTML 报告 |
| `rps` | RPS/RFS 配置查看 |
| `set-rps` | RPS/RFS 软中断分流配置 |
| `persist` | 持久化管理 |
| `restore` | 变更快照回滚 |
| `set-queues` | 网卡队列数调整 |

## 离线分析

```bash
# 收集 sosreport（需 root）
sos report --all -k irq=yes

# 分析快照
kirqkit show enp125s0f0 --sos /path/to/sosreport
kirqkit health-check --sos /path/to/sosreport
```

## 环境要求

- Linux 内核 2.6+
- Python 3.6+
- root 权限（在线模式绑核）
- irqbalance 服务管理权限

## 详细文档

详见 [kirqkit_usage_manual.md](kirqkit_usage_manual.md)

## 版本

v1.9.0 (build 2026-09-25)

## 许可证

MIT License