include/atalk/volume.h

   1 /*
   2  * Copyright (c) 1990,1994 Regents of The University of Michigan.
   3  * All Rights Reserved.  See COPYRIGHT.
   4  */
   5
   6 #ifndef ATALK_VOLUME_H
   7 #define ATALK_VOLUME_H 1
   8
   9 #include <stdint.h>
  10 #include <sys/types.h>
  11
  12 #include <atalk/unicode.h>
  13 #include <atalk/cnid.h>
  14 #include <atalk/hash.h>
  15 #include <atalk/vfs.h>
  16 #include <atalk/globals.h>
  17
  18 #define AFPVOL_U8MNAMELEN   255 /* AFP3 sepc */
  19 #define AFPVOL_MACNAMELEN    27 /* AFP2 spec */
  20
  21 typedef uint64_t VolSpace;
  22
  23 /* This should belong in a file.h */
  24 struct extmap {
  25     char                *em_ext;
  26     char                em_creator[4];
  27     char                em_type[4];
  28 };
  29
  30 struct vol {
  31     struct vol      *v_next;
  32     AFPObj          *v_obj;
  33     uint16_t        v_vid;
  34     int             v_flags;
  35     char            *v_path;
  36     struct dir      *v_root;
  37     time_t          v_mtime;
  38
  39     charset_t       v_volcharset;
  40     charset_t       v_maccharset;
  41     uint16_t        v_mtou_flags;    /* flags for convert_charset in mtoupath */
  42     uint16_t        v_utom_flags;
  43     long            v_kTextEncoding; /* mac charset encoding in network order
  44                                       * FIXME: should be a u_int32_t ? */
  45     size_t          max_filename;
  46     char            *v_veto;
  47     int             v_adouble;    /* adouble format: v1, v2, sfm ... */
  48     int             v_ad_options; /* adouble option NODEV, NOCACHE, etc.. */
  49     const char      *(*ad_path)(const char *, int);
  50     struct _cnid_db *v_cdb;
  51     char            v_stamp[ADEDLEN_PRIVSYN];
  52     VolSpace        v_limitsize; /* Size limit, if any, in MiB */
  53     mode_t          v_umask;
  54     mode_t          v_dperm; /* default directories permission value OR with requested perm*/
  55     mode_t          v_fperm; /* default files permission value OR with requested perm*/
  56     ucs2_t          *v_u8mname;     /* converted to utf8-mac in ucs2 */
  57     ucs2_t          *v_macname;     /* mangled to legacy longname in ucs2 */
  58     ucs2_t          *v_name;        /* either v_u8mname or v_macname */
  59
  60     /* get/set volparams */
  61     time_t          v_ctime;  /* volume creation date, not unix ctime */
  62     dev_t           v_dev;    /* Unix volume device, Set but not used */
  63
  64     /* adouble VFS indirection */
  65     struct vfs_ops  *vfs;   /* pointer to vfs_master_funcs for chaining */
  66     const struct vfs_ops *vfs_modules[4];
  67     int             v_vfs_ea;       /* The AFPVOL_EA_xx flag */
  68
  69     /* misc */
  70     char            *v_gvs;
  71     void            *v_nfsclient;
  72     int             v_nfs;
  73     VolSpace        v_tm_used;  /* used bytes on a TM volume */
  74     time_t          v_tm_cachetime; /* time at which v_tm_used was calculated last */
  75     VolSpace        v_appended; /* amount of data appended to files */
  76
  77     /* only when opening/closing volumes or in error */
  78     int             v_casefold;
  79     char            *v_configname;   /* as defined in afpc.conf */
  80     char            *v_localname;    /* as defined in afp.conf but with vars expanded */
  81     char            *v_volcodepage;
  82     char            *v_maccodepage;
  83     char            *v_password;
  84     char            *v_cnidscheme;
  85     char            *v_dbpath;
  86     char            *v_cnidserver;
  87     char            *v_cnidport;
  88 #if 0
  89     int             v_hide;       /* new volume wait until old volume is closed */
  90     int             v_new;        /* volume deleted but there's a new one with the same name */
  91 #endif
  92     int             v_deleted;    /* volume open but deleted in new config file */
  93     char            *v_root_preexec;
  94     char            *v_preexec;
  95     char            *v_root_postexec;
  96     char            *v_postexec;
  97     int             v_root_preexec_close;
  98     int             v_preexec_close;
  99     char            *v_uuid;    /* For TimeMachine zeroconf record */
 100     int             v_qfd;
 101     uint32_t        v_ignattr;  /* AFP attributes that shall be ignored */
 102 };
 103
 104 /* load_volumes() flags */
 105 #define LV_ALL (1 << 0)
 106
 107 /* volume flags */
 108 #define AFPVOL_OPEN (1<<0)
 109 /* flags  for AFS and quota 0xxx0 */
 110 #define AFPVOL_GVSMASK  (7<<2)
 111 #define AFPVOL_NONE     (0<<2)
 112 #define AFPVOL_AFSGVS   (1<<2)
 113 #define AFPVOL_USTATFS  (1<<3)
 114 #define AFPVOL_UQUOTA   (1<<4)
 115
 116 /*
 117   Flags that alter volume behaviour.
 118   Keep in sync with libatalk/util/volinfo.c
 119 */
 120 #define AFPVOL_NOV2TOEACONV (1 << 5) /* no adouble:v2 to adouble:ea conversion */
 121 #define AFPVOL_RO        (1 << 8)   /* read-only volume */
 122 #define AFPVOL_NOSTAT    (1 << 16)  /* advertise the volume even if we can't stat() it
 123                                      * maybe because it will be mounted later in preexec */
 124 #define AFPVOL_UNIX_PRIV (1 << 17)  /* support unix privileges */
 125 #define AFPVOL_NODEV     (1 << 18)  /* always use 0 for device number in cnid calls
 126                                      * help if device number is notconsistent across reboot
 127                                      * NOTE symlink to a different device will return an ACCESS error
 128                                      */
 129 #define AFPVOL_EILSEQ    (1 << 20)  /* encode illegal sequence 'asis' UCS2, ex "\217-", which is not
 130                                        a valid SHIFT-JIS char, is encoded  as U\217 -*/
 131 #define AFPVOL_INV_DOTS  (1 << 22)   /* dots files are invisible */
 132 #define AFPVOL_TM        (1 << 23)   /* Supports TimeMachine */
 133 #define AFPVOL_ACLS      (1 << 24)   /* Volume supports ACLS */
 134 #define AFPVOL_SEARCHDB  (1 << 25)   /* Use fast CNID db search instead of filesystem */
 135 #define AFPVOL_NONETIDS  (1 << 26)   /* signal the client it shall do privelege mapping */
 136 #define AFPVOL_FOLLOWSYM (1 << 27)   /* follow symlinks on the server, default is not to */
 137 #define AFPVOL_DELVETO   (1 << 28)   /* delete veto files and dirs */
 138
 139 /* Extended Attributes vfs indirection  */
 140 #define AFPVOL_EA_NONE           0   /* No EAs */
 141 #define AFPVOL_EA_AUTO           1   /* try sys, fallback to ad (default) */
 142 #define AFPVOL_EA_SYS            2   /* Store them in native EAs */
 143 #define AFPVOL_EA_AD             3   /* Store them in adouble files */
 144
 145 /* FPGetSrvrParms options */
 146 #define AFPSRVR_CONFIGINFO     (1 << 0)
 147 #define AFPSRVR_PASSWD         (1 << 7)
 148
 149 /* handle casefolding */
 150 #define AFPVOL_MTOUUPPER       (1 << 0)
 151 #define AFPVOL_MTOULOWER       (1 << 1)
 152 #define AFPVOL_UTOMUPPER       (1 << 2)
 153 #define AFPVOL_UTOMLOWER       (1 << 3)
 154 #define AFPVOL_UMLOWER         (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
 155 #define AFPVOL_UMUPPER         (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
 156 #define AFPVOL_UUPPERMLOWER    (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
 157 #define AFPVOL_ULOWERMUPPER    (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
 158
 159 #define AFPVOLSIG_FLAT          0x0001 /* flat fs */
 160 #define AFPVOLSIG_FIX           0x0002 /* fixed ids */
 161 #define AFPVOLSIG_VAR           0x0003 /* variable ids */
 162 #define AFPVOLSIG_DEFAULT       AFPVOLSIG_FIX
 163
 164 /* volume attributes */
 165 #define VOLPBIT_ATTR_RO           (1 << 0)
 166 #define VOLPBIT_ATTR_PASSWD       (1 << 1)
 167 #define VOLPBIT_ATTR_FILEID       (1 << 2)
 168 #define VOLPBIT_ATTR_CATSEARCH    (1 << 3)
 169 #define VOLPBIT_ATTR_BLANKACCESS  (1 << 4)
 170 #define VOLPBIT_ATTR_UNIXPRIV     (1 << 5)
 171 #define VOLPBIT_ATTR_UTF8         (1 << 6)
 172 #define VOLPBIT_ATTR_NONETIDS     (1 << 7)
 173 #define VOLPBIT_ATTR_EXT_ATTRS    (1 << 10)
 174 #define VOLPBIT_ATTR_ACLS         (1 << 11)
 175 #define VOLPBIT_ATTR_TM           (1 << 13)
 176
 177 #define VOLPBIT_ATTR    0
 178 #define VOLPBIT_SIG 1
 179 #define VOLPBIT_CDATE   2
 180 #define VOLPBIT_MDATE   3
 181 #define VOLPBIT_BDATE   4
 182 #define VOLPBIT_VID 5
 183 #define VOLPBIT_BFREE   6
 184 #define VOLPBIT_BTOTAL  7
 185 #define VOLPBIT_NAME    8
 186 /* handle > 4GB volumes */
 187 #define VOLPBIT_XBFREE  9
 188 #define VOLPBIT_XBTOTAL 10
 189 #define VOLPBIT_BSIZE   11        /* block size */
 190
 191 #define utf8_encoding(obj) ((obj)->afp_version >= 30)
 192
 193 #define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
 194 #define vol_unix_priv(vol) ((vol)->v_obj->afp_version >= 30 && ((vol)->v_flags & AFPVOL_UNIX_PRIV))
 195 #define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)
 196 #define vol_syml_opt(vol) (((vol)->v_flags & AFPVOL_FOLLOWSYM) ? 0 : O_NOFOLLOW)
 197
 198 #endif