blob: 09de12b63c1dddc36e10e1a0f24f49e508337f4d [file] [log] [blame]
Tom Tucker1d8206b2007-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>
Tom Tuckere1b31572007-12-30 21:07:46 -060011#include <linux/module.h>
Tom Tucker1d8206b2007-12-30 21:07:15 -060012
13struct svc_xprt_ops {
Tom Tuckerb700cbb2007-12-30 21:07:42 -060014 struct svc_xprt *(*xpo_create)(struct svc_serv *,
15 struct sockaddr *, int,
16 int);
Tom Tucker38a417c2007-12-30 21:07:36 -060017 struct svc_xprt *(*xpo_accept)(struct svc_xprt *);
Tom Tucker323bee32007-12-30 21:07:31 -060018 int (*xpo_has_wspace)(struct svc_xprt *);
Tom Tucker5d137992007-12-30 21:07:23 -060019 int (*xpo_recvfrom)(struct svc_rqst *);
Tom Tuckere831fe62007-12-30 21:07:29 -060020 void (*xpo_prep_reply_hdr)(struct svc_rqst *);
Tom Tucker5d137992007-12-30 21:07:23 -060021 int (*xpo_sendto)(struct svc_rqst *);
Tom Tucker5148bf42007-12-30 21:07:25 -060022 void (*xpo_release_rqst)(struct svc_rqst *);
Tom Tucker755ccea2007-12-30 21:07:27 -060023 void (*xpo_detach)(struct svc_xprt *);
24 void (*xpo_free)(struct svc_xprt *);
Tom Tucker1d8206b2007-12-30 21:07:15 -060025};
26
27struct svc_xprt_class {
28 const char *xcl_name;
29 struct module *xcl_owner;
30 struct svc_xprt_ops *xcl_ops;
31 struct list_head xcl_list;
Tom Tucker49023152007-12-30 21:07:21 -060032 u32 xcl_max_payload;
Tom Tucker1d8206b2007-12-30 21:07:15 -060033};
34
35struct svc_xprt {
36 struct svc_xprt_class *xpt_class;
37 struct svc_xprt_ops *xpt_ops;
Tom Tuckere1b31572007-12-30 21:07:46 -060038 struct kref xpt_ref;
Tom Tucker7a182082007-12-30 21:07:53 -060039 struct list_head xpt_list;
40 struct list_head xpt_ready;
Tom Tucker02fc6c32007-12-30 21:07:48 -060041 unsigned long xpt_flags;
42#define XPT_BUSY 0 /* enqueued/receiving */
43#define XPT_CONN 1 /* conn pending */
44#define XPT_CLOSE 2 /* dead or dying */
45#define XPT_DATA 3 /* data pending */
46#define XPT_TEMP 4 /* connected transport */
47#define XPT_DEAD 6 /* transport closed */
48#define XPT_CHNGBUF 7 /* need to change snd/rcv buf sizes */
49#define XPT_DEFERRED 8 /* deferred request pending */
50#define XPT_OLD 9 /* used for xprt aging mark+sweep */
51#define XPT_DETACHED 10 /* detached from tempsocks list */
52#define XPT_LISTENER 11 /* listening endpoint */
Tom Tuckerdef13d72007-12-30 21:08:08 -060053#define XPT_CACHE_AUTH 12 /* cache auth info */
Tom Tuckerbb5cf162007-12-30 21:07:50 -060054
55 struct svc_pool *xpt_pool; /* current pool iff queued */
56 struct svc_serv *xpt_server; /* service for transport */
Tom Tucker7a90e8c2007-12-30 21:07:55 -060057 atomic_t xpt_reserved; /* space on outq that is rsvd */
Tom Tuckera50fea22007-12-30 21:07:59 -060058 struct mutex xpt_mutex; /* to serialize sending data */
Tom Tuckerdef13d72007-12-30 21:08:08 -060059 spinlock_t xpt_lock; /* protects sk_deferred
60 * and xpt_auth_cache */
61 void *xpt_auth_cache;/* auth cache */
Tom Tucker8c7b0172007-12-30 21:08:10 -060062 struct list_head xpt_deferred; /* deferred requests that need
63 * to be revisted */
Tom Tucker9dbc2402007-12-30 21:08:12 -060064 struct sockaddr_storage xpt_local; /* local address */
65 size_t xpt_locallen; /* length of address */
66 struct sockaddr_storage xpt_remote; /* remote peer's address */
67 size_t xpt_remotelen; /* length of address */
Tom Tucker1d8206b2007-12-30 21:07:15 -060068};
69
70int svc_reg_xprt_class(struct svc_xprt_class *);
71void svc_unreg_xprt_class(struct svc_xprt_class *);
Tom Tuckerbb5cf162007-12-30 21:07:50 -060072void svc_xprt_init(struct svc_xprt_class *, struct svc_xprt *,
73 struct svc_serv *);
Tom Tuckerb700cbb2007-12-30 21:07:42 -060074int svc_create_xprt(struct svc_serv *, char *, unsigned short, int);
Tom Tuckera6046f72007-12-30 21:08:01 -060075void svc_xprt_received(struct svc_xprt *);
Tom Tuckere1b31572007-12-30 21:07:46 -060076void svc_xprt_put(struct svc_xprt *xprt);
Tom Tucker9dbc2402007-12-30 21:08:12 -060077void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
Tom Tuckere1b31572007-12-30 21:07:46 -060078static inline void svc_xprt_get(struct svc_xprt *xprt)
79{
80 kref_get(&xprt->xpt_ref);
81}
Tom Tucker9dbc2402007-12-30 21:08:12 -060082static inline void svc_xprt_set_local(struct svc_xprt *xprt,
83 struct sockaddr *sa, int salen)
84{
85 memcpy(&xprt->xpt_local, sa, salen);
86 xprt->xpt_locallen = salen;
87}
88static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
89 struct sockaddr *sa, int salen)
90{
91 memcpy(&xprt->xpt_remote, sa, salen);
92 xprt->xpt_remotelen = salen;
93}
94static inline unsigned short svc_addr_port(struct sockaddr *sa)
95{
96 unsigned short ret = 0;
97 switch (sa->sa_family) {
98 case AF_INET:
99 ret = ntohs(((struct sockaddr_in *)sa)->sin_port);
100 break;
101 case AF_INET6:
102 ret = ntohs(((struct sockaddr_in6 *)sa)->sin6_port);
103 break;
104 }
105 return ret;
106}
107
108static inline size_t svc_addr_len(struct sockaddr *sa)
109{
110 switch (sa->sa_family) {
111 case AF_INET:
112 return sizeof(struct sockaddr_in);
113 case AF_INET6:
114 return sizeof(struct sockaddr_in6);
115 }
116 return -EAFNOSUPPORT;
117}
118
119static inline unsigned short svc_xprt_local_port(struct svc_xprt *xprt)
120{
121 return svc_addr_port((struct sockaddr *)&xprt->xpt_local);
122}
123
124static inline unsigned short svc_xprt_remote_port(struct svc_xprt *xprt)
125{
126 return svc_addr_port((struct sockaddr *)&xprt->xpt_remote);
127}
Tom Tucker1d8206b2007-12-30 21:07:15 -0600128
129#endif /* SUNRPC_SVC_XPRT_H */