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: smbfs_subr.h,v 1.25 2005/03/17 01:23:40 lindak Exp $ 33 */ 34 35 /* 36 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 37 * Use is subject to license terms. 38 */ 39 40 #ifndef _FS_SMBFS_SMBFS_SUBR_H_ 41 #define _FS_SMBFS_SMBFS_SUBR_H_ 42 43 #pragma ident "%Z%%M% %I% %E% SMI" 44 45 #include <sys/cmn_err.h> 46 #include <netsmb/mchain.h> 47 48 #if defined(DEBUG) || defined(lint) 49 #define SMB_VNODE_DEBUG 1 50 #endif 51 52 #ifndef FALSE 53 #define FALSE (0) 54 #endif 55 56 #ifndef TRUE 57 #define TRUE (1) 58 #endif 59 60 /* 61 * Let's use C99 standard variadic macros! 62 * Also the C99 __func__ (function name) feature. 63 */ 64 #define SMBFSERR(...) \ 65 smb_errmsg(CE_NOTE, __func__, __VA_ARGS__) 66 #define SMBVDEBUG(...) \ 67 smb_errmsg(CE_CONT, __func__, __VA_ARGS__) 68 69 /* 70 * Possible lock commands 71 */ 72 #define SMB_LOCK_EXCL 0 73 #define SMB_LOCK_SHARED 1 74 #define SMB_LOCK_RELEASE 2 75 76 struct smb_cred; 77 struct smb_vc; 78 struct statvfs; 79 struct timespec; 80 81 82 /* 83 * Context to perform findfirst/findnext/findclose operations 84 */ 85 #define SMBFS_RDD_FINDFIRST 0x01 86 #define SMBFS_RDD_EOF 0x02 87 #define SMBFS_RDD_FINDSINGLE 0x04 88 #define SMBFS_RDD_USESEARCH 0x08 89 #define SMBFS_RDD_NOCLOSE 0x10 90 #define SMBFS_RDD_GOTRNAME 0x1000 91 92 /* 93 * Search context supplied by server 94 */ 95 #define SMB_SKEYLEN 21 /* search context */ 96 #define SMB_DENTRYLEN (SMB_SKEYLEN + 22) /* entire entry */ 97 98 struct smbfs_fctx { 99 /* 100 * Setable values 101 */ 102 int f_flags; /* SMBFS_RDD_ */ 103 /* 104 * Return values 105 */ 106 struct smbfattr f_attr; /* current attributes */ 107 char *f_name; /* current file name */ 108 int f_nmlen; /* name len */ 109 int f_namesz; /* memory allocated */ 110 /* 111 * Internal variables 112 */ 113 uint16_t f_limit; /* maximum number of entries */ 114 uint16_t f_attrmask; /* SMB_FA_ */ 115 int f_wclen; 116 const char *f_wildcard; 117 struct smbnode *f_dnp; 118 struct smb_cred *f_scred; 119 struct smb_share *f_ssp; 120 union { 121 struct smb_rq *uf_rq; 122 struct smb_t2rq *uf_t2; 123 } f_urq; 124 int f_left; /* entries left */ 125 int f_ecnt; /* entries left in current response */ 126 int f_eofs; /* entry offset in data block */ 127 uchar_t f_skey[SMB_SKEYLEN]; /* server side search context */ 128 uchar_t f_fname[8 + 1 + 3 + 1]; /* for 8.3 filenames */ 129 uint16_t f_Sid; /* Search handle (like a FID) */ 130 uint16_t f_infolevel; 131 int f_rnamelen; 132 char *f_rname; /* resume name */ 133 int f_rnameofs; 134 int f_otws; /* # over-the-wire ops so far */ 135 char *f_firstnm; /* first filename we got back */ 136 int f_firstnmlen; 137 int f_rkey; /* resume key */ 138 }; 139 typedef struct smbfs_fctx smbfs_fctx_t; 140 141 #define f_rq f_urq.uf_rq 142 #define f_t2 f_urq.uf_t2 143 144 145 /* 146 * smb level 147 */ 148 int smbfs_smb_lock(struct smbnode *np, int op, caddr_t id, 149 offset_t start, uint64_t len, int largelock, 150 struct smb_cred *scrp, uint32_t timeout); 151 int smbfs_smb_qfsattr(struct smb_share *ssp, uint32_t *attrp, 152 struct smb_cred *scrp); 153 int smbfs_smb_statfs(struct smb_share *ssp, statvfs64_t *sbp, 154 struct smb_cred *scrp); 155 int smbfs_smb_setfsize(struct smbnode *np, uint16_t fid, uint64_t newsize, 156 struct smb_cred *scrp); 157 158 int smbfs_smb_getfattr(struct smbnode *np, struct smbfattr *fap, 159 struct smb_cred *scrp); 160 161 int smbfs_smb_setfattr(struct smbnode *np, uint16_t fid, 162 uint32_t attr, struct timespec *mtime, struct timespec *atime, 163 struct smb_cred *scrp); 164 165 int smbfs_smb_setpattr(struct smbnode *np, 166 uint32_t attr, struct timespec *mtime, struct timespec *atime, 167 struct smb_cred *scrp); 168 169 int smbfs_smb_open(struct smbnode *np, uint32_t rights, struct smb_cred *scrp, 170 int *attrcacheupdated, uint16_t *fidp, const char *name, int nmlen, 171 int xattr, len_t *sizep, uint32_t *rightsp); 172 int smbfs_smb_tmpopen(struct smbnode *np, uint32_t rights, 173 struct smb_cred *scrp, uint16_t *fidp); 174 int smbfs_smb_close(struct smb_share *ssp, uint16_t fid, 175 struct timespec *mtime, struct smb_cred *scrp); 176 int smbfs_smb_tmpclose(struct smbnode *ssp, uint16_t fid, 177 struct smb_cred *scrp); 178 int smbfs_smb_create(struct smbnode *dnp, const char *name, int len, 179 struct smb_cred *scrp, uint16_t *fidp, uint32_t disp, int xattr); 180 int smbfs_smb_delete(struct smbnode *np, struct smb_cred *scrp, 181 const char *name, int len, int xattr); 182 int smbfs_smb_rename(struct smbnode *src, struct smbnode *tdnp, 183 const char *tname, int tnmlen, struct smb_cred *scrp); 184 int smbfs_smb_t2rename(struct smbnode *np, struct smbnode *tdnp, 185 const char *tname, int tnmlen, struct smb_cred *scrp, int overwrite); 186 int smbfs_smb_move(struct smbnode *src, struct smbnode *tdnp, 187 const char *tname, int tnmlen, uint16_t flags, struct smb_cred *scrp); 188 int smbfs_smb_mkdir(struct smbnode *dnp, const char *name, int len, 189 struct smb_cred *scrp); 190 int smbfs_smb_rmdir(struct smbnode *np, struct smb_cred *scrp); 191 int smbfs_smb_findopen(struct smbnode *dnp, const char *wildcard, int wclen, 192 int attr, struct smb_cred *scrp, struct smbfs_fctx **ctxpp); 193 int smbfs_smb_findnext(struct smbfs_fctx *ctx, int limit, 194 struct smb_cred *scrp); 195 int smbfs_smb_findclose(struct smbfs_fctx *ctx, struct smb_cred *scrp); 196 int smbfs_fullpath(struct mbchain *mbp, struct smb_vc *vcp, 197 struct smbnode *dnp, const char *name, int *nmlenp, uint8_t sep); 198 int smbfs_smb_lookup(struct smbnode *dnp, const char **namep, int *nmlenp, 199 struct smbfattr *fap, struct smb_cred *scrp); 200 int smbfs_smb_hideit(struct smbnode *np, const char *name, int len, 201 struct smb_cred *scrp); 202 int smbfs_smb_unhideit(struct smbnode *np, const char *name, int len, 203 struct smb_cred *scrp); 204 int smbfs_smb_flush(struct smbnode *np, struct smb_cred *scrp); 205 int smbfs_0extend(vnode_t *vp, uint16_t fid, len_t from, len_t to, 206 struct smb_cred *scredp, int timo); 207 208 /* get/set security descriptor */ 209 int smbfs_smb_getsec_m(struct smb_share *ssp, uint16_t fid, 210 struct smb_cred *scrp, uint32_t selector, 211 mblk_t **res, uint32_t *reslen); 212 int smbfs_smb_setsec_m(struct smb_share *ssp, uint16_t fid, 213 struct smb_cred *scrp, uint32_t selector, mblk_t **mp); 214 215 int smbfs_getacl(vnode_t *vp, vsecattr_t *vsecattr, 216 int *uidp, int *gidp, int flag, cred_t *cr); 217 int smbfs_setacl(vnode_t *vp, vsecattr_t *vsecattr, 218 int uid, int gid, int flag, cred_t *cr); 219 220 int smbfs_getsd(vnode_t *vp, uint32_t sel, mblk_t **mp, cred_t *cr); 221 int smbfs_setsd(vnode_t *vp, uint32_t sel, mblk_t **mp, cred_t *cr); 222 int smbfs_ioc_getsd(vnode_t *vp, intptr_t arg, int flag, cred_t *cr); 223 int smbfs_ioc_setsd(vnode_t *vp, intptr_t arg, int flag, cred_t *cr); 224 225 #ifdef NOT_YET 226 int smbfs_smb_getsec(struct smb_share *ssp, uint16_t fid, 227 struct smb_cred *scrp, uint32_t selector, struct ntsecdesc **res); 228 int smbfs_smb_setsec(struct smb_share *ssp, uint16_t fid, 229 struct smb_cred *scrp, uint32_t selector, uint16_t flags, 230 struct ntsid *owner, struct ntsid *group, struct ntacl *sacl, 231 struct ntacl *dacl); 232 int smbfs_smb_qstreaminfo(struct smbnode *np, struct smb_cred *scrp, 233 uio_t uio, size_t *sizep); 234 #endif /* NOT_YET */ 235 236 void smbfs_fname_tolocal(struct smbfs_fctx *ctx); 237 238 void smb_time_local2server(struct timespec *tsp, int tzoff, long *seconds); 239 void smb_time_server2local(ulong_t seconds, int tzoff, struct timespec *tsp); 240 void smb_time_NT2local(uint64_t nsec, int tzoff, struct timespec *tsp); 241 void smb_time_local2NT(struct timespec *tsp, int tzoff, uint64_t *nsec); 242 void smb_time_unix2dos(struct timespec *tsp, int tzoff, uint16_t *ddp, 243 uint16_t *dtp, uint8_t *dhp); 244 void smb_dos2unixtime(uint_t dd, uint_t dt, uint_t dh, int tzoff, 245 struct timespec *tsp); 246 247 /* Stuff borrowed from NFS (and then hacked) */ 248 vnode_t *smbfs_make_node(vfs_t *vfsp, 249 const char *dir, int dirlen, 250 const char *name, int nmlen, 251 struct smbfattr *fap); 252 void smb_addfree(smbnode_t *sp); 253 void smb_addhash(smbnode_t *sp); 254 void smb_rmhash(smbnode_t *); 255 256 int smbfs_subrinit(void); 257 void smbfs_subrfini(void); 258 int smbfs_clntinit(void); 259 void smbfs_clntfini(void); 260 void smbfs_zonelist_add(smbmntinfo_t *smi); 261 void smbfs_zonelist_remove(smbmntinfo_t *smi); 262 void smbfs_destroy_table(struct vfs *vfsp); 263 int smbfs_readvnode(vnode_t *, uio_t *, cred_t *, struct vattr *); 264 int smbfs_writevnode(vnode_t *vp, uio_t *uiop, cred_t *cr, 265 int ioflag, int timo); 266 int smbfsgetattr(vnode_t *vp, struct vattr *vap, cred_t *cr); 267 268 /* For Solaris, interruptible rwlock */ 269 int smbfs_rw_enter_sig(smbfs_rwlock_t *l, krw_t rw, int intr); 270 int smbfs_rw_tryenter(smbfs_rwlock_t *l, krw_t rw); 271 void smbfs_rw_exit(smbfs_rwlock_t *l); 272 int smbfs_rw_lock_held(smbfs_rwlock_t *l, krw_t rw); 273 void smbfs_rw_init(smbfs_rwlock_t *l, char *name, krw_type_t type, void *arg); 274 void smbfs_rw_destroy(smbfs_rwlock_t *l); 275 276 #endif /* !_FS_SMBFS_SMBFS_SUBR_H_ */ 277