first public release
[dpdk.git] / lib / librte_eal / linuxapp / eal / include / exec-env / rte_per_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_PER_LCORE_H_
37 #error "don't include this file directly, please include generic <rte_per_lcore.h>"
38 #endif
39
40 #ifndef _RTE_LINUXAPP_PER_LCORE_H_
41 #define _RTE_LINUXAPP_PER_LCORE_H_
42
43 /**
44  * @file
45  * Per-lcore variables in RTE on linuxapp environment
46  */
47
48 #include <pthread.h>
49
50 /**
51  * Macro to define a per lcore variable "var" of type "type", don't
52  * use keywords like "static" or "volatile" in type, just prefix the
53  * whole macro.
54  */
55 #define RTE_DEFINE_PER_LCORE(type, name)                        \
56         __thread __typeof__(type) per_lcore_##name
57
58 /**
59  * Macro to declare an extern per lcore variable "var" of type "type"
60  */
61 #define RTE_DECLARE_PER_LCORE(type, name)                       \
62         extern __thread __typeof__(type) per_lcore_##name
63
64 /**
65  * Read/write the per-lcore variable value
66  */
67 #define RTE_PER_LCORE(name) (per_lcore_##name)
68
69 #endif /* _RTE_LINUXAPP_PER_LCORE_H_ */