1. 程式人生 > >C++中的inline行內函數

C++中的inline行內函數

inline 關鍵字可以只在函式定義處新增,也可以只在函式宣告處新增,也可以同時新增;但是在函式宣告處新增 inline 關鍵字是無效的,編譯器會忽略函式宣告處的 inline 關鍵字。也就是說,inline 是一種“用於實現的關鍵字”,而不是一種“用於宣告的關鍵字”。
儘管大多數教科書中在函式宣告和函式定義處都增加了 inline 關鍵字,但我認為 inline 關鍵字不應該出現在函式宣告處。這個細節雖然不會影響函式的功能,但是體現了高質量 C++ 程式設計風格的一個基本原則:宣告與定義不可混為一談,使用者沒有必要、也不應該知道函式是否需要內聯。
更為嚴格地說,行內函數不應該有宣告,應該將函式定義放在本應該出現函式宣告的地方,這是一種良好的程式設計風格。
在多檔案程式設計中,我們通常將函式的定義放在原始檔中,將函式的宣告放在標頭檔案中,希望呼叫函式時,引入對應的標頭檔案即可,我們鼓勵這種將函式定義和函式宣告分開的做法。但這種做法不適用於行內函數,將行內函數的宣告和定義分散到不同的檔案中會出錯,請看下面的例子。
main.cpp 程式碼:
#include <iostream>
using namespace std;
//行內函數宣告
void func();
int main(){
func();
return 0;
}
module.cpp 程式碼:
#include <iostream>
using namespace std;
//行內函數定義
inline void func(){
cout<<"inline function"<<endl;
}
上面的程式碼能夠正常編譯,但在連結時會出錯。func() 是行內函數,編譯期間會用它來替換函式呼叫處,編譯完成後函式就不存在了,連結器在將多個目標檔案(.o或.obj檔案)合併成一個可執行檔案時找不到 func() 函式的定義,所以會產生連結錯誤。
行內函數雖然叫做函式,在定義和宣告的語法上也和普通函式一樣,但它已經失去了函式的本質。函式是一段可以重複使用的程式碼,它位於虛擬地址空間中的程式碼區,也佔用可執行檔案的體積,而行內函數的程式碼在編譯後就被消除了,不存在於虛擬地址空間中,沒法重複使用。
行內函數看起來簡單,但是有很多細節需要注意,從程式碼重複利用的角度講,行內函數已經不再是函數了(????還是函式,不過會將函式程式碼進行一次搬運?)。我認為將行內函數作為帶參巨集的替代方案更為靠譜,而不是真的當做函式使用。
在多檔案程式設計時,我建議將行內函數的定義直接放在標頭檔案中,並且禁用行內函數的宣告(宣告是多此一舉)。

1.  行內函數

在C++中我們通常定義以下函式來求兩個整數的最大值:

複製程式碼 程式碼如下:

int max(int a, int b)
{
 return a > b ? a : b;
}
為這麼一個小的操作定義一個函式的好處有:

① 閱讀和理解函式 max 的呼叫,要比讀一條等價的條件表示式並解釋它的含義要容易得多

② 如果需要做任何修改,修改函式要比找出並修改每一處等價表示式容易得多

③ 使用函式可以確保統一的行為,每個測試都保證以相同的方式實現

④ 函式可以重用,不必為其他應用程式重寫程式碼

雖然有這麼多好處,但是寫成函式有一個潛在的缺點:呼叫函式比求解等價表示式要慢得多。在大多數的機器上,呼叫函式都要做很多工作:呼叫前要先儲存暫存器,並在返回時恢復,複製實參,程式還必須轉向一個新位置執行

C++中支援行內函數,其目的是為了提高函式的執行效率,用關鍵字 inline 放在函式定義(注意是定義而非宣告,下文繼續講到)的前面即可將函式指定為行內函數,行內函數通常就是將它在程式中的每個呼叫點上“內聯地”展開,假設我們將 max 定義為行內函數:

複製程式碼 程式碼如下:

inline int max(int a, int b)
{
 return a > b ? a : b;
}
則呼叫: cout<<max(a, b)<<endl;


在編譯時展開為: cout<<(a > b ? a : b)<<endl;

從而消除了把 max寫成函式的額外執行開銷

2.  行內函數和巨集

無論是《Effective C++》中的 “Prefer consts,enums,and inlines to #defines” 條款,還是《高質量程式設計指南——C++/C語言》中的“用函式內聯取代巨集”,巨集在C++中基本是被廢了,在書《高質量程式設計指南——C++/C語言》中這樣解釋到:

3.  將行內函數放入標頭檔案

關鍵字 inline 必須與函式定義體放在一起才能使函式成為內聯,僅將 inline 放在函式宣告前面不起任何作用。

如下風格的函式 Foo 不能成為行內函數:

複製程式碼 程式碼如下:

