2 * Copyright 2015 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.
17 #include <folly/IPAddressV4.h>
22 #include <folly/Format.h>
23 #include <folly/IPAddress.h>
24 #include <folly/IPAddressV6.h>
33 size_t hash_value(const IPAddressV4& addr) {
36 ostream& operator<<(ostream& os, const IPAddressV4& addr) {
40 void toAppend(IPAddressV4 addr, string* result) {
41 result->append(addr.str());
43 void toAppend(IPAddressV4 addr, fbstring* result) {
44 result->append(addr.str());
49 IPAddressV4 IPAddressV4::fromLong(uint32_t src) {
52 return IPAddressV4(addr);
55 IPAddressV4 IPAddressV4::fromLongHBO(uint32_t src) {
57 addr.s_addr = htonl(src);
58 return IPAddressV4(addr);
62 uint32_t IPAddressV4::toLong(StringPiece ip) {
65 if (inet_pton(AF_INET, str.c_str(), &addr) != 1) {
66 throw IPAddressFormatException("Can't convert invalid IP '", ip, "' ",
73 uint32_t IPAddressV4::toLongHBO(StringPiece ip) {
74 return ntohl(IPAddressV4::toLong(ip));
77 // public default constructor
78 IPAddressV4::IPAddressV4() {
81 // ByteArray4 constructor
82 IPAddressV4::IPAddressV4(const ByteArray4& src)
87 // public string constructor
88 IPAddressV4::IPAddressV4(StringPiece addr)
92 if (inet_pton(AF_INET, ip.c_str(), &addr_.inAddr_) != 1) {
93 throw IPAddressFormatException("Invalid IPv4 address '", addr, "'");
97 // in_addr constructor
98 IPAddressV4::IPAddressV4(const in_addr src)
104 void IPAddressV4::setFromBinary(ByteRange bytes) {
105 if (bytes.size() != 4) {
106 throw IPAddressFormatException("Invalid IPv4 binary data: length must "
107 "be 4 bytes, got ", bytes.size());
109 memcpy(&addr_.inAddr_.s_addr, bytes.data(), sizeof(in_addr));
113 IPAddressV6 IPAddressV4::createIPv6() const {
117 std::memcpy(&ba[12], bytes(), 4);
118 return IPAddressV6(ba);
122 string IPAddressV4::toJson() const {
124 "{{family:'AF_INET', addr:'{}', hash:{}}}", str(), hash()).str();
128 bool IPAddressV4::inSubnet(StringPiece cidrNetwork) const {
129 auto subnetInfo = IPAddress::createNetwork(cidrNetwork);
130 auto addr = subnetInfo.first;
132 throw IPAddressFormatException("Address '", addr.toJson(), "' ",
133 "is not a V4 address");
135 return inSubnetWithMask(addr.asV4(), fetchMask(subnetInfo.second));
139 bool IPAddressV4::inSubnetWithMask(const IPAddressV4& subnet,
140 const ByteArray4 cidrMask) const {
141 const ByteArray4 mask = detail::Bytes::mask(toByteArray(), cidrMask);
142 const ByteArray4 subMask = detail::Bytes::mask(subnet.toByteArray(),
144 return (mask == subMask);
148 bool IPAddressV4::isLoopback() const {
149 static IPAddressV4 loopback_addr("127.0.0.0");
150 return inSubnetWithMask(loopback_addr, fetchMask(8));
154 bool IPAddressV4::isLinkLocal() const {
155 static IPAddressV4 linklocal_addr("169.254.0.0");
156 return inSubnetWithMask(linklocal_addr, fetchMask(16));
160 bool IPAddressV4::isNonroutable() const {
161 auto ip = toLongHBO();
162 return isPrivate() ||
163 (ip <= 0x00FFFFFF) || // 0.0.0.0-0.255.255.255
164 (ip >= 0xC0000000 && ip <= 0xC00000FF) || // 192.0.0.0-192.0.0.255
165 (ip >= 0xC0000200 && ip <= 0xC00002FF) || // 192.0.2.0-192.0.2.255
166 (ip >= 0xC6120000 && ip <= 0xC613FFFF) || // 198.18.0.0-198.19.255.255
167 (ip >= 0xC6336400 && ip <= 0xC63364FF) || // 198.51.100.0-198.51.100.255
168 (ip >= 0xCB007100 && ip <= 0xCB0071FF) || // 203.0.113.0-203.0.113.255
169 (ip >= 0xE0000000 && ip <= 0xFFFFFFFF); // 224.0.0.0-255.255.255.255
173 bool IPAddressV4::isPrivate() const {
174 auto ip = toLongHBO();
176 (ip >= 0x0A000000 && ip <= 0x0AFFFFFF) || // 10.0.0.0-10.255.255.255
177 (ip >= 0x7F000000 && ip <= 0x7FFFFFFF) || // 127.0.0.0-127.255.255.255
178 (ip >= 0xA9FE0000 && ip <= 0xA9FEFFFF) || // 169.254.0.0-169.254.255.255
179 (ip >= 0xAC100000 && ip <= 0xAC1FFFFF) || // 172.16.0.0-172.31.255.255
180 (ip >= 0xC0A80000 && ip <= 0xC0A8FFFF); // 192.168.0.0-192.168.255.255
184 bool IPAddressV4::isMulticast() const {
185 return (toLongHBO() & 0xf0000000) == 0xe0000000;
189 IPAddressV4 IPAddressV4::mask(size_t numBits) const {
190 static const auto bits = bitCount();
191 if (numBits > bits) {
192 throw IPAddressFormatException("numBits(", numBits,
193 ") > bitsCount(", bits, ")");
196 ByteArray4 ba = detail::Bytes::mask(fetchMask(numBits), addr_.bytes_);
197 return IPAddressV4(ba);
201 string IPAddressV4::str() const {
202 return detail::fastIpv4ToString(addr_.inAddr_);
206 uint8_t IPAddressV4::getNthMSByte(size_t byteIndex) const {
207 const auto highestIndex = byteCount() - 1;
208 if (byteIndex > highestIndex) {
209 throw std::invalid_argument(to<string>("Byte index must be <= ",
210 to<string>(highestIndex), " for addresses of type :",
211 detail::familyNameStr(AF_INET)));
213 return bytes()[byteIndex];
216 const ByteArray4 IPAddressV4::fetchMask(size_t numBits) {
217 static const uint8_t bits = bitCount();
218 if (numBits > bits) {
219 throw IPAddressFormatException("IPv4 addresses are 32 bits");
221 // masks_ is backed by an array so is zero indexed
222 return masks_[numBits];
226 const std::array<ByteArray4, 33> IPAddressV4::masks_ = {{
227 {{0x00, 0x00, 0x00, 0x00}},
228 {{0x80, 0x00, 0x00, 0x00}},
229 {{0xc0, 0x00, 0x00, 0x00}},
230 {{0xe0, 0x00, 0x00, 0x00}},
231 {{0xf0, 0x00, 0x00, 0x00}},
232 {{0xf8, 0x00, 0x00, 0x00}},
233 {{0xfc, 0x00, 0x00, 0x00}},
234 {{0xfe, 0x00, 0x00, 0x00}},
235 {{0xff, 0x00, 0x00, 0x00}},
236 {{0xff, 0x80, 0x00, 0x00}},
237 {{0xff, 0xc0, 0x00, 0x00}},
238 {{0xff, 0xe0, 0x00, 0x00}},
239 {{0xff, 0xf0, 0x00, 0x00}},
240 {{0xff, 0xf8, 0x00, 0x00}},
241 {{0xff, 0xfc, 0x00, 0x00}},
242 {{0xff, 0xfe, 0x00, 0x00}},
243 {{0xff, 0xff, 0x00, 0x00}},
244 {{0xff, 0xff, 0x80, 0x00}},
245 {{0xff, 0xff, 0xc0, 0x00}},
246 {{0xff, 0xff, 0xe0, 0x00}},
247 {{0xff, 0xff, 0xf0, 0x00}},
248 {{0xff, 0xff, 0xf8, 0x00}},
249 {{0xff, 0xff, 0xfc, 0x00}},
250 {{0xff, 0xff, 0xfe, 0x00}},
251 {{0xff, 0xff, 0xff, 0x00}},
252 {{0xff, 0xff, 0xff, 0x80}},
253 {{0xff, 0xff, 0xff, 0xc0}},
254 {{0xff, 0xff, 0xff, 0xe0}},
255 {{0xff, 0xff, 0xff, 0xf0}},
256 {{0xff, 0xff, 0xff, 0xf8}},
257 {{0xff, 0xff, 0xff, 0xfc}},
258 {{0xff, 0xff, 0xff, 0xfe}},
259 {{0xff, 0xff, 0xff, 0xff}}