什么?C语言动态库免费大放送了?

看到有同学说 Lua 库少, 需要自己造轮子. 其实不是这样的, 今天给大家看一个魔法, 这个魔法可以让你非常方便的在 luajit 里面使用高性能的 C/CPP 库, 从而避免自己造轮子的痛苦.

海州网站制作公司哪家好,找创新互联公司!从网页设计、网站建设、微信开发、APP开发、成都响应式网站建设公司等网站项目制作,到程序开发,运营维护。创新互联公司自2013年创立以来到现在10年的时间,我们拥有了丰富的建站经验和运维经验,来保证我们的工作的顺利进行。专注于网站建设就选创新互联公司

这个魔法是 FFI ( Foreign function interface ), 我并不打算仔细讲 FFI 原理, 所以简单来说, FFI 实现了跨语言的二进制接口. 它的优点是高效方便. 直接调用 ABI, 缺点也很明显, 出了问题直接会挂掉, 因此数据跨临界区前仔细检查就可以了.

我们今天直接找个 C 语言库, 然后利用 FFI 在 luajit 里面调用这个函数库作为个大家的演示.

什么? 这里竟然躺着一个高性能 base64 库?

我们以这个 repo 为例: https:// github.com/aklomp/base6 4 . 这是一个 C 编写的 Base64 编码/解码库, 而且支持SIMD.

可以简单运行下这个库的 benchmark:

 
 
 
  1. karminski@router02:/data/works/base64$ make clean && SSSE3_CFLAGS=-mssse3 AVX2_CFLAGS=-mavx2 make && make -C test
  2. ...
  3. Testing with buffer size 100 KB, fastest of 10 * 100
  4. AVX2    encode  12718.47 MB/sec
  5. AVX2    decode  14542.81 MB/sec
  6. plain   encode  3657.40 MB/sec
  7. plain   decode  3433.23 MB/sec
  8. SSSE3   encode  7269.55 MB/sec
  9. SSSE3   decode  8173.10 MB/sec
  10. ...

我的 CPU 是 Intel(R) Xeon(R) CPU E3-1246 v3 @ 3.50GHz, 可以看到CPU如果支持 AVX2 的话, 可以达到 12GB/s 以上, 这个性能非常强悍, 甚至连普通的SSD都跟不上了.

