1 files changed, 580 insertions, 0 deletions

diff --git a/src/spdk/test/nvme/aer/aer.c b/src/spdk/test/nvme/aer/aer.c
new file mode 100644
index 00000000..e102813f
--- /dev/null
+++ b/src/spdk/test/nvme/aer/aer.c
@@ -0,0 +1,580 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright (c) Intel Corporation.
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "spdk/stdinc.h"
+
+#include "spdk/log.h"
+#include "spdk/nvme.h"
+#include "spdk/env.h"
+
+#define MAX_DEVS 64
+
+struct dev {
+	struct spdk_nvme_ctrlr				*ctrlr;
+	struct spdk_nvme_health_information_page	*health_page;
+	struct spdk_nvme_ns_list			*changed_ns_list;
+	uint32_t					orig_temp_threshold;
+	char						name[SPDK_NVMF_TRADDR_MAX_LEN + 1];
+};
+
+static void get_feature_test(struct dev *dev);
+
+static struct dev devs[MAX_DEVS];
+static int num_devs = 0;
+
+#define foreach_dev(iter) \
+	for (iter = devs; iter - devs < num_devs; iter++)
+
+static int outstanding_commands = 0;
+static int aer_done = 0;
+static int temperature_done = 0;
+static int failed = 0;
+static struct spdk_nvme_transport_id g_trid;
+
+/* Enable AER temperature test */
+static int enable_temp_test = 0;
+/* Enable AER namespace attribute notice test, this variable holds
+ * the NSID that is expected to be in the Changed NS List.
+ */
+static uint32_t expected_ns_test = 0;
+
+static void
+set_temp_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl)
+{
+	struct dev *dev = cb_arg;
+
+	outstanding_commands--;
+
+	if (spdk_nvme_cpl_is_error(cpl)) {
+		printf("%s: set feature (temp threshold) failed\n", dev->name);
+		failed = 1;
+		return;
+	}
+
+	/* Admin command completions are synchronized by the NVMe driver,
+	 * so we don't need to do any special locking here. */
+	temperature_done++;
+}
+
+static int
+set_temp_threshold(struct dev *dev, uint32_t temp)
+{
+	struct spdk_nvme_cmd cmd = {};
+	int rc;
+
+	cmd.opc = SPDK_NVME_OPC_SET_FEATURES;
+	cmd.cdw10 = SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD;
+	cmd.cdw11 = temp;
+
+	rc = spdk_nvme_ctrlr_cmd_admin_raw(dev->ctrlr, &cmd, NULL, 0, set_temp_completion, dev);
+	if (rc == 0) {
+		outstanding_commands++;
+	}
+
+	return rc;
+}
+
+static void
+get_temp_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl)
+{
+	struct dev *dev = cb_arg;
+
+	outstanding_commands--;
+
+	if (spdk_nvme_cpl_is_error(cpl)) {
+		printf("%s: get feature (temp threshold) failed\n", dev->name);
+		failed = 1;
+		return;
+	}
+
+	dev->orig_temp_threshold = cpl->cdw0;
+	printf("%s: original temperature threshold: %u Kelvin (%d Celsius)\n",
+	       dev->name, dev->orig_temp_threshold, dev->orig_temp_threshold - 273);
+
+	temperature_done++;
+}
+
+static int
+get_temp_threshold(struct dev *dev)
+{
+	struct spdk_nvme_cmd cmd = {};
+	int rc;
+
+	cmd.opc = SPDK_NVME_OPC_GET_FEATURES;
+	cmd.cdw10 = SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD;
+
+	rc = spdk_nvme_ctrlr_cmd_admin_raw(dev->ctrlr, &cmd, NULL, 0, get_temp_completion, dev);
+	if (rc == 0) {
+		outstanding_commands++;
+	}
+
+	return rc;
+}
+
+static void
+print_health_page(struct dev *dev, struct spdk_nvme_health_information_page *hip)
+{
+	printf("%s: Current Temperature:         %u Kelvin (%d Celsius)\n",
+	       dev->name, hip->temperature, hip->temperature - 273);
+}
+
+static void
+get_health_log_page_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl)
+{
+	struct dev *dev = cb_arg;
+
+	outstanding_commands --;
+
+	if (spdk_nvme_cpl_is_error(cpl)) {
+		printf("%s: get log page failed\n", dev->name);
+		failed = 1;
+		return;
+	}
+
+	print_health_page(dev, dev->health_page);
+	aer_done++;
+}
+
+static void
+get_changed_ns_log_page_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl)
+{
+	struct dev *dev = cb_arg;
+	bool found = false;
+	uint32_t i;
+
+	outstanding_commands --;
+
+	if (spdk_nvme_cpl_is_error(cpl)) {
+		printf("%s: get log page failed\n", dev->name);
+		failed = 1;
+		return;
+	}
+
+	/* Let's compare the expected namespce ID is
+	 * in changed namespace list
+	 */
+	if (dev->changed_ns_list->ns_list[0] != 0xffffffffu) {
+		for (i = 0; i < sizeof(*dev->changed_ns_list) / sizeof(uint32_t); i++) {
+			if (expected_ns_test == dev->changed_ns_list->ns_list[i]) {
+				printf("%s: changed NS list contains expected NSID: %u\n",
+				       dev->name, expected_ns_test);
+				found = true;
+				break;
+			}
+		}
+	}
+
+	if (!found) {
+		printf("%s: Error: Can't find expected NSID %u\n", dev->name, expected_ns_test);
+		failed = 1;
+	}
+
+	aer_done++;
+}
+
+static int
+get_health_log_page(struct dev *dev)
+{
+	int rc;
+
+	rc = spdk_nvme_ctrlr_cmd_get_log_page(dev->ctrlr, SPDK_NVME_LOG_HEALTH_INFORMATION,
+					      SPDK_NVME_GLOBAL_NS_TAG, dev->health_page, sizeof(*dev->health_page), 0,
+					      get_health_log_page_completion, dev);
+
+	if (rc == 0) {
+		outstanding_commands++;
+	}
+
+	return rc;
+}
+
+static int
+get_changed_ns_log_page(struct dev *dev)
+{
+	int rc;
+
+	rc = spdk_nvme_ctrlr_cmd_get_log_page(dev->ctrlr, SPDK_NVME_LOG_CHANGED_NS_LIST,
+					      SPDK_NVME_GLOBAL_NS_TAG, dev->changed_ns_list,
+					      sizeof(*dev->changed_ns_list), 0,
+					      get_changed_ns_log_page_completion, dev);
+
+	if (rc == 0) {
+		outstanding_commands++;
+	}
+
+	return rc;
+}
+
+static void
+cleanup(void)
+{
+	struct dev *dev;
+
+	foreach_dev(dev) {
+		if (dev->health_page) {
+			spdk_dma_free(dev->health_page);
+		}
+		if (dev->changed_ns_list) {
+			spdk_dma_free(dev->changed_ns_list);
+		}
+	}
+}
+
+static void
+aer_cb(void *arg, const struct spdk_nvme_cpl *cpl)
+{
+	uint32_t log_page_id = (cpl->cdw0 & 0xFF0000) >> 16;
+	struct dev *dev = arg;
+
+	if (spdk_nvme_cpl_is_error(cpl)) {
+		printf("%s: AER failed\n", dev->name);
+		failed = 1;
+		return;
+	}
+
+	printf("%s: aer_cb for log page %d\n", dev->name, log_page_id);
+
+	if (log_page_id == SPDK_NVME_LOG_HEALTH_INFORMATION) {
+		/* Set the temperature threshold back to the original value
+		 * so the AER doesn't trigger again.
+		 */
+		set_temp_threshold(dev, dev->orig_temp_threshold);
+		get_health_log_page(dev);
+	} else if (log_page_id == SPDK_NVME_LOG_CHANGED_NS_LIST) {
+		get_changed_ns_log_page(dev);
+	}
+}
+
+static void
+usage(const char *program_name)
+{
+	printf("%s [options]", program_name);
+	printf("\n");
+	printf("options:\n");
+	printf(" -T         enable temperature tests\n");
+	printf(" -n         expected Namespace attribute notice ID\n");
+	printf(" -r trid    remote NVMe over Fabrics target address\n");
+	printf("    Format: 'key:value [key:value] ...'\n");
+	printf("    Keys:\n");
+	printf("     trtype      Transport type (e.g. RDMA)\n");
+	printf("     adrfam      Address family (e.g. IPv4, IPv6)\n");
+	printf("     traddr      Transport address (e.g. 192.168.100.8)\n");
+	printf("     trsvcid     Transport service identifier (e.g. 4420)\n");
+	printf("     subnqn      Subsystem NQN (default: %s)\n", SPDK_NVMF_DISCOVERY_NQN);
+	printf("    Example: -r 'trtype:RDMA adrfam:IPv4 traddr:192.168.100.8 trsvcid:4420'\n");
+
+	spdk_tracelog_usage(stdout, "-L");
+
+	printf(" -v         verbose (enable warnings)\n");
+	printf(" -H         show this usage\n");
+}
+
+static int
+parse_args(int argc, char **argv)
+{
+	int op, rc;
+
+	g_trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
+	snprintf(g_trid.subnqn, sizeof(g_trid.subnqn), "%s", SPDK_NVMF_DISCOVERY_NQN);
+
+	while ((op = getopt(argc, argv, "n:r:HL:T")) != -1) {
+		switch (op) {
+		case 'n':
+			expected_ns_test = atoi(optarg);
+			break;
+		case 'r':
+			if (spdk_nvme_transport_id_parse(&g_trid, optarg) != 0) {
+				fprintf(stderr, "Error parsing transport address\n");
+				return 1;
+			}
+			break;
+		case 'L':
+			rc = spdk_log_set_trace_flag(optarg);
+			if (rc < 0) {
+				fprintf(stderr, "unknown flag\n");
+				usage(argv[0]);
+				exit(EXIT_FAILURE);
+			}
+			spdk_log_set_print_level(SPDK_LOG_DEBUG);
+#ifndef DEBUG
+			fprintf(stderr, "%s must be rebuilt with CONFIG_DEBUG=y for -L flag.\n",
+				argv[0]);
+			usage(argv[0]);
+			return 0;
+#endif
+			break;
+		case 'T':
+			enable_temp_test = 1;
+			break;
+		case 'H':
+		default:
+			usage(argv[0]);
+			return 1;
+		}
+	}
+
+	return 0;
+}
+
+static bool
+probe_cb(void *cb_ctx, const struct spdk_nvme_transport_id *trid,
+	 struct spdk_nvme_ctrlr_opts *opts)
+{
+	printf("Attaching to %s\n", trid->traddr);
+
+	return true;
+}
+
+static void
+attach_cb(void *cb_ctx, const struct spdk_nvme_transport_id *trid,
+	  struct spdk_nvme_ctrlr *ctrlr, const struct spdk_nvme_ctrlr_opts *opts)
+{
+	struct dev *dev;
+
+	/* add to dev list */
+	dev = &devs[num_devs++];
+
+	dev->ctrlr = ctrlr;
+
+	snprintf(dev->name, sizeof(dev->name), "%s",
+		 trid->traddr);
+
+	printf("Attached to %s\n", dev->name);
+
+	dev->health_page = spdk_dma_zmalloc(sizeof(*dev->health_page), 4096, NULL);
+	if (dev->health_page == NULL) {
+		printf("Allocation error (health page)\n");
+		failed = 1;
+	}
+	dev->changed_ns_list = spdk_dma_zmalloc(sizeof(*dev->changed_ns_list), 4096, NULL);
+	if (dev->changed_ns_list == NULL) {
+		printf("Allocation error (changed namespace list page)\n");
+		failed = 1;
+	}
+}
+
+static void
+get_feature_test_cb(void *cb_arg, const struct spdk_nvme_cpl *cpl)
+{
+	struct dev *dev = cb_arg;
+
+	outstanding_commands--;
+
+	if (spdk_nvme_cpl_is_error(cpl)) {
+		printf("%s: get number of queues failed\n", dev->name);
+		failed = 1;
+		return;
+	}
+
+	if (aer_done < num_devs) {
+		/*
+		 * Resubmit Get Features command to continue filling admin queue
+		 * while the test is running.
+		 */
+		get_feature_test(dev);
+	}
+}
+
+static void
+get_feature_test(struct dev *dev)
+{
+	struct spdk_nvme_cmd cmd;
+
+	memset(&cmd, 0, sizeof(cmd));
+	cmd.opc = SPDK_NVME_OPC_GET_FEATURES;
+	cmd.cdw10 = SPDK_NVME_FEAT_NUMBER_OF_QUEUES;
+	if (spdk_nvme_ctrlr_cmd_admin_raw(dev->ctrlr, &cmd, NULL, 0,
+					  get_feature_test_cb, dev) != 0) {
+		printf("Failed to send Get Features command for dev=%p\n", dev);
+		failed = 1;
+		return;
+	}
+
+	outstanding_commands++;
+}
+
+static int
+spdk_aer_temperature_test(void)
+{
+	struct dev *dev;
+
+	printf("Getting temperature thresholds of all controllers...\n");
+	foreach_dev(dev) {
+		/* Get the original temperature threshold */
+		get_temp_threshold(dev);
+	}
+
+	while (!failed && temperature_done < num_devs) {
+		foreach_dev(dev) {
+			spdk_nvme_ctrlr_process_admin_completions(dev->ctrlr);
+		}
+	}
+
+	if (failed) {
+		return failed;
+	}
+	temperature_done = 0;
+	aer_done = 0;
+
+	/* Send admin commands to test admin queue wraparound while waiting for the AER */
+	foreach_dev(dev) {
+		get_feature_test(dev);
+	}
+
+	if (failed) {
+		return failed;
+	}
+
+	printf("Waiting for all controllers to trigger AER...\n");
+	foreach_dev(dev) {
+		/* Set the temperature threshold to a low value */
+		set_temp_threshold(dev, 200);
+	}
+
+	if (failed) {
+		return failed;
+	}
+
+	while (!failed && (aer_done < num_devs || temperature_done < num_devs)) {
+		foreach_dev(dev) {
+			spdk_nvme_ctrlr_process_admin_completions(dev->ctrlr);
+		}
+	}
+
+	if (failed) {
+		return failed;
+	}
+
+	return 0;
+}
+
+static int
+spdk_aer_changed_ns_test(void)
+{
+	struct dev *dev;
+
+	aer_done = 0;
+
+	printf("Starting namespce attribute notice tests for all controllers...\n");
+
+	foreach_dev(dev) {
+		get_feature_test(dev);
+	}
+
+	if (failed) {
+		return failed;
+	}
+
+	while (!failed && (aer_done < num_devs)) {
+		foreach_dev(dev) {
+			spdk_nvme_ctrlr_process_admin_completions(dev->ctrlr);
+		}
+	}
+
+	if (failed) {
+		return failed;
+	}
+
+	return 0;
+}
+
+int main(int argc, char **argv)
+{
+	struct dev		*dev;
+	int			i;
+	struct spdk_env_opts	opts;
+	int			rc;
+
+	rc = parse_args(argc, argv);
+	if (rc != 0) {
+		return rc;
+	}
+
+	spdk_env_opts_init(&opts);
+	opts.name = "aer";
+	opts.core_mask = "0x1";
+	opts.mem_size = 64;
+	if (spdk_env_init(&opts) < 0) {
+		fprintf(stderr, "Unable to initialize SPDK env\n");
+		return 1;
+	}
+
+	printf("Asynchronous Event Request test\n");
+
+	if (spdk_nvme_probe(&g_trid, NULL, probe_cb, attach_cb, NULL) != 0) {
+		fprintf(stderr, "spdk_nvme_probe() failed\n");
+		return 1;
+	}
+
+	if (failed) {
+		goto done;
+	}
+
+	printf("Registering asynchronous event callbacks...\n");
+	foreach_dev(dev) {
+		spdk_nvme_ctrlr_register_aer_callback(dev->ctrlr, aer_cb, dev);
+	}
+
+	/* AER temperature test */
+	if (enable_temp_test) {
+		if (spdk_aer_temperature_test()) {
+			goto done;
+		}
+	}
+
+	/* AER changed namespace list test */
+	if (expected_ns_test) {
+		if (spdk_aer_changed_ns_test()) {
+			goto done;
+		}
+	}
+
+	printf("Cleaning up...\n");
+
+	while (outstanding_commands) {
+		foreach_dev(dev) {
+			spdk_nvme_ctrlr_process_admin_completions(dev->ctrlr);
+		}
+	}
+
+	for (i = 0; i < num_devs; i++) {
+		struct dev *dev = &devs[i];
+
+		spdk_nvme_detach(dev->ctrlr);
+	}
+
+done:
+	cleanup();
+
+	return failed;
+}