从 C# 调用 Haskell

Posted 2023-02-19

【中文标题】从 C# 调用 Haskell

【英文标题】：Calling Haskell from C#

【发布时间】：2013-05-13 00:16:17

【问题描述】：

我刚刚花了一周左右的时间研究如何从 C# 执行 C++ 代码，作为我日常工作的一部分。我们花了很长时间才弄清楚，但最终的解决方案相当简单。

现在我很好奇... 有多难？ （注意：这是调用 Haskell 来自 C#，而不是相反。所以主要的可执行文件是 C#。）

如果真的很难，我不会打扰。但如果它相当容易，我可能不得不玩它......

基本上，我们编写了一些 C++ 代码。在 Windows 上它被编译成一个 DLL，在 Linux 上它被编译成一个共享对象 (*.so)。然后在 C# 方面，如果你试图传递任何重要的东西，你会做一个DllImport 并编写一些手动内存管理代码。 （例如，数组、字符串等）

我知道 GHC 应该支持在两个平台上构建共享库，但我不确定技术细节。导出内容的语法是什么，调用者必须先做一些特殊的事情来初始化 DLL 吗？

具体来说：假设存在一个函数foobar :: FilePath -> IO Int32。有人可以拼凑一个小草图显示：

我需要编写哪些 Haskell 声明才能将其暴露给外界。 如何告诉 GHC 构建一个独立的 DLL/SO 文件。 除了绑定foobar 本身的常规过程之外，调用者需要执行的任何特殊操作。

我不太担心 C# 端的实际语法；我想我或多或少对此感到困惑。

附：我确实简要地查看了hs-dotnet，但这似乎是特定于 Windows 的。 （即，不适用于 Mono，因此不适用于 Linux。）

【问题讨论】：

对于 FFI 绑定，您总是有一个计划 B，即“在 C 中编写一个瘦包装器”。大多数具有任何类型 FFI 的语言都可以与 C 互操作。

指针：来自 GHC 用户指南的第 4.13 和 8.2 章，haskell.org/haskellwiki/Calling_Haskell_from_C

GHC 似乎有一个关于 DLL 创建的章节：haskell.org/ghc/docs/latest/html/users_guide/win32-dlls.html 在 GHC 的最新版本中，这部分似乎也发生了变化。 (!)

请注意如何编译和链接 c/c++ 代码 (***.com/questions/5829170/…)。我不知道这种效果是否会暴露在 .net/managed 代码上。

@Jonke 出于完全相同的原因，我们在将 C++ 链接到 C# 时获得了七种乐趣。我不知道这些东西是什么，但显然它是正确的关键......

【参考方案1】：

就这两种语言而言，您基本上可以假装您正在尝试与 C 代码交互。

这是一个复杂的话题，因此我不会尝试解释所有内容，而是专注于制作一个简单的示例，您可以使用下面链接的资源进行构建。

首先，您需要为使用来自Foreign.C.* 模块的类型而不是通常的haskell 类型的Haskell 函数编写包装器。 CInt 代替 Int，CString 代替 String 等。这是最复杂的步骤，尤其是当您必须处理用户定义的类型时。

您还必须使用 ForeignFunctionInterface 扩展为这些函数编写 foreign export 声明。

-# LANGUAGE ForeignFunctionInterface #-
module Foo where

import Foreign.C.String
import Foreign.C.Types

foreign export ccall
  foo :: CString -> IO CInt

foo :: CString -> IO CInt
foo c_str = do
  str    <- peekCString c_str
  result <- hs_foo str 
 return $ fromIntegral result

hs_foo :: String -> IO Int
hs_foo str = do
  putStrLn $ "Hello, " ++ str
  return (length str + 42)

然后，在编译时，你告诉 GHC 创建一个共享库：

$ ghc -O2 --make -no-hs-main -optl '-shared' -o Foo.so Foo.hs

在C#方面，除了导入要调用的函数外，还必须导入hs_init()并调用它来初始化运行时系统，然后才能调用任何Haskell函数。完成后您还应该致电hs_exit()。

using System;
using System.Runtime.InteropServices;

namespace Foo 
    class MainClass 
        [DllImport("Foo.so", CallingConvention = CallingConvention.Cdecl)]
        private static extern void hs_init(IntPtr argc, IntPtr argv);

        [DllImport("Foo.so", CallingConvention = CallingConvention.Cdecl)]
        private static extern void hs_exit();

        [DllImport("Foo.so", CallingConvention = CallingConvention.Cdecl)]
        private static extern int foo(string str);

        public static void Main(string[] args) 
            Console.WriteLine("Initializing runtime...");
            hs_init(IntPtr.Zero, IntPtr.Zero);

            try 
                Console.WriteLine("Calling to Haskell...");
                int result = foo("C#");
                Console.WriteLine("Got result: 0", result);
             finally 
                Console.WriteLine("Exiting runtime...");
                hs_exit();
            
        
    

