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 | 22 | int (*xpo_recvfrom)(struct svc_rqst *); |
e831fe65 | 23 | void (*xpo_prep_reply_hdr)(struct svc_rqst *); |
5d137990 | 24 | int (*xpo_sendto)(struct svc_rqst *); |
5148bf4e | 25 | void (*xpo_release_rqst)(struct svc_rqst *); |
755cceab TT |
26 | void (*xpo_detach)(struct svc_xprt *); |
27 | void (*xpo_free)(struct svc_xprt *); | |
16e4d93f | 28 | int (*xpo_secure_port)(struct svc_rqst *); |
ea08e392 | 29 | void (*xpo_kill_temp_xprt)(struct svc_xprt *); |
1d8206b9 TT |
30 | }; |
31 | ||
32 | struct svc_xprt_class { | |
33 | const char *xcl_name; | |
34 | struct module *xcl_owner; | |
2412e927 | 35 | const struct svc_xprt_ops *xcl_ops; |
1d8206b9 | 36 | struct list_head xcl_list; |
49023155 | 37 | u32 xcl_max_payload; |
3c45ddf8 | 38 | int xcl_ident; |
1d8206b9 TT |
39 | }; |
40 | ||
edc7a894 BF |
41 | /* |
42 | * This is embedded in an object that wants a callback before deleting | |
43 | * an xprt; intended for use by NFSv4.1, which needs to know when a | |
44 | * client's tcp connection (and hence possibly a backchannel) goes away. | |
45 | */ | |
46 | struct svc_xpt_user { | |
47 | struct list_head list; | |
48 | void (*callback)(struct svc_xpt_user *); | |
49 | }; | |
50 | ||
1d8206b9 TT |
51 | struct svc_xprt { |
52 | struct svc_xprt_class *xpt_class; | |
2412e927 | 53 | const struct svc_xprt_ops *xpt_ops; |
e1b3157f | 54 | struct kref xpt_ref; |
7a182083 TT |
55 | struct list_head xpt_list; |
56 | struct list_head xpt_ready; | |
02fc6c36 TT |
57 | unsigned long xpt_flags; |
58 | #define XPT_BUSY 0 /* enqueued/receiving */ | |
59 | #define XPT_CONN 1 /* conn pending */ | |
60 | #define XPT_CLOSE 2 /* dead or dying */ | |
61 | #define XPT_DATA 3 /* data pending */ | |
62 | #define XPT_TEMP 4 /* connected transport */ | |
63 | #define XPT_DEAD 6 /* transport closed */ | |
64 | #define XPT_CHNGBUF 7 /* need to change snd/rcv buf sizes */ | |
65 | #define XPT_DEFERRED 8 /* deferred request pending */ | |
66 | #define XPT_OLD 9 /* used for xprt aging mark+sweep */ | |
8d65ef76 JL |
67 | #define XPT_LISTENER 10 /* listening endpoint */ |
68 | #define XPT_CACHE_AUTH 11 /* cache auth info */ | |
69 | #define XPT_LOCAL 12 /* connection from loopback interface */ | |
546125d1 | 70 | #define XPT_KILL_TEMP 13 /* call xpo_kill_temp_xprt before closing */ |
362142b2 | 71 | #define XPT_CONG_CTRL 14 /* has congestion control */ |
bb5cf160 | 72 | |
bb5cf160 | 73 | struct svc_serv *xpt_server; /* service for transport */ |
7a90e8cc | 74 | atomic_t xpt_reserved; /* space on outq that is rsvd */ |
ff3ac5c3 | 75 | atomic_t xpt_nr_rqsts; /* Number of requests */ |
a50fea26 | 76 | struct mutex xpt_mutex; /* to serialize sending data */ |
def13d74 TT |
77 | spinlock_t xpt_lock; /* protects sk_deferred |
78 | * and xpt_auth_cache */ | |
79 | void *xpt_auth_cache;/* auth cache */ | |
8c7b0172 TT |
80 | struct list_head xpt_deferred; /* deferred requests that need |
81 | * to be revisted */ | |
9dbc240f TT |
82 | struct sockaddr_storage xpt_local; /* local address */ |
83 | size_t xpt_locallen; /* length of address */ | |
84 | struct sockaddr_storage xpt_remote; /* remote peer's address */ | |
85 | size_t xpt_remotelen; /* length of address */ | |
4cfc7e60 | 86 | struct rpc_wait_queue xpt_bc_pending; /* backchannel wait queue */ |
edc7a894 | 87 | struct list_head xpt_users; /* callbacks on free */ |
4fb8518b PE |
88 | |
89 | struct net *xpt_net; | |
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 PE |
122 | int svc_create_xprt(struct svc_serv *, const char *, struct net *, |
123 | const int, const unsigned short, int); | |
b9e13cdf | 124 | void svc_xprt_do_enqueue(struct svc_xprt *xprt); |
0f0257ea | 125 | void svc_xprt_enqueue(struct svc_xprt *xprt); |
e1b3157f | 126 | void svc_xprt_put(struct svc_xprt *xprt); |
9dbc240f | 127 | void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt); |
0f0257ea | 128 | void svc_close_xprt(struct svc_xprt *xprt); |
0f0257ea | 129 | int svc_port_is_privileged(struct sockaddr *sin); |
dc9a16e4 | 130 | int svc_print_xprts(char *buf, int maxlen); |
156e6209 | 131 | struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name, |
4cb54ca2 SK |
132 | struct net *net, const sa_family_t af, |
133 | const unsigned short port); | |
335c54bd | 134 | int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen); |
39b55301 | 135 | void svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *xprt); |
c3d4879e | 136 | void svc_age_temp_xprts_now(struct svc_serv *, struct sockaddr *); |
0f0257ea | 137 | |
e1b3157f TT |
138 | static inline void svc_xprt_get(struct svc_xprt *xprt) |
139 | { | |
140 | kref_get(&xprt->xpt_ref); | |
141 | } | |
9dbc240f | 142 | static inline void svc_xprt_set_local(struct svc_xprt *xprt, |
efb3288b CL |
143 | const struct sockaddr *sa, |
144 | const size_t salen) | |
9dbc240f TT |
145 | { |
146 | memcpy(&xprt->xpt_local, sa, salen); | |
147 | xprt->xpt_locallen = salen; | |
148 | } | |
149 | static inline void svc_xprt_set_remote(struct svc_xprt *xprt, | |
efb3288b CL |
150 | const struct sockaddr *sa, |
151 | const size_t salen) | |
9dbc240f TT |
152 | { |
153 | memcpy(&xprt->xpt_remote, sa, salen); | |
154 | xprt->xpt_remotelen = salen; | |
155 | } | |
efb3288b | 156 | static inline unsigned short svc_addr_port(const struct sockaddr *sa) |
9dbc240f | 157 | { |
efb3288b CL |
158 | const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; |
159 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa; | |
160 | ||
9dbc240f TT |
161 | switch (sa->sa_family) { |
162 | case AF_INET: | |
efb3288b | 163 | return ntohs(sin->sin_port); |
9dbc240f | 164 | case AF_INET6: |
efb3288b | 165 | return ntohs(sin6->sin6_port); |
9dbc240f | 166 | } |
efb3288b CL |
167 | |
168 | return 0; | |
9dbc240f TT |
169 | } |
170 | ||
abc5c44d | 171 | static inline size_t svc_addr_len(const struct sockaddr *sa) |
9dbc240f TT |
172 | { |
173 | switch (sa->sa_family) { | |
174 | case AF_INET: | |
175 | return sizeof(struct sockaddr_in); | |
176 | case AF_INET6: | |
177 | return sizeof(struct sockaddr_in6); | |
178 | } | |
af6d5721 | 179 | BUG(); |
9dbc240f TT |
180 | } |
181 | ||
efb3288b | 182 | static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt) |
9dbc240f | 183 | { |
efb3288b | 184 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_local); |
9dbc240f TT |
185 | } |
186 | ||
efb3288b | 187 | static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt) |
9dbc240f | 188 | { |
efb3288b | 189 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote); |
9dbc240f | 190 | } |
1d8206b9 | 191 | |
efb3288b CL |
192 | static inline char *__svc_print_addr(const struct sockaddr *addr, |
193 | char *buf, const size_t len) | |
0f0257ea | 194 | { |
efb3288b CL |
195 | const struct sockaddr_in *sin = (const struct sockaddr_in *)addr; |
196 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr; | |
197 | ||
0f0257ea TT |
198 | switch (addr->sa_family) { |
199 | case AF_INET: | |
efb3288b CL |
200 | snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr, |
201 | ntohs(sin->sin_port)); | |
0f0257ea TT |
202 | break; |
203 | ||
204 | case AF_INET6: | |
5b095d98 | 205 | snprintf(buf, len, "%pI6, port=%u", |
efb3288b CL |
206 | &sin6->sin6_addr, |
207 | ntohs(sin6->sin6_port)); | |
0f0257ea TT |
208 | break; |
209 | ||
210 | default: | |
211 | snprintf(buf, len, "unknown address type: %d", addr->sa_family); | |
212 | break; | |
213 | } | |
efb3288b | 214 | |
0f0257ea TT |
215 | return buf; |
216 | } | |
1d8206b9 | 217 | #endif /* SUNRPC_SVC_XPRT_H */ |