proc->thread stage 4: rework the VFS and DEVICE subsystems to take thread
[dragonfly.git] / sys / netproto / smb / smb_conn.h
CommitLineData
984263bc
MD
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: src/sys/netsmb/smb_conn.h,v 1.1.2.3 2002/04/23 03:45:01 bp Exp $
dadab5e9 33 * $DragonFly: src/sys/netproto/smb/smb_conn.h,v 1.3 2003/06/25 03:56:06 dillon Exp $
984263bc
MD
34 */
35#ifndef _NETINET_IN_H_
36#include <netinet/in.h>
37#endif
38
39/*
40 * Two levels of connection hierarchy
41 */
42#define SMBL_SM 0
43#define SMBL_VC 1
44#define SMBL_SHARE 2
45#define SMBL_NUM 3
46#define SMBL_NONE (-1)
47
48#define SMB_CS_NONE 0x0000
49#define SMB_CS_UPPER 0x0001 /* convert passed string to upper case */
50#define SMB_CS_LOWER 0x0002 /* convert passed string to lower case */
51
52/*
53 * Common object flags
54 */
55#define SMBO_GONE 0x1000000
56
57/*
58 * access modes
59 */
60#define SMBM_READ 0400 /* read conn attrs.(like list shares) */
61#define SMBM_WRITE 0200 /* modify conn attrs */
62#define SMBM_EXEC 0100 /* can send SMB requests */
63#define SMBM_READGRP 0040
64#define SMBM_WRITEGRP 0020
65#define SMBM_EXECGRP 0010
66#define SMBM_READOTH 0004
67#define SMBM_WRITEOTH 0002
68#define SMBM_EXECOTH 0001
69#define SMBM_MASK 0777
70#define SMBM_EXACT 010000 /* check for specified mode exactly */
71#define SMBM_ALL (SMBM_READ | SMBM_WRITE | SMBM_EXEC)
72#define SMBM_DEFAULT (SMBM_READ | SMBM_WRITE | SMBM_EXEC)
73#define SMBM_ANY_OWNER ((uid_t)-1)
74#define SMBM_ANY_GROUP ((gid_t)-1)
75
76/*
77 * VC flags
78 */
79#define SMBV_PERMANENT 0x0002
80#define SMBV_LONGNAMES 0x0004 /* connection is configured to use long names */
81#define SMBV_ENCRYPT 0x0008 /* server asked for encrypted password */
82#define SMBV_WIN95 0x0010 /* used to apply bugfixes for this OS */
83#define SMBV_PRIVATE 0x0020 /* connection can be used only by creator */
84#define SMBV_RECONNECTING 0x0040 /* conn is in the process of reconnection */
85#define SMBV_SINGLESHARE 0x0080 /* only one share connecting should be allowed */
86#define SMBV_CREATE 0x0100 /* lookup for create operation */
87/*#define SMBV_FAILED 0x0200*/ /* last reconnect attempt has failed */
88#define SMBV_UNICODE 0x0400 /* connection is configured to use Unicode */
89
90
91/*
92 * smb_share flags
93 */
94#define SMBS_PERMANENT 0x0001
95#define SMBS_RECONNECTING 0x0002
96#define SMBS_CONNECTED 0x0004
97
98/*
99 * share types
100 */
101#define SMB_ST_DISK 0x0 /* A: */
102#define SMB_ST_PRINTER 0x1 /* LPT: */
103#define SMB_ST_PIPE 0x2 /* IPC */
104#define SMB_ST_COMM 0x3 /* COMM */
105#define SMB_ST_ANY 0x4
106#define SMB_ST_MAX 0x4
107#define SMB_ST_NONE 0xff /* not a part of protocol */
108
109/*
110 * Negotiated protocol parameters
111 */
112struct smb_sopt {
113 int sv_proto;
114 int16_t sv_tz; /* offset in min relative to UTC */
115 u_int32_t sv_maxtx; /* maximum transmit buf size */
116 u_char sv_sm; /* security mode */
117 u_int16_t sv_maxmux; /* max number of outstanding rq's */
118 u_int16_t sv_maxvcs; /* max number of VCs */
119 u_int16_t sv_rawmode;
120 u_int32_t sv_maxraw; /* maximum raw-buffer size */
121 u_int32_t sv_skey; /* session key */
122 u_int32_t sv_caps; /* capabilities SMB_CAP_ */
123};
124
125/*
126 * network IO daemon states
127 */
128enum smbiod_state {
129 SMBIOD_ST_NOTCONN, /* no connect request was made */
130 SMBIOD_ST_RECONNECT, /* a [re]connect attempt is in progress */
131 SMBIOD_ST_TRANACTIVE, /* transport level is up */
132 SMBIOD_ST_VCACTIVE, /* session established */
133 SMBIOD_ST_DEAD /* connection broken, transport is down */
134};
135
136
137/*
138 * Info structures
139 */
140#define SMB_INFO_NONE 0
141#define SMB_INFO_VC 2
142#define SMB_INFO_SHARE 3
143
144struct smb_vc_info {
145 int itype;
146 int usecount;
147 uid_t uid; /* user id of connection */
148 gid_t gid; /* group of connection */
149 mode_t mode; /* access mode */
150 int flags;
151 enum smbiod_state iodstate;
152 struct smb_sopt sopt;
153 char srvname[SMB_MAXSRVNAMELEN];
154 char vcname[128];
155};
156
157struct smb_share_info {
158 int itype;
159 int usecount;
160 u_short tid; /* TID */
161 int type; /* share type */
162 uid_t uid; /* user id of connection */
163 gid_t gid; /* group of connection */
164 mode_t mode; /* access mode */
165 int flags;
166 char sname[128];
167};
168
169#ifdef _KERNEL
170
171#include <sys/lock.h>
172#include <netsmb/smb_subr.h>
173
174#define CONNADDREQ(a1,a2) ((a1)->sa_len == (a2)->sa_len && \
175 bcmp(a1, a2, (a1)->sa_len) == 0)
176
177struct smb_vc;
178struct smb_share;
179struct smb_cred;
180struct smb_rq;
181struct mbdata;
182struct smbioc_oshare;
183struct smbioc_ossn;
184struct uio;
185
186TAILQ_HEAD(smb_rqhead, smb_rq);
187
188#define SMB_DEFRQTIMO 5
189
190#define SMB_DIALECT(vcp) ((vcp)->vc_sopt.sv_proto)
191
192struct smb_tran_desc;
193
194/*
195 * Connection object
196 */
197struct smb_connobj;
198
199typedef void smb_co_gone_t (struct smb_connobj *cp, struct smb_cred *scred);
200typedef void smb_co_free_t (struct smb_connobj *cp);
201
202#define SMB_CO_LOCK(cp) smb_sl_lock(&(cp)->co_interlock)
203#define SMB_CO_UNLOCK(cp) smb_sl_unlock(&(cp)->co_interlock)
204
205struct smb_connobj {
206 int co_level; /* SMBL_ */
207 int co_flags;
208 struct lock co_lock;
209 struct smb_slock co_interlock;
210 int co_usecount;
211 struct smb_connobj * co_parent;
212 SLIST_HEAD(,smb_connobj)co_children;
213 SLIST_ENTRY(smb_connobj)co_next;
214 smb_co_gone_t * co_gone;
215 smb_co_free_t * co_free;
216};
217
218#define SMBCO_FOREACH(var, cp) SLIST_FOREACH((var), &(cp)->co_children, co_next)
219
220/*
221 * Virtual Circuit (session) to a server.
222 * This is the most (over)complicated part of SMB protocol.
223 * For the user security level (usl), each session with different remote
224 * user name has its own VC.
225 * It is unclear however, should share security level (ssl) allow additional
226 * VCs, because user name is not used and can be the same. On other hand,
227 * multiple VCs allows us to create separate sessions to server on a per
228 * user basis.
229 */
230
231/*
232 * This lock protects vc_flags
233 */
234#define SMBC_ST_LOCK(vcp) smb_sl_lock(&(vcp)->vc_stlock)
235#define SMBC_ST_UNLOCK(vcp) smb_sl_unlock(&(vcp)->vc_stlock)
236
237
238struct smb_vc {
239 struct smb_connobj obj;
240 char * vc_srvname;
241 struct sockaddr*vc_paddr; /* server addr */
242 struct sockaddr*vc_laddr; /* local addr, if any */
243 char * vc_username;
244 char * vc_pass; /* password for usl case */
245 char * vc_domain; /* workgroup/primary domain */
246
247 u_int vc_timo; /* default request timeout */
248 int vc_maxvcs; /* maximum number of VC per connection */
249
250 void * vc_tolower; /* local charset */
251 void * vc_toupper; /* local charset */
252 void * vc_toserver; /* local charset to server one */
253 void * vc_tolocal; /* server charset to local one */
254 int vc_number; /* number of this VC from the client side */
255 int vc_genid;
256 uid_t vc_uid; /* user id of connection */
257 gid_t vc_grp; /* group of connection */
258 mode_t vc_mode; /* access mode */
259 struct tnode * vc_tnode; /* backing object */
260 u_short vc_smbuid; /* unique vc id assigned by server */
261
262 u_char vc_hflags; /* or'ed with flags in the smb header */
263 u_short vc_hflags2; /* or'ed with flags in the smb header */
264 void * vc_tdata; /* transport control block */
265 struct smb_tran_desc *vc_tdesc;
266 int vc_chlen; /* actual challenge length */
267 u_char vc_ch[SMB_MAXCHALLENGELEN];
268 u_short vc_mid; /* multiplex id */
269 struct smb_sopt vc_sopt; /* server options */
270 int vc_txmax; /* max tx/rx packet size */
271 struct smbiod * vc_iod;
272 struct smb_slock vc_stlock;
273};
274
275#define vc_maxmux vc_sopt.sv_maxmux
276#define vc_flags obj.co_flags
277
278
279/*
280 * smb_share structure describes connection to the given SMB share (tree).
281 * Connection to share is always built on top of the VC.
282 */
283
284/*
285 * This lock protects ss_flags
286 */
287#define SMBS_ST_LOCK(ssp) smb_sl_lock(&(ssp)->ss_stlock)
288#define SMBS_ST_LOCKPTR(ssp) (&(ssp)->ss_stlock)
289#define SMBS_ST_UNLOCK(ssp) smb_sl_unlock(&(ssp)->ss_stlock)
290
291struct smb_share {
292 struct smb_connobj obj;
293 char * ss_name;
294 u_short ss_tid; /* TID */
295 int ss_type; /* share type */
296 uid_t ss_uid; /* user id of connection */
297 gid_t ss_grp; /* group of connection */
298 mode_t ss_mode; /* access mode */
299 int ss_vcgenid;
300 char * ss_pass; /* password to a share, can be null */
301 struct smb_slock ss_stlock;
302};
303
304#define ss_flags obj.co_flags
305
306#define CPTOVC(cp) ((struct smb_vc*)(cp))
307#define VCTOCP(vcp) (&(vcp)->obj)
308#define CPTOSS(cp) ((struct smb_share*)(cp))
309#define SSTOVC(ssp) CPTOVC(((ssp)->obj.co_parent))
310#define SSTOCP(ssp) (&(ssp)->obj)
311
312struct smb_vcspec {
313 char * srvname;
314 struct sockaddr*sap;
315 struct sockaddr*lap;
316 int flags;
317 char * username;
318 char * pass;
319 char * domain;
320 mode_t mode;
321 mode_t rights;
322 uid_t owner;
323 gid_t group;
324 char * localcs;
325 char * servercs;
326 struct smb_sharespec *shspec;
327 struct smb_share *ssp; /* returned */
328 /*
329 * The rest is an internal data
330 */
331 struct smb_cred *scred;
332};
333
334struct smb_sharespec {
335 char * name;
336 char * pass;
337 mode_t mode;
338 mode_t rights;
339 uid_t owner;
340 gid_t group;
341 int stype;
342 /*
343 * The rest is an internal data
344 */
345 struct smb_cred *scred;
346};
347
348/*
349 * Session level functions
350 */
351int smb_sm_init(void);
352int smb_sm_done(void);
353int smb_sm_lookup(struct smb_vcspec *vcspec,
354 struct smb_sharespec *shspec, struct smb_cred *scred,
355 struct smb_vc **vcpp);
356
357/*
358 * Connection object
359 */
dadab5e9 360void smb_co_ref(struct smb_connobj *cp, struct thread *td);
984263bc
MD
361void smb_co_rele(struct smb_connobj *cp, struct smb_cred *scred);
362int smb_co_get(struct smb_connobj *cp, int flags, struct smb_cred *scred);
363void smb_co_put(struct smb_connobj *cp, struct smb_cred *scred);
dadab5e9
MD
364int smb_co_lock(struct smb_connobj *cp, int flags, struct thread *td);
365void smb_co_unlock(struct smb_connobj *cp, int flags, struct thread *td);
984263bc
MD
366
367/*
368 * session level functions
369 */
370int smb_vc_create(struct smb_vcspec *vcspec,
371 struct smb_cred *scred, struct smb_vc **vcpp);
372int smb_vc_connect(struct smb_vc *vcp, struct smb_cred *scred);
373int smb_vc_access(struct smb_vc *vcp, struct smb_cred *scred, mode_t mode);
374int smb_vc_get(struct smb_vc *vcp, int flags, struct smb_cred *scred);
375void smb_vc_put(struct smb_vc *vcp, struct smb_cred *scred);
dadab5e9 376void smb_vc_ref(struct smb_vc *vcp, struct thread *td);
984263bc 377void smb_vc_rele(struct smb_vc *vcp, struct smb_cred *scred);
dadab5e9
MD
378int smb_vc_lock(struct smb_vc *vcp, int flags, struct thread *td);
379void smb_vc_unlock(struct smb_vc *vcp, int flags, struct thread *td);
984263bc
MD
380int smb_vc_lookupshare(struct smb_vc *vcp, struct smb_sharespec *shspec,
381 struct smb_cred *scred, struct smb_share **sspp);
382const char * smb_vc_getpass(struct smb_vc *vcp);
383u_short smb_vc_nextmid(struct smb_vc *vcp);
384
385/*
386 * share level functions
387 */
388int smb_share_create(struct smb_vc *vcp, struct smb_sharespec *shspec,
389 struct smb_cred *scred, struct smb_share **sspp);
390int smb_share_access(struct smb_share *ssp, struct smb_cred *scred, mode_t mode);
dadab5e9 391void smb_share_ref(struct smb_share *ssp, struct thread *td);
984263bc
MD
392void smb_share_rele(struct smb_share *ssp, struct smb_cred *scred);
393int smb_share_get(struct smb_share *ssp, int flags, struct smb_cred *scred);
394void smb_share_put(struct smb_share *ssp, struct smb_cred *scred);
dadab5e9
MD
395int smb_share_lock(struct smb_share *ssp, int flags, struct thread *td);
396void smb_share_unlock(struct smb_share *ssp, int flags, struct thread *td);
984263bc
MD
397void smb_share_invalidate(struct smb_share *ssp);
398int smb_share_valid(struct smb_share *ssp);
399const char * smb_share_getpass(struct smb_share *ssp);
400
401/*
402 * SMB protocol level functions
403 */
404int smb_smb_negotiate(struct smb_vc *vcp, struct smb_cred *scred);
405int smb_smb_ssnsetup(struct smb_vc *vcp, struct smb_cred *scred);
406int smb_smb_ssnclose(struct smb_vc *vcp, struct smb_cred *scred);
407int smb_smb_treeconnect(struct smb_share *ssp, struct smb_cred *scred);
408int smb_smb_treedisconnect(struct smb_share *ssp, struct smb_cred *scred);
409int smb_read(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
410 struct smb_cred *scred);
411int smb_write(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
412 struct smb_cred *scred);
413int smb_smb_echo(struct smb_vc *vcp, struct smb_cred *scred);
414
415/*
416 * smbiod thread
417 */
418
419#define SMBIOD_EV_NEWRQ 0x0001
420#define SMBIOD_EV_SHUTDOWN 0x0002
421#define SMBIOD_EV_CONNECT 0x0003
422#define SMBIOD_EV_DISCONNECT 0x0004
423#define SMBIOD_EV_TREECONNECT 0x0005
424#define SMBIOD_EV_MASK 0x00ff
425#define SMBIOD_EV_SYNC 0x0100
426#define SMBIOD_EV_PROCESSING 0x0200
427
428struct smbiod_event {
429 int ev_type;
430 int ev_error;
431 void * ev_ident;
432 STAILQ_ENTRY(smbiod_event) ev_link;
433};
434
435#define SMBIOD_SHUTDOWN 0x0001
436
437struct smbiod {
438 int iod_id;
439 int iod_flags;
440 enum smbiod_state iod_state;
441 int iod_muxcnt; /* number of active outstanding requests */
442 int iod_sleeptimo;
443 struct smb_vc * iod_vc;
444 struct smb_slock iod_rqlock; /* iod_rqlist, iod_muxwant */
445 struct smb_rqhead iod_rqlist; /* list of outstanding requests */
446 int iod_muxwant;
dadab5e9 447 struct thread * iod_td;
984263bc
MD
448 struct smb_cred iod_scred;
449 struct smb_slock iod_evlock; /* iod_evlist */
450 STAILQ_HEAD(,smbiod_event) iod_evlist;
451 struct timespec iod_lastrqsent;
452 struct timespec iod_pingtimo;
453};
454
455int smb_iod_init(void);
456int smb_iod_done(void);
457int smb_iod_create(struct smb_vc *vcp);
458int smb_iod_destroy(struct smbiod *iod);
459int smb_iod_request(struct smbiod *iod, int event, void *ident);
460int smb_iod_addrq(struct smb_rq *rqp);
461int smb_iod_waitrq(struct smb_rq *rqp);
462int smb_iod_removerq(struct smb_rq *rqp);
463
464#endif /* _KERNEL */