Linux内核编码风格.docx

Linux内核编码风格.docx

《Linux内核编码风格.docx》由会员分享，可在线阅读，更多相关《Linux内核编码风格.docx（20页珍藏版）》请在冰豆网上搜索。

Linux内核编码风格

Linux内核编码风格

资料来源：

21icBBS

这是翻译版本，英文原版是linux源码Documentation文件夹下的CodingStyle

一个良好风格的程序看起来直观、美观，便于阅读，还能有助于对程序的理解，特别在代码量比较大情况下更显现编码素质的重要性。

相反没有良好的风格的代码读起来难看、晦涩，甚至有时候一个括号没对齐就能造成对程序的曲解或者不理解。

我曾经就遇见过这样的情况，花费了很多不必要的时间在程序的上下文对照上，还debug了半天没理解的程序。

后来直接用indent-kr-i8给他转换格式来看了。

特此转过来一个关于代码风格的帖子分享一下～

Linux内核编码风格

这是一份简短的，描述linux内核首选编码风格的文档。

编码风格是很个人化的东西，而且我也不愿意把我的观点强加给任何人，不过这里所讲述的是我必须要维护的代码所遵守的风格，并且我也希望绝大多数其他代码也能遵守这个风格。

所以请至少考虑一下本文所述的观点。

首先，我建议你打印一份GNU的编码规范，然后不要读它。

烧掉它，这是一个很高调的具有象征意义的姿态。

Anyway,heregoes:

第一章：

缩进

制表符是8个字符，所以缩进也是8个字符。

有些异端运动试图将缩进变为4（乃至2）个字符深，这跟尝试着将圆周率PI的值定义为3没什么两样。

理由：

缩进的全部意义就在于清楚的定义一个控制块起止于何处。

尤其是当你盯着你的屏幕连续看了20小时之后，你将会发现大一点的缩进将会使你更容易分辨缩进。

现在，有些人会抱怨8个字符的缩进会使代码向右边移动的太远，在80个字符的终端屏幕上就很难读这样的代码。

这个问题的答案是，如果你需要3级以上的缩进，不管缩进深度如何你的代码已经有问题了，应该修正你的程序。

简而言之，8个字符的缩进可以让代码更容易阅读，还有一个好处是当你的函数嵌套太深的时候可以向你提出告警。

请留意这个警告。

在switch语句中消除多级缩进的首选的方式是让“switch”和从属于它的“case”标签对

齐于同一列，而不要“两次缩进”“case”标签。

比如：

      switch（suffix）{

      case'G':

      case'g':

          mem<<=30;

          break;

      case'M':

      case'm':

          mem<<=20;

          break;

      case'K':

      case'k':

          mem<<=10;

          /*fallthrough*/

      default:

          break;

      }

不要把多个语句放在一行里，除非你有什么东西要隐藏：

      if（condition）do_this;

      do_something_everytime;

也不要在一行里放多个赋值语句。

内核编码风格超级简单。

就是请避免使用怪异的表达式。

除了注释、文档和Kconfig之外，不要使用空格来缩进，前面的例子是例外，是有意为之。

选用一个好的编辑器，不要在行尾留空格。

第二章：

把长的行和字符串打散

编码风格的意义就在于使用平常使用的工具来维持代码的可读性和可维护性。

每一行的长度的限制是80列，我们强烈建议您遵守这个惯例。

长于80列的语句要打散成有意义的片段。

每个片段要明显短于原来的语句，而且放置的位置也明显的靠右。

同样的规则也适用于有很长参数列表的函数头。

长字符串也要打散成较短的字符串。

唯一的例外是超过80列可以大幅度提高可读性并且不会隐藏信息的情况。

voidfun（inta,intb,intc）

{

      if（condition）

          printk（KERN_WARNING"Warningthisisalongprintkwith"

                                "3parametersa:

%ub:

%u"

                                "c:

%u\n",a,b,c）;

      else

          next_statement;

}

第三章：

大括号和空格的放置

C语言风格中另外一个常见问题是大括号的放置。

和缩进大小不同，选择或弃用某种放置策略并没有多少技术上的原因，不过首选的方式，就像Kernighan和Ritchie展示给我们的，是把起始大括号放在行尾，而把结束大括号放在行首，所以：

      if（xistrue）{

          wedoy

      }

这适用于所有的非函数语句块（if、switch、for、while、do）。

比如：

      switch（action）{

      caseKOBJ_ADD:

          return"add";

      caseKOBJ_REMOVE:

          return"remove";

      caseKOBJ_CHANGE:

          return"change";

      default:

          returnNULL;

      }

不过，有一种特殊情况，命名函数：

它们的起始大括号放置于下一行的开头，这样：

      intfunction（intx）

      {

          bodyoffunction

      }

