2 * $Id: adouble.h,v 1.41 2009-09-14 00:02:21 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
135 #define SFM_MAGIC 0x00504641
137 /* sizes of relevant entry bits */
138 #define ADEDLEN_MAGIC 4
139 #define ADEDLEN_VERSION 4
140 #define ADEDLEN_FILLER 16
141 #define ADEDLEN_NENTRIES 2
144 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
145 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
146 #define AD_ENTRY_LEN 12 /* size of a single entry header */
148 /* v1 field widths */
149 #define ADEDLEN_NAME 255
150 #define ADEDLEN_COMMENT 200
151 #define ADEDLEN_FILEI 16
152 #define ADEDLEN_FINDERI 32
154 /* v2 field widths */
155 #define ADEDLEN_FILEDATESI 16
156 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
157 #define ADEDLEN_AFPFILEI 4
158 #define ADEDLEN_MACFILEI 4
159 #define ADEDLEN_PRODOSFILEI 8
160 #define ADEDLEN_MSDOSFILEI 2
161 #define ADEDLEN_DID 4
162 #define ADEDLEN_PRIVDEV 8
163 #define ADEDLEN_PRIVINO 8
164 #define ADEDLEN_PRIVSYN 8
165 #define ADEDLEN_PRIVID 4
167 #define ADEID_NUM_V1 5
168 #define ADEID_NUM_V2 13
170 // #define ADEID_NUM_SFM 5
171 /* sizeof SFM meta data */
172 #define AD_SFM_LEN 60
175 #define AD_DATASZ1 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT +ADEDLEN_FILEI +ADEDLEN_FINDERI+\
176 ADEID_NUM_V1*AD_ENTRY_LEN)
178 #if AD_DATASZ1 != 589
179 #error bad size for AD_DATASZ1
182 #define AD_NEWSZ2 (ADEDLEN_DID + ADEDLEN_AFPFILEI +ADEDLEN_SHORTNAME +ADEDLEN_PRODOSFILEI \
183 +ADEDLEN_PRIVDEV +ADEDLEN_PRIVINO +ADEDLEN_PRIVSYN+ ADEDLEN_PRIVID)
186 #define AD_DATASZ2 (AD_DATASZ1 + AD_NEWSZ2 + (ADEID_NUM_V2 -ADEID_NUM_V1)*AD_ENTRY_LEN)
188 #if AD_DATASZ2 != 741
189 #error bad size for AD_DATASZ2
192 #define AD_DATASZ_MAX 1024
193 #if AD_VERSION == AD_VERSION1
194 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
195 #elif AD_VERSION == AD_VERSION2
196 #define AD_DATASZ AD_DATASZ2
200 * some legacy defines from netatalk-990130
201 * (to keep from breaking certain packages)
205 #define ADEDOFF_RFORK 589
206 #define ADEDOFF_NAME 86
207 #define ADEDOFF_COMMENT 341
208 #define ADEDOFF_FINDERI 557
209 #ifndef ADEDOFF_FILEI
210 #define ADEDOFF_FILEI 541
213 typedef u_int32_t cnid_t;
216 * The header of the AppleDouble Header File looks like this:
222 * Home File System 16 (this becomes filler in ad v2)
223 * Number of Entries 2
224 * Entry Descriptors for each entry:
235 typedef struct adf_lock_t {
238 int *refcount; /* handle read locks with multiple users */
250 adf_lock_t *adf_lock;
251 int adf_refcount, adf_lockcount, adf_lockmax;
254 /* some header protection */
255 #define AD_INITED 0xad494e54 /* ad"INT" */
260 u_int32_t ad_version;
261 char ad_filler[ 16 ];
262 struct ad_entry ad_eid[ ADEID_MAX ];
263 struct ad_fd ad_data_fork, ad_resource_fork, ad_metadata_fork;
264 struct ad_fd *ad_md; /* either ad_resource or ad_metadata */
266 int ad_flags; /* This really stores version info too (AD_VERSION*) */
267 int ad_adflags; /* ad_open flags adflags like ADFLAGS_DIR */
268 unsigned int ad_inited;
271 int ad_refcount; /* used in afpd/ofork.c */
272 off_t ad_rlen; /* ressource fork len with AFP 3.0
273 the header parameter size is too small.
275 char *ad_m_name; /* mac name for open fork */
277 struct adouble_fops *ad_ops;
280 u_int16_t ad_open_forks; /* open forks (by others) */
282 #ifdef USE_MMAPPED_HEADERS
285 char ad_data[AD_DATASZ_MAX];
289 struct adouble_fops {
290 char *(*ad_path)(const char *, int);
291 int (*ad_mkrf)(char *);
293 int (*ad_rebuild_header)(struct adouble *);
294 int (*ad_check_header)(struct adouble *, struct stat *);
295 int (*ad_header_read)(struct adouble *, struct stat *);
297 int (*ad_header_upgrade)(struct adouble *, char *);
301 #define ADFLAGS_DF (1<<0)
302 #define ADFLAGS_HF (1<<1)
303 #define ADFLAGS_DIR (1<<2)
304 #define ADFLAGS_NOADOUBLE (1<<3)
305 #define ADFLAGS_V1COMPAT (1<<4)
306 #define ADFLAGS_NOHF (1<<5) /* not an error if no ressource fork */
307 #define ADFLAGS_RDONLY (1<<6) /* don't try readwrite */
308 #define ADFLAGS_OPENFORKS (1<<7) /* check for open fork in ad_metadata function */
309 #define ADFLAGS_RF (1<<8)
310 #define ADFLAGS_MD ADFLAGS_HF /* (1<<9) */
311 #define ADFLAGS_CREATE (1<<9)
313 /* adouble v2 cnid cache */
314 #define ADVOL_NODEV (1 << 0)
315 #define ADVOL_CACHE (1 << 1)
316 /* adouble unix priv */
317 #define ADVOL_UNIXPRIV (1 << 2)
318 /* dot files (.DS_Store) are invisible) */
319 #define ADVOL_INVDOTS (1 << 3)
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) \
434 ((ad)->ad_eid[(eid)].ade_len = (len))
435 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
436 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + \
437 (ad)->ad_eid[(eid)].ade_off)
439 #define ad_get_HF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
440 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
445 extern int ad_rebuild_adouble_header __P((struct adouble *));
446 extern int ad_rebuild_sfm_header __P((struct adouble *));
447 extern int ad_copy_header __P((struct adouble *, struct adouble *));
449 extern int ad_flush __P((struct adouble *));
450 extern int ad_close __P((struct adouble *, int));
453 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
454 const int /*type*/, const off_t /*offset*/,
455 const off_t /*len*/, const int /*user*/));
456 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
458 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
459 const int /*type*/, const off_t /*offset*/,
460 const off_t /*len*/, const int /*user*/));
462 extern int ad_testlock __P((struct adouble * /*adp*/, int /*eid*/, off_t /*off*/));
463 extern int ad_excl_lock __P((struct adouble * /*adp*/, const u_int32_t /*eid*/));
465 #define ad_lock ad_fcntl_lock
466 #define ad_tmplock ad_fcntl_tmplock
467 #define ad_unlock ad_fcntl_unlock
470 extern int ad_setfuid __P((const uid_t ));
471 extern uid_t ad_getfuid __P((void ));
473 extern char *ad_dir __P((const char *));
474 extern char *ad_path __P((const char *, int));
475 extern char *ad_path_osx __P((const char *, int));
476 extern char *ad_path_ads __P((const char *, int));
477 extern char *ad_path_sfm __P((const char *, int));
479 extern int ad_mode __P((const char *, int));
480 extern int ad_mkdir __P((const char *, int));
481 extern void ad_init __P((struct adouble *, int, int ));
483 extern int ad_open __P((const char *, int, int, int, struct adouble *));
484 extern int ad_refresh __P((struct adouble *));
485 extern int ad_stat __P((const char *, struct stat *));
486 extern int ad_metadata __P((const char *, int, struct adouble *));
488 #define ad_open_metadata(name, flags, mode, adp)\
489 ad_open(name, ADFLAGS_MD|(flags), O_RDWR |(mode), 0666, (adp))
491 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_MD)
493 /* build a resource fork mode from the data fork mode:
494 * remove X mode and extend header to RW if R or W (W if R for locking),
496 static inline mode_t ad_hf_mode (mode_t mode)
498 mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
499 /* fnctl lock need write access */
500 if ((mode & S_IRUSR))
502 if ((mode & S_IRGRP))
504 if ((mode & S_IROTH))
507 /* if write mode set add read mode */
508 if ((mode & S_IWUSR))
510 if ((mode & S_IWGRP))
512 if ((mode & S_IWOTH))
518 /* ad_read.c/ad_write.c */
519 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
520 const off_t, char *, const size_t));
521 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
523 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
524 const int, const char *, const size_t));
526 extern ssize_t adf_pread __P((struct ad_fd *, void *, size_t, off_t));
527 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
529 extern int ad_dtruncate __P((struct adouble *, const off_t));
530 extern int ad_rtruncate __P((struct adouble *, const off_t));
533 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
536 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
537 const off_t, const size_t));
538 extern void *ad_mmapwrite __P((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 __P((const struct adouble *, unsigned int, u_int32_t));
544 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
547 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
548 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
549 /* Note: starting with Netatalk 2.1 we do NOT alway set the name */
550 extern int ad_setname __P((struct adouble *, const char *));
551 #if AD_VERSION == AD_VERSION2
552 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 *));
553 extern u_int32_t ad_getid __P((struct adouble *, const dev_t, const ino_t, const cnid_t, const void *));
554 extern u_int32_t ad_forcegetid __P((struct adouble *adp));
556 #define ad_setid(a, b, c)
560 extern ssize_t ad_readfile __P((const struct adouble *, const int,
561 const int, off_t, const size_t));
565 #ifdef HAVE_SENDFILE_WRITE
566 extern ssize_t ad_writefile __P((struct adouble *, const int,
567 const int, off_t, const int, const size_t));