include/atalk/adouble.h

   1 /*
   2  * $Id: adouble.h,v 1.32 2006-09-29 09:44:59 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 /*
  50    Still have to figure out which platforms really
  51    need _XOPEN_SOURCE defined for pread.
  52  */
  53 #if defined(HAVE_PREAD) && !defined(SOLARIS) && !defined(__OpenBSD__) && !defined(__NetBSD__) && !defined(__FreeBSD__) && !defined(TRU64)
  54 #ifdef _XOPEN_SOURCE
  55 #undef _XOPEN_SOURCE
  56 #endif
  57 #define _XOPEN_SOURCE 500
  58 #endif
  59
  60 #include <sys/types.h>
  61 #include <sys/stat.h>
  62
  63 #ifdef HAVE_UNISTD_H
  64 #undef __USE_MISC
  65 #define __USE_MISC
  66 #include <unistd.h>
  67 #endif
  68
  69 #include <sys/cdefs.h>
  70
  71 #ifdef HAVE_FCNTL_H
  72 #include <fcntl.h>
  73 #endif
  74
  75 #include <sys/mman.h>
  76 #ifdef HAVE_SYS_TIME_H
  77 #include <sys/time.h>
  78 #endif
  79 #include <netatalk/endian.h>
  80
  81 /* version info */
  82 #define AD_VERSION1     0x00010000
  83 #define SFM_VERSION     AD_VERSION1
  84
  85 #define AD_VERSION2     0x00020000
  86 #define AD_VERSION2_OSX 0x00020001
  87 #define AD_VERSION1_ADS 0x00010002
  88 #define AD_VERSION1_SFM 0x00010003
  89 #define AD_VERSION      AD_VERSION2
  90
  91 /*
  92  * AppleDouble entry IDs.
  93  */
  94 #define ADEID_DFORK             1
  95 #define ADEID_RFORK             2
  96 #define ADEID_NAME              3
  97 #define ADEID_COMMENT           4
  98 #define ADEID_ICONBW            5
  99 #define ADEID_ICONCOL           6
 100 #define ADEID_FILEI             7  /* v1, replaced by: */
 101 #define ADEID_FILEDATESI        8  /* this */
 102 #define ADEID_FINDERI           9
 103 #define ADEID_MACFILEI          10 /* we don't use this */
 104 #define ADEID_PRODOSFILEI       11 /* we store prodos info here */
 105 #define ADEID_MSDOSFILEI        12 /* we don't use this */
 106 #define ADEID_SHORTNAME         13
 107 #define ADEID_AFPFILEI          14 /* where the rest of the FILEI info goes */
 108 #define ADEID_DID               15
 109
 110 #if AD_VERSION == AD_VERSION1
 111 #define ADEID_MAX               16
 112 #else
 113 /* netatalk private note fileid reused DID */
 114 #define ADEID_PRIVDEV           16
 115 #define ADEID_PRIVINO           17
 116 #define ADEID_PRIVSYN           18 /* in synch with database */
 117 #define ADEID_PRIVID            19
 118 #define ADEID_SFMRESERVE1       20
 119 #define ADEID_SFMRESERVE2       21
 120
 121 #define AD_DEV                  0x80444556
 122 #define AD_INO                  0x80494E4F
 123 #define AD_SYN                  0x8053594E
 124 #define AD_ID                   0x8053567E
 125 #define ADEID_MAX               22
 126 #endif
 127
 128 /* magic */
 129 #define AD_APPLESINGLE_MAGIC 0x00051600
 130 #define AD_APPLEDOUBLE_MAGIC 0x00051607
 131 #define AD_MAGIC             AD_APPLEDOUBLE_MAGIC
 132
 133 #define SFM_MAGIC            0x00504641
 134
 135 /* sizes of relevant entry bits */
 136 #define ADEDLEN_MAGIC       4
 137 #define ADEDLEN_VERSION     4
 138 #define ADEDLEN_FILLER      16
 139 #define ADEDLEN_NENTRIES    2
 140
 141 /* 26 */
 142 #define AD_HEADER_LEN       (ADEDLEN_MAGIC + ADEDLEN_VERSION + \
 143                              ADEDLEN_FILLER + ADEDLEN_NENTRIES)
 144 #define AD_ENTRY_LEN        12  /* size of a single entry header */
 145
 146 /* v1 field widths */
 147 #define ADEDLEN_NAME        255
 148 #define ADEDLEN_COMMENT     200
 149 #define ADEDLEN_FILEI       16
 150 #define ADEDLEN_FINDERI     32
 151
 152 /* v2 field widths */
 153 #define ADEDLEN_FILEDATESI      16
 154 #define ADEDLEN_SHORTNAME       12 /* length up to 8.3 */
 155 #define ADEDLEN_AFPFILEI        4
 156 #define ADEDLEN_MACFILEI        4
 157 #define ADEDLEN_PRODOSFILEI     8
 158 #define ADEDLEN_MSDOSFILEI      2
 159 #define ADEDLEN_DID             4
 160 #define ADEDLEN_PRIVDEV         8
 161 #define ADEDLEN_PRIVINO         8
 162 #define ADEDLEN_PRIVSYN         8
 163 #define ADEDLEN_PRIVID          4
 164
 165 #define ADEID_NUM_V1         5
 166 #define ADEID_NUM_V2         13
 167
 168 // #define ADEID_NUM_SFM        5
 169 /* sizeof SFM meta data */
 170 #define AD_SFM_LEN 60
 171
 172 /* 589 */
 173 #define AD_DATASZ1      (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT +ADEDLEN_FILEI +ADEDLEN_FINDERI+\
 174 ADEID_NUM_V1*AD_ENTRY_LEN)
 175
 176 #if AD_DATASZ1 != 589
 177 #error bad size for AD_DATASZ1
 178 #endif
 179
 180 #define AD_NEWSZ2       (ADEDLEN_DID + ADEDLEN_AFPFILEI +ADEDLEN_SHORTNAME +ADEDLEN_PRODOSFILEI \
 181 +ADEDLEN_PRIVDEV +ADEDLEN_PRIVINO +ADEDLEN_PRIVSYN+ ADEDLEN_PRIVID)
 182
 183 /* 725 */
 184 #define AD_DATASZ2      (AD_DATASZ1 + AD_NEWSZ2 + (ADEID_NUM_V2 -ADEID_NUM_V1)*AD_ENTRY_LEN)
 185
 186 #if AD_DATASZ2 != 741
 187 #error bad size for AD_DATASZ2
 188 #endif
 189
 190 #define AD_DATASZ_MAX   1024
 191 #if AD_VERSION == AD_VERSION1
 192 #define AD_DATASZ       AD_DATASZ1 /* hold enough for the entries */
 193 #elif AD_VERSION == AD_VERSION2
 194 #define AD_DATASZ       AD_DATASZ2
 195 #endif
 196
 197 /*
 198  * some legacy defines from netatalk-990130
 199  * (to keep from breaking certain packages)
 200  *
 201  */
 202
 203 #define ADEDOFF_RFORK   589
 204 #define ADEDOFF_NAME    86
 205 #define ADEDOFF_COMMENT 341
 206 #define ADEDOFF_FINDERI 557
 207 #ifndef ADEDOFF_FILEI
 208 #define ADEDOFF_FILEI   541
 209 #endif
 210
 211 typedef u_int32_t cnid_t;
 212
 213 /*
 214  * The header of the AppleDouble Header File looks like this:
 215  *
 216  *      NAME                    SIZE
 217  *      ====                    ====
 218  *      Magic                   4
 219  *      Version                 4
 220  *      Home File System        16  (this becomes filler in ad v2)
 221  *      Number of Entries       2
 222  *      Entry Descriptors for each entry:
 223  *              Entry ID        4
 224  *              Offset          4
 225  *              Length          4
 226  */
 227
 228 struct ad_entry {
 229     u_int32_t   ade_off;
 230     u_int32_t   ade_len;
 231 };
 232
 233 typedef struct adf_lock_t {
 234   struct flock lock;
 235   int user;
 236   int *refcount; /* handle read locks with multiple users */
 237 } adf_lock_t;
 238
 239 struct ad_fd {
 240     int          adf_fd;
 241
 242 #ifndef HAVE_PREAD
 243     off_t        adf_off;
 244 #endif
 245
 246     int          adf_flags;
 247     int          adf_excl;
 248     adf_lock_t   *adf_lock;
 249     int          adf_refcount, adf_lockcount, adf_lockmax;
 250 };
 251
 252 /* fork attribute */
 253 #define ATTRBIT_DOPEN     (1<<3)  /* data fork already open */
 254 #define ATTRBIT_ROPEN     (1<<4)  /* resource fork already open */
 255
 256 /* some header protection */
 257 #define AD_INITED  0xad494e54  /* ad"INT" */
 258 struct adouble_fops;
 259
 260 struct adouble {
 261     u_int32_t           ad_magic;
 262     u_int32_t           ad_version;
 263     char                ad_filler[ 16 ];
 264     struct ad_entry     ad_eid[ ADEID_MAX ];
 265     struct ad_fd        ad_data_fork, ad_resource_fork, ad_metadata_fork;
 266     struct ad_fd        *ad_md; /* either ad_resource or ad_metadata */
 267
 268     int                 ad_flags;
 269     unsigned int        ad_inited;
 270     int                 ad_options;
 271     int                 ad_refcount; /* used in afpd/ofork.c */
 272     off_t               ad_rlen;     /* ressource fork len with AFP 3.0
 273                                         the header parameter size is too small.
 274                                      */
 275     char                *ad_m_name;   /* mac name for open fork */
 276     int                 ad_m_namelen;
 277     struct adouble_fops *ad_ops;
 278
 279
 280     u_int16_t           ad_open_forks;      /* open forks (by others) */
 281
 282 #ifdef USE_MMAPPED_HEADERS
 283     char                *ad_data;
 284 #else
 285     char                ad_data[AD_DATASZ_MAX];
 286 #endif
 287 };
 288
 289 struct adouble_fops {
 290     char                *(*ad_path)(const char *, int);
 291     int                 (*ad_mkrf)(char *);
 292
 293     int                 (*ad_rebuild_header)(struct adouble *);
 294     int                 (*ad_check_header)(struct adouble *, struct stat *);
 295     int                 (*ad_header_read)(struct adouble *, struct stat *);
 296
 297     int                 (*ad_header_upgrade)(struct adouble *, char *);
 298
 299 };
 300
 301 #define ADFLAGS_DF        (1<<0)
 302 #define ADFLAGS_HF        (1<<1)
 303 #define ADFLAGS_DIR       (1<<2)
 304 #define ADFLAGS_NOADOUBLE (1<<3)
 305 #define ADFLAGS_V1COMPAT  (1<<4)
 306 #define ADFLAGS_NOHF      (1<<5)  /* not an error if no ressource fork */
 307 #define ADFLAGS_RDONLY    (1<<6)  /* don't try readwrite */
 308 #define ADFLAGS_OPENFORKS (1<<7)  /* check for open fork in ad_metadata function */
 309 #define ADFLAGS_RF        (1<<8)
 310 #define ADFLAGS_MD        ADFLAGS_HF /* (1<<9) */
 311 #define ADFLAGS_CREATE    (1<<9)
 312
 313 /* adouble v2 cnid cache */
 314 #define ADVOL_NODEV      (1 << 0)
 315 #define ADVOL_CACHE      (1 << 1)
 316 /* adouble unix priv */
 317 #define ADVOL_UNIXPRIV   (1 << 2)
 318 /* dot files (.DS_Store) are invisible) */
 319 #define ADVOL_INVDOTS    (1 << 3)
 320
 321 /* lock flags */
 322 #define ADLOCK_CLR      (0)
 323 #define ADLOCK_RD       (1<<0)
 324 #define ADLOCK_WR       (1<<1)
 325 #define ADLOCK_MASK     (ADLOCK_RD | ADLOCK_WR)
 326 #define ADLOCK_UPGRADE  (1<<2)
 327 #define ADLOCK_FILELOCK (1<<3)
 328
 329 /* we use this so that we can use the same mechanism for both byte
 330  * locks and file synchronization locks. i do this by co-opting either
 331  * first bits on 32-bit machines or shifting above the last bit on
 332  * 64-bit machines. this only matters for the data fork. */
 333 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
 334 /* synchronization locks */
 335 #define AD_FILELOCK_BASE (0x80000000)
 336 #else
 337 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
 338 #endif
 339
 340 /* FIXME:
 341  * AD_FILELOCK_BASE case
 342  */
 343 #if _FILE_OFFSET_BITS == 64
 344 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
 345 #else
 346 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
 347 #if defined(TRU64)
 348 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
 349 #else
 350 #define BYTELOCK_MAX (0x7FFFFFFFU)
 351 #endif
 352 #endif
 353
 354 #define AD_FILELOCK_OPEN_WR        (AD_FILELOCK_BASE + 0)
 355 #define AD_FILELOCK_OPEN_RD        (AD_FILELOCK_BASE + 1)
 356 #define AD_FILELOCK_DENY_WR        (AD_FILELOCK_BASE + 2)
 357 #define AD_FILELOCK_DENY_RD        (AD_FILELOCK_BASE + 3)
 358 #define AD_FILELOCK_OPEN_NONE      (AD_FILELOCK_BASE + 4)
 359
 360 /* time stuff. we overload the bits a little.  */
 361 #define AD_DATE_CREATE         0
 362 #define AD_DATE_MODIFY         4
 363 #define AD_DATE_BACKUP         8
 364 #define AD_DATE_ACCESS        12
 365 #define AD_DATE_MASK          (AD_DATE_CREATE | AD_DATE_MODIFY | \
 366                                AD_DATE_BACKUP | AD_DATE_ACCESS)
 367 #define AD_DATE_UNIX          (1 << 10)
 368 #define AD_DATE_START         htonl(0x80000000)
 369 #define AD_DATE_DELTA         946684800
 370 #define AD_DATE_FROM_UNIX(x)  htonl((x) - AD_DATE_DELTA)
 371 #define AD_DATE_TO_UNIX(x)    (ntohl(x) + AD_DATE_DELTA)
 372
 373 /* various finder offset and info bits */
 374 #define FINDERINFO_FRTYPEOFF   0
 375 #define FINDERINFO_FRCREATOFF  4
 376
 377 #define FINDERINFO_FRFLAGOFF   8
 378 /* finderinfo flags */
 379 #define FINDERINFO_ISONDESK      (1)
 380 #define FINDERINFO_COLOR         (0x0e)
 381 #define FINDERINFO_ISHARED       (1<<6)
 382 #define FINDERINFO_HASNOINITS    (1<<7)
 383 #define FINDERINFO_HASBEENINITED (1<<8)
 384 #define FINDERINFO_HASCUSTOMICON (1<<10)
 385 #define FINDERINFO_ISSTATIONNERY (1<<11)
 386 #define FINDERINFO_NAMELOCKED    (1<<12)
 387 #define FINDERINFO_HASBUNDLE     (1<<13)
 388 #define FINDERINFO_INVISIBLE     (1<<14)
 389 #define FINDERINFO_ISALIAS       (1<<15)
 390
 391 #define FINDERINFO_FRVIEWOFF  14
 392 #define FINDERINFO_CUSTOMICON 0x4
 393 #define FINDERINFO_CLOSEDVIEW 0x100
 394
 395
 396 /* private AFPFileInfo bits */
 397 #define AD_AFPFILEI_OWNER       (1 << 0) /* any owner */
 398 #define AD_AFPFILEI_GROUP       (1 << 1) /* ignore group */
 399 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
 400
 401 #define ad_data_fileno(ad)      ((ad)->ad_data_fork.adf_fd)
 402 #define ad_reso_fileno(ad)      ((ad)->ad_resource_fork.adf_fd)
 403 #define ad_meta_fileno(ad)      ((ad)->ad_md->adf_fd)
 404
 405 #define ad_getversion(ad)       ((ad)->ad_version)
 406
 407 #define ad_getentrylen(ad,eid)  ((ad)->ad_eid[(eid)].ade_len)
 408 #define ad_setentrylen(ad,eid,len) \
 409         ((ad)->ad_eid[(eid)].ade_len = (len))
 410 #define ad_getentryoff(ad,eid)  ((ad)->ad_eid[(eid)].ade_off)
 411 #define ad_entry(ad,eid)        ((caddr_t)(ad)->ad_data + \
 412                                  (ad)->ad_eid[(eid)].ade_off)
 413
 414 #define ad_get_HF_flags(ad)     ((ad)->ad_resource_fork.adf_flags)
 415 #define ad_get_MD_flags(ad)     ((ad)->ad_md->adf_flags)
 416
 417 /* ad_flush.c
 418
 419 */
 420 extern int ad_rebuild_adouble_header __P((struct adouble *));
 421 extern int ad_rebuild_sfm_header __P((struct adouble *));
 422
 423 extern int ad_flush           __P((struct adouble *));
 424 extern int ad_close           __P((struct adouble *, int));
 425
 426 /* ad_lock.c */
 427 extern int ad_fcntl_lock __P((struct adouble *, const u_int32_t /*eid*/,
 428                               const int /*type*/, const off_t /*offset*/,
 429                               const off_t /*len*/, const int /*user*/));
 430 extern void ad_fcntl_unlock __P((struct adouble *, const int /*user*/));
 431
 432 extern int ad_fcntl_tmplock __P((struct adouble *, const u_int32_t /*eid*/,
 433                                  const int /*type*/, const off_t /*offset*/,
 434                                  const off_t /*len*/, const int /*user*/));
 435
 436 extern int ad_testlock      __P((struct adouble * /*adp*/, int /*eid*/, off_t /*off*/));
 437 extern int ad_excl_lock     __P((struct adouble * /*adp*/, const u_int32_t /*eid*/));
 438
 439 #define ad_lock ad_fcntl_lock
 440 #define ad_tmplock ad_fcntl_tmplock
 441 #define ad_unlock ad_fcntl_unlock
 442
 443 /* ad_open.c */
 444 extern int ad_setfuid     __P((const uid_t ));
 445 extern uid_t ad_getfuid   __P((void ));
 446
 447 extern char *ad_dir       __P((const char *));
 448 extern char *ad_path      __P((const char *, int));
 449 extern char *ad_path_osx  __P((const char *, int));
 450 extern char *ad_path_ads  __P((const char *, int));
 451 extern char *ad_path_sfm  __P((const char *, int));
 452
 453 extern int ad_mode        __P((const char *, int));
 454 extern int ad_mkdir       __P((const char *, int));
 455 extern void ad_init       __P((struct adouble *, int, int ));
 456
 457 extern int ad_open        __P((const char *, int, int, int, struct adouble *));
 458 extern int ad_refresh     __P((struct adouble *));
 459 extern int ad_stat        __P((const char *, struct stat *));
 460 extern int ad_metadata    __P((const char *, int, struct adouble *));
 461
 462 #define ad_open_metadata(name, flags, mode, adp)\
 463    ad_open(name, ADFLAGS_MD|(flags), O_RDWR |(mode), 0666, (adp))
 464
 465 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_MD)
 466
 467 /* build a resource fork mode from the data fork mode:
 468  * remove X mode and extend header to RW if R or W (W if R for locking),
 469  */
 470 #ifndef ATACC
 471 #ifndef __inline__
 472 #define __inline__
 473 #endif
 474 static __inline__ mode_t ad_hf_mode (mode_t mode)
 475 {
 476     mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
 477     /* fnctl lock need write access */
 478     if ((mode & S_IRUSR))
 479         mode |= S_IWUSR;
 480     if ((mode & S_IRGRP))
 481         mode |= S_IWGRP;
 482     if ((mode & S_IROTH))
 483         mode |= S_IWOTH;
 484
 485     /* if write mode set add read mode */
 486     if ((mode & S_IWUSR))
 487         mode |= S_IRUSR;
 488     if ((mode & S_IWGRP))
 489         mode |= S_IRGRP;
 490     if ((mode & S_IWOTH))
 491         mode |= S_IROTH;
 492
 493     return mode;
 494 }
 495 #else
 496 extern mode_t ad_hf_mode __P((mode_t ));
 497 #endif
 498
 499 /* ad_read.c/ad_write.c */
 500 extern ssize_t ad_read __P((struct adouble *, const u_int32_t,
 501                             const off_t, char *, const size_t));
 502 extern ssize_t ad_pread __P((struct ad_fd *, void *, size_t, off_t));
 503
 504 extern ssize_t ad_write __P((struct adouble *, const u_int32_t, off_t,
 505                              const int, const char *, const size_t));
 506
 507 extern ssize_t adf_pread  __P((struct ad_fd *, void *, size_t, off_t));
 508 extern ssize_t adf_pwrite __P((struct ad_fd *, const void *, size_t, off_t));
 509
 510 extern int ad_dtruncate __P((struct adouble *, const off_t));
 511 extern int ad_rtruncate __P((struct adouble *, const off_t));
 512
 513 /* ad_size.c */
 514 extern off_t ad_size __P((const struct adouble *, const u_int32_t ));
 515
 516 /* ad_mmap.c */
 517 extern void *ad_mmapread __P((struct adouble *, const u_int32_t,
 518                               const off_t, const size_t));
 519 extern void *ad_mmapwrite __P((struct adouble *, const u_int32_t,
 520                                const off_t, const int, const size_t));
 521 #define ad_munmap(buf, len)  (munmap((buf), (len)))
 522
 523 /* ad_date.c */
 524 extern int ad_setdate __P((const struct adouble *, unsigned int, u_int32_t));
 525 extern int ad_getdate __P((const struct adouble *, unsigned int, u_int32_t *));
 526
 527 /* ad_attr.c */
 528 extern int ad_setattr __P((const struct adouble *, const u_int16_t));
 529 extern int ad_getattr __P((const struct adouble *, u_int16_t *));
 530
 531 extern int ad_setname __P((struct adouble *, const char *));
 532 #if AD_VERSION == AD_VERSION2
 533 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 *));
 534 extern u_int32_t ad_getid __P((struct adouble *, const dev_t, const ino_t, const cnid_t, const void *));
 535 #else
 536 #define ad_setid(a, b, c)
 537 #endif
 538
 539 #ifdef WITH_SENDFILE
 540 extern ssize_t ad_readfile __P((const struct adouble *, const int,
 541                                 const int, off_t, const size_t));
 542 #endif
 543
 544 #if 0
 545 #ifdef HAVE_SENDFILE_WRITE
 546 extern ssize_t ad_writefile __P((struct adouble *, const int,
 547                                  const int, off_t, const int, const size_t));
 548 #endif
 549 #endif
 550
 551 #endif