| 1 |
.TH "nvme_mi_admin_get_ana_log_atomic" 9 "nvme_mi_admin_get_ana_log_atomic" "November 2025" "libnvme API manual" LINUX |
| 2 |
.SH NAME |
| 3 |
nvme_mi_admin_get_ana_log_atomic \- Retrieve Asymmetric Namespace Access log page atomically |
| 4 |
.SH SYNOPSIS |
| 5 |
.B "int" nvme_mi_admin_get_ana_log_atomic |
| 6 |
.BI "(nvme_mi_ctrl_t ctrl " "," |
| 7 |
.BI "bool rgo " "," |
| 8 |
.BI "bool rae " "," |
| 9 |
.BI "unsigned int retries " "," |
| 10 |
.BI "struct nvme_ana_log *log " "," |
| 11 |
.BI "__u32 *len " ");" |
| 12 |
.SH ARGUMENTS |
| 13 |
.IP "ctrl" 12 |
| 14 |
Controller to query |
| 15 |
.IP "rgo" 12 |
| 16 |
Whether to retrieve ANA groups only (no NSIDs) |
| 17 |
.IP "rae" 12 |
| 18 |
Whether to retain asynchronous events |
| 19 |
.IP "retries" 12 |
| 20 |
The maximum number of times to retry on log page changes |
| 21 |
.IP "log" 12 |
| 22 |
Pointer to a buffer to receive the ANA log page |
| 23 |
.IP "len" 12 |
| 24 |
Input: the length of the log page buffer. |
| 25 |
Output: the actual length of the ANA log page. |
| 26 |
.SH "DESCRIPTION" |
| 27 |
See \fIstruct nvme_ana_log\fP for the definition of the returned structure. |
| 28 |
.SH "RETURN" |
| 29 |
If successful, returns 0 and sets *len to the actual log page length. |
| 30 |
If unsuccessful, returns the nvme command status if a response was received |
| 31 |
(see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. |
| 32 |
Sets errno = EINVAL if retries == 0. |
| 33 |
Sets errno = EAGAIN if unable to read the log page atomically |
| 34 |
because chgcnt changed during each of the retries attempts. |
| 35 |
Sets errno = ENOSPC if the full log page does not fit in the provided buffer. |