folly/IPAddressV4.h

   1 /*
   2  * Copyright 2016 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 #pragma once
  18
  19 #include <cstring>
  20
  21 #include <array>
  22 #include <functional>
  23 #include <iosfwd>
  24
  25 #include <folly/Hash.h>
  26 #include <folly/Range.h>
  27 #include <folly/detail/IPAddress.h>
  28
  29 namespace folly {
  30
  31 class IPAddress;
  32 class IPAddressV4;
  33 class IPAddressV6;
  34
  35 /**
  36  * Pair of IPAddressV4, netmask
  37  */
  38 typedef std::pair<IPAddressV4, uint8_t> CIDRNetworkV4;
  39
  40 /**
  41  * Specialization for IPv4 addresses
  42  */
  43 typedef std::array<uint8_t, 4> ByteArray4;
  44
  45 /**
  46  * IPv4 variation of IPAddress.
  47  *
  48  * Added methods: toLong, toLongHBO and createIPv6
  49  *
  50  * @note toLong/fromLong deal in network byte order, use toLongHBO/fromLongHBO
  51  * if working in host byte order.
  52  *
  53  * @see IPAddress
  54  */
  55 class IPAddressV4 {
  56  public:
  57   // returns true iff the input string can be parsed as an ipv4-address
  58   static bool validate(StringPiece ip);
  59
  60   // create an IPAddressV4 instance from a uint32_t (network byte order)
  61   static IPAddressV4 fromLong(uint32_t src);
  62   // same as above but host byte order
  63   static IPAddressV4 fromLongHBO(uint32_t src);
  64
  65   /**
  66    * Create a new IPAddress instance from the provided binary data.
  67    * @throws IPAddressFormatException if the input length is not 4 bytes.
  68    */
  69   static IPAddressV4 fromBinary(ByteRange bytes) {
  70     IPAddressV4 addr;
  71     addr.setFromBinary(bytes);
  72     return addr;
  73   }
  74
  75   /**
  76    * Returns the address as a Range.
  77    */
  78   ByteRange toBinary() const {
  79     return ByteRange((const unsigned char *) &addr_.inAddr_.s_addr, 4);
  80   }
  81
  82   /**
  83    * Convert a IPv4 address string to a long in network byte order.
  84    * @param [in] ip the address to convert
  85    * @return the long representation of the address
  86    */
  87   static uint32_t toLong(StringPiece ip);
  88   // Same as above, but in host byte order.
  89   // This is slightly slower than toLong.
  90   static uint32_t toLongHBO(StringPiece ip);
  91
  92   /**
  93    * Default constructor for IPAddressV4.
  94    *
  95    * The address value will be 0.0.0.0
  96    */
  97   IPAddressV4();
  98
  99   // Create an IPAddressV4 from a string
 100   // @throws IPAddressFormatException
 101   explicit IPAddressV4(StringPiece ip);
 102
 103   // ByteArray4 constructor
 104   explicit IPAddressV4(const ByteArray4& src);
 105
 106   // in_addr constructor
 107   explicit IPAddressV4(const in_addr src);
 108
 109   // Return the V6 mapped representation of the address.
 110   IPAddressV6 createIPv6() const;
 111
 112   /**
 113    * Return a V6 address in the format of an 6To4 address.
 114    */
 115   IPAddressV6 getIPv6For6To4() const;
 116
 117   // Return the long (network byte order) representation of the address.
 118   uint32_t toLong() const {
 119     return toAddr().s_addr;
 120   }
 121
 122   // Return the long (host byte order) representation of the address.
 123   // This is slightly slower than toLong.
 124   uint32_t toLongHBO() const {
 125     return ntohl(toLong());
 126   }
 127
 128   /**
 129    * @see IPAddress#bitCount
 130    * @returns 32
 131    */
 132   static size_t bitCount() { return 32; }
 133
 134   /**
 135    * @See IPAddress#toJson
 136    */
 137   std::string toJson() const;
 138
 139   size_t hash() const {
 140     static const uint32_t seed = AF_INET;
 141     uint32_t hashed = hash::fnv32_buf(&addr_, 4);
 142     return hash::hash_combine(seed, hashed);
 143   }
 144
 145   // @see IPAddress#inSubnet
 146   // @throws IPAddressFormatException if string doesn't contain a V4 address
 147   bool inSubnet(StringPiece cidrNetwork) const;
 148
 149   // return true if address is in subnet
 150   bool inSubnet(const IPAddressV4& subnet, uint8_t cidr) const {
 151     return inSubnetWithMask(subnet, fetchMask(cidr));
 152   }
 153   bool inSubnetWithMask(const IPAddressV4& subnet, const ByteArray4 mask) const;
 154
 155   // @see IPAddress#isLoopback
 156   bool isLoopback() const;
 157
 158   // @see IPAddress#isLinkLocal
 159   bool isLinkLocal() const;
 160
 161   // @see IPAddress#isNonroutable
 162   bool isNonroutable() const;
 163
 164   // @see IPAddress#isPrivate
 165   bool isPrivate() const;
 166
 167   // @see IPAddress#isMulticast
 168   bool isMulticast() const;
 169
 170   // @see IPAddress#isZero
 171   bool isZero() const {
 172     constexpr auto zero = ByteArray4{{}};
 173     return 0 == std::memcmp(bytes(), zero.data(), zero.size());
 174   }
 175
 176   bool isLinkLocalBroadcast() const {
 177     return (INADDR_BROADCAST == toLongHBO());
 178   }
 179
 180   // @see IPAddress#mask
 181   IPAddressV4 mask(size_t numBits) const;
 182
 183   // @see IPAddress#str
 184   std::string str() const;
 185
 186   // return underlying in_addr structure
 187   in_addr toAddr() const { return addr_.inAddr_; }
 188
 189   sockaddr_in toSockAddr() const {
 190     sockaddr_in addr;
 191     memset(&addr, 0, sizeof(sockaddr_in));
 192     addr.sin_family = AF_INET;
 193     memcpy(&addr.sin_addr, &addr_.inAddr_, sizeof(in_addr));
 194     return addr;
 195   }
 196
 197   ByteArray4 toByteArray() const {
 198     ByteArray4 ba{{0}};
 199     std::memcpy(ba.data(), bytes(), 4);
 200     return ba;
 201   }
 202
 203   // @see IPAddress#toFullyQualified
 204   std::string toFullyQualified() const { return str(); }
 205
 206   // @see IPAddress#version
 207   uint8_t version() const { return 4; }
 208
 209   /**
 210    * Return the mask associated with the given number of bits.
 211    * If for instance numBits was 24 (e.g. /24) then the V4 mask returned should
 212    * be {0xff, 0xff, 0xff, 0x00}.
 213    * @param [in] numBits bitmask to retrieve
 214    * @throws abort if numBits == 0 or numBits > bitCount()
 215    * @return mask associated with numBits
 216    */
 217   static const ByteArray4 fetchMask(size_t numBits);
 218
 219   // Given 2 IPAddressV4, mask pairs extract the longest common IPAddress,
 220   // mask pair
 221   static CIDRNetworkV4 longestCommonPrefix(
 222       const CIDRNetworkV4& one,
 223       const CIDRNetworkV4& two);
 224   // Number of bytes in the address representation.
 225   static size_t byteCount() { return 4; }
 226   //get nth most significant bit - 0 indexed
 227   bool getNthMSBit(size_t bitIndex) const {
 228     return detail::getNthMSBitImpl(*this, bitIndex, AF_INET);
 229   }
 230   //get nth most significant byte - 0 indexed
 231   uint8_t getNthMSByte(size_t byteIndex) const;
 232   //get nth bit - 0 indexed
 233   bool getNthLSBit(size_t bitIndex) const {
 234     return getNthMSBit(bitCount() - bitIndex - 1);
 235   }
 236   //get nth byte - 0 indexed
 237   uint8_t getNthLSByte(size_t byteIndex) const {
 238     return getNthMSByte(byteCount() - byteIndex - 1);
 239   }
 240
 241   const unsigned char* bytes() const { return addr_.bytes_.data(); }
 242
 243  private:
 244   union AddressStorage {
 245     static_assert(sizeof(in_addr) == sizeof(ByteArray4),
 246                   "size of in_addr and ByteArray4 are different");
 247     in_addr inAddr_;
 248     ByteArray4 bytes_;
 249     AddressStorage() {
 250       std::memset(this, 0, sizeof(AddressStorage));
 251     }
 252     explicit AddressStorage(const ByteArray4 bytes): bytes_(bytes) {}
 253     explicit AddressStorage(const in_addr addr): inAddr_(addr) {}
 254   } addr_;
 255
 256   static const std::array<ByteArray4, 33> masks_;
 257
 258   /**
 259    * Set the current IPAddressV4 object to have the address specified by bytes.
 260    * @throws IPAddressFormatException if bytes.size() is not 4.
 261    */
 262   void setFromBinary(ByteRange bytes);
 263 };
 264
 265 // boost::hash uses hash_value() so this allows boost::hash to work
 266 // automatically for IPAddressV4
 267 size_t hash_value(const IPAddressV4& addr);
 268 std::ostream& operator<<(std::ostream& os, const IPAddressV4& addr);
 269 // Define toAppend() to allow IPAddressV4 to be used with to<string>
 270 void toAppend(IPAddressV4 addr, std::string* result);
 271 void toAppend(IPAddressV4 addr, fbstring* result);
 272
 273 /**
 274  * Return true if two addresses are equal.
 275  */
 276 inline bool operator==(const IPAddressV4& addr1, const IPAddressV4& addr2) {
 277   return (addr1.toLong() == addr2.toLong());
 278 }
 279 // Return true if addr1 < addr2
 280 inline bool operator<(const IPAddressV4& addr1, const IPAddressV4& addr2) {
 281   return (addr1.toLongHBO() < addr2.toLongHBO());
 282 }
 283 // Derived operators
 284 inline bool operator!=(const IPAddressV4& a, const IPAddressV4& b) {
 285   return !(a == b);
 286 }
 287 inline bool operator>(const IPAddressV4& a, const IPAddressV4& b) {
 288   return b < a;
 289 }
 290 inline bool operator<=(const IPAddressV4& a, const IPAddressV4& b) {
 291   return !(a > b);
 292 }
 293 inline bool operator>=(const IPAddressV4& a, const IPAddressV4& b) {
 294   return !(a < b);
 295 }
 296
 297 }  // folly
 298
 299 namespace std {
 300 template<>
 301 struct hash<folly::IPAddressV4> {
 302   size_t operator()(const folly::IPAddressV4 addr) const {
 303     return addr.hash();
 304   }
 305 };
 306 }  // std