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/types.h>
12 #include <atalk/unicode.h>
13 #include <atalk/cnid.h>
14 #include <atalk/hash.h>
15 #include <atalk/vfs.h>
16 #include <atalk/globals.h>
18 #define AFPVOL_U8MNAMELEN 255 /* AFP3 sepc */
19 #define AFPVOL_MACNAMELEN 27 /* AFP2 spec */
21 typedef uint64_t VolSpace;
32 charset_t v_volcharset;
33 charset_t v_maccharset;
34 uint16_t v_mtou_flags; /* flags for convert_charset in mtoupath */
35 uint16_t v_utom_flags;
36 long v_kTextEncoding; /* mac charset encoding in network order
37 * FIXME: should be a u_int32_t ? */
40 int v_adouble; /* adouble format: v1, v2, sfm ... */
41 int v_ad_options; /* adouble option NODEV, NOCACHE, etc.. */
42 const char *(*ad_path)(const char *, int);
43 struct _cnid_db *v_cdb;
44 char v_stamp[ADEDLEN_PRIVSYN];
45 VolSpace v_limitsize; /* Size limit, if any, in MiB */
47 mode_t v_perm; /* default permission value OR with requested perm*/
48 mode_t v_dperm; /* default directories permission value OR with requested perm*/
49 mode_t v_fperm; /* default files permission value OR with requested perm*/
50 ucs2_t *v_u8mname; /* converted to utf8-mac in ucs2 */
51 ucs2_t *v_macname; /* mangled to legacy longname in ucs2 */
52 ucs2_t *v_name; /* either v_u8mname or v_macname */
54 /* get/set volparams */
55 time_t v_ctime; /* volume creation date, not unix ctime */
56 dev_t v_dev; /* Unix volume device, Set but not used */
58 /* adouble VFS indirection */
59 struct vfs_ops *vfs; /* pointer to vfs_master_funcs for chaining */
60 const struct vfs_ops *vfs_modules[4];
61 int v_vfs_ea; /* The AFPVOL_EA_xx flag */
67 VolSpace v_tm_used; /* used bytes on a TM volume */
68 time_t v_tm_cachetime; /* time at which v_tm_used was calculated last */
69 VolSpace v_appended; /* amount of data appended to files */
71 /* only when opening/closing volumes or in error */
73 char *v_configname; /* as defined in afpc.conf */
74 char *v_localname; /* as defined in afp.conf but with vars expanded */
83 int v_hide; /* new volume wait until old volume is closed */
84 int v_new; /* volume deleted but there's a new one with the same name */
86 int v_deleted; /* volume open but deleted in new config file */
89 char *v_root_postexec;
91 int v_root_preexec_close;
93 char *v_uuid; /* For TimeMachine zeroconf record */
99 /* load_volumes() flags */
100 #define LV_ALL (1 << 0)
103 #define AFPVOL_OPEN (1<<0)
104 /* flags for AFS and quota 0xxx0 */
105 #define AFPVOL_GVSMASK (7<<2)
106 #define AFPVOL_NONE (0<<2)
107 #define AFPVOL_AFSGVS (1<<2)
108 #define AFPVOL_USTATFS (1<<3)
109 #define AFPVOL_UQUOTA (1<<4)
112 Flags that alter volume behaviour.
113 Keep in sync with libatalk/util/volinfo.c
115 #define AFPVOL_NOV2TOEACONV (1 << 5) /* no adouble:v2 to adouble:ea conversion */
116 #define AFPVOL_UNIX_CTXT (1 << 6) /* volume created by getvolbypath ie UNIX access, not afpd AFP user session */
117 #define AFPVOL_RO (1 << 8) /* read-only volume */
118 #define AFPVOL_NOHEX (1 << 10) /* don't do :hex translation */
119 #define AFPVOL_USEDOTS (1 << 11) /* use real dots */
120 #define AFPVOL_NOSTAT (1 << 16) /* advertise the volume even if we can't stat() it
121 * maybe because it will be mounted later in preexec */
122 #define AFPVOL_UNIX_PRIV (1 << 17) /* support unix privileges */
123 #define AFPVOL_NODEV (1 << 18) /* always use 0 for device number in cnid calls
124 * help if device number is notconsistent across reboot
125 * NOTE symlink to a different device will return an ACCESS error
127 #define AFPVOL_CASEINSEN (1 << 19) /* volume is case insensitive */
128 #define AFPVOL_EILSEQ (1 << 20) /* encode illegal sequence 'asis' UCS2, ex "\217-", which is not
129 a valid SHIFT-JIS char, is encoded as U\217 -*/
130 #define AFPVOL_INV_DOTS (1 << 22) /* dots files are invisible */
131 #define AFPVOL_TM (1 << 23) /* Supports TimeMachine */
132 #define AFPVOL_ACLS (1 << 24) /* Volume supports ACLS */
133 #define AFPVOL_SEARCHDB (1 << 25) /* Use fast CNID db search instead of filesystem */
134 #define AFPVOL_NONETIDS (1 << 26) /* signal the client it shall do privelege mapping */
136 /* Extended Attributes vfs indirection */
137 #define AFPVOL_EA_NONE 0 /* No EAs */
138 #define AFPVOL_EA_AUTO 1 /* try sys, fallback to ad (default) */
139 #define AFPVOL_EA_SYS 2 /* Store them in native EAs */
140 #define AFPVOL_EA_AD 3 /* Store them in adouble files */
142 /* FPGetSrvrParms options */
143 #define AFPSRVR_CONFIGINFO (1 << 0)
144 #define AFPSRVR_PASSWD (1 << 7)
146 /* handle casefolding */
147 #define AFPVOL_MTOUUPPER (1 << 0)
148 #define AFPVOL_MTOULOWER (1 << 1)
149 #define AFPVOL_UTOMUPPER (1 << 2)
150 #define AFPVOL_UTOMLOWER (1 << 3)
151 #define AFPVOL_UMLOWER (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
152 #define AFPVOL_UMUPPER (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
153 #define AFPVOL_UUPPERMLOWER (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
154 #define AFPVOL_ULOWERMUPPER (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
156 #define AFPVOLSIG_FLAT 0x0001 /* flat fs */
157 #define AFPVOLSIG_FIX 0x0002 /* fixed ids */
158 #define AFPVOLSIG_VAR 0x0003 /* variable ids */
159 #define AFPVOLSIG_DEFAULT AFPVOLSIG_FIX
161 /* volume attributes */
162 #define VOLPBIT_ATTR_RO (1 << 0)
163 #define VOLPBIT_ATTR_PASSWD (1 << 1)
164 #define VOLPBIT_ATTR_FILEID (1 << 2)
165 #define VOLPBIT_ATTR_CATSEARCH (1 << 3)
166 #define VOLPBIT_ATTR_BLANKACCESS (1 << 4)
167 #define VOLPBIT_ATTR_UNIXPRIV (1 << 5)
168 #define VOLPBIT_ATTR_UTF8 (1 << 6)
169 #define VOLPBIT_ATTR_NONETIDS (1 << 7)
170 #define VOLPBIT_ATTR_EXT_ATTRS (1 << 10)
171 #define VOLPBIT_ATTR_ACLS (1 << 11)
172 #define VOLPBIT_ATTR_TM (1 << 13)
174 #define VOLPBIT_ATTR 0
175 #define VOLPBIT_SIG 1
176 #define VOLPBIT_CDATE 2
177 #define VOLPBIT_MDATE 3
178 #define VOLPBIT_BDATE 4
179 #define VOLPBIT_VID 5
180 #define VOLPBIT_BFREE 6
181 #define VOLPBIT_BTOTAL 7
182 #define VOLPBIT_NAME 8
183 /* handle > 4GB volumes */
184 #define VOLPBIT_XBFREE 9
185 #define VOLPBIT_XBTOTAL 10
186 #define VOLPBIT_BSIZE 11 /* block size */
188 #define utf8_encoding(obj) ((obj)->afp_version >= 30)
190 #define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
191 #define vol_unix_priv(vol) ((vol)->v_obj->afp_version >= 30 && ((vol)->v_flags & AFPVOL_UNIX_PRIV))
192 #define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)