xref: /titanic_41/usr/src/uts/common/fs/smbclnt/smbfs/smbfs.h (revision 0a0e9771ca0211c15f3ac4466b661c145feeb9e4)
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.h,v 1.30.100.1 2005/05/27 02:35:28 lindak Exp $
33  */
34 
35 /*
36  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
37  * Use is subject to license terms.
38  */
39 
40 #ifndef	_SMBFS_SMBFS_H
41 #define	_SMBFS_SMBFS_H
42 
43 /*
44  * FS-specific VFS structures for smbfs.
45  * (per-mount stuff, etc.)
46  *
47  * This file used to have mount args stuff,
48  * but that's now in sys/fs/smbfs_mount.h
49  */
50 
51 #include <sys/param.h>
52 #include <sys/fstyp.h>
53 #include <sys/list.h>
54 #include <sys/vfs.h>
55 #include <sys/fs/smbfs_mount.h>
56 
57 /*
58  * Path component length
59  *
60  * The generic fs code uses MAXNAMELEN to represent
61  * what the largest component length is, but note:
62  * that length DOES include the terminating NULL.
63  * SMB_MAXFNAMELEN does NOT include the NULL.
64  */
65 #define	SMB_MAXFNAMELEN		(MAXNAMELEN-1)	/* 255 */
66 
67 /*
68  * SM_MAX_STATFSTIME is the maximum time to cache statvfs data. Since this
69  * should be a fast call on the server, the time the data cached is short.
70  * That lets the cache handle bursts of statvfs() requests without generating
71  * lots of network traffic.
72  */
73 #define	SM_MAX_STATFSTIME 2
74 
75 /* Mask values for smbmount structure sm_status field */
76 #define	SM_STATUS_STATFS_BUSY 0x00000001 /* statvfs is in progress */
77 #define	SM_STATUS_STATFS_WANT 0x00000002 /* statvfs wakeup is wanted */
78 #define	SM_STATUS_TIMEO 0x00000004 /* this mount is not responding */
79 #define	SM_STATUS_DEAD	0x00000010 /* connection gone - unmount this */
80 
81 extern const struct fs_operation_def	smbfs_vnodeops_template[];
82 extern struct vnodeops			*smbfs_vnodeops;
83 
84 struct smbnode;
85 struct smb_share;
86 
87 /*
88  * The values for smi_flags.
89  */
90 #define	SMI_INT		0x01		/* interrupts allowed */
91 #define	SMI_DEAD	0x02		/* zone shutting down */
92 #define	SMI_LLOCK	0x80		/* local locking only */
93 
94 /*
95  * Stuff returned by smbfs_smb_qfsattr
96  * See [CIFS] SMB_QUERY_FS_ATTRIBUTE_INFO
97  */
98 typedef struct smb_fs_attr_info {
99 	uint32_t	fsa_aflags;	/* Attr. flags [CIFS 4.1.6.6] */
100 	uint32_t	fsa_maxname;	/* max. component length */
101 	char		fsa_tname[FSTYPSZ]; /* type name, i.e. "NTFS" */
102 } smb_fs_attr_info_t;
103 
104 /*
105  * Corresponds to Darwin: struct smbmount
106  */
107 typedef struct smbmntinfo {
108 	struct vfs		*smi_vfsp;	/* mount back pointer to vfs */
109 	struct smbnode		*smi_root;	/* the root node */
110 	struct smb_share	*smi_share;	/* netsmb SMB share conn data */
111 	kmutex_t		smi_lock;	/* mutex for flags, etc. */
112 	uint32_t		smi_flags;	/* NFS-derived flag bits */
113 	uint32_t		smi_status;	/* status bits for this mount */
114 	hrtime_t		smi_statfstime;	/* sm_statvfsbuf cache time */
115 	statvfs64_t		smi_statvfsbuf;	/* cached statvfs data */
116 	kcondvar_t		smi_statvfs_cv;
117 	smb_fs_attr_info_t	smi_fsa;	/* SMB FS attributes. */
118 #define	smi_fsattr		smi_fsa.fsa_aflags
119 
120 	/*
121 	 * Kstat statistics
122 	 */
123 	struct kstat    *smi_io_kstats;
124 	struct kstat    *smi_ro_kstats;
125 
126 	/*
127 	 * Zones support.
128 	 */
129 	struct zone		*smi_zone;	/* Zone mounted in */
130 	list_node_t		smi_zone_node;	/* Link to per-zone smi list */
131 	/* Lock for the list is: smi_globals_t -> smg_lock */
132 
133 	/*
134 	 * Copy of the args from mount.
135 	 */
136 	struct smbfs_args	smi_args;
137 } smbmntinfo_t;
138 
139 typedef struct smbfattr {
140 	int		fa_attr;
141 	len_t		fa_size;
142 	struct timespec fa_atime;
143 	struct timespec fa_ctime;
144 	struct timespec fa_mtime;
145 	ino64_t		fa_ino;
146 	struct timespec fa_reqtime;
147 } smbfattr_t;
148 
149 /*
150  * vnode pointer to mount info
151  */
152 #define	VTOSMI(vp)	((smbmntinfo_t *)(((vp)->v_vfsp)->vfs_data))
153 #define	VFTOSMI(vfsp)	((smbmntinfo_t *)((vfsp)->vfs_data))
154 #define	SMBINTR(vp)	(VTOSMI(vp)->smi_flags & SMI_INT)
155 
156 #endif	/* _SMBFS_SMBFS_H */
157