2 * $Id: volume.h,v 1.7 2009-11-17 12:33:30 franklahm Exp $
4 * Copyright (c) 1990,1994 Regents of The University of Michigan.
5 * All Rights Reserved. See COPYRIGHT.
9 #define ATALK_VOLUME_H 1
11 #include <sys/cdefs.h>
12 #include <sys/types.h>
13 #include <netatalk/endian.h>
15 #include <atalk/unicode.h>
16 #include <atalk/cnid.h>
17 #include <atalk/hash.h>
18 #include <atalk/vfs.h>
20 #define AFPVOL_U8MNAMELEN 255 /* AFP3 sepc */
21 #define AFPVOL_MACNAMELEN 27 /* AFP2 spec */
30 struct dir *v_dir, *v_root;
31 struct dir *v_curdir; /* cache */
36 charset_t v_volcharset;
37 charset_t v_maccharset;
39 u_int16_t v_mtou_flags; /* flags for convert_charset in mtoupath */
40 u_int16_t v_utom_flags;
42 long v_kTextEncoding; /* mac charset encoding in network order
43 * XXX should be a u_int32_t ?
49 int v_adouble; /* default adouble format */
50 int v_ad_options; /* adouble option NODEV, NOCACHE, etc.. */
51 char *(*ad_path)(const char *, int);
53 struct _cnid_db *v_cdb;
54 char v_stamp[ADEDLEN_PRIVSYN];
56 mode_t v_perm; /* default permission value OR with requested perm*/
57 mode_t v_dperm; /* default directories permission value OR with requested perm*/
58 mode_t v_fperm; /* default files permission value OR with requested perm*/
65 /* adouble indirection */
66 struct vfs_ops *vfs; /* pointer to vfs_master_funcs for chaining */
67 const struct vfs_ops *vfs_modules[4];
68 int v_vfs_ea; /* The AFPVOL_EA_xx flag */
70 ucs2_t *v_u8mname; /* converted to utf8-mac in ucs2 */
71 ucs2_t *v_macname; /* mangled to legacy longname in ucs2 */
72 ucs2_t *v_name; /* either v_u8mname or v_macname */
74 /* get/set volparams */
75 time_t v_ctime; /* volume creation date, not unix ctime */
77 dev_t v_dev; /* Unix volume device, Set but not used */
86 /* only when opening/closing volumes or in error */
89 char *v_localname; /* as defined in AppleVolumes.default */
98 int v_hide; /* new volume wait until old volume is closed */
99 int v_new; /* volume deleted but there's a new one with the same name */
100 int v_deleted; /* volume open but deleted in new config file */
101 char *v_root_preexec;
104 char *v_root_postexec;
107 int v_root_preexec_close;
112 #ifdef NO_LARGE_VOL_SUPPORT
113 typedef u_int32_t VolSpace;
114 #else /* NO_LARGE_VOL_SUPPORT */
115 typedef u_int64_t VolSpace;
116 #endif /* NO_LARGE_VOL_SUPPORT */
118 #define AFPVOL_OPEN (1<<0)
120 /* flags for AFS and quota 0xxx0 */
121 #define AFPVOL_GVSMASK (7<<2)
122 #define AFPVOL_NONE (0<<2)
123 #define AFPVOL_AFSGVS (1<<2)
124 #define AFPVOL_USTATFS (2<<2)
125 #define AFPVOL_UQUOTA (4<<2)
128 Flags that alter volume behaviour.
129 Keep in sync with include/atalk/volinfo.h and libatalk/util/volinfo.c
131 #define AFPVOL_A2VOL (1 << 5) /* prodos volume */
132 #define AFPVOL_CRLF (1 << 6) /* cr/lf translation */
133 #define AFPVOL_NOADOUBLE (1 << 7) /* don't create .AppleDouble by default */
134 #define AFPVOL_RO (1 << 8) /* read-only volume */
135 #define AFPVOL_MSWINDOWS (1 << 9) /* deal with ms-windows yuckiness.
136 this is going away. */
137 #define AFPVOL_NOHEX (1 << 10) /* don't do :hex translation */
138 #define AFPVOL_USEDOTS (1 << 11) /* use real dots */
139 #define AFPVOL_LIMITSIZE (1 << 12) /* limit size for older macs */
140 #define AFPVOL_MAPASCII (1 << 13) /* map the ascii range as well */
141 #define AFPVOL_DROPBOX (1 << 14) /* dropkludge dropbox support */
142 #define AFPVOL_NOFILEID (1 << 15) /* don't advertise createid resolveid and deleteid calls */
143 #define AFPVOL_NOSTAT (1 << 16) /* advertise the volume even if we can't stat() it
144 * maybe because it will be mounted later in preexec */
145 #define AFPVOL_UNIX_PRIV (1 << 17) /* support unix privileges */
146 #define AFPVOL_NODEV (1 << 18) /* always use 0 for device number in cnid calls
147 * help if device number is notconsistent across reboot
148 * NOTE symlink to a different device will return an ACCESS error
150 #define AFPVOL_CASEINSEN (1 << 19) /* volume is case insensitive */
151 #define AFPVOL_EILSEQ (1 << 20) /* encode illegal sequence 'asis' UCS2, ex "\217-", which is not
152 a valid SHIFT-JIS char, is encoded as U\217 -*/
154 #define AFPVOL_CACHE (1 << 21) /* Use adouble v2 CNID caching. Default: yes */
155 #define AFPVOL_INV_DOTS (1 << 22) /* dots files are invisible */
156 #define AFPVOL_TM (1 << 24) /* Supports TimeMachine */
157 #define AFPVOL_ACLS (1 << 25) /* Volume supports ACLS */
159 /* Extended Attributes vfs indirection */
160 #define AFPVOL_EA_AD 0 /* Store them in adouble files. Default. */
161 #define AFPVOL_EA_SYS 1 /* Store them in native EAs */
163 /* FPGetSrvrParms options */
164 #define AFPSRVR_CONFIGINFO (1 << 0)
165 #define AFPSRVR_PASSWD (1 << 7)
167 /* handle casefolding */
168 #define AFPVOL_MTOUUPPER (1 << 0)
169 #define AFPVOL_MTOULOWER (1 << 1)
170 #define AFPVOL_UTOMUPPER (1 << 2)
171 #define AFPVOL_UTOMLOWER (1 << 3)
172 #define AFPVOL_UMLOWER (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
173 #define AFPVOL_UMUPPER (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
174 #define AFPVOL_UUPPERMLOWER (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
175 #define AFPVOL_ULOWERMUPPER (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
177 #define MSWINDOWS_BADCHARS ":\t\\/<>*?|\""
179 int wincheck(const struct vol *vol, const char *path);
181 #define AFPVOLSIG_FLAT 0x0001 /* flat fs */
182 #define AFPVOLSIG_FIX 0x0002 /* fixed ids */
183 #define AFPVOLSIG_VAR 0x0003 /* variable ids */
184 #define AFPVOLSIG_DEFAULT AFPVOLSIG_FIX
186 /* volume attributes */
187 #define VOLPBIT_ATTR_RO (1 << 0)
188 #define VOLPBIT_ATTR_PASSWD (1 << 1)
189 #define VOLPBIT_ATTR_FILEID (1 << 2)
190 #define VOLPBIT_ATTR_CATSEARCH (1 << 3)
191 #define VOLPBIT_ATTR_BLANKACCESS (1 << 4)
192 #define VOLPBIT_ATTR_UNIXPRIV (1 << 5)
193 #define VOLPBIT_ATTR_UTF8 (1 << 6)
194 #define VOLPBIT_ATTR_NONETUID (1 << 7)
195 #define VOLPBIT_ATTR_EXT_ATTRS (1 << 10)
196 #define VOLPBIT_ATTR_ACLS (1 << 11)
197 #define VOLPBIT_ATTR_TM (1 << 13)
199 #define VOLPBIT_ATTR 0
200 #define VOLPBIT_SIG 1
201 #define VOLPBIT_CDATE 2
202 #define VOLPBIT_MDATE 3
203 #define VOLPBIT_BDATE 4
204 #define VOLPBIT_VID 5
205 #define VOLPBIT_BFREE 6
206 #define VOLPBIT_BTOTAL 7
207 #define VOLPBIT_NAME 8
208 /* handle > 4GB volumes */
209 #define VOLPBIT_XBFREE 9
210 #define VOLPBIT_XBTOTAL 10
211 #define VOLPBIT_BSIZE 11 /* block size */
214 #define vol_noadouble(vol) (((vol)->v_flags & AFPVOL_NOADOUBLE) ? \
215 ADFLAGS_NOADOUBLE : 0)
217 #define utf8_encoding() (afp_version >= 30)
219 #define utf8_encoding() (0)
222 #define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
223 #define vol_unix_priv(vol) (afp_version >= 30 && ((vol)->v_flags & AFPVOL_UNIX_PRIV))
224 #define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)