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