创建DLL时导出所有符号

时间:2008-10-22 11:48:48

标签: c++ windows visual-studio visual-studio-2005

使用VS2005,我想创建一个DLL并自动导出所有符号,而无需在任何地方添加__declspec(dllexport),也无需手工创建.def文件。这是一种方法吗?

7 个答案:

答案 0 :(得分:37)

可以做到......

我们这样做的方法是使用链接器的/ DEF选项传递包含导出列表的"module definition file"。我从你的问题中看到你知道这些文件。但是,我们不是手工完成的。导出列表本身由dumpbin / LINKERMEMBER命令创建,并通过简单脚本将输出操作为模块定义文件的格式。

设置需要做很多工作,但它允许我们编译在Windows上没有针对Unix的dllexport声明创建的代码。

答案 1 :(得分:29)

简短回答

你可以借助新版本的CMake(任何版本的cmake-3.3.20150721-g9cd2f-win32-x86.exe或更高版本)来实现。

目前它在开发部门。 稍后,该功能将添加到cmake-3.4的发布版本中。

链接到cmake dev:

cmake_dev

链接到描述技术的文章:

Create dlls on Windows without declspec() using new CMake export all feature

链接到示例项目:

cmake_windows_export_all_symbols

答案很长

注意: 以下所有信息都与MSVC编译器或Visual Studio有关。

如果您在Linux上使用其他编译器(如Linux上的gcc或Windows上的MinGW gcc编译器),则由于未导出符号而导致链接错误,因为gcc编译器默认导出动态库(dll)中的所有符号而不是MSVC或Intel Windows编译器。

在Windows中,您必须从dll中明确导出符号。

有关此内容的更多信息,请参见链接:

Exporting from a DLL

HowTo: Export C++ classes from a DLL

因此,如果您想使用MSVC(Visual Studio编译器)从dll导出所有符号,您有两个选择:

  • 在类/函数的定义中使用关键字__declspec(dllexport)。
  • 创建模块定义(.def)文件,并在构建DLL时使用.def文件。

1。在类/函数的定义中使用关键字__declspec(dllexport)

1.1。添加" __ declspec(dllexport)/ __declspec(dllimport)"要使用的类或方法的宏。因此,如果要导出所有类,则应将此宏添加到所有类

有关此内容的更多信息,请参见链接:

Exporting from a DLL Using __declspec(dllexport)

使用示例(替换"项目"按实际项目名称):

// ProjectExport.h

#ifndef __PROJECT_EXPORT_H
#define __PROJECT_EXPORT_H

#ifdef USEPROJECTLIBRARY
#ifdef  PROJECTLIBRARY_EXPORTS 
#define PROJECTAPI __declspec(dllexport)
#else
#define PROJECTAPI __declspec(dllimport)
#endif
#else
#define PROJECTAPI
#endif

#endif

然后添加" PROJECTAPI"所有课程。 定义" USEPROJECTLIBRARY"仅当您需要来自dll的导出/导入符号时。 定义" PROJECTLIBRARY_EXPORTS"对于dll。

类导出示例:

#include "ProjectExport.h"

namespace hello {
    class PROJECTAPI Hello {}   
}

功能导出示例:

#include "ProjectExport.h"

PROJECTAPI void HelloWorld();

警告:不要忘记包含" ProjectExport.h"文件。

1.2。导出为C函数。 如果你使用C ++编译器编译代码是用C语言编写的,你可以添加extern" C"在函数前面消除名称错误

有关C ++ name mangling的更多信息,请参阅链接:

Name Decoration

使用示例:

extern "C" __declspec(dllexport) void HelloWorld();

有关此内容的更多信息,请参见链接:

Exporting C++ Functions for Use in C-Language Executables

2。创建模块定义(.def)文件并在构建DLL时使用.def文件

有关此内容的更多信息,请参见链接:

Exporting from a DLL Using DEF Files

此外,我描述了有关如何创建.def文件的三种方法。

2.1。导出C函数

在这种情况下,您可以手动在.def文件中添加函数声明。

使用示例:

