summaryrefslogtreecommitdiffstats
path: root/nsframework/common_library/client/include/native_service/cl_region.h
blob: c9eec5f33052bcae046b173f0cd5570cb054e673 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/*
 * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file cl_region.h
 * @brief region manage
 *
 */

#ifndef _CL_REGION_H_  // NOLINT(build/header_guard)
#define _CL_REGION_H_  // NOLINT(build/header_guard)

#include <stdint.h>
#include <stdbool.h>
#include <unistd.h>

#define CL_REGION_DEFAULT_SIZE    (4 * 1024)

#define CL_ALIGNOF(type) __alignof(type)

typedef void (*cl_region_cleanup_pt)(void *data);

typedef struct cl_region_cleanup_s  cl_region_cleanup_t;

/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Monitor
/// \~english @par Brief
///        region cleanup struct
/////////////////////////////////////////////////////////////////////////////////////
struct cl_region_cleanup_s {  // NOLINT(readability/nolint)
  cl_region_cleanup_pt handler;
  void                 *data;
  cl_region_cleanup_t  *next;
};


typedef struct cl_region_large_s  cl_region_large_t;

/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Monitor
/// \~english @par Brief
///        region large struct
/////////////////////////////////////////////////////////////////////////////////////
struct cl_region_large_s {  // NOLINT(readability/nolint)
  cl_region_large_t *next;
  void              *alloc;
  size_t            size;
};


typedef struct cl_region_s cl_region_t;

/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Monitor
/// \~english @par Brief
///        region data struct
/////////////////////////////////////////////////////////////////////////////////////
typedef struct {
  uint8_t     *last;
  uint8_t     *end;
  cl_region_t *next;
  int         failed;
} cl_region_data_t;

/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Monitor
/// \~english @par Brief
///        region struct
/////////////////////////////////////////////////////////////////////////////////////
struct cl_region_s {  // NOLINT(readability/nolint)
  cl_region_data_t    d;
  size_t              max;
  cl_region_t         *current;
  cl_region_large_t   *large;
  cl_region_cleanup_t *cleanup;
};


#ifdef __cplusplus
extern "C" {
#endif
/**
 * @file cl_region.h
 */

/** @addtogroup BaseSystem
 *  @{
 */
/** @addtogroup native_service
 *  @ingroup BaseSystem
 *  @{
 */
/** @addtogroup common_library
 *  @ingroup native_service
 *  @{
 */

/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Region
/// \~english @par Brief
///     Region create
/// \~english @param [in] size
///     size_t - the size to create
/// \~english @retval 0  Success
/// \~english @retval -1 Error
/// \~english @par Prerequisite
///     None
/// \~english @par Change of internal state
///     None
/// \~english @par Conditions of processing failure
///     None
/// \~english @par Classification
///     Public
/// \~english @par Type
///     Sync
/// \~english @par Detail
///     None
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
cl_region_t *CL_RegionCreate(size_t size);  // NOLINT(readability/nolint)


/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Region
/// \~english @par Brief
///     Region destroy
/// \~english @param [in] region
///     cl_region_t * - the region to destroy
/// \~english @retval 0  Success
/// \~english @retval -1 Error
/// \~english @par Prerequisite
///     None
/// \~english @par Change of internal state
///     None
/// \~english @par Conditions of processing failure
///     None
/// \~english @par Classification
///     Public
/// \~english @par Type
///     Sync
/// \~english @par Detail
///     None
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
void CL_RegionDestroy(cl_region_t *region);  // NOLINT(readability/nolint)


/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Region
/// \~english @par Brief
///     Region allocation
/// \~english @param [in] region
///     cl_region_t * - the region to allocate
/// \~english @param [in] size
///     size_t * - the size to allocate
/// \~english @param [in] align_size
///     size_t * - the size to align
/// \~english @retval the pointer to region allocated
/// \~english @par Prerequisite
///     None
/// \~english @par Change of internal state
///     None
/// \~english @par Conditions of processing failure
///     None
/// \~english @par Classification
///     Public
/// \~english @par Type
///     Sync
/// \~english @par Detail
///     None
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
#define CL_RegionAlloc(region, type, length) \
  cl_region_alloc(region, sizeof(type) * length, CL_ALIGNOF(type))
void *cl_region_alloc(cl_region_t *region, size_t size, size_t align_size);  // NOLINT(readability/nolint)

/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Region
/// \~english @par Brief
///     Region free
/// \~english @param [in] region
///     cl_region_t * - the region to free
/// \~english @param [in] p
///     void * - the pointer to region
/// \~english @retval true  Success
/// \~english @retval false Error
/// \~english @par Prerequisite
///     None
/// \~english @par Change of internal state
///     None
/// \~english @par Conditions of processing failure
///     None
/// \~english @par Classification
///     Public
/// \~english @par Type
///     Sync
/// \~english @par Detail
///     None
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
bool CL_RegionFree(cl_region_t *region, void *p);  // NOLINT(readability/nolint)


/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup Region
/// \~english @par Brief
///     add region cleanup
/// \~english @param [in] region
///     cl_region_t * - the region to allocate
/// \~english @param [in] size
///     size_t * - the size to add
/// \~english @param [in] align_size
///     size_t * - the size to align
/// \~english @retval the pointer to region cleanup added
/// \~english @par Prerequisite
///     None
/// \~english @par Change of internal state
///     None
/// \~english @par Conditions of processing failure
///     None
/// \~english @par Classification
///     Public
/// \~english @par Type
///     Sync
/// \~english @par Detail
///     None
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
#define CL_RegionCleanupAdd(region, type, length) \
  cl_region_cleanup_add(region, sizeof(type) * length, CL_ALIGNOF(type))
cl_region_cleanup_t *cl_region_cleanup_add(cl_region_t *region, size_t size,  // NOLINT(readability/nolint)
                                           size_t align_size);

/** @}*/  // end of common_library
/** @}*/  // end of NativeService
/** @}*/  // end of BaseSystem
#ifdef __cplusplus
}
#endif


#endif /* _CL_REGION_H_ */  // NOLINT(build/header_guard)

/* vim:set ts=8 sw=2 sts=2: */