最近在項目中遇到了multiple definition of X鏈接錯誤,當時因為時間緊,沒有細分析原因,后來想起來一查才發現自己實在是太山炮了,導致這個錯誤的原因太多了,現在大致總結了一下:
1. 錯誤原因
首先查了一下C&C++從源代碼編譯到可執行文件的過程:
1)預處理將偽指令(宏定義、條件編譯、和引用頭文件)和特殊符號進行處理
2)編譯過程通過詞法分析、語法分析等步驟生成匯編代碼的過程,過程中還會進行優化
3)匯編過程將匯編代碼翻譯為目標機器指令的過程(.o文件,至少包含代碼段和數據段)
4)鏈接程序將所有需要用到的目標代碼(變量函數或其他庫文件等)裝配到一個整體中(可分為靜態鏈接和動態鏈接)
前三個步驟總稱為編譯過程,第四個步驟為鏈接過程,這就是我們通常說的編譯+鏈接。
問題分析:預處理程序將include頭文件的內容包含進源文件,這個過程完成后,頭文件就沒用了,然后就由編譯程序和匯編程序分別對預處理后的源文件a.c, b.c, …生成目標代碼.o文件a.o, b.o, …,然后由鏈接程序裝配所有生成的.o文件為可執行文件,問題出在這里,如果在頭文件中定義了變量(是定義不是聲明),並分別在a.c和b.c中進行了引用,編譯過程中這個變量的符號會同時包含在a.o和b.o中,導致鏈接失敗,原因是C語言規定“一個變量可以多次聲明但只能定義一次”,解決辦法是在頭文件中加上#ifndef X條件編譯,使該變量只定義一次,但是這里又有一個問題,該解決辦法只適用C而不適用C++,在C++中,即使在頭文件中加了#ifndef X,鏈接錯誤同樣會發生,原因是C++中#ifndef X的作用域僅在單個文件中,因此只要在.h中定義了變量並在不同.cpp中進行引用,鏈接時都會報重定義錯誤,再說得直白點,a.cpp和b.cpp都引用了條件編譯的g.h,g.h的條件編譯只能分別保證在a.cpp和b.cpp中不出現重復定義,但在鏈接a.o和b.o的過程中就會發現重復定義。
看下列代碼和錯誤重現:
// const.h #ifndef __CONST_H__ #define __CONST_H__ const char *zutypes[] = { "CL", "CY", "GM", "SSD", "XC", "ZS", "ZWX", "LS" , "KQWR", "LY", "KT", "DY", "FS", "GJ", "HC" , "JT", "LK", "YS", "MF", "YSH", "PJ", "FFZ" , "HZ", "TGWD", "FH", "XQ", "YD", "YH" }; // 28種指數類型映射表 #endif // __CONST_H__ // hfTrans.h #ifndef __HFTRANS_H__ #define __HFTRANS_H__ #include "const.h" #endif // __HFTRANS_H__ // hfTrans.cpp #include "hfTrans.h" ... // main.cpp #include "hfTrans.h" ...
# 控制台輸出 Linking console executable: bin/Debug/main obj/Debug/main.o:(.data+0x0): multiple definition of `zutypes' obj/Debug/hfTrans.o:(.data+0x0): first defined here collect2: ld 返回 1 Process terminated with status 1 (0 minutes, 0 seconds) 0 errors, 0 warnings
2. 解決方案
1).h的變量前用static修飾:static限制了變量的作用域,該變量僅在引用.h的源文件中有效,也就是說.h被引用了幾次這個變量就被定義了幾次,且各變量之間互不影響(各變量具有不同的內存地址)。這種方法不適用於定義全局變量,因為它們不是同一個變量(相當於多個同名的人住在不同的地方)。
// global.h #ifndef __GLOBAL_H__ #define __GLOBAL_H__ #include <stdio.h> static int var = 10; #endif // test1.cpp #include "global.h" void print1() { printf("%p = %d\n", &var, var); // 打印變量的內存地址 } // test2.cpp #include "global.h" void print2() { printf("%p = %d\n", &var, var); } // main.cpp #include "global.h" extern void print1(); extern void print2(); int main() { print1(); var = 5; printf("%p = %d\n", &var, var); print2(); return 0; }
# 輸出結果 0x8049840 = 10 0x804983c = 5 0x8049844 = 10 # var地址各不相同,內容互不影響 Process returned 0 (0x0) execution time : 0.046 s Press ENTER to continue.
根據static的上述特性,在源文件開頭處(緊跟include后)可直接定義static非全局變量。
2).h的變量前用const修飾:表示此變量是常量,內容不可修改,與static特性相似,該常量僅在引用.h的源文件中有效。將上述例子中的static關鍵字修改為const,可以發現每個源文件的var地址依然不同,因此這種方法也不適用於定義全局變量(當然,在某種程度上,如果不在乎重復分配內存也可以用這種方法)。
// global.h #ifndef __GLOBAL_H__ #define __GLOBAL_H__ #include <stdio.h> const int var = 10; #endif
# 輸出結果 0x80485e0 = 10 0x80485d0 = 10 0x80485f0 = 10 Process returned 0 (0x0) execution time : 0.005 s Press ENTER to continue.
到這里可以發現在C++中,const和static一樣都可以使變量具有內部鏈接屬性。只有變量的作用域為當前模塊時,該變量才可以在頭文件中定義,否則鏈接時就會報重定義錯誤,因此只有const和static變量可以在頭文件中定義。另外在C++中,const值在編譯期間被保存在符號表中,即使在運行期間通過間接方法改變了const值(改變的其實是內存中的拷貝),輸出值也不會改變。
根據const的上述特性,在源文件開頭處(緊跟include后)可直接定義const非全局常量。
定義一般常量沒有問題,需要注意的是用const定義指針,指針必須符合上述原則才能通過鏈接:
// global.h const char str[][8] = { "Hello, ", "World!" }; // 正確, str是常量字符串數組 char const str[][8] = { "Hello, ", "World!" }; // 正確, 同上 static char str[][8] = { "Hello, ", "World!" }; // 正確 static const char str[][8] = { "Hello, ", "World!" }; // 正確 const char* str[] = { "Hello, ", "World!" }; // 錯誤,str非內部鏈接 char* const str[] = { "Hello, ", "World!" }; // 正確,但不建議常量字符串到char*的轉換 const char* const str[] = { "Hello, ", "World!" }; // 正確, str是指向常量字符串的常量指針數組 static char* str[] = { "Hello, ", "World!" }; // 正確,但不建議 static const char* str[] = { "Hello, ", "World!" }; // 正確
3)定義全局常量時經常將const和extern結合使用,前面提到const修飾的變量具有內部鏈接屬性,用extern修飾的變量具有外部鏈接屬性,也就是說將兩者結合就可以實現全局和只讀變量的目的,但需要說明的是,變量必須在頭文件中給出聲明而不是定義,然后在與頭文件對應的源文件中給出定義(也可以在任意引用該頭文件的源文件中給出定義,但不推薦)。
// global.h #ifndef GLOBAL_H_INCLUDED #define GLOBAL_H_INCLUDED #include <stdio.h> extern const int var; // 聲明var #endif // GLOBAL_H_INCLUDED // global.cpp #include "global.h" const int var = 10; // 正確,定義var // test1.cpp #include "global.h" //const int var = 10; // 正確,但不推薦,容易出現重定義 void print1() { const int var = 0; // 錯誤,var的作用域為print1() printf("%p = %d\n", &var, var); // 局部變量var覆蓋了全局變量 } // test2.cpp #include "global.h" void print2() { printf("%p = %d\n", &var, var); } // main.cpp #include "global.h" extern void print1(); extern void print2(); int main() { print1(); printf("%p = %d\n", &var, var); print2(); return 0; }
# 輸出結果 0xbfcff14c = 0 0x80485d0 = 10 0x80485d0 = 10 # var地址相同 Process returned 0 (0x0) execution time : 0.014 s Press ENTER to continue.
可以看到在global.cpp中定義的var具有全局唯一性,在每個模塊中訪問的var地址都相同,例子的var是常量,不能改變它的值,如果在頭文件中聲明extern int var並在源文件中定義int var = 10,然后在需要用到var的模塊中引入該頭文件,就可以實現C語言的全局變量,並且它的值可以被改變。
3. 其他補充
環境:本文代碼在Red Hat Enterprise Linux Workstation release 6.1 (Santiago),Linux Kernel 2.6.32-131.0.15.el6.i686,GCC 4.4.5 20110214下調試通過。
原則:注意聲明和定義的區別,避免在頭文件中定義變量。
編譯單元:一個編譯單元就是一個經過預處理的源文件(.c\.cpp)。
內部鏈接:如果一個名稱對於它的編譯單元來說是局部的,並且在鏈接的時候不會與其它編譯單元中同樣的名稱相沖突,則這個名稱具有內部鏈接。
外部鏈接:如果一個名稱在鏈接時可以和其他編譯單元交互,那么這個名稱就具有外部鏈接。
分別編譯:每個文件中所用到的名字及其類型,必須在這個文件中進行聲明,使該文件的編譯工作與整個程序的其他文件無關。
C++規定,有const修飾的變量,不但不可修改,還都將具有內部鏈接屬性,也就是只在本文件可見。這是原來C語言的static修飾字的功能,現在const也有這個功能了。
C++又補充規定,extern const聯合修飾時,extern將壓制const的內部鏈接屬性。
C++定義全局變量的方法:在.h文件中聲明extern int var; 在.cpp文件中定義int var = 10;
4. 參考資料