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