notify: add notification library

This patch adds library that will provide ability to notify about events. On one side each spdk library can specify what kind of notification it can produce and on the other side libraries can fetch those notifications. Example is bdev module, which lib notify about added or removed bdev. Signed-off-by: Ben Walker <[email protected]> Signed-off-by: Piotr Pelplinski <[email protected]> Signed-off-by: Pawel Wodkowski <[email protected]> Change-Id: Ia95e564a8a43400b2745d9de8217b9cc84cd1b16 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/431920 Tested-by: SPDK CI Jenkins <[email protected]> Reviewed-by: Jim Harris <[email protected]>
K-Wu · Mar 29, 2019 · de5f532 · de5f532
1 parent 851829c
commit de5f532
Show file tree

Hide file tree

Showing 23 changed files with 339 additions and 20 deletions.
diff --git a/app/iscsi_tgt/Makefile b/app/iscsi_tgt/Makefile
@@ -46,7 +46,7 @@ C_SRCS := iscsi_tgt.c
 SPDK_LIB_LIST = $(ALL_MODULES_LIST)
 SPDK_LIB_LIST += event_bdev event_copy event_iscsi event_net event_scsi event
 SPDK_LIB_LIST += jsonrpc json rpc bdev_rpc bdev iscsi scsi copy trace conf
-SPDK_LIB_LIST += thread util log log_rpc trace_rpc app_rpc net sock
+SPDK_LIB_LIST += thread util log log_rpc trace_rpc app_rpc net sock notify
 
 ifeq ($(OS),Linux)
 SPDK_LIB_LIST += event_nbd nbd

diff --git a/app/nvmf_tgt/Makefile b/app/nvmf_tgt/Makefile
@@ -42,7 +42,7 @@ C_SRCS := nvmf_main.c
 SPDK_LIB_LIST = $(ALL_MODULES_LIST)
 SPDK_LIB_LIST += event_bdev event_copy event_nvmf event_net
 SPDK_LIB_LIST += nvmf event log trace conf thread util bdev copy rpc jsonrpc json net sock
-SPDK_LIB_LIST += app_rpc log_rpc trace_rpc bdev_rpc
+SPDK_LIB_LIST += app_rpc log_rpc trace_rpc bdev_rpc notify
 
 ifeq ($(OS),Linux)
 SPDK_LIB_LIST += event_nbd nbd

diff --git a/app/spdk_tgt/Makefile b/app/spdk_tgt/Makefile
@@ -52,7 +52,7 @@ endif
 
 SPDK_LIB_LIST += event_bdev event_copy event_iscsi event_net event_scsi event_nvmf event
 SPDK_LIB_LIST += nvmf trace log conf thread util bdev iscsi scsi copy rpc jsonrpc json
-SPDK_LIB_LIST += app_rpc log_rpc trace_rpc bdev_rpc net sock
+SPDK_LIB_LIST += app_rpc log_rpc trace_rpc bdev_rpc net sock notify
 
 ifeq ($(OS),Linux)
 SPDK_LIB_LIST += event_nbd nbd

diff --git a/app/vhost/Makefile b/app/vhost/Makefile
@@ -49,6 +49,6 @@ endif
 SPDK_LIB_LIST += event_bdev event_copy event_net event_scsi event
 SPDK_LIB_LIST += jsonrpc json rpc bdev_rpc bdev scsi copy trace conf
 SPDK_LIB_LIST += thread util log log_rpc trace_rpc app_rpc
-SPDK_LIB_LIST += event_nbd nbd net sock
+SPDK_LIB_LIST += event_nbd nbd net sock notify
 
 include $(SPDK_ROOT_DIR)/mk/spdk.app.mk
diff --git a/examples/bdev/fio_plugin/Makefile b/examples/bdev/fio_plugin/Makefile
@@ -43,6 +43,6 @@ CFLAGS += -I$(CONFIG_FIO_SOURCE_DIR)
 LDFLAGS += -shared -rdynamic -Wl,-z,nodelete
 
 SPDK_LIB_LIST = $(ALL_MODULES_LIST)
-SPDK_LIB_LIST += thread util bdev conf copy rpc jsonrpc json log sock trace
+SPDK_LIB_LIST += thread util bdev conf copy rpc jsonrpc json log sock trace notify
 
 include $(SPDK_ROOT_DIR)/mk/spdk.app.mk
diff --git a/examples/bdev/hello_world/Makefile b/examples/bdev/hello_world/Makefile
@@ -39,6 +39,6 @@ C_SRCS := hello_bdev.c
 
 SPDK_LIB_LIST = $(ALL_MODULES_LIST)
 SPDK_LIB_LIST += event_bdev event_copy
-SPDK_LIB_LIST += bdev copy event thread util conf trace log jsonrpc json rpc sock
+SPDK_LIB_LIST += bdev copy event thread util conf trace log jsonrpc json rpc sock notify
 
 include $(SPDK_ROOT_DIR)/mk/spdk.app.mk
diff --git a/examples/blob/cli/Makefile b/examples/blob/cli/Makefile
@@ -41,6 +41,6 @@ C_SRCS := blobcli.c
 SPDK_LIB_LIST = $(filter-out bdev_lvol,$(ALL_MODULES_LIST))
 SPDK_LIB_LIST += event_bdev event_copy
 SPDK_LIB_LIST += bdev copy event thread util conf trace \
