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 }; 37 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 48 struct svc_xprt { 49 struct svc_xprt_class *xpt_class; 50 struct svc_xprt_ops *xpt_ops; 51 struct kref xpt_ref; 52 struct list_head xpt_list; 53 struct list_head xpt_ready; 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 */ 66 #define XPT_CACHE_AUTH 12 /* cache auth info */ 67 #define XPT_LOCAL 13 /* 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 struct mutex xpt_mutex; /* to serialize sending data */ 72 spinlock_t xpt_lock; /* protects sk_deferred 73 * and xpt_auth_cache */ 74 void *xpt_auth_cache;/* auth cache */ 75 struct list_head xpt_deferred; /* deferred requests that need 76 * to be revisted */ 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 */ 81 struct rpc_wait_queue xpt_bc_pending; /* backchannel wait queue */ 82 struct list_head xpt_users; /* callbacks on free */ 83 84 struct net *xpt_net; 85 struct rpc_xprt *xpt_bc_xprt; /* NFSv4.1 backchannel */ 86 }; 87 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 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 112 int svc_reg_xprt_class(struct svc_xprt_class *); 113 void svc_unreg_xprt_class(struct svc_xprt_class *); 114 void svc_xprt_init(struct net *, struct svc_xprt_class *, struct svc_xprt *, 115 struct svc_serv *); 116 int svc_create_xprt(struct svc_serv *, const char *, struct net *, 117 const int, const unsigned short, int); 118 void svc_xprt_enqueue(struct svc_xprt *xprt); 119 void svc_xprt_put(struct svc_xprt *xprt); 120 void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt); 121 void svc_close_xprt(struct svc_xprt *xprt); 122 int svc_port_is_privileged(struct sockaddr *sin); 123 int svc_print_xprts(char *buf, int maxlen); 124 struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name, 125 struct net *net, const sa_family_t af, 126 const unsigned short port); 127 int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen); 128 void svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *xprt); 129 130 static inline void svc_xprt_get(struct svc_xprt *xprt) 131 { 132 kref_get(&xprt->xpt_ref); 133 } 134 static inline void svc_xprt_set_local(struct svc_xprt *xprt, 135 const struct sockaddr *sa, 136 const size_t salen) 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, 142 const struct sockaddr *sa, 143 const size_t salen) 144 { 145 memcpy(&xprt->xpt_remote, sa, salen); 146 xprt->xpt_remotelen = salen; 147 } 148 static inline unsigned short svc_addr_port(const struct sockaddr *sa) 149 { 150 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa; 151 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa; 152 153 switch (sa->sa_family) { 154 case AF_INET: 155 return ntohs(sin->sin_port); 156 case AF_INET6: 157 return ntohs(sin6->sin6_port); 158 } 159 160 return 0; 161 } 162 163 static inline size_t svc_addr_len(const struct sockaddr *sa) 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 } 171 BUG(); 172 } 173 174 static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt) 175 { 176 return svc_addr_port((const struct sockaddr *)&xprt->xpt_local); 177 } 178 179 static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt) 180 { 181 return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote); 182 } 183 184 static inline char *__svc_print_addr(const struct sockaddr *addr, 185 char *buf, const size_t len) 186 { 187 const struct sockaddr_in *sin = (const struct sockaddr_in *)addr; 188 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr; 189 190 switch (addr->sa_family) { 191 case AF_INET: 192 snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr, 193 ntohs(sin->sin_port)); 194 break; 195 196 case AF_INET6: 197 snprintf(buf, len, "%pI6, port=%u", 198 &sin6->sin6_addr, 199 ntohs(sin6->sin6_port)); 200 break; 201 202 default: 203 snprintf(buf, len, "unknown address type: %d", addr->sa_family); 204 break; 205 } 206 207 return buf; 208 } 209 #endif /* SUNRPC_SVC_XPRT_H */ 210