VSF Documented
vsf_pbuf_pool.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_PBUF_POOL_H__
19#define __VSF_PBUF_POOL_H__
20
21/*============================ INCLUDES ======================================*/
22#include "service/vsf_service_cfg.h"
23#if VSF_USE_PBUF == ENABLED
24#include "./vsf_pbuf.h"
25#include "service/pool/vsf_pool.h"
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31/*============================ MACROS ========================================*/
32/*============================ MACROFIED FUNCTIONS ===========================*/
33#define __declare_pbuf_pool(__NAME) \
34 typedef struct __NAME##_pool_item_t __NAME##_pool_item_t; \
35 typedef struct __NAME##_pool_t __NAME##_pool_t;
36
37#define __def_pbuf_pool(__NAME, __SIZE, ...) \
38 struct __NAME##_pool_item_t { \
39 implement(vsf_pbuf_t); \
40 uint8_t u8_buffer[__SIZE]; \
41 }; \
42 struct __NAME##_pool_t { \
43 implement(vsf_pbuf_pool_t) \
44 __VA_ARGS__ \
45 };
46
47#define __vsf_pbuf_pool_req_pbuf_evt(__NAME, __POOL) \
48 (req_pbuf_evt_t) \
49 { .handler_fn = __NAME##_req_pbuf_evt_handler, \
50 .target_ptr = (__POOL), \
51 }
52
53#if VSF_STREAM_CFG_SUPPORT_RESOURCE_LIMITATION == ENABLED
54#define __implement_pbuf_pool(__NAME) \
55 vsf_pbuf_t *__NAME##_req_pbuf_evt_handler(void *target_ptr, \
56 int_fast32_t nNoLessThan, \
57 int_fast32_t nBestSize, \
58 uint_fast16_t hwReserve) \
59{ \
60 vsf_pool(__NAME) *this_ptr = (vsf_pool(__NAME) *)target_ptr; \
61 VSF_SERVICE_ASSERT(NULL != this_ptr); \
62 if (vsf_pbuf_get_pool_item_count( \
63 &(this_ptr->use_as__vsf_pbuf_pool_t)) <= hwReserve) { \
64 return NULL; \
65 } \
66 return vsf_pbuf_pool_alloc(&(this_ptr->use_as__vsf_pbuf_pool_t)); \
67}
68#else
69#define __implement_pbuf_pool(__NAME) \
70 vsf_pbuf_t *__NAME##_req_pbuf_evt_handler(void *target_ptr, \
71 int_fast32_t nNoLessThan, \
72 int_fast32_t nBestSize, \
73 uint_fast16_t hwReserve) \
74{ \
75 vsf_pool(__NAME) *this_ptr = (vsf_pool(__NAME) *)target_ptr; \
76 VSF_SERVICE_ASSERT(NULL != this_ptr); \
77 return vsf_pbuf_pool_alloc(&(this_ptr->use_as__vsf_pbuf_pool_t)); \
78}
79#endif
80
81#define __init_pbuf_pool(__NAME, __POOL, __ID, __COUNT, ...) \
82 do { \
83 VSF_CAL_NO_INIT static vsf_pool_item(__NAME) \
84 __##__NAME##_data_buffer[__COUNT]; \
85 const vsf_pbuf_adapter_t *adapter_ptr = \
86 vsf_pbuf_adapter_get(__ID); \
87 vsf_pool_cfg_t cfg = { \
88 .target_ptr = (uintptr_t)adapter_ptr, \
89 .pool_name_ptr = #__NAME, \
90 __VA_ARGS__ \
91 }; \
92 \
93 vsf_pbuf_pool_init( &((__POOL)->use_as__vsf_pbuf_pool_t), \
94 sizeof(vsf_pool_item(__NAME)), \
95 VSF_CAL_ALIGN_OF(vsf_pool_item(__NAME)), \
96 &cfg); \
97 vsf_pbuf_pool_add_buffer( &((__POOL)->use_as__vsf_pbuf_pool_t), \
98 __##__NAME##_data_buffer, \
99 sizeof(__##__NAME##_data_buffer), \
100 sizeof(vsf_pool_item(__NAME))); \
101 } while(0)
102
103#define init_pbuf_pool(__NAME, __POOL, __ID, __COUNT, ...) \
104 __init_pbuf_pool(__NAME, (__POOL), (__ID), (__COUNT), __VA_ARGS__)
105
106#define __prepare_pbuf_pool(__NAME, __POOL, __ID, ...) \
107 do { \
108 const vsf_pbuf_adapter_t *adapter_ptr = \
109 vsf_pbuf_adapter_get(__ID); \
110 vsf_pool_cfg_t cfg = { \
111 .target_ptr = (uintptr_t)adapter_ptr, \
112 .pool_name_ptr = #__NAME, \
113 .item_init_fn = &vsf_pbuf_pool_item_init_event_handler, \
114 __VA_ARGS__ \
115 }; \
116 \
117 vsf_pbuf_pool_init( &((__POOL)->use_as__vsf_pbuf_pool_t), \
118 sizeof(vsf_pool_item(__NAME)), \
119 VSF_CAL_ALIGN_OF(vsf_pool_item(__NAME)), \
120 &cfg); \
121 } while(0)
122
123#define prepare_pbuf_pool(__NAME, __POOL, __ID, ...) \
124 __prepare_pbuf_pool(__NAME, (__POOL), (__ID), __VA_ARGS__)
125
126
127#define def_pbuf_pool(__NAME, __SIZE, ...) \
128 __def_pbuf_pool(__NAME, (__SIZE), __VA_ARGS__)
129
130#define declare_pbuf_pool(__NAME) __declare_pbuf_pool(__NAME)
131
132#define vsf_pbuf_pool_req_pbuf_evt(__NAME, __POOL) \
133 __vsf_pbuf_pool_req_pbuf_evt(__NAME, (__POOL))
134
135#define implement_pbuf_pool(...) __implement_pbuf_pool(__VA_ARGS__)
136
137#define vsf_pbuf_pool_adapter(__ID, __POOL) \
138 { \
139 .target_ptr = (__POOL), \
140 .ID = (__ID), \
141 .methods_ptr = &VSF_PBUF_ADAPTER_METHODS_STREAM_SRC, \
142 }
143/*============================ TYPES =========================================*/
144
145typedef union vsf_pbuf_pool_item_t vsf_pbuf_pool_item_t;
146typedef struct vsf_pbuf_pool_t vsf_pbuf_pool_t;
147
148union vsf_pbuf_pool_item_t {
149 implement(vsf_slist_t)
150 vsf_pbuf_t tMem;
151};
152struct vsf_pbuf_pool_t {
153 implement(vsf_pool_t)
154};
155
156
157/*============================ GLOBAL VARIABLES ==============================*/
158extern const i_pbuf_methods_t VSF_PBUF_ADAPTER_METHODS_STREAM_SRC;
159
160/*============================ PROTOTYPES ====================================*/
161extern
162void vsf_pbuf_pool_init(vsf_pbuf_pool_t *this_ptr,
163 uint32_t u32_item_size,
164 uint_fast16_t u16_align,
165 vsf_pool_cfg_t *pcfg);
166
167extern
168bool vsf_pbuf_pool_add_buffer( vsf_pbuf_pool_t *this_ptr,
169 void *buffer_ptr,
170 uint_fast32_t u32_size,
171 uint_fast16_t u16_item_size) ;
172
173extern vsf_pbuf_t *vsf_pbuf_pool_alloc(vsf_pbuf_pool_t *);
174
175extern void vsf_pbuf_pool_free(vsf_pbuf_pool_t *, vsf_pbuf_t *);
176
177VSF_CAL_SECTION(".text." "vsf_pbuf" "_get_pool_item_count")
178extern uint_fast32_t vsf_pbuf_get_pool_item_count(vsf_pbuf_pool_t *);
179
180VSF_CAL_SECTION(".text." "vsf_pbuf" "_pool_get_region")
181extern vsf_protect_region_t *vsf_pbuf_pool_get_region(vsf_pbuf_pool_t *);
182
183VSF_CAL_SECTION(".text." "vsf_pbuf" "_pool_get_target")
184extern uintptr_t vsf_pbuf_pool_get_target(vsf_pbuf_pool_t *);
185
186#ifdef __cplusplus
187}
188#endif
189
190#endif
191#endif
192/* EOF */
VSF_CAL_SECTION
#define VSF_CAL_SECTION(__SEC)
Definition __compiler.h:181
uintptr_t
uint32_t uintptr_t
Definition stdint.h:38
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint_fast32_t
unsigned int uint_fast32_t
Definition stdint.h:27
uint_fast16_t
unsigned short uint_fast16_t
Definition stdint.h:25
vsf_pbuf_pool_t
Definition vsf_pbuf_pool.h:152
vsf_protect_region_t
Definition vsf_arch_abstraction.h:54
vsf_slist_t
Definition vsf_list.h:872
vsf_pbuf_pool_item_t
Definition vsf_pbuf_pool.h:148
vsf_pbuf_pool_item_t::tMem
vsf_slist_t vsf_pbuf_t tMem
Definition vsf_pbuf_pool.h:150
vsf_pbuf.h
vsf_pbuf_pool_init
void vsf_pbuf_pool_init(vsf_pbuf_pool_t *this_ptr, uint32_t u32_item_size, uint_fast16_t u16_align, vsf_pool_cfg_t *pcfg)
Definition vsf_pbuf_pool.c:44
vsf_pbuf_pool_get_region
vsf_protect_region_t * vsf_pbuf_pool_get_region(vsf_pbuf_pool_t *)
Definition vsf_pbuf_pool.c:92
vsf_pbuf_pool_get_target
uintptr_t vsf_pbuf_pool_get_target(vsf_pbuf_pool_t *)
Definition vsf_pbuf_pool.c:98
vsf_pbuf_pool_free
void vsf_pbuf_pool_free(vsf_pbuf_pool_t *, vsf_pbuf_t *)
Definition vsf_pbuf_pool.c:79
VSF_PBUF_ADAPTER_METHODS_STREAM_SRC
const i_pbuf_methods_t VSF_PBUF_ADAPTER_METHODS_STREAM_SRC
Definition vsf_pbuf_pool.c:31
vsf_pbuf_get_pool_item_count
uint_fast32_t vsf_pbuf_get_pool_item_count(vsf_pbuf_pool_t *)
Definition vsf_pbuf_pool.c:85
vsf_pbuf_pool_alloc
vsf_pbuf_t * vsf_pbuf_pool_alloc(vsf_pbuf_pool_t *)
Definition vsf_pbuf_pool.c:70
vsf_pbuf_pool_add_buffer
bool vsf_pbuf_pool_add_buffer(vsf_pbuf_pool_t *this_ptr, void *buffer_ptr, uint_fast32_t u32_size, uint_fast16_t u16_item_size)
Definition vsf_pbuf_pool.c:52
vsf_pool.h
vsf_pool_cfg_t
vsf_pool_cfg_t
Definition vsf_pool.h:539
vsf_service_cfg.h
Generated by doxygen 1.9.8