我们需要的第一步是把这个 repo 编译为动态库. 但是这个 repo 并没有提供动态库的编译选项, 所以我们魔改下这个项目的 Makefile.

 
 
 
  1. CFLAGS += -std=c99 -O3 -Wall -Wextra -pedantic
  2. # Set OBJCOPY if not defined by environment:
  3. OBJCOPY ?= objcopy
  4. OBJS = \
  5.   lib/arch/avx2/codec.o \
  6.   lib/arch/generic/codec.o \
  7.   lib/arch/neon32/codec.o \
  8.   lib/arch/neon64/codec.o \
  9.   lib/arch/ssse3/codec.o \
  10.   lib/arch/sse41/codec.o \
  11.   lib/arch/sse42/codec.o \
  12.   lib/arch/avx/codec.o \
  13.   lib/lib.o \
  14.   lib/codec_choose.o \
  15.   lib/tables/tables.o
  16. SOOBJS = \
  17.   lib/arch/avx2/codec.so \
  18.   lib/arch/generic/codec.so \
  19.   lib/arch/neon32/codec.so \
  20.   lib/arch/neon64/codec.so \
  21.   lib/arch/ssse3/codec.so \
  22.   lib/arch/sse41/codec.so \
  23.   lib/arch/sse42/codec.so \
  24.   lib/arch/avx/codec.so \
  25.   lib/lib.so \
  26.   lib/codec_choose.so \
  27.   lib/tables/tables.so
  28. HAVE_AVX2   = 0
  29. HAVE_NEON32 = 0
  30. HAVE_NEON64 = 0
  31. HAVE_SSSE3  = 0
  32. HAVE_SSE41  = 0
  33. HAVE_SSE42  = 0
  34. HAVE_AVX    = 0
  35. # The user should supply compiler flags for the codecs they want to build.
  36. # Check which codecs we're going to include:
  37. ifdef AVX2_CFLAGS
  38.   HAVE_AVX2 = 1
  39. endif
  40. ifdef NEON32_CFLAGS
  41.   HAVE_NEON32 = 1
  42. endif
  43. ifdef NEON64_CFLAGS
  44.   HAVE_NEON64 = 1
  45. endif
  46. ifdef SSSE3_CFLAGS
  47.   HAVE_SSSE3 = 1
  48. endif
  49. ifdef SSE41_CFLAGS
  50.   HAVE_SSE41 = 1
  51. endif
  52. ifdef SSE42_CFLAGS
  53.   HAVE_SSE42 = 1
  54. endif
  55. ifdef AVX_CFLAGS
  56.   HAVE_AVX = 1
  57. endif
  58. ifdef OPENMP
  59.   CFLAGS += -fopenmp
  60. endif
  61. .PHONY: all analyze clean
  62. all: bin/base64 lib/libbase64.o lib/libbase64.so
  63. bin/base64: bin/base64.o lib/libbase64.o lib/libbase64.so
  64.     $(CC) $(CFLAGS) -o $@ $^
  65. lib/libbase64.o: $(OBJS)
  66.     $(LD) -r -o $@ $^
  67.     $(OBJCOPY) --keep-global-symbols=lib/exports.txt $@
  68. lib/libbase64.so: $(SOOBJS)
  69.     $(LD) -shared -fPIC -o $@ $^
  70.     $(OBJCOPY) --keep-global-symbols=lib/exports.txt $@
  71. lib/config.h:
  72.     @echo "#define HAVE_AVX2   $(HAVE_AVX2)"    > $@
  73.     @echo "#define HAVE_NEON32 $(HAVE_NEON32)" >> $@
  74.     @echo "#define HAVE_NEON64 $(HAVE_NEON64)" >> $@
  75.     @echo "#define HAVE_SSSE3  $(HAVE_SSSE3)"  >> $@
  76.     @echo "#define HAVE_SSE41  $(HAVE_SSE41)"  >> $@
  77.     @echo "#define HAVE_SSE42  $(HAVE_SSE42)"  >> $@
  78.     @echo "#define HAVE_AVX    $(HAVE_AVX)"    >> $@
  79. $(OBJS): lib/config.h
  80. $(SOOBJS): lib/config.h
  81. # o
  82. lib/arch/avx2/codec.o:   CFLAGS += $(AVX2_CFLAGS)
  83. lib/arch/neon32/codec.o: CFLAGS += $(NEON32_CFLAGS)
  84. lib/arch/neon64/codec.o: CFLAGS += $(NEON64_CFLAGS)
  85. lib/arch/ssse3/codec.o:  CFLAGS += $(SSSE3_CFLAGS)
  86. lib/arch/sse41/codec.o:  CFLAGS += $(SSE41_CFLAGS)
  87. lib/arch/sse42/codec.o:  CFLAGS += $(SSE42_CFLAGS)
  88. lib/arch/avx/codec.o:    CFLAGS += $(AVX_CFLAGS)
  89. # so
  90. lib/arch/avx2/codec.so:   CFLAGS += $(AVX2_CFLAGS)
  91. lib/arch/neon32/codec.so: CFLAGS += $(NEON32_CFLAGS)
  92. lib/arch/neon64/codec.so: CFLAGS += $(NEON64_CFLAGS)
  93. lib/arch/ssse3/codec.so:  CFLAGS += $(SSSE3_CFLAGS)
  94. lib/arch/sse41/codec.so:  CFLAGS += $(SSE41_CFLAGS)
  95. lib/arch/sse42/codec.so:  CFLAGS += $(SSE42_CFLAGS)
  96. lib/arch/avx/codec.so:    CFLAGS += $(AVX_CFLAGS)
  97. %.o: %.c
  98.     $(CC) $(CFLAGS) -o $@ -c $<
  99. %.so: %.c
  100.     $(CC) $(CFLAGS) -shared -fPIC -o $@ -c $<
  101. analyze: clean
  102.     scan-build --use-analyzer=`which clang` --status-bugs make
  103. clean:
  104.     rm -f bin/base64 bin/base64.o lib/libbase64.o lib/libbase64.so lib/config.h $(OBJS)

