1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2000-2001 Boris Popov
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28#ifndef _FS_SMBFS_SMBFS_SUBR_H_
29#define _FS_SMBFS_SMBFS_SUBR_H_
30
31#ifdef MALLOC_DECLARE
32MALLOC_DECLARE(M_SMBFSDATA);
33MALLOC_DECLARE(M_SMBFSCRED);
34#endif
35
36#define SMBFSERR(format, args...) printf("%s: "format, __func__ ,## args)
37
38#ifdef SMB_VNODE_DEBUG
39#define SMBVDEBUG(format, args...) printf("%s: "format, __func__ ,## args)
40#else
41#define SMBVDEBUG(format, args...)
42#endif
43
44/*
45 * Possible lock commands
46 */
47#define SMB_LOCK_EXCL 0
48#define SMB_LOCK_SHARED 1
49#define SMB_LOCK_RELEASE 2
50
51struct smbmount;
52struct proc;
53struct timespec;
54struct ucred;
55struct vattr;
56struct vnode;
57struct statfs;
58
59struct smbfattr {
60 int fa_attr;
61 int64_t fa_size;
62 struct timespec fa_atime;
63 struct timespec fa_ctime;
64 struct timespec fa_mtime;
65 long fa_ino;
66};
67
68/*
69 * Context to perform findfirst/findnext/findclose operations
70 */
71#define SMBFS_RDD_FINDFIRST 0x01
72#define SMBFS_RDD_EOF 0x02
73#define SMBFS_RDD_FINDSINGLE 0x04
74#define SMBFS_RDD_USESEARCH 0x08
75#define SMBFS_RDD_NOCLOSE 0x10
76#define SMBFS_RDD_GOTRNAME 0x1000
77
78/*
79 * Search context supplied by server
80 */
81#define SMB_SKEYLEN 21 /* search context */
82#define SMB_DENTRYLEN (SMB_SKEYLEN + 22) /* entire entry */
83
84struct smbfs_fctx {
85 /*
86 * Setable values
87 */
88 int f_flags; /* SMBFS_RDD_ */
89 /*
90 * Return values
91 */
92 struct smbfattr f_attr; /* current attributes */
93 char * f_name; /* current file name */
94 int f_nmlen; /* name len */
95 /*
96 * Internal variables
97 */
98 int f_limit; /* maximum number of entries */
99 int f_attrmask; /* SMB_FA_ */
100 int f_wclen;
101 const char * f_wildcard;
102 struct smbnode* f_dnp;
103 struct smb_cred*f_scred;
104 struct smb_share *f_ssp;
105 union {
106 struct smb_rq * uf_rq;
107 struct smb_t2rq * uf_t2;
108 } f_urq;
109 int f_left; /* entries left */
110 int f_ecnt; /* entries left in the current response */
111 int f_eofs; /* entry offset in the parameter block */
112 u_char f_skey[SMB_SKEYLEN]; /* server side search context */
113 u_char f_fname[8 + 1 + 3 + 1]; /* common case for 8.3 filenames */
114 u_int16_t f_Sid;
115 u_int16_t f_infolevel;
116 int f_rnamelen;
117 char * f_rname; /* resume name/key */
118 int f_rnameofs;
119};
120
121#define f_rq f_urq.uf_rq
122#define f_t2 f_urq.uf_t2
123
124/*
125 * smb level
126 */
127int smbfs_smb_lock(struct smbnode *np, int op, caddr_t id,
128 off_t start, off_t end, struct smb_cred *scred);
129int smbfs_smb_statfs(struct smb_share *ssp, struct statfs *sbp,
130 struct smb_cred *scred);
131int smbfs_smb_setfsize(struct smbnode *np, int64_t newsize,
132 struct smb_cred *scred);
133
134int smbfs_smb_query_info(struct smbnode *np, const char *name, int len,
135 struct smbfattr *fap, struct smb_cred *scred);
136int smbfs_smb_setpattr(struct smbnode *np, u_int16_t attr,
137 struct timespec *mtime, struct smb_cred *scred);
138int smbfs_smb_setptime2(struct smbnode *np, struct timespec *mtime,
139 struct timespec *atime, int attr, struct smb_cred *scred);
140int smbfs_smb_setpattrNT(struct smbnode *np, u_int16_t attr,
141 struct timespec *mtime, struct timespec *atime, struct smb_cred *scred);
142
143int smbfs_smb_setftime(struct smbnode *np, struct timespec *mtime,
144 struct timespec *atime, struct smb_cred *scred);
145int smbfs_smb_setfattrNT(struct smbnode *np, u_int16_t attr,
146 struct timespec *mtime, struct timespec *atime, struct smb_cred *scred);
147
148int smbfs_smb_open(struct smbnode *np, int accmode, struct smb_cred *scred);
149int smbfs_smb_close(struct smb_share *ssp, u_int16_t fid,
150 struct timespec *mtime, struct smb_cred *scred);
151int smbfs_smb_create(struct smbnode *dnp, const char *name, int len,
152 struct smb_cred *scred);
153int smbfs_smb_delete(struct smbnode *np, struct smb_cred *scred);
154int smbfs_smb_flush(struct smbnode *np, struct smb_cred *scred);
155int smbfs_smb_rename(struct smbnode *src, struct smbnode *tdnp,
156 const char *tname, int tnmlen, struct smb_cred *scred);
157int smbfs_smb_move(struct smbnode *src, struct smbnode *tdnp,
158 const char *tname, int tnmlen, u_int16_t flags, struct smb_cred *scred);
159int smbfs_smb_mkdir(struct smbnode *dnp, const char *name, int len,
160 struct smb_cred *scred);
161int smbfs_smb_rmdir(struct smbnode *np, struct smb_cred *scred);
162int smbfs_findopen(struct smbnode *dnp, const char *wildcard, int wclen,
163 int attr, struct smb_cred *scred, struct smbfs_fctx **ctxpp);
164int smbfs_findnext(struct smbfs_fctx *ctx, int limit, struct smb_cred *scred);
165int smbfs_findclose(struct smbfs_fctx *ctx, struct smb_cred *scred);
166int smbfs_fullpath(struct mbchain *mbp, struct smb_vc *vcp,
167 struct smbnode *dnp, const char *name, int nmlen);
168int smbfs_smb_lookup(struct smbnode *dnp, const char *name, int nmlen,
169 struct smbfattr *fap, struct smb_cred *scred);
170
171int smbfs_fname_tolocal(struct smb_vc *vcp, char *name, int *nmlen, int caseopt);
172
173void smb_time_local2server(struct timespec *tsp, int tzoff, u_long *seconds);
174void smb_time_server2local(u_long seconds, int tzoff, struct timespec *tsp);
175void smb_time_NT2local(int64_t nsec, int tzoff, struct timespec *tsp);
176void smb_time_local2NT(struct timespec *tsp, int tzoff, int64_t *nsec);
177void smb_time_unix2dos(struct timespec *tsp, int tzoff, u_int16_t *ddp,
178 u_int16_t *dtp, u_int8_t *dhp);
179void smb_dos2unixtime (u_int dd, u_int dt, u_int dh, int tzoff, struct timespec *tsp);
180
181void *smbfs_malloc_scred(void);
182void smbfs_free_scred(void *);
183#endif /* !_FS_SMBFS_SMBFS_SUBR_H_ */