Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
service.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Meta
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_NET_HTTP_SERVICE_H_
8#define ZEPHYR_INCLUDE_NET_HTTP_SERVICE_H_
9
22#include "zephyr/net/http/server.h"
23#include <stdint.h>
24#include <stddef.h>
25
26#include <zephyr/sys/util_macro.h>
27#include <zephyr/sys/iterable_sections.h>
28#include <zephyr/net/tls_credentials.h>
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
35struct http_resource_desc {
37 const char *resource;
39 void *detail;
40};
41
59#define HTTP_RESOURCE_DEFINE(_name, _service, _resource, _detail) \
60 const STRUCT_SECTION_ITERABLE_ALTERNATE(http_resource_desc_##_service, http_resource_desc, \
61 _name) = { \
62 .resource = _resource, \
63 .detail = (void *)(_detail), \
64 }
65
68struct http_service_runtime_data {
69 int num_clients;
70};
71
72struct http_service_desc;
73
75typedef int (*http_socket_create_fn)(const struct http_service_desc *svc, int af, int proto);
76
78struct http_service_config {
80 http_socket_create_fn socket_create;
81 /* If any more service-specific configuration is needed, it can be added here. */
82};
83
84struct http_service_desc {
85 const char *host;
86 uint16_t *port;
87 int *fd;
88 void *detail;
89 size_t concurrent;
90 size_t backlog;
91 struct http_service_runtime_data *data;
92 struct http_resource_desc *res_begin;
93 struct http_resource_desc *res_end;
94 struct http_resource_detail *res_fallback;
95 const struct http_service_config *config;
96#if defined(CONFIG_NET_SOCKETS_SOCKOPT_TLS)
97 const sec_tag_t *sec_tag_list;
98 size_t sec_tag_list_size;
99#endif
100};
101
102#define __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
103 _res_fallback, _res_begin, _res_end, _config, ...) \
104 BUILD_ASSERT(_concurrent <= CONFIG_HTTP_SERVER_MAX_CLIENTS, \
105 "can't accept more then MAX_CLIENTS"); \
106 BUILD_ASSERT(_backlog > 0, "backlog can't be 0"); \
107 static int _name##_fd = -1; \
108 static struct http_service_runtime_data _name##_data = {0}; \
109 const STRUCT_SECTION_ITERABLE(http_service_desc, _name) = { \
110 .host = _host, \
111 .port = (uint16_t *)(_port), \
112 .fd = &_name##_fd, \
113 .detail = (void *)(_detail), \
114 .concurrent = (_concurrent), \
115 .backlog = (_backlog), \
116 .data = &_name##_data, \
117 .res_begin = (_res_begin), \
118 .res_end = (_res_end), \
119 .res_fallback = (_res_fallback), \
120 .config = (_config), \
121 COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS, \
122 (.sec_tag_list = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (NULL), \
123 (GET_ARG_N(1, __VA_ARGS__))),), ()) \
124 COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS, \
125 (.sec_tag_list_size = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (0),\
126 (GET_ARG_N(1, GET_ARGS_LESS_N(1, __VA_ARGS__))))), ())\
127 }
128
152#define HTTP_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail, \
153 _res_fallback, _config) \
154 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
155 _res_fallback, NULL, NULL, _config)
156
180#define HTTPS_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail, \
181 _res_fallback, _config, _sec_tag_list, _sec_tag_list_size) \
182 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
183 _res_fallback, NULL, NULL, _config, \
184 _sec_tag_list, _sec_tag_list_size); \
185 BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS), \
186 "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
187
209#define HTTP_SERVICE_DEFINE(_name, _host, _port, _concurrent, _backlog, _detail, _res_fallback, \
210 _config) \
211 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[]; \
212 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[]; \
213 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
214 _res_fallback, \
215 &_CONCAT(_http_resource_desc_##_name, _list_start)[0], \
216 &_CONCAT(_http_resource_desc_##_name, _list_end)[0], _config);
217
241#define HTTPS_SERVICE_DEFINE(_name, _host, _port, _concurrent, _backlog, _detail, \
242 _res_fallback, _config, _sec_tag_list, _sec_tag_list_size) \
243 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[]; \
244 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[]; \
245 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
246 _res_fallback, \
247 &_CONCAT(_http_resource_desc_##_name, _list_start)[0], \
248 &_CONCAT(_http_resource_desc_##_name, _list_end)[0], _config, \
249 _sec_tag_list, _sec_tag_list_size); \
250 BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS), \
251 "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
252
258#define HTTP_SERVICE_COUNT(_dst) STRUCT_SECTION_COUNT(http_service_desc, _dst)
259
265#define HTTP_SERVICE_RESOURCE_COUNT(_service) ((_service)->res_end - (_service)->res_begin)
266
272#define HTTP_SERVICE_FOREACH(_it) STRUCT_SECTION_FOREACH(http_service_desc, _it)
273
282#define HTTP_RESOURCE_FOREACH(_service, _it) \
283 STRUCT_SECTION_FOREACH_ALTERNATE(http_resource_desc_##_service, http_resource_desc, _it)
284
294#define HTTP_SERVICE_FOREACH_RESOURCE(_service, _it) \
295 for (struct http_resource_desc *_it = (_service)->res_begin; ({ \
296 __ASSERT(_it <= (_service)->res_end, "unexpected list end location"); \
297 _it < (_service)->res_end; \
298 }); \
299 _it++)
300
301#ifdef __cplusplus
302}
303#endif
304
309#endif /* ZEPHYR_INCLUDE_NET_HTTP_SERVICE_H_ */
sec_tag_t
int sec_tag_t
Secure tag, a reference to TLS credential.
Definition tls_credentials.h:80
server.h
HTTP server API.
uint16_t
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
http_resource_desc
HTTP resource description.
Definition service.h:35
http_resource_desc::resource
const char * resource
Resource name.
Definition service.h:37
http_resource_desc::detail
void * detail
Detail associated with this resource.
Definition service.h:39
http_resource_detail
Representation of a server resource, common for all resource types.
Definition server.h:88
iterable_sections.h
tls_credentials.h
TLS credentials management.
util_macro.h
Macro utilities.