socket_service.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_SOCKET_SERVICE_H_
#define ZEPHYR_INCLUDE_NET_SOCKET_SERVICE_H_
 
#include <sys/types.h>
#include <zephyr/types.h>
#include <zephyr/net/socket.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct net_socket_service_event {
        struct k_work work;
        k_work_handler_t callback;
        struct zsock_pollfd event;
        void *user_data;
        struct net_socket_service_desc *svc;
};
 
struct net_socket_service_desc {
#if CONFIG_NET_SOCKETS_LOG_LEVEL >= LOG_LEVEL_DBG
        const char *owner;
#endif
        struct k_work_q *work_q;
        struct net_socket_service_event *pev;
        int pev_len;
        int *idx;
};
 
#define __z_net_socket_svc_get_name(_svc_id) __z_net_socket_service_##_svc_id
#define __z_net_socket_svc_get_idx(_svc_id) __z_net_socket_service_idx_##_svc_id
#define __z_net_socket_svc_get_owner __FILE__ ":" STRINGIFY(__LINE__)
 
extern void net_socket_service_callback(struct k_work *work);
 
#if CONFIG_NET_SOCKETS_LOG_LEVEL >= LOG_LEVEL_DBG
#define NET_SOCKET_SERVICE_OWNER .owner = __z_net_socket_svc_get_owner,
#else
#define NET_SOCKET_SERVICE_OWNER
#endif
 
#define NET_SOCKET_SERVICE_CALLBACK_MODE(_flag)                         \
        IF_ENABLED(_flag,                                               \
                   (.work = Z_WORK_INITIALIZER(net_socket_service_callback),))
 
#define __z_net_socket_service_define(_name, _work_q, _cb, _count, _async, ...) \
        static int __z_net_socket_svc_get_idx(_name);                   \
        static struct net_socket_service_event                          \
                        __z_net_socket_svc_get_name(_name)[_count] = {  \
                [0 ... ((_count) - 1)] = {                              \
                        .event.fd = -1, /* Invalid socket */            \
                        NET_SOCKET_SERVICE_CALLBACK_MODE(_async)        \
                        .callback = _cb,                                \
                }                                                       \
        };                                                              \
        COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (), __VA_ARGS__)   \
        const STRUCT_SECTION_ITERABLE(net_socket_service_desc, _name) = { \
                NET_SOCKET_SERVICE_OWNER                                \
                .work_q = (_work_q),                                    \
                .pev = __z_net_socket_svc_get_name(_name),              \
                .pev_len = (_count),                                    \
                .idx = &__z_net_socket_svc_get_idx(_name),              \
        }
 
#define NET_SOCKET_SERVICE_ASYNC_DEFINE(name, work_q, cb, count)        \
        __z_net_socket_service_define(name, work_q, cb, count, 1)
 
#define NET_SOCKET_SERVICE_ASYNC_DEFINE_STATIC(name, work_q, cb, count) \
        __z_net_socket_service_define(name, work_q, cb, count, 1, static)
 
#define NET_SOCKET_SERVICE_SYNC_DEFINE(name, work_q, cb, count) \
        __z_net_socket_service_define(name, work_q, cb, count, 0)
 
#define NET_SOCKET_SERVICE_SYNC_DEFINE_STATIC(name, work_q, cb, count)  \
        __z_net_socket_service_define(name, work_q, cb, count, 0, static)
 
__syscall int net_socket_service_register(const struct net_socket_service_desc *service,
                                          struct zsock_pollfd *fds, int len, void *user_data);
 
static inline int net_socket_service_unregister(const struct net_socket_service_desc *service)
{
        return net_socket_service_register(service, NULL, 0, NULL);
}
 
typedef void (*net_socket_service_cb_t)(const struct net_socket_service_desc *svc,
                                        void *user_data);
 
void net_socket_service_foreach(net_socket_service_cb_t cb, void *user_data);
 
#ifdef __cplusplus
}
#endif
 
#include <syscalls/socket_service.h>
 
#endif /* ZEPHYR_INCLUDE_NET_SOCKET_SERVICE_H_ */