搜索

[24230] 2015-08-27_Linux源代码分析工具链

文档创建者：s7ckTeam
浏览次数：1
最后更新：2025-01-18
2015-08-27_Linux源代码分析工具链 L i n u x 源 代 码 分 析 工 具 链 Y o n a h - 潇   L i n u x 中 国   2 0 1 5 - 0 8 - 2 7 前 言 看 源 代 码 是 一 个 程 序 员 必 须 经 历 的 事 情 ， 也 是 可 以 提 升 能 力 的 一 个 捷 径 。 个 人 认 为 ：   要 完 全 掌 握 一 个 软 件 的 方 法 只 有 阅 读 源 码 。 要 完 全 掌 握 一 个 软 件 的 方 法 只 有 阅 读 源 码 。 在 W i n d o w s 下 有 s o u r c e i n s i g h t 这 个 源 码 阅 读 软 件 （ 虽 然 我 没 用 过 ， 但 是 网 上 评 价 还 不 错 ） ， 由 于 我 是 个 L i n u x e r ， 并 不 喜 欢 用 W i n d o w s ， 所 以 自 然 是 选 择 在 L i n u x 下 阅 读 源 码 的 工 具 了 。 下 面 我 将 逐 一 介 绍 在 L i n u x 下 阅 读 源 码 的 工 具 。 v i m + c t a g s + c s c o p e 源 码 阅 读 三 剑 客 ： v i m 配 合 c t a g s 和 c s c o p e ， 足 以 在 源 代 码 里 面 自 由 翱 翔 ， 在 函 数 和 变 量 间 自 由 跳 转 。 安 装
v i m v i m 的 使 用 就 略 过 了 ， 网 上 资 料 很 多 ， 不 是 一 篇 文 章 能 说 完 的 ， 未 来 我 可 能 会 写 一 篇 v i m 的 使 用 心 得 。 推 荐 一 篇 简 明   V i m   练 级 攻 略 ， 看 完 就 差 不 多 会 用 了 。 c t a g s c t a g s 的 使 用 很 简 单 ， v i m 已 经 内 置 了 对 c t a g s 的 支 持 。 首 先 在 源 代 码 根 目 录 执 行 ， 递 归 的 为 源 码 建 立 t a g s ， 在 根 目 录 会 生 成 一 个 T a g s 的 文 件 ， 存 放 各 种 函 数 和 变 量 的 t a g ， 便 于 跳 转 ： 使 光 标 在 函 数 或 变 量 上 ， 即 可 跳 转 到 其 定 义 处 可 以 回 到 你 跳 转 之 前 的 位 置 对 于 简 单 的 代 码 ， c t a g s 就 够 用 了 ， 但 是 对 于 比 较 复 杂 的 代 码 来 说 ， c t a g s 显 得 有 点 力 不 从 心 ， 于 是 ， 下 一 位 剑 客 就 登 场 了 。 c s c o p e v i m 同 样 内 置 了 对 c s c o p e 的 支 持 。 首 先 在 源 代 码 根 目 录 执 行 ， 就 会 生 成 c s c o p e . o u t 文 件 ( 索 引 数 据 库 ) - R :   在 生 成 索 引 文 件 时 ， 搜 索 子 目 录 树 中 的 代 码 - b :   只 生 成 索 引 文 件 ， 不 进 入 c s c o p e 的 界 面 - q :   生 成 c s c o p e . i n . o u t 和 c s c o p e . p o . o u t 文 件 ， 加 快 c s c o p e 的 索 引 速 度 然 后 在 v i m 中 执 行 ， 添 加 数 据 库 。 接 下 来 就 可 以 使 用 进 行 查 找 。 （ x 代 表 查 询 选 项 ， v a r 表 示 要 查 找 的 函 数 或 变 量 名 ） c s c o p e 支 持 8 种 查 询 方 式 s :   查 找 C 语 言 符 号 ， 即 查 找 函 数 名 、 宏 、 枚 举 值 等 出 现 的 地 方 g :   查 找 函 数 、 宏 、 枚 举 等 定 义 的 位 置 ， 类 似 c t a g s 所 提 供 的 功 能 d :   查 找 本 函 数 调 用 的 函 数 c :   查 找 调 用 本 函 数 的 函 数 t :   查 找 指 定 的 字 符 串 1 .   s u d o   a p t - g e t   i n s t a l l   v i m   c t a g s   c s c o p e c t a g s   - R C t r l   +   ] C t r l   +   t c s c o p e   - R b q : c s   a d d   c s c o p e . o u t : c s   f i n d   x   v a r
e :   查 找 e g r e p 模 式 ， 相 当 于 e g r e p 功 能 ， 但 查 找 速 度 快 多 了 f :   查 找 并 打 开 文 件 ， 类 似 v i m 的 f i n d 功 能 i :   查 找 包 含 本 文 件 的 文 件 例 如 ， 我 们 想 在 v i m   7 . 0 的 源 代 码 中 查 找 调 用 d o _ c s c o p e ( ) 函 数 的 函 数 ， 我 们 可 以 输 入 ： ” : c s   f i n d   c   d o _ c s c o p e “ ， 回 车 后 发 现 没 有 找 到 匹 配 的 功 能 ， 可 能 并 没 有 函 数 调 用 d o _ c s c o p e ( ) 。 我 们 再 输 入 ” : c s   f i n d   s   d o _ c s c o p e “ ， 查 找 这 个 C 符 号 出 现 的 位 置 ， 现 在 v i m 列 出 了 这 个 符 号 出 现 的 所 有 位 置 。 每 次 都 有 输 入 来 查 找 数 据 是 不 是 有 点 麻 烦 ， 有 没 有 更 方 便 的 方 法 呢 。 当 然 有 ， v i m 的 神 奇 之 处 在 其 可 定 制 性 。 提 供 一 份 c s c o p e 的 配 置 ， 将 其 放 在 . v i m r c 中 即 可 。 1 5 .   上 面 的 配 置 即 把 作 为 的 快 捷 键 ， 也 就 是 说 要 查 找 某 个 函 数 名 ， 只 需 要 把 光 标 放 在 函 数 名 上 ， 按 下 c s   f i n d 1 .   " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " 2 .   "   c s c o p e   s e t t i n g 3 .   " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " 4 .   i f   h a s ( " c s c o p e " ) 5 .       s e t   c s p r g = / u s r / b i n / c s c o p e 6 .       s e t   c s t o = 1 7 .       s e t   c s t 8 .       s e t   n o c s v e r b 9 .       "   a d d   a n y   d a t a b a s e   i n   c u r r e n t   d i r e c t o r y 1 0 .       i f   f i l e r e a d a b l e ( " c s c o p e . o u t " ) 1 1 .               c s   a d d   c s c o p e . o u t 1 2 .       e n d i f 1 3 .       s e t   c s v e r b 1 4 .   e n d i f 1 6 .   n m a p   < C - @ > s   : c s   f i n d   s   < C - R > = e x p a n d ( " < c w o r d > " ) < C R > < C R > 1 7 .   n m a p   < C - @ > g   : c s   f i n d   g   < C - R > = e x p a n d ( " < c w o r d > " ) < C R > < C R > 1 8 .   n m a p   < C - @ > c   : c s   f i n d   c   < C - R > = e x p a n d ( " < c w o r d > " ) < C R > < C R > 1 9 .   n m a p   < C - @ > t   : c s   f i n d   t   < C - R > = e x p a n d ( " < c w o r d > " ) < C R > < C R > 2 0 .   n m a p   < C - @ > e   : c s   f i n d   e   < C - R > = e x p a n d ( " < c w o r d > " ) < C R > < C R > 2 1 .   n m a p   < C - @ > f   : c s   f i n d   f   < C - R > = e x p a n d ( " < c f i l e > " ) < C R > < C R > 2 2 .   n m a p   < C - @ > i   : c s   f i n d   i   ^ < C - R > = e x p a n d ( " < c f i l e > " ) < C R > $ < C R > 2 3 .   n m a p   < C - @ > d   : c s   f i n d   d   < C - R > = e x p a n d ( " < c w o r d > " ) < C R > < C R > C t r l   +   @ : c s   f i n d C t r l   +   @   +   s
即 可 ， 简 直 不 能 更 方 便 。 而 且 你 可 以 自 己 修 改 配 置 ， 映 射 到 自 己 觉 得 舒 服 的 快 捷 键 上 。 本 着 不 重 复 造 轮 子 的 原 则 ， 我 就 简 单 的 写 了 c s c o p e 的 基 本 用 法 ， 其 实 基 本 上 就 够 用 了 ， 进 阶 的 用 法 参 考 这 篇 文 章 v i / v i m 使 用 进 阶 :   程 序 员 的 利 器   –   c s c o p e 。 d o x y g e n 上 面 我 们 讲 的 是 用 v i m 来 查 看 源 代 码 ， 但 是 面 对 几 十 万 代 码 的 时 候 ， 想 要 看 清 楚 各 个 结 构 体 之 间 的 关 系 就 不 是 v i m 能 够 做 到 的 了 。 这 时 候 我 们 就 需 要 d o x y g e n 来 帮 手 了 。 D o x y g e n   i s   t h e   d e   f a c t o   s t a n d a r d   t o o l   f o r   g e n e r a t i n g   d o c u m e n t a t i o n   f r o m   a n n o t a t e d   C + +   s o u r c e s ，   b u t   i t a l s o   s u p p o r t s   o t h e r   p o p u l a r   p r o g r a m m i n g   l a n g u a g e s   s u c h   a s   C ,   O b j e c t i v e - C ,   C # ,   P H P ,   J a v a ,   P y t h o n ,   I D L ( C o r b a ,   M i c r o s o f t ,   a n d   U N O / O p e n O f f i c e   f l a v o r s ) ,   F o r t r a n ,   V H D L ,   T c l ,   a n d   t o   s o m e   e x t e n t   D . d o x y g e n 是 一 个 根 据 源 代 码 生 成 文 档 的 工 具 ， 这 货 虽 然 主 要 是 给 C + + 用 的 ， 但 是 它 也 对 其 他 语 言 有 支 持 。 安 装 直 接 去 官 网 ， 按 照 其 指 导 安 装 即 可 。 下 面 介 绍 一 下 d o x y g e n 的 使 用 方 法 。 首 先 ， 在 源 代 码 根 目 录 执 行 ， 然 后 在 根 目 录 就 会 突 然 冒 出 一 个 名 为 D o x y f i l e 的 文 件 ， 这 个 文 件 就 是 d o x y g e n 生 成 文 档 的 配 置 文 件 了 。 那 么 ， 重 点 来 了 ， 怎 么 配 置 这 个 文 件 ， 默 认 的 配 置 是 根 据 代 码 生 成 各 个 结 构 体 的 成 员 数 据 ， 然 后 生 成 h t m l 和 l a t e x 两 个 文 件 夹 ， 分 别 是 网 页 和 l a t e x 文 档 。 说 实 话 ， 默 认 生 成 的 文 档 并 没 有 什 么 卵 用 ， 除 了 让 你 更 方 便 的 看 到 各 个 结 构 体 的 组 成 成 员 。 我 们 关 心 的 是 各 个 结 构 体 之 间 的 关 系 ， 这 是 针 对 C 而 言 的 。 对 与 C + + 和 j a v a 而 言 ， 关 心 的 是 类 之 间 的 关 系 。 所 以 ， 默 认 的 配 置 肯 定 是 要 修 改 的 。 至 于 怎 么 改 ， 看 官 方 文 档 。 当 然 了 ， 如 果 这 篇 文 章 唯 一 给 出 的 建 议 就 是 看 文 档 ， 那 这 篇 文 章 有 什 么 意 义 呢 。 大 家 都 知 道 看 文 档 可 以 解 决 问 题 ， 但 是 时 间 成 本 太 高 ， 而 且 是 英 文 的 。 写 这 篇 文 章 的 目 的 是 分 享 自 己 学 习 得 到 的 经 验 ， 让 大 家 少 走 弯 路 ， 如 果 不 能 解 决 你 的 问 题 ， 只 能 去 看 文 档 了 。 接 下 来 我 根 据 我 自 己 看 文 档 用 到 的 配 置 跟 大 家 解 释 一 下 。 首 先 ， D o x y g e n 里 面 的 配 置 可 谓 又 臭 又 长 ， 你 绝 对 不 会 有 读 完 它 的 欲 望 。 所 以 我 给 出 几 个 关 键 的 配 置 项 ， 到 时 候 搜 索 它 修 改 即 可 这 是 针 对 各 种 语 言 优 化 输 出 的 选 项 ， 默 认 都 是 N O ， 因 为 它 不 清 楚 你 用 的 是 什 么 语 言 ( 话 说 看 一 下 后 缀 不 就 知 道 了 吗 … ) 这 个 是 生 成 文 档 的 类 型 的 选 项 ， 默 认 生 成 h t m l 和 l a t e x ， 共 支 持 六 种 类 型 的 文 档 ， 每 种 类 型 的 生 成 配 置 也 是 很 多 ， 具 体 根 据 需 要 配 置 d o x y g e n   - g 1 .   O P T I M I Z E _ O U T P U T _ F O R _ C 2 .   O P T I M I Z E _ O U T P U T _ J A V A 3 .   O P T I M I Z E _ F O R _ F O R T R A N 4 .   O P T I M I Z E _ O U T P U T _ V H D L 1 .   G E N E R A T E _ H T M L 2 .   G E N E R A T E _ L A T E X
来 源 ： S H A R E H U B 原 文 ： h t t p : / / x - h a n s o n g . g i t h u b . i o / 2 0 1 5 / 0 8 / 2 4 / L i n u x % E 6 % B A % 9 0 % E 7 % A 0 % 8 1 % E 5 % 8 8 % 8 6 % E 6 % 9 E % 9 0 % E 5 % B 7 % A 5 % E 5 % 8 5 % B 7 % E 9 % 9 3 % B E / 作 者 ：   Y o n a h - 潇 关 于 生 成 图 像 的 选 项 。 d o x y g e n 使 用 d o t 这 个 工 具 来 绘 图 ， 所 以 要 先 执 行 安 装 d o t 。 在 设 置 好 这 个 绘 图 选 项 之 后 ， d o x y g e n 就 会 生 成 各 个 结 构 体 的 关 系 ， 对 于 类 会 生 成 函 数 调 用 关 系 ( 我 没 试 过 ， 因 为 只 试 过 C 的 ) 。 给 一 个 结 构 体 关 系 图 ， 就 是 d o x y g e n 生 成 的 。 [ m a c h i n e _ c l a s s ] 最 后 一 步 ， 在 源 码 根 目 录 执 行 ， 它 会 自 动 找 到 D o x y g e n 配 置 ， 根 据 配 置 生 成 文 档 。 g d b 最 后 一 个 工 具 ， 大 名 鼎 鼎 的 g d b 。 分 析 源 码 执 行 流 程 的 最 好 方 式 的 是 运 行 它 ， 然 后 一 步 步 执 行 。 用 来 观 察 它 最 好 的 工 具 当 然 是 g d b 了 ( 针 对 C / C + + ) 。 g d b 的 使 用 我 也 不 打 算 造 轮 子 ， 直 接 参 考 用 G D B 调 试 程 序 ， 这 篇 写 的 很 好 ， 通 俗 易 懂 。 后 记 以 上 就 是 我 在 阅 读 源 码 的 时 候 使 用 的 L i n u x 工 具 ， 三 剑 客 v i m + c t a g s + c s c o p e ， 两 板 斧 d o x y g e n   g d b ， 足 以 驰 骋 源 代 码 的 江 湖 。 以 上 工 具 ， v i m 和 g d b 是 最 难 学 的 ， 学 习 曲 线 很 陡 峭 。 但 是 学 好 之 后 ， 就 能 守 得 云 开 见 月 明 。 参 考 文 章 ， 感 谢 帮 助   ： v i / v i m 使 用 进 阶 :   程 序 员 的 利 器   –   c s c o p e 2 .   G E N E R A T E _ L A T E X 3 .   G E N E R A T E _ R T F 4 .   G E N E R A T E _ X M L 5 .   G E N E R A T E _ D O C B O O K 6 .   G E N E R A T E _ M A N s u d o   a p t - g e t   i n s t a l l   g r a p h v i z 1 .   H A V E _ D O T   ( 一 定 要 置 为 Y E S ， 后 面 的 选 项 都 依 赖 这 个 ) 2 .   D O T _ N U M _ T H R E A D S   ( 使 用 d o t 绘 图 的 线 程 数 量 ， 越 多 越 快 ， 我 一 般 是 设 置 跟 c p u 的 核 数 一 样 ) d o x y g e n
阅 读 原 文
回复

举报

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

使用Markdown编辑器编辑 使用富文本编辑器编辑

Archiver| 手机版| 小黑屋|
Powered by Discuz! X3.4 Copyright © 2001-2020, Tencent Cloud. 商业源码建议获取授权，如侵犯您的权益，请联系客服处理