OpenJPH: /build/openjph/src/OpenJPH/src/core/others/ojph_mem_c.c Source File

OpenJPH Open-source implementation of JPEG2000 Part-15

Loading...
Searching...
No Matches
ojph_mem_c.c
Go to the documentation of this file.
1//***************************************************************************/
2// This software is released under the 2-Clause BSD license, included
3// below.
4//
5// Copyright (c) 2025, Aous Naman
6// Copyright (c) 2025, Kakadu Software Pty Ltd, Australia
7// Copyright (c) 2025, The University of New South Wales, Australia
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12//
13// 1. Redistributions of source code must retain the above copyright
14// notice, this list of conditions and the following disclaimer.
15//
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
21// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31//***************************************************************************/
32// This file is part of the OpenJPH software implementation.
33// File: ojph_mem_c.c
34// Author: Aous Naman
35// Date: 17 October 2025
36//***************************************************************************/
37
38#include <assert.h>
39#include <stdlib.h>
40#include <stdint.h>
41
43// OS detection definitions for C only
45#if (defined WIN32) || (defined _WIN32) || (defined _WIN64)
46#define OJPH_OS_WINDOWS
47#elif (defined __APPLE__)
48#define OJPH_OS_APPLE
49#elif (defined __ANDROID__)
50#define OJPH_OS_ANDROID
51#elif (defined __linux)
52#define OJPH_OS_LINUX
53#endif
54
56// Defines for dll in C only
58#if defined(OJPH_OS_WINDOWS) && defined(OJPH_BUILD_SHARED_LIBRARY)
59#define OJPH_EXPORT __declspec(dllexport)
60#else
61#define OJPH_EXPORT
62#endif
63
65#ifdef OJPH_OS_WINDOWS
66 OJPH_EXPORT void* ojph_aligned_malloc(size_t alignment, size_t size)
67 {
68 assert(alignment != 0 && (alignment & (alignment - 1)) == 0);
69 return _aligned_malloc(size, alignment);
70 }
71
72 OJPH_EXPORT void ojph_aligned_free(void* pointer)
73 {
74 _aligned_free(pointer);
75 }
76#elif (defined OJPH_ALIGNED_ALLOC_EXISTS)
77 void* ojph_aligned_malloc(size_t alignment, size_t size)
78 {
79 assert(alignment != 0 && (alignment & (alignment - 1)) == 0);
80 return aligned_alloc(alignment, size);
81 }
82
83 void ojph_aligned_free(void* pointer)
84 {
85 free(pointer);
86 }
87#elif (defined OJPH_POSIX_MEMALIGN_EXISTS)
88 void* ojph_aligned_malloc(size_t alignment, size_t size)
89 {
90 assert(alignment != 0 && (alignment & (alignment - 1)) == 0);
91 void *p = NULL;
92 int e = posix_memalign(&p, alignment, size);
93 return (e ? NULL : p);
94 }
95
96 void ojph_aligned_free(void* pointer)
97 {
98 free(pointer);
99 }
100#else
101 void* ojph_aligned_malloc(size_t alignment, size_t size)
102 {
103 assert(alignment != 0 && (alignment & (alignment - 1)) == 0);
104
105 // emulate aligned_alloc
106 void* orig_ptr = malloc(size + alignment + sizeof(void*));
107 if (orig_ptr == NULL)
108 return NULL; // Allocation failed
109
110 uintptr_t start_of_mem = (uintptr_t)orig_ptr + sizeof(void*);
111 uintptr_t aligned_addr = (start_of_mem + alignment - 1) & ~(alignment - 1);
112
113 void** ptr_to_orig_ptr = (void**)aligned_addr;
114 ptr_to_orig_ptr[-1] = orig_ptr;
115
116 return (void*)aligned_addr;
117 }
118
119 void ojph_aligned_free(void* pointer)
120 {
121 if (pointer) {
122 // Retrieve the original pointer stored just before aligned pointer
123 void** ptr_to_orig_ptr = (void**)pointer;
124 void* orig_ptr = ptr_to_orig_ptr[-1];
125
126 free(orig_ptr);
127 }
128 }
129#endif
OJPH_EXPORT
#define OJPH_EXPORT
Definition ojph_arch.h:144
ojph_aligned_malloc
void * ojph_aligned_malloc(size_t alignment, size_t size)
Definition ojph_mem_c.c:101
ojph_aligned_free
void ojph_aligned_free(void *pointer)
Definition ojph_mem_c.c:119