include/atalk/adouble.h

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