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