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