基于Verialtor源码开发DLL时链接svGetScope报未定义引用错误

• 基于Verilator源码构建原生支持的.dll动态库，项目使用typedef void* svScope作为通用作用域句柄，待开发的动态库复用该句柄类型。
• 按如下方式定义导出函数：__declspec(dllexport) svScope svGetScope( void );

相关代码 #

头文件svdpi.h #

#ifndef INCLUDED_SVDPI
#define INCLUDED_SVDPI

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

__declspec(dllexport) typedef void* svScope;

__declspec(dllexport) svScope svGetScope( void );

#ifdef __cplusplus
}
#endif
#endif

导出函数实现svdpi.cpp #

#include "svdpi.h"

svScope svGetScope() {return 0;}

测试代码test.cpp #

#include <stdlib.h>
#include <stdio.h>
#include "svdpi.h"

int main()
{
    svScope Scope = svGetScope();
}

遇到的问题 #

完成动态库编译后，对测试程序执行链接操作，链接器可以正常识别到目标库文件，但触发以下错误：

• 执行的链接命令：g++ -o test.exe -s test.o -L. -lsvdpi
• 完整报错：

c:/mingw/bin/../lib/gcc/mingw32/9.2.0/../../../../mingw32/bin/ld.exe: test.o:test.cpp:(.text+0xf): undefined reference to `_imp__svGetScope'
collect2.exe: error: ld returned 1 exit status

错误原因 #

• 头文件写死了__declspec(dllexport)修饰符，没有区分动态库编译阶段和应用调用阶段的声明属性：编译调用方代码时，因为没有声明对应的导入属性，编译器生成的符号引用无法和动态库导出的符号匹配。当编译器发现调用程序中只有声明、没有实现的dllexport修饰的函数时，会默认生成带_imp__前缀的导入符号引用，但动态库侧没有正确导出对应符号。
• 错误地将__declspec(dllexport)加在typedef语句上，该用法属于无效语法（typedef仅定义类型别名，不涉及实体导出），可能导致编译器对后续函数声明的修饰属性解析偏差，让函数导出标记失效。
• 编译动态库时未显式生成对应的导入库（.a文件），链接器找到的库文件未包含svGetScope对应的导入符号，导致符号解析失败。

解决方法 #

• 重构头文件的宏定义逻辑，统一管理导入导出属性：

  #ifndef INCLUDED_SVDPI
  #define INCLUDED_SVDPI
  
  #include <stdint.h>
  
  // 动态库编译时定义SVDPI_BUILD，否则按导入处理
  #ifdef SVDPI_BUILD
  #define SVDPI_API __declspec(dllexport)
  #else
  #define SVDPI_API __declspec(dllimport)
  #endif
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  // 移除typedef上无效的导出修饰符
  typedef void* svScope;
  
  SVDPI_API svScope svGetScope( void );
  
  #ifdef __cplusplus
  }
  #endif
  #endif
  

• 编译动态库源码时，先定义SVDPI_BUILD宏，显式生成动态库和对应的导入库：

  g++ -DSVDPI_BUILD -shared -o svdpi.dll svdpi.cpp -Wl,--out-implib,libsvdpi.a
  

• 清理所有旧的编译中间文件、旧动态库、旧导入库，重新编译测试代码并执行链接，避免残留目标文件导致符号不匹配：

  g++ -c test.cpp -o test.o
  g++ -o test.exe -s test.o -L. -lsvdpi
  

内容的提问来源于stack exchange，提问作者lukas