-		log jsonrpc json rpc sock
+		log jsonrpc json rpc sock notify
 
 include $(SPDK_ROOT_DIR)/mk/spdk.app.mk
diff --git a/examples/blob/hello_world/Makefile b/examples/blob/hello_world/Makefile
@@ -40,6 +40,6 @@ C_SRCS := hello_blob.c
 SPDK_LIB_LIST = $(ALL_MODULES_LIST)
 SPDK_LIB_LIST += event_bdev event_copy
 SPDK_LIB_LIST += bdev copy event thread util conf trace \
-		log jsonrpc json rpc sock
+		log jsonrpc json rpc sock notify
 
 include $(SPDK_ROOT_DIR)/mk/spdk.app.mk
diff --git a/examples/sock/hello_world/Makefile b/examples/sock/hello_world/Makefile
@@ -38,6 +38,6 @@ APP = hello_sock
 C_SRCS := hello_sock.c
 
 SPDK_LIB_LIST = $(SOCK_MODULES_LIST)
-SPDK_LIB_LIST += event thread util conf trace log jsonrpc json rpc sock
+SPDK_LIB_LIST += event thread util conf trace log jsonrpc json rpc sock notify
 
 include $(SPDK_ROOT_DIR)/mk/spdk.app.mk
diff --git a/include/spdk/notify.h b/include/spdk/notify.h
@@ -0,0 +1,128 @@
+/*-
+ *   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.
+ */
+
+#ifndef SPDK_NOTIFY_H
+#define SPDK_NOTIFY_H
+
+#include "spdk/stdinc.h"
+#include "spdk/json.h"
+#include "spdk/queue.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * Opaque event type.
+ */
+struct spdk_notify_type;
+
+typedef int (*spdk_notify_get_type_cb)(const struct spdk_notify_type *type, void *ctx);
+
+#define SPDK_NOTIFY_MAX_NAME_SIZE 128
+#define SPDK_NOTIFY_MAX_CTX_SIZE 128
+
+struct spdk_notify_event {
+	char type[SPDK_NOTIFY_MAX_NAME_SIZE];
+	char ctx[SPDK_NOTIFY_MAX_CTX_SIZE];
+};
+
+/**
+ * Callback type for event enumeration.
+ *
+ * \param idx Event index
+ * \param event Event data
+ * \param ctx User context
+ * \return Non zero to break iteration.
+ */
+typedef int (*spdk_notify_get_event_cb)(uint64_t idx, const struct spdk_notify_event *event,
+					void *ctx);
+
+/**
+ * Register \c type as new notification type.
+ *
+ * The \c type must be valid through whole program lifetime (chance being a global variable).
+ *
+ * \note This function is thread safe.
+ *
+ * \param type New notification type to register.
+ * \return registered notification type or NULL on failure.
+ */
+struct spdk_notify_type *spdk_notify_type_register(const char *type);
+
+/**
+ * Return name of the notification type.
+ *
+ * \param type Notification type we are talking about.
+ * \return Name of notification type.
+ */
+const char *spdk_notify_type_get_name(const struct spdk_notify_type *type);
+
+/**
+ * Call cb_fn for all event types.
+ *
+ * \note Whole function call is under lock so user callback should not sleep.
+ * \param cb_fn
+ * \param ctx
+ */
+void spdk_notify_get_types(spdk_notify_get_type_cb cb_fn, void *ctx);
+
+/**
+ * Send given notification.
+ *
+ * \param type Notification type
+ * \param ctx Notification context
+ *
+ * \return Event index.
+ */
+uint64_t spdk_notify_send(const char *type, const char *ctx);
+
+/**
+ * Call cb_fn with events from given range.
+ *
+ * \note Whole function call is under lock so user callback should not sleep.
+ *
+ * \param start_idx First event index
+ * \param cb_fn User callback function. Return non-zero to break iteration.
+ * \param max Maximum number of invocations of user calback function.
+ * \param ctx User context
+ * \return Number of user callback invocations
+ */
+uint64_t spdk_notify_get_events(uint64_t start_idx, uint64_t max, spdk_notify_get_event_cb cb_fn,
+				void *ctx);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* SPDK_NOTIFY_H */
diff --git a/lib/Makefile b/lib/Makefile
@@ -36,7 +36,7 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
 
 DIRS-y += bdev blob blobfs conf copy event json jsonrpc \
           log lvol net rpc sock thread trace util nvme nvmf scsi ioat \
-	  ut_mock iscsi
+          ut_mock iscsi notify
 ifeq ($(OS),Linux)
 DIRS-y += nbd
 DIRS-$(CONFIG_VHOST) += vhost
@@ -54,6 +54,7 @@ DIRS-y += $(ENV_NAME)
 endif
 
 DEPDIRS-iscsi := scsi
+DEPDIRS-bdev := notify
 
 .PHONY: all clean $(DIRS-y)
 

diff --git a/lib/notify/Makefile b/lib/notify/Makefile
@@ -0,0 +1,40 @@
+#
+#  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.
+#
+
+SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)
+include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
+
+C_SRCS = notify.c
+LIBNAME = notify
+
+include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk