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>
901 lines
20 KiB
C
901 lines
20 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) Intel Corporation. All rights reserved.
|
|
* Copyright (c) 2020 Mellanox Technologies LTD. All rights reserved.
|
|
* Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
*/
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#include "spdk/sock.h"
|
|
#include "spdk_internal/sock.h"
|
|
#include "spdk/log.h"
|
|
#include "spdk/env.h"
|
|
#include "spdk/util.h"
|
|
|
|
#define SPDK_SOCK_DEFAULT_PRIORITY 0
|
|
#define SPDK_SOCK_DEFAULT_ZCOPY true
|
|
#define SPDK_SOCK_DEFAULT_ACK_TIMEOUT 0
|
|
|
|
#define SPDK_SOCK_OPTS_FIELD_OK(opts, field) (offsetof(struct spdk_sock_opts, field) + sizeof(opts->field) <= (opts->opts_size))
|
|
|
|
static STAILQ_HEAD(, spdk_net_impl) g_net_impls = STAILQ_HEAD_INITIALIZER(g_net_impls);
|
|
static struct spdk_net_impl *g_default_impl;
|
|
|
|
struct spdk_sock_placement_id_entry {
|
|
int placement_id;
|
|
uint32_t ref;
|
|
struct spdk_sock_group_impl *group;
|
|
STAILQ_ENTRY(spdk_sock_placement_id_entry) link;
|
|
};
|
|
|
|
static inline struct spdk_sock_group_impl *
|
|
sock_get_group_impl_from_group(struct spdk_sock *sock, struct spdk_sock_group *group)
|
|
{
|
|
struct spdk_sock_group_impl *group_impl = NULL;
|
|
|
|
STAILQ_FOREACH_FROM(group_impl, &group->group_impls, link) {
|
|
if (sock->net_impl == group_impl->net_impl) {
|
|
return group_impl;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
/* Called under map->mtx lock */
|
|
static struct spdk_sock_placement_id_entry *
|
|
_sock_map_entry_alloc(struct spdk_sock_map *map, int placement_id)
|
|
{
|
|
struct spdk_sock_placement_id_entry *entry;
|
|
|
|
entry = calloc(1, sizeof(*entry));
|
|
if (!entry) {
|
|
SPDK_ERRLOG("Cannot allocate an entry for placement_id=%u\n", placement_id);
|
|
return NULL;
|
|
}
|
|
|
|
entry->placement_id = placement_id;
|
|
|
|
STAILQ_INSERT_TAIL(&map->entries, entry, link);
|
|
|
|
return entry;
|
|
}
|
|
|
|
int
|
|
spdk_sock_map_insert(struct spdk_sock_map *map, int placement_id,
|
|
struct spdk_sock_group_impl *group)
|
|
{
|
|
struct spdk_sock_placement_id_entry *entry;
|
|
int rc = 0;
|
|
|
|
pthread_mutex_lock(&map->mtx);
|
|
STAILQ_FOREACH(entry, &map->entries, link) {
|
|
if (placement_id == entry->placement_id) {
|
|
/* Can't set group to NULL if it is already not-NULL */
|
|
if (group == NULL) {
|
|
rc = (entry->group == NULL) ? 0 : -EINVAL;
|
|
goto end;
|
|
}
|
|
|
|
if (entry->group == NULL) {
|
|
entry->group = group;
|
|
} else if (entry->group != group) {
|
|
rc = -EINVAL;
|
|
goto end;
|
|
}
|
|
|
|
entry->ref++;
|
|
goto end;
|
|
}
|
|
}
|
|
|
|
entry = _sock_map_entry_alloc(map, placement_id);
|
|
if (entry == NULL) {
|
|
rc = -ENOMEM;
|
|
goto end;
|
|
}
|
|
if (group) {
|
|
entry->group = group;
|
|
entry->ref++;
|
|
}
|
|
end:
|
|
pthread_mutex_unlock(&map->mtx);
|
|
|
|
return rc;
|
|
}
|
|
|
|
void
|
|
spdk_sock_map_release(struct spdk_sock_map *map, int placement_id)
|
|
{
|
|
struct spdk_sock_placement_id_entry *entry;
|
|
|
|
pthread_mutex_lock(&map->mtx);
|
|
STAILQ_FOREACH(entry, &map->entries, link) {
|
|
if (placement_id == entry->placement_id) {
|
|
assert(entry->ref > 0);
|
|
entry->ref--;
|
|
|
|
if (entry->ref == 0) {
|
|
entry->group = NULL;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
pthread_mutex_unlock(&map->mtx);
|
|
}
|
|
|
|
int
|
|
spdk_sock_map_lookup(struct spdk_sock_map *map, int placement_id,
|
|
struct spdk_sock_group_impl **group, struct spdk_sock_group_impl *hint)
|
|
{
|
|
struct spdk_sock_placement_id_entry *entry;
|
|
|
|
*group = NULL;
|
|
pthread_mutex_lock(&map->mtx);
|
|
STAILQ_FOREACH(entry, &map->entries, link) {
|
|
if (placement_id == entry->placement_id) {
|
|
*group = entry->group;
|
|
if (*group != NULL) {
|
|
/* Return previously assigned sock_group */
|
|
pthread_mutex_unlock(&map->mtx);
|
|
return 0;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* No entry with assigned sock_group, nor hint to use */
|
|
if (hint == NULL) {
|
|
pthread_mutex_unlock(&map->mtx);
|
|
return -EINVAL;
|
|
}
|
|
|
|
/* Create new entry if there is none with matching placement_id */
|
|
if (entry == NULL) {
|
|
entry = _sock_map_entry_alloc(map, placement_id);
|
|
if (entry == NULL) {
|
|
pthread_mutex_unlock(&map->mtx);
|
|
return -ENOMEM;
|
|
}
|
|
}
|
|
|
|
entry->group = hint;
|
|
pthread_mutex_unlock(&map->mtx);
|
|
|
|
return 0;
|
|
}
|
|
|
|
void
|
|
spdk_sock_map_cleanup(struct spdk_sock_map *map)
|
|
{
|
|
struct spdk_sock_placement_id_entry *entry, *tmp;
|
|
|
|
pthread_mutex_lock(&map->mtx);
|
|
STAILQ_FOREACH_SAFE(entry, &map->entries, link, tmp) {
|
|
STAILQ_REMOVE(&map->entries, entry, spdk_sock_placement_id_entry, link);
|
|
free(entry);
|
|
}
|
|
pthread_mutex_unlock(&map->mtx);
|
|
}
|
|
|
|
int
|
|
spdk_sock_map_find_free(struct spdk_sock_map *map)
|
|
{
|
|
struct spdk_sock_placement_id_entry *entry;
|
|
int placement_id = -1;
|
|
|
|
pthread_mutex_lock(&map->mtx);
|
|
STAILQ_FOREACH(entry, &map->entries, link) {
|
|
if (entry->group == NULL) {
|
|
placement_id = entry->placement_id;
|
|
break;
|
|
}
|
|
}
|
|
|
|
pthread_mutex_unlock(&map->mtx);
|
|
|
|
return placement_id;
|
|
}
|
|
|
|
int
|
|
spdk_sock_get_optimal_sock_group(struct spdk_sock *sock, struct spdk_sock_group **group,
|
|
struct spdk_sock_group *hint)
|
|
{
|
|
struct spdk_sock_group_impl *group_impl;
|
|
struct spdk_sock_group_impl *hint_group_impl = NULL;
|
|
|
|
assert(group != NULL);
|
|
|
|
if (hint != NULL) {
|
|
hint_group_impl = sock_get_group_impl_from_group(sock, hint);
|
|
if (hint_group_impl == NULL) {
|
|
return -EINVAL;
|
|
}
|
|
}
|
|
|
|
group_impl = sock->net_impl->group_impl_get_optimal(sock, hint_group_impl);
|
|
|
|
if (group_impl) {
|
|
*group = group_impl->group;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
int
|
|
spdk_sock_getaddr(struct spdk_sock *sock, char *saddr, int slen, uint16_t *sport,
|
|
char *caddr, int clen, uint16_t *cport)
|
|
{
|
|
return sock->net_impl->getaddr(sock, saddr, slen, sport, caddr, clen, cport);
|
|
}
|
|
|
|
void
|
|
spdk_sock_get_default_opts(struct spdk_sock_opts *opts)
|
|
{
|
|
assert(opts);
|
|
|
|
if (SPDK_SOCK_OPTS_FIELD_OK(opts, priority)) {
|
|
opts->priority = SPDK_SOCK_DEFAULT_PRIORITY;
|
|
}
|
|
|
|
if (SPDK_SOCK_OPTS_FIELD_OK(opts, zcopy)) {
|
|
opts->zcopy = SPDK_SOCK_DEFAULT_ZCOPY;
|
|
}
|
|
|
|
if (SPDK_SOCK_OPTS_FIELD_OK(opts, ack_timeout)) {
|
|
opts->ack_timeout = SPDK_SOCK_DEFAULT_ACK_TIMEOUT;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* opts The opts allocated in the current library.
|
|
* opts_user The opts passed by the caller.
|
|
* */
|
|
static void
|
|
sock_init_opts(struct spdk_sock_opts *opts, struct spdk_sock_opts *opts_user)
|
|
{
|
|
assert(opts);
|
|
assert(opts_user);
|
|
|
|
opts->opts_size = sizeof(*opts);
|
|
spdk_sock_get_default_opts(opts);
|
|
|
|
/* reset the size according to the user */
|
|
opts->opts_size = opts_user->opts_size;
|
|
if (SPDK_SOCK_OPTS_FIELD_OK(opts, priority)) {
|
|
opts->priority = opts_user->priority;
|
|
}
|
|
|
|
if (SPDK_SOCK_OPTS_FIELD_OK(opts, zcopy)) {
|
|
opts->zcopy = opts_user->zcopy;
|
|
}
|
|
|
|
if (SPDK_SOCK_OPTS_FIELD_OK(opts, ack_timeout)) {
|
|
opts->ack_timeout = opts_user->ack_timeout;
|
|
}
|
|
}
|
|
|
|
struct spdk_sock *
|
|
spdk_sock_connect(const char *ip, int port, char *impl_name)
|
|
{
|
|
struct spdk_sock_opts opts;
|
|
|
|
opts.opts_size = sizeof(opts);
|
|
spdk_sock_get_default_opts(&opts);
|
|
return spdk_sock_connect_ext(ip, port, impl_name, &opts);
|
|
}
|
|
|
|
struct spdk_sock *
|
|
spdk_sock_connect_ext(const char *ip, int port, char *_impl_name, struct spdk_sock_opts *opts)
|
|
{
|
|
struct spdk_net_impl *impl = NULL;
|
|
struct spdk_sock *sock;
|
|
struct spdk_sock_opts opts_local;
|
|
const char *impl_name = NULL;
|
|
struct spdk_sock_impl_opts impl_opts = {};
|
|
size_t len;
|
|
|
|
if (opts == NULL) {
|
|
SPDK_ERRLOG("the opts should not be NULL pointer\n");
|
|
return NULL;
|
|
}
|
|
|
|
if (_impl_name) {
|
|
impl_name = _impl_name;
|
|
} else if (g_default_impl) {
|
|
impl_name = g_default_impl->name;
|
|
}
|
|
|
|
STAILQ_FOREACH_FROM(impl, &g_net_impls, link) {
|
|
if (impl_name && strncmp(impl_name, impl->name, strlen(impl->name) + 1)) {
|
|
continue;
|
|
}
|
|
|
|
SPDK_DEBUGLOG(sock, "Creating a client socket using impl %s\n", impl->name);
|
|
sock_init_opts(&opts_local, opts);
|
|
sock = impl->connect(ip, port, &opts_local);
|
|
if (sock != NULL) {
|
|
/* Copy the contents, both the two structures are the same ABI version */
|
|
memcpy(&sock->opts, &opts_local, sizeof(sock->opts));
|
|
sock->net_impl = impl;
|
|
TAILQ_INIT(&sock->queued_reqs);
|
|
TAILQ_INIT(&sock->pending_reqs);
|
|
|
|
len = sizeof(struct spdk_sock_impl_opts);
|
|
spdk_sock_impl_get_opts(impl->name, &impl_opts, &len);
|
|
sock->zerocopy_threshold = impl_opts.zerocopy_threshold;
|
|
return sock;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
struct spdk_sock *
|
|
spdk_sock_listen(const char *ip, int port, char *impl_name)
|
|
{
|
|
struct spdk_sock_opts opts;
|
|
|
|
opts.opts_size = sizeof(opts);
|
|
spdk_sock_get_default_opts(&opts);
|
|
return spdk_sock_listen_ext(ip, port, impl_name, &opts);
|
|
}
|
|
|
|
struct spdk_sock *
|
|
spdk_sock_listen_ext(const char *ip, int port, char *_impl_name, struct spdk_sock_opts *opts)
|
|
{
|
|
struct spdk_net_impl *impl = NULL;
|
|
struct spdk_sock *sock;
|
|
struct spdk_sock_opts opts_local;
|
|
const char *impl_name = NULL;
|
|
|
|
if (opts == NULL) {
|
|
SPDK_ERRLOG("the opts should not be NULL pointer\n");
|
|
return NULL;
|
|
}
|
|
|
|
if (_impl_name) {
|
|
impl_name = _impl_name;
|
|
} else if (g_default_impl) {
|
|
impl_name = g_default_impl->name;
|
|
}
|
|
|
|
STAILQ_FOREACH_FROM(impl, &g_net_impls, link) {
|
|
if (impl_name && strncmp(impl_name, impl->name, strlen(impl->name) + 1)) {
|
|
continue;
|
|
}
|
|
|
|
SPDK_DEBUGLOG(sock, "Creating a listening socket using impl %s\n", impl->name);
|
|
sock_init_opts(&opts_local, opts);
|
|
sock = impl->listen(ip, port, &opts_local);
|
|
if (sock != NULL) {
|
|
/* Copy the contents, both the two structures are the same ABI version */
|
|
memcpy(&sock->opts, &opts_local, sizeof(sock->opts));
|
|
sock->net_impl = impl;
|
|
/* Don't need to initialize the request queues for listen
|
|
* sockets. */
|
|
return sock;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
struct spdk_sock *
|
|
spdk_sock_accept(struct spdk_sock *sock)
|
|
{
|
|
struct spdk_sock *new_sock;
|
|
struct spdk_sock_impl_opts impl_opts = {};
|
|
size_t len;
|
|
|
|
new_sock = sock->net_impl->accept(sock);
|
|
if (new_sock != NULL) {
|
|
/* Inherit the opts from the "accept sock" */
|
|
new_sock->opts = sock->opts;
|
|
memcpy(&new_sock->opts, &sock->opts, sizeof(new_sock->opts));
|
|
new_sock->net_impl = sock->net_impl;
|
|
TAILQ_INIT(&new_sock->queued_reqs);
|
|
TAILQ_INIT(&new_sock->pending_reqs);
|
|
|
|
len = sizeof(struct spdk_sock_impl_opts);
|
|
spdk_sock_impl_get_opts(sock->net_impl->name, &impl_opts, &len);
|
|
new_sock->zerocopy_threshold = impl_opts.zerocopy_threshold;
|
|
}
|
|
|
|
return new_sock;
|
|
}
|
|
|
|
int
|
|
spdk_sock_close(struct spdk_sock **_sock)
|
|
{
|
|
struct spdk_sock *sock = *_sock;
|
|
|
|
if (sock == NULL) {
|
|
errno = EBADF;
|
|
return -1;
|
|
}
|
|
|
|
if (sock->cb_fn != NULL) {
|
|
/* This sock is still part of a sock_group. */
|
|
errno = EBUSY;
|
|
return -1;
|
|
}
|
|
|
|
/* Beyond this point the socket is considered closed. */
|
|
*_sock = NULL;
|
|
|
|
sock->flags.closed = true;
|
|
|
|
if (sock->cb_cnt > 0) {
|
|
/* Let the callback unwind before destroying the socket */
|
|
return 0;
|
|
}
|
|
|
|
spdk_sock_abort_requests(sock);
|
|
|
|
return sock->net_impl->close(sock);
|
|
}
|
|
|
|
ssize_t
|
|
spdk_sock_recv(struct spdk_sock *sock, void *buf, size_t len)
|
|
{
|
|
if (sock == NULL || sock->flags.closed) {
|
|
errno = EBADF;
|
|
return -1;
|
|
}
|
|
|
|
return sock->net_impl->recv(sock, buf, len);
|
|
}
|
|
|
|
ssize_t
|
|
spdk_sock_readv(struct spdk_sock *sock, struct iovec *iov, int iovcnt)
|
|
{
|
|
if (sock == NULL || sock->flags.closed) {
|
|
errno = EBADF;
|
|
return -1;
|
|
}
|
|
|
|
return sock->net_impl->readv(sock, iov, iovcnt);
|
|
}
|
|
|
|
ssize_t
|
|
spdk_sock_writev(struct spdk_sock *sock, struct iovec *iov, int iovcnt)
|
|
{
|
|
if (sock == NULL || sock->flags.closed) {
|
|
errno = EBADF;
|
|
return -1;
|
|
}
|
|
|
|
return sock->net_impl->writev(sock, iov, iovcnt);
|
|
}
|
|
|
|
void
|
|
spdk_sock_writev_async(struct spdk_sock *sock, struct spdk_sock_request *req)
|
|
{
|
|
assert(req->cb_fn != NULL);
|
|
|
|
if (sock == NULL || sock->flags.closed) {
|
|
req->cb_fn(req->cb_arg, -EBADF);
|
|
return;
|
|
}
|
|
|
|
sock->net_impl->writev_async(sock, req);
|
|
}
|
|
|
|
int
|
|
spdk_sock_flush(struct spdk_sock *sock)
|
|
{
|
|
if (sock == NULL || sock->flags.closed) {
|
|
return -EBADF;
|
|
}
|
|
|
|
/* Sock is in a polling group, so group polling mechanism will work */
|
|
if (sock->group_impl != NULL) {
|
|
return 0;
|
|
}
|
|
|
|
return sock->net_impl->flush(sock);
|
|
}
|
|
|
|
int
|
|
spdk_sock_set_recvlowat(struct spdk_sock *sock, int nbytes)
|
|
{
|
|
return sock->net_impl->set_recvlowat(sock, nbytes);
|
|
}
|
|
|
|
int
|
|
spdk_sock_set_recvbuf(struct spdk_sock *sock, int sz)
|
|
{
|
|
return sock->net_impl->set_recvbuf(sock, sz);
|
|
}
|
|
|
|
int
|
|
spdk_sock_set_sendbuf(struct spdk_sock *sock, int sz)
|
|
{
|
|
return sock->net_impl->set_sendbuf(sock, sz);
|
|
}
|
|
|
|
bool
|
|
spdk_sock_is_ipv6(struct spdk_sock *sock)
|
|
{
|
|
return sock->net_impl->is_ipv6(sock);
|
|
}
|
|
|
|
bool
|
|
spdk_sock_is_ipv4(struct spdk_sock *sock)
|
|
{
|
|
return sock->net_impl->is_ipv4(sock);
|
|
}
|
|
|
|
bool
|
|
spdk_sock_is_connected(struct spdk_sock *sock)
|
|
{
|
|
return sock->net_impl->is_connected(sock);
|
|
}
|
|
|
|
struct spdk_sock_group *
|
|
spdk_sock_group_create(void *ctx)
|
|
{
|
|
struct spdk_net_impl *impl = NULL;
|
|
struct spdk_sock_group *group;
|
|
struct spdk_sock_group_impl *group_impl;
|
|
|
|
group = calloc(1, sizeof(*group));
|
|
if (group == NULL) {
|
|
return NULL;
|
|
}
|
|
|
|
STAILQ_INIT(&group->group_impls);
|
|
|
|
STAILQ_FOREACH_FROM(impl, &g_net_impls, link) {
|
|
group_impl = impl->group_impl_create();
|
|
if (group_impl != NULL) {
|
|
STAILQ_INSERT_TAIL(&group->group_impls, group_impl, link);
|
|
TAILQ_INIT(&group_impl->socks);
|
|
group_impl->net_impl = impl;
|
|
group_impl->group = group;
|
|
}
|
|
}
|
|
|
|
group->ctx = ctx;
|
|
|
|
return group;
|
|
}
|
|
|
|
void *
|
|
spdk_sock_group_get_ctx(struct spdk_sock_group *group)
|
|
{
|
|
if (group == NULL) {
|
|
return NULL;
|
|
}
|
|
|
|
return group->ctx;
|
|
}
|
|
|
|
int
|
|
spdk_sock_group_add_sock(struct spdk_sock_group *group, struct spdk_sock *sock,
|
|
spdk_sock_cb cb_fn, void *cb_arg)
|
|
{
|
|
struct spdk_sock_group_impl *group_impl = NULL;
|
|
int rc;
|
|
|
|
if (cb_fn == NULL) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
if (sock->group_impl != NULL) {
|
|
/*
|
|
* This sock is already part of a sock_group.
|
|
*/
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
group_impl = sock_get_group_impl_from_group(sock, group);
|
|
if (group_impl == NULL) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
rc = group_impl->net_impl->group_impl_add_sock(group_impl, sock);
|
|
if (rc != 0) {
|
|
return rc;
|
|
}
|
|
|
|
TAILQ_INSERT_TAIL(&group_impl->socks, sock, link);
|
|
sock->group_impl = group_impl;
|
|
sock->cb_fn = cb_fn;
|
|
sock->cb_arg = cb_arg;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int
|
|
spdk_sock_group_remove_sock(struct spdk_sock_group *group, struct spdk_sock *sock)
|
|
{
|
|
struct spdk_sock_group_impl *group_impl = NULL;
|
|
int rc;
|
|
|
|
group_impl = sock_get_group_impl_from_group(sock, group);
|
|
if (group_impl == NULL) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
assert(group_impl == sock->group_impl);
|
|
|
|
rc = group_impl->net_impl->group_impl_remove_sock(group_impl, sock);
|
|
if (rc == 0) {
|
|
TAILQ_REMOVE(&group_impl->socks, sock, link);
|
|
sock->group_impl = NULL;
|
|
sock->cb_fn = NULL;
|
|
sock->cb_arg = NULL;
|
|
}
|
|
|
|
return rc;
|
|
}
|
|
|
|
int
|
|
spdk_sock_group_poll(struct spdk_sock_group *group)
|
|
{
|
|
return spdk_sock_group_poll_count(group, MAX_EVENTS_PER_POLL);
|
|
}
|
|
|
|
static int
|
|
sock_group_impl_poll_count(struct spdk_sock_group_impl *group_impl,
|
|
struct spdk_sock_group *group,
|
|
int max_events)
|
|
{
|
|
struct spdk_sock *socks[MAX_EVENTS_PER_POLL];
|
|
int num_events, i;
|
|
|
|
if (TAILQ_EMPTY(&group_impl->socks)) {
|
|
return 0;
|
|
}
|
|
|
|
num_events = group_impl->net_impl->group_impl_poll(group_impl, max_events, socks);
|
|
if (num_events == -1) {
|
|
return -1;
|
|
}
|
|
|
|
for (i = 0; i < num_events; i++) {
|
|
struct spdk_sock *sock = socks[i];
|
|
assert(sock->cb_fn != NULL);
|
|
sock->cb_fn(sock->cb_arg, group, sock);
|
|
}
|
|
|
|
return num_events;
|
|
}
|
|
|
|
int
|
|
spdk_sock_group_poll_count(struct spdk_sock_group *group, int max_events)
|
|
{
|
|
struct spdk_sock_group_impl *group_impl = NULL;
|
|
int rc, num_events = 0;
|
|
|
|
if (max_events < 1) {
|
|
errno = -EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
/*
|
|
* Only poll for up to 32 events at a time - if more events are pending,
|
|
* the next call to this function will reap them.
|
|
*/
|
|
if (max_events > MAX_EVENTS_PER_POLL) {
|
|
max_events = MAX_EVENTS_PER_POLL;
|
|
}
|
|
|
|
STAILQ_FOREACH_FROM(group_impl, &group->group_impls, link) {
|
|
rc = sock_group_impl_poll_count(group_impl, group, max_events);
|
|
if (rc < 0) {
|
|
num_events = -1;
|
|
SPDK_ERRLOG("group_impl_poll_count for net(%s) failed\n",
|
|
group_impl->net_impl->name);
|
|
} else if (num_events >= 0) {
|
|
num_events += rc;
|
|
}
|
|
}
|
|
|
|
return num_events;
|
|
}
|
|
|
|
int
|
|
spdk_sock_group_close(struct spdk_sock_group **group)
|
|
{
|
|
struct spdk_sock_group_impl *group_impl = NULL, *tmp;
|
|
int rc;
|
|
|
|
if (*group == NULL) {
|
|
errno = EBADF;
|
|
return -1;
|
|
}
|
|
|
|
STAILQ_FOREACH_SAFE(group_impl, &(*group)->group_impls, link, tmp) {
|
|
if (!TAILQ_EMPTY(&group_impl->socks)) {
|
|
errno = EBUSY;
|
|
return -1;
|
|
}
|
|
}
|
|
|
|
STAILQ_FOREACH_SAFE(group_impl, &(*group)->group_impls, link, tmp) {
|
|
rc = group_impl->net_impl->group_impl_close(group_impl);
|
|
if (rc != 0) {
|
|
SPDK_ERRLOG("group_impl_close for net(%s) failed\n",
|
|
group_impl->net_impl->name);
|
|
}
|
|
}
|
|
|
|
free(*group);
|
|
*group = NULL;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static inline struct spdk_net_impl *
|
|
sock_get_impl_by_name(const char *impl_name)
|
|
{
|
|
struct spdk_net_impl *impl;
|
|
|
|
assert(impl_name != NULL);
|
|
STAILQ_FOREACH(impl, &g_net_impls, link) {
|
|
if (0 == strcmp(impl_name, impl->name)) {
|
|
return impl;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
int
|
|
spdk_sock_impl_get_opts(const char *impl_name, struct spdk_sock_impl_opts *opts, size_t *len)
|
|
{
|
|
struct spdk_net_impl *impl;
|
|
|
|
if (!impl_name || !opts || !len) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
impl = sock_get_impl_by_name(impl_name);
|
|
if (!impl) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
if (!impl->get_opts) {
|
|
errno = ENOTSUP;
|
|
return -1;
|
|
}
|
|
|
|
return impl->get_opts(opts, len);
|
|
}
|
|
|
|
int
|
|
spdk_sock_impl_set_opts(const char *impl_name, const struct spdk_sock_impl_opts *opts, size_t len)
|
|
{
|
|
struct spdk_net_impl *impl;
|
|
|
|
if (!impl_name || !opts) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
impl = sock_get_impl_by_name(impl_name);
|
|
if (!impl) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
if (!impl->set_opts) {
|
|
errno = ENOTSUP;
|
|
return -1;
|
|
}
|
|
|
|
return impl->set_opts(opts, len);
|
|
}
|
|
|
|
void
|
|
spdk_sock_write_config_json(struct spdk_json_write_ctx *w)
|
|
{
|
|
struct spdk_net_impl *impl;
|
|
struct spdk_sock_impl_opts opts;
|
|
size_t len;
|
|
|
|
assert(w != NULL);
|
|
|
|
spdk_json_write_array_begin(w);
|
|
|
|
if (g_default_impl) {
|
|
spdk_json_write_object_begin(w);
|
|
spdk_json_write_named_string(w, "method", "sock_set_default_impl");
|
|
spdk_json_write_named_object_begin(w, "params");
|
|
spdk_json_write_named_string(w, "impl_name", g_default_impl->name);
|
|
spdk_json_write_object_end(w);
|
|
spdk_json_write_object_end(w);
|
|
}
|
|
|
|
STAILQ_FOREACH(impl, &g_net_impls, link) {
|
|
if (!impl->get_opts) {
|
|
continue;
|
|
}
|
|
|
|
len = sizeof(opts);
|
|
if (impl->get_opts(&opts, &len) == 0) {
|
|
spdk_json_write_object_begin(w);
|
|
spdk_json_write_named_string(w, "method", "sock_impl_set_options");
|
|
spdk_json_write_named_object_begin(w, "params");
|
|
spdk_json_write_named_string(w, "impl_name", impl->name);
|
|
spdk_json_write_named_uint32(w, "recv_buf_size", opts.recv_buf_size);
|
|
spdk_json_write_named_uint32(w, "send_buf_size", opts.send_buf_size);
|
|
spdk_json_write_named_bool(w, "enable_recv_pipe", opts.enable_recv_pipe);
|
|
spdk_json_write_named_bool(w, "enable_quickack", opts.enable_quickack);
|
|
spdk_json_write_named_uint32(w, "enable_placement_id", opts.enable_placement_id);
|
|
spdk_json_write_named_bool(w, "enable_zerocopy_send_server", opts.enable_zerocopy_send_server);
|
|
spdk_json_write_named_bool(w, "enable_zerocopy_send_client", opts.enable_zerocopy_send_client);
|
|
spdk_json_write_named_uint32(w, "zerocopy_threshold", opts.zerocopy_threshold);
|
|
spdk_json_write_object_end(w);
|
|
spdk_json_write_object_end(w);
|
|
} else {
|
|
SPDK_ERRLOG("Failed to get socket options for socket implementation %s\n", impl->name);
|
|
}
|
|
}
|
|
|
|
spdk_json_write_array_end(w);
|
|
}
|
|
|
|
void
|
|
spdk_net_impl_register(struct spdk_net_impl *impl, int priority)
|
|
{
|
|
struct spdk_net_impl *cur, *prev;
|
|
|
|
impl->priority = priority;
|
|
prev = NULL;
|
|
STAILQ_FOREACH(cur, &g_net_impls, link) {
|
|
if (impl->priority > cur->priority) {
|
|
break;
|
|
}
|
|
prev = cur;
|
|
}
|
|
|
|
if (prev) {
|
|
STAILQ_INSERT_AFTER(&g_net_impls, prev, impl, link);
|
|
} else {
|
|
STAILQ_INSERT_HEAD(&g_net_impls, impl, link);
|
|
}
|
|
}
|
|
|
|
int spdk_sock_set_default_impl(const char *impl_name)
|
|
{
|
|
struct spdk_net_impl *impl;
|
|
|
|
if (!impl_name) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
impl = sock_get_impl_by_name(impl_name);
|
|
if (!impl) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
if (impl == g_default_impl) {
|
|
return 0;
|
|
}
|
|
|
|
if (g_default_impl) {
|
|
SPDK_DEBUGLOG(sock, "Change the default sock impl from %s to %s\n", g_default_impl->name,
|
|
impl->name);
|
|
} else {
|
|
SPDK_DEBUGLOG(sock, "Set default sock implementation to %s\n", impl_name);
|
|
}
|
|
|
|
g_default_impl = impl;
|
|
|
|
return 0;
|
|
}
|
|
|
|
SPDK_LOG_REGISTER_COMPONENT(sock)
|