include/atalk/adouble.h

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