2 * $Id: adouble.h,v 1.21.6.1 2003-09-09 16:42:20 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()
52 #define _XOPEN_SOURCE 500
65 #include <sys/cdefs.h>
66 #include <sys/types.h>
69 #include <netatalk/endian.h>
71 /* XXX: this is the wrong place to put this.
72 * NOTE: as of 2.2.1, linux can't do a sendfile from a socket.
73 * and it doesn't have 64 bits sendfile
75 #ifdef SENDFILE_FLAVOR_LINUX
77 #if _FILE_OFFSET_BITS == 64
79 #undef SENDFILE_FLAVOR_LINUX
81 #else /* _FILE_OFFSET_BITS != 64 */
83 #define HAVE_SENDFILE_READ
84 #define HAVE_SENDFILE_WRITE
85 #include <asm/unistd.h>
89 extern int sendfile __P((int , int , off_t *, size_t ));
91 static __inline__ int sendfile(int fdout, int fdin, off_t *off, size_t count)
93 return syscall(__NR_sendfile, fdout, fdin, off, count);
97 #else /* !__NR_sendfile */
98 #include <sys/sendfile.h>
99 #endif /* __NR_sendfile */
100 #endif /* _FILE_OFFSET_BITS */
101 #endif /* SENDFILE_FLAVOR_LINUX */
103 #ifdef SENDFILE_FLAVOR_BSD
104 #define HAVE_SENDFILE_READ
108 #define AD_VERSION1 0x00010000
109 #define AD_VERSION2 0x00020000
110 #define AD_VERSION AD_VERSION2
113 * AppleDouble entry IDs.
115 #define ADEID_DFORK 1
116 #define ADEID_RFORK 2
118 #define ADEID_COMMENT 4
119 #define ADEID_ICONBW 5
120 #define ADEID_ICONCOL 6
121 #define ADEID_FILEI 7 /* v1, replaced by: */
122 #define ADEID_FILEDATESI 8 /* this */
123 #define ADEID_FINDERI 9
124 #define ADEID_MACFILEI 10 /* we don't use this */
125 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
126 #define ADEID_MSDOSFILEI 12 /* we don't use this */
127 #define ADEID_SHORTNAME 13
128 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
131 #if AD_VERSION == AD_VERSION1
134 /* netatalk private note fileid reused DID */
135 #define ADEID_PRIVDEV 16
136 #define ADEID_PRIVINO 17
137 #define ADEID_PRIVSYN 18 /* in synch with database */
139 #define AD_DEV 0x80444556
140 #define AD_INO 0x80494E4F
141 #define AD_SYN 0x8053594E
146 #define AD_APPLESINGLE_MAGIC 0x00051600
147 #define AD_APPLEDOUBLE_MAGIC 0x00051607
148 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
151 /* sizes of relevant entry bits */
152 #define ADEDLEN_MAGIC 4
153 #define ADEDLEN_VERSION 4
154 #define ADEDLEN_FILLER 16
155 #define ADEDLEN_NENTRIES 2
158 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
159 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
160 #define AD_ENTRY_LEN 12 /* size of a single entry header */
162 /* v1 field widths */
163 #define ADEDLEN_NAME 255
164 #define ADEDLEN_COMMENT 200
165 #define ADEDLEN_FILEI 16
166 #define ADEDLEN_FINDERI 32
168 /* v2 field widths */
169 #define ADEDLEN_FILEDATESI 16
170 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
171 #define ADEDLEN_AFPFILEI 4
172 #define ADEDLEN_MACFILEI 4
173 #define ADEDLEN_PRODOSFILEI 8
174 #define ADEDLEN_MSDOSFILEI 2
175 #define ADEDLEN_DID 4
176 #define ADEDLEN_PRIVDEV 8
177 #define ADEDLEN_PRIVINO 8
178 #define ADEDLEN_PRIVSYN 8
180 #define ADEID_NUM_V1 5
181 #define ADEID_NUM_V2 12
184 #define AD_DATASZ1 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT +ADEDLEN_FILEI +ADEDLEN_FINDERI+\
185 ADEID_NUM_V1*AD_ENTRY_LEN)
187 #if AD_DATASZ1 != 589
188 #error bad size for AD_DATASZ1
191 #define AD_NEWSZ2 (ADEDLEN_DID + ADEDLEN_AFPFILEI +ADEDLEN_SHORTNAME +ADEDLEN_PRODOSFILEI \
192 +ADEDLEN_PRIVDEV +ADEDLEN_PRIVINO +ADEDLEN_PRIVSYN)
195 #define AD_DATASZ2 (AD_DATASZ1 + (ADEID_NUM_V2 -ADEID_NUM_V1)*AD_ENTRY_LEN)
196 #define AD_DATASZ_MAX 1024
197 #if AD_VERSION == AD_VERSION1
198 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
199 #elif AD_VERSION == AD_VERSION2
200 #define AD_DATASZ AD_DATASZ2
204 * some legacy defines from netatalk-990130
205 * (to keep from breaking certain packages)
209 #define ADEDOFF_RFORK 589
210 #define ADEDOFF_NAME 86
211 #define ADEDOFF_COMMENT 341
212 #define ADEDOFF_FINDERI 557
213 #ifndef ADEDOFF_FILEI
214 #define ADEDOFF_FILEI 541
217 typedef u_int32_t cnid_t;
220 * The header of the AppleDouble Header File looks like this:
226 * Home File System 16 (this becomes filler in ad v2)
227 * Number of Entries 2
228 * Entry Descriptors for each entry:
239 typedef struct adf_lock_t {
242 int *refcount; /* handle read locks with multiple users */
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" */
262 u_int32_t ad_version;
263 char ad_filler[ 16 ];
264 struct ad_entry ad_eid[ ADEID_MAX ];
265 struct ad_fd ad_df, ad_hf;
266 int ad_flags, ad_inited;
267 int ad_refcount; /* used in afpd/ofork.c */
268 off_t ad_rlen; /* ressource fork len with AFP 3.0
269 the header parameter size is too small.
271 #ifdef USE_MMAPPED_HEADERS
274 char ad_data[AD_DATASZ_MAX];
278 #define ADFLAGS_DF (1<<0)
279 #define ADFLAGS_HF (1<<1)
280 #define ADFLAGS_DIR (1<<2)
281 #define ADFLAGS_NOADOUBLE (1<<3)
282 #define ADFLAGS_V1COMPAT (1<<4)
283 #define ADFLAGS_NOHF (1<<5) /* not an error if no ressource fork */
286 #define ADLOCK_CLR (0)
287 #define ADLOCK_RD (1<<0)
288 #define ADLOCK_WR (1<<1)
289 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
290 #define ADLOCK_UPGRADE (1<<2)
291 #define ADLOCK_FILELOCK (1<<3)
293 /* we use this so that we can use the same mechanism for both byte
294 * locks and file synchronization locks. i do this by co-opting either
295 * first bits on 32-bit machines or shifting above the last bit on
296 * 64-bit machines. this only matters for the data fork. */
297 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
298 /* synchronization locks */
299 #define AD_FILELOCK_BASE (0x80000000)
301 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
305 * AD_FILELOCK_BASE case
307 #if _FILE_OFFSET_BITS == 64
308 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
310 #define BYTELOCK_MAX (0x7FFFFFFFU)
313 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
314 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
315 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
316 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
317 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
319 /* time stuff. we overload the bits a little. */
320 #define AD_DATE_CREATE 0
321 #define AD_DATE_MODIFY 4
322 #define AD_DATE_BACKUP 8
323 #define AD_DATE_ACCESS 12
324 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
325 AD_DATE_BACKUP | AD_DATE_ACCESS)
326 #define AD_DATE_UNIX (1 << 10)
327 #define AD_DATE_START htonl(0x80000000)
328 #define AD_DATE_DELTA 946684800
329 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
330 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
332 /* private AFPFileInfo bits */
333 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
334 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
335 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
337 #define ad_dfileno(ad) ((ad)->ad_df.adf_fd)
338 #define ad_hfileno(ad) ((ad)->ad_hf.adf_fd)
339 #define ad_getversion(ad) ((ad)->ad_version)
341 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
342 #define ad_setentrylen(ad,eid,len) \
343 ((ad)->ad_eid[(eid)].ade_len = (len))
344 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
345 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + \
346 (ad)->ad_eid[(eid)].ade_off)
347 #define ad_getoflags(ad,adf) (((adf)&ADFLAGS_HF) ? \
348 (ad)->ad_hf.adf_flags : (ad)->ad_df.adf_flags)
350 #define ad_get_HF_flags(ad) ((ad)->ad_hf.adf_flags)
353 extern void ad_rebuild_header __P((struct adouble *));
354 extern int ad_flush __P((struct adouble *, int));
355 extern int ad_close __P((struct adouble *, int));
358 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
359 const int /*type*/, const off_t /*offset*/,
360 const off_t /*len*/, const int /*user*/));
361 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
363 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
364 const int /*type*/, const off_t /*offset*/,
365 const off_t /*len*/, const int /*user*/));
367 extern int ad_testlock __P((struct adouble * /*adp*/, int /*eid*/, off_t /*off*/));
368 extern int ad_excl_lock __P((struct adouble * /*adp*/, const u_int32_t /*eid*/));
370 #define ad_lock ad_fcntl_lock
371 #define ad_tmplock ad_fcntl_tmplock
372 #define ad_unlock ad_fcntl_unlock
375 extern int ad_setfuid __P((const uid_t ));
376 extern uid_t ad_getfuid __P((void ));
378 extern char *ad_dir __P((const char *));
379 extern char *ad_path __P((const char *, int));
380 extern int ad_mode __P((const char *, int));
381 extern int ad_mkdir __P((const char *, int));
382 extern void ad_init __P((struct adouble *, int ));
384 extern int ad_open __P((const char *, int, int, int, struct adouble *));
385 extern int ad_refresh __P((struct adouble *));
386 extern int ad_stat __P((const char *, struct stat *));
388 /* extend header to RW if R or W (W if R for locking),
391 static __inline__ mode_t ad_hf_mode (mode_t mode)
393 /* fnctl lock need write access */
394 if ((mode & S_IRUSR))
396 if ((mode & S_IRGRP))
398 if ((mode & S_IROTH))
401 /* if write mode set add read mode */
402 if ((mode & S_IWUSR))
404 if ((mode & S_IWGRP))
406 if ((mode & S_IWOTH))
412 extern mode_t ad_hf_mode __P((mode_t ));
415 /* ad_read.c/ad_write.c */
416 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
417 const off_t, char *, const size_t));
418 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
420 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
421 const int, const char *, const size_t));
423 extern ssize_t adf_pread __P((struct ad_fd *, void *, size_t, off_t));
424 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
426 extern int ad_dtruncate __P((struct adouble *, const off_t));
427 extern int ad_rtruncate __P((struct adouble *, const off_t));
430 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
433 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
434 const off_t, const size_t));
435 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
436 const off_t, const int, const size_t));
437 #define ad_munmap(buf, len) (munmap((buf), (len)))
440 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
441 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
444 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
445 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
447 #if AD_VERSION == AD_VERSION2
448 extern int ad_setid __P((struct adouble *, const struct stat *, const u_int32_t, const void *));
450 #define ad_setid(a, b, c)
453 #ifdef HAVE_SENDFILE_READ
454 extern ssize_t ad_readfile __P((const struct adouble *, const int,
455 const int, off_t, const size_t));
459 #ifdef HAVE_SENDFILE_WRITE
460 extern ssize_t ad_writefile __P((struct adouble *, const int,
461 const int, off_t, const int, const size_t));