全世界的异端可能会抱怨这个不一致性，呃…确实是不一致的，不过所有思维健全的人都知道（a）K&R是正确的，并且（b）K&R是正确的。

另外，不管怎样函数都是特殊的（在C语言中，函数是不能嵌套的）。

注意结束大括号独自占据一行，除非它后面跟着同一个语句的剩余部分，比如说do语句中的“while”或者if语句中的“else”，像这样：

      do{

          bodyofdo-loop

      }while（condition）;

和

      if（x==y）{

          ..

      }elseif（x>y）{

          ...

      }else{

          ....

      }

理由：

K&R。

也请注意这种大括号的放置方式还能使空（或者差不多空的）行的数量最小化，同时不失可读性。

因此，由于你的屏幕上的新行的供应不是可回收的资源（想想25行的终端屏幕），你将会有更多的空行来放置注释。

仅有一个单独的语句时，不用加不必要的大括号。

if（condition）

      action（）;

这点不适用于本身为某个条件语句的一个分支的单独语句。

这时应该两个分支里都使用

大括号。

if（condition）{

      do_this（）;

      do_that（）;

}else{

      otherwise（）;

}

3.1：

空格

Linux内核的空格使用方格（主要）取决于它是用于函数还是关键字。

（大多数）关键字后要加一个空格。

值得注意的例外是sizeof、typeof、alignof和__attribute__，这些关键字在一定程度上看起来更像函数（它们在Linux里也常常伴随小括号使用，尽管在C语言里这样的小括号不是必需的，就像“structfileinfoinfo”声明过后的“sizeofinfo”）

所以在这些关键字之后放一个空格：

      if,switch,case,for,do,while

但是不在sizeof、typeof、alignof或者__attribute__这些关键字之后放空格。

例如，

      s=sizeof（structfile）;

不要在小括号里的表达式两侧加空格。

这是一个反例：

      s=sizeof（structfile）;

当声明指针类型或者返回指针类型的函数时，“*”的首选使用方式是使之靠近变量名或者函数名，而不是靠近类型名。

例子：

      char*linux_banner;

      unsignedlonglongmemparse（char*ptr,char**retptr）;

      char*match_strdup（substring_t*s）;

在大多数二元和三元操作符两侧使用一个空格，例如下面所有这些操作符：

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

=  ?

  :

但是一元操作符后不要加空格：

      &  *  +  -  ~  !

  sizeof  typeof  alignof  __attribute__  defined

后缀自增和自减一元操作符前不加空格：

      ++  --

前缀自增和自减一元操作符后不加空格：

      ++  --

“.”和“->”结构体成员操作符前后不加空格。

不要在行尾留空白。

有些可以自动缩进的编辑器会在新行的行首加入适量的空白，然后你就可以直接在那一行输入代码。

不过假如你最后没有在那一行输入代码，有些编辑器就不会移除已经加入的空白，就像你故意留下一个只有空白的行。

包含行尾空白的行就这样产生了。

当Git发现补丁包含了行尾空白的时候会警告你，并且可以应你的要求去掉行尾空白；不过如果你是正在打一系列补丁，这样做会导致后面的补丁失败，因为你改变了补丁的上下文。

第四章：

命名

C是一个简朴的语言，你的命名也应该这样。

和Modula-2和Pascal程序员不同，C程序员不使用类似ThisVariableIsATemporaryCounter这样华丽的名字。

C程序员会称那个变量为

“tmp”，这样写起来会更容易，而且至少不会令其难于理解。

不过，虽然混用大小写的名字是不提倡使用的，但是全局变量还是需要一个具描述性的名字。

称一个全局函数为“foo”是一个难以饶恕的错误。

全局变量（只有当你真正需要它们的时候再用它）需要有一个具描述性的名字，就像全局函数。

如果你有一个可以计算活动用户数量的函数，你应该叫它“count_active_users（）”

或者类似的名字，你不应该叫它“cntuser（）”。

在函数名中包含函数类型（所谓的匈牙利命名法）是脑子出了问题——编译器知道那些类型而且能够检查那些类型，这样做只能把程序员弄糊涂了。

难怪微软总是制造出有问题的程序。

本地变量名应该简短，而且能够表达相关的含义。

如果你有一些随机的整数型的循环计数器，它应该被称为“i”。

叫它“loop_counter”并无益处，如果它没有可能被误解的话。

类似的“tmp”可以用来称呼任意类型的临时变量。

如果你怕混淆了你的本地变量名，你就遇到另一个问题了，叫做函数增长荷尔蒙失衡综合症。

请看第六章（函数）。

第五章：

Typedef

不要使用类似“vps_t”之类的东西。

对结构体和指针使用typedef是一个错误。

