Linux 内核Coding Style整理

简介:

总结linux内核开发的coding style, 便于以后写代码时参考.

下面只是罗列一些规则, 具体说明可以参考: 内核源码(Documentation/CodingStyle)

 

01 - 缩进

缩进用 Tab, 并且Tab的宽度为8个字符

swich 和 case对齐, 不用缩进

switch (suffix) {
case 'G':
case 'g':
        mem <<= 30;
        break;
case 'M':
case 'm':
        mem <<= 20;
        break;
case 'K':
case 'k':
        mem <<= 10;
        /* fall through */
default:
        break;
}

 

一行只有一个表达式

if (condition) do_this;  /* bad example */

 

不要用空格来缩进 (除了注释或文档)

 

02 - 代码行长度控制在80个字符以内

长度过长的行截断时, 注意保持易读性

void fun(int a, int b, int c)
{
        if (condition)
                printk(KERN_WARNING "Warning this is a long printk with "
                       "3 parameters a: %u b: %u "
                       "c: %u \n", a, b, c);
        else
                next_statement;
}

 

03 - 括号和空格的位置

函数的大括号另起一行

int function(int x)
{   /* 这个大括号 { 另起了一行 */
        body of function
}

 

非函数的语句块(if, switch, for, while, do)不用另起一行

if (x is true) {  /* 这个大括号 { 不用另起一行 */
        we do y
}

 

只有一行的语句块不用大括号

if (condition)
        action();

 

如果if用了大括号, 那么else即使只有一行也要用大括号

if (condition) {
        do_this();
        do_that();
} else {
        otherwise();
}

 

下列 keywords 后面追加一个空格

if, switch, case, for, do, while

 

下列 keywords 后面 *不要* 追加一个空格

sizeof, typeof, alignof, __attribute

s = sizeof(struct file);    /* good */
s = sizeof( struct file );  /* bad  */

 

定义指针时, * 紧靠函数名或者变量名

char *linux_banner;
unsigned long long memparse(char *ptr, char **retptr);
char *match_strdup(substring_t *s);

 

下面的二元和三元操作符左右要留一个空格

=  +  -  <  >  *  /  %  |  &  ^  <=  >=  ==  !=  ?  :

 

下面的一元操作符后面 *不要* 留空格

&  *  +  -  ~  !  sizeof  typeof  alignof  __attribute__  defined

 

后缀操作符(++ --)前面不要留空格

 

前缀操作符(++ --)后面不要留空格

 

结构体成员操作符(. ->)前后都不要留空格

 

每行代码之后不要有多余的空格

 

04 - 命名

全局变量或函数(在确实需要时才使用)要有个描述性的名称

count_active_users()  /* good */
cntusr()              /* cnt  */

 

局部变量名称要简洁(这个规则比较抽象, 只能多看看内核代码中其他人的命名方式)

 

05 – Typedefs

尽量不要使用 typedef, 使用typedef主要为了下面的用途:

1. 完全不透明的类型(访问这些类型也需要对应的访问函数)

    ex. pid_t, uid_t, pte_t ... 等等

2. 避免整型数据的困扰

    比如int, long类型的长度在不同体系结构中不一致等等, 使用 u8/u16/u32 来代替整型定义

3. 当使用kernel的sparse工具做变量类型检查时, 可以typedef一个类型.

4. 定义C99标准中的新类型

5. 为了用户空间的类型安全

    内核空间的结构体映射到用户空间时使用typedef, 这样即使内核空间的数据结构有变化, 用户空间也能正常运行

 

06 - 函数

函数要简短,一个函数只做一件事情

 

函数长度一般不超过2屏(1屏的大小是 80x24), 也就是48行

 

如果函数中的 switch 有很多简单的 case语句, 那么超出2屏也可以

 

函数中局部变量不能超过 5~10 个

 

函数与函数之间空一行, 但是和EXPORT* 之间不用空

int one_func(void)
{
        return 0;
}

