NS3 使用 waf 工具添加外部库

我最近在写 NS3 的时候想要把他人写好的外部库添加到 NS3 中一起编译，在 Linux 系统中，添加外部库往往通过编译选项 -l<外部库名> 来添加，而在大型项目中往往需要把外部库写到 Makefile 文件中通过 make 来编译。奈何 NS3 的早期版本都是使用 waf 编译的，这导致项目中是没有 Makefile 文件的，无法直接通过修改 Makefile 文件实现（如果使用的是 NS3 晚期的版本——例如3.39等，官方文档就提供了如何使用外部库 HOWTO use ns-3 with other libraries）。

建议了解本文之前先弄明白 C++ 是怎么通过 Makefile 编译的，传送门：在Linux中开发C++

在我尝试的过程中，我是看了 NS3使用waf工具添加外部库（static library or shared library）亲测可用，已成功添加ZMQ库 这一篇文章成功编译的，但我感觉这种做法还不够优雅，因此我读过 waf 的代码之后重新说一下怎么做，如果赶时间可以直接阅读上面这篇文章。

在本文，我们则通过修改 waf 的具体代码文件——wscript 来引入第三方库。我们直接修改 NS3 根目录下的 wscript 文件即可。点开该文件可以发现，这个其实就是 python 代码，而作者在 938-946行其实给出了添加用户自定义编译 flags 的线索，如下：

    # append user defined flags after all our ones
    for (confvar, envvar) in [['CCFLAGS', 'CCFLAGS_EXTRA'],
                              ['CXXFLAGS', 'CXXFLAGS_EXTRA'],
                              ['LINKFLAGS', 'LINKFLAGS_EXTRA'],
                              ['LINKFLAGS', 'LDFLAGS_EXTRA']]:
        if envvar in os.environ:
            value = shlex.split(os.environ[envvar])
            conf.env.append_value(confvar, value)

这一段代码的意思就是额外对 conf.env 的 “CCFLAGS”、“CXXFLAGS”、“LINKFLAGS” 变量添加值，对应值的来源是环境变量 “CCFLAGS_EXTRA”、 “CXXFLAGS_EXTRA”、 “LINKFLAGS_EXTRA”、 “LDFLAGS_EXTRA”。根据我们对 C++ 编码的经验，这里添加的三个变量含义如下：

• CCFLAGS：编译 C语言文件（.c）时额外添加的选项，例如我们可以添加 -Wall 等等。
• CXXFLAGS：编译 C++语言文件（.cc、.cpp）时额外添加的选项，同上。
• LINKFLAGS：连接库时给出的共享链接库，格式即 -l<外部库名>。

注：C 语言编译分为编译和连接两个过程，如不了解先得去看看 在Linux中开发C++ ，我们常用的 IDE 以及 gcc编译 都把这两个过程给合并了而已。

显然，我们要添加外部库，就需要把外部库文件交给 LINKFLAGS 变量，因此我们只需要设置 “LINKFLAGS_EXTRA” 和 “LDFLAGS_EXTRA” 两个环境变量就行。在 C++ 编译中，“LIBRARY_PATH” 环境变量给出编译过程中所需要的动态库路径，而 “LD_LIBRARY_PATH” 则给出运行过程中所需要的动态库路径。只不过在 waf 这里把这两个路径给合并了而已，所以也推荐为了避免错误，我们把第三方库生成的编译库和运行库都放一起，然后指定同一个路径就行。

在上面那篇文章中，作者给出引入第三方库 -lzmq 的成功经验为在NS3根目录的 wscript 中，def configure 函数添加如下代码：

   #Add extenal lib zmq
                   
    conf.env.append_value('INCLUDES', '/usr/local/include')
    # conf.env.append_value('LINKFLAGS', '-lzmq' )
    conf.env.append_value("LINKFLAGS", ["-lzmq","-L/usr/local/lib/libzmq.a"])
    # conf.env.append_value("LIB", ["Geographic"])
    #仅添加上面代码并不行，会报出找不到函数的未定义错误
    
    #添加这些后，突然就成功了哈哈哈哈
    conf.env.append_value("LINKFLAGS", ["-L/usr/local/lib"])  #链接库地址
    conf.env.append_value('CXXFLAGS', '-I/usr/local/include/zmq') #头文件地址
    conf.env.append_value("LIB", ["zmq"]) #用于列出链接库列表

这里的几句话其实只有两句是有用的：

    conf.env.append_value("LINKFLAGS", ["-L/usr/local/lib"])  #链接库地址
    conf.env.append_value("LIB", ["zmq"]) #用于列出链接库列表

而至于添加 INCLUDES 当且仅当你是使用 #include<> 来引用的时候才有必要，但我其实不太推荐这样，你把外部库的 include 文件夹放 workspace 下我认为是更合理一些的，在根目录下单独建一个 include 文件夹即可。而前面一句直接 “-L/usr/local/lib/libzmq.a” 这是不符合逻辑的呀，怎么可能直接 Link 到库名上呢，只需要 Link 到放库的文件夹即可。

而上面说过，LINKFLAGS 实际上在 wscript 也提供了通过 “LINKFLAGS_EXTRA” 和 “LDFLAGS_EXTRA” 环境变量添加的方法，因此对于作者的例子来说，更优雅的做法是在运行前通过 shell 添加环境变量：

export LINKFLAGS_EXTRA="-lzmq -L/usr/local/lib"

当然如果这样添加关掉 Shell 就没了，如果希望永久保留就放到 .bashrc 文件中，这里就不展开了，具体自己百度一下：Linux 如何设置永久环境变量。当然其实临时变量问题也不大，我们这部分代码仅在 ./waf configure 的时候会运行（写在 def configure 函数中的），而我们生成了配置文件之后一般直接 ./waf build 进行编译就行了，没必要总是生成新的配置文件，所以后续我们再次编译代码的时候是没有影响的！

再说一点，就是经过我的测试， conf.env.append_value(“LIB”, [“zmq”]) 这一句话不加是会报错的，具体原因我到目前还没有完全理解，可能要完整看一下所有 wscript 才能清楚。但 wscript 里面又没有提供添加 “LIB” 的方法，因此我认为比较优雅的改动方式是，直接在它的 for 循环里增加添加 “LIB” 的方法，即把 wscript 第 938-946行 修改为：

    # append user defined flags after all our ones
    for (confvar, envvar) in [['CCFLAGS', 'CCFLAGS_EXTRA'],
                              ['CXXFLAGS', 'CXXFLAGS_EXTRA'],
                              ['LINKFLAGS', 'LINKFLAGS_EXTRA'],
                              ['LINKFLAGS', 'LDFLAGS_EXTRA'],
                              ['LIB', 'LIB_EXTRA']]:
        if envvar in os.environ:
            value = shlex.split(os.environ[envvar])
            conf.env.append_value(confvar, value)

然后我们就可以同样在 shell 中添加环境变量：

export LIB_EXTRA="zmq"

即可成功编译，这样我们修改 wscript 的次数比较少，尽量把我们自己实现的东西通过系统环境变量的方式传入会显得更优雅一些。

总结一下，如果要添加一个新的链接库，首先需要把 NS3 根目录下的 wscript 的 938-946行 修改一下；然后分别设置 LINKFLAGS_EXTRA 和 LIB_EXTRA 环境变量，最后记得 ./waf clean 之后重新 ./waf configure 再编译（./waf build）。

最后说一点：还是推荐使用 Makefile，写 CMakeLists.txt 比写这个 waf 文件要舒服多了。