当你在代码里看到：

      vps_ta;

这代表什么意思呢？

相反，如果是这样

      structvirtual_container*a;

你就知道“a”是什么了。

很多人认为typedef“能提高可读性”。

实际不是这样的。

它们只在下列情况下有用：

（a）完全不透明的对象（这种情况下要主动使用typedef来隐藏这个对象实际上是什么）。

  例如：

“pte_t”等不透明对象，你只能用合适的访问函数来访问它们。

  注意！

不透明性和“访问函数本身”是不好的。

我们使用pte_t等类型的原因在于真的

  是完全没有任何共用的可访问信息。

（b）清楚的整数类型，这样抽象层就可以帮助我们消除到底是"int"还是"long"的混淆。

  u8/u16/u32是完全没有问题的typedef，不过它们更符合（d）中所言，而不是这里。

再次注意！

要这样做，必须事出有因。

如果某个变量是“unsignedlong“，那么没有必要

      typedefunsignedlongmyflags_t;

  不过如果有一个明确的原因，比如它在某种情况下可能会是一个“unsignedint”而

  在其他情况下可能为“unsignedlong”，那么就不要犹豫，请务必使用typedef。

（c）当你使用sparse按字面的创建一个新类型来做类型检查的时候。

（d）和标准C99类型相同的类型，在某些例外的情况下。

  虽然让眼睛和脑筋来适应新的标准类型比如“uint32_t”不需要花很多时间，可以有

  些人仍然拒绝使用它们。

  因此，Linux特有的等同于标准类型的“u8/u16/u32/u64”类型和它们的有符号类型是被允许的——尽管在你自己的新代码中，它们不是强制要求要使用的。

  当编辑已经使用了某个类型集的已有代码时，你应该遵循那些代码中已经做出的选择。

（e）可以在用户空间安全使用的类型。

  在某些用户空间可见的结构体里，我们不能要求C99类型而且不能用上面提到的“u32”类型。

因此，我们在与用户空间共享的所有结构体中使用__u32和类似的类型。

可能还有其他的情况，不过基本的规则是永远不要使用typedef，除非你可以明确的应用上述某个规则中的一个。

总的来说，如果一个指针或者一个结构体里的元素可以合理的被直接访问到，那么它们就不应该是一个typedef。

 第六章：

函数

函数应该简短而漂亮，并且只完成一件事情。

函数应该可以一屏或者两屏显示完（我们都知道ISO/ANSI屏幕大小是80x24），只做一件事情，而且把它做好。

一个函数的最大长度是和该函数的复杂度和缩进级数成反比的。

所以，如果你有一个理论上很简单的只有一个很长（但是简单）的case语句的函数，而且你需要在每个case里做很多很小的事情，这样的函数尽管很长，但也是可以的。

不过，如果你有一个复杂的函数，而且你怀疑一个天分不是很高的高中一年级学生可能甚至搞不清楚这个函数的目的，你应该更严格的遵守最大限制。

使用辅助函数，并为之取个具描述性的名字（如果你觉得其对性能要求严格的话，你可以要求编译器将它们内联展开，它往往会比你更好的完成任务。

）

函数的另外一个衡量标准是本地变量的数量。

此数量不应超过5－10个，否则你的函数就有问题了。

重新考虑一下你的函数，把它分拆成更小的函数。

人的大脑一般可以轻松的同时跟踪7个不同的事物，如果再增多的话，就会糊涂了。

即便你聪颖过人，你也可能会记不清你2个星期前做过的事情。

在源文件里，使用空行隔开不同的函数。

如果该函数需要被导出，它的EXPORT*宏应该紧贴在它的结束大括号之下。

比如：

intsystem_is_up（void）

{

      returnsystem_state==SYSTEM_RUNNING;

}

EXPORT_SYMBOL（system_is_up）;

在函数原型中，包含函数名和它们的数据类型。

虽然C语言里没有这样的要求，在Linux里这是提倡的做法，因为这样可以很简单的给读者提供更多的有价值的信息。

第七章：

集中的函数退出途径

虽然被某些人声称已经过时，但是goto语句的等价物还是经常被编译器所使用，具体形式是无条件跳转指令。

当一个函数从多个位置退出并且需要做一些通用的清洁工作的时候，goto的好处就显现出来了。

理由是：

-无条件语句容易理解和跟踪

-嵌套程度减小

-可以避免由于修改时忘记更新某个单独的退出点而导致的错误

-减轻了编译器的工作，无需删除冗余代码;）

intfun（inta）

{

      intresult=0;

      char*buffer=kmalloc（SIZE）;

      if（buffer==NULL）

          return-ENOMEM;

      if（condition1）{

          while（loop1）{

                ...

          }

          result=1;

          gotoout;

      }

      ...

out:

      kfree（buffer）;

      returnresult;

}

