Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1d8206b9 TT |
2 | /* |
3 | * linux/include/linux/sunrpc/svc_xprt.h | |
4 | * | |
5 | * RPC server transport I/O | |
6 | */ | |
7 | ||
8 | #ifndef SUNRPC_SVC_XPRT_H | |
9 | #define SUNRPC_SVC_XPRT_H | |
10 | ||
11 | #include <linux/sunrpc/svc.h> | |
de477254 PG |
12 | |
13 | struct module; | |
1d8206b9 TT |
14 | |
15 | struct svc_xprt_ops { | |
b700cbb1 | 16 | struct svc_xprt *(*xpo_create)(struct svc_serv *, |
62832c03 | 17 | struct net *net, |
b700cbb1 TT |
18 | struct sockaddr *, int, |
19 | int); | |
38a417cc | 20 | struct svc_xprt *(*xpo_accept)(struct svc_xprt *); |
323bee32 | 21 | int (*xpo_has_wspace)(struct svc_xprt *); |
5d137990 TT |
22 | int (*xpo_recvfrom)(struct svc_rqst *); |
23 | int (*xpo_sendto)(struct svc_rqst *); | |
5148bf4e | 24 | void (*xpo_release_rqst)(struct svc_rqst *); |
755cceab TT |
25 | void (*xpo_detach)(struct svc_xprt *); |
26 | void (*xpo_free)(struct svc_xprt *); | |
989f881e | 27 | void (*xpo_secure_port)(struct svc_rqst *rqstp); |
ea08e392 | 28 | void (*xpo_kill_temp_xprt)(struct svc_xprt *); |
1d8206b9 TT |
29 | }; |
30 | ||
31 | struct svc_xprt_class { | |
32 | const char *xcl_name; | |
33 | struct module *xcl_owner; | |
2412e927 | 34 | const struct svc_xprt_ops *xcl_ops; |
1d8206b9 | 35 | struct list_head xcl_list; |
49023155 | 36 | u32 xcl_max_payload; |
3c45ddf8 | 37 | int xcl_ident; |
1d8206b9 TT |
38 | }; |
39 | ||
edc7a894 BF |
40 | /* |
41 | * This is embedded in an object that wants a callback before deleting | |
42 | * an xprt; intended for use by NFSv4.1, which needs to know when a | |
43 | * client's tcp connection (and hence possibly a backchannel) goes away. | |
44 | */ | |
45 | struct svc_xpt_user { | |
46 | struct list_head list; | |
47 | void (*callback)(struct svc_xpt_user *); | |
48 | }; | |
49 | ||
1d8206b9 TT |
50 | struct svc_xprt { |
51 | struct svc_xprt_class *xpt_class; | |
2412e927 | 52 | const struct svc_xprt_ops *xpt_ops; |
e1b3157f | 53 | struct kref xpt_ref; |
7a182083 TT |
54 | struct list_head xpt_list; |
55 | struct list_head xpt_ready; | |
02fc6c36 TT |
56 | unsigned long xpt_flags; |
57 | #define XPT_BUSY 0 /* enqueued/receiving */ | |
58 | #define XPT_CONN 1 /* conn pending */ | |
59 | #define XPT_CLOSE 2 /* dead or dying */ | |
60 | #define XPT_DATA 3 /* data pending */ | |
61 | #define XPT_TEMP 4 /* connected transport */ | |
62 | #define XPT_DEAD 6 /* transport closed */ | |
63 | #define XPT_CHNGBUF 7 /* need to change snd/rcv buf sizes */ | |
64 | #define XPT_DEFERRED 8 /* deferred request pending */ | |
65 | #define XPT_OLD 9 /* used for xprt aging mark+sweep */ | |
8d65ef76 JL |
66 | #define XPT_LISTENER 10 /* listening endpoint */ |
67 | #define XPT_CACHE_AUTH 11 /* cache auth info */ | |
68 | #define XPT_LOCAL 12 /* connection from loopback interface */ | |
546125d1 | 69 | #define XPT_KILL_TEMP 13 /* call xpo_kill_temp_xprt before closing */ |
362142b2 | 70 | #define XPT_CONG_CTRL 14 /* has congestion control */ |
bb5cf160 | 71 | |
bb5cf160 | 72 | struct svc_serv *xpt_server; /* service for transport */ |
7a90e8cc | 73 | atomic_t xpt_reserved; /* space on outq that is rsvd */ |
ff3ac5c3 | 74 | atomic_t xpt_nr_rqsts; /* Number of requests */ |
a50fea26 | 75 | struct mutex xpt_mutex; /* to serialize sending data */ |
def13d74 TT |
76 | spinlock_t xpt_lock; /* protects sk_deferred |
77 | * and xpt_auth_cache */ | |
78 | void *xpt_auth_cache;/* auth cache */ | |
8c7b0172 TT |
79 | struct list_head xpt_deferred; /* deferred requests that need |
80 | * to be revisted */ | |
9dbc240f TT |
81 | struct sockaddr_storage xpt_local; /* local address */ |
82 | size_t xpt_locallen; /* length of address */ | |
83 | struct sockaddr_storage xpt_remote; /* remote peer's address */ | |
84 | size_t xpt_remotelen; /* length of address */ | |
ece200dd | 85 | char xpt_remotebuf[INET6_ADDRSTRLEN + 10]; |
edc7a894 | 86 | struct list_head xpt_users; /* callbacks on free */ |
4fb8518b PE |
87 | |
88 | struct net *xpt_net; | |
4df493a2 | 89 | const struct cred *xpt_cred; |
d75faea3 | 90 | struct rpc_xprt *xpt_bc_xprt; /* NFSv4.1 backchannel */ |
39a9beab | 91 | struct rpc_xprt_switch *xpt_bc_xps; /* NFSv4.1 backchannel */ |
1d8206b9 TT |
92 | }; |
93 | ||
21b75b01 | 94 | static inline void unregister_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u) |
edc7a894 BF |
95 | { |
96 | spin_lock(&xpt->xpt_lock); | |
21b75b01 | 97 | list_del_init(&u->list); |
edc7a894 BF |
98 | spin_unlock(&xpt->xpt_lock); |
99 | } | |
100 | ||
21b75b01 | 101 | static inline int register_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u) |
edc7a894 BF |
102 | { |
103 | spin_lock(&xpt->xpt_lock); | |
21b75b01 BF |
104 | if (test_bit(XPT_CLOSE, &xpt->xpt_flags)) { |
105 | /* | |
106 | * The connection is about to be deleted soon (or, | |
107 | * worse, may already be deleted--in which case we've | |
108 | * already notified the xpt_users). | |
109 | */ | |
110 | spin_unlock(&xpt->xpt_lock); | |
111 | return -ENOTCONN; | |
112 | } | |
113 | list_add(&u->list, &xpt->xpt_users); | |
edc7a894 | 114 | spin_unlock(&xpt->xpt_lock); |
21b75b01 | 115 | return 0; |
edc7a894 BF |
116 | } |
117 | ||
1d8206b9 TT |
118 | int svc_reg_xprt_class(struct svc_xprt_class *); |
119 | void svc_unreg_xprt_class(struct svc_xprt_class *); | |
bd4620dd | 120 | void svc_xprt_init(struct net *, struct svc_xprt_class *, struct svc_xprt *, |
bb5cf160 | 121 | struct svc_serv *); |
fc5d00b0 | 122 | int svc_create_xprt(struct svc_serv *, const char *, struct net *, |
4df493a2 TM |
123 | const int, const unsigned short, int, |
124 | const struct cred *); | |
b9e13cdf | 125 | void svc_xprt_do_enqueue(struct svc_xprt *xprt); |
0f0257ea | 126 | void svc_xprt_enqueue(struct svc_xprt *xprt); |
e1b3157f | 127 | void svc_xprt_put(struct svc_xprt *xprt); |
9dbc240f | 128 | void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt); |
0f0257ea | 129 | void svc_close_xprt(struct svc_xprt *xprt); |
0f0257ea | 130 | int svc_port_is_privileged(struct sockaddr *sin); |
dc9a16e4 | 131 | int svc_print_xprts(char *buf, int maxlen); |
156e6209 | 132 | struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name, |
4cb54ca2 SK |
133 | struct net *net, const sa_family_t af, |
134 | const unsigned short port); | |
335c54bd | 135 | int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen); |
39b55301 | 136 | void svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *xprt); |
c3d4879e | 137 | void svc_age_temp_xprts_now(struct svc_serv *, struct sockaddr *); |
0f0257ea | 138 | |
e1b3157f TT |
139 | static inline void svc_xprt_get(struct svc_xprt *xprt) |
140 | { | |
141 | kref_get(&xprt->xpt_ref); | |
142 | } | |
9dbc240f | 143 | static inline void svc_xprt_set_local(struct svc_xprt *xprt, |
efb3288b CL |
144 | const struct sockaddr *sa, |
145 | const size_t salen) | |
9dbc240f TT |
146 | { |
147 | memcpy(&xprt->xpt_local, sa, salen); | |
148 | xprt->xpt_locallen = salen; | |
149 | } | |
150 | static inline void svc_xprt_set_remote(struct svc_xprt *xprt, | |
efb3288b CL |
151 | const struct sockaddr *sa, |
152 | const size_t salen) | |
9dbc240f TT |
153 | { |
154 | memcpy(&xprt->xpt_remote, sa, salen); | |
155 | xprt->xpt_remotelen = salen; | |
ece200dd CL |
156 | snprintf(xprt->xpt_remotebuf, sizeof(xprt->xpt_remotebuf) - 1, |
157 | "%pISpc", sa); | |
9dbc240f | 158 | } |
ece200dd | 159 | |
efb3288b | 160 | static inline unsigned short svc_addr_port(const struct sockaddr *sa) |
9dbc240f | 161 | { |
efb3288b CL |
162 | const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; |
163 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa; | |
164 | ||
9dbc240f TT |
165 | switch (sa->sa_family) { |
166 | case AF_INET: | |
efb3288b | 167 | return ntohs(sin->sin_port); |
9dbc240f | 168 | case AF_INET6: |
efb3288b | 169 | return ntohs(sin6->sin6_port); |
9dbc240f | 170 | } |
efb3288b CL |
171 | |
172 | return 0; | |
9dbc240f TT |
173 | } |
174 | ||
abc5c44d | 175 | static inline size_t svc_addr_len(const struct sockaddr *sa) |
9dbc240f TT |
176 | { |
177 | switch (sa->sa_family) { | |
178 | case AF_INET: | |
179 | return sizeof(struct sockaddr_in); | |
180 | case AF_INET6: | |
181 | return sizeof(struct sockaddr_in6); | |
182 | } | |
af6d5721 | 183 | BUG(); |
9dbc240f TT |
184 | } |
185 | ||
efb3288b | 186 | static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt) |
9dbc240f | 187 | { |
efb3288b | 188 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_local); |
9dbc240f TT |
189 | } |
190 | ||
efb3288b | 191 | static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt) |
9dbc240f | 192 | { |
efb3288b | 193 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote); |
9dbc240f | 194 | } |
1d8206b9 | 195 | |
efb3288b CL |
196 | static inline char *__svc_print_addr(const struct sockaddr *addr, |
197 | char *buf, const size_t len) | |
0f0257ea | 198 | { |
efb3288b CL |
199 | const struct sockaddr_in *sin = (const struct sockaddr_in *)addr; |
200 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr; | |
201 | ||
0f0257ea TT |
202 | switch (addr->sa_family) { |
203 | case AF_INET: | |
efb3288b CL |
204 | snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr, |
205 | ntohs(sin->sin_port)); | |
0f0257ea TT |
206 | break; |
207 | ||
208 | case AF_INET6: | |
5b095d98 | 209 | snprintf(buf, len, "%pI6, port=%u", |
efb3288b CL |
210 | &sin6->sin6_addr, |
211 | ntohs(sin6->sin6_port)); | |
0f0257ea TT |
212 | break; |
213 | ||
214 | default: | |
215 | snprintf(buf, len, "unknown address type: %d", addr->sa_family); | |
216 | break; | |
217 | } | |
efb3288b | 218 | |
0f0257ea TT |
219 | return buf; |
220 | } | |
1d8206b9 | 221 | #endif /* SUNRPC_SVC_XPRT_H */ |