{"id":37146437,"url":"https://github.com/intel/ixl-go","last_synced_at":"2026-01-14T17:02:49.916Z","repository":{"id":176567157,"uuid":"645675020","full_name":"intel/ixl-go","owner":"intel","description":"Intel accelerators user library for Go","archived":false,"fork":false,"pushed_at":"2025-02-17T06:32:21.000Z","size":131,"stargazers_count":12,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-17T07:29:22.859Z","etag":null,"topics":["accelerator","compression","dsa","golang","iaa","sapphirerapids"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/intel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-26T07:22:21.000Z","updated_at":"2025-02-17T06:32:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"d1204e07-bebe-416f-b604-eafae1d2264c","html_url":"https://github.com/intel/ixl-go","commit_stats":null,"previous_names":["intel/ixl-go"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/intel/ixl-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intel%2Fixl-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intel%2Fixl-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intel%2Fixl-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intel%2Fixl-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intel","download_url":"https://codeload.github.com/intel/ixl-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intel%2Fixl-go/sbom","scorecard":{"id":490694,"data":{"date":"2025-08-11","repo":{"name":"github.com/intel/ixl-go","commit":"77c95045e34ac2766937dc16ead92a17c82c39c9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.1,"checks":[{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: security.md:1","Info: Found linked content: security.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: security.md:1","Info: Found text in security policy: security.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Code-Review","score":4,"reason":"Found 4/10 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":10,"reason":"project is fuzzed","details":["Info: GoBuiltInFuzzer integration found: compress/deflate_test.go:54","Info: GoBuiltInFuzzer integration found: compress/inflate_test.go:91","Info: GoBuiltInFuzzer integration found: compress/writer_test.go:124","Info: GoBuiltInFuzzer integration found: crc/crc_test.go:151","Info: GoBuiltInFuzzer integration found: crc/crc_test.go:167","Info: GoBuiltInFuzzer integration found: datamove/ctx_test.go:154","Info: GoBuiltInFuzzer integration found: filter/scan_test.go:141","Info: GoBuiltInFuzzer integration found: internal/device/selector_test.go:55"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T19:03:17.007Z","repository_id":176567157,"created_at":"2025-08-19T19:03:17.007Z","updated_at":"2025-08-19T19:03:17.007Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28427182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T16:38:47.836Z","status":"ssl_error","status_checked_at":"2026-01-14T16:34:59.695Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accelerator","compression","dsa","golang","iaa","sapphirerapids"],"created_at":"2026-01-14T17:02:49.171Z","updated_at":"2026-01-14T17:02:49.903Z","avatar_url":"https://github.com/intel.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Intel Accelerators User Library for Go\n============================================\n\nThe project is aimed to develop Go library of IAA/DSA to empower cloud native industry. IAA/DSA is introduced by 4th Gen Intel(R) Xeon(R) Scalable Processor which was launched on Jan'23.\n\n- [Intel Accelerators User Library for Go](#intel-accelerators-user-library-for-go)\n\t- [Supported Hardware Accelerator Features](#supported-hardware-accelerator-features)\n\t- [Advantages](#advantages)\n- [How to use](#how-to-use)\n\t- [Installation](#installation)\n\t- [Quick Start](#quick-start)\n\t\t- [Example1: Compress/Decompress](#example1-compressdecompress)\n\t\t- [Example2: CRC Calculation](#example2-crc-calculation)\n\t\t- [Example3: Data Copy](#example3-data-copy)\n- [Documentation](#documentation)\n- [FAQ](#faq)\n\t- [Why is the compression API not the same as compress/flate or compress/gzip?](#why-is-the-compression-api-not-the-same-as-compressflate-or-compressgzip)\n\t- [Why I got a \"no DSA device detected\" or \"no hardware device detected\" error?](#why-i-got-a-no-dsa-device-detected-or-no-hardware-device-detected-error)\n\n## Supported Hardware Accelerator Features\n\n- Compression/Decompression\n  - Deflate\n  - Gzip\n- CRC calculation\n- Data Filter (Bitpack / RLE format / Int Array): \n  - Expand\n  - Select\n  - Scan\n  - Extract\n- Data Move\n\n## Advantages\n\nThe library is designed to be a lightweight pure Go language implementation with zero dependencies.\n\n\n- Lower barriers to use for users, no need to install dependency libraries in advance.\n- No CGO performance overhead.\n- Easy to learn and start.\n# How to use\n\n## Installation\n\nUse the following commands to add ixl-go as a dependency to your existing Go project.\n\n```bash\ngo get github.com/intel/ixl-go\n```\n## Quick Start\n\nTo use the accelerated functions you need IAA or DSA devices on your machine.\n\nYou can use `Ready` function to check if the devices are OK for ixl-go. \n\nNotice: \n\n\u003e we don't support non-svm environment for now. \n\u003e \n\u003e We only support workqueues which enabled **block_on_fault** and **SVM**.\n\nIf you don't know about how to config IAA/DSA workqueues, you can follow [this simple recipe](./enable-iaa.md).\n\n### Example1: Compress/Decompress\n\n```go\npackage main\n\nimport (\n\t\"bytes\"\n\t\"flag\"\n\t\"io\"\n\t\"log\"\n\t\"os\"\n\n\t\"github.com/intel/ixl-go/compress\"\n)\n\nvar f = flag.String(\"f\", \"\", \"file to compress\")\n\nfunc main() {\n\tflag.Parse()\n\tif !compress.Ready() {\n\t\tlog.Fatalln(\"IAA workqueue not found\")\n\t\treturn\n\t}\n\tif *f == \"\" {\n\t\tlog.Fatalln(\"must give a file to compress\")\n\t}\n\n\tgzipExample(*f)\n\tdeflateExample(*f)\n}\n\n// gzip example:\nfunc gzipExample(filename string) {\n\tfile, err := os.Open(filename)\n\tif err != nil {\n\t\tlog.Fatalln(\"open file failed:\", err)\n\t}\n\tdefer file.Close()\n\n\toutput, err := os.Create(filename + \".gz\")\n\tif err != nil {\n\t\tlog.Fatalln(\"create file failed:\", err)\n\t}\n\tdefer output.Close()\n\n\tw := compress.NewGzip(output)\n\tw.ReadFrom(file)\n\tw.Close()\n}\n\n// deflate example:\nfunc deflateExample(filename string) {\n\tfile, err := os.Open(filename)\n\tif err != nil {\n\t\tlog.Fatalln(\"open file failed:\", err)\n\t}\n\tdefer file.Close()\n\n\tbuf := bytes.NewBuffer(nil)\n\td, err := compress.NewDeflate(buf)\n\tif err != nil {\n\t\tlog.Fatalln(\"NewDeflate failed:\", err)\n\t}\n\td.ReadFrom(file)\n\td.Close()\n\n\tinflateExample(buf)\n}\n\n// inflate example:\nfunc inflateExample(r io.Reader) {\n\ti, err := compress.NewInflate(r)\n\tif err != nil {\n\t\tlog.Fatalln(\"NewInflate failed:\", err)\n\t}\n\tblock := make([]byte, 1024)\n\tfor {\n\t\t_, err := i.Read(block)\n\t\tif err != nil {\n\t\t\tif err != io.EOF {\n\t\t\t\tlog.Fatalln(\"error:\", err)\n\t\t\t}\n\t\t\tbreak\n\t\t}\n\t}\n}\n\n```\n\n\n\n### Example2: CRC Calculation\n\n```go\nc, err := crc.NewCalculator()\nif err != nil{\n\treturn err\n}\nresult, err := c.CheckSum64(data, crc64.ISO)\n```\n\n### Example3: Data Copy\n```go\ndatamove.Copy(output, input)\n\n```\n\n# Documentation\n\n| module   | doc                           | accelerator | \n| -------- | ----------------------------- | ----------- |\n| compress | [compress](./compress/doc.md) | IAA         |\n| crc      | [crc](./crc/doc.md)           | IAA/DSA         |\n| filter   | [filter](./filter/doc.md)     | IAA         |\n| datamove | [datamove](./datamove/doc.md) | DSA         |\n| util/mem | [util/mem](./util/mem/doc.md) | _           |\n\n# FAQ\n## Why is the compression API not the same as compress/flate or compress/gzip?\n\nThere are several reasons for this:\n\n1. flate and gzip packages provide a parameter called level to tune the compression speed. \n   IAA compression is different from software, it doesn't have a tuning \"button\" to set the compression level.\n2. Compress.Deflate does not implement an io.Writer interface, instead it provides a `ReadFrom` method.\n   The main reason is that `ReadFrom` does not need to copy the data everytime and maintain a 64k+ buffer. \n   If you want an `io.Writer`, you can wrap it using the compress.BufWriter:\n\n   ```go\n    d, err := compress.NewDeflate(underWriter)\n\tif err != nil {\n\t\tlog.Fatalln(\"NewDeflate failed:\", err)\n\t}\n\tw := compress.NewWriter(d)\n\t// or using new API\n\tw = compress.NewDeflateWriter(underWriter)\n\n   ```\n   Be aware of the data copy overhead and the memory overhead.\n\n## Why I got a \"no DSA device detected\" or \"no hardware device detected\" error?\n\nFirst, please check your CPU platform, make sure you have IAA or DSA devices.\n\n```shell\nls -df /sys/bus/dsa/devices/dsa* # lists all DSA devices if present. Only \u003cpath\u003e/dsa\u003cid\u003e are devices.\nls -df /sys/bus/dsa/devices/iax* # lists all IAA devices if present.\n```\n\nThen, use the command below to check whether the workqueues have been configured.\n\n```shell\naccel-config list\n```\n\nAnd the most common reason for the problem is that the application is not running as root, try again with `sudo`. \n\nBy default, DSA and IAA workqueues must be used under root permission.\n\nIf you want to use the hardware under a non-privileged account, for example, grant IAA/wq1.0 permission to your `foo` account, try this:\n\n```shell\nsudo setfacl -m u:foo:rw /dev/iax/wq1.0\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintel%2Fixl-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintel%2Fixl-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintel%2Fixl-go/lists"}