xalloc.h

Absolute File Name:

/home/opencoverage/opencoverage/guest-scripts/coreutils/src/gnulib/lib/xalloc.h

Line

Source

Count

/* xalloc.h -- malloc with out-of-memory checking

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program. If not, see <https://www.gnu.org/licenses/>. */

#ifndef XALLOC_H_

#define XALLOC_H_

#include <stddef.h>

#include <stdint.h>

#include "xalloc-oversized.h"

#ifndef _GL_INLINE_HEADER_BEGIN

#error "Please include config.h first."

#endif

_GL_INLINE_HEADER_BEGIN

#ifndef XALLOC_INLINE

# define XALLOC_INLINE _GL_INLINE

#endif

#ifdef __cplusplus

extern "C" {

#endif

#if __GNUC__ >= 3

# define _GL_ATTRIBUTE_MALLOC __attribute__ ((__malloc__))

#else

# define _GL_ATTRIBUTE_MALLOC

#endif

#if ! defined __clang__ && \

(__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))

# define _GL_ATTRIBUTE_ALLOC_SIZE(args) __attribute__ ((__alloc_size__ args))

#else

# define _GL_ATTRIBUTE_ALLOC_SIZE(args)

#endif

/* This function is always triggered when memory is exhausted.

It must be defined by the application, either explicitly

or by using gnulib's xalloc-die module. This is the

function to call when one wants the program to die because of a

memory allocation failure. */

extern _Noreturn void xalloc_die (void);

void *xmalloc (size_t s)

_GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1));

void *xzalloc (size_t s)

_GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1));

void *xcalloc (size_t n, size_t s)

_GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1, 2));

void *xrealloc (void *p, size_t s)

_GL_ATTRIBUTE_ALLOC_SIZE ((2));

void *x2realloc (void *p, size_t *pn);

void *xmemdup (void const *p, size_t s)

_GL_ATTRIBUTE_ALLOC_SIZE ((2));

char *xstrdup (char const *str)

_GL_ATTRIBUTE_MALLOC;

/* In the following macros, T must be an elementary or structure/union or

typedef'ed type, or a pointer to such a type. To apply one of the

following macros to a function pointer or array type, you need to typedef

it first and use the typedef name. */

/* Allocate an object of type T dynamically, with error checking. */

/* extern t *XMALLOC (typename t); */

#define XMALLOC(t) ((t *) xmalloc (sizeof (t)))

/* Allocate memory for N elements of type T, with error checking. */

/* extern t *XNMALLOC (size_t n, typename t); */

#define XNMALLOC(n, t) \

((t *) (sizeof (t) == 1 ? xmalloc (n) : xnmalloc (n, sizeof (t))))

/* Allocate an object of type T dynamically, with error checking,

and zero it. */

/* extern t *XZALLOC (typename t); */

#define XZALLOC(t) ((t *) xzalloc (sizeof (t)))

/* Allocate memory for N elements of type T, with error checking,

and zero it. */

/* extern t *XCALLOC (size_t n, typename t); */

#define XCALLOC(n, t) \

((t *) (sizeof (t) == 1 ? xzalloc (n) : xcalloc (n, sizeof (t))))

/* Allocate an array of N objects, each with S bytes of memory,

100

dynamically, with error checking. S must be nonzero. */

101

102

XALLOC_INLINE void *xnmalloc (size_t n, size_t s)

103

_GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1, 2));

104

XALLOC_INLINE void *

105

xnmalloc (size_t n, size_t s)

106

{

107

if (xalloc_oversized (n, s))

(__builtin_con...oc_count); }))	Description
TRUE	never evaluated
FALSE	evaluated 15918 times by 20 tests Evaluated by: chmod df dir head ls mkdir od paste pr ptx shred shuf sort split tail tee tr users vdir wc

__builtin_constant_p (n)	Description
TRUE	evaluated 2626 times by 5 tests Evaluated by: dir head ls od vdir
FALSE	evaluated 13292 times by 18 tests Evaluated by: chmod df dir ls mkdir paste pr ptx shred shuf sort split tail tee tr users vdir wc

__builtin_constant_p (s)	Description
TRUE	evaluated 1166 times by 3 tests Evaluated by: dir ls vdir
FALSE	evaluated 1460 times by 2 tests Evaluated by: head od

0-15918

108

xalloc_die ();

never executed: xalloc_die ();

109

return xmalloc (n * s);

executed 15918 times by 20 tests: return xmalloc (n * s);

Executed by:

chmod
df
dir
head
ls
mkdir
od
paste
pr
ptx
shred
shuf
sort
split
tail
tee
tr
users
vdir
wc

15918

110

}

111

112

