rockbox/firmware/include/core_alloc.h
Aidan MacDonald add06955a2 firmware: add copyright headers to core_alloc.c/h
These files have been missing copyright headers since
they were added in comit d0b72e2590 ("GSoC/Buflib:
Add buflib memory alocator to the core.").

Thomas Martitz seems to be the original author, which
is documented in the commit metadata and backed up by
emails from the rockbox-dev archive, for example [1].

[1]: https://www.rockbox.org/mail/archive/rockbox-dev-archive-2011-08/0000.shtml

Change-Id: Id1a3abd4975674ffbc6f7e9123ee57d49bcaa38e
2026-03-09 10:26:18 +00:00

86 lines
2.9 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2011 Thomas Martitz
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef __CORE_ALLOC_H__
#define __CORE_ALLOC_H__
#include <string.h>
#include <stdbool.h>
#include "config.h"
#include "buflib.h"
#include "chunk_alloc.h"
/* All functions below are wrappers for functions in buflib.h, except
* they have a predefined context
*/
void core_allocator_init(void) INIT_ATTR;
int core_alloc(size_t size);
int core_alloc_ex(size_t size, struct buflib_callbacks *ops);
int core_alloc_maximum(size_t *size, struct buflib_callbacks *ops);
bool core_shrink(int handle, void* new_start, size_t new_size);
void core_pin(int handle);
void core_unpin(int handle);
unsigned core_pin_count(int handle);
int core_free(int handle);
size_t core_available(void);
size_t core_allocatable(void);
#ifdef BUFLIB_DEBUG_CHECK_VALID
void core_check_valid(void);
#endif
/* DO NOT ADD wrappers for buflib_buffer_out/in. They do not call
* the move callbacks and are therefore unsafe in the core */
#ifdef BUFLIB_DEBUG_PRINT
int core_get_num_blocks(void);
bool core_print_block_at(int block_num, char* buf, size_t bufsize);
/* frees the debug test alloc created at initialization,
* since this is the first any further alloc should force a compaction run
* only used if debug print is active */
bool core_test_free(void);
#endif
static inline void* core_get_data(int handle)
{
extern struct buflib_context core_ctx;
return buflib_get_data(&core_ctx, handle);
}
static inline void* core_get_data_pinned(int handle)
{
extern struct buflib_context core_ctx;
return buflib_get_data_pinned(&core_ctx, handle);
}
static inline void core_put_data_pinned(void *data)
{
extern struct buflib_context core_ctx;
buflib_put_data_pinned(&core_ctx, data);
}
/* core context chunk_alloc */
static inline bool core_chunk_alloc_init(struct chunk_alloc_header *hdr,
size_t chunk_size, size_t max_chunks)
{
extern struct buflib_context core_ctx;
return chunk_alloc_init(hdr, &core_ctx, chunk_size, max_chunks);
}
#endif /* __CORE_ALLOC_H__ */