update Intel copyright years to 2014
[dpdk.git] / lib / librte_eal / linuxapp / eal / include / exec-env / rte_lcore.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_LCORE_H_
35 #error "don't include this file directly, please include generic <rte_lcore.h>"
36 #endif
37
38 #ifndef _RTE_LINUXAPP_LCORE_H_
39 #define _RTE_LINUXAPP_LCORE_H_
40
41 /**
42  * @file
43  * API for lcore and socket manipulation in linuxapp environment
44  */
45
46 /**
47  * structure storing internal configuration (per-lcore)
48  */
49 struct lcore_config {
50         unsigned detected;         /**< true if lcore was detected */
51         pthread_t thread_id;       /**< pthread identifier */
52         int pipe_master2slave[2];  /**< communication pipe with master */
53         int pipe_slave2master[2];  /**< communication pipe with master */
54         lcore_function_t * volatile f;         /**< function to call */
55         void * volatile arg;       /**< argument of function */
56         volatile int ret;          /**< return value of function */
57         volatile enum rte_lcore_state_t state; /**< lcore state */
58         unsigned socket_id;        /**< physical socket id for this lcore */
59         unsigned core_id;          /**< core number on socket for this lcore */
60 };
61
62 /**
63  * internal configuration (per-lcore)
64  */
65 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
66
67 #endif /* _RTE_LINUXAPP_LCORE_H_ */