2 * $Id: adouble.h,v 1.37 2009-06-22 12:05:15 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
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
87 #define AD_VERSION1_ADS 0x00010002
88 #define AD_VERSION1_SFM 0x00010003
89 #define AD_VERSION AD_VERSION2
92 * AppleDouble entry IDs.
96 #define ADEID_NAME 3 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
97 #define ADEID_COMMENT 4
98 #define ADEID_ICONBW 5
99 #define ADEID_ICONCOL 6
100 #define ADEID_FILEI 7 /* v1, replaced by: */
101 #define ADEID_FILEDATESI 8 /* this */
102 #define ADEID_FINDERI 9
103 #define ADEID_MACFILEI 10 /* we don't use this */
104 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
105 #define ADEID_MSDOSFILEI 12 /* we don't use this */
106 #define ADEID_SHORTNAME 13
107 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
110 #if AD_VERSION == AD_VERSION1
113 /* netatalk private note fileid reused DID */
114 #define ADEID_PRIVDEV 16
115 #define ADEID_PRIVINO 17
116 #define ADEID_PRIVSYN 18 /* in synch with database */
117 #define ADEID_PRIVID 19
118 #define ADEID_SFMRESERVE1 20
119 #define ADEID_SFMRESERVE2 21
121 #define AD_DEV 0x80444556
122 #define AD_INO 0x80494E4F
123 #define AD_SYN 0x8053594E
124 #define AD_ID 0x8053567E
129 #define AD_APPLESINGLE_MAGIC 0x00051600
130 #define AD_APPLEDOUBLE_MAGIC 0x00051607
131 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
133 #define SFM_MAGIC 0x00504641
135 /* sizes of relevant entry bits */
136 #define ADEDLEN_MAGIC 4
137 #define ADEDLEN_VERSION 4
138 #define ADEDLEN_FILLER 16
139 #define ADEDLEN_NENTRIES 2
142 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
143 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
144 #define AD_ENTRY_LEN 12 /* size of a single entry header */
146 /* v1 field widths */
147 #define ADEDLEN_NAME 255
148 #define ADEDLEN_COMMENT 200
149 #define ADEDLEN_FILEI 16
150 #define ADEDLEN_FINDERI 32
152 /* v2 field widths */
153 #define ADEDLEN_FILEDATESI 16
154 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
155 #define ADEDLEN_AFPFILEI 4
156 #define ADEDLEN_MACFILEI 4
157 #define ADEDLEN_PRODOSFILEI 8
158 #define ADEDLEN_MSDOSFILEI 2
159 #define ADEDLEN_DID 4
160 #define ADEDLEN_PRIVDEV 8
161 #define ADEDLEN_PRIVINO 8
162 #define ADEDLEN_PRIVSYN 8
163 #define ADEDLEN_PRIVID 4
165 #define ADEID_NUM_V1 5
166 #define ADEID_NUM_V2 13
168 // #define ADEID_NUM_SFM 5
169 /* sizeof SFM meta data */
170 #define AD_SFM_LEN 60
173 #define AD_DATASZ1 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT +ADEDLEN_FILEI +ADEDLEN_FINDERI+\
174 ADEID_NUM_V1*AD_ENTRY_LEN)
176 #if AD_DATASZ1 != 589
177 #error bad size for AD_DATASZ1
180 #define AD_NEWSZ2 (ADEDLEN_DID + ADEDLEN_AFPFILEI +ADEDLEN_SHORTNAME +ADEDLEN_PRODOSFILEI \
181 +ADEDLEN_PRIVDEV +ADEDLEN_PRIVINO +ADEDLEN_PRIVSYN+ ADEDLEN_PRIVID)
184 #define AD_DATASZ2 (AD_DATASZ1 + AD_NEWSZ2 + (ADEID_NUM_V2 -ADEID_NUM_V1)*AD_ENTRY_LEN)
186 #if AD_DATASZ2 != 741
187 #error bad size for AD_DATASZ2
190 #define AD_DATASZ_MAX 1024
191 #if AD_VERSION == AD_VERSION1
192 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
193 #elif AD_VERSION == AD_VERSION2
194 #define AD_DATASZ AD_DATASZ2
198 * some legacy defines from netatalk-990130
199 * (to keep from breaking certain packages)
203 #define ADEDOFF_RFORK 589
204 #define ADEDOFF_NAME 86
205 #define ADEDOFF_COMMENT 341
206 #define ADEDOFF_FINDERI 557
207 #ifndef ADEDOFF_FILEI
208 #define ADEDOFF_FILEI 541
211 typedef u_int32_t cnid_t;
214 * The header of the AppleDouble Header File looks like this:
220 * Home File System 16 (this becomes filler in ad v2)
221 * Number of Entries 2
222 * Entry Descriptors for each entry:
233 typedef struct adf_lock_t {
236 int *refcount; /* handle read locks with multiple users */
248 adf_lock_t *adf_lock;
249 int adf_refcount, adf_lockcount, adf_lockmax;
252 /* some header protection */
253 #define AD_INITED 0xad494e54 /* ad"INT" */
258 u_int32_t ad_version;
259 char ad_filler[ 16 ];
260 struct ad_entry ad_eid[ ADEID_MAX ];
261 struct ad_fd ad_data_fork, ad_resource_fork, ad_metadata_fork;
262 struct ad_fd *ad_md; /* either ad_resource or ad_metadata */
264 int ad_flags; /* This really stores version info too (AD_VERSION*) */
265 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
266 unsigned int ad_inited;
269 int ad_refcount; /* used in afpd/ofork.c */
270 off_t ad_rlen; /* ressource fork len with AFP 3.0
271 the header parameter size is too small.
273 char *ad_m_name; /* mac name for open fork */
275 struct adouble_fops *ad_ops;
278 u_int16_t ad_open_forks; /* open forks (by others) */
280 #ifdef USE_MMAPPED_HEADERS
283 char ad_data[AD_DATASZ_MAX];
287 struct adouble_fops {
288 char *(*ad_path)(const char *, int);
289 int (*ad_mkrf)(char *);
291 int (*ad_rebuild_header)(struct adouble *);
292 int (*ad_check_header)(struct adouble *, struct stat *);
293 int (*ad_header_read)(struct adouble *, struct stat *);
295 int (*ad_header_upgrade)(struct adouble *, char *);
299 #define ADFLAGS_DF (1<<0)
300 #define ADFLAGS_HF (1<<1)
301 #define ADFLAGS_DIR (1<<2)
302 #define ADFLAGS_NOADOUBLE (1<<3)
303 #define ADFLAGS_V1COMPAT (1<<4)
304 #define ADFLAGS_NOHF (1<<5) /* not an error if no ressource fork */
305 #define ADFLAGS_RDONLY (1<<6) /* don't try readwrite */
306 #define ADFLAGS_OPENFORKS (1<<7) /* check for open fork in ad_metadata function */
307 #define ADFLAGS_RF (1<<8)
308 #define ADFLAGS_MD ADFLAGS_HF /* (1<<9) */
309 #define ADFLAGS_CREATE (1<<9)
311 /* adouble v2 cnid cache */
312 #define ADVOL_NODEV (1 << 0)
313 #define ADVOL_CACHE (1 << 1)
314 /* adouble unix priv */
315 #define ADVOL_UNIXPRIV (1 << 2)
316 /* dot files (.DS_Store) are invisible) */
317 #define ADVOL_INVDOTS (1 << 3)
320 #define ADLOCK_CLR (0)
321 #define ADLOCK_RD (1<<0)
322 #define ADLOCK_WR (1<<1)
323 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
324 #define ADLOCK_UPGRADE (1<<2)
325 #define ADLOCK_FILELOCK (1<<3)
327 /* we use this so that we can use the same mechanism for both byte
328 * locks and file synchronization locks. i do this by co-opting either
329 * first bits on 32-bit machines or shifting above the last bit on
330 * 64-bit machines. this only matters for the data fork. */
331 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
332 /* synchronization locks */
333 #define AD_FILELOCK_BASE (0x80000000)
335 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
339 * AD_FILELOCK_BASE case
341 #if _FILE_OFFSET_BITS == 64
342 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
344 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
346 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
348 #define BYTELOCK_MAX (0x7FFFFFFFU)
352 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
353 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
354 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
355 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
356 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
358 /* time stuff. we overload the bits a little. */
359 #define AD_DATE_CREATE 0
360 #define AD_DATE_MODIFY 4
361 #define AD_DATE_BACKUP 8
362 #define AD_DATE_ACCESS 12
363 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
364 AD_DATE_BACKUP | AD_DATE_ACCESS)
365 #define AD_DATE_UNIX (1 << 10)
366 #define AD_DATE_START htonl(0x80000000)
367 #define AD_DATE_DELTA 946684800
368 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
369 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
371 /* various finder offset and info bits */
372 #define FINDERINFO_FRTYPEOFF 0
373 #define FINDERINFO_FRCREATOFF 4
374 #define FINDERINFO_FRFLAGOFF 8
376 /* finderinfo flags */
377 #define FINDERINFO_ISONDESK (1) /* "d" */
378 #define FINDERINFO_COLOR (0x0e)
379 #define FINDERINFO_ISHARED (1<<6) /* "m" */
380 #define FINDERINFO_HASNOINITS (1<<7) /* "n" */
381 #define FINDERINFO_HASBEENINITED (1<<8) /* "i" */
382 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c" */
383 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t" */
384 #define FINDERINFO_NAMELOCKED (1<<12) /* "s" */
385 #define FINDERINFO_HASBUNDLE (1<<13) /* "b" */
386 #define FINDERINFO_INVISIBLE (1<<14) /* "v" */
387 #define FINDERINFO_ISALIAS (1<<15) /* "a" */
389 #define FINDERINFO_FRVIEWOFF 14
390 #define FINDERINFO_CUSTOMICON 0x4
391 #define FINDERINFO_CLOSEDVIEW 0x100
394 The "shared" and "invisible" attributes are opaque and stored and
395 retrieved from the FinderFlags. This fixes Bug #2802236:
396 <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
399 /* AFP attributes for files and dirs. (d) = only these are valid for directories */
400 #define ATTRBIT_INVISIBLE (1<<0) /* (d) */
401 #define ATTRBIT_MULTIUSER (1<<1)
402 #define ATTRBIT_SYSTEM (1<<2) /* "y" (d) */
403 #define ATTRBIT_DOPEN (1<<3) /* data fork already open */
404 #define ATTRBIT_ROPEN (1<<4) /* resource fork already open */
405 #define ATTRBIT_NOWRITE (1<<5) /* "w" write inhibit(v2)/read-only(v1) bit ("") */
406 #define ATTRBIT_BACKUP (1<<6) /* "b" (d) */
407 #define ATTRBIT_NORENAME (1<<7) /* "r" (d) */
408 #define ATTRBIT_NODELETE (1<<8) /* "d" (d) */
409 #define ATTRBIT_NOCOPY (1<<10) /* "c" */
410 #define ATTRBIT_SETCLR (1<<15) /* set/clear bits (d) */
412 /* AFP attributes for dirs */
413 #define ATTRBIT_EXPFLDR (1<<1) /* Folder is a sharepoint ("p") */
414 #define ATTRBIT_MOUNTED (1<<3) /* Directory is mounted by a user ("") */
415 #define ATTRBIT_SHARED (1<<4) /* shared area, called IsExpFolder in spec ("") */
417 /* private AFPFileInfo bits */
418 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
419 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
420 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
422 #define ad_data_fileno(ad) ((ad)->ad_data_fork.adf_fd)
423 #define ad_reso_fileno(ad) ((ad)->ad_resource_fork.adf_fd)
424 #define ad_meta_fileno(ad) ((ad)->ad_md->adf_fd)
426 #define ad_getversion(ad) ((ad)->ad_version)
428 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
429 #define ad_setentrylen(ad,eid,len) \
430 ((ad)->ad_eid[(eid)].ade_len = (len))
431 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
432 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + \
433 (ad)->ad_eid[(eid)].ade_off)
435 #define ad_get_HF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
436 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
441 extern int ad_rebuild_adouble_header __P((struct adouble *));
442 extern int ad_rebuild_sfm_header __P((struct adouble *));
444 extern int ad_flush __P((struct adouble *));
445 extern int ad_close __P((struct adouble *, int));
448 extern int ad_fcntl_lock __P((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 __P((struct adouble *, const int /*user*/));
453 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
454 const int /*type*/, const off_t /*offset*/,
455 const off_t /*len*/, const int /*user*/));
457 extern int ad_testlock __P((struct adouble * /*adp*/, int /*eid*/, off_t /*off*/));
458 extern int ad_excl_lock __P((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 __P((const uid_t ));
466 extern uid_t ad_getfuid __P((void ));
468 extern char *ad_dir __P((const char *));
469 extern char *ad_path __P((const char *, int));
470 extern char *ad_path_osx __P((const char *, int));
471 extern char *ad_path_ads __P((const char *, int));
472 extern char *ad_path_sfm __P((const char *, int));
474 extern int ad_mode __P((const char *, int));
475 extern int ad_mkdir __P((const char *, int));
476 extern void ad_init __P((struct adouble *, int, int ));
478 extern int ad_open __P((const char *, int, int, int, struct adouble *));
479 extern int ad_refresh __P((struct adouble *));
480 extern int ad_stat __P((const char *, struct stat *));
481 extern int ad_metadata __P((const char *, int, struct adouble *));
483 #define ad_open_metadata(name, flags, mode, adp)\
484 ad_open(name, ADFLAGS_MD|(flags), O_RDWR |(mode), 0666, (adp))
486 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_MD)
488 /* build a resource fork mode from the data fork mode:
489 * remove X mode and extend header to RW if R or W (W if R for locking),
492 static inline mode_t ad_hf_mode (mode_t mode)
494 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
495 /* fnctl lock need write access */
496 if ((mode & S_IRUSR))
498 if ((mode & S_IRGRP))
500 if ((mode & S_IROTH))
503 /* if write mode set add read mode */
504 if ((mode & S_IWUSR))
506 if ((mode & S_IWGRP))
508 if ((mode & S_IWOTH))
514 extern mode_t ad_hf_mode __P((mode_t ));
517 /* ad_read.c/ad_write.c */
518 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
519 const off_t, char *, const size_t));
520 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
522 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
523 const int, const char *, const size_t));
525 extern ssize_t adf_pread __P((struct ad_fd *, void *, size_t, off_t));
526 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
528 extern int ad_dtruncate __P((struct adouble *, const off_t));
529 extern int ad_rtruncate __P((struct adouble *, const off_t));
532 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
535 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
536 const off_t, const size_t));
537 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
538 const off_t, const int, const size_t));
539 #define ad_munmap(buf, len) (munmap((buf), (len)))
542 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
543 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
546 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
547 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
548 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
549 extern int ad_setname __P((struct adouble *, const char *));
550 #if AD_VERSION == AD_VERSION2
551 extern int ad_setid __P((struct adouble *, const dev_t dev,const ino_t ino, const u_int32_t, const u_int32_t, const void *));
552 extern u_int32_t ad_getid __P((struct adouble *, const dev_t, const ino_t, const cnid_t, const void *));
553 extern u_int32_t ad_forcegetid __P((struct adouble *adp));
555 #define ad_setid(a, b, c)
559 extern ssize_t ad_readfile __P((const struct adouble *, const int,
560 const int, off_t, const size_t));
564 #ifdef HAVE_SENDFILE_WRITE
565 extern ssize_t ad_writefile __P((struct adouble *, const int,
566 const int, off_t, const int, const size_t));