include/atalk/adouble.h

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