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
31#ifndef _RPC_KRPC_H_
32#define	_RPC_KRPC_H_
33
34#ifdef _KERNEL
35/*
36 * Definitions now shared between client and server RPC for backchannels.
37 */
38#define MCALL_MSG_SIZE 24
39
40void clnt_bck_svccall(void *, struct mbuf *, uint32_t);
41enum clnt_stat clnt_bck_call(CLIENT *, struct rpc_callextra *, rpcproc_t,
42    struct mbuf *, struct mbuf **, struct timeval, SVCXPRT *);
43struct mbuf *_rpc_copym_into_ext_pgs(struct mbuf *, int);
44
45/*
46 * A pending RPC request which awaits a reply. Requests which have
47 * received their reply will have cr_xid set to zero and cr_mrep to
48 * the mbuf chain of the reply.
49 */
50struct ct_request {
51	TAILQ_ENTRY(ct_request) cr_link;
52	uint32_t		cr_xid;		/* XID of request */
53	struct mbuf		*cr_mrep;	/* reply received by upcall */
54	int			cr_error;	/* any error from upcall */
55	char			cr_verf[MAX_AUTH_BYTES]; /* reply verf */
56};
57
58TAILQ_HEAD(ct_request_list, ct_request);
59
60struct rc_data {
61	struct mtx		rc_lock;
62	struct sockaddr_storage	rc_addr; /* server address */
63	struct netconfig*	rc_nconf; /* network type */
64	rpcprog_t		rc_prog;  /* program number */
65	rpcvers_t		rc_vers;  /* version number */
66	size_t			rc_sendsz;
67	size_t			rc_recvsz;
68	struct timeval		rc_timeout;
69	struct timeval		rc_retry;
70	int			rc_retries;
71	int			rc_privport;
72	char			*rc_waitchan;
73	int			rc_intr;
74	int			rc_connecting;
75	int			rc_closed;
76	struct ucred		*rc_ucred;
77	CLIENT*			rc_client; /* underlying RPC client */
78	struct rpc_err		rc_err;
79	void			*rc_backchannel;
80	bool			rc_tls; /* Enable TLS on connection */
81	char			*rc_tlscertname;
82	void			(*rc_reconcall)(CLIENT *, void *,
83				    struct ucred *); /* reconection upcall */
84	void			*rc_reconarg;	/* upcall arg */
85};
86
87/* Bits for ct_rcvstate. */
88#define RPCRCVSTATE_NORMAL		0x01	/* Normal reception. */
89#define RPCRCVSTATE_NONAPPDATA		0x02	/* Reception of a non-application record. */
90#define RPCRCVSTATE_TLSHANDSHAKE	0x04	/* Reception blocked for TLS handshake. */
91#define RPCRCVSTATE_UPCALLNEEDED	0x08	/* Upcall to rpctlscd needed. */
92#define RPCRCVSTATE_UPCALLINPROG	0x10	/* Upcall to rpctlscd in progress. */
93#define RPCRCVSTATE_SOUPCALLNEEDED	0x20	/* Socket upcall needed. */
94#define RPCRCVSTATE_UPCALLTHREAD	0x40	/* Upcall kthread running. */
95
96struct ct_data {
97	struct mtx	ct_lock;
98	int		ct_threads;	/* number of threads in clnt_vc_call */
99	bool_t		ct_closing;	/* TRUE if we are closing */
100	bool_t		ct_closed;	/* TRUE if we are closed */
101	struct socket	*ct_socket;	/* connection socket */
102	bool_t		ct_closeit;	/* close it on destroy */
103	struct timeval	ct_wait;	/* wait interval in milliseconds */
104	struct sockaddr_storage	ct_addr; /* remote addr */
105	struct rpc_err	ct_error;
106	uint32_t	ct_xid;
107	char		ct_mcallc[MCALL_MSG_SIZE]; /* marshalled callmsg */
108	size_t		ct_mpos;	/* pos after marshal */
109	const char	*ct_waitchan;
110	int		ct_waitflag;
111	struct mbuf	*ct_record;	/* current reply record */
112	size_t		ct_record_resid; /* how much left of reply to read */
113	bool_t		ct_record_eor;	 /* true if reading last fragment */
114	struct ct_request_list ct_pending;
115	int		ct_upcallrefs;	/* Ref cnt of upcalls in prog. */
116	SVCXPRT		*ct_backchannelxprt; /* xprt for backchannel */
117	uint64_t	ct_sslsec;	/* RPC-over-TLS connection. */
118	uint64_t	ct_sslusec;
119	uint64_t	ct_sslrefno;
120	uint32_t 	ct_rcvstate;	/* Handle receiving for TLS upcalls */
121	struct mbuf	*ct_raw;	/* Raw mbufs recv'd */
122};
123
124struct cf_conn {  /* kept in xprt->xp_p1 for actual connection */
125	enum xprt_stat strm_stat;
126	struct mbuf *mpending;	/* unparsed data read from the socket */
127	struct mbuf *mreq;	/* current record being built from mpending */
128	uint32_t resid;		/* number of bytes needed for fragment */
129	bool_t eor;		/* reading last fragment of current record */
130};
131
132#endif	/* _KERNEL */
133
134#endif	/* _RPC_KRPC_H_ */
135