rte_memzone.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_MEMZONE_H_
#define _RTE_MEMZONE_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_MEMZONE_2MB            0x00000001   
#define RTE_MEMZONE_1GB            0x00000002   
#define RTE_MEMZONE_16MB           0x00000100   
#define RTE_MEMZONE_16GB           0x00000200   
#define RTE_MEMZONE_256KB          0x00010000   
#define RTE_MEMZONE_256MB          0x00020000   
#define RTE_MEMZONE_512MB          0x00040000   
#define RTE_MEMZONE_4GB            0x00080000   
#define RTE_MEMZONE_SIZE_HINT_ONLY 0x00000004   
struct rte_memzone {

#define RTE_MEMZONE_NAMESIZE 32       
    char name[RTE_MEMZONE_NAMESIZE];  
    phys_addr_t phys_addr;            
    RTE_STD_C11
    union {
        void *addr;                   
        uint64_t addr_64;             
    };
    size_t len;                       
    uint64_t hugepage_sz;             
    int32_t socket_id;                
    uint32_t flags;                   
    uint32_t memseg_id;               
} __attribute__((__packed__));

const struct rte_memzone *rte_memzone_reserve(const char *name,
                          size_t len, int socket_id,
                          unsigned flags);

const struct rte_memzone *rte_memzone_reserve_aligned(const char *name,
            size_t len, int socket_id,
            unsigned flags, unsigned align);

const struct rte_memzone *rte_memzone_reserve_bounded(const char *name,
            size_t len, int socket_id,
            unsigned flags, unsigned align, unsigned bound);

int rte_memzone_free(const struct rte_memzone *mz);

const struct rte_memzone *rte_memzone_lookup(const char *name);

void rte_memzone_dump(FILE *f);

void rte_memzone_walk(void (*func)(const struct rte_memzone *, void *arg),
              void *arg);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_MEMZONE_H_ */