extern "C" void HelloWorld();

.def文件示例(__cdecl命名约定):

EXPORTS 
_HelloWorld

2.2。从静态库中导出符号

我尝试了" user72260"。

建议的方法 他说:

  • 首先,您可以创建静态库。
  • 然后使用" dumpbin / LINKERMEMBER"从静态库中导出所有符号。
  • 解析输出。
  • 将所有结果放入.def文件中。
  • 使用.def文件创建dll。

我使用了这种方法,但总是创建两个版本(一个作为静态而另一个作为动态库)并不是很方便。但是,我必须承认,这种方法确实有效。

2.3。从.obj文件导出符号或借助CMake

2.3.1。使用CMake

重要提示:您不需要对类或函数进行任何导出宏!

重要提示:使用此方法时,您无法使用/ GL(Whole Program Optimization)!

  • 根据" CMakeLists.txt"创建CMake项目文件。
  • 将以下行添加到" CMakeLists.txt"文件: 设置(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  • 然后在" CMake(cmake-gui)"的帮助下创建Visual Studio项目。
  • 编译项​​目。

使用示例:

根文件夹

CMakeLists.txt(根文件夹)

cmake_minimum_required(VERSION 2.6)
project(cmake_export_all)

set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)

set(dir ${CMAKE_CURRENT_SOURCE_DIR})
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${dir}/bin")

set(SOURCE_EXE main.cpp)

include_directories(foo)

add_executable(main ${SOURCE_EXE})

add_subdirectory(foo)

target_link_libraries(main foo)

main.cpp(根文件夹)

#include "foo.h"

int main() {
    HelloWorld();

    return 0;
}

Foo文件夹(根文件夹/ Foo文件夹)

CMakeLists.txt(Foo文件夹)

project(foo)

set(SOURCE_LIB foo.cpp)

add_library(foo SHARED ${SOURCE_LIB})

foo.h(Foo文件夹)

void HelloWorld();

foo.cpp(Foo文件夹)

#include <iostream>

void HelloWorld() {
    std::cout << "Hello World!" << std::endl;
}

再次链接到示例项目:

cmake_windows_export_all_symbols

CMake使用的不同于&#34; 2.2。从静态库中导出符号&#34;做法。

它执行以下操作:

1)创建&#34; objects.txt&#34;在构建目录中包含.obj文件信息的文件在dll中使用。

2)编译dll,即创建.obj文件。

3)基于&#34; objects.txt&#34;文件信息从.obj文件中提取所有符号。

使用示例:

DUMPBIN /SYMBOLS example.obj > log.txt

有关此内容的更多信息,请参见链接:

/SYMBOLS

4)从.obj文件信息中提取的解析。

在我看来,我会使用呼叫对流,例如&#34; __ cdecl / __ fastcall&#34;,&#34; SECTx / UNDEF&#34;符号字段(第三列),&#34;外部/静态&#34;符号字段(第五列),&#34; ??&#34;,&#34;?&#34;用于解析.obj文件的信息。

我不知道CMake究竟是如何解析.obj文件的。 但是,CMake是开源的,所以你可以找出它是否对你感兴趣。

链接到CMake项目:

CMake_github

5)将所有导出的符号放在.def文件中。

6)使用.def创建的文件链接dll。

步骤4)-5),即解析.obj文件并在链接和使用.def文件之前创建.def文件.CMake在&#34; Pre-Link事件&#34;的帮助下完成。 而&#34; Pre-Link事件&#34;你可以拨打任何你想要的程序。 因此,如果&#34; CMake使用&#34; &#34;预先链接事件&#34;使用以下信息调用CMake,其中包含.def文件的放置位置以及&#34; objects.txt&#34;文件和参数&#34; -E __create_def&#34;。 您可以通过使用&#34; set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)&#34;创建CMake Visusal Studio项目来检查此信息。然后检查&#34; .vcxproj&#34; dll的项目文件。

如果您尝试编译没有&#34;设置(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)&#34;或者用&#34;设置(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS OFF)&#34;由于符号不是从dll导出的,因此会出现链接错误。

