看开源代码利器—用Graphviz + CodeViz生成C/C++函数调用图(call graph)

1、Graphviz + CodeViz简单介绍

CodeViz是《Understanding The Linux Virtual Memory Manager》的做者 Mel Gorman 写的一款分析C/C++源代码中函数调用关系的open source工具（相似的open source软件有 egypt、ncc）。其基本原理是给 GCC 打个补丁（若是你的gcc版本不符合它的要求还得先下载正确的gcc版本），让它在编译每一个源文件时 dump 出其中函数的 call graph，而后用 Perl 脚本收集并整理调用关系，转交给Graphviz绘制图形（Graphviz属于后端，CodeViz属于前端）。

CodeViz 本来是做者用来分析 Linux virtual memory 的源码时写的一个小工具，如今已经基本支持 C++ 语言，最新的 1.0.9 版能在 Windows + Cygwin 下顺利地编译使用。

基本介绍就到这儿，若是你对其原理比较感兴趣，能够参考这篇文章：egypt分析函数调用关系图(call graph)的几种方法

2、Graphviz + CodeViz编译安装

1. 安装 GraphViz

调用图的生成依赖于 GraphViz，因此首先要安装 GraphViz。能够下载源码包编译、安装（下载主页：http://www.graphviz.org/Download.php）。
若是是Ubuntu系统能够直接apt安装： sudo apt-get install graphviz

2. 安装 CodeViz

下载CodeVize源码包：http://www.csn.ul.ie/~mel/projects/codeviz/
解压：tar xvf codeviz-1.0.12.tar.gz （目前最新版是1.0.12）

进入解压后的目录：cd codeviz-1.0.12/

CodeViz 使用了一个 patch 版本的 GCC 编译器，并且不一样的 CodeViz 版本使用的GCC 版本也不一样，能够下载 CodeViz 的源码包后查看 Makefile 文件来肯定要使用的 GCC 版

本，codeviz-1.0.12 使用 GCC-4.6.2。实际上安装 CodeViz 时安装脚本make会检查当前的GCC版本若是不符合则会自动下载对应的 GCC并打 patch，但因为GCC较大若是网速很差且在虚拟机中的话容易下载失败或系统错误什么的，所以这里咱们仍是分步安装比较好，先安装gcc再回来安装 CodeViz。

（1）安装 GCC

下载gcc-4.6.2.tar.gz到 cd codeviz-1.0.12目录下的compilers里。
下载地址：ftp://ftp.gnu.org/pub/gnu/gcc/gcc-4.6.2/gcc-4.6.2.tar.gz

CodeViz 的安装脚本 compilers/install_gcc-4.6.2.sh 会自动检测 compilers 目录下是否有 gcc 的源码包，若没有则自动下载并打 patch。这里前面已经下载，直接移到该目录便可,则剩下的就是解压安装了。install_gcc-3.4.6.sh 会解压缩 gcc打 patch，并将其安装到指定目录,如果没有指定目录,则缺省使用$HOME/gcc-graph，一般指定安装在/usr/
local/gcc-graph(这时须要 root 权限)。

安装： ./install_gcc-4.6.2.sh

注意：这里可能安装时有些错误，具体错误及解决方案见后面。

（2）安装 CodeViz
./configure && make install-codeviz

注1：不须要 make ，由于make的做用就是检测是否有gcc若没有则下载源码包，因此这里只要安装 codeviz 便可。具体查看 Makefile 文件。

注意：这里为何不是一般用的make install，由于这里make install的做用是先安装gcc再安装codeviz，而前面已经安装了 gcc，因此这里只须要安装 codeviz ，即make install-codeviz脚本，该脚本也就是将genfull 和 gengraph 复制到/usr/local/bin 目录下。

目前为止,CodeViz 安装完成了。

3、基本使用方法

GraphViz 支持生成不一样风格的调用图,可是一些须要安装额外的支持工具或者库程序，有兴趣的朋友能够到官网上查找相关资料。这里重点讲述 CodeViz 的使用方法，具体的图像风格控制再也不详述。

