blob: 173491dc3a4eff2092944ed9d0c51fd837aa1cf2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file longBow_Memory.c
* @ingroup internal
* @brief Memory allocation and deallocation support.
*
*/
#ifndef LongBow_longBow_Memory_h
#define LongBow_longBow_Memory_h
#include <stdint.h>
/**
* Allocate `size` bytes of memory.
*
* @param [in] size The number of bytes to allocate
*
* @return non-NULL A pointer to allocated memory that must be deallocated via `longBowMemory_Deallocate`
* @return NULL Memory could not be allocated.
* @see longBowMemory_Deallocate
*/
void *longBowMemory_Allocate(const size_t size);
/**
* Reallocate memory adjusting to a new size.
*
* @param [in] oldAllocation A pointer to memory previously allocated by `longBowMemory_Allocate` or `longBowMemory_Reallocate`
* @param [in] newSize The number of bytes to allocate
*
* @return non-NULL A pointer to allocated memory that must be deallocated via `longBowMemory_Deallocate`
* @return NULL Memory could not be allocated.
* @see longBowMemory_Allocate
*/
void *longBowMemory_Reallocate(void *oldAllocation, const size_t newSize);
/**
* Deallocate previously allocated memory.
*
* @param [in,out] pointerPointer A pointer to a pointer to allocated memory that will set to NULL.
*
* @see longBowMemory_Allocate
*/
void longBowMemory_Deallocate(void **pointerPointer);
/**
* Duplicate a nul-terminated C string in allocated memory.
*
* @param [in] string The nul-terminated string to duplicate
*
* @return non-NULL A pointer to allocated memory that must be deallocated via `longBowMemory_Deallocate`
* @return NULL Memory could not be allocated.
*
* Example:
* @code
* {
* char *copy = longBowMemory_StringCopy("Hello World");
*
* longBowMemory_Deallocate((void **) ©);
* }
* @endcode
*
* @see longBowMemory_Deallocate
*/
char *longBowMemory_StringCopy(const char *string);
/**
* Get the count of outstanding memory allocations.
*
* @return The number of outstanding memory allocations.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*/
uint64_t longBowMemory_OutstandingAllocations(void);
#endif
|
