grpc 1.40.0.pre1 → 1.42.0.pre1

data/src/core/lib/gpr/useful.h

@@ -19,48 +19,95 @@
 #ifndef GRPC_CORE_LIB_GPR_USEFUL_H
 #define GRPC_CORE_LIB_GPR_USEFUL_H
 
-/** useful macros that don't belong anywhere else */
+#include <grpc/support/port_platform.h>
+
+#include <cstddef>
+
+/** useful utilities that don't belong anywhere else */
+
+namespace grpc_core {
+
+template <typename T>
+T Clamp(T val, T min, T max) {
+  if (val < min) return min;
+  if (max < val) return max;
+  return val;
+}
 
-#define GPR_MIN(a, b) ((a) < (b) ? (a) : (b))
-#define GPR_MAX(a, b) ((a) > (b) ? (a) : (b))
-#define GPR_CLAMP(a, min, max) ((a) < (min) ? (min) : (a) > (max) ? (max) : (a))
 /** rotl, rotr assume x is unsigned */
-#define GPR_ROTL(x, n) (((x) << (n)) | ((x) >> (sizeof(x) * 8 - (n))))
-#define GPR_ROTR(x, n) (((x) >> (n)) | ((x) << (sizeof(x) * 8 - (n))))
+template <typename T>
+constexpr T RotateLeft(T x, T n) {
+  return ((x << n) | (x >> (sizeof(x) * 8 - n)));
+}
+template <typename T>
+constexpr T RotateRight(T x, T n) {
+  return ((x >> n) | (x << (sizeof(x) * 8 - n)));
+}
 
-#define GPR_ARRAY_SIZE(array) (sizeof(array) / sizeof(*(array)))
+// Set the n-th bit of i
+template <typename T>
+T SetBit(T* i, size_t n) {
+  return *i |= (T(1) << n);
+}
+
+// Clear the n-th bit of i
+template <typename T>
+T ClearBit(T* i, size_t n) {
+  return *i &= ~(T(1) << n);
+}
 
-#define GPR_SWAP(type, a, b) \
-  do {                       \
-    type x = a;              \
-    (a) = b;                 \
-    (b) = x;                 \
-  } while (0)
+// Get the n-th bit of i
+template <typename T>
+bool GetBit(T i, size_t n) {
+  return (i & (T(1) << n)) != 0;
+}
 
-/** Set the \a n-th bit of \a i (a mutable pointer). */
-#define GPR_BITSET(i, n) ((*(i)) |= (1u << (n)))
+namespace useful_detail {
+inline constexpr uint32_t HexdigitBitcount(uint32_t x) {
+  return (x - ((x >> 1) & 0x77777777) - ((x >> 2) & 0x33333333) -
+          ((x >> 3) & 0x11111111));
+}
+}  // namespace useful_detail
 
-/** Clear the \a n-th bit of \a i (a mutable pointer). */
-#define GPR_BITCLEAR(i, n) ((*(i)) &= ~(1u << (n)))
+inline constexpr uint32_t BitCount(uint32_t i) {
+  return (((useful_detail::HexdigitBitcount(i) +
+            (useful_detail::HexdigitBitcount(i) >> 4)) &
+           0x0f0f0f0f) %
+          255);
+}
 
-/** Get the \a n-th bit of \a i */
-#define GPR_BITGET(i, n) (((i) & (1u << (n))) != 0)
+inline constexpr uint32_t BitCount(uint64_t i) {
+  return BitCount(uint32_t(i)) + BitCount(uint32_t(i >> 32));
+}
 
-#define GPR_INTERNAL_HEXDIGIT_BITCOUNT(x)                        \
-  ((x) - (((x) >> 1) & 0x77777777) - (((x) >> 2) & 0x33333333) - \
-   (((x) >> 3) & 0x11111111))
+inline constexpr uint32_t BitCount(uint16_t i) { return BitCount(uint32_t(i)); }
+inline constexpr uint32_t BitCount(uint8_t i) { return BitCount(uint32_t(i)); }
+inline constexpr uint32_t BitCount(int64_t i) { return BitCount(uint64_t(i)); }
+inline constexpr uint32_t BitCount(int32_t i) { return BitCount(uint32_t(i)); }
+inline constexpr uint32_t BitCount(int16_t i) { return BitCount(uint16_t(i)); }
+inline constexpr uint32_t BitCount(int8_t i) { return BitCount(uint8_t(i)); }
 
-/** Returns number of bits set in bitset \a i */
-#define GPR_BITCOUNT(i)                          \
-  (((GPR_INTERNAL_HEXDIGIT_BITCOUNT(i) +         \
-     (GPR_INTERNAL_HEXDIGIT_BITCOUNT(i) >> 4)) & \
-    0x0f0f0f0f) %                                \
-   255)
+// This function uses operator< to implement a qsort-style comparison, whereby:
+// if a is smaller than b, a number smaller than 0 is returned.
+// if a is bigger than b, a number greater than 0 is returned.
+// if a is neither smaller nor bigger than b, 0 is returned.
+template <typename T>
+int QsortCompare(const T& a, const T& b) {
+  if (a < b) return -1;
+  if (b < a) return 1;
+  return 0;
+}
 
-#define GPR_ICMP(a, b) ((a) < (b) ? -1 : ((a) > (b) ? 1 : 0))
+template <typename T>
+constexpr size_t HashPointer(T* p, size_t range) {
+  return (((reinterpret_cast<size_t>(p)) >> 4) ^
+          ((reinterpret_cast<size_t>(p)) >> 9) ^
+          ((reinterpret_cast<size_t>(p)) >> 14)) %
+         range;
+}
 
-#define GPR_HASH_POINTER(x, range)                                         \
-  (((((size_t)(x)) >> 4) ^ (((size_t)(x)) >> 9) ^ (((size_t)(x)) >> 14)) % \
-   (range))
+}  // namespace grpc_core
+
+#define GPR_ARRAY_SIZE(array) (sizeof(array) / sizeof(*(array)))
 
 #endif /* GRPC_CORE_LIB_GPR_USEFUL_H */

