service.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Meta
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_HTTP_SERVICE_H_
#define ZEPHYR_INCLUDE_NET_HTTP_SERVICE_H_
 
#include <stdint.h>
#include <stddef.h>
 
#include <zephyr/sys/util_macro.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/net/tls_credentials.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct http_resource_desc {
        const char *resource;
        void *detail;
};
 
#define HTTP_RESOURCE_DEFINE(_name, _service, _resource, _detail)                                  \
        const STRUCT_SECTION_ITERABLE_ALTERNATE(http_resource_desc_##_service, http_resource_desc, \
                                                _name) = {                                         \
                .resource = _resource,                                                             \
                .detail = (void *)(_detail),                                                       \
        }
 
struct http_service_desc {
        const char *host;
        uint16_t *port;
        void *detail;
        size_t concurrent;
        size_t backlog;
        struct http_resource_desc *res_begin;
        struct http_resource_desc *res_end;
#if defined(CONFIG_NET_SOCKETS_SOCKOPT_TLS)
        const sec_tag_t *sec_tag_list;
        size_t sec_tag_list_size;
#endif
};
 
#define __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, _res_begin,   \
                                _res_end, ...)                                                     \
        static const STRUCT_SECTION_ITERABLE(http_service_desc, _name) = {                         \
                .host = _host,                                                                     \
                .port = (uint16_t *)(_port),                                                       \
                .detail = (void *)(_detail),                                                       \
                .concurrent = (_concurrent),                                                       \
                .backlog = (_backlog),                                                             \
                .res_begin = (_res_begin),                                                         \
                .res_end = (_res_end),                                                             \
                COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS,                                        \
                            (.sec_tag_list = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (NULL),  \
                                                         (GET_ARG_N(1, __VA_ARGS__))),), ())       \
                COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS,                                        \
                            (.sec_tag_list_size = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (0),\
                                             (GET_ARG_N(1, GET_ARGS_LESS_N(1, __VA_ARGS__))))), ())\
        }
 
#define HTTP_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail)             \
        __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, NULL, NULL)
 
#define HTTPS_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail,          \
                                   _sec_tag_list, _sec_tag_list_size)                            \
        __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, NULL, NULL, \
                                _sec_tag_list, _sec_tag_list_size);                              \
        BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS),                                 \
                     "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
 
#define HTTP_SERVICE_DEFINE(_name, _host, _port, _concurrent, _backlog, _detail)                   \
        extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[];      \
        extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[];        \
        __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,               \
                                &_CONCAT(_http_resource_desc_##_name, _list_start)[0],             \
                                &_CONCAT(_http_resource_desc_##_name, _list_end)[0])
 
#define HTTPS_SERVICE_DEFINE(_name, _host, _port, _concurrent, _backlog, _detail,              \
                             _sec_tag_list, _sec_tag_list_size)                                \
        extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[];  \
        extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[];    \
        __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,           \
                                &_CONCAT(_http_resource_desc_##_name, _list_start)[0],         \
                                &_CONCAT(_http_resource_desc_##_name, _list_end)[0],           \
                                _sec_tag_list, _sec_tag_list_size);                            \
        BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS),                               \
                     "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
 
#define HTTP_SERVICE_COUNT(_dst) STRUCT_SECTION_COUNT(http_service_desc, _dst)
 
#define HTTP_SERVICE_RESOURCE_COUNT(_service) ((_service)->res_end - (_service)->res_begin)
 
#define HTTP_SERVICE_FOREACH(_it) STRUCT_SECTION_FOREACH(http_service_desc, _it)
 
#define HTTP_RESOURCE_FOREACH(_service, _it)                                                       \
        STRUCT_SECTION_FOREACH_ALTERNATE(http_resource_desc_##_service, http_resource_desc, _it)
 
#define HTTP_SERVICE_FOREACH_RESOURCE(_service, _it)                                               \
        for (struct http_resource_desc *_it = (_service)->res_begin; ({                            \
                     __ASSERT(_it <= (_service)->res_end, "unexpected list end location");         \
                     _it < (_service)->res_end;                                                    \
             });                                                                                   \
             _it++)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_HTTP_SERVICE_H_ */