看不懂没关系, Makefile 是如此的复杂, 我也看不懂, 仅仅是凭着感觉修改的, 然后他就恰好能运行了... 注意 Makefile 的缩进一定要用 "\t", 否则不符合语法会报错.

然后我们进行编译:

 
 
 
  1. AVX2_CFLAGS=-mavx2 SSSE3_CFLAGS=-mssse3 SSE41_CFLAGS=-msse4.1 SSE42_CFLAGS=-msse4.2 AVX_CFLAGS=-mavx make lib/libbase64.so

这样我们就得到了libbase64.so 动态库 (在 lib 里面). 这里还顺便开启了各种 SIMD 选项. 如果不需要的话可以关闭.

魔改开始

当然这只是魔法, 不是炼金术, 所以是需要付出努力的, 我们要手动实现动态库的桥接, 首先我们需要查看我们要调用的函数需要什么参数. 这两个定义很简单, 我们需要传入:

 
 
 
  1. const char *src
  2. size_t srclen
  3. char *out
  4. size_t *outlen
  5. int flags
 
 
 
  1. void base64_encode(const char *src, size_t srclen, char *out, size_t *outlen, int flags);
  2. int  base64_decode(const char *src, size_t srclen, char *out, size_t *outlen, int flags);

然后我们就可以开始编写 ffi 桥接程序了. 首先把需要的库全都包含进来, 注意, 多用 local 没坏处, 使用 local 可以有效从局部查询, 避免低效的全局查询. 甚至其他包中的函数都可以 local 一下来提升性能.

动态库的话用专用的 ffi.load 来引用.

然后定义一个 _M 用来包裹我们的库. 这里跟 JavaScript 很像, JavaScript 在浏览器里有 window, Lua 有 _G. 我们要尽可能避免封装好的库直接扔给全局, 因此封装起来是个好办法.

 
 
 
  1. -- init
  2. local ffi        = require "ffi"
  3. local floor      = math.floor
  4. local ffi_new    = ffi.new
  5. local ffi_str    = ffi.string
  6. local ffi_typeof = ffi.typeof
  7. local C          = ffi.C
  8. local libbase64  = ffi.load("./libbase64.so") -- change this path when needed.
  9. local _M = { _VERSION = '0.0.1' }

然后是用 ffi.cdef 声明 ABI 接口, 这里更简单, 直接把源代码的头文件中的函数声明拷过来就完事了:

 
 
 
  1. -- cdef
  2. ffi.cdef[[
  3. void base64_encode(const uint8_t *src, size_t srclen, uint8_t *out, size_t *outlen, size_t flags);
  4. int  base64_decode(const uint8_t *src, size_t srclen, uint8_t *out, size_t *outlen, size_t flags);
  5. ]]