第八章：

注释

注释是好的，不过有过度注释的危险。

永远不要在注释里解释你的代码是如何运作的：

更好的做法是让别人一看你的代码就可以明白，解释写的很差的代码是浪费时间。

一般的，你想要你的注释告诉别人你的代码做了什么，而不是怎么做的。

也请你不要把注释放在一个函数体内部：

如果函数复杂到你需要独立的注释其中的一部分，你很可能需要回到第六章看一看。

你可以做一些小注释来注明或警告某些很聪明（或者槽糕）的做法，但不要加太多。

你应该做的，是把注释放在函数的头部，告诉人们它做了什么，也可以加上它做这些事情的原因。

当注释内核API函数时，请使用kernel-doc格式。

请看

Documentation/kernel-doc-nano-HOWTO.txt和scripts/kernel-doc以获得详细信息。

Linux的注释风格是C89“/*...*/”风格。

不要使用C99风格“//...”注释。

长（多行）的首选注释风格是：

      /*

      *Thisisthepreferredstyleformulti-line

      *commentsintheLinuxkernelsourcecode.

      *Pleaseuseitconsistently.

      *

      *Description:

  Acolumnofasterisksontheleftside,

      *withbeginningandendingalmost-blanklines.

      */

注释数据也是很重要的，不管是基本类型还是衍生类型。

为了方便实现这一点，每一行应只声明一个数据（不要使用逗号来一次声明多个数据）。

这样你就有空间来为每个数据写一段小注释来解释它们的用途了。

第九章：

你已经把事情弄糟了

这没什么，我们都是这样。

可能你的使用了很长时间Unix的朋友已经告诉你“GNUemacs”能自动帮你格式化C源代码，而且你也注意到了，确实是这样，不过它所使用的默认值和我们想要的相去甚远（实际上，甚至比随机打的还要差——无数个猴子在GNUemacs里打字永远不会创造出一个好程序）（译注：

请参考InfiniteMonkeyTheorem）

所以你要么放弃GNUemacs，要么改变它让它使用更合理的设定。

要采用后一个方案，你可以把下面这段粘贴到你的.emacs文件里。

（defunlinux-c-mode（）

  "CmodewithadjusteddefaultsforusewiththeLinuxkernel."

  （interactive）

  （c-mode）

  （c-set-style"K&R"）

  （setqtab-width8）

  （setqindent-tabs-modet）

  （setqc-basic-offset8））

这样就定义了M-xlinux-c-mode命令。

当你hack一个模块的时候，如果你把字符串

-*-linux-c-*-放在头两行的某个位置，这个模式将会被自动调用。

如果你希望在你修改

/usr/src/linux里的文件时魔术般自动打开linux-c-mode的话，你也可能需要添加

（setqauto-mode-alist（cons'（"/usr/src/linux.*/.*\\.[ch]$".linux-c-mode）

                auto-mode-alist））

到你的.emacs文件里。

不过就算你尝试让emacs正确的格式化代码失败了，也并不意味着你失去了一切：

还可以用“indent”。

不过，GNUindent也有和GNUemacs一样有问题的设定，所以你需要给它一些命令选项。

不过，这还不算太糟糕，因为就算是GNUindent的作者也认同K&R的权威性（GNU的人并不是坏人，他们只是在这个问题上被严重的误导了），所以你只要给indent指定选项“-kr-i8”（代表“K&R，8个字符缩进”），或者使用“scripts/Lindent”，这样就可以以最时髦的方式缩进源代码。

“indent”有很多选项，特别是重新格式化注释的时候，你可能需要看一下它的手册页。

不过记住：

“indent”不能修正坏的编程习惯。

第十章：

Kconfig配置文件

对于遍布源码树的所有Kconfig*配置文件来说，它们缩进方式与C代码相比有所不同。

紧挨在“config”定义下面的行缩进一个制表符，帮助信息则再多缩进2个空格。

比如：

configAUDIT

      bool"Auditingsupport"

      dependsonNET

      help

      Enableauditinginfrastructurethatcanbeusedwithanother

      kernelsubsystem,suchasSELinux（whichrequiresthisfor

      loggingofavcmessagesoutput）.  Doesnotdosystem-call

      auditingwithoutCONFIG_AUDITSYSCALL.

仍然被认为不够稳定的功能应该被定义为依赖于“EXPERIMENTAL”：

configSLUB

      dependsonEXPERIMENTAL&&!

ARCH_USES_SLAB_PAGE_STRUCT

      bool"SLUB（UnqueuedAllocator）"

      ...

而那些危险的功能（比如某些文件系统的写支持）应该在它们的提示字符串里显著的声明这一点：

configADFS_FS