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