PolarSSL v1.3.9
Macros | Functions
memory_buffer_alloc.h File Reference

Buffer-based memory allocator. More...

#include "config.h"
#include <stdlib.h>
Include dependency graph for memory_buffer_alloc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MEMORY_VERIFY_NONE   0
 
#define MEMORY_VERIFY_ALLOC   (1 << 0)
 
#define MEMORY_VERIFY_FREE   (1 << 1)
 
#define MEMORY_VERIFY_ALWAYS   (MEMORY_VERIFY_ALLOC | MEMORY_VERIFY_FREE)
 
SECTION: Module settings

The configuration options you can set for this module are in this section.

Either change them in config.h or define them on the compiler command line.

#define POLARSSL_MEMORY_ALIGN_MULTIPLE   4
 Align on multiples of this value.
 

Functions

int memory_buffer_alloc_init (unsigned char *buf, size_t len)
 Initialize use of stack-based memory allocator.
 
void memory_buffer_alloc_free (void)
 Free the mutex for thread-safety and clear remaining memory.
 
void memory_buffer_set_verify (int verify)
 Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data.
 
int memory_buffer_alloc_verify (void)
 Verifies that all headers in the memory buffer are correct and contain sane values.
 

Detailed Description

Buffer-based memory allocator.

Copyright (C) 2006-2014, Brainspark B.V.

This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>

All rights reserved.

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 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-1301 USA.

Definition in file memory_buffer_alloc.h.

Macro Definition Documentation

#define MEMORY_VERIFY_ALLOC   (1 << 0)

Definition at line 53 of file memory_buffer_alloc.h.

#define MEMORY_VERIFY_ALWAYS   (MEMORY_VERIFY_ALLOC | MEMORY_VERIFY_FREE)

Definition at line 55 of file memory_buffer_alloc.h.

#define MEMORY_VERIFY_FREE   (1 << 1)

Definition at line 54 of file memory_buffer_alloc.h.

#define MEMORY_VERIFY_NONE   0

Definition at line 52 of file memory_buffer_alloc.h.

#define POLARSSL_MEMORY_ALIGN_MULTIPLE   4

Align on multiples of this value.

Definition at line 47 of file memory_buffer_alloc.h.

Function Documentation

void memory_buffer_alloc_free ( void  )

Free the mutex for thread-safety and clear remaining memory.

Referenced by main().

int memory_buffer_alloc_init ( unsigned char *  buf,
size_t  len 
)

Initialize use of stack-based memory allocator.

     The stack-based allocator does memory management inside the
     presented buffer and does not call malloc() and free().
     It sets the global polarssl_malloc() and polarssl_free() pointers
     to its own functions.
     (Provided polarssl_malloc() and polarssl_free() are thread-safe if
      POLARSSL_THREADING_C is defined)
Note
This code is not optimized and provides a straight-forward implementation of a stack-based memory allocator.
Parameters
bufbuffer to use as heap
lensize of the buffer
Returns
0 if successful

Referenced by main().

int memory_buffer_alloc_verify ( void  )

Verifies that all headers in the memory buffer are correct and contain sane values.

Helps debug buffer-overflow errors.

    Prints out first failure if POLARSSL_MEMORY_DEBUG is defined.
    Prints out full header information if POLARSSL_MEMORY_DEBUG_HEADERS
    is defined. (Includes stack trace information for each block if
    POLARSSL_MEMORY_BACKTRACE is defined as well).
Returns
0 if verified, 1 otherwise
void memory_buffer_set_verify ( int  verify)

Determine when the allocator should automatically verify the state of the entire chain of headers / meta-data.

     (Default: MEMORY_VERIFY_NONE)
Parameters
verifyOne of MEMORY_VERIFY_NONE, MEMORY_VERIFY_ALLOC, MEMORY_VERIFY_FREE or MEMORY_VERIFY_ALWAYS