2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2007, Callum Lerwick <seg@haxxed.com>
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
32 #ifndef __OPJ_MALLOC_H
33 #define __OPJ_MALLOC_H
38 @brief Internal functions
40 The functions in opj_malloc.h are internal utilities used for memory management.
43 /** @defgroup MISC MISC - Miscellaneous internal functions */
46 /** @name Exported functions */
48 /* ----------------------------------------------------------------------- */
51 Allocate an uninitialized memory block
52 @param size Bytes to allocate
53 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
55 void * opj_malloc(size_t size);
58 Allocate a memory block with elements initialized to 0
59 @param num Blocks to allocate
60 @param size Bytes per block to allocate
61 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
63 void * opj_calloc(size_t numOfElements, size_t sizeOfElements);
66 Allocate memory aligned to a 16 byte boundary
67 @param size Bytes to allocate
68 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
70 void * opj_aligned_malloc(size_t size);
71 void * opj_aligned_realloc(void *ptr, size_t size);
72 void opj_aligned_free(void* ptr);
75 Reallocate memory blocks.
76 @param m Pointer to previously allocated memory block
77 @param s New size in bytes
78 @return Returns a void pointer to the reallocated (and possibly moved) memory block
80 void * opj_realloc(void * m, size_t s);
83 Deallocates or frees a memory block.
84 @param m Previously allocated memory block to be freed
86 void opj_free(void * m);
88 #if defined(__GNUC__) && !defined(OPJ_SKIP_POISON)
89 #pragma GCC poison malloc calloc realloc free
92 /* ----------------------------------------------------------------------- */
97 #endif /* __OPJ_MALLOC_H */