int system_is_up(void)
{
        return system_state == SYSTEM_RUNNING;
}
EXPORT_SYMBOL(system_is_up);

 

07 - 函数退出

将函数的退出集中在一起, 特别有需要清理内存的时候.(goto 并不是洪水猛兽, 有时也很有用)

int fun(int a)
{
        int result = 0;
        char *buffer = kmalloc(SIZE);

        if (buffer == NULL)
                return -ENOMEM;

        if (condition1) {
                while (loop1) {
                        ...
                }
                result = 1;
                goto out;
        }
        ...
        out:
                kfree(buffer);
                return result;
}

 

08 - 注释

注释code做了什么, 而不是如何做的

 

使用C89的注释风格(/* ... */), 不要用C99的注释风格(// ...)

 

注释定义的数据, 不管是基本类型还是衍生的类型

 

09 - 控制缩进的方法

用emacs来保证缩进, .emacs中的配置如下:

(defun c-lineup-arglist-tabs-only (ignored)
  "Line up argument lists by tabs, not spaces"
  (let* ((anchor (c-langelem-pos c-syntactic-element))
     (column (c-langelem-2nd-pos c-syntactic-element))
     (offset (- (1+ column) anchor))
     (steps (floor offset c-basic-offset)))
    (* (max steps 1)
       c-basic-offset)))

(add-hook 'c-mode-common-hook
          (lambda ()
            ;; Add kernel style
            (c-add-style
             "linux-tabs-only"
             '("linux" (c-offsets-alist
                        (arglist-cont-nonempty
                         c-lineup-gcc-asm-reg
                         c-lineup-arglist-tabs-only))))))

(add-hook 'c-mode-hook
          (lambda ()
            (let ((filename (buffer-file-name)))
              ;; Enable kernel mode for the appropriate files
              (when (and filename
                         (string-match (expand-file-name "~/src/linux-trees")
                                       filename))
                (setq indent-tabs-mode t)
                (c-set-style "linux-tabs-only")))))

 

使用 indent 脚本来保证缩进. (脚本位置: scripts/Lindent)

 

10 - Kconfig配置文件

"config" 下一行要缩进一个Tab, "help" 下则缩进2个空格

config AUDIT
        bool "Auditing support"
        depends on NET
        help
          Enable auditing infrastructure that can be used with another
          kernel subsystem, such as SELinux (which requires this for
          logging of avc messages output).  Does not do system-call
          auditing without CONFIG_AUDITSYSCALL.

 

不稳定的特性要加上 *EXPERIMENTAL*

config SLUB
        depends on EXPERIMENTAL && !ARCH_USES_SLAB_PAGE_STRUCT
        bool "SLUB (Unqueued Allocator)"
        ...

 

危险的特性要加上 *DANGEROUS*

config ADFS_FS_RW
        bool "ADFS write support (DANGEROUS)"
        depends on ADFS_FS
        ...

 

Kconfig的说明可以参见: Documentation/kbuild/kconfig-language.txt

 

11 - 数据结构

结构体要包含一个引用计数字段 (内核中没有自动垃圾收集, 需要手动释放内存)

 

需要保证结构体数据一致性时要加锁

 

结构体中有时甚至会需要多层的引用计数

ex. struc mm_struct, struct super_block

 

12 - 宏, 枚举类型和RTL

宏定义常量后者标签时使用大写字母

#define CONSTANT 0x12345

 

宏定义多行语句时要放入 do - while 中, 此时宏的名称用小写

#define macrofun(a, b, c)             \
    do {                    \
        if (a == 5)            \
            do_this(b, c);        \
    } while (0)

 

宏定义表达式时要放在 () 中

#define CONSTANT 0x4000
#define CONSTEXP (CONSTANT | 3)

 

枚举类型 用来定义多个有联系的常量

 

13 - 打印内核消息

保持打印信息的简明清晰

比如, 不要用 "dont", 而是使用 "do not" 或者 "don't"

 

