Skip to content

Commit 24a3908

Browse files
committed
mi: Introduce asynchronous event message handling
Added new functionality to mi.c and mi-mctp.c to handle AEMs. Included new example mi-mctp-ae.c for usage. Added tests for mi-mctp. Signed-off-by: Chuck Horkin <[email protected]>
1 parent 5ec1f52 commit 24a3908

9 files changed

Lines changed: 2240 additions & 57 deletions

File tree

examples/meson.build

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ executable(
4040
include_directories: [incdir, internal_incdir]
4141
)
4242

43+
executable(
44+
'mi-mctp-ae',
45+
['mi-mctp-ae.c'],
46+
dependencies: libnvme_mi_dep,
47+
include_directories: [incdir, internal_incdir]
48+
)
49+
4350
if libdbus_dep.found()
4451
executable(
4552
'mi-conf',

examples/mi-mctp-ae.c

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
// SPDX-License-Identifier: LGPL-2.1-or-later
2+
/**
3+
* This file is part of libnvme.
4+
*/
5+
6+
/**
7+
* mi-mctp-ae: open a MI connection over MCTP, supporting asynchronous event messages
8+
*/
9+
10+
#include <assert.h>
11+
#include <ctype.h>
12+
#include <err.h>
13+
#include <stdio.h>
14+
#include <stdlib.h>
15+
#include <stddef.h>
16+
#include <string.h>
17+
#include <errno.h>
18+
#include <unistd.h> // for usleep
19+
20+
#include <libnvme-mi.h>
21+
#include <poll.h>
22+
23+
#include <ccan/array_size/array_size.h>
24+
#include <ccan/endian/endian.h>
25+
#include <sys/select.h>
26+
27+
struct app_userdata {
28+
uint32_t count;
29+
};
30+
31+
static void print_byte_array(void *data, size_t len)
32+
{
33+
uint8_t *byte_data = (uint8_t *)data;
34+
35+
for (size_t i = 0; i < len; ++i)
36+
printf("%02X ", byte_data[i]);
37+
printf("\n");
38+
}
39+
40+
static void print_event_info(struct nvme_mi_event *event)
41+
{
42+
printf("aeoi: %02X\n", event->aeoi);
43+
printf("aeocidi: %04X\n", event->aeocidi);
44+
printf("aessi: %02X\n", event->aessi);
45+
46+
if (event->spec_info_len && event->spec_info) {
47+
printf("specific_info: ");
48+
print_byte_array(event->spec_info, event->spec_info_len);
49+
}
50+
51+
if (event->vend_spec_info_len && event->vend_spec_info) {
52+
printf("vendor_specific_info: ");
53+
print_byte_array(event->vend_spec_info, event->vend_spec_info_len);
54+
}
55+
}
56+
57+
enum nvme_mi_aem_handler_next_action aem_handler(nvme_mi_ep_t ep, size_t num_events, void *userdata)
58+
{
59+
struct app_userdata *data = (struct app_userdata *) userdata;
60+
61+
data->count++;
62+
63+
printf("Received notification #%d with %zu events:\n", data->count, num_events);
64+
for (int i = 0; i < num_events; i++) {
65+
struct nvme_mi_event *event = nvme_mi_aem_get_next_event(ep);
66+
67+
if (event == NULL)
68+
printf("Unexpected NULL event\n");
69+
else {
70+
printf("Event:\n");
71+
print_event_info(event);
72+
printf("\n");
73+
}
74+
}
75+
76+
return NVME_MI_AEM_HNA_ACK;
77+
}
78+
79+
int main(int argc, char **argv)
80+
{
81+
nvme_root_t root;
82+
nvme_mi_ep_t ep;
83+
uint8_t eid = 0;
84+
int rc = 0, net = 0;
85+
struct nvme_mi_aem_config aem_cb_info = {0};
86+
struct nvme_mi_aem_enabled_map enabled_map = {0};
87+
struct app_userdata data = {0};
88+
89+
const uint8_t AEM_FD_INDEX = 0;
90+
const uint8_t STD_IN_FD_INDEX = 1;
91+
92+
if (argc == 4) {
93+
net = atoi(argv[1]);
94+
eid = atoi(argv[2]) & 0xff;
95+
argv += 2;
96+
argc -= 2;
97+
98+
int event_count = argc - 1;
99+
100+
for (int i = 0; i < event_count; i++) {
101+
int event = atoi(argv[1+i]);
102+
103+
aem_cb_info.enabled_map.enabled[event] = true;
104+
}
105+
} else {
106+
fprintf(stderr,
107+
"usage: %s <net> <eid> [AE #s separated by spaces]\n",
108+
argv[0]);
109+
return EXIT_FAILURE;
110+
}
111+
112+
root = nvme_mi_create_root(stderr, DEFAULT_LOGLEVEL);
113+
if (!root)
114+
err(EXIT_FAILURE, "can't create NVMe root");
115+
116+
ep = nvme_mi_open_mctp(root, net, eid);
117+
if (!ep)
118+
errx(EXIT_FAILURE, "can't open MCTP endpoint %d:%d", net, eid);
119+
120+
aem_cb_info.aem_handler = aem_handler;
121+
122+
rc = nvme_mi_aem_get_enabled(ep, &enabled_map);
123+
if (rc)
124+
errx(EXIT_FAILURE, "Can't query enabled aems:%d (%d)", rc, errno);
125+
printf("The following events are now enabled:\n");
126+
for (int i = 0; i < 256; i++) {
127+
if (enabled_map.enabled[i])
128+
printf("Event: %d\n", i);
129+
}
130+
131+
rc = nvme_mi_aem_enable(ep, true, true, true, 1, 100, &aem_cb_info, &data);
132+
if (rc)
133+
errx(EXIT_FAILURE, "Can't enable aem:%d (%d)", rc, errno);
134+
135+
rc = nvme_mi_aem_get_enabled(ep, &enabled_map);
136+
if (rc)
137+
errx(EXIT_FAILURE, "Can't query enabled aems:%d (%d)", rc, errno);
138+
139+
struct pollfd fds[2];
140+
141+
fds[AEM_FD_INDEX].fd = nvme_mi_aem_get_fd(ep);
142+
if (fds[AEM_FD_INDEX].fd < 0)
143+
errx(EXIT_FAILURE, "Can't get aem fd\n");
144+
145+
fds[STD_IN_FD_INDEX].fd = STDIN_FILENO;
146+
147+
fds[AEM_FD_INDEX].events = POLLIN;
148+
fds[STD_IN_FD_INDEX].events = POLLIN;
149+
150+
printf("Press any key to exit\n");
151+
while (1) {
152+
rc = poll(fds, 2, -1);
153+
154+
if (rc == -1) {
155+
perror("poll");
156+
break;
157+
}
158+
//Time to do the work
159+
if (fds[AEM_FD_INDEX].revents & POLLIN) {
160+
rc = nvme_mi_aem_process(ep, &data);
161+
if (rc)
162+
errx(EXIT_FAILURE,
163+
"nvme_mi_aem_process failed with:%d (%d)",
164+
rc,
165+
errno);
166+
}
167+
if (fds[STD_IN_FD_INDEX].revents & POLLIN)
168+
break;//we are done
169+
}
170+
171+
//Cleanup
172+
nvme_mi_aem_disable(ep);
173+
nvme_mi_close(ep);
174+
nvme_mi_free_root(root);
175+
176+
return rc ? EXIT_FAILURE : EXIT_SUCCESS;
177+
}
178+
179+

src/libnvme-mi.map

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
LIBNVME_MI_1_13 {
2+
global:
3+
nvme_mi_aem_get_fd;
4+
nvme_mi_aem_enable;
5+
nvme_mi_aem_process;
6+
nvme_mi_aem_disable;
7+
nvme_mi_aem_get_next_event;
8+
nvme_mi_aem_get_enabled;
9+
};
10+
111
LIBNVME_MI_1_12 {
212
global:
313
nvme_mi_mi_xfer;

0 commit comments

Comments
 (0)