facebook/zstd

[Huffman Assembly] Expand supported platforms

Open

#2,789 建立於 2021年9月20日

在 GitHub 查看
 (11 留言) (2 反應) (1 負責人)C (27,100 star) (2,481 fork)batch import
help wantedlong-term

描述

The x86-64 Huffman assembly implementation is currently allow-listed to work on:

  • Linux: defined(__linux__) || defined(__linux)
  • MacOS: defined(__APPLE__)

The macro to check this is HUF_ASM_SUPPORTED defined in huf_decompress.c.

I've selected a very restricted set of platforms because I want to be sure that it is well tested before enabling it. Any platform that shares a calling convention with Linux should just work, but I want to be cautious of details, like working with interrupt handlers & debuggers. It should be easy to add BSD to this list, if someone wants to test that everything works as expected.

The assembly currently doesn't work on Windows because it has a different calling convention. And I had a really hard time getting the detection macros right. So if someone wants to take that on, that would be great.

Tasks:

  • Test and enable support for x86-64 assembly on BSD.
  • Add support for Windows in the x86-64 assembly & enable assembly in the Visual Studios build.
  • Add support for assembly in the amalgamated build (build/single_file_libs). Probably by translating the .S file into inline assembly.
  • Add an aarch64 assembly implementation.

貢獻者指南

技術棧
c
領域
performance
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
5
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
C programmingx86-64 assemblyBuild system (CMake)Platform calling conventions
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
15
研究方向
Examine huf decompress.c for HUF ASM SUPPORTED macro and related assembly files. Investigate current platform support for Linux and macOS. Study the x86-64 calling convention differences on Windows. Review build system configurations for Visual Studio and amalgamated build. Look into existing aarch64 assembly patterns in the codebase for implementation reference.