base64

base64

快速Base64流式编解码库 支持多种SIMD加速

这是一个C99实现的Base64流式编解码库,支持多种SIMD指令集和OpenMP加速。库提供简单的字符串编解码函数,注重性能、易用性和代码优雅。在x86平台上,库会进行运行时特性检测,自动选择最优编解码方案,显著提升性能。支持AVX2、AVX512、NEON等多种SIMD指令集,适用于不同架构的处理器。

Base64编码解码SIMD加速C语言OpenMPGithub开源项目

快速Base64流编解码器

构建状态

这是一个用C99实现的base64流编解码库,支持SIMD(AVX2、AVX512、NEON、AArch64/NEON、SSSE3、SSE4.1、SSE4.2、AVX)和OpenMP加速。它还包含了用于编解码简单长度限定字符串的包装函数。该库旨在做到:

  • 快速;
  • 易用;
  • 优雅。

在x86平台上,该库会进行运行时特性检测。首次调用时,库会确定适合该机器的编解码例程,并在程序的整个生命周期内记住它们。如果处理器支持AVX2、SSSE3、SSE4.1、SSE4.2或AVX指令,库会选择优化的编解码器,一次处理12或24字节,比"普通"的按字节处理的编解码器快4倍或更多。

目前AVX512支持仅用于编码,使用AVX512 VL和VBMI指令。解码部分重用了AVX2实现。2018年后生产的Cannonlake之后的CPU支持这些指令。

NEON支持在编译时硬编码为开启或关闭,因为ARM平台上没有可移植的运行时特性检测。

即使处理器不支持SIMD指令,这也是一个非常快速的库。回退例程可以在一轮中处理32或64位输入,取决于处理器的字长,这仍然比朴素的按字节实现快得多。在某些64位机器上,64位例程甚至比SSSE3例程表现更好。

据作者所知,在最初发布时,这是唯一提供SIMD加速的Base64库。作者写了一篇文章解释了一种可能的SIMD方法来编解码Base64。该文章可以帮助理解代码在做什么,以及为什么这样做。

主要特点:

  • 通过使用SIMD向量处理,在x86和ARM系统上非常快;
  • 可以使用OpenMP实现更多并行加速;
  • 在其他32位或64位平台上通过优化例程实现高速;
  • 读/写流数据块;
  • 不动态分配内存;
  • 有效的C99代码,可以使用严格选项编译;
  • 可重入和线程安全;
  • 经过单元测试;
  • 使用Duff's Device。

致谢

原始的AVX2、NEON和Aarch64/NEON编解码器由Inkymail慷慨贡献,他们在自己的分支中还实现了一些额外功能。他们的工作正在逐步移植回这个项目。

SSSE3和AVX2编解码器通过使用Wojciech Muła在一系列文章中描述的非常巧妙的优化而得到了实质性改进。他自己的代码在这里

AVX512编码器基于Wojciech Muła的base64simd库中的代码。

OpenMP实现由来自Exalon Delft的Ferry Toth (@htot)添加。

构建

lib目录包含实际库的代码。在顶级目录中输入make将构建lib/libbase64.obin/base64。前者是一个单独的、自包含的目标文件,可以链接到你自己的项目中。后者是一个独立的测试二进制文件,其工作方式类似于base64系统工具。

使用该库所需的匹配头文件在include/libbase64.h中。

要仅编译不带SIMD编解码器的"普通"库,输入:

make lib/libbase64.o

可以通过指定AVX2_CFLAGSAVX512_CFLAGSNEON32_CFLAGSNEON64_CFLAGSSSSE3_CFLAGSSSE41_CFLAGSSSE42_CFLAGS和/或AVX_CFLAGS环境变量来包含可选的SIMD编解码器。x86上典型的构建调用如下:

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

AVX2

要构建并包含AVX2编解码器,将AVX2_CFLAGS环境变量设置为一个能在编译器中开启AVX2支持的值,通常是-mavx2。 示例:

AVX2_CFLAGS=-mavx2 make

AVX512

要构建并包含AVX512编解码器,将AVX512_CFLAGS环境变量设置为一个能在编译器中开启AVX512支持的值,通常是-mavx512vl -mavx512vbmi。 示例:

AVX512_CFLAGS="-mavx512vl -mavx512vbmi" make

只有当运行时特性检测显示目标机器支持AVX2时,才会使用该编解码器。

SSSE3

要构建并包含SSSE3编解码器,将SSSE3_CFLAGS环境变量设置为一个能在编译器中开启SSSE3支持的值,通常是-mssse3。 示例:

SSSE3_CFLAGS=-mssse3 make

只有当运行时特性检测显示目标机器支持SSSE3时,才会使用该编解码器。

NEON

该库包含两个NEON编解码器:一个用于常规32位ARM,另一个用于64位AArch64 with NEON,后者有双倍数量的SIMD寄存器,可以进行完整的64字节表查找。这些编解码器以48字节块进行编码,以64字节大块进行解码,所以它们必须增加一个uint32/64编解码器以在较小的输入上保持快速!

使用LLVM/Clang来编译NEON编解码器。至少GCC 4.6(Raspbian附带的版本,用于测试)在编译vstq4_u8()时存在一个bug,生成的汇编代码质量低。NEON内联函数是GCC的已知弱点。Clang做得更好。

不幸的是,NEON支持无法在用户空间可移植地在运行时检测(mrc指令是特权指令),所以使用NEON编解码器的默认值在编译时确定。但你可以进行自己的运行时检测。你可以包含NEON编解码器并将其设为默认,然后在运行时检查CPU是否支持NEON,如果不支持,强制降级到非NEON,使用BASE64_FORCE_PLAIN

你有这些选项:

  1. 不包含NEON支持;
  2. 构建NEON支持并将其设为默认,但构建所有其他代码时不使用NEON标志,这样你可以在运行时用BASE64_FORCE_PLAIN覆盖默认设置;
  3. 用NEON支持构建所有内容并将其设为默认;
  4. 用NEON支持构建所有内容,但不将其设为默认(这没有意义)。

对于选项1,只需完全不指定任何NEON特定的编译器标志,像这样:

CC=clang CFLAGS="-march=armv6" make

对于选项2,保持CFLAGS简单,但将NEON32_CFLAGS环境变量设置为一个能构建NEON支持的值。例如,下面的行将在ARMv6级别构建所有代码,除了NEON编解码器,它在ARMv7级别构建。它还会将NEON编解码器设为默认。对于ARMv6平台,在运行时用BASE64_FORCE_PLAIN标志覆盖该默认设置。这样就不会触及任何ARMv7/NEON代码。

CC=clang CFLAGS="-march=armv6" NEON32_CFLAGS="-march=armv7 -mfpu=neon" make

对于选项3,将所有内容放入CFLAGS并使用一个存根但非空的NEON32_CFLAGS。这个例子适用于Raspberry Pi 2B V1.1,它支持NEON:

CC=clang CFLAGS="-march=armv7 -mtune=cortex-a7" NEON32_CFLAGS="-mfpu=neon" make

要构建并包含NEON64编解码器,像往常一样使用CFLAGS定义平台,并将NEON64_CFLAGS设置为一个非空的存根。(AArch64目标强制支持NEON64。) 示例:

CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a" NEON64_CFLAGS=" " make

OpenMP

要在GCC上启用OpenMP,需要使用-fopenmp构建。这可以通过将OPENMP环境变量设置为1来实现。

示例:

OPENMP=1 make

这将让编译器定义_OPENMP,从而将OpenMP优化的lib_openmp.c包含到lib.c中。

默认情况下,并行线程数将等于处理器的核心数。在一个带有超线程的四核处理器上,将检测到八个核心,但超线程不会提高性能。

要获取有关OpenMP的详细信息,可以使用OMP_DISPLAY_ENV=VERBOSE启动程序,例如

OMP_DISPLAY_ENV=VERBOSE test/benchmark

要限制线程数,请使用OMP_THREAD_LIMIT=n启动程序,例如:

OMP_THREAD_LIMIT=2 test/benchmark

一个运行启用OpenMP、SSSE3和AVX2的基准测试的例子:

