ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

notify: add notification library

Browse Source 
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 <benjamin.walker@intel.com>
Signed-off-by: Piotr Pelplinski <piotr.pelplinski@intel.com>
Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
Change-Id: Ia95e564a8a43400b2745d9de8217b9cc84cd1b16
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/431920
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Piotr Pelplinski 2018-11-14 09:36:25 +01:00 committed by Jim Harris
parent 851829c4ea
commit de5f53220c
23 changed files with 339 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/iscsi_tgt/Makefile
View File

@ -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

2
app/nvmf_tgt/Makefile
View File

@ -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

2
app/spdk_tgt/Makefile
View File

@ -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

2
app/vhost/Makefile
View File

@ -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

2
examples/bdev/fio_plugin/Makefile
View File

@ -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

2
examples/bdev/hello_world/Makefile
View File

@ -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

2
examples/blob/cli/Makefile
View File

@ -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

2
examples/blob/hello_world/Makefile
View File

@ -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

2
examples/sock/hello_world/Makefile
View File

@ -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

128
include/spdk/notify.h Normal file
View File

@ -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 */

3
lib/Makefile
View File

@ -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)

40
lib/notify/Makefile Normal file
View File

@ -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

150
lib/notify/notify.c Normal file
View File

@ -0,0 +1,150 @@
/*-
* 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 <sys/queue.h>
#include "spdk/stdinc.h"
#include "spdk/util.h"
#include "spdk/queue.h"
#include "spdk/string.h"
#include "spdk/log.h"
#include "spdk/notify.h"
#define SPDK_NOTIFY_MAX_EVENTS 1024
struct spdk_notify_type {
char name[SPDK_NOTIFY_MAX_NAME_SIZE];
TAILQ_ENTRY(spdk_notify_type) tailq;
};
pthread_mutex_t g_events_lock = PTHREAD_MUTEX_INITIALIZER;
static struct spdk_notify_event g_events[SPDK_NOTIFY_MAX_EVENTS];
static uint64_t g_events_head;
static TAILQ_HEAD(, spdk_notify_type) g_notify_types = TAILQ_HEAD_INITIALIZER(g_notify_types);
struct spdk_notify_type *
spdk_notify_type_register(const char *type)
{
struct spdk_notify_type *it = NULL;
if (!type) {
SPDK_ERRLOG("Invalid notification type %p\n", type);
return NULL;
} else if (!type || strlen(type) >= SPDK_NOTIFY_MAX_NAME_SIZE) {
SPDK_ERRLOG("Invalid notification type (add: %p, name: %s)\n", type,
type ? type : "(null)");
return NULL;
}
pthread_mutex_lock(&g_events_lock);
TAILQ_FOREACH(it, &g_notify_types, tailq) {
if (strcmp(type, it->name) == 0) {
SPDK_ERRLOG("Notification type '%s' already registered.\n", type);
goto out;
}
}
it = calloc(1, sizeof(*it));
if (it == NULL) {
goto out;
}
snprintf(it->name, sizeof(it->name), "%s", type);
TAILQ_INSERT_TAIL(&g_notify_types, it, tailq);
out:
pthread_mutex_unlock(&g_events_lock);
return it;
}
const char *
spdk_notify_type_get_name(const struct spdk_notify_type *type)
{
return type->name;
}
void
spdk_notify_get_types(spdk_notify_get_type_cb cb, void *ctx)
{
struct spdk_notify_type *it;
pthread_mutex_lock(&g_events_lock);
TAILQ_FOREACH(it, &g_notify_types, tailq) {
if (cb(it, ctx)) {
break;
}
}
pthread_mutex_unlock(&g_events_lock);
}
uint64_t
spdk_notify_send(const char *type, const char *ctx)
{
uint64_t head;
struct spdk_notify_event *ev;
pthread_mutex_lock(&g_events_lock);
head = g_events_head;
g_events_head++;
ev = &g_events[head % SPDK_NOTIFY_MAX_EVENTS];
spdk_strcpy_pad(ev->type, type, sizeof(ev->type), '\0');
spdk_strcpy_pad(ev->ctx, ctx, sizeof(ev->ctx), '\0');
pthread_mutex_unlock(&g_events_lock);
return head;
}
uint64_t
spdk_notify_get_events(uint64_t start_idx, uint64_t max, spdk_notify_get_event_cb cb_fn, void *ctx)
{
uint64_t i;
pthread_mutex_lock(&g_events_lock);
if (g_events_head > SPDK_NOTIFY_MAX_EVENTS && start_idx < g_events_head - SPDK_NOTIFY_MAX_EVENTS) {
start_idx = g_events_head - SPDK_NOTIFY_MAX_EVENTS;
}
for (i = 0; start_idx < g_events_head && i < max; start_idx++, i++) {
if (cb_fn(start_idx, &g_events[start_idx % SPDK_NOTIFY_MAX_EVENTS], ctx)) {
break;
}
}
pthread_mutex_unlock(&g_events_lock);
return i;
}

2
lib/rocksdb/spdk.rocksdb.mk
View File

@ -55,7 +55,7 @@ endif
SPDK_LIB_LIST = $(ALL_MODULES_LIST)
SPDK_LIB_LIST += event_bdev event_copy
SPDK_LIB_LIST += bdev copy event util conf trace log jsonrpc json rpc sock thread
SPDK_LIB_LIST += bdev copy event util conf trace log jsonrpc json rpc sock thread notify
AM_LINK += $(SPDK_LIB_LINKER_ARGS) $(ENV_LINKER_ARGS)
AM_LINK += $(SYS_LIBS)

2
test/app/bdev_svc/Makefile
View File

@ -42,7 +42,7 @@ C_SRCS := bdev_svc.c
SPDK_LIB_LIST = $(ALL_MODULES_LIST)
SPDK_LIB_LIST += event_bdev event_copy
SPDK_LIB_LIST += nvmf event log trace conf thread util bdev copy rpc jsonrpc json 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

2
test/app/stub/Makefile
View File

@ -40,6 +40,6 @@ APP = stub
C_SRCS := stub.c
SPDK_LIB_LIST = $(SOCK_MODULES_LIST)
SPDK_LIB_LIST += event conf nvme log trace rpc jsonrpc json thread util sock
SPDK_LIB_LIST += event conf nvme log trace rpc jsonrpc json thread util sock notify
include $(SPDK_ROOT_DIR)/mk/spdk.app.mk

2
test/bdev/bdevio/Makefile
View File

@ -41,7 +41,7 @@ C_SRCS := bdevio.c
SPDK_LIB_LIST = $(ALL_MODULES_LIST)
SPDK_LIB_LIST += event_bdev event_copy
SPDK_LIB_LIST += bdev copy event trace log conf thread util rpc jsonrpc json sock
SPDK_LIB_LIST += bdev copy event trace log conf thread util rpc jsonrpc json sock notify
LIBS += -lcunit

2
test/bdev/bdevperf/Makefile
View File

@ -41,6 +41,6 @@ C_SRCS := bdevperf.c
SPDK_LIB_LIST = $(ALL_MODULES_LIST)
SPDK_LIB_LIST += event_bdev event_copy
SPDK_LIB_LIST += bdev copy event trace log conf thread util rpc bdev_rpc jsonrpc json sock
SPDK_LIB_LIST += bdev copy event trace log conf thread util rpc bdev_rpc jsonrpc json sock notify
include $(SPDK_ROOT_DIR)/mk/spdk.app.mk

2
test/blobfs/fuse/Makefile
View File

@ -42,7 +42,7 @@ C_SRCS := fuse.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
LIBS+= -L/usr/local/lib -lfuse3

2
test/blobfs/mkfs/Makefile
View File

@ -42,6 +42,6 @@ C_SRCS := mkfs.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

2
test/event/event_perf/Makefile
View File

@ -37,6 +37,6 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
APP = event_perf
C_SRCS := event_perf.c
SPDK_LIB_LIST = event trace conf thread util log rpc jsonrpc json sock
SPDK_LIB_LIST = event trace conf thread util log rpc jsonrpc json sock notify
include $(SPDK_ROOT_DIR)/mk/spdk.app.mk

2
test/event/reactor/Makefile
View File

@ -37,6 +37,6 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
APP = reactor
C_SRCS := reactor.c
SPDK_LIB_LIST = event trace conf thread util log rpc jsonrpc json sock
SPDK_LIB_LIST = event trace conf thread util log rpc jsonrpc json sock notify
include $(SPDK_ROOT_DIR)/mk/spdk.app.mk

2
test/event/reactor_perf/Makefile
View File

@ -37,6 +37,6 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
APP = reactor_perf
C_SRCS := reactor_perf.c
SPDK_LIB_LIST = event trace conf thread util log rpc jsonrpc json sock
SPDK_LIB_LIST = event trace conf thread util log rpc jsonrpc json sock notify
include $(SPDK_ROOT_DIR)/mk/spdk.app.mk