include/atalk/adouble.h

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