2 * Copyright 2017 Facebook, Inc.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <folly/Hash.h>
26 #include <folly/Range.h>
27 #include <folly/detail/IPAddress.h>
36 * Pair of IPAddressV4, netmask
38 typedef std::pair<IPAddressV4, uint8_t> CIDRNetworkV4;
41 * Specialization for IPv4 addresses
43 typedef std::array<uint8_t, 4> ByteArray4;
46 * IPv4 variation of IPAddress.
48 * Added methods: toLong, toLongHBO and createIPv6
50 * @note toLong/fromLong deal in network byte order, use toLongHBO/fromLongHBO
51 * if working in host byte order.
57 // returns true iff the input string can be parsed as an ipv4-address
58 static bool validate(StringPiece ip);
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);
66 * Create a new IPAddress instance from the provided binary data.
67 * @throws IPAddressFormatException if the input length is not 4 bytes.
69 static IPAddressV4 fromBinary(ByteRange bytes) {
71 addr.setFromBinary(bytes);
76 * Returns the address as a Range.
78 ByteRange toBinary() const {
79 return ByteRange((const unsigned char *) &addr_.inAddr_.s_addr, 4);
83 * Create a new IPAddress instance from the in-addr.arpa representation.
84 * @throws IPAddressFormatException if the input is not a valid in-addr.arpa
87 static IPAddressV4 fromInverseArpaName(const std::string& arpaname);
90 * Convert a IPv4 address string to a long in network byte order.
91 * @param [in] ip the address to convert
92 * @return the long representation of the address
94 static uint32_t toLong(StringPiece ip);
95 // Same as above, but in host byte order.
96 // This is slightly slower than toLong.
97 static uint32_t toLongHBO(StringPiece ip);
100 * Default constructor for IPAddressV4.
102 * The address value will be 0.0.0.0
106 // Create an IPAddressV4 from a string
107 // @throws IPAddressFormatException
108 explicit IPAddressV4(StringPiece ip);
110 // ByteArray4 constructor
111 explicit IPAddressV4(const ByteArray4& src);
113 // in_addr constructor
114 explicit IPAddressV4(const in_addr src);
116 // Return the V6 mapped representation of the address.
117 IPAddressV6 createIPv6() const;
120 * Return a V6 address in the format of an 6To4 address.
122 IPAddressV6 getIPv6For6To4() const;
124 // Return the long (network byte order) representation of the address.
125 uint32_t toLong() const {
126 return toAddr().s_addr;
129 // Return the long (host byte order) representation of the address.
130 // This is slightly slower than toLong.
131 uint32_t toLongHBO() const {
132 return ntohl(toLong());
136 * @see IPAddress#bitCount
139 static size_t bitCount() { return 32; }
142 * @See IPAddress#toJson
144 std::string toJson() const;
146 size_t hash() const {
147 static const uint32_t seed = AF_INET;
148 uint32_t hashed = hash::fnv32_buf(&addr_, 4);
149 return hash::hash_combine(seed, hashed);
152 // @see IPAddress#inSubnet
153 // @throws IPAddressFormatException if string doesn't contain a V4 address
154 bool inSubnet(StringPiece cidrNetwork) const;
156 // return true if address is in subnet
157 bool inSubnet(const IPAddressV4& subnet, uint8_t cidr) const {
158 return inSubnetWithMask(subnet, fetchMask(cidr));
160 bool inSubnetWithMask(const IPAddressV4& subnet, const ByteArray4 mask) const;
162 // @see IPAddress#isLoopback
163 bool isLoopback() const;
165 // @see IPAddress#isLinkLocal
166 bool isLinkLocal() const;
168 // @see IPAddress#isNonroutable
169 bool isNonroutable() const;
171 // @see IPAddress#isPrivate
172 bool isPrivate() const;
174 // @see IPAddress#isMulticast
175 bool isMulticast() const;
177 // @see IPAddress#isZero
178 bool isZero() const {
179 constexpr auto zero = ByteArray4{{}};
180 return 0 == std::memcmp(bytes(), zero.data(), zero.size());
183 bool isLinkLocalBroadcast() const {
184 return (INADDR_BROADCAST == toLongHBO());
187 // @see IPAddress#mask
188 IPAddressV4 mask(size_t numBits) const;
190 // @see IPAddress#str
191 std::string str() const;
193 std::string toInverseArpaName() const;
195 // return underlying in_addr structure
196 in_addr toAddr() const { return addr_.inAddr_; }
198 sockaddr_in toSockAddr() const {
200 memset(&addr, 0, sizeof(sockaddr_in));
201 addr.sin_family = AF_INET;
202 memcpy(&addr.sin_addr, &addr_.inAddr_, sizeof(in_addr));
206 ByteArray4 toByteArray() const {
208 std::memcpy(ba.data(), bytes(), 4);
212 // @see IPAddress#toFullyQualified
213 std::string toFullyQualified() const { return str(); }
215 // @see IPAddress#version
216 uint8_t version() const { return 4; }
219 * Return the mask associated with the given number of bits.
220 * If for instance numBits was 24 (e.g. /24) then the V4 mask returned should
221 * be {0xff, 0xff, 0xff, 0x00}.
222 * @param [in] numBits bitmask to retrieve
223 * @throws abort if numBits == 0 or numBits > bitCount()
224 * @return mask associated with numBits
226 static const ByteArray4 fetchMask(size_t numBits);
228 // Given 2 IPAddressV4, mask pairs extract the longest common IPAddress,
230 static CIDRNetworkV4 longestCommonPrefix(
231 const CIDRNetworkV4& one,
232 const CIDRNetworkV4& two);
233 // Number of bytes in the address representation.
234 static size_t byteCount() { return 4; }
235 //get nth most significant bit - 0 indexed
236 bool getNthMSBit(size_t bitIndex) const {
237 return detail::getNthMSBitImpl(*this, bitIndex, AF_INET);
239 //get nth most significant byte - 0 indexed
240 uint8_t getNthMSByte(size_t byteIndex) const;
241 //get nth bit - 0 indexed
242 bool getNthLSBit(size_t bitIndex) const {
243 return getNthMSBit(bitCount() - bitIndex - 1);
245 //get nth byte - 0 indexed
246 uint8_t getNthLSByte(size_t byteIndex) const {
247 return getNthMSByte(byteCount() - byteIndex - 1);
250 const unsigned char* bytes() const { return addr_.bytes_.data(); }
253 union AddressStorage {
254 static_assert(sizeof(in_addr) == sizeof(ByteArray4),
255 "size of in_addr and ByteArray4 are different");
259 std::memset(this, 0, sizeof(AddressStorage));
261 explicit AddressStorage(const ByteArray4 bytes): bytes_(bytes) {}
262 explicit AddressStorage(const in_addr addr): inAddr_(addr) {}
265 static const std::array<ByteArray4, 33> masks_;
268 * Set the current IPAddressV4 object to have the address specified by bytes.
269 * @throws IPAddressFormatException if bytes.size() is not 4.
271 void setFromBinary(ByteRange bytes);
274 // boost::hash uses hash_value() so this allows boost::hash to work
275 // automatically for IPAddressV4
276 size_t hash_value(const IPAddressV4& addr);
277 std::ostream& operator<<(std::ostream& os, const IPAddressV4& addr);
278 // Define toAppend() to allow IPAddressV4 to be used with to<string>
279 void toAppend(IPAddressV4 addr, std::string* result);
280 void toAppend(IPAddressV4 addr, fbstring* result);
283 * Return true if two addresses are equal.
285 inline bool operator==(const IPAddressV4& addr1, const IPAddressV4& addr2) {
286 return (addr1.toLong() == addr2.toLong());
288 // Return true if addr1 < addr2
289 inline bool operator<(const IPAddressV4& addr1, const IPAddressV4& addr2) {
290 return (addr1.toLongHBO() < addr2.toLongHBO());
293 inline bool operator!=(const IPAddressV4& a, const IPAddressV4& b) {
296 inline bool operator>(const IPAddressV4& a, const IPAddressV4& b) {
299 inline bool operator<=(const IPAddressV4& a, const IPAddressV4& b) {
302 inline bool operator>=(const IPAddressV4& a, const IPAddressV4& b) {
310 struct hash<folly::IPAddressV4> {
311 size_t operator()(const folly::IPAddressV4 addr) const {