接下来是最重要的类型转换:

 
 
 
  1. -- define types
  2. local uint8t    = ffi_typeof("uint8_t[?]") -- uint8_t *
  3. local psizet    = ffi_typeof("size_t[1]")  -- size_t *
  4. -- package function
  5. function _M.base64_encode(src, flags)
  6.     local dlen   = floor((#src * 8 + 4) / 6)
  7.     local out    = ffi_new(uint8t, dlen)
  8.     local outlen = ffi_new(psizet, 1)
  9.     libbase64.base64_encode(src, #src, out, outlen, flags)
  10.     return ffi_str(out, outlen[0])
  11. end 
  12. function _M.base64_decode(src, flags)
  13.     local dlen   = floor((#src + 1) * 6 / 8)
  14.     local out    = ffi_new(uint8t, dlen)
  15.     local outlen = ffi_new(psizet, 1)
  16.     libbase64.base64_decode(src, #src, out, outlen, flags)
  17.     return ffi_str(out, outlen[0])
  18. end

我们用 ffi_typeof 来定义需要映射的数据类型, 然后用 ffi_new 来将其实例化, 分配内存空间. 具体来讲:

我们定义了2种数据类型, 其中, local uint8t = ffi_typeof("uint8_t[?]") 类型用来传输字符串, 后面的问号是给 local out = ffi_new(uint8t, dlen) 中的 ffi_new 函数准备的, 它的第二个参数可以指定实例化该数据类型时的长度. 这样我们就得到了一个空的字符串数组, 用来装 C 函数返回的结果. 这里的 dlen 计算出了源字符串 base64 encode 之后的长度, 分配该长度即可.

同样, local psizet = ffi_typeof("size_t[1]") 指定了一个 size_t * 类型. C 语言里面数组就是指针, 即 size_t[0] 与 site_t* 是等价的. 因此我们分只有一个元素的 size_t 数组就得到了指向 size_t 类型的指针. 然后在 local outlen = ffi_new(psizet, 1) 的时候后面的参数写的也是1, 不过这里写什么已经无所谓了, 它只是不支持传进去空, 所以我们相当于传了个 placeholder.

在使用这个值的时候, 我们也是按照数组的模式去使用的: return ffi_str(out, outlen[0]) .

需要注意的是, 一定要将 require "ffi" 以及 ffi.load 放在代码最底层, 否则会出现 table overflow 的情况.

最后, 这个文件是这样子的:

 
 
 
  1. --[[
  2.  
  3.     ffi-base64.lua
  4.     
  5.     @version    20201228:1
  6.     @author     karminski 
  7. ]]--
  8. -- init
  9. local ffi        = require "ffi"
  10. local floor      = math.floor
  11. local ffi_new    = ffi.new
  12. local ffi_str    = ffi.string
  13. local ffi_typeof = ffi.typeof
  14. local C          = ffi.C
  15. local libbase64  = ffi.load("./libbase64.so") -- change this path when needed.
  16. local _M = { _VERSION = '0.0.1' }
  17. -- cdef
  18. ffi.cdef[[
  19. void base64_encode(const uint8_t *src, size_t srclen, uint8_t *out, size_t *outlen, size_t flags);
  20. int  base64_decode(const uint8_t *src, size_t srclen, uint8_t *out, size_t *outlen, size_t flags);
  21. ]]
  22. -- define types
  23. local uint8t    = ffi_typeof("uint8_t[?]") -- uint8_t *
  24. local psizet    = ffi_typeof("size_t[1]")  -- size_t *
  25. -- package function
  26. function _M.base64_encode(src, flags)
  27.     local dlen   = floor((#src * 8 + 4) / 6)
  28.     local out    = ffi_new(uint8t, dlen)
  29.     local outlen = ffi_new(psizet, 1)
  30.     libbase64.base64_encode(src, #src, out, outlen, flags)
  31.     return ffi_str(out, outlen[0])
  32. end 
  33. function _M.base64_decode(src, flags)
  34.     local dlen   = floor((#src + 1) * 6 / 8)
  35.     local out    = ffi_new(uint8t, dlen)
  36.     local outlen = ffi_new(psizet, 1)
  37.     libbase64.base64_decode(src, #src, out, outlen, flags)
  38.     return ffi_str(out, outlen[0])
  39. end 
  40. return _M

好了, 大功告成, 我们写个 demo 调用一下试试:

 
 
 
  1. -- main.lua
  2. local ffi_base64 = require "ffi-base64" 
  3. local target = "https://cdxwcx.com"
  4. local r = ffi_base64.base64_encode(target, 0)
  5. print("base64 encode result: \n"..r)
  6. local r = ffi_base64.base64_decode(r, 0)
  7. print("base64 decode result: \n"..r)
 
 
 
  1. root@router02:/data/works/libbase64-ffi# luajit -v
  2. LuaJIT 2.1.0-beta3 -- Copyright (C) 2005-2020 Mike Pall. https://luajit.org/
  3. root@router02:/data/works/libbase64-ffi# luajit ./main.lua 
  4. base64 encode result: 
  5. aHR0cHM6Ly9leGFtcGxlLmNvbQ==
  6. base64 decode result: 
  7. https://cdxwcx.com

搞定! 是不是很简单? 类似的 FFI 库还有很多, 各个语言也有不同程度的支持. 大家都可以尝试一下.

最后, 当你遇到类似的问题的时候, 就可以回忆起来, 还有 FFI 这样一件趁手的兵(魔)器(法)在你的武器库里面.

当前文章:什么?C语言动态库免费大放送了?
网站路径:http://www.hantingmc.com/qtweb/news47/497297.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联