xref: /linux-6.15/include/linux/sunrpc/svcsock.h (revision ba6e8564)
1 /*
2  * linux/include/linux/sunrpc/svcsock.h
3  *
4  * RPC server socket I/O.
5  *
6  * Copyright (C) 1995, 1996 Olaf Kirch <[email protected]>
7  */
8 
9 #ifndef SUNRPC_SVCSOCK_H
10 #define SUNRPC_SVCSOCK_H
11 
12 #include <linux/sunrpc/svc.h>
13 
14 /*
15  * RPC server socket.
16  */
17 struct svc_sock {
18 	struct list_head	sk_ready;	/* list of ready sockets */
19 	struct list_head	sk_list;	/* list of all sockets */
20 	struct socket *		sk_sock;	/* berkeley socket layer */
21 	struct sock *		sk_sk;		/* INET layer */
22 
23 	struct svc_pool *	sk_pool;	/* current pool iff queued */
24 	struct svc_serv *	sk_server;	/* service for this socket */
25 	atomic_t		sk_inuse;	/* use count */
26 	unsigned long		sk_flags;
27 #define	SK_BUSY		0			/* enqueued/receiving */
28 #define	SK_CONN		1			/* conn pending */
29 #define	SK_CLOSE	2			/* dead or dying */
30 #define	SK_DATA		3			/* data pending */
31 #define	SK_TEMP		4			/* temp (TCP) socket */
32 #define	SK_DEAD		6			/* socket closed */
33 #define	SK_CHNGBUF	7			/* need to change snd/rcv buffer sizes */
34 #define	SK_DEFERRED	8			/* request on sk_deferred */
35 #define	SK_OLD		9			/* used for temp socket aging mark+sweep */
36 #define	SK_DETACHED	10			/* detached from tempsocks list */
37 
38 	atomic_t    	    	sk_reserved;	/* space on outq that is reserved */
39 
40 	spinlock_t		sk_defer_lock;	/* protects sk_deferred */
41 	struct list_head	sk_deferred;	/* deferred requests that need to
42 						 * be revisted */
43 	struct mutex		sk_mutex;	/* to serialize sending data */
44 
45 	int			(*sk_recvfrom)(struct svc_rqst *rqstp);
46 	int			(*sk_sendto)(struct svc_rqst *rqstp);
47 
48 	/* We keep the old state_change and data_ready CB's here */
49 	void			(*sk_ostate)(struct sock *);
50 	void			(*sk_odata)(struct sock *, int bytes);
51 	void			(*sk_owspace)(struct sock *);
52 
53 	/* private TCP part */
54 	int			sk_reclen;	/* length of record */
55 	int			sk_tcplen;	/* current read length */
56 	time_t			sk_lastrecv;	/* time of last received request */
57 
58 	/* cache of various info for TCP sockets */
59 	void			*sk_info_authunix;
60 
61 	struct sockaddr_storage	sk_remote;	/* remote peer's address */
62 	int			sk_remotelen;	/* length of address */
63 };
64 
65 /*
66  * Function prototypes.
67  */
68 int		svc_makesock(struct svc_serv *, int, unsigned short, int flags);
69 void		svc_force_close_socket(struct svc_sock *);
70 int		svc_recv(struct svc_rqst *, long);
71 int		svc_send(struct svc_rqst *);
72 void		svc_drop(struct svc_rqst *);
73 void		svc_sock_update_bufs(struct svc_serv *serv);
74 int		svc_sock_names(char *buf, struct svc_serv *serv, char *toclose);
75 int		svc_addsock(struct svc_serv *serv,
76 			    int fd,
77 			    char *name_return,
78 			    int *proto);
79 
80 /*
81  * svc_makesock socket characteristics
82  */
83 #define SVC_SOCK_DEFAULTS	(0U)
84 #define SVC_SOCK_ANONYMOUS	(1U << 0)	/* don't register with pmap */
85 #define SVC_SOCK_TEMPORARY	(1U << 1)	/* flag socket as temporary */
86 
87 #endif /* SUNRPC_SVCSOCK_H */
88