include/atalk/adouble.h

   1 /*
   2  * $Id: adouble.h,v 1.5 2001-03-21 14:36:36 rufustfirefly Exp $
   3  * Copyright (c) 1990,1991 Regents of The University of Michigan.
   4  * All Rights Reserved.
   5  *
   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.
  15  *
  16  *      Research Systems Unix Group
  17  *      The University of Michigan
  18  *      c/o Mike Clark
  19  *      535 W. William Street
  20  *      Ann Arbor, Michigan
  21  *      +1-313-763-0525
  22  *      netatalk@itd.umich.edu
  23  */
  24
  25 #ifndef _ATALK_ADOUBLE_H
  26 #define _ATALK_ADOUBLE_H
  27
  28 #include <unistd.h>
  29
  30 #if defined(sun) && defined(__svr4__)
  31 #include </usr/ucbinclude/sys/file.h>
  32 #else
  33 #include <sys/file.h>
  34 #endif
  35 #include <fcntl.h>
  36 #include <sys/cdefs.h>
  37 #include <sys/types.h>
  38 #include <sys/mman.h>
  39 #include <netatalk/endian.h>
  40
  41
  42 /* XXX: this is the wrong place to put this.
  43  * NOTE: as of 2.2.1, linux can't do a sendfile from a socket. */
  44 #ifdef SENDFILE_FLAVOR_LINUX
  45 #define HAVE_SENDFILE_READ
  46 #define HAVE_SENDFILE_WRITE
  47 #include <asm/unistd.h>
  48 #ifdef __NR_sendfile
  49 static inline int sendfile(int fdout, int fdin, off_t *off, size_t count)
  50 {
  51   return syscall(__NR_sendfile, fdout, fdin, off, count);
  52 }
  53 #else
  54 #include <sys/sendfile.h>
  55 #endif
  56 #endif
  57
  58 #ifdef SENDFILE_FLAVOR_BSD
  59 #define HAVE_SENDFILE_READ
  60 #endif
  61
  62 /*
  63  * AppleDouble entry IDs.
  64  */
  65 #define ADEID_DFORK             1
  66 #define ADEID_RFORK             2
  67 #define ADEID_NAME              3
  68 #define ADEID_COMMENT           4
  69 #define ADEID_ICONBW            5
  70 #define ADEID_ICONCOL           6
  71 #define ADEID_FILEI             7  /* v1, replaced by: */
  72 #define ADEID_FILEDATESI        8  /* this */
  73 #define ADEID_FINDERI           9
  74 #define ADEID_MACFILEI          10 /* we don't use this */
  75 #define ADEID_PRODOSFILEI       11 /* we store prodos info here */
  76 #define ADEID_MSDOSFILEI        12 /* we don't use this */
  77 #define ADEID_SHORTNAME         13
  78 #define ADEID_AFPFILEI          14 /* where the rest of the FILEI info goes */
  79 #define ADEID_DID               15
  80
  81 #define ADEID_MAX               16
  82
  83 /* magic */
  84 #define AD_APPLESINGLE_MAGIC 0x00051600
  85 #define AD_APPLEDOUBLE_MAGIC 0x00051607
  86 #define AD_MAGIC             AD_APPLEDOUBLE_MAGIC
  87
  88 /* version info */
  89 #define AD_VERSION1     0x00010000
  90 #define AD_VERSION2     0x00020000
  91 #define AD_VERSION      AD_VERSION1
  92
  93 /* sizes of relevant entry bits */
  94 #define ADEDLEN_MAGIC       4
  95 #define ADEDLEN_VERSION     4
  96 #define ADEDLEN_FILLER      16
  97 #define ADEDLEN_NENTRIES    2
  98
  99 #define AD_HEADER_LEN       (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
 100                              ADEDLEN_FILLER + ADEDLEN_NENTRIES)
 101 #define AD_ENTRY_LEN        12  /* size of a single entry header */
 102
 103 /* v1 field widths */
 104 #define ADEDLEN_NAME        255
 105 #define ADEDLEN_COMMENT     200
 106 #define ADEDLEN_FILEI       16
 107 #define ADEDLEN_FINDERI     32
 108
 109 /* v2 field widths */
 110 #define ADEDLEN_FILEDATESI      16
 111 #define ADEDLEN_SHORTNAME       12 /* length up to 8.3 */
 112 #define ADEDLEN_AFPFILEI        4
 113 #define ADEDLEN_MACFILEI        4
 114 #define ADEDLEN_PRODOSFILEI     8
 115 #define ADEDLEN_MSDOSFILEI      2
 116 #define ADEDLEN_DID             4
 117
 118
 119 #define AD_DATASZ1      589
 120 #define AD_DATASZ2      665  /* v1 + 4 new entries (entry desc. + entry) */
 121 #define AD_DATASZ_MAX   1024
 122 #if AD_VERSION == AD_VERSION1
 123 #define AD_DATASZ       AD_DATASZ1 /* hold enough for the entries */
 124 #else if AD_VERSION == AD_VERSION2
 125 #define AD_DATASZ       AD_DATASZ2
 126 #endif
 127
 128 /*
 129  * some legacy defines from netatalk-990130
 130  * (to keep from breaking certain packages)
 131  *
 132  */
 133
 134 #define ADEDOFF_RFORK   589
 135 #define ADEDOFF_NAME    86
 136 #define ADEDOFF_COMMENT 341
 137 #define ADEDOFF_FINDERI 557
 138 #ifndef ADEDOFF_FILEI
 139 #define ADEDOFF_FILEI   541
 140 #endif
 141
 142 /*
 143  * The header of the AppleDouble Header File looks like this:
 144  *
 145  *      NAME                    SIZE
 146  *      ====                    ====
 147  *      Magic                   4
 148  *      Version                 4
 149  *      Home File System        16  (this becomes filler in ad v2)
 150  *      Number of Entries       2
 151  *      Entry Descriptors for each entry:
 152  *              Entry ID        4
 153  *              Offset          4
 154  *              Length          4
 155  */
 156
 157 struct ad_entry {
 158     u_int32_t   ade_off;
 159     u_int32_t   ade_len;
 160 };
 161
 162 typedef struct adf_lock_t {
 163   struct flock lock;
 164   int user;
 165   int *refcount; /* handle read locks with multiple users */
 166 } adf_lock_t;
 167
 168 struct ad_fd {
 169     int          adf_fd;
 170     off_t        adf_off;
 171     int          adf_flags;
 172     adf_lock_t   *adf_lock;
 173     int          adf_refcount, adf_lockcount, adf_lockmax;
 174 };
 175
 176 /* some header protection */
 177 #define AD_INITED  0xad494e54  /* ad"INT" */
 178 struct adouble {
 179     u_int32_t           ad_magic;
 180     u_int32_t           ad_version;
 181     char                ad_filler[ 16 ];
 182     struct ad_entry     ad_eid[ ADEID_MAX ];
 183     struct ad_fd        ad_df, ad_hf;
 184     int                 ad_flags, ad_inited;
 185     int             ad_refcount; /* used in afpd/ofork.c */
 186 #ifdef USE_MMAPPED_HEADERS
 187     char                *ad_data;
 188 #else
 189     char                ad_data[AD_DATASZ_MAX];
 190 #endif
 191 };
 192
 193 #define ADFLAGS_DF        (1<<0)
 194 #define ADFLAGS_HF        (1<<1)
 195 #define ADFLAGS_DIR       (1<<2)
 196 #define ADFLAGS_NOADOUBLE (1<<3)
 197 #define ADFLAGS_V1COMPAT  (1<<4)
 198
 199 /* lock flags */
 200 #define ADLOCK_CLR      (0)
 201 #define ADLOCK_RD       (1<<0)
 202 #define ADLOCK_WR       (1<<1)
 203 #define ADLOCK_MASK     (ADLOCK_RD | ADLOCK_WR)
 204 #define ADLOCK_UPGRADE  (1<<2)
 205 #define ADLOCK_FILELOCK (1<<3)
 206
 207 /* we use this so that we can use the same mechanism for both byte
 208  * locks and file synchronization locks. i do this by co-opting either
 209  * first bits on 32-bit machines or shifting above the last bit on
 210  * 64-bit machines. this only matters for the data fork. */
 211 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
 212 /* synchronization locks */
 213 #define AD_FILELOCK_BASE (0x80000000)
 214 #define AD_FILELOCK_WR   (AD_FILELOCK_BASE + 0)
 215 #define AD_FILELOCK_RD   (AD_FILELOCK_BASE + 1)
 216 #else
 217 #define AD_FILELOCK_BASE (0x7FFFFFFE)
 218 #define AD_FILELOCK_WR   (AD_FILELOCK_BASE + 0)
 219 #define AD_FILELOCK_RD   (AD_FILELOCK_BASE + 1)
 220 #endif
 221
 222 /* time stuff. we overload the bits a little.  */
 223 #define AD_DATE_CREATE         0
 224 #define AD_DATE_MODIFY         4
 225 #define AD_DATE_BACKUP         8
 226 #define AD_DATE_ACCESS        12
 227 #define AD_DATE_MASK          (AD_DATE_CREATE | AD_DATE_MODIFY | \
 228                                AD_DATE_BACKUP | AD_DATE_ACCESS)
 229 #define AD_DATE_UNIX          (1 << 10)
 230 #define AD_DATE_START         htonl(0x80000000)
 231 #define AD_DATE_DELTA         946684800
 232 #define AD_DATE_FROM_UNIX(x)  htonl((x) - AD_DATE_DELTA)
 233 #define AD_DATE_TO_UNIX(x)    (ntohl(x) + AD_DATE_DELTA)
 234
 235 /* private AFPFileInfo bits */
 236 #define AD_AFPFILEI_OWNER       (1 << 0) /* any owner */
 237 #define AD_AFPFILEI_GROUP       (1 << 1) /* ignore group */
 238 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
 239
 240 #define ad_dfileno(ad)          ((ad)->ad_df.adf_fd)
 241 #define ad_hfileno(ad)          ((ad)->ad_hf.adf_fd)
 242 #define ad_getversion(ad)       ((ad)->ad_version)
 243
 244 #define ad_getentrylen(ad,eid)  ((ad)->ad_eid[(eid)].ade_len)
 245 #define ad_setentrylen(ad,eid,len) \
 246         ((ad)->ad_eid[(eid)].ade_len = (len))
 247 #define ad_getentryoff(ad,eid)  ((ad)->ad_eid[(eid)].ade_off)
 248 #define ad_entry(ad,eid)        ((caddr_t)(ad)->ad_data + \
 249                                  (ad)->ad_eid[(eid)].ade_off)
 250 #define ad_getoflags(ad,adf)    (((adf)&ADFLAGS_HF) ? \
 251         (ad)->ad_hf.adf_flags : (ad)->ad_df.adf_flags)
 252
 253 /* ad_flush.c */
 254 extern void ad_rebuild_header __P((struct adouble *));
 255 extern int ad_flush           __P((struct adouble *, int));
 256 extern int ad_close           __P((struct adouble *, int));
 257
 258 /* ad_lock.c */
 259 extern int ad_flock_lock __P((struct adouble *, const u_int32_t /*eid*/,
 260                               const int /*type*/, const off_t /*offset*/,
 261                               const size_t /*len*/, const int /*user*/));
 262 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
 263                               const int /*type*/, const off_t /*offset*/,
 264                               const size_t /*len*/, const int /*user*/));
 265 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
 266
 267 extern int ad_flock_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
 268                                  const int /*type*/, const off_t /*offset*/,
 269                                  const size_t /*len*/));
 270 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
 271                                  const int /*type*/, const off_t /*offset*/,
 272                                  const size_t /*len*/));
 273
 274 #ifdef USE_FLOCK_LOCKS
 275 #define ad_lock ad_flock_lock
 276 #define ad_tmplock ad_flock_tmplock
 277 #define ad_unlock(a,b)
 278 #else
 279 #define ad_lock ad_fcntl_lock
 280 #define ad_tmplock ad_fcntl_tmplock
 281 #define ad_unlock ad_fcntl_unlock
 282 #endif
 283
 284 /* ad_open.c */
 285 extern char *ad_path  __P((char *, int));
 286 extern int ad_mode    __P((char *, int));
 287 extern int ad_mkdir   __P((char *, int));
 288 extern int ad_open    __P((char *, int, int, int, struct adouble *));
 289 extern int ad_refresh __P((struct adouble *));
 290
 291 /* ad_read.c/ad_write.c */
 292 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
 293                             const off_t, char *, const size_t));
 294 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
 295                              const int, const char *, const size_t));
 296 extern int ad_dtruncate __P((struct adouble *, const size_t));
 297 extern int ad_rtruncate __P((struct adouble *, const size_t));
 298
 299 /* ad_size.c */
 300 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
 301
 302 /* ad_mmap.c */
 303 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
 304                               const off_t, const size_t));
 305 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
 306                                const off_t, const int, const size_t));
 307 #define ad_munmap(buf, len)  (munmap((buf), (len)))
 308
 309 /* ad_date.c */
 310 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
 311 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
 312
 313 /* ad_attr.c */
 314 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
 315 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
 316
 317 #ifdef HAVE_SENDFILE_READ
 318 extern ssize_t ad_readfile __P((const struct adouble *, const int,
 319                                 const int, off_t, const size_t));
 320 #endif
 321
 322 #if 0
 323 #ifdef HAVE_SENDFILE_WRITE
 324 extern ssize_t ad_writefile __P((struct adouble *, const int,
 325                                  const int, off_t, const int, const size_t));
 326 #endif
 327 #endif
 328
 329 #endif