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