include/atalk/adouble.h

   1 /*
   2  * $Id: adouble.h,v 1.21.6.7 2004-02-06 13:39:52 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 #define ADEID_PRIVID            19
 106
 107 #define AD_DEV                  0x80444556
 108 #define AD_INO                  0x80494E4F
 109 #define AD_SYN                  0x8053594E
 110 #define AD_ID                   0x8053567E
 111 #define ADEID_MAX               20
 112 #endif
 113
 114 /* magic */
 115 #define AD_APPLESINGLE_MAGIC 0x00051600
 116 #define AD_APPLEDOUBLE_MAGIC 0x00051607
 117 #define AD_MAGIC             AD_APPLEDOUBLE_MAGIC
 118
 119
 120 /* sizes of relevant entry bits */
 121 #define ADEDLEN_MAGIC       4
 122 #define ADEDLEN_VERSION     4
 123 #define ADEDLEN_FILLER      16
 124 #define ADEDLEN_NENTRIES    2
 125
 126 /* 26 */
 127 #define AD_HEADER_LEN       (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
 128                              ADEDLEN_FILLER + ADEDLEN_NENTRIES)
 129 #define AD_ENTRY_LEN        12  /* size of a single entry header */
 130
 131 /* v1 field widths */
 132 #define ADEDLEN_NAME        255
 133 #define ADEDLEN_COMMENT     200
 134 #define ADEDLEN_FILEI       16
 135 #define ADEDLEN_FINDERI     32
 136
 137 /* v2 field widths */
 138 #define ADEDLEN_FILEDATESI      16
 139 #define ADEDLEN_SHORTNAME       12 /* length up to 8.3 */
 140 #define ADEDLEN_AFPFILEI        4
 141 #define ADEDLEN_MACFILEI        4
 142 #define ADEDLEN_PRODOSFILEI     8
 143 #define ADEDLEN_MSDOSFILEI      2
 144 #define ADEDLEN_DID             4
 145 #define ADEDLEN_PRIVDEV         8
 146 #define ADEDLEN_PRIVINO         8
 147 #define ADEDLEN_PRIVSYN         8
 148 #define ADEDLEN_PRIVID          4
 149
 150 #define ADEID_NUM_V1         5
 151 #define ADEID_NUM_V2         13
 152
 153 /* 589 */
 154 #define AD_DATASZ1      (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT +ADEDLEN_FILEI +ADEDLEN_FINDERI+\
 155 ADEID_NUM_V1*AD_ENTRY_LEN)
 156
 157 #if AD_DATASZ1 != 589
 158 #error bad size for AD_DATASZ1
 159 #endif
 160
 161 #define AD_NEWSZ2       (ADEDLEN_DID + ADEDLEN_AFPFILEI +ADEDLEN_SHORTNAME +ADEDLEN_PRODOSFILEI \
 162 +ADEDLEN_PRIVDEV +ADEDLEN_PRIVINO +ADEDLEN_PRIVSYN+ ADEDLEN_PRIVID)
 163
 164 /* 725 */
 165 #define AD_DATASZ2      (AD_DATASZ1 + AD_NEWSZ2 + (ADEID_NUM_V2 -ADEID_NUM_V1)*AD_ENTRY_LEN)
 166
 167 #if AD_DATASZ2 != 741
 168 #error bad size for AD_DATASZ2
 169 #endif
 170
 171 #define AD_DATASZ_MAX   1024
 172 #if AD_VERSION == AD_VERSION1
 173 #define AD_DATASZ       AD_DATASZ1 /* hold enough for the entries */
 174 #elif AD_VERSION == AD_VERSION2
 175 #define AD_DATASZ       AD_DATASZ2
 176 #endif
 177
 178 /*
 179  * some legacy defines from netatalk-990130
 180  * (to keep from breaking certain packages)
 181  *
 182  */
 183
 184 #define ADEDOFF_RFORK   589
 185 #define ADEDOFF_NAME    86
 186 #define ADEDOFF_COMMENT 341
 187 #define ADEDOFF_FINDERI 557
 188 #ifndef ADEDOFF_FILEI
 189 #define ADEDOFF_FILEI   541
 190 #endif
 191
 192 typedef u_int32_t cnid_t;
 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     int          adf_excl;
 229     adf_lock_t   *adf_lock;
 230     int          adf_refcount, adf_lockcount, adf_lockmax;
 231 };
 232
 233 /* some header protection */
 234 #define AD_INITED  0xad494e54  /* ad"INT" */
 235 struct adouble {
 236     u_int32_t           ad_magic;
 237     u_int32_t           ad_version;
 238     char                ad_filler[ 16 ];
 239     struct ad_entry     ad_eid[ ADEID_MAX ];
 240     struct ad_fd        ad_df, ad_hf;
 241     int                 ad_flags, ad_inited;
 242     int                 ad_refcount; /* used in afpd/ofork.c */
 243     off_t               ad_rlen;     /* ressource fork len with AFP 3.0
 244                                         the header parameter size is too small.
 245                                      */
 246 #ifdef USE_MMAPPED_HEADERS
 247     char                *ad_data;
 248 #else
 249     char                ad_data[AD_DATASZ_MAX];
 250 #endif
 251 };
 252
 253 #define ADFLAGS_DF        (1<<0)
 254 #define ADFLAGS_HF        (1<<1)
 255 #define ADFLAGS_DIR       (1<<2)
 256 #define ADFLAGS_NOADOUBLE (1<<3)
 257 #define ADFLAGS_V1COMPAT  (1<<4)
 258 #define ADFLAGS_NOHF      (1<<5)  /* not an error if no ressource fork */
 259
 260 /* lock flags */
 261 #define ADLOCK_CLR      (0)
 262 #define ADLOCK_RD       (1<<0)
 263 #define ADLOCK_WR       (1<<1)
 264 #define ADLOCK_MASK     (ADLOCK_RD | ADLOCK_WR)
 265 #define ADLOCK_UPGRADE  (1<<2)
 266 #define ADLOCK_FILELOCK (1<<3)
 267
 268 /* we use this so that we can use the same mechanism for both byte
 269  * locks and file synchronization locks. i do this by co-opting either
 270  * first bits on 32-bit machines or shifting above the last bit on
 271  * 64-bit machines. this only matters for the data fork. */
 272 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
 273 /* synchronization locks */
 274 #define AD_FILELOCK_BASE (0x80000000)
 275 #else
 276 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
 277 #endif
 278
 279 /* FIXME:
 280  * AD_FILELOCK_BASE case
 281  */
 282 #if _FILE_OFFSET_BITS == 64
 283 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
 284 #else
 285 #define BYTELOCK_MAX (0x7FFFFFFFU)
 286 #endif
 287
 288 #define AD_FILELOCK_OPEN_WR        (AD_FILELOCK_BASE + 0)
 289 #define AD_FILELOCK_OPEN_RD        (AD_FILELOCK_BASE + 1)
 290 #define AD_FILELOCK_DENY_WR        (AD_FILELOCK_BASE + 2)
 291 #define AD_FILELOCK_DENY_RD        (AD_FILELOCK_BASE + 3)
 292 #define AD_FILELOCK_OPEN_NONE      (AD_FILELOCK_BASE + 4)
 293
 294 /* time stuff. we overload the bits a little.  */
 295 #define AD_DATE_CREATE         0
 296 #define AD_DATE_MODIFY         4
 297 #define AD_DATE_BACKUP         8
 298 #define AD_DATE_ACCESS        12
 299 #define AD_DATE_MASK          (AD_DATE_CREATE | AD_DATE_MODIFY | \
 300                                AD_DATE_BACKUP | AD_DATE_ACCESS)
 301 #define AD_DATE_UNIX          (1 << 10)
 302 #define AD_DATE_START         htonl(0x80000000)
 303 #define AD_DATE_DELTA         946684800
 304 #define AD_DATE_FROM_UNIX(x)  htonl((x) - AD_DATE_DELTA)
 305 #define AD_DATE_TO_UNIX(x)    (ntohl(x) + AD_DATE_DELTA)
 306
 307 /* private AFPFileInfo bits */
 308 #define AD_AFPFILEI_OWNER       (1 << 0) /* any owner */
 309 #define AD_AFPFILEI_GROUP       (1 << 1) /* ignore group */
 310 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
 311
 312 #define ad_dfileno(ad)          ((ad)->ad_df.adf_fd)
 313 #define ad_hfileno(ad)          ((ad)->ad_hf.adf_fd)
 314 #define ad_getversion(ad)       ((ad)->ad_version)
 315
 316 #define ad_getentrylen(ad,eid)  ((ad)->ad_eid[(eid)].ade_len)
 317 #define ad_setentrylen(ad,eid,len) \
 318         ((ad)->ad_eid[(eid)].ade_len = (len))
 319 #define ad_getentryoff(ad,eid)  ((ad)->ad_eid[(eid)].ade_off)
 320 #define ad_entry(ad,eid)        ((caddr_t)(ad)->ad_data + \
 321                                  (ad)->ad_eid[(eid)].ade_off)
 322 #define ad_getoflags(ad,adf)    (((adf)&ADFLAGS_HF) ? \
 323         (ad)->ad_hf.adf_flags : (ad)->ad_df.adf_flags)
 324
 325 #define ad_get_HF_flags(ad)     ((ad)->ad_hf.adf_flags)
 326
 327 /* ad_flush.c */
 328 extern void ad_rebuild_header __P((struct adouble *));
 329 extern int ad_flush           __P((struct adouble *, int));
 330 extern int ad_close           __P((struct adouble *, int));
 331
 332 /* ad_lock.c */
 333 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
 334                               const int /*type*/, const off_t /*offset*/,
 335                               const off_t /*len*/, const int /*user*/));
 336 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
 337
 338 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
 339                                  const int /*type*/, const off_t /*offset*/,
 340                                  const off_t /*len*/, const int /*user*/));
 341
 342 extern int ad_testlock      __P((struct adouble * /*adp*/, int /*eid*/, off_t /*off*/));
 343 extern int ad_excl_lock     __P((struct adouble * /*adp*/, const u_int32_t /*eid*/));
 344
 345 #define ad_lock ad_fcntl_lock
 346 #define ad_tmplock ad_fcntl_tmplock
 347 #define ad_unlock ad_fcntl_unlock
 348
 349 /* ad_open.c */
 350 extern int ad_setfuid __P((const uid_t ));
 351 extern uid_t ad_getfuid __P((void ));
 352
 353 extern char *ad_dir   __P((const char *));
 354 extern char *ad_path  __P((const char *, int));
 355 extern int ad_mode    __P((const char *, int));
 356 extern int ad_mkdir   __P((const char *, int));
 357 extern void ad_init   __P((struct adouble *, int ));
 358
 359 extern int ad_open    __P((const char *, int, int, int, struct adouble *));
 360 extern int ad_refresh __P((struct adouble *));
 361 extern int ad_stat    __P((const char *, struct stat *));
 362
 363 /* extend header to RW if R or W (W if R for locking),
 364  */
 365 #ifndef ATACC
 366 static __inline__ mode_t ad_hf_mode (mode_t mode)
 367 {
 368     /* fnctl lock need write access */
 369     if ((mode & S_IRUSR))
 370         mode |= S_IWUSR;
 371     if ((mode & S_IRGRP))
 372         mode |= S_IWGRP;
 373     if ((mode & S_IROTH))
 374         mode |= S_IWOTH;
 375
 376     /* if write mode set add read mode */
 377     if ((mode & S_IWUSR))
 378         mode |= S_IRUSR;
 379     if ((mode & S_IWGRP))
 380         mode |= S_IRGRP;
 381     if ((mode & S_IWOTH))
 382         mode |= S_IROTH;
 383
 384     return mode;
 385 }
 386 #else
 387 extern mode_t ad_hf_mode __P((mode_t ));
 388 #endif
 389
 390 /* ad_read.c/ad_write.c */
 391 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
 392                             const off_t, char *, const size_t));
 393 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
 394
 395 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
 396                              const int, const char *, const size_t));
 397
 398 extern ssize_t adf_pread  __P((struct ad_fd *, void *, size_t, off_t));
 399 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
 400
 401 extern int ad_dtruncate __P((struct adouble *, const off_t));
 402 extern int ad_rtruncate __P((struct adouble *, const off_t));
 403
 404 /* ad_size.c */
 405 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
 406
 407 /* ad_mmap.c */
 408 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
 409                               const off_t, const size_t));
 410 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
 411                                const off_t, const int, const size_t));
 412 #define ad_munmap(buf, len)  (munmap((buf), (len)))
 413
 414 /* ad_date.c */
 415 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
 416 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
 417
 418 /* ad_attr.c */
 419 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
 420 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
 421
 422 #if AD_VERSION == AD_VERSION2
 423 extern int ad_setid __P((struct adouble *, const dev_t dev,const ino_t ino, const u_int32_t, const u_int32_t, const void *));
 424 #else
 425 #define ad_setid(a, b, c)
 426 #endif
 427
 428 #ifdef WITH_SENDFILE
 429 extern ssize_t ad_readfile __P((const struct adouble *, const int,
 430                                 const int, off_t, const size_t));
 431 #endif
 432
 433 #if 0
 434 #ifdef HAVE_SENDFILE_WRITE
 435 extern ssize_t ad_writefile __P((struct adouble *, const int,
 436                                  const int, off_t, const int, const size_t));
 437 #endif
 438 #endif
 439
 440 #endif