make clean && OPENMP=1 SSSE3_CFLAGS=-mssse3 AVX2_CFLAGS=-mavx2 make && OPENMP=1 make -C test

API参考

字符串由指针和长度表示;它们不以零结尾。这是一个有意识的设计决定。在解码步骤中,依赖零终止是没有意义的,因为输出可能包含合法的零字节。在编码步骤中,返回长度可以节省对输出调用strlen()的开销。如果你坚持要追加零,可以在给定的偏移量处轻松添加。

标志

一些API调用接受flags参数。 该参数可用于强制使用特定编解码器,即使该编解码器在当前构建中是无操作的。 主要用于测试目的,这在ARM上也很有用,因为在ARM上进行运行时NEON检测的唯一方法是询问操作系统它是否可用。 可以使用以下常量:

  • BASE64_FORCE_AVX2
  • BASE64_FORCE_AVX512
  • BASE64_FORCE_NEON32
  • BASE64_FORCE_NEON64
  • BASE64_FORCE_PLAIN
  • BASE64_FORCE_SSSE3
  • BASE64_FORCE_SSE41
  • BASE64_FORCE_SSE42
  • BASE64_FORCE_AVX

flags设置为0以获得默认行为,即在x86上进行运行时特性检测,在ARM上使用编译时固定编解码器,在其他平台上使用普通编解码器。

编码

base64_encode

void base64_encode ( const char *src , size_t srclen , char *out , size_t *outlen , int flags ) ;

包装函数,用于编码给定长度的普通字符串。 输出写入out,不带尾随零。 输出长度(以字节为单位)写入outlenout中的缓冲区由调用者分配,至少为输入大小的4/3。

base64_stream_encode_init

void base64_stream_encode_init ( struct base64_state *state , int flags ) ;

在调用base64_stream_encode()之前调用此函数来初始化状态。

base64_stream_encode

void base64_stream_encode ( struct base64_state *state , const char *src , size_t srclen , char *out , size_t *outlen ) ;

src处给定长度的数据块编码到out处的缓冲区中。 调用者负责分配足够大的输出缓冲区;它必须至少是输入缓冲区大小的4/3,但要留有一些余量。 将写入的新字节数放入outlen(函数开始时设置为零)。 不会对输出进行零终止或最终处理。

base64_stream_encode_final

void base64_stream_encode_final ( struct base64_state *state , char *out , size_t *outlen ) ;

完成由之前对base64_stream_encode()的调用开始的输出。 如果适当,添加所需的流结束标记。 修改outlen,它将包含在out处写入的新字节数(通常为零)。

解码

base64_decode

int base64_decode ( const char *src , size_t srclen , char *out , size_t *outlen , int flags ) ;

包装函数,用于解码给定长度的普通字符串。 输出写入out,不带尾随零。输出长度(以字节为单位)写入outlenout中的缓冲区由调用者分配,至少为输入大小的3/4。 成功时返回1,由于无效输入导致解码错误时返回0。 如果所选编解码器未包含在当前构建中,则返回-1

base64_stream_decode_init

void base64_stream_decode_init ( struct base64_state *state , int flags ) ;

在调用base64_stream_decode()之前调用此函数来初始化状态。

base64_stream_decode

int base64_stream_decode ( struct base64_state *state , const char *src , size_t srclen , char *out , size_t *outlen ) ;

src处给定长度的数据块解码到out处的缓冲区中。 调用者负责分配足够大的输出缓冲区;它必须至少是输入缓冲区大小的3/4,但要留有一些余量。 将写入的新字节数放入outlen(函数开始时设置为零)。 不会对输出进行零终止。 如果一切正常则返回1,如果发现解码错误(如无效字符)则返回0。 如果所选编解码器未包含在当前构建中,则返回-1。 测试工具使用此函数来检查编解码器是否可用于测试。

示例

一个将静态字符串编码为base64并将输出打印到stdout的简单示例:

#include <stdio.h> /* fwrite */ #include "libbase64.h" int main () { char src[] = "hello world"; char out[20]; size_t srclen = sizeof(src) - 1; size_t outlen; base64_encode(src, srclen, out, &outlen, 0); fwrite(out, outlen, 1, stdout); return 0; }

