xref: /aosp_15_r20/external/dynamic_depth/internal/strings/fastmem.h (revision a62be0856e8e1158f43b03e41bbad10f4d005fde)
1*a62be085SSadaf Ebrahimi // Fast memory copying and comparison routines.
2*a62be085SSadaf Ebrahimi //   strings::fastmemcmp_inlined() replaces memcmp()
3*a62be085SSadaf Ebrahimi //   strings::memcpy_inlined() replaces memcpy()
4*a62be085SSadaf Ebrahimi //   strings::memeq(a, b, n) replaces memcmp(a, b, n) == 0
5*a62be085SSadaf Ebrahimi //
6*a62be085SSadaf Ebrahimi // strings::*_inlined() routines are inline versions of the
7*a62be085SSadaf Ebrahimi // routines exported by this module.  Sometimes using the inlined
8*a62be085SSadaf Ebrahimi // versions is faster.  Measure before using the inlined versions.
9*a62be085SSadaf Ebrahimi 
10*a62be085SSadaf Ebrahimi #ifndef DYNAMIC_DEPTH_INTERNAL_STRINGS_FASTMEM_H_  // NOLINT
11*a62be085SSadaf Ebrahimi #define DYNAMIC_DEPTH_INTERNAL_STRINGS_FASTMEM_H_  // NOLINT
12*a62be085SSadaf Ebrahimi 
13*a62be085SSadaf Ebrahimi #include <stddef.h>
14*a62be085SSadaf Ebrahimi #include <stdint.h>
15*a62be085SSadaf Ebrahimi #include <stdio.h>
16*a62be085SSadaf Ebrahimi #include <string.h>
17*a62be085SSadaf Ebrahimi 
18*a62be085SSadaf Ebrahimi #include "base/integral_types.h"
19*a62be085SSadaf Ebrahimi #include "base/macros.h"
20*a62be085SSadaf Ebrahimi #include "base/port.h"
21*a62be085SSadaf Ebrahimi 
22*a62be085SSadaf Ebrahimi namespace dynamic_depth {
23*a62be085SSadaf Ebrahimi namespace strings {
24*a62be085SSadaf Ebrahimi 
25*a62be085SSadaf Ebrahimi // Return true if the n bytes at a equal the n bytes at b.
26*a62be085SSadaf Ebrahimi // The regions are allowed to overlap.
27*a62be085SSadaf Ebrahimi //
28*a62be085SSadaf Ebrahimi // The performance is similar to the performance of memcmp(), but faster for
29*a62be085SSadaf Ebrahimi // moderately-sized inputs, or inputs that share a common prefix and differ
30*a62be085SSadaf Ebrahimi // somewhere in their last 8 bytes. Further optimizations can be added later
31*a62be085SSadaf Ebrahimi // if it makes sense to do so.  Alternatively, if the compiler & runtime improve
32*a62be085SSadaf Ebrahimi // to eliminate the need for this, we can remove it.  Please keep this in sync
33*a62be085SSadaf Ebrahimi // with google_internal::gg_memeq() in //third_party/stl/gcc3/string.
memeq(const char * a,const char * b,size_t n)34*a62be085SSadaf Ebrahimi inline bool memeq(const char* a, const char* b, size_t n) {
35*a62be085SSadaf Ebrahimi   size_t n_rounded_down = n & ~static_cast<size_t>(7);
36*a62be085SSadaf Ebrahimi   if (PREDICT_FALSE(n_rounded_down == 0)) {  // n <= 7
37*a62be085SSadaf Ebrahimi     return memcmp(a, b, n) == 0;
38*a62be085SSadaf Ebrahimi   }
39*a62be085SSadaf Ebrahimi   // n >= 8
40*a62be085SSadaf Ebrahimi   uint64 u = UNALIGNED_LOAD64(a) ^ UNALIGNED_LOAD64(b);
41*a62be085SSadaf Ebrahimi   uint64 v = UNALIGNED_LOAD64(a + n - 8) ^ UNALIGNED_LOAD64(b + n - 8);
42*a62be085SSadaf Ebrahimi   if ((u | v) != 0) {  // The first or last 8 bytes differ.
43*a62be085SSadaf Ebrahimi     return false;
44*a62be085SSadaf Ebrahimi   }
45*a62be085SSadaf Ebrahimi   // The next line forces n to be a multiple of 8.
46*a62be085SSadaf Ebrahimi   n = n_rounded_down;
47*a62be085SSadaf Ebrahimi   if (n >= 80) {
48*a62be085SSadaf Ebrahimi     // In 2013 or later, this should be fast on long strings.
49*a62be085SSadaf Ebrahimi     return memcmp(a, b, n) == 0;
50*a62be085SSadaf Ebrahimi   }
51*a62be085SSadaf Ebrahimi   // Now force n to be a multiple of 16.  Arguably, a "switch" would be smart
52*a62be085SSadaf Ebrahimi   // here, but there's a difficult-to-evaluate code size vs. speed issue.  The
53*a62be085SSadaf Ebrahimi   // current approach often re-compares some bytes (worst case is if n initially
54*a62be085SSadaf Ebrahimi   // was 16, 32, 48, or 64), but is fairly short.
55*a62be085SSadaf Ebrahimi   size_t e = n & 8;
56*a62be085SSadaf Ebrahimi   a += e;
57*a62be085SSadaf Ebrahimi   b += e;
58*a62be085SSadaf Ebrahimi   n -= e;
59*a62be085SSadaf Ebrahimi   // n is now in {0, 16, 32, ...}.  Process 0 or more 16-byte chunks.
60*a62be085SSadaf Ebrahimi   while (n > 0) {
61*a62be085SSadaf Ebrahimi     uint64 x = UNALIGNED_LOAD64(a) ^ UNALIGNED_LOAD64(b);
62*a62be085SSadaf Ebrahimi     uint64 y = UNALIGNED_LOAD64(a + 8) ^ UNALIGNED_LOAD64(b + 8);
63*a62be085SSadaf Ebrahimi     if ((x | y) != 0) {
64*a62be085SSadaf Ebrahimi       return false;
65*a62be085SSadaf Ebrahimi     }
66*a62be085SSadaf Ebrahimi     a += 16;
67*a62be085SSadaf Ebrahimi     b += 16;
68*a62be085SSadaf Ebrahimi     n -= 16;
69*a62be085SSadaf Ebrahimi   }
70*a62be085SSadaf Ebrahimi   return true;
71*a62be085SSadaf Ebrahimi }
72*a62be085SSadaf Ebrahimi 
fastmemcmp_inlined(const void * va,const void * vb,size_t n)73*a62be085SSadaf Ebrahimi inline int fastmemcmp_inlined(const void* va, const void* vb, size_t n) {
74*a62be085SSadaf Ebrahimi   const unsigned char* pa = static_cast<const unsigned char*>(va);
75*a62be085SSadaf Ebrahimi   const unsigned char* pb = static_cast<const unsigned char*>(vb);
76*a62be085SSadaf Ebrahimi   switch (n) {
77*a62be085SSadaf Ebrahimi     default:
78*a62be085SSadaf Ebrahimi       return memcmp(va, vb, n);
79*a62be085SSadaf Ebrahimi     case 7:
80*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
81*a62be085SSadaf Ebrahimi       ++pa;
82*a62be085SSadaf Ebrahimi       ++pb;
83*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
84*a62be085SSadaf Ebrahimi     case 6:
85*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
86*a62be085SSadaf Ebrahimi       ++pa;
87*a62be085SSadaf Ebrahimi       ++pb;
88*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
89*a62be085SSadaf Ebrahimi     case 5:
90*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
91*a62be085SSadaf Ebrahimi       ++pa;
92*a62be085SSadaf Ebrahimi       ++pb;
93*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
94*a62be085SSadaf Ebrahimi     case 4:
95*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
96*a62be085SSadaf Ebrahimi       ++pa;
97*a62be085SSadaf Ebrahimi       ++pb;
98*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
99*a62be085SSadaf Ebrahimi     case 3:
100*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
101*a62be085SSadaf Ebrahimi       ++pa;
102*a62be085SSadaf Ebrahimi       ++pb;
103*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
104*a62be085SSadaf Ebrahimi     case 2:
105*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
106*a62be085SSadaf Ebrahimi       ++pa;
107*a62be085SSadaf Ebrahimi       ++pb;
108*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
109*a62be085SSadaf Ebrahimi     case 1:
110*a62be085SSadaf Ebrahimi       if (*pa != *pb) return *pa < *pb ? -1 : +1;
111*a62be085SSadaf Ebrahimi       FALLTHROUGH_INTENDED;
112*a62be085SSadaf Ebrahimi     case 0:
113*a62be085SSadaf Ebrahimi       break;
114*a62be085SSadaf Ebrahimi   }
115*a62be085SSadaf Ebrahimi   return 0;
116*a62be085SSadaf Ebrahimi }
117*a62be085SSadaf Ebrahimi 
118*a62be085SSadaf Ebrahimi // The standard memcpy operation is slow for variable small sizes.
119*a62be085SSadaf Ebrahimi // This implementation inlines the optimal realization for sizes 1 to 16.
120*a62be085SSadaf Ebrahimi // To avoid code bloat don't use it in case of not performance-critical spots,
121*a62be085SSadaf Ebrahimi // nor when you don't expect very frequent values of size <= 16.
memcpy_inlined(char * dst,const char * src,size_t size)122*a62be085SSadaf Ebrahimi inline void memcpy_inlined(char* dst, const char* src, size_t size) {
123*a62be085SSadaf Ebrahimi   // Compiler inlines code with minimal amount of data movement when third
124*a62be085SSadaf Ebrahimi   // parameter of memcpy is a constant.
125*a62be085SSadaf Ebrahimi   switch (size) {
126*a62be085SSadaf Ebrahimi     case 1:
127*a62be085SSadaf Ebrahimi       memcpy(dst, src, 1);
128*a62be085SSadaf Ebrahimi       break;
129*a62be085SSadaf Ebrahimi     case 2:
130*a62be085SSadaf Ebrahimi       memcpy(dst, src, 2);
131*a62be085SSadaf Ebrahimi       break;
132*a62be085SSadaf Ebrahimi     case 3:
133*a62be085SSadaf Ebrahimi       memcpy(dst, src, 3);
134*a62be085SSadaf Ebrahimi       break;
135*a62be085SSadaf Ebrahimi     case 4:
136*a62be085SSadaf Ebrahimi       memcpy(dst, src, 4);
137*a62be085SSadaf Ebrahimi       break;
138*a62be085SSadaf Ebrahimi     case 5:
139*a62be085SSadaf Ebrahimi       memcpy(dst, src, 5);
140*a62be085SSadaf Ebrahimi       break;
141*a62be085SSadaf Ebrahimi     case 6:
142*a62be085SSadaf Ebrahimi       memcpy(dst, src, 6);
143*a62be085SSadaf Ebrahimi       break;
144*a62be085SSadaf Ebrahimi     case 7:
145*a62be085SSadaf Ebrahimi       memcpy(dst, src, 7);
146*a62be085SSadaf Ebrahimi       break;
147*a62be085SSadaf Ebrahimi     case 8:
148*a62be085SSadaf Ebrahimi       memcpy(dst, src, 8);
149*a62be085SSadaf Ebrahimi       break;
150*a62be085SSadaf Ebrahimi     case 9:
151*a62be085SSadaf Ebrahimi       memcpy(dst, src, 9);
152*a62be085SSadaf Ebrahimi       break;
153*a62be085SSadaf Ebrahimi     case 10:
154*a62be085SSadaf Ebrahimi       memcpy(dst, src, 10);
155*a62be085SSadaf Ebrahimi       break;
156*a62be085SSadaf Ebrahimi     case 11:
157*a62be085SSadaf Ebrahimi       memcpy(dst, src, 11);
158*a62be085SSadaf Ebrahimi       break;
159*a62be085SSadaf Ebrahimi     case 12:
160*a62be085SSadaf Ebrahimi       memcpy(dst, src, 12);
161*a62be085SSadaf Ebrahimi       break;
162*a62be085SSadaf Ebrahimi     case 13:
163*a62be085SSadaf Ebrahimi       memcpy(dst, src, 13);
164*a62be085SSadaf Ebrahimi       break;
165*a62be085SSadaf Ebrahimi     case 14:
166*a62be085SSadaf Ebrahimi       memcpy(dst, src, 14);
167*a62be085SSadaf Ebrahimi       break;
168*a62be085SSadaf Ebrahimi     case 15:
169*a62be085SSadaf Ebrahimi       memcpy(dst, src, 15);
170*a62be085SSadaf Ebrahimi       break;
171*a62be085SSadaf Ebrahimi     case 16:
172*a62be085SSadaf Ebrahimi       memcpy(dst, src, 16);
173*a62be085SSadaf Ebrahimi       break;
174*a62be085SSadaf Ebrahimi     default:
175*a62be085SSadaf Ebrahimi       memcpy(dst, src, size);
176*a62be085SSadaf Ebrahimi       break;
177*a62be085SSadaf Ebrahimi   }
178*a62be085SSadaf Ebrahimi }
179*a62be085SSadaf Ebrahimi 
180*a62be085SSadaf Ebrahimi }  // namespace strings
181*a62be085SSadaf Ebrahimi }  // namespace dynamic_depth
182*a62be085SSadaf Ebrahimi 
183*a62be085SSadaf Ebrahimi #endif  // DYNAMIC_DEPTH_INTERNAL_STRINGS_FASTMEM_H_  // NOLINT
184