CodeViz 使用两个脚原本生成调用图，一个是 genfull，该脚本能够生成项目的完整调用图，所以调用图可能很大很复杂，缺省使用 cdepn 文件来建立调用图；另外一个是gengraph，该脚本能够对给定一组函数生成一个小的调用图，还能够生成对应的postscript 文件。安装时这两个脚本被复制到/usr/local/bin 目录下，因此能够直接使用而不须要指定路径。其基本步骤以下：

下面以编译一个简单的test.c文件为例进行说明：

1. 使用刚刚安装的gcc-4.6.2来编译当前目录下全部.c文件，gcc/g++为编译的每一个 C/C++文件生成.cdepn 文件。只要编译(参数 -c)就行，无需连接。

即为：$ ~/gcc-graph/bin/gcc test.c

2.调用genful会在当前目录生成一个full.graph文件，该脚本能够生成项目的完整调用图信息文件，记录了全部函数在源码中的位置和它们之间的调用关系。 所以调用图信息文件可能很大很复杂,，缺省使用 cdepn 文件来建立调用图信息文件。

即为：$ genfull

3. 使用gengraph能够对给定一组函数生成一个小的调用图，显示函数调用关系。

即为：$ gengraph

4、简单示例演示

本身编写个简单的程序，看下效果再说~~~

 

// test.c
#include <stdio.h>

void test1();
void test2();
void test3();

int main()
{
    test1();
    test2();

    return 0;
}

void test1()
{
}

void test2()
{
    test2();
}

void test3()
{
}

 

 

按照上面的三个步骤依次进行以下图所示：

打开main.ps看到效果以下，一目了然：

5、进阶使用

固然你们使用CodeViz都不是用来玩的，而是用于真正的项目中，四中简单的使用根本不够，下面来点稍微高深点的。

1. 先来分析下上面的执行流程

首先使用刚刚安装的gcc编译咱们的.c文件（PS：这里必定要指定刚刚安装gcc的 地方，不然用的是系统gcc而非咱们安装的gcc），而后genfull建立full.graph文件，可使用genfull --help或者genfull --man来查看如何使用。最简单的方式是在项目的顶级目录以无参数方式运行。因为项目的彻底调用信息很是庞大，因此一般只是简单的生成项目的 full.graph，而后在后面使用genfull获取须要的调用信息。如果须要完整信息则将full.graph由dot处理而后查看来生成的 postscript文件。（dot是GraphViz中的一个工具，具体使用没有深究过，感兴趣的读者能够自行查阅~~~）。到test.c所在目录运 行genfull看到生成了full.graph文件，你们能够用cat查看下。接下来使用gengraph生成函数调用图，可使用gengraph --help或gengraph --man来查看如何使用。对于我而言，目前只关注下面几个选项就够了，即：

-f：指定顶级函数，即入口函数，如main等（固然不限定是main了）；

-o：指定输出的postfile文件名，不指定的话就是函数名了，如上面的main；

--output-type：指定输出类型，例如png、gif、html和ps，缺省是ps，如上面的main.ps；

-d：指定最大调用层数；

-s：仅仅显示指定的函数，而不对其调用进行展开；

-i：忽略指定的函数

-t：忽略Linux特有的内核函数集；

-k：保留由-s忽略的内部细节造成的中间文件，为sub.graph

2. 使用gengraph时的选项参数值要使用""括起来，例如：

gengraph --output-type "png" -f main

3. 命名冲突问题

在一个复杂的项目中，full.graph并不十分完美。例如，kernel中的模块 有许多同名函数，这时genfull不能区分它们，有两种方法能够解决，其中第一种方法太复杂易错不推荐使用，这里就介绍下第二种方法，即便用 genfull的-s选项，-s指定了检测哪些子目录。例如kernel中在mm目录和drivers/char/drm目录下都定义了 alloc_pages函数，那么能够如下列方式调用genfull：

