1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
24 // The purpose of this module is to allow custom dynamic memory allocation
25 // code to easily be added to the TB Stack by redefining the OICMalloc and
26 // OICFree functions. Examples of when this might be needed are on TB
27 // platforms that do not support dynamic allocation or if a memory pool
30 // Note that these functions are intended to be used ONLY within the TB
31 // stack and NOT by the application code. The application should be
32 // responsible for its own dynamic allocation.
34 //-----------------------------------------------------------------------------
36 //-----------------------------------------------------------------------------
43 //-----------------------------------------------------------------------------
45 //-----------------------------------------------------------------------------
47 //-----------------------------------------------------------------------------
49 //-----------------------------------------------------------------------------
51 //-----------------------------------------------------------------------------
52 // Function prototypes
53 //-----------------------------------------------------------------------------
56 * Allocates a block of size bytes, returning a pointer to the beginning of
57 * the allocated block.
59 * NOTE: This function is intended to be used internally by the TB Stack.
60 * It is not intended to be used by applications.
62 * @param size - Size of the memory block in bytes, where size > 0
65 * on success, a pointer to the allocated memory block
66 * on failure, a null pointer is returned
68 void *OICMalloc(size_t size);
71 * Re-allocates a block of memory, pointed to by ptr to the size specified
72 * in size. The returned value contains a pointer to the new location, with
73 * all data copied into it. If the new size of the memory-object require movement,
74 * the previous space is freed. If the new size is larger, the newly allocated
75 * area has non-deterministic content. If the space cannot be allocated, the value
76 * ptr is left unchanged.
78 * @param ptr - Pointer to a block of memory previously allocated by OICCalloc,
79 * OICMalloc, or a previous call to this function. If this value is
80 * NULL, this function will work identically to a call to OICMalloc.
82 * @param size - Size of the new memory block in bytes, where size > 0
85 * on success, a pointer to the newly sized memory block
86 * on failure, a null pointer is returned, and the memory pointed to by *ptr is untouched
88 void *OICRealloc(void *ptr, size_t size);
91 * Allocates a block of memory for an array of num elements, each of them
92 * size bytes long and initializes all its bits to zero.
94 * @param num - The number of elements
95 * @param size - Size of the element type in bytes, where size > 0
98 * on success, a pointer to the allocated memory block
99 * on failure, a null pointer is returned
101 void *OICCalloc(size_t num, size_t size);
104 * Deallocate a block of memory previously allocated by a call to OCMalloc
106 * NOTE: This function is intended to be used internally by the TB Stack.
107 * It is not intended to be used by applications.
109 * @param ptr - Pointer to block of memory previously allocated by OICMalloc.
110 * If ptr is a null pointer, the function does nothing.
112 void OICFree(void *ptr);
116 #endif // __cplusplus
117 #endif /* OIC_MALLOC_H_ */