krpc.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2009, Sun Microsystems, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * - Redistributions of source code must retain the above copyright notice,
10 *   this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright notice,
12 *   this list of conditions and the following disclaimer in the documentation
13 *   and/or other materials provided with the distribution.
14 * - Neither the name of Sun Microsystems, Inc. nor the names of its
15 *   contributors may be used to endorse or promote products derived
16 *   from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 *
30 * $FreeBSD: stable/11/sys/rpc/krpc.h 330897 2018-03-14 03:19:51Z eadler $
31 */
32
33#ifndef _RPC_KRPC_H_
34#define	_RPC_KRPC_H_
35
36#ifdef _KERNEL
37/*
38 * Definitions now shared between client and server RPC for backchannels.
39 */
40#define MCALL_MSG_SIZE 24
41
42void clnt_bck_svccall(void *, struct mbuf *, uint32_t);
43enum clnt_stat clnt_bck_call(CLIENT *, struct rpc_callextra *, rpcproc_t,
44    struct mbuf *, struct mbuf **, struct timeval, SVCXPRT *);
45
46/*
47 * A pending RPC request which awaits a reply. Requests which have
48 * received their reply will have cr_xid set to zero and cr_mrep to
49 * the mbuf chain of the reply.
50 */
51struct ct_request {
52	TAILQ_ENTRY(ct_request) cr_link;
53	uint32_t		cr_xid;		/* XID of request */
54	struct mbuf		*cr_mrep;	/* reply received by upcall */
55	int			cr_error;	/* any error from upcall */
56	char			cr_verf[MAX_AUTH_BYTES]; /* reply verf */
57};
58
59TAILQ_HEAD(ct_request_list, ct_request);
60
61struct rc_data {
62	struct mtx		rc_lock;
63	struct sockaddr_storage	rc_addr; /* server address */
64	struct netconfig*	rc_nconf; /* network type */
65	rpcprog_t		rc_prog;  /* program number */
66	rpcvers_t		rc_vers;  /* version number */
67	size_t			rc_sendsz;
68	size_t			rc_recvsz;
69	struct timeval		rc_timeout;
70	struct timeval		rc_retry;
71	int			rc_retries;
72	int			rc_privport;
73	char			*rc_waitchan;
74	int			rc_intr;
75	int			rc_connecting;
76	int			rc_closed;
77	struct ucred		*rc_ucred;
78	CLIENT*			rc_client; /* underlying RPC client */
79	struct rpc_err		rc_err;
80	void			*rc_backchannel;
81};
82
83struct ct_data {
84	struct mtx	ct_lock;
85	int		ct_threads;	/* number of threads in clnt_vc_call */
86	bool_t		ct_closing;	/* TRUE if we are closing */
87	bool_t		ct_closed;	/* TRUE if we are closed */
88	struct socket	*ct_socket;	/* connection socket */
89	bool_t		ct_closeit;	/* close it on destroy */
90	struct timeval	ct_wait;	/* wait interval in milliseconds */
91	struct sockaddr_storage	ct_addr; /* remote addr */
92	struct rpc_err	ct_error;
93	uint32_t	ct_xid;
94	char		ct_mcallc[MCALL_MSG_SIZE]; /* marshalled callmsg */
95	size_t		ct_mpos;	/* pos after marshal */
96	const char	*ct_waitchan;
97	int		ct_waitflag;
98	struct mbuf	*ct_record;	/* current reply record */
99	size_t		ct_record_resid; /* how much left of reply to read */
100	bool_t		ct_record_eor;	 /* true if reading last fragment */
101	struct ct_request_list ct_pending;
102	int		ct_upcallrefs;	/* Ref cnt of upcalls in prog. */
103	SVCXPRT		*ct_backchannelxprt; /* xprt for backchannel */
104};
105
106struct cf_conn {  /* kept in xprt->xp_p1 for actual connection */
107	enum xprt_stat strm_stat;
108	struct mbuf *mpending;	/* unparsed data read from the socket */
109	struct mbuf *mreq;	/* current record being built from mpending */
110	uint32_t resid;		/* number of bytes needed for fragment */
111	bool_t eor;		/* reading last fragment of current record */
112};
113
114#endif	/* _KERNEL */
115
116#endif	/* _RPC_KRPC_H_ */
117