include/atalk/adouble.h

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