svc_xprt.h 6.11 KB
Newer Older
Tom Tucker's avatar
Tom Tucker committed
1
2
3
4
5
6
7
8
9
10
/*
 * linux/include/linux/sunrpc/svc_xprt.h
 *
 * RPC server transport I/O
 */

#ifndef SUNRPC_SVC_XPRT_H
#define SUNRPC_SVC_XPRT_H

#include <linux/sunrpc/svc.h>
Tom Tucker's avatar
Tom Tucker committed
11
#include <linux/module.h>
Tom Tucker's avatar
Tom Tucker committed
12
13

struct svc_xprt_ops {
14
	struct svc_xprt	*(*xpo_create)(struct svc_serv *,
15
				       struct net *net,
16
17
				       struct sockaddr *, int,
				       int);
18
	struct svc_xprt	*(*xpo_accept)(struct svc_xprt *);
19
	int		(*xpo_has_wspace)(struct svc_xprt *);
20
	int		(*xpo_recvfrom)(struct svc_rqst *);
Tom Tucker's avatar
Tom Tucker committed
21
	void		(*xpo_prep_reply_hdr)(struct svc_rqst *);
22
	int		(*xpo_sendto)(struct svc_rqst *);
23
	void		(*xpo_release_rqst)(struct svc_rqst *);
24
25
	void		(*xpo_detach)(struct svc_xprt *);
	void		(*xpo_free)(struct svc_xprt *);
Tom Tucker's avatar
Tom Tucker committed
26
27
28
29
30
31
32
};

struct svc_xprt_class {
	const char		*xcl_name;
	struct module		*xcl_owner;
	struct svc_xprt_ops	*xcl_ops;
	struct list_head	xcl_list;
33
	u32			xcl_max_payload;
Tom Tucker's avatar
Tom Tucker committed
34
35
};

36
37
38
39
40
41
42
43
44
45
/*
 * This is embedded in an object that wants a callback before deleting
 * an xprt; intended for use by NFSv4.1, which needs to know when a
 * client's tcp connection (and hence possibly a backchannel) goes away.
 */
struct svc_xpt_user {
	struct list_head list;
	void (*callback)(struct svc_xpt_user *);
};

Tom Tucker's avatar
Tom Tucker committed
46
47
48
struct svc_xprt {
	struct svc_xprt_class	*xpt_class;
	struct svc_xprt_ops	*xpt_ops;
Tom Tucker's avatar
Tom Tucker committed
49
	struct kref		xpt_ref;
50
51
	struct list_head	xpt_list;
	struct list_head	xpt_ready;
52
53
54
55
56
57
58
59
60
61
62
63
	unsigned long		xpt_flags;
#define	XPT_BUSY	0		/* enqueued/receiving */
#define	XPT_CONN	1		/* conn pending */
#define	XPT_CLOSE	2		/* dead or dying */
#define	XPT_DATA	3		/* data pending */
#define	XPT_TEMP	4		/* connected transport */
#define	XPT_DEAD	6		/* transport closed */
#define	XPT_CHNGBUF	7		/* need to change snd/rcv buf sizes */
#define	XPT_DEFERRED	8		/* deferred request pending */
#define	XPT_OLD		9		/* used for xprt aging mark+sweep */
#define	XPT_DETACHED	10		/* detached from tempsocks list */
#define XPT_LISTENER	11		/* listening endpoint */
64
#define XPT_CACHE_AUTH	12		/* cache auth info */
65
66

	struct svc_serv		*xpt_server;	/* service for transport */
Tom Tucker's avatar
Tom Tucker committed
67
	atomic_t    	    	xpt_reserved;	/* space on outq that is rsvd */
68
	struct mutex		xpt_mutex;	/* to serialize sending data */
69
70
71
	spinlock_t		xpt_lock;	/* protects sk_deferred
						 * and xpt_auth_cache */
	void			*xpt_auth_cache;/* auth cache */
72
73
	struct list_head	xpt_deferred;	/* deferred requests that need
						 * to be revisted */
74
75
76
77
	struct sockaddr_storage	xpt_local;	/* local address */
	size_t			xpt_locallen;	/* length of address */
	struct sockaddr_storage	xpt_remote;	/* remote peer's address */
	size_t			xpt_remotelen;	/* length of address */
78
	struct rpc_wait_queue	xpt_bc_pending;	/* backchannel wait queue */
79
	struct list_head	xpt_users;	/* callbacks on free */
80
81

	struct net		*xpt_net;
82
	struct rpc_xprt		*xpt_bc_xprt;	/* NFSv4.1 backchannel */
Tom Tucker's avatar
Tom Tucker committed
83
84
};

