1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/net/sunrpc/svc_xprt.c
8 #include <linux/sched.h>
9 #include <linux/errno.h>
10 #include <linux/freezer.h>
11 #include <linux/kthread.h>
12 #include <linux/slab.h>
14 #include <linux/sunrpc/addr.h>
15 #include <linux/sunrpc/stats.h>
16 #include <linux/sunrpc/svc_xprt.h>
17 #include <linux/sunrpc/svcsock.h>
18 #include <linux/sunrpc/xprt.h>
19 #include <linux/module.h>
20 #include <linux/netdevice.h>
21 #include <trace/events/sunrpc.h>
23 #define RPCDBG_FACILITY RPCDBG_SVCXPRT
25 static unsigned int svc_rpc_per_connection_limit __read_mostly;
26 module_param(svc_rpc_per_connection_limit, uint, 0644);
29 static struct svc_deferred_req *svc_deferred_dequeue(struct svc_xprt *xprt);
30 static int svc_deferred_recv(struct svc_rqst *rqstp);
31 static struct cache_deferred_req *svc_defer(struct cache_req *req);
32 static void svc_age_temp_xprts(struct timer_list *t);
33 static void svc_delete_xprt(struct svc_xprt *xprt);
35 /* apparently the "standard" is that clients close
36 * idle connections after 5 minutes, servers after
38 * http://nfsv4bat.org/Documents/ConnectAThon/1996/nfstcp.pdf
40 static int svc_conn_age_period = 6*60;
42 /* List of registered transport classes */
43 static DEFINE_SPINLOCK(svc_xprt_class_lock);
44 static LIST_HEAD(svc_xprt_class_list);
46 /* SMP locking strategy:
48 * svc_pool->sp_lock protects most of the fields of that pool.
49 * svc_serv->sv_lock protects sv_tempsocks, sv_permsocks, sv_tmpcnt.
50 * when both need to be taken (rare), svc_serv->sv_lock is first.
51 * The "service mutex" protects svc_serv->sv_nrthread.
52 * svc_sock->sk_lock protects the svc_sock->sk_deferred list
53 * and the ->sk_info_authunix cache.
55 * The XPT_BUSY bit in xprt->xpt_flags prevents a transport being
56 * enqueued multiply. During normal transport processing this bit
57 * is set by svc_xprt_enqueue and cleared by svc_xprt_received.
58 * Providers should not manipulate this bit directly.
60 * Some flags can be set to certain values at any time
61 * providing that certain rules are followed:
64 * - Can be set or cleared at any time.
65 * - After a set, svc_xprt_enqueue must be called to enqueue
66 * the transport for processing.
67 * - After a clear, the transport must be read/accepted.
68 * If this succeeds, it must be set again.
70 * - Can set at any time. It is never cleared.
72 * - Can only be set while XPT_BUSY is held which ensures
73 * that no other thread will be using the transport or will
74 * try to set XPT_DEAD.
76 int svc_reg_xprt_class(struct svc_xprt_class *xcl)
78 struct svc_xprt_class *cl;
81 dprintk("svc: Adding svc transport class '%s'\n", xcl->xcl_name);
83 INIT_LIST_HEAD(&xcl->xcl_list);
84 spin_lock(&svc_xprt_class_lock);
85 /* Make sure there isn't already a class with the same name */
86 list_for_each_entry(cl, &svc_xprt_class_list, xcl_list) {
87 if (strcmp(xcl->xcl_name, cl->xcl_name) == 0)
90 list_add_tail(&xcl->xcl_list, &svc_xprt_class_list);
93 spin_unlock(&svc_xprt_class_lock);
96 EXPORT_SYMBOL_GPL(svc_reg_xprt_class);
98 void svc_unreg_xprt_class(struct svc_xprt_class *xcl)
100 dprintk("svc: Removing svc transport class '%s'\n", xcl->xcl_name);
101 spin_lock(&svc_xprt_class_lock);
102 list_del_init(&xcl->xcl_list);
103 spin_unlock(&svc_xprt_class_lock);
105 EXPORT_SYMBOL_GPL(svc_unreg_xprt_class);
108 * svc_print_xprts - Format the transport list for printing
109 * @buf: target buffer for formatted address
110 * @maxlen: length of target buffer
112 * Fills in @buf with a string containing a list of transport names, each name
113 * terminated with '\n'. If the buffer is too small, some entries may be
114 * missing, but it is guaranteed that all lines in the output buffer are
117 * Returns positive length of the filled-in string.
119 int svc_print_xprts(char *buf, int maxlen)
121 struct svc_xprt_class *xcl;
126 spin_lock(&svc_xprt_class_lock);
127 list_for_each_entry(xcl, &svc_xprt_class_list, xcl_list) {
130 slen = snprintf(tmpstr, sizeof(tmpstr), "%s %d\n",
131 xcl->xcl_name, xcl->xcl_max_payload);
132 if (slen >= sizeof(tmpstr) || len + slen >= maxlen)
137 spin_unlock(&svc_xprt_class_lock);
142 static void svc_xprt_free(struct kref *kref)
144 struct svc_xprt *xprt =
145 container_of(kref, struct svc_xprt, xpt_ref);
146 struct module *owner = xprt->xpt_class->xcl_owner;
147 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags))
148 svcauth_unix_info_release(xprt);
149 put_cred(xprt->xpt_cred);
150 put_net(xprt->xpt_net);
151 /* See comment on corresponding get in xs_setup_bc_tcp(): */
152 if (xprt->xpt_bc_xprt)
153 xprt_put(xprt->xpt_bc_xprt);
154 if (xprt->xpt_bc_xps)
155 xprt_switch_put(xprt->xpt_bc_xps);
156 xprt->xpt_ops->xpo_free(xprt);
160 void svc_xprt_put(struct svc_xprt *xprt)
162 kref_put(&xprt->xpt_ref, svc_xprt_free);
164 EXPORT_SYMBOL_GPL(svc_xprt_put);
167 * Called by transport drivers to initialize the transport independent
168 * portion of the transport instance.
170 void svc_xprt_init(struct net *net, struct svc_xprt_class *xcl,
171 struct svc_xprt *xprt, struct svc_serv *serv)
173 memset(xprt, 0, sizeof(*xprt));
174 xprt->xpt_class = xcl;
175 xprt->xpt_ops = xcl->xcl_ops;
176 kref_init(&xprt->xpt_ref);
177 xprt->xpt_server = serv;
178 INIT_LIST_HEAD(&xprt->xpt_list);
179 INIT_LIST_HEAD(&xprt->xpt_ready);
180 INIT_LIST_HEAD(&xprt->xpt_deferred);
181 INIT_LIST_HEAD(&xprt->xpt_users);
182 mutex_init(&xprt->xpt_mutex);
183 spin_lock_init(&xprt->xpt_lock);
184 set_bit(XPT_BUSY, &xprt->xpt_flags);
185 xprt->xpt_net = get_net(net);
186 strcpy(xprt->xpt_remotebuf, "uninitialized");
188 EXPORT_SYMBOL_GPL(svc_xprt_init);
190 static struct svc_xprt *__svc_xpo_create(struct svc_xprt_class *xcl,
191 struct svc_serv *serv,
194 const unsigned short port,
197 struct sockaddr_in sin = {
198 .sin_family = AF_INET,
199 .sin_addr.s_addr = htonl(INADDR_ANY),
200 .sin_port = htons(port),
202 #if IS_ENABLED(CONFIG_IPV6)
203 struct sockaddr_in6 sin6 = {
204 .sin6_family = AF_INET6,
205 .sin6_addr = IN6ADDR_ANY_INIT,
206 .sin6_port = htons(port),
209 struct sockaddr *sap;
214 sap = (struct sockaddr *)&sin;
217 #if IS_ENABLED(CONFIG_IPV6)
219 sap = (struct sockaddr *)&sin6;
224 return ERR_PTR(-EAFNOSUPPORT);
227 return xcl->xcl_ops->xpo_create(serv, net, sap, len, flags);
231 * svc_xprt_received conditionally queues the transport for processing
232 * by another thread. The caller must hold the XPT_BUSY bit and must
233 * not thereafter touch transport data.
235 * Note: XPT_DATA only gets cleared when a read-attempt finds no (or
236 * insufficient) data.
238 static void svc_xprt_received(struct svc_xprt *xprt)
240 if (!test_bit(XPT_BUSY, &xprt->xpt_flags)) {
241 WARN_ONCE(1, "xprt=0x%p already busy!", xprt);
245 /* As soon as we clear busy, the xprt could be closed and
246 * 'put', so we need a reference to call svc_enqueue_xprt with:
249 smp_mb__before_atomic();
250 clear_bit(XPT_BUSY, &xprt->xpt_flags);
251 xprt->xpt_server->sv_ops->svo_enqueue_xprt(xprt);
255 void svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *new)
257 clear_bit(XPT_TEMP, &new->xpt_flags);
258 spin_lock_bh(&serv->sv_lock);
259 list_add(&new->xpt_list, &serv->sv_permsocks);
260 spin_unlock_bh(&serv->sv_lock);
261 svc_xprt_received(new);
264 static int _svc_create_xprt(struct svc_serv *serv, const char *xprt_name,
265 struct net *net, const int family,
266 const unsigned short port, int flags,
267 const struct cred *cred)
269 struct svc_xprt_class *xcl;
271 spin_lock(&svc_xprt_class_lock);
272 list_for_each_entry(xcl, &svc_xprt_class_list, xcl_list) {
273 struct svc_xprt *newxprt;
274 unsigned short newport;
276 if (strcmp(xprt_name, xcl->xcl_name))
279 if (!try_module_get(xcl->xcl_owner))
282 spin_unlock(&svc_xprt_class_lock);
283 newxprt = __svc_xpo_create(xcl, serv, net, family, port, flags);
284 if (IS_ERR(newxprt)) {
285 module_put(xcl->xcl_owner);
286 return PTR_ERR(newxprt);
288 newxprt->xpt_cred = get_cred(cred);
289 svc_add_new_perm_xprt(serv, newxprt);
290 newport = svc_xprt_local_port(newxprt);
294 spin_unlock(&svc_xprt_class_lock);
295 /* This errno is exposed to user space. Provide a reasonable
296 * perror msg for a bad transport. */
297 return -EPROTONOSUPPORT;
300 int svc_create_xprt(struct svc_serv *serv, const char *xprt_name,
301 struct net *net, const int family,
302 const unsigned short port, int flags,
303 const struct cred *cred)
307 dprintk("svc: creating transport %s[%d]\n", xprt_name, port);
308 err = _svc_create_xprt(serv, xprt_name, net, family, port, flags, cred);
309 if (err == -EPROTONOSUPPORT) {
310 request_module("svc%s", xprt_name);
311 err = _svc_create_xprt(serv, xprt_name, net, family, port, flags, cred);
314 dprintk("svc: transport %s not found, err %d\n",
318 EXPORT_SYMBOL_GPL(svc_create_xprt);
321 * Copy the local and remote xprt addresses to the rqstp structure
323 void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt)
325 memcpy(&rqstp->rq_addr, &xprt->xpt_remote, xprt->xpt_remotelen);
326 rqstp->rq_addrlen = xprt->xpt_remotelen;
329 * Destination address in request is needed for binding the
330 * source address in RPC replies/callbacks later.
332 memcpy(&rqstp->rq_daddr, &xprt->xpt_local, xprt->xpt_locallen);
333 rqstp->rq_daddrlen = xprt->xpt_locallen;
335 EXPORT_SYMBOL_GPL(svc_xprt_copy_addrs);
338 * svc_print_addr - Format rq_addr field for printing
339 * @rqstp: svc_rqst struct containing address to print
340 * @buf: target buffer for formatted address
341 * @len: length of target buffer
344 char *svc_print_addr(struct svc_rqst *rqstp, char *buf, size_t len)
346 return __svc_print_addr(svc_addr(rqstp), buf, len);
348 EXPORT_SYMBOL_GPL(svc_print_addr);
350 static bool svc_xprt_slots_in_range(struct svc_xprt *xprt)
352 unsigned int limit = svc_rpc_per_connection_limit;
353 int nrqsts = atomic_read(&xprt->xpt_nr_rqsts);
355 return limit == 0 || (nrqsts >= 0 && nrqsts < limit);
358 static bool svc_xprt_reserve_slot(struct svc_rqst *rqstp, struct svc_xprt *xprt)
360 if (!test_bit(RQ_DATA, &rqstp->rq_flags)) {
361 if (!svc_xprt_slots_in_range(xprt))
363 atomic_inc(&xprt->xpt_nr_rqsts);
364 set_bit(RQ_DATA, &rqstp->rq_flags);
369 static void svc_xprt_release_slot(struct svc_rqst *rqstp)
371 struct svc_xprt *xprt = rqstp->rq_xprt;
372 if (test_and_clear_bit(RQ_DATA, &rqstp->rq_flags)) {
373 atomic_dec(&xprt->xpt_nr_rqsts);
374 smp_wmb(); /* See smp_rmb() in svc_xprt_ready() */
375 svc_xprt_enqueue(xprt);
379 static bool svc_xprt_ready(struct svc_xprt *xprt)
381 unsigned long xpt_flags;
384 * If another cpu has recently updated xpt_flags,
385 * sk_sock->flags, xpt_reserved, or xpt_nr_rqsts, we need to
386 * know about it; otherwise it's possible that both that cpu and
387 * this one could call svc_xprt_enqueue() without either
388 * svc_xprt_enqueue() recognizing that the conditions below
389 * are satisfied, and we could stall indefinitely:
392 xpt_flags = READ_ONCE(xprt->xpt_flags);
394 if (xpt_flags & (BIT(XPT_CONN) | BIT(XPT_CLOSE)))
396 if (xpt_flags & (BIT(XPT_DATA) | BIT(XPT_DEFERRED))) {
397 if (xprt->xpt_ops->xpo_has_wspace(xprt) &&
398 svc_xprt_slots_in_range(xprt))
400 trace_svc_xprt_no_write_space(xprt);
406 void svc_xprt_do_enqueue(struct svc_xprt *xprt)
408 struct svc_pool *pool;
409 struct svc_rqst *rqstp = NULL;
412 if (!svc_xprt_ready(xprt))
415 /* Mark transport as busy. It will remain in this state until
416 * the provider calls svc_xprt_received. We update XPT_BUSY
417 * atomically because it also guards against trying to enqueue
418 * the transport twice.
420 if (test_and_set_bit(XPT_BUSY, &xprt->xpt_flags))
424 pool = svc_pool_for_cpu(xprt->xpt_server, cpu);
426 atomic_long_inc(&pool->sp_stats.packets);
428 spin_lock_bh(&pool->sp_lock);
429 list_add_tail(&xprt->xpt_ready, &pool->sp_sockets);
430 pool->sp_stats.sockets_queued++;
431 spin_unlock_bh(&pool->sp_lock);
433 /* find a thread for this xprt */
435 list_for_each_entry_rcu(rqstp, &pool->sp_all_threads, rq_all) {
436 if (test_and_set_bit(RQ_BUSY, &rqstp->rq_flags))
438 atomic_long_inc(&pool->sp_stats.threads_woken);
439 rqstp->rq_qtime = ktime_get();
440 wake_up_process(rqstp->rq_task);
443 set_bit(SP_CONGESTED, &pool->sp_flags);
448 trace_svc_xprt_do_enqueue(xprt, rqstp);
450 EXPORT_SYMBOL_GPL(svc_xprt_do_enqueue);
453 * Queue up a transport with data pending. If there are idle nfsd
454 * processes, wake 'em up.
457 void svc_xprt_enqueue(struct svc_xprt *xprt)
459 if (test_bit(XPT_BUSY, &xprt->xpt_flags))
461 xprt->xpt_server->sv_ops->svo_enqueue_xprt(xprt);
463 EXPORT_SYMBOL_GPL(svc_xprt_enqueue);
466 * Dequeue the first transport, if there is one.
468 static struct svc_xprt *svc_xprt_dequeue(struct svc_pool *pool)
470 struct svc_xprt *xprt = NULL;
472 if (list_empty(&pool->sp_sockets))
475 spin_lock_bh(&pool->sp_lock);
476 if (likely(!list_empty(&pool->sp_sockets))) {
477 xprt = list_first_entry(&pool->sp_sockets,
478 struct svc_xprt, xpt_ready);
479 list_del_init(&xprt->xpt_ready);
482 spin_unlock_bh(&pool->sp_lock);
488 * svc_reserve - change the space reserved for the reply to a request.
489 * @rqstp: The request in question
490 * @space: new max space to reserve
492 * Each request reserves some space on the output queue of the transport
493 * to make sure the reply fits. This function reduces that reserved
494 * space to be the amount of space used already, plus @space.
497 void svc_reserve(struct svc_rqst *rqstp, int space)
499 struct svc_xprt *xprt = rqstp->rq_xprt;
501 space += rqstp->rq_res.head[0].iov_len;
503 if (xprt && space < rqstp->rq_reserved) {
504 atomic_sub((rqstp->rq_reserved - space), &xprt->xpt_reserved);
505 rqstp->rq_reserved = space;
506 smp_wmb(); /* See smp_rmb() in svc_xprt_ready() */
507 svc_xprt_enqueue(xprt);
510 EXPORT_SYMBOL_GPL(svc_reserve);
512 static void svc_xprt_release(struct svc_rqst *rqstp)
514 struct svc_xprt *xprt = rqstp->rq_xprt;
516 xprt->xpt_ops->xpo_release_rqst(rqstp);
518 kfree(rqstp->rq_deferred);
519 rqstp->rq_deferred = NULL;
521 svc_free_res_pages(rqstp);
522 rqstp->rq_res.page_len = 0;
523 rqstp->rq_res.page_base = 0;
525 /* Reset response buffer and release
527 * But first, check that enough space was reserved
528 * for the reply, otherwise we have a bug!
530 if ((rqstp->rq_res.len) > rqstp->rq_reserved)
531 printk(KERN_ERR "RPC request reserved %d but used %d\n",
535 rqstp->rq_res.head[0].iov_len = 0;
536 svc_reserve(rqstp, 0);
537 svc_xprt_release_slot(rqstp);
538 rqstp->rq_xprt = NULL;
543 * Some svc_serv's will have occasional work to do, even when a xprt is not
544 * waiting to be serviced. This function is there to "kick" a task in one of
545 * those services so that it can wake up and do that work. Note that we only
546 * bother with pool 0 as we don't need to wake up more than one thread for
549 void svc_wake_up(struct svc_serv *serv)
551 struct svc_rqst *rqstp;
552 struct svc_pool *pool;
554 pool = &serv->sv_pools[0];
557 list_for_each_entry_rcu(rqstp, &pool->sp_all_threads, rq_all) {
558 /* skip any that aren't queued */
559 if (test_bit(RQ_BUSY, &rqstp->rq_flags))
562 wake_up_process(rqstp->rq_task);
563 trace_svc_wake_up(rqstp->rq_task->pid);
568 /* No free entries available */
569 set_bit(SP_TASK_PENDING, &pool->sp_flags);
571 trace_svc_wake_up(0);
573 EXPORT_SYMBOL_GPL(svc_wake_up);
575 int svc_port_is_privileged(struct sockaddr *sin)
577 switch (sin->sa_family) {
579 return ntohs(((struct sockaddr_in *)sin)->sin_port)
582 return ntohs(((struct sockaddr_in6 *)sin)->sin6_port)
590 * Make sure that we don't have too many active connections. If we have,
591 * something must be dropped. It's not clear what will happen if we allow
592 * "too many" connections, but when dealing with network-facing software,
593 * we have to code defensively. Here we do that by imposing hard limits.
595 * There's no point in trying to do random drop here for DoS
596 * prevention. The NFS clients does 1 reconnect in 15 seconds. An
597 * attacker can easily beat that.
599 * The only somewhat efficient mechanism would be if drop old
600 * connections from the same IP first. But right now we don't even
601 * record the client IP in svc_sock.
603 * single-threaded services that expect a lot of clients will probably
604 * need to set sv_maxconn to override the default value which is based
605 * on the number of threads
607 static void svc_check_conn_limits(struct svc_serv *serv)
609 unsigned int limit = serv->sv_maxconn ? serv->sv_maxconn :
610 (serv->sv_nrthreads+3) * 20;
612 if (serv->sv_tmpcnt > limit) {
613 struct svc_xprt *xprt = NULL;
614 spin_lock_bh(&serv->sv_lock);
615 if (!list_empty(&serv->sv_tempsocks)) {
616 /* Try to help the admin */
617 net_notice_ratelimited("%s: too many open connections, consider increasing the %s\n",
618 serv->sv_name, serv->sv_maxconn ?
619 "max number of connections" :
620 "number of threads");
622 * Always select the oldest connection. It's not fair,
625 xprt = list_entry(serv->sv_tempsocks.prev,
628 set_bit(XPT_CLOSE, &xprt->xpt_flags);
631 spin_unlock_bh(&serv->sv_lock);
634 svc_xprt_enqueue(xprt);
640 static int svc_alloc_arg(struct svc_rqst *rqstp)
642 struct svc_serv *serv = rqstp->rq_server;
647 /* now allocate needed pages. If we get a failure, sleep briefly */
648 pages = (serv->sv_max_mesg + 2 * PAGE_SIZE) >> PAGE_SHIFT;
649 if (pages > RPCSVC_MAXPAGES) {
650 pr_warn_once("svc: warning: pages=%u > RPCSVC_MAXPAGES=%lu\n",
651 pages, RPCSVC_MAXPAGES);
652 /* use as many pages as possible */
653 pages = RPCSVC_MAXPAGES;
655 for (i = 0; i < pages ; i++)
656 while (rqstp->rq_pages[i] == NULL) {
657 struct page *p = alloc_page(GFP_KERNEL);
659 set_current_state(TASK_INTERRUPTIBLE);
660 if (signalled() || kthread_should_stop()) {
661 set_current_state(TASK_RUNNING);
664 schedule_timeout(msecs_to_jiffies(500));
666 rqstp->rq_pages[i] = p;
668 rqstp->rq_page_end = &rqstp->rq_pages[i];
669 rqstp->rq_pages[i++] = NULL; /* this might be seen in nfs_read_actor */
671 /* Make arg->head point to first page and arg->pages point to rest */
672 arg = &rqstp->rq_arg;
673 arg->head[0].iov_base = page_address(rqstp->rq_pages[0]);
674 arg->head[0].iov_len = PAGE_SIZE;
675 arg->pages = rqstp->rq_pages + 1;
677 /* save at least one page for response */
678 arg->page_len = (pages-2)*PAGE_SIZE;
679 arg->len = (pages-1)*PAGE_SIZE;
680 arg->tail[0].iov_len = 0;
685 rqst_should_sleep(struct svc_rqst *rqstp)
687 struct svc_pool *pool = rqstp->rq_pool;
689 /* did someone call svc_wake_up? */
690 if (test_and_clear_bit(SP_TASK_PENDING, &pool->sp_flags))
693 /* was a socket queued? */
694 if (!list_empty(&pool->sp_sockets))
697 /* are we shutting down? */
698 if (signalled() || kthread_should_stop())
701 /* are we freezing? */
702 if (freezing(current))
708 static struct svc_xprt *svc_get_next_xprt(struct svc_rqst *rqstp, long timeout)
710 struct svc_pool *pool = rqstp->rq_pool;
713 /* rq_xprt should be clear on entry */
714 WARN_ON_ONCE(rqstp->rq_xprt);
716 rqstp->rq_xprt = svc_xprt_dequeue(pool);
721 * We have to be able to interrupt this wait
722 * to bring down the daemons ...
724 set_current_state(TASK_INTERRUPTIBLE);
725 smp_mb__before_atomic();
726 clear_bit(SP_CONGESTED, &pool->sp_flags);
727 clear_bit(RQ_BUSY, &rqstp->rq_flags);
728 smp_mb__after_atomic();
730 if (likely(rqst_should_sleep(rqstp)))
731 time_left = schedule_timeout(timeout);
733 __set_current_state(TASK_RUNNING);
737 set_bit(RQ_BUSY, &rqstp->rq_flags);
738 smp_mb__after_atomic();
739 rqstp->rq_xprt = svc_xprt_dequeue(pool);
744 atomic_long_inc(&pool->sp_stats.threads_timedout);
746 if (signalled() || kthread_should_stop())
747 return ERR_PTR(-EINTR);
748 return ERR_PTR(-EAGAIN);
750 /* Normally we will wait up to 5 seconds for any required
751 * cache information to be provided.
753 if (!test_bit(SP_CONGESTED, &pool->sp_flags))
754 rqstp->rq_chandle.thread_wait = 5*HZ;
756 rqstp->rq_chandle.thread_wait = 1*HZ;
757 trace_svc_xprt_dequeue(rqstp);
758 return rqstp->rq_xprt;
761 static void svc_add_new_temp_xprt(struct svc_serv *serv, struct svc_xprt *newxpt)
763 spin_lock_bh(&serv->sv_lock);
764 set_bit(XPT_TEMP, &newxpt->xpt_flags);
765 list_add(&newxpt->xpt_list, &serv->sv_tempsocks);
767 if (serv->sv_temptimer.function == NULL) {
768 /* setup timer to age temp transports */
769 serv->sv_temptimer.function = svc_age_temp_xprts;
770 mod_timer(&serv->sv_temptimer,
771 jiffies + svc_conn_age_period * HZ);
773 spin_unlock_bh(&serv->sv_lock);
774 svc_xprt_received(newxpt);
777 static int svc_handle_xprt(struct svc_rqst *rqstp, struct svc_xprt *xprt)
779 struct svc_serv *serv = rqstp->rq_server;
782 if (test_bit(XPT_CLOSE, &xprt->xpt_flags)) {
783 dprintk("svc_recv: found XPT_CLOSE\n");
784 if (test_and_clear_bit(XPT_KILL_TEMP, &xprt->xpt_flags))
785 xprt->xpt_ops->xpo_kill_temp_xprt(xprt);
786 svc_delete_xprt(xprt);
787 /* Leave XPT_BUSY set on the dead xprt: */
790 if (test_bit(XPT_LISTENER, &xprt->xpt_flags)) {
791 struct svc_xprt *newxpt;
793 * We know this module_get will succeed because the
794 * listener holds a reference too
796 __module_get(xprt->xpt_class->xcl_owner);
797 svc_check_conn_limits(xprt->xpt_server);
798 newxpt = xprt->xpt_ops->xpo_accept(xprt);
800 newxpt->xpt_cred = get_cred(xprt->xpt_cred);
801 svc_add_new_temp_xprt(serv, newxpt);
803 module_put(xprt->xpt_class->xcl_owner);
804 } else if (svc_xprt_reserve_slot(rqstp, xprt)) {
805 /* XPT_DATA|XPT_DEFERRED case: */
806 dprintk("svc: server %p, pool %u, transport %p, inuse=%d\n",
807 rqstp, rqstp->rq_pool->sp_id, xprt,
808 kref_read(&xprt->xpt_ref));
809 rqstp->rq_deferred = svc_deferred_dequeue(xprt);
810 if (rqstp->rq_deferred)
811 len = svc_deferred_recv(rqstp);
813 len = xprt->xpt_ops->xpo_recvfrom(rqstp);
815 trace_svc_xdr_recvfrom(rqstp, &rqstp->rq_arg);
816 rqstp->rq_stime = ktime_get();
817 rqstp->rq_reserved = serv->sv_max_mesg;
818 atomic_add(rqstp->rq_reserved, &xprt->xpt_reserved);
820 /* clear XPT_BUSY: */
821 svc_xprt_received(xprt);
823 trace_svc_handle_xprt(xprt, len);
828 * Receive the next request on any transport. This code is carefully
829 * organised not to touch any cachelines in the shared svc_serv
830 * structure, only cachelines in the local svc_pool.
832 int svc_recv(struct svc_rqst *rqstp, long timeout)
834 struct svc_xprt *xprt = NULL;
835 struct svc_serv *serv = rqstp->rq_server;
838 dprintk("svc: server %p waiting for data (to = %ld)\n",
843 "svc_recv: service %p, transport not NULL!\n",
846 err = svc_alloc_arg(rqstp);
853 if (signalled() || kthread_should_stop())
856 xprt = svc_get_next_xprt(rqstp, timeout);
862 len = svc_handle_xprt(rqstp, xprt);
864 /* No data, incomplete (TCP) read, or accept() */
869 clear_bit(XPT_OLD, &xprt->xpt_flags);
871 xprt->xpt_ops->xpo_secure_port(rqstp);
872 rqstp->rq_chandle.defer = svc_defer;
873 rqstp->rq_xid = svc_getu32(&rqstp->rq_arg.head[0]);
876 serv->sv_stats->netcnt++;
877 trace_svc_recv(rqstp, len);
880 rqstp->rq_res.len = 0;
881 svc_xprt_release(rqstp);
885 EXPORT_SYMBOL_GPL(svc_recv);
890 void svc_drop(struct svc_rqst *rqstp)
892 trace_svc_drop(rqstp);
893 dprintk("svc: xprt %p dropped request\n", rqstp->rq_xprt);
894 svc_xprt_release(rqstp);
896 EXPORT_SYMBOL_GPL(svc_drop);
899 * Return reply to client.
901 int svc_send(struct svc_rqst *rqstp)
903 struct svc_xprt *xprt;
907 xprt = rqstp->rq_xprt;
911 /* calculate over-all length */
913 xb->len = xb->head[0].iov_len +
916 trace_svc_xdr_sendto(rqstp, xb);
918 /* Grab mutex to serialize outgoing data. */
919 mutex_lock(&xprt->xpt_mutex);
920 trace_svc_stats_latency(rqstp);
921 if (test_bit(XPT_DEAD, &xprt->xpt_flags)
922 || test_bit(XPT_CLOSE, &xprt->xpt_flags))
925 len = xprt->xpt_ops->xpo_sendto(rqstp);
926 mutex_unlock(&xprt->xpt_mutex);
927 trace_svc_send(rqstp, len);
928 svc_xprt_release(rqstp);
930 if (len == -ECONNREFUSED || len == -ENOTCONN || len == -EAGAIN)
937 * Timer function to close old temporary transports, using
938 * a mark-and-sweep algorithm.
940 static void svc_age_temp_xprts(struct timer_list *t)
942 struct svc_serv *serv = from_timer(serv, t, sv_temptimer);
943 struct svc_xprt *xprt;
944 struct list_head *le, *next;
946 dprintk("svc_age_temp_xprts\n");
948 if (!spin_trylock_bh(&serv->sv_lock)) {
949 /* busy, try again 1 sec later */
950 dprintk("svc_age_temp_xprts: busy\n");
951 mod_timer(&serv->sv_temptimer, jiffies + HZ);
955 list_for_each_safe(le, next, &serv->sv_tempsocks) {
956 xprt = list_entry(le, struct svc_xprt, xpt_list);
958 /* First time through, just mark it OLD. Second time
959 * through, close it. */
960 if (!test_and_set_bit(XPT_OLD, &xprt->xpt_flags))
962 if (kref_read(&xprt->xpt_ref) > 1 ||
963 test_bit(XPT_BUSY, &xprt->xpt_flags))
966 set_bit(XPT_CLOSE, &xprt->xpt_flags);
967 dprintk("queuing xprt %p for closing\n", xprt);
969 /* a thread will dequeue and close it soon */
970 svc_xprt_enqueue(xprt);
972 spin_unlock_bh(&serv->sv_lock);
974 mod_timer(&serv->sv_temptimer, jiffies + svc_conn_age_period * HZ);
977 /* Close temporary transports whose xpt_local matches server_addr immediately
978 * instead of waiting for them to be picked up by the timer.
980 * This is meant to be called from a notifier_block that runs when an ip
981 * address is deleted.
983 void svc_age_temp_xprts_now(struct svc_serv *serv, struct sockaddr *server_addr)
985 struct svc_xprt *xprt;
986 struct list_head *le, *next;
987 LIST_HEAD(to_be_closed);
989 spin_lock_bh(&serv->sv_lock);
990 list_for_each_safe(le, next, &serv->sv_tempsocks) {
991 xprt = list_entry(le, struct svc_xprt, xpt_list);
992 if (rpc_cmp_addr(server_addr, (struct sockaddr *)
994 dprintk("svc_age_temp_xprts_now: found %p\n", xprt);
995 list_move(le, &to_be_closed);
998 spin_unlock_bh(&serv->sv_lock);
1000 while (!list_empty(&to_be_closed)) {
1001 le = to_be_closed.next;
1003 xprt = list_entry(le, struct svc_xprt, xpt_list);
1004 set_bit(XPT_CLOSE, &xprt->xpt_flags);
1005 set_bit(XPT_KILL_TEMP, &xprt->xpt_flags);
1006 dprintk("svc_age_temp_xprts_now: queuing xprt %p for closing\n",
1008 svc_xprt_enqueue(xprt);
1011 EXPORT_SYMBOL_GPL(svc_age_temp_xprts_now);
1013 static void call_xpt_users(struct svc_xprt *xprt)
1015 struct svc_xpt_user *u;
1017 spin_lock(&xprt->xpt_lock);
1018 while (!list_empty(&xprt->xpt_users)) {
1019 u = list_first_entry(&xprt->xpt_users, struct svc_xpt_user, list);
1020 list_del_init(&u->list);
1023 spin_unlock(&xprt->xpt_lock);
1027 * Remove a dead transport
1029 static void svc_delete_xprt(struct svc_xprt *xprt)
1031 struct svc_serv *serv = xprt->xpt_server;
1032 struct svc_deferred_req *dr;
1034 /* Only do this once */
1035 if (test_and_set_bit(XPT_DEAD, &xprt->xpt_flags))
1038 dprintk("svc: svc_delete_xprt(%p)\n", xprt);
1039 xprt->xpt_ops->xpo_detach(xprt);
1040 if (xprt->xpt_bc_xprt)
1041 xprt->xpt_bc_xprt->ops->close(xprt->xpt_bc_xprt);
1043 spin_lock_bh(&serv->sv_lock);
1044 list_del_init(&xprt->xpt_list);
1045 WARN_ON_ONCE(!list_empty(&xprt->xpt_ready));
1046 if (test_bit(XPT_TEMP, &xprt->xpt_flags))
1048 spin_unlock_bh(&serv->sv_lock);
1050 while ((dr = svc_deferred_dequeue(xprt)) != NULL)
1053 call_xpt_users(xprt);
1057 void svc_close_xprt(struct svc_xprt *xprt)
1059 set_bit(XPT_CLOSE, &xprt->xpt_flags);
1060 if (test_and_set_bit(XPT_BUSY, &xprt->xpt_flags))
1061 /* someone else will have to effect the close */
1064 * We expect svc_close_xprt() to work even when no threads are
1065 * running (e.g., while configuring the server before starting
1066 * any threads), so if the transport isn't busy, we delete
1069 svc_delete_xprt(xprt);
1071 EXPORT_SYMBOL_GPL(svc_close_xprt);
1073 static int svc_close_list(struct svc_serv *serv, struct list_head *xprt_list, struct net *net)
1075 struct svc_xprt *xprt;
1078 spin_lock(&serv->sv_lock);
1079 list_for_each_entry(xprt, xprt_list, xpt_list) {
1080 if (xprt->xpt_net != net)
1083 set_bit(XPT_CLOSE, &xprt->xpt_flags);
1084 svc_xprt_enqueue(xprt);
1086 spin_unlock(&serv->sv_lock);
1090 static struct svc_xprt *svc_dequeue_net(struct svc_serv *serv, struct net *net)
1092 struct svc_pool *pool;
1093 struct svc_xprt *xprt;
1094 struct svc_xprt *tmp;
1097 for (i = 0; i < serv->sv_nrpools; i++) {
1098 pool = &serv->sv_pools[i];
1100 spin_lock_bh(&pool->sp_lock);
1101 list_for_each_entry_safe(xprt, tmp, &pool->sp_sockets, xpt_ready) {
1102 if (xprt->xpt_net != net)
1104 list_del_init(&xprt->xpt_ready);
1105 spin_unlock_bh(&pool->sp_lock);
1108 spin_unlock_bh(&pool->sp_lock);
1113 static void svc_clean_up_xprts(struct svc_serv *serv, struct net *net)
1115 struct svc_xprt *xprt;
1117 while ((xprt = svc_dequeue_net(serv, net))) {
1118 set_bit(XPT_CLOSE, &xprt->xpt_flags);
1119 svc_delete_xprt(xprt);
1124 * Server threads may still be running (especially in the case where the
1125 * service is still running in other network namespaces).
1127 * So we shut down sockets the same way we would on a running server, by
1128 * setting XPT_CLOSE, enqueuing, and letting a thread pick it up to do
1129 * the close. In the case there are no such other threads,
1130 * threads running, svc_clean_up_xprts() does a simple version of a
1131 * server's main event loop, and in the case where there are other
1132 * threads, we may need to wait a little while and then check again to
1133 * see if they're done.
1135 void svc_close_net(struct svc_serv *serv, struct net *net)
1139 while (svc_close_list(serv, &serv->sv_permsocks, net) +
1140 svc_close_list(serv, &serv->sv_tempsocks, net)) {
1142 svc_clean_up_xprts(serv, net);
1148 * Handle defer and revisit of requests
1151 static void svc_revisit(struct cache_deferred_req *dreq, int too_many)
1153 struct svc_deferred_req *dr =
1154 container_of(dreq, struct svc_deferred_req, handle);
1155 struct svc_xprt *xprt = dr->xprt;
1157 spin_lock(&xprt->xpt_lock);
1158 set_bit(XPT_DEFERRED, &xprt->xpt_flags);
1159 if (too_many || test_bit(XPT_DEAD, &xprt->xpt_flags)) {
1160 spin_unlock(&xprt->xpt_lock);
1161 dprintk("revisit canceled\n");
1163 trace_svc_drop_deferred(dr);
1167 dprintk("revisit queued\n");
1169 list_add(&dr->handle.recent, &xprt->xpt_deferred);
1170 spin_unlock(&xprt->xpt_lock);
1171 svc_xprt_enqueue(xprt);
1176 * Save the request off for later processing. The request buffer looks
1179 * <xprt-header><rpc-header><rpc-pagelist><rpc-tail>
1181 * This code can only handle requests that consist of an xprt-header
1184 static struct cache_deferred_req *svc_defer(struct cache_req *req)
1186 struct svc_rqst *rqstp = container_of(req, struct svc_rqst, rq_chandle);
1187 struct svc_deferred_req *dr;
1189 if (rqstp->rq_arg.page_len || !test_bit(RQ_USEDEFERRAL, &rqstp->rq_flags))
1190 return NULL; /* if more than a page, give up FIXME */
1191 if (rqstp->rq_deferred) {
1192 dr = rqstp->rq_deferred;
1193 rqstp->rq_deferred = NULL;
1197 /* FIXME maybe discard if size too large */
1198 size = sizeof(struct svc_deferred_req) + rqstp->rq_arg.len;
1199 dr = kmalloc(size, GFP_KERNEL);
1203 dr->handle.owner = rqstp->rq_server;
1204 dr->prot = rqstp->rq_prot;
1205 memcpy(&dr->addr, &rqstp->rq_addr, rqstp->rq_addrlen);
1206 dr->addrlen = rqstp->rq_addrlen;
1207 dr->daddr = rqstp->rq_daddr;
1208 dr->argslen = rqstp->rq_arg.len >> 2;
1209 dr->xprt_hlen = rqstp->rq_xprt_hlen;
1211 /* back up head to the start of the buffer and copy */
1212 skip = rqstp->rq_arg.len - rqstp->rq_arg.head[0].iov_len;
1213 memcpy(dr->args, rqstp->rq_arg.head[0].iov_base - skip,
1216 svc_xprt_get(rqstp->rq_xprt);
1217 dr->xprt = rqstp->rq_xprt;
1218 set_bit(RQ_DROPME, &rqstp->rq_flags);
1220 dr->handle.revisit = svc_revisit;
1221 trace_svc_defer(rqstp);
1226 * recv data from a deferred request into an active one
1228 static int svc_deferred_recv(struct svc_rqst *rqstp)
1230 struct svc_deferred_req *dr = rqstp->rq_deferred;
1232 /* setup iov_base past transport header */
1233 rqstp->rq_arg.head[0].iov_base = dr->args + (dr->xprt_hlen>>2);
1234 /* The iov_len does not include the transport header bytes */
1235 rqstp->rq_arg.head[0].iov_len = (dr->argslen<<2) - dr->xprt_hlen;
1236 rqstp->rq_arg.page_len = 0;
1237 /* The rq_arg.len includes the transport header bytes */
1238 rqstp->rq_arg.len = dr->argslen<<2;
1239 rqstp->rq_prot = dr->prot;
1240 memcpy(&rqstp->rq_addr, &dr->addr, dr->addrlen);
1241 rqstp->rq_addrlen = dr->addrlen;
1242 /* Save off transport header len in case we get deferred again */
1243 rqstp->rq_xprt_hlen = dr->xprt_hlen;
1244 rqstp->rq_daddr = dr->daddr;
1245 rqstp->rq_respages = rqstp->rq_pages;
1246 return (dr->argslen<<2) - dr->xprt_hlen;
1250 static struct svc_deferred_req *svc_deferred_dequeue(struct svc_xprt *xprt)
1252 struct svc_deferred_req *dr = NULL;
1254 if (!test_bit(XPT_DEFERRED, &xprt->xpt_flags))
1256 spin_lock(&xprt->xpt_lock);
1257 if (!list_empty(&xprt->xpt_deferred)) {
1258 dr = list_entry(xprt->xpt_deferred.next,
1259 struct svc_deferred_req,
1261 list_del_init(&dr->handle.recent);
1262 trace_svc_revisit_deferred(dr);
1264 clear_bit(XPT_DEFERRED, &xprt->xpt_flags);
1265 spin_unlock(&xprt->xpt_lock);
1270 * svc_find_xprt - find an RPC transport instance
1271 * @serv: pointer to svc_serv to search
1272 * @xcl_name: C string containing transport's class name
1273 * @net: owner net pointer
1274 * @af: Address family of transport's local address
1275 * @port: transport's IP port number
1277 * Return the transport instance pointer for the endpoint accepting
1278 * connections/peer traffic from the specified transport class,
1279 * address family and port.
1281 * Specifying 0 for the address family or port is effectively a
1282 * wild-card, and will result in matching the first transport in the
1283 * service's list that has a matching class name.
1285 struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name,
1286 struct net *net, const sa_family_t af,
1287 const unsigned short port)
1289 struct svc_xprt *xprt;
1290 struct svc_xprt *found = NULL;
1292 /* Sanity check the args */
1293 if (serv == NULL || xcl_name == NULL)
1296 spin_lock_bh(&serv->sv_lock);
1297 list_for_each_entry(xprt, &serv->sv_permsocks, xpt_list) {
1298 if (xprt->xpt_net != net)
1300 if (strcmp(xprt->xpt_class->xcl_name, xcl_name))
1302 if (af != AF_UNSPEC && af != xprt->xpt_local.ss_family)
1304 if (port != 0 && port != svc_xprt_local_port(xprt))
1310 spin_unlock_bh(&serv->sv_lock);
1313 EXPORT_SYMBOL_GPL(svc_find_xprt);
1315 static int svc_one_xprt_name(const struct svc_xprt *xprt,
1316 char *pos, int remaining)
1320 len = snprintf(pos, remaining, "%s %u\n",
1321 xprt->xpt_class->xcl_name,
1322 svc_xprt_local_port(xprt));
1323 if (len >= remaining)
1324 return -ENAMETOOLONG;
1329 * svc_xprt_names - format a buffer with a list of transport names
1330 * @serv: pointer to an RPC service
1331 * @buf: pointer to a buffer to be filled in
1332 * @buflen: length of buffer to be filled in
1334 * Fills in @buf with a string containing a list of transport names,
1335 * each name terminated with '\n'.
1337 * Returns positive length of the filled-in string on success; otherwise
1338 * a negative errno value is returned if an error occurs.
1340 int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen)
1342 struct svc_xprt *xprt;
1346 /* Sanity check args */
1350 spin_lock_bh(&serv->sv_lock);
1354 list_for_each_entry(xprt, &serv->sv_permsocks, xpt_list) {
1355 len = svc_one_xprt_name(xprt, pos, buflen - totlen);
1367 spin_unlock_bh(&serv->sv_lock);
1370 EXPORT_SYMBOL_GPL(svc_xprt_names);
1373 /*----------------------------------------------------------------------------*/
1375 static void *svc_pool_stats_start(struct seq_file *m, loff_t *pos)
1377 unsigned int pidx = (unsigned int)*pos;
1378 struct svc_serv *serv = m->private;
1380 dprintk("svc_pool_stats_start, *pidx=%u\n", pidx);
1383 return SEQ_START_TOKEN;
1384 return (pidx > serv->sv_nrpools ? NULL : &serv->sv_pools[pidx-1]);
1387 static void *svc_pool_stats_next(struct seq_file *m, void *p, loff_t *pos)
1389 struct svc_pool *pool = p;
1390 struct svc_serv *serv = m->private;
1392 dprintk("svc_pool_stats_next, *pos=%llu\n", *pos);
1394 if (p == SEQ_START_TOKEN) {
1395 pool = &serv->sv_pools[0];
1397 unsigned int pidx = (pool - &serv->sv_pools[0]);
1398 if (pidx < serv->sv_nrpools-1)
1399 pool = &serv->sv_pools[pidx+1];
1407 static void svc_pool_stats_stop(struct seq_file *m, void *p)
1411 static int svc_pool_stats_show(struct seq_file *m, void *p)
1413 struct svc_pool *pool = p;
1415 if (p == SEQ_START_TOKEN) {
1416 seq_puts(m, "# pool packets-arrived sockets-enqueued threads-woken threads-timedout\n");
1420 seq_printf(m, "%u %lu %lu %lu %lu\n",
1422 (unsigned long)atomic_long_read(&pool->sp_stats.packets),
1423 pool->sp_stats.sockets_queued,
1424 (unsigned long)atomic_long_read(&pool->sp_stats.threads_woken),
1425 (unsigned long)atomic_long_read(&pool->sp_stats.threads_timedout));
1430 static const struct seq_operations svc_pool_stats_seq_ops = {
1431 .start = svc_pool_stats_start,
1432 .next = svc_pool_stats_next,
1433 .stop = svc_pool_stats_stop,
1434 .show = svc_pool_stats_show,
1437 int svc_pool_stats_open(struct svc_serv *serv, struct file *file)
1441 err = seq_open(file, &svc_pool_stats_seq_ops);
1443 ((struct seq_file *) file->private_data)->private = serv;
1446 EXPORT_SYMBOL(svc_pool_stats_open);
1448 /*----------------------------------------------------------------------------*/