include/atalk/adouble.h

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