xref: /illumos-gate/usr/src/uts/common/fs/smbclnt/netsmb/smb_rq.h (revision ed5289f91b9bf164dccd6c75398362be77a4478d)
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  * $Id: smb_rq.h,v 1.9 2005/01/22 22:20:58 lindak Exp $
33  */
34 #ifndef _NETSMB_SMB_RQ_H_
35 #define	_NETSMB_SMB_RQ_H_
36 
37 #pragma ident	"%Z%%M%	%I%	%E% SMI"
38 
39 #include <netsmb/mchain.h>
40 #include <sys/queue.h>
41 
42 #define	SMBR_ALLOCED		0x0001	/* structure was malloced */
43 #define	SMBR_SENT		0x0002	/* request successfully transmitted */
44 #define	SMBR_REXMIT		0x0004	/* request should be retransmitted */
45 #define	SMBR_INTR		0x0008	/* request interrupted */
46 #define	SMBR_RESTART		0x0010	/* req should be repeated if possible */
47 #define	SMBR_NORESTART		0x0020	/* request is not restartable */
48 #define	SMBR_MULTIPACKET	0x0040	/* multiple pkts can be sent/received */
49 #define	SMBR_INTERNAL		0x0080	/* request is internal to netsmb */
50 #define	SMBR_NOINTR_SEND	0x0100	/* no interrupt in send wait */
51 #define	SMBR_NOINTR_RECV	0x0200	/* no interrupt in recv wait */
52 #define	SMBR_SENDWAIT		0x0400	/* waiting for send to complete */
53 #define	SMBR_VCREF		0x4000	/* took vc reference */
54 #define	SMBR_MOREDATA		0x8000	/* our buffer was too small */
55 
56 #define	SMBT2_ALLSENT		0x0001	/* all data and params are sent */
57 #define	SMBT2_ALLRECV		0x0002	/* all data and params are received */
58 #define	SMBT2_ALLOCED		0x0004
59 #define	SMBT2_RESTART		0x0008
60 #define	SMBT2_NORESTART		0x0010
61 #define	SMBT2_MOREDATA		0x8000	/* our buffer was too small */
62 
63 #define	SMBRQ_LOCK(rqp) 	mutex_enter(&(rqp)->sr_lock)
64 #define	SMBRQ_UNLOCK(rqp)	mutex_exit(&(rqp)->sr_lock)
65 
66 
67 enum smbrq_state {
68 	SMBRQ_NOTSENT,		/* rq have data to send */
69 	SMBRQ_SENT,		/* send procedure completed */
70 	SMBRQ_REPLYRECEIVED,
71 	SMBRQ_NOTIFIED		/* owner notified about completion */
72 };
73 
74 struct smb_vc;
75 
76 struct smb_rq {
77 	TAILQ_ENTRY(smb_rq)	sr_link;
78 	kmutex_t		sr_lock;
79 	kcondvar_t		sr_cond;
80 	enum smbrq_state	sr_state;
81 	struct smb_vc		*sr_vc;
82 	struct smb_share	*sr_share;
83 	struct _kthread 	*sr_owner;
84 	ushort_t			sr_mid;
85 	struct mbchain		sr_rq;
86 	uchar_t			sr_cmd;
87 	uint8_t			sr_rqflags;
88 	uint16_t		sr_rqflags2;
89 	uchar_t			*sr_wcount;
90 	uchar_t			*sr_bcount;
91 	struct mdchain		sr_rp;
92 	int			sr_rpgen;
93 	int			sr_rplast;
94 	int			sr_flags;	/* SMBR_* */
95 	int			sr_rpsize;
96 	struct smb_cred		*sr_cred;
97 	int			sr_timo;
98 	int			sr_rexmit; /* how many more retries.  dflt 0 */
99 	int			sr_sendcnt;
100 	struct timespec 	sr_timesent;
101 	int			sr_lerror;
102 	uint16_t		*sr_rqtid;
103 	uint16_t		*sr_rquid;
104 	uint8_t			sr_errclass;
105 	uint16_t		sr_serror;
106 	uint32_t		sr_error;
107 	uint8_t			sr_rpflags;
108 	uint16_t		sr_rpflags2;
109 	uint16_t		sr_rptid;
110 	uint16_t		sr_rppid;
111 	uint16_t		sr_rpuid;
112 	uint16_t		sr_rpmid;
113 };
114 typedef struct smb_rq smb_rq_t;
115 
116 struct smb_t2rq {
117 	kmutex_t	t2_lock;
118 	kcondvar_t	t2_cond;
119 	uint16_t	t2_setupcount;
120 	uint16_t	*t2_setupdata;
121 	uint16_t	t2_setup[SMB_MAXSETUPWORDS];
122 	uint8_t		t2_maxscount;	/* max setup words to return */
123 	uint16_t	t2_maxpcount;	/* max param bytes to return */
124 	uint16_t	t2_maxdcount;	/* max data bytes to return */
125 	uint16_t	t2_fid;		/* for T2 request */
126 	char		t_name[128];	/* for T, should be zero for T2 */
127 	int		t2_flags;	/* SMBT2_ */
128 	struct mbchain	t2_tparam;	/* parameters to transmit */
129 	struct mbchain	t2_tdata;	/* data to transmit */
130 	struct mdchain	t2_rparam;	/* received paramters */
131 	struct mdchain	t2_rdata;	/* received data */
132 	struct smb_cred	*t2_cred;
133 	struct smb_connobj	*t2_source;
134 	struct smb_rq	*t2_rq;
135 	struct smb_vc	*t2_vc;
136 	struct smb_share *t2_share;	/* for smb up/down */
137 	/* unmapped windows error detail */
138 	uint8_t		t2_sr_errclass;
139 	uint16_t	t2_sr_serror;
140 	uint32_t	t2_sr_error;
141 	uint16_t	t2_sr_rpflags2;
142 };
143 typedef struct smb_t2rq smb_t2rq_t;
144 
145 struct smb_ntrq {
146 	kmutex_t	nt_lock;
147 	kcondvar_t	nt_cond;
148 	uint16_t	nt_function;
149 	uint8_t		nt_maxscount;	/* max setup words to return */
150 	uint32_t	nt_maxpcount;	/* max param bytes to return */
151 	uint32_t	nt_maxdcount;	/* max data bytes to return */
152 	int		nt_flags;	/* SMBT2_ */
153 	struct mbchain	nt_tsetup;	/* setup to transmit */
154 	struct mbchain	nt_tparam;	/* parameters to transmit */
155 	struct mbchain	nt_tdata;	/* data to transmit */
156 	struct mdchain	nt_rparam;	/* received paramters */
157 	struct mdchain	nt_rdata;	/* received data */
158 	struct smb_cred	*nt_cred;
159 	struct smb_connobj *nt_source;
160 	struct smb_rq	*nt_rq;
161 	struct smb_vc	*nt_vc;
162 	struct smb_share *nt_share;	/* for smb up/down */
163 	/* unmapped windows error details */
164 	uint32_t	nt_sr_error;
165 	uint16_t	nt_sr_rpflags2;
166 };
167 typedef struct smb_ntrq smb_ntrq_t;
168 
169 int   smb_rq_alloc(struct smb_connobj *layer, uchar_t cmd,
170 	struct smb_cred *scred, struct smb_rq **rqpp);
171 int  smb_rq_init(struct smb_rq *rqp, struct smb_connobj *layer,
172 	uchar_t cmd, struct smb_cred *scred);
173 void smb_rq_done(struct smb_rq *rqp);
174 int  smb_rq_getrequest(struct smb_rq *rqp, struct mbchain **mbpp);
175 int  smb_rq_getreply(struct smb_rq *rqp, struct mdchain **mbpp);
176 void smb_rq_wstart(struct smb_rq *rqp);
177 void smb_rq_wend(struct smb_rq *rqp);
178 void smb_rq_bstart(struct smb_rq *rqp);
179 void smb_rq_bend(struct smb_rq *rqp);
180 int  smb_rq_intr(struct smb_rq *rqp);
181 int  smb_rq_simple(struct smb_rq *rqp);
182 int  smb_rq_simple_timed(struct smb_rq *rqp, int timeout);
183 
184 int  smb_t2_alloc(struct smb_connobj *layer, ushort_t setup,
185 	struct smb_cred *scred, struct smb_t2rq **rqpp);
186 int  smb_t2_init(struct smb_t2rq *rqp, struct smb_connobj *layer,
187 	ushort_t *setup, int setupcnt, struct smb_cred *scred);
188 void smb_t2_done(struct smb_t2rq *t2p);
189 int  smb_t2_request(struct smb_t2rq *t2p);
190 uint32_t smb_t2_err(struct smb_t2rq *t2p);
191 
192 int  smb_nt_alloc(struct smb_connobj *layer, ushort_t fn,
193 	struct smb_cred *scred, struct smb_ntrq **rqpp);
194 int  smb_nt_init(struct smb_ntrq *rqp, struct smb_connobj *layer,
195 	ushort_t fn, struct smb_cred *scred);
196 void smb_nt_done(struct smb_ntrq *ntp);
197 int  smb_nt_request(struct smb_ntrq *ntp);
198 
199 #endif /* _NETSMB_SMB_RQ_H_ */
200