Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 2 | * linux/include/linux/sunrpc/xprt.h |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | * |
| 4 | * Declarations for the RPC transport interface. |
| 5 | * |
| 6 | * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de> |
| 7 | */ |
| 8 | |
| 9 | #ifndef _LINUX_SUNRPC_XPRT_H |
| 10 | #define _LINUX_SUNRPC_XPRT_H |
| 11 | |
| 12 | #include <linux/uio.h> |
| 13 | #include <linux/socket.h> |
| 14 | #include <linux/in.h> |
Chuck Lever | ff83997 | 2010-05-07 13:34:47 -0400 | [diff] [blame] | 15 | #include <linux/ktime.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | #include <linux/sunrpc/sched.h> |
| 17 | #include <linux/sunrpc/xdr.h> |
Greg Banks | 7adae48 | 2006-10-04 02:15:47 -0700 | [diff] [blame] | 18 | #include <linux/sunrpc/msg_prot.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 19 | |
Frank van Maarseveen | 96802a0 | 2007-07-08 13:08:54 +0200 | [diff] [blame] | 20 | #ifdef __KERNEL__ |
| 21 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 22 | #define RPC_MIN_SLOT_TABLE (2U) |
| 23 | #define RPC_DEF_SLOT_TABLE (16U) |
| 24 | #define RPC_MAX_SLOT_TABLE (128U) |
| 25 | |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 26 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | * This describes a timeout strategy |
| 28 | */ |
| 29 | struct rpc_timeout { |
| 30 | unsigned long to_initval, /* initial timeout */ |
| 31 | to_maxval, /* max timeout */ |
| 32 | to_increment; /* if !exponential */ |
| 33 | unsigned int to_retries; /* max # of retries */ |
| 34 | unsigned char to_exponential; |
| 35 | }; |
| 36 | |
Chuck Lever | edb267a | 2006-08-22 20:06:18 -0400 | [diff] [blame] | 37 | enum rpc_display_format_t { |
| 38 | RPC_DISPLAY_ADDR = 0, |
| 39 | RPC_DISPLAY_PORT, |
| 40 | RPC_DISPLAY_PROTO, |
Chuck Lever | fbfe3cc | 2007-08-06 11:57:02 -0400 | [diff] [blame] | 41 | RPC_DISPLAY_HEX_ADDR, |
| 42 | RPC_DISPLAY_HEX_PORT, |
\"Talpey, Thomas\ | 4417c8c | 2007-09-10 13:43:05 -0400 | [diff] [blame] | 43 | RPC_DISPLAY_NETID, |
Chuck Lever | edb267a | 2006-08-22 20:06:18 -0400 | [diff] [blame] | 44 | RPC_DISPLAY_MAX, |
| 45 | }; |
| 46 | |
Chuck Lever | 529b33c | 2005-08-25 16:25:54 -0700 | [diff] [blame] | 47 | struct rpc_task; |
| 48 | struct rpc_xprt; |
Trond Myklebust | e99170f | 2006-04-18 13:21:42 -0400 | [diff] [blame] | 49 | struct seq_file; |
Chuck Lever | 529b33c | 2005-08-25 16:25:54 -0700 | [diff] [blame] | 50 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | /* |
| 52 | * This describes a complete RPC request |
| 53 | */ |
| 54 | struct rpc_rqst { |
| 55 | /* |
| 56 | * This is the user-visible part |
| 57 | */ |
| 58 | struct rpc_xprt * rq_xprt; /* RPC client */ |
| 59 | struct xdr_buf rq_snd_buf; /* send buffer */ |
| 60 | struct xdr_buf rq_rcv_buf; /* recv buffer */ |
| 61 | |
| 62 | /* |
| 63 | * This is the private part |
| 64 | */ |
| 65 | struct rpc_task * rq_task; /* RPC task data */ |
Trond Myklebust | a17c215 | 2010-07-31 14:29:08 -0400 | [diff] [blame] | 66 | struct rpc_cred * rq_cred; /* Bound cred */ |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 67 | __be32 rq_xid; /* request XID */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | int rq_cong; /* has incremented xprt->cong */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | u32 rq_seqno; /* gss seq no. used on req. */ |
J. Bruce Fields | ead5e1c | 2005-10-13 16:54:43 -0400 | [diff] [blame] | 70 | int rq_enc_pages_num; |
| 71 | struct page **rq_enc_pages; /* scratch pages for use by |
| 72 | gss privacy code */ |
| 73 | void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | struct list_head rq_list; |
| 75 | |
Chuck Lever | 0210714 | 2006-01-03 09:55:49 +0100 | [diff] [blame] | 76 | __u32 * rq_buffer; /* XDR encode buffer */ |
Benny Halevy | c977a2e | 2008-12-23 16:06:13 -0500 | [diff] [blame] | 77 | size_t rq_callsize, |
Chuck Lever | 2bea90d | 2007-03-29 16:47:53 -0400 | [diff] [blame] | 78 | rq_rcvsize; |
Trond Myklebust | d60dbb2 | 2010-05-13 12:51:49 -0400 | [diff] [blame] | 79 | size_t rq_xmit_bytes_sent; /* total bytes sent */ |
| 80 | size_t rq_reply_bytes_recvd; /* total reply bytes */ |
| 81 | /* received */ |
Chuck Lever | 0210714 | 2006-01-03 09:55:49 +0100 | [diff] [blame] | 82 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 83 | struct xdr_buf rq_private_buf; /* The receive buffer |
| 84 | * used in the softirq. |
| 85 | */ |
| 86 | unsigned long rq_majortimeo; /* major timeout alarm */ |
| 87 | unsigned long rq_timeout; /* Current timeout value */ |
Trond Myklebust | d60dbb2 | 2010-05-13 12:51:49 -0400 | [diff] [blame] | 88 | ktime_t rq_rtt; /* round-trip time */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | unsigned int rq_retries; /* # of retries */ |
Trond Myklebust | 7c1d71c | 2008-04-17 16:52:57 -0400 | [diff] [blame] | 90 | unsigned int rq_connect_cookie; |
| 91 | /* A cookie used to track the |
| 92 | state of the transport |
| 93 | connection */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | |
| 95 | /* |
| 96 | * Partial send handling |
| 97 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | u32 rq_bytes_sent; /* Bytes we have sent */ |
| 99 | |
Chuck Lever | ff83997 | 2010-05-07 13:34:47 -0400 | [diff] [blame] | 100 | ktime_t rq_xtime; /* transmit time stamp */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | int rq_ntrans; |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 102 | |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 103 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 104 | struct list_head rq_bc_list; /* Callback service list */ |
| 105 | unsigned long rq_bc_pa_state; /* Backchannel prealloc state */ |
| 106 | struct list_head rq_bc_pa_list; /* Backchannel prealloc list */ |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 107 | #endif /* CONFIG_SUNRPC_BACKCHANEL */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | }; |
| 109 | #define rq_svec rq_snd_buf.head |
| 110 | #define rq_slen rq_snd_buf.len |
| 111 | |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 112 | struct rpc_xprt_ops { |
Chuck Lever | 470056c | 2005-08-25 16:25:56 -0700 | [diff] [blame] | 113 | void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize); |
Chuck Lever | 12a8046 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 114 | int (*reserve_xprt)(struct rpc_task *task); |
Chuck Lever | 49e9a89 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 115 | void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task); |
Chuck Lever | bbf7c1d | 2006-08-22 20:06:16 -0400 | [diff] [blame] | 116 | void (*rpcbind)(struct rpc_task *task); |
Chuck Lever | 9220041 | 2006-01-03 09:55:51 +0100 | [diff] [blame] | 117 | void (*set_port)(struct rpc_xprt *xprt, unsigned short port); |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 118 | void (*connect)(struct rpc_task *task); |
Chuck Lever | 0210714 | 2006-01-03 09:55:49 +0100 | [diff] [blame] | 119 | void * (*buf_alloc)(struct rpc_task *task, size_t size); |
Chuck Lever | c5a4dd8 | 2007-03-29 16:47:58 -0400 | [diff] [blame] | 120 | void (*buf_free)(void *buffer); |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 121 | int (*send_request)(struct rpc_task *task); |
Chuck Lever | fe3aca2 | 2005-08-25 16:25:50 -0700 | [diff] [blame] | 122 | void (*set_retrans_timeout)(struct rpc_task *task); |
Chuck Lever | 46c0ee8 | 2005-08-25 16:25:52 -0700 | [diff] [blame] | 123 | void (*timer)(struct rpc_task *task); |
Chuck Lever | a58dd39 | 2005-08-25 16:25:53 -0700 | [diff] [blame] | 124 | void (*release_request)(struct rpc_task *task); |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 125 | void (*close)(struct rpc_xprt *xprt); |
| 126 | void (*destroy)(struct rpc_xprt *xprt); |
Chuck Lever | 262ca07 | 2006-03-20 13:44:16 -0500 | [diff] [blame] | 127 | void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq); |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 128 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | |
Alexandros Batsakis | f300bab | 2009-09-10 17:33:30 +0300 | [diff] [blame] | 130 | /* |
| 131 | * RPC transport identifiers |
| 132 | * |
| 133 | * To preserve compatibility with the historical use of raw IP protocol |
| 134 | * id's for transport selection, UDP and TCP identifiers are specified |
| 135 | * with the previous values. No such restriction exists for new transports, |
| 136 | * except that they may not collide with these values (17 and 6, |
| 137 | * respectively). |
| 138 | */ |
| 139 | #define XPRT_TRANSPORT_BC (1 << 31) |
| 140 | enum xprt_transports { |
| 141 | XPRT_TRANSPORT_UDP = IPPROTO_UDP, |
| 142 | XPRT_TRANSPORT_TCP = IPPROTO_TCP, |
| 143 | XPRT_TRANSPORT_BC_TCP = IPPROTO_TCP | XPRT_TRANSPORT_BC, |
Chuck Lever | 176e21e | 2011-05-09 15:22:44 -0400 | [diff] [blame] | 144 | XPRT_TRANSPORT_RDMA = 256, |
| 145 | XPRT_TRANSPORT_LOCAL = 257, |
Alexandros Batsakis | f300bab | 2009-09-10 17:33:30 +0300 | [diff] [blame] | 146 | }; |
| 147 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | struct rpc_xprt { |
Trond Myklebust | a8de240 | 2011-03-15 19:56:30 -0400 | [diff] [blame] | 149 | atomic_t count; /* Reference count */ |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 150 | struct rpc_xprt_ops * ops; /* transport methods */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
Trond Myklebust | ba7392b | 2007-12-20 16:03:55 -0500 | [diff] [blame] | 152 | const struct rpc_timeout *timeout; /* timeout parms */ |
Chuck Lever | c4efcb1 | 2006-08-22 20:06:19 -0400 | [diff] [blame] | 153 | struct sockaddr_storage addr; /* server address */ |
| 154 | size_t addrlen; /* size of server address */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | int prot; /* IP protocol */ |
| 156 | |
| 157 | unsigned long cong; /* current congestion */ |
| 158 | unsigned long cwnd; /* congestion window */ |
| 159 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 160 | size_t max_payload; /* largest RPC payload size, |
| 161 | in bytes */ |
Chuck Lever | 808012f | 2005-08-25 16:25:49 -0700 | [diff] [blame] | 162 | unsigned int tsh_size; /* size of transport specific |
| 163 | header */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | |
Chuck Lever | 4a68179 | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 165 | struct rpc_wait_queue binding; /* requests waiting on rpcbind */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 166 | struct rpc_wait_queue sending; /* requests waiting to send */ |
| 167 | struct rpc_wait_queue resend; /* requests waiting to resend */ |
| 168 | struct rpc_wait_queue pending; /* requests in flight */ |
| 169 | struct rpc_wait_queue backlog; /* waiting for slot */ |
| 170 | struct list_head free; /* free slots */ |
| 171 | struct rpc_rqst * slot; /* slot table storage */ |
| 172 | unsigned int max_reqs; /* total slots */ |
Chuck Lever | 2226feb | 2005-08-11 16:25:38 -0400 | [diff] [blame] | 173 | unsigned long state; /* transport state */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | unsigned char shutdown : 1, /* being shut down */ |
Chuck Lever | 43118c2 | 2005-08-25 16:25:49 -0700 | [diff] [blame] | 175 | resvport : 1; /* use a reserved port */ |
Chuck Lever | a509050 | 2007-03-29 16:48:04 -0400 | [diff] [blame] | 176 | unsigned int bind_index; /* bind function index */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | |
| 178 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 179 | * Connection of transports |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | */ |
Trond Myklebust | a8ce4a8 | 2010-04-16 16:42:12 -0400 | [diff] [blame] | 181 | unsigned long bind_timeout, |
Chuck Lever | 03bf4b7 | 2005-08-25 16:25:55 -0700 | [diff] [blame] | 182 | reestablish_timeout; |
Trond Myklebust | 7c1d71c | 2008-04-17 16:52:57 -0400 | [diff] [blame] | 183 | unsigned int connect_cookie; /* A cookie that gets bumped |
| 184 | every time the transport |
| 185 | is reconnected */ |
Chuck Lever | 03bf4b7 | 2005-08-25 16:25:55 -0700 | [diff] [blame] | 186 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 187 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 188 | * Disconnection of idle transports |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 189 | */ |
| 190 | struct work_struct task_cleanup; |
| 191 | struct timer_list timer; |
Chuck Lever | 03bf4b7 | 2005-08-25 16:25:55 -0700 | [diff] [blame] | 192 | unsigned long last_used, |
| 193 | idle_timeout; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 194 | |
| 195 | /* |
| 196 | * Send stuff |
| 197 | */ |
Chuck Lever | 4a0f8c0 | 2005-08-11 16:25:32 -0400 | [diff] [blame] | 198 | spinlock_t transport_lock; /* lock transport info */ |
Chuck Lever | 5dc0772 | 2005-08-11 16:25:35 -0400 | [diff] [blame] | 199 | spinlock_t reserve_lock; /* lock slot table */ |
Chuck Lever | e744cf2 | 2006-10-17 14:44:24 -0400 | [diff] [blame] | 200 | u32 xid; /* Next XID value to use */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | struct rpc_task * snd_task; /* Task blocked in send */ |
Rahul Iyer | 4cfc7e6 | 2009-09-10 17:32:28 +0300 | [diff] [blame] | 202 | struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */ |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 203 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 204 | struct svc_serv *bc_serv; /* The RPC service which will */ |
| 205 | /* process the callback */ |
Ricardo Labiaga | fb7a0b9 | 2009-04-01 09:23:00 -0400 | [diff] [blame] | 206 | unsigned int bc_alloc_count; /* Total number of preallocs */ |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 207 | spinlock_t bc_pa_lock; /* Protects the preallocated |
| 208 | * items */ |
| 209 | struct list_head bc_pa_list; /* List of preallocated |
| 210 | * backchannel rpc_rqst's */ |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 211 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | struct list_head recv; |
| 213 | |
Chuck Lever | 262ca07 | 2006-03-20 13:44:16 -0500 | [diff] [blame] | 214 | struct { |
| 215 | unsigned long bind_count, /* total number of binds */ |
| 216 | connect_count, /* total number of connects */ |
| 217 | connect_start, /* connect start timestamp */ |
| 218 | connect_time, /* jiffies waiting for connect */ |
| 219 | sends, /* how many complete requests */ |
| 220 | recvs, /* how many complete requests */ |
| 221 | bad_xids; /* lookup_rqst didn't find XID */ |
| 222 | |
| 223 | unsigned long long req_u, /* average requests on the wire */ |
| 224 | bklog_u; /* backlog queue utilization */ |
| 225 | } stat; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 226 | |
Pavel Emelyanov | 37aa213 | 2010-09-29 16:05:43 +0400 | [diff] [blame] | 227 | struct net *xprt_net; |
Chuck Lever | b454ae9 | 2008-01-07 18:34:48 -0500 | [diff] [blame] | 228 | const char *address_strings[RPC_DISPLAY_MAX]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 229 | }; |
| 230 | |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 231 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 232 | /* |
| 233 | * Backchannel flags |
| 234 | */ |
| 235 | #define RPC_BC_PA_IN_USE 0x0001 /* Preallocated backchannel */ |
| 236 | /* buffer in use */ |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 237 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 238 | |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 239 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
Ricardo Labiaga | 55ae1aa | 2009-04-01 09:23:03 -0400 | [diff] [blame] | 240 | static inline int bc_prealloc(struct rpc_rqst *req) |
| 241 | { |
| 242 | return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state); |
| 243 | } |
| 244 | #else |
| 245 | static inline int bc_prealloc(struct rpc_rqst *req) |
| 246 | { |
| 247 | return 0; |
| 248 | } |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame^] | 249 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
Ricardo Labiaga | 55ae1aa | 2009-04-01 09:23:03 -0400 | [diff] [blame] | 250 | |
\"Talpey, Thomas\ | 3c341b0b | 2007-09-10 13:47:07 -0400 | [diff] [blame] | 251 | struct xprt_create { |
\"Talpey, Thomas\ | 4fa016e | 2007-09-10 13:47:57 -0400 | [diff] [blame] | 252 | int ident; /* XPRT_TRANSPORT identifier */ |
Pavel Emelyanov | 9a23e33 | 2010-09-29 16:05:12 +0400 | [diff] [blame] | 253 | struct net * net; |
Frank van Maarseveen | d3bc9a1 | 2007-07-09 22:23:35 +0200 | [diff] [blame] | 254 | struct sockaddr * srcaddr; /* optional local address */ |
Frank van Maarseveen | 96802a0 | 2007-07-08 13:08:54 +0200 | [diff] [blame] | 255 | struct sockaddr * dstaddr; /* remote peer address */ |
| 256 | size_t addrlen; |
Alexandros Batsakis | f300bab | 2009-09-10 17:33:30 +0300 | [diff] [blame] | 257 | struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */ |
Frank van Maarseveen | 96802a0 | 2007-07-08 13:08:54 +0200 | [diff] [blame] | 258 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 259 | |
\"Talpey, Thomas\ | 81c098a | 2007-09-10 13:46:00 -0400 | [diff] [blame] | 260 | struct xprt_class { |
| 261 | struct list_head list; |
\"Talpey, Thomas\ | 4fa016e | 2007-09-10 13:47:57 -0400 | [diff] [blame] | 262 | int ident; /* XPRT_TRANSPORT identifier */ |
\"Talpey, Thomas\ | 3c341b0b | 2007-09-10 13:47:07 -0400 | [diff] [blame] | 263 | struct rpc_xprt * (*setup)(struct xprt_create *); |
\"Talpey, Thomas\ | 81c098a | 2007-09-10 13:46:00 -0400 | [diff] [blame] | 264 | struct module *owner; |
| 265 | char name[32]; |
| 266 | }; |
| 267 | |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 268 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 269 | * Generic internal transport functions |
| 270 | */ |
\"Talpey, Thomas\ | 3c341b0b | 2007-09-10 13:47:07 -0400 | [diff] [blame] | 271 | struct rpc_xprt *xprt_create_transport(struct xprt_create *args); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 272 | void xprt_connect(struct rpc_task *task); |
| 273 | void xprt_reserve(struct rpc_task *task); |
Chuck Lever | 12a8046 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 274 | int xprt_reserve_xprt(struct rpc_task *task); |
| 275 | int xprt_reserve_xprt_cong(struct rpc_task *task); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 276 | int xprt_prepare_transmit(struct rpc_task *task); |
| 277 | void xprt_transmit(struct rpc_task *task); |
Trond Myklebust | e0ab53d | 2006-07-27 17:22:50 -0400 | [diff] [blame] | 278 | void xprt_end_transmit(struct rpc_task *task); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 279 | int xprt_adjust_timeout(struct rpc_rqst *req); |
Chuck Lever | 49e9a89 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 280 | void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task); |
| 281 | void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 282 | void xprt_release(struct rpc_task *task); |
Trond Myklebust | 6b6ca86 | 2006-09-05 12:55:57 -0400 | [diff] [blame] | 283 | struct rpc_xprt * xprt_get(struct rpc_xprt *xprt); |
| 284 | void xprt_put(struct rpc_xprt *xprt); |
Pavel Emelyanov | 37aa213 | 2010-09-29 16:05:43 +0400 | [diff] [blame] | 285 | struct rpc_xprt * xprt_alloc(struct net *net, int size, int max_req); |
Pavel Emelyanov | e204e62 | 2010-09-29 16:03:13 +0400 | [diff] [blame] | 286 | void xprt_free(struct rpc_xprt *); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 287 | |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 288 | static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p) |
Chuck Lever | 808012f | 2005-08-25 16:25:49 -0700 | [diff] [blame] | 289 | { |
| 290 | return p + xprt->tsh_size; |
| 291 | } |
| 292 | |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 293 | /* |
| 294 | * Transport switch helper functions |
| 295 | */ |
\"Talpey, Thomas\ | 81c098a | 2007-09-10 13:46:00 -0400 | [diff] [blame] | 296 | int xprt_register_transport(struct xprt_class *type); |
| 297 | int xprt_unregister_transport(struct xprt_class *type); |
Tom Talpey | 441e3e2 | 2009-03-11 14:37:56 -0400 | [diff] [blame] | 298 | int xprt_load_transport(const char *); |
Chuck Lever | fe3aca2 | 2005-08-25 16:25:50 -0700 | [diff] [blame] | 299 | void xprt_set_retrans_timeout_def(struct rpc_task *task); |
| 300 | void xprt_set_retrans_timeout_rtt(struct rpc_task *task); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 301 | void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status); |
Trond Myklebust | b6ddf64 | 2008-04-17 18:52:19 -0400 | [diff] [blame] | 302 | void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action); |
Chuck Lever | c7b2cae | 2005-08-11 16:25:50 -0400 | [diff] [blame] | 303 | void xprt_write_space(struct rpc_xprt *xprt); |
Chuck Lever | 46c0ee8 | 2005-08-25 16:25:52 -0700 | [diff] [blame] | 304 | void xprt_adjust_cwnd(struct rpc_task *task, int result); |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 305 | struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid); |
Chuck Lever | 1570c1e | 2005-08-25 16:25:52 -0700 | [diff] [blame] | 306 | void xprt_complete_rqst(struct rpc_task *task, int copied); |
Chuck Lever | a58dd39 | 2005-08-25 16:25:53 -0700 | [diff] [blame] | 307 | void xprt_release_rqst_cong(struct rpc_task *task); |
Trond Myklebust | 62da3b2 | 2007-11-06 18:44:20 -0500 | [diff] [blame] | 308 | void xprt_disconnect_done(struct rpc_xprt *xprt); |
Trond Myklebust | 66af1e5 | 2007-11-06 10:18:36 -0500 | [diff] [blame] | 309 | void xprt_force_disconnect(struct rpc_xprt *xprt); |
Trond Myklebust | 7c1d71c | 2008-04-17 16:52:57 -0400 | [diff] [blame] | 310 | void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 311 | |
| 312 | /* |
Chuck Lever | 2226feb | 2005-08-11 16:25:38 -0400 | [diff] [blame] | 313 | * Reserved bit positions in xprt->state |
| 314 | */ |
| 315 | #define XPRT_LOCKED (0) |
| 316 | #define XPRT_CONNECTED (1) |
| 317 | #define XPRT_CONNECTING (2) |
Trond Myklebust | 632e3bd | 2006-01-03 09:55:55 +0100 | [diff] [blame] | 318 | #define XPRT_CLOSE_WAIT (3) |
Chuck Lever | ec739ef | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 319 | #define XPRT_BOUND (4) |
Chuck Lever | 4a68179 | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 320 | #define XPRT_BINDING (5) |
Trond Myklebust | 3b948ae | 2007-11-05 17:42:39 -0500 | [diff] [blame] | 321 | #define XPRT_CLOSING (6) |
Trond Myklebust | 7d1e825 | 2009-03-11 14:38:03 -0400 | [diff] [blame] | 322 | #define XPRT_CONNECTION_ABORT (7) |
Trond Myklebust | f75e674 | 2009-04-21 17:18:20 -0400 | [diff] [blame] | 323 | #define XPRT_CONNECTION_CLOSE (8) |
J. Bruce Fields | f0418aa | 2010-12-08 13:48:19 -0500 | [diff] [blame] | 324 | #define XPRT_INITIALIZED (9) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 325 | |
Chuck Lever | 2226feb | 2005-08-11 16:25:38 -0400 | [diff] [blame] | 326 | static inline void xprt_set_connected(struct rpc_xprt *xprt) |
| 327 | { |
| 328 | set_bit(XPRT_CONNECTED, &xprt->state); |
| 329 | } |
| 330 | |
| 331 | static inline void xprt_clear_connected(struct rpc_xprt *xprt) |
| 332 | { |
| 333 | clear_bit(XPRT_CONNECTED, &xprt->state); |
| 334 | } |
| 335 | |
| 336 | static inline int xprt_connected(struct rpc_xprt *xprt) |
| 337 | { |
| 338 | return test_bit(XPRT_CONNECTED, &xprt->state); |
| 339 | } |
| 340 | |
| 341 | static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt) |
| 342 | { |
| 343 | return test_and_set_bit(XPRT_CONNECTED, &xprt->state); |
| 344 | } |
| 345 | |
| 346 | static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt) |
| 347 | { |
| 348 | return test_and_clear_bit(XPRT_CONNECTED, &xprt->state); |
| 349 | } |
| 350 | |
| 351 | static inline void xprt_clear_connecting(struct rpc_xprt *xprt) |
| 352 | { |
| 353 | smp_mb__before_clear_bit(); |
| 354 | clear_bit(XPRT_CONNECTING, &xprt->state); |
| 355 | smp_mb__after_clear_bit(); |
| 356 | } |
| 357 | |
| 358 | static inline int xprt_connecting(struct rpc_xprt *xprt) |
| 359 | { |
| 360 | return test_bit(XPRT_CONNECTING, &xprt->state); |
| 361 | } |
| 362 | |
| 363 | static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt) |
| 364 | { |
| 365 | return test_and_set_bit(XPRT_CONNECTING, &xprt->state); |
| 366 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 367 | |
Chuck Lever | ec739ef | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 368 | static inline void xprt_set_bound(struct rpc_xprt *xprt) |
| 369 | { |
| 370 | test_and_set_bit(XPRT_BOUND, &xprt->state); |
| 371 | } |
| 372 | |
| 373 | static inline int xprt_bound(struct rpc_xprt *xprt) |
| 374 | { |
| 375 | return test_bit(XPRT_BOUND, &xprt->state); |
| 376 | } |
| 377 | |
| 378 | static inline void xprt_clear_bound(struct rpc_xprt *xprt) |
| 379 | { |
| 380 | clear_bit(XPRT_BOUND, &xprt->state); |
| 381 | } |
| 382 | |
Chuck Lever | 4a68179 | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 383 | static inline void xprt_clear_binding(struct rpc_xprt *xprt) |
| 384 | { |
| 385 | smp_mb__before_clear_bit(); |
| 386 | clear_bit(XPRT_BINDING, &xprt->state); |
| 387 | smp_mb__after_clear_bit(); |
| 388 | } |
| 389 | |
| 390 | static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt) |
| 391 | { |
| 392 | return test_and_set_bit(XPRT_BINDING, &xprt->state); |
| 393 | } |
| 394 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 395 | #endif /* __KERNEL__*/ |
| 396 | |
| 397 | #endif /* _LINUX_SUNRPC_XPRT_H */ |