genfull -s "mm include/linux drivers/block arch/i386"

实际的使用中，-s很是方便，请你们记住这个选项。

4. 使用Daemon/Client模式

当full.graph很大时，大量的时间花费到读取输入文件上了，例如kernel的full.graph是很大的，前面生成的大约有15M，这还不是所有内核的函数调用分析信息。为了节省时间，能够讲gengraph以daemon方式运行，这药使用-p选项：

gengraph -p -g linux-2.6.25/full.graph

该命令返回时gengraph以daemon方式运行，同时在/tmp目录下生成了codeviz.pipe文件。要生成函数调用图，可使用-q选项：

gengraph -q -t -d 2 -f alloc_pages

要终止gengraph的运行，使用以下命令：

echo QUIT > /tmpcodeviz.pipe

6、进阶演示

以分析《嵌入式实时操做系统 uC/OS-II (第二版)》中的第一个范例程序为例，是什么程序没关系，这里主要看的是如何使用及使用后的效果。

首先分析main()：

1. gengraph --output-type gif -f main
分析main()的call graph，获得的图以下，看不出要领：

2. gengraph --output-type gif -f main -s OSInit
暂时不关心OSInit()的内部实现细节(参数 -s)，让它显示为一个节点。获得的图以下，有点乱，不过好多了：

3. gengraph --output-type gif -f main -s OSInit -i "OSCPUSaveSR;OSCPURestoreSR"
基本上每一个函数都会有进入/退出临界区的代码，忽略之(参数 -i)。获得的图以下，基本清楚了：

4. gengraph --output-type gif -f main -s "OSInit;OSSemCreate" -i "OSCPUSaveSR;OSCPURestoreSR" -k
OSSemCreate()的内部细节彷佛也不用关心，不过保留中间文件sub.graph(参数 -k)，获得的图以下，

5. dot -Tgif -o main.gif sub.graph
修改sub.graph，使图形符合函数调用顺序，最后获得的图以下，有了这个都不用看代码了:)

接着分析OSTimeDly()的被调用关系：

gengraph --output-type gif -r -f OSTimeDly

看看哪些函数调用了OSTimeDly()，参数 -r ，Task()和TaskStart()都是用户编写的函数：

最后看看Task()直接调用了哪些函数：

gengraph --output-type gif -d 1 -f Task

只看从Task出发的第一层调用（参数 -d 1）：

 

 

7、安装过程出现的错误及解决方案

1. 在运行./install_gcc-4.6.2.sh时出现下面错误：

gcc configure: error: Building GCC requires GMP 4.2+, MPFR 2.3.1+ and MPC 0.8.0+

从错误中能够看出：GCC编译须要GMP， MPFR， MPC这三个库（有的系统已经安装了就没有这个提示，个人没有安装），有两种安装方法（建议第二种）：

（1）二进制源码安装（强烈不推荐）

我使用的版本为gmp-4.3.2，mpfr-2.4.2和mpc-0.8.1，在“ftp://gcc.gnu.org/pub/gcc/infrastructure/" 下载，根据提示的顺序分别安装GMP，MPFR和MPC（mpfr依赖gmp，mpc依赖gmp和mpfr），这里所有本身指定了安装目录，若是没有指定 则默认分装在在/usr/include、/usr/lib和/usr/share，管理起来不方便，好比想卸载的时候还得一个个去找：

安装gmp: ./configure --prefix=/usr/local/gmp-4.3.2; make install

安装mpfr: ./configure --prefix=/usr/local/mpfr-2.4.2 --with-gmp=/usr/local/gmp-4.3.2/; make install

安装mpc: ./configure --prefix=/usr/local/mpc-0.8.1 --with-gmp=/usr/local/gmp-4.3.2/ --with-mpfr=/usr/local/mpfr-2.4.2/; make install

PS：安装过程当中可能又出现新的错误提示，请看二、三、4条。

