1/*
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.
6 *
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2007, Callum Lerwick <seg@haxxed.com>
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
19 *
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.
31 */
32#ifndef OPJ_MALLOC_H
33#define OPJ_MALLOC_H
34
35#include <stddef.h>
36/**
37@file opj_malloc.h
38@brief Internal functions
39
40The functions in opj_malloc.h are internal utilities used for memory management.
41*/
42
43/** @defgroup MISC MISC - Miscellaneous internal functions */
44/*@{*/
45
46/** @name Exported functions */
47/*@{*/
48/* ----------------------------------------------------------------------- */
49
50/**
51Allocate 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
54*/
55void * opj_malloc(size_t size);
56
57/**
58Allocate a memory block with elements initialized to 0
59@param numOfElements Blocks to allocate
60@param sizeOfElements Bytes per block to allocate
61@return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
62*/
63void * opj_calloc(size_t numOfElements, size_t sizeOfElements);
64
65/**
66Allocate 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
69*/
70void * opj_aligned_malloc(size_t size);
71void * opj_aligned_realloc(void *ptr, size_t size);
72void opj_aligned_free(void* ptr);
73
74/**
75Allocate memory aligned to a 32 byte boundary
76@param size Bytes to allocate
77@return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
78*/
79void * opj_aligned_32_malloc(size_t size);
80void * opj_aligned_32_realloc(void *ptr, size_t size);
81
82/**
83Reallocate memory blocks.
84@param m Pointer to previously allocated memory block
85@param s New size in bytes
86@return Returns a void pointer to the reallocated (and possibly moved) memory block
87*/
88void * opj_realloc(void * m, size_t s);
89
90/**
91Deallocates or frees a memory block.
92@param m Previously allocated memory block to be freed
93*/
94void opj_free(void * m);
95
96#if defined(__GNUC__) && !defined(OPJ_SKIP_POISON)
97#pragma GCC poison malloc calloc realloc free
98#endif
99
100/* ----------------------------------------------------------------------- */
101/*@}*/
102
103/*@}*/
104
105#endif /* OPJ_MALLOC_H */
106
107