mbuf: use 2 bytes for port and nb segments
[dpdk.git] / lib / librte_eal / linuxapp / eal / include / exec-env / rte_kni_common.h
old mode 100755 (executable)
new mode 100644 (file)
index 012522b..2ac879f
@@ -1,60 +1,59 @@
 /*-
- *   This file is provided under a dual BSD/LGPLv2 license.  When using or \r
- *   redistributing this file, you may do so under either license.\r
- * \r
- *   GNU LESSER GENERAL PUBLIC LICENSE\r
- *                    \r
- *   Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.\r
- * \r
- *   This program is free software; you can redistribute it and/or modify \r
- *   it under the terms of version 2.1 of the GNU Lesser General Public License\r
- *   as published by the Free Software Foundation.\r
- * \r
- *   This program is distributed in the hope that it will be useful, but \r
- *   WITHOUT ANY WARRANTY; without even the implied warranty of \r
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU \r
- *   Lesser General Public License for more details.\r
- * \r
- *   You should have received a copy of the GNU Lesser General Public License \r
- *   along with this program; if not, write to the Free Software \r
- *   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.\r
- * \r
- *   Contact Information:\r
- *   Intel Corporation\r
- * \r
- *   \r
- *   BSD LICENSE\r
- *    \r
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.\r
- *   All rights reserved.\r
- * \r
- *   Redistribution and use in source and binary forms, with or without \r
- *   modification, are permitted provided that the following conditions \r
- *   are met: \r
- *  \r
- *   * Redistributions of source code must retain the above copyright \r
- *     notice, this list of conditions and the following disclaimer.\r
- *   * Redistributions in binary form must reproduce the above copyright \r
- *     notice, this list of conditions and the following disclaimer in \r
- *     the documentation and/or other materials provided with the \r
- *     distribution.\r
- *   * Neither the name of Intel Corporation nor the names of its \r
- *     contributors may be used to endorse or promote products derived \r
- *     from this software without specific prior written permission.\r
- * \r
- *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \r
- *    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \r
- *    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \r
- *    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \r
- *    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \r
- *    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT \r
- *    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, \r
- *    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY \r
- *    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
- *    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
- *    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
- * \r
- * 
+ *   This file is provided under a dual BSD/LGPLv2 license.  When using or
+ *   redistributing this file, you may do so under either license.
+ *
+ *   GNU LESSER GENERAL PUBLIC LICENSE
+ *
+ *   Copyright(c) 2007-2014 Intel Corporation. All rights reserved.
+ *
+ *   This program is free software; you can redistribute it and/or modify
+ *   it under the terms of version 2.1 of the GNU Lesser General Public License
+ *   as published by the Free Software Foundation.
+ *
+ *   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
+ *   Lesser General Public License for more details.
+ *
+ *   You should have received a copy of the GNU Lesser General Public License
+ *   along with this program; if not, write to the Free Software
+ *   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ *   Contact Information:
+ *   Intel Corporation
+ *
+ *
+ *   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_KNI_COMMON_H_
 
 #ifdef __KERNEL__
 #include <linux/if.h>
+#define RTE_STD_C11
+#else
+#include <rte_common.h>
 #endif
 
+/**
+ * KNI name is part of memzone name.
+ */
+#define RTE_KNI_NAMESIZE 32
+
+#define RTE_CACHE_LINE_MIN_SIZE 64
+
 /*
  * Request id.
  */
@@ -79,6 +88,7 @@ enum rte_kni_req_id {
  */
 struct rte_kni_request {
        uint32_t req_id;             /**< Request id */
+       RTE_STD_C11
        union {
                uint32_t new_mtu;    /**< New MTU */
                uint8_t if_up;       /**< 1: interface up, 0: interface down */
@@ -88,7 +98,7 @@ struct rte_kni_request {
 
 /*
  * Fifo struct mapped in a shared memory. It describes a circular buffer FIFO
- * Write and read should wrap arround. Fifo is empty when write == read
+ * Write and read should wrap around. Fifo is empty when write == read
  * Writing should never overwrite the read position
  */
 struct rte_kni_fifo {
@@ -96,7 +106,7 @@ struct rte_kni_fifo {
        volatile unsigned read;      /**< Next position to be read */
        unsigned len;                /**< Circular buffer length */
        unsigned elem_size;          /**< Pointer size - for 32/64 bit OS */
-       void * volatile buffer[0];   /**< The buffer contains mbuf pointers */
+       void *volatile buffer[];     /**< The buffer contains mbuf pointers */
 };
 
 /*
@@ -104,24 +114,29 @@ struct rte_kni_fifo {
  * Padding is necessary to assure the offsets of these fields
  */
 struct rte_kni_mbuf {
+       void *buf_addr __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)));
+       uint64_t buf_physaddr;
+       uint16_t data_off;      /**< Start address of data in segment buffer. */
+       char pad1[2];
+       uint16_t nb_segs;       /**< Number of segments. */
+       char pad4[2];
+       uint64_t ol_flags;      /**< Offload features. */
+       char pad2[4];
+       uint32_t pkt_len;       /**< Total pkt len: sum of all segment data_len. */
+       uint16_t data_len;      /**< Amount of data in segment buffer. */
+
+       /* fields on second cache line */
+       char pad3[8] __attribute__((__aligned__(RTE_CACHE_LINE_MIN_SIZE)));
        void *pool;
-       void *buf_addr;
-       char pad0[14];
-       uint16_t ol_flags;      /**< Offload features. */
        void *next;
-       void *data;             /**< Start address of data in segment buffer. */
-       uint16_t data_len;      /**< Amount of data in segment buffer. */
-       char pad2[2];
-       uint16_t pkt_len;       /**< Total pkt len: sum of all segment data_len. */
-} __attribute__((__aligned__(64)));
+};
 
 /*
  * Struct used to create a KNI device. Passed to the kernel in IOCTL call
  */
 
-struct rte_kni_device_info
-{
-       char name[IFNAMSIZ];
+struct rte_kni_device_info {
+       char name[RTE_KNI_NAMESIZE];  /**< Network device name for KNI */
 
        phys_addr_t tx_phys;
        phys_addr_t rx_phys;
@@ -145,13 +160,20 @@ struct rte_kni_device_info
        uint8_t devid;                /**< Device ID */
        uint8_t function;             /**< Device function. */
 
+       uint16_t group_id;            /**< Group ID */
+       uint32_t core_id;             /**< core ID to bind for kernel thread */
+
+       __extension__
+       uint8_t force_bind : 1;       /**< Flag for kernel thread binding */
+
        /* mbuf size */
        unsigned mbuf_size;
 };
 
 #define KNI_DEVICE "kni"
 
-#define RTE_KNI_IOCTL_TEST   _IOWR(0, 1, int)
-#define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)
+#define RTE_KNI_IOCTL_TEST    _IOWR(0, 1, int)
+#define RTE_KNI_IOCTL_CREATE  _IOWR(0, 2, struct rte_kni_device_info)
+#define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)
 
 #endif /* _RTE_KNI_COMMON_H_ */