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 * Types of find_first, find_next context objects 83 */ 84 typedef enum { 85 ft_LM1 = 1, 86 ft_LM2, 87 ft_XA 88 } smbfs_fctx_type_t; 89 90 /* 91 * Context to perform findfirst/findnext/findclose operations 92 */ 93 #define SMBFS_RDD_FINDFIRST 0x01 94 #define SMBFS_RDD_EOF 0x02 95 #define SMBFS_RDD_FINDSINGLE 0x04 96 /* note SMBFS_RDD_USESEARCH 0x08 replaced by smbfs_fctx_type */ 97 #define SMBFS_RDD_NOCLOSE 0x10 98 #define SMBFS_RDD_GOTRNAME 0x1000 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 char *f_name; /* current file name */ 117 int f_nmlen; /* name len */ 118 int f_namesz; /* memory allocated */ 119 /* 120 * Internal variables 121 */ 122 uint16_t f_limit; /* maximum number of entries */ 123 uint16_t f_attrmask; /* SMB_FA_ */ 124 int f_wclen; 125 const char *f_wildcard; 126 struct smbnode *f_dnp; 127 struct smb_cred *f_scred; 128 struct smb_share *f_ssp; 129 union { 130 struct smb_rq *uf_rq; 131 struct smb_t2rq *uf_t2; 132 } f_urq; 133 int f_left; /* entries left */ 134 int f_ecnt; /* entries left in current response */ 135 int f_eofs; /* entry offset in data block */ 136 uchar_t f_skey[SMB_SKEYLEN]; /* server side search context */ 137 uchar_t f_fname[8 + 1 + 3 + 1]; /* for 8.3 filenames */ 138 uint16_t f_Sid; /* Search handle (like a FID) */ 139 uint16_t f_infolevel; 140 int f_rnamelen; 141 char *f_rname; /* resume name */ 142 int f_rnameofs; 143 int f_otws; /* # over-the-wire ops so far */ 144 char *f_firstnm; /* first filename we got back */ 145 int f_firstnmlen; 146 int f_rkey; /* resume key */ 147 }; 148 typedef struct smbfs_fctx smbfs_fctx_t; 149 150 #define f_rq f_urq.uf_rq 151 #define f_t2 f_urq.uf_t2 152 153 154 /* 155 * smb level 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, uint32_t *attrp, 161 struct smb_cred *scrp); 162 int smbfs_smb_statfs(struct smb_share *ssp, statvfs64_t *sbp, 163 struct smb_cred *scrp); 164 int smbfs_smb_setfsize(struct smbnode *np, uint16_t fid, uint64_t newsize, 165 struct smb_cred *scrp); 166 167 int smbfs_smb_getfattr(struct smbnode *np, struct smbfattr *fap, 168 struct smb_cred *scrp); 169 170 int smbfs_smb_setfattr(struct smbnode *np, uint16_t fid, 171 uint32_t attr, struct timespec *mtime, struct timespec *atime, 172 struct smb_cred *scrp); 173 174 int smbfs_smb_setpattr(struct smbnode *np, 175 uint32_t attr, struct timespec *mtime, struct timespec *atime, 176 struct smb_cred *scrp); 177 178 int smbfs_smb_open(struct smbnode *np, uint32_t rights, struct smb_cred *scrp, 179 int *attrcacheupdated, uint16_t *fidp, const char *name, int nmlen, 180 int xattr, len_t *sizep, uint32_t *rightsp); 181 int smbfs_smb_tmpopen(struct smbnode *np, uint32_t rights, 182 struct smb_cred *scrp, uint16_t *fidp); 183 int smbfs_smb_close(struct smb_share *ssp, uint16_t fid, 184 struct timespec *mtime, struct smb_cred *scrp); 185 int smbfs_smb_tmpclose(struct smbnode *ssp, uint16_t fid, 186 struct smb_cred *scrp); 187 int smbfs_smb_create(struct smbnode *dnp, const char *name, int len, 188 struct smb_cred *scrp, uint16_t *fidp, uint32_t disp, int xattr); 189 int smbfs_smb_delete(struct smbnode *np, struct smb_cred *scrp, 190 const char *name, int len, int xattr); 191 int smbfs_smb_rename(struct smbnode *src, struct smbnode *tdnp, 192 const char *tname, int tnmlen, struct smb_cred *scrp); 193 int smbfs_smb_t2rename(struct smbnode *np, struct smbnode *tdnp, 194 const char *tname, int tnmlen, struct smb_cred *scrp, int overwrite); 195 int smbfs_smb_move(struct smbnode *src, struct smbnode *tdnp, 196 const char *tname, int tnmlen, uint16_t flags, struct smb_cred *scrp); 197 int smbfs_smb_mkdir(struct smbnode *dnp, const char *name, int len, 198 struct smb_cred *scrp); 199 int smbfs_smb_rmdir(struct smbnode *np, struct smb_cred *scrp); 200 int smbfs_smb_findopen(struct smbnode *dnp, const char *wildcard, int wclen, 201 int attr, struct smb_cred *scrp, struct smbfs_fctx **ctxpp); 202 int smbfs_smb_findnext(struct smbfs_fctx *ctx, int limit, 203 struct smb_cred *scrp); 204 int smbfs_smb_findclose(struct smbfs_fctx *ctx, struct smb_cred *scrp); 205 int smbfs_fullpath(struct mbchain *mbp, struct smb_vc *vcp, 206 struct smbnode *dnp, const char *name, int *nmlenp, uint8_t sep); 207 int smbfs_smb_lookup(struct smbnode *dnp, const char **namep, int *nmlenp, 208 struct smbfattr *fap, struct smb_cred *scrp); 209 int smbfs_smb_hideit(struct smbnode *np, const char *name, int len, 210 struct smb_cred *scrp); 211 int smbfs_smb_unhideit(struct smbnode *np, const char *name, int len, 212 struct smb_cred *scrp); 213 int smbfs_smb_flush(struct smbnode *np, struct smb_cred *scrp); 214 int smbfs_0extend(vnode_t *vp, uint16_t fid, len_t from, len_t to, 215 struct smb_cred *scredp, int timo); 216 217 /* get/set security descriptor */ 218 int smbfs_smb_getsec_m(struct smb_share *ssp, uint16_t fid, 219 struct smb_cred *scrp, uint32_t selector, 220 mblk_t **res, uint32_t *reslen); 221 int smbfs_smb_setsec_m(struct smb_share *ssp, uint16_t fid, 222 struct smb_cred *scrp, uint32_t selector, mblk_t **mp); 223 224 int smbfs_getacl(vnode_t *vp, vsecattr_t *vsecattr, 225 int *uidp, int *gidp, int flag, cred_t *cr); 226 int smbfs_setacl(vnode_t *vp, vsecattr_t *vsecattr, 227 int uid, int gid, int flag, cred_t *cr); 228 229 int smbfs_getsd(vnode_t *vp, uint32_t sel, mblk_t **mp, cred_t *cr); 230 int smbfs_setsd(vnode_t *vp, uint32_t sel, mblk_t **mp, cred_t *cr); 231 int smbfs_ioc_getsd(vnode_t *vp, intptr_t arg, int flag, cred_t *cr); 232 int smbfs_ioc_setsd(vnode_t *vp, intptr_t arg, int flag, cred_t *cr); 233 234 #ifdef NOT_YET 235 int smbfs_smb_getsec(struct smb_share *ssp, uint16_t fid, 236 struct smb_cred *scrp, uint32_t selector, struct ntsecdesc **res); 237 int smbfs_smb_setsec(struct smb_share *ssp, uint16_t fid, 238 struct smb_cred *scrp, uint32_t selector, uint16_t flags, 239 struct ntsid *owner, struct ntsid *group, struct ntacl *sacl, 240 struct ntacl *dacl); 241 int smbfs_smb_qstreaminfo(struct smbnode *np, struct smb_cred *scrp, 242 uio_t uio, size_t *sizep); 243 #endif /* NOT_YET */ 244 245 void smbfs_fname_tolocal(struct smbfs_fctx *ctx); 246 247 void smb_time_local2server(struct timespec *tsp, int tzoff, long *seconds); 248 void smb_time_server2local(ulong_t seconds, int tzoff, struct timespec *tsp); 249 void smb_time_NT2local(uint64_t nsec, int tzoff, struct timespec *tsp); 250 void smb_time_local2NT(struct timespec *tsp, int tzoff, uint64_t *nsec); 251 void smb_time_unix2dos(struct timespec *tsp, int tzoff, uint16_t *ddp, 252 uint16_t *dtp, uint8_t *dhp); 253 void smb_dos2unixtime(uint_t dd, uint_t dt, uint_t dh, int tzoff, 254 struct timespec *tsp); 255 256 /* Stuff borrowed from NFS (and then hacked) */ 257 vnode_t *smbfs_make_node(vfs_t *vfsp, 258 const char *dir, int dirlen, 259 const char *name, int nmlen, 260 char sep, struct smbfattr *fap); 261 void smb_addfree(smbnode_t *sp); 262 void smb_addhash(smbnode_t *sp); 263 void smb_rmhash(smbnode_t *); 264 265 int smbfs_subrinit(void); 266 void smbfs_subrfini(void); 267 int smbfs_clntinit(void); 268 void smbfs_clntfini(void); 269 void smbfs_zonelist_add(smbmntinfo_t *smi); 270 void smbfs_zonelist_remove(smbmntinfo_t *smi); 271 void smbfs_destroy_table(struct vfs *vfsp); 272 int smbfs_readvnode(vnode_t *, uio_t *, cred_t *, struct vattr *); 273 int smbfs_writevnode(vnode_t *vp, uio_t *uiop, cred_t *cr, 274 int ioflag, int timo); 275 int smbfsgetattr(vnode_t *vp, struct vattr *vap, cred_t *cr); 276 277 /* smbfs_xattr.c */ 278 int smbfs_get_xattrdir(vnode_t *dvp, vnode_t **vpp, cred_t *cr, int); 279 int smbfs_xa_parent(vnode_t *vp, vnode_t **vpp); 280 int smbfs_xa_exists(vnode_t *vp, cred_t *cr); 281 int smbfs_xa_getfattr(struct smbnode *np, struct smbfattr *fap, 282 struct smb_cred *scrp); 283 int smbfs_xa_findopen(struct smbfs_fctx *ctx, struct smbnode *dnp, 284 const char *name, int nmlen); 285 int smbfs_xa_findnext(struct smbfs_fctx *ctx, uint16_t limit); 286 int smbfs_xa_findclose(struct smbfs_fctx *ctx); 287 288 /* For Solaris, interruptible rwlock */ 289 int smbfs_rw_enter_sig(smbfs_rwlock_t *l, krw_t rw, int intr); 290 int smbfs_rw_tryenter(smbfs_rwlock_t *l, krw_t rw); 291 void smbfs_rw_exit(smbfs_rwlock_t *l); 292 int smbfs_rw_lock_held(smbfs_rwlock_t *l, krw_t rw); 293 void smbfs_rw_init(smbfs_rwlock_t *l, char *name, krw_type_t type, void *arg); 294 void smbfs_rw_destroy(smbfs_rwlock_t *l); 295 296 #endif /* !_FS_SMBFS_SMBFS_SUBR_H_ */ 297