include/atalk/adouble.h

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