Spdk/lib/notify/notify.c
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

123 lines
2.7 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
*/
#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[0] || strlen(type) >= SPDK_NOTIFY_MAX_NAME_SIZE) {
SPDK_ERRLOG("Notification type '%s' too short or too long\n", type);
return NULL;
}
pthread_mutex_lock(&g_events_lock);
TAILQ_FOREACH(it, &g_notify_types, tailq) {
if (strcmp(type, it->name) == 0) {
SPDK_NOTICELOG("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_foreach_type(spdk_notify_foreach_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_foreach_event(uint64_t start_idx, uint64_t max,
spdk_notify_foreach_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;
}