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.
19 #include <sys/types.h>
20 #include <sys/socket.h>
22 #include <netinet/in.h>
28 #include <folly/IPAddress.h>
29 #include <folly/Portability.h>
30 #include <folly/Range.h>
36 SocketAddress() = default;
39 * Construct a SocketAddress from a hostname and port.
41 * Note: If the host parameter is not a numeric IP address, hostname
42 * resolution will be performed, which can be quite slow.
44 * Raises std::system_error on error.
46 * @param host The IP address (or hostname, if allowNameLookup is true)
47 * @param port The port (in host byte order)
48 * @pram allowNameLookup If true, attempt to perform hostname lookup
49 * if the hostname does not appear to be a numeric IP address.
50 * This is potentially a very slow operation, so is disabled by
53 SocketAddress(const char* host, uint16_t port,
54 bool allowNameLookup = false) {
55 // Initialize the address family first,
56 // since setFromHostPort() and setFromIpPort() will check it.
58 if (allowNameLookup) {
59 setFromHostPort(host, port);
61 setFromIpPort(host, port);
65 SocketAddress(const std::string& host, uint16_t port,
66 bool allowNameLookup = false) {
67 // Initialize the address family first,
68 // since setFromHostPort() and setFromIpPort() will check it.
70 if (allowNameLookup) {
71 setFromHostPort(host.c_str(), port);
73 setFromIpPort(host.c_str(), port);
77 SocketAddress(const IPAddress& ipAddr, uint16_t port) {
78 setFromIpAddrPort(ipAddr, port);
81 SocketAddress(const SocketAddress& addr) {
83 if (addr.getFamily() == AF_UNIX) {
84 storage_.un.init(addr.storage_.un);
86 storage_ = addr.storage_;
88 external_ = addr.external_;
91 SocketAddress& operator=(const SocketAddress& addr) {
93 if (addr.getFamily() != AF_UNIX) {
94 storage_ = addr.storage_;
96 storage_ = addr.storage_;
97 storage_.un.init(addr.storage_.un);
100 if (addr.getFamily() == AF_UNIX) {
101 storage_.un.copy(addr.storage_.un);
104 storage_ = addr.storage_;
108 external_ = addr.external_;
112 SocketAddress(SocketAddress&& addr) noexcept {
113 storage_ = addr.storage_;
115 external_ = addr.external_;
116 addr.external_ = false;
119 SocketAddress& operator=(SocketAddress&& addr) {
120 std::swap(storage_, addr.storage_);
121 std::swap(port_, addr.port_);
122 std::swap(external_, addr.external_);
132 bool isInitialized() const {
133 return (getFamily() != AF_UNSPEC);
137 * Return whether this address is within private network.
139 * According to RFC1918, the 10/8 prefix, 172.16/12 prefix, and 192.168/16
140 * prefix are reserved for private networks.
141 * fc00::/7 is the IPv6 version, defined in RFC4139. IPv6 link-local
142 * addresses (fe80::/10) are also considered private addresses.
144 * The loopback addresses 127/8 and ::1 are also regarded as private networks
145 * for the purpose of this function.
147 * Returns true if this is a private network address, and false otherwise.
149 bool isPrivateAddress() const;
152 * Return whether this address is a loopback address.
154 bool isLoopbackAddress() const;
157 prepFamilyChange(AF_UNSPEC);
161 * Initialize this SocketAddress from a hostname and port.
163 * Note: If the host parameter is not a numeric IP address, hostname
164 * resolution will be performed, which can be quite slow.
166 * If the hostname resolves to multiple addresses, only the first will be
169 * Raises std::system_error on error.
171 * @param host The hostname or IP address
172 * @param port The port (in host byte order)
174 void setFromHostPort(const char* host, uint16_t port);
176 void setFromHostPort(const std::string& host, uint16_t port) {
177 setFromHostPort(host.c_str(), port);
181 * Initialize this SocketAddress from an IP address and port.
183 * This is similar to setFromHostPort(), but only accepts numeric IP
184 * addresses. If the IP string does not look like an IP address, it throws a
185 * std::invalid_argument rather than trying to perform a hostname resolution.
187 * Raises std::system_error on error.
189 * @param ip The IP address, as a human-readable string.
190 * @param port The port (in host byte order)
192 void setFromIpPort(const char* ip, uint16_t port);
194 void setFromIpPort(const std::string& ip, uint16_t port) {
195 setFromIpPort(ip.c_str(), port);
199 * Initialize this SocketAddress from an IPAddress struct and port.
201 * @param ip The IP address in IPAddress format
202 * @param port The port (in host byte order)
204 void setFromIpAddrPort(const IPAddress& ip, uint16_t port);
207 * Initialize this SocketAddress from a local port number.
209 * This is intended to be used by server code to determine the address to
212 * If the current machine has any IPv6 addresses configured, an IPv6 address
213 * will be returned (since connections from IPv4 clients can be mapped to the
214 * IPv6 address). If the machine does not have any IPv6 addresses, an IPv4
215 * address will be returned.
217 void setFromLocalPort(uint16_t port);
220 * Initialize this SocketAddress from a local port number.
222 * This version of setFromLocalPort() accepts the port as a string. A
223 * std::invalid_argument will be raised if the string does not refer to a port
224 * number. Non-numeric service port names are not accepted.
226 void setFromLocalPort(const char* port);
227 void setFromLocalPort(const std::string& port) {
228 return setFromLocalPort(port.c_str());
232 * Initialize this SocketAddress from a local port number and optional IP
235 * The addressAndPort string may be specified either as "<ip>:<port>", or
236 * just as "<port>". If the IP is not specified, the address will be
237 * initialized to 0, so that a server socket bound to this address will
238 * accept connections on all local IP addresses.
240 * Both the IP address and port number must be numeric. DNS host names and
241 * non-numeric service port names are not accepted.
243 void setFromLocalIpPort(const char* addressAndPort);
244 void setFromLocalIpPort(const std::string& addressAndPort) {
245 return setFromLocalIpPort(addressAndPort.c_str());
249 * Initialize this SocketAddress from an IP address and port number.
251 * The addressAndPort string must be of the form "<ip>:<port>". E.g.,
254 * Both the IP address and port number must be numeric. DNS host names and
255 * non-numeric service port names are not accepted.
257 void setFromIpPort(const char* addressAndPort);
258 void setFromIpPort(const std::string& addressAndPort) {
259 return setFromIpPort(addressAndPort.c_str());
263 * Initialize this SocketAddress from a host name and port number.
265 * The addressAndPort string must be of the form "<host>:<port>". E.g.,
266 * "www.facebook.com:443".
268 * If the host name is not a numeric IP address, a DNS lookup will be
269 * performed. Beware that the DNS lookup may be very slow. The port number
270 * must be numeric; non-numeric service port names are not accepted.
272 void setFromHostPort(const char* hostAndPort);
273 void setFromHostPort(const std::string& hostAndPort) {
274 return setFromHostPort(hostAndPort.c_str());
278 * Initialize this SocketAddress from a local unix path.
280 * Raises std::invalid_argument on error.
282 void setFromPath(StringPiece path);
284 void setFromPath(const char* path, size_t length) {
285 setFromPath(StringPiece{path, length});
288 // a typedef that allow us to compile against both winsock & POSIX sockets:
289 using SocketDesc = decltype(socket(0,0,0)); // POSIX: int, winsock: unsigned
292 * Initialize this SocketAddress from a socket's peer address.
294 * Raises std::system_error on error.
296 void setFromPeerAddress(SocketDesc socket);
299 * Initialize this SocketAddress from a socket's local address.
301 * Raises std::system_error on error.
303 void setFromLocalAddress(SocketDesc socket);
306 * Initialize this folly::SocketAddress from a struct sockaddr.
308 * Raises std::system_error on error.
310 * This method is not supported for AF_UNIX addresses. For unix addresses,
311 * the address length must be explicitly specified.
313 * @param address A struct sockaddr. The size of the address is implied
314 * from address->sa_family.
316 void setFromSockaddr(const struct sockaddr* address);
319 * Initialize this SocketAddress from a struct sockaddr.
321 * Raises std::system_error on error.
323 * @param address A struct sockaddr.
324 * @param addrlen The length of address data available. This must be long
325 * enough for the full address type required by
326 * address->sa_family.
328 void setFromSockaddr(const struct sockaddr* address,
332 * Initialize this SocketAddress from a struct sockaddr_in.
334 void setFromSockaddr(const struct sockaddr_in* address);
337 * Initialize this SocketAddress from a struct sockaddr_in6.
339 void setFromSockaddr(const struct sockaddr_in6* address);
342 * Initialize this SocketAddress from a struct sockaddr_un.
344 * Note that the addrlen parameter is necessary to properly detect anonymous
345 * addresses, which have 0 valid path bytes, and may not even have a NUL
346 * character at the start of the path.
348 * @param address A struct sockaddr_un.
349 * @param addrlen The length of address data. This should include all of
350 * the valid bytes of sun_path, not including any NUL
353 void setFromSockaddr(const struct sockaddr_un* address,
358 * Fill in a given sockaddr_storage with the ip or unix address.
360 * Returns the actual size of the storage used.
362 socklen_t getAddress(sockaddr_storage* addr) const {
364 return storage_.addr.toSockaddrStorage(addr, htons(port_));
366 memcpy(addr, storage_.un.addr, sizeof(*storage_.un.addr));
367 return storage_.un.len;
371 const folly::IPAddress& getIPAddress() const;
373 // Deprecated: getAddress() above returns the same size as getActualSize()
374 socklen_t getActualSize() const;
376 sa_family_t getFamily() const {
377 DCHECK(external_ || AF_UNIX != storage_.addr.family());
378 return external_ ? AF_UNIX : storage_.addr.family();
382 return getFamily() == AF_UNSPEC;
386 * Get a string representation of the IPv4 or IPv6 address.
388 * Raises std::invalid_argument if an error occurs (for example, if
389 * the address is not an IPv4 or IPv6 address).
391 std::string getAddressStr() const;
394 * Get a string representation of the IPv4 or IPv6 address.
396 * Raises std::invalid_argument if an error occurs (for example, if
397 * the address is not an IPv4 or IPv6 address).
399 void getAddressStr(char* buf, size_t buflen) const;
402 * For v4 & v6 addresses, return the fully qualified address string
404 std::string getFullyQualified() const;
407 * Get the IPv4 or IPv6 port for this address.
409 * Raises std::invalid_argument if this is not an IPv4 or IPv6 address.
411 * @return Returns the port, in host byte order.
413 uint16_t getPort() const;
416 * Set the IPv4 or IPv6 port for this address.
418 * Raises std::invalid_argument if this is not an IPv4 or IPv6 address.
420 void setPort(uint16_t port);
423 * Return true if this is an IPv4-mapped IPv6 address.
425 bool isIPv4Mapped() const {
426 return (getFamily() == AF_INET6 &&
427 storage_.addr.isIPv4Mapped());
431 * Convert an IPv4-mapped IPv6 address to an IPv4 address.
433 * Raises std::invalid_argument if this is not an IPv4-mapped IPv6 address.
435 void convertToIPv4();
438 * Try to convert an address to IPv4.
440 * This attempts to convert an address to an IPv4 address if possible.
441 * If the address is an IPv4-mapped IPv6 address, it is converted to an IPv4
442 * address and true is returned. Otherwise nothing is done, and false is
445 bool tryConvertToIPv4();
448 * Convert an IPv4 address to IPv6 [::ffff:a.b.c.d]
454 * Get string representation of the host name (or IP address if the host name
455 * cannot be resolved).
457 * Warning: Using this method is strongly discouraged. It performs a
458 * DNS lookup, which may block for many seconds.
460 * Raises std::invalid_argument if an error occurs.
462 std::string getHostStr() const;
465 * Get the path name for a Unix domain socket.
467 * Returns a std::string containing the path. For anonymous sockets, an
468 * empty string is returned.
470 * For addresses in the abstract namespace (Linux-specific), a std::string
471 * containing binary data is returned. In this case the first character will
472 * always be a NUL character.
474 * Raises std::invalid_argument if called on a non-Unix domain socket.
476 std::string getPath() const;
479 * Get human-readable string representation of the address.
481 * This prints a string representation of the address, for human consumption.
482 * For IP addresses, the string is of the form "<IP>:<port>".
484 std::string describe() const;
486 bool operator==(const SocketAddress& other) const;
487 bool operator!=(const SocketAddress& other) const {
488 return !(*this == other);
492 * Check whether the first N bits of this address match the first N
493 * bits of another address.
494 * @note returns false if the addresses are not from the same
495 * address family or if the family is neither IPv4 nor IPv6
497 bool prefixMatch(const SocketAddress& other, unsigned prefixLength) const;
500 * Use this operator for storing maps based on SocketAddress.
502 bool operator<(const SocketAddress& other) const;
505 * Compuate a hash of a SocketAddress.
511 * Unix socket addresses require more storage than IPv4 and IPv6 addresses,
512 * and are comparatively little-used.
514 * Therefore SocketAddress' internal storage_ member variable doesn't
515 * contain room for a full unix address, to avoid wasting space in the common
516 * case. When we do need to store a Unix socket address, we use this
517 * ExternalUnixAddr structure to allocate a struct sockaddr_un separately on
520 struct ExternalUnixAddr {
521 struct sockaddr_un *addr;
524 /* For debugging only, will be removed */
526 static constexpr uint64_t kMagic = 0x1234faceb00c;
528 socklen_t pathLength() const {
529 return len - offsetof(struct sockaddr_un, sun_path);
533 addr = new sockaddr_un;
535 addr->sun_family = AF_UNIX;
538 void init(const ExternalUnixAddr &other) {
539 addr = new sockaddr_un;
542 memcpy(addr, other.addr, len);
543 // Fill the rest with 0s, just for safety
544 memset(reinterpret_cast<char*>(addr) + len, 0,
545 sizeof(struct sockaddr_un) - len);
547 void copy(const ExternalUnixAddr &other) {
548 CHECK(magic == kMagic);
550 memcpy(addr, other.addr, len);
553 CHECK(magic == kMagic);
559 // a typedef that allow us to compile against both winsock & POSIX sockets:
560 // (both arg types and calling conventions differ for both)
561 // POSIX: void setFromSocket(int socket,
562 // int(*fn)(int, struct sockaddr*, socklen_t*));
563 // mingw: void setFromSocket(unsigned socket,
564 // int(*fn)(unsigned, struct sockaddr*, socklen_t*));
565 using GetPeerNameFunc = decltype(getpeername);
567 struct addrinfo* getAddrInfo(const char* host, uint16_t port, int flags);
568 struct addrinfo* getAddrInfo(const char* host, const char* port, int flags);
569 void setFromAddrInfo(const struct addrinfo* results);
570 void setFromLocalAddr(const struct addrinfo* results);
571 void setFromSocket(SocketDesc socket, GetPeerNameFunc fn);
572 std::string getIpString(int flags) const;
573 void getIpString(char *buf, size_t buflen, int flags) const;
575 void updateUnixAddressLength(socklen_t addrlen);
577 void prepFamilyChange(sa_family_t newFamily) {
578 if (newFamily != AF_UNIX) {
581 storage_.addr = folly::IPAddress();
593 * storage_ contains room for a full IPv4 or IPv6 address, so they can be
594 * stored inline without a separate allocation on the heap.
596 * If we need to store a Unix socket address, ExternalUnixAddr is a shim to
597 * track a struct sockaddr_un allocated separately on the heap.
600 folly::IPAddress addr{};
603 // IPAddress class does nto save zone or port, and must be saved here
606 bool external_{false};
610 * Hash a SocketAddress object.
612 * boost::hash uses hash_value(), so this allows boost::hash to automatically
613 * work for SocketAddress.
615 size_t hash_value(const SocketAddress& address);
617 std::ostream& operator<<(std::ostream& os, const SocketAddress& addr);
623 // Provide an implementation for std::hash<SocketAddress>
625 struct hash<folly::SocketAddress> {
627 const folly::SocketAddress& addr) const {