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>
49 #include <atalk/locking.h>
52 #define AD_VERSION2 0x00020000
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)
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
123 #define AD_DATASZ2 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT + ADEDLEN_FILEI + \
124 ADEDLEN_FINDERI + ADEDLEN_DID + ADEDLEN_AFPFILEI + ADEDLEN_SHORTNAME + \
125 ADEDLEN_PRODOSFILEI + ADEDLEN_PRIVDEV + ADEDLEN_PRIVINO + \
126 ADEDLEN_PRIVSYN + ADEDLEN_PRIVID + (ADEID_NUM_V2 * AD_ENTRY_LEN))
127 #if AD_DATASZ2 != 741
128 #error bad size for AD_DATASZ2
131 #define AD_DATASZ_EA (AD_HEADER_LEN + (ADEID_NUM_EA * AD_ENTRY_LEN) + ADEDLEN_FINDERI + \
132 ADEDLEN_COMMENT + ADEDLEN_FILEDATESI + ADEDLEN_AFPFILEI + ADEDLEN_PRIVID)
134 #if AD_DATASZ_EA != 342
135 #error bad size for AD_DATASZ_EA
138 #define AD_DATASZ_MAX 1024
140 #if AD_VERSION == AD_VERSION2
141 #define AD_DATASZ AD_DATASZ2
142 #elif AD_VERSION == AD_VERSION_EA
143 #define AD_DATASZ AD_DATASZ_EA
146 #define RFORK_EA_ALLOCSIZE (128*1024) /* 128k */
148 typedef uint32_t cnid_t;
155 typedef struct adf_lock_t {
158 int *refcount; /* handle read locks with multiple users */
162 int adf_fd; /* -1: invalid, -2: symlink */
170 adf_lock_t *adf_lock;
171 int adf_refcount, adf_lockcount, adf_lockmax;
175 /* some header protection */
176 #define AD_INITED 0xad494e54 /* ad"INT" */
177 #define AD_CLOSED 0xadc10ced
181 struct adouble_fops {
182 const char *(*ad_path)(const char *, int);
183 int (*ad_mkrf)(const char *);
184 int (*ad_rebuild_header)(struct adouble *);
185 int (*ad_header_read)(struct adouble *, struct stat *);
186 int (*ad_header_upgrade)(struct adouble *, const char *);
190 uint32_t ad_magic; /* Official adouble magic */
191 uint32_t ad_version; /* Official adouble version number */
193 struct ad_entry ad_eid[ADEID_MAX];
194 struct ad_fd ad_data_fork; /* the data fork */
195 struct ad_fd ad_resource_fork; /* adouble:v2 -> the adouble file *
196 * adouble:ea -> the rfork EA */
197 struct ad_fd ad_metadata_fork; /* adouble:v2 -> unused *
198 * adouble:ea -> the metadata EA */
199 struct ad_fd *ad_md; /* either ad_resource or ad_metadata */
200 int ad_flags; /* Our adouble version info (AD_VERSION*) */
201 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
204 int ad_refcount; /* multiple forks may open one adouble */
205 void *ad_resforkbuf; /* buffer for AD_VERSION_EA ressource fork */
206 size_t ad_resforkbufsize; /* size of ad_resforkbuf */
207 off_t ad_rlen; /* ressource fork len with AFP 3.0 *
208 * the header parameter size is too small. */
209 char *ad_m_name; /* mac name for open fork */
211 bstring ad_fullpath; /* fullpath of file, adouble:ea need this */
212 struct adouble_fops *ad_ops;
213 uint16_t ad_open_forks; /* open forks (by others) */
214 char ad_data[AD_DATASZ_MAX];
217 #define ADFLAGS_DF (1<<0)
218 #define ADFLAGS_RF (1<<1)
219 #define ADFLAGS_HF (1<<2)
220 #define ADFLAGS_DIR (1<<3)
221 #define ADFLAGS_NOHF (1<<4) /* not an error if no ressource fork */
222 #define ADFLAGS_CHECK_OF (1<<6) /* check for open forks from us and other afpd's */
224 #define ADVOL_NODEV (1 << 0)
225 #define ADVOL_CACHE (1 << 1)
226 #define ADVOL_UNIXPRIV (1 << 2) /* adouble unix priv */
227 #define ADVOL_INVDOTS (1 << 3) /* dot files (.DS_Store) are invisible) */
228 #define ADVOL_NOADOUBLE (1 << 4)
231 #define ADLOCK_CLR (0)
232 #define ADLOCK_RD (1<<0)
233 #define ADLOCK_WR (1<<1)
234 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
235 #define ADLOCK_UPGRADE (1<<2)
236 #define ADLOCK_FILELOCK (1<<3)
238 /* we use this so that we can use the same mechanism for both byte
239 * locks and file synchronization locks. i do this by co-opting either
240 * first bits on 32-bit machines or shifting above the last bit on
241 * 64-bit machines. this only matters for the data fork. */
242 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
243 /* synchronization locks */
244 #define AD_FILELOCK_BASE (0x80000000)
246 #if _FILE_OFFSET_BITS == 64
247 #define AD_FILELOCK_BASE (0x7FFFFFFFFFFFFFFFULL - 9)
249 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
254 * AD_FILELOCK_BASE case
256 #if _FILE_OFFSET_BITS == 64
257 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
259 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
261 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
263 #define BYTELOCK_MAX (0x7FFFFFFFU)
267 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
268 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
269 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
270 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
271 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
273 /* time stuff. we overload the bits a little. */
274 #define AD_DATE_CREATE 0
275 #define AD_DATE_MODIFY 4
276 #define AD_DATE_BACKUP 8
277 #define AD_DATE_ACCESS 12
278 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
279 AD_DATE_BACKUP | AD_DATE_ACCESS)
280 #define AD_DATE_UNIX (1 << 10)
281 #define AD_DATE_START htonl(0x80000000)
282 #define AD_DATE_DELTA 946684800
283 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
284 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
286 /* various finder offset and info bits */
287 #define FINDERINFO_FRTYPEOFF 0
288 #define FINDERINFO_FRCREATOFF 4
289 #define FINDERINFO_FRFLAGOFF 8
291 /* FinderInfo Flags, char in `ad ls`, valid for files|dirs */
292 #define FINDERINFO_ISONDESK (1) /* "d", fd */
293 #define FINDERINFO_COLOR (0x0e)
294 #define FINDERINFO_HIDEEXT (1<<4) /* "e", fd */
295 #define FINDERINFO_ISHARED (1<<6) /* "m", f */
296 #define FINDERINFO_HASNOINITS (1<<7) /* "n", f */
297 #define FINDERINFO_HASBEENINITED (1<<8) /* "i", fd */
298 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c", fd */
299 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t", f */
300 #define FINDERINFO_NAMELOCKED (1<<12) /* "s", fd */
301 #define FINDERINFO_HASBUNDLE (1<<13) /* "b", fd */
302 #define FINDERINFO_INVISIBLE (1<<14) /* "v", fd */
303 #define FINDERINFO_ISALIAS (1<<15) /* "a", fd */
305 #define FINDERINFO_FRVIEWOFF 14
306 #define FINDERINFO_CUSTOMICON 0x4
307 #define FINDERINFO_CLOSEDVIEW 0x100
310 The "shared" and "invisible" attributes are opaque and stored and
311 retrieved from the FinderFlags. This fixes Bug #2802236:
312 <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
315 /* AFP attributes, char in `ad ls`, valid for files|dirs */
316 #define ATTRBIT_INVISIBLE (1<<0) /* opaque from FinderInfo */
317 #define ATTRBIT_MULTIUSER (1<<1) /* file: opaque, dir: see below */
318 #define ATTRBIT_SYSTEM (1<<2) /* "y", fd */
319 #define ATTRBIT_DOPEN (1<<3) /* data fork already open. Not stored, computed on the fly */
320 #define ATTRBIT_ROPEN (1<<4) /* resource fork already open. Not stored, computed on the fly */
321 #define ATTRBIT_NOWRITE (1<<5) /* "w", f, write inhibit(v2)/read-only(v1) bit */
322 #define ATTRBIT_BACKUP (1<<6) /* "p", fd */
323 #define ATTRBIT_NORENAME (1<<7) /* "r", fd */
324 #define ATTRBIT_NODELETE (1<<8) /* "l", fd */
325 #define ATTRBIT_NOCOPY (1<<10) /* "o", f */
326 #define ATTRBIT_SETCLR (1<<15) /* set/clear bit (d) */
328 /* AFP attributes for dirs. These should probably be computed on the fly.
329 * We don't do that, nor does e.g. OS S X 10.5 Server */
330 #define ATTRBIT_EXPFLDR (1<<1) /* Folder is a sharepoint */
331 #define ATTRBIT_MOUNTED (1<<3) /* Directory is mounted by a user */
332 #define ATTRBIT_SHARED (1<<4) /* Shared area, called IsExpFolder in spec */
334 /* private AFPFileInfo bits */
335 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
336 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
337 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
339 #define ad_data_fileno(ad) ((ad)->ad_data_fork.adf_fd)
340 #define ad_reso_fileno(ad) ((ad)->ad_resource_fork.adf_fd)
341 #define ad_meta_fileno(ad) ((ad)->ad_md->adf_fd)
343 #define ad_getversion(ad) ((ad)->ad_version)
345 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
346 #define ad_setentrylen(ad,eid,len) ((ad)->ad_eid[(eid)].ade_len = (len))
347 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
348 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + (ad)->ad_eid[(eid)].ade_off)
350 #define ad_get_RF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
351 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
353 /* Refcounting open forks using one struct adouble */
354 #define ad_ref(ad) (ad)->ad_refcount++
355 #define ad_unref(ad) --((ad)->ad_refcount)
358 extern int ad_rebuild_adouble_header (struct adouble *);
359 extern int ad_rebuild_sfm_header (struct adouble *);
360 extern int ad_copy_header (struct adouble *, struct adouble *);
361 extern int ad_flush (struct adouble *);
362 extern int ad_close (struct adouble *, int);
365 extern int ad_testlock (struct adouble *adp, int eid, off_t off);
366 extern uint16_t ad_openforks(struct adouble *adp, uint16_t);
367 extern int ad_excl_lock (struct adouble *adp, uint32_t eid);
369 extern int ad_lock(struct adouble *, uint32_t eid, int type, off_t off, off_t len, int user);
370 extern void ad_unlock(struct adouble *, int user);
371 extern int ad_tmplock(struct adouble *, uint32_t eid, int type, off_t off, off_t len, int user);
374 extern const char *oflags2logstr(int oflags);
375 extern const char *adflags2logstr(int adflags);
376 extern int ad_setfuid (const uid_t );
377 extern uid_t ad_getfuid (void );
378 extern char *ad_dir (const char *);
379 extern const char *ad_path (const char *, int);
380 extern const char *ad_path_ea (const char *, int);
381 extern int ad_mode (const char *, int);
382 extern int ad_mkdir (const char *, int);
383 extern void ad_init (struct adouble *, int, int );
384 extern int ad_open (struct adouble *ad, const char *path, int adflags, ...);
385 extern int ad_openat (struct adouble *, int dirfd, const char *path, int adflags, ...);
386 extern int ad_refresh (struct adouble *);
387 extern int ad_stat (const char *, struct stat *);
388 extern int ad_metadata (const char *, int, struct adouble *);
389 extern int ad_metadataat (int, const char *, int, struct adouble *);
392 #define ad_open_metadata(name, flags, mode, adp)\
393 ad_open(name, ADFLAGS_HF | (flags), O_RDWR |(mode), 0666, (adp))
396 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_HF)
398 /* build a resource fork mode from the data fork mode:
399 * remove X mode and extend header to RW if R or W (W if R for locking),
401 static inline mode_t ad_hf_mode (mode_t mode)
403 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
404 /* fnctl lock need write access */
405 if ((mode & S_IRUSR))
407 if ((mode & S_IRGRP))
409 if ((mode & S_IROTH))
412 /* if write mode set add read mode */
413 if ((mode & S_IWUSR))
415 if ((mode & S_IWGRP))
417 if ((mode & S_IWOTH))
423 /* ad_read.c/ad_write.c */
424 extern int sys_ftruncate(int fd, off_t length);
425 extern ssize_t ad_read(struct adouble *, uint32_t, off_t, char *, size_t);
426 extern ssize_t ad_pread(struct ad_fd *, void *, size_t, off_t);
427 extern ssize_t ad_write(struct adouble *, uint32_t, off_t, int, const char *, size_t);
428 extern ssize_t adf_pread(struct ad_fd *, void *, size_t, off_t);
429 extern ssize_t adf_pwrite(struct ad_fd *, const void *, size_t, off_t);
430 extern int ad_dtruncate(struct adouble *, off_t);
431 extern int ad_rtruncate(struct adouble *, off_t);
434 extern off_t ad_size (const struct adouble *, uint32_t );
437 extern void *ad_mmapread(struct adouble *, uint32_t, off_t, size_t);
438 extern void *ad_mmapwrite(struct adouble *, uint32_t, off_t, int, size_t);
439 #define ad_munmap(buf, len) (munmap((buf), (len)))
442 extern int ad_setdate(struct adouble *, unsigned int, uint32_t);
443 extern int ad_getdate(const struct adouble *, unsigned int, uint32_t *);
446 extern int ad_setattr(const struct adouble *, uint16_t);
447 extern int ad_getattr(const struct adouble *, uint16_t *);
448 extern int ad_setname(struct adouble *, const char *);
449 extern int ad_setid(struct adouble *, dev_t dev, ino_t ino, uint32_t, uint32_t, const void *);
450 extern uint32_t ad_getid(struct adouble *, dev_t, ino_t, cnid_t, const void *);
451 extern uint32_t ad_forcegetid(struct adouble *adp);
454 extern int ad_readfile_init(const struct adouble *ad, int eid, off_t *off, int end);
458 #ifdef HAVE_SENDFILE_WRITE
459 extern ssize_t ad_writefile(struct adouble *, int, int, off_t, int, size_t);
460 #endif /* HAVE_SENDFILE_WRITE */
463 #endif /* _ATALK_ADOUBLE_H */