lib/librte_ivshmem/rte_ivshmem.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef RTE_IVSHMEM_H_
  35 #define RTE_IVSHMEM_H_
  36
  37 #include <rte_memzone.h>
  38 #include <rte_mempool.h>
  39
  40 /**
  41  * @file
  42  *
  43  * The RTE IVSHMEM interface provides functions to create metadata files
  44  * describing memory segments to be shared via QEMU IVSHMEM.
  45  */
  46
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 #define IVSHMEM_MAGIC           0x0BADC0DE
  53 #define IVSHMEM_NAME_LEN        32
  54
  55 /**
  56  * Structure that holds IVSHMEM shared metadata entry.
  57  */
  58 struct rte_ivshmem_metadata_entry {
  59         struct rte_memzone mz;  /**< shared memzone */
  60         uint64_t offset;        /**< offset of memzone within IVSHMEM device */
  61 };
  62
  63 /**
  64  * Structure that holds IVSHMEM metadata.
  65  */
  66 struct rte_ivshmem_metadata {
  67         int magic_number;                               /**< magic number */
  68         char name[IVSHMEM_NAME_LEN];    /**< name of the metadata file */
  69         struct rte_ivshmem_metadata_entry entry[RTE_LIBRTE_IVSHMEM_MAX_ENTRIES];
  70                         /**< metadata entries */
  71 };
  72
  73 /**
  74  * Creates metadata file with a given name
  75  *
  76  * @param name
  77  *  Name of metadata file to be created
  78  *
  79  * @return
  80  *  - On success, zero
  81  *  - On failure, a negative value
  82  */
  83 int rte_ivshmem_metadata_create(const char * name);
  84
  85 /**
  86  * Adds memzone to a specific metadata file
  87  *
  88  * @param mz
  89  *  Memzone to be added
  90  * @param md_name
  91  *  Name of metadata file for the memzone to be added to
  92  *
  93  * @return
  94  *  - On success, zero
  95  *  - On failure, a negative value
  96  */
  97 int rte_ivshmem_metadata_add_memzone(const struct rte_memzone * mz,
  98                 const char * md_name);
  99
 100 /**
 101  * Adds a ring descriptor to a specific metadata file
 102  *
 103  * @param r
 104  *  Ring descriptor to be added
 105  * @param md_name
 106  *  Name of metadata file for the ring to be added to
 107  *
 108  * @return
 109  *  - On success, zero
 110  *  - On failure, a negative value
 111  */
 112 int rte_ivshmem_metadata_add_ring(const struct rte_ring * r,
 113                 const char * md_name);
 114
 115 /**
 116  * Adds a mempool to a specific metadata file
 117  *
 118  * @param mp
 119  *  Mempool to be added
 120  * @param md_name
 121  *  Name of metadata file for the mempool to be added to
 122  *
 123  * @return
 124  *  - On success, zero
 125  *  - On failure, a negative value
 126  */
 127 int rte_ivshmem_metadata_add_mempool(const struct rte_mempool * mp,
 128                 const char * md_name);
 129
 130
 131 /**
 132  * Generates the QEMU command-line for IVSHMEM device for a given metadata file.
 133  * This function is to be called after all the objects were added.
 134  *
 135  * @param buffer
 136  *  Buffer to be filled with the command line arguments.
 137  * @param size
 138  *  Size of the buffer.
 139  * @param name
 140  *  Name of metadata file to generate QEMU command-line parameters for
 141  *
 142  * @return
 143  *  - On success, zero
 144  *  - On failure, a negative value
 145  */
 146 int rte_ivshmem_metadata_cmdline_generate(char *buffer, unsigned size,
 147                 const char *name);
 148
 149
 150 /**
 151  * Dump all metadata entries from a given metadata file to the console.
 152  *
 153  * @name
 154  *  Name of the metadata file to be dumped to console.
 155  */
 156 void rte_ivshmem_metadata_dump(const char *name);
 157
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif
 162
 163 #endif /* RTE_IVSHMEM_H_ */