2 * $Id: adouble.h,v 1.55 2010-03-30 12:55:26 franklahm Exp $
3 * Copyright (c) 1990,1991 Regents of The University of Michigan.
6 * Permission to use, copy, modify, and distribute this software and
7 * its documentation for any purpose and without fee is hereby granted,
8 * provided that the above copyright notice appears in all copies and
9 * that both that copyright notice and this permission notice appear
10 * in supporting documentation, and that the name of The University
11 * of Michigan not be used in advertising or publicity pertaining to
12 * distribution of the software without specific, written prior
13 * permission. This software is supplied as is without expressed or
14 * implied warranties of any kind.
16 * Research Systems Unix Group
17 * The University of Michigan
19 * 535 W. William Street
22 * netatalk@itd.umich.edu
27 * @brief Part of Netatalk's AppleDouble implementatation
30 #ifndef _ATALK_ADOUBLE_H
31 #define _ATALK_ADOUBLE_H
37 /* -------------------
38 * need pread() and pwrite()
55 Still have to figure out which platforms really
56 need _XOPEN_SOURCE defined for pread.
58 #if defined(HAVE_PREAD) && !defined(SOLARIS) && !defined(__OpenBSD__) && !defined(__NetBSD__) && !defined(__FreeBSD__) && !defined(TRU64)
60 #define _XOPEN_SOURCE 500
64 #include <sys/types.h>
73 #include <sys/cdefs.h>
80 #ifdef HAVE_SYS_TIME_H
83 #include <netatalk/endian.h>
86 #define AD_VERSION1 0x00010000
87 #define SFM_VERSION AD_VERSION1
89 #define AD_VERSION2 0x00020000
90 #define AD_VERSION2_OSX 0x00020001
92 #define AD_VERSION1_ADS 0x00010002
94 #define AD_VERSION1_SFM 0x00010003
95 #define AD_VERSION AD_VERSION2
98 * AppleDouble entry IDs.
100 #define ADEID_DFORK 1
101 #define ADEID_RFORK 2
102 #define ADEID_NAME 3 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
103 #define ADEID_COMMENT 4
104 #define ADEID_ICONBW 5
105 #define ADEID_ICONCOL 6
106 #define ADEID_FILEI 7 /* v1, replaced by: */
107 #define ADEID_FILEDATESI 8 /* this */
108 #define ADEID_FINDERI 9
109 #define ADEID_MACFILEI 10 /* we don't use this */
110 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
111 #define ADEID_MSDOSFILEI 12 /* we don't use this */
112 #define ADEID_SHORTNAME 13
113 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
116 #if AD_VERSION == AD_VERSION1
119 /* netatalk private note fileid reused DID */
120 #define ADEID_PRIVDEV 16
121 #define ADEID_PRIVINO 17
122 #define ADEID_PRIVSYN 18 /* in synch with database */
123 #define ADEID_PRIVID 19
124 #define ADEID_SFMRESERVE1 20
125 #define ADEID_SFMRESERVE2 21
127 #define AD_DEV 0x80444556
128 #define AD_INO 0x80494E4F
129 #define AD_SYN 0x8053594E
130 #define AD_ID 0x8053567E
135 #define AD_APPLESINGLE_MAGIC 0x00051600
136 #define AD_APPLEDOUBLE_MAGIC 0x00051607
137 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
138 #define SFM_MAGIC 0x00504641
140 /* sizes of relevant entry bits */
141 #define ADEDLEN_MAGIC 4
142 #define ADEDLEN_VERSION 4
143 #define ADEDLEN_FILLER 16
144 #define ADEDLEN_NENTRIES 2
147 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
148 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
149 #define AD_ENTRY_LEN 12 /* size of a single entry header */
151 /* v1 field widths */
152 #define ADEDLEN_NAME 255
153 #define ADEDLEN_COMMENT 200
154 #define ADEDLEN_FILEI 16
155 #define ADEDLEN_FINDERI 32
157 /* v2 field widths */
158 #define ADEDLEN_FILEDATESI 16
159 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
160 #define ADEDLEN_AFPFILEI 4
161 #define ADEDLEN_MACFILEI 4
162 #define ADEDLEN_PRODOSFILEI 8
163 #define ADEDLEN_MSDOSFILEI 2
164 #define ADEDLEN_DID 4
165 #define ADEDLEN_PRIVDEV 8
166 #define ADEDLEN_PRIVINO 8
167 #define ADEDLEN_PRIVSYN 8
168 #define ADEDLEN_PRIVID 4
170 #define ADEID_NUM_V1 5
171 #define ADEID_NUM_V2 13
173 // #define ADEID_NUM_SFM 5
174 /* sizeof SFM meta data */
175 #define AD_SFM_LEN 60
178 #define AD_DATASZ1 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT + ADEDLEN_FILEI + ADEDLEN_FINDERI + \
179 (ADEID_NUM_V1 * AD_ENTRY_LEN))
181 #if AD_DATASZ1 != 589
182 #error bad size for AD_DATASZ1
185 #define AD_NEWSZ2 (ADEDLEN_DID + ADEDLEN_AFPFILEI + ADEDLEN_SHORTNAME + ADEDLEN_PRODOSFILEI \
186 + ADEDLEN_PRIVDEV + ADEDLEN_PRIVINO + ADEDLEN_PRIVSYN + ADEDLEN_PRIVID)
189 #define AD_DATASZ2 (AD_DATASZ1 + AD_NEWSZ2 + ((ADEID_NUM_V2 - ADEID_NUM_V1) * AD_ENTRY_LEN))
191 #if AD_DATASZ2 != 741
192 #error bad size for AD_DATASZ2
195 #define AD_DATASZ_MAX 1024
196 #if AD_VERSION == AD_VERSION1
197 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
198 #elif AD_VERSION == AD_VERSION2
199 #define AD_DATASZ AD_DATASZ2
203 * some legacy defines from netatalk-990130
204 * (to keep from breaking certain packages)
208 #define ADEDOFF_RFORK 589
209 #define ADEDOFF_NAME 86
210 #define ADEDOFF_COMMENT 341
211 #define ADEDOFF_FINDERI 557
212 #ifndef ADEDOFF_FILEI
213 #define ADEDOFF_FILEI 541
216 typedef u_int32_t cnid_t;
219 * The header of the AppleDouble Header File looks like this:
225 * Home File System 16 (this becomes filler in ad v2)
226 * Number of Entries 2
227 * Entry Descriptors for each entry:
238 typedef struct adf_lock_t {
241 int *refcount; /* handle read locks with multiple users */
245 int adf_fd; /* -1: invalid, -2: symlink */
254 adf_lock_t *adf_lock;
255 int adf_refcount, adf_lockcount, adf_lockmax;
258 /* some header protection */
259 #define AD_INITED 0xad494e54 /* ad"INT" */
264 u_int32_t ad_version;
265 char ad_filler[ 16 ];
266 struct ad_entry ad_eid[ ADEID_MAX ];
267 struct ad_fd ad_data_fork, ad_resource_fork, ad_metadata_fork;
268 struct ad_fd *ad_md; /* either ad_resource or ad_metadata */
270 int ad_flags; /* This really stores version info too (AD_VERSION*) */
271 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
272 unsigned int ad_inited;
275 int ad_refcount; /* used in afpd/ofork.c */
276 off_t ad_rlen; /* ressource fork len with AFP 3.0
277 the header parameter size is too small.
279 char *ad_m_name; /* mac name for open fork */
281 struct adouble_fops *ad_ops;
282 u_int16_t ad_open_forks; /* open forks (by others) */
284 #ifdef USE_MMAPPED_HEADERS
287 char ad_data[AD_DATASZ_MAX];
291 struct adouble_fops {
292 char *(*ad_path)(const char *, int);
293 int (*ad_mkrf)(char *);
294 int (*ad_rebuild_header)(struct adouble *);
295 int (*ad_check_header)(struct adouble *, struct stat *);
296 int (*ad_header_read)(struct adouble *, struct stat *);
297 int (*ad_header_upgrade)(struct adouble *, char *);
300 #define ADFLAGS_DF (1<<0)
301 #define ADFLAGS_HF (1<<1)
302 #define ADFLAGS_DIR (1<<2)
304 #define ADFLAGS_NOADOUBLE (1<<3)
306 #define ADFLAGS_V1COMPAT (1<<4)
307 #define ADFLAGS_NOHF (1<<5) /* not an error if no ressource fork */
308 #define ADFLAGS_RDONLY (1<<6) /* don't try readwrite */
309 #define ADFLAGS_OPENFORKS (1<<7) /* check for open fork in ad_metadata function */
310 #define ADFLAGS_RF (1<<8)
311 #define ADFLAGS_MD ADFLAGS_HF /* (1<<9) */
312 #define ADFLAGS_CREATE (1<<9)
314 /* adouble v2 cnid cache */
315 #define ADVOL_NODEV (1 << 0)
316 #define ADVOL_CACHE (1 << 1)
317 #define ADVOL_UNIXPRIV (1 << 2) /* adouble unix priv */
318 #define ADVOL_INVDOTS (1 << 3) /* dot files (.DS_Store) are invisible) */
319 #define ADVOL_NOADOUBLE (1 << 4)
322 #define ADLOCK_CLR (0)
323 #define ADLOCK_RD (1<<0)
324 #define ADLOCK_WR (1<<1)
325 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
326 #define ADLOCK_UPGRADE (1<<2)
327 #define ADLOCK_FILELOCK (1<<3)
329 /* we use this so that we can use the same mechanism for both byte
330 * locks and file synchronization locks. i do this by co-opting either
331 * first bits on 32-bit machines or shifting above the last bit on
332 * 64-bit machines. this only matters for the data fork. */
333 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
334 /* synchronization locks */
335 #define AD_FILELOCK_BASE (0x80000000)
337 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
341 * AD_FILELOCK_BASE case
343 #if _FILE_OFFSET_BITS == 64
344 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
346 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
348 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
350 #define BYTELOCK_MAX (0x7FFFFFFFU)
354 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
355 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
356 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
357 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
358 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
360 /* time stuff. we overload the bits a little. */
361 #define AD_DATE_CREATE 0
362 #define AD_DATE_MODIFY 4
363 #define AD_DATE_BACKUP 8
364 #define AD_DATE_ACCESS 12
365 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
366 AD_DATE_BACKUP | AD_DATE_ACCESS)
367 #define AD_DATE_UNIX (1 << 10)
368 #define AD_DATE_START htonl(0x80000000)
369 #define AD_DATE_DELTA 946684800
370 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
371 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
373 /* various finder offset and info bits */
374 #define FINDERINFO_FRTYPEOFF 0
375 #define FINDERINFO_FRCREATOFF 4
376 #define FINDERINFO_FRFLAGOFF 8
378 /* FinderInfo Flags, char in `ad ls`, valid for files|dirs */
379 #define FINDERINFO_ISONDESK (1) /* "d", fd */
380 #define FINDERINFO_COLOR (0x0e)
381 #define FINDERINFO_HIDEEXT (1<<4) /* "e", fd */
382 #define FINDERINFO_ISHARED (1<<6) /* "m", f */
383 #define FINDERINFO_HASNOINITS (1<<7) /* "n", f */
384 #define FINDERINFO_HASBEENINITED (1<<8) /* "i", fd */
385 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c", fd */
386 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t", f */
387 #define FINDERINFO_NAMELOCKED (1<<12) /* "s", fd */
388 #define FINDERINFO_HASBUNDLE (1<<13) /* "b", fd */
389 #define FINDERINFO_INVISIBLE (1<<14) /* "v", fd */
390 #define FINDERINFO_ISALIAS (1<<15) /* "a", fd */
392 #define FINDERINFO_FRVIEWOFF 14
393 #define FINDERINFO_CUSTOMICON 0x4
394 #define FINDERINFO_CLOSEDVIEW 0x100
397 The "shared" and "invisible" attributes are opaque and stored and
398 retrieved from the FinderFlags. This fixes Bug #2802236:
399 <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
402 /* AFP attributes, char in `ad ls`, valid for files|dirs */
403 #define ATTRBIT_INVISIBLE (1<<0) /* opaque from FinderInfo */
404 #define ATTRBIT_MULTIUSER (1<<1) /* file: opaque, dir: see below */
405 #define ATTRBIT_SYSTEM (1<<2) /* "y", fd */
406 #define ATTRBIT_DOPEN (1<<3) /* data fork already open. Not stored, computed on the fly */
407 #define ATTRBIT_ROPEN (1<<4) /* resource fork already open. Not stored, computed on the fly */
408 #define ATTRBIT_NOWRITE (1<<5) /* "w", f, write inhibit(v2)/read-only(v1) bit */
409 #define ATTRBIT_BACKUP (1<<6) /* "p", fd */
410 #define ATTRBIT_NORENAME (1<<7) /* "r", fd */
411 #define ATTRBIT_NODELETE (1<<8) /* "l", fd */
412 #define ATTRBIT_NOCOPY (1<<10) /* "o", f */
413 #define ATTRBIT_SETCLR (1<<15) /* set/clear bit (d) */
415 /* AFP attributes for dirs. These should probably be computed on the fly.
416 * We don't do that, nor does e.g. OS S X 10.5 Server */
417 #define ATTRBIT_EXPFLDR (1<<1) /* Folder is a sharepoint */
418 #define ATTRBIT_MOUNTED (1<<3) /* Directory is mounted by a user */
419 #define ATTRBIT_SHARED (1<<4) /* Shared area, called IsExpFolder in spec */
421 /* private AFPFileInfo bits */
422 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
423 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
424 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
426 #define ad_data_fileno(ad) ((ad)->ad_data_fork.adf_fd)
427 #define ad_reso_fileno(ad) ((ad)->ad_resource_fork.adf_fd)
428 #define ad_meta_fileno(ad) ((ad)->ad_md->adf_fd)
430 #define ad_getversion(ad) ((ad)->ad_version)
432 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
433 #define ad_setentrylen(ad,eid,len) ((ad)->ad_eid[(eid)].ade_len = (len))
434 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
435 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + (ad)->ad_eid[(eid)].ade_off)
437 #define ad_get_HF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
438 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
441 extern int ad_rebuild_adouble_header (struct adouble *);
442 extern int ad_rebuild_sfm_header (struct adouble *);
443 extern int ad_copy_header (struct adouble *, struct adouble *);
444 extern int ad_flush (struct adouble *);
445 extern int ad_close (struct adouble *, int);
448 extern int ad_fcntl_lock (struct adouble *, const u_int32_t /*eid*/,
449 const int /*type*/, const off_t /*offset*/,
450 const off_t /*len*/, const int /*user*/);
451 extern void ad_fcntl_unlock (struct adouble *, const int /*user*/);
452 extern int ad_fcntl_tmplock (struct adouble *, const u_int32_t /*eid*/,
453 const int /*type*/, const off_t /*offset*/,
454 const off_t /*len*/, const int /*user*/);
455 extern int ad_testlock (struct adouble * /*adp*/, int /*eid*/, off_t /*off*/);
457 extern u_int16_t ad_openforks (struct adouble * /*adp*/, u_int16_t);
458 extern int ad_excl_lock (struct adouble * /*adp*/, const u_int32_t /*eid*/);
460 #define ad_lock ad_fcntl_lock
461 #define ad_tmplock ad_fcntl_tmplock
462 #define ad_unlock ad_fcntl_unlock
465 extern int ad_setfuid (const uid_t );
466 extern uid_t ad_getfuid (void );
467 extern char *ad_dir (const char *);
468 extern char *ad_path (const char *, int);
469 extern char *ad_path_osx (const char *, int);
470 extern char *ad_path_ads (const char *, int);
471 extern char *ad_path_sfm (const char *, int);
472 extern int ad_mode (const char *, int);
473 extern int ad_mkdir (const char *, int);
474 extern void ad_init (struct adouble *, int, int );
475 extern int ad_open (const char *, int, int, int, struct adouble *);
476 extern int ad_openat (int dirfd, const char *, int, int, int, struct adouble *);
477 extern int ad_refresh (struct adouble *);
478 extern int ad_stat (const char *, struct stat *);
479 extern int ad_metadata (const char *, int, struct adouble *);
480 extern int ad_metadataat (int, const char *, int, struct adouble *);
482 #define ad_open_metadata(name, flags, mode, adp)\
483 ad_open(name, ADFLAGS_MD|(flags), O_RDWR |(mode), 0666, (adp))
485 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_MD)
487 /* build a resource fork mode from the data fork mode:
488 * remove X mode and extend header to RW if R or W (W if R for locking),
490 static inline mode_t ad_hf_mode (mode_t mode)
492 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
493 /* fnctl lock need write access */
494 if ((mode & S_IRUSR))
496 if ((mode & S_IRGRP))
498 if ((mode & S_IROTH))
501 /* if write mode set add read mode */
502 if ((mode & S_IWUSR))
504 if ((mode & S_IWGRP))
506 if ((mode & S_IWOTH))
513 ssize_t sys_getxattr (const char *path, const char *name, void *value, size_t size);
514 ssize_t sys_lgetxattr (const char *path, const char *name, void *value, size_t size);
515 ssize_t sys_fgetxattr (int filedes, const char *name, void *value, size_t size);
516 ssize_t sys_listxattr (const char *path, char *list, size_t size);
517 ssize_t sys_llistxattr (const char *path, char *list, size_t size);
518 ssize_t sys_flistxattr (int filedes, char *list, size_t size);
519 int sys_removexattr (const char *path, const char *name);
520 int sys_lremovexattr (const char *path, const char *name);
521 int sys_fremovexattr (int filedes, const char *name);
522 int sys_setxattr (const char *path, const char *name, const void *value, size_t size, int flags);
523 int sys_lsetxattr (const char *path, const char *name, const void *value, size_t size, int flags);
524 int sys_fsetxattr (int filedes, const char *name, const void *value, size_t size, int flags);
525 int sys_copyxattr (const char *src, const char *dst);
527 /* ad_read.c/ad_write.c */
528 extern int sys_ftruncate(int fd, off_t length);
530 extern ssize_t ad_read (struct adouble *, const u_int32_t,
531 const off_t, char *, const size_t);
532 extern ssize_t ad_pread (struct ad_fd *, void *, size_t, off_t);
533 extern ssize_t ad_write (struct adouble *, const u_int32_t, off_t,
534 const int, const char *, const size_t);
535 extern ssize_t adf_pread (struct ad_fd *, void *, size_t, off_t);
536 extern ssize_t adf_pwrite (struct ad_fd *, const void *, size_t, off_t);
537 extern int ad_dtruncate (struct adouble *, const off_t);
538 extern int ad_rtruncate (struct adouble *, const off_t);
541 extern off_t ad_size (const struct adouble *, const u_int32_t );
544 extern void *ad_mmapread (struct adouble *, const u_int32_t,
545 const off_t, const size_t);
546 extern void *ad_mmapwrite (struct adouble *, const u_int32_t,
547 const off_t, const int, const size_t);
548 #define ad_munmap(buf, len) (munmap((buf), (len)))
551 extern int ad_setdate (struct adouble *, unsigned int, u_int32_t);
552 extern int ad_getdate (const struct adouble *, unsigned int, u_int32_t *);
555 extern int ad_setattr (const struct adouble *, const u_int16_t);
556 extern int ad_getattr (const struct adouble *, u_int16_t *);
558 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
559 extern int ad_setname (struct adouble *, const char *);
561 #if AD_VERSION == AD_VERSION2
562 extern int ad_setid (struct adouble *, const dev_t dev,const ino_t ino, const u_int32_t, const u_int32_t, const void *);
563 extern u_int32_t ad_getid (struct adouble *, const dev_t, const ino_t, const cnid_t, const void *);
564 extern u_int32_t ad_forcegetid (struct adouble *adp);
566 #define ad_setid(a, b, c)
570 extern int ad_readfile_init(const struct adouble *ad,
571 const int eid, off_t *off,
576 #ifdef HAVE_SENDFILE_WRITE
577 extern ssize_t ad_writefile (struct adouble *, const int,
578 const int, off_t, const int, const size_t);
579 #endif /* HAVE_SENDFILE_WRITE */
582 #endif /* _ATALK_ADOUBLE_H */