xref: /freebsd/sys/netsmb/smb_rq.h (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
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 
58 #define SMBRQ_SLOCK(rqp)	smb_sl_lock(&(rqp)->sr_slock)
59 #define SMBRQ_SUNLOCK(rqp)	smb_sl_unlock(&(rqp)->sr_slock)
60 #define SMBRQ_SLOCKPTR(rqp)	(&(rqp)->sr_slock)
61 
62 
63 enum smbrq_state {
64 	SMBRQ_NOTSENT,		/* rq have data to send */
65 	SMBRQ_SENT,		/* send procedure completed */
66 	SMBRQ_REPLYRECEIVED,
67 	SMBRQ_NOTIFIED		/* owner notified about completion */
68 };
69 
70 struct smb_vc;
71 struct smb_t2rq;
72 
73 struct smb_rq {
74 	enum smbrq_state	sr_state;
75 	struct smb_vc * 	sr_vc;
76 	struct smb_share*	sr_share;
77 	u_short			sr_mid;
78 	struct mbchain		sr_rq;
79 	u_int8_t		sr_rqflags;
80 	u_int16_t		sr_rqflags2;
81 	u_char *		sr_wcount;
82 	u_short *		sr_bcount;
83 	struct mdchain		sr_rp;
84 	int			sr_rpgen;
85 	int			sr_rplast;
86 	int			sr_flags;	/* SMBR_* */
87 	int			sr_rpsize;
88 	struct smb_cred *	sr_cred;
89 	int			sr_timo;
90 	int			sr_rexmit;
91 	int			sr_sendcnt;
92 	struct timespec 	sr_timesent;
93 	int			sr_lerror;
94 	u_int16_t *		sr_rqtid;
95 	u_int16_t *		sr_rquid;
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 paramters */
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