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;
23 /* This should belong in a file.h */
39 charset_t v_volcharset;
40 charset_t v_maccharset;
41 uint16_t v_mtou_flags; /* flags for convert_charset in mtoupath */
42 uint16_t v_utom_flags;
43 long v_kTextEncoding; /* mac charset encoding in network order
44 * FIXME: should be a u_int32_t ? */
47 int v_adouble; /* adouble format: v1, v2, sfm ... */
48 int v_ad_options; /* adouble option NODEV, NOCACHE, etc.. */
49 const char *(*ad_path)(const char *, int);
50 struct _cnid_db *v_cdb;
51 char v_stamp[ADEDLEN_PRIVSYN];
52 VolSpace v_limitsize; /* Size limit, if any, in MiB */
54 mode_t v_dperm; /* default directories permission value OR with requested perm*/
55 mode_t v_fperm; /* default files permission value OR with requested perm*/
56 ucs2_t *v_u8mname; /* converted to utf8-mac in ucs2 */
57 ucs2_t *v_macname; /* mangled to legacy longname in ucs2 */
58 ucs2_t *v_name; /* either v_u8mname or v_macname */
60 /* get/set volparams */
61 time_t v_ctime; /* volume creation date, not unix ctime */
62 dev_t v_dev; /* Unix volume device, Set but not used */
64 /* adouble VFS indirection */
65 struct vfs_ops *vfs; /* pointer to vfs_master_funcs for chaining */
66 const struct vfs_ops *vfs_modules[4];
67 int v_vfs_ea; /* The AFPVOL_EA_xx flag */
73 VolSpace v_tm_used; /* used bytes on a TM volume */
74 time_t v_tm_cachetime; /* time at which v_tm_used was calculated last */
75 VolSpace v_appended; /* amount of data appended to files */
77 /* only when opening/closing volumes or in error */
79 char *v_configname; /* as defined in afpc.conf */
80 char *v_localname; /* as defined in afp.conf but with vars expanded */
89 int v_hide; /* new volume wait until old volume is closed */
90 int v_new; /* volume deleted but there's a new one with the same name */
92 int v_deleted; /* volume open but deleted in new config file */
95 char *v_root_postexec;
97 int v_root_preexec_close;
99 char *v_uuid; /* For TimeMachine zeroconf record */
101 uint32_t v_ignattr; /* AFP attributes that shall be ignored */
104 /* load_volumes() flags */
105 typedef enum {lv_none = 0, lv_all = 1} lv_flags_t;
108 #define AFPVOL_OPEN (1<<0)
109 /* flags for AFS and quota 0xxx0 */
110 #define AFPVOL_GVSMASK (7<<2)
111 #define AFPVOL_NONE (0<<2)
112 #define AFPVOL_AFSGVS (1<<2)
113 #define AFPVOL_USTATFS (1<<3)
114 #define AFPVOL_UQUOTA (1<<4)
117 Flags that alter volume behaviour.
118 Keep in sync with libatalk/util/volinfo.c
120 #define AFPVOL_NOV2TOEACONV (1 << 5) /* no adouble:v2 to adouble:ea conversion */
121 #define AFPVOL_SPOTLIGHT (1 << 6) /* Index volume for Spotlight searches */
122 #define AFPVOL_RO (1 << 8) /* read-only volume */
123 #define AFPVOL_NOSTAT (1 << 16) /* advertise the volume even if we can't stat() it
124 * maybe because it will be mounted later in preexec */
125 #define AFPVOL_UNIX_PRIV (1 << 17) /* support unix privileges */
126 #define AFPVOL_NODEV (1 << 18) /* always use 0 for device number in cnid calls
127 * help if device number is notconsistent across reboot
128 * NOTE symlink to a different device will return an ACCESS error
130 #define AFPVOL_EILSEQ (1 << 20) /* encode illegal sequence 'asis' UCS2, ex "\217-", which is not
131 a valid SHIFT-JIS char, is encoded as U\217 -*/
132 #define AFPVOL_INV_DOTS (1 << 22) /* dots files are invisible */
133 #define AFPVOL_TM (1 << 23) /* Supports TimeMachine */
134 #define AFPVOL_ACLS (1 << 24) /* Volume supports ACLS */
135 #define AFPVOL_SEARCHDB (1 << 25) /* Use fast CNID db search instead of filesystem */
136 #define AFPVOL_NONETIDS (1 << 26) /* signal the client it shall do privelege mapping */
137 #define AFPVOL_FOLLOWSYM (1 << 27) /* follow symlinks on the server, default is not to */
138 #define AFPVOL_DELVETO (1 << 28) /* delete veto files and dirs */
140 /* Extended Attributes vfs indirection */
141 #define AFPVOL_EA_NONE 0 /* No EAs */
142 #define AFPVOL_EA_AUTO 1 /* try sys, fallback to ad (default) */
143 #define AFPVOL_EA_SYS 2 /* Store them in native EAs */
144 #define AFPVOL_EA_AD 3 /* Store them in adouble files */
146 /* FPGetSrvrParms options */
147 #define AFPSRVR_CONFIGINFO (1 << 0)
148 #define AFPSRVR_PASSWD (1 << 7)
150 /* handle casefolding */
151 #define AFPVOL_MTOUUPPER (1 << 0)
152 #define AFPVOL_MTOULOWER (1 << 1)
153 #define AFPVOL_UTOMUPPER (1 << 2)
154 #define AFPVOL_UTOMLOWER (1 << 3)
155 #define AFPVOL_UMLOWER (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
156 #define AFPVOL_UMUPPER (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
157 #define AFPVOL_UUPPERMLOWER (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
158 #define AFPVOL_ULOWERMUPPER (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
160 #define AFPVOLSIG_FLAT 0x0001 /* flat fs */
161 #define AFPVOLSIG_FIX 0x0002 /* fixed ids */
162 #define AFPVOLSIG_VAR 0x0003 /* variable ids */
163 #define AFPVOLSIG_DEFAULT AFPVOLSIG_FIX
165 /* volume attributes */
166 #define VOLPBIT_ATTR_RO (1 << 0)
167 #define VOLPBIT_ATTR_PASSWD (1 << 1)
168 #define VOLPBIT_ATTR_FILEID (1 << 2)
169 #define VOLPBIT_ATTR_CATSEARCH (1 << 3)
170 #define VOLPBIT_ATTR_BLANKACCESS (1 << 4)
171 #define VOLPBIT_ATTR_UNIXPRIV (1 << 5)
172 #define VOLPBIT_ATTR_UTF8 (1 << 6)
173 #define VOLPBIT_ATTR_NONETIDS (1 << 7)
174 #define VOLPBIT_ATTR_EXT_ATTRS (1 << 10)
175 #define VOLPBIT_ATTR_ACLS (1 << 11)
176 #define VOLPBIT_ATTR_TM (1 << 13)
178 #define VOLPBIT_ATTR 0
179 #define VOLPBIT_SIG 1
180 #define VOLPBIT_CDATE 2
181 #define VOLPBIT_MDATE 3
182 #define VOLPBIT_BDATE 4
183 #define VOLPBIT_VID 5
184 #define VOLPBIT_BFREE 6
185 #define VOLPBIT_BTOTAL 7
186 #define VOLPBIT_NAME 8
187 /* handle > 4GB volumes */
188 #define VOLPBIT_XBFREE 9
189 #define VOLPBIT_XBTOTAL 10
190 #define VOLPBIT_BSIZE 11 /* block size */
192 #define utf8_encoding(obj) ((obj)->afp_version >= 30)
194 #define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
195 #define vol_unix_priv(vol) ((vol)->v_obj->afp_version >= 30 && ((vol)->v_flags & AFPVOL_UNIX_PRIV))
196 #define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)
197 #define vol_syml_opt(vol) (((vol)->v_flags & AFPVOL_FOLLOWSYM) ? 0 : O_NOFOLLOW)