2 * Copyright (c) 1990,1991 Regents of The University of Michigan.
5 * Permission to use, copy, modify, and distribute this software and
6 * its documentation for any purpose and without fee is hereby granted,
7 * provided that the above copyright notice appears in all copies and
8 * that both that copyright notice and this permission notice appear
9 * in supporting documentation, and that the name of The University
10 * of Michigan not be used in advertising or publicity pertaining to
11 * distribution of the software without specific, written prior
12 * permission. This software is supplied as is without expressed or
13 * implied warranties of any kind.
15 * Research Systems Unix Group
16 * The University of Michigan
18 * 535 W. William Street
21 * netatalk@itd.umich.edu
24 #ifndef _ATALK_ADOUBLE_H
25 #define _ATALK_ADOUBLE_H
29 #if defined(sun) && defined(__svr4__)
30 #include </usr/ucbinclude/sys/file.h>
35 #include <sys/cdefs.h>
36 #include <sys/types.h>
38 #include <netatalk/endian.h>
41 /* XXX: this is the wrong place to put this.
42 * NOTE: as of 2.2.1, linux can't do a sendfile from a socket. */
43 #ifdef SENDFILE_FLAVOR_LINUX
44 #define HAVE_SENDFILE_READ
45 #define HAVE_SENDFILE_WRITE
46 #include <asm/unistd.h>
48 static inline int sendfile(int fdout, int fdin, off_t *off, size_t count)
50 return syscall(__NR_sendfile, fdout, fdin, off, count);
53 #include <sys/sendfile.h>
57 #ifdef SENDFILE_FLAVOR_BSD
58 #define HAVE_SENDFILE_READ
62 * AppleDouble entry IDs.
67 #define ADEID_COMMENT 4
68 #define ADEID_ICONBW 5
69 #define ADEID_ICONCOL 6
70 #define ADEID_FILEI 7 /* v1, replaced by: */
71 #define ADEID_FILEDATESI 8 /* this */
72 #define ADEID_FINDERI 9
73 #define ADEID_MACFILEI 10 /* we don't use this */
74 #define ADEID_PRODOSFILEI 11 /* we store prodos info here */
75 #define ADEID_MSDOSFILEI 12 /* we don't use this */
76 #define ADEID_SHORTNAME 13
77 #define ADEID_AFPFILEI 14 /* where the rest of the FILEI info goes */
83 #define AD_APPLESINGLE_MAGIC 0x00051600
84 #define AD_APPLEDOUBLE_MAGIC 0x00051607
85 #define AD_MAGIC AD_APPLEDOUBLE_MAGIC
88 #define AD_VERSION1 0x00010000
89 #define AD_VERSION2 0x00020000
90 #define AD_VERSION AD_VERSION1
92 /* sizes of relevant entry bits */
93 #define ADEDLEN_MAGIC 4
94 #define ADEDLEN_VERSION 4
95 #define ADEDLEN_FILLER 16
96 #define ADEDLEN_NENTRIES 2
98 #define AD_HEADER_LEN (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
99 ADEDLEN_FILLER + ADEDLEN_NENTRIES)
100 #define AD_ENTRY_LEN 12 /* size of a single entry header */
102 /* v1 field widths */
103 #define ADEDLEN_NAME 255
104 #define ADEDLEN_COMMENT 200
105 #define ADEDLEN_FILEI 16
106 #define ADEDLEN_FINDERI 32
108 /* v2 field widths */
109 #define ADEDLEN_FILEDATESI 16
110 #define ADEDLEN_SHORTNAME 12 /* length up to 8.3 */
111 #define ADEDLEN_AFPFILEI 4
112 #define ADEDLEN_MACFILEI 4
113 #define ADEDLEN_PRODOSFILEI 8
114 #define ADEDLEN_MSDOSFILEI 2
115 #define ADEDLEN_DID 4
118 #define AD_DATASZ1 589
119 #define AD_DATASZ2 665 /* v1 + 4 new entries (entry desc. + entry) */
120 #define AD_DATASZ_MAX 1024
121 #if AD_VERSION == AD_VERSION1
122 #define AD_DATASZ AD_DATASZ1 /* hold enough for the entries */
123 #else if AD_VERSION == AD_VERSION2
124 #define AD_DATASZ AD_DATASZ2
128 * some legacy defines from netatalk-990130
129 * (to keep from breaking certain packages)
133 #define ADEDOFF_RFORK 589
134 #define ADEDOFF_NAME 86
135 #define ADEDOFF_COMMENT 341
136 #define ADEDOFF_FILEI 541
137 #define ADEDOFF_FINDERI 557
140 * The header of the AppleDouble Header File looks like this:
146 * Home File System 16 (this becomes filler in ad v2)
147 * Number of Entries 2
148 * Entry Descriptors for each entry:
159 typedef struct adf_lock_t {
162 int *refcount; /* handle read locks with multiple users */
169 adf_lock_t *adf_lock;
170 int adf_refcount, adf_lockcount, adf_lockmax;
173 /* some header protection */
174 #define AD_INITED 0xad494e54 /* ad"INT" */
177 u_int32_t ad_version;
178 char ad_filler[ 16 ];
179 struct ad_entry ad_eid[ ADEID_MAX ];
180 struct ad_fd ad_df, ad_hf;
181 int ad_flags, ad_inited;
182 #ifdef USE_MMAPPED_HEADERS
185 char ad_data[AD_DATASZ_MAX];
189 #define ADFLAGS_DF (1<<0)
190 #define ADFLAGS_HF (1<<1)
191 #define ADFLAGS_DIR (1<<2)
192 #define ADFLAGS_NOADOUBLE (1<<3)
193 #define ADFLAGS_V1COMPAT (1<<4)
196 #define ADLOCK_CLR (0)
197 #define ADLOCK_RD (1<<0)
198 #define ADLOCK_WR (1<<1)
199 #define ADLOCK_MASK (ADLOCK_RD | ADLOCK_WR)
200 #define ADLOCK_UPGRADE (1<<2)
201 #define ADLOCK_FILELOCK (1<<3)
203 /* we use this so that we can use the same mechanism for both byte
204 * locks and file synchronization locks. i do this by co-opting either
205 * first bits on 32-bit machines or shifting above the last bit on
206 * 64-bit machines. this only matters for the data fork. */
207 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
208 /* synchronization locks */
209 #define AD_FILELOCK_BASE (0x80000000)
210 #define AD_FILELOCK_WR (AD_FILELOCK_BASE + 0)
211 #define AD_FILELOCK_RD (AD_FILELOCK_BASE + 1)
213 #define AD_FILELOCK_BASE (0x7FFFFFFE)
214 #define AD_FILELOCK_WR (AD_FILELOCK_BASE + 0)
215 #define AD_FILELOCK_RD (AD_FILELOCK_BASE + 1)
218 /* time stuff. we overload the bits a little. */
219 #define AD_DATE_CREATE 0
220 #define AD_DATE_MODIFY 4
221 #define AD_DATE_BACKUP 8
222 #define AD_DATE_ACCESS 12
223 #define AD_DATE_MASK (AD_DATE_CREATE | AD_DATE_MODIFY | \
224 AD_DATE_BACKUP | AD_DATE_ACCESS)
225 #define AD_DATE_UNIX (1 << 10)
226 #define AD_DATE_START htonl(0x80000000)
227 #define AD_DATE_DELTA 946684800
228 #define AD_DATE_FROM_UNIX(x) htonl((x) - AD_DATE_DELTA)
229 #define AD_DATE_TO_UNIX(x) (ntohl(x) + AD_DATE_DELTA)
231 /* private AFPFileInfo bits */
232 #define AD_AFPFILEI_OWNER (1 << 0) /* any owner */
233 #define AD_AFPFILEI_GROUP (1 << 1) /* ignore group */
234 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
236 #define ad_dfileno(ad) ((ad)->ad_df.adf_fd)
237 #define ad_hfileno(ad) ((ad)->ad_hf.adf_fd)
238 #define ad_getversion(ad) ((ad)->ad_version)
240 #define ad_getentrylen(ad,eid) ((ad)->ad_eid[(eid)].ade_len)
241 #define ad_setentrylen(ad,eid,len) \
242 ((ad)->ad_eid[(eid)].ade_len = (len))
243 #define ad_getentryoff(ad,eid) ((ad)->ad_eid[(eid)].ade_off)
244 #define ad_entry(ad,eid) ((caddr_t)(ad)->ad_data + \
245 (ad)->ad_eid[(eid)].ade_off)
246 #define ad_getoflags(ad,adf) (((adf)&ADFLAGS_HF) ? \
247 (ad)->ad_hf.adf_flags : (ad)->ad_df.adf_flags)
250 extern void ad_rebuild_header __P((struct adouble *));
251 extern int ad_flush __P((struct adouble *, int));
252 extern int ad_close __P((struct adouble *, int));
255 extern int ad_flock_lock __P((struct adouble *, const u_int32_t /*eid*/,
256 const int /*type*/, const off_t /*offset*/,
257 const size_t /*len*/, const int /*user*/));
258 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
259 const int /*type*/, const off_t /*offset*/,
260 const size_t /*len*/, const int /*user*/));
261 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
263 extern int ad_flock_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
264 const int /*type*/, const off_t /*offset*/,
265 const size_t /*len*/));
266 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
267 const int /*type*/, const off_t /*offset*/,
268 const size_t /*len*/));
270 #ifdef USE_FLOCK_LOCKS
271 #define ad_lock ad_flock_lock
272 #define ad_tmplock ad_flock_tmplock
273 #define ad_unlock(a,b)
275 #define ad_lock ad_fcntl_lock
276 #define ad_tmplock ad_fcntl_tmplock
277 #define ad_unlock ad_fcntl_unlock
281 extern char *ad_path __P((char *, int));
282 extern int ad_mode __P((char *, int));
283 extern int ad_mkdir __P((char *, int));
284 extern int ad_open __P((char *, int, int, int, struct adouble *));
285 extern int ad_refresh __P((struct adouble *));
287 /* ad_read.c/ad_write.c */
288 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
289 const off_t, char *, const size_t));
290 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
291 const int, const char *, const size_t));
292 extern int ad_dtruncate __P((struct adouble *, const size_t));
293 extern int ad_rtruncate __P((struct adouble *, const size_t));
296 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
299 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
300 const off_t, const size_t));
301 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
302 const off_t, const int, const size_t));
303 #define ad_munmap(buf, len) (munmap((buf), (len)))
306 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
307 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
310 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
311 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
313 #ifdef HAVE_SENDFILE_READ
314 extern ssize_t ad_readfile __P((const struct adouble *, const int,
315 const int, off_t, const size_t));
319 #ifdef HAVE_SENDFILE_WRITE
320 extern ssize_t ad_writefile __P((struct adouble *, const int,
321 const int, off_t, const int, const size_t));