Zephyr Project API 4.0.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_desc {
69 const char *host;
70 uint16_t *port;
71 int *fd;
72 void *detail;
73 size_t concurrent;
74 size_t backlog;
75 struct http_resource_desc *res_begin;
76 struct http_resource_desc *res_end;
77 struct http_resource_detail *res_fallback;
78#if defined(CONFIG_NET_SOCKETS_SOCKOPT_TLS)
79 const sec_tag_t *sec_tag_list;
80 size_t sec_tag_list_size;
81#endif
82};
83
84#define __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
85 _res_fallback, _res_begin, \
86 _res_end, ...) \
87 static int _name##_fd = -1; \
88 const STRUCT_SECTION_ITERABLE(http_service_desc, _name) = { \
89 .host = _host, \
90 .port = (uint16_t *)(_port), \
91 .fd = &_name##_fd, \
92 .detail = (void *)(_detail), \
93 .concurrent = (_concurrent), \
94 .backlog = (_backlog), \
95 .res_begin = (_res_begin), \
96 .res_end = (_res_end), \
97 .res_fallback = (_res_fallback), \
98 COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS, \
99 (.sec_tag_list = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (NULL), \
100 (GET_ARG_N(1, __VA_ARGS__))),), ()) \
101 COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS, \
102 (.sec_tag_list_size = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (0),\
103 (GET_ARG_N(1, GET_ARGS_LESS_N(1, __VA_ARGS__))))), ())\
104 }
105
128#define HTTP_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail, \
129 _res_fallback) \
130 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
131 _res_fallback, NULL, NULL)
132
155#define HTTPS_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail, \
156 _res_fallback, _sec_tag_list, _sec_tag_list_size) \
157 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
158 _res_fallback, NULL, NULL, \
159 _sec_tag_list, _sec_tag_list_size); \
160 BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS), \
161 "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
162
183#define HTTP_SERVICE_DEFINE(_name, _host, _port, _concurrent, _backlog, _detail, _res_fallback) \
184 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[]; \
185 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[]; \
186 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
187 _res_fallback, \
188 &_CONCAT(_http_resource_desc_##_name, _list_start)[0], \
189 &_CONCAT(_http_resource_desc_##_name, _list_end)[0])
190
213#define HTTPS_SERVICE_DEFINE(_name, _host, _port, _concurrent, _backlog, _detail, \
214 _res_fallback, _sec_tag_list, _sec_tag_list_size) \
215 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[]; \
216 extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[]; \
217 __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail, \
218 _res_fallback, \
219 &_CONCAT(_http_resource_desc_##_name, _list_start)[0], \
220 &_CONCAT(_http_resource_desc_##_name, _list_end)[0], \
221 _sec_tag_list, _sec_tag_list_size); \
222 BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS), \
223 "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
224
230#define HTTP_SERVICE_COUNT(_dst) STRUCT_SECTION_COUNT(http_service_desc, _dst)
231
237#define HTTP_SERVICE_RESOURCE_COUNT(_service) ((_service)->res_end - (_service)->res_begin)
238
244#define HTTP_SERVICE_FOREACH(_it) STRUCT_SECTION_FOREACH(http_service_desc, _it)
245
254#define HTTP_RESOURCE_FOREACH(_service, _it) \
255 STRUCT_SECTION_FOREACH_ALTERNATE(http_resource_desc_##_service, http_resource_desc, _it)
256
266#define HTTP_SERVICE_FOREACH_RESOURCE(_service, _it) \
267 for (struct http_resource_desc *_it = (_service)->res_begin; ({ \
268 __ASSERT(_it <= (_service)->res_end, "unexpected list end location"); \
269 _it < (_service)->res_end; \
270 }); \
271 _it++)
272
273#ifdef __cplusplus
274}
275#endif
276
281#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:74
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.