include/atalk/adouble.h

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