2 * $Id: adouble.h,v 1.13 2003-01-16 20:06:33 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
28 /* -------------------
29 * need pread() and pwrite()
48 #define _XOPEN_SOURCE 500
59 #include <sys/cdefs.h>
60 #include <sys/types.h>
63 #include <netatalk/endian.h>
65 /* XXX: this is the wrong place to put this.
66 * NOTE: as of 2.2.1, linux can't do a sendfile from a socket.
67 * and it doesn't have 64 bits sendfile
69 #ifdef SENDFILE_FLAVOR_LINUX
71 #if _FILE_OFFSET_BITS == 64
73 #undef SENDFILE_FLAVOR_LINUX
76 #define HAVE_SENDFILE_READ
77 #define HAVE_SENDFILE_WRITE
78 #include <asm/unistd.h>
82 static __inline__ int sendfile(int fdout, int fdin, off_t *off, size_t count)
84 #if _FILE_OFFSET_BITS == 64
85 return syscall(__NR_sendfile64, fdout, fdin, off, count);
87 return syscall(__NR_sendfile, fdout, fdin, off, count);
91 extern int sendfile __P((int , int , off_t *, size_t ));
95 #include <sys/sendfile.h>
98 #endif /* SENDFILE_FLAVOR_LINUX */
100 #ifdef SENDFILE_FLAVOR_BSD
101 #define HAVE_SENDFILE_READ
105 * AppleDouble entry IDs.
107 #define ADEID_DFORK 1
108 #define ADEID_RFORK 2
110 #define ADEID_COMMENT 4
111 #define ADEID_ICONBW 5
112 #define ADEID_ICONCOL 6
113 #define ADEID_FILEI 7 /* v1, replaced by: */
114 #define ADEID_FILEDATESI 8 /* this */
115 #define ADEID_FINDERI 9
116 #define ADEID_MACFILEI 10 /* we don't use this */
117 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
118 #define ADEID_MSDOSFILEI 12 /* we don't use this */
119 #define ADEID_SHORTNAME 13
120 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
126 #define AD_APPLESINGLE_MAGIC 0x00051600
127 #define AD_APPLEDOUBLE_MAGIC 0x00051607
128 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
131 #define AD_VERSION1 0x00010000
132 #define AD_VERSION2 0x00020000
133 #define AD_VERSION AD_VERSION1
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
141 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
142 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
143 #define AD_ENTRY_LEN 12 /* size of a single entry header */
145 /* v1 field widths */
146 #define ADEDLEN_NAME 255
147 #define ADEDLEN_COMMENT 200
148 #define ADEDLEN_FILEI 16
149 #define ADEDLEN_FINDERI 32
151 /* v2 field widths */
152 #define ADEDLEN_FILEDATESI 16
153 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
154 #define ADEDLEN_AFPFILEI 4
155 #define ADEDLEN_MACFILEI 4
156 #define ADEDLEN_PRODOSFILEI 8
157 #define ADEDLEN_MSDOSFILEI 2
158 #define ADEDLEN_DID 4
161 #define AD_DATASZ1 589
162 #define AD_DATASZ2 665 /* v1 + 4 new entries (entry desc. + entry) */
163 #define AD_DATASZ_MAX 1024
164 #if AD_VERSION == AD_VERSION1
165 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
166 #elif AD_VERSION == AD_VERSION2
167 #define AD_DATASZ AD_DATASZ2
171 * some legacy defines from netatalk-990130
172 * (to keep from breaking certain packages)
176 #define ADEDOFF_RFORK 589
177 #define ADEDOFF_NAME 86
178 #define ADEDOFF_COMMENT 341
179 #define ADEDOFF_FINDERI 557
180 #ifndef ADEDOFF_FILEI
181 #define ADEDOFF_FILEI 541
185 * The header of the AppleDouble Header File looks like this:
191 * Home File System 16 (this becomes filler in ad v2)
192 * Number of Entries 2
193 * Entry Descriptors for each entry:
204 typedef struct adf_lock_t {
207 int *refcount; /* handle read locks with multiple users */
218 adf_lock_t *adf_lock;
219 int adf_refcount, adf_lockcount, adf_lockmax;
222 /* some header protection */
223 #define AD_INITED 0xad494e54 /* ad"INT" */
226 u_int32_t ad_version;
227 char ad_filler[ 16 ];
228 struct ad_entry ad_eid[ ADEID_MAX ];
229 struct ad_fd ad_df, ad_hf;
230 int ad_flags, ad_inited;
231 int ad_refcount; /* used in afpd/ofork.c */
232 off_t ad_rlen; /* ressource fork len with AFP 3.0
233 the header parameter size is too small.
235 #ifdef USE_MMAPPED_HEADERS
238 char ad_data[AD_DATASZ_MAX];
242 #define ADFLAGS_DF (1<<0)
243 #define ADFLAGS_HF (1<<1)
244 #define ADFLAGS_DIR (1<<2)
245 #define ADFLAGS_NOADOUBLE (1<<3)
246 #define ADFLAGS_V1COMPAT (1<<4)
249 #define ADLOCK_CLR (0)
250 #define ADLOCK_RD (1<<0)
251 #define ADLOCK_WR (1<<1)
252 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
253 #define ADLOCK_UPGRADE (1<<2)
254 #define ADLOCK_FILELOCK (1<<3)
256 /* we use this so that we can use the same mechanism for both byte
257 * locks and file synchronization locks. i do this by co-opting either
258 * first bits on 32-bit machines or shifting above the last bit on
259 * 64-bit machines. this only matters for the data fork. */
260 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
261 /* synchronization locks */
262 #define AD_FILELOCK_BASE (0x80000000)
264 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
268 * AD_FILELOCK_BASE case
270 #if _FILE_OFFSET_BITS == 64
271 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
273 #define BYTELOCK_MAX (0x7FFFFFFFU)
276 #define AD_FILELOCK_OPEN_WR (AD_FILELOCK_BASE + 0)
277 #define AD_FILELOCK_OPEN_RD (AD_FILELOCK_BASE + 1)
278 #define AD_FILELOCK_DENY_WR (AD_FILELOCK_BASE + 2)
279 #define AD_FILELOCK_DENY_RD (AD_FILELOCK_BASE + 3)
280 #define AD_FILELOCK_OPEN_NONE (AD_FILELOCK_BASE + 4)
282 /* time stuff. we overload the bits a little. */
283 #define AD_DATE_CREATE 0
284 #define AD_DATE_MODIFY 4
285 #define AD_DATE_BACKUP 8
286 #define AD_DATE_ACCESS 12
287 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
288 AD_DATE_BACKUP | AD_DATE_ACCESS)
289 #define AD_DATE_UNIX (1 << 10)
290 #define AD_DATE_START htonl(0x80000000)
291 #define AD_DATE_DELTA 946684800
292 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
293 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
295 /* private AFPFileInfo bits */
296 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
297 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
298 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
300 #define ad_dfileno(ad) ((ad)->ad_df.adf_fd)
301 #define ad_hfileno(ad) ((ad)->ad_hf.adf_fd)
302 #define ad_getversion(ad) ((ad)->ad_version)
304 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
305 #define ad_setentrylen(ad,eid,len) \
306 ((ad)->ad_eid[(eid)].ade_len = (len))
307 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
308 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + \
309 (ad)->ad_eid[(eid)].ade_off)
310 #define ad_getoflags(ad,adf) (((adf)&ADFLAGS_HF) ? \
311 (ad)->ad_hf.adf_flags : (ad)->ad_df.adf_flags)
314 extern void ad_rebuild_header __P((struct adouble *));
315 extern int ad_flush __P((struct adouble *, int));
316 extern int ad_close __P((struct adouble *, int));
319 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
320 const int /*type*/, const off_t /*offset*/,
321 const off_t /*len*/, const int /*user*/));
322 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
324 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
325 const int /*type*/, const off_t /*offset*/,
326 const off_t /*len*/, const int /*user*/));
328 #define ad_lock ad_fcntl_lock
329 #define ad_tmplock ad_fcntl_tmplock
330 #define ad_unlock ad_fcntl_unlock
333 extern char *ad_dir __P((const char *));
334 extern char *ad_path __P((const char *, int));
335 extern int ad_mode __P((const char *, int));
336 extern int ad_mkdir __P((const char *, int));
337 extern int ad_open __P((const char *, int, int, int, struct adouble *));
338 extern int ad_refresh __P((struct adouble *));
340 /* extend header to RW if R or W (W if R for locking),
343 static __inline__ mode_t ad_hf_mode (mode_t mode)
345 /* fnctl lock need write access */
346 if ((mode & S_IRUSR))
348 if ((mode & S_IRGRP))
350 if ((mode & S_IROTH))
353 /* if write mode set add read mode */
354 if ((mode & S_IWUSR))
356 if ((mode & S_IWGRP))
358 if ((mode & S_IWOTH))
364 extern mode_t ad_hf_mode __P((mode_t ));
367 /* ad_read.c/ad_write.c */
368 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
369 const off_t, char *, const size_t));
370 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
372 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
373 const int, const char *, const size_t));
375 extern ssize_t adf_pread __P((struct ad_fd *, void *, size_t, off_t));
376 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
378 extern int ad_dtruncate __P((struct adouble *, const off_t));
379 extern int ad_rtruncate __P((struct adouble *, const off_t));
382 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
385 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
386 const off_t, const size_t));
387 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
388 const off_t, const int, const size_t));
389 #define ad_munmap(buf, len) (munmap((buf), (len)))
392 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
393 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
396 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
397 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
399 #ifdef HAVE_SENDFILE_READ
400 extern ssize_t ad_readfile __P((const struct adouble *, const int,
401 const int, off_t, const size_t));
405 #ifdef HAVE_SENDFILE_WRITE
406 extern ssize_t ad_writefile __P((struct adouble *, const int,
407 const int, off_t, const int, const size_t));