一个将标准输入流编码到标准输出的简单示例(没有错误检查等):

#include <stdio.h> #include "libbase64.h" int main () { size_t nread, nout; char buf[12000], out[16000]; struct base64_state state; // 初始化流编码器: base64_stream_encode_init(&state, 0); // 将stdin的内容读入缓冲区: while ((nread = fread(buf, 1, sizeof(buf), stdin)) > 0) { // 编码缓冲区: base64_stream_encode(&state, buf, nread, out, &nout); // 如果有输出,将其打印到stdout: if (nout) { fwrite(out, nout, 1, stdout); } // 如果发生错误,退出循环: if (feof(stdin)) { break; } } // 完成编码: base64_stream_encode_final(&state, out, &nout); // 如果最终处理产生额外的输出字节,打印它们: if (nout) { fwrite(out, nout, 1, stdout); } return 0; }

另请参阅bin/base64.c,它是base64实用程序的简单重新实现。 文件或标准输入通过编码器/解码器传递,输出写入标准输出。

测试

请参阅tests/目录中的小型测试套件。测试使用GitHub Actions自动化,它在各种架构上构建和测试代码。

基准测试

可以使用内置的基准测试程序运行基准测试,如下所示:

make -C test benchmark <buildflags> && test/benchmark

它将为所有已编译的编解码器运行编码和解码基准测试。

下表包含一些随机机器上的结果。所有数字均使用10MB缓冲区测量,单位为MB/秒,四舍五入到最接近的整数。

*: 需要更新

x86处理器

处理器普通加密普通解密SSSE3加密SSSE3解密AVX加密AVX解密AVX2加密AVX2解密
i7-4771 @ 3.5 GHz833*1111*3333*4444*待定待定4999*6666*
i7-4770 @ 3.4 GHz DDR16001790*3038*4899*4043*4796*5709*4681*6386*
i7-4770 @ 3.4 GHz DDR1600 OPENMP 1线程1784*3041*4945*4035*4776*5719*4661*6294*
i7-4770 @ 3.4 GHz DDR1600 OPENMP 2线程3401*5729*5489*7444*5003*8624*5105*8558*
i7-4770 @ 3.4 GHz DDR1600 OPENMP 4线程4884*7099*4917*7057*4799*7143*4902*7219*
i7-4770 @ 3.4 GHz DDR1600 OPENMP 8线程5212*8849*5284*9099*5289*9220*4849*9200*
i7-4870HQ @ 2.5 GHz1471*3066*6721*6962*7015*8267*8328*11576*
i5-4590S @ 3.0 GHz33563197436361044243*62334160*6344
Xeon X5570 @ 2.93 GHz2161150831603915----
Pentium4 @ 3.4 GHz896740------
Atom N270243266508387----
AMD E-450645564625634----
Intel Edison @ 500 MHz79*92*152*172*----
Intel Edison @ 500 MHz OPENMP 2线程158*184*300*343*----
Intel Edison @ 500 MHz (x86-64)162119209164----
Intel Edison @ 500 MHz (x86-64) 2线程319237412329----

ARM处理器

处理器普通加密普通解密NEON32加密NEON32解密NEON64加密NEON64解密
Raspberry PI B+ V1.246*40*----
Raspberry PI 2 B V1.185141300225--
Apple iPhone SE armv71056*895*2943*2618*--
Apple iPhone SE arm641061*1239*--4098*3983*

PowerPC处理器

处理器普通加密普通解密
PowerPC E6500 @ 1.8GHz270*265*

i7-4770 @ 3.4 GHz DDR1600不同缓冲区大小的基准测试: 基准测�试

注意:利用缓存的最佳缓冲区大小范围为100 kB到1 MB,使AVX编码/解码速度比普通方式快12倍,或吞吐量达到24/27GB/秒。 还要注意,当缓冲区大小小于10 kB时,由于线程创建开销,性能会下降。 为防止这种情况发生,lib_openmp.c定义了OMP_THRESHOLD 20000,要求至少20000字节的缓冲区才能启用多线程。

许可证

本仓库采用BSD 2-clause许可证。详见LICENSE文件。

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多