mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 20:12:31 +01:00
347 lines
12 KiB
C
347 lines
12 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 1994, 2016, Oracle and/or its affiliates. All Rights Reserved.
|
|
Copyright (c) 2017, 2019, MariaDB Corporation.
|
|
|
|
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; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/**************************************************//**
|
|
@file include/mem0mem.h
|
|
The memory management
|
|
|
|
Created 6/9/1994 Heikki Tuuri
|
|
*******************************************************/
|
|
|
|
#ifndef mem0mem_h
|
|
#define mem0mem_h
|
|
|
|
#include "ut0mem.h"
|
|
#include "ut0rnd.h"
|
|
#include "mach0data.h"
|
|
|
|
#include <memory>
|
|
|
|
/* -------------------- MEMORY HEAPS ----------------------------- */
|
|
|
|
/** A block of a memory heap consists of the info structure
|
|
followed by an area of memory */
|
|
typedef struct mem_block_info_t mem_block_t;
|
|
|
|
/** A memory heap is a nonempty linear list of memory blocks */
|
|
typedef mem_block_t mem_heap_t;
|
|
|
|
/** Types of allocation for memory heaps: DYNAMIC means allocation from the
|
|
dynamic memory pool of the C compiler, BUFFER means allocation from the
|
|
buffer pool; the latter method is used for very big heaps */
|
|
|
|
#define MEM_HEAP_DYNAMIC 0 /* the most common type */
|
|
#define MEM_HEAP_BUFFER 1
|
|
#define MEM_HEAP_BTR_SEARCH 2 /* this flag can optionally be
|
|
ORed to MEM_HEAP_BUFFER, in which
|
|
case heap->free_block is used in
|
|
some cases for memory allocations,
|
|
and if it's NULL, the memory
|
|
allocation functions can return
|
|
NULL. */
|
|
|
|
/** Different type of heaps in terms of which datastructure is using them */
|
|
#define MEM_HEAP_FOR_BTR_SEARCH (MEM_HEAP_BTR_SEARCH | MEM_HEAP_BUFFER)
|
|
#define MEM_HEAP_FOR_PAGE_HASH (MEM_HEAP_DYNAMIC)
|
|
#define MEM_HEAP_FOR_RECV_SYS (MEM_HEAP_BUFFER)
|
|
#define MEM_HEAP_FOR_LOCK_HEAP (MEM_HEAP_BUFFER)
|
|
|
|
/** The following start size is used for the first block in the memory heap if
|
|
the size is not specified, i.e., 0 is given as the parameter in the call of
|
|
create. The standard size is the maximum (payload) size of the blocks used for
|
|
allocations of small buffers. */
|
|
|
|
#define MEM_BLOCK_START_SIZE 64
|
|
#define MEM_BLOCK_STANDARD_SIZE \
|
|
(srv_page_size >= 16384 ? 8000 : MEM_MAX_ALLOC_IN_BUF)
|
|
|
|
/** If a memory heap is allowed to grow into the buffer pool, the following
|
|
is the maximum size for a single allocated buffer: */
|
|
#define MEM_MAX_ALLOC_IN_BUF (srv_page_size - 200 + REDZONE_SIZE)
|
|
|
|
/** Space needed when allocating for a user a field of length N.
|
|
The space is allocated only in multiples of UNIV_MEM_ALIGNMENT. */
|
|
#define MEM_SPACE_NEEDED(N) UT_CALC_ALIGN((N), UNIV_MEM_ALIGNMENT)
|
|
|
|
#ifdef UNIV_DEBUG
|
|
/** Macro for memory heap creation.
|
|
@param[in] size Desired start block size. */
|
|
# define mem_heap_create(size) \
|
|
mem_heap_create_func((size), __FILE__, __LINE__, MEM_HEAP_DYNAMIC)
|
|
|
|
/** Macro for memory heap creation.
|
|
@param[in] size Desired start block size.
|
|
@param[in] type Heap type */
|
|
# define mem_heap_create_typed(size, type) \
|
|
mem_heap_create_func((size), __FILE__, __LINE__, (type))
|
|
|
|
#else /* UNIV_DEBUG */
|
|
/** Macro for memory heap creation.
|
|
@param[in] size Desired start block size. */
|
|
# define mem_heap_create(size) mem_heap_create_func((size), MEM_HEAP_DYNAMIC)
|
|
|
|
/** Macro for memory heap creation.
|
|
@param[in] size Desired start block size.
|
|
@param[in] type Heap type */
|
|
# define mem_heap_create_typed(size, type) \
|
|
mem_heap_create_func((size), (type))
|
|
|
|
#endif /* UNIV_DEBUG */
|
|
|
|
/** Creates a memory heap.
|
|
NOTE: Use the corresponding macros instead of this function.
|
|
A single user buffer of 'size' will fit in the block.
|
|
0 creates a default size block.
|
|
@param[in] size Desired start block size.
|
|
@param[in] file_name File name where created
|
|
@param[in] line Line where created
|
|
@param[in] type Heap type
|
|
@return own: memory heap, NULL if did not succeed (only possible for
|
|
MEM_HEAP_BTR_SEARCH type heaps) */
|
|
UNIV_INLINE
|
|
mem_heap_t*
|
|
mem_heap_create_func(
|
|
ulint size,
|
|
#ifdef UNIV_DEBUG
|
|
const char* file_name,
|
|
unsigned line,
|
|
#endif /* UNIV_DEBUG */
|
|
ulint type);
|
|
|
|
/** Frees the space occupied by a memory heap.
|
|
NOTE: Use the corresponding macro instead of this function.
|
|
@param[in] heap Heap to be freed */
|
|
UNIV_INLINE
|
|
void
|
|
mem_heap_free(
|
|
mem_heap_t* heap);
|
|
|
|
/** Allocates and zero-fills n bytes of memory from a memory heap.
|
|
@param[in] heap memory heap
|
|
@param[in] n number of bytes; if the heap is allowed to grow into
|
|
the buffer pool, this must be <= MEM_MAX_ALLOC_IN_BUF
|
|
@return allocated, zero-filled storage */
|
|
UNIV_INLINE
|
|
void*
|
|
mem_heap_zalloc(
|
|
mem_heap_t* heap,
|
|
ulint n);
|
|
|
|
/** Allocates n bytes of memory from a memory heap.
|
|
@param[in] heap memory heap
|
|
@param[in] n number of bytes; if the heap is allowed to grow into
|
|
the buffer pool, this must be <= MEM_MAX_ALLOC_IN_BUF
|
|
@return allocated storage, NULL if did not succeed (only possible for
|
|
MEM_HEAP_BTR_SEARCH type heaps) */
|
|
UNIV_INLINE
|
|
void*
|
|
mem_heap_alloc(
|
|
mem_heap_t* heap,
|
|
ulint n);
|
|
|
|
/** Returns a pointer to the heap top.
|
|
@param[in] heap memory heap
|
|
@return pointer to the heap top */
|
|
UNIV_INLINE
|
|
byte*
|
|
mem_heap_get_heap_top(
|
|
mem_heap_t* heap);
|
|
|
|
/** Frees the space in a memory heap exceeding the pointer given.
|
|
The pointer must have been acquired from mem_heap_get_heap_top.
|
|
The first memory block of the heap is not freed.
|
|
@param[in] heap heap from which to free
|
|
@param[in] old_top pointer to old top of heap */
|
|
UNIV_INLINE
|
|
void
|
|
mem_heap_free_heap_top(
|
|
mem_heap_t* heap,
|
|
byte* old_top);
|
|
|
|
/** Empties a memory heap.
|
|
The first memory block of the heap is not freed.
|
|
@param[in] heap heap to empty */
|
|
UNIV_INLINE
|
|
void
|
|
mem_heap_empty(
|
|
mem_heap_t* heap);
|
|
|
|
/** Returns a pointer to the topmost element in a memory heap.
|
|
The size of the element must be given.
|
|
@param[in] heap memory heap
|
|
@param[in] n size of the topmost element
|
|
@return pointer to the topmost element */
|
|
UNIV_INLINE
|
|
void*
|
|
mem_heap_get_top(
|
|
mem_heap_t* heap,
|
|
ulint n);
|
|
|
|
/*****************************************************************//**
|
|
Frees the topmost element in a memory heap.
|
|
The size of the element must be given. */
|
|
UNIV_INLINE
|
|
void
|
|
mem_heap_free_top(
|
|
/*==============*/
|
|
mem_heap_t* heap, /*!< in: memory heap */
|
|
ulint n); /*!< in: size of the topmost element */
|
|
/*****************************************************************//**
|
|
Returns the space in bytes occupied by a memory heap. */
|
|
UNIV_INLINE
|
|
ulint
|
|
mem_heap_get_size(
|
|
/*==============*/
|
|
mem_heap_t* heap); /*!< in: heap */
|
|
|
|
/**********************************************************************//**
|
|
Duplicates a NUL-terminated string.
|
|
@return own: a copy of the string, must be deallocated with ut_free */
|
|
UNIV_INLINE
|
|
char*
|
|
mem_strdup(
|
|
/*=======*/
|
|
const char* str); /*!< in: string to be copied */
|
|
/**********************************************************************//**
|
|
Makes a NUL-terminated copy of a nonterminated string.
|
|
@return own: a copy of the string, must be deallocated with ut_free */
|
|
UNIV_INLINE
|
|
char*
|
|
mem_strdupl(
|
|
/*========*/
|
|
const char* str, /*!< in: string to be copied */
|
|
ulint len); /*!< in: length of str, in bytes */
|
|
|
|
/** Duplicate a block of data, allocated from a memory heap.
|
|
@param[in] heap memory heap where string is allocated
|
|
@param[in] data block of data to be copied
|
|
@param[in] len length of data, in bytes
|
|
@return own: a copy of data */
|
|
inline
|
|
void*
|
|
mem_heap_dup(mem_heap_t* heap, const void* data, size_t len)
|
|
{
|
|
ut_ad(data || !len);
|
|
return UNIV_LIKELY(data != NULL)
|
|
? memcpy(mem_heap_alloc(heap, len), data, len)
|
|
: NULL;
|
|
}
|
|
|
|
/** Duplicate a NUL-terminated string, allocated from a memory heap.
|
|
@param[in] heap memory heap where string is allocated
|
|
@param[in] str string to be copied
|
|
@return own: a copy of the string */
|
|
inline
|
|
char*
|
|
mem_heap_strdup(mem_heap_t* heap, const char* str)
|
|
{
|
|
return(static_cast<char*>(mem_heap_dup(heap, str, strlen(str) + 1)));
|
|
}
|
|
|
|
/** Duplicate a string, allocated from a memory heap.
|
|
@param[in] heap memory heap where string is allocated
|
|
@param[in] str string to be copied
|
|
@param[in] len length of str, in bytes
|
|
@return own: a NUL-terminated copy of str */
|
|
inline
|
|
char*
|
|
mem_heap_strdupl(mem_heap_t* heap, const char* str, size_t len)
|
|
{
|
|
char* s = static_cast<char*>(mem_heap_alloc(heap, len + 1));
|
|
s[len] = 0;
|
|
return(static_cast<char*>(memcpy(s, str, len)));
|
|
}
|
|
|
|
/**********************************************************************//**
|
|
Concatenate two strings and return the result, using a memory heap.
|
|
@return own: the result */
|
|
char*
|
|
mem_heap_strcat(
|
|
/*============*/
|
|
mem_heap_t* heap, /*!< in: memory heap where string is allocated */
|
|
const char* s1, /*!< in: string 1 */
|
|
const char* s2); /*!< in: string 2 */
|
|
|
|
/****************************************************************//**
|
|
A simple sprintf replacement that dynamically allocates the space for the
|
|
formatted string from the given heap. This supports a very limited set of
|
|
the printf syntax: types 's' and 'u' and length modifier 'l' (which is
|
|
required for the 'u' type).
|
|
@return heap-allocated formatted string */
|
|
char*
|
|
mem_heap_printf(
|
|
/*============*/
|
|
mem_heap_t* heap, /*!< in: memory heap */
|
|
const char* format, /*!< in: format string */
|
|
...) MY_ATTRIBUTE ((format (printf, 2, 3)));
|
|
|
|
#ifdef UNIV_DEBUG
|
|
/** Validates the contents of a memory heap.
|
|
Asserts that the memory heap is consistent
|
|
@param[in] heap Memory heap to validate */
|
|
void
|
|
mem_heap_validate(
|
|
const mem_heap_t* heap);
|
|
|
|
#endif /* UNIV_DEBUG */
|
|
|
|
/*#######################################################################*/
|
|
|
|
/** The info structure stored at the beginning of a heap block */
|
|
struct mem_block_info_t {
|
|
#ifdef UNIV_DEBUG
|
|
char file_name[8];/* file name where the mem heap was created */
|
|
unsigned line; /*!< line number where the mem heap was created */
|
|
#endif /* UNIV_DEBUG */
|
|
UT_LIST_BASE_NODE_T(mem_block_t) base; /* In the first block in the
|
|
the list this is the base node of the list of blocks;
|
|
in subsequent blocks this is undefined */
|
|
UT_LIST_NODE_T(mem_block_t) list; /* This contains pointers to next
|
|
and prev in the list. The first block allocated
|
|
to the heap is also the first block in this list,
|
|
though it also contains the base node of the list. */
|
|
ulint len; /*!< physical length of this block in bytes */
|
|
ulint total_size; /*!< physical length in bytes of all blocks
|
|
in the heap. This is defined only in the base
|
|
node and is set to ULINT_UNDEFINED in others. */
|
|
ulint type; /*!< type of heap: MEM_HEAP_DYNAMIC, or
|
|
MEM_HEAP_BUF possibly ORed to MEM_HEAP_BTR_SEARCH */
|
|
ulint free; /*!< offset in bytes of the first free position for
|
|
user data in the block */
|
|
ulint start; /*!< the value of the struct field 'free' at the
|
|
creation of the block */
|
|
|
|
void* free_block;
|
|
/* if the MEM_HEAP_BTR_SEARCH bit is set in type,
|
|
and this is the heap root, this can contain an
|
|
allocated buffer frame, which can be appended as a
|
|
free block to the heap, if we need more space;
|
|
otherwise, this is NULL */
|
|
void* buf_block;
|
|
/* if this block has been allocated from the buffer
|
|
pool, this contains the buf_block_t handle;
|
|
otherwise, this is NULL */
|
|
};
|
|
|
|
/* Header size for a memory heap block */
|
|
#define MEM_BLOCK_HEADER_SIZE UT_CALC_ALIGN(sizeof(mem_block_info_t),\
|
|
UNIV_MEM_ALIGNMENT)
|
|
|
|
#include "mem0mem.inl"
|
|
#endif
|