add sched_yield in RWTicketSpinLock
[folly.git] / folly / Range.h
1 /*
2  * Copyright 2012 Facebook, Inc.
3  *
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
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 // @author Mark Rabkin (mrabkin@fb.com)
18 // @author Andrei Alexandrescu (andrei.alexandrescu@fb.com)
19
20 #ifndef FOLLY_RANGE_H_
21 #define FOLLY_RANGE_H_
22
23 #include "folly/FBString.h"
24 #include <glog/logging.h>
25 #include <iostream>
26 #include <string>
27 #include <stdexcept>
28 #include <type_traits>
29 #include <boost/operators.hpp>
30 #include <boost/utility/enable_if.hpp>
31 #include <boost/type_traits.hpp>
32 #include <bits/c++config.h>
33 #include "folly/Traits.h"
34
35 namespace folly {
36
37 template <class T> class Range;
38
39 /**
40 Finds the first occurrence of needle in haystack. The algorithm is on
41 average faster than O(haystack.size() * needle.size()) but not as fast
42 as Boyer-Moore. On the upside, it does not do any upfront
43 preprocessing and does not allocate memory.
44  */
45 template <class T>
46 inline size_t qfind(const Range<T> & haystack,
47                     const Range<T> & needle);
48
49 /**
50 Finds the first occurrence of needle in haystack. The result is the
51 offset reported to the beginning of haystack, or string::npos if
52 needle wasn't found.
53  */
54 template <class T>
55 size_t qfind(const Range<T> & haystack,
56              const typename Range<T>::value_type& needle);
57
58 /**
59  * Small internal helper - returns the value just before an iterator.
60  */
61 namespace detail {
62
63 /**
64  * For random-access iterators, the value before is simply i[-1].
65  */
66 template <class Iter>
67 typename boost::enable_if_c<
68   boost::is_same<typename std::iterator_traits<Iter>::iterator_category,
69                  std::random_access_iterator_tag>::value,
70   typename std::iterator_traits<Iter>::reference>::type
71 value_before(Iter i) {
72   return i[-1];
73 }
74
75 /**
76  * For all other iterators, we need to use the decrement operator.
77  */
78 template <class Iter>
79 typename boost::enable_if_c<
80   !boost::is_same<typename std::iterator_traits<Iter>::iterator_category,
81                   std::random_access_iterator_tag>::value,
82   typename std::iterator_traits<Iter>::reference>::type
83 value_before(Iter i) {
84   return *--i;
85 }
86
87 } // namespace detail
88
89 /**
90  * Range abstraction keeping a pair of iterators. We couldn't use
91  * boost's similar range abstraction because we need an API identical
92  * with the former StringPiece class, which is used by a lot of other
93  * code. This abstraction does fulfill the needs of boost's
94  * range-oriented algorithms though.
95  *
96  * (Keep memory lifetime in mind when using this class, since it
97  * doesn't manage the data it refers to - just like an iterator
98  * wouldn't.)
99  */
100 template <class Iter>
101 class Range : private boost::totally_ordered<Range<Iter> > {
102 public:
103   typedef std::size_t size_type;
104   typedef Iter iterator;
105   typedef Iter const_iterator;
106   typedef typename boost::remove_reference<
107     typename std::iterator_traits<Iter>::reference>::type
108   value_type;
109   typedef typename std::iterator_traits<Iter>::reference reference;
110   typedef std::char_traits<value_type> traits_type;
111
112   static const size_type npos = -1;
113
114   // Works for all iterators
115   Range() : b_(), e_() {
116   }
117
118 private:
119   static bool reachable(Iter b, Iter e, std::forward_iterator_tag) {
120     for (; b != e; ++b) {
121       LOG_EVERY_N(INFO, 100000) << __FILE__ ":" << __LINE__
122                                 << " running reachability test ("
123                                 << google::COUNTER << " iterations)...";
124     }
125     return true;
126   }
127
128   static bool reachable(Iter b, Iter e, std::random_access_iterator_tag) {
129     return b <= e;
130   }
131
132 public:
133   // Works for all iterators
134   Range(Iter start, Iter end)
135       : b_(start), e_(end) {
136     assert(reachable(b_, e_,
137                      typename std::iterator_traits<Iter>::iterator_category()));
138   }
139
140   // Works only for random-access iterators
141   Range(Iter start, size_t size)
142       : b_(start), e_(start + size) { }
143
144   // Works only for Range<const char*>
145   /* implicit */ Range(Iter str)
146       : b_(str), e_(b_ + strlen(str)) {}
147   // Works only for Range<const char*>
148   /* implicit */ Range(const std::string& str)
149       : b_(str.data()), e_(b_ + str.size()) {}
150   // Works only for Range<const char*>
151   Range(const std::string& str, std::string::size_type startFrom) {
152     CHECK_LE(startFrom, str.size());
153     b_ = str.data() + startFrom;
154     e_ = str.data() + str.size();
155   }
156   // Works only for Range<const char*>
157   Range(const std::string& str,
158         std::string::size_type startFrom,
159         std::string::size_type size) {
160     CHECK_LE(startFrom + size, str.size());
161     b_ = str.data() + startFrom;
162     e_ = b_ + size;
163   }
164   Range(const Range<Iter>& str,
165         size_t startFrom,
166         size_t size) {
167     CHECK_LE(startFrom + size, str.size());
168     b_ = str.b_ + startFrom;
169     e_ = b_ + size;
170   }
171   // Works only for Range<const char*>
172   /* implicit */ Range(const fbstring& str)
173     : b_(str.data()), e_(b_ + str.size()) { }
174   // Works only for Range<const char*>
175   Range(const fbstring& str, fbstring::size_type startFrom) {
176     CHECK_LE(startFrom, str.size());
177     b_ = str.data() + startFrom;
178     e_ = str.data() + str.size();
179   }
180   // Works only for Range<const char*>
181   Range(const fbstring& str, fbstring::size_type startFrom,
182         fbstring::size_type size) {
183     CHECK_LE(startFrom + size, str.size());
184     b_ = str.data() + startFrom;
185     e_ = b_ + size;
186   }
187
188   // Allow implicit conversion from Range<const char*> (aka StringPiece) to
189   // Range<const unsigned char*> (aka ByteRange), as they're both frequently
190   // used to represent ranges of bytes.
191   template <class OtherIter, typename std::enable_if<
192       (std::is_same<Iter, const unsigned char*>::value &&
193        std::is_same<OtherIter, const char*>::value), int>::type = 0>
194   /* implicit */ Range(const Range<OtherIter>& other)
195     : b_(reinterpret_cast<const unsigned char*>(other.begin())),
196       e_(reinterpret_cast<const unsigned char*>(other.end())) {
197   }
198
199   void clear() {
200     b_ = Iter();
201     e_ = Iter();
202   }
203
204   void assign(Iter start, Iter end) {
205     b_ = start;
206     e_ = end;
207   }
208
209   void reset(Iter start, size_type size) {
210     b_ = start;
211     e_ = start + size;
212   }
213
214   // Works only for Range<const char*>
215   void reset(const std::string& str) {
216     reset(str.data(), str.size());
217   }
218
219   size_type size() const {
220     assert(b_ <= e_);
221     return e_ - b_;
222   }
223   size_type walk_size() const {
224     assert(b_ <= e_);
225     return std::distance(b_, e_);
226   }
227   bool empty() const { return b_ == e_; }
228   Iter data() const { return b_; }
229   Iter start() const { return b_; }
230   Iter begin() const { return b_; }
231   Iter end() const { return e_; }
232   Iter cbegin() const { return b_; }
233   Iter cend() const { return e_; }
234   value_type& front() {
235     assert(b_ < e_);
236     return *b_;
237   }
238   value_type& back() {
239     assert(b_ < e_);
240     return detail::value_before(e_);
241   }
242   const value_type& front() const {
243     assert(b_ < e_);
244     return *b_;
245   }
246   const value_type& back() const {
247     assert(b_ < e_);
248     return detail::value_before(e_);
249   }
250   // Works only for Range<const char*>
251   std::string str() const { return std::string(b_, size()); }
252   std::string toString() const { return str(); }
253   // Works only for Range<const char*>
254   fbstring fbstr() const { return fbstring(b_, size()); }
255   fbstring toFbstring() const { return fbstr(); }
256
257   // Works only for Range<const char*>
258   int compare(const Range& o) const {
259     const size_type tsize = this->size();
260     const size_type osize = o.size();
261     const size_type msize = std::min(tsize, osize);
262     int r = traits_type::compare(data(), o.data(), msize);
263     if (r == 0) r = tsize - osize;
264     return r;
265   }
266
267   value_type& operator[](size_t i) {
268     CHECK_GT(size(), i);
269     return b_[i];
270   }
271
272   const value_type& operator[](size_t i) const {
273     CHECK_GT(size(), i);
274     return b_[i];
275   }
276
277   value_type& at(size_t i) {
278     if (i >= size()) throw std::out_of_range("index out of range");
279     return b_[i];
280   }
281
282   const value_type& at(size_t i) const {
283     if (i >= size()) throw std::out_of_range("index out of range");
284     return b_[i];
285   }
286
287   // Works only for Range<const char*>
288   uint32_t hash() const {
289     // Taken from fbi/nstring.h:
290     //    Quick and dirty bernstein hash...fine for short ascii strings
291     uint32_t hash = 5381;
292     for (size_t ix = 0; ix < size(); ix++) {
293       hash = ((hash << 5) + hash) + b_[ix];
294     }
295     return hash;
296   }
297
298   void advance(size_type n) {
299     CHECK_LE(n, size());
300     b_ += n;
301   }
302
303   void subtract(size_type n) {
304     CHECK_LE(n, size());
305     e_ -= n;
306   }
307
308   void pop_front() {
309     assert(b_ < e_);
310     ++b_;
311   }
312
313   void pop_back() {
314     assert(b_ < e_);
315     --e_;
316   }
317
318   Range subpiece(size_type first,
319                  size_type length = std::string::npos) const {
320     CHECK_LE(first, size());
321     return Range(b_ + first,
322                  std::min<std::string::size_type>(length, size() - first));
323   }
324
325   // string work-alike functions
326   size_type find(Range str) const {
327     return qfind(*this, str);
328   }
329
330   size_type find(Range str, size_t pos) const {
331     if (pos > size()) return std::string::npos;
332     size_t ret = qfind(subpiece(pos), str);
333     return ret == npos ? ret : ret + pos;
334   }
335
336   size_type find(Iter s, size_t pos, size_t n) const {
337     if (pos > size()) return std::string::npos;
338     size_t ret = qfind(pos ? subpiece(pos) : *this, Range(s, n));
339     return ret == npos ? ret : ret + pos;
340   }
341
342   size_type find(const Iter s) const {
343     return qfind(*this, Range(s));
344   }
345
346   size_type find(const Iter s, size_t pos) const {
347     if (pos > size()) return std::string::npos;
348     size_type ret = qfind(subpiece(pos), Range(s));
349     return ret == npos ? ret : ret + pos;
350   }
351
352   size_type find(value_type c) const {
353     return qfind(*this, c);
354   }
355
356   size_type find(value_type c, size_t pos) const {
357     if (pos > size()) return std::string::npos;
358     size_type ret = qfind(subpiece(pos), c);
359     return ret == npos ? ret : ret + pos;
360   }
361
362   void swap(Range& rhs) {
363     std::swap(b_, rhs.b_);
364     std::swap(e_, rhs.e_);
365   }
366
367 private:
368   Iter b_, e_;
369 };
370
371 template <class Iter>
372 const typename Range<Iter>::size_type Range<Iter>::npos;
373
374 template <class T>
375 void swap(Range<T>& lhs, Range<T>& rhs) {
376   lhs.swap(rhs);
377 }
378
379 /**
380  * Create a range from two iterators, with type deduction.
381  */
382 template <class Iter>
383 Range<Iter> makeRange(Iter first, Iter last) {
384   return Range<Iter>(first, last);
385 }
386
387 typedef Range<const char*> StringPiece;
388 typedef Range<const unsigned char*> ByteRange;
389
390 std::ostream& operator<<(std::ostream& os, const StringPiece& piece);
391
392 /**
393  * Templated comparison operators
394  */
395
396 template <class T>
397 inline bool operator==(const Range<T>& lhs, const Range<T>& rhs) {
398   return lhs.size() == rhs.size() && lhs.compare(rhs) == 0;
399 }
400
401 template <class T>
402 inline bool operator<(const Range<T>& lhs, const Range<T>& rhs) {
403   return lhs.compare(rhs) < 0;
404 }
405
406 /**
407  * Specializations of comparison operators for StringPiece
408  */
409
410 namespace detail {
411
412 template <class A, class B>
413 struct ComparableAsStringPiece {
414   enum {
415     value =
416     (boost::is_convertible<A, StringPiece>::value
417      && boost::is_same<B, StringPiece>::value)
418     ||
419     (boost::is_convertible<B, StringPiece>::value
420      && boost::is_same<A, StringPiece>::value)
421   };
422 };
423
424 } // namespace detail
425
426 /**
427  * operator== through conversion for Range<const char*>
428  */
429 template <class T, class U>
430 typename
431 boost::enable_if_c<detail::ComparableAsStringPiece<T, U>::value, bool>::type
432 operator==(const T& lhs, const U& rhs) {
433   return StringPiece(lhs) == StringPiece(rhs);
434 }
435
436 /**
437  * operator< through conversion for Range<const char*>
438  */
439 template <class T, class U>
440 typename
441 boost::enable_if_c<detail::ComparableAsStringPiece<T, U>::value, bool>::type
442 operator<(const T& lhs, const U& rhs) {
443   return StringPiece(lhs) < StringPiece(rhs);
444 }
445
446 /**
447  * operator> through conversion for Range<const char*>
448  */
449 template <class T, class U>
450 typename
451 boost::enable_if_c<detail::ComparableAsStringPiece<T, U>::value, bool>::type
452 operator>(const T& lhs, const U& rhs) {
453   return StringPiece(lhs) > StringPiece(rhs);
454 }
455
456 /**
457  * operator< through conversion for Range<const char*>
458  */
459 template <class T, class U>
460 typename
461 boost::enable_if_c<detail::ComparableAsStringPiece<T, U>::value, bool>::type
462 operator<=(const T& lhs, const U& rhs) {
463   return StringPiece(lhs) <= StringPiece(rhs);
464 }
465
466 /**
467  * operator> through conversion for Range<const char*>
468  */
469 template <class T, class U>
470 typename
471 boost::enable_if_c<detail::ComparableAsStringPiece<T, U>::value, bool>::type
472 operator>=(const T& lhs, const U& rhs) {
473   return StringPiece(lhs) >= StringPiece(rhs);
474 }
475
476 struct StringPieceHash {
477   std::size_t operator()(const StringPiece& str) const {
478     return static_cast<std::size_t>(str.hash());
479   }
480 };
481
482 /**
483  * Finds substrings faster than brute force by borrowing from Boyer-Moore
484  */
485 template <class T, class Comp>
486 size_t qfind(const Range<T>& haystack,
487              const Range<T>& needle,
488              Comp eq) {
489   // Don't use std::search, use a Boyer-Moore-like trick by comparing
490   // the last characters first
491   auto const nsize = needle.size();
492   if (haystack.size() < nsize) {
493     return std::string::npos;
494   }
495   if (!nsize) return 0;
496   auto const nsize_1 = nsize - 1;
497   auto const lastNeedle = needle[nsize_1];
498
499   // Boyer-Moore skip value for the last char in the needle. Zero is
500   // not a valid value; skip will be computed the first time it's
501   // needed.
502   std::string::size_type skip = 0;
503
504   auto i = haystack.begin();
505   auto iEnd = haystack.end() - nsize_1;
506
507   while (i < iEnd) {
508     // Boyer-Moore: match the last element in the needle
509     while (!eq(i[nsize_1], lastNeedle)) {
510       if (++i == iEnd) {
511         // not found
512         return std::string::npos;
513       }
514     }
515     // Here we know that the last char matches
516     // Continue in pedestrian mode
517     for (size_t j = 0; ; ) {
518       assert(j < nsize);
519       if (!eq(i[j], needle[j])) {
520         // Not found, we can skip
521         // Compute the skip value lazily
522         if (skip == 0) {
523           skip = 1;
524           while (skip <= nsize_1 && !eq(needle[nsize_1 - skip], lastNeedle)) {
525             ++skip;
526           }
527         }
528         i += skip;
529         break;
530       }
531       // Check if done searching
532       if (++j == nsize) {
533         // Yay
534         return i - haystack.begin();
535       }
536     }
537   }
538   return std::string::npos;
539 }
540
541 struct AsciiCaseSensitive {
542   bool operator()(char lhs, char rhs) const {
543     return lhs == rhs;
544   }
545 };
546
547 struct AsciiCaseInsensitive {
548   bool operator()(char lhs, char rhs) const {
549     return toupper(lhs) == toupper(rhs);
550   }
551 };
552
553 extern const AsciiCaseSensitive asciiCaseSensitive;
554 extern const AsciiCaseInsensitive asciiCaseInsensitive;
555
556 template <class T>
557 size_t qfind(const Range<T>& haystack,
558              const Range<T>& needle) {
559   return qfind(haystack, needle, asciiCaseSensitive);
560 }
561
562 template <class T>
563 size_t qfind(const Range<T>& haystack,
564              const typename Range<T>::value_type& needle) {
565   return qfind(haystack, makeRange(&needle, &needle + 1));
566 }
567
568 }  // !namespace folly
569
570 FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1(folly::Range);
571
572 #endif // FOLLY_RANGE_H_