.NET Core 调用 Python 共享库(.so) 终极指南：解决 EntryPointNotFoundException 错误

2024-09-15 13:39:40

在 .NET Core 的开发过程中，我们有时需要借助 Python 的强大功能来处理特定任务，比如图像识别、自然语言处理等等。这时，我们会选择将 Python 代码编译成共享库（例如 Linux 上的 .so 文件），然后在 .NET Core 应用程序中调用这些库中的函数。

然而，在这个过程中，你可能会遇到 "System.EntryPointNotFoundException: Unable to find an entry point named 'xxx' in shared library 'xxx.so'" 这样的错误。这意味着 .NET Core 无法在共享库中找到你想要调用的函数。

别担心，这个问题很常见，并且通常可以通过一些方法解决。让我们来探索一下可能的原因以及相应的解决策略。

函数名称改编 (Name Mangling)

首先，我们需要了解 C/C++ 编译器的一个特性，叫做函数名称改编（Name Mangling）。编译器会修改函数名称，添加一些额外的信息，例如参数类型、返回值类型等等。这样做是为了避免函数名称冲突，但也导致了在其他语言（例如 .NET）中调用这些函数时出现问题。

Python 本身没有 Name Mangling 的问题，但如果你是用 Cython 将 Python 代码编译成 .so 文件，那么 Name Mangling 就可能发生。

为了查看 .so 文件中的函数名称是否被改编，可以使用 Linux 下的 nm 命令。例如，nm -D xxx.so 会列出所有导出的函数及其名称。

如果发现函数名称确实被改编了，那么在 .NET Core 代码中调用该函数时，需要使用改编后的名称。

缺少 extern "C" 声明

如果你使用 Cython 编译 Python 代码，那么可以通过 extern "C" 声明来告诉编译器不要进行 Name Mangling。

例如，在你的 Cython 代码中，可以这样写：

extern "C":
    def my_function(a, b):
        # ... your code here ...

这样编译出来的 .so 文件中的函数名称就不会被改编，.NET Core 就可以找到它了。

编译选项问题

编译 .so 文件时使用的选项也可能影响 .NET Core 是否能够成功调用其中的函数。

一个重要的选项是 -fPIC，它告诉编译器生成位置无关代码 (Position Independent Code)。位置无关代码可以在内存的任何位置加载和执行，这对于 .NET Core 正确加载和调用 .so 文件至关重要。

平台兼容性问题

.NET Core 应用程序和 .so 文件必须针对相同的平台进行编译。例如，如果你的 .NET Core 应用程序是 64 位的，那么 .so 文件也必须是 64 位的。否则，.NET Core 将无法加载 .so 文件。

解决方案

综合以上分析，我们可以尝试以下步骤来解决 "System.EntryPointNotFoundException" 错误：

使用 nm 命令查看 .so 文件中的函数名称是否被改编。
如果函数名称被改编了，在 .NET Core 代码中使用改编后的名称调用该函数。
在 Cython 代码中使用 extern "C" 声明，避免函数名称被改编。
使用 -fPIC 选项编译 .so 文件，生成位置无关代码。
确保 .NET Core 应用程序和 .so 文件针对相同的平台进行编译。

示例代码

假设你有一个名为 mylib.so 的共享库，其中包含一个名为 my_function 的函数，该函数接受两个整数作为参数，并返回它们的和。

以下是 .NET Core 代码中调用 my_function 的示例：

using System;
using System.Runtime.InteropServices;

public class MyLibrary
{
    [DllImport("mylib.so", EntryPoint = "my_function")]
    private static extern int my_function(int a, int b);

    public static void Main(string[] args)
    {
        int result = my_function(10, 20);
        Console.WriteLine("Result: " + result); 
    }
}