有关此内容的更多信息,请参见链接:

Understanding Custom Build Steps and Build Events

2.3.2。没有CMake使用

你可以创建一个小程序来自己解析.obj文件,而不需要使用CMake usege。 Hovewer,我不得不承认CMake是非常有用的程序,特别是对于跨平台开发。

答案 2 :(得分:8)

我编写了一个小程序来解析.lib文件中“dumpbin / linkermember”的输出。我有超过8,000个函数引用从一个DLL导出。

在DLL上执行此操作的问题是,您必须在没有导出的定义的情况下链接DLL以创建.lib文件,然后生成.def,这意味着您现在必须使用.def重新重新链接DLL。文件实际上已导出引用。

使用静态库更容易。将所有源代码编译为静态库,运行dumbin,使用您的小程序生成.def,然后将libs链接到DLL中,直到导出名称可用。

不幸的是,我的公司不允许我向您展示来源。所涉及的工作是识别def文件中不需要转储输出中的“公共符号”。你必须扔掉很多这些引用,NULL_IMPORT_DESCRIPTOR,NULL_THUNK_DATA,__ imp *等。

答案 3 :(得分:2)

感谢@Maks的detailed answer

下面是我在Pre-Link事件中用来从obj生成def文件的示例。我希望它会对某人有所帮助。

dumpbin /SYMBOLS $(Platform)\$(Configuration)\mdb.obj | findstr /R "().*External.*mdb_.*" > $(Platform)\$(Configuration)\mdb_symbols
(echo EXPORTS & for /F "usebackq tokens=2 delims==|" %%E in (`type $(Platform)\$(Configuration)\mdb_symbols`) do @echo  %%E) > $(Platform)\$(Configuration)\lmdb.def

基本上我只使用了一个对象(mdb.obj)和grepped mdb_ *函数。然后解析输出以保持名称考虑到缩进的空间量(一个在分成标记之后,另一个在回声中。我不知道它是否重要)。

现实世界的剧本可能会更加复杂。

答案 4 :(得分:0)

  

我想创建一个DLL并自动导出所有符号,而无需在各处添加__declspec(dllexport)且无需手动创建.def文件。有没有办法做到这一点?

这是一个较晚的答案,但在第(2)节中提供了Maks答案的详细信息。它还避免使用脚本,并使用名为dump2def的C ++程序。 dump2def的源代码如下。

最后,下面的步骤假定您正在Visual Studio Developer Prompt上工作,该计算机是运行vcvarsall.bat的Windows终端。您需要确保cl.exelib.exelink.exenmake.exe之类的构建工具在使用中。

  

有关此问题的更多信息,请参见链接:

     

Exporting from a DLL Using DEF Files
  ...

以下说明使用:

  • static.lib-静态库存档(* .Linux上的文件)
  • dynamic.dll-动态库(Linux上的* .so文件)
  • import.lib-动态库(Windows上的导入库)

还要注意,尽管您正在从DLL中导出所有内容,但客户端仍然必须在客户端使用的所有符号(类,函数和数据)上使用declspec(dllimport)。另请参见MSDN。

首先,带上您的对象并创建一个静态存档:

AR = lib.exe
ARFLAGS = /nologo

CXX_SRCS = a.cpp b.cpp c.cpp ...
LIB_OBJS = a.obj b.obj c.obj ...

static.lib: $(LIB_OBJS)
    $(AR) $(ARFLAGS) $(LIB_OBJS) /out:$@

第二,在存档上运行dumpbin.exe /LINKERMEMEBER,以创建一个*.dump文件:

dynamic.dump:
    dumpbin /LINKERMEMBER static.lib > dynamic.dump

第三,在dump2def.exe文件上运行*.dump以产生*.def文件。 dump2def.exe的源代码如下。

dynamic.def: static.lib dynamic.dump
    dump2def.exe dynamic.dump dynamic.def

第四,构建DLL:

LD = link.exe
LDFLAGS = /OPT:REF /MACHINE:X64
LDLIBS = kernel32.lib

