include/linux/sunrpc/svc.h

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