/* Change the size of an allocated block of memory P to an array of N

113

objects each of S bytes, with error checking. S must be nonzero. */

114

115

XALLOC_INLINE void *xnrealloc (void *p, size_t n, size_t s)

116

_GL_ATTRIBUTE_ALLOC_SIZE ((2, 3));

117

XALLOC_INLINE void *

118

xnrealloc (void *p, size_t n, size_t s)

119

{

120

if (xalloc_oversized (n, s))

(__builtin_con...oc_count); }))	Description
TRUE	never evaluated
FALSE	evaluated 780 times by 6 tests Evaluated by: cp df dir head ls shuf

__builtin_constant_p (n)	Description
TRUE	never evaluated
FALSE	evaluated 780 times by 6 tests Evaluated by: cp df dir head ls shuf

__builtin_constant_p (s)	Description
TRUE	never evaluated
FALSE	never evaluated

0-780

121

xalloc_die ();

never executed: xalloc_die ();

122

return xrealloc (p, n * s);

executed 780 times by 6 tests: return xrealloc (p, n * s);

Executed by:

cp
df
dir
head
ls
shuf

780

123

}

124

125

/* If P is null, allocate a block of at least *PN such objects;

126

otherwise, reallocate P so that it contains more than *PN objects

127

each of S bytes. S must be nonzero. Set *PN to the new number of

128

objects, and return the pointer to the new block. *PN is never set

129

to zero, and the returned pointer is never null.

130

131

Repeated reallocations are guaranteed to make progress, either by

132

allocating an initial block with a nonzero size, or by allocating a

133

larger block.

134

135

In the following implementation, nonzero sizes are increased by a

136

factor of approximately 1.5 so that repeated reallocations have

137

O(N) overall cost rather than O(N**2) cost, but the

138

specification for this function does not guarantee that rate.

139

140

Here is an example of use:

int *p = NULL;

size_t used = 0;

size_t allocated = 0;

145

146

void

147

append_int (int value)

148

{

149

if (used == allocated)

150

p = x2nrealloc (p, &allocated, sizeof *p);

p[used++] = value;

}

This causes x2nrealloc to allocate a block of some nonzero size the

155

first time it is called.

156

157

To have finer-grained control over the initial size, set *PN to a

158

nonzero value before calling this function with P == NULL. For

example:

int *p = NULL;

size_t used = 0;

size_t allocated = 0;

164

size_t allocated1 = 1000;

165

166

void

167

append_int (int value)

168

{

169

if (used == allocated)

170

{

171

p = x2nrealloc (p, &allocated1, sizeof *p);

172

allocated = allocated1;

}

p[used++] = value;

}

XALLOC_INLINE void *

x2nrealloc (void *p, size_t *pn, size_t s)

{

size_t n = *pn;

if (! p)

! p	Description
TRUE	evaluated 8169 times by 24 tests Evaluated by: chmod comm cp csplit cut du expand factor fold join mv nl numfmt od pinky pr ptx sort split tsort unexpand uniq users who
FALSE	evaluated 245 times by 9 tests Evaluated by: chmod cp csplit pinky ptx sort uniq users who

245-8169

185

{

186

if (! n)

! n	Description
TRUE	evaluated 8144 times by 23 tests Evaluated by: comm cp csplit cut du expand factor fold join mv nl numfmt od pinky pr ptx sort split tsort unexpand uniq users who
FALSE	evaluated 25 times by 1 test Evaluated by: chmod

25-8144

187

{

188

/* The approximate size to use for initial small allocation

189

requests, when the invoking code specifies an old size of

190

zero. This is the largest "small" request for the GNU C

191

library malloc. */

192

enum { DEFAULT_MXFAST = 64 * sizeof (size_t) / 4 };

193

194

n = DEFAULT_MXFAST / s;

195

n += !n;

196

}

executed 8144 times by 23 tests: end of block

Executed by:

comm
cp
csplit
cut
du
expand
factor
fold
join
mv
nl
numfmt
od
pinky
pr
ptx
sort
split
tsort
unexpand
uniq
users
who

8144

197

if (xalloc_oversized (n, s))

(__builtin_con...oc_count); }))	Description
TRUE	never evaluated
FALSE	evaluated 8169 times by 24 tests Evaluated by: chmod comm cp csplit cut du expand factor fold join mv nl numfmt od pinky pr ptx sort split tsort unexpand uniq users who

__builtin_constant_p (n)	Description
TRUE	never evaluated
FALSE	evaluated 8169 times by 24 tests Evaluated by: chmod comm cp csplit cut du expand factor fold join mv nl numfmt od pinky pr ptx sort split tsort unexpand uniq users who