2 * linux/net/sunrpc/svc.c
4 * High-level RPC service routines
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
8 * Multiple threads pools and NUMAisation
9 * Copyright (c) 2006 Silicon Graphics, Inc.
10 * by Greg Banks <gnb@melbourne.sgi.com>
13 #include <linux/linkage.h>
14 #include <linux/sched.h>
15 #include <linux/errno.h>
16 #include <linux/net.h>
19 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/kthread.h>
23 #include <linux/sunrpc/types.h>
24 #include <linux/sunrpc/xdr.h>
25 #include <linux/sunrpc/stats.h>
26 #include <linux/sunrpc/svcsock.h>
27 #include <linux/sunrpc/clnt.h>
28 #include <linux/sunrpc/bc_xprt.h>
30 #define RPCDBG_FACILITY RPCDBG_SVCDSP
32 static void svc_unregister(const struct svc_serv
*serv
);
34 #define svc_serv_is_pooled(serv) ((serv)->sv_function)
37 * Mode for mapping cpus to pools.
40 SVC_POOL_AUTO
= -1, /* choose one of the others */
41 SVC_POOL_GLOBAL
, /* no mapping, just a single global pool
42 * (legacy & UP mode) */
43 SVC_POOL_PERCPU
, /* one pool per cpu */
44 SVC_POOL_PERNODE
/* one pool per numa node */
46 #define SVC_POOL_DEFAULT SVC_POOL_GLOBAL
49 * Structure for mapping cpus to pools and vice versa.
50 * Setup once during sunrpc initialisation.
52 static struct svc_pool_map
{
53 int count
; /* How many svc_servs use us */
54 int mode
; /* Note: int not enum to avoid
55 * warnings about "enumeration value
56 * not handled in switch" */
58 unsigned int *pool_to
; /* maps pool id to cpu or node */
59 unsigned int *to_pool
; /* maps cpu or node to pool id */
62 .mode
= SVC_POOL_DEFAULT
64 static DEFINE_MUTEX(svc_pool_map_mutex
);/* protects svc_pool_map.count only */
67 param_set_pool_mode(const char *val
, struct kernel_param
*kp
)
69 int *ip
= (int *)kp
->arg
;
70 struct svc_pool_map
*m
= &svc_pool_map
;
73 mutex_lock(&svc_pool_map_mutex
);
80 if (!strncmp(val
, "auto", 4))
82 else if (!strncmp(val
, "global", 6))
83 *ip
= SVC_POOL_GLOBAL
;
84 else if (!strncmp(val
, "percpu", 6))
85 *ip
= SVC_POOL_PERCPU
;
86 else if (!strncmp(val
, "pernode", 7))
87 *ip
= SVC_POOL_PERNODE
;
92 mutex_unlock(&svc_pool_map_mutex
);
97 param_get_pool_mode(char *buf
, struct kernel_param
*kp
)
99 int *ip
= (int *)kp
->arg
;
104 return strlcpy(buf
, "auto", 20);
105 case SVC_POOL_GLOBAL
:
106 return strlcpy(buf
, "global", 20);
107 case SVC_POOL_PERCPU
:
108 return strlcpy(buf
, "percpu", 20);
109 case SVC_POOL_PERNODE
:
110 return strlcpy(buf
, "pernode", 20);
112 return sprintf(buf
, "%d", *ip
);
116 module_param_call(pool_mode
, param_set_pool_mode
, param_get_pool_mode
,
117 &svc_pool_map
.mode
, 0644);
120 * Detect best pool mapping mode heuristically,
121 * according to the machine's topology.
124 svc_pool_map_choose_mode(void)
128 if (nr_online_nodes
> 1) {
130 * Actually have multiple NUMA nodes,
131 * so split pools on NUMA node boundaries
133 return SVC_POOL_PERNODE
;
136 node
= any_online_node(node_online_map
);
137 if (nr_cpus_node(node
) > 2) {
139 * Non-trivial SMP, or CONFIG_NUMA on
140 * non-NUMA hardware, e.g. with a generic
141 * x86_64 kernel on Xeons. In this case we
142 * want to divide the pools on cpu boundaries.
144 return SVC_POOL_PERCPU
;
147 /* default: one global pool */
148 return SVC_POOL_GLOBAL
;
152 * Allocate the to_pool[] and pool_to[] arrays.
153 * Returns 0 on success or an errno.
156 svc_pool_map_alloc_arrays(struct svc_pool_map
*m
, unsigned int maxpools
)
158 m
->to_pool
= kcalloc(maxpools
, sizeof(unsigned int), GFP_KERNEL
);
161 m
->pool_to
= kcalloc(maxpools
, sizeof(unsigned int), GFP_KERNEL
);
175 * Initialise the pool map for SVC_POOL_PERCPU mode.
176 * Returns number of pools or <0 on error.
179 svc_pool_map_init_percpu(struct svc_pool_map
*m
)
181 unsigned int maxpools
= nr_cpu_ids
;
182 unsigned int pidx
= 0;
186 err
= svc_pool_map_alloc_arrays(m
, maxpools
);
190 for_each_online_cpu(cpu
) {
191 BUG_ON(pidx
> maxpools
);
192 m
->to_pool
[cpu
] = pidx
;
193 m
->pool_to
[pidx
] = cpu
;
196 /* cpus brought online later all get mapped to pool0, sorry */
203 * Initialise the pool map for SVC_POOL_PERNODE mode.
204 * Returns number of pools or <0 on error.
207 svc_pool_map_init_pernode(struct svc_pool_map
*m
)
209 unsigned int maxpools
= nr_node_ids
;
210 unsigned int pidx
= 0;
214 err
= svc_pool_map_alloc_arrays(m
, maxpools
);
218 for_each_node_with_cpus(node
) {
219 /* some architectures (e.g. SN2) have cpuless nodes */
220 BUG_ON(pidx
> maxpools
);
221 m
->to_pool
[node
] = pidx
;
222 m
->pool_to
[pidx
] = node
;
225 /* nodes brought online later all get mapped to pool0, sorry */
232 * Add a reference to the global map of cpus to pools (and
233 * vice versa). Initialise the map if we're the first user.
234 * Returns the number of pools.
237 svc_pool_map_get(void)
239 struct svc_pool_map
*m
= &svc_pool_map
;
242 mutex_lock(&svc_pool_map_mutex
);
245 mutex_unlock(&svc_pool_map_mutex
);
249 if (m
->mode
== SVC_POOL_AUTO
)
250 m
->mode
= svc_pool_map_choose_mode();
253 case SVC_POOL_PERCPU
:
254 npools
= svc_pool_map_init_percpu(m
);
256 case SVC_POOL_PERNODE
:
257 npools
= svc_pool_map_init_pernode(m
);
262 /* default, or memory allocation failure */
264 m
->mode
= SVC_POOL_GLOBAL
;
268 mutex_unlock(&svc_pool_map_mutex
);
274 * Drop a reference to the global map of cpus to pools.
275 * When the last reference is dropped, the map data is
276 * freed; this allows the sysadmin to change the pool
277 * mode using the pool_mode module option without
278 * rebooting or re-loading sunrpc.ko.
281 svc_pool_map_put(void)
283 struct svc_pool_map
*m
= &svc_pool_map
;
285 mutex_lock(&svc_pool_map_mutex
);
288 m
->mode
= SVC_POOL_DEFAULT
;
296 mutex_unlock(&svc_pool_map_mutex
);
301 * Set the given thread's cpus_allowed mask so that it
302 * will only run on cpus in the given pool.
305 svc_pool_map_set_cpumask(struct task_struct
*task
, unsigned int pidx
)
307 struct svc_pool_map
*m
= &svc_pool_map
;
308 unsigned int node
= m
->pool_to
[pidx
];
311 * The caller checks for sv_nrpools > 1, which
312 * implies that we've been initialized.
314 BUG_ON(m
->count
== 0);
317 case SVC_POOL_PERCPU
:
319 set_cpus_allowed_ptr(task
, cpumask_of(node
));
322 case SVC_POOL_PERNODE
:
324 set_cpus_allowed_ptr(task
, cpumask_of_node(node
));
331 * Use the mapping mode to choose a pool for a given CPU.
332 * Used when enqueueing an incoming RPC. Always returns
333 * a non-NULL pool pointer.
336 svc_pool_for_cpu(struct svc_serv
*serv
, int cpu
)
338 struct svc_pool_map
*m
= &svc_pool_map
;
339 unsigned int pidx
= 0;
342 * An uninitialised map happens in a pure client when
343 * lockd is brought up, so silently treat it the
344 * same as SVC_POOL_GLOBAL.
346 if (svc_serv_is_pooled(serv
)) {
348 case SVC_POOL_PERCPU
:
349 pidx
= m
->to_pool
[cpu
];
351 case SVC_POOL_PERNODE
:
352 pidx
= m
->to_pool
[cpu_to_node(cpu
)];
356 return &serv
->sv_pools
[pidx
% serv
->sv_nrpools
];
361 * Create an RPC service
363 static struct svc_serv
*
364 __svc_create(struct svc_program
*prog
, unsigned int bufsize
, int npools
,
365 void (*shutdown
)(struct svc_serv
*serv
))
367 struct svc_serv
*serv
;
369 unsigned int xdrsize
;
372 if (!(serv
= kzalloc(sizeof(*serv
), GFP_KERNEL
)))
374 serv
->sv_name
= prog
->pg_name
;
375 serv
->sv_program
= prog
;
376 serv
->sv_nrthreads
= 1;
377 serv
->sv_stats
= prog
->pg_stats
;
378 if (bufsize
> RPCSVC_MAXPAYLOAD
)
379 bufsize
= RPCSVC_MAXPAYLOAD
;
380 serv
->sv_max_payload
= bufsize
? bufsize
: 4096;
381 serv
->sv_max_mesg
= roundup(serv
->sv_max_payload
+ PAGE_SIZE
, PAGE_SIZE
);
382 serv
->sv_shutdown
= shutdown
;
385 prog
->pg_lovers
= prog
->pg_nvers
-1;
386 for (vers
=0; vers
<prog
->pg_nvers
; vers
++)
387 if (prog
->pg_vers
[vers
]) {
388 prog
->pg_hivers
= vers
;
389 if (prog
->pg_lovers
> vers
)
390 prog
->pg_lovers
= vers
;
391 if (prog
->pg_vers
[vers
]->vs_xdrsize
> xdrsize
)
392 xdrsize
= prog
->pg_vers
[vers
]->vs_xdrsize
;
394 prog
= prog
->pg_next
;
396 serv
->sv_xdrsize
= xdrsize
;
397 INIT_LIST_HEAD(&serv
->sv_tempsocks
);
398 INIT_LIST_HEAD(&serv
->sv_permsocks
);
399 init_timer(&serv
->sv_temptimer
);
400 spin_lock_init(&serv
->sv_lock
);
402 serv
->sv_nrpools
= npools
;
404 kcalloc(serv
->sv_nrpools
, sizeof(struct svc_pool
),
406 if (!serv
->sv_pools
) {
411 for (i
= 0; i
< serv
->sv_nrpools
; i
++) {
412 struct svc_pool
*pool
= &serv
->sv_pools
[i
];
414 dprintk("svc: initialising pool %u for %s\n",
418 INIT_LIST_HEAD(&pool
->sp_threads
);
419 INIT_LIST_HEAD(&pool
->sp_sockets
);
420 INIT_LIST_HEAD(&pool
->sp_all_threads
);
421 spin_lock_init(&pool
->sp_lock
);
424 /* Remove any stale portmap registrations */
425 svc_unregister(serv
);
431 svc_create(struct svc_program
*prog
, unsigned int bufsize
,
432 void (*shutdown
)(struct svc_serv
*serv
))
434 return __svc_create(prog
, bufsize
, /*npools*/1, shutdown
);
436 EXPORT_SYMBOL_GPL(svc_create
);
439 svc_create_pooled(struct svc_program
*prog
, unsigned int bufsize
,
440 void (*shutdown
)(struct svc_serv
*serv
),
441 svc_thread_fn func
, struct module
*mod
)
443 struct svc_serv
*serv
;
444 unsigned int npools
= svc_pool_map_get();
446 serv
= __svc_create(prog
, bufsize
, npools
, shutdown
);
449 serv
->sv_function
= func
;
450 serv
->sv_module
= mod
;
455 EXPORT_SYMBOL_GPL(svc_create_pooled
);
458 * Destroy an RPC service. Should be called with appropriate locking to
459 * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
462 svc_destroy(struct svc_serv
*serv
)
464 dprintk("svc: svc_destroy(%s, %d)\n",
465 serv
->sv_program
->pg_name
,
468 if (serv
->sv_nrthreads
) {
469 if (--(serv
->sv_nrthreads
) != 0) {
470 svc_sock_update_bufs(serv
);
474 printk("svc_destroy: no threads for serv=%p!\n", serv
);
476 del_timer_sync(&serv
->sv_temptimer
);
480 if (serv
->sv_shutdown
)
481 serv
->sv_shutdown(serv
);
483 cache_clean_deferred(serv
);
485 if (svc_serv_is_pooled(serv
))
488 #if defined(CONFIG_NFS_V4_1)
489 svc_sock_destroy(serv
->bc_xprt
);
490 #endif /* CONFIG_NFS_V4_1 */
492 svc_unregister(serv
);
493 kfree(serv
->sv_pools
);
496 EXPORT_SYMBOL_GPL(svc_destroy
);
499 * Allocate an RPC server's buffer space.
500 * We allocate pages and place them in rq_argpages.
503 svc_init_buffer(struct svc_rqst
*rqstp
, unsigned int size
)
505 unsigned int pages
, arghi
;
507 pages
= size
/ PAGE_SIZE
+ 1; /* extra page as we hold both request and reply.
508 * We assume one is at most one page
511 BUG_ON(pages
> RPCSVC_MAXPAGES
);
513 struct page
*p
= alloc_page(GFP_KERNEL
);
516 rqstp
->rq_pages
[arghi
++] = p
;
523 * Release an RPC server buffer
526 svc_release_buffer(struct svc_rqst
*rqstp
)
530 for (i
= 0; i
< ARRAY_SIZE(rqstp
->rq_pages
); i
++)
531 if (rqstp
->rq_pages
[i
])
532 put_page(rqstp
->rq_pages
[i
]);
536 svc_prepare_thread(struct svc_serv
*serv
, struct svc_pool
*pool
)
538 struct svc_rqst
*rqstp
;
540 rqstp
= kzalloc(sizeof(*rqstp
), GFP_KERNEL
);
544 init_waitqueue_head(&rqstp
->rq_wait
);
546 serv
->sv_nrthreads
++;
547 spin_lock_bh(&pool
->sp_lock
);
548 pool
->sp_nrthreads
++;
549 list_add(&rqstp
->rq_all
, &pool
->sp_all_threads
);
550 spin_unlock_bh(&pool
->sp_lock
);
551 rqstp
->rq_server
= serv
;
552 rqstp
->rq_pool
= pool
;
554 rqstp
->rq_argp
= kmalloc(serv
->sv_xdrsize
, GFP_KERNEL
);
558 rqstp
->rq_resp
= kmalloc(serv
->sv_xdrsize
, GFP_KERNEL
);
562 if (!svc_init_buffer(rqstp
, serv
->sv_max_mesg
))
567 svc_exit_thread(rqstp
);
569 return ERR_PTR(-ENOMEM
);
571 EXPORT_SYMBOL_GPL(svc_prepare_thread
);
574 * Choose a pool in which to create a new thread, for svc_set_num_threads
576 static inline struct svc_pool
*
577 choose_pool(struct svc_serv
*serv
, struct svc_pool
*pool
, unsigned int *state
)
582 return &serv
->sv_pools
[(*state
)++ % serv
->sv_nrpools
];
586 * Choose a thread to kill, for svc_set_num_threads
588 static inline struct task_struct
*
589 choose_victim(struct svc_serv
*serv
, struct svc_pool
*pool
, unsigned int *state
)
592 struct task_struct
*task
= NULL
;
595 spin_lock_bh(&pool
->sp_lock
);
597 /* choose a pool in round-robin fashion */
598 for (i
= 0; i
< serv
->sv_nrpools
; i
++) {
599 pool
= &serv
->sv_pools
[--(*state
) % serv
->sv_nrpools
];
600 spin_lock_bh(&pool
->sp_lock
);
601 if (!list_empty(&pool
->sp_all_threads
))
603 spin_unlock_bh(&pool
->sp_lock
);
609 if (!list_empty(&pool
->sp_all_threads
)) {
610 struct svc_rqst
*rqstp
;
613 * Remove from the pool->sp_all_threads list
614 * so we don't try to kill it again.
616 rqstp
= list_entry(pool
->sp_all_threads
.next
, struct svc_rqst
, rq_all
);
617 list_del_init(&rqstp
->rq_all
);
618 task
= rqstp
->rq_task
;
620 spin_unlock_bh(&pool
->sp_lock
);
626 * Create or destroy enough new threads to make the number
627 * of threads the given number. If `pool' is non-NULL, applies
628 * only to threads in that pool, otherwise round-robins between
629 * all pools. Must be called with a svc_get() reference and
630 * the BKL or another lock to protect access to svc_serv fields.
632 * Destroying threads relies on the service threads filling in
633 * rqstp->rq_task, which only the nfs ones do. Assumes the serv
634 * has been created using svc_create_pooled().
636 * Based on code that used to be in nfsd_svc() but tweaked
640 svc_set_num_threads(struct svc_serv
*serv
, struct svc_pool
*pool
, int nrservs
)
642 struct svc_rqst
*rqstp
;
643 struct task_struct
*task
;
644 struct svc_pool
*chosen_pool
;
646 unsigned int state
= serv
->sv_nrthreads
-1;
649 /* The -1 assumes caller has done a svc_get() */
650 nrservs
-= (serv
->sv_nrthreads
-1);
652 spin_lock_bh(&pool
->sp_lock
);
653 nrservs
-= pool
->sp_nrthreads
;
654 spin_unlock_bh(&pool
->sp_lock
);
657 /* create new threads */
658 while (nrservs
> 0) {
660 chosen_pool
= choose_pool(serv
, pool
, &state
);
662 rqstp
= svc_prepare_thread(serv
, chosen_pool
);
664 error
= PTR_ERR(rqstp
);
668 __module_get(serv
->sv_module
);
669 task
= kthread_create(serv
->sv_function
, rqstp
, serv
->sv_name
);
671 error
= PTR_ERR(task
);
672 module_put(serv
->sv_module
);
673 svc_exit_thread(rqstp
);
677 rqstp
->rq_task
= task
;
678 if (serv
->sv_nrpools
> 1)
679 svc_pool_map_set_cpumask(task
, chosen_pool
->sp_id
);
681 svc_sock_update_bufs(serv
);
682 wake_up_process(task
);
684 /* destroy old threads */
685 while (nrservs
< 0 &&
686 (task
= choose_victim(serv
, pool
, &state
)) != NULL
) {
687 send_sig(SIGINT
, task
, 1);
693 EXPORT_SYMBOL_GPL(svc_set_num_threads
);
696 * Called from a server thread as it's exiting. Caller must hold the BKL or
697 * the "service mutex", whichever is appropriate for the service.
700 svc_exit_thread(struct svc_rqst
*rqstp
)
702 struct svc_serv
*serv
= rqstp
->rq_server
;
703 struct svc_pool
*pool
= rqstp
->rq_pool
;
705 svc_release_buffer(rqstp
);
706 kfree(rqstp
->rq_resp
);
707 kfree(rqstp
->rq_argp
);
708 kfree(rqstp
->rq_auth_data
);
710 spin_lock_bh(&pool
->sp_lock
);
711 pool
->sp_nrthreads
--;
712 list_del(&rqstp
->rq_all
);
713 spin_unlock_bh(&pool
->sp_lock
);
717 /* Release the server */
721 EXPORT_SYMBOL_GPL(svc_exit_thread
);
724 * Register an "inet" protocol family netid with the local
725 * rpcbind daemon via an rpcbind v4 SET request.
727 * No netconfig infrastructure is available in the kernel, so
728 * we map IP_ protocol numbers to netids by hand.
730 * Returns zero on success; a negative errno value is returned
731 * if any error occurs.
733 static int __svc_rpcb_register4(const u32 program
, const u32 version
,
734 const unsigned short protocol
,
735 const unsigned short port
)
737 const struct sockaddr_in sin
= {
738 .sin_family
= AF_INET
,
739 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
740 .sin_port
= htons(port
),
747 netid
= RPCBIND_NETID_UDP
;
750 netid
= RPCBIND_NETID_TCP
;
756 error
= rpcb_v4_register(program
, version
,
757 (const struct sockaddr
*)&sin
, netid
);
760 * User space didn't support rpcbind v4, so retry this
761 * registration request with the legacy rpcbind v2 protocol.
763 if (error
== -EPROTONOSUPPORT
)
764 error
= rpcb_register(program
, version
, protocol
, port
);
769 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
771 * Register an "inet6" protocol family netid with the local
772 * rpcbind daemon via an rpcbind v4 SET request.
774 * No netconfig infrastructure is available in the kernel, so
775 * we map IP_ protocol numbers to netids by hand.
777 * Returns zero on success; a negative errno value is returned
778 * if any error occurs.
780 static int __svc_rpcb_register6(const u32 program
, const u32 version
,
781 const unsigned short protocol
,
782 const unsigned short port
)
784 const struct sockaddr_in6 sin6
= {
785 .sin6_family
= AF_INET6
,
786 .sin6_addr
= IN6ADDR_ANY_INIT
,
787 .sin6_port
= htons(port
),
794 netid
= RPCBIND_NETID_UDP6
;
797 netid
= RPCBIND_NETID_TCP6
;
803 error
= rpcb_v4_register(program
, version
,
804 (const struct sockaddr
*)&sin6
, netid
);
807 * User space didn't support rpcbind version 4, so we won't
808 * use a PF_INET6 listener.
810 if (error
== -EPROTONOSUPPORT
)
811 error
= -EAFNOSUPPORT
;
815 #endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
818 * Register a kernel RPC service via rpcbind version 4.
820 * Returns zero on success; a negative errno value is returned
821 * if any error occurs.
823 static int __svc_register(const char *progname
,
824 const u32 program
, const u32 version
,
826 const unsigned short protocol
,
827 const unsigned short port
)
829 int error
= -EAFNOSUPPORT
;
833 error
= __svc_rpcb_register4(program
, version
,
836 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
838 error
= __svc_rpcb_register6(program
, version
,
840 #endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
844 printk(KERN_WARNING
"svc: failed to register %sv%u RPC "
845 "service (errno %d).\n", progname
, version
, -error
);
850 * svc_register - register an RPC service with the local portmapper
851 * @serv: svc_serv struct for the service to register
852 * @family: protocol family of service's listener socket
853 * @proto: transport protocol number to advertise
854 * @port: port to advertise
856 * Service is registered for any address in the passed-in protocol family
858 int svc_register(const struct svc_serv
*serv
, const int family
,
859 const unsigned short proto
, const unsigned short port
)
861 struct svc_program
*progp
;
865 BUG_ON(proto
== 0 && port
== 0);
867 for (progp
= serv
->sv_program
; progp
; progp
= progp
->pg_next
) {
868 for (i
= 0; i
< progp
->pg_nvers
; i
++) {
869 if (progp
->pg_vers
[i
] == NULL
)
872 dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
875 proto
== IPPROTO_UDP
? "udp" : "tcp",
878 progp
->pg_vers
[i
]->vs_hidden
?
879 " (but not telling portmap)" : "");
881 if (progp
->pg_vers
[i
]->vs_hidden
)
884 error
= __svc_register(progp
->pg_name
, progp
->pg_prog
,
885 i
, family
, proto
, port
);
895 * If user space is running rpcbind, it should take the v4 UNSET
896 * and clear everything for this [program, version]. If user space
897 * is running portmap, it will reject the v4 UNSET, but won't have
898 * any "inet6" entries anyway. So a PMAP_UNSET should be sufficient
899 * in this case to clear all existing entries for [program, version].
901 static void __svc_unregister(const u32 program
, const u32 version
,
902 const char *progname
)
906 error
= rpcb_v4_register(program
, version
, NULL
, "");
909 * User space didn't support rpcbind v4, so retry this
910 * request with the legacy rpcbind v2 protocol.
912 if (error
== -EPROTONOSUPPORT
)
913 error
= rpcb_register(program
, version
, 0, 0);
915 dprintk("svc: %s(%sv%u), error %d\n",
916 __func__
, progname
, version
, error
);
920 * All netids, bind addresses and ports registered for [program, version]
921 * are removed from the local rpcbind database (if the service is not
922 * hidden) to make way for a new instance of the service.
924 * The result of unregistration is reported via dprintk for those who want
925 * verification of the result, but is otherwise not important.
927 static void svc_unregister(const struct svc_serv
*serv
)
929 struct svc_program
*progp
;
933 clear_thread_flag(TIF_SIGPENDING
);
935 for (progp
= serv
->sv_program
; progp
; progp
= progp
->pg_next
) {
936 for (i
= 0; i
< progp
->pg_nvers
; i
++) {
937 if (progp
->pg_vers
[i
] == NULL
)
939 if (progp
->pg_vers
[i
]->vs_hidden
)
942 __svc_unregister(progp
->pg_prog
, i
, progp
->pg_name
);
946 spin_lock_irqsave(¤t
->sighand
->siglock
, flags
);
948 spin_unlock_irqrestore(¤t
->sighand
->siglock
, flags
);
952 * Printk the given error with the address of the client that caused it.
955 __attribute__ ((format (printf
, 2, 3)))
956 svc_printk(struct svc_rqst
*rqstp
, const char *fmt
, ...)
960 char buf
[RPC_MAX_ADDRBUFLEN
];
962 if (!net_ratelimit())
965 printk(KERN_WARNING
"svc: %s: ",
966 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
969 r
= vprintk(fmt
, args
);
976 * Common routine for processing the RPC request.
979 svc_process_common(struct svc_rqst
*rqstp
, struct kvec
*argv
, struct kvec
*resv
)
981 struct svc_program
*progp
;
982 struct svc_version
*versp
= NULL
; /* compiler food */
983 struct svc_procedure
*procp
= NULL
;
984 struct svc_serv
*serv
= rqstp
->rq_server
;
987 u32 prog
, vers
, proc
;
988 __be32 auth_stat
, rpc_stat
;
992 rpc_stat
= rpc_success
;
994 if (argv
->iov_len
< 6*4)
997 /* Will be turned off only in gss privacy case: */
998 rqstp
->rq_splice_ok
= 1;
999 /* Will be turned off only when NFSv4 Sessions are used */
1000 rqstp
->rq_usedeferral
= 1;
1002 /* Setup reply header */
1003 rqstp
->rq_xprt
->xpt_ops
->xpo_prep_reply_hdr(rqstp
);
1005 svc_putu32(resv
, rqstp
->rq_xid
);
1007 vers
= svc_getnl(argv
);
1009 /* First words of reply: */
1010 svc_putnl(resv
, 1); /* REPLY */
1012 if (vers
!= 2) /* RPC version number */
1015 /* Save position in case we later decide to reject: */
1016 reply_statp
= resv
->iov_base
+ resv
->iov_len
;
1018 svc_putnl(resv
, 0); /* ACCEPT */
1020 rqstp
->rq_prog
= prog
= svc_getnl(argv
); /* program number */
1021 rqstp
->rq_vers
= vers
= svc_getnl(argv
); /* version number */
1022 rqstp
->rq_proc
= proc
= svc_getnl(argv
); /* procedure number */
1024 progp
= serv
->sv_program
;
1026 for (progp
= serv
->sv_program
; progp
; progp
= progp
->pg_next
)
1027 if (prog
== progp
->pg_prog
)
1031 * Decode auth data, and add verifier to reply buffer.
1032 * We do this before anything else in order to get a decent
1035 auth_res
= svc_authenticate(rqstp
, &auth_stat
);
1036 /* Also give the program a chance to reject this call: */
1037 if (auth_res
== SVC_OK
&& progp
) {
1038 auth_stat
= rpc_autherr_badcred
;
1039 auth_res
= progp
->pg_authenticate(rqstp
);
1047 rpc_stat
= rpc_system_err
;
1060 if (vers
>= progp
->pg_nvers
||
1061 !(versp
= progp
->pg_vers
[vers
]))
1064 procp
= versp
->vs_proc
+ proc
;
1065 if (proc
>= versp
->vs_nproc
|| !procp
->pc_func
)
1067 rqstp
->rq_procinfo
= procp
;
1069 /* Syntactic check complete */
1070 serv
->sv_stats
->rpccnt
++;
1072 /* Build the reply header. */
1073 statp
= resv
->iov_base
+resv
->iov_len
;
1074 svc_putnl(resv
, RPC_SUCCESS
);
1076 /* Bump per-procedure stats counter */
1079 /* Initialize storage for argp and resp */
1080 memset(rqstp
->rq_argp
, 0, procp
->pc_argsize
);
1081 memset(rqstp
->rq_resp
, 0, procp
->pc_ressize
);
1083 /* un-reserve some of the out-queue now that we have a
1084 * better idea of reply size
1086 if (procp
->pc_xdrressize
)
1087 svc_reserve_auth(rqstp
, procp
->pc_xdrressize
<<2);
1089 /* Call the function that processes the request. */
1090 if (!versp
->vs_dispatch
) {
1091 /* Decode arguments */
1092 xdr
= procp
->pc_decode
;
1093 if (xdr
&& !xdr(rqstp
, argv
->iov_base
, rqstp
->rq_argp
))
1096 *statp
= procp
->pc_func(rqstp
, rqstp
->rq_argp
, rqstp
->rq_resp
);
1099 if (*statp
== rpc_drop_reply
) {
1100 if (procp
->pc_release
)
1101 procp
->pc_release(rqstp
, NULL
, rqstp
->rq_resp
);
1104 if (*statp
== rpc_success
&& (xdr
= procp
->pc_encode
)
1105 && !xdr(rqstp
, resv
->iov_base
+resv
->iov_len
, rqstp
->rq_resp
)) {
1106 dprintk("svc: failed to encode reply\n");
1107 /* serv->sv_stats->rpcsystemerr++; */
1108 *statp
= rpc_system_err
;
1111 dprintk("svc: calling dispatcher\n");
1112 if (!versp
->vs_dispatch(rqstp
, statp
)) {
1113 /* Release reply info */
1114 if (procp
->pc_release
)
1115 procp
->pc_release(rqstp
, NULL
, rqstp
->rq_resp
);
1120 /* Check RPC status result */
1121 if (*statp
!= rpc_success
)
1122 resv
->iov_len
= ((void*)statp
) - resv
->iov_base
+ 4;
1124 /* Release reply info */
1125 if (procp
->pc_release
)
1126 procp
->pc_release(rqstp
, NULL
, rqstp
->rq_resp
);
1128 if (procp
->pc_encode
== NULL
)
1132 if (svc_authorise(rqstp
))
1134 return 1; /* Caller can now send it */
1137 svc_authorise(rqstp
); /* doesn't hurt to call this twice */
1138 dprintk("svc: svc_process dropit\n");
1143 svc_printk(rqstp
, "short len %Zd, dropping request\n",
1146 goto dropit
; /* drop request */
1149 serv
->sv_stats
->rpcbadfmt
++;
1150 svc_putnl(resv
, 1); /* REJECT */
1151 svc_putnl(resv
, 0); /* RPC_MISMATCH */
1152 svc_putnl(resv
, 2); /* Only RPCv2 supported */
1157 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat
));
1158 serv
->sv_stats
->rpcbadauth
++;
1159 /* Restore write pointer to location of accept status: */
1160 xdr_ressize_check(rqstp
, reply_statp
);
1161 svc_putnl(resv
, 1); /* REJECT */
1162 svc_putnl(resv
, 1); /* AUTH_ERROR */
1163 svc_putnl(resv
, ntohl(auth_stat
)); /* status */
1167 dprintk("svc: unknown program %d\n", prog
);
1168 serv
->sv_stats
->rpcbadfmt
++;
1169 svc_putnl(resv
, RPC_PROG_UNAVAIL
);
1173 svc_printk(rqstp
, "unknown version (%d for prog %d, %s)\n",
1174 vers
, prog
, progp
->pg_name
);
1176 serv
->sv_stats
->rpcbadfmt
++;
1177 svc_putnl(resv
, RPC_PROG_MISMATCH
);
1178 svc_putnl(resv
, progp
->pg_lovers
);
1179 svc_putnl(resv
, progp
->pg_hivers
);
1183 svc_printk(rqstp
, "unknown procedure (%d)\n", proc
);
1185 serv
->sv_stats
->rpcbadfmt
++;
1186 svc_putnl(resv
, RPC_PROC_UNAVAIL
);
1190 svc_printk(rqstp
, "failed to decode args\n");
1192 rpc_stat
= rpc_garbage_args
;
1194 serv
->sv_stats
->rpcbadfmt
++;
1195 svc_putnl(resv
, ntohl(rpc_stat
));
1198 EXPORT_SYMBOL_GPL(svc_process
);
1201 * Process the RPC request.
1204 svc_process(struct svc_rqst
*rqstp
)
1206 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
1207 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
1208 struct svc_serv
*serv
= rqstp
->rq_server
;
1213 * Setup response xdr_buf.
1214 * Initially it has just one page
1216 rqstp
->rq_resused
= 1;
1217 resv
->iov_base
= page_address(rqstp
->rq_respages
[0]);
1219 rqstp
->rq_res
.pages
= rqstp
->rq_respages
+ 1;
1220 rqstp
->rq_res
.len
= 0;
1221 rqstp
->rq_res
.page_base
= 0;
1222 rqstp
->rq_res
.page_len
= 0;
1223 rqstp
->rq_res
.buflen
= PAGE_SIZE
;
1224 rqstp
->rq_res
.tail
[0].iov_base
= NULL
;
1225 rqstp
->rq_res
.tail
[0].iov_len
= 0;
1227 rqstp
->rq_xid
= svc_getu32(argv
);
1229 dir
= svc_getnl(argv
);
1231 /* direction != CALL */
1232 svc_printk(rqstp
, "bad direction %d, dropping request\n", dir
);
1233 serv
->sv_stats
->rpcbadfmt
++;
1238 error
= svc_process_common(rqstp
, argv
, resv
);
1242 return svc_send(rqstp
);
1245 #if defined(CONFIG_NFS_V4_1)
1247 * Process a backchannel RPC request that arrived over an existing
1248 * outbound connection
1251 bc_svc_process(struct svc_serv
*serv
, struct rpc_rqst
*req
,
1252 struct svc_rqst
*rqstp
)
1254 struct kvec
*argv
= &rqstp
->rq_arg
.head
[0];
1255 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
1258 /* Build the svc_rqst used by the common processing routine */
1259 rqstp
->rq_xprt
= serv
->bc_xprt
;
1260 rqstp
->rq_xid
= req
->rq_xid
;
1261 rqstp
->rq_prot
= req
->rq_xprt
->prot
;
1262 rqstp
->rq_server
= serv
;
1264 rqstp
->rq_addrlen
= sizeof(req
->rq_xprt
->addr
);
1265 memcpy(&rqstp
->rq_addr
, &req
->rq_xprt
->addr
, rqstp
->rq_addrlen
);
1266 memcpy(&rqstp
->rq_arg
, &req
->rq_rcv_buf
, sizeof(rqstp
->rq_arg
));
1267 memcpy(&rqstp
->rq_res
, &req
->rq_snd_buf
, sizeof(rqstp
->rq_res
));
1269 /* reset result send buffer "put" position */
1272 if (rqstp
->rq_prot
!= IPPROTO_TCP
) {
1273 printk(KERN_ERR
"No support for Non-TCP transports!\n");
1278 * Skip the next two words because they've already been
1279 * processed in the trasport
1281 svc_getu32(argv
); /* XID */
1282 svc_getnl(argv
); /* CALLDIR */
1284 error
= svc_process_common(rqstp
, argv
, resv
);
1288 memcpy(&req
->rq_snd_buf
, &rqstp
->rq_res
, sizeof(req
->rq_snd_buf
));
1289 return bc_send(req
);
1291 EXPORT_SYMBOL(bc_svc_process
);
1292 #endif /* CONFIG_NFS_V4_1 */
1295 * Return (transport-specific) limit on the rpc payload.
1297 u32
svc_max_payload(const struct svc_rqst
*rqstp
)
1299 u32 max
= rqstp
->rq_xprt
->xpt_class
->xcl_max_payload
;
1301 if (rqstp
->rq_server
->sv_max_payload
< max
)
1302 max
= rqstp
->rq_server
->sv_max_payload
;
1305 EXPORT_SYMBOL_GPL(svc_max_payload
);