mem.h 7.09 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
22
 * @file
23
 * memory handling functions
24 25
 */

26 27
#ifndef AVUTIL_MEM_H
#define AVUTIL_MEM_H
28

29 30
#include <limits.h>

31
#include "attributes.h"
Nicolas George's avatar
Nicolas George committed
32
#include "error.h"
33
#include "avutil.h"
34

35 36 37 38 39 40
/**
 * @addtogroup lavu_mem
 * @{
 */


41
#if defined(__INTEL_COMPILER) && __INTEL_COMPILER < 1110 || defined(__SUNPRO_C)
42
    #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
43
    #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
44 45 46 47 48 49 50
#elif defined(__TI_COMPILER_VERSION__)
    #define DECLARE_ALIGNED(n,t,v)                      \
        AV_PRAGMA(DATA_ALIGN(v,n))                      \
        t __attribute__((aligned(n))) v
    #define DECLARE_ASM_CONST(n,t,v)                    \
        AV_PRAGMA(DATA_ALIGN(v,n))                      \
        static const t __attribute__((aligned(n))) v
51
#elif defined(__GNUC__)
52
    #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
53
    #define DECLARE_ASM_CONST(n,t,v)    static const t av_used __attribute__ ((aligned (n))) v
54 55 56 57 58 59 60 61
#elif defined(_MSC_VER)
    #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
    #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
#else
    #define DECLARE_ALIGNED(n,t,v)      t v
    #define DECLARE_ASM_CONST(n,t,v)    static const t v
#endif

62
#if AV_GCC_VERSION_AT_LEAST(3,1)
63 64 65 66 67
    #define av_malloc_attrib __attribute__((__malloc__))
#else
    #define av_malloc_attrib
#endif

68
#if AV_GCC_VERSION_AT_LEAST(4,3)
69
    #define av_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
70
#else
71
    #define av_alloc_size(...)
72 73
#endif

74
/**
75
 * Allocate a block of size bytes with alignment suitable for all
76 77
 * memory accesses (including vectors if available on the CPU).
 * @param size Size in bytes for the memory block to be allocated.
78 79
 * @return Pointer to the allocated block, NULL if the block cannot
 * be allocated.
80
 * @see av_mallocz()
81
 */
82
void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1);
83

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
/**
 * Helper function to allocate a block of size * nmemb bytes with
 * using av_malloc()
 * @param nmemb Number of elements
 * @param size Size of the single element
 * @return Pointer to the allocated block, NULL if the block cannot
 * be allocated.
 * @see av_malloc()
 */
av_alloc_size(1,2) static inline void *av_malloc_array(size_t nmemb, size_t size)
{
    if (size <= 0 || nmemb >= INT_MAX / size)
        return NULL;
    return av_malloc(nmemb * size);
}

100
/**
101 102 103
 * Allocate or reallocate a block of memory.
 * If ptr is NULL and size > 0, allocate a new block. If
 * size is zero, free the memory block pointed to by ptr.
104 105
 * @param ptr Pointer to a memory block already allocated with
 * av_malloc(z)() or av_realloc() or NULL.
106 107
 * @param size Size in bytes for the memory block to be allocated or
 * reallocated.
108 109
 * @return Pointer to a newly reallocated block or NULL if the block
 * cannot be reallocated or the function is used to free the memory block.
110
 * @see av_fast_realloc()
111
 */
112
void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
113

Nicolas George's avatar
Nicolas George committed
114 115 116 117 118 119 120 121 122 123
/**
 * Allocate or reallocate a block of memory.
 * This function does the same thing as av_realloc, except:
 * - It takes two arguments and checks the result of the multiplication for
 *   integer overflow.
 * - It frees the input block in case of failure, thus avoiding the memory
 *   leak with the classic "buf = realloc(buf); if (!buf) return -1;".
 */
void *av_realloc_f(void *ptr, size_t nelem, size_t elsize);

124
/**
125
 * Free a memory block which has been allocated with av_malloc(z)() or
126 127
 * av_realloc().
 * @param ptr Pointer to the memory block which should be freed.
128 129
 * @note ptr = NULL is explicitly allowed.
 * @note It is recommended that you use av_freep() instead.
130
 * @see av_freep()
131 132 133
 */
void av_free(void *ptr);

134
/**
135
 * Allocate a block of size bytes with alignment suitable for all
136
 * memory accesses (including vectors if available on the CPU) and
137
 * zero all the bytes of the block.
138
 * @param size Size in bytes for the memory block to be allocated.
139
 * @return Pointer to the allocated block, NULL if it cannot be allocated.
140 141
 * @see av_malloc()
 */
142
void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1);
143

Laurent Aimar's avatar
Laurent Aimar committed
144 145 146 147 148 149 150 151 152 153 154 155
/**
 * Allocate a block of nmemb * size bytes with alignment suitable for all
 * memory accesses (including vectors if available on the CPU) and
 * zero all the bytes of the block.
 * The allocation will fail if nmemb * size is greater than or equal
 * to INT_MAX.
 * @param nmemb
 * @param size
 * @return Pointer to the allocated block, NULL if it cannot be allocated.
 */
void *av_calloc(size_t nmemb, size_t size) av_malloc_attrib;

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
/**
 * Helper function to allocate a block of size * nmemb bytes with
 * using av_mallocz()
 * @param nmemb Number of elements
 * @param size Size of the single element
 * @return Pointer to the allocated block, NULL if the block cannot
 * be allocated.
 * @see av_mallocz()
 * @see av_malloc_array()
 */
av_alloc_size(1,2) static inline void *av_mallocz_array(size_t nmemb, size_t size)
{
    if (size <= 0 || nmemb >= INT_MAX / size)
        return NULL;
    return av_mallocz(nmemb * size);
}

173
/**
174
 * Duplicate the string s.
175
 * @param s string to be duplicated
176
 * @return Pointer to a newly allocated string containing a
177
 * copy of s or NULL if the string cannot be allocated.
178
 */
179
char *av_strdup(const char *s) av_malloc_attrib;
180 181

/**
182
 * Free a memory block which has been allocated with av_malloc(z)() or
183
 * av_realloc() and set the pointer pointing to it to NULL.
184 185 186
 * @param ptr Pointer to the pointer to the memory block which should
 * be freed.
 * @see av_free()
187 188 189
 */
void av_freep(void *ptr);

190 191 192 193 194 195 196 197 198
/**
 * Add an element to a dynamic array.
 *
 * @param tab_ptr Pointer to the array.
 * @param nb_ptr  Pointer to the number of elements in the array.
 * @param elem    Element to be added.
 */
void av_dynarray_add(void *tab_ptr, int *nb_ptr, void *elem);

Nicolas George's avatar
Nicolas George committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/**
 * Multiply two size_t values checking for overflow.
 * @return  0 if success, AVERROR(EINVAL) if overflow.
 */
static inline int av_size_mult(size_t a, size_t b, size_t *r)
{
    size_t t = a * b;
    /* Hack inspired from glibc: only try the division if nelem and elsize
     * are both greater than sqrt(SIZE_MAX). */
    if ((a | b) >= ((size_t)1 << (sizeof(size_t) * 4)) && a && t / a != b)
        return AVERROR(EINVAL);
    *r = t;
    return 0;
}

214 215 216 217 218
/**
 * Set the maximum size that may me allocated in one block.
 */
void av_max_alloc(size_t max);

219 220 221 222
/**
 * @}
 */

223
#endif /* AVUTIL_MEM_H */