Avoid heap allocations in IPAddress

net/base/ip_address.cc

 // Copyright (c) 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/base/ip_address.h"
 
 #include <limits.h>
+#include <algorithm>
 
 #include "base/strings/string_piece.h"
 #include "base/strings/string_split.h"
 #include "base/strings/stringprintf.h"
 #include "net/base/parse_number.h"
 #include "url/gurl.h"
 #include "url/url_canon_ip.h"
 
+namespace net {
 namespace {
 
 // The prefix for IPv6 mapped IPv4 addresses.
 // https://tools.ietf.org/html/rfc4291#section-2.5.5.2
 const uint8_t kIPv4MappedPrefix[] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF};
 
 // Note that this function assumes:
 // * |ip_address| is at least |prefix_length_in_bits| (bits) long;
 // * |ip_prefix| is at least |prefix_length_in_bits| (bits) long.
-bool IPAddressPrefixCheck(const std::vector<uint8_t>& ip_address,
+bool IPAddressPrefixCheck(const IPAddress::IPAddressBytes& ip_address,
                           const uint8_t* ip_prefix,
                           size_t prefix_length_in_bits) {
   // Compare all the bytes that fall entirely within the prefix.
   size_t num_entire_bytes_in_prefix = prefix_length_in_bits / 8;
   for (size_t i = 0; i < num_entire_bytes_in_prefix; ++i) {
     if (ip_address[i] != ip_prefix[i])
       return false;
   }
 
   // In case the prefix was not a multiple of 8, there will be 1 byte
   // which is only partially masked.
   size_t remaining_bits = prefix_length_in_bits % 8;
   if (remaining_bits != 0) {
     uint8_t mask = 0xFF << (8 - remaining_bits);
     size_t i = num_entire_bytes_in_prefix;
     if ((ip_address[i] & mask) != (ip_prefix[i] & mask))
       return false;
   }
   return true;
 }
 
 // Returns true if |ip_address| matches any of the reserved IPv4 ranges. This
 // method operates on a blacklist of reserved IPv4 ranges. Some ranges are
 // consolidated.
 // Sources for info:
 // www.iana.org/assignments/ipv4-address-space/ipv4-address-space.xhtml
 // www.iana.org/assignments/iana-ipv4-special-registry/
 // iana-ipv4-special-registry.xhtml
-bool IsReservedIPv4(const std::vector<uint8_t>& ip_address) {
+bool IsReservedIPv4(const IPAddress::IPAddressBytes& ip_address) {
   // Different IP versions have different range reservations.
-  DCHECK_EQ(net::IPAddress::kIPv4AddressSize, ip_address.size());
+  DCHECK_EQ(IPAddress::kIPv4AddressSize, ip_address.size());
   struct {
     const uint8_t address[4];
     size_t prefix_length_in_bits;
   } static const kReservedIPv4Ranges[] = {
       {{0, 0, 0, 0}, 8},     {{10, 0, 0, 0}, 8},      {{100, 64, 0, 0}, 10},
       {{127, 0, 0, 0}, 8},   {{169, 254, 0, 0}, 16},  {{172, 16, 0, 0}, 12},
       {{192, 0, 2, 0}, 24},  {{192, 88, 99, 0}, 24},  {{192, 168, 0, 0}, 16},
       {{198, 18, 0, 0}, 15}, {{198, 51, 100, 0}, 24}, {{203, 0, 113, 0}, 24},
       {{224, 0, 0, 0}, 3}};
 
   for (const auto& range : kReservedIPv4Ranges) {
     if (IPAddressPrefixCheck(ip_address, range.address,
                              range.prefix_length_in_bits)) {
       return true;
     }
   }
 
   return false;
 }
 
 // Returns true if |ip_address| matches any of the reserved IPv6 ranges. This
 // method operates on a whitelist of non-reserved IPv6 ranges. All IPv6
 // addresses outside these ranges are reserved.
 // Sources for info:
 // www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
-bool IsReservedIPv6(const std::vector<uint8_t>& ip_address) {
+bool IsReservedIPv6(const IPAddress::IPAddressBytes& ip_address) {
   // Different IP versions have different range reservations.
-  DCHECK_EQ(net::IPAddress::kIPv6AddressSize, ip_address.size());
+  DCHECK_EQ(IPAddress::kIPv6AddressSize, ip_address.size());
   struct {
     const uint8_t address_prefix[2];
     size_t prefix_length_in_bits;
   } static const kPublicIPv6Ranges[] = {
       // 2000::/3  -- Global Unicast
       {{0x20, 0}, 3},
       // ff00::/8  -- Multicast
       {{0xff, 0}, 8},
   };
 
   for (const auto& range : kPublicIPv6Ranges) {
     if (IPAddressPrefixCheck(ip_address, range.address_prefix,
                              range.prefix_length_in_bits)) {
       return false;
     }
   }
 
   return true;
 }
 
 bool ParseIPLiteralToBytes(const base::StringPiece& ip_literal,
-                           std::vector<uint8_t>* bytes) {
+                           IPAddress::IPAddressBytes* bytes) {
   // |ip_literal| could be either an IPv4 or an IPv6 literal. If it contains
   // a colon however, it must be an IPv6 address.
   if (ip_literal.find(':') != base::StringPiece::npos) {
     // GURL expects IPv6 hostnames to be surrounded with brackets.
     std::string host_brackets = "[";
     ip_literal.AppendToString(&host_brackets);
     host_brackets.push_back(']');
     url::Component host_comp(0, host_brackets.size());
 
     // Try parsing the hostname as an IPv6 literal.
-    bytes->resize(16);  // 128 bits.
+    bytes->Resize(16);  // 128 bits.
     return url::IPv6AddressToNumber(host_brackets.data(), host_comp,
                                     bytes->data());
   }
 
   // Otherwise the string is an IPv4 address.
-  bytes->resize(4);  // 32 bits.
+  bytes->Resize(4);  // 32 bits.
   url::Component host_comp(0, ip_literal.size());
   int num_components;
   url::CanonHostInfo::Family family = url::IPv4AddressToNumber(
       ip_literal.data(), host_comp, bytes->data(), &num_components);
   return family == url::CanonHostInfo::IPV4;
 }
 
 }  // namespace
 
-namespace net {
+IPAddress::IPAddressBytes::IPAddressBytes() : size_(0) {}
+
+IPAddress::IPAddressBytes::IPAddressBytes(const uint8_t* data, size_t data_len)
+    : size_(data_len) {
+  CHECK_GE(16u, data_len);
+  std::copy_n(data, data_len, bytes_.data());
+}
+
+IPAddress::IPAddressBytes::~IPAddressBytes() {}
+IPAddress::IPAddressBytes::IPAddressBytes(
+    IPAddress::IPAddressBytes const& other) = default;
+
+bool IPAddress::IPAddressBytes::operator<(
+    const IPAddress::IPAddressBytes& other) const {
+  if (size_ < other.size_)
+    return true;
+  if (size_ > other.size_)
+    return false;
+  for (size_t i = 0; i < size_; ++i) {

[eroman, 2017/05/19 17:37:54]

Since you already include <algorithm> could do:

return std::lexicographical_compare(begin(), end(), other.begin(), other.end());

[Ryan Hamilton, 2017/05/19 21:30:46]

BRILLIANT! I had no idea this existed, but it does explain references to
"lexicographical_compare" I found in other documentation.

Done.

+    if (bytes_[i] < other.bytes_[i])
+      return true;
+    if (bytes_[i] > other.bytes_[i])
+      return false;
+  }
+  return false;
+}
+
+bool IPAddress::IPAddressBytes::operator==(

[eroman, 2017/05/19 17:37:54]

Or:

return std::equal(begin(), end(), other.begin(), other.end());

[Ryan Hamilton, 2017/05/19 21:30:46]

Done. (though std::equal does not take 4 args, curiously)

+    const IPAddress::IPAddressBytes& other) const {
+  if (size_ != other.size_)
+    return false;
+  for (size_t i = 0; i < size_; ++i) {
+    if (bytes_[i] != other.bytes_[i])
+      return false;
+  }
+  return true;
+}
+
+bool IPAddress::IPAddressBytes::operator!=(
+    const IPAddress::IPAddressBytes& other) const {
+  return !(*this == other);
+}
 
 IPAddress::IPAddress() {}
 
 IPAddress::IPAddress(const std::vector<uint8_t>& address)
-    : ip_address_(address) {}
+    : ip_address_(address.data(), address.size()) {}
+
+IPAddress::IPAddress(const base::StackVector<uint8_t, 16>& address)
+    : ip_address_(address->data(), address->size()) {}
 
 IPAddress::IPAddress(const IPAddress& other) = default;
 
 IPAddress::IPAddress(const uint8_t* address, size_t address_len)
-    : ip_address_(address, address + address_len) {}
+    : ip_address_(address, address_len) {}
 
 IPAddress::IPAddress(uint8_t b0, uint8_t b1, uint8_t b2, uint8_t b3) {
-  ip_address_.reserve(4);
   ip_address_.push_back(b0);
   ip_address_.push_back(b1);
   ip_address_.push_back(b2);
   ip_address_.push_back(b3);
 }
 
 IPAddress::IPAddress(uint8_t b0,
                      uint8_t b1,
                      uint8_t b2,
                      uint8_t b3,
                      uint8_t b4,
                      uint8_t b5,
                      uint8_t b6,
                      uint8_t b7,
                      uint8_t b8,
                      uint8_t b9,
                      uint8_t b10,
                      uint8_t b11,
                      uint8_t b12,
                      uint8_t b13,
                      uint8_t b14,
                      uint8_t b15) {
-  const uint8_t address[] = {b0, b1, b2,  b3,  b4,  b5,  b6,  b7,
-                             b8, b9, b10, b11, b12, b13, b14, b15};
-  ip_address_ = std::vector<uint8_t>(std::begin(address), std::end(address));
+  ip_address_.push_back(b0);
+  ip_address_.push_back(b1);
+  ip_address_.push_back(b2);
+  ip_address_.push_back(b3);
+  ip_address_.push_back(b4);
+  ip_address_.push_back(b5);
+  ip_address_.push_back(b6);
+  ip_address_.push_back(b7);
+  ip_address_.push_back(b8);
+  ip_address_.push_back(b9);
+  ip_address_.push_back(b10);
+  ip_address_.push_back(b11);
+  ip_address_.push_back(b12);
+  ip_address_.push_back(b13);
+  ip_address_.push_back(b14);
+  ip_address_.push_back(b15);
 }
 
 IPAddress::~IPAddress() {}
 
 bool IPAddress::IsIPv4() const {
   return ip_address_.size() == kIPv4AddressSize;
 }
 
 bool IPAddress::IsIPv6() const {
   return ip_address_.size() == kIPv6AddressSize;
@@ skipping 19 matching lines @@
   }
 
   return !empty();
 }
 
 bool IPAddress::IsIPv4MappedIPv6() const {
   return IsIPv6() && IPAddressStartsWith(*this, kIPv4MappedPrefix);
 }
 
 bool IPAddress::AssignFromIPLiteral(const base::StringPiece& ip_literal) {
-  std::vector<uint8_t> number;
+  IPAddressBytes number;
 
+  // TODO(rch): change the contract so ip_address_ is cleared on failure,
+  // to avoid needing this temporary at all.
   if (!ParseIPLiteralToBytes(ip_literal, &number))
     return false;
 
-  std::swap(number, ip_address_);
+  ip_address_ = number;
   return true;
 }
 
+std::vector<uint8_t> IPAddress::BytesAsVector() const {
+  return std::vector<uint8_t>(ip_address_.begin(), ip_address_.end());
+}
+
 // static
 IPAddress IPAddress::IPv4Localhost() {
   static const uint8_t kLocalhostIPv4[] = {127, 0, 0, 1};
   return IPAddress(kLocalhostIPv4);
 }
 
 // static
 IPAddress IPAddress::IPv6Localhost() {
   static const uint8_t kLocalhostIPv6[] = {0, 0, 0, 0, 0, 0, 0, 0,
                                            0, 0, 0, 0, 0, 0, 0, 1};
   return IPAddress(kLocalhostIPv6);
 }
 
 // static
 IPAddress IPAddress::AllZeros(size_t num_zero_bytes) {
-  return IPAddress(std::vector<uint8_t>(num_zero_bytes));
+  base::StackVector<uint8_t, 16> bytes;

[eroman, 2017/05/19 17:37:54]

optional: If you want to save a extra copy:

CHECK_LE(num_zero_bytes, 16);
IPAddress result;
result.Resize(num_zero_bytes);
std::fill(result.begin(), result.end(), 0);
return result;

[Ryan Hamilton, 2017/05/19 21:30:46]

There are a couple of problems with this. begin() and end are on IPAddressBytes
not IPAddress. So that's easy. but then they return const refs not mutable refs.

So how 'bout I just push_back(0u) on the underlying IPAddressBytes?

+  bytes->resize(num_zero_bytes);
+  return IPAddress(bytes);
 }
 
 // static
 IPAddress IPAddress::IPv4AllZeros() {
   return AllZeros(kIPv4AddressSize);
 }
 
 // static
 IPAddress IPAddress::IPv6AllZeros() {
   return AllZeros(kIPv6AddressSize);
@@ skipping 44 matching lines @@
 
 std::string IPAddressToPackedString(const IPAddress& address) {
   return std::string(reinterpret_cast<const char*>(address.bytes().data()),
                      address.size());
 }
 
 IPAddress ConvertIPv4ToIPv4MappedIPv6(const IPAddress& address) {
   DCHECK(address.IsIPv4());
   // IPv4-mapped addresses are formed by:
   // <80 bits of zeros>  + <16 bits of ones> + <32-bit IPv4 address>.
-  std::vector<uint8_t> bytes;
-  bytes.reserve(16);
-  bytes.insert(bytes.end(), std::begin(kIPv4MappedPrefix),
-               std::end(kIPv4MappedPrefix));
-  bytes.insert(bytes.end(), address.bytes().begin(), address.bytes().end());
+  base::StackVector<uint8_t, 16> bytes;
+  bytes->insert(bytes->end(), std::begin(kIPv4MappedPrefix),
+                std::end(kIPv4MappedPrefix));
+  bytes->insert(bytes->end(), address.bytes().begin(), address.bytes().end());
   return IPAddress(bytes);
 }
 
 IPAddress ConvertIPv4MappedIPv6ToIPv4(const IPAddress& address) {
   DCHECK(address.IsIPv4MappedIPv6());
 
-  return IPAddress(std::vector<uint8_t>(
-      address.bytes().begin() + arraysize(kIPv4MappedPrefix),
-      address.bytes().end()));
+  base::StackVector<uint8_t, 16> bytes;
+  bytes->insert(bytes->end(),
+                address.bytes().begin() + arraysize(kIPv4MappedPrefix),
+                address.bytes().end());
+  return IPAddress(bytes);
 }
 
 bool IPAddressMatchesPrefix(const IPAddress& ip_address,
                             const IPAddress& ip_prefix,
                             size_t prefix_length_in_bits) {
   // Both the input IP address and the prefix IP address should be either IPv4
   // or IPv6.
   DCHECK(ip_address.IsValid());
   DCHECK(ip_prefix.IsValid());
 
@@ skipping 67 matching lines @@
       if (diff & (1 << (CHAR_BIT - 1)))
         return i * CHAR_BIT + j;
       diff <<= 1;
     }
     NOTREACHED();
   }
   return a1.size() * CHAR_BIT;
 }
 
 unsigned MaskPrefixLength(const IPAddress& mask) {
-  std::vector<uint8_t> all_ones(mask.size(), 0xFF);
+  base::StackVector<uint8_t, 16> all_ones;
+  all_ones->resize(mask.size(), 0xFF);
   return CommonPrefixLength(mask, IPAddress(all_ones));
 }
 
 }  // namespace net