FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
cache.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  Copyright (c) 2005 Eliot Dresselhaus
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject to
24  the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 */
37 
38 #ifndef included_clib_cache_h
39 #define included_clib_cache_h
40 
42 
43 /*
44  * Allow CFLAGS to override the configured / deduced cache line size
45  */
46 #ifndef CLIB_LOG2_CACHE_LINE_BYTES
47 
48 /* Default cache line size of 64 bytes. */
49 #ifndef CLIB_LOG2_CACHE_LINE_BYTES
50 #define CLIB_LOG2_CACHE_LINE_BYTES 6
51 #endif
52 
53 #endif /* CLIB_LOG2_CACHE_LINE_BYTES defined */
54 
55 #if (CLIB_LOG2_CACHE_LINE_BYTES >= 9)
56 #error Cache line size 512 bytes or greater
57 #endif
58 
59 #define CLIB_CACHE_LINE_BYTES (1 << CLIB_LOG2_CACHE_LINE_BYTES)
60 #define CLIB_CACHE_LINE_ALIGN_MARK(mark) u8 mark[0] __attribute__((aligned(CLIB_CACHE_LINE_BYTES)))
61 #define CLIB_CACHE_LINE_ROUND(x) ((x + CLIB_CACHE_LINE_BYTES - 1) & ~(CLIB_CACHE_LINE_BYTES - 1))
62 
63 /* Default cache line fill buffers. */
64 #ifndef CLIB_N_PREFETCHES
65 #define CLIB_N_PREFETCHES 16
66 #endif
67 
68 /* Read/write arguments to __builtin_prefetch. */
69 #define CLIB_PREFETCH_READ 0
70 #define CLIB_PREFETCH_LOAD 0 /* alias for read */
71 #define CLIB_PREFETCH_WRITE 1
72 #define CLIB_PREFETCH_STORE 1 /* alias for write */
73 
74 #define _CLIB_PREFETCH(n,size,type) \
75  if ((size) > (n)*CLIB_CACHE_LINE_BYTES) \
76  __builtin_prefetch (_addr + (n)*CLIB_CACHE_LINE_BYTES, \
77  CLIB_PREFETCH_##type, \
78  /* locality */ 3);
79 
80 #define CLIB_PREFETCH(addr,size,type) \
81 do { \
82  void * _addr = (addr); \
83  \
84  ASSERT ((size) <= 4*CLIB_CACHE_LINE_BYTES); \
85  _CLIB_PREFETCH (0, size, type); \
86  _CLIB_PREFETCH (1, size, type); \
87  _CLIB_PREFETCH (2, size, type); \
88  _CLIB_PREFETCH (3, size, type); \
89 } while (0)
90 
91 #undef _
92 
93 #endif /* included_clib_cache_h */
94 
95 
96 /*
97  * fd.io coding-style-patch-verification: ON
98  *
99  * Local Variables:
100  * eval: (c-set-style "gnu")
101  * End:
102  */