xref: /linux/include/linux/sunrpc/svcsock.h (revision b0319c4642638bad4b36974055b1c0894b2c7aa9)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * linux/include/linux/sunrpc/svcsock.h
4  *
5  * RPC server socket I/O.
6  *
7  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
8  */
9 
10 #ifndef SUNRPC_SVCSOCK_H
11 #define SUNRPC_SVCSOCK_H
12 
13 #include <linux/sunrpc/svc.h>
14 #include <linux/sunrpc/svc_xprt.h>
15 
16 /*
17  * RPC server socket.
18  */
19 struct svc_sock {
20 	struct svc_xprt		sk_xprt;
21 	struct socket *		sk_sock;	/* berkeley socket layer */
22 	struct sock *		sk_sk;		/* INET layer */
23 
24 	/* We keep the old state_change and data_ready CB's here */
25 	void			(*sk_ostate)(struct sock *);
26 	void			(*sk_odata)(struct sock *);
27 	void			(*sk_owspace)(struct sock *);
28 
29 	/* For sends (protected by xpt_mutex) */
30 	struct bio_vec		*sk_bvec;
31 
32 	/* private TCP part */
33 	/* On-the-wire fragment header: */
34 	__be32			sk_marker;
35 	/* As we receive a record, this includes the length received so
36 	 * far (including the fragment header): */
37 	u32			sk_tcplen;
38 	/* Total length of the data (not including fragment headers)
39 	 * received so far in the fragments making up this rpc: */
40 	u32			sk_datalen;
41 
42 	struct page_frag_cache  sk_frag_cache;
43 
44 	struct completion	sk_handshake_done;
45 
46 	/* received data */
47 	unsigned long		sk_maxpages;
48 	struct page *		sk_pages[] __counted_by(sk_maxpages);
49 };
50 
svc_sock_reclen(struct svc_sock * svsk)51 static inline u32 svc_sock_reclen(struct svc_sock *svsk)
52 {
53 	return be32_to_cpu(svsk->sk_marker) & RPC_FRAGMENT_SIZE_MASK;
54 }
55 
svc_sock_final_rec(struct svc_sock * svsk)56 static inline u32 svc_sock_final_rec(struct svc_sock *svsk)
57 {
58 	return be32_to_cpu(svsk->sk_marker) & RPC_LAST_STREAM_FRAGMENT;
59 }
60 
61 /*
62  * Function prototypes.
63  */
64 void		svc_recv(struct svc_rqst *rqstp);
65 void		svc_send(struct svc_rqst *rqstp);
66 int		svc_addsock(struct svc_serv *serv, struct net *net,
67 			    const int fd, char *name_return, const size_t len,
68 			    const struct cred *cred);
69 void		svc_init_xprt_sock(void);
70 void		svc_cleanup_xprt_sock(void);
71 
72 /*
73  * svc_makesock socket characteristics
74  */
75 #define SVC_SOCK_DEFAULTS	(0U)
76 #define SVC_SOCK_ANONYMOUS	(1U << 0)	/* don't register with pmap */
77 #define SVC_SOCK_TEMPORARY	(1U << 1)	/* flag socket as temporary */
78 
79 #endif /* SUNRPC_SVCSOCK_H */
80