inline void Foo(int x, int y);   // inline 僅與函式宣告放在一起   
void Foo(int x, int y)
{
 ...

而如下風格的函式 Foo 則成為行內函數:

複製程式碼 程式碼如下:

void Foo(int x, int y);   
inline void Foo(int x, int y)   // inline 與函式定義體放在一起
{
 ...

所以說,C++ inline函式是一種“用於實現的關鍵字”,而不是一種“用於宣告的關鍵字”。一般地,使用者可以閱讀函式的宣告,但是看不到函式的定義。儘管在大多數教科書中行內函數的宣告、定義體前面都加了 inline 關鍵字,但我認為 inline 不應該出現在函式的宣告中。這個細節雖然不會影響函式的功能,但是體現了高質量C++/C 程式設計風格的一個基本原則:宣告與定義不可混為一談,使用者沒有必要、也不應該知道函式是否需要內聯。

定義在類宣告之中的成員函式將自動地成為行內函數,例如:

複製程式碼 程式碼如下:

class A
{  
public:
 void Foo(int x, int y) { ... }   // 自動地成為行內函數  

但是編譯器是否將它真正內聯則要看 Foo函式如何定義

行內函數應該在標頭檔案中定義,這一點不同於其他函式。編譯器在呼叫點內聯展開函式的程式碼時,必須能夠找到 inline 函式的定義才能將呼叫函式替換為函式程式碼,而對於在標頭檔案中僅有函式宣告是不夠的。

當然行內函數定義也可以放在原始檔中,但此時只有定義的那個原始檔可以用它,而且必須為每個原始檔拷貝一份定義(即每個原始檔裡的定義必須是完全相同的),當然即使是放在標頭檔案中,也是對每個定義做一份拷貝,只不過是編譯器替你完成這種拷貝罷了。但相比於放在原始檔中,放在標頭檔案中既能夠確保呼叫函式是定義是相同的,又能夠保證在呼叫點能夠找到函式定義從而完成內聯(替換)。

但是你會很奇怪,重複定義那麼多次,不會產生連結錯誤?

我們來看一個例子:

A.h :

複製程式碼 程式碼如下:

class A
{
public:
 A(int a, int b) : a(a),b(b){}
 int max();
private:
 int a;
 int b;
};

A.cpp : 

複製程式碼 程式碼如下:

#include "A.h"
inline int A::max()
{
 return a > b ? a : b;
}

Main.cpp : 

複製程式碼 程式碼如下:

#include <iostream>
#include "A.h"
using namespace std;
inline int A::max()
{
 return a > b ? a : b;
}

int main()
{
 A a(3, 5);
 cout<<a.max()<<endl;
 return 0;
}

一切正常編譯,輸出結果:5

 


倘若你在Main.cpp中沒有定義max行內函數,那麼會出現連結錯誤:

error LNK2001: unresolved external symbol "public: int __thiscall A::max(void)" ([email protected]@@QAEHXZ)main.obj
找不到函式的定義,所以行內函數可以在程式中定義不止一次,只要 inline 函式的定義在某個原始檔中只出現一次,而且在所有原始檔中,其定義必須是完全相同的就可以。

在標頭檔案中加入或修改 inline 函式時,使用了該標頭檔案的所有原始檔都必須重新編譯。

4.  慎用內聯

內聯雖有它的好處,但是也要慎用,以下摘自《高質量程式設計指南——C++/C語言》:

而在Google C++編碼規範中則規定得更加明確和詳細:

行內函數:

Tip: 只有當函式只有 10 行甚至更少時才將其定義為行內函數.

定義: 當函式被宣告為行內函數之後, 編譯器會將其內聯展開, 而不是按通常的函式呼叫機制進行呼叫.
優點: 當函式體比較小的時候, 內聯該函式可以令目的碼更加高效. 對於存取函式以及其它函式體比較短, 效能關鍵的函式, 鼓勵使用內聯.
缺點: 濫用內聯將導致程式變慢. 內聯可能使目的碼量或增或減, 這取決於行內函數的大小. 內聯非常短小的存取函式通常會減少程式碼大小, 但內聯一個相當大的函式將戲劇性的增加程式碼大小. 現代處理器由於更好的利用了指令快取, 小巧的程式碼往往執行更快。
結論: 一個較為合理的經驗準則是, 不要內聯超過 10 行的函式. 謹慎對待解構函式, 解構函式往往比其表面看起來要更長, 因為有隱含的成員和基類解構函式被呼叫!
另一個實用的經驗準則: 內聯那些包含迴圈或 switch 語句的函式常常是得不償失 (除非在大多數情況下, 這些迴圈或 switch 語句從不被執行).
有些函式即使宣告為內聯的也不一定會被編譯器內聯, 這點很重要; 比如虛擬函式和遞迴函式就不會被正常內聯. 通常, 遞迴函式不應該宣告成行內函數.(遞迴呼叫堆疊的展開並不像迴圈那麼簡單, 比如遞迴層數在編譯時可能是未知的, 大多數編譯器都不支援內聯遞迴函式). 虛擬函式內聯的主要原因則是想把它的函式體放在類定義內, 為了圖個方便, 抑或是當作文件描述其行為, 比如精短的存取函式.

-inl.h檔案:


Tip: 複雜的行內函數的定義, 應放在後綴名為 -inl.h 的標頭檔案中.


行內函數的定義必須放在標頭檔案中, 編譯器才能在呼叫點內聯展開定義. 然而, 實現程式碼理論上應該放在 .cc 檔案中, 我們不希望 .h 檔案中有太多實現程式碼, 除非在可讀性和效能上有明顯優勢.

如果行內函數的定義比較短小, 邏輯比較簡單, 實現程式碼放在 .h 檔案裡沒有任何問題. 比如, 存取函式的實現理所當然都應該放在類定義內. 出於編寫者和呼叫者的方便, 較複雜的行內函數也可以放到 .h 檔案中, 如果你覺得這樣會使標頭檔案顯得笨重, 也可以把它萃取到單獨的 -inl.h 中. 這樣把實現和類定義分離開來, 當需要時包含對應的 -inl.h 即可。