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
|
.TH LIBSIMPLE_VARRAYALLOC 3 libsimple
.SH NAME
libsimple_varrayalloc \- allocate memory in a flexible manner
.SH SYNOPSIS
.nf
#include <libsimple.h>
enum libsimple_arrayalloc_option {
/* constants omitted, see \fBDESCRIPTION\fP */
};
void *libsimple_varrayalloc(\fItype\fP, size_t \fIn\fP, va_list \fIap\fP);
void *libsimple_envarrayalloc(int \fIstatus\fP, \fItype\fP, size_t \fIn\fP, va_list \fIap\fP);
void *libsimple_evarrayalloc(\fItype\fP, size_t \fIn\fP, va_list \fIap\fP);
void *libsimple_arrayalloc(\fItype\fP, size_t \fIn\fP, ..., /* LIBSIMPLE_ARRAYALLOC_END */);
void *libsimple_enarrayalloc(int \fIstatus\fP, \fItype\fP, size_t \fIn\fP, ..., /* LIBSIMPLE_ARRAYALLOC_END */);
void *libsimple_earrayalloc(\fItype\fP, size_t \fIn\fP, ..., /* LIBSIMPLE_ARRAYALLOC_END */);
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_varrayalloc (),
.BR libsimple_envarrayalloc (),
.BR libsimple_earrayalloc (),
.BR libsimple_arrayalloc (),
.BR libsimple_enarrayalloc (),
and
.BR libsimple_earrayalloc ()
functions are versions of the
.BR libsimple_vmemalloc (),
.BR libsimple_envmemalloc (),
.BR libsimple_ememalloc (),
.BR libsimple_memalloc (),
.BR libsimple_enmemalloc (),
and
.BR libsimple_ememalloc ()
functions, respectively, implemented as macros,
and are identical to those functions with the
following excepts:
.TP
*
The namespaces
.B libsimple_arrayalloc
and
.B LIBSIMPLE_ARRAYALLOC
instead of
.B libsimple_memalloc
and
.BR LIBSIMPLE_MEMALLOC .
.TP
*
The constants
.BR LIBSIMPLE_MEMALLOC_ALIGNMENT ,
.BR LIBSIMPLE_MEMALLOC_PAGE_ALIGNMENT ,
and
.B LIBSIMPLE_MEMALLOC_ELEMENT_SIZE
are not defined.
.TP
*
The additional parameter
.I type
which shall be a type, or an identifier, for which
.I sizeof(type)
and
.I _Alignof(type)
can be evaluated.
.TP
*
.I _Alignof(type)
will be used as the alignment for the returned pointer.
.TP
*
The specified allocatio size will be multiplied by
.IR sizeof(type) .
.SH RETURN VALUE
The
.BR libsimple_varrayalloc (),
.BR libsimple_envarrayalloc (),
.BR libsimple_earrayalloc (),
.BR libsimple_arrayalloc (),
.BR libsimple_enarrayalloc (),
and
.BR libsimple_earrayalloc ()
functions return the a pointer to the allocated
memory upon successful completion; otherwise the
.BR libsimple_varrayalloc ()
and
.BR libsimple_arrayalloc ()
functions return
.B NULL
and set
.I errno
to indicate the error, whereas the
.BR libsimple_envarrayalloc (),
.BR libsimple_earrayalloc (),
.BR libsimple_enarrayalloc (),
and
.BR libsimple_earrayalloc ()
functions terminate the process.
.SH ERRORS
The
.BR libsimple_varrayalloc ()
and
.BR libsimple_arrayalloc ()
functions will fail if
.TP
.B EINVAL
An invalid argument is specified.
.TP
.B EINVAL
An option is specified twice or in
conjunction with a mutually exclusive option.
.TP
.B ENOMEM
Enough memory could not be allocated.
.PP
The
.BR libsimple_envarrayalloc (),
.BR libsimple_earrayalloc (),
.BR libsimple_enarrayalloc (),
and
.BR libsimple_earrayalloc ()
functions 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_varrayalloc (),
.br
.BR libsimple_envarrayalloc (),
.br
.BR libsimple_earrayalloc (),
.br
.BR libsimple_arrayalloc (),
.br
.BR libsimple_enarrayalloc (),
.br
.BR libsimple_earrayalloc ()
T} Thread safety MT-Safe
T{
.BR libsimple_varrayalloc (),
.br
.BR libsimple_envarrayalloc (),
.br
.BR libsimple_earrayalloc (),
.br
.BR libsimple_arrayalloc (),
.br
.BR libsimple_enarrayalloc (),
.br
.BR libsimple_earrayalloc ()
T} Async-signal safety AS-Safe
T{
.BR libsimple_varrayalloc (),
.br
.BR libsimple_envarrayalloc (),
.br
.BR libsimple_earrayalloc (),
.br
.BR libsimple_arrayalloc (),
.br
.BR libsimple_enarrayalloc (),
.br
.BR libsimple_earrayalloc ()
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_vmemalloc (3),
.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_valigned_alloczn (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)
|