内核信息不需要使用 "." 结尾

 

打印 "(%d)" 之类的没有任何意义, 应该避免

 

选择合适的打印级别(调试,还是警告,错误等等)

 

14 - 分配内存

分配内存时sizeof(指针) 而不是 sizeof(结构体)

p = kmalloc(sizeof(*p), ...);

这样的话, 当p指向其他结构体时, 上面的代码仍然可用

 

分配内存后返回值转为 void指针是多余的, C语言本身会完成这个步骤

 

15 - 内联的弊端

如果一个函数有3行以上, 不要使用 inline 来标记它

 

16 - 函数返回值和名称

如果函数功能是一个动作或者一个命令时, 返回 int型的 error-code

比如, add_work() 函数执行成功时返回 0, 失败时返回对应的error-code(ex. -EBUSY)

 

如果函数功能是一个判断时, 返回 "0" 表示失败, "1" 表示成功

 

所有Exported函数, 公用的函数都要上述2条要求

 

所有私有(static)函数, 不强制要求, 但最好能满足上面2条要求

 

如果函数返回真实计算结果, 而不是是否成功时, 通过返回计算结果范围外的值来表示失败

比如一个返回指针的函数, 通过返回 NULL 来表示失败

 

17 - 不要重复发明内核宏

内核定义的宏在头文件 include/linux/kernel.h 中, 想定义新的宏时, 首先看看其中是否已有类似的宏可用

 

18 - 编辑器模式行和其他

不要在代码中加入特定编辑器的内容或者其他工具的配置,

比如 emacs 的配置

-*- mode: c -*-
or
/*
Local Variables:
compile-command: "gcc -DMAGIC_DEBUG_FLAG foo.c"
End:
*/

 

vim 的配置

/* vim:set sw=8 noet */

 

每个人使用的开发工具可能都不一样, 这样的配置对有些人来说就是垃圾

 

内核代码格式化工具介绍

checkpatch.pl - 检查source或者patch是否符合规范

Lindent       - 格式化代码的缩进

 

这2个工具都在内核代码树中的 scripts 文件夹中。



本文转自wang_yb博客园博客,原文链接:http://www.cnblogs.com/wang_yb/p/3532349.html,如需转载请自行联系原作者