配置环境变量：我这里指定了安装位置，若是没有指定则 这几个库的默认位置是/usr/local/include和/usr/local/lib，无论有没有指定GCC编译时均可能会找不到这三个库，须要确 认库位置是否在环境变量LD_LIBRARY_PATH中，查看环境变量内容能够用命令
$echo $LD_LIBRARY_PATH
设置该环境变量命令以下：

指定安装：export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/gmp-4.3.2/lib:/usr/local/mpfr-2.4.2/lib:/usr/local/mpc-0.8.1/lib

默认安装：$export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib

PS：十分不推荐这种安装方法，通常来讲这样的确能够成功安装，可是也不排除安装过程当中又出现新的问题，具体看问题5。

（2）gcc自带脚本安装（强烈推荐）

方法（1）的安装方法十分繁琐，安装过程当中可能出现各类预料不到的新错误，所以gcc 源码包中自带了一个gcc依赖库安装脚本download_prerequisites，位置在gcc源码目录中的 contrib/download_prerequisites，所以只须要进入该目录，直接运行脚本安装便可：. /download_prerequisites

PS：该脚本内容以下：

 

#! /bin/sh

# Download some prerequisites needed by gcc.
# Run this from the top level of the gcc source tree and the gcc
# build will do the right thing.
#
# (C) 2010 Free Software Foundation
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program. If not, see http://www.gnu.org/licenses/.

MPFR=mpfr-2.4.2
GMP=gmp-4.3.2
MPC=mpc-0.8.1

wget ftp://gcc.gnu.org/pub/gcc/infrastructure/$MPFR.tar.bz2 || exit 1
tar xjf $MPFR.tar.bz2 || exit 1
ln -sf $MPFR mpfr || exit 1

wget ftp://gcc.gnu.org/pub/gcc/infrastructure/$GMP.tar.bz2 || exit 1
tar xjf $GMP.tar.bz2  || exit 1
ln -sf $GMP gmp || exit 1

wget ftp://gcc.gnu.org/pub/gcc/infrastructure/$MPC.tar.gz || exit 1
tar xzf $MPC.tar.gz || exit 1
ln -sf $MPC mpc || exit 1

rm $MPFR.tar.bz2 $GMP.tar.bz2 $MPC.tar.gz || exit 1

可见是经过wget的方式下载安装，所以若是没有安装wget则须要先安装下。

你们仔细看下这个脚本，发现很是简单，就是从网上自动下载三个依赖库并解压，而后创建三个更名后的软连接分别指向这三个库，这里创建软连接过程当中也可能出错，具体看问题6，你们也能够本身修改脚本，改为直接修更名称而后移到gcc目录下。

技巧：从这里也能够看出，gcc所依赖的库其实只要解压了放在gcc当前目录下就好了，方法（1）的那么多步骤其实均可以省掉，直接将下载的三个压缩包解压后更名移到gcc下面便可，也不用设置环境变量了。

2. 编译gmp时出现错误：

No usable m4 in $PATH or /usr/5bin (see config.log for reasons).
由此能够看出是缺乏M4文件。能够去这里下载：http://ftp.gnu.org/gnu/m4/而后编译安装，我因为是Ubuntu系统，就直接

sudo apt-get install m4安装了。

3. 安装mpfr时出现错误：

configure: error: gmp.h can't be found, or is unusable.

这是由于在安装mpfr时未先安装gmp致使的，mpfr依赖于gmp。

4. 安装mpc时出现错误：

configure: error: libgmp not found or uses a different ABI.和configure: error: libmpfr not found or uses a different ABI.“。

一样是由于未安装mpc依赖的库gmp和mpfr。

5. 在运行./install_gcc-4.6.2.sh过程当中出现错误，即按照gcc过程当中出现的问题：

（1）libmpfr.so.1: cannot open shared object file: No such file or directory

分析：该脚本就是安装gcc，可是若是你出现了问题1，而且使用方法（1）解决该问题，那么你后期就可能出现这样的问题，固然你运气没那么背的话通常不会出现这样的问题，反正我运行比较背，出现了这样的问题。

