folly/IPAddressV4.h

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