85
static inline void unregister_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u)
86
87
{
	spin_lock(&xpt->xpt_lock);
88
	list_del_init(&u->list);
89
90
91
	spin_unlock(&xpt->xpt_lock);
}

92
static inline int register_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u)
93
94
{
	spin_lock(&xpt->xpt_lock);
95
96
97
98
99
100
101
102
103
104
	if (test_bit(XPT_CLOSE, &xpt->xpt_flags)) {
		/*
		 * The connection is about to be deleted soon (or,
		 * worse, may already be deleted--in which case we've
		 * already notified the xpt_users).
		 */
		spin_unlock(&xpt->xpt_lock);
		return -ENOTCONN;
	}
	list_add(&u->list, &xpt->xpt_users);
105
	spin_unlock(&xpt->xpt_lock);
106
	return 0;
107
108
}

Tom Tucker's avatar
Tom Tucker committed
109
110
int	svc_reg_xprt_class(struct svc_xprt_class *);
void	svc_unreg_xprt_class(struct svc_xprt_class *);
111
112
void	svc_xprt_init(struct svc_xprt_class *, struct svc_xprt *,
		      struct svc_serv *);
113
114
int	svc_create_xprt(struct svc_serv *, const char *, struct net *,
			const int, const unsigned short, int);
115
void	svc_xprt_enqueue(struct svc_xprt *xprt);
116
void	svc_xprt_received(struct svc_xprt *);
Tom Tucker's avatar
Tom Tucker committed
117
void	svc_xprt_put(struct svc_xprt *xprt);
118
void	svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
119
120
121
void	svc_close_xprt(struct svc_xprt *xprt);
void	svc_delete_xprt(struct svc_xprt *xprt);
int	svc_port_is_privileged(struct sockaddr *sin);
122
int	svc_print_xprts(char *buf, int maxlen);
123
124
struct	svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name,
			const sa_family_t af, const unsigned short port);
125
int	svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen);
126

Tom Tucker's avatar
Tom Tucker committed
127
128
129
130
static inline void svc_xprt_get(struct svc_xprt *xprt)
{
	kref_get(&xprt->xpt_ref);
}
131
static inline void svc_xprt_set_local(struct svc_xprt *xprt,
132
133
				      const struct sockaddr *sa,
				      const size_t salen)
134
135
136
137
138
{
	memcpy(&xprt->xpt_local, sa, salen);
	xprt->xpt_locallen = salen;
}
static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
139
140
				       const struct sockaddr *sa,
				       const size_t salen)
141
142
143
144
{
	memcpy(&xprt->xpt_remote, sa, salen);
	xprt->xpt_remotelen = salen;
}
145
static inline unsigned short svc_addr_port(const struct sockaddr *sa)
146
{
147
148
149
	const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
	const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa;

150
151
	switch (sa->sa_family) {
	case AF_INET:
152
		return ntohs(sin->sin_port);
153
	case AF_INET6:
154
		return ntohs(sin6->sin6_port);
155
	}
156
157

	return 0;
158
159
}

160
static inline size_t svc_addr_len(const struct sockaddr *sa)
161
162
163
164
165
166
167
{
	switch (sa->sa_family) {
	case AF_INET:
		return sizeof(struct sockaddr_in);
	case AF_INET6:
		return sizeof(struct sockaddr_in6);
	}
168
169

	return 0;
170
171
}

172
static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt)
173
{
174
	return svc_addr_port((const struct sockaddr *)&xprt->xpt_local);
175
176
}

177
static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt)
178
{
179
	return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote);
180
}
Tom Tucker's avatar
Tom Tucker committed
181

182
183
static inline char *__svc_print_addr(const struct sockaddr *addr,
				     char *buf, const size_t len)
184
{
185
186
187
	const struct sockaddr_in *sin = (const struct sockaddr_in *)addr;
	const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr;

188
189
	switch (addr->sa_family) {
	case AF_INET:
190
191
		snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr,
			ntohs(sin->sin_port));
192
193
194
		break;

	case AF_INET6:
Harvey Harrison's avatar
Harvey Harrison committed
195
		snprintf(buf, len, "%pI6, port=%u",
196
197
			 &sin6->sin6_addr,
			ntohs(sin6->sin6_port));
198
199
200
201
202
203
		break;

	default:
		snprintf(buf, len, "unknown address type: %d", addr->sa_family);
		break;
	}
204

205
206
	return buf;
}
Tom Tucker's avatar
Tom Tucker committed
207
#endif /* SUNRPC_SVC_XPRT_H */