1 /*
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>
11 #include <linux/module.h>
12
13 struct svc_xprt_ops {
14 struct svc_xprt *(*xpo_create)(struct svc_serv *,
15 struct sockaddr *, int,
16 int);
17 struct svc_xprt *(*xpo_accept)(struct svc_xprt *);
18 int (*xpo_has_wspace)(struct svc_xprt *);
19 int (*xpo_recvfrom)(struct svc_rqst *);
20 void (*xpo_prep_reply_hdr)(struct svc_rqst *);
21 int (*xpo_sendto)(struct svc_rqst *);
22 void (*xpo_release_rqst)(struct svc_rqst *);
23 void (*xpo_detach)(struct svc_xprt *);
24 void (*xpo_free)(struct svc_xprt *);
25 };
26
27 struct 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;
32 u32 xcl_max_payload;
33 };
34
35 struct svc_xprt {
36 struct svc_xprt_class *xpt_class;
37 struct svc_xprt_ops *xpt_ops;
38 struct kref xpt_ref;
39 struct list_head xpt_list;
40 struct list_head xpt_ready;
41 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 */
53 #define XPT_CACHE_AUTH 12 /* cache auth info */
54
55 struct svc_pool *xpt_pool; /* current pool iff queued */
56 struct svc_serv *xpt_server; /* service for transport */
57 atomic_t xpt_reserved; /* space on outq that is rsvd */
58 struct mutex xpt_mutex; /* to serialize sending data */
59 spinlock_t xpt_lock; /* protects sk_deferred
60 * and xpt_auth_cache */
61 void *xpt_auth_cache;/* auth cache */
62 struct list_head xpt_deferred; /* deferred requests that need
63 * to be revisted */
64 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 */
68 };
69
70 int svc_reg_xprt_class(struct svc_xprt_class *);
71 void svc_unreg_xprt_class(struct svc_xprt_class *);
72 void svc_xprt_init(struct svc_xprt_class *, struct svc_xprt *,
73 struct svc_serv *);
74 int svc_create_xprt(struct svc_serv *, char *, unsigned short, int);
75 void svc_xprt_enqueue(struct svc_xprt *xprt);
76 void svc_xprt_received(struct svc_xprt *);
77 void svc_xprt_put(struct svc_xprt *xprt);
78 void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
79 void svc_close_xprt(struct svc_xprt *xprt);
80 void svc_delete_xprt(struct svc_xprt *xprt);
81 int svc_port_is_privileged(struct sockaddr *sin);
82 int svc_print_xprts(char *buf, int maxlen);
83 struct svc_xprt *svc_find_xprt(struct svc_serv *, char *, int, int);
84 int svc_xprt_names(struct svc_serv *serv, char *buf, int buflen);
85
svc_xprt_get(struct svc_xprt * xprt)86 static inline void svc_xprt_get(struct svc_xprt *xprt)
87 {
88 kref_get(&xprt->xpt_ref);
89 }
svc_xprt_set_local(struct svc_xprt * xprt,struct sockaddr * sa,int salen)90 static inline void svc_xprt_set_local(struct svc_xprt *xprt,
91 struct sockaddr *sa, int salen)
92 {
93 memcpy(&xprt->xpt_local, sa, salen);
94 xprt->xpt_locallen = salen;
95 }
svc_xprt_set_remote(struct svc_xprt * xprt,struct sockaddr * sa,int salen)96 static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
97 struct sockaddr *sa, int salen)
98 {
99 memcpy(&xprt->xpt_remote, sa, salen);
100 xprt->xpt_remotelen = salen;
101 }
svc_addr_port(struct sockaddr * sa)102 static inline unsigned short svc_addr_port(struct sockaddr *sa)
103 {
104 unsigned short ret = 0;
105 switch (sa->sa_family) {
106 case AF_INET:
107 ret = ntohs(((struct sockaddr_in *)sa)->sin_port);
108 break;
109 case AF_INET6:
110 ret = ntohs(((struct sockaddr_in6 *)sa)->sin6_port);
111 break;
112 }
113 return ret;
114 }
115
svc_addr_len(struct sockaddr * sa)116 static inline size_t svc_addr_len(struct sockaddr *sa)
117 {
118 switch (sa->sa_family) {
119 case AF_INET:
120 return sizeof(struct sockaddr_in);
121 case AF_INET6:
122 return sizeof(struct sockaddr_in6);
123 }
124 return -EAFNOSUPPORT;
125 }
126
svc_xprt_local_port(struct svc_xprt * xprt)127 static inline unsigned short svc_xprt_local_port(struct svc_xprt *xprt)
128 {
129 return svc_addr_port((struct sockaddr *)&xprt->xpt_local);
130 }
131
svc_xprt_remote_port(struct svc_xprt * xprt)132 static inline unsigned short svc_xprt_remote_port(struct svc_xprt *xprt)
133 {
134 return svc_addr_port((struct sockaddr *)&xprt->xpt_remote);
135 }
136
__svc_print_addr(struct sockaddr * addr,char * buf,size_t len)137 static inline char *__svc_print_addr(struct sockaddr *addr,
138 char *buf, size_t len)
139 {
140 switch (addr->sa_family) {
141 case AF_INET:
142 snprintf(buf, len, "%pI4, port=%u",
143 &((struct sockaddr_in *)addr)->sin_addr,
144 ntohs(((struct sockaddr_in *) addr)->sin_port));
145 break;
146
147 case AF_INET6:
148 snprintf(buf, len, "%pI6, port=%u",
149 &((struct sockaddr_in6 *)addr)->sin6_addr,
150 ntohs(((struct sockaddr_in6 *) addr)->sin6_port));
151 break;
152
153 default:
154 snprintf(buf, len, "unknown address type: %d", addr->sa_family);
155 break;
156 }
157 return buf;
158 }
159 #endif /* SUNRPC_SVC_XPRT_H */
160