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 #include <atalk/standards.h>
39 #include <sys/types.h>
48 #include <sys/cdefs.h>
56 #ifdef HAVE_SYS_TIME_H
59 #include <netatalk/endian.h>
62 #define AD_VERSION1 0x00010000
63 #define SFM_VERSION AD_VERSION1
65 #define AD_VERSION2 0x00020000
66 #define AD_VERSION2_OSX 0x00020001
68 #define AD_VERSION1_ADS 0x00010002
70 #define AD_VERSION1_SFM 0x00010003
71 #define AD_VERSION AD_VERSION2
74 * AppleDouble entry IDs.
78 #define ADEID_NAME 3 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
79 #define ADEID_COMMENT 4
80 #define ADEID_ICONBW 5
81 #define ADEID_ICONCOL 6
82 #define ADEID_FILEI 7 /* v1, replaced by: */
83 #define ADEID_FILEDATESI 8 /* this */
84 #define ADEID_FINDERI 9
85 #define ADEID_MACFILEI 10 /* we don't use this */
86 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
87 #define ADEID_MSDOSFILEI 12 /* we don't use this */
88 #define ADEID_SHORTNAME 13
89 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
92 #if AD_VERSION == AD_VERSION1
95 /* netatalk private note fileid reused DID */
96 #define ADEID_PRIVDEV 16
97 #define ADEID_PRIVINO 17
98 #define ADEID_PRIVSYN 18 /* in synch with database */
99 #define ADEID_PRIVID 19
100 #define ADEID_SFMRESERVE1 20
101 #define ADEID_SFMRESERVE2 21
103 #define AD_DEV 0x80444556
104 #define AD_INO 0x80494E4F
105 #define AD_SYN 0x8053594E
106 #define AD_ID 0x8053567E
111 #define AD_APPLESINGLE_MAGIC 0x00051600
112 #define AD_APPLEDOUBLE_MAGIC 0x00051607
113 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
114 #define SFM_MAGIC 0x00504641
116 /* sizes of relevant entry bits */
117 #define ADEDLEN_MAGIC 4
118 #define ADEDLEN_VERSION 4
119 #define ADEDLEN_FILLER 16
120 #define ADEDLEN_NENTRIES 2
123 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
124 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
125 #define AD_ENTRY_LEN 12 /* size of a single entry header */
127 /* v1 field widths */
128 #define ADEDLEN_NAME 255
129 #define ADEDLEN_COMMENT 200
130 #define ADEDLEN_FILEI 16
131 #define ADEDLEN_FINDERI 32
133 /* v2 field widths */
134 #define ADEDLEN_FILEDATESI 16
135 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
136 #define ADEDLEN_AFPFILEI 4
137 #define ADEDLEN_MACFILEI 4
138 #define ADEDLEN_PRODOSFILEI 8
139 #define ADEDLEN_MSDOSFILEI 2
140 #define ADEDLEN_DID 4
141 #define ADEDLEN_PRIVDEV 8
142 #define ADEDLEN_PRIVINO 8
143 #define ADEDLEN_PRIVSYN 8
144 #define ADEDLEN_PRIVID 4
146 #define ADEID_NUM_V1 5
147 #define ADEID_NUM_V2 13
149 // #define ADEID_NUM_SFM 5
150 /* sizeof SFM meta data */
151 #define AD_SFM_LEN 60
154 #define AD_DATASZ1 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT + ADEDLEN_FILEI + ADEDLEN_FINDERI + \
155 (ADEID_NUM_V1 * AD_ENTRY_LEN))
157 #if AD_DATASZ1 != 589
158 #error bad size for AD_DATASZ1
161 #define AD_NEWSZ2 (ADEDLEN_DID + ADEDLEN_AFPFILEI + ADEDLEN_SHORTNAME + ADEDLEN_PRODOSFILEI \
162 + ADEDLEN_PRIVDEV + ADEDLEN_PRIVINO + ADEDLEN_PRIVSYN + ADEDLEN_PRIVID)
165 #define AD_DATASZ2 (AD_DATASZ1 + AD_NEWSZ2 + ((ADEID_NUM_V2 - ADEID_NUM_V1) * AD_ENTRY_LEN))
167 #if AD_DATASZ2 != 741
168 #error bad size for AD_DATASZ2
171 #define AD_DATASZ_MAX 1024
172 #if AD_VERSION == AD_VERSION1
173 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
174 #elif AD_VERSION == AD_VERSION2
175 #define AD_DATASZ AD_DATASZ2
179 * some legacy defines from netatalk-990130
180 * (to keep from breaking certain packages)
184 #define ADEDOFF_RFORK 589
185 #define ADEDOFF_NAME 86
186 #define ADEDOFF_COMMENT 341
187 #define ADEDOFF_FINDERI 557
188 #ifndef ADEDOFF_FILEI
189 #define ADEDOFF_FILEI 541
192 typedef u_int32_t cnid_t;
195 * The header of the AppleDouble Header File looks like this:
201 * Home File System 16 (this becomes filler in ad v2)
202 * Number of Entries 2
203 * Entry Descriptors for each entry:
214 typedef struct adf_lock_t {
217 int *refcount; /* handle read locks with multiple users */
221 int adf_fd; /* -1: invalid, -2: symlink */
230 adf_lock_t *adf_lock;
231 int adf_refcount, adf_lockcount, adf_lockmax;
234 /* some header protection */
235 #define AD_INITED 0xad494e54 /* ad"INT" */
240 u_int32_t ad_version;
241 char ad_filler[ 16 ];
242 struct ad_entry ad_eid[ ADEID_MAX ];
243 struct ad_fd ad_data_fork, ad_resource_fork, ad_metadata_fork;
244 struct ad_fd *ad_md; /* either ad_resource or ad_metadata */
246 int ad_flags; /* This really stores version info too (AD_VERSION*) */
247 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
248 unsigned int ad_inited;
251 int ad_refcount; /* used in afpd/ofork.c */
252 off_t ad_rlen; /* ressource fork len with AFP 3.0
253 the header parameter size is too small.
255 char *ad_m_name; /* mac name for open fork */
257 struct adouble_fops *ad_ops;
258 u_int16_t ad_open_forks; /* open forks (by others) */
260 #ifdef USE_MMAPPED_HEADERS
263 char ad_data[AD_DATASZ_MAX];
267 struct adouble_fops {
268 char *(*ad_path)(const char *, int);
269 int (*ad_mkrf)(char *);
270 int (*ad_rebuild_header)(struct adouble *);
271 int (*ad_check_header)(struct adouble *, struct stat *);
272 int (*ad_header_read)(struct adouble *, struct stat *);
273 int (*ad_header_upgrade)(struct adouble *, char *);
276 #define ADFLAGS_DF (1<<0)
277 #define ADFLAGS_HF (1<<1)
278 #define ADFLAGS_DIR (1<<2)
280 #define ADFLAGS_NOADOUBLE (1<<3)
282 #define ADFLAGS_V1COMPAT (1<<4)
283 #define ADFLAGS_NOHF (1<<5) /* not an error if no ressource fork */
284 #define ADFLAGS_RDONLY (1<<6) /* don't try readwrite */
285 #define ADFLAGS_OPENFORKS (1<<7) /* check for open fork in ad_metadata function */
286 #define ADFLAGS_RF (1<<8)
287 #define ADFLAGS_MD ADFLAGS_HF /* (1<<9) */
288 #define ADFLAGS_CREATE (1<<9)
290 /* adouble v2 cnid cache */
291 #define ADVOL_NODEV (1 << 0)
292 #define ADVOL_CACHE (1 << 1)
293 #define ADVOL_UNIXPRIV (1 << 2) /* adouble unix priv */
294 #define ADVOL_INVDOTS (1 << 3) /* dot files (.DS_Store) are invisible) */
295 #define ADVOL_NOADOUBLE (1 << 4)
296 #define ADVOL_FOLLO_SYML (1 << 5)
300 #define ADLOCK_CLR (0)
301 #define ADLOCK_RD (1<<0)
302 #define ADLOCK_WR (1<<1)
303 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
304 #define ADLOCK_UPGRADE (1<<2)
305 #define ADLOCK_FILELOCK (1<<3)
307 /* we use this so that we can use the same mechanism for both byte
308 * locks and file synchronization locks. i do this by co-opting either
309 * first bits on 32-bit machines or shifting above the last bit on
310 * 64-bit machines. this only matters for the data fork. */
311 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
312 /* synchronization locks */
313 #define AD_FILELOCK_BASE (0x80000000)
315 #if _FILE_OFFSET_BITS == 64
316 #define AD_FILELOCK_BASE (0x7FFFFFFFFFFFFFFFULL - 9)
318 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
323 * AD_FILELOCK_BASE case
325 #if _FILE_OFFSET_BITS == 64
326 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
328 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
330 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
332 #define BYTELOCK_MAX (0x7FFFFFFFU)
336 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
337 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
338 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
339 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
340 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
342 /* time stuff. we overload the bits a little. */
343 #define AD_DATE_CREATE 0
344 #define AD_DATE_MODIFY 4
345 #define AD_DATE_BACKUP 8
346 #define AD_DATE_ACCESS 12
347 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
348 AD_DATE_BACKUP | AD_DATE_ACCESS)
349 #define AD_DATE_UNIX (1 << 10)
350 #define AD_DATE_START htonl(0x80000000)
351 #define AD_DATE_DELTA 946684800
352 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
353 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
355 /* various finder offset and info bits */
356 #define FINDERINFO_FRTYPEOFF 0
357 #define FINDERINFO_FRCREATOFF 4
358 #define FINDERINFO_FRFLAGOFF 8
360 /* FinderInfo Flags, char in `ad ls`, valid for files|dirs */
361 #define FINDERINFO_ISONDESK (1) /* "d", fd */
362 #define FINDERINFO_COLOR (0x0e)
363 #define FINDERINFO_HIDEEXT (1<<4) /* "e", fd */
364 #define FINDERINFO_ISHARED (1<<6) /* "m", f */
365 #define FINDERINFO_HASNOINITS (1<<7) /* "n", f */
366 #define FINDERINFO_HASBEENINITED (1<<8) /* "i", fd */
367 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c", fd */
368 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t", f */
369 #define FINDERINFO_NAMELOCKED (1<<12) /* "s", fd */
370 #define FINDERINFO_HASBUNDLE (1<<13) /* "b", fd */
371 #define FINDERINFO_INVISIBLE (1<<14) /* "v", fd */
372 #define FINDERINFO_ISALIAS (1<<15) /* "a", fd */
374 #define FINDERINFO_FRVIEWOFF 14
375 #define FINDERINFO_CUSTOMICON 0x4
376 #define FINDERINFO_CLOSEDVIEW 0x100
379 The "shared" and "invisible" attributes are opaque and stored and
380 retrieved from the FinderFlags. This fixes Bug #2802236:
381 <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
384 /* AFP attributes, char in `ad ls`, valid for files|dirs */
385 #define ATTRBIT_INVISIBLE (1<<0) /* opaque from FinderInfo */
386 #define ATTRBIT_MULTIUSER (1<<1) /* file: opaque, dir: see below */
387 #define ATTRBIT_SYSTEM (1<<2) /* "y", fd */
388 #define ATTRBIT_DOPEN (1<<3) /* data fork already open. Not stored, computed on the fly */
389 #define ATTRBIT_ROPEN (1<<4) /* resource fork already open. Not stored, computed on the fly */
390 #define ATTRBIT_NOWRITE (1<<5) /* "w", f, write inhibit(v2)/read-only(v1) bit */
391 #define ATTRBIT_BACKUP (1<<6) /* "p", fd */
392 #define ATTRBIT_NORENAME (1<<7) /* "r", fd */
393 #define ATTRBIT_NODELETE (1<<8) /* "l", fd */
394 #define ATTRBIT_NOCOPY (1<<10) /* "o", f */
395 #define ATTRBIT_SETCLR (1<<15) /* set/clear bit (d) */
397 /* AFP attributes for dirs. These should probably be computed on the fly.
398 * We don't do that, nor does e.g. OS S X 10.5 Server */
399 #define ATTRBIT_EXPFLDR (1<<1) /* Folder is a sharepoint */
400 #define ATTRBIT_MOUNTED (1<<3) /* Directory is mounted by a user */
401 #define ATTRBIT_SHARED (1<<4) /* Shared area, called IsExpFolder in spec */
403 /* private AFPFileInfo bits */
404 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
405 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
406 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
408 #define ad_data_fileno(ad) ((ad)->ad_data_fork.adf_fd)
409 #define ad_reso_fileno(ad) ((ad)->ad_resource_fork.adf_fd)
410 #define ad_meta_fileno(ad) ((ad)->ad_md->adf_fd)
412 #define ad_getversion(ad) ((ad)->ad_version)
414 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
415 #define ad_setentrylen(ad,eid,len) ((ad)->ad_eid[(eid)].ade_len = (len))
416 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
417 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + (ad)->ad_eid[(eid)].ade_off)
419 #define ad_get_HF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
420 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
422 #define ad_get_syml_opt(ad) (((ad)->ad_options & ADVOL_FOLLO_SYML) ? 0 : O_NOFOLLOW)
425 extern int ad_rebuild_adouble_header (struct adouble *);
426 extern int ad_rebuild_sfm_header (struct adouble *);
427 extern int ad_copy_header (struct adouble *, struct adouble *);
428 extern int ad_flush (struct adouble *);
429 extern int ad_close (struct adouble *, int);
432 extern int ad_fcntl_lock (struct adouble *, const u_int32_t /*eid*/,
433 const int /*type*/, const off_t /*offset*/,
434 const off_t /*len*/, const int /*user*/);
435 extern void ad_fcntl_unlock (struct adouble *, const int /*user*/);
436 extern int ad_fcntl_tmplock (struct adouble *, const u_int32_t /*eid*/,
437 const int /*type*/, const off_t /*offset*/,
438 const off_t /*len*/, const int /*user*/);
439 extern int ad_testlock (struct adouble * /*adp*/, int /*eid*/, off_t /*off*/);
441 extern u_int16_t ad_openforks (struct adouble * /*adp*/, u_int16_t);
442 extern int ad_excl_lock (struct adouble * /*adp*/, const u_int32_t /*eid*/);
444 #define ad_lock ad_fcntl_lock
445 #define ad_tmplock ad_fcntl_tmplock
446 #define ad_unlock ad_fcntl_unlock
449 extern int ad_setfuid (const uid_t );
450 extern uid_t ad_getfuid (void );
451 extern char *ad_dir (const char *);
452 extern char *ad_path (const char *, int);
453 extern char *ad_path_osx (const char *, int);
454 extern char *ad_path_ads (const char *, int);
455 extern char *ad_path_sfm (const char *, int);
456 extern int ad_mode (const char *, int);
457 extern int ad_mkdir (const char *, int);
458 extern void ad_init (struct adouble *, int, int );
459 extern int ad_open (const char *, int, int, int, struct adouble *);
460 extern int ad_openat (int dirfd, const char *, int, int, int, struct adouble *);
461 extern int ad_refresh (struct adouble *);
462 extern int ad_stat (const char *, struct stat *);
463 extern int ad_metadata (const char *, int, struct adouble *);
464 extern int ad_metadataat (int, const char *, int, struct adouble *);
466 #define ad_open_metadata(name, flags, mode, adp)\
467 ad_open(name, ADFLAGS_MD|(flags), O_RDWR |(mode), 0666, (adp))
469 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_MD)
471 /* build a resource fork mode from the data fork mode:
472 * remove X mode and extend header to RW if R or W (W if R for locking),
474 static inline mode_t ad_hf_mode (mode_t mode)
476 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
477 /* fnctl lock need write access */
478 if ((mode & S_IRUSR))
480 if ((mode & S_IRGRP))
482 if ((mode & S_IROTH))
485 /* if write mode set add read mode */
486 if ((mode & S_IWUSR))
488 if ((mode & S_IWGRP))
490 if ((mode & S_IWOTH))
497 ssize_t sys_getxattr (const char *path, const char *name, void *value, size_t size);
498 ssize_t sys_lgetxattr (const char *path, const char *name, void *value, size_t size);
499 ssize_t sys_fgetxattr (int filedes, const char *name, void *value, size_t size);
500 ssize_t sys_listxattr (const char *path, char *list, size_t size);
501 ssize_t sys_llistxattr (const char *path, char *list, size_t size);
502 ssize_t sys_flistxattr (int filedes, char *list, size_t size);
503 int sys_removexattr (const char *path, const char *name);
504 int sys_lremovexattr (const char *path, const char *name);
505 int sys_fremovexattr (int filedes, const char *name);
506 int sys_setxattr (const char *path, const char *name, const void *value, size_t size, int flags);
507 int sys_lsetxattr (const char *path, const char *name, const void *value, size_t size, int flags);
508 int sys_fsetxattr (int filedes, const char *name, const void *value, size_t size, int flags);
509 int sys_copyxattr (const char *src, const char *dst);
511 /* ad_read.c/ad_write.c */
512 extern int sys_ftruncate(int fd, off_t length);
514 extern ssize_t ad_read (struct adouble *, const u_int32_t,
515 const off_t, char *, const size_t);
516 extern ssize_t ad_pread (struct ad_fd *, void *, size_t, off_t);
517 extern ssize_t ad_write (struct adouble *, const u_int32_t, off_t,
518 const int, const char *, const size_t);
519 extern ssize_t adf_pread (struct ad_fd *, void *, size_t, off_t);
520 extern ssize_t adf_pwrite (struct ad_fd *, const void *, size_t, off_t);
521 extern int ad_dtruncate (struct adouble *, const off_t);
522 extern int ad_rtruncate (struct adouble *, const off_t);
525 extern off_t ad_size (const struct adouble *, const u_int32_t );
528 extern void *ad_mmapread (struct adouble *, const u_int32_t,
529 const off_t, const size_t);
530 extern void *ad_mmapwrite (struct adouble *, const u_int32_t,
531 const off_t, const int, const size_t);
532 #define ad_munmap(buf, len) (munmap((buf), (len)))
535 extern int ad_setdate (struct adouble *, unsigned int, u_int32_t);
536 extern int ad_getdate (const struct adouble *, unsigned int, u_int32_t *);
539 extern int ad_setattr (const struct adouble *, const u_int16_t);
540 extern int ad_getattr (const struct adouble *, u_int16_t *);
542 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
543 extern int ad_setname (struct adouble *, const char *);
545 #if AD_VERSION == AD_VERSION2
546 extern int ad_setid (struct adouble *, const dev_t dev,const ino_t ino, const u_int32_t, const u_int32_t, const void *);
547 extern u_int32_t ad_getid (struct adouble *, const dev_t, const ino_t, const cnid_t, const void *);
548 extern u_int32_t ad_forcegetid (struct adouble *adp);
550 #define ad_setid(a, b, c)
554 extern int ad_readfile_init(const struct adouble *ad,
555 const int eid, off_t *off,
560 #ifdef HAVE_SENDFILE_WRITE
561 extern ssize_t ad_writefile (struct adouble *, const int,
562 const int, off_t, const int, const size_t);
563 #endif /* HAVE_SENDFILE_WRITE */
566 #endif /* _ATALK_ADOUBLE_H */