2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include "RangeSse42.h"
19 #include <glog/logging.h>
20 #include <folly/Portability.h>
22 // Essentially, two versions of this file: one with an SSE42 implementation
23 // and one with a fallback implementation. We determine which version to use by
24 // testing for the presence of the required headers.
26 // TODO: Maybe this should be done by the build system....
27 #if !FOLLY_SSE_PREREQ(4, 2)
30 size_t qfind_first_byte_of_sse42(const StringPieceLite haystack,
31 const StringPieceLite needles) {
32 return qfind_first_byte_of_nosse(haystack, needles);
41 #include <emmintrin.h>
42 #include <nmmintrin.h>
43 #include <smmintrin.h>
45 #include <folly/Likely.h>
47 // GCC 4.9 with ASAN has a problem: a function with no_sanitize_address calling
48 // a function with always_inline fails to build. The _mm_* functions are marked
50 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
51 #if defined FOLLY_SANITIZE_ADDRESS && \
52 FOLLY_SANITIZE_ADDRESS == 1 && \
54 # define _mm_load_si128(p) (*(p))
55 # define _mm_loadu_si128(p) ((__m128i)__builtin_ia32_loaddqu((const char*)(p)))
59 # define _mm_cmpestri(a, b, c, d, e) \
60 __builtin_ia32_pcmpestri128((__v16qi)(a), b, (__v16qi)(c), d, e)
66 // It's okay if pages are bigger than this (as powers of two), but they should
68 static constexpr size_t kMinPageSize = 4096;
69 static_assert(kMinPageSize >= 16,
70 "kMinPageSize must be at least SSE register size");
73 static inline uintptr_t page_for(T* addr) {
74 return reinterpret_cast<uintptr_t>(addr) / kMinPageSize;
77 static inline size_t nextAlignedIndex(const char* arr) {
78 auto firstPossible = reinterpret_cast<uintptr_t>(arr) + 1;
79 return 1 + // add 1 because the index starts at 'arr'
80 ((firstPossible + 15) & ~0xF) // round up to next multiple of 16
84 static size_t qfind_first_byte_of_needles16(const StringPieceLite haystack,
85 const StringPieceLite needles)
86 FOLLY_DISABLE_ADDRESS_SANITIZER;
88 // helper method for case where needles.size() <= 16
89 size_t qfind_first_byte_of_needles16(const StringPieceLite haystack,
90 const StringPieceLite needles) {
91 DCHECK_GT(haystack.size(), 0u);
92 DCHECK_GT(needles.size(), 0u);
93 DCHECK_LE(needles.size(), 16u);
94 if ((needles.size() <= 2 && haystack.size() >= 256) ||
95 // must bail if we can't even SSE-load a single segment of haystack
96 (haystack.size() < 16 &&
97 page_for(haystack.end() - 1) != page_for(haystack.data() + 15)) ||
98 // can't load needles into SSE register if it could cross page boundary
99 page_for(needles.end() - 1) != page_for(needles.data() + 15)) {
100 return detail::qfind_first_byte_of_nosse(haystack, needles);
103 auto arr2 = _mm_loadu_si128(
104 reinterpret_cast<const __m128i*>(needles.data()));
105 // do an unaligned load for first block of haystack
106 auto arr1 = _mm_loadu_si128(
107 reinterpret_cast<const __m128i*>(haystack.data()));
109 _mm_cmpestri(arr2, int(needles.size()), arr1, int(haystack.size()), 0);
111 return size_t(index);
114 // Now, we can do aligned loads hereafter...
115 size_t i = nextAlignedIndex(haystack.data());
116 for (; i < haystack.size(); i+= 16) {
118 _mm_load_si128(reinterpret_cast<const __m128i*>(haystack.data() + i));
119 index = _mm_cmpestri(
120 arr2, int(needles.size()), arr1, int(haystack.size() - i), 0);
125 return std::string::npos;
128 template <bool HAYSTACK_ALIGNED>
129 size_t scanHaystackBlock(const StringPieceLite haystack,
130 const StringPieceLite needles,
132 // Turn off ASAN because the "arr2 = ..." assignment in the loop below reads
133 // up to 15 bytes beyond end of the buffer in #needles#. That is ok because
134 // ptr2 is always 16-byte aligned, so the read can never span a page boundary.
135 // Also, the extra data that may be read is never actually used.
136 FOLLY_DISABLE_ADDRESS_SANITIZER;
138 // Scans a 16-byte block of haystack (starting at blockStartIdx) to find first
139 // needle. If HAYSTACK_ALIGNED, then haystack must be 16byte aligned.
140 // If !HAYSTACK_ALIGNED, then caller must ensure that it is safe to load the
142 template <bool HAYSTACK_ALIGNED>
143 size_t scanHaystackBlock(const StringPieceLite haystack,
144 const StringPieceLite needles,
145 uint64_t blockStartIdx) {
146 DCHECK_GT(needles.size(), 16u); // should handled by *needles16() method
147 DCHECK(blockStartIdx + 16 <= haystack.size() ||
148 (page_for(haystack.data() + blockStartIdx) ==
149 page_for(haystack.data() + blockStartIdx + 15)));
152 if (HAYSTACK_ALIGNED) {
153 arr1 = _mm_load_si128(
154 reinterpret_cast<const __m128i*>(haystack.data() + blockStartIdx));
156 arr1 = _mm_loadu_si128(
157 reinterpret_cast<const __m128i*>(haystack.data() + blockStartIdx));
160 // This load is safe because needles.size() >= 16
161 auto arr2 = _mm_loadu_si128(
162 reinterpret_cast<const __m128i*>(needles.data()));
164 _mm_cmpestri(arr2, 16, arr1, int(haystack.size() - blockStartIdx), 0);
166 size_t j = nextAlignedIndex(needles.data());
167 for (; j < needles.size(); j += 16) {
168 arr2 = _mm_load_si128(
169 reinterpret_cast<const __m128i*>(needles.data() + j));
171 auto index = _mm_cmpestri(
173 int(needles.size() - j),
175 int(haystack.size() - blockStartIdx),
177 b = std::min(index, b);
181 return blockStartIdx + b;
183 return std::string::npos;
186 size_t qfind_first_byte_of_sse42(const StringPieceLite haystack,
187 const StringPieceLite needles);
189 size_t qfind_first_byte_of_sse42(const StringPieceLite haystack,
190 const StringPieceLite needles) {
191 if (UNLIKELY(needles.empty() || haystack.empty())) {
192 return std::string::npos;
193 } else if (needles.size() <= 16) {
194 // we can save some unnecessary load instructions by optimizing for
195 // the common case of needles.size() <= 16
196 return qfind_first_byte_of_needles16(haystack, needles);
199 if (haystack.size() < 16 &&
200 page_for(haystack.end() - 1) != page_for(haystack.data() + 16)) {
201 // We can't safely SSE-load haystack. Use a different approach.
202 if (haystack.size() <= 2) {
203 return qfind_first_byte_of_std(haystack, needles);
205 return qfind_first_byte_of_byteset(haystack, needles);
208 auto ret = scanHaystackBlock<false>(haystack, needles, 0);
209 if (ret != std::string::npos) {
213 size_t i = nextAlignedIndex(haystack.data());
214 for (; i < haystack.size(); i += 16) {
215 ret = scanHaystackBlock<true>(haystack, needles, i);
216 if (ret != std::string::npos) {
221 return std::string::npos;