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 2012 Nexenta Systems, Inc. All rights reserved. 37 * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 38 * Use is subject to license terms. 39 */ 40 41 #ifndef _FS_SMBFS_SMBFS_SUBR_H_ 42 #define _FS_SMBFS_SMBFS_SUBR_H_ 43 44 #include <sys/cmn_err.h> 45 #include <netsmb/mchain.h> 46 #include <netsmb/smb_subr.h> 47 #include <smbfs/smbfs_node.h> 48 49 #if defined(DEBUG) || defined(lint) 50 #define SMB_VNODE_DEBUG 1 51 #endif 52 53 #ifndef FALSE 54 #define FALSE (0) 55 #endif 56 57 #ifndef TRUE 58 #define TRUE (1) 59 #endif 60 61 /* 62 * Let's use C99 standard variadic macros! 63 * Also the C99 __func__ (function name) feature. 64 */ 65 #define SMBFSERR(...) \ 66 smb_errmsg(CE_NOTE, __func__, __VA_ARGS__) 67 #define SMBVDEBUG(...) \ 68 smb_errmsg(CE_CONT, __func__, __VA_ARGS__) 69 70 /* 71 * Possible lock commands 72 */ 73 #define SMB_LOCK_EXCL 0 74 #define SMB_LOCK_SHARED 1 75 #define SMB_LOCK_RELEASE 2 76 77 struct smb_cred; 78 struct smb_vc; 79 struct statvfs; 80 struct timespec; 81 82 /* 83 * Types of find_first, find_next context objects 84 */ 85 typedef enum { 86 ft_LM1 = 1, 87 ft_LM2, 88 ft_XA 89 } smbfs_fctx_type_t; 90 91 /* 92 * Context to perform findfirst/findnext/findclose operations 93 */ 94 #define SMBFS_RDD_FINDFIRST 0x01 95 #define SMBFS_RDD_EOF 0x02 96 #define SMBFS_RDD_FINDSINGLE 0x04 97 /* note SMBFS_RDD_USESEARCH 0x08 replaced by smbfs_fctx_type */ 98 #define SMBFS_RDD_NOCLOSE 0x10 99 100 /* 101 * Search context supplied by server 102 */ 103 #define SMB_SKEYLEN 21 /* search context */ 104 #define SMB_DENTRYLEN (SMB_SKEYLEN + 22) /* entire entry */ 105 106 struct smbfs_fctx { 107 /* 108 * Setable values 109 */ 110 smbfs_fctx_type_t f_type; 111 int f_flags; /* SMBFS_RDD_ */ 112 /* 113 * Return values 114 */ 115 struct smbfattr f_attr; /* current attributes */ 116 u_longlong_t f_inum; /* current I number */ 117 char *f_name; /* current file name */ 118 int f_nmlen; /* name len */ 119 int f_namesz; /* memory allocated */ 120 /* 121 * Internal variables 122 */ 123 uint16_t f_limit; /* maximum number of entries */ 124 uint16_t f_attrmask; /* SMB_FA_ */ 125 int f_wclen; 126 const char *f_wildcard; 127 struct smbnode *f_dnp; 128 struct smb_cred *f_scred; 129 struct smb_share *f_ssp; 130 union { 131 struct smb_rq *uf_rq; 132 struct smb_t2rq *uf_t2; 133 } f_urq; 134 int f_left; /* entries left */ 135 int f_ecnt; /* entries left in current response */ 136 int f_eofs; /* entry offset in data block */ 137 uchar_t f_skey[SMB_SKEYLEN]; /* server side search context */ 138 uchar_t f_fname[8 + 1 + 3 + 1]; /* for 8.3 filenames */ 139 uint16_t f_Sid; /* Search handle (like a FID) */ 140 uint16_t f_infolevel; 141 int f_rnamelen; 142 char *f_rname; /* resume name */ 143 int f_rnameofs; 144 int f_otws; /* # over-the-wire ops so far */ 145 char *f_firstnm; /* first filename we got back */ 146 int f_firstnmlen; 147 int f_rkey; /* resume key */ 148 }; 149 typedef struct smbfs_fctx smbfs_fctx_t; 150 151 #define f_rq f_urq.uf_rq 152 #define f_t2 f_urq.uf_t2 153 154 /* 155 * smb level (smbfs_smb.c) 156 */ 157 int smbfs_smb_lock(struct smbnode *np, int op, caddr_t id, 158 offset_t start, uint64_t len, int largelock, 159 struct smb_cred *scrp, uint32_t timeout); 160 int smbfs_smb_qfsattr(struct smb_share *ssp, struct smb_fs_attr_info *, 161 struct smb_cred *scrp); 162 int smbfs_smb_statfs(struct smb_share *ssp, statvfs64_t *sbp, 163 struct smb_cred *scrp); 164 165 int smbfs_smb_setdisp(struct smbnode *np, uint16_t fid, uint8_t newdisp, 166 struct smb_cred *scrp); 167 int smbfs_smb_setfsize(struct smbnode *np, uint16_t fid, uint64_t newsize, 168 struct smb_cred *scrp); 169 170 int smbfs_smb_getfattr(struct smbnode *np, struct smbfattr *fap, 171 struct smb_cred *scrp); 172 173 int smbfs_smb_setfattr(struct smbnode *np, int fid, 174 uint32_t attr, struct timespec *mtime, struct timespec *atime, 175 struct smb_cred *scrp); 176 177 int smbfs_smb_open(struct smbnode *np, const char *name, int nmlen, 178 int xattr, uint32_t rights, struct smb_cred *scrp, 179 uint16_t *fidp, uint32_t *rightsp, struct smbfattr *fap); 180 int smbfs_smb_tmpopen(struct smbnode *np, uint32_t rights, 181 struct smb_cred *scrp, uint16_t *fidp); 182 int smbfs_smb_close(struct smb_share *ssp, uint16_t fid, 183 struct timespec *mtime, struct smb_cred *scrp); 184 int smbfs_smb_tmpclose(struct smbnode *ssp, uint16_t fid, 185 struct smb_cred *scrp); 186 int smbfs_smb_create(struct smbnode *dnp, const char *name, int nmlen, 187 int xattr, uint32_t disp, struct smb_cred *scrp, uint16_t *fidp); 188 int smbfs_smb_delete(struct smbnode *np, struct smb_cred *scrp, 189 const char *name, int len, int xattr); 190 int smbfs_smb_rename(struct smbnode *src, struct smbnode *tdnp, 191 const char *tname, int tnmlen, struct smb_cred *scrp); 192 int smbfs_smb_t2rename(struct smbnode *np, const char *tname, int tnmlen, 193 struct smb_cred *scrp, uint16_t fid, int replace); 194 int smbfs_smb_move(struct smbnode *src, struct smbnode *tdnp, 195 const char *tname, int tnmlen, uint16_t flags, struct smb_cred *scrp); 196 int smbfs_smb_mkdir(struct smbnode *dnp, const char *name, int len, 197 struct smb_cred *scrp); 198 int smbfs_smb_rmdir(struct smbnode *np, struct smb_cred *scrp); 199 int smbfs_smb_findopen(struct smbnode *dnp, const char *wildcard, int wclen, 200 int attr, struct smb_cred *scrp, struct smbfs_fctx **ctxpp); 201 int smbfs_smb_findnext(struct smbfs_fctx *ctx, int limit, 202 struct smb_cred *scrp); 203 int smbfs_smb_findclose(struct smbfs_fctx *ctx, struct smb_cred *scrp); 204 int smbfs_fullpath(struct mbchain *mbp, struct smb_vc *vcp, 205 struct smbnode *dnp, const char *name, int nmlen, uint8_t sep); 206 int smbfs_smb_lookup(struct smbnode *dnp, const char **namep, int *nmlenp, 207 struct smbfattr *fap, struct smb_cred *scrp); 208 int smbfs_smb_hideit(struct smbnode *np, const char *name, int len, 209 struct smb_cred *scrp); 210 int smbfs_smb_unhideit(struct smbnode *np, const char *name, int len, 211 struct smb_cred *scrp); 212 int smbfs_smb_flush(struct smbnode *np, struct smb_cred *scrp); 213 int smbfs_0extend(vnode_t *vp, uint16_t fid, len_t from, len_t to, 214 struct smb_cred *scredp, int timo); 215 216 /* get/set security descriptor */ 217 int smbfs_smb_getsec_m(struct smb_share *ssp, uint16_t fid, 218 struct smb_cred *scrp, uint32_t selector, 219 mblk_t **res, uint32_t *reslen); 220 int smbfs_smb_setsec_m(struct smb_share *ssp, uint16_t fid, 221 struct smb_cred *scrp, uint32_t selector, mblk_t **mp); 222 223 /* 224 * VFS-level init, fini stuff 225 */ 226 227 int smbfs_vfsinit(void); 228 void smbfs_vfsfini(void); 229 int smbfs_subrinit(void); 230 void smbfs_subrfini(void); 231 int smbfs_clntinit(void); 232 void smbfs_clntfini(void); 233 234 void smbfs_zonelist_add(smbmntinfo_t *smi); 235 void smbfs_zonelist_remove(smbmntinfo_t *smi); 236 237 int smbfs_check_table(struct vfs *vfsp, struct smbnode *srp); 238 void smbfs_destroy_table(struct vfs *vfsp); 239 void smbfs_rflush(struct vfs *vfsp, cred_t *cr); 240 void smbfs_flushall(cred_t *cr); 241 242 int smbfs_directio(vnode_t *vp, int cmd, cred_t *cr); 243 244 uint32_t smbfs_newnum(void); 245 int smbfs_newname(char *buf, size_t buflen); 246 247 /* 248 * Function definitions - those having to do with 249 * smbfs nodes, vnodes, etc 250 */ 251 252 void smbfs_attrcache_prune(struct smbnode *np); 253 void smbfs_attrcache_remove(struct smbnode *np); 254 void smbfs_attrcache_rm_locked(struct smbnode *np); 255 #ifndef DEBUG 256 #define smbfs_attrcache_rm_locked(np) (np)->r_attrtime = gethrtime() 257 #endif 258 void smbfs_attr_touchdir(struct smbnode *dnp); 259 void smbfs_attrcache_fa(vnode_t *vp, struct smbfattr *fap); 260 261 int smbfs_validate_caches(struct vnode *vp, cred_t *cr); 262 void smbfs_purge_caches(struct vnode *vp, cred_t *cr); 263 264 void smbfs_addfree(struct smbnode *sp); 265 void smbfs_rmhash(struct smbnode *); 266 267 /* See avl_create in smbfs_vfsops.c */ 268 void smbfs_init_hash_avl(avl_tree_t *); 269 270 uint32_t smbfs_gethash(const char *rpath, int prlen); 271 uint32_t smbfs_getino(struct smbnode *dnp, const char *name, int nmlen); 272 273 extern struct smbfattr smbfs_fattr0; 274 smbnode_t *smbfs_node_findcreate(smbmntinfo_t *mi, 275 const char *dir, int dirlen, 276 const char *name, int nmlen, 277 char sep, struct smbfattr *fap); 278 279 int smbfs_nget(vnode_t *dvp, const char *name, int nmlen, 280 struct smbfattr *fap, vnode_t **vpp); 281 282 void smbfs_fname_tolocal(struct smbfs_fctx *ctx); 283 char *smbfs_name_alloc(const char *name, int nmlen); 284 void smbfs_name_free(const char *name, int nmlen); 285 286 int smbfs_readvnode(vnode_t *, uio_t *, cred_t *, struct vattr *); 287 int smbfs_writevnode(vnode_t *vp, uio_t *uiop, cred_t *cr, 288 int ioflag, int timo); 289 int smbfsgetattr(vnode_t *vp, struct vattr *vap, cred_t *cr); 290 291 void smbfs_invalidate_pages(vnode_t *vp, u_offset_t off, cred_t *cr); 292 293 /* smbfs ACL support */ 294 int smbfs_acl_getids(vnode_t *, cred_t *); 295 int smbfs_acl_setids(vnode_t *, vattr_t *, cred_t *); 296 int smbfs_acl_getvsa(vnode_t *, vsecattr_t *, int, cred_t *); 297 int smbfs_acl_setvsa(vnode_t *, vsecattr_t *, int, cred_t *); 298 int smbfs_acl_iocget(vnode_t *, intptr_t, int, cred_t *); 299 int smbfs_acl_iocset(vnode_t *, intptr_t, int, cred_t *); 300 301 /* smbfs_xattr.c */ 302 int smbfs_get_xattrdir(vnode_t *dvp, vnode_t **vpp, cred_t *cr, int); 303 int smbfs_xa_parent(vnode_t *vp, vnode_t **vpp); 304 int smbfs_xa_exists(vnode_t *vp, cred_t *cr); 305 int smbfs_xa_getfattr(struct smbnode *np, struct smbfattr *fap, 306 struct smb_cred *scrp); 307 int smbfs_xa_findopen(struct smbfs_fctx *ctx, struct smbnode *dnp, 308 const char *name, int nmlen); 309 int smbfs_xa_findnext(struct smbfs_fctx *ctx, uint16_t limit); 310 int smbfs_xa_findclose(struct smbfs_fctx *ctx); 311 312 /* For Solaris, interruptible rwlock */ 313 int smbfs_rw_enter_sig(smbfs_rwlock_t *l, krw_t rw, int intr); 314 int smbfs_rw_tryenter(smbfs_rwlock_t *l, krw_t rw); 315 void smbfs_rw_exit(smbfs_rwlock_t *l); 316 int smbfs_rw_lock_held(smbfs_rwlock_t *l, krw_t rw); 317 void smbfs_rw_init(smbfs_rwlock_t *l, char *name, krw_type_t type, void *arg); 318 void smbfs_rw_destroy(smbfs_rwlock_t *l); 319 320 #endif /* !_FS_SMBFS_SMBFS_SUBR_H_ */ 321