FD.io VPP  v16.12-rc0-308-g931be3a
Vector Packet Processing
memcpy_sse3.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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  * BSD LICENSE
17  *
18  * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
19  * All rights reserved.
20  *
21  * Redistribution and use in source and binary forms, with or without
22  * modification, are permitted provided that the following conditions
23  * are met:
24  *
25  * * Redistributions of source code must retain the above copyright
26  * notice, this list of conditions and the following disclaimer.
27  * * Redistributions in binary form must reproduce the above copyright
28  * notice, this list of conditions and the following disclaimer in
29  * the documentation and/or other materials provided with the
30  * distribution.
31  * * Neither the name of Intel Corporation nor the names of its
32  * contributors may be used to endorse or promote products derived
33  * from this software without specific prior written permission.
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  */
47 
48 #ifndef included_clib_memcpy_sse3_h
49 #define included_clib_memcpy_sse3_h
50 
51 #include <stdint.h>
52 #include <x86intrin.h>
53 
54 typedef u8 u8x16u __attribute__ ((vector_size (16), aligned (1)));
55 typedef u8 u8x32u __attribute__ ((vector_size (32), aligned (1)));
56 
57 static inline void
58 clib_mov16 (u8 * dst, const u8 * src)
59 {
60  *(u8x16u *) dst = *(u8x16u *) src;
61 }
62 
63 static inline void
64 clib_mov32 (u8 * dst, const u8 * src)
65 {
66  *(u8x32u *) dst = *(u8x32u *) src;
67 }
68 
69 static inline void
70 clib_mov64 (u8 * dst, const u8 * src)
71 {
72  clib_mov32 ((u8 *) dst + 0 * 32, (const u8 *) src + 0 * 32);
73  clib_mov32 ((u8 *) dst + 1 * 32, (const u8 *) src + 1 * 32);
74 }
75 
76 static inline void
77 clib_mov128 (u8 * dst, const u8 * src)
78 {
79  clib_mov64 ((u8 *) dst + 0 * 64, (const u8 *) src + 0 * 64);
80  clib_mov64 ((u8 *) dst + 1 * 64, (const u8 *) src + 1 * 64);
81 }
82 
83 static inline void
84 clib_mov256 (u8 * dst, const u8 * src)
85 {
86  clib_mov128 ((u8 *) dst + 0 * 128, (const u8 *) src + 0 * 128);
87  clib_mov128 ((u8 *) dst + 1 * 128, (const u8 *) src + 1 * 128);
88 }
89 
90 /**
91  * Macro for copying unaligned block from one location to another with constant load offset,
92  * 47 bytes leftover maximum,
93  * locations should not overlap.
94  * Requirements:
95  * - Store is aligned
96  * - Load offset is <offset>, which must be immediate value within [1, 15]
97  * - For <src>, make sure <offset> bit backwards & <16 - offset> bit forwards are available for loading
98  * - <dst>, <src>, <len> must be variables
99  * - __m128i <xmm0> ~ <xmm8> must be pre-defined
100  */
101 #define CLIB_MVUNALIGN_LEFT47_IMM(dst, src, len, offset) \
102 ({ \
103  int tmp; \
104  while (len >= 128 + 16 - offset) { \
105  xmm0 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 0 * 16)); \
106  len -= 128; \
107  xmm1 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 1 * 16)); \
108  xmm2 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 2 * 16)); \
109  xmm3 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 3 * 16)); \
110  xmm4 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 4 * 16)); \
111  xmm5 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 5 * 16)); \
112  xmm6 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 6 * 16)); \
113  xmm7 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 7 * 16)); \
114  xmm8 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 8 * 16)); \
115  src = (const u8 *)src + 128; \
116  _mm_storeu_si128((__m128i *)((u8 *)dst + 0 * 16), _mm_alignr_epi8(xmm1, xmm0, offset)); \
117  _mm_storeu_si128((__m128i *)((u8 *)dst + 1 * 16), _mm_alignr_epi8(xmm2, xmm1, offset)); \
118  _mm_storeu_si128((__m128i *)((u8 *)dst + 2 * 16), _mm_alignr_epi8(xmm3, xmm2, offset)); \
119  _mm_storeu_si128((__m128i *)((u8 *)dst + 3 * 16), _mm_alignr_epi8(xmm4, xmm3, offset)); \
120  _mm_storeu_si128((__m128i *)((u8 *)dst + 4 * 16), _mm_alignr_epi8(xmm5, xmm4, offset)); \
121  _mm_storeu_si128((__m128i *)((u8 *)dst + 5 * 16), _mm_alignr_epi8(xmm6, xmm5, offset)); \
122  _mm_storeu_si128((__m128i *)((u8 *)dst + 6 * 16), _mm_alignr_epi8(xmm7, xmm6, offset)); \
123  _mm_storeu_si128((__m128i *)((u8 *)dst + 7 * 16), _mm_alignr_epi8(xmm8, xmm7, offset)); \
124  dst = (u8 *)dst + 128; \
125  } \
126  tmp = len; \
127  len = ((len - 16 + offset) & 127) + 16 - offset; \
128  tmp -= len; \
129  src = (const u8 *)src + tmp; \
130  dst = (u8 *)dst + tmp; \
131  if (len >= 32 + 16 - offset) { \
132  while (len >= 32 + 16 - offset) { \
133  xmm0 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 0 * 16)); \
134  len -= 32; \
135  xmm1 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 1 * 16)); \
136  xmm2 = _mm_loadu_si128((const __m128i *)((const u8 *)src - offset + 2 * 16)); \
137  src = (const u8 *)src + 32; \
138  _mm_storeu_si128((__m128i *)((u8 *)dst + 0 * 16), _mm_alignr_epi8(xmm1, xmm0, offset)); \
139  _mm_storeu_si128((__m128i *)((u8 *)dst + 1 * 16), _mm_alignr_epi8(xmm2, xmm1, offset)); \
140  dst = (u8 *)dst + 32; \
141  } \
142  tmp = len; \
143  len = ((len - 16 + offset) & 31) + 16 - offset; \
144  tmp -= len; \
145  src = (const u8 *)src + tmp; \
146  dst = (u8 *)dst + tmp; \
147  } \
148 })
149 
150 /**
151  * Macro for copying unaligned block from one location to another,
152  * 47 bytes leftover maximum,
153  * locations should not overlap.
154  * Use switch here because the aligning instruction requires immediate value for shift count.
155  * Requirements:
156  * - Store is aligned
157  * - Load offset is <offset>, which must be within [1, 15]
158  * - For <src>, make sure <offset> bit backwards & <16 - offset> bit forwards are available for loading
159  * - <dst>, <src>, <len> must be variables
160  * - __m128i <xmm0> ~ <xmm8> used in CLIB_MVUNALIGN_LEFT47_IMM must be pre-defined
161  */
162 #define CLIB_MVUNALIGN_LEFT47(dst, src, len, offset) \
163 ({ \
164  switch (offset) { \
165  case 0x01: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x01); break; \
166  case 0x02: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x02); break; \
167  case 0x03: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x03); break; \
168  case 0x04: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x04); break; \
169  case 0x05: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x05); break; \
170  case 0x06: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x06); break; \
171  case 0x07: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x07); break; \
172  case 0x08: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x08); break; \
173  case 0x09: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x09); break; \
174  case 0x0A: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x0A); break; \
175  case 0x0B: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x0B); break; \
176  case 0x0C: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x0C); break; \
177  case 0x0D: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x0D); break; \
178  case 0x0E: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x0E); break; \
179  case 0x0F: CLIB_MVUNALIGN_LEFT47_IMM(dst, src, n, 0x0F); break; \
180  default:; \
181  } \
182 })
183 
184 static inline void *
185 clib_memcpy (void *dst, const void *src, size_t n)
186 {
187  __m128i xmm0, xmm1, xmm2, xmm3, xmm4, xmm5, xmm6, xmm7, xmm8;
188  uword dstu = (uword) dst;
189  uword srcu = (uword) src;
190  void *ret = dst;
191  size_t dstofss;
192  size_t srcofs;
193 
194  /**
195  * Copy less than 16 bytes
196  */
197  if (n < 16)
198  {
199  if (n & 0x01)
200  {
201  *(u8 *) dstu = *(const u8 *) srcu;
202  srcu = (uword) ((const u8 *) srcu + 1);
203  dstu = (uword) ((u8 *) dstu + 1);
204  }
205  if (n & 0x02)
206  {
207  *(u16 *) dstu = *(const u16 *) srcu;
208  srcu = (uword) ((const u16 *) srcu + 1);
209  dstu = (uword) ((u16 *) dstu + 1);
210  }
211  if (n & 0x04)
212  {
213  *(u32 *) dstu = *(const u32 *) srcu;
214  srcu = (uword) ((const u32 *) srcu + 1);
215  dstu = (uword) ((u32 *) dstu + 1);
216  }
217  if (n & 0x08)
218  {
219  *(u64 *) dstu = *(const u64 *) srcu;
220  }
221  return ret;
222  }
223 
224  /**
225  * Fast way when copy size doesn't exceed 512 bytes
226  */
227  if (n <= 32)
228  {
229  clib_mov16 ((u8 *) dst, (const u8 *) src);
230  clib_mov16 ((u8 *) dst - 16 + n, (const u8 *) src - 16 + n);
231  return ret;
232  }
233  if (n <= 48)
234  {
235  clib_mov32 ((u8 *) dst, (const u8 *) src);
236  clib_mov16 ((u8 *) dst - 16 + n, (const u8 *) src - 16 + n);
237  return ret;
238  }
239  if (n <= 64)
240  {
241  clib_mov32 ((u8 *) dst, (const u8 *) src);
242  clib_mov16 ((u8 *) dst + 32, (const u8 *) src + 32);
243  clib_mov16 ((u8 *) dst - 16 + n, (const u8 *) src - 16 + n);
244  return ret;
245  }
246  if (n <= 128)
247  {
248  goto COPY_BLOCK_128_BACK15;
249  }
250  if (n <= 512)
251  {
252  if (n >= 256)
253  {
254  n -= 256;
255  clib_mov128 ((u8 *) dst, (const u8 *) src);
256  clib_mov128 ((u8 *) dst + 128, (const u8 *) src + 128);
257  src = (const u8 *) src + 256;
258  dst = (u8 *) dst + 256;
259  }
260  COPY_BLOCK_255_BACK15:
261  if (n >= 128)
262  {
263  n -= 128;
264  clib_mov128 ((u8 *) dst, (const u8 *) src);
265  src = (const u8 *) src + 128;
266  dst = (u8 *) dst + 128;
267  }
268  COPY_BLOCK_128_BACK15:
269  if (n >= 64)
270  {
271  n -= 64;
272  clib_mov64 ((u8 *) dst, (const u8 *) src);
273  src = (const u8 *) src + 64;
274  dst = (u8 *) dst + 64;
275  }
276  COPY_BLOCK_64_BACK15:
277  if (n >= 32)
278  {
279  n -= 32;
280  clib_mov32 ((u8 *) dst, (const u8 *) src);
281  src = (const u8 *) src + 32;
282  dst = (u8 *) dst + 32;
283  }
284  if (n > 16)
285  {
286  clib_mov16 ((u8 *) dst, (const u8 *) src);
287  clib_mov16 ((u8 *) dst - 16 + n, (const u8 *) src - 16 + n);
288  return ret;
289  }
290  if (n > 0)
291  {
292  clib_mov16 ((u8 *) dst - 16 + n, (const u8 *) src - 16 + n);
293  }
294  return ret;
295  }
296 
297  /**
298  * Make store aligned when copy size exceeds 512 bytes,
299  * and make sure the first 15 bytes are copied, because
300  * unaligned copy functions require up to 15 bytes
301  * backwards access.
302  */
303  dstofss = 16 - ((uword) dst & 0x0F) + 16;
304  n -= dstofss;
305  clib_mov32 ((u8 *) dst, (const u8 *) src);
306  src = (const u8 *) src + dstofss;
307  dst = (u8 *) dst + dstofss;
308  srcofs = ((uword) src & 0x0F);
309 
310  /**
311  * For aligned copy
312  */
313  if (srcofs == 0)
314  {
315  /**
316  * Copy 256-byte blocks
317  */
318  for (; n >= 256; n -= 256)
319  {
320  clib_mov256 ((u8 *) dst, (const u8 *) src);
321  dst = (u8 *) dst + 256;
322  src = (const u8 *) src + 256;
323  }
324 
325  /**
326  * Copy whatever left
327  */
328  goto COPY_BLOCK_255_BACK15;
329  }
330 
331  /**
332  * For copy with unaligned load
333  */
334  CLIB_MVUNALIGN_LEFT47 (dst, src, n, srcofs);
335 
336  /**
337  * Copy whatever left
338  */
339  goto COPY_BLOCK_64_BACK15;
340 }
341 
342 
343 #undef CLIB_MVUNALIGN_LEFT47_IMM
344 #undef CLIB_MVUNALIGN_LEFT47
345 
346 #endif /* included_clib_memcpy_sse3_h */
347 
348 
349 /*
350  * fd.io coding-style-patch-verification: ON
351  *
352  * Local Variables:
353  * eval: (c-set-style "gnu")
354  * End:
355  */
#define CLIB_MVUNALIGN_LEFT47(dst, src, len, offset)
Macro for copying unaligned block from one location to another, 47 bytes leftover maximum...
Definition: memcpy_sse3.h:162
u8 u8x32u
Definition: memcpy_avx.h:55
unsigned long u64
Definition: types.h:89
u8 u8x16u
Definition: memcpy_avx.h:54
static void clib_mov64(u8 *dst, const u8 *src)
Definition: memcpy_sse3.h:70
static void clib_mov128(u8 *dst, const u8 *src)
Definition: memcpy_sse3.h:77
unsigned int u32
Definition: types.h:88
static void clib_mov16(u8 *dst, const u8 *src)
Definition: memcpy_sse3.h:58
static void clib_mov256(u8 *dst, const u8 *src)
Definition: memcpy_sse3.h:84
u64 uword
Definition: types.h:112
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
static void clib_mov32(u8 *dst, const u8 *src)
Definition: memcpy_sse3.h:64
static void * clib_memcpy(void *dst, const void *src, size_t n)
Definition: memcpy_sse3.h:185