include/atalk/adouble.h

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