xref: /freebsd/sys/netsmb/smb_rq.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2000-2001 Boris Popov
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
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 #ifndef _NETSMB_SMB_RQ_H_
31 #define	_NETSMB_SMB_RQ_H_
32 
33 #ifndef MB_MSYSTEM
34 #include <sys/mchain.h>
35 #endif
36 
37 #define	SMBR_ALLOCED		0x0001	/* structure was malloced */
38 #define	SMBR_SENT		0x0002	/* request successfully transmitted */
39 #define	SMBR_REXMIT		0x0004	/* request should be retransmitted */
40 #define	SMBR_INTR		0x0008	/* request interrupted */
41 #define	SMBR_RESTART		0x0010	/* request should be repeated if possible */
42 #define	SMBR_NORESTART		0x0020	/* request is not restartable */
43 #define	SMBR_MULTIPACKET	0x0040	/* multiple packets can be sent and received */
44 #define	SMBR_INTERNAL		0x0080	/* request is internal to smbrqd */
45 #define	SMBR_XLOCK		0x0100	/* request locked and can't be moved */
46 #define	SMBR_XLOCKWANT		0x0200	/* waiter on XLOCK */
47 
48 #define SMBT2_ALLSENT		0x0001	/* all data and params are sent */
49 #define SMBT2_ALLRECV		0x0002	/* all data and params are received */
50 #define	SMBT2_ALLOCED		0x0004
51 #define	SMBT2_RESTART		0x0008
52 #define	SMBT2_NORESTART		0x0010
53 #define	SMBT2_SECONDARY		0x0020	/* secondary request */
54 
55 #define SMBRQ_SLOCK(rqp)	smb_sl_lock(&(rqp)->sr_slock)
56 #define SMBRQ_SUNLOCK(rqp)	smb_sl_unlock(&(rqp)->sr_slock)
57 #define SMBRQ_SLOCKPTR(rqp)	(&(rqp)->sr_slock)
58 
59 
60 enum smbrq_state {
61 	SMBRQ_NOTSENT,		/* rq have data to send */
62 	SMBRQ_SENT,		/* send procedure completed */
63 	SMBRQ_REPLYRECEIVED,
64 	SMBRQ_NOTIFIED		/* owner notified about completion */
65 };
66 
67 struct smb_vc;
68 struct smb_t2rq;
69 
70 struct smb_rq {
71 	enum smbrq_state	sr_state;
72 	struct smb_vc * 	sr_vc;
73 	struct smb_share*	sr_share;
74 	u_short			sr_mid;
75 	u_int32_t		sr_seqno;
76 	u_int32_t		sr_rseqno;
77 	struct mbchain		sr_rq;
78 	u_int8_t		sr_rqflags;
79 	u_int16_t		sr_rqflags2;
80 	u_char *		sr_wcount;
81 	void *			sr_bcount;	/* Points to 2-byte buffer. */
82 	struct mdchain		sr_rp;
83 	int			sr_rpgen;
84 	int			sr_rplast;
85 	int			sr_flags;	/* SMBR_* */
86 	int			sr_rpsize;
87 	struct smb_cred *	sr_cred;
88 	int			sr_timo;
89 	int			sr_rexmit;
90 	int			sr_sendcnt;
91 	struct timespec 	sr_timesent;
92 	int			sr_lerror;
93 	u_int8_t *		sr_rqsig;
94 	void *			sr_rqtid;	/* Points to 2-byte buffer. */
95 	void *			sr_rquid;	/* Points to 2-byte buffer. */
96 	u_int8_t		sr_errclass;
97 	u_int16_t		sr_serror;
98 	u_int32_t		sr_error;
99 	u_int8_t		sr_rpflags;
100 	u_int16_t		sr_rpflags2;
101 	u_int16_t		sr_rptid;
102 	u_int16_t		sr_rppid;
103 	u_int16_t		sr_rpuid;
104 	u_int16_t		sr_rpmid;
105 	struct smb_slock	sr_slock;	/* short term locks */
106 	struct smb_t2rq *	sr_t2;
107 	TAILQ_ENTRY(smb_rq)	sr_link;
108 };
109 
110 struct smb_t2rq {
111 	u_int16_t	t2_setupcount;
112 	u_int16_t *	t2_setupdata;
113 	u_int16_t	t2_setup[2];	/* most of rqs has setupcount of 1 */
114 	u_int8_t	t2_maxscount;	/* max setup words to return */
115 	u_int16_t	t2_maxpcount;	/* max param bytes to return */
116 	u_int16_t	t2_maxdcount;	/* max data bytes to return */
117 	u_int16_t	t2_fid;		/* for T2 request */
118 	char *		t_name;		/* for T request, should be zero for T2 */
119 	int		t2_flags;	/* SMBT2_ */
120 	struct mbchain	t2_tparam;	/* parameters to transmit */
121 	struct mbchain	t2_tdata;	/* data to transmit */
122 	struct mdchain	t2_rparam;	/* received parameters */
123 	struct mdchain	t2_rdata;	/* received data */
124 	struct smb_cred*t2_cred;
125 	struct smb_connobj *t2_source;
126 	struct smb_rq *	t2_rq;
127 	struct smb_vc * t2_vc;
128 };
129 
130 int  smb_rq_alloc(struct smb_connobj *layer, u_char cmd,
131 	struct smb_cred *scred, struct smb_rq **rqpp);
132 int  smb_rq_init(struct smb_rq *rqp, struct smb_connobj *layer, u_char cmd,
133 	struct smb_cred *scred);
134 void smb_rq_done(struct smb_rq *rqp);
135 int  smb_rq_getrequest(struct smb_rq *rqp, struct mbchain **mbpp);
136 int  smb_rq_getreply(struct smb_rq *rqp, struct mdchain **mbpp);
137 void smb_rq_wstart(struct smb_rq *rqp);
138 void smb_rq_wend(struct smb_rq *rqp);
139 void smb_rq_bstart(struct smb_rq *rqp);
140 void smb_rq_bend(struct smb_rq *rqp);
141 int  smb_rq_intr(struct smb_rq *rqp);
142 int  smb_rq_simple(struct smb_rq *rqp);
143 
144 int  smb_t2_alloc(struct smb_connobj *layer, u_short setup, struct smb_cred *scred,
145 	struct smb_t2rq **rqpp);
146 int  smb_t2_init(struct smb_t2rq *rqp, struct smb_connobj *layer, u_short setup,
147 	struct smb_cred *scred);
148 void smb_t2_done(struct smb_t2rq *t2p);
149 int  smb_t2_request(struct smb_t2rq *t2p);
150 
151 #endif /* !_NETSMB_SMB_RQ_H_ */
152