include/atalk/adouble.h

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