New upstream version 17.11.1
[deb_dpdk.git] / lib / librte_table / rte_lru.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 __INCLUDE_RTE_LRU_H__
35 #define __INCLUDE_RTE_LRU_H__
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 #include <rte_config.h>
42 #ifdef RTE_ARCH_X86_64
43 #include "rte_lru_x86.h"
44 #elif defined(RTE_ARCH_ARM64)
45 #include "rte_lru_arm64.h"
46 #else
47 #undef RTE_TABLE_HASH_LRU_STRATEGY
48 #define RTE_TABLE_HASH_LRU_STRATEGY                        1
49 #endif
50
51 #if RTE_TABLE_HASH_LRU_STRATEGY == 0
52
53 #define lru_init(bucket)                                                \
54 do                                                                      \
55         bucket = bucket;                                                \
56 while (0)
57
58 #define lru_pos(bucket) (bucket->lru_list & 0xFFFFLLU)
59
60 #define lru_update(bucket, mru_val)                                     \
61 do {                                                                    \
62         bucket = bucket;                                                \
63         mru_val = mru_val;                                              \
64 } while (0)
65
66 #elif RTE_TABLE_HASH_LRU_STRATEGY == 1
67
68 #define lru_init(bucket)                                                \
69 do                                                                      \
70         bucket->lru_list = 0x0000000100020003LLU;                       \
71 while (0)
72
73 #define lru_pos(bucket) (bucket->lru_list & 0xFFFFLLU)
74
75 #define lru_update(bucket, mru_val)                                     \
76 do {                                                                    \
77         uint64_t x, pos, x0, x1, x2, mask;                              \
78                                                                         \
79         x = bucket->lru_list;                                           \
80                                                                         \
81         pos = 4;                                                        \
82         if ((x >> 48) == ((uint64_t) mru_val))                          \
83                 pos = 3;                                                \
84                                                                         \
85         if (((x >> 32) & 0xFFFFLLU) == ((uint64_t) mru_val))            \
86                 pos = 2;                                                \
87                                                                         \
88         if (((x >> 16) & 0xFFFFLLU) == ((uint64_t) mru_val))            \
89                 pos = 1;                                                \
90                                                                         \
91         if ((x & 0xFFFFLLU) == ((uint64_t) mru_val))                    \
92                 pos = 0;                                                \
93                                                                         \
94                                                                         \
95         pos <<= 4;                                                      \
96         mask = (~0LLU) << pos;                                          \
97         x0 = x & (~mask);                                               \
98         x1 = (x >> 16) & mask;                                          \
99         x2 = (x << (48 - pos)) & (0xFFFFLLU << 48);                     \
100         x = x0 | x1 | x2;                                               \
101                                                                         \
102         if (pos != 64)                                                  \
103                 bucket->lru_list = x;                                   \
104 } while (0)
105
106 #elif (RTE_TABLE_HASH_LRU_STRATEGY == 2) || (RTE_TABLE_HASH_LRU_STRATEGY == 3)
107
108 /**
109  * These strategies are implemented in architecture specific header files.
110  */
111
112 #else
113
114 #error "Incorrect value for RTE_TABLE_HASH_LRU_STRATEGY"
115
116 #endif
117
118 #ifdef __cplusplus
119 }
120 #endif
121
122 #endif