2 * Copyright 2016 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.
22 #include <boost/operators.hpp>
24 #include <folly/Hash.h>
25 #include <folly/Range.h>
26 #include <folly/detail/IPAddress.h>
35 * Pair of IPAddressV4, netmask
37 typedef std::pair<IPAddressV4, uint8_t> CIDRNetworkV4;
40 * Specialization for IPv4 addresses
42 typedef std::array<uint8_t, 4> ByteArray4;
45 * IPv4 variation of IPAddress.
47 * Added methods: toLong, toLongHBO and createIPv6
49 * @note toLong/fromLong deal in network byte order, use toLongHBO/fromLongHBO
50 * if working in host byte order.
54 class IPAddressV4 : boost::totally_ordered<IPAddressV4> {
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);
62 * Create a new IPAddress instance from the provided binary data.
63 * @throws IPAddressFormatException if the input length is not 4 bytes.
65 static IPAddressV4 fromBinary(ByteRange bytes) {
67 addr.setFromBinary(bytes);
72 * Returns the address as a Range.
74 ByteRange toBinary() const {
75 return ByteRange((const unsigned char *) &addr_.inAddr_.s_addr, 4);
79 * Convert a IPv4 address string to a long in network byte order.
80 * @param [in] ip the address to convert
81 * @return the long representation of the address
83 static uint32_t toLong(StringPiece ip);
84 // Same as above, but in host byte order.
85 // This is slightly slower than toLong.
86 static uint32_t toLongHBO(StringPiece ip);
89 * Default constructor for IPAddressV4.
91 * The address value will be 0.0.0.0
95 // Create an IPAddressV4 from a string
96 // @throws IPAddressFormatException
97 explicit IPAddressV4(StringPiece ip);
99 // ByteArray4 constructor
100 explicit IPAddressV4(const ByteArray4& src);
102 // in_addr constructor
103 explicit IPAddressV4(const in_addr src);
105 // Return the V6 mapped representation of the address.
106 IPAddressV6 createIPv6() const;
109 * Return a V6 address in the format of an 6To4 address.
111 IPAddressV6 getIPv6For6To4() const;
113 // Return the long (network byte order) representation of the address.
114 uint32_t toLong() const {
115 return toAddr().s_addr;
118 // Return the long (host byte order) representation of the address.
119 // This is slightly slower than toLong.
120 uint32_t toLongHBO() const {
121 return ntohl(toLong());
125 * @see IPAddress#bitCount
128 static size_t bitCount() { return 32; }
131 * @See IPAddress#toJson
133 std::string toJson() const;
135 size_t hash() const {
136 static const uint32_t seed = AF_INET;
137 uint32_t hashed = hash::fnv32_buf(&addr_, 4);
138 return hash::hash_combine(seed, hashed);
141 // @see IPAddress#inSubnet
142 // @throws IPAddressFormatException if string doesn't contain a V4 address
143 bool inSubnet(StringPiece cidrNetwork) const;
145 // return true if address is in subnet
146 bool inSubnet(const IPAddressV4& subnet, uint8_t cidr) const {
147 return inSubnetWithMask(subnet, fetchMask(cidr));
149 bool inSubnetWithMask(const IPAddressV4& subnet, const ByteArray4 mask) const;
151 // @see IPAddress#isLoopback
152 bool isLoopback() const;
154 // @see IPAddress#isLinkLocal
155 bool isLinkLocal() const;
157 // @see IPAddress#isNonroutable
158 bool isNonroutable() const;
160 // @see IPAddress#isPrivate
161 bool isPrivate() const;
163 // @see IPAddress#isMulticast
164 bool isMulticast() const;
166 // @see IPAddress#isZero
167 bool isZero() const {
168 return detail::Bytes::isZero(bytes(), 4);
171 bool isLinkLocalBroadcast() const {
172 return (INADDR_BROADCAST == toLongHBO());
175 // @see IPAddress#mask
176 IPAddressV4 mask(size_t numBits) const;
178 // @see IPAddress#str
179 std::string str() const;
181 // return underlying in_addr structure
182 in_addr toAddr() const { return addr_.inAddr_; }
184 sockaddr_in toSockAddr() const {
186 memset(&addr, 0, sizeof(sockaddr_in));
187 addr.sin_family = AF_INET;
188 memcpy(&addr.sin_addr, &addr_.inAddr_, sizeof(in_addr));
192 ByteArray4 toByteArray() const {
194 std::memcpy(ba.data(), bytes(), 4);
198 // @see IPAddress#toFullyQualified
199 std::string toFullyQualified() const { return str(); }
201 // @see IPAddress#version
202 size_t version() const { return 4; }
205 * Return the mask associated with the given number of bits.
206 * If for instance numBits was 24 (e.g. /24) then the V4 mask returned should
207 * be {0xff, 0xff, 0xff, 0x00}.
208 * @param [in] numBits bitmask to retrieve
209 * @throws abort if numBits == 0 or numBits > bitCount()
210 * @return mask associated with numBits
212 static const ByteArray4 fetchMask(size_t numBits);
214 // Given 2 IPAddressV4,mask pairs extract the longest common IPAddress,
216 static CIDRNetworkV4 longestCommonPrefix(
217 const CIDRNetworkV4& one, const CIDRNetworkV4& two) {
219 detail::Bytes::longestCommonPrefix(one.first.addr_.bytes_, one.second,
220 two.first.addr_.bytes_, two.second);
221 return {IPAddressV4(prefix.first), prefix.second};
223 // Number of bytes in the address representation.
224 static size_t byteCount() { return 4; }
225 //get nth most significant bit - 0 indexed
226 bool getNthMSBit(size_t bitIndex) const {
227 return detail::getNthMSBitImpl(*this, bitIndex, AF_INET);
229 //get nth most significant byte - 0 indexed
230 uint8_t getNthMSByte(size_t byteIndex) const;
231 //get nth bit - 0 indexed
232 bool getNthLSBit(size_t bitIndex) const {
233 return getNthMSBit(bitCount() - bitIndex - 1);
235 //get nth byte - 0 indexed
236 uint8_t getNthLSByte(size_t byteIndex) const {
237 return getNthMSByte(byteCount() - byteIndex - 1);
240 const unsigned char* bytes() const { return addr_.bytes_.data(); }
243 union AddressStorage {
244 static_assert(sizeof(in_addr) == sizeof(ByteArray4),
245 "size of in_addr and ByteArray4 are different");
249 std::memset(this, 0, sizeof(AddressStorage));
251 explicit AddressStorage(const ByteArray4 bytes): bytes_(bytes) {}
252 explicit AddressStorage(const in_addr addr): inAddr_(addr) {}
255 static const std::array<ByteArray4, 33> masks_;
258 * Set the current IPAddressV4 object to have the address specified by bytes.
259 * @throws IPAddressFormatException if bytes.size() is not 4.
261 void setFromBinary(ByteRange bytes);
264 // boost::hash uses hash_value() so this allows boost::hash to work
265 // automatically for IPAddressV4
266 size_t hash_value(const IPAddressV4& addr);
267 std::ostream& operator<<(std::ostream& os, const IPAddressV4& addr);
268 // Define toAppend() to allow IPAddressV4 to be used with to<string>
269 void toAppend(IPAddressV4 addr, std::string* result);
270 void toAppend(IPAddressV4 addr, fbstring* result);
273 * Return true if two addresses are equal.
275 inline bool operator==(const IPAddressV4& addr1, const IPAddressV4& addr2) {
276 return (addr1.toLong() == addr2.toLong());
278 // Return true if addr1 < addr2
279 inline bool operator<(const IPAddressV4& addr1, const IPAddressV4& addr2) {
280 return (addr1.toLongHBO() < addr2.toLongHBO());
287 struct hash<folly::IPAddressV4> {
288 size_t operator()(const folly::IPAddressV4 addr) const {