linux/libnvme
1
0
Fork 0
Code Issues Activity

Merging upstream version 1.7.1.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 10:16:49 +01:00
parent 41144a7301
commit 476f38f2bb
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
878 changed files with 2965 additions and 1746 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
.checkpatch.conf Normal file
View file

@ -0,0 +1,24 @@
# Checkpatch options.
# REF: https://docs.kernel.org/dev-tools/checkpatch.html
# This isn't actually a Linux kernel tree
--no-tree
--max-line-length=120
--ignore EMAIL_SUBJECT
# FILE_PATH_CHANGES reports this kind of message:
# "added, moved or deleted file(s), does MAINTAINERS need updating?"
--ignore FILE_PATH_CHANGES
# Commit messages might contain a Gerrit Change-Id.
--ignore GERRIT_CHANGE_ID
# Do not check the format of commit messages, as Gerrit's merge commits do not
# preserve it.
--ignore GIT_COMMIT_ID
# Avoid "Does not appear to be a unified-diff format patch" message
--ignore NOT_UNIFIED_DIFF

19
.github/workflows/build.yml vendored
View file

@ -17,16 +17,13 @@ jobs:
compiler: [gcc, clang]
buildtype: [debug, release]
container:
image: ghcr.io/igaw/linux-nvme/debian:latest
image: ghcr.io/igaw/linux-nvme/debian.python:latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: build
run: |
scripts/build.sh -b ${{ matrix.buildtype }} -c ${{ matrix.compiler }}
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
name: upload logs
if: failure()
with:
@ -56,7 +53,7 @@ jobs:
scripts/build.sh -b release -c gcc -t ${{ matrix.arch }} cross
params: "--platform linux/amd64"
pull-params: "--platform linux/amd64"
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
name: upload logs
if: failure()
with:
@ -71,13 +68,10 @@ jobs:
image: ghcr.io/igaw/linux-nvme/debian:latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: build
run: |
scripts/build.sh -b release -c gcc libdbus
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
name: upload logs
if: failure()
with:
@ -93,13 +87,10 @@ jobs:
if: github.ref == 'refs/heads/master'
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: build
run: |
scripts/build.sh -b release -c gcc fallback
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
if: failure()
with:
name: log files

15
.github/workflows/checkpatch.yml vendored Normal file
View file

@ -0,0 +1,15 @@
name: checkpatch review
on: [pull_request]
jobs:
checkpatch:
name: checkpatch review
runs-on: ubuntu-latest
steps:
- name: 'Calculate PR commits + 1'
run: echo "PR_FETCH_DEPTH=$(( ${{ github.event.pull_request.commits }} + 1 ))" >> $GITHUB_ENV
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: ${{ env.PR_FETCH_DEPTH }}
- name: Run checkpatch review
uses: webispy/checkpatch-action@v9

1
.github/workflows/coverage.yml vendored
View file

@ -7,6 +7,7 @@ on:
jobs:
code-coverage:
if: github.repository == 'linux-nvme/libnvme'
name: code coverage
runs-on: ubuntu-latest
container:

8
.github/workflows/release-python.yml vendored
View file

