<!-- @page { margin: 2cm } P { margin-bottom: 0.21cm } -->
Linux內核代碼風格
By Linus Torvalds
<!-- @page { margin: 2cm } H1 { margin-top: 0.6cm; margin-bottom: 0.58cm; line-height: 200%; page-break-inside: avoid } H1.western { font-family: "DejaVu Serif", serif; font-size: 22pt } H1.cjk { font-family: "DejaVu Sans"; font-size: 22pt; font-style: normal; font-weight: bold } H1.toc-標題-western { margin-top: 0.85cm; margin-bottom: 0cm; color: #365f91; font-family: "Cambria", serif; font-size: 14pt; line-height: 115%; text-align: left; widows: 2; orphans: 2 } H1.toc-標題-cjk { margin-top: 0.85cm; margin-bottom: 0cm; color: #365f91; font-family: "宋體", "SimSun"; font-style: normal; font-weight: bold; line-height: 115%; text-align: left; widows: 2; orphans: 2 } H1.toc-標題-ctl { margin-top: 0.85cm; margin-bottom: 0cm; color: #365f91; font-family: "Times New Roman", serif; font-size: 14pt; font-weight: bold; line-height: 115%; text-align: left; widows: 2; orphans: 2 } H2 { margin-top: 0.46cm; margin-bottom: 0.46cm; line-height: 171%; page-break-inside: avoid } H2.western { font-family: "Cambria", serif; font-size: 16pt } H2.cjk { font-family: "宋體", "SimSun"; font-size: 16pt; font-style: normal } H2.ctl { font-family: "DejaVu Sans"; font-size: 12pt; font-weight: normal } P { margin-bottom: 0.21cm } A:link { so-language: zxx } -->
這是一個簡短的文檔，描述了linux內核的首選代碼風格。代碼風格是因人而異的，而且我不願意把我的觀點強加給任何人，不過這裏所講述的是我必須要維護的代碼所遵守的風格，並且我也希望絕大多數其他代碼也能遵守這個風格。請在寫代碼時至少考慮一下本文所述的風格。
首先，我建議你打印一份GNU代碼規範，然後不要讀它。燒了它，這是一個具有重大象徵性意義的動作。
不管怎樣，現在我們開始：
目錄
第一章：縮進
製表符是8個字符，所以縮進也是8個字符。有些異端運動試圖將縮進變爲4（乃至2）個字符深，這幾乎相當於嘗試將圓周率的值定義爲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;
/* fall through */
default:
break;
}
不要把多個語句放在一行裏，除非你有什麼東西要隱藏：
if (condition) do_this;
do_something_everytime;
也不要在一行裏放多個賦值語句。內核代碼風格超級簡單。就是避免可能導致別人誤讀的表
達式。
除了註釋、文檔和Kconfig之外，不要使用空格來縮進，前面的例子是例外，是有意爲之。
選用一個好的編輯器，不要在行尾留空格。
第二章：把長的行和字符串打散
代碼風格的意義就在於使用平常使用的工具來維持代碼的可讀性和可維護性。
每一行的長度的限制是80列，我們強烈建議您遵守這個慣例。
長於80列的語句要打散成有意義的片段。每個片段要明顯短於原來的語句，而且放置的位置也明顯的靠右。同樣的規則也適用於有很長參數列表的函數頭。長字符串也要打散成較短的字符串。唯一的例外是超過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;
}
第三章：大括號和空格的放置
C語言風格中另外一個常見問題是大括號的放置。和縮進大小不同，選擇或棄用某種放置策
略並沒有多少技術上的原因，不過首選的方式，就像Kernighan和Ritchie展示給我們的，是
把起始大括號放在行尾，而把結束大括號放在行首，所以：
if (x is true) {
we do y
}
這適用於所有的非函數語句塊（if、switch、for、while、do）。比如：
switch (action) {
case KOBJ_ADD:
return "add";
case KOBJ_REMOVE:
return "remove";
case KOBJ_CHANGE:
return "change";
default:
return NULL;
}
不過，有一個例外，那就是函數：函數的起始大括號放置於下一行的開頭，所以：
int function(int x)
{
body of function
}
全世界的異端可能會抱怨這個不一致性是……呃……不一致的，不過所有思維健全的人都知道（a）K&R是_正確的_，並且（b）K&R是正確的。此外，不管怎樣函數都是特殊的（在C語言中，函數是不能嵌套的）。
注意結束大括號獨自佔據一行，除非它後面跟着同一個語句的剩餘部分，也就是do語句中的“while”或者if語句中的“else”，像這樣：
do {
body of do-loop
} while (condition);
和
if (x == y) {
..
} else if (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語言裏這樣的小括號不是必需的，就像“struct fileinfo info”聲明過後的“sizeof info”）。
所以在這些關鍵字之後放一個空格：
if, switch, case, for, do, while
但是不要在sizeof、typeof、alignof或者__attribute__這些關鍵字之後放空格。例如，
s = sizeof(struct file);
不要在小括號裏的表達式兩側加空格。這是一個反例：
s = sizeof( struct file );
當聲明指針類型或者返回指針類型的函數時，“*”的首選使用方式是使之靠近變量名或者函
數名，而不是靠近類型名。例子：
char *linux_banner;
unsigned long long memparse(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_t a;
這代表什麼意思呢？
相反，如果是這樣
struct virtual_container *a;
你就知道“a”是什麼了。
很多人認爲typedef“能提高可讀性”。實際不是這樣的。它們只在下列情況下有用：
(a) 完全不透明的對象（這種情況下要主動使用typedef來隱藏這個對象實際上是什麼）。
例如：“pte_t”等不透明對象，你只能用合適的訪問函數來訪問它們。
注意！不透明性和“訪問函數”本身是不好的。我們使用pte_t等類型的原因在於真的是完全沒有任何共用的可訪問信息。
(b) 清楚的整數類型，如此，這層抽象就可以幫助消除到底是“int”還是“long”的混淆。
u8/u16/u32是完全沒有問題的typedef，不過它們更符合類別(d)而不是這裏。
再次注意！要這樣做，必須事出有因。如果某個變量是“unsigned long“，那麼沒有必要
typedef unsigned long myflags_t;
不過如果有一個明確的原因，比如它在某種情況下可能會是一個“unsigned int”而在
其他情況下可能爲“unsigned long”，那麼就不要猶豫，請務必使用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*宏應該緊貼
在它的結束大括號之下。比如：
int system_is_up(void)
{
return system_state == SYSTEM_RUNNING;
}
EXPORT_SYMBOL(system_is_up);
在函數原型中，包含函數名和它們的數據類型。雖然C語言裏沒有這樣的要求，在Linux裏這是提倡的做法，因爲這樣可以很簡單的給讀者提供更多的有價值的信息。
第七章：集中的函數退出途徑
雖然被某些人聲稱已經過時，但是goto語句的等價物還是經常被編譯器所使用，具體形式是無條件跳轉指令。
當一個函數從多個位置退出並且需要做一些通用的清理工作的時候，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;
}
第八章：註釋
註釋是好的，不過有過度註釋的危險。永遠不要在註釋裏解釋你的代碼是如何運作的：更好
的做法是讓別人一看你的代碼就可以明白，解釋寫的很差的代碼是浪費時間。
一般的，你想要你的註釋告訴別人你的代碼做了什麼，而不是怎麼做的。也請你不要把註釋
放在一個函數體內部：如果函數複雜到你需要獨立的註釋其中的一部分，你很可能需要回到
第六章看一看。你可以做一些小注釋來註明或警告某些很聰明（或者槽糕）的做法，但不要
加太多。你應該做的，是把註釋放在函數的頭部，告訴人們它做了什麼，也可以加上它做這
些事情的原因。
當註釋內核API函數時，請使用kernel-doc格式。請看
Documentation/kernel-doc-nano-HOWTO.txt和scripts/kernel-doc以獲得詳細信息。
Linux的註釋風格是C89“/* ... */”風格。不要使用C99風格“// ...”註釋。
長（多行）的首選註釋風格是：
/*
* This is the preferred style for multi-line
* comments in the Linux kernel source code.
* Please use it consistently.
*
* Description: A column of asterisks on the left side,
* with beginning and ending almost-blank lines.
*/
註釋數據也是很重要的，不管是基本類型還是衍生類型。爲了方便實現這一點，每一行應只
聲明一個數據（不要使用逗號來一次聲明多個數據）。這樣你就有空間來爲每個數據寫一段
小注釋來解釋它們的用途了。
第九章：你已經把事情弄糟了
這沒什麼，我們都是這樣。可能你的使用了很長時間Unix的朋友已經告訴你“GNU emacs”能自動幫你格式化C源代碼，而且你也注意到了，確實是這樣，不過它所使用的默認值和我們想要的相去甚遠（實際上，甚至比隨機打的還要差——無數個猴子在GNU emacs裏打字永遠不會創造出一個好程序）（譯註：請參考Infinite Monkey Theorem）
所以你要麼放棄GNU emacs，要麼改變它讓它使用更合理的設定。要採用後一個方案，你可
以把下面這段粘貼到你的.emacs文件裏。
(defun linux-c-mode ()
"C mode with adjusted defaults for use with the Linux kernel."
(interactive)
(c-mode)
(c-set-style "K&R")
(setq tab-width 8)
(setq indent-tabs-mode t)
(setq c-basic-offset 8))
這樣就定義了M-x linux-c-mode命令。當你hack一個模塊的時候，如果你把字符串
-*- linux-c -*-放在頭兩行的某個位置，這個模式將會被自動調用。如果你希望在你修改
/usr/src/linux裏的文件時魔術般自動打開linux-c-mode的話，你也可能需要添加
(setq auto-mode-alist (cons '("/usr/src/linux.*/.*//.[ch]$" . linux-c-mode)
auto-mode-alist))
到你的.emacs文件裏。
不過就算你嘗試讓emacs正確的格式化代碼失敗了，也並不意味着你失去了一切：還可以用“indent”。
不過，GNU indent也有和GNU emacs一樣有問題的設定，所以你需要給它一些命令選項。不過，這還不算太糟糕，因爲就算是GNU indent的作者也認同K&R的權威性（GNU的人並不是壞人，他們只是在這個問題上被嚴重的誤導了），所以你只要給indent指定選項“-kr -i8”
（代表“K&R，8個字符縮進”），或者使用“scripts/Lindent”，這樣就可以以最時髦的方式
縮進源代碼。
“indent”有很多選項，特別是重新格式化註釋的時候，你可能需要看一下它的手冊頁。不過記住：“indent”不能修正壞的編程習慣。
第十章：Kconfig配置文件
對於遍佈源碼樹的所有Kconfig*配置文件來說，它們縮進方式與C代碼相比有所不同。緊挨
在“config”定義下面的行縮進一個製表符，幫助信息則再多縮進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)"
...
而那些危險的功能（比如某些文件系統的寫支持）應該在它們的提示字符串裏顯著的聲明這
一點：
config ADFS_FS_RW
bool "ADFS write support (DANGEROUS)"
depends on ADFS_FS
...
要查看配置文件的完整文檔，請看Documentation/kbuild/kconfig-language.txt。
第十一章：數據結構
如果一個數據結構，在創建和銷燬它的單線執行環境之外可見，那麼它必須要有一個引用計
數器。內核裏沒有垃圾收集（並且內核之外的垃圾收集慢且效率低下），這意味着你絕對需
要記錄你對這種數據結構的使用情況。
引用計數意味着你能夠避免上鎖，並且允許多個用戶並行訪問這個數據結構——而不需要擔心這個數據結構僅僅因爲暫時不被使用就消失了，那些用戶可能不過是沉睡了一陣或者做了一些其他事情而已。
注意上鎖不能取代引用計數。上鎖是爲了保持數據結構的一致性，而引用計數是一個內存管
理技巧。通常二者都需要，不要把兩個搞混了。
很多數據結構實際上有2級引用計數，它們通常有不同“類”的用戶。子類計數器統計子類用戶的數量，每當子類計數器減至零時，全局計數器減一。
這種“多級引用計數”的例子可以在內存管理（“struct mm_struct”：mm_users和mm_count）
和文件系統（“struct super_block”：s_count和s_active）中找到。
記住：如果另一個執行線索可以找到你的數據結構，但是這個數據結構沒有引用計數器，這
裏幾乎肯定是一個bug。
第十二章：宏，枚舉和RTL
用於定義常量的宏的名字及枚舉裏的標籤需要大寫。
#define CONSTANT 0x12345
在定義幾個相關的常量時，最好用枚舉。
宏的名字請用大寫字母，不過形如函數的宏的名字可以用小寫字母。
一般的，如果能寫成內聯函數就不要寫成像函數的宏。
含有多個語句的宏應該被包含在一個do-while代碼塊裏：
#define macrofun(a, b, c) /
do { /
if (a == 5) /
do_this(b, c); /
} while (0)
使用宏的時候應避免的事情：
1) 影響控制流程的宏：
#define FOO(x) /
do { /
if (blah(x) < 0) /
return -EBUGGERED; /
} while(0)
非常不好。它看起來像一個函數，不過卻能導致“調用”它的函數退出；不要打亂讀者大腦裏的語法分析器。
2) 依賴於一個固定名字的本地變量的宏：
#define FOO(val) bar(index, val)
可能看起來像是個不錯的東西，不過它非常容易把讀代碼的人搞糊塗，而且容易導致看起來
不相關的改動帶來錯誤。
3) 作爲左值的帶參數的宏： FOO(x) = y；如果有人把FOO變成一個內聯函數的話，這種用
法就會出錯了。
4) 忘記了優先級：使用表達式定義常量的宏必須將表達式置於一對小括號之內。帶參數的
宏也要注意此類問題。
#define CONSTANT 0x4000
#define CONSTEXP (CONSTANT | 3)
cpp手冊對宏的講解很詳細。Gcc internals手冊也詳細講解了RTL（譯註：register
transfer language），內核裏的彙編語言經常用到它。
第十三章：打印內核消息
內核開發者應該是受過良好教育的。請一定注意內核信息的拼寫，以給人以好的印象。不要
用不規範的單詞比如“dont”，而要用“do not”或者“don't”。保證這些信息簡單、明瞭、無歧義。
內核信息不必以句號（譯註：英文句號，即點）結束。
在小括號裏打印數字(%d)沒有任何價值，應該避免這樣做。
<linux/device.h>裏有一些驅動模型診斷宏，你應該使用它們，以確保信息對應於正確的
設備和驅動，並且被標記了正確的消息級別。這些宏有：dev_err(), dev_warn(),
dev_info()等等。對於那些不和某個特定設備相關連的信息，<linux/kernel.h>定義了
pr_debug()和pr_info()。
寫出好的調試信息可以是一個很大的挑戰；當你寫出來之後，這些信息在遠程除錯的時候
就會成爲極大的幫助。當DEBUG符號沒有被定義的時候，這些信息不應該被編譯進內核裏
（也就是說，默認地，它們不應該被包含在內）。如果你使用dev_dbg()或者pr_debug()，
就能自動達到這個效果。很多子系統擁有Kconfig選項來啓用-DDEBUG。還有一個相關的慣例是使用VERBOSE_DEBUG來添加dev_vdbg()消息到那些已經由DEBUG啓用的消息之上。
第十四章：分配內存
內核提供了下面的一般用途的內存分配函數：kmalloc()，kzalloc()，kcalloc()和
vmalloc()。請參考API文檔以獲取有關它們的詳細信息。
傳遞結構體大小的首選形式是這樣的：
p = kmalloc(sizeof(*p), ...);
另外一種傳遞方式中，sizeof的操作數是結構體的名字，這樣會降低可讀性，並且可能會引
入bug。有可能指針變量類型被改變時，而對應的傳遞給內存分配函數的sizeof的結果不變。
強制轉換一個void指針返回值是多餘的。C語言本身保證了從void指針到其他任何指針類型的轉換是沒有問題的。
第十五章：內聯弊病
有一個常見的誤解是內聯函數是gcc提供的可以讓代碼運行更快的一個選項。雖然使用內聯
函數有時候是恰當的（比如作爲一種替代宏的方式，請看第十二章），不過很多情況下不是
這樣。inline關鍵字的過度使用會使內核變大，從而使整個系統運行速度變慢。因爲大內核
會佔用更多的指令高速緩存（譯註：一級緩存通常是指令緩存和數據緩存分開的）而且會導
致pagecache的可用內存減少。想象一下，一次pagecache未命中就會導致一次磁盤尋址，將耗時5毫秒。5毫秒的時間內CPU能執行很多很多指令。
一個基本的原則是如果一個函數有3行以上，就不要把它變成內聯函數。這個原則的一個例
外是，如果你知道某個參數是一個編譯時常量，而且因爲這個常量你確定編譯器在編譯時能
優化掉你的函數的大部分代碼，那仍然可以給它加上inline關鍵字。kmalloc()內聯函數就
是一個很好的例子。
人們經常主張給static的而且只用了一次的函數加上inline，如此不會有任何損失，因爲沒
有什麼好權衡的。雖然從技術上說這是正確的，但是實際上這種情況下即使不加inline gcc
也可以自動使其內聯。而且其他用戶可能會要求移除inline，由此而來的爭論會抵消inline
自身的潛在價值，得不償失。
第十六章：函數返回值及命名
函數可以返回很多種不同類型的值，最常見的一種是表明函數執行成功或者失敗的值。這樣
的一個值可以表示爲一個錯誤代碼整數（-Exxx＝失敗，0＝成功）或者一個“成功”布爾值（0＝失敗，非0＝成功）。
混合使用這兩種表達方式是難於發現的bug的來源。如果C語言本身嚴格區分整形和布爾型變量，那麼編譯器就能夠幫我們發現這些錯誤……不過C語言不區分。爲了避免產生這種bug，請遵循下面的慣例：
如果函數的名字是一個動作或者強制性的命令，那麼這個函數應該返回錯誤代碼整
數。如果是一個判斷，那麼函數應該返回一個“成功”布爾值。
比如，“add work”是一個命令，所以add_work()函數在成功時返回0，在失敗時返回-EBUSY。
類似的，因爲“PCI device present”是一個判斷，所以pci_dev_present()函數在成功找到
一個匹配的設備時應該返回1，如果找不到時應該返回0。
所有導出（譯註：EXPORT）的函數都必須遵守這個慣例，所有的公共函數也都應該如此。私有（static）函數不需要如此，但是我們也推薦這樣做。
返回值是實際計算結果而不是計算是否成功的標誌的函數不受此慣例的限制。一般的，他們
通過返回一些正常值範圍之外的結果來表示出錯。典型的例子是返回指針的函數，他們使用
NULL或者ERR_PTR機制來報告錯誤。
第十七章：不要重新發明內核宏
頭文件include/linux/kernel.h包含了一些宏，你應該使用它們，而不要自己寫一些它們的
變種。比如，如果你需要計算一個數組的長度，使用這個宏
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
類似的，如果你要計算某結構體成員的大小，使用
#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
還有可以做嚴格的類型檢查的min()和max()宏，如果你需要可以使用它們。你可以自己看看
那個頭文件裏還定義了什麼你可以拿來用的東西，如果有定義的話，你就不應在你的代碼裏
自己重新定義。
第十八章：編輯器模式行和其他需要羅嗦的事情
有一些編輯器可以解釋嵌入在源文件裏的由一些特殊標記標明的配置信息。比如，emacs
能夠解釋被標記成這樣的行：
-*- mode: c -*-
或者這樣的：
/*
Local Variables:
compile-command: "gcc -DMAGIC_DEBUG_FLAG foo.c"
End:
*/
Vim能夠解釋這樣的標記：
/* vim:set sw=8 noet */
不要在源代碼中包含任何這樣的內容。每個人都有他自己的編輯器配置，你的源文件不應
該覆蓋別人的配置。這包括有關縮進和模式配置的標記。人們可以使用他們自己定製的模
式，或者使用其他可以產生正確的縮進的巧妙方法。
附錄 I：參考
The C Programming Language, 第二版, 作者Brian W. Kernighan和Denni
M. Ritchie. Prentice Hall, Inc., 1988. ISBN 0-13-110362-8 (軟皮),
0-13-110370-9 (硬皮). URL: http://cm.bell-labs.com/cm/cs/cbook/
The Practice of Programming 作者Brian W. Kernighan和Rob Pike. Addison-Wesley,
Inc., 1999. ISBN 0-201-61586-X. URL: http://cm.bell-labs.com/cm/cs/tpop/
cpp，gcc，gcc internals和indent的GNU手冊——和K&R及本文相符合的部分，全部可以在
http://www.gnu.org/manual/找到
WG14是C語言的國際標準化工作組，URL: http://www.open-std.org/JTC1/SC22/WG14/
Kernel CodingStyle，作者[email protected]發表於OLS 2002：
http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
最後更新於2007年7月13日。
