FD.io VPP  v18.11-rc0-18-g2a3fb1a
Vector Packet Processing
vector.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_vector_h
39 #define included_clib_vector_h
40 
41 #include <vppinfra/clib.h>
42 
43 /* Vector types. */
44 
45 #if defined (__MMX__) || defined (__IWMMXT__) || defined (__aarch64__)
46 #define CLIB_HAVE_VEC64
47 #endif
48 
49 #if defined (__aarch64__) && defined(__ARM_NEON)
50 #define CLIB_HAVE_VEC128
51 #endif
52 
53 #if defined (__SSE4_2__) && __GNUC__ >= 4
54 #define CLIB_HAVE_VEC128
55 #endif
56 
57 #if defined (__ALTIVEC__)
58 #define CLIB_HAVE_VEC128
59 #endif
60 
61 #if defined (__AVX2__)
62 #define CLIB_HAVE_VEC256
63 #if defined (__clang__) && __clang_major__ < 4
64 #undef CLIB_HAVE_VEC256
65 #endif
66 #endif
67 
68 #if defined (__AVX512F__)
69 #define CLIB_HAVE_VEC512
70 #endif
71 
72 /* 128 implies 64 */
73 #ifdef CLIB_HAVE_VEC128
74 #define CLIB_HAVE_VEC64
75 #endif
76 
77 #define _vector_size(n) __attribute__ ((vector_size (n)))
78 
79 #define foreach_vec64i _(i,8,8) _(i,16,4) _(i,32,2)
80 #define foreach_vec64u _(u,8,8) _(u,16,4) _(u,32,2)
81 #define foreach_vec64f _(f,32,2)
82 #define foreach_vec128i _(i,8,16) _(i,16,8) _(i,32,4) _(i,64,2)
83 #define foreach_vec128u _(u,8,16) _(u,16,8) _(u,32,4) _(u,64,2)
84 #define foreach_vec128f _(f,32,4) _(f,64,2)
85 #define foreach_vec256i _(i,8,32) _(i,16,16) _(i,32,8) _(i,64,4)
86 #define foreach_vec256u _(u,8,32) _(u,16,16) _(u,32,8) _(u,64,4)
87 #define foreach_vec256f _(f,32,8) _(f,64,4)
88 #define foreach_vec512i _(i,8,64) _(i,16,32) _(i,32,16) _(i,64,8)
89 #define foreach_vec512u _(u,8,64) _(u,16,32) _(u,32,16) _(u,64,8)
90 #define foreach_vec512f _(f,32,16) _(f,64,8)
91 
92 #if defined (CLIB_HAVE_VEC512)
93 #define foreach_int_vec foreach_vec64i foreach_vec128i foreach_vec256i foreach_vec512i
94 #define foreach_uint_vec foreach_vec64u foreach_vec128u foreach_vec256u foreach_vec512u
95 #define foreach_float_vec foreach_vec64f foreach_vec128f foreach_vec256f foreach_vec512f
96 #elif defined (CLIB_HAVE_VEC256)
97 #define foreach_int_vec foreach_vec64i foreach_vec128i foreach_vec256i
98 #define foreach_uint_vec foreach_vec64u foreach_vec128u foreach_vec256u
99 #define foreach_float_vec foreach_vec64f foreach_vec128f foreach_vec256f
100 #else
101 #define foreach_int_vec foreach_vec64i foreach_vec128i
102 #define foreach_uint_vec foreach_vec64u foreach_vec128u
103 #define foreach_float_vec foreach_vec64f foreach_vec128f
104 #endif
105 
106 #define foreach_vec foreach_int_vec foreach_uint_vec foreach_float_vec
107 
108 /* *INDENT-OFF* */
109 
110 /* Type Definitions */
111 #define _(t,s,c) \
112 typedef t##s t##s##x##c _vector_size (s/8*c); \
113 typedef union { \
114  t##s##x##c as_##t##s##x##c; \
115  t##s as_##t##s[c]; \
116 } t##s##x##c##_union_t;
117 
122 #undef _
123 
124 /* Vector word sized types. */
125 #ifndef CLIB_VECTOR_WORD_BITS
126 #ifdef CLIB_HAVE_VEC128
127 #define CLIB_VECTOR_WORD_BITS 128
128 #else
129 #define CLIB_VECTOR_WORD_BITS 64
130 #endif
131 #endif /* CLIB_VECTOR_WORD_BITS */
132 
133 /* Vector word sized types. */
134 #if CLIB_VECTOR_WORD_BITS == 128
135 typedef i8 i8x _vector_size (16);
136 typedef i16 i16x _vector_size (16);
137 typedef i32 i32x _vector_size (16);
138 typedef i64 i64x _vector_size (16);
139 typedef u8 u8x _vector_size (16);
140 typedef u16 u16x _vector_size (16);
141 typedef u32 u32x _vector_size (16);
142 typedef u64 u64x _vector_size (16);
143 #endif
144 #if CLIB_VECTOR_WORD_BITS == 64
145 typedef i8 i8x _vector_size (8);
146 typedef i16 i16x _vector_size (8);
147 typedef i32 i32x _vector_size (8);
148 typedef i64 i64x _vector_size (8);
149 typedef u8 u8x _vector_size (8);
150 typedef u16 u16x _vector_size (8);
151 typedef u32 u32x _vector_size (8);
152 typedef u64 u64x _vector_size (8);
153 #endif
154 
155 #undef _vector_size
156 
157 #define VECTOR_WORD_TYPE(t) t##x
158 #define VECTOR_WORD_TYPE_LEN(t) (sizeof (VECTOR_WORD_TYPE(t)) / sizeof (t))
159 
160 #if defined (__SSE4_2__) && __GNUC__ >= 4
161 #include <vppinfra/vector_sse42.h>
162 #endif
163 
164 #if defined (__AVX2__)
165 #include <vppinfra/vector_avx2.h>
166 #endif
167 
168 #if defined (__AVX512F__)
169 #include <vppinfra/vector_avx512.h>
170 #endif
171 
172 #if defined (__ALTIVEC__)
173 #include <vppinfra/vector_altivec.h>
174 #endif
175 
176 #if defined (__aarch64__)
177 #include <vppinfra/vector_neon.h>
178 #endif
179 
180 #if (defined(CLIB_HAVE_VEC128) || defined(CLIB_HAVE_VEC64))
181 #include <vppinfra/vector_funcs.h>
182 #endif
183 
184 /* this macro generate _splat inline functions for each scalar vector type */
185 #ifndef CLIB_VEC128_SPLAT_DEFINED
186 #define _(t, s, c) \
187  static_always_inline t##s##x##c \
188 t##s##x##c##_splat (t##s x) \
189 { \
190  t##s##x##c r; \
191  int i; \
192  \
193  for (i = 0; i < c; i++) \
194  r[i] = x; \
195  \
196  return r; \
197 }
199 #undef _
200 #endif
201 
202 /* *INDENT-ON* */
203 
204 #endif /* included_clib_vector_h */
205 /*
206  * fd.io coding-style-patch-verification: ON
207  *
208  * Local Variables:
209  * eval: (c-set-style "gnu")
210  * End:
211  */
#define foreach_vec256u
Definition: vector.h:86
unsigned long u64
Definition: types.h:89
#define foreach_vec128u
Definition: vector.h:83
unsigned char u8
Definition: types.h:56
#define foreach_vec512f
Definition: vector.h:90
#define foreach_vec128i
Definition: vector.h:82
#define foreach_vec128f
Definition: vector.h:84
unsigned int u32
Definition: types.h:88
#define foreach_vec256f
Definition: vector.h:87
unsigned short u16
Definition: types.h:57
signed long i64
Definition: types.h:82
signed char i8
Definition: types.h:45
#define foreach_vec512i
Definition: vector.h:88
signed int i32
Definition: types.h:81
#define foreach_vec64i
Definition: vector.h:79
#define foreach_vec512u
Definition: vector.h:89
#define foreach_vec256i
Definition: vector.h:85
#define foreach_vec64f
Definition: vector.h:81
#define foreach_vec64u
Definition: vector.h:80
signed short i16
Definition: types.h:46