include/atalk/adouble.h

   1 /*
   2  * Copyright (c) 1990,1991 Regents of The University of Michigan.
   3  * All Rights Reserved.
   4  *
   5  * Permission to use, copy, modify, and distribute this software and
   6  * its documentation for any purpose and without fee is hereby granted,
   7  * provided that the above copyright notice appears in all copies and
   8  * that both that copyright notice and this permission notice appear
   9  * in supporting documentation, and that the name of The University
  10  * of Michigan not be used in advertising or publicity pertaining to
  11  * distribution of the software without specific, written prior
  12  * permission. This software is supplied as is without expressed or
  13  * implied warranties of any kind.
  14  *
  15  *  Research Systems Unix Group
  16  *  The University of Michigan
  17  *  c/o Mike Clark
  18  *  535 W. William Street
  19  *  Ann Arbor, Michigan
  20  *  +1-313-763-0525
  21  *  netatalk@itd.umich.edu
  22  */
  23
  24 /*!
  25  * @file
  26  * @brief Part of Netatalk's AppleDouble implementatation
  27  */
  28
  29 #ifndef _ATALK_ADOUBLE_H
  30 #define _ATALK_ADOUBLE_H
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include <config.h>
  34 #endif
  35
  36 #include <inttypes.h>
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #include <unistd.h>
  40 #include <sys/cdefs.h>
  41 #include <fcntl.h>
  42 #include <sys/mman.h>
  43 #include <sys/time.h>
  44
  45 #include <netatalk/endian.h>
  46 #include <atalk/bstrlib.h>
  47
  48 /* version info */
  49 #define AD_VERSION2     0x00020000
  50 #define AD_VERSION_EA   0x00020002
  51
  52 /* default */
  53 #define AD_VERSION      AD_VERSION2
  54
  55 /*
  56  * AppleDouble entry IDs.
  57  */
  58 #define ADEID_DFORK         1
  59 #define ADEID_RFORK         2
  60 #define ADEID_NAME          3
  61 #define ADEID_COMMENT       4
  62 #define ADEID_ICONBW        5
  63 #define ADEID_ICONCOL       6
  64 #define ADEID_FILEI         7  /* v1, replaced by: */
  65 #define ADEID_FILEDATESI    8  /* this */
  66 #define ADEID_FINDERI       9
  67 #define ADEID_MACFILEI      10 /* we don't use this */
  68 #define ADEID_PRODOSFILEI   11 /* we store prodos info here */
  69 #define ADEID_MSDOSFILEI    12 /* we don't use this */
  70 #define ADEID_SHORTNAME     13
  71 #define ADEID_AFPFILEI      14 /* where the rest of the FILEI info goes */
  72 #define ADEID_DID           15
  73
  74 /* netatalk private note fileid reused DID */
  75 #define ADEID_PRIVDEV       16
  76 #define ADEID_PRIVINO       17
  77 #define ADEID_PRIVSYN       18 /* in synch with database */
  78 #define ADEID_PRIVID        19
  79 #define ADEID_MAX           (ADEID_PRIVID + 1)
  80
  81 /* These are the real ids for these entries, as stored in the adouble file */
  82 #define AD_DEV              0x80444556
  83 #define AD_INO              0x80494E4F
  84 #define AD_SYN              0x8053594E
  85 #define AD_ID               0x8053567E
  86
  87 /* magic */
  88 #define AD_APPLESINGLE_MAGIC 0x00051600
  89 #define AD_APPLEDOUBLE_MAGIC 0x00051607
  90 #define AD_MAGIC             AD_APPLEDOUBLE_MAGIC
  91
  92 /* sizes of relevant entry bits */
  93 #define ADEDLEN_MAGIC       4
  94 #define ADEDLEN_VERSION     4
  95 #define ADEDLEN_FILLER      16
  96 #define ADEDLEN_NENTRIES    2
  97 #define AD_HEADER_LEN       (ADEDLEN_MAGIC + ADEDLEN_VERSION + ADEDLEN_FILLER + ADEDLEN_NENTRIES)
  98 #define AD_ENTRY_LEN        12  /* size of a single entry header */
  99
 100 /* field widths */
 101 #define ADEDLEN_NAME            255
 102 #define ADEDLEN_COMMENT         200
 103 #define ADEDLEN_FILEI           16
 104 #define ADEDLEN_FINDERI         32
 105 #define ADEDLEN_FILEDATESI      16
 106 #define ADEDLEN_SHORTNAME       12 /* length up to 8.3 */
 107 #define ADEDLEN_AFPFILEI        4
 108 #define ADEDLEN_MACFILEI        4
 109 #define ADEDLEN_PRODOSFILEI     8
 110 #define ADEDLEN_MSDOSFILEI      2
 111 #define ADEDLEN_DID             4
 112 #define ADEDLEN_PRIVDEV         8
 113 #define ADEDLEN_PRIVINO         8
 114 #define ADEDLEN_PRIVSYN         8
 115 #define ADEDLEN_PRIVID          4
 116
 117 #define ADEID_NUM_V2            13
 118 #define ADEID_NUM_EA            5
 119
 120 #define AD_DATASZ2 (AD_HEADER_LEN + ADEDLEN_NAME + ADEDLEN_COMMENT + ADEDLEN_FILEI + \
 121                     ADEDLEN_FINDERI + ADEDLEN_DID + ADEDLEN_AFPFILEI + ADEDLEN_SHORTNAME + \
 122                     ADEDLEN_PRODOSFILEI + ADEDLEN_PRIVDEV + ADEDLEN_PRIVINO + \
 123                     ADEDLEN_PRIVSYN + ADEDLEN_PRIVID + (ADEID_NUM_V2 * AD_ENTRY_LEN))
 124 #if AD_DATASZ2 != 741
 125 #error bad size for AD_DATASZ2
 126 #endif
 127
 128 #define AD_DATASZ_EA (AD_HEADER_LEN + (ADEID_NUM_EA * AD_ENTRY_LEN) + ADEDLEN_FINDERI + \
 129                       ADEDLEN_COMMENT + ADEDLEN_FILEDATESI + ADEDLEN_AFPFILEI + ADEDLEN_PRIVID)
 130
 131 #if AD_DATASZ_EA != 342
 132 #error bad size for AD_DATASZ_EA
 133 #endif
 134
 135 #define AD_DATASZ_MAX   1024
 136
 137 #if AD_VERSION == AD_VERSION2
 138 #define AD_DATASZ   AD_DATASZ2
 139 #elif AD_VERSION == AD_VERSION_EA
 140 #define AD_DATASZ   AD_DATASZ_EA
 141 #endif
 142
 143 #define RFORK_EA_ALLOCSIZE (128*1024) /* 128k */
 144
 145 typedef u_int32_t cnid_t;
 146
 147 struct ad_entry {
 148     uint32_t   ade_off;
 149     uint32_t   ade_len;
 150 };
 151
 152 typedef struct adf_lock_t {
 153     struct flock lock;
 154     int user;
 155     int *refcount; /* handle read locks with multiple users */
 156 } adf_lock_t;
 157
 158 struct ad_fd {
 159     int          adf_fd;        /* -1: invalid, -2: symlink */
 160 #ifndef HAVE_PREAD
 161     off_t        adf_off;
 162 #endif
 163     char         *adf_syml;
 164     int          adf_flags;
 165     int          adf_excl;
 166 #if 0
 167     adf_lock_t   *adf_lock;
 168     int          adf_refcount, adf_lockcount, adf_lockmax;
 169 #endif
 170 };
 171
 172 /* some header protection */
 173 #define AD_INITED  0xad494e54  /* ad"INT" */
 174
 175 struct adouble;
 176
 177 struct adouble_fops {
 178     const char *(*ad_path)(const char *, int);
 179     int  (*ad_mkrf)(const char *);
 180     int  (*ad_rebuild_header)(struct adouble *);
 181     int  (*ad_header_read)(struct adouble *, struct stat *);
 182     int  (*ad_header_upgrade)(struct adouble *, const char *);
 183 };
 184
 185 struct adouble {
 186     u_int32_t           ad_magic;
 187     u_int32_t           ad_version;
 188     char                ad_filler[ 16 ];
 189     struct ad_entry     ad_eid[ ADEID_MAX ];
 190     struct ad_fd        ad_data_fork, ad_resource_fork, ad_metadata_fork;
 191     struct ad_fd        *ad_md; /* either ad_resource or ad_metadata */
 192     int                 ad_flags;    /* This really stores version info too (AD_VERSION*) */
 193     int                 ad_adflags;  /* ad_open flags adflags like ADFLAGS_DIR */
 194     unsigned int        ad_inited;
 195     int                 ad_options;
 196     void                *ad_resforkbuf;  /* buffer for AD_VERSION_EA ressource fork */
 197     size_t              ad_resforkbufsize; /* size of ad_resforkbuf */
 198     off_t               ad_rlen;     /* ressource fork len with AFP 3.0
 199                                         the header parameter size is too small. */
 200     char                *ad_m_name;   /* mac name for open fork */
 201     int                 ad_m_namelen;
 202     bstring             ad_fullpath; /* adouble EA need this */
 203     struct adouble_fops *ad_ops;
 204     uint16_t            ad_open_forks; /* open forks (by others) */
 205     char                ad_data[AD_DATASZ_MAX];
 206 };
 207
 208 #define ADFLAGS_DF        (1<<0)
 209 #define ADFLAGS_RF        (1<<1)
 210 #define ADFLAGS_HF        (1<<2)
 211 #define ADFLAGS_DIR       (1<<3)
 212 #define ADFLAGS_NOHF      (1<<4)  /* not an error if no ressource fork */
 213 #define ADFLAGS_OPENFORKS (1<<5)  /* check for open fork in ad_metadata function */
 214
 215 #define ADVOL_NODEV      (1 << 0)
 216 #define ADVOL_CACHE      (1 << 1)
 217 #define ADVOL_UNIXPRIV   (1 << 2) /* adouble unix priv */
 218 #define ADVOL_INVDOTS    (1 << 3) /* dot files (.DS_Store) are invisible) */
 219 #define ADVOL_NOADOUBLE  (1 << 4)
 220
 221 /* lock flags */
 222 #define ADLOCK_CLR      (0)
 223 #define ADLOCK_RD       (1<<0)
 224 #define ADLOCK_WR       (1<<1)
 225 #define ADLOCK_MASK     (ADLOCK_RD | ADLOCK_WR)
 226 #define ADLOCK_UPGRADE  (1<<2)
 227 #define ADLOCK_FILELOCK (1<<3)
 228
 229 /* we use this so that we can use the same mechanism for both byte
 230  * locks and file synchronization locks. i do this by co-opting either
 231  * first bits on 32-bit machines or shifting above the last bit on
 232  * 64-bit machines. this only matters for the data fork. */
 233 #if defined(TRY_64BITOFF_T) && (~0UL > 0xFFFFFFFFU)
 234 /* synchronization locks */
 235 #define AD_FILELOCK_BASE (0x80000000)
 236 #else
 237 #define AD_FILELOCK_BASE (0x7FFFFFFF -9)
 238 #endif
 239
 240 /* FIXME:
 241  * AD_FILELOCK_BASE case
 242  */
 243 #if _FILE_OFFSET_BITS == 64
 244 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
 245 #else
 246 /* Tru64 is an always-64-bit OS; version 4.0 does not set _FILE_OFFSET_BITS */
 247 #if defined(TRU64)
 248 #define BYTELOCK_MAX (0x7FFFFFFFFFFFFFFFULL)
 249 #else
 250 #define BYTELOCK_MAX (0x7FFFFFFFU)
 251 #endif
 252 #endif
 253
 254 #define AD_FILELOCK_OPEN_WR        (AD_FILELOCK_BASE + 0)
 255 #define AD_FILELOCK_OPEN_RD        (AD_FILELOCK_BASE + 1)
 256 #define AD_FILELOCK_DENY_WR        (AD_FILELOCK_BASE + 2)
 257 #define AD_FILELOCK_DENY_RD        (AD_FILELOCK_BASE + 3)
 258 #define AD_FILELOCK_OPEN_NONE      (AD_FILELOCK_BASE + 4)
 259
 260 /* time stuff. we overload the bits a little.  */
 261 #define AD_DATE_CREATE         0
 262 #define AD_DATE_MODIFY         4
 263 #define AD_DATE_BACKUP         8
 264 #define AD_DATE_ACCESS        12
 265 #define AD_DATE_MASK          (AD_DATE_CREATE | AD_DATE_MODIFY | \
 266                               AD_DATE_BACKUP | AD_DATE_ACCESS)
 267 #define AD_DATE_UNIX          (1 << 10)
 268 #define AD_DATE_START         htonl(0x80000000)
 269 #define AD_DATE_DELTA         946684800
 270 #define AD_DATE_FROM_UNIX(x)  htonl((x) - AD_DATE_DELTA)
 271 #define AD_DATE_TO_UNIX(x)    (ntohl(x) + AD_DATE_DELTA)
 272
 273 /* various finder offset and info bits */
 274 #define FINDERINFO_FRTYPEOFF   0
 275 #define FINDERINFO_FRCREATOFF  4
 276 #define FINDERINFO_FRFLAGOFF   8
 277
 278 /* FinderInfo Flags, char in `ad ls`, valid for files|dirs */
 279 #define FINDERINFO_ISONDESK      (1)     /* "d", fd */
 280 #define FINDERINFO_COLOR         (0x0e)
 281 #define FINDERINFO_HIDEEXT       (1<<4)  /* "e", fd */
 282 #define FINDERINFO_ISHARED       (1<<6)  /* "m", f  */
 283 #define FINDERINFO_HASNOINITS    (1<<7)  /* "n", f  */
 284 #define FINDERINFO_HASBEENINITED (1<<8)  /* "i", fd */
 285 #define FINDERINFO_HASCUSTOMICON (1<<10) /* "c", fd */
 286 #define FINDERINFO_ISSTATIONNERY (1<<11) /* "t", f  */
 287 #define FINDERINFO_NAMELOCKED    (1<<12) /* "s", fd */
 288 #define FINDERINFO_HASBUNDLE     (1<<13) /* "b", fd */
 289 #define FINDERINFO_INVISIBLE     (1<<14) /* "v", fd */
 290 #define FINDERINFO_ISALIAS       (1<<15) /* "a", fd */
 291
 292 #define FINDERINFO_FRVIEWOFF  14
 293 #define FINDERINFO_CUSTOMICON 0x4
 294 #define FINDERINFO_CLOSEDVIEW 0x100
 295
 296 /*
 297   The "shared" and "invisible" attributes are opaque and stored and
 298   retrieved from the FinderFlags. This fixes Bug #2802236:
 299   <https://sourceforge.net/tracker/?func=detail&aid=2802236&group_id=8642&atid=108642>
 300 */
 301
 302 /* AFP attributes, char in `ad ls`, valid for files|dirs */
 303 #define ATTRBIT_INVISIBLE (1<<0)  /* opaque from FinderInfo */
 304 #define ATTRBIT_MULTIUSER (1<<1)  /* file: opaque, dir: see below */
 305 #define ATTRBIT_SYSTEM    (1<<2)  /* "y", fd */
 306 #define ATTRBIT_DOPEN     (1<<3)  /* data fork already open. Not stored, computed on the fly */
 307 #define ATTRBIT_ROPEN     (1<<4)  /* resource fork already open. Not stored, computed on the fly */
 308 #define ATTRBIT_NOWRITE   (1<<5)  /* "w", f, write inhibit(v2)/read-only(v1) bit */
 309 #define ATTRBIT_BACKUP    (1<<6)  /* "p", fd */
 310 #define ATTRBIT_NORENAME  (1<<7)  /* "r", fd */
 311 #define ATTRBIT_NODELETE  (1<<8)  /* "l", fd */
 312 #define ATTRBIT_NOCOPY    (1<<10) /* "o", f */
 313 #define ATTRBIT_SETCLR    (1<<15) /* set/clear bit (d) */
 314
 315 /* AFP attributes for dirs. These should probably be computed on the fly.
 316  * We don't do that, nor does e.g. OS S X 10.5 Server */
 317 #define ATTRBIT_EXPFLDR   (1<<1)  /* Folder is a sharepoint */
 318 #define ATTRBIT_MOUNTED   (1<<3)  /* Directory is mounted by a user */
 319 #define ATTRBIT_SHARED    (1<<4)  /* Shared area, called IsExpFolder in spec */
 320
 321 /* private AFPFileInfo bits */
 322 #define AD_AFPFILEI_OWNER       (1 << 0) /* any owner */
 323 #define AD_AFPFILEI_GROUP       (1 << 1) /* ignore group */
 324 #define AD_AFPFILEI_BLANKACCESS (1 << 2) /* blank access permissions */
 325
 326 #define ad_data_fileno(ad)  ((ad)->ad_data_fork.adf_fd)
 327 #define ad_reso_fileno(ad)  ((ad)->ad_resource_fork.adf_fd)
 328 #define ad_meta_fileno(ad)  ((ad)->ad_md->adf_fd)
 329
 330 #define ad_getversion(ad)   ((ad)->ad_version)
 331
 332 #define ad_getentrylen(ad,eid)     ((ad)->ad_eid[(eid)].ade_len)
 333 #define ad_setentrylen(ad,eid,len) ((ad)->ad_eid[(eid)].ade_len = (len))
 334 #define ad_getentryoff(ad,eid)     ((ad)->ad_eid[(eid)].ade_off)
 335 #define ad_entry(ad,eid)           ((caddr_t)(ad)->ad_data + (ad)->ad_eid[(eid)].ade_off)
 336
 337 #define ad_get_HF_flags(ad) ((ad)->ad_resource_fork.adf_flags)
 338 #define ad_get_MD_flags(ad) ((ad)->ad_md->adf_flags)
 339
 340 /* ad_flush.c */
 341 extern int ad_rebuild_adouble_header (struct adouble *);
 342 extern int ad_rebuild_sfm_header (struct adouble *);
 343 extern int ad_copy_header (struct adouble *, struct adouble *);
 344 extern int ad_flush (struct adouble *);
 345 extern int ad_close (struct adouble *, int);
 346
 347 /* ad_lock.c */
 348 extern int ad_fcntl_lock    (struct adouble *, const u_int32_t /*eid*/,
 349                                  const int /*type*/, const off_t /*offset*/,
 350                                  const off_t /*len*/, const int /*user*/);
 351 extern void ad_fcntl_unlock (struct adouble *, const int /*user*/);
 352 extern int ad_fcntl_tmplock (struct adouble *, const u_int32_t /*eid*/,
 353                                  const int /*type*/, const off_t /*offset*/,
 354                                  const off_t /*len*/, const int /*user*/);
 355 extern int ad_testlock      (struct adouble * /*adp*/, int /*eid*/, off_t /*off*/);
 356
 357 extern u_int16_t ad_openforks (struct adouble * /*adp*/, u_int16_t);
 358 extern int ad_excl_lock     (struct adouble * /*adp*/, const u_int32_t /*eid*/);
 359
 360 #define ad_lock ad_fcntl_lock
 361 #define ad_tmplock ad_fcntl_tmplock
 362 #define ad_unlock ad_fcntl_unlock
 363
 364 /* ad_open.c */
 365 extern const char *oflags2logstr(int oflags);
 366 extern const char *adflags2logstr(int adflags);
 367 extern int ad_setfuid     (const uid_t );
 368 extern uid_t ad_getfuid   (void );
 369 extern char *ad_dir       (const char *);
 370 extern const char *ad_path      (const char *, int);
 371 extern const char *ad_path_ea   (const char *, int);
 372 extern int ad_mode        (const char *, int);
 373 extern int ad_mkdir       (const char *, int);
 374 extern void ad_init       (struct adouble *, int, int );
 375 extern int ad_open        (struct adouble *ad, const char *path, int adflags, ...);
 376 extern int ad_openat      (struct adouble *, int dirfd, const char *path, int adflags, ...);
 377 extern int ad_refresh     (struct adouble *);
 378 extern int ad_stat        (const char *, struct stat *);
 379 extern int ad_metadata    (const char *, int, struct adouble *);
 380 extern int ad_metadataat  (int, const char *, int, struct adouble *);
 381
 382 #if 0
 383 #define ad_open_metadata(name, flags, mode, adp)\
 384    ad_open(name, ADFLAGS_HF | (flags), O_RDWR |(mode), 0666, (adp))
 385 #endif
 386
 387 #define ad_close_metadata(adp) ad_close( (adp), ADFLAGS_HF)
 388
 389 /* build a resource fork mode from the data fork mode:
 390  * remove X mode and extend header to RW if R or W (W if R for locking),
 391  */
 392 static inline mode_t ad_hf_mode (mode_t mode)
 393 {
 394     mode &= ~(S_IXUSR | S_IXGRP | S_IXOTH);
 395     /* fnctl lock need write access */
 396     if ((mode & S_IRUSR))
 397         mode |= S_IWUSR;
 398     if ((mode & S_IRGRP))
 399         mode |= S_IWGRP;
 400     if ((mode & S_IROTH))
 401         mode |= S_IWOTH;
 402
 403     /* if write mode set add read mode */
 404     if ((mode & S_IWUSR))
 405         mode |= S_IRUSR;
 406     if ((mode & S_IWGRP))
 407         mode |= S_IRGRP;
 408     if ((mode & S_IWOTH))
 409         mode |= S_IROTH;
 410
 411     return mode;
 412 }
 413
 414 /* ad_read.c/ad_write.c */
 415 extern int     sys_ftruncate(int fd, off_t length);
 416 extern ssize_t ad_read(struct adouble *, uint32_t, off_t, char *, size_t);
 417 extern ssize_t ad_pread(struct ad_fd *, void *, size_t, off_t);
 418 extern ssize_t ad_write(struct adouble *, uint32_t, off_t, int, const char *, size_t);
 419 extern ssize_t adf_pread(struct ad_fd *, void *, size_t, off_t);
 420 extern ssize_t adf_pwrite(struct ad_fd *, const void *, size_t, off_t);
 421 extern int     ad_dtruncate(struct adouble *, off_t);
 422 extern int     ad_rtruncate(struct adouble *, off_t);
 423
 424 /* ad_size.c */
 425 extern off_t ad_size (const struct adouble *, uint32_t );
 426
 427 /* ad_mmap.c */
 428 extern void *ad_mmapread(struct adouble *, uint32_t, off_t, size_t);
 429 extern void *ad_mmapwrite(struct adouble *, uint32_t, off_t, int, size_t);
 430 #define ad_munmap(buf, len)  (munmap((buf), (len)))
 431
 432 /* ad_date.c */
 433 extern int ad_setdate(struct adouble *, unsigned int, uint32_t);
 434 extern int ad_getdate(const struct adouble *, unsigned int, uint32_t *);
 435
 436 /* ad_attr.c */
 437 extern int       ad_setattr(const struct adouble *, uint16_t);
 438 extern int       ad_getattr(const struct adouble *, uint16_t *);
 439 extern int       ad_setname(struct adouble *, const char *);
 440 extern int       ad_setid(struct adouble *, dev_t dev, ino_t ino, uint32_t, uint32_t, const void *);
 441 extern u_int32_t ad_getid(struct adouble *, dev_t, ino_t, cnid_t, const void *);
 442 extern u_int32_t ad_forcegetid(struct adouble *adp);
 443
 444 #ifdef WITH_SENDFILE
 445 extern int ad_readfile_init(const struct adouble *ad, int eid, off_t *off, int end);
 446 #endif
 447
 448 #if 0
 449 #ifdef HAVE_SENDFILE_WRITE
 450 extern ssize_t ad_writefile(struct adouble *, int, int, off_t, int, size_t);
 451 #endif /* HAVE_SENDFILE_WRITE */
 452 #endif /* 0 */
 453
 454 #endif /* _ATALK_ADOUBLE_H */