Commit | Line | Data |
---|---|---|
1d8206b9 TT |
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> | |
de477254 PG |
11 | |
12 | struct module; | |
1d8206b9 TT |
13 | |
14 | struct svc_xprt_ops { | |
b700cbb1 | 15 | struct svc_xprt *(*xpo_create)(struct svc_serv *, |
62832c03 | 16 | struct net *net, |
b700cbb1 TT |
17 | struct sockaddr *, int, |
18 | int); | |
38a417cc | 19 | struct svc_xprt *(*xpo_accept)(struct svc_xprt *); |
323bee32 | 20 | int (*xpo_has_wspace)(struct svc_xprt *); |
5d137990 | 21 | int (*xpo_recvfrom)(struct svc_rqst *); |
e831fe65 | 22 | void (*xpo_prep_reply_hdr)(struct svc_rqst *); |
5d137990 | 23 | int (*xpo_sendto)(struct svc_rqst *); |
5148bf4e | 24 | void (*xpo_release_rqst)(struct svc_rqst *); |
755cceab TT |
25 | void (*xpo_detach)(struct svc_xprt *); |
26 | void (*xpo_free)(struct svc_xprt *); | |
1d8206b9 TT |
27 | }; |
28 | ||
29 | struct svc_xprt_class { | |
30 | const char *xcl_name; | |
31 | struct module *xcl_owner; | |
32 | struct svc_xprt_ops *xcl_ops; | |
33 | struct list_head xcl_list; | |
49023155 | 34 | u32 xcl_max_payload; |
1d8206b9 TT |
35 | }; |
36 | ||
edc7a894 BF |
37 | /* |
38 | * This is embedded in an object that wants a callback before deleting | |
39 | * an xprt; intended for use by NFSv4.1, which needs to know when a | |
40 | * client's tcp connection (and hence possibly a backchannel) goes away. | |
41 | */ | |
42 | struct svc_xpt_user { | |
43 | struct list_head list; | |
44 | void (*callback)(struct svc_xpt_user *); | |
45 | }; | |
46 | ||
1d8206b9 TT |
47 | struct svc_xprt { |
48 | struct svc_xprt_class *xpt_class; | |
49 | struct svc_xprt_ops *xpt_ops; | |
e1b3157f | 50 | struct kref xpt_ref; |
7a182083 TT |
51 | struct list_head xpt_list; |
52 | struct list_head xpt_ready; | |
02fc6c36 TT |
53 | unsigned long xpt_flags; |
54 | #define XPT_BUSY 0 /* enqueued/receiving */ | |
55 | #define XPT_CONN 1 /* conn pending */ | |
56 | #define XPT_CLOSE 2 /* dead or dying */ | |
57 | #define XPT_DATA 3 /* data pending */ | |
58 | #define XPT_TEMP 4 /* connected transport */ | |
59 | #define XPT_DEAD 6 /* transport closed */ | |
60 | #define XPT_CHNGBUF 7 /* need to change snd/rcv buf sizes */ | |
61 | #define XPT_DEFERRED 8 /* deferred request pending */ | |
62 | #define XPT_OLD 9 /* used for xprt aging mark+sweep */ | |
63 | #define XPT_DETACHED 10 /* detached from tempsocks list */ | |
64 | #define XPT_LISTENER 11 /* listening endpoint */ | |
def13d74 | 65 | #define XPT_CACHE_AUTH 12 /* cache auth info */ |
bb5cf160 | 66 | |
bb5cf160 | 67 | struct svc_serv *xpt_server; /* service for transport */ |
7a90e8cc | 68 | atomic_t xpt_reserved; /* space on outq that is rsvd */ |
a50fea26 | 69 | struct mutex xpt_mutex; /* to serialize sending data */ |
def13d74 TT |
70 | spinlock_t xpt_lock; /* protects sk_deferred |
71 | * and xpt_auth_cache */ | |
72 | void *xpt_auth_cache;/* auth cache */ | |
8c7b0172 TT |
73 | struct list_head xpt_deferred; /* deferred requests that need |
74 | * to be revisted */ | |
9dbc240f TT |
75 | struct sockaddr_storage xpt_local; /* local address */ |
76 | size_t xpt_locallen; /* length of address */ | |
77 | struct sockaddr_storage xpt_remote; /* remote peer's address */ | |
78 | size_t xpt_remotelen; /* length of address */ | |
4cfc7e60 | 79 | struct rpc_wait_queue xpt_bc_pending; /* backchannel wait queue */ |
edc7a894 | 80 | struct list_head xpt_users; /* callbacks on free */ |
4fb8518b PE |
81 | |
82 | struct net *xpt_net; | |
d75faea3 | 83 | struct rpc_xprt *xpt_bc_xprt; /* NFSv4.1 backchannel */ |
1d8206b9 TT |
84 | }; |
85 | ||
21b75b01 | 86 | static inline void unregister_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u) |
edc7a894 BF |
87 | { |
88 | spin_lock(&xpt->xpt_lock); | |
21b75b01 | 89 | list_del_init(&u->list); |
edc7a894 BF |
90 | spin_unlock(&xpt->xpt_lock); |
91 | } | |
92 | ||
21b75b01 | 93 | static inline int register_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u) |
edc7a894 BF |
94 | { |
95 | spin_lock(&xpt->xpt_lock); | |
21b75b01 BF |
96 | if (test_bit(XPT_CLOSE, &xpt->xpt_flags)) { |
97 | /* | |
98 | * The connection is about to be deleted soon (or, | |
99 | * worse, may already be deleted--in which case we've | |
100 | * already notified the xpt_users). | |
101 | */ | |
102 | spin_unlock(&xpt->xpt_lock); | |
103 | return -ENOTCONN; | |
104 | } | |
105 | list_add(&u->list, &xpt->xpt_users); | |
edc7a894 | 106 | spin_unlock(&xpt->xpt_lock); |
21b75b01 | 107 | return 0; |
edc7a894 BF |
108 | } |
109 | ||
1d8206b9 TT |
110 | int svc_reg_xprt_class(struct svc_xprt_class *); |
111 | void svc_unreg_xprt_class(struct svc_xprt_class *); | |
bd4620dd | 112 | void svc_xprt_init(struct net *, struct svc_xprt_class *, struct svc_xprt *, |
bb5cf160 | 113 | struct svc_serv *); |
fc5d00b0 PE |
114 | int svc_create_xprt(struct svc_serv *, const char *, struct net *, |
115 | const int, const unsigned short, int); | |
0f0257ea | 116 | void svc_xprt_enqueue(struct svc_xprt *xprt); |
a6046f71 | 117 | void svc_xprt_received(struct svc_xprt *); |
e1b3157f | 118 | void svc_xprt_put(struct svc_xprt *xprt); |
9dbc240f | 119 | void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt); |
0f0257ea | 120 | void svc_close_xprt(struct svc_xprt *xprt); |
0f0257ea | 121 | int svc_port_is_privileged(struct sockaddr *sin); |
dc9a16e4 | 122 | int svc_print_xprts(char *buf, int maxlen); |
156e6209 CL |
123 | struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name, |
124 | const sa_family_t af, const unsigned short port); | |
335c54bd | 125 | int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen); |
0f0257ea | 126 | |
e1b3157f TT |
127 | static inline void svc_xprt_get(struct svc_xprt *xprt) |
128 | { | |
129 | kref_get(&xprt->xpt_ref); | |
130 | } | |
9dbc240f | 131 | static inline void svc_xprt_set_local(struct svc_xprt *xprt, |
efb3288b CL |
132 | const struct sockaddr *sa, |
133 | const size_t salen) | |
9dbc240f TT |
134 | { |
135 | memcpy(&xprt->xpt_local, sa, salen); | |
136 | xprt->xpt_locallen = salen; | |
137 | } | |
138 | static inline void svc_xprt_set_remote(struct svc_xprt *xprt, | |
efb3288b CL |
139 | const struct sockaddr *sa, |
140 | const size_t salen) | |
9dbc240f TT |
141 | { |
142 | memcpy(&xprt->xpt_remote, sa, salen); | |
143 | xprt->xpt_remotelen = salen; | |
144 | } | |
efb3288b | 145 | static inline unsigned short svc_addr_port(const struct sockaddr *sa) |
9dbc240f | 146 | { |
efb3288b CL |
147 | const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; |
148 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa; | |
149 | ||
9dbc240f TT |
150 | switch (sa->sa_family) { |
151 | case AF_INET: | |
efb3288b | 152 | return ntohs(sin->sin_port); |
9dbc240f | 153 | case AF_INET6: |
efb3288b | 154 | return ntohs(sin6->sin6_port); |
9dbc240f | 155 | } |
efb3288b CL |
156 | |
157 | return 0; | |
9dbc240f TT |
158 | } |
159 | ||
abc5c44d | 160 | static inline size_t svc_addr_len(const struct sockaddr *sa) |
9dbc240f TT |
161 | { |
162 | switch (sa->sa_family) { | |
163 | case AF_INET: | |
164 | return sizeof(struct sockaddr_in); | |
165 | case AF_INET6: | |
166 | return sizeof(struct sockaddr_in6); | |
167 | } | |
abc5c44d CL |
168 | |
169 | return 0; | |
9dbc240f TT |
170 | } |
171 | ||
efb3288b | 172 | static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt) |
9dbc240f | 173 | { |
efb3288b | 174 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_local); |
9dbc240f TT |
175 | } |
176 | ||
efb3288b | 177 | static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt) |
9dbc240f | 178 | { |
efb3288b | 179 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote); |
9dbc240f | 180 | } |
1d8206b9 | 181 | |
efb3288b CL |
182 | static inline char *__svc_print_addr(const struct sockaddr *addr, |
183 | char *buf, const size_t len) | |
0f0257ea | 184 | { |
efb3288b CL |
185 | const struct sockaddr_in *sin = (const struct sockaddr_in *)addr; |
186 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr; | |
187 | ||
0f0257ea TT |
188 | switch (addr->sa_family) { |
189 | case AF_INET: | |
efb3288b CL |
190 | snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr, |
191 | ntohs(sin->sin_port)); | |
0f0257ea TT |
192 | break; |
193 | ||
194 | case AF_INET6: | |
5b095d98 | 195 | snprintf(buf, len, "%pI6, port=%u", |
efb3288b CL |
196 | &sin6->sin6_addr, |
197 | ntohs(sin6->sin6_port)); | |
0f0257ea TT |
198 | break; |
199 | ||
200 | default: | |
201 | snprintf(buf, len, "unknown address type: %d", addr->sa_family); | |
202 | break; | |
203 | } | |
efb3288b | 204 | |
0f0257ea TT |
205 | return buf; |
206 | } | |
1d8206b9 | 207 | #endif /* SUNRPC_SVC_XPRT_H */ |