Akos Kiss
9aca0086b9
Fixed doc comments issues:
* Fixed mistyped param doc comments (`/**<` is OK, `/** <` is not).
* Put special characters (e.g., pipe, backslash, etc.) in quotes, as they can
confuse doxygen and it will print lots of various warnings. For the sake of
completeness and consistent style, also quote some special characters in
re-bytecode.h
* Added missing `@{`s, removed extra `@}`s.
* Turned `/*` comments to `/**<` doc comments.
Ensured same style for doc groups everywhere:
* Where `\addtogroup`, `@{`, and `@}` doxygen commands are used, the order to be
followed is: license, `#ifndef` guards (in headers), includes, `\addtogroup`
and `@{`, main code content, `@}`, `#endif` guards (in headers).
* Multiple `\addtogroup`s or multiple `@}`s should be in the same doc comment.
* First `\addtogroup` should be on the very first line of a doc comment, i.e.,
`/** \addtogroup`.
JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
126 lines
3.4 KiB
C
126 lines
3.4 KiB
C
/* Copyright 2014-2016 Samsung Electronics Co., Ltd.
|
|
* Copyright 2016 University of Szeged.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* Heap allocator interface
|
|
*/
|
|
#ifndef MEM_HEAP_H
|
|
#define MEM_HEAP_H
|
|
|
|
#include "jrt.h"
|
|
|
|
/** \addtogroup mem Memory allocation
|
|
* @{
|
|
*
|
|
* \addtogroup heap Heap
|
|
* @{
|
|
*/
|
|
|
|
extern void mem_heap_init (void);
|
|
extern void mem_heap_finalize (void);
|
|
extern void *mem_heap_alloc_block (const size_t);
|
|
extern void mem_heap_free_block (void *, const size_t);
|
|
extern void *mem_heap_alloc_block_store_size (size_t);
|
|
extern void mem_heap_free_block_size_stored (void *);
|
|
extern uintptr_t mem_heap_compress_pointer (const void *);
|
|
extern void *mem_heap_decompress_pointer (uintptr_t);
|
|
extern bool mem_is_heap_pointer (const void *);
|
|
|
|
#ifdef MEM_STATS
|
|
/**
|
|
* Heap memory usage statistics
|
|
*/
|
|
typedef struct
|
|
{
|
|
size_t size; /**< size */
|
|
|
|
size_t allocated_bytes; /**< currently allocated bytes */
|
|
size_t peak_allocated_bytes; /**< peak allocated bytes */
|
|
size_t global_peak_allocated_bytes; /**< non-resettable peak allocated bytes */
|
|
|
|
size_t waste_bytes; /**< bytes waste due to blocks filled partially
|
|
and due to block headers */
|
|
size_t peak_waste_bytes; /**< peak bytes waste */
|
|
size_t global_peak_waste_bytes; /**< non-resettable peak bytes waste */
|
|
|
|
size_t skip_count;
|
|
size_t nonskip_count;
|
|
|
|
size_t alloc_count;
|
|
size_t alloc_iter_count;
|
|
|
|
size_t free_count;
|
|
size_t free_iter_count;
|
|
} mem_heap_stats_t;
|
|
|
|
extern void mem_heap_get_stats (mem_heap_stats_t *);
|
|
extern void mem_heap_stats_reset_peak (void);
|
|
extern void mem_heap_stats_print (void);
|
|
#endif /* MEM_STATS */
|
|
|
|
#ifdef JERRY_VALGRIND_FREYA
|
|
|
|
#ifdef JERRY_VALGRIND
|
|
#error Valgrind and valgrind-freya modes are not compatible.
|
|
#endif
|
|
|
|
extern void mem_heap_valgrind_freya_mempool_request (void);
|
|
|
|
#define MEM_HEAP_VALGRIND_FREYA_MEMPOOL_REQUEST() mem_heap_valgrind_freya_mempool_request ()
|
|
|
|
#else /* JERRY_VALGRIND_FREYA */
|
|
|
|
#define MEM_HEAP_VALGRIND_FREYA_MEMPOOL_REQUEST()
|
|
|
|
#endif /* JERRY_VALGRIND_FREYA */
|
|
|
|
/**
|
|
* Define a local array variable and allocate memory for the array on the heap.
|
|
*
|
|
* If requested number of elements is zero, assign NULL to the variable.
|
|
*
|
|
* Warning:
|
|
* if there is not enough memory on the heap, shutdown engine with ERR_OUT_OF_MEMORY.
|
|
*/
|
|
#define MEM_DEFINE_LOCAL_ARRAY(var_name, number, type) \
|
|
{ \
|
|
size_t var_name ## ___size = (size_t) (number) * sizeof (type); \
|
|
type *var_name = (type *) (mem_heap_alloc_block (var_name ## ___size));
|
|
|
|
/**
|
|
* Free the previously defined local array variable, freeing corresponding block on the heap,
|
|
* if it was allocated (i.e. if the array's size was non-zero).
|
|
*/
|
|
#define MEM_FINALIZE_LOCAL_ARRAY(var_name) \
|
|
if (var_name != NULL) \
|
|
{ \
|
|
JERRY_ASSERT (var_name ## ___size != 0); \
|
|
\
|
|
mem_heap_free_block (var_name, var_name ## ___size); \
|
|
} \
|
|
else \
|
|
{ \
|
|
JERRY_ASSERT (var_name ## ___size == 0); \
|
|
} \
|
|
}
|
|
|
|
/**
|
|
* @}
|
|
* @}
|
|
*/
|
|
|
|
#endif /* !MEM_HEAP_H */
|