搜索

[24147] 2015-07-30_谈谈为Linux内核写驱动的编码规范

文档创建者：s7ckTeam
浏览次数：0
最后更新：2025-01-18
2015-07-30_谈谈为Linux内核写驱动的编码规范 谈 谈 为   L i n u x   内 核 写 驱 动 的 编 码 规 范 L i n u x 中 国   2 0 1 5 - 0 7 - 3 0 最 近 在 向 L i n u x 内 核 提 交 一 些 驱 动 程 序 ， 在 提 交 的 过 程 中 ， 发 现 自 己 的 代 码 离 L i n u x 内 核 的 c o d i n g   s t y l e 要 求 还 是 差 很 多 。 当 初 自 己 对 内 核 文 档 里 的 C o d i n g S t y l e 一 文 只 是 粗 略 的 浏 览 ， 真 正 写 代 码 的 时 候 在 很 多 细 节 上 会 照 顾 不 周 。 不 过 ，   在 不 遵 守 规 则 的 程 序 员 队 伍 里 ， 我 并 不 是 孤 独 的 。 如 果 去 看 d r i v e r s / s t a g i n g 下 的 代 码 ， 就 会 发 现 很 多 驱 动 程 序 都 没 有 严 格 遵 守 内 核 的 c o d i n g   s t y l e ， 而 且 在 很 多 驱 动 程 序 的 T O D O 文 件 里 ， 都 会 把 " c h e c k p a t c h . p l   f i x e s " 作 为 自 己 的 目 标 之 一 （ c h e c k p a t c h . p l 是 用 来 检 查 代 码 是 否 符 合 c o d i n g   s t y l e 的 脚 本 ） 。 不 可 否 认 ， c o d i n g   s t y l e 是 仁 者 见 仁 、 智 者 见 智 的 事 情 。 比 如 M i c r o s o f t 所 推 崇 的 匈 牙 利 命 名 法 ， 在 L i n u s 看 来 就 是 及 其 脑 残 ( b r a i n   d a m a g e d ) 的 做 法 。 也 许 您 并 不 赞 成 L i n u s 制 定 的 c o d i n g   s t y l e ， 但 在 提 交 内 核 驱 动 这 件 事 上 ， 最 好 还 是 以 大 局 为 重 。 对 于 这 么 一 个 庞 大 的 集 市 式 的 开 发 来 说 ， 随 意 书 写 代 码 必 将 带 来 严 重 的 可 维 护 性 的 灾 难 。 一 些 辅 助 工 具 当 代 码 量 达 到 一 定 程 度 时 ， 手 动 去 检 查 和 修 改 c o d i n g   s t y l e 是 非 常 繁 琐 的 工 作 ， 幸 好 ， 我 们 还 有 一 些 工 具 可 以 使 用 。 s c r i p t s / c h e c k p a t c h . p l 这 是 一 个 检 查 代 码 是 否 符 合 内 核 编 码 规 范 的 的 脚 本 。 顾 名 思 义 ， c h e c k p a t c h 是 用 来 检 查 p a t c h 的 ， 默 认 的 调 用 也 确 实 如 此 。 如 果 用 来 检 查 原 文 件 ， 需 要 加 上 “ - f ” 的 选 项 。 我 们 来 看 一 段 无 聊 的 代 码 ( 文 件 名 为 p r i n t _ m s g . c ) ：
这 段 代 码 的 c o d i n g   s t y l e 是 否 有 问 题 呢 ？ 用 c h e c k p a t c h . p l 来 检 查 一 下 ： 检 查 的 结 果 是 ： 在 L i n u x 内 核 的 c o d i n g   s t y l e 里 ， s w i t c h 和 c a s e 要 求 有 相 同 的 缩 进 。 本 例 的 代 码 很 少 ， 错 误 也 只 有 这 一 个 ， 手 动 修 改 很 方 便 。 如 果 类 似 的 缩 紧 错 误 很 多 怎 么 办 ？ s c r i p t s / L i n d e n t s c r i p t s 目 录 下 的 工 具 L i n d e n t 可 以 用 来 自 动 修 改 缩 进 问 题 。 提 醒 一 下 ， 使 用 L i n d e n t 要 求 系 统 安 装 i n d e n t 这 个 工 具 。 对 于 上 面 这 个 例 子 ， 执 行 L i n d e n t 命 令 ： 1 .   v o i d   p r i n t _ m s g ( i n t   a ) 2 .   { 3 .           s w i t c h   ( a )   { 4 .                   c a s e   1 : 5 .                           p r i n t f ( " a   = =   1 n " ) ; 6 .                           b r e a k ; 7 .     8 .                   c a s e   2 : 9 .                           p r i n t f ( " a   = =   2 n " ) ; 1 0 .                           b r e a k ; 1 1 .           } 1 2 .   } 1 .   s c r i p t s / c h e c k p a t c h . p l   - f     p r i n t _ m s g . c 1 .   E R R O R :   s w i t c h   a n d   c a s e   s h o u l d   b e   a t   t h e   s a m e   i n d e n t 2 .   # 3 :   F I L E :   s w i t c h . c : 3 : 3 .   +               s w i t c h   ( a )   { 4 .   +                               c a s e   1 : 5 .   [ . . . ] 6 .   +                               c a s e   2 : 7 .     8 .   t o t a l :   1   e r r o r s ,   0   w a r n i n g s ,   1 2   l i n e s   c h e c k e d 9 .     1 0 .   s w i t c h . c   h a s   s t y l e   p r o b l e m s ,   p l e a s e   r e v i e w .     I f   a n y   o f   t h e s e   e r r o r s 1 1 .   a r e   f a l s e   p o s i t i v e s   r e p o r t   t h e m   t o   t h e   m a i n t a i n e r ,   s e e 1 2 .   C H E C K P A T C H   i n   M A I N T A I N E R S . 1 .   s c r i p t s / L i n d e n t   p r i n t _ m s g . c
得 到 的 新 代 码 是 ： s e d s e d 是 一 个 流 编 辑 器 ， 其 强 大 的 功 能 可 以 帮 助 我 们 处 理 很 多 重 复 性 的 工 作 。 比 如 ， L i n u x 内 核 的 c o d i n g   s t y l e 要 求 ， 行 尾 不 能 有 空 格 （ 包 括 T a b ） ， 去 除 这 些 空 格 就 可 以 借 助 s e d 。 我 自 己 的 习 惯 很 差 ， 经 常 在 代 码 的 行 尾 留 下 一 些 空 格 。 比 如 一 行 代 码 过 长 需 要 换 行 时 ， 总 是 下 意 识 的 在 换 行 的 地 方 敲 一 个 空 格 。 另 外 ， 我 常 用 的 编 辑 器 之 一 的 K a t e ， 为 了 对 齐 的 需 要 ， 经 常 在 空 行 的 前 面 留 上 几 个 缩 进 的 T a b （ 如 下 图 ） 。 手 动 去 除 这 些 行 尾 的 空 格 是 一 件 头 大 的 事 情 ， 但 对 于 s e d 来 说 不 过 是 举 手 之 劳 。 命 令 格 式 如 下 ： 一 些 需 要 注 意 的 代 码 风 格 缩 进 1 、 除 了 注 释 、 文 档 和 K c o n f i g 之 外 ， 使 用 T a b 缩 进 ， 而 不 是 空 格 ， 并 且 T a b 的 宽 度 为 8 个 字 符 ； 2 、 s w i t c h   . . .   c a s e   . . . 语 句 中 ， s w i t c h 和 c a s e 具 有 相 同 的 缩 进 （ 参 考 上 文 ） ； 花 括 号 3 、 花 括 号 的 使 用 参 考 K & R 风 格 。 如 果 是 函 数 ， 左 花 括 号 另 起 一 行 ： 1 .   v o i d   p r i n t _ m s g ( i n t   a ) 2 .   { 3 .           s w i t c h   ( a )   { 4 .           c a s e   1 : 5 .                   p r i n t f ( " a   = =   1 n " ) ; 6 .                   b r e a k ; 7 .     8 .           c a s e   2 : 9 .                   p r i n t f ( " a   = =   2 n " ) ; 1 0 .                   b r e a k ; 1 1 .           } 1 2 .   } 1 .   s e d   ' s / [   t ] * $ / / g '   y o u r _ c o d e . c
否 则 ， 花 括 号 紧 接 在 语 句 的 最 后 ： 如 果 只 有 一 行 语 句 ， 则 不 需 要 用 花 括 号 ： 但 是 ， 对 于 条 件 语 句 来 说 ， 如 果 一 个 分 支 是 一 行 语 句 ， 另 一 个 分 支 是 多 行 ， 则 需 要 保 持 一 致 ， 使 用 花 括 号 ： 空 格 4 、 在 关 键 字 “ i f ,   s w i t c h ,   c a s e ,   f o r ,   d o ,   w h i l e ” 之 后 需 要 加 上 空 格 ， 如 ： 5 、 在 关 键 字 “ s i z e o f ,   t y p e o f ,   a l i g n o f ,   o r   _ _ a t t r i b u t e _ _ ” 之 后 不 要 加 空 格 ， 如 ： 6 、 在 括 号 里 的 表 达 式 两 边 不 要 加 空 格 ， 比 如 ， 下 面 是 一 个 反 面 的 例 子 反 面 的 例 子 ： 7 、 大 多 说 的 二 元 和 三 元 运 算 符 两 边 需 要 空 格 ， 如 “ =   +   -   <   >   *   /   %   |   &   ^   < =   > =   = =   ! =   ?   : ” ； 1 .   i n t   f u n c t i o n ( i n t   x ) 2 .   { 3 .                   b o d y   o f   f u n c t i o n 4 .   } 1 .   i f   ( x   i s   t r u e )   { 2 .                   w e   d o   y 3 .   } 1 .   i f   ( c o n d i t i o n ) 2 .                   a c t i o n ( ) ; 1 .   i f   ( c o n d i t i o n )   { 2 .                   d o _ t h i s ( ) ; 3 .                   d o _ t h a t ( ) ; 4 .   }   e l s e   { 5 .                   o t h e r w i s e ( ) ; 6 .   } 1 .   i f   ( s o m e t h i n g ) 1 .   s i z e o f ( s t r u c t   f i l e ) 1 .   s i z e o f (   s t r u c t   f i l e   )
8 、 一 元 运 算 符 后 面 不 要 空 格 ， 如 “ &   *   +   -   ~   !   s i z e o f   t y p e o f   a l i g n o f   _ _ a t t r i b u t e _ _   d e f i n e d ” ； 9 、 在 前 缀 自 增 自 减 运 算 符 之 后 和 后 缀 自 增 自 减 运 算 符 之 前 不 需 要 空 格 （ “ + + ” 和 “ - - ” ） ； 1 0 、 结 构 成 员 运 算 符 （ “ . ” 和 “ - > ” ） 的 两 边 不 需 要 空 格 ； 1 1 、 行 尾 不 需 要 空 格 ； 注 释 1 2 、 使 用 C 8 9 的 “ / *   . . .   * / ” 风 格 而 不 是 C 9 9 的 “ / /   . . . ” 风 格 ； 1 3 、 对 于 多 行 注 释 ， 可 以 参 考 下 例 ： K c o n f i g 1 4 、 “ c o n f i g ” 定 义 下 面 的 语 句 用 T a b 缩 进 ， h e l p 下 面 的 语 句 再 额 外 缩 进 两 个 空 格 ， 如 ： 宏 1 5 、 多 行 的 宏 定 义 需 要 用 “ d o   . .   w h i l e ” 封 装 ， 如 ： 1 .   / * 2 .   *   T h i s   i s   t h e   p r e f e r r e d   s t y l e   f o r   m u l t i - l i n e 3 .   *   c o m m e n t s   i n   t h e   L i n u x   k e r n e l   s o u r c e   c o d e . 4 .   *   P l e a s e   u s e   i t   c o n s i s t e n t l y . 5 .   * 6 .   *   D e s c r i p t i o n :   A   c o l u m n   o f   a s t e r i s k s   o n   t h e   l e f t   s i d e , 7 .   *   w i t h   b e g i n n i n g   a n d   e n d i n g   a l m o s t - b l a n k   l i n e s . 8 .   * / 1 .   c o n f i g   A U D I T 2 .                   b o o l   " A u d i t i n g   s u p p o r t " 3 .                   d e p e n d s   o n   N E T 4 .                   h e l p 5 .                       E n a b l e   a u d i t i n g   i n f r a s t r u c t u r e   t h a t   c a n   b e   u s e d   w i t h   a n o t h e r 6 .                       k e r n e l   s u b s y s t e m ,   s u c h   a s   S E L i n u x   ( w h i c h   r e q u i r e s   t h i s   f o r 7 .                       l o g g i n g   o f   a v c   m e s s a g e s   o u t p u t ) .   D o e s   n o t   d o   s y s t e m - c a l l 8 .                       a u d i t i n g   w i t h o u t   C O N F I G _ A U D I T S Y S C A L L . 1 .   # d e f i n e   m a c r o f u n ( a ,   b ,   c )                               2 .   d o   {                                                                         3 .                   i f   ( a   = =   5 )                                           4 .                                   d o _ t h i s ( b ,   c ) ;                     5 .   }   w h i l e   ( 0 )
函 数 返 回 值 1 6 、 函 数 返 回 值 的 定 义 最 好 也 要 遵 循 一 定 的 章 法 。 如 果 函 数 的 名 称 是 一 种 动 作 动 作 或 者 命 令 式 命 令 式 的 语 句 ， 应 该 以 错 误 代 码 的 形 式 返 回 （ 通 常 是 0 表 示 成 功 ， - E x x x 这 种 形 式 的 负 数 表 示 错 误 ） ， 如 ： 如 果 函 数 的 名 称 是 判 断 判 断 语 句 ， 则 返 回 值 应 该 类 似 与 布 尔 值 （ 通 常 1 表 示 成 功 ， 0 表 示 错 误 ） ， 如 ： 【 参 考 资 料 】 （ 1 ）   D o c u m e n t a t i o n / C o d i n g S t y l e （ 2 ）   h t t p : / / w w w . k r o a h . c o m / l i n u x / t a l k s / o l s _ 2 0 0 2 _ k e r n e l _ c o d i n g s t y l e _ t a l k / h t m l / 1 .   d o _ s o m e t h i n g ( ) 1 .   s o m e t h i n g _ i s _ p r e s e n t ( )
阅 读 原 文
回复

举报

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

本版积分规则

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

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