目录
相关文章
|
6天前
|
算法 Linux 调度
深入理解Linux内核调度器:从基础到优化####
本文旨在通过剖析Linux操作系统的心脏——内核调度器,为读者揭开其高效管理CPU资源的神秘面纱。不同于传统的摘要概述,本文将直接以一段精简代码片段作为引子,展示一个简化版的任务调度逻辑,随后逐步深入,详细探讨Linux内核调度器的工作原理、关键数据结构、调度算法演变以及性能调优策略,旨在为开发者与系统管理员提供一份实用的技术指南。 ####
32 4
|
10天前
|
缓存 算法 Linux
深入理解Linux内核调度器:公平性与性能的平衡####
真知灼见 本文将带你深入了解Linux操作系统的核心组件之一——完全公平调度器(CFS),通过剖析其设计原理、工作机制以及在实际系统中的应用效果,揭示它是如何在众多进程间实现资源分配的公平性与高效性的。不同于传统的摘要概述,本文旨在通过直观且富有洞察力的视角,让读者仿佛亲身体验到CFS在复杂系统环境中游刃有余地进行任务调度的过程。 ####
31 6
|
9天前
|
缓存 资源调度 安全
深入探索Linux操作系统的心脏——内核配置与优化####
本文作为一篇技术性深度解析文章,旨在引领读者踏上一场揭秘Linux内核配置与优化的奇妙之旅。不同于传统的摘要概述,本文将以实战为导向,直接跳入核心内容,探讨如何通过精细调整内核参数来提升系统性能、增强安全性及实现资源高效利用。从基础概念到高级技巧,逐步揭示那些隐藏在命令行背后的强大功能,为系统管理员和高级用户打开一扇通往极致性能与定制化体验的大门。 --- ###
31 9
|
8天前
|
缓存 负载均衡 Linux
深入理解Linux内核调度器
本文探讨了Linux操作系统核心组件之一——内核调度器的工作原理和设计哲学。不同于常规的技术文章,本摘要旨在提供一种全新的视角来审视Linux内核的调度机制,通过分析其对系统性能的影响以及在多核处理器环境下的表现,揭示调度器如何平衡公平性和效率。文章进一步讨论了完全公平调度器(CFS)的设计细节,包括它如何处理不同优先级的任务、如何进行负载均衡以及它是如何适应现代多核架构的挑战。此外,本文还简要概述了Linux调度器的未来发展方向,包括对实时任务支持的改进和对异构计算环境的适应性。
27 6
|
9天前
|
缓存 Linux 开发者
Linux内核中的并发控制机制:深入理解与应用####
【10月更文挑战第21天】 本文旨在为读者提供一个全面的指南,探讨Linux操作系统中用于实现多线程和进程间同步的关键技术——并发控制机制。通过剖析互斥锁、自旋锁、读写锁等核心概念及其在实际场景中的应用,本文将帮助开发者更好地理解和运用这些工具来构建高效且稳定的应用程序。 ####
28 5
|
9天前
|
算法 Unix Linux
深入理解Linux内核调度器:原理与优化
本文探讨了Linux操作系统的心脏——内核调度器(Scheduler)的工作原理,以及如何通过参数调整和代码优化来提高系统性能。不同于常规摘要仅概述内容,本摘要旨在激发读者对Linux内核调度机制深层次运作的兴趣,并简要介绍文章将覆盖的关键话题,如调度算法、实时性增强及节能策略等。
|
10天前
|
存储 监控 安全
Linux内核调优的艺术:从基础到高级###
本文深入探讨了Linux操作系统的心脏——内核的调优方法。文章首先概述了Linux内核的基本结构与工作原理,随后详细阐述了内核调优的重要性及基本原则。通过具体的参数调整示例(如sysctl、/proc/sys目录中的设置),文章展示了如何根据实际应用场景优化系统性能,包括提升CPU利用率、内存管理效率以及I/O性能等关键方面。最后,介绍了一些高级工具和技术,如perf、eBPF和SystemTap,用于更深层次的性能分析和问题定位。本文旨在为系统管理员和高级用户提供实用的内核调优策略,以最大化Linux系统的效率和稳定性。 ###
|
9天前
|
Java Linux Android开发
深入探索Android系统架构:从Linux内核到应用层
本文将带领读者深入了解Android操作系统的复杂架构,从其基于Linux的内核到丰富多彩的应用层。我们将探讨Android的各个关键组件,包括硬件抽象层(HAL)、运行时环境、以及核心库等,揭示它们如何协同工作以支持广泛的设备和应用。通过本文,您将对Android系统的工作原理有一个全面的认识,理解其如何平衡开放性与安全性,以及如何在多样化的设备上提供一致的用户体验。
|
11天前
|
Linux 数据库
Linux内核中的锁机制:保障并发操作的数据一致性####
【10月更文挑战第29天】 在多线程编程中,确保数据一致性和防止竞争条件是至关重要的。本文将深入探讨Linux操作系统中实现的几种关键锁机制,包括自旋锁、互斥锁和读写锁等。通过分析这些锁的设计原理和使用场景,帮助读者理解如何在实际应用中选择合适的锁机制以优化系统性能和稳定性。 ####
29 6
|
12天前
|
机器学习/深度学习 负载均衡 算法
深入探索Linux内核调度机制的优化策略###
本文旨在为读者揭开Linux操作系统中至关重要的一环——CPU调度机制的神秘面纱。通过深入浅出地解析其工作原理,并探讨一系列创新优化策略,本文不仅增强了技术爱好者的理论知识,更为系统管理员和软件开发者提供了实用的性能调优指南,旨在促进系统的高效运行与资源利用最大化。 ###