blob: e5d19344037491651c6c80f6b310842ee5715126 [file] [log] [blame]
Tom Tucker1d8206b92007-12-30 21:07:15 -06001/*
2 * linux/include/linux/sunrpc/svc_xprt.h
3 *
4 * RPC server transport I/O
5 */
6
7#ifndef SUNRPC_SVC_XPRT_H
8#define SUNRPC_SVC_XPRT_H
9
10#include <linux/sunrpc/svc.h>
Paul Gortmakerde477252011-05-26 13:46:22 -040011
12struct module;
Tom Tucker1d8206b92007-12-30 21:07:15 -060013
14struct svc_xprt_ops {
Tom Tuckerb700cbb2007-12-30 21:07:42 -060015 struct svc_xprt *(*xpo_create)(struct svc_serv *,
Pavel Emelyanov62832c02010-09-29 16:04:18 +040016 struct net *net,
Tom Tuckerb700cbb2007-12-30 21:07:42 -060017 struct sockaddr *, int,
18 int);
Tom Tucker38a417c2007-12-30 21:07:36 -060019 struct svc_xprt *(*xpo_accept)(struct svc_xprt *);
Tom Tucker323bee32007-12-30 21:07:31 -060020 int (*xpo_has_wspace)(struct svc_xprt *);
Tom Tucker5d137992007-12-30 21:07:23 -060021 int (*xpo_recvfrom)(struct svc_rqst *);
Tom Tuckere831fe62007-12-30 21:07:29 -060022 void (*xpo_prep_reply_hdr)(struct svc_rqst *);
Tom Tucker5d137992007-12-30 21:07:23 -060023 int (*xpo_sendto)(struct svc_rqst *);
Tom Tucker5148bf42007-12-30 21:07:25 -060024 void (*xpo_release_rqst)(struct svc_rqst *);
Tom Tucker755ccea2007-12-30 21:07:27 -060025 void (*xpo_detach)(struct svc_xprt *);
26 void (*xpo_free)(struct svc_xprt *);
Chuck Lever16e4d932014-05-19 13:40:22 -040027 int (*xpo_secure_port)(struct svc_rqst *);
Scott Mayhewea08e392016-11-11 13:16:22 -050028 void (*xpo_kill_temp_xprt)(struct svc_xprt *);
Tom Tucker1d8206b92007-12-30 21:07:15 -060029};
30
31struct svc_xprt_class {
32 const char *xcl_name;
33 struct module *xcl_owner;
34 struct svc_xprt_ops *xcl_ops;
35 struct list_head xcl_list;
Tom Tucker49023152007-12-30 21:07:21 -060036 u32 xcl_max_payload;
Chuck Lever3c45ddf2014-07-16 15:38:32 -040037 int xcl_ident;
Tom Tucker1d8206b92007-12-30 21:07:15 -060038};
39
J. Bruce Fieldsedc7a892010-03-22 15:37:17 -040040/*
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 */
45struct svc_xpt_user {
46 struct list_head list;
47 void (*callback)(struct svc_xpt_user *);
48};
49
Tom Tucker1d8206b92007-12-30 21:07:15 -060050struct svc_xprt {
51 struct svc_xprt_class *xpt_class;
52 struct svc_xprt_ops *xpt_ops;
Tom Tuckere1b31572007-12-30 21:07:46 -060053 struct kref xpt_ref;
Tom Tucker7a182082007-12-30 21:07:53 -060054 struct list_head xpt_list;
55 struct list_head xpt_ready;
Tom Tucker02fc6c32007-12-30 21:07:48 -060056 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 */
Jeff Layton8d65ef72014-11-17 17:02:57 -050066#define XPT_LISTENER 10 /* listening endpoint */
67#define XPT_CACHE_AUTH 11 /* cache auth info */
68#define XPT_LOCAL 12 /* connection from loopback interface */
Tom Tuckerbb5cf162007-12-30 21:07:50 -060069
Tom Tuckerbb5cf162007-12-30 21:07:50 -060070 struct svc_serv *xpt_server; /* service for transport */
Tom Tucker7a90e8c2007-12-30 21:07:55 -060071 atomic_t xpt_reserved; /* space on outq that is rsvd */
Trond Myklebustff3ac5c2016-06-24 10:55:50 -040072 atomic_t xpt_nr_rqsts; /* Number of requests */
Tom Tuckera50fea22007-12-30 21:07:59 -060073 struct mutex xpt_mutex; /* to serialize sending data */
Tom Tuckerdef13d72007-12-30 21:08:08 -060074 spinlock_t xpt_lock; /* protects sk_deferred
75 * and xpt_auth_cache */
76 void *xpt_auth_cache;/* auth cache */
Tom Tucker8c7b0172007-12-30 21:08:10 -060077 struct list_head xpt_deferred; /* deferred requests that need
78 * to be revisted */
Tom Tucker9dbc2402007-12-30 21:08:12 -060079 struct sockaddr_storage xpt_local; /* local address */
80 size_t xpt_locallen; /* length of address */
81 struct sockaddr_storage xpt_remote; /* remote peer's address */
82 size_t xpt_remotelen; /* length of address */
Rahul Iyer4cfc7e62009-09-10 17:32:28 +030083 struct rpc_wait_queue xpt_bc_pending; /* backchannel wait queue */
J. Bruce Fieldsedc7a892010-03-22 15:37:17 -040084 struct list_head xpt_users; /* callbacks on free */
Pavel Emelyanov4fb85182010-09-27 14:00:49 +040085
86 struct net *xpt_net;
J. Bruce Fieldsd75faea2010-11-30 19:15:01 -050087 struct rpc_xprt *xpt_bc_xprt; /* NFSv4.1 backchannel */
J. Bruce Fields39a9bea2016-05-17 12:38:21 -040088 struct rpc_xprt_switch *xpt_bc_xps; /* NFSv4.1 backchannel */
Tom Tucker1d8206b92007-12-30 21:07:15 -060089};
90
J. Bruce Fieldsedc7a892010-03-22 15:37:17 -040091static inline void unregister_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u)
92{
93 spin_lock(&xpt->xpt_lock);
94 list_del_init(&u->list);
95 spin_unlock(&xpt->xpt_lock);
96}
97
J. Bruce Fields21b75b02010-10-26 10:07:17 -040098static inline int register_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u)
99{
100 spin_lock(&xpt->xpt_lock);
101 if (test_bit(XPT_CLOSE, &xpt->xpt_flags)) {
102 /*
103 * The connection is about to be deleted soon (or,
104 * worse, may already be deleted--in which case we've
105 * already notified the xpt_users).
106 */
107 spin_unlock(&xpt->xpt_lock);
108 return -ENOTCONN;
109 }
110 list_add(&u->list, &xpt->xpt_users);
111 spin_unlock(&xpt->xpt_lock);
112 return 0;
113}
114
Tom Tucker1d8206b92007-12-30 21:07:15 -0600115int svc_reg_xprt_class(struct svc_xprt_class *);
116void svc_unreg_xprt_class(struct svc_xprt_class *);
Stanislav Kinsburskybd4620d2011-12-06 14:19:10 +0300117void svc_xprt_init(struct net *, struct svc_xprt_class *, struct svc_xprt *,
Tom Tuckerbb5cf162007-12-30 21:07:50 -0600118 struct svc_serv *);
Pavel Emelyanovfc5d00b2010-09-29 16:03:50 +0400119int svc_create_xprt(struct svc_serv *, const char *, struct net *,
120 const int, const unsigned short, int);
Jeff Laytonb9e13cd2015-06-08 12:06:51 -0700121void svc_xprt_do_enqueue(struct svc_xprt *xprt);
Tom Tucker0f0257e2007-12-30 21:08:27 -0600122void svc_xprt_enqueue(struct svc_xprt *xprt);
Tom Tuckere1b31572007-12-30 21:07:46 -0600123void svc_xprt_put(struct svc_xprt *xprt);
Tom Tucker9dbc2402007-12-30 21:08:12 -0600124void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
Tom Tucker0f0257e2007-12-30 21:08:27 -0600125void svc_close_xprt(struct svc_xprt *xprt);
Tom Tucker0f0257e2007-12-30 21:08:27 -0600126int svc_port_is_privileged(struct sockaddr *sin);
Tom Tuckerdc9a16e2007-12-30 21:08:31 -0600127int svc_print_xprts(char *buf, int maxlen);
Chuck Lever156e6202009-03-18 20:45:58 -0400128struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name,
Stanislav Kinsbursky4cb54ca2012-01-20 16:50:53 +0400129 struct net *net, const sa_family_t af,
130 const unsigned short port);
Chuck Lever335c54b2009-04-23 19:32:25 -0400131int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen);
J. Bruce Fields39b55302012-08-14 15:50:34 -0400132void svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *xprt);
Scott Mayhewc3d48792015-12-11 16:45:58 -0500133void svc_age_temp_xprts_now(struct svc_serv *, struct sockaddr *);
Tom Tucker0f0257e2007-12-30 21:08:27 -0600134
Tom Tuckere1b31572007-12-30 21:07:46 -0600135static inline void svc_xprt_get(struct svc_xprt *xprt)
136{
137 kref_get(&xprt->xpt_ref);
138}
Tom Tucker9dbc2402007-12-30 21:08:12 -0600139static inline void svc_xprt_set_local(struct svc_xprt *xprt,
Chuck Leverefb32882009-03-18 20:45:43 -0400140 const struct sockaddr *sa,
141 const size_t salen)
Tom Tucker9dbc2402007-12-30 21:08:12 -0600142{
143 memcpy(&xprt->xpt_local, sa, salen);
144 xprt->xpt_locallen = salen;
145}
146static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
Chuck Leverefb32882009-03-18 20:45:43 -0400147 const struct sockaddr *sa,
148 const size_t salen)
Tom Tucker9dbc2402007-12-30 21:08:12 -0600149{
150 memcpy(&xprt->xpt_remote, sa, salen);
151 xprt->xpt_remotelen = salen;
152}
Chuck Leverefb32882009-03-18 20:45:43 -0400153static inline unsigned short svc_addr_port(const struct sockaddr *sa)
Tom Tucker9dbc2402007-12-30 21:08:12 -0600154{
Chuck Leverefb32882009-03-18 20:45:43 -0400155 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
156 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa;
157
Tom Tucker9dbc2402007-12-30 21:08:12 -0600158 switch (sa->sa_family) {
159 case AF_INET:
Chuck Leverefb32882009-03-18 20:45:43 -0400160 return ntohs(sin->sin_port);
Tom Tucker9dbc2402007-12-30 21:08:12 -0600161 case AF_INET6:
Chuck Leverefb32882009-03-18 20:45:43 -0400162 return ntohs(sin6->sin6_port);
Tom Tucker9dbc2402007-12-30 21:08:12 -0600163 }
Chuck Leverefb32882009-03-18 20:45:43 -0400164
165 return 0;
Tom Tucker9dbc2402007-12-30 21:08:12 -0600166}
167
Chuck Leverabc5c442009-04-23 19:31:25 -0400168static inline size_t svc_addr_len(const struct sockaddr *sa)
Tom Tucker9dbc2402007-12-30 21:08:12 -0600169{
170 switch (sa->sa_family) {
171 case AF_INET:
172 return sizeof(struct sockaddr_in);
173 case AF_INET6:
174 return sizeof(struct sockaddr_in6);
175 }
J. Bruce Fieldsaf6d5722012-08-21 17:22:11 -0400176 BUG();
Tom Tucker9dbc2402007-12-30 21:08:12 -0600177}
178
Chuck Leverefb32882009-03-18 20:45:43 -0400179static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt)
Tom Tucker9dbc2402007-12-30 21:08:12 -0600180{
Chuck Leverefb32882009-03-18 20:45:43 -0400181 return svc_addr_port((const struct sockaddr *)&xprt->xpt_local);
Tom Tucker9dbc2402007-12-30 21:08:12 -0600182}
183
Chuck Leverefb32882009-03-18 20:45:43 -0400184static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt)
Tom Tucker9dbc2402007-12-30 21:08:12 -0600185{
Chuck Leverefb32882009-03-18 20:45:43 -0400186 return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote);
Tom Tucker9dbc2402007-12-30 21:08:12 -0600187}
Tom Tucker1d8206b92007-12-30 21:07:15 -0600188
Chuck Leverefb32882009-03-18 20:45:43 -0400189static inline char *__svc_print_addr(const struct sockaddr *addr,
190 char *buf, const size_t len)
Tom Tucker0f0257e2007-12-30 21:08:27 -0600191{
Chuck Leverefb32882009-03-18 20:45:43 -0400192 const struct sockaddr_in *sin = (const struct sockaddr_in *)addr;
193 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr;
194
Tom Tucker0f0257e2007-12-30 21:08:27 -0600195 switch (addr->sa_family) {
196 case AF_INET:
Chuck Leverefb32882009-03-18 20:45:43 -0400197 snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr,
198 ntohs(sin->sin_port));
Tom Tucker0f0257e2007-12-30 21:08:27 -0600199 break;
200
201 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700202 snprintf(buf, len, "%pI6, port=%u",
Chuck Leverefb32882009-03-18 20:45:43 -0400203 &sin6->sin6_addr,
204 ntohs(sin6->sin6_port));
Tom Tucker0f0257e2007-12-30 21:08:27 -0600205 break;
206
207 default:
208 snprintf(buf, len, "unknown address type: %d", addr->sa_family);
209 break;
210 }
Chuck Leverefb32882009-03-18 20:45:43 -0400211
Tom Tucker0f0257e2007-12-30 21:08:27 -0600212 return buf;
213}
Tom Tucker1d8206b92007-12-30 21:07:15 -0600214#endif /* SUNRPC_SVC_XPRT_H */