Linux下使用nm命令排查和解決“undefined reference to ”

一、案例

     編譯出一個動態庫.libXXXEngine.so。然後直接在另一個工程中，把標頭檔案include進來，並link到該庫：-lXXXEngine.

嘗試編譯，出錯：

.//libXXXEngine.so:undefined reference to`CHttpParser::GetCurrentHttpMethod(http_method_t&)'

 

.//libGenaEngine.so: undefined reference to `CHttpParser::CHttpParser(std::basic_string<char, std::char_traits<char>, std::allocator<char> >)'
.//libGenaEngine.so: undefined reference to `CHttpParser::ExactResultFromHttpMsgBody(std::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::basic_string<char, std::char_traits<char>, std::allocator<char> >&)'
.//libGenaEngine.so: undefined reference to `CHttpParser::parse(std::basic_string<char, std::char_traits<char>, std::allocator<char> >)'
collect2: ld returned 1 exit status

從描述上看，以下四個函式沒有定義：

 

（1） CHttpParser::GetCurrentHttpMethod(http_method_t&)

（2）CHttpParser::CHttpParser(std::basic_string<char, std::char_traits<char>, std::allocator<char> >)

（3）CHttpParser::ExactResultFromHttpMsgBody(std::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::basic_string<char, std::char_traits<char>, std::allocator<char> >&)'

（4）CHttpParser::parse(std::basic_string<char, std::char_traits<char>, std::allocator<char> >)

 

然而奇怪的是，當我跟進libXXXengine.so的具體程式碼時，卻發現標頭檔案和原始檔的定義和宣告都可以找到。那麼究竟什麼原因呢？

二 問題分析

    出現這種錯誤，有幾個原因：

（1）一是使用者自己定義的函式或者全域性變數所在原始碼檔案，沒有被編譯、連線。

（2）一是使用者自己定義的函式或者全域性變數沒有定義。

（3） 未定義的符號是一個動態庫函式，在源程式中使用了該庫函式，而連線過程中還沒有給定相應的函式庫的名稱，或者是該檔案庫的目錄名稱有問題.

即：.so檔案沒有把所有需要的庫都連結上。使用了庫中定義的實體，但沒有指定庫（-lXXX）或者沒有指定庫路徑（-LYYY），會導致該錯誤,

（4）C/C++相互依賴和連結 
gcc和g++編譯結果的混用需要保證能夠extern "C" 兩邊都可以使用的介面,在我們的64位環境中gcc連結g++的庫還需要加上 -lstdc++。

     經排查，我們在makefile中通過-lXXEngine正確連結了libXXXEngine.so，同時，我們也把相應的標頭檔案放到我當前工程目錄下了。然而，被告知且出錯的函式都是在動態庫中的。好奇怪！

    為了進一步找到問題的root cause,我們使用了nm命令來進一步排查：

nm libXXXEngine.so |grep CHttpParser

 

              U _ZN11CHttpParser20GetCurrentHttpMethodER13http_method_t
                 U _ZN11CHttpParser26ExactResultFromHttpMsgBodyESsRSs
                 U _ZN11CHttpParser5parseESs
                 U _ZN11CHttpParserC1ESs
00000000000134e6 W _ZN5boost10shared_ptrI11CHttpParserE4swapERS2_
0000000000012e56 W _ZN5boost10shared_ptrI11CHttpParserEC1ERKS2_
0000000000012e30 W _ZN5boost10shared_ptrI11CHttpParserEC1Ev
0000000000014cda W _ZN5boost10shared_ptrI11CHttpParserEC1IS1_EEPT_
0000000000012cda W _ZN5boost10shared_ptrI11CHttpParserED1Ev
0000000000013df4 W _ZN5boost10shared_ptrI11CHttpParserEaSERKS2_
000000000001348b W _ZN5boost14checked_deleteI11CHttpParserEEvPT_
0000000000014c4c W _ZN5boost6detail12shared_countC1I11CHttpParserEEPT_
0000000000013bae W _ZN5boost6detail17sp_counted_impl_pI11CHttpParserE11get_deleterERKSt9type_info
0000000000013b92 W _ZN5boost6detail17sp_counted_impl_pI11CHttpParserE7disposeEv
0000000000013452 W _ZN5boost6detail17sp_counted_impl_pI11CHttpParserEC1EPS2_
0000000000014d1e W _ZN5boost6detail17sp_counted_impl_pI11CHttpParserED0Ev
0000000000014d5a W _ZN5boost6detail17sp_counted_impl_pI11CHttpParserED1Ev
000000000001591c W _ZNK5boost10shared_ptrI11CHttpParserEptEv
00000000000134b4 W _ZSt4swapIP11CHttpParserEvRT_S3_
000000000021ba40 V _ZTIN5boost6detail17sp_counted_impl_pI11CHttpParserEE
0000000000017420 V _ZTSN5boost6detail17sp_counted_impl_pI11CHttpParserEE
000000000021ba00 V _ZTVN5boost6detail17sp_counted_impl_pI11CHttpParserEE
0000000000017100 r _ZZNK5boost10shared_ptrI11CHttpParserEptEvE19__PRETTY_FUNCTION__

 

 

命令輸出結果顯示，那些報錯的函式的符號 同樣可以在nm裡找到。

不同的是，這四個出錯的函式，輸出的前半部分為空。

這就是異常和問題所在！

 

下面我們只要對nm命令稍作了解：

nm命令還是比較簡單而且強大的。它用來列出一個目標檔案中的各種符號。符號的種類很多，以下是一些常見的符號型別

 

至此，我們可以推斷：動態庫中有未定義的符號，說明該動態庫的編譯有問題，即是如下原因之一：

（1）一是使用者自己定義的函式或者全域性變數所在原始碼檔案，沒有被編譯、連線。

（2）一是使用者自己定義的函式或者全域性變數沒有定義。

這種問題的解決，首先就要檢查動態庫的makefile寫的是否有問題。

果然，發現makefile裡沒有把該出錯函式所在的定義的原始檔沒有編譯進去。

 

 

三 問題解決

     找到了原因，問題解決就方便了。修改.so的makefile即可。

svn diff

-COM_SRCS := $(GENASRCDIR)/CGenaEngine.cpp
+COM_SRCS := $(GENASRCDIR)/CGenaEngine.cpp   $(HTTPSRCDIR)/CHttpMiniParser.cpp   -----》把CHttpMiniParser.cpp  編譯進去。