Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * linux/include/linux/sunrpc/svc.h |
| 3 | * |
| 4 | * RPC server declarations. |
| 5 | * |
| 6 | * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de> |
| 7 | */ |
| 8 | |
| 9 | |
| 10 | #ifndef SUNRPC_SVC_H |
| 11 | #define SUNRPC_SVC_H |
| 12 | |
| 13 | #include <linux/in.h> |
Chuck Lever | 73df0db | 2007-02-12 00:53:35 -0800 | [diff] [blame] | 14 | #include <linux/in6.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 15 | #include <linux/sunrpc/types.h> |
| 16 | #include <linux/sunrpc/xdr.h> |
Greg Banks | 7adae48 | 2006-10-04 02:15:47 -0700 | [diff] [blame] | 17 | #include <linux/sunrpc/auth.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <linux/sunrpc/svcauth.h> |
| 19 | #include <linux/wait.h> |
| 20 | #include <linux/mm.h> |
| 21 | |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 22 | /* |
| 23 | * This is the RPC server thread function prototype |
| 24 | */ |
Jeff Layton | 9867d76 | 2008-06-10 08:40:38 -0400 | [diff] [blame] | 25 | typedef int (*svc_thread_fn)(void *); |
Greg Banks | 3262c81 | 2006-10-02 02:17:58 -0700 | [diff] [blame] | 26 | |
Greg Banks | 03cf6c9 | 2009-01-13 21:26:36 +1100 | [diff] [blame] | 27 | /* statistics for svc_pool structures */ |
| 28 | struct svc_pool_stats { |
| 29 | unsigned long packets; |
| 30 | unsigned long sockets_queued; |
| 31 | unsigned long threads_woken; |
Greg Banks | 03cf6c9 | 2009-01-13 21:26:36 +1100 | [diff] [blame] | 32 | unsigned long threads_timedout; |
| 33 | }; |
| 34 | |
Greg Banks | 3262c81 | 2006-10-02 02:17:58 -0700 | [diff] [blame] | 35 | /* |
| 36 | * |
| 37 | * RPC service thread pool. |
| 38 | * |
| 39 | * Pool of threads and temporary sockets. Generally there is only |
| 40 | * a single one of these per RPC service, but on NUMA machines those |
| 41 | * services that can benefit from it (i.e. nfs but not lockd) will |
| 42 | * have one pool per NUMA node. This optimisation reduces cross- |
| 43 | * node traffic on multi-node NUMA NFS servers. |
| 44 | */ |
| 45 | struct svc_pool { |
| 46 | unsigned int sp_id; /* pool id; also node id on NUMA */ |
| 47 | spinlock_t sp_lock; /* protects all fields */ |
| 48 | struct list_head sp_threads; /* idle server threads */ |
| 49 | struct list_head sp_sockets; /* pending sockets */ |
| 50 | unsigned int sp_nrthreads; /* # of threads in pool */ |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 51 | struct list_head sp_all_threads; /* all server threads */ |
Greg Banks | 03cf6c9 | 2009-01-13 21:26:36 +1100 | [diff] [blame] | 52 | struct svc_pool_stats sp_stats; /* statistics on pool operation */ |
Greg Banks | 3262c81 | 2006-10-02 02:17:58 -0700 | [diff] [blame] | 53 | } ____cacheline_aligned_in_smp; |
| 54 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | /* |
| 56 | * RPC service. |
| 57 | * |
| 58 | * An RPC service is a ``daemon,'' possibly multithreaded, which |
| 59 | * receives and processes incoming RPC messages. |
| 60 | * It has one or more transport sockets associated with it, and maintains |
| 61 | * a list of idle threads waiting for input. |
| 62 | * |
| 63 | * We currently do not support more than one RPC program per daemon. |
| 64 | */ |
| 65 | struct svc_serv { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | struct svc_program * sv_program; /* RPC program */ |
| 67 | struct svc_stat * sv_stats; /* RPC statistics */ |
| 68 | spinlock_t sv_lock; |
| 69 | unsigned int sv_nrthreads; /* # of server threads */ |
Jeff Layton | c9233eb | 2008-10-20 11:51:57 -0400 | [diff] [blame] | 70 | unsigned int sv_maxconn; /* max connections allowed or |
| 71 | * '0' causing max to be based |
| 72 | * on number of threads. */ |
| 73 | |
NeilBrown | c6b0a9f | 2006-10-06 00:44:05 -0700 | [diff] [blame] | 74 | unsigned int sv_max_payload; /* datagram payload size */ |
| 75 | unsigned int sv_max_mesg; /* max_payload + 1 page for overheads */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 76 | unsigned int sv_xdrsize; /* XDR buffer size */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | struct list_head sv_permsocks; /* all permanent sockets */ |
| 78 | struct list_head sv_tempsocks; /* all temporary sockets */ |
| 79 | int sv_tmpcnt; /* count of temporary sockets */ |
Greg Banks | 36bdfc8 | 2006-10-02 02:17:54 -0700 | [diff] [blame] | 80 | struct timer_list sv_temptimer; /* timer for aging temporary sockets */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | |
| 82 | char * sv_name; /* service name */ |
NeilBrown | bc591cc | 2006-10-02 02:17:44 -0700 | [diff] [blame] | 83 | |
Greg Banks | 3262c81 | 2006-10-02 02:17:58 -0700 | [diff] [blame] | 84 | unsigned int sv_nrpools; /* number of thread pools */ |
| 85 | struct svc_pool * sv_pools; /* array of thread pools */ |
| 86 | |
Stanislav Kinsbursky | 5ecebb7 | 2012-01-13 14:03:04 +0400 | [diff] [blame] | 87 | void (*sv_shutdown)(struct svc_serv *serv, |
| 88 | struct net *net); |
NeilBrown | bc591cc | 2006-10-02 02:17:44 -0700 | [diff] [blame] | 89 | /* Callback to use when last thread |
| 90 | * exits. |
| 91 | */ |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 92 | |
| 93 | struct module * sv_module; /* optional module to count when |
| 94 | * adding threads */ |
| 95 | svc_thread_fn sv_function; /* main function for threads */ |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame] | 96 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
Ricardo Labiaga | 56632b5 | 2009-04-01 09:22:58 -0400 | [diff] [blame] | 97 | struct list_head sv_cb_list; /* queue for callback requests |
| 98 | * that arrive over the same |
| 99 | * connection */ |
| 100 | spinlock_t sv_cb_lock; /* protects the svc_cb_list */ |
| 101 | wait_queue_head_t sv_cb_waitq; /* sleep here if there are no |
| 102 | * entries in the svc_cb_list */ |
Andy Adamson | 4a19de0 | 2011-01-06 02:04:35 +0000 | [diff] [blame] | 103 | struct svc_xprt *sv_bc_xprt; /* callback on fore channel */ |
Trond Myklebust | 9e00abc | 2011-07-13 19:20:49 -0400 | [diff] [blame] | 104 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | }; |
| 106 | |
| 107 | /* |
Greg Banks | 9a24ab5 | 2006-10-02 02:17:58 -0700 | [diff] [blame] | 108 | * We use sv_nrthreads as a reference count. svc_destroy() drops |
| 109 | * this refcount, so we need to bump it up around operations that |
| 110 | * change the number of threads. Horrible, but there it is. |
| 111 | * Should be called with the BKL held. |
| 112 | */ |
| 113 | static inline void svc_get(struct svc_serv *serv) |
| 114 | { |
| 115 | serv->sv_nrthreads++; |
| 116 | } |
| 117 | |
| 118 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 119 | * Maximum payload size supported by a kernel RPC server. |
| 120 | * This is use to determine the max number of pages nfsd is |
| 121 | * willing to return in a single READ operation. |
Greg Banks | 7adae48 | 2006-10-04 02:15:47 -0700 | [diff] [blame] | 122 | * |
| 123 | * These happen to all be powers of 2, which is not strictly |
| 124 | * necessary but helps enforce the real limitation, which is |
| 125 | * that they should be multiples of PAGE_CACHE_SIZE. |
| 126 | * |
| 127 | * For UDP transports, a block plus NFS,RPC, and UDP headers |
| 128 | * has to fit into the IP datagram limit of 64K. The largest |
| 129 | * feasible number for all known page sizes is probably 48K, |
| 130 | * but we choose 32K here. This is the same as the historical |
| 131 | * Linux limit; someone who cares more about NFS/UDP performance |
| 132 | * can test a larger number. |
| 133 | * |
| 134 | * For TCP transports we have more freedom. A size of 1MB is |
| 135 | * chosen to match the client limit. Other OSes are known to |
| 136 | * have larger limits, but those numbers are probably beyond |
| 137 | * the point of diminishing returns. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | */ |
Greg Banks | 7adae48 | 2006-10-04 02:15:47 -0700 | [diff] [blame] | 139 | #define RPCSVC_MAXPAYLOAD (1*1024*1024u) |
| 140 | #define RPCSVC_MAXPAYLOAD_TCP RPCSVC_MAXPAYLOAD |
| 141 | #define RPCSVC_MAXPAYLOAD_UDP (32*1024u) |
| 142 | |
| 143 | extern u32 svc_max_payload(const struct svc_rqst *rqstp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
| 145 | /* |
| 146 | * RPC Requsts and replies are stored in one or more pages. |
| 147 | * We maintain an array of pages for each server thread. |
| 148 | * Requests are copied into these pages as they arrive. Remaining |
| 149 | * pages are available to write the reply into. |
| 150 | * |
| 151 | * Pages are sent using ->sendpage so each server thread needs to |
| 152 | * allocate more to replace those used in sending. To help keep track |
| 153 | * of these pages we have a receive list where all pages initialy live, |
| 154 | * and a send list where pages are moved to when there are to be part |
| 155 | * of a reply. |
| 156 | * |
| 157 | * We use xdr_buf for holding responses as it fits well with NFS |
| 158 | * read responses (that have a header, and some data pages, and possibly |
| 159 | * a tail) and means we can share some client side routines. |
| 160 | * |
| 161 | * The xdr_buf.head kvec always points to the first page in the rq_*pages |
| 162 | * list. The xdr_buf.pages pointer points to the second page on that |
| 163 | * list. xdr_buf.tail points to the end of the first page. |
| 164 | * This assumes that the non-page part of an rpc reply will fit |
| 165 | * in a page - NFSd ensures this. lockd also has no trouble. |
| 166 | * |
| 167 | * Each request/reply pair can have at most one "payload", plus two pages, |
| 168 | * one for the request, and one for the reply. |
NeilBrown | 250f391 | 2007-01-26 00:56:59 -0800 | [diff] [blame] | 169 | * We using ->sendfile to return read data, we might need one extra page |
| 170 | * if the request is not page-aligned. So add another '1'. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | */ |
NeilBrown | 250f391 | 2007-01-26 00:56:59 -0800 | [diff] [blame] | 172 | #define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE \ |
| 173 | + 2 + 1) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 175 | static inline u32 svc_getnl(struct kvec *iov) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | { |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 177 | __be32 val, *vp; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 | vp = iov->iov_base; |
| 179 | val = *vp++; |
| 180 | iov->iov_base = (void*)vp; |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 181 | iov->iov_len -= sizeof(__be32); |
| 182 | return ntohl(val); |
| 183 | } |
| 184 | |
| 185 | static inline void svc_putnl(struct kvec *iov, u32 val) |
| 186 | { |
| 187 | __be32 *vp = iov->iov_base + iov->iov_len; |
| 188 | *vp = htonl(val); |
| 189 | iov->iov_len += sizeof(__be32); |
| 190 | } |
| 191 | |
| 192 | static inline __be32 svc_getu32(struct kvec *iov) |
| 193 | { |
| 194 | __be32 val, *vp; |
| 195 | vp = iov->iov_base; |
| 196 | val = *vp++; |
| 197 | iov->iov_base = (void*)vp; |
| 198 | iov->iov_len -= sizeof(__be32); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | return val; |
| 200 | } |
| 201 | |
| 202 | static inline void svc_ungetu32(struct kvec *iov) |
| 203 | { |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 204 | __be32 *vp = (__be32 *)iov->iov_base; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 205 | iov->iov_base = (void *)(vp - 1); |
| 206 | iov->iov_len += sizeof(*vp); |
| 207 | } |
| 208 | |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 209 | static inline void svc_putu32(struct kvec *iov, __be32 val) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 210 | { |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 211 | __be32 *vp = iov->iov_base + iov->iov_len; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | *vp = val; |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 213 | iov->iov_len += sizeof(__be32); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 214 | } |
| 215 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 216 | /* |
| 217 | * The context of a single thread, including the request currently being |
| 218 | * processed. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 219 | */ |
| 220 | struct svc_rqst { |
| 221 | struct list_head rq_list; /* idle list */ |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 222 | struct list_head rq_all; /* all threads list */ |
Tom Tucker | 57b1d3b | 2007-12-30 21:08:22 -0600 | [diff] [blame] | 223 | struct svc_xprt * rq_xprt; /* transport ptr */ |
Mi Jinlong | 849a1cf | 2011-08-30 17:18:41 +0800 | [diff] [blame] | 224 | |
Chuck Lever | 27459f0 | 2007-02-12 00:53:34 -0800 | [diff] [blame] | 225 | struct sockaddr_storage rq_addr; /* peer address */ |
| 226 | size_t rq_addrlen; |
Mi Jinlong | 849a1cf | 2011-08-30 17:18:41 +0800 | [diff] [blame] | 227 | struct sockaddr_storage rq_daddr; /* dest addr of request |
| 228 | * - reply from here */ |
| 229 | size_t rq_daddrlen; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | |
| 231 | struct svc_serv * rq_server; /* RPC service definition */ |
Greg Banks | 3262c81 | 2006-10-02 02:17:58 -0700 | [diff] [blame] | 232 | struct svc_pool * rq_pool; /* thread pool */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 233 | struct svc_procedure * rq_procinfo; /* procedure info */ |
| 234 | struct auth_ops * rq_authop; /* authentication flavour */ |
Andy Adamson | c417058 | 2007-07-17 04:04:42 -0700 | [diff] [blame] | 235 | u32 rq_flavor; /* pseudoflavor */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | struct svc_cred rq_cred; /* auth info */ |
Tom Tucker | 5148bf4 | 2007-12-30 21:07:25 -0600 | [diff] [blame] | 237 | void * rq_xprt_ctxt; /* transport specific context ptr */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 238 | struct svc_deferred_req*rq_deferred; /* deferred request we are replaying */ |
Andy Adamson | 2f42587 | 2009-04-03 08:27:32 +0300 | [diff] [blame] | 239 | int rq_usedeferral; /* use deferral */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | |
Tom Tucker | 260c1d1 | 2007-12-30 21:08:29 -0600 | [diff] [blame] | 241 | size_t rq_xprt_hlen; /* xprt header len */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | struct xdr_buf rq_arg; |
| 243 | struct xdr_buf rq_res; |
NeilBrown | 4452435 | 2006-10-04 02:15:46 -0700 | [diff] [blame] | 244 | struct page * rq_pages[RPCSVC_MAXPAGES]; |
| 245 | struct page * *rq_respages; /* points into rq_pages */ |
| 246 | int rq_resused; /* number of pages used for result */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 247 | |
NeilBrown | 3cc03b1 | 2006-10-04 02:15:47 -0700 | [diff] [blame] | 248 | struct kvec rq_vec[RPCSVC_MAXPAGES]; /* generally useful.. */ |
| 249 | |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 250 | __be32 rq_xid; /* transmission id */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 251 | u32 rq_prog; /* program number */ |
| 252 | u32 rq_vers; /* program version */ |
| 253 | u32 rq_proc; /* procedure number */ |
| 254 | u32 rq_prot; /* IP protocol */ |
| 255 | unsigned short |
| 256 | rq_secure : 1; /* secure port */ |
| 257 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 258 | void * rq_argp; /* decoded arguments */ |
| 259 | void * rq_resp; /* xdr'd results */ |
| 260 | void * rq_auth_data; /* flavor-specific data */ |
| 261 | |
| 262 | int rq_reserved; /* space on socket outq |
| 263 | * reserved for this request |
| 264 | */ |
| 265 | |
| 266 | struct cache_req rq_chandle; /* handle passed to caches for |
| 267 | * request delaying |
| 268 | */ |
J. Bruce Fields | 9e701c6 | 2011-01-02 21:56:36 -0500 | [diff] [blame] | 269 | bool rq_dropme; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 270 | /* Catering to nfsd */ |
| 271 | struct auth_domain * rq_client; /* RPC peer info */ |
J. Bruce Fields | 3ab4d8b | 2007-07-17 04:04:46 -0700 | [diff] [blame] | 272 | struct auth_domain * rq_gssclient; /* "gss/"-style peer info */ |
J. Bruce Fields | 1091006 | 2011-01-24 12:11:02 -0500 | [diff] [blame] | 273 | int rq_cachetype; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | struct svc_cacherep * rq_cacherep; /* cache info */ |
Jens Axboe | cf8208d | 2007-06-12 21:22:14 +0200 | [diff] [blame] | 275 | int rq_splice_ok; /* turned off in gss privacy |
J. Bruce Fields | 5c04c46 | 2006-06-30 01:56:19 -0700 | [diff] [blame] | 276 | * to prevent encrypting page |
| 277 | * cache pages */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 278 | wait_queue_head_t rq_wait; /* synchronization */ |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 279 | struct task_struct *rq_task; /* service thread */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 280 | }; |
| 281 | |
| 282 | /* |
Chuck Lever | 27459f0 | 2007-02-12 00:53:34 -0800 | [diff] [blame] | 283 | * Rigorous type checking on sockaddr type conversions |
| 284 | */ |
Chuck Lever | 5344b12 | 2008-08-27 16:57:46 -0400 | [diff] [blame] | 285 | static inline struct sockaddr_in *svc_addr_in(const struct svc_rqst *rqst) |
Chuck Lever | 27459f0 | 2007-02-12 00:53:34 -0800 | [diff] [blame] | 286 | { |
| 287 | return (struct sockaddr_in *) &rqst->rq_addr; |
| 288 | } |
| 289 | |
Chuck Lever | 5344b12 | 2008-08-27 16:57:46 -0400 | [diff] [blame] | 290 | static inline struct sockaddr_in6 *svc_addr_in6(const struct svc_rqst *rqst) |
Chuck Lever | 9575648 | 2007-02-12 00:53:38 -0800 | [diff] [blame] | 291 | { |
| 292 | return (struct sockaddr_in6 *) &rqst->rq_addr; |
| 293 | } |
| 294 | |
Chuck Lever | 5344b12 | 2008-08-27 16:57:46 -0400 | [diff] [blame] | 295 | static inline struct sockaddr *svc_addr(const struct svc_rqst *rqst) |
Chuck Lever | 27459f0 | 2007-02-12 00:53:34 -0800 | [diff] [blame] | 296 | { |
| 297 | return (struct sockaddr *) &rqst->rq_addr; |
| 298 | } |
| 299 | |
Mi Jinlong | 849a1cf | 2011-08-30 17:18:41 +0800 | [diff] [blame] | 300 | static inline struct sockaddr_in *svc_daddr_in(const struct svc_rqst *rqst) |
| 301 | { |
| 302 | return (struct sockaddr_in *) &rqst->rq_daddr; |
| 303 | } |
| 304 | |
| 305 | static inline struct sockaddr_in6 *svc_daddr_in6(const struct svc_rqst *rqst) |
| 306 | { |
| 307 | return (struct sockaddr_in6 *) &rqst->rq_daddr; |
| 308 | } |
| 309 | |
| 310 | static inline struct sockaddr *svc_daddr(const struct svc_rqst *rqst) |
| 311 | { |
| 312 | return (struct sockaddr *) &rqst->rq_daddr; |
| 313 | } |
| 314 | |
Chuck Lever | 27459f0 | 2007-02-12 00:53:34 -0800 | [diff] [blame] | 315 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 316 | * Check buffer bounds after decoding arguments |
| 317 | */ |
| 318 | static inline int |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 319 | xdr_argsize_check(struct svc_rqst *rqstp, __be32 *p) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 320 | { |
| 321 | char *cp = (char *)p; |
| 322 | struct kvec *vec = &rqstp->rq_arg.head[0]; |
NeilBrown | 0ba7536 | 2005-11-07 01:00:26 -0800 | [diff] [blame] | 323 | return cp >= (char*)vec->iov_base |
| 324 | && cp <= (char*)vec->iov_base + vec->iov_len; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 325 | } |
| 326 | |
| 327 | static inline int |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 328 | xdr_ressize_check(struct svc_rqst *rqstp, __be32 *p) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 329 | { |
| 330 | struct kvec *vec = &rqstp->rq_res.head[0]; |
| 331 | char *cp = (char*)p; |
| 332 | |
| 333 | vec->iov_len = cp - (char*)vec->iov_base; |
| 334 | |
| 335 | return vec->iov_len <= PAGE_SIZE; |
| 336 | } |
| 337 | |
NeilBrown | 4452435 | 2006-10-04 02:15:46 -0700 | [diff] [blame] | 338 | static inline void svc_free_res_pages(struct svc_rqst *rqstp) |
Andreas Gruenbacher | a257cdd | 2005-06-22 17:16:26 +0000 | [diff] [blame] | 339 | { |
NeilBrown | 4452435 | 2006-10-04 02:15:46 -0700 | [diff] [blame] | 340 | while (rqstp->rq_resused) { |
| 341 | struct page **pp = (rqstp->rq_respages + |
| 342 | --rqstp->rq_resused); |
| 343 | if (*pp) { |
| 344 | put_page(*pp); |
| 345 | *pp = NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 346 | } |
| 347 | } |
| 348 | } |
| 349 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 350 | struct svc_deferred_req { |
| 351 | u32 prot; /* protocol (UDP or TCP) */ |
Tom Tucker | 8c7b017 | 2007-12-30 21:08:10 -0600 | [diff] [blame] | 352 | struct svc_xprt *xprt; |
Chuck Lever | 2442222 | 2007-02-12 00:53:33 -0800 | [diff] [blame] | 353 | struct sockaddr_storage addr; /* where reply must go */ |
| 354 | size_t addrlen; |
Mi Jinlong | 849a1cf | 2011-08-30 17:18:41 +0800 | [diff] [blame] | 355 | struct sockaddr_storage daddr; /* where reply must come from */ |
| 356 | size_t daddrlen; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 357 | struct cache_deferred_req handle; |
Tom Tucker | 260c1d1 | 2007-12-30 21:08:29 -0600 | [diff] [blame] | 358 | size_t xprt_hlen; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 359 | int argslen; |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 360 | __be32 args[0]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 361 | }; |
| 362 | |
| 363 | /* |
Andreas Gruenbacher | 9ba0263 | 2005-06-22 17:16:24 +0000 | [diff] [blame] | 364 | * List of RPC programs on the same transport endpoint |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 365 | */ |
| 366 | struct svc_program { |
Andreas Gruenbacher | 9ba0263 | 2005-06-22 17:16:24 +0000 | [diff] [blame] | 367 | struct svc_program * pg_next; /* other programs (same xprt) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 368 | u32 pg_prog; /* program number */ |
| 369 | unsigned int pg_lovers; /* lowest version */ |
| 370 | unsigned int pg_hivers; /* lowest version */ |
| 371 | unsigned int pg_nvers; /* number of versions */ |
| 372 | struct svc_version ** pg_vers; /* version array */ |
| 373 | char * pg_name; /* service name */ |
| 374 | char * pg_class; /* class name: services sharing authentication */ |
| 375 | struct svc_stat * pg_stats; /* rpc statistics */ |
| 376 | int (*pg_authenticate)(struct svc_rqst *); |
| 377 | }; |
| 378 | |
| 379 | /* |
| 380 | * RPC program version |
| 381 | */ |
| 382 | struct svc_version { |
| 383 | u32 vs_vers; /* version number */ |
| 384 | u32 vs_nproc; /* number of procedures */ |
| 385 | struct svc_procedure * vs_proc; /* per-procedure info */ |
| 386 | u32 vs_xdrsize; /* xdrsize needed for this version */ |
| 387 | |
Olaf Kirch | bc5fea4 | 2006-10-04 02:16:05 -0700 | [diff] [blame] | 388 | unsigned int vs_hidden : 1; /* Don't register with portmapper. |
| 389 | * Only used for nfsacl so far. */ |
| 390 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 391 | /* Override dispatch function (e.g. when caching replies). |
| 392 | * A return value of 0 means drop the request. |
| 393 | * vs_dispatch == NULL means use default dispatcher. |
| 394 | */ |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 395 | int (*vs_dispatch)(struct svc_rqst *, __be32 *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 396 | }; |
| 397 | |
| 398 | /* |
| 399 | * RPC procedure info |
| 400 | */ |
Al Viro | 7111c66 | 2006-10-19 23:28:45 -0700 | [diff] [blame] | 401 | typedef __be32 (*svc_procfunc)(struct svc_rqst *, void *argp, void *resp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 402 | struct svc_procedure { |
| 403 | svc_procfunc pc_func; /* process the request */ |
| 404 | kxdrproc_t pc_decode; /* XDR decode args */ |
| 405 | kxdrproc_t pc_encode; /* XDR encode result */ |
| 406 | kxdrproc_t pc_release; /* XDR free result */ |
| 407 | unsigned int pc_argsize; /* argument struct size */ |
| 408 | unsigned int pc_ressize; /* result struct size */ |
| 409 | unsigned int pc_count; /* call count */ |
| 410 | unsigned int pc_cachetype; /* cache info (NFS) */ |
| 411 | unsigned int pc_xdrressize; /* maximum size of XDR reply */ |
| 412 | }; |
| 413 | |
| 414 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 415 | * Function prototypes. |
| 416 | */ |
Stanislav Kinsbursky | bb2224d | 2012-01-31 15:08:05 +0400 | [diff] [blame] | 417 | int svc_rpcb_setup(struct svc_serv *serv, struct net *net); |
Stanislav Kinsbursky | 5ecebb7 | 2012-01-13 14:03:04 +0400 | [diff] [blame] | 418 | void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net); |
Stanislav Kinsbursky | 0234d8f6 | 2012-06-25 16:40:08 -0400 | [diff] [blame^] | 419 | int svc_bind(struct svc_serv *serv, struct net *net); |
Chuck Lever | 49a9072 | 2009-03-18 20:46:29 -0400 | [diff] [blame] | 420 | struct svc_serv *svc_create(struct svc_program *, unsigned int, |
Stanislav Kinsbursky | 5ecebb7 | 2012-01-13 14:03:04 +0400 | [diff] [blame] | 421 | void (*shutdown)(struct svc_serv *, struct net *net)); |
Jeff Layton | 0113ab3 | 2008-01-29 10:30:54 -0500 | [diff] [blame] | 422 | struct svc_rqst *svc_prepare_thread(struct svc_serv *serv, |
Eric Dumazet | 11fd165 | 2011-07-28 20:04:09 +0200 | [diff] [blame] | 423 | struct svc_pool *pool, int node); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 424 | void svc_exit_thread(struct svc_rqst *); |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 425 | struct svc_serv * svc_create_pooled(struct svc_program *, unsigned int, |
Stanislav Kinsbursky | 5ecebb7 | 2012-01-13 14:03:04 +0400 | [diff] [blame] | 426 | void (*shutdown)(struct svc_serv *, struct net *net), |
Chuck Lever | e851db5 | 2008-06-30 18:45:30 -0400 | [diff] [blame] | 427 | svc_thread_fn, struct module *); |
Greg Banks | a745544 | 2006-10-02 02:17:59 -0700 | [diff] [blame] | 428 | int svc_set_num_threads(struct svc_serv *, struct svc_pool *, int); |
Greg Banks | 03cf6c9 | 2009-01-13 21:26:36 +1100 | [diff] [blame] | 429 | int svc_pool_stats_open(struct svc_serv *serv, struct file *file); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 430 | void svc_destroy(struct svc_serv *); |
Stanislav Kinsbursky | bb2224d | 2012-01-31 15:08:05 +0400 | [diff] [blame] | 431 | void svc_shutdown_net(struct svc_serv *, struct net *); |
NeilBrown | 6fb2b47 | 2006-10-02 02:17:50 -0700 | [diff] [blame] | 432 | int svc_process(struct svc_rqst *); |
Ricardo Labiaga | 4d6bbb6 | 2009-04-01 09:23:07 -0400 | [diff] [blame] | 433 | int bc_svc_process(struct svc_serv *, struct rpc_rqst *, |
| 434 | struct svc_rqst *); |
Stanislav Kinsbursky | 5247fab | 2012-01-13 14:02:48 +0400 | [diff] [blame] | 435 | int svc_register(const struct svc_serv *, struct net *, const int, |
Chuck Lever | 4b62e58 | 2009-03-18 20:46:06 -0400 | [diff] [blame] | 436 | const unsigned short, const unsigned short); |
Chuck Lever | a26cfad | 2008-08-18 19:34:16 -0400 | [diff] [blame] | 437 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 438 | void svc_wake_up(struct svc_serv *); |
| 439 | void svc_reserve(struct svc_rqst *rqstp, int space); |
Greg Banks | bfd2416 | 2006-10-02 02:18:01 -0700 | [diff] [blame] | 440 | struct svc_pool * svc_pool_for_cpu(struct svc_serv *serv, int cpu); |
Chuck Lever | ad06e4b | 2007-02-12 00:53:32 -0800 | [diff] [blame] | 441 | char * svc_print_addr(struct svc_rqst *, char *, size_t); |
| 442 | |
| 443 | #define RPC_MAX_ADDRBUFLEN (63U) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 444 | |
Jeff Layton | cd12301 | 2007-05-09 02:34:50 -0700 | [diff] [blame] | 445 | /* |
| 446 | * When we want to reduce the size of the reserved space in the response |
| 447 | * buffer, we need to take into account the size of any checksum data that |
| 448 | * may be at the end of the packet. This is difficult to determine exactly |
| 449 | * for all cases without actually generating the checksum, so we just use a |
| 450 | * static value. |
| 451 | */ |
J. Bruce Fields | fbb7878 | 2008-02-07 23:10:21 -0500 | [diff] [blame] | 452 | static inline void svc_reserve_auth(struct svc_rqst *rqstp, int space) |
Jeff Layton | cd12301 | 2007-05-09 02:34:50 -0700 | [diff] [blame] | 453 | { |
J. Bruce Fields | fbb7878 | 2008-02-07 23:10:21 -0500 | [diff] [blame] | 454 | int added_space = 0; |
Jeff Layton | cd12301 | 2007-05-09 02:34:50 -0700 | [diff] [blame] | 455 | |
J. Bruce Fields | fbb7878 | 2008-02-07 23:10:21 -0500 | [diff] [blame] | 456 | if (rqstp->rq_authop->flavour) |
| 457 | added_space = RPC_MAX_AUTH_SIZE; |
| 458 | svc_reserve(rqstp, space + added_space); |
Jeff Layton | cd12301 | 2007-05-09 02:34:50 -0700 | [diff] [blame] | 459 | } |
| 460 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 461 | #endif /* SUNRPC_SVC_H */ |