aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_aligned_reallocf.3
blob: 75d292a94f3bbc8168b4821b8e24f17161357299 (plain) (blame)
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
.TH LIBSIMPLE_ALIGNED_REALLOCF 3 libsimple
.SH NAME
libsimple_aligned_reallocf \- reallocate memory and customise alignment

.SH SYNOPSIS
.nf
#include <libsimple.h>

inline void *libsimple_aligned_reallocf(void *\fIptr\fP, size_t \fIalignment\fP, size_t \fIn\fP);

#ifndef aligned_reallocf
# define aligned_reallocf libsimple_aligned_reallocf
#endif
.fi
.PP
Link with
.IR \-lsimple .

.SH DESCRIPTION
The
.BR libsimple_aligned_reallocf ()
function reallocates memory allocated on
the heap and return the older pointer or a new
pointer with the alignment of
.I alignment
to the allocated memory of 
.I n
bytes. The returned pointer will contain the
same content as
.IR ptr ,
but truncated to
.I n
bytes if it is smaller or with the new bytes
uninitialised if it is larger. If a new pointer
is returned, rather than
.IR ptr ,
.I ptr
is deallocated;
.I ptr
is deallocated on failure. The function
.BR free (3)
shall be called with the returned pointer as
input when the allocated memory is no longer needed.
.PP
If
.I n
is 0,
.I ptr
is deallocaed and
.B NULL
is returned, however portable applications should,
unless the namespaced alias is used, assume the
behaviour is unspecifed in this case.

.SH RETURN VALUE
The
.BR libsimple_aligned_reallocf (),
function returns a pointer to the allocated memory
upon success completion; otherwise the
.BR libsimple_aligned_reallocf ()
function returns
.B NULL
and set
.I errno
it indicate the error.

.SH ERRORS
The
.BR libsimple_aligned_reallocf ()
function will fail for the reasons specified for the
.BR realloc (3)
function, and if:
.TP
.B EINVAL
.I alignment
is an invalid alignment (usually it needs to be an power of 2).
.TP
.B ENOSYS
The function is not implemented. The function requires
non-standard libc functions, and is therefore not supported
for all libc implementations.

The function is implemented if and only if the macro
.B LIBSIMPLE_HAVE_ALIGNED_REALLOC
is defined by the library.

.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_aligned_reallocf ()
T}	Thread safety	MT-Safe
T{
.BR libsimple_aligned_reallocf ()
T}	Async-signal safety	AS-Safe
T{
.BR libsimple_aligned_reallocf ()
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 HISTORY
libsimple 1.2

.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_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),
.BR libsimple_vmemalloc (3),
.BR libsimple_varrayalloc (3),
.BR malloc (3)