xref: /OK3568_Linux_fs/kernel/include/linux/sunrpc/addr.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * linux/include/linux/sunrpc/addr.h
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Various routines for copying and comparing sockaddrs and for
6*4882a593Smuzhiyun  * converting them to and from presentation format.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun #ifndef _LINUX_SUNRPC_ADDR_H
9*4882a593Smuzhiyun #define _LINUX_SUNRPC_ADDR_H
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/socket.h>
12*4882a593Smuzhiyun #include <linux/in.h>
13*4882a593Smuzhiyun #include <linux/in6.h>
14*4882a593Smuzhiyun #include <net/ipv6.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun size_t		rpc_ntop(const struct sockaddr *, char *, const size_t);
17*4882a593Smuzhiyun size_t		rpc_pton(struct net *, const char *, const size_t,
18*4882a593Smuzhiyun 			 struct sockaddr *, const size_t);
19*4882a593Smuzhiyun char *		rpc_sockaddr2uaddr(const struct sockaddr *, gfp_t);
20*4882a593Smuzhiyun size_t		rpc_uaddr2sockaddr(struct net *, const char *, const size_t,
21*4882a593Smuzhiyun 				   struct sockaddr *, const size_t);
22*4882a593Smuzhiyun 
rpc_get_port(const struct sockaddr * sap)23*4882a593Smuzhiyun static inline unsigned short rpc_get_port(const struct sockaddr *sap)
24*4882a593Smuzhiyun {
25*4882a593Smuzhiyun 	switch (sap->sa_family) {
26*4882a593Smuzhiyun 	case AF_INET:
27*4882a593Smuzhiyun 		return ntohs(((struct sockaddr_in *)sap)->sin_port);
28*4882a593Smuzhiyun 	case AF_INET6:
29*4882a593Smuzhiyun 		return ntohs(((struct sockaddr_in6 *)sap)->sin6_port);
30*4882a593Smuzhiyun 	}
31*4882a593Smuzhiyun 	return 0;
32*4882a593Smuzhiyun }
33*4882a593Smuzhiyun 
rpc_set_port(struct sockaddr * sap,const unsigned short port)34*4882a593Smuzhiyun static inline void rpc_set_port(struct sockaddr *sap,
35*4882a593Smuzhiyun 				const unsigned short port)
36*4882a593Smuzhiyun {
37*4882a593Smuzhiyun 	switch (sap->sa_family) {
38*4882a593Smuzhiyun 	case AF_INET:
39*4882a593Smuzhiyun 		((struct sockaddr_in *)sap)->sin_port = htons(port);
40*4882a593Smuzhiyun 		break;
41*4882a593Smuzhiyun 	case AF_INET6:
42*4882a593Smuzhiyun 		((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
43*4882a593Smuzhiyun 		break;
44*4882a593Smuzhiyun 	}
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun #define IPV6_SCOPE_DELIMITER		'%'
48*4882a593Smuzhiyun #define IPV6_SCOPE_ID_LEN		sizeof("%nnnnnnnnnn")
49*4882a593Smuzhiyun 
rpc_cmp_addr4(const struct sockaddr * sap1,const struct sockaddr * sap2)50*4882a593Smuzhiyun static inline bool rpc_cmp_addr4(const struct sockaddr *sap1,
51*4882a593Smuzhiyun 				 const struct sockaddr *sap2)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun 	const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
54*4882a593Smuzhiyun 	const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
57*4882a593Smuzhiyun }
58*4882a593Smuzhiyun 
__rpc_copy_addr4(struct sockaddr * dst,const struct sockaddr * src)59*4882a593Smuzhiyun static inline bool __rpc_copy_addr4(struct sockaddr *dst,
60*4882a593Smuzhiyun 				    const struct sockaddr *src)
61*4882a593Smuzhiyun {
62*4882a593Smuzhiyun 	const struct sockaddr_in *ssin = (struct sockaddr_in *) src;
63*4882a593Smuzhiyun 	struct sockaddr_in *dsin = (struct sockaddr_in *) dst;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	dsin->sin_family = ssin->sin_family;
66*4882a593Smuzhiyun 	dsin->sin_addr.s_addr = ssin->sin_addr.s_addr;
67*4882a593Smuzhiyun 	return true;
68*4882a593Smuzhiyun }
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun #if IS_ENABLED(CONFIG_IPV6)
rpc_cmp_addr6(const struct sockaddr * sap1,const struct sockaddr * sap2)71*4882a593Smuzhiyun static inline bool rpc_cmp_addr6(const struct sockaddr *sap1,
72*4882a593Smuzhiyun 				 const struct sockaddr *sap2)
73*4882a593Smuzhiyun {
74*4882a593Smuzhiyun 	const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
75*4882a593Smuzhiyun 	const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun 	if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
78*4882a593Smuzhiyun 		return false;
79*4882a593Smuzhiyun 	else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
80*4882a593Smuzhiyun 		return sin1->sin6_scope_id == sin2->sin6_scope_id;
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 	return true;
83*4882a593Smuzhiyun }
84*4882a593Smuzhiyun 
__rpc_copy_addr6(struct sockaddr * dst,const struct sockaddr * src)85*4882a593Smuzhiyun static inline bool __rpc_copy_addr6(struct sockaddr *dst,
86*4882a593Smuzhiyun 				    const struct sockaddr *src)
87*4882a593Smuzhiyun {
88*4882a593Smuzhiyun 	const struct sockaddr_in6 *ssin6 = (const struct sockaddr_in6 *) src;
89*4882a593Smuzhiyun 	struct sockaddr_in6 *dsin6 = (struct sockaddr_in6 *) dst;
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 	dsin6->sin6_family = ssin6->sin6_family;
92*4882a593Smuzhiyun 	dsin6->sin6_addr = ssin6->sin6_addr;
93*4882a593Smuzhiyun 	dsin6->sin6_scope_id = ssin6->sin6_scope_id;
94*4882a593Smuzhiyun 	return true;
95*4882a593Smuzhiyun }
96*4882a593Smuzhiyun #else	/* !(IS_ENABLED(CONFIG_IPV6) */
rpc_cmp_addr6(const struct sockaddr * sap1,const struct sockaddr * sap2)97*4882a593Smuzhiyun static inline bool rpc_cmp_addr6(const struct sockaddr *sap1,
98*4882a593Smuzhiyun 				   const struct sockaddr *sap2)
99*4882a593Smuzhiyun {
100*4882a593Smuzhiyun 	return false;
101*4882a593Smuzhiyun }
102*4882a593Smuzhiyun 
__rpc_copy_addr6(struct sockaddr * dst,const struct sockaddr * src)103*4882a593Smuzhiyun static inline bool __rpc_copy_addr6(struct sockaddr *dst,
104*4882a593Smuzhiyun 				    const struct sockaddr *src)
105*4882a593Smuzhiyun {
106*4882a593Smuzhiyun 	return false;
107*4882a593Smuzhiyun }
108*4882a593Smuzhiyun #endif	/* !(IS_ENABLED(CONFIG_IPV6) */
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun /**
111*4882a593Smuzhiyun  * rpc_cmp_addr - compare the address portion of two sockaddrs.
112*4882a593Smuzhiyun  * @sap1: first sockaddr
113*4882a593Smuzhiyun  * @sap2: second sockaddr
114*4882a593Smuzhiyun  *
115*4882a593Smuzhiyun  * Just compares the family and address portion. Ignores port, but
116*4882a593Smuzhiyun  * compares the scope if it's a link-local address.
117*4882a593Smuzhiyun  *
118*4882a593Smuzhiyun  * Returns true if the addrs are equal, false if they aren't.
119*4882a593Smuzhiyun  */
rpc_cmp_addr(const struct sockaddr * sap1,const struct sockaddr * sap2)120*4882a593Smuzhiyun static inline bool rpc_cmp_addr(const struct sockaddr *sap1,
121*4882a593Smuzhiyun 				const struct sockaddr *sap2)
122*4882a593Smuzhiyun {
123*4882a593Smuzhiyun 	if (sap1->sa_family == sap2->sa_family) {
124*4882a593Smuzhiyun 		switch (sap1->sa_family) {
125*4882a593Smuzhiyun 		case AF_INET:
126*4882a593Smuzhiyun 			return rpc_cmp_addr4(sap1, sap2);
127*4882a593Smuzhiyun 		case AF_INET6:
128*4882a593Smuzhiyun 			return rpc_cmp_addr6(sap1, sap2);
129*4882a593Smuzhiyun 		}
130*4882a593Smuzhiyun 	}
131*4882a593Smuzhiyun 	return false;
132*4882a593Smuzhiyun }
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun /**
135*4882a593Smuzhiyun  * rpc_cmp_addr_port - compare the address and port number of two sockaddrs.
136*4882a593Smuzhiyun  * @sap1: first sockaddr
137*4882a593Smuzhiyun  * @sap2: second sockaddr
138*4882a593Smuzhiyun  */
rpc_cmp_addr_port(const struct sockaddr * sap1,const struct sockaddr * sap2)139*4882a593Smuzhiyun static inline bool rpc_cmp_addr_port(const struct sockaddr *sap1,
140*4882a593Smuzhiyun 				     const struct sockaddr *sap2)
141*4882a593Smuzhiyun {
142*4882a593Smuzhiyun 	if (!rpc_cmp_addr(sap1, sap2))
143*4882a593Smuzhiyun 		return false;
144*4882a593Smuzhiyun 	return rpc_get_port(sap1) == rpc_get_port(sap2);
145*4882a593Smuzhiyun }
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun /**
148*4882a593Smuzhiyun  * rpc_copy_addr - copy the address portion of one sockaddr to another
149*4882a593Smuzhiyun  * @dst: destination sockaddr
150*4882a593Smuzhiyun  * @src: source sockaddr
151*4882a593Smuzhiyun  *
152*4882a593Smuzhiyun  * Just copies the address portion and family. Ignores port, scope, etc.
153*4882a593Smuzhiyun  * Caller is responsible for making certain that dst is large enough to hold
154*4882a593Smuzhiyun  * the address in src. Returns true if address family is supported. Returns
155*4882a593Smuzhiyun  * false otherwise.
156*4882a593Smuzhiyun  */
rpc_copy_addr(struct sockaddr * dst,const struct sockaddr * src)157*4882a593Smuzhiyun static inline bool rpc_copy_addr(struct sockaddr *dst,
158*4882a593Smuzhiyun 				 const struct sockaddr *src)
159*4882a593Smuzhiyun {
160*4882a593Smuzhiyun 	switch (src->sa_family) {
161*4882a593Smuzhiyun 	case AF_INET:
162*4882a593Smuzhiyun 		return __rpc_copy_addr4(dst, src);
163*4882a593Smuzhiyun 	case AF_INET6:
164*4882a593Smuzhiyun 		return __rpc_copy_addr6(dst, src);
165*4882a593Smuzhiyun 	}
166*4882a593Smuzhiyun 	return false;
167*4882a593Smuzhiyun }
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun /**
170*4882a593Smuzhiyun  * rpc_get_scope_id - return scopeid for a given sockaddr
171*4882a593Smuzhiyun  * @sa: sockaddr to get scopeid from
172*4882a593Smuzhiyun  *
173*4882a593Smuzhiyun  * Returns the value of the sin6_scope_id for AF_INET6 addrs, or 0 if
174*4882a593Smuzhiyun  * not an AF_INET6 address.
175*4882a593Smuzhiyun  */
rpc_get_scope_id(const struct sockaddr * sa)176*4882a593Smuzhiyun static inline u32 rpc_get_scope_id(const struct sockaddr *sa)
177*4882a593Smuzhiyun {
178*4882a593Smuzhiyun 	if (sa->sa_family != AF_INET6)
179*4882a593Smuzhiyun 		return 0;
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun 	return ((struct sockaddr_in6 *) sa)->sin6_scope_id;
182*4882a593Smuzhiyun }
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun #endif /* _LINUX_SUNRPC_ADDR_H */
185