2 * Copyright (c) 1990,1991 Regents of The University of Michigan.
5 * Permission to use, copy, modify, and distribute this software and
6 * its documentation for any purpose and without fee is hereby granted,
7 * provided that the above copyright notice appears in all copies and
8 * that both that copyright notice and this permission notice appear
9 * in supporting documentation, and that the name of The University
10 * of Michigan not be used in advertising or publicity pertaining to
11 * distribution of the software without specific, written prior
12 * permission. This software is supplied as is without expressed or
13 * implied warranties of any kind.
15 * Research Systems Unix Group
16 * The University of Michigan
18 * 535 W. William Street
21 * netatalk@itd.umich.edu
26 * @brief Part of Netatalk's AppleDouble implementatation
29 #ifndef _ATALK_ADOUBLE_H
30 #define _ATALK_ADOUBLE_H
36 #include <atalk/standards.h>
39 #include <sys/types.h>
48 #include <atalk/bstrlib.h>
51 #define AD_VERSION2 0x00020000
52 #define AD_VERSION2_OSX 0x00020001
53 #define AD_VERSION_EA 0x00020002
56 #define AD_VERSION AD_VERSION2
59 * AppleDouble entry IDs.
64 #define ADEID_COMMENT 4
65 #define ADEID_ICONBW 5
66 #define ADEID_ICONCOL 6
67 #define ADEID_FILEI 7 /* v1, replaced by: */
68 #define ADEID_FILEDATESI 8 /* this */
69 #define ADEID_FINDERI 9
70 #define ADEID_MACFILEI 10 /* we don't use this */
71 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
72 #define ADEID_MSDOSFILEI 12 /* we don't use this */
73 #define ADEID_SHORTNAME 13
74 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
77 /* netatalk private note fileid reused DID */
78 #define ADEID_PRIVDEV 16
79 #define ADEID_PRIVINO 17
80 #define ADEID_PRIVSYN 18 /* in synch with database */
81 #define ADEID_PRIVID 19
82 #define ADEID_MAX (ADEID_PRIVID + 1)
84 /* These are the real ids for these entries, as stored in the adouble file */
85 #define AD_DEV 0x80444556
86 #define AD_INO 0x80494E4F
87 #define AD_SYN 0x8053594E
88 #define AD_ID 0x8053567E
91 #define AD_APPLESINGLE_MAGIC 0x00051600
92 #define AD_APPLEDOUBLE_MAGIC 0x00051607
93 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
95 /* sizes of relevant entry bits */
96 #define ADEDLEN_MAGIC 4
97 #define ADEDLEN_VERSION 4
98 #define ADEDLEN_FILLER 16
99 #define ADEDLEN_NENTRIES 2
100 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + ADEDLEN_FILLER + ADEDLEN_NENTRIES) /* 26 */
101 #define AD_ENTRY_LEN 12 /* size of a single entry header */
104 #define ADEDLEN_NAME 255
105 #define ADEDLEN_COMMENT 200
106 #define ADEDLEN_FILEI 16
107 #define ADEDLEN_FINDERI 32
108 #define ADEDLEN_FILEDATESI 16
109 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
110 #define ADEDLEN_AFPFILEI 4
111 #define ADEDLEN_MACFILEI 4
112 #define ADEDLEN_PRODOSFILEI 8
113 #define ADEDLEN_MSDOSFILEI 2
114 #define ADEDLEN_DID 4
115 #define ADEDLEN_PRIVDEV 8
116 #define ADEDLEN_PRIVINO 8
117 #define ADEDLEN_PRIVSYN 8
118 #define ADEDLEN_PRIVID 4
120 #define ADEID_NUM_V2 13
121 #define ADEID_NUM_EA 5
122 #define ADEID_NUM_OSX 2
124 #define AD_DATASZ2 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT + ADEDLEN_FILEI + \
125 ADEDLEN_FINDERI + ADEDLEN_DID + ADEDLEN_AFPFILEI + ADEDLEN_SHORTNAME + \
126 ADEDLEN_PRODOSFILEI + ADEDLEN_PRIVDEV + ADEDLEN_PRIVINO + \
127 ADEDLEN_PRIVSYN + ADEDLEN_PRIVID + (ADEID_NUM_V2 * AD_ENTRY_LEN))
128 #if AD_DATASZ2 != 741
129 #error bad size for AD_DATASZ2
132 #define AD_DATASZ_EA (AD_HEADER_LEN + (ADEID_NUM_EA * AD_ENTRY_LEN) + ADEDLEN_FINDERI + \
133 ADEDLEN_COMMENT + ADEDLEN_FILEDATESI + ADEDLEN_AFPFILEI + ADEDLEN_PRIVID)
135 #if AD_DATASZ_EA != 342
136 #error bad size for AD_DATASZ_EA
139 #define AD_DATASZ_OSX (AD_HEADER_LEN + (ADEID_NUM_OSX * AD_ENTRY_LEN) + ADEDLEN_FINDERI)
141 #if AD_DATASZ_OSX != 82
142 #error bad size for AD_DATASZ_OSX
145 #define AD_DATASZ_MAX 1024
147 #if AD_VERSION == AD_VERSION2
148 #define AD_DATASZ AD_DATASZ2
149 #elif AD_VERSION == AD_VERSION_EA
150 #define AD_DATASZ AD_DATASZ_EA
153 /* fallback for ad:ea on filesystems without fds for EAs, like old adouble:osx */
154 #define ADEDOFF_FINDERI_OSX (AD_HEADER_LEN + ADEID_NUM_OSX*AD_ENTRY_LEN)
155 #define ADEDOFF_RFORK_OSX (ADEDOFF_FINDERI_OSX + ADEDLEN_FINDERI)
157 typedef uint32_t cnid_t;
164 typedef struct adf_lock_t {
167 int *refcount; /* handle read locks with multiple users */
171 int adf_fd; /* -1: invalid, -2: symlink */
174 adf_lock_t *adf_lock;
175 int adf_refcount, adf_lockcount, adf_lockmax;
178 /* some header protection */
179 #define AD_INITED 0xad494e54 /* ad"INT" */
180 #define AD_CLOSED 0xadc10ced
184 struct adouble_fops {
185 const char *(*ad_path)(const char *, int);
186 int (*ad_mkrf)(const char *);
187 int (*ad_rebuild_header)(struct adouble *);
188 int (*ad_header_read)(const char *, struct adouble *, struct stat *);
189 int (*ad_header_upgrade)(struct adouble *, const char *);
193 uint32_t ad_magic; /* Official adouble magic */
194 uint32_t ad_version; /* Official adouble version number */
196 struct ad_entry ad_eid[ADEID_MAX];
198 struct ad_fd ad_data_fork; /* the data fork */
200 struct ad_fd ad_metadata_fork; /* adouble:v2 -> unused *
201 * adouble:ea -> fd unused, only flags used */
203 struct ad_fd ad_resource_fork; /* adouble:v2 -> the adouble file *
204 * adouble:ea -> the EA fd */
206 struct ad_fd *ad_rfp; /* adouble:v2 -> ad_resource_fork *
207 * adouble:ea -> ad_resource_fork */
209 struct ad_fd *ad_mdp; /* adouble:v2 -> ad_resource_fork *
210 * adouble:ea -> ad_metadata_fork */
212 int ad_vers; /* Our adouble version info (AD_VERSION*) */
213 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
216 int ad_refcount; /* multiple forks may open one adouble */
217 off_t ad_rlen; /* ressource fork len with AFP 3.0 *
218 * the header parameter size is too small. */
219 char *ad_m_name; /* mac name for open fork */
221 struct adouble_fops *ad_ops;
222 uint16_t ad_open_forks; /* open forks (by others) */
223 char ad_data[AD_DATASZ_MAX];
226 #define ADFLAGS_DF (1<<0)
227 #define ADFLAGS_RF (1<<1)
228 #define ADFLAGS_HF (1<<2)
229 #define ADFLAGS_DIR (1<<3)
230 #define ADFLAGS_NOHF (1<<4) /* not an error if no metadata fork */
231 #define ADFLAGS_NORF (1<<5) /* not an error if no ressource fork */
232 #define ADFLAGS_CHECK_OF (1<<6) /* check for open forks from us and other afpd's */
233 #define ADFLAGS_SETSHRMD (1<<7) /* setting share mode must be done with excl fcnt lock,
234 which implies that the file must be openend rw.
235 If it can't be opened rw (eg EPERM or EROFS) it will
236 be opened ro and the fcntl locks will be shared, that
237 at least prevent other users who have rw access to the
238 file from placing excl locks. */
239 #define ADFLAGS_RDWR (1<<8) /* open read/write */
240 #define ADFLAGS_RDONLY (1<<9) /* open read only */
241 #define ADFLAGS_CREATE (1<<10) /* create file, open called with O_CREAT */
242 #define ADFLAGS_EXCL (1<<11) /* exclusive open, open called with O_EXCL */
243 #define ADFLAGS_TRUNC (1<<12) /* truncate, open called with O_TRUNC */
245 #define ADVOL_NODEV (1 << 0)
246 #define ADVOL_CACHE (1 << 1)
247 #define ADVOL_UNIXPRIV (1 << 2) /* adouble unix priv */
248 #define ADVOL_INVDOTS (1 << 3) /* dot files (.DS_Store) are invisible) */
251 #define ADLOCK_CLR (0)
252 #define ADLOCK_RD (1<<0)
253 #define ADLOCK_WR (1<<1)
254 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
255 #define ADLOCK_UPGRADE (1<<2)
256 #define ADLOCK_FILELOCK (1<<3)
258 /* we use this so that we can use the same mechanism for both byte
259 * locks and file synchronization locks. */
260 #if _FILE_OFFSET_BITS == 64
261 #define AD_FILELOCK_BASE (UINT64_C(0x7FFFFFFFFFFFFFFF) - 9)
263 #define AD_FILELOCK_BASE (UINT32_C(0x7FFFFFFF) - 9)
266 #define BYTELOCK_MAX (AD_FILELOCK_BASE - 1)
268 /* datafork and rsrcfork sharemode locks */
269 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
270 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
271 #define AD_FILELOCK_RSRC_OPEN_WR (AD_FILELOCK_BASE + 2)
272 #define AD_FILELOCK_RSRC_OPEN_RD (AD_FILELOCK_BASE + 3)
274 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 4)
275 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 5)
276 #define AD_FILELOCK_RSRC_DENY_WR (AD_FILELOCK_BASE + 6)
277 #define AD_FILELOCK_RSRC_DENY_RD (AD_FILELOCK_BASE + 7)
279 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 8)
280 #define AD_FILELOCK_RSRC_OPEN_NONE (AD_FILELOCK_BASE + 9)
282 /* time stuff. we overload the bits a little. */
283 #define AD_DATE_CREATE 0
284 #define AD_DATE_MODIFY 4
285 #define AD_DATE_BACKUP 8
286 #define AD_DATE_ACCESS 12
287 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
288 AD_DATE_BACKUP | AD_DATE_ACCESS)
289 #define AD_DATE_UNIX (1 << 10)
290 #define AD_DATE_START htonl(0x80000000)
291 #define AD_DATE_DELTA 946684800
292 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
293 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
295 /* various finder offset and info bits */
296 #define FINDERINFO_FRTYPEOFF 0
297 #define FINDERINFO_FRCREATOFF 4
298 #define FINDERINFO_FRFLAGOFF 8
300 /* FinderInfo Flags, char in `ad ls`, valid for files|dirs */
301 #define FINDERINFO_ISONDESK (1) /* "d", fd */
302 #define FINDERINFO_COLOR (0x0e)
303 #define FINDERINFO_HIDEEXT (1<<4) /* "e", fd */
304 #define FINDERINFO_ISHARED (1<<6) /* "m", f */
305 #define FINDERINFO_HASNOINITS (1<<7) /* "n", f */
306 #define FINDERINFO_HASBEENINITED (1<<8) /* "i", fd */
307 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c", fd */
308 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t", f */
309 #define FINDERINFO_NAMELOCKED (1<<12) /* "s", fd */
310 #define FINDERINFO_HASBUNDLE (1<<13) /* "b", fd */
311 #define FINDERINFO_INVISIBLE (1<<14) /* "v", fd */
312 #define FINDERINFO_ISALIAS (1<<15) /* "a", fd */
314 #define FINDERINFO_FRVIEWOFF 14
315 #define FINDERINFO_CUSTOMICON 0x4
316 #define FINDERINFO_CLOSEDVIEW 0x100
319 The "shared" and "invisible" attributes are opaque and stored and
320 retrieved from the FinderFlags. This fixes Bug #2802236:
321 <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
324 /* AFP attributes, char in `ad ls`, valid for files|dirs */
325 #define ATTRBIT_INVISIBLE (1<<0) /* opaque from FinderInfo */
326 #define ATTRBIT_MULTIUSER (1<<1) /* file: opaque, dir: see below */
327 #define ATTRBIT_SYSTEM (1<<2) /* "y", fd */
328 #define ATTRBIT_DOPEN (1<<3) /* data fork already open. Not stored, computed on the fly */
329 #define ATTRBIT_ROPEN (1<<4) /* resource fork already open. Not stored, computed on the fly */
330 #define ATTRBIT_NOWRITE (1<<5) /* "w", f, write inhibit(v2)/read-only(v1) bit */
331 #define ATTRBIT_BACKUP (1<<6) /* "p", fd */
332 #define ATTRBIT_NORENAME (1<<7) /* "r", fd */
333 #define ATTRBIT_NODELETE (1<<8) /* "l", fd */
334 #define ATTRBIT_NOCOPY (1<<10) /* "o", f */
335 #define ATTRBIT_SETCLR (1<<15) /* set/clear bit (d) */
337 /* AFP attributes for dirs. These should probably be computed on the fly.
338 * We don't do that, nor does e.g. OS S X 10.5 Server */
339 #define ATTRBIT_EXPFLDR (1<<1) /* Folder is a sharepoint */
340 #define ATTRBIT_MOUNTED (1<<3) /* Directory is mounted by a user */
341 #define ATTRBIT_SHARED (1<<4) /* Shared area, called IsExpFolder in spec */
343 /* private AFPFileInfo bits */
344 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
345 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
346 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
348 #define ad_data_fileno(ad) ((ad)->ad_data_fork.adf_fd)
349 #define ad_reso_fileno(ad) ((ad)->ad_rfp->adf_fd)
350 #define ad_meta_fileno(ad) ((ad)->ad_mdp->adf_fd)
352 /* -1 means not open, -2 is a symlink */
353 #define AD_DATA_OPEN(ad) ((ad)->ad_data_fork.adf_fd >= 0)
354 #define AD_META_OPEN(ad) ((ad)->ad_mdp->adf_fd >= 0)
355 #define AD_RSRC_OPEN(ad) ((ad)->ad_rfp->adf_fd >= 0)
357 #define ad_getversion(ad) ((ad)->ad_version)
359 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
360 #define ad_setentrylen(ad,eid,len) ((ad)->ad_eid[(eid)].ade_len = (len))
361 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
362 #define ad_setentryoff(ad,eid,off) ((ad)->ad_eid[(eid)].ade_off = (off))
363 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + (ad)->ad_eid[(eid)].ade_off)
365 #define ad_get_RF_flags(ad) ((ad)->ad_rfp->adf_flags)
366 #define ad_get_MD_flags(ad) ((ad)->ad_mdp->adf_flags)
368 /* Refcounting open forks using one struct adouble */
369 #define ad_ref(ad) (ad)->ad_refcount++
370 #define ad_unref(ad) --((ad)->ad_refcount)
373 extern int ad_rebuild_adouble_header (struct adouble *);
374 extern int ad_copy_header (struct adouble *, struct adouble *);
375 extern int ad_flush (struct adouble *);
376 extern int ad_close (struct adouble *, int);
377 extern int fsetrsrcea(struct adouble *ad, int fd, const char *eaname, const void *value, size_t size, int flags);
380 extern int ad_testlock (struct adouble *adp, int eid, off_t off);
381 extern uint16_t ad_openforks(struct adouble *adp, uint16_t);
382 extern int ad_lock(struct adouble *, uint32_t eid, int type, off_t off, off_t len, int user);
383 extern void ad_unlock(struct adouble *, int user);
384 extern int ad_tmplock(struct adouble *, uint32_t eid, int type, off_t off, off_t len, int user);
387 extern const char *adflags2logstr(int adflags);
388 extern int ad_setfuid (const uid_t );
389 extern uid_t ad_getfuid (void );
390 extern char *ad_dir (const char *);
391 extern const char *ad_path (const char *, int);
392 extern const char *ad_path_ea (const char *, int);
393 extern const char *ad_path_osx (const char *path, int adflags);
394 extern int ad_mode (const char *, mode_t);
395 extern int ad_mkdir (const char *, mode_t);
397 extern void ad_init (struct adouble *, const struct vol * restrict);
398 extern void ad_init_old (struct adouble *ad, int flags, int options);
399 extern int ad_open (struct adouble *ad, const char *path, int adflags, ...);
400 extern int ad_openat (struct adouble *, int dirfd, const char *path, int adflags, ...);
401 extern int ad_refresh (const char *path, struct adouble *);
402 extern int ad_stat (const char *, struct stat *);
403 extern int ad_metadata (const char *, int, struct adouble *);
404 extern int ad_metadataat (int, const char *, int, struct adouble *);
406 /* build a resource fork mode from the data fork mode:
407 * remove X mode and extend header to RW if R or W (W if R for locking),
409 static inline mode_t ad_hf_mode (mode_t mode)
411 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
412 /* fnctl lock need write access */
413 if ((mode & S_IRUSR))
415 if ((mode & S_IRGRP))
417 if ((mode & S_IROTH))
420 /* if write mode set add read mode */
421 if ((mode & S_IWUSR))
423 if ((mode & S_IWGRP))
425 if ((mode & S_IWOTH))
431 /* ad_read.c/ad_write.c */
432 extern int sys_ftruncate(int fd, off_t length);
433 extern ssize_t ad_read(struct adouble *, uint32_t, off_t, char *, size_t);
434 extern ssize_t ad_pread(struct ad_fd *, void *, size_t, off_t);
435 extern ssize_t ad_write(struct adouble *, uint32_t, off_t, int, const char *, size_t);
436 extern ssize_t adf_pread(struct ad_fd *, void *, size_t, off_t);
437 extern ssize_t adf_pwrite(struct ad_fd *, const void *, size_t, off_t);
438 extern int ad_dtruncate(struct adouble *, off_t);
439 extern int ad_rtruncate(struct adouble *, off_t);
442 extern off_t ad_size (const struct adouble *, uint32_t );
445 extern void *ad_mmapread(struct adouble *, uint32_t, off_t, size_t);
446 extern void *ad_mmapwrite(struct adouble *, uint32_t, off_t, int, size_t);
447 #define ad_munmap(buf, len) (munmap((buf), (len)))
450 extern int ad_setdate(struct adouble *, unsigned int, uint32_t);
451 extern int ad_getdate(const struct adouble *, unsigned int, uint32_t *);
454 extern int ad_setattr(const struct adouble *, uint16_t);
455 extern int ad_getattr(const struct adouble *, uint16_t *);
456 extern int ad_setname(struct adouble *, const char *);
457 extern int ad_setid(struct adouble *, dev_t dev, ino_t ino, uint32_t, uint32_t, const void *);
458 extern uint32_t ad_getid(struct adouble *, dev_t, ino_t, cnid_t, const void *);
459 extern uint32_t ad_forcegetid(struct adouble *adp);
462 extern int ad_readfile_init(const struct adouble *ad, int eid, off_t *off, int end);
465 #endif /* _ATALK_ADOUBLE_H */