Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 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> |
Paul Gortmaker | de47725 | 2011-05-26 13:46:22 -0400 | [diff] [blame] | 11 | |
| 12 | struct module; |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 13 | |
| 14 | struct svc_xprt_ops { |
Tom Tucker | b700cbb | 2007-12-30 21:07:42 -0600 | [diff] [blame] | 15 | struct svc_xprt *(*xpo_create)(struct svc_serv *, |
Pavel Emelyanov | 62832c0 | 2010-09-29 16:04:18 +0400 | [diff] [blame] | 16 | struct net *net, |
Tom Tucker | b700cbb | 2007-12-30 21:07:42 -0600 | [diff] [blame] | 17 | struct sockaddr *, int, |
| 18 | int); |
Tom Tucker | 38a417c | 2007-12-30 21:07:36 -0600 | [diff] [blame] | 19 | struct svc_xprt *(*xpo_accept)(struct svc_xprt *); |
Tom Tucker | 323bee3 | 2007-12-30 21:07:31 -0600 | [diff] [blame] | 20 | int (*xpo_has_wspace)(struct svc_xprt *); |
Tom Tucker | 5d13799 | 2007-12-30 21:07:23 -0600 | [diff] [blame] | 21 | int (*xpo_recvfrom)(struct svc_rqst *); |
Tom Tucker | e831fe6 | 2007-12-30 21:07:29 -0600 | [diff] [blame] | 22 | void (*xpo_prep_reply_hdr)(struct svc_rqst *); |
Tom Tucker | 5d13799 | 2007-12-30 21:07:23 -0600 | [diff] [blame] | 23 | int (*xpo_sendto)(struct svc_rqst *); |
Tom Tucker | 5148bf4 | 2007-12-30 21:07:25 -0600 | [diff] [blame] | 24 | void (*xpo_release_rqst)(struct svc_rqst *); |
Tom Tucker | 755ccea | 2007-12-30 21:07:27 -0600 | [diff] [blame] | 25 | void (*xpo_detach)(struct svc_xprt *); |
| 26 | void (*xpo_free)(struct svc_xprt *); |
Chuck Lever | 16e4d93 | 2014-05-19 13:40:22 -0400 | [diff] [blame] | 27 | int (*xpo_secure_port)(struct svc_rqst *); |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 28 | }; |
| 29 | |
| 30 | struct svc_xprt_class { |
| 31 | const char *xcl_name; |
| 32 | struct module *xcl_owner; |
| 33 | struct svc_xprt_ops *xcl_ops; |
| 34 | struct list_head xcl_list; |
Tom Tucker | 4902315 | 2007-12-30 21:07:21 -0600 | [diff] [blame] | 35 | u32 xcl_max_payload; |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 36 | }; |
| 37 | |
J. Bruce Fields | edc7a89 | 2010-03-22 15:37:17 -0400 | [diff] [blame] | 38 | /* |
| 39 | * This is embedded in an object that wants a callback before deleting |
| 40 | * an xprt; intended for use by NFSv4.1, which needs to know when a |
| 41 | * client's tcp connection (and hence possibly a backchannel) goes away. |
| 42 | */ |
| 43 | struct svc_xpt_user { |
| 44 | struct list_head list; |
| 45 | void (*callback)(struct svc_xpt_user *); |
| 46 | }; |
| 47 | |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 48 | struct svc_xprt { |
| 49 | struct svc_xprt_class *xpt_class; |
| 50 | struct svc_xprt_ops *xpt_ops; |
Tom Tucker | e1b3157 | 2007-12-30 21:07:46 -0600 | [diff] [blame] | 51 | struct kref xpt_ref; |
Tom Tucker | 7a18208 | 2007-12-30 21:07:53 -0600 | [diff] [blame] | 52 | struct list_head xpt_list; |
| 53 | struct list_head xpt_ready; |
Tom Tucker | 02fc6c3 | 2007-12-30 21:07:48 -0600 | [diff] [blame] | 54 | unsigned long xpt_flags; |
| 55 | #define XPT_BUSY 0 /* enqueued/receiving */ |
| 56 | #define XPT_CONN 1 /* conn pending */ |
| 57 | #define XPT_CLOSE 2 /* dead or dying */ |
| 58 | #define XPT_DATA 3 /* data pending */ |
| 59 | #define XPT_TEMP 4 /* connected transport */ |
| 60 | #define XPT_DEAD 6 /* transport closed */ |
| 61 | #define XPT_CHNGBUF 7 /* need to change snd/rcv buf sizes */ |
| 62 | #define XPT_DEFERRED 8 /* deferred request pending */ |
| 63 | #define XPT_OLD 9 /* used for xprt aging mark+sweep */ |
| 64 | #define XPT_DETACHED 10 /* detached from tempsocks list */ |
| 65 | #define XPT_LISTENER 11 /* listening endpoint */ |
Tom Tucker | def13d7 | 2007-12-30 21:08:08 -0600 | [diff] [blame] | 66 | #define XPT_CACHE_AUTH 12 /* cache auth info */ |
NeilBrown | ef11ce2 | 2014-05-12 11:22:47 +1000 | [diff] [blame] | 67 | #define XPT_LOCAL 13 /* connection from loopback interface */ |
Tom Tucker | bb5cf16 | 2007-12-30 21:07:50 -0600 | [diff] [blame] | 68 | |
Tom Tucker | bb5cf16 | 2007-12-30 21:07:50 -0600 | [diff] [blame] | 69 | struct svc_serv *xpt_server; /* service for transport */ |
Tom Tucker | 7a90e8c | 2007-12-30 21:07:55 -0600 | [diff] [blame] | 70 | atomic_t xpt_reserved; /* space on outq that is rsvd */ |
Tom Tucker | a50fea2 | 2007-12-30 21:07:59 -0600 | [diff] [blame] | 71 | struct mutex xpt_mutex; /* to serialize sending data */ |
Tom Tucker | def13d7 | 2007-12-30 21:08:08 -0600 | [diff] [blame] | 72 | spinlock_t xpt_lock; /* protects sk_deferred |
| 73 | * and xpt_auth_cache */ |
| 74 | void *xpt_auth_cache;/* auth cache */ |
Tom Tucker | 8c7b017 | 2007-12-30 21:08:10 -0600 | [diff] [blame] | 75 | struct list_head xpt_deferred; /* deferred requests that need |
| 76 | * to be revisted */ |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 77 | struct sockaddr_storage xpt_local; /* local address */ |
| 78 | size_t xpt_locallen; /* length of address */ |
| 79 | struct sockaddr_storage xpt_remote; /* remote peer's address */ |
| 80 | size_t xpt_remotelen; /* length of address */ |
Rahul Iyer | 4cfc7e6 | 2009-09-10 17:32:28 +0300 | [diff] [blame] | 81 | struct rpc_wait_queue xpt_bc_pending; /* backchannel wait queue */ |
J. Bruce Fields | edc7a89 | 2010-03-22 15:37:17 -0400 | [diff] [blame] | 82 | struct list_head xpt_users; /* callbacks on free */ |
Pavel Emelyanov | 4fb8518 | 2010-09-27 14:00:49 +0400 | [diff] [blame] | 83 | |
| 84 | struct net *xpt_net; |
J. Bruce Fields | d75faea | 2010-11-30 19:15:01 -0500 | [diff] [blame] | 85 | struct rpc_xprt *xpt_bc_xprt; /* NFSv4.1 backchannel */ |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 86 | }; |
| 87 | |
J. Bruce Fields | edc7a89 | 2010-03-22 15:37:17 -0400 | [diff] [blame] | 88 | static inline void unregister_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u) |
| 89 | { |
| 90 | spin_lock(&xpt->xpt_lock); |
| 91 | list_del_init(&u->list); |
| 92 | spin_unlock(&xpt->xpt_lock); |
| 93 | } |
| 94 | |
J. Bruce Fields | 21b75b0 | 2010-10-26 10:07:17 -0400 | [diff] [blame] | 95 | static inline int register_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u) |
| 96 | { |
| 97 | spin_lock(&xpt->xpt_lock); |
| 98 | if (test_bit(XPT_CLOSE, &xpt->xpt_flags)) { |
| 99 | /* |
| 100 | * The connection is about to be deleted soon (or, |
| 101 | * worse, may already be deleted--in which case we've |
| 102 | * already notified the xpt_users). |
| 103 | */ |
| 104 | spin_unlock(&xpt->xpt_lock); |
| 105 | return -ENOTCONN; |
| 106 | } |
| 107 | list_add(&u->list, &xpt->xpt_users); |
| 108 | spin_unlock(&xpt->xpt_lock); |
| 109 | return 0; |
| 110 | } |
| 111 | |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 112 | int svc_reg_xprt_class(struct svc_xprt_class *); |
| 113 | void svc_unreg_xprt_class(struct svc_xprt_class *); |
Stanislav Kinsbursky | bd4620d | 2011-12-06 14:19:10 +0300 | [diff] [blame] | 114 | void svc_xprt_init(struct net *, struct svc_xprt_class *, struct svc_xprt *, |
Tom Tucker | bb5cf16 | 2007-12-30 21:07:50 -0600 | [diff] [blame] | 115 | struct svc_serv *); |
Pavel Emelyanov | fc5d00b | 2010-09-29 16:03:50 +0400 | [diff] [blame] | 116 | int svc_create_xprt(struct svc_serv *, const char *, struct net *, |
| 117 | const int, const unsigned short, int); |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 118 | void svc_xprt_enqueue(struct svc_xprt *xprt); |
Tom Tucker | e1b3157 | 2007-12-30 21:07:46 -0600 | [diff] [blame] | 119 | void svc_xprt_put(struct svc_xprt *xprt); |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 120 | void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt); |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 121 | void svc_close_xprt(struct svc_xprt *xprt); |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 122 | int svc_port_is_privileged(struct sockaddr *sin); |
Tom Tucker | dc9a16e | 2007-12-30 21:08:31 -0600 | [diff] [blame] | 123 | int svc_print_xprts(char *buf, int maxlen); |
Chuck Lever | 156e620 | 2009-03-18 20:45:58 -0400 | [diff] [blame] | 124 | struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name, |
Stanislav Kinsbursky | 4cb54ca | 2012-01-20 16:50:53 +0400 | [diff] [blame] | 125 | struct net *net, const sa_family_t af, |
| 126 | const unsigned short port); |
Chuck Lever | 335c54b | 2009-04-23 19:32:25 -0400 | [diff] [blame] | 127 | int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen); |
J. Bruce Fields | 39b5530 | 2012-08-14 15:50:34 -0400 | [diff] [blame] | 128 | void svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *xprt); |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 129 | |
Tom Tucker | e1b3157 | 2007-12-30 21:07:46 -0600 | [diff] [blame] | 130 | static inline void svc_xprt_get(struct svc_xprt *xprt) |
| 131 | { |
| 132 | kref_get(&xprt->xpt_ref); |
| 133 | } |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 134 | static inline void svc_xprt_set_local(struct svc_xprt *xprt, |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 135 | const struct sockaddr *sa, |
| 136 | const size_t salen) |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 137 | { |
| 138 | memcpy(&xprt->xpt_local, sa, salen); |
| 139 | xprt->xpt_locallen = salen; |
| 140 | } |
| 141 | static inline void svc_xprt_set_remote(struct svc_xprt *xprt, |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 142 | const struct sockaddr *sa, |
| 143 | const size_t salen) |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 144 | { |
| 145 | memcpy(&xprt->xpt_remote, sa, salen); |
| 146 | xprt->xpt_remotelen = salen; |
| 147 | } |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 148 | static inline unsigned short svc_addr_port(const struct sockaddr *sa) |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 149 | { |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 150 | const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; |
| 151 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa; |
| 152 | |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 153 | switch (sa->sa_family) { |
| 154 | case AF_INET: |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 155 | return ntohs(sin->sin_port); |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 156 | case AF_INET6: |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 157 | return ntohs(sin6->sin6_port); |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 158 | } |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 159 | |
| 160 | return 0; |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 161 | } |
| 162 | |
Chuck Lever | abc5c44 | 2009-04-23 19:31:25 -0400 | [diff] [blame] | 163 | static inline size_t svc_addr_len(const struct sockaddr *sa) |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 164 | { |
| 165 | switch (sa->sa_family) { |
| 166 | case AF_INET: |
| 167 | return sizeof(struct sockaddr_in); |
| 168 | case AF_INET6: |
| 169 | return sizeof(struct sockaddr_in6); |
| 170 | } |
J. Bruce Fields | af6d572 | 2012-08-21 17:22:11 -0400 | [diff] [blame] | 171 | BUG(); |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 172 | } |
| 173 | |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 174 | static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt) |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 175 | { |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 176 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_local); |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 177 | } |
| 178 | |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 179 | static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt) |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 180 | { |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 181 | return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote); |
Tom Tucker | 9dbc240 | 2007-12-30 21:08:12 -0600 | [diff] [blame] | 182 | } |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 183 | |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 184 | static inline char *__svc_print_addr(const struct sockaddr *addr, |
| 185 | char *buf, const size_t len) |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 186 | { |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 187 | const struct sockaddr_in *sin = (const struct sockaddr_in *)addr; |
| 188 | const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr; |
| 189 | |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 190 | switch (addr->sa_family) { |
| 191 | case AF_INET: |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 192 | snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr, |
| 193 | ntohs(sin->sin_port)); |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 194 | break; |
| 195 | |
| 196 | case AF_INET6: |
Harvey Harrison | 5b095d989 | 2008-10-29 12:52:50 -0700 | [diff] [blame] | 197 | snprintf(buf, len, "%pI6, port=%u", |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 198 | &sin6->sin6_addr, |
| 199 | ntohs(sin6->sin6_port)); |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 200 | break; |
| 201 | |
| 202 | default: |
| 203 | snprintf(buf, len, "unknown address type: %d", addr->sa_family); |
| 204 | break; |
| 205 | } |
Chuck Lever | efb3288 | 2009-03-18 20:45:43 -0400 | [diff] [blame] | 206 | |
Tom Tucker | 0f0257e | 2007-12-30 21:08:27 -0600 | [diff] [blame] | 207 | return buf; |
| 208 | } |
Tom Tucker | 1d8206b9 | 2007-12-30 21:07:15 -0600 | [diff] [blame] | 209 | #endif /* SUNRPC_SVC_XPRT_H */ |