chpp/include/chpp/memory.h

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * 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.
 */

#ifndef CHPP_MEMORY_H_
#define CHPP_MEMORY_H_

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Allocate memory
 */
void *chppMalloc(const size_t size);

/**
 * Free memory.
 * Note that is is expected that CHPP_FREE_AND_NULLIFY() is used exclusively
 * instead of calling chppFree directly. This would ensure that buf is set to
 * NULL afterwards.
 */
void chppFree(void *ptr);

/**
 * Reallocate memory.
 * Ideally should use realloc() for systems that efficiently support it.
 *
 * Sample implementation for systems that don't support realloc():
 *
 * if (newSize == oldSize) return oldPtr;
 * void *newPtr = NULL;
 * if (newSize == 0) {
 *   free(oldPtr);
 * } else {
 *   newPtr = malloc(newSize);
 *   if (newPtr) {
 *     newPtr = memcpy(newPtr, oldPtr, MIN(oldSize, newSize));
 *     free(oldPtr);
 *   }
 * }
 * return newPtr;
 *
 * TODO: A future enhancement could be to store fragments separately (e.g.
 * linked list) and bubble up all of them
 */
void *chppRealloc(void *oldPtr, const size_t newSize, const size_t oldSize);

#ifdef __cplusplus
}
#endif

#endif  // CHPP_MEMORY_H_