lib/librte_eal/linuxapp/eal/include/exec-env/rte_lcore.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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  *  version: DPDK.L.1.2.3-3
  34  */
  35
  36 #ifndef _RTE_LCORE_H_
  37 #error "don't include this file directly, please include generic <rte_lcore.h>"
  38 #endif
  39
  40 #ifndef _RTE_LINUXAPP_LCORE_H_
  41 #define _RTE_LINUXAPP_LCORE_H_
  42
  43 /**
  44  * @file
  45  * API for lcore and socket manipulation in linuxapp environment
  46  */
  47
  48 /**
  49  * structure storing internal configuration (per-lcore)
  50  */
  51 struct lcore_config {
  52         unsigned detected;         /**< true if lcore was detected */
  53         pthread_t thread_id;       /**< pthread identifier */
  54         int pipe_master2slave[2];  /**< communication pipe with master */
  55         int pipe_slave2master[2];  /**< communication pipe with master */
  56         lcore_function_t * volatile f;         /**< function to call */
  57         void * volatile arg;       /**< argument of function */
  58         volatile int ret;          /**< return value of function */
  59         volatile enum rte_lcore_state_t state; /**< lcore state */
  60         unsigned socket_id;        /**< physical socket id for this lcore */
  61 };
  62
  63 /**
  64  * internal configuration (per-lcore)
  65  */
  66 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
  67
  68 /**
  69  * Return the ID of the physical socket of the logical core we are
  70  * running on.
  71  */
  72 static inline unsigned
  73 rte_socket_id(void)
  74 {
  75         return lcore_config[rte_lcore_id()].socket_id;
  76 }
  77
  78 /**
  79  * Get the ID of the physical socket of the specified lcore
  80  *
  81  * @param lcore_id
  82  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
  83  * @return
  84  *   the ID of lcoreid's physical socket
  85  */
  86 static inline unsigned
  87 rte_lcore_to_socket_id(unsigned lcore_id)
  88 {
  89         return lcore_config[lcore_id].socket_id;
  90 }
  91
  92 #endif /* _RTE_LCORE_H_ */