dynamic.dll: $(LIB_OBJS) dynamic.def
    $(LD) $(LDFLAGS) /DLL /DEF:dynamic.def /IGNORE:4102 $(LIB_OBJS) $(LDLIBS) /out:$@

/IGNORE:4102用于避免此警告。预计在这种情况下:

dynamic.def : warning LNK4102: export of deleting destructor 'public: virtual v
oid * __ptr64 __cdecl std::exception::`scalar deleting destructor'(unsigned int)
 __ptr64'; image may not run correctly

调用dynamic.dll配方时,它还会创建一个dynamic.lib导入文件和dynamic.exp文件:

> cls && nmake /f test.nmake dynamic.dll
...
Creating library dynamic.lib and object dynamic.exp

并且:

 C:\Users\Test\testdll>dir *.lib *.dll *.def *.exp
 Volume in drive C is Windows
 Volume Serial Number is CC36-23BE

 Directory of C:\Users\Test\testdll

01/06/2019  08:33 PM        71,501,578 static.lib
01/06/2019  08:33 PM        11,532,052 dynamic.lib

 Directory of C:\Users\Test\testdll

01/06/2019  08:35 PM         5,143,552 dynamic.dll

 Directory of C:\Users\Test\testdll

01/06/2019  08:33 PM         1,923,070 dynamic.def

 Directory of C:\Users\Test\testdll

01/06/2019  08:35 PM         6,937,789 dynamic.exp
               5 File(s)     97,038,041 bytes
               0 Dir(s)  139,871,186,944 bytes free

将Nmake makefile看起来像粘合在一起。它是real Nmake file的一部分:

all: test.exe

test.exe: pch.pch static.lib $(TEST_OBJS)
    $(LD) $(LDFLAGS) $(TEST_OBJS) static.lib $(LDLIBS) /out:$@

static.lib: $(LIB_OBJS)
    $(AR) $(ARFLAGS) $(LIB_OBJS) /out:$@

dynamic.map:
    $(LD) $(LDFLAGS) /DLL /MAP /MAPINFO:EXPORTS $(LIB_OBJS) $(LDLIBS) /out:dynamic.dll

dynamic.dump:
    dumpbin.exe /LINKERMEMBER static.lib /OUT:dynamic.dump

dynamic.def: static.lib dynamic.dump
    dump2def.exe dynamic.dump

dynamic.dll: $(LIB_OBJS) dynamic.def
    $(LD) $(LDFLAGS) /DLL /DEF:dynamic.def /IGNORE:4102 $(LIB_OBJS) $(LDLIBS) /out:$@

clean:
    $(RM) /F /Q pch.pch $(LIB_OBJS) pch.obj static.lib $(TEST_OBJS) test.exe *.pdb

这是dump2def.exe的源代码:

#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <vector>
#include <set>

typedef std::set<std::string> SymbolMap;

void PrintHelpAndExit(int code)
{
    std::cout << "dump2def - create a module definitions file from a dumpbin file" << std::endl;
    std::cout << "           Written and placed in public domain by Jeffrey Walton" << std::endl;
    std::cout << std::endl;

    std::cout << "Usage: " << std::endl;

    std::cout << "  dump2def <infile>" << std::endl;
    std::cout << "    - Create a def file from <infile> and write it to a file with" << std::endl;
    std::cout << "      the same name as <infile> but using the .def extension" << std::endl;

    std::cout << "  dump2def <infile> <outfile>" << std::endl;
    std::cout << "    - Create a def file from <infile> and write it to <outfile>" << std::endl;

    std::exit(code);
}

int main(int argc, char* argv[])
{
    // ******************** Handle Options ******************** //

    // Convenience item
    std::vector<std::string> opts;
    for (size_t i=0; i<argc; ++i)
        opts.push_back(argv[i]);

    // Look for help
    std::string opt = opts.size() < 3 ? "" : opts[1].substr(0,2);
    if (opt == "/h" || opt == "-h" || opt == "/?" || opt == "-?")
        PrintHelpAndExit(0);

    // Add <outfile> as needed
    if (opts.size() == 2)
    {
        std::string outfile = opts[1];
        std::string::size_type pos = outfile.length() < 5 ? std::string::npos : outfile.length() - 5;
        if (pos == std::string::npos || outfile.substr(pos) != ".dump")
            PrintHelpAndExit(1);

        outfile.replace(pos, 5, ".def");
        opts.push_back(outfile);
    }

    // Check or exit
    if (opts.size() != 3)
        PrintHelpAndExit(1);

    // ******************** Read MAP file ******************** //

    SymbolMap symbols;

    try
    {
        std::ifstream infile(opts[1].c_str());
        std::string::size_type pos;
        std::string line;

        // Find start of the symbol table
        while (std::getline(infile, line))
        {
            pos = line.find("public symbols");
            if (pos == std::string::npos) { continue; }        

            // Eat the whitespace after the table heading
            infile >> std::ws;
            break;
        }

        while (std::getline(infile, line))
        {
            // End of table
            if (line.empty()) { break; }

            std::istringstream iss(line);
            std::string address, symbol;
            iss >> address >> symbol;

            symbols.insert(symbol);
        }
    }
    catch (const std::exception& ex)
    {
        std::cerr << "Unexpected exception:" << std::endl;
        std::cerr << ex.what() << std::endl;
        std::cerr << std::endl;

        PrintHelpAndExit(1);
    }

    // ******************** Write DEF file ******************** //

    try
    {
        std::ofstream outfile(opts[2].c_str());

        // Library name, cryptopp.dll
        std::string name = opts[2];
        std::string::size_type pos = name.find_last_of(".");

        if (pos != std::string::npos)
            name.erase(pos);

        outfile << "LIBRARY " << name << std::endl;
        outfile << "DESCRIPTION \"Crypto++ Library\"" << std::endl;        
        outfile << "EXPORTS" << std::endl;
        outfile << std::endl;

        outfile << "\t;; " << symbols.size() << " symbols" << std::endl;

        // Symbols from our object files
        SymbolMap::const_iterator it = symbols.begin();
        for ( ; it != symbols.end(); ++it)
            outfile << "\t" << *it << std::endl;
    }
    catch (const std::exception& ex)
    {
        std::cerr << "Unexpected exception:" << std::endl;
        std::cerr << ex.what() << std::endl;
        std::cerr << std::endl;

        PrintHelpAndExit(1);
    }   

    return 0;
}

答案 5 :(得分:0)

也许有人发现我有用的Python脚本可用于将.dump转换为.def。

import sys, os
functions = []
startPoint = False
# Exclude standard API like sprintf to avoid multiple definition link error
excluded_functions = [ 'sprintf', 'snprintf', 'sscanf', 'fprintf' ]

if len(sys.argv) < 2:
    print('Usage: %s <Input .dump file> <Output .def file>.' % sys.argv[0])
    print('Example: %s myStaticLib.dump exports.def' % sys.argv[0])
    sys.exit(1)
print('%s: Processing %s to %s' % (sys.argv[0], sys.argv[1], sys.argv[2]))

fin = open(sys.argv[1], 'r')
lines = fin.readlines()
fin.close()

# Reading
for l in lines:
    l_str = l.strip()
    if (startPoint == True) and (l_str == 'Summary'): # end point
        break
    if (startPoint == False) and ("public symbols" in l_str):
        startPoint = True
        continue
    if (startPoint == True) and l_str is not '':
        funcName = l_str.split(' ')[-1]
        if funcName not in excluded_functions:
            functions.append("    " + funcName)
# Writing
fout = open(sys.argv[2], 'w')
fout.write('EXPORTS\n')
for f in functions:
    fout.write('%s\n' % f)
fout.close()

使用此脚本,您可以通过两个步骤为.lib获取.def文件:

dumpbin /LINKERMEMBER:1 myStaticLib.lib > myExports.dump
python dump2def.py myExports.dump myExports.def

答案 6 :(得分:-3)

不,当实现导出函数的.cpp文件包含一个宏时,你需要一个解析为__declspec(dllexport)的宏,否则解析为__declspec(dllimport)