现在我们编译并运行：

$ mcs -unsafe Foo.cs
$ LD_LIBRARY_PATH=. mono Foo.exe
Initializing runtime...
Calling to Haskell...
Hello, C#
Got result: 44
Exiting runtime...

有效！

资源：

GHC User's Guide HaskellWiki

【讨论】：

这看起来很像我想要的。但是... #1 你不是也需要打电话给hs_exit() 吗？ #2 当我运行它时，我得到了 hs_init(null, null) 中第二个参数的 MarshalDirectiveException。嗯？

@MathematicalOrchid：#1：是的。 #2：嗯。上面的代码在我的机器上工作，但我试图弄清楚如何正确编组它。出于某种原因hs_init 需要char** argv[]，尽管据我所知char *argv[] 就足够了。从我能够找到的示例中，StringBuilder 的数组应该在后一种情况下工作，但我不知道如何处理额外的间接级别（至少在没有手动完成所有操作的情况下不会）。无论如何，只要你只是要传递null，任何指针类型都应该可以工作。

已修复。我将两个参数都更改为IntPtr，但随后我收到了不平衡堆栈警告。显然我需要添加CallingConvention=CallingConvention.Cdecl 出于某种原因...现在它似乎工作得很好。

在编译 Haskell 部分时，我遇到了错误：“未定义对 'WinMain' 的引用”。这可以通过更改“-optl”->“-optl-mwindows”来解决。我从以下地址得到了这个解决方案：gitlab.haskell.org/ghc/ghc/issues/2459

【参考方案2】：

作为参考，我能够让以下过程在 Windows 下工作...

-# LANGUAGE ForeignFunctionInterface #-

module Fibonacci () where

import Data.Word
import Foreign.C.Types

fibs :: [Word32]
fibs = 1 : 1 : zipWith (+) fibs (tail fibs)

fibonacci :: Word8 -> Word32
fibonacci n =
  if n > 47
    then 0
    else fibs !! (fromIntegral n)

c_fibonacci :: CUChar -> CUInt
c_fibonacci (CUChar n) = CUInt (fibonacci n)

foreign export ccall c_fibonacci :: CUChar -> CUInt

编译

ghc --make -shared Fibonacci.hs

这会产生六个文件，其中一个是HSdll.dll。然后我将其复制到 Visual Studio C# 项目中，并执行以下操作：

using System;
using System.Runtime.InteropServices;

namespace ConsoleApplication1

    public sealed class Fibonacci : IDisposable
    
        #region DLL imports

        [DllImport("HSdll.dll", CallingConvention=CallingConvention.Cdecl)]
        private static extern unsafe void hs_init(IntPtr argc, IntPtr argv);

        [DllImport("HSdll.dll", CallingConvention = CallingConvention.Cdecl)]
        private static extern unsafe void hs_exit();

        [DllImport("HSdll.dll", CallingConvention = CallingConvention.Cdecl)]
        private static extern UInt32 c_fibonacci(byte i);

        #endregion

        #region Public interface

        public Fibonacci()
        
            Console.WriteLine("Initialising DLL...");
            unsafe  hs_init(IntPtr.Zero, IntPtr.Zero); 
        

        public void Dispose()
        
            Console.WriteLine("Shutting down DLL...");
            unsafe  hs_exit(); 
        

        public UInt32 fibonacci(byte i)
        
            Console.WriteLine(string.Format("Calling c_fibonacci(0)...", i));
            var result = c_fibonacci(i);
            Console.WriteLine(string.Format("Result = 0", result));
            return result;
        

        #endregion
    

Console.WriteLine() 调用显然是可选的。

我还没有尝试在 Mono / Linux 下运行它，但大概是相似的。

总而言之，这与让 C++ DLL 工作的难度大致相同。 （即，让类型签名匹配并使编组正常工作是困难的。）

我还必须编辑项目设置并选择“允许不安全代码”。

【讨论】：

只有在我使用原始指针时才需要unsafe 位。使用IntPtr，它应该可以在没有它们的情况下工作。

是的，这都是真的。改成IntPtr，去掉所有unsafe关键字，关闭编译选项，还是可以编译运行正常的。