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
|
.TH LIBSIMPLE_VALIGNED_ALLOCZN 3 2018-11-03 libsimple
.SH NAME
libsimple_valigned_alloczn \- allocate optionally initialised memory with custom alignment
.SH SYNOPSIS
.nf
#include <libsimple.h>
void *libsimple_valigned_alloczn(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, va_list \fIap\fP);
void *libsimple_envaligned_alloczn(int \fIstatus\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, va_list \fIap\fP);
static inline void *libsimple_evaligned_alloczn(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, va_list \fIap\fP);
static inline void *libsimple_aligned_alloczn(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
static inline void *libsimple_enaligned_alloczn(int \fIstatus\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
static inline void *libsimple_ealigned_alloczn(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
#ifndef valigned_alloczn
# define valigned_alloczn libsimple_valigned_alloczn
#endif
#ifndef envaligned_alloczn
# define envaligned_alloczn libsimple_envaligned_alloczn
#endif
#ifndef evaligned_alloczn
# define evaligned_alloczn libsimple_evaligned_alloczn
#endif
#ifndef aligned_alloczn
# define aligned_alloczn libsimple_aligned_alloczn
#endif
#ifndef enaligned_alloczn
# define enaligned_alloczn libsimple_enaligned_alloczn
#endif
#ifndef ealigned_alloczn
# define ealigned_alloczn libsimple_ealigned_alloczn
#endif
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_aligned_alloczn (),
.BR libsimple_enaligned_alloczn (),
and
.BR libsimple_ealigned_alloczn ()
functions allocate
.I N
bytes to the heap and return a pointer with an
alignment of
.I alignment
bytes to the allocated memory, where
.I N
is the product of
.I n
and all following arguments (which should have the type
.BR size_t )
up to the first 0;
.I n
must not be 0. The memory will be initialised
with zeroes if
.I clear
is a non-zero value. The function
.BR free (3)
shall be called with the returned pointer as
input when the allocated memory is no longer needed.
.PP
The
.BR libsimple_enaligned_alloczn ()
and
.BR libsimple_ealigned_alloczn ()
functions will terminate the process if the memory
cannot be allocated, by calling the
.BR libsimple_enprintf ()
and
.BR libsimple_eprintf ()
functions, respectively.
On failure, the process's exit value will be
.I status
if the
.BR libsimple_enaligned_alloczn ()
function is used or
.IR libsimple_default_failure_exit (3)
if the
.BR libsimple_ealigned_alloczn ()
function is used.
.PP
The
.BR libsimple_valigned_alloczn (),
.BR libsimple_envaligned_alloczn (),
and
.BR libsimple_evaligned_alloczn ()
functions are versions of the
.BR libsimple_aligned_alloczn (),
.BR libsimple_enaligned_alloczn (),
and
.BR libsimple_ealigned_alloczn (),
respectively, that use
.B va_list
instead of variadic arguments.
.SH RETURN VALUE
The
.BR libsimple_valigned_alloczn (),
.BR libsimple_envaligned_alloczn (),
.BR libsimple_evaligned_alloczn (),
.BR libsimple_aligned_alloczn (),
.BR libsimple_enaligned_alloczn (),
and
.BR libsimple_ealigned_alloczn ()
functions return a pointer to the allocated memory
upon success completion; otherwise the
.BR libsimple_valigned_alloczn ()
and
.BR libsimple_aligned_alloczn ()
functions return
.B NULL
and set
.I errno
it indicate the error, and the
.BR libsimple_envaligned_alloczn (),
.BR libsimple_evaligned_alloczn (),
.BR libsimple_enaligned_alloczn (),
and
.BR libsimple_ealigned_alloczn ()
functions terminated the process.
.SH ERRORS
The
.BR libsimple_valigned_alloczn (),
.BR libsimple_aligned_alloczn ()
function will fail if:
.TP
.B EINVAL
.I n
is 0.
.TP
.B EINVAL
.I n
is not a multiple of
.IR alignment .
.TP
.B EINVAL
.I alignment
is not a power of two.
.TP
.B ENOMEM
Enough memory could not be allocated.
.PP
The
.BR libsimple_envaligned_alloczn (),
.BR libsimple_evaligned_alloczn (),
.BR libsimple_enaligned_alloczn (),
and
.BR libsimple_ealigned_alloczn ()
functions will terminate the process on failure.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface Attribute Value
T{
.BR libsimple_valigned_alloczn (),
.br
.BR libsimple_envaligned_alloczn (),
.br
.BR libsimple_evaligned_alloczn (),
.br
.BR libsimple_aligned_alloczn (),
.br
.BR libsimple_enaligned_alloczn (),
.br
.BR libsimple_ealigned_alloczn ()
T} Thread safety MT-Safe
T{
.BR libsimple_valigned_alloczn (),
.br
.BR libsimple_envaligned_alloczn (),
.br
.BR libsimple_evaligned_alloczn (),
.br
.BR libsimple_aligned_alloczn (),
.br
.BR libsimple_enaligned_alloczn (),
.br
.BR libsimple_ealigned_alloczn ()
T} Async-signal safety AS-Safe
T{
.BR libsimple_valigned_alloczn (),
.br
.BR libsimple_envaligned_alloczn (),
.br
.BR libsimple_evaligned_alloczn (),
.br
.BR libsimple_aligned_alloczn (),
.br
.BR libsimple_enaligned_alloczn (),
.br
.BR libsimple_ealigned_alloczn ()
T} Async-cancel safety AC-Safe
.TE
.SH EXAMPLES
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH FUTURE DIRECTIONS
None.
.SH NOTES
None.
.SH BUGS
None.
.SH SEE ALSO
.BR libsimple_enmalloc (3),
.BR libsimple_mallocz (3),
.BR libsimple_vmallocn (3),
.BR libsimple_vmalloczn (3),
.BR libsimple_encalloc (3),
.BR libsimple_vcallocn (3),
.BR libsimple_enrealloc (3),
.BR libsimple_reallocarray (3),
.BR libsimple_vreallocn (3),
.BR libsimple_reallocf (3),
.BR libsimple_reallocarrayf (3),
.BR libsimple_vreallocfn (3),
.BR libsimple_aligned_realloc (3),
.BR libsimple_aligned_reallocarray (3),
.BR libsimple_aligned_vreallocn (3),
.BR libsimple_aligned_reallocf (3),
.BR libsimple_aligned_reallocarrayf (3),
.BR libsimple_aligned_vreallocfn (3),
.BR libsimple_memalign (3),
.BR libsimple_memalignz (3),
.BR libsimple_vmemalignn (3),
.BR libsimple_vmemalignzn (3),
.BR libsimple_enposix_memalign (3),
.BR libsimple_posix_memalignz (3),
.BR libsimple_vposix_memalignn (3),
.BR libsimple_vposix_memalignzn (3),
.BR libsimple_enaligned_alloc (3),
.BR libsimple_aligned_allocz (3),
.BR libsimple_valigned_allocn (3),
.BR libsimple_pvalloc (3),
.BR libsimple_pvallocz (3),
.BR libsimple_vpvallocn (3),
.BR libsimple_vpvalloczn (3),
.BR libsimple_valloc (3),
.BR libsimple_vallocz (3),
.BR libsimple_vvallocn (3),
.BR libsimple_vvalloczn (3),
.BR libsimple_vmemalloc (3),
.BR libsimple_varrayalloc (3),
.BR aligned_alloc (3)
|
