include/atalk/adouble.h

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