rte_malloc.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_MALLOC_H_
#define _RTE_MALLOC_H_

#include <stdio.h>
#include <stddef.h>
#include <rte_memory.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_malloc_socket_stats {
    size_t heap_totalsz_bytes; 
    size_t heap_freesz_bytes;  
    size_t greatest_free_size; 
    unsigned free_count;       
    unsigned alloc_count;      
    size_t heap_allocsz_bytes; 
};

void *
rte_malloc(const char *type, size_t size, unsigned align);

void *
rte_zmalloc(const char *type, size_t size, unsigned align);

void *
rte_calloc(const char *type, size_t num, size_t size, unsigned align);

void *
rte_realloc(void *ptr, size_t size, unsigned align);

void *
rte_malloc_socket(const char *type, size_t size, unsigned align, int socket);

void *
rte_zmalloc_socket(const char *type, size_t size, unsigned align, int socket);

void *
rte_calloc_socket(const char *type, size_t num, size_t size, unsigned align, int socket);

void
rte_free(void *ptr);

int
rte_malloc_validate(const void *ptr, size_t *size);

int
rte_malloc_get_socket_stats(int socket,
        struct rte_malloc_socket_stats *socket_stats);

void
rte_malloc_dump_stats(FILE *f, const char *type);

int
rte_malloc_set_limit(const char *type, size_t max);

rte_iova_t
rte_malloc_virt2iova(const void *addr);

__rte_deprecated
static inline phys_addr_t
rte_malloc_virt2phy(const void *addr)
{
    return rte_malloc_virt2iova(addr);
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_MALLOC_H_ */