2 * linux/net/sunrpc/svcsock.c
4 * These are the RPC server socket internals.
6 * The server scheduling algorithm does not always distribute the load
7 * evenly when servicing a single client. May need to modify the
8 * svc_xprt_enqueue procedure...
10 * TCP support is largely untested and may be a little slow. The problem
11 * is that we currently do two separate recvfrom's, one for the 4-byte
12 * record length, and the second for the actual record. This could possibly
13 * be improved by always reading a minimum size of around 100 bytes and
14 * tucking any superfluous bytes away in a temporary store. Still, that
15 * leaves write requests out in the rain. An alternative may be to peek at
16 * the first skb in the queue, and if it matches the next TCP sequence
17 * number, to extract the record marker. Yuck.
19 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
22 #include <linux/kernel.h>
23 #include <linux/sched.h>
24 #include <linux/errno.h>
25 #include <linux/fcntl.h>
26 #include <linux/net.h>
28 #include <linux/inet.h>
29 #include <linux/udp.h>
30 #include <linux/tcp.h>
31 #include <linux/unistd.h>
32 #include <linux/slab.h>
33 #include <linux/netdevice.h>
34 #include <linux/skbuff.h>
35 #include <linux/file.h>
36 #include <linux/freezer.h>
38 #include <net/checksum.h>
42 #include <net/tcp_states.h>
43 #include <asm/uaccess.h>
44 #include <asm/ioctls.h>
46 #include <linux/sunrpc/types.h>
47 #include <linux/sunrpc/clnt.h>
48 #include <linux/sunrpc/xdr.h>
49 #include <linux/sunrpc/msg_prot.h>
50 #include <linux/sunrpc/svcsock.h>
51 #include <linux/sunrpc/stats.h>
53 #define RPCDBG_FACILITY RPCDBG_SVCXPRT
56 static struct svc_sock
*svc_setup_socket(struct svc_serv
*, struct socket
*,
57 int *errp
, int flags
);
58 static void svc_udp_data_ready(struct sock
*, int);
59 static int svc_udp_recvfrom(struct svc_rqst
*);
60 static int svc_udp_sendto(struct svc_rqst
*);
61 static void svc_sock_detach(struct svc_xprt
*);
62 static void svc_tcp_sock_detach(struct svc_xprt
*);
63 static void svc_sock_free(struct svc_xprt
*);
65 static struct svc_xprt
*svc_create_socket(struct svc_serv
*, int,
66 struct sockaddr
*, int, int);
67 #ifdef CONFIG_DEBUG_LOCK_ALLOC
68 static struct lock_class_key svc_key
[2];
69 static struct lock_class_key svc_slock_key
[2];
71 static void svc_reclassify_socket(struct socket
*sock
)
73 struct sock
*sk
= sock
->sk
;
74 BUG_ON(sock_owned_by_user(sk
));
75 switch (sk
->sk_family
) {
77 sock_lock_init_class_and_name(sk
, "slock-AF_INET-NFSD",
79 "sk_xprt.xpt_lock-AF_INET-NFSD",
84 sock_lock_init_class_and_name(sk
, "slock-AF_INET6-NFSD",
86 "sk_xprt.xpt_lock-AF_INET6-NFSD",
95 static void svc_reclassify_socket(struct socket
*sock
)
101 * Release an skbuff after use
103 static void svc_release_skb(struct svc_rqst
*rqstp
)
105 struct sk_buff
*skb
= rqstp
->rq_xprt_ctxt
;
108 struct svc_sock
*svsk
=
109 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
110 rqstp
->rq_xprt_ctxt
= NULL
;
112 dprintk("svc: service %p, releasing skb %p\n", rqstp
, skb
);
113 skb_free_datagram(svsk
->sk_sk
, skb
);
117 union svc_pktinfo_u
{
118 struct in_pktinfo pkti
;
119 struct in6_pktinfo pkti6
;
121 #define SVC_PKTINFO_SPACE \
122 CMSG_SPACE(sizeof(union svc_pktinfo_u))
124 static void svc_set_cmsg_data(struct svc_rqst
*rqstp
, struct cmsghdr
*cmh
)
126 struct svc_sock
*svsk
=
127 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
128 switch (svsk
->sk_sk
->sk_family
) {
130 struct in_pktinfo
*pki
= CMSG_DATA(cmh
);
132 cmh
->cmsg_level
= SOL_IP
;
133 cmh
->cmsg_type
= IP_PKTINFO
;
134 pki
->ipi_ifindex
= 0;
135 pki
->ipi_spec_dst
.s_addr
= rqstp
->rq_daddr
.addr
.s_addr
;
136 cmh
->cmsg_len
= CMSG_LEN(sizeof(*pki
));
141 struct in6_pktinfo
*pki
= CMSG_DATA(cmh
);
143 cmh
->cmsg_level
= SOL_IPV6
;
144 cmh
->cmsg_type
= IPV6_PKTINFO
;
145 pki
->ipi6_ifindex
= 0;
146 ipv6_addr_copy(&pki
->ipi6_addr
,
147 &rqstp
->rq_daddr
.addr6
);
148 cmh
->cmsg_len
= CMSG_LEN(sizeof(*pki
));
156 * Generic sendto routine
158 static int svc_sendto(struct svc_rqst
*rqstp
, struct xdr_buf
*xdr
)
160 struct svc_sock
*svsk
=
161 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
162 struct socket
*sock
= svsk
->sk_sock
;
166 long all
[SVC_PKTINFO_SPACE
/ sizeof(long)];
168 struct cmsghdr
*cmh
= &buffer
.hdr
;
172 struct page
**ppage
= xdr
->pages
;
173 size_t base
= xdr
->page_base
;
174 unsigned int pglen
= xdr
->page_len
;
175 unsigned int flags
= MSG_MORE
;
176 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
180 if (rqstp
->rq_prot
== IPPROTO_UDP
) {
181 struct msghdr msg
= {
182 .msg_name
= &rqstp
->rq_addr
,
183 .msg_namelen
= rqstp
->rq_addrlen
,
185 .msg_controllen
= sizeof(buffer
),
186 .msg_flags
= MSG_MORE
,
189 svc_set_cmsg_data(rqstp
, cmh
);
191 if (sock_sendmsg(sock
, &msg
, 0) < 0)
196 if (slen
== xdr
->head
[0].iov_len
)
198 len
= kernel_sendpage(sock
, rqstp
->rq_respages
[0], 0,
199 xdr
->head
[0].iov_len
, flags
);
200 if (len
!= xdr
->head
[0].iov_len
)
202 slen
-= xdr
->head
[0].iov_len
;
207 size
= PAGE_SIZE
- base
< pglen
? PAGE_SIZE
- base
: pglen
;
211 result
= kernel_sendpage(sock
, *ppage
, base
, size
, flags
);
218 size
= PAGE_SIZE
< pglen
? PAGE_SIZE
: pglen
;
223 if (xdr
->tail
[0].iov_len
) {
224 result
= kernel_sendpage(sock
, rqstp
->rq_respages
[0],
225 ((unsigned long)xdr
->tail
[0].iov_base
)
227 xdr
->tail
[0].iov_len
, 0);
233 dprintk("svc: socket %p sendto([%p %Zu... ], %d) = %d (addr %s)\n",
234 svsk
, xdr
->head
[0].iov_base
, xdr
->head
[0].iov_len
,
235 xdr
->len
, len
, svc_print_addr(rqstp
, buf
, sizeof(buf
)));
241 * Report socket names for nfsdfs
243 static int svc_one_sock_name(struct svc_sock
*svsk
, char *buf
, int remaining
)
245 const struct sock
*sk
= svsk
->sk_sk
;
246 const char *proto_name
= sk
->sk_protocol
== IPPROTO_UDP
?
250 switch (sk
->sk_family
) {
252 len
= snprintf(buf
, remaining
, "ipv4 %s %pI4 %d\n",
254 &inet_sk(sk
)->rcv_saddr
,
258 len
= snprintf(buf
, remaining
, "ipv6 %s %pI6 %d\n",
260 &inet6_sk(sk
)->rcv_saddr
,
264 len
= snprintf(buf
, remaining
, "*unknown-%d*\n",
268 if (len
>= remaining
) {
270 return -ENAMETOOLONG
;
276 * svc_sock_names - construct a list of listener names in a string
277 * @serv: pointer to RPC service
278 * @buf: pointer to a buffer to fill in with socket names
279 * @buflen: size of the buffer to be filled
280 * @toclose: pointer to '\0'-terminated C string containing the name
281 * of a listener to be closed
283 * Fills in @buf with a '\n'-separated list of names of listener
284 * sockets. If @toclose is not NULL, the socket named by @toclose
285 * is closed, and is not included in the output list.
287 * Returns positive length of the socket name string, or a negative
288 * errno value on error.
290 int svc_sock_names(struct svc_serv
*serv
, char *buf
, const size_t buflen
,
293 struct svc_sock
*svsk
, *closesk
= NULL
;
299 spin_lock_bh(&serv
->sv_lock
);
300 list_for_each_entry(svsk
, &serv
->sv_permsocks
, sk_xprt
.xpt_list
) {
301 int onelen
= svc_one_sock_name(svsk
, buf
+ len
, buflen
- len
);
306 if (toclose
&& strcmp(toclose
, buf
+ len
) == 0)
311 spin_unlock_bh(&serv
->sv_lock
);
314 /* Should unregister with portmap, but you cannot
315 * unregister just one protocol...
317 svc_close_xprt(&closesk
->sk_xprt
);
322 EXPORT_SYMBOL_GPL(svc_sock_names
);
325 * Check input queue length
327 static int svc_recv_available(struct svc_sock
*svsk
)
329 struct socket
*sock
= svsk
->sk_sock
;
332 err
= kernel_sock_ioctl(sock
, TIOCINQ
, (unsigned long) &avail
);
334 return (err
>= 0)? avail
: err
;
338 * Generic recvfrom routine.
340 static int svc_recvfrom(struct svc_rqst
*rqstp
, struct kvec
*iov
, int nr
,
343 struct svc_sock
*svsk
=
344 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
345 struct msghdr msg
= {
346 .msg_flags
= MSG_DONTWAIT
,
350 rqstp
->rq_xprt_hlen
= 0;
352 len
= kernel_recvmsg(svsk
->sk_sock
, &msg
, iov
, nr
, buflen
,
355 dprintk("svc: socket %p recvfrom(%p, %Zu) = %d\n",
356 svsk
, iov
[0].iov_base
, iov
[0].iov_len
, len
);
361 * Set socket snd and rcv buffer lengths
363 static void svc_sock_setbufsize(struct socket
*sock
, unsigned int snd
,
368 oldfs
= get_fs(); set_fs(KERNEL_DS
);
369 sock_setsockopt(sock
, SOL_SOCKET
, SO_SNDBUF
,
370 (char*)&snd
, sizeof(snd
));
371 sock_setsockopt(sock
, SOL_SOCKET
, SO_RCVBUF
,
372 (char*)&rcv
, sizeof(rcv
));
374 /* sock_setsockopt limits use to sysctl_?mem_max,
375 * which isn't acceptable. Until that is made conditional
376 * on not having CAP_SYS_RESOURCE or similar, we go direct...
377 * DaveM said I could!
380 sock
->sk
->sk_sndbuf
= snd
* 2;
381 sock
->sk
->sk_rcvbuf
= rcv
* 2;
382 sock
->sk
->sk_userlocks
|= SOCK_SNDBUF_LOCK
|SOCK_RCVBUF_LOCK
;
383 sock
->sk
->sk_write_space(sock
->sk
);
384 release_sock(sock
->sk
);
388 * INET callback when data has been received on the socket.
390 static void svc_udp_data_ready(struct sock
*sk
, int count
)
392 struct svc_sock
*svsk
= (struct svc_sock
*)sk
->sk_user_data
;
395 dprintk("svc: socket %p(inet %p), count=%d, busy=%d\n",
397 test_bit(XPT_BUSY
, &svsk
->sk_xprt
.xpt_flags
));
398 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
399 svc_xprt_enqueue(&svsk
->sk_xprt
);
401 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
))
402 wake_up_interruptible(sk
->sk_sleep
);
406 * INET callback when space is newly available on the socket.
408 static void svc_write_space(struct sock
*sk
)
410 struct svc_sock
*svsk
= (struct svc_sock
*)(sk
->sk_user_data
);
413 dprintk("svc: socket %p(inet %p), write_space busy=%d\n",
414 svsk
, sk
, test_bit(XPT_BUSY
, &svsk
->sk_xprt
.xpt_flags
));
415 svc_xprt_enqueue(&svsk
->sk_xprt
);
418 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
)) {
419 dprintk("RPC svc_write_space: someone sleeping on %p\n",
421 wake_up_interruptible(sk
->sk_sleep
);
425 static void svc_tcp_write_space(struct sock
*sk
)
427 struct socket
*sock
= sk
->sk_socket
;
429 if (sk_stream_wspace(sk
) >= sk_stream_min_wspace(sk
) && sock
)
430 clear_bit(SOCK_NOSPACE
, &sock
->flags
);
435 * Copy the UDP datagram's destination address to the rqstp structure.
436 * The 'destination' address in this case is the address to which the
437 * peer sent the datagram, i.e. our local address. For multihomed
438 * hosts, this can change from msg to msg. Note that only the IP
439 * address changes, the port number should remain the same.
441 static void svc_udp_get_dest_address(struct svc_rqst
*rqstp
,
444 struct svc_sock
*svsk
=
445 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
446 switch (svsk
->sk_sk
->sk_family
) {
448 struct in_pktinfo
*pki
= CMSG_DATA(cmh
);
449 rqstp
->rq_daddr
.addr
.s_addr
= pki
->ipi_spec_dst
.s_addr
;
453 struct in6_pktinfo
*pki
= CMSG_DATA(cmh
);
454 ipv6_addr_copy(&rqstp
->rq_daddr
.addr6
, &pki
->ipi6_addr
);
461 * Receive a datagram from a UDP socket.
463 static int svc_udp_recvfrom(struct svc_rqst
*rqstp
)
465 struct svc_sock
*svsk
=
466 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
467 struct svc_serv
*serv
= svsk
->sk_xprt
.xpt_server
;
471 long all
[SVC_PKTINFO_SPACE
/ sizeof(long)];
473 struct cmsghdr
*cmh
= &buffer
.hdr
;
474 struct msghdr msg
= {
475 .msg_name
= svc_addr(rqstp
),
477 .msg_controllen
= sizeof(buffer
),
478 .msg_flags
= MSG_DONTWAIT
,
483 if (test_and_clear_bit(XPT_CHNGBUF
, &svsk
->sk_xprt
.xpt_flags
))
484 /* udp sockets need large rcvbuf as all pending
485 * requests are still in that buffer. sndbuf must
486 * also be large enough that there is enough space
487 * for one reply per thread. We count all threads
488 * rather than threads in a particular pool, which
489 * provides an upper bound on the number of threads
490 * which will access the socket.
492 svc_sock_setbufsize(svsk
->sk_sock
,
493 (serv
->sv_nrthreads
+3) * serv
->sv_max_mesg
,
494 (serv
->sv_nrthreads
+3) * serv
->sv_max_mesg
);
496 clear_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
498 err
= kernel_recvmsg(svsk
->sk_sock
, &msg
, NULL
,
499 0, 0, MSG_PEEK
| MSG_DONTWAIT
);
501 skb
= skb_recv_datagram(svsk
->sk_sk
, 0, 1, &err
);
504 if (err
!= -EAGAIN
) {
505 /* possibly an icmp error */
506 dprintk("svc: recvfrom returned error %d\n", -err
);
507 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
509 svc_xprt_received(&svsk
->sk_xprt
);
512 len
= svc_addr_len(svc_addr(rqstp
));
514 return -EAFNOSUPPORT
;
515 rqstp
->rq_addrlen
= len
;
516 if (skb
->tstamp
.tv64
== 0) {
517 skb
->tstamp
= ktime_get_real();
518 /* Don't enable netstamp, sunrpc doesn't
519 need that much accuracy */
521 svsk
->sk_sk
->sk_stamp
= skb
->tstamp
;
522 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
); /* there may be more data... */
525 * Maybe more packets - kick another thread ASAP.
527 svc_xprt_received(&svsk
->sk_xprt
);
529 len
= skb
->len
- sizeof(struct udphdr
);
530 rqstp
->rq_arg
.len
= len
;
532 rqstp
->rq_prot
= IPPROTO_UDP
;
534 if (cmh
->cmsg_level
!= IPPROTO_IP
||
535 cmh
->cmsg_type
!= IP_PKTINFO
) {
537 printk("rpcsvc: received unknown control message:"
539 cmh
->cmsg_level
, cmh
->cmsg_type
);
540 skb_free_datagram(svsk
->sk_sk
, skb
);
543 svc_udp_get_dest_address(rqstp
, cmh
);
545 if (skb_is_nonlinear(skb
)) {
546 /* we have to copy */
548 if (csum_partial_copy_to_xdr(&rqstp
->rq_arg
, skb
)) {
551 skb_free_datagram(svsk
->sk_sk
, skb
);
555 skb_free_datagram(svsk
->sk_sk
, skb
);
557 /* we can use it in-place */
558 rqstp
->rq_arg
.head
[0].iov_base
= skb
->data
+
559 sizeof(struct udphdr
);
560 rqstp
->rq_arg
.head
[0].iov_len
= len
;
561 if (skb_checksum_complete(skb
)) {
562 skb_free_datagram(svsk
->sk_sk
, skb
);
565 rqstp
->rq_xprt_ctxt
= skb
;
568 rqstp
->rq_arg
.page_base
= 0;
569 if (len
<= rqstp
->rq_arg
.head
[0].iov_len
) {
570 rqstp
->rq_arg
.head
[0].iov_len
= len
;
571 rqstp
->rq_arg
.page_len
= 0;
572 rqstp
->rq_respages
= rqstp
->rq_pages
+1;
574 rqstp
->rq_arg
.page_len
= len
- rqstp
->rq_arg
.head
[0].iov_len
;
575 rqstp
->rq_respages
= rqstp
->rq_pages
+ 1 +
576 DIV_ROUND_UP(rqstp
->rq_arg
.page_len
, PAGE_SIZE
);
580 serv
->sv_stats
->netudpcnt
++;
586 svc_udp_sendto(struct svc_rqst
*rqstp
)
590 error
= svc_sendto(rqstp
, &rqstp
->rq_res
);
591 if (error
== -ECONNREFUSED
)
592 /* ICMP error on earlier request. */
593 error
= svc_sendto(rqstp
, &rqstp
->rq_res
);
598 static void svc_udp_prep_reply_hdr(struct svc_rqst
*rqstp
)
602 static int svc_udp_has_wspace(struct svc_xprt
*xprt
)
604 struct svc_sock
*svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
605 struct svc_serv
*serv
= xprt
->xpt_server
;
606 unsigned long required
;
609 * Set the SOCK_NOSPACE flag before checking the available
612 set_bit(SOCK_NOSPACE
, &svsk
->sk_sock
->flags
);
613 required
= atomic_read(&svsk
->sk_xprt
.xpt_reserved
) + serv
->sv_max_mesg
;
614 if (required
*2 > sock_wspace(svsk
->sk_sk
))
616 clear_bit(SOCK_NOSPACE
, &svsk
->sk_sock
->flags
);
620 static struct svc_xprt
*svc_udp_accept(struct svc_xprt
*xprt
)
626 static struct svc_xprt
*svc_udp_create(struct svc_serv
*serv
,
627 struct sockaddr
*sa
, int salen
,
630 return svc_create_socket(serv
, IPPROTO_UDP
, sa
, salen
, flags
);
633 static struct svc_xprt_ops svc_udp_ops
= {
634 .xpo_create
= svc_udp_create
,
635 .xpo_recvfrom
= svc_udp_recvfrom
,
636 .xpo_sendto
= svc_udp_sendto
,
637 .xpo_release_rqst
= svc_release_skb
,
638 .xpo_detach
= svc_sock_detach
,
639 .xpo_free
= svc_sock_free
,
640 .xpo_prep_reply_hdr
= svc_udp_prep_reply_hdr
,
641 .xpo_has_wspace
= svc_udp_has_wspace
,
642 .xpo_accept
= svc_udp_accept
,
645 static struct svc_xprt_class svc_udp_class
= {
647 .xcl_owner
= THIS_MODULE
,
648 .xcl_ops
= &svc_udp_ops
,
649 .xcl_max_payload
= RPCSVC_MAXPAYLOAD_UDP
,
652 static void svc_udp_init(struct svc_sock
*svsk
, struct svc_serv
*serv
)
657 svc_xprt_init(&svc_udp_class
, &svsk
->sk_xprt
, serv
);
658 clear_bit(XPT_CACHE_AUTH
, &svsk
->sk_xprt
.xpt_flags
);
659 svsk
->sk_sk
->sk_data_ready
= svc_udp_data_ready
;
660 svsk
->sk_sk
->sk_write_space
= svc_write_space
;
662 /* initialise setting must have enough space to
663 * receive and respond to one request.
664 * svc_udp_recvfrom will re-adjust if necessary
666 svc_sock_setbufsize(svsk
->sk_sock
,
667 3 * svsk
->sk_xprt
.xpt_server
->sv_max_mesg
,
668 3 * svsk
->sk_xprt
.xpt_server
->sv_max_mesg
);
670 /* data might have come in before data_ready set up */
671 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
672 set_bit(XPT_CHNGBUF
, &svsk
->sk_xprt
.xpt_flags
);
676 /* make sure we get destination address info */
677 svsk
->sk_sock
->ops
->setsockopt(svsk
->sk_sock
, IPPROTO_IP
, IP_PKTINFO
,
678 (char __user
*)&one
, sizeof(one
));
683 * A data_ready event on a listening socket means there's a connection
684 * pending. Do not use state_change as a substitute for it.
686 static void svc_tcp_listen_data_ready(struct sock
*sk
, int count_unused
)
688 struct svc_sock
*svsk
= (struct svc_sock
*)sk
->sk_user_data
;
690 dprintk("svc: socket %p TCP (listen) state change %d\n",
694 * This callback may called twice when a new connection
695 * is established as a child socket inherits everything
696 * from a parent LISTEN socket.
697 * 1) data_ready method of the parent socket will be called
698 * when one of child sockets become ESTABLISHED.
699 * 2) data_ready method of the child socket may be called
700 * when it receives data before the socket is accepted.
701 * In case of 2, we should ignore it silently.
703 if (sk
->sk_state
== TCP_LISTEN
) {
705 set_bit(XPT_CONN
, &svsk
->sk_xprt
.xpt_flags
);
706 svc_xprt_enqueue(&svsk
->sk_xprt
);
708 printk("svc: socket %p: no user data\n", sk
);
711 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
))
712 wake_up_interruptible_all(sk
->sk_sleep
);
716 * A state change on a connected socket means it's dying or dead.
718 static void svc_tcp_state_change(struct sock
*sk
)
720 struct svc_sock
*svsk
= (struct svc_sock
*)sk
->sk_user_data
;
722 dprintk("svc: socket %p TCP (connected) state change %d (svsk %p)\n",
723 sk
, sk
->sk_state
, sk
->sk_user_data
);
726 printk("svc: socket %p: no user data\n", sk
);
728 set_bit(XPT_CLOSE
, &svsk
->sk_xprt
.xpt_flags
);
729 svc_xprt_enqueue(&svsk
->sk_xprt
);
731 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
))
732 wake_up_interruptible_all(sk
->sk_sleep
);
735 static void svc_tcp_data_ready(struct sock
*sk
, int count
)
737 struct svc_sock
*svsk
= (struct svc_sock
*)sk
->sk_user_data
;
739 dprintk("svc: socket %p TCP data ready (svsk %p)\n",
740 sk
, sk
->sk_user_data
);
742 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
743 svc_xprt_enqueue(&svsk
->sk_xprt
);
745 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
))
746 wake_up_interruptible(sk
->sk_sleep
);
750 * Accept a TCP connection
752 static struct svc_xprt
*svc_tcp_accept(struct svc_xprt
*xprt
)
754 struct svc_sock
*svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
755 struct sockaddr_storage addr
;
756 struct sockaddr
*sin
= (struct sockaddr
*) &addr
;
757 struct svc_serv
*serv
= svsk
->sk_xprt
.xpt_server
;
758 struct socket
*sock
= svsk
->sk_sock
;
759 struct socket
*newsock
;
760 struct svc_sock
*newsvsk
;
762 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
764 dprintk("svc: tcp_accept %p sock %p\n", svsk
, sock
);
768 clear_bit(XPT_CONN
, &svsk
->sk_xprt
.xpt_flags
);
769 err
= kernel_accept(sock
, &newsock
, O_NONBLOCK
);
772 printk(KERN_WARNING
"%s: no more sockets!\n",
774 else if (err
!= -EAGAIN
&& net_ratelimit())
775 printk(KERN_WARNING
"%s: accept failed (err %d)!\n",
776 serv
->sv_name
, -err
);
779 set_bit(XPT_CONN
, &svsk
->sk_xprt
.xpt_flags
);
781 err
= kernel_getpeername(newsock
, sin
, &slen
);
784 printk(KERN_WARNING
"%s: peername failed (err %d)!\n",
785 serv
->sv_name
, -err
);
786 goto failed
; /* aborted connection or whatever */
789 /* Ideally, we would want to reject connections from unauthorized
790 * hosts here, but when we get encryption, the IP of the host won't
791 * tell us anything. For now just warn about unpriv connections.
793 if (!svc_port_is_privileged(sin
)) {
795 "%s: connect from unprivileged port: %s\n",
797 __svc_print_addr(sin
, buf
, sizeof(buf
)));
799 dprintk("%s: connect from %s\n", serv
->sv_name
,
800 __svc_print_addr(sin
, buf
, sizeof(buf
)));
802 /* make sure that a write doesn't block forever when
805 newsock
->sk
->sk_sndtimeo
= HZ
*30;
807 if (!(newsvsk
= svc_setup_socket(serv
, newsock
, &err
,
808 (SVC_SOCK_ANONYMOUS
| SVC_SOCK_TEMPORARY
))))
810 svc_xprt_set_remote(&newsvsk
->sk_xprt
, sin
, slen
);
811 err
= kernel_getsockname(newsock
, sin
, &slen
);
812 if (unlikely(err
< 0)) {
813 dprintk("svc_tcp_accept: kernel_getsockname error %d\n", -err
);
814 slen
= offsetof(struct sockaddr
, sa_data
);
816 svc_xprt_set_local(&newsvsk
->sk_xprt
, sin
, slen
);
819 serv
->sv_stats
->nettcpconn
++;
821 return &newsvsk
->sk_xprt
;
824 sock_release(newsock
);
829 * Receive data from a TCP socket.
831 static int svc_tcp_recvfrom(struct svc_rqst
*rqstp
)
833 struct svc_sock
*svsk
=
834 container_of(rqstp
->rq_xprt
, struct svc_sock
, sk_xprt
);
835 struct svc_serv
*serv
= svsk
->sk_xprt
.xpt_server
;
840 dprintk("svc: tcp_recv %p data %d conn %d close %d\n",
841 svsk
, test_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
),
842 test_bit(XPT_CONN
, &svsk
->sk_xprt
.xpt_flags
),
843 test_bit(XPT_CLOSE
, &svsk
->sk_xprt
.xpt_flags
));
845 if (test_and_clear_bit(XPT_CHNGBUF
, &svsk
->sk_xprt
.xpt_flags
))
846 /* sndbuf needs to have room for one request
847 * per thread, otherwise we can stall even when the
848 * network isn't a bottleneck.
850 * We count all threads rather than threads in a
851 * particular pool, which provides an upper bound
852 * on the number of threads which will access the socket.
854 * rcvbuf just needs to be able to hold a few requests.
855 * Normally they will be removed from the queue
856 * as soon a a complete request arrives.
858 svc_sock_setbufsize(svsk
->sk_sock
,
859 (serv
->sv_nrthreads
+3) * serv
->sv_max_mesg
,
860 3 * serv
->sv_max_mesg
);
862 clear_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
864 /* Receive data. If we haven't got the record length yet, get
865 * the next four bytes. Otherwise try to gobble up as much as
866 * possible up to the complete record length.
868 if (svsk
->sk_tcplen
< sizeof(rpc_fraghdr
)) {
869 int want
= sizeof(rpc_fraghdr
) - svsk
->sk_tcplen
;
872 iov
.iov_base
= ((char *) &svsk
->sk_reclen
) + svsk
->sk_tcplen
;
874 if ((len
= svc_recvfrom(rqstp
, &iov
, 1, want
)) < 0)
876 svsk
->sk_tcplen
+= len
;
879 dprintk("svc: short recvfrom while reading record "
880 "length (%d of %d)\n", len
, want
);
881 svc_xprt_received(&svsk
->sk_xprt
);
882 return -EAGAIN
; /* record header not complete */
885 svsk
->sk_reclen
= ntohl(svsk
->sk_reclen
);
886 if (!(svsk
->sk_reclen
& RPC_LAST_STREAM_FRAGMENT
)) {
887 /* FIXME: technically, a record can be fragmented,
888 * and non-terminal fragments will not have the top
889 * bit set in the fragment length header.
890 * But apparently no known nfs clients send fragmented
893 printk(KERN_NOTICE
"RPC: multiple fragments "
894 "per record not supported\n");
897 svsk
->sk_reclen
&= RPC_FRAGMENT_SIZE_MASK
;
898 dprintk("svc: TCP record, %d bytes\n", svsk
->sk_reclen
);
899 if (svsk
->sk_reclen
> serv
->sv_max_mesg
) {
901 printk(KERN_NOTICE
"RPC: "
902 "fragment too large: 0x%08lx\n",
903 (unsigned long)svsk
->sk_reclen
);
908 /* Check whether enough data is available */
909 len
= svc_recv_available(svsk
);
913 if (len
< svsk
->sk_reclen
) {
914 dprintk("svc: incomplete TCP record (%d of %d)\n",
915 len
, svsk
->sk_reclen
);
916 svc_xprt_received(&svsk
->sk_xprt
);
917 return -EAGAIN
; /* record not complete */
919 len
= svsk
->sk_reclen
;
920 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
923 vec
[0] = rqstp
->rq_arg
.head
[0];
927 vec
[pnum
].iov_base
= page_address(rqstp
->rq_pages
[pnum
]);
928 vec
[pnum
].iov_len
= PAGE_SIZE
;
932 rqstp
->rq_respages
= &rqstp
->rq_pages
[pnum
];
934 /* Now receive data */
935 len
= svc_recvfrom(rqstp
, vec
, pnum
, len
);
939 dprintk("svc: TCP complete record (%d bytes)\n", len
);
940 rqstp
->rq_arg
.len
= len
;
941 rqstp
->rq_arg
.page_base
= 0;
942 if (len
<= rqstp
->rq_arg
.head
[0].iov_len
) {
943 rqstp
->rq_arg
.head
[0].iov_len
= len
;
944 rqstp
->rq_arg
.page_len
= 0;
946 rqstp
->rq_arg
.page_len
= len
- rqstp
->rq_arg
.head
[0].iov_len
;
949 rqstp
->rq_xprt_ctxt
= NULL
;
950 rqstp
->rq_prot
= IPPROTO_TCP
;
952 /* Reset TCP read info */
956 svc_xprt_copy_addrs(rqstp
, &svsk
->sk_xprt
);
957 svc_xprt_received(&svsk
->sk_xprt
);
959 serv
->sv_stats
->nettcpcnt
++;
964 set_bit(XPT_CLOSE
, &svsk
->sk_xprt
.xpt_flags
);
968 if (len
== -EAGAIN
) {
969 dprintk("RPC: TCP recvfrom got EAGAIN\n");
970 svc_xprt_received(&svsk
->sk_xprt
);
972 printk(KERN_NOTICE
"%s: recvfrom returned errno %d\n",
973 svsk
->sk_xprt
.xpt_server
->sv_name
, -len
);
981 * Send out data on TCP socket.
983 static int svc_tcp_sendto(struct svc_rqst
*rqstp
)
985 struct xdr_buf
*xbufp
= &rqstp
->rq_res
;
989 /* Set up the first element of the reply kvec.
990 * Any other kvecs that may be in use have been taken
991 * care of by the server implementation itself.
993 reclen
= htonl(0x80000000|((xbufp
->len
) - 4));
994 memcpy(xbufp
->head
[0].iov_base
, &reclen
, 4);
996 if (test_bit(XPT_DEAD
, &rqstp
->rq_xprt
->xpt_flags
))
999 sent
= svc_sendto(rqstp
, &rqstp
->rq_res
);
1000 if (sent
!= xbufp
->len
) {
1002 "rpc-srv/tcp: %s: %s %d when sending %d bytes "
1003 "- shutting down socket\n",
1004 rqstp
->rq_xprt
->xpt_server
->sv_name
,
1005 (sent
<0)?"got error":"sent only",
1007 set_bit(XPT_CLOSE
, &rqstp
->rq_xprt
->xpt_flags
);
1008 svc_xprt_enqueue(rqstp
->rq_xprt
);
1015 * Setup response header. TCP has a 4B record length field.
1017 static void svc_tcp_prep_reply_hdr(struct svc_rqst
*rqstp
)
1019 struct kvec
*resv
= &rqstp
->rq_res
.head
[0];
1021 /* tcp needs a space for the record length... */
1025 static int svc_tcp_has_wspace(struct svc_xprt
*xprt
)
1027 struct svc_sock
*svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
1028 struct svc_serv
*serv
= svsk
->sk_xprt
.xpt_server
;
1031 if (test_bit(XPT_LISTENER
, &xprt
->xpt_flags
))
1033 required
= atomic_read(&xprt
->xpt_reserved
) + serv
->sv_max_mesg
;
1034 if (sk_stream_wspace(svsk
->sk_sk
) >= required
)
1036 set_bit(SOCK_NOSPACE
, &svsk
->sk_sock
->flags
);
1040 static struct svc_xprt
*svc_tcp_create(struct svc_serv
*serv
,
1041 struct sockaddr
*sa
, int salen
,
1044 return svc_create_socket(serv
, IPPROTO_TCP
, sa
, salen
, flags
);
1047 static struct svc_xprt_ops svc_tcp_ops
= {
1048 .xpo_create
= svc_tcp_create
,
1049 .xpo_recvfrom
= svc_tcp_recvfrom
,
1050 .xpo_sendto
= svc_tcp_sendto
,
1051 .xpo_release_rqst
= svc_release_skb
,
1052 .xpo_detach
= svc_tcp_sock_detach
,
1053 .xpo_free
= svc_sock_free
,
1054 .xpo_prep_reply_hdr
= svc_tcp_prep_reply_hdr
,
1055 .xpo_has_wspace
= svc_tcp_has_wspace
,
1056 .xpo_accept
= svc_tcp_accept
,
1059 static struct svc_xprt_class svc_tcp_class
= {
1061 .xcl_owner
= THIS_MODULE
,
1062 .xcl_ops
= &svc_tcp_ops
,
1063 .xcl_max_payload
= RPCSVC_MAXPAYLOAD_TCP
,
1066 void svc_init_xprt_sock(void)
1068 svc_reg_xprt_class(&svc_tcp_class
);
1069 svc_reg_xprt_class(&svc_udp_class
);
1072 void svc_cleanup_xprt_sock(void)
1074 svc_unreg_xprt_class(&svc_tcp_class
);
1075 svc_unreg_xprt_class(&svc_udp_class
);
1078 static void svc_tcp_init(struct svc_sock
*svsk
, struct svc_serv
*serv
)
1080 struct sock
*sk
= svsk
->sk_sk
;
1082 svc_xprt_init(&svc_tcp_class
, &svsk
->sk_xprt
, serv
);
1083 set_bit(XPT_CACHE_AUTH
, &svsk
->sk_xprt
.xpt_flags
);
1084 if (sk
->sk_state
== TCP_LISTEN
) {
1085 dprintk("setting up TCP socket for listening\n");
1086 set_bit(XPT_LISTENER
, &svsk
->sk_xprt
.xpt_flags
);
1087 sk
->sk_data_ready
= svc_tcp_listen_data_ready
;
1088 set_bit(XPT_CONN
, &svsk
->sk_xprt
.xpt_flags
);
1090 dprintk("setting up TCP socket for reading\n");
1091 sk
->sk_state_change
= svc_tcp_state_change
;
1092 sk
->sk_data_ready
= svc_tcp_data_ready
;
1093 sk
->sk_write_space
= svc_tcp_write_space
;
1095 svsk
->sk_reclen
= 0;
1096 svsk
->sk_tcplen
= 0;
1098 tcp_sk(sk
)->nonagle
|= TCP_NAGLE_OFF
;
1100 /* initialise setting must have enough space to
1101 * receive and respond to one request.
1102 * svc_tcp_recvfrom will re-adjust if necessary
1104 svc_sock_setbufsize(svsk
->sk_sock
,
1105 3 * svsk
->sk_xprt
.xpt_server
->sv_max_mesg
,
1106 3 * svsk
->sk_xprt
.xpt_server
->sv_max_mesg
);
1108 set_bit(XPT_CHNGBUF
, &svsk
->sk_xprt
.xpt_flags
);
1109 set_bit(XPT_DATA
, &svsk
->sk_xprt
.xpt_flags
);
1110 if (sk
->sk_state
!= TCP_ESTABLISHED
)
1111 set_bit(XPT_CLOSE
, &svsk
->sk_xprt
.xpt_flags
);
1115 void svc_sock_update_bufs(struct svc_serv
*serv
)
1118 * The number of server threads has changed. Update
1119 * rcvbuf and sndbuf accordingly on all sockets
1121 struct list_head
*le
;
1123 spin_lock_bh(&serv
->sv_lock
);
1124 list_for_each(le
, &serv
->sv_permsocks
) {
1125 struct svc_sock
*svsk
=
1126 list_entry(le
, struct svc_sock
, sk_xprt
.xpt_list
);
1127 set_bit(XPT_CHNGBUF
, &svsk
->sk_xprt
.xpt_flags
);
1129 list_for_each(le
, &serv
->sv_tempsocks
) {
1130 struct svc_sock
*svsk
=
1131 list_entry(le
, struct svc_sock
, sk_xprt
.xpt_list
);
1132 set_bit(XPT_CHNGBUF
, &svsk
->sk_xprt
.xpt_flags
);
1134 spin_unlock_bh(&serv
->sv_lock
);
1136 EXPORT_SYMBOL_GPL(svc_sock_update_bufs
);
1139 * Initialize socket for RPC use and create svc_sock struct
1140 * XXX: May want to setsockopt SO_SNDBUF and SO_RCVBUF.
1142 static struct svc_sock
*svc_setup_socket(struct svc_serv
*serv
,
1143 struct socket
*sock
,
1144 int *errp
, int flags
)
1146 struct svc_sock
*svsk
;
1148 int pmap_register
= !(flags
& SVC_SOCK_ANONYMOUS
);
1150 dprintk("svc: svc_setup_socket %p\n", sock
);
1151 if (!(svsk
= kzalloc(sizeof(*svsk
), GFP_KERNEL
))) {
1158 /* Register socket with portmapper */
1159 if (*errp
>= 0 && pmap_register
)
1160 *errp
= svc_register(serv
, inet
->sk_family
, inet
->sk_protocol
,
1161 ntohs(inet_sk(inet
)->sport
));
1168 inet
->sk_user_data
= svsk
;
1169 svsk
->sk_sock
= sock
;
1171 svsk
->sk_ostate
= inet
->sk_state_change
;
1172 svsk
->sk_odata
= inet
->sk_data_ready
;
1173 svsk
->sk_owspace
= inet
->sk_write_space
;
1175 /* Initialize the socket */
1176 if (sock
->type
== SOCK_DGRAM
)
1177 svc_udp_init(svsk
, serv
);
1179 svc_tcp_init(svsk
, serv
);
1181 dprintk("svc: svc_setup_socket created %p (inet %p)\n",
1188 * svc_addsock - add a listener socket to an RPC service
1189 * @serv: pointer to RPC service to which to add a new listener
1190 * @fd: file descriptor of the new listener
1191 * @name_return: pointer to buffer to fill in with name of listener
1192 * @len: size of the buffer
1194 * Fills in socket name and returns positive length of name if successful.
1195 * Name is terminated with '\n'. On error, returns a negative errno
1198 int svc_addsock(struct svc_serv
*serv
, const int fd
, char *name_return
,
1202 struct socket
*so
= sockfd_lookup(fd
, &err
);
1203 struct svc_sock
*svsk
= NULL
;
1207 if (so
->sk
->sk_family
!= AF_INET
)
1208 err
= -EAFNOSUPPORT
;
1209 else if (so
->sk
->sk_protocol
!= IPPROTO_TCP
&&
1210 so
->sk
->sk_protocol
!= IPPROTO_UDP
)
1211 err
= -EPROTONOSUPPORT
;
1212 else if (so
->state
> SS_UNCONNECTED
)
1215 if (!try_module_get(THIS_MODULE
))
1218 svsk
= svc_setup_socket(serv
, so
, &err
,
1221 struct sockaddr_storage addr
;
1222 struct sockaddr
*sin
= (struct sockaddr
*)&addr
;
1224 if (kernel_getsockname(svsk
->sk_sock
, sin
, &salen
) == 0)
1225 svc_xprt_set_local(&svsk
->sk_xprt
, sin
, salen
);
1226 clear_bit(XPT_TEMP
, &svsk
->sk_xprt
.xpt_flags
);
1227 spin_lock_bh(&serv
->sv_lock
);
1228 list_add(&svsk
->sk_xprt
.xpt_list
, &serv
->sv_permsocks
);
1229 spin_unlock_bh(&serv
->sv_lock
);
1230 svc_xprt_received(&svsk
->sk_xprt
);
1233 module_put(THIS_MODULE
);
1239 return svc_one_sock_name(svsk
, name_return
, len
);
1241 EXPORT_SYMBOL_GPL(svc_addsock
);
1244 * Create socket for RPC service.
1246 static struct svc_xprt
*svc_create_socket(struct svc_serv
*serv
,
1248 struct sockaddr
*sin
, int len
,
1251 struct svc_sock
*svsk
;
1252 struct socket
*sock
;
1255 struct sockaddr_storage addr
;
1256 struct sockaddr
*newsin
= (struct sockaddr
*)&addr
;
1260 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
1262 dprintk("svc: svc_create_socket(%s, %d, %s)\n",
1263 serv
->sv_program
->pg_name
, protocol
,
1264 __svc_print_addr(sin
, buf
, sizeof(buf
)));
1266 if (protocol
!= IPPROTO_UDP
&& protocol
!= IPPROTO_TCP
) {
1267 printk(KERN_WARNING
"svc: only UDP and TCP "
1268 "sockets supported\n");
1269 return ERR_PTR(-EINVAL
);
1272 type
= (protocol
== IPPROTO_UDP
)? SOCK_DGRAM
: SOCK_STREAM
;
1273 switch (sin
->sa_family
) {
1281 return ERR_PTR(-EINVAL
);
1284 error
= sock_create_kern(family
, type
, protocol
, &sock
);
1286 return ERR_PTR(error
);
1288 svc_reclassify_socket(sock
);
1291 * If this is an PF_INET6 listener, we want to avoid
1292 * getting requests from IPv4 remotes. Those should
1293 * be shunted to a PF_INET listener via rpcbind.
1296 if (family
== PF_INET6
)
1297 kernel_setsockopt(sock
, SOL_IPV6
, IPV6_V6ONLY
,
1298 (char *)&val
, sizeof(val
));
1300 if (type
== SOCK_STREAM
)
1301 sock
->sk
->sk_reuse
= 1; /* allow address reuse */
1302 error
= kernel_bind(sock
, sin
, len
);
1307 error
= kernel_getsockname(sock
, newsin
, &newlen
);
1311 if (protocol
== IPPROTO_TCP
) {
1312 if ((error
= kernel_listen(sock
, 64)) < 0)
1316 if ((svsk
= svc_setup_socket(serv
, sock
, &error
, flags
)) != NULL
) {
1317 svc_xprt_set_local(&svsk
->sk_xprt
, newsin
, newlen
);
1318 return (struct svc_xprt
*)svsk
;
1322 dprintk("svc: svc_create_socket error = %d\n", -error
);
1324 return ERR_PTR(error
);
1328 * Detach the svc_sock from the socket so that no
1329 * more callbacks occur.
1331 static void svc_sock_detach(struct svc_xprt
*xprt
)
1333 struct svc_sock
*svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
1334 struct sock
*sk
= svsk
->sk_sk
;
1336 dprintk("svc: svc_sock_detach(%p)\n", svsk
);
1338 /* put back the old socket callbacks */
1339 sk
->sk_state_change
= svsk
->sk_ostate
;
1340 sk
->sk_data_ready
= svsk
->sk_odata
;
1341 sk
->sk_write_space
= svsk
->sk_owspace
;
1343 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
))
1344 wake_up_interruptible(sk
->sk_sleep
);
1348 * Disconnect the socket, and reset the callbacks
1350 static void svc_tcp_sock_detach(struct svc_xprt
*xprt
)
1352 struct svc_sock
*svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
1354 dprintk("svc: svc_tcp_sock_detach(%p)\n", svsk
);
1356 svc_sock_detach(xprt
);
1358 if (!test_bit(XPT_LISTENER
, &xprt
->xpt_flags
))
1359 kernel_sock_shutdown(svsk
->sk_sock
, SHUT_RDWR
);
1363 * Free the svc_sock's socket resources and the svc_sock itself.
1365 static void svc_sock_free(struct svc_xprt
*xprt
)
1367 struct svc_sock
*svsk
= container_of(xprt
, struct svc_sock
, sk_xprt
);
1368 dprintk("svc: svc_sock_free(%p)\n", svsk
);
1370 if (svsk
->sk_sock
->file
)
1371 sockfd_put(svsk
->sk_sock
);
1373 sock_release(svsk
->sk_sock
);
1378 * Create a svc_xprt.
1380 * For internal use only (e.g. nfsv4.1 backchannel).
1381 * Callers should typically use the xpo_create() method.
1383 struct svc_xprt
*svc_sock_create(struct svc_serv
*serv
, int prot
)
1385 struct svc_sock
*svsk
;
1386 struct svc_xprt
*xprt
= NULL
;
1388 dprintk("svc: %s\n", __func__
);
1389 svsk
= kzalloc(sizeof(*svsk
), GFP_KERNEL
);
1393 xprt
= &svsk
->sk_xprt
;
1394 if (prot
== IPPROTO_TCP
)
1395 svc_xprt_init(&svc_tcp_class
, xprt
, serv
);
1396 else if (prot
== IPPROTO_UDP
)
1397 svc_xprt_init(&svc_udp_class
, xprt
, serv
);
1401 dprintk("svc: %s return %p\n", __func__
, xprt
);
1404 EXPORT_SYMBOL_GPL(svc_sock_create
);
1407 * Destroy a svc_sock.
1409 void svc_sock_destroy(struct svc_xprt
*xprt
)
1412 kfree(container_of(xprt
, struct svc_sock
, sk_xprt
));
1414 EXPORT_SYMBOL_GPL(svc_sock_destroy
);