include/atalk/adouble.h

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