data/src/core/lib/gprpp/arena.cc

@@ -21,6 +21,7 @@
 #include "src/core/lib/gprpp/arena.h"
 
 #include <string.h>
+
 #include <new>
 
 #include <grpc/support/alloc.h>
@@ -75,7 +76,7 @@ std::pair<Arena*, void*> Arena::CreateWithAlloc(size_t initial_size,
 }
 
 size_t Arena::Destroy() {
-  size_t size = total_used_.Load(MemoryOrder::RELAXED);
+  size_t size = total_used_.load(std::memory_order_relaxed);
   this->~Arena();
   gpr_free_aligned(this);
   return size;

data/src/core/lib/gprpp/arena.h

@@ -27,6 +27,10 @@
 
 #include <grpc/support/port_platform.h>
 
+#include <stddef.h>
+
+#include <atomic>
+#include <memory>
 #include <new>
 #include <utility>
 
@@ -35,9 +39,6 @@
 
 #include "src/core/lib/gpr/alloc.h"
 #include "src/core/lib/gpr/spinlock.h"
-#include "src/core/lib/gprpp/atomic.h"
-
-#include <stddef.h>
 
 namespace grpc_core {
 
@@ -59,7 +60,7 @@ class Arena {
     static constexpr size_t base_size =
         GPR_ROUND_UP_TO_ALIGNMENT_SIZE(sizeof(Arena));
     size = GPR_ROUND_UP_TO_ALIGNMENT_SIZE(size);
-    size_t begin = total_used_.FetchAdd(size, MemoryOrder::RELAXED);
+    size_t begin = total_used_.fetch_add(size, std::memory_order_relaxed);
     if (begin + size <= initial_zone_size_) {
       return reinterpret_cast<char*>(this) + base_size + begin;
     } else {
@@ -105,7 +106,7 @@ class Arena {
 
   // Keep track of the total used size. We use this in our call sizing
   // hysteresis.
-  Atomic<size_t> total_used_;
+  std::atomic<size_t> total_used_{0};
   const size_t initial_zone_size_;
   gpr_spinlock arena_growth_spinlock_ = GPR_SPINLOCK_STATIC_INITIALIZER;
   // If the initial arena allocation wasn't enough, we allocate additional zones
@@ -116,6 +117,15 @@ class Arena {
   Zone* last_zone_ = nullptr;
 };
 
+// Smart pointer for arenas when the final size is not required.
+struct ScopedArenaDeleter {
+  void operator()(Arena* arena) { arena->Destroy(); }
+};
+using ScopedArenaPtr = std::unique_ptr<Arena, ScopedArenaDeleter>;
+inline ScopedArenaPtr MakeScopedArena(size_t initial_size) {
+  return ScopedArenaPtr(Arena::Create(initial_size));
+}
+
 }  // namespace grpc_core
 
 #endif /* GRPC_CORE_LIB_GPRPP_ARENA_H */

data/src/core/lib/gprpp/atomic_utils.h

@@ -0,0 +1,47 @@
+/*
+ *
+ * Copyright 2017 gRPC authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+#ifndef GRPC_CORE_LIB_GPRPP_ATOMIC_UTILS_H
+#define GRPC_CORE_LIB_GPRPP_ATOMIC_UTILS_H
+
+#include <grpc/support/port_platform.h>
+
+#include <atomic>
+
+namespace grpc_core {
+
+// Atomically increment a counter only if the counter value is not zero.
+// Returns true if increment took place; false if counter is zero.
+template <typename T>
+inline bool IncrementIfNonzero(std::atomic<T>* p) {
+  T count = p->load(std::memory_order_acquire);
+  do {
+    // If zero, we are done (without an increment). If not, we must do a CAS
+    // to maintain the contract: do not increment the counter if it is already
+    // zero
+    if (count == 0) {
+      return false;
+    }
+  } while (!p->compare_exchange_weak(
+      count, count + 1, std::memory_order_acq_rel, std::memory_order_acquire));
+  return true;
+}
+
+}  // namespace grpc_core
+
+#endif /* GRPC_CORE_LIB_GPRPP_ATOMIC_UTILS_H */

data/src/core/lib/gprpp/bitset.h

@@ -0,0 +1,188 @@
+// Copyright 2021 gRPC authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef GRPC_CORE_LIB_GPRPP_BITSET_H
+#define GRPC_CORE_LIB_GPRPP_BITSET_H
+
+#include <grpc/support/port_platform.h>
+
+#include <utility>
+
+#include "src/core/lib/gpr/useful.h"
+
+#if __cplusplus > 201103l
+#define GRPC_BITSET_CONSTEXPR_MUTATOR constexpr
+#else
+#define GRPC_BITSET_CONSTEXPR_MUTATOR
+#endif
+
+namespace grpc_core {
+
+// Given a bit count as an integer, vend as member type `Type` a type with
+// exactly that number of bits. Undefined if that bit count is not available.
+template <size_t kBits>
+struct UintSelector;
+template <>
+struct UintSelector<8> {
+  typedef uint8_t Type;
+};
+template <>
+struct UintSelector<16> {
+  typedef uint16_t Type;
+};
+template <>
+struct UintSelector<32> {
+  typedef uint32_t Type;
+};
+template <>
+struct UintSelector<64> {
+  typedef uint64_t Type;
+};
+
+// An unsigned integer of some number of bits.
+template <size_t kBits>
+using Uint = typename UintSelector<kBits>::Type;
+
+// Given the total number of bits that need to be stored, choose the size of
+// 'unit' for a BitSet... We'll use an array of units to store the total set.
+// For small bit counts we are selective in the type to try and balance byte
+// size and performance
+// - the details will likely be tweaked into the future.
+// Once we get over 96 bits, we just use uint64_t for everything.
+constexpr size_t ChooseUnitBitsForBitSet(size_t total_bits) {
+  return total_bits <= 8    ? 8
+         : total_bits <= 16 ? 16
+         : total_bits <= 24 ? 8
+         : total_bits <= 32 ? 32
+         : total_bits <= 48 ? 16
+         : total_bits <= 64 ? 64
+         : total_bits <= 96 ? 32
+                            : 64;
+}
+
+// A BitSet that's configurable.
+// Contains storage for kTotalBits, stored as an array of integers of size
+// kUnitBits. e.g. to store 72 bits in 8 bit chunks, we'd say BitSet<72, 8>.
+// Since most users shouldn't care about the size of unit used, we default
+// kUnitBits to whatever is selected by ChooseUnitBitsForBitSet
+template <size_t kTotalBits,
+          size_t kUnitBits = ChooseUnitBitsForBitSet(kTotalBits)>
+class BitSet {
+  static constexpr size_t kUnits = (kTotalBits + kUnitBits - 1) / kUnitBits;
+
+ public:
+  // Initialize to all bits false
+  constexpr BitSet() : units_{} {}
+
+  // Set bit i to true
+  GRPC_BITSET_CONSTEXPR_MUTATOR void set(int i) {
+    units_[unit_for(i)] |= mask_for(i);
+  }
+
+  // Set bit i to is_set
+  GRPC_BITSET_CONSTEXPR_MUTATOR void set(int i, bool is_set) {
+    if (is_set) {
+      set(i);
+    } else {
+      clear(i);
+    }
+  }
+
+  // Set bit i to false
+  GRPC_BITSET_CONSTEXPR_MUTATOR void clear(int i) {
+    units_[unit_for(i)] &= ~mask_for(i);
+  }
+
+  // Return true if bit i is set
+  constexpr bool is_set(int i) const {
+    return (units_[unit_for(i)] & mask_for(i)) != 0;
+  }
+
+  // Return true if all bits are set
+  bool all() const {
+    if (kTotalBits % kUnitBits == 0) {
+      // kTotalBits is a multiple of kUnitBits ==> we can just check for all
+      // ones in each unit.
+      for (size_t i = 0; i < kUnits; i++) {
+        if (units_[i] != all_ones()) return false;
+      }
+      return true;
+    } else {
+      // kTotalBits is not a multiple of kUnitBits ==> we need special handling
+      // for checking partial filling of the last unit (since not all of its
+      // bits are used!)
+      for (size_t i = 0; i < kUnits - 1; i++) {
+        if (units_[i] != all_ones()) return false;
+      }
+      return units_[kUnits - 1] == n_ones(kTotalBits % kUnitBits);
+    }
+  }
+
+  // Return true if *no* bits are set.
+  bool none() const {
+    for (size_t i = 0; i < kUnits; i++) {
+      if (units_[i] != 0) return false;
+    }
+    return true;
+  }
+
+  // Return a count of how many bits are set.
+  uint32_t count() const {
+    uint32_t count = 0;
+    for (size_t i = 0; i < kUnits; i++) {
+      count += BitCount(units_[i]);
+    }
+    return count;
+  }
+
+ private:
+  // Given a bit index, return which unit it's stored in.
+  static constexpr size_t unit_for(size_t bit) { return bit / kUnitBits; }
+
+  // Given a bit index, return a mask to access that bit within it's unit.
+  static constexpr Uint<kUnitBits> mask_for(size_t bit) {
+    return Uint<kUnitBits>{1} << (bit % kUnitBits);
+  }
+
+  // Return a value that is all ones
+  static constexpr Uint<kUnitBits> all_ones() {
+    return Uint<kUnitBits>(~Uint<kUnitBits>(0));
+  }
+
+  // Return a value with n bottom bits ones
+  static constexpr Uint<kUnitBits> n_ones(size_t n) {
+    return n == kUnitBits ? all_ones() : (Uint<kUnitBits>(1) << n) - 1;
+  }
+
+  // The set of units - kUnitBits sized integers that store kUnitBits bits!
+  Uint<kUnitBits> units_[kUnits];
+};
+
+// Zero-size specialization of BitSet.
+// Useful for generic programming.
+// Make a compile time error out of get/set type accesses, and hard-codes
+// queries that do make sense.
+template <>
+class BitSet<0> {
+ public:
+  constexpr BitSet() {}
+
+  bool all() const { return true; }
+  bool none() const { return true; }
+  uint32_t count() const { return 0; }
+};
+
+}  // namespace grpc_core
+
+#endif  // GRPC_CORE_LIB_GPRPP_BITSET_H

data/src/core/lib/gprpp/chunked_vector.h

@@ -0,0 +1,211 @@
+// Copyright 2021 gRPC authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef GRPC_CORE_LIB_GPRPP_CHUNKED_VECTOR_H
+#define GRPC_CORE_LIB_GPRPP_CHUNKED_VECTOR_H
+
+#include <grpc/support/port_platform.h>
+
+#include "src/core/lib/gprpp/arena.h"
+#include "src/core/lib/gprpp/manual_constructor.h"
+
+namespace grpc_core {
+
+// Arena-friendly vector type.
+// This "vector" allocates non-contiguous runs of kChunkSize T's at a time.
+// Expectation is that most usage will fit in one chunk, sometimes two will be
+// needed, and very rarely three. Appending is constant time, calculating the
+// size is O(n_chunks).
+template <typename T, size_t kChunkSize>
+class ChunkedVector {
+ private:
+  // One chunk of allocated memory.
+  struct Chunk {
+    Chunk() = default;
+    Chunk* next = nullptr;
+    size_t count = 0;
+    ManualConstructor<T> data[kChunkSize];
+  };
+
+ public:
+  explicit ChunkedVector(Arena* arena) : arena_(arena) {}
+  template <class Iterator>
+  ChunkedVector(Arena* arena, Iterator begin, Iterator end) : arena_(arena) {
+    for (; begin != end; ++begin) {
+      EmplaceBack(*begin);
+    }
+  }
+  ChunkedVector(const ChunkedVector& other)
+      : ChunkedVector(other.arena_, other.begin(), other.end()) {}
+  ChunkedVector& operator=(ChunkedVector other) {
+    Swap(&other);
+    return *this;
+  }
+  ChunkedVector(ChunkedVector&& other) noexcept
+      : arena_(other.arena_), first_(other.first_), append_(other.append_) {
+    other.first_ = nullptr;
+    other.append_ = nullptr;
+  }
+  ChunkedVector& operator=(ChunkedVector&& other) noexcept {
+    Swap(&other);
+    return *this;
+  }
+  ~ChunkedVector() { Clear(); }
+  void Swap(ChunkedVector* other) {
+    std::swap(other->arena_, arena_);
+    std::swap(other->first_, first_);
+    std::swap(other->append_, append_);
+  }
+
+  Arena* arena() const { return arena_; }
+
+  // Append a new element to the end of the vector.
+  template <typename... Args>
+  T* EmplaceBack(Args&&... args) {
+    auto* p = AppendSlot();
+    p->Init(std::forward<Args>(args)...);
+    return &**p;
+  }
+
+  // Remove the last element and return it.
+  T PopBack() {
+    GPR_ASSERT(append_ != nullptr);
+    if (append_->count == 0) {
+      GPR_ASSERT(first_ != append_);
+      Chunk* chunk = first_;
+      while (chunk->next != append_) {
+        chunk = chunk->next;
+      }
+      append_ = chunk;
+    }
+    const auto last = append_->count - 1;
+    T result = std::move(*append_->data[last]);
+    append_->data[last].Destroy();
+    append_->count = last;
+    return result;
+  }
+
+  void Clear() {
+    Chunk* chunk = first_;
+    while (chunk != nullptr && chunk->count != 0) {
+      for (size_t i = 0; i < chunk->count; i++) {
+        chunk->data[i].Destroy();
+      }
+      chunk->count = 0;
+      chunk = chunk->next;
+    }
+    append_ = first_;
+  }
+
+  // Forward-only iterator.
+  class ForwardIterator {
+   public:
+    ForwardIterator(Chunk* chunk, size_t n) : chunk_(chunk), n_(n) {}
+
+    T& operator*() const { return *chunk_->data[n_]; }
+    T* operator->() const { return &*chunk_->data[n_]; }
+    ForwardIterator& operator++() {
+      ++n_;
+      while (chunk_ != nullptr && n_ == chunk_->count) {
+        chunk_ = chunk_->next;
+        n_ = 0;
+      }
+      return *this;
+    }
+    bool operator==(const ForwardIterator& other) const {
+      return chunk_ == other.chunk_ && n_ == other.n_;
+    }
+    bool operator!=(const ForwardIterator& other) const {
+      return !(*this == other);
+    }
+
+   private:
+    Chunk* chunk_;
+    size_t n_;
+  };
+
+  // Const Forward-only iterator.
+  class ConstForwardIterator {
+   public:
+    ConstForwardIterator(const Chunk* chunk, size_t n) : chunk_(chunk), n_(n) {}
+
+    const T& operator*() const { return *chunk_->data[n_]; }
+    const T* operator->() const { return &*chunk_->data[n_]; }
+    ConstForwardIterator& operator++() {
+      ++n_;
+      while (chunk_ != nullptr && n_ == chunk_->count) {
+        chunk_ = chunk_->next;
+        n_ = 0;
+      }
+      return *this;
+    }
+    bool operator==(const ConstForwardIterator& other) const {
+      return chunk_ == other.chunk_ && n_ == other.n_;
+    }
+    bool operator!=(const ConstForwardIterator& other) const {
+      return !(*this == other);
+    }
+
+   private:
+    const Chunk* chunk_;
+    size_t n_;
+  };
+
+  ForwardIterator begin() {
+    if (first_ != nullptr && first_->count == 0) return end();
+    return ForwardIterator(first_, 0);
+  }
+  ForwardIterator end() { return ForwardIterator(nullptr, 0); }
+
+  ConstForwardIterator begin() const {
+    if (first_ != nullptr && first_->count == 0) return cend();
+    return ConstForwardIterator(first_, 0);
+  }
+  ConstForwardIterator end() const { return ConstForwardIterator(nullptr, 0); }
+
+  ConstForwardIterator cbegin() const { return begin(); }
+  ConstForwardIterator cend() const { return end(); }
+
+  // Count the number of elements in the vector.
+  size_t size() const {
+    size_t n = 0;
+    for (const Chunk* chunk = first_; chunk != nullptr; chunk = chunk->next) {
+      n += chunk->count;
+    }
+    return n;
+  }
+
+ private:
+  ManualConstructor<T>* AppendSlot() {
+    if (append_ == nullptr) {
+      GPR_ASSERT(first_ == nullptr);
+      first_ = arena_->New<Chunk>();
+      append_ = first_;
+    } else if (append_->count == kChunkSize) {
+      if (append_->next == nullptr) {
+        append_->next = arena_->New<Chunk>();
+      }
+      append_ = append_->next;
+    }
+    return &append_->data[append_->count++];
+  }
+
+  Arena* arena_;
+  Chunk* first_ = nullptr;
+  Chunk* append_ = nullptr;
+};
+
+}  // namespace grpc_core
+
+#endif  // GRPC_CORE_LIB_GPRPP_CHUNKED_VECTOR_H