解决方法：能够参考这篇文章http://blog.csdn.net/leo115/article/details/7671819解决。

 

（2）../../gcc-4.6.2/gcc/realmpfr.h:27:17: fatal error: mpc.h: No such file or directory
分析：gcc没找到所依赖的库mpc，缘由不少，最有多是你没设置环境变量或mpc放的地方不对。

解决方法：设置环境变量，看问题1。

 

（3） /usr/include/stdc-predef.h:30:26: fatal error: bits/predefs.h: No such file or directory

分析：用命令“locate bits/predefs.h”找下该头文件的路径，发现是在'/usr/include/x86_64-linux-gnu'
解决方法：设置环境变量：
#export C_INCLUDE_PATH=/usr/include/i386-linux-gnu && export CPLUS_INCLUDE_PATH=$C_INCLUDE_PATH

（4） /usr/bin/ld: cannot find crti.o: No such file or directory

分析：一样用“locate crti.o” 找下这个文件，在'/usr/lib/i386-linux-gnu/crti.o'。

解决方法：设置LIBRARY_PATH (LDFLAGS)这个环境变量以下：
#export LIBRARY_PATH=/usr/lib/i386-linux-gnu

（5）unwind-dw2.c:1031: error: field `info' has incomplete type

分析：这个错误搞了很久，由于网上找不到对应的解决方法，只说这是gcc的一个bug。

解决方法：深刻到源文件中，发现错误的地方是这样的：

 

static _Unwind_Reason_Code
uw_frame_state_for (struct _Unwind_Context *context, _Unwind_FrameState *fs)
{
  struct dwarf_fde *fde;
  struct dwarf_cie *cie;
  const unsigned char *aug, *insn, *end;
 
  memset (fs, 0, sizeof (*fs));
  context->args_size = 0;
  context->lsda = 0;
 
  fde = _Unwind_Find_FDE (context->ra - 1, &context->bases); //这里返回了NULL
  if (fde == NULL)
    {
      /* Couldn't find frame unwind info for this function.  Try a
     target-specific fallback mechanism.  This will necessarily
     not profide a personality routine or LSDA.  */
#ifdef MD_FALLBACK_FRAME_STATE_FOR
      MD_FALLBACK_FRAME_STATE_FOR (context, fs, success); // 出错的地方
      return _URC_END_OF_STACK;
    success:
      return _URC_NO_REASON;
#else
      return _URC_END_OF_STACK;  //出错返回
#endif
    }
.....
}

 

 

出错的地方用标注了，由于fde返回了NULL，致使不能找到frame unwind info，最重要的是下面这个方法

MD_FALLBACK_FRAME_STATE_FOR (context, fs, success);  

出错了，为何返回NULL我确定研究不出来，只知道这个函数调用失败了，致使不成功，因而个人解决方法十分偷懒，就是将下面的两行注释掉了，直接success，哈哈，勿喷我，由于这样作事后就解决了，后面一路成功~~~

// MD_FALLBACK_FRAME_STATE_FOR (context, fs, success); // 出错的地方  
// return _URC_END_OF_STACK; 

 

6.  解决ln -s 软连接产生Too many levels of symbolic links错误

从网上查找了一下缘由，原来是创建软链接的时候采用的是相对路径，因此才会产生这样的错误，解决方式是采用绝对路径创建软连接：这样问题就解决了。

8、小结

本文查阅了网上的许多资料比较详细的讲解了CodeViz的安装和使用。CodeViz依赖于GraphViz，于是能够生成十分丰富的函数调用图。具体选项的使用及图像格式的选择可由读者根据我的须要和偏好本身揣摩使用。在分析源码的时候，把这些图形打印在手边，在上面作笔记，实在方便收益颇多。

9、参考资料：

1. http://blog.csdn.net/delphiwcdj/article/details/9936717

2. http://www.cppblog.com/hacrwang/archive/2007/06/30/27296.html

3. http://www.cnblogs.com/xuxm2007/archive/2010/10/14/1851086.html