2 * $Id: adouble.h,v 1.50 2009-11-18 11:14:59 didg 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
25 #ifndef _ATALK_ADOUBLE_H
26 #define _ATALK_ADOUBLE_H
32 /* -------------------
33 * need pread() and pwrite()
50 Still have to figure out which platforms really
51 need _XOPEN_SOURCE defined for pread.
53 #if defined(HAVE_PREAD) && !defined(SOLARIS) && !defined(__OpenBSD__) && !defined(__NetBSD__) && !defined(__FreeBSD__) && !defined(TRU64)
57 #define _XOPEN_SOURCE 500
60 #include <sys/types.h>
69 #include <sys/cdefs.h>
76 #ifdef HAVE_SYS_TIME_H
79 #include <netatalk/endian.h>
82 #define AD_VERSION1 0x00010000
83 #define SFM_VERSION AD_VERSION1
85 #define AD_VERSION2 0x00020000
86 #define AD_VERSION2_OSX 0x00020001
88 #define AD_VERSION1_ADS 0x00010002
90 #define AD_VERSION1_SFM 0x00010003
91 #define AD_VERSION AD_VERSION2
94 * AppleDouble entry IDs.
98 #define ADEID_NAME 3 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
99 #define ADEID_COMMENT 4
100 #define ADEID_ICONBW 5
101 #define ADEID_ICONCOL 6
102 #define ADEID_FILEI 7 /* v1, replaced by: */
103 #define ADEID_FILEDATESI 8 /* this */
104 #define ADEID_FINDERI 9
105 #define ADEID_MACFILEI 10 /* we don't use this */
106 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
107 #define ADEID_MSDOSFILEI 12 /* we don't use this */
108 #define ADEID_SHORTNAME 13
109 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
112 #if AD_VERSION == AD_VERSION1
115 /* netatalk private note fileid reused DID */
116 #define ADEID_PRIVDEV 16
117 #define ADEID_PRIVINO 17
118 #define ADEID_PRIVSYN 18 /* in synch with database */
119 #define ADEID_PRIVID 19
120 #define ADEID_SFMRESERVE1 20
121 #define ADEID_SFMRESERVE2 21
123 #define AD_DEV 0x80444556
124 #define AD_INO 0x80494E4F
125 #define AD_SYN 0x8053594E
126 #define AD_ID 0x8053567E
131 #define AD_APPLESINGLE_MAGIC 0x00051600
132 #define AD_APPLEDOUBLE_MAGIC 0x00051607
133 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
134 #define SFM_MAGIC 0x00504641
136 /* sizes of relevant entry bits */
137 #define ADEDLEN_MAGIC 4
138 #define ADEDLEN_VERSION 4
139 #define ADEDLEN_FILLER 16
140 #define ADEDLEN_NENTRIES 2
143 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
144 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
145 #define AD_ENTRY_LEN 12 /* size of a single entry header */
147 /* v1 field widths */
148 #define ADEDLEN_NAME 255
149 #define ADEDLEN_COMMENT 200
150 #define ADEDLEN_FILEI 16
151 #define ADEDLEN_FINDERI 32
153 /* v2 field widths */
154 #define ADEDLEN_FILEDATESI 16
155 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
156 #define ADEDLEN_AFPFILEI 4
157 #define ADEDLEN_MACFILEI 4
158 #define ADEDLEN_PRODOSFILEI 8
159 #define ADEDLEN_MSDOSFILEI 2
160 #define ADEDLEN_DID 4
161 #define ADEDLEN_PRIVDEV 8
162 #define ADEDLEN_PRIVINO 8
163 #define ADEDLEN_PRIVSYN 8
164 #define ADEDLEN_PRIVID 4
166 #define ADEID_NUM_V1 5
167 #define ADEID_NUM_V2 13
169 // #define ADEID_NUM_SFM 5
170 /* sizeof SFM meta data */
171 #define AD_SFM_LEN 60
174 #define AD_DATASZ1 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT + ADEDLEN_FILEI + ADEDLEN_FINDERI + \
175 (ADEID_NUM_V1 * AD_ENTRY_LEN))
177 #if AD_DATASZ1 != 589
178 #error bad size for AD_DATASZ1
181 #define AD_NEWSZ2 (ADEDLEN_DID + ADEDLEN_AFPFILEI + ADEDLEN_SHORTNAME + ADEDLEN_PRODOSFILEI \
182 + ADEDLEN_PRIVDEV + ADEDLEN_PRIVINO + ADEDLEN_PRIVSYN + ADEDLEN_PRIVID)
185 #define AD_DATASZ2 (AD_DATASZ1 + AD_NEWSZ2 + ((ADEID_NUM_V2 - ADEID_NUM_V1) * AD_ENTRY_LEN))
187 #if AD_DATASZ2 != 741
188 #error bad size for AD_DATASZ2
191 #define AD_DATASZ_MAX 1024
192 #if AD_VERSION == AD_VERSION1
193 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
194 #elif AD_VERSION == AD_VERSION2
195 #define AD_DATASZ AD_DATASZ2
199 * some legacy defines from netatalk-990130
200 * (to keep from breaking certain packages)
204 #define ADEDOFF_RFORK 589
205 #define ADEDOFF_NAME 86
206 #define ADEDOFF_COMMENT 341
207 #define ADEDOFF_FINDERI 557
208 #ifndef ADEDOFF_FILEI
209 #define ADEDOFF_FILEI 541
212 typedef u_int32_t cnid_t;
215 * The header of the AppleDouble Header File looks like this:
221 * Home File System 16 (this becomes filler in ad v2)
222 * Number of Entries 2
223 * Entry Descriptors for each entry:
234 typedef struct adf_lock_t {
237 int *refcount; /* handle read locks with multiple users */
249 adf_lock_t *adf_lock;
250 int adf_refcount, adf_lockcount, adf_lockmax;
253 /* some header protection */
254 #define AD_INITED 0xad494e54 /* ad"INT" */
259 u_int32_t ad_version;
260 char ad_filler[ 16 ];
261 struct ad_entry ad_eid[ ADEID_MAX ];
262 struct ad_fd ad_data_fork, ad_resource_fork, ad_metadata_fork;
263 struct ad_fd *ad_md; /* either ad_resource or ad_metadata */
265 int ad_flags; /* This really stores version info too (AD_VERSION*) */
266 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
267 unsigned int ad_inited;
270 int ad_refcount; /* used in afpd/ofork.c */
271 off_t ad_rlen; /* ressource fork len with AFP 3.0
272 the header parameter size is too small.
274 char *ad_m_name; /* mac name for open fork */
276 struct adouble_fops *ad_ops;
277 u_int16_t ad_open_forks; /* open forks (by others) */
279 #ifdef USE_MMAPPED_HEADERS
282 char ad_data[AD_DATASZ_MAX];
286 struct adouble_fops {
287 char *(*ad_path)(const char *, int);
288 int (*ad_mkrf)(char *);
289 int (*ad_rebuild_header)(struct adouble *);
290 int (*ad_check_header)(struct adouble *, struct stat *);
291 int (*ad_header_read)(struct adouble *, struct stat *);
292 int (*ad_header_upgrade)(struct adouble *, char *);
295 #define ADFLAGS_DF (1<<0)
296 #define ADFLAGS_HF (1<<1)
297 #define ADFLAGS_DIR (1<<2)
298 #define ADFLAGS_NOADOUBLE (1<<3)
299 #define ADFLAGS_V1COMPAT (1<<4)
300 #define ADFLAGS_NOHF (1<<5) /* not an error if no ressource fork */
301 #define ADFLAGS_RDONLY (1<<6) /* don't try readwrite */
302 #define ADFLAGS_OPENFORKS (1<<7) /* check for open fork in ad_metadata function */
303 #define ADFLAGS_RF (1<<8)
304 #define ADFLAGS_MD ADFLAGS_HF /* (1<<9) */
305 #define ADFLAGS_CREATE (1<<9)
307 /* adouble v2 cnid cache */
308 #define ADVOL_NODEV (1 << 0)
309 #define ADVOL_CACHE (1 << 1)
310 /* adouble unix priv */
311 #define ADVOL_UNIXPRIV (1 << 2)
312 /* dot files (.DS_Store) are invisible) */
313 #define ADVOL_INVDOTS (1 << 3)
316 #define ADLOCK_CLR (0)
317 #define ADLOCK_RD (1<<0)
318 #define ADLOCK_WR (1<<1)
319 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
320 #define ADLOCK_UPGRADE (1<<2)
321 #define ADLOCK_FILELOCK (1<<3)
323 /* we use this so that we can use the same mechanism for both byte
324 * locks and file synchronization locks. i do this by co-opting either
325 * first bits on 32-bit machines or shifting above the last bit on
326 * 64-bit machines. this only matters for the data fork. */
327 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
328 /* synchronization locks */
329 #define AD_FILELOCK_BASE (0x80000000)
331 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
335 * AD_FILELOCK_BASE case
337 #if _FILE_OFFSET_BITS == 64
338 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
340 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
342 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
344 #define BYTELOCK_MAX (0x7FFFFFFFU)
348 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
349 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
350 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
351 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
352 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
354 /* time stuff. we overload the bits a little. */
355 #define AD_DATE_CREATE 0
356 #define AD_DATE_MODIFY 4
357 #define AD_DATE_BACKUP 8
358 #define AD_DATE_ACCESS 12
359 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
360 AD_DATE_BACKUP | AD_DATE_ACCESS)
361 #define AD_DATE_UNIX (1 << 10)
362 #define AD_DATE_START htonl(0x80000000)
363 #define AD_DATE_DELTA 946684800
364 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
365 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
367 /* various finder offset and info bits */
368 #define FINDERINFO_FRTYPEOFF 0
369 #define FINDERINFO_FRCREATOFF 4
370 #define FINDERINFO_FRFLAGOFF 8
372 /* FinderInfo Flags, char in `ad ls`, valid for files|dirs */
373 #define FINDERINFO_ISONDESK (1) /* "d", fd */
374 #define FINDERINFO_COLOR (0x0e)
375 #define FINDERINFO_HIDEEXT (1<<4) /* "e", fd */
376 #define FINDERINFO_ISHARED (1<<6) /* "m", f */
377 #define FINDERINFO_HASNOINITS (1<<7) /* "n", f */
378 #define FINDERINFO_HASBEENINITED (1<<8) /* "i", fd */
379 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c", fd */
380 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t", f */
381 #define FINDERINFO_NAMELOCKED (1<<12) /* "s", fd */
382 #define FINDERINFO_HASBUNDLE (1<<13) /* "b", fd */
383 #define FINDERINFO_INVISIBLE (1<<14) /* "v", fd */
384 #define FINDERINFO_ISALIAS (1<<15) /* "a", fd */
386 #define FINDERINFO_FRVIEWOFF 14
387 #define FINDERINFO_CUSTOMICON 0x4
388 #define FINDERINFO_CLOSEDVIEW 0x100
391 The "shared" and "invisible" attributes are opaque and stored and
392 retrieved from the FinderFlags. This fixes Bug #2802236:
393 <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
396 /* AFP attributes, char in `ad ls`, valid for files|dirs */
397 #define ATTRBIT_INVISIBLE (1<<0) /* opaque from FinderInfo */
398 #define ATTRBIT_MULTIUSER (1<<1) /* file: opaque, dir: see below */
399 #define ATTRBIT_SYSTEM (1<<2) /* "y", fd */
400 #define ATTRBIT_DOPEN (1<<3) /* data fork already open. Not stored, computed on the fly */
401 #define ATTRBIT_ROPEN (1<<4) /* resource fork already open. Not stored, computed on the fly */
402 #define ATTRBIT_NOWRITE (1<<5) /* "w", f, write inhibit(v2)/read-only(v1) bit */
403 #define ATTRBIT_BACKUP (1<<6) /* "p", fd */
404 #define ATTRBIT_NORENAME (1<<7) /* "r", fd */
405 #define ATTRBIT_NODELETE (1<<8) /* "l", fd */
406 #define ATTRBIT_NOCOPY (1<<10) /* "o", f */
407 #define ATTRBIT_SETCLR (1<<15) /* set/clear bit (d) */
409 /* AFP attributes for dirs. These should probably be computed on the fly.
410 * We don't do that, nor does e.g. OS S X 10.5 Server */
411 #define ATTRBIT_EXPFLDR (1<<1) /* Folder is a sharepoint */
412 #define ATTRBIT_MOUNTED (1<<3) /* Directory is mounted by a user */
413 #define ATTRBIT_SHARED (1<<4) /* Shared area, called IsExpFolder in spec */
415 /* private AFPFileInfo bits */
416 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
417 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
418 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
420 #define ad_data_fileno(ad) ((ad)->ad_data_fork.adf_fd)
421 #define ad_reso_fileno(ad) ((ad)->ad_resource_fork.adf_fd)
422 #define ad_meta_fileno(ad) ((ad)->ad_md->adf_fd)
424 #define ad_getversion(ad) ((ad)->ad_version)
426 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
427 #define ad_setentrylen(ad,eid,len) ((ad)->ad_eid[(eid)].ade_len = (len))
428 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
429 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + (ad)->ad_eid[(eid)].ade_off)
431 #define ad_get_HF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
432 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
435 extern int ad_rebuild_adouble_header (struct adouble *);
436 extern int ad_rebuild_sfm_header (struct adouble *);
437 extern int ad_copy_header (struct adouble *, struct adouble *);
438 extern int ad_flush (struct adouble *);
439 extern int ad_close (struct adouble *, int);
442 extern int ad_fcntl_lock (struct adouble *, const u_int32_t /*eid*/,
443 const int /*type*/, const off_t /*offset*/,
444 const off_t /*len*/, const int /*user*/);
445 extern void ad_fcntl_unlock (struct adouble *, const int /*user*/);
446 extern int ad_fcntl_tmplock (struct adouble *, const u_int32_t /*eid*/,
447 const int /*type*/, const off_t /*offset*/,
448 const off_t /*len*/, const int /*user*/);
449 extern int ad_testlock (struct adouble * /*adp*/, int /*eid*/, off_t /*off*/);
451 extern u_int16_t ad_openforks (struct adouble * /*adp*/, u_int16_t);
452 extern int ad_excl_lock (struct adouble * /*adp*/, const u_int32_t /*eid*/);
454 #define ad_lock ad_fcntl_lock
455 #define ad_tmplock ad_fcntl_tmplock
456 #define ad_unlock ad_fcntl_unlock
459 extern int ad_setfuid (const uid_t );
460 extern uid_t ad_getfuid (void );
461 extern char *ad_dir (const char *);
462 extern char *ad_path (const char *, int);
463 extern char *ad_path_osx (const char *, int);
464 extern char *ad_path_ads (const char *, int);
465 extern char *ad_path_sfm (const char *, int);
466 extern int ad_mode (const char *, int);
467 extern int ad_mkdir (const char *, int);
468 extern void ad_init (struct adouble *, int, int );
469 extern int ad_open (const char *, int, int, int, struct adouble *);
470 extern int ad_refresh (struct adouble *);
471 extern int ad_stat (const char *, struct stat *);
472 extern int ad_metadata (const char *, int, struct adouble *);
474 #define ad_open_metadata(name, flags, mode, adp)\
475 ad_open(name, ADFLAGS_MD|(flags), O_RDWR |(mode), 0666, (adp))
477 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_MD)
479 /* build a resource fork mode from the data fork mode:
480 * remove X mode and extend header to RW if R or W (W if R for locking),
482 static inline mode_t ad_hf_mode (mode_t mode)
484 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
485 /* fnctl lock need write access */
486 if ((mode & S_IRUSR))
488 if ((mode & S_IRGRP))
490 if ((mode & S_IROTH))
493 /* if write mode set add read mode */
494 if ((mode & S_IWUSR))
496 if ((mode & S_IWGRP))
498 if ((mode & S_IWOTH))
505 ssize_t sys_getxattr (const char *path, const char *name, void *value, size_t size);
506 ssize_t sys_lgetxattr (const char *path, const char *name, void *value, size_t size);
507 ssize_t sys_fgetxattr (int filedes, const char *name, void *value, size_t size);
508 ssize_t sys_listxattr (const char *path, char *list, size_t size);
509 ssize_t sys_llistxattr (const char *path, char *list, size_t size);
510 ssize_t sys_flistxattr (int filedes, char *list, size_t size);
511 int sys_removexattr (const char *path, const char *name);
512 int sys_lremovexattr (const char *path, const char *name);
513 int sys_fremovexattr (int filedes, const char *name);
514 int sys_setxattr (const char *path, const char *name, const void *value, size_t size, int flags);
515 int sys_lsetxattr (const char *path, const char *name, const void *value, size_t size, int flags);
516 int sys_fsetxattr (int filedes, const char *name, const void *value, size_t size, int flags);
517 int sys_copyxattr (const char *src, const char *dst);
519 /* ad_read.c/ad_write.c */
520 extern int sys_ftruncate(int fd, off_t length);
522 extern ssize_t ad_read (struct adouble *, const u_int32_t,
523 const off_t, char *, const size_t);
524 extern ssize_t ad_pread (struct ad_fd *, void *, size_t, off_t);
525 extern ssize_t ad_write (struct adouble *, const u_int32_t, off_t,
526 const int, const char *, const size_t);
527 extern ssize_t adf_pread (struct ad_fd *, void *, size_t, off_t);
528 extern ssize_t adf_pwrite (struct ad_fd *, const void *, size_t, off_t);
529 extern int ad_dtruncate (struct adouble *, const off_t);
530 extern int ad_rtruncate (struct adouble *, const off_t);
533 extern off_t ad_size (const struct adouble *, const u_int32_t );
536 extern void *ad_mmapread (struct adouble *, const u_int32_t,
537 const off_t, const size_t);
538 extern void *ad_mmapwrite (struct adouble *, const u_int32_t,
539 const off_t, const int, const size_t);
540 #define ad_munmap(buf, len) (munmap((buf), (len)))
543 extern int ad_setdate (const struct adouble *, unsigned int, u_int32_t);
544 extern int ad_getdate (const struct adouble *, unsigned int, u_int32_t *);
547 extern int ad_setattr (const struct adouble *, const u_int16_t);
548 extern int ad_getattr (const struct adouble *, u_int16_t *);
550 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
551 extern int ad_setname (struct adouble *, const char *);
553 #if AD_VERSION == AD_VERSION2
554 extern int ad_setid (struct adouble *, const dev_t dev,const ino_t ino, const u_int32_t, const u_int32_t, const void *);
555 extern u_int32_t ad_getid (struct adouble *, const dev_t, const ino_t, const cnid_t, const void *);
556 extern u_int32_t ad_forcegetid (struct adouble *adp);
558 #define ad_setid(a, b, c)
562 extern int ad_readfile_init(const struct adouble *ad,
563 const int eid, off_t *off,
568 #ifdef HAVE_SENDFILE_WRITE
569 extern ssize_t ad_writefile (struct adouble *, const int,
570 const int, off_t, const int, const size_t);
571 #endif /* HAVE_SENDFILE_WRITE */
574 #endif /* _ATALK_ADOUBLE_H */