include/atalk/adouble.h

   1 /*
   2  * $Id: adouble.h,v 1.21.6.4 2004-01-03 22:21:09 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 #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 #undef __USE_MISC
  57 #define __USE_MISC
  58 #include <unistd.h>
  59 #endif
  60
  61 #ifdef HAVE_FCNTL_H
  62 #include <fcntl.h>
  63 #endif
  64
  65 #include <sys/cdefs.h>
  66 #include <sys/types.h>
  67 #include <sys/stat.h>
  68 #include <sys/mman.h>
  69 #include <netatalk/endian.h>
  70
  71 /* version info */
  72 #define AD_VERSION1     0x00010000
  73 #define AD_VERSION2     0x00020000
  74 #define AD_VERSION      AD_VERSION2
  75
  76 /*
  77  * AppleDouble entry IDs.
  78  */
  79 #define ADEID_DFORK             1
  80 #define ADEID_RFORK             2
  81 #define ADEID_NAME              3
  82 #define ADEID_COMMENT           4
  83 #define ADEID_ICONBW            5
  84 #define ADEID_ICONCOL           6
  85 #define ADEID_FILEI             7  /* v1, replaced by: */
  86 #define ADEID_FILEDATESI        8  /* this */
  87 #define ADEID_FINDERI           9
  88 #define ADEID_MACFILEI          10 /* we don't use this */
  89 #define ADEID_PRODOSFILEI       11 /* we store prodos info here */
  90 #define ADEID_MSDOSFILEI        12 /* we don't use this */
  91 #define ADEID_SHORTNAME         13
  92 #define ADEID_AFPFILEI          14 /* where the rest of the FILEI info goes */
  93 #define ADEID_DID               15
  94
  95 #if AD_VERSION == AD_VERSION1
  96 #define ADEID_MAX               16
  97 #else
  98 /* netatalk private note fileid reused DID */
  99 #define ADEID_PRIVDEV           16
 100 #define ADEID_PRIVINO           17
 101 #define ADEID_PRIVSYN           18 /* in synch with database */
 102
 103 #define AD_DEV                  0x80444556
 104 #define AD_INO                  0x80494E4F
 105 #define AD_SYN                  0x8053594E
 106 #define ADEID_MAX               19
 107 #endif
 108
 109 /* magic */
 110 #define AD_APPLESINGLE_MAGIC 0x00051600
 111 #define AD_APPLEDOUBLE_MAGIC 0x00051607
 112 #define AD_MAGIC             AD_APPLEDOUBLE_MAGIC
 113
 114
 115 /* sizes of relevant entry bits */
 116 #define ADEDLEN_MAGIC       4
 117 #define ADEDLEN_VERSION     4
 118 #define ADEDLEN_FILLER      16
 119 #define ADEDLEN_NENTRIES    2
 120
 121 /* 26 */
 122 #define AD_HEADER_LEN       (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
 123                              ADEDLEN_FILLER + ADEDLEN_NENTRIES)
 124 #define AD_ENTRY_LEN        12  /* size of a single entry header */
 125
 126 /* v1 field widths */
 127 #define ADEDLEN_NAME        255
 128 #define ADEDLEN_COMMENT     200
 129 #define ADEDLEN_FILEI       16
 130 #define ADEDLEN_FINDERI     32
 131
 132 /* v2 field widths */
 133 #define ADEDLEN_FILEDATESI      16
 134 #define ADEDLEN_SHORTNAME       12 /* length up to 8.3 */
 135 #define ADEDLEN_AFPFILEI        4
 136 #define ADEDLEN_MACFILEI        4
 137 #define ADEDLEN_PRODOSFILEI     8
 138 #define ADEDLEN_MSDOSFILEI      2
 139 #define ADEDLEN_DID             4
 140 #define ADEDLEN_PRIVDEV         8
 141 #define ADEDLEN_PRIVINO         8
 142 #define ADEDLEN_PRIVSYN         8
 143
 144 #define ADEID_NUM_V1         5
 145 #define ADEID_NUM_V2         12
 146
 147 /* 589 */
 148 #define AD_DATASZ1      (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT +ADEDLEN_FILEI +ADEDLEN_FINDERI+\
 149 ADEID_NUM_V1*AD_ENTRY_LEN)
 150
 151 #if AD_DATASZ1 != 589
 152 #error bad size for AD_DATASZ1
 153 #endif
 154
 155 #define AD_NEWSZ2       (ADEDLEN_DID + ADEDLEN_AFPFILEI +ADEDLEN_SHORTNAME +ADEDLEN_PRODOSFILEI \
 156 +ADEDLEN_PRIVDEV +ADEDLEN_PRIVINO +ADEDLEN_PRIVSYN)
 157
 158 /* 725 */
 159 /*
 160 #define AD_DATASZ2      (AD_DATASZ1 + (ADEID_NUM_V2 -ADEID_NUM_V1)*AD_ENTRY_LEN)
 161 FIXME I give up,
 162 for our adouble version 2 size *is* 725
 163 */
 164 #define AD_DATASZ2 725
 165
 166 #if AD_DATASZ2 != 725
 167 #error bad size for AD_DATASZ2
 168 #endif
 169
 170 #define AD_DATASZ_MAX   1024
 171 #if AD_VERSION == AD_VERSION1
 172 #define AD_DATASZ       AD_DATASZ1 /* hold enough for the entries */
 173 #elif AD_VERSION == AD_VERSION2
 174 #define AD_DATASZ       AD_DATASZ2
 175 #endif
 176
 177 /*
 178  * some legacy defines from netatalk-990130
 179  * (to keep from breaking certain packages)
 180  *
 181  */
 182
 183 #define ADEDOFF_RFORK   589
 184 #define ADEDOFF_NAME    86
 185 #define ADEDOFF_COMMENT 341
 186 #define ADEDOFF_FINDERI 557
 187 #ifndef ADEDOFF_FILEI
 188 #define ADEDOFF_FILEI   541
 189 #endif
 190
 191 typedef u_int32_t cnid_t;
 192
 193 /*
 194  * The header of the AppleDouble Header File looks like this:
 195  *
 196  *      NAME                    SIZE
 197  *      ====                    ====
 198  *      Magic                   4
 199  *      Version                 4
 200  *      Home File System        16  (this becomes filler in ad v2)
 201  *      Number of Entries       2
 202  *      Entry Descriptors for each entry:
 203  *              Entry ID        4
 204  *              Offset          4
 205  *              Length          4
 206  */
 207
 208 struct ad_entry {
 209     u_int32_t   ade_off;
 210     u_int32_t   ade_len;
 211 };
 212
 213 typedef struct adf_lock_t {
 214   struct flock lock;
 215   int user;
 216   int *refcount; /* handle read locks with multiple users */
 217 } adf_lock_t;
 218
 219 struct ad_fd {
 220     int          adf_fd;
 221
 222 #ifndef HAVE_PREAD
 223     off_t        adf_off;
 224 #endif
 225
 226     int          adf_flags;
 227     int          adf_excl;
 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 #define ADFLAGS_NOHF      (1<<5)  /* not an error if no ressource fork */
 258
 259 /* lock flags */
 260 #define ADLOCK_CLR      (0)
 261 #define ADLOCK_RD       (1<<0)
 262 #define ADLOCK_WR       (1<<1)
 263 #define ADLOCK_MASK     (ADLOCK_RD | ADLOCK_WR)
 264 #define ADLOCK_UPGRADE  (1<<2)
 265 #define ADLOCK_FILELOCK (1<<3)
 266
 267 /* we use this so that we can use the same mechanism for both byte
 268  * locks and file synchronization locks. i do this by co-opting either
 269  * first bits on 32-bit machines or shifting above the last bit on
 270  * 64-bit machines. this only matters for the data fork. */
 271 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
 272 /* synchronization locks */
 273 #define AD_FILELOCK_BASE (0x80000000)
 274 #else
 275 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
 276 #endif
 277
 278 /* FIXME:
 279  * AD_FILELOCK_BASE case
 280  */
 281 #if _FILE_OFFSET_BITS == 64
 282 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
 283 #else
 284 #define BYTELOCK_MAX (0x7FFFFFFFU)
 285 #endif
 286
 287 #define AD_FILELOCK_OPEN_WR        (AD_FILELOCK_BASE + 0)
 288 #define AD_FILELOCK_OPEN_RD        (AD_FILELOCK_BASE + 1)
 289 #define AD_FILELOCK_DENY_WR        (AD_FILELOCK_BASE + 2)
 290 #define AD_FILELOCK_DENY_RD        (AD_FILELOCK_BASE + 3)
 291 #define AD_FILELOCK_OPEN_NONE      (AD_FILELOCK_BASE + 4)
 292
 293 /* time stuff. we overload the bits a little.  */
 294 #define AD_DATE_CREATE         0
 295 #define AD_DATE_MODIFY         4
 296 #define AD_DATE_BACKUP         8
 297 #define AD_DATE_ACCESS        12
 298 #define AD_DATE_MASK          (AD_DATE_CREATE | AD_DATE_MODIFY | \
 299                                AD_DATE_BACKUP | AD_DATE_ACCESS)
 300 #define AD_DATE_UNIX          (1 << 10)
 301 #define AD_DATE_START         htonl(0x80000000)
 302 #define AD_DATE_DELTA         946684800
 303 #define AD_DATE_FROM_UNIX(x)  htonl((x) - AD_DATE_DELTA)
 304 #define AD_DATE_TO_UNIX(x)    (ntohl(x) + AD_DATE_DELTA)
 305
 306 /* private AFPFileInfo bits */
 307 #define AD_AFPFILEI_OWNER       (1 << 0) /* any owner */
 308 #define AD_AFPFILEI_GROUP       (1 << 1) /* ignore group */
 309 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
 310
 311 #define ad_dfileno(ad)          ((ad)->ad_df.adf_fd)
 312 #define ad_hfileno(ad)          ((ad)->ad_hf.adf_fd)
 313 #define ad_getversion(ad)       ((ad)->ad_version)
 314
 315 #define ad_getentrylen(ad,eid)  ((ad)->ad_eid[(eid)].ade_len)
 316 #define ad_setentrylen(ad,eid,len) \
 317         ((ad)->ad_eid[(eid)].ade_len = (len))
 318 #define ad_getentryoff(ad,eid)  ((ad)->ad_eid[(eid)].ade_off)
 319 #define ad_entry(ad,eid)        ((caddr_t)(ad)->ad_data + \
 320                                  (ad)->ad_eid[(eid)].ade_off)
 321 #define ad_getoflags(ad,adf)    (((adf)&ADFLAGS_HF) ? \
 322         (ad)->ad_hf.adf_flags : (ad)->ad_df.adf_flags)
 323
 324 #define ad_get_HF_flags(ad)     ((ad)->ad_hf.adf_flags)
 325
 326 /* ad_flush.c */
 327 extern void ad_rebuild_header __P((struct adouble *));
 328 extern int ad_flush           __P((struct adouble *, int));
 329 extern int ad_close           __P((struct adouble *, int));
 330
 331 /* ad_lock.c */
 332 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
 333                               const int /*type*/, const off_t /*offset*/,
 334                               const off_t /*len*/, const int /*user*/));
 335 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
 336
 337 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
 338                                  const int /*type*/, const off_t /*offset*/,
 339                                  const off_t /*len*/, const int /*user*/));
 340
 341 extern int ad_testlock      __P((struct adouble * /*adp*/, int /*eid*/, off_t /*off*/));
 342 extern int ad_excl_lock     __P((struct adouble * /*adp*/, const u_int32_t /*eid*/));
 343
 344 #define ad_lock ad_fcntl_lock
 345 #define ad_tmplock ad_fcntl_tmplock
 346 #define ad_unlock ad_fcntl_unlock
 347
 348 /* ad_open.c */
 349 extern int ad_setfuid __P((const uid_t ));
 350 extern uid_t ad_getfuid __P((void ));
 351
 352 extern char *ad_dir   __P((const char *));
 353 extern char *ad_path  __P((const char *, int));
 354 extern int ad_mode    __P((const char *, int));
 355 extern int ad_mkdir   __P((const char *, int));
 356 extern void ad_init   __P((struct adouble *, int ));
 357
 358 extern int ad_open    __P((const char *, int, int, int, struct adouble *));
 359 extern int ad_refresh __P((struct adouble *));
 360 extern int ad_stat    __P((const char *, struct stat *));
 361
 362 /* extend header to RW if R or W (W if R for locking),
 363  */
 364 #ifndef ATACC
 365 static __inline__ mode_t ad_hf_mode (mode_t mode)
 366 {
 367     /* fnctl lock need write access */
 368     if ((mode & S_IRUSR))
 369         mode |= S_IWUSR;
 370     if ((mode & S_IRGRP))
 371         mode |= S_IWGRP;
 372     if ((mode & S_IROTH))
 373         mode |= S_IWOTH;
 374
 375     /* if write mode set add read mode */
 376     if ((mode & S_IWUSR))
 377         mode |= S_IRUSR;
 378     if ((mode & S_IWGRP))
 379         mode |= S_IRGRP;
 380     if ((mode & S_IWOTH))
 381         mode |= S_IROTH;
 382
 383     return mode;
 384 }
 385 #else
 386 extern mode_t ad_hf_mode __P((mode_t ));
 387 #endif
 388
 389 /* ad_read.c/ad_write.c */
 390 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
 391                             const off_t, char *, const size_t));
 392 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
 393
 394 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
 395                              const int, const char *, const size_t));
 396
 397 extern ssize_t adf_pread  __P((struct ad_fd *, void *, size_t, off_t));
 398 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
 399
 400 extern int ad_dtruncate __P((struct adouble *, const off_t));
 401 extern int ad_rtruncate __P((struct adouble *, const off_t));
 402
 403 /* ad_size.c */
 404 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
 405
 406 /* ad_mmap.c */
 407 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
 408                               const off_t, const size_t));
 409 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
 410                                const off_t, const int, const size_t));
 411 #define ad_munmap(buf, len)  (munmap((buf), (len)))
 412
 413 /* ad_date.c */
 414 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
 415 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
 416
 417 /* ad_attr.c */
 418 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
 419 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
 420
 421 #if AD_VERSION == AD_VERSION2
 422 extern int ad_setid __P((struct adouble *, const dev_t dev,const ino_t ino, const u_int32_t, const void *));
 423 #else
 424 #define ad_setid(a, b, c)
 425 #endif
 426
 427 #ifdef WITH_SENDFILE
 428 extern ssize_t ad_readfile __P((const struct adouble *, const int,
 429                                 const int, off_t, const size_t));
 430 #endif
 431
 432 #if 0
 433 #ifdef HAVE_SENDFILE_WRITE
 434 extern ssize_t ad_writefile __P((struct adouble *, const int,
 435                                  const int, off_t, const int, const size_t));
 436 #endif
 437 #endif
 438
 439 #endif