2 * Copyright (c) 1990,1994 Regents of The University of Michigan.
3 * All Rights Reserved. See COPYRIGHT.
7 #define ATALK_VOLUME_H 1
10 #include <sys/cdefs.h>
11 #include <sys/types.h>
13 #include <atalk/unicode.h>
14 #include <atalk/cnid.h>
15 #include <atalk/hash.h>
16 #include <atalk/vfs.h>
18 #define AFPVOL_U8MNAMELEN 255 /* AFP3 sepc */
19 #define AFPVOL_MACNAMELEN 27 /* AFP2 spec */
21 typedef uint64_t VolSpace;
31 charset_t v_volcharset;
32 charset_t v_maccharset;
33 uint16_t v_mtou_flags; /* flags for convert_charset in mtoupath */
34 uint16_t v_utom_flags;
35 long v_kTextEncoding; /* mac charset encoding in network order
36 * FIXME: should be a u_int32_t ? */
39 int v_adouble; /* adouble format: v1, v2, sfm ... */
40 int v_ad_options; /* adouble option NODEV, NOCACHE, etc.. */
41 const char *(*ad_path)(const char *, int);
42 struct _cnid_db *v_cdb;
43 char v_stamp[ADEDLEN_PRIVSYN];
44 VolSpace v_limitsize; /* Size limit, if any, in MiB */
46 mode_t v_perm; /* default permission value OR with requested perm*/
47 mode_t v_dperm; /* default directories permission value OR with requested perm*/
48 mode_t v_fperm; /* default files permission value OR with requested perm*/
49 ucs2_t *v_u8mname; /* converted to utf8-mac in ucs2 */
50 ucs2_t *v_macname; /* mangled to legacy longname in ucs2 */
51 ucs2_t *v_name; /* either v_u8mname or v_macname */
53 /* get/set volparams */
54 time_t v_ctime; /* volume creation date, not unix ctime */
55 dev_t v_dev; /* Unix volume device, Set but not used */
57 /* adouble VFS indirection */
58 struct vfs_ops *vfs; /* pointer to vfs_master_funcs for chaining */
59 const struct vfs_ops *vfs_modules[4];
60 int v_vfs_ea; /* The AFPVOL_EA_xx flag */
66 VolSpace v_tm_used; /* used bytes on a TM volume */
67 time_t v_tm_cachetime; /* time at which v_tm_used was calculated last */
68 VolSpace v_appended; /* amount of data appended to files */
70 /* only when opening/closing volumes or in error */
72 char *v_localname; /* as defined in AppleVolumes.default */
80 int v_hide; /* new volume wait until old volume is closed */
81 int v_new; /* volume deleted but there's a new one with the same name */
82 int v_deleted; /* volume open but deleted in new config file */
85 char *v_root_postexec;
87 int v_root_preexec_close;
89 char *v_uuid; /* For TimeMachine zeroconf record */
95 #define AFPVOL_OPEN (1<<0)
97 /* flags for AFS and quota 0xxx0 */
98 #define AFPVOL_GVSMASK (7<<2)
99 #define AFPVOL_NONE (0<<2)
100 #define AFPVOL_AFSGVS (1<<2)
101 #define AFPVOL_USTATFS (2<<2)
102 #define AFPVOL_UQUOTA (4<<2)
105 Flags that alter volume behaviour.
106 Keep in sync with libatalk/util/volinfo.c
108 #define AFPVOL_A2VOL (1 << 5) /* prodos volume */
109 #define AFPVOL_CRLF (1 << 6) /* cr/lf translation */
110 #define AFPVOL_NOADOUBLE (1 << 7) /* don't create .AppleDouble by default */
111 #define AFPVOL_RO (1 << 8) /* read-only volume */
112 #define AFPVOL_MSWINDOWS (1 << 9) /* deal with ms-windows yuckiness.
113 this is going away. */
114 #define AFPVOL_NOHEX (1 << 10) /* don't do :hex translation */
115 #define AFPVOL_USEDOTS (1 << 11) /* use real dots */
116 #define AFPVOL_LIMITSIZE (1 << 12) /* limit size for older macs */
117 #define AFPVOL_MAPASCII (1 << 13) /* map the ascii range as well */
118 #define AFPVOL_NOFILEID (1 << 15) /* don't advertise createid resolveid and deleteid calls */
119 #define AFPVOL_NOSTAT (1 << 16) /* advertise the volume even if we can't stat() it
120 * maybe because it will be mounted later in preexec */
121 #define AFPVOL_UNIX_PRIV (1 << 17) /* support unix privileges */
122 #define AFPVOL_NODEV (1 << 18) /* always use 0 for device number in cnid calls
123 * help if device number is notconsistent across reboot
124 * NOTE symlink to a different device will return an ACCESS error
126 #define AFPVOL_CASEINSEN (1 << 19) /* volume is case insensitive */
127 #define AFPVOL_EILSEQ (1 << 20) /* encode illegal sequence 'asis' UCS2, ex "\217-", which is not
128 a valid SHIFT-JIS char, is encoded as U\217 -*/
130 #define AFPVOL_CACHE (1 << 21) /* Use adouble v2 CNID caching. Default: yes */
131 #define AFPVOL_INV_DOTS (1 << 22) /* dots files are invisible */
132 #define AFPVOL_TM (1 << 23) /* Supports TimeMachine */
133 #define AFPVOL_ACLS (1 << 24) /* Volume supports ACLS */
134 #define AFPVOL_SEARCHDB (1 << 25) /* Use fast CNID db search instead of filesystem */
135 #define AFPVOL_NONETIDS (1 << 26) /* signal the client it shall do privelege mapping */
137 /* Extended Attributes vfs indirection */
138 #define AFPVOL_EA_NONE 0 /* No EAs */
139 #define AFPVOL_EA_AUTO 1 /* try sys, fallback to ad (default) */
140 #define AFPVOL_EA_SYS 2 /* Store them in native EAs */
141 #define AFPVOL_EA_AD 3 /* Store them in adouble files */
143 /* FPGetSrvrParms options */
144 #define AFPSRVR_CONFIGINFO (1 << 0)
145 #define AFPSRVR_PASSWD (1 << 7)
147 /* handle casefolding */
148 #define AFPVOL_MTOUUPPER (1 << 0)
149 #define AFPVOL_MTOULOWER (1 << 1)
150 #define AFPVOL_UTOMUPPER (1 << 2)
151 #define AFPVOL_UTOMLOWER (1 << 3)
152 #define AFPVOL_UMLOWER (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
153 #define AFPVOL_UMUPPER (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
154 #define AFPVOL_UUPPERMLOWER (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
155 #define AFPVOL_ULOWERMUPPER (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
157 #define MSWINDOWS_BADCHARS ":\t\\/<>*?|\""
159 int wincheck(const struct vol *vol, const char *path);
161 #define AFPVOLSIG_FLAT 0x0001 /* flat fs */
162 #define AFPVOLSIG_FIX 0x0002 /* fixed ids */
163 #define AFPVOLSIG_VAR 0x0003 /* variable ids */
164 #define AFPVOLSIG_DEFAULT AFPVOLSIG_FIX
166 /* volume attributes */
167 #define VOLPBIT_ATTR_RO (1 << 0)
168 #define VOLPBIT_ATTR_PASSWD (1 << 1)
169 #define VOLPBIT_ATTR_FILEID (1 << 2)
170 #define VOLPBIT_ATTR_CATSEARCH (1 << 3)
171 #define VOLPBIT_ATTR_BLANKACCESS (1 << 4)
172 #define VOLPBIT_ATTR_UNIXPRIV (1 << 5)
173 #define VOLPBIT_ATTR_UTF8 (1 << 6)
174 #define VOLPBIT_ATTR_NONETIDS (1 << 7)
175 #define VOLPBIT_ATTR_EXT_ATTRS (1 << 10)
176 #define VOLPBIT_ATTR_ACLS (1 << 11)
177 #define VOLPBIT_ATTR_TM (1 << 13)
179 #define VOLPBIT_ATTR 0
180 #define VOLPBIT_SIG 1
181 #define VOLPBIT_CDATE 2
182 #define VOLPBIT_MDATE 3
183 #define VOLPBIT_BDATE 4
184 #define VOLPBIT_VID 5
185 #define VOLPBIT_BFREE 6
186 #define VOLPBIT_BTOTAL 7
187 #define VOLPBIT_NAME 8
188 /* handle > 4GB volumes */
189 #define VOLPBIT_XBFREE 9
190 #define VOLPBIT_XBTOTAL 10
191 #define VOLPBIT_BSIZE 11 /* block size */
193 #define utf8_encoding() (afp_version >= 30)
195 #define vol_noadouble(vol) ((((vol)->v_flags & AFPVOL_NOADOUBLE) \
196 || ((vol)->v_adouble & AD_VERSION_EA)) ? 1 : 0)
197 #define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
198 #define vol_unix_priv(vol) (afp_version >= 30 && ((vol)->v_flags & AFPVOL_UNIX_PRIV))
199 #define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)