@ -26,7 +26,7 @@ jobs:
- name: Build sdist
run: pipx run build --sdist
- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
with:
path: dist/*.tar.gz
retention-days: 5
@ -36,7 +36,7 @@ jobs:
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v')
steps:
- uses: actions/download-artifact@v3
- uses: actions/download-artifact@v4
with:
name: artifact
path: dist
@ -51,7 +51,7 @@ jobs:
upload_pypi:
needs: [build_sdist]
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/v') && github.repository == 'linux-nvme/libnvme'
steps:
- name: Check if it is a release tag
id: check-tag
@ -60,7 +60,7 @@ jobs:
echo ::set-output name=match::true
fi
- name: Download artifiact
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
if: steps.check-tag.outputs.match == 'true'
with:
name: artifact

2
.github/workflows/release.yml vendored
View file

@ -10,7 +10,7 @@ on:
jobs:
build:
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/v') && github.repository == 'linux-nvme/libnvme'
permissions:
contents: write
steps:

14
README.md
View file

@ -79,7 +79,13 @@ there are two project which implement the Ninja and the Meson API in pure C99
- samurai: https://github.com/michaelforney/samurai.git
- muon: https://git.sr.ht/~lattis/muon
See the CI [build](.github/workflows/build.yml) for an example how to use it.
The CI build helper script `scripts/build.sh` is able to setup and build this
project in a minimal setup using samurai and muon and thus only depending on:
- gcc
- make
- git
`scripts/build.sh -m muon`
## To compile libnvme
@ -171,8 +177,12 @@ To enable address sanitizer (advanced debugging of memory issues):
meson setup .build -Db_sanitize=address
```
This option adds `-fsanitize=address` to the gcc options. Note that when using the sanitize feature, the library `libasan.so` must be available and must be the very first library loaded when running an executable. Ensuring that `libasan.so` gets loaded first can be achieved with the `LD_PRELOAD` environment variable as follows:
This option adds `-fsanitize=address` to the gcc options. The tests can then be run normally (`meson test -C .build`).
Note that when using the sanitize feature, the library `libasan.so` must be available and must be the very first library loaded when running an executable. If experiencing linking issues, you can ensure that `libasan.so` gets loaded first with the `LD_PRELOAD` environment variable as follows:
```
meson setup .build -Db_sanitize=address && LD_PRELOAD=/lib64/libasan.so.6 ninja -C .build test
```
It's also possible to enable the undefined behavior sanitizer with `-Db_sanitize=undefined`. To enable both, use `-Db_sanitize=address,undefined`.

6
codecov.yml Normal file
View file

@ -0,0 +1,6 @@
---
ignore:
- 'subprojects'
- 'ccan'
- 'test'
- 'examples'

2
doc/conf.py
View file

@ -12,7 +12,7 @@ copyright = '2020, Keith Busch'
author = 'Keith Busch <kbusch@kernel.org>'
master_doc = 'index'
release = '1.6'
release = '1.7.1'
# -- General configuration ---------------------------------------------------

2
doc/man/nbft_control.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_control" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_control" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_control \- NBFT Table - Control Descriptor (Figure 8)
.SH SYNOPSIS

2
doc/man/nbft_control_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_control_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_control_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_control_flags \- Control Descriptor Flags
.SH SYNOPSIS

2
doc/man/nbft_desc_type.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_desc_type" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_desc_type" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_desc_type \- NBFT Elements - Descriptor Types (Figure 5)
.SH SYNOPSIS

2
doc/man/nbft_discovery.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_discovery" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_discovery" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_discovery \- Discovery Descriptor (Figure 24)
.SH SYNOPSIS

2
doc/man/nbft_discovery_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_discovery_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_discovery_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_discovery_flags \- Discovery Descriptor Flags
.SH SYNOPSIS

2
doc/man/nbft_header.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_header" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_header" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_header \- NBFT Table - Header (Figure 8)
.SH SYNOPSIS

2
doc/man/nbft_heap_obj.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_heap_obj" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_heap_obj" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_heap_obj \- NBFT Header Driver Signature
.SH SYNOPSIS

2
doc/man/nbft_hfi.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_hfi" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_hfi" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_hfi \- Host Fabric Interface (HFI) Descriptor (Figure 11)
.SH SYNOPSIS

2
doc/man/nbft_hfi_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_hfi_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_hfi_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_hfi_flags \- HFI Descriptor Flags
.SH SYNOPSIS

2
doc/man/nbft_hfi_info_tcp.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP (Figure 13)
.SH SYNOPSIS

2
doc/man/nbft_hfi_info_tcp_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_hfi_info_tcp_flags \- HFI Transport Flags
.SH SYNOPSIS

2
doc/man/nbft_host.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_host" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_host" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_host \- Host Descriptor (Figure 9)
.SH SYNOPSIS

2
doc/man/nbft_host_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_host_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_host_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_host_flags \- Host Flags
.SH SYNOPSIS

2
doc/man/nbft_info.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info \- The parsed NBFT table data.
.SH SYNOPSIS

2
doc/man/nbft_info_discovery.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_discovery" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_discovery" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_discovery \- Discovery Descriptor
.SH SYNOPSIS

2
doc/man/nbft_info_hfi.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_hfi" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_hfi" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi \- Host Fabric Interface (HFI) Descriptor
.SH SYNOPSIS

2
doc/man/nbft_info_hfi_info_tcp.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP
.SH SYNOPSIS

2
doc/man/nbft_info_host.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_host" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_host" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_host \- Host Descriptor
.SH SYNOPSIS

2
doc/man/nbft_info_nid_type.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_info_nid_type" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_info_nid_type" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_info_nid_type \- Namespace Identifier Type (NIDT)
.SH SYNOPSIS

2
doc/man/nbft_info_primary_admin_host_flag.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_info_primary_admin_host_flag \- Primary Administrative Host Descriptor Flags
.SH SYNOPSIS

2
doc/man/nbft_info_security.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_security" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_security" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_security \- Security Profile Descriptor
.SH SYNOPSIS

2
doc/man/nbft_info_subsystem_ns.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_subsystem_ns \- Subsystem Namespace (SSNS) info
.SH SYNOPSIS

2
doc/man/nbft_security.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_security" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_security" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_security \- Security Profile Descriptor (Figure 21)
.SH SYNOPSIS

2
doc/man/nbft_security_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_security_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_security_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_security_flags \- Security Profile Descriptor Flags (Figure 22)
.SH SYNOPSIS

2
doc/man/nbft_security_secret_type.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_security_secret_type" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_security_secret_type" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_security_secret_type \- Security Profile Descriptor Secret Type
.SH SYNOPSIS

2
doc/man/nbft_ssns.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_ssns" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_ssns" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_ssns \- Subsystem Namespace (SSNS) Descriptor (Figure 15)
.SH SYNOPSIS

2
doc/man/nbft_ssns_ext_info.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_ssns_ext_info \- Subsystem and Namespace Extended Information Descriptor (Figure 19)
.SH SYNOPSIS

2
doc/man/nbft_ssns_ext_info_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_ssns_ext_info_flags \- Subsystem and Namespace Extended Information Descriptor Flags
.SH SYNOPSIS

2
doc/man/nbft_ssns_flags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_ssns_flags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_ssns_flags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_ssns_flags \- Subsystem and Namespace Specific Flags Field (Figure 16)
.SH SYNOPSIS

2
doc/man/nbft_ssns_trflags.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_ssns_trflags" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_ssns_trflags" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_ssns_trflags \- SSNS Transport Specific Flags Field (Figure 17)
.SH SYNOPSIS

2
doc/man/nbft_trtype.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_trtype" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_trtype" "December 2023" "API Manual" LINUX
.SH NAME
enum nbft_trtype \- NBFT Interface Transport Types (Figure 7)
.SH SYNOPSIS

2
doc/man/nvme_admin_opcode.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_admin_opcode" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_admin_opcode" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_admin_opcode \- Known NVMe admin opcodes
.SH SYNOPSIS

2
doc/man/nvme_admin_passthru.2
View file

@ -1,4 +1,4 @@
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "September 2023" "libnvme API manual" LINUX
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru \- Submit an nvme passthrough command
.SH SYNOPSIS

2
doc/man/nvme_admin_passthru64.2
View file

@ -1,4 +1,4 @@
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "September 2023" "libnvme API manual" LINUX
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
.SH SYNOPSIS

2
doc/man/nvme_ae_info_css_nvm.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
.SH SYNOPSIS

2
doc/man/nvme_ae_info_error.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_error" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_error" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
.SH SYNOPSIS

2
doc/man/nvme_ae_info_notice.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_notice" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_notice" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
.SH SYNOPSIS

2
doc/man/nvme_ae_info_smart.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_smart" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_smart" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
.SH SYNOPSIS

2
doc/man/nvme_ae_type.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_type" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_type" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_type \- Asynchronous Event Type
.SH SYNOPSIS

2
doc/man/nvme_aggregate_endurance_group_event.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
.SH SYNOPSIS

2
doc/man/nvme_aggregate_predictable_lat_event.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS

2
doc/man/nvme_ana_group_desc.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ana_group_desc" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_group_desc" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_ana_group_desc \- ANA Group Descriptor
.SH SYNOPSIS

2
doc/man/nvme_ana_log.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ana_log" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_log" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_ana_log \- Asymmetric Namespace Access Log
.SH SYNOPSIS

2
doc/man/nvme_ana_state.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ana_state" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ana_state" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
.SH SYNOPSIS

2
doc/man/nvme_apst_entry.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_apst_entry" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_apst_entry" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_apst_entry \- Autonomous Power State Transition
.SH SYNOPSIS

2
doc/man/nvme_boot_partition.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_boot_partition" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_boot_partition" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_boot_partition \- Boot Partition Log
.SH SYNOPSIS

2
doc/man/nvme_capacity_config_desc.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
.SH SYNOPSIS

2
doc/man/nvme_capacity_mgmt.2
View file

@ -1,4 +1,4 @@
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "September 2023" "libnvme API manual" LINUX
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_capacity_mgmt \- Capacity management command
.SH SYNOPSIS

2
doc/man/nvme_change_ns_event.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_change_ns_event" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_change_ns_event" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_change_ns_event \- Change Namespace Event Data
.SH SYNOPSIS

2
doc/man/nvme_channel_config_desc.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_channel_config_desc" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_channel_config_desc" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_channel_config_desc \- Channel Configuration Descriptor
.SH SYNOPSIS

2
doc/man/nvme_cmb_size.2
View file

@ -1,4 +1,4 @@
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "September 2023" "libnvme API manual" LINUX
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_cmb_size \- Calculate size of the controller memory buffer
.SH SYNOPSIS

2
doc/man/nvme_cmd_effects.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_effects" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_effects" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_effects \- Commands Supported and Effects
.SH SYNOPSIS

2
doc/man/nvme_cmd_effects_log.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_cmd_effects_log \- Commands Supported and Effects Log
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_mset.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_mset \- Format NVM - Metadata Settings
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_pi.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pi \- Format NVM - Protection Information
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_pil.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pil \- Format NVM - Protection Information Location
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_ses.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
.SH SYNOPSIS

2
doc/man/nvme_cmd_get_log_lid.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
.SH SYNOPSIS

2
doc/man/nvme_cmd_get_log_telemetry_host_lsp.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
.SH SYNOPSIS

2
doc/man/nvme_compare.2
View file

@ -1,4 +1,4 @@
.TH "nvme_compare" 9 "nvme_compare" "September 2023" "libnvme API manual" LINUX
.TH "nvme_compare" 9 "nvme_compare" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_compare \- Submit an nvme user compare command
.SH SYNOPSIS

2
doc/man/nvme_connect_err.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_connect_err" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_connect_err" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_connect_err \- nvme connect error codes
.SH SYNOPSIS

2
doc/man/nvme_constants.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_constants" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_constants" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_constants \- A place to stash various constant nvme values
.SH SYNOPSIS

2
doc/man/nvme_copy.2
View file

@ -1,4 +1,4 @@
.TH "nvme_copy" 9 "nvme_copy" "September 2023" "libnvme API manual" LINUX
.TH "nvme_copy" 9 "nvme_copy" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_copy \- Copy command
.SH SYNOPSIS

2
doc/man/nvme_copy_range.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_copy_range" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_copy_range" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
.SH SYNOPSIS

2
doc/man/nvme_copy_range_f1.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_copy_range_f1" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_copy_range_f1" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f1 \- Copy - Source Range Entries Descriptor Format 1h
.SH SYNOPSIS

48
doc/man/nvme_copy_range_f2.2 Normal file
View file

@ -0,0 +1,48 @@
.TH "libnvme" 9 "struct nvme_copy_range_f2" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f2 \- Copy - Source Range Entries Descriptor Format 2h
.SH SYNOPSIS
struct nvme_copy_range_f2 {
.br
.BI " __le32 snsid;"
.br
.BI " __u8 rsvd4[4];"
.br
.BI " __le64 slba;"
.br
.BI " __le16 nlb;"
.br
.BI " __u8 rsvd18[4];"
.br
.BI " __le16 sopt;"
.br
.BI " __le32 eilbrt;"
.br
.BI " __le16 elbat;"
.br
.BI " __le16 elbatm;"
.br
.BI "
};
.br
.SH Members
.IP "snsid" 12
Source Namespace Identifier
.IP "rsvd4" 12
Reserved
.IP "slba" 12
Starting LBA
.IP "nlb" 12
Number of Logical Blocks
.IP "rsvd18" 12
Reserved
.IP "sopt" 12
Source Options
.IP "eilbrt" 12
Expected Initial Logical Block Reference Tag /
Expected Logical Block Storage Tag
.IP "elbat" 12
Expected Logical Block Application Tag
.IP "elbatm" 12
Expected Logical Block Application Tag Mask

52
doc/man/nvme_copy_range_f3.2 Normal file
View file

@ -0,0 +1,52 @@
.TH "libnvme" 9 "struct nvme_copy_range_f3" "December 2023" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f3 \- Copy - Source Range Entries Descriptor Format 3h
.SH SYNOPSIS
struct nvme_copy_range_f3 {
.br
.BI " __le32 snsid;"
.br
.BI " __u8 rsvd4[4];"
.br
.BI " __le64 slba;"
.br
.BI " __le16 nlb;"
.br
.BI " __u8 rsvd18[4];"
.br
.BI " __le16 sopt;"
.br
.BI " __u8 rsvd24[2];"
.br
.BI " __u8 elbt[10];"
.br
.BI " __le16 elbat;"
.br
.BI " __le16 elbatm;"
.br
.BI "
};
.br
.SH Members
.IP "snsid" 12
Source Namespace Identifier
.IP "rsvd4" 12
Reserved
.IP "slba" 12
Starting LBA
.IP "nlb" 12
Number of Logical Blocks
.IP "rsvd18" 12
Reserved
.IP "sopt" 12
Source Options
.IP "rsvd24" 12
Reserved
.IP "elbt" 12
Expected Initial Logical Block Reference Tag /
Expected Logical Block Storage Tag
.IP "elbat" 12
Expected Logical Block Application Tag
.IP "elbatm" 12
Expected Logical Block Application Tag Mask

12
doc/man/nvme_copy_range_sopt.2 Normal file
View file

@ -0,0 +1,12 @@
.TH "libnvme" 9 "enum nvme_copy_range_sopt" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_copy_range_sopt \- NVMe Copy Range Source Options
.SH SYNOPSIS
enum nvme_copy_range_sopt {
.br
.BI " NVME_COPY_SOPT_FCO"
};
.SH Constants
.IP "NVME_COPY_SOPT_FCO" 12
NVMe Copy Source Option Fast Copy Only

2
doc/man/nvme_create_ctrl.2
View file

@ -1,4 +1,4 @@
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "September 2023" "libnvme API manual" LINUX
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_create_ctrl \- Allocate an unconnected NVMe controller
.SH SYNOPSIS

2
doc/man/nvme_create_root.2
View file

@ -1,4 +1,4 @@
.TH "nvme_create_root" 9 "nvme_create_root" "September 2023" "libnvme API manual" LINUX
.TH "nvme_create_root" 9 "nvme_create_root" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_create_root \- Initialize root object
.SH SYNOPSIS

2
doc/man/nvme_csi.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_csi" "September 2023" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_csi" "December 2023" "API Manual" LINUX
.SH NAME
enum nvme_csi \- Defined command set indicators
.SH SYNOPSIS

2
doc/man/nvme_ctrl_config_match.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_config_match \- Check if ctrl @c matches config params
.SH SYNOPSIS

2
doc/man/nvme_ctrl_find.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_find \- Locate an existing controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_first_ns.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_ns \- Start namespace iterator
.SH SYNOPSIS

2
doc/man/nvme_ctrl_first_path.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_path \- Start path iterator
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_ns.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns \- Traverse namespaces
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_ns_safe.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns_safe \- Traverse namespaces
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_path.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path \- Traverse paths
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_path_safe.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path_safe \- Traverse paths
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_address.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_address \- Address string of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_config.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_config \- Fabrics configuration of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_dhchap_host_key.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_host_key \- Return host key
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_dhchap_key.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_key \- Return controller key
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_fd.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_fd \- Get associated file descriptor
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_firmware.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_firmware \- Firmware string of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_host_iface.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_iface \- Host interface name of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_host_traddr.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_traddr \- Host transport address of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_model.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_model \- Model of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_name.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_name \- sysfs name of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_numa_node.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_numa_node \- NUMA node of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_phy_slot.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_phy_slot" 9 "nvme_ctrl_get_phy_slot" "September 2023" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_phy_slot" 9 "nvme_ctrl_get_phy_slot" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_phy_slot \- PCI physical slot number of a controller
.SH SYNOPSIS

Some files were not shown because too many files have changed in this diff Show more