xref: /freebsd/sys/fs/smbfs/smbfs_subr.h (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
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 _FS_SMBFS_SMBFS_SUBR_H_
35 #define _FS_SMBFS_SMBFS_SUBR_H_
36 
37 #ifdef MALLOC_DECLARE
38 MALLOC_DECLARE(M_SMBFSDATA);
39 #endif
40 
41 #define SMBFSERR(format, args...) printf("%s: "format, __func__ ,## args)
42 
43 #ifdef SMB_VNODE_DEBUG
44 #define SMBVDEBUG(format, args...) printf("%s: "format, __func__ ,## args)
45 #else
46 #define SMBVDEBUG(format, args...)
47 #endif
48 
49 /*
50  * Possible lock commands
51  */
52 #define SMB_LOCK_EXCL		0
53 #define	SMB_LOCK_SHARED		1
54 #define	SMB_LOCK_RELEASE	2
55 
56 struct smbmount;
57 struct proc;
58 struct timespec;
59 struct ucred;
60 struct vattr;
61 struct vnode;
62 struct statfs;
63 
64 struct smbfattr {
65 	int		fa_attr;
66 	int64_t		fa_size;
67 	struct timespec	fa_atime;
68 	struct timespec	fa_ctime;
69 	struct timespec	fa_mtime;
70 	long		fa_ino;
71 };
72 
73 /*
74  * Context to perform findfirst/findnext/findclose operations
75  */
76 #define	SMBFS_RDD_FINDFIRST	0x01
77 #define	SMBFS_RDD_EOF		0x02
78 #define	SMBFS_RDD_FINDSINGLE	0x04
79 #define	SMBFS_RDD_USESEARCH	0x08
80 #define	SMBFS_RDD_NOCLOSE	0x10
81 #define	SMBFS_RDD_GOTRNAME	0x1000
82 
83 /*
84  * Search context supplied by server
85  */
86 #define	SMB_SKEYLEN		21			/* search context */
87 #define SMB_DENTRYLEN		(SMB_SKEYLEN + 22)	/* entire entry */
88 
89 struct smbfs_fctx {
90 	/*
91 	 * Setable values
92 	 */
93 	int		f_flags;	/* SMBFS_RDD_ */
94 	/*
95 	 * Return values
96 	 */
97 	struct smbfattr	f_attr;		/* current attributes */
98 	char *		f_name;		/* current file name */
99 	int		f_nmlen;	/* name len */
100 	/*
101 	 * Internal variables
102 	 */
103 	int		f_limit;	/* maximum number of entries */
104 	int		f_attrmask;	/* SMB_FA_ */
105 	int		f_wclen;
106 	const char *	f_wildcard;
107 	struct smbnode*	f_dnp;
108 	struct smb_cred*f_scred;
109 	struct smb_share *f_ssp;
110 	union {
111 		struct smb_rq *	uf_rq;
112 		struct smb_t2rq * uf_t2;
113 	} f_urq;
114 	int		f_left;		/* entries left */
115 	int		f_ecnt;		/* entries left in the current reponse */
116 	int		f_eofs;		/* entry offset in the parameter block */
117 	u_char 		f_skey[SMB_SKEYLEN]; /* server side search context */
118 	u_char		f_fname[8 + 1 + 3 + 1]; /* common case for 8.3 filenames */
119 	u_int16_t	f_Sid;
120 	u_int16_t	f_infolevel;
121 	int		f_rnamelen;
122 	char *		f_rname;	/* resume name/key */
123 	int		f_rnameofs;
124 };
125 
126 #define f_rq	f_urq.uf_rq
127 #define f_t2	f_urq.uf_t2
128 
129 /*
130  * smb level
131  */
132 int  smbfs_smb_lock(struct smbnode *np, int op, caddr_t id,
133 	off_t start, off_t end,	struct smb_cred *scred);
134 int  smbfs_smb_statfs2(struct smb_share *ssp, struct statfs *sbp,
135 	struct smb_cred *scred);
136 int  smbfs_smb_statfs(struct smb_share *ssp, struct statfs *sbp,
137 	struct smb_cred *scred);
138 int  smbfs_smb_setfsize(struct smbnode *np, int newsize, struct smb_cred *scred);
139 
140 int  smbfs_smb_query_info(struct smbnode *np, const char *name, int len,
141 	struct smbfattr *fap, struct smb_cred *scred);
142 int  smbfs_smb_setpattr(struct smbnode *np, u_int16_t attr,
143 	struct timespec *mtime, struct smb_cred *scred);
144 int  smbfs_smb_setptime2(struct smbnode *np, struct timespec *mtime,
145 	struct timespec *atime, int attr, struct smb_cred *scred);
146 int  smbfs_smb_setpattrNT(struct smbnode *np, u_int16_t attr,
147 	struct timespec *mtime, struct timespec *atime, struct smb_cred *scred);
148 
149 int  smbfs_smb_setftime(struct smbnode *np, struct timespec *mtime,
150 	struct timespec *atime, struct smb_cred *scred);
151 int  smbfs_smb_setfattrNT(struct smbnode *np, u_int16_t attr,
152 	struct timespec *mtime,	struct timespec *atime, struct smb_cred *scred);
153 
154 int  smbfs_smb_open(struct smbnode *np, int accmode, struct smb_cred *scred);
155 int  smbfs_smb_close(struct smb_share *ssp, u_int16_t fid,
156 	 struct timespec *mtime, struct smb_cred *scred);
157 int  smbfs_smb_create(struct smbnode *dnp, const char *name, int len,
158 	struct smb_cred *scred);
159 int  smbfs_smb_delete(struct smbnode *np, struct smb_cred *scred);
160 int  smbfs_smb_flush(struct smbnode *np, struct smb_cred *scred);
161 int  smbfs_smb_rename(struct smbnode *src, struct smbnode *tdnp,
162 	const char *tname, int tnmlen, struct smb_cred *scred);
163 int  smbfs_smb_move(struct smbnode *src, struct smbnode *tdnp,
164 	const char *tname, int tnmlen, u_int16_t flags, struct smb_cred *scred);
165 int  smbfs_smb_mkdir(struct smbnode *dnp, const char *name, int len,
166 	struct smb_cred *scred);
167 int  smbfs_smb_rmdir(struct smbnode *np, struct smb_cred *scred);
168 int  smbfs_findopen(struct smbnode *dnp, const char *wildcard, int wclen,
169 	int attr, struct smb_cred *scred, struct smbfs_fctx **ctxpp);
170 int  smbfs_findnext(struct smbfs_fctx *ctx, int limit, struct smb_cred *scred);
171 int  smbfs_findclose(struct smbfs_fctx *ctx, struct smb_cred *scred);
172 int  smbfs_fullpath(struct mbchain *mbp, struct smb_vc *vcp,
173 	struct smbnode *dnp, const char *name, int nmlen);
174 int  smbfs_smb_lookup(struct smbnode *dnp, const char *name, int nmlen,
175 	struct smbfattr *fap, struct smb_cred *scred);
176 
177 int  smbfs_fname_tolocal(struct smb_vc *vcp, char *name, int *nmlen, int caseopt);
178 
179 void  smb_time_local2server(struct timespec *tsp, int tzoff, u_long *seconds);
180 void  smb_time_server2local(u_long seconds, int tzoff, struct timespec *tsp);
181 void  smb_time_NT2local(int64_t nsec, int tzoff, struct timespec *tsp);
182 void  smb_time_local2NT(struct timespec *tsp, int tzoff, int64_t *nsec);
183 void  smb_time_unix2dos(struct timespec *tsp, int tzoff, u_int16_t *ddp,
184 	     u_int16_t *dtp, u_int8_t *dhp);
185 void smb_dos2unixtime (u_int dd, u_int dt, u_int dh, int tzoff, struct timespec *tsp);
186 
187 #endif /* !_FS_SMBFS_SMBFS_SUBR_H_ */
188