fs/aufs/opts.h

   1 /*
   2  * Copyright (C) 2005-2017 Junjiro R. Okajima
   3  *
   4  * This program, aufs is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * mount options/flags
  20  */
  21
  22 #ifndef __AUFS_OPTS_H__
  23 #define __AUFS_OPTS_H__
  24
  25 #ifdef __KERNEL__
  26
  27 #include <linux/path.h>
  28
  29 struct file;
  30
  31 /* ---------------------------------------------------------------------- */
  32
  33 /* mount flags */
  34 #define AuOpt_XINO              1               /* external inode number bitmap
  35                                                    and translation table */
  36 #define AuOpt_TRUNC_XINO        (1 << 1)        /* truncate xino files */
  37 #define AuOpt_UDBA_NONE         (1 << 2)        /* users direct branch access */
  38 #define AuOpt_UDBA_REVAL        (1 << 3)
  39 #define AuOpt_UDBA_HNOTIFY      (1 << 4)
  40 #define AuOpt_SHWH              (1 << 5)        /* show whiteout */
  41 #define AuOpt_PLINK             (1 << 6)        /* pseudo-link */
  42 #define AuOpt_DIRPERM1          (1 << 7)        /* ignore the lower dir's perm
  43                                                    bits */
  44 #define AuOpt_ALWAYS_DIROPQ     (1 << 9)        /* policy to creating diropq */
  45 #define AuOpt_SUM               (1 << 10)       /* summation for statfs(2) */
  46 #define AuOpt_SUM_W             (1 << 11)       /* unimplemented */
  47 #define AuOpt_WARN_PERM         (1 << 12)       /* warn when add-branch */
  48 #define AuOpt_VERBOSE           (1 << 13)       /* busy inode when del-branch */
  49 #define AuOpt_DIO               (1 << 14)       /* direct io */
  50
  51 #ifndef CONFIG_AUFS_HNOTIFY
  52 #undef AuOpt_UDBA_HNOTIFY
  53 #define AuOpt_UDBA_HNOTIFY      0
  54 #endif
  55 #ifndef CONFIG_AUFS_SHWH
  56 #undef AuOpt_SHWH
  57 #define AuOpt_SHWH              0
  58 #endif
  59
  60 #define AuOpt_Def       (AuOpt_XINO \
  61                          | AuOpt_UDBA_REVAL \
  62                          | AuOpt_PLINK \
  63                          /* | AuOpt_DIRPERM1 */ \
  64                          | AuOpt_WARN_PERM)
  65 #define AuOptMask_UDBA  (AuOpt_UDBA_NONE \
  66                          | AuOpt_UDBA_REVAL \
  67                          | AuOpt_UDBA_HNOTIFY)
  68
  69 #define au_opt_test(flags, name)        (flags & AuOpt_##name)
  70 #define au_opt_set(flags, name) do { \
  71         BUILD_BUG_ON(AuOpt_##name & AuOptMask_UDBA); \
  72         ((flags) |= AuOpt_##name); \
  73 } while (0)
  74 #define au_opt_set_udba(flags, name) do { \
  75         (flags) &= ~AuOptMask_UDBA; \
  76         ((flags) |= AuOpt_##name); \
  77 } while (0)
  78 #define au_opt_clr(flags, name) do { \
  79         ((flags) &= ~AuOpt_##name); \
  80 } while (0)
  81
  82 static inline unsigned int au_opts_plink(unsigned int mntflags)
  83 {
  84 #ifdef CONFIG_PROC_FS
  85         return mntflags;
  86 #else
  87         return mntflags & ~AuOpt_PLINK;
  88 #endif
  89 }
  90
  91 /* ---------------------------------------------------------------------- */
  92
  93 /* policies to select one among multiple writable branches */
  94 enum {
  95         AuWbrCreate_TDP,        /* top down parent */
  96         AuWbrCreate_RR,         /* round robin */
  97         AuWbrCreate_MFS,        /* most free space */
  98         AuWbrCreate_MFSV,       /* mfs with seconds */
  99         AuWbrCreate_MFSRR,      /* mfs then rr */
 100         AuWbrCreate_MFSRRV,     /* mfs then rr with seconds */
 101         AuWbrCreate_TDMFS,      /* top down regardless parent and mfs */
 102         AuWbrCreate_TDMFSV,     /* top down regardless parent and mfs */
 103         AuWbrCreate_PMFS,       /* parent and mfs */
 104         AuWbrCreate_PMFSV,      /* parent and mfs with seconds */
 105         AuWbrCreate_PMFSRR,     /* parent, mfs and round-robin */
 106         AuWbrCreate_PMFSRRV,    /* plus seconds */
 107
 108         AuWbrCreate_Def = AuWbrCreate_TDP
 109 };
 110
 111 enum {
 112         AuWbrCopyup_TDP,        /* top down parent */
 113         AuWbrCopyup_BUP,        /* bottom up parent */
 114         AuWbrCopyup_BU,         /* bottom up */
 115
 116         AuWbrCopyup_Def = AuWbrCopyup_TDP
 117 };
 118
 119 /* ---------------------------------------------------------------------- */
 120
 121 struct au_opt_add {
 122         aufs_bindex_t   bindex;
 123         char            *pathname;
 124         int             perm;
 125         struct path     path;
 126 };
 127
 128 struct au_opt_del {
 129         char            *pathname;
 130         struct path     h_path;
 131 };
 132
 133 struct au_opt_mod {
 134         char            *path;
 135         int             perm;
 136         struct dentry   *h_root;
 137 };
 138
 139 struct au_opt_xino {
 140         char            *path;
 141         struct file     *file;
 142 };
 143
 144 struct au_opt_xino_itrunc {
 145         aufs_bindex_t   bindex;
 146 };
 147
 148 struct au_opt_wbr_create {
 149         int                     wbr_create;
 150         int                     mfs_second;
 151         unsigned long long      mfsrr_watermark;
 152 };
 153
 154 struct au_opt {
 155         int type;
 156         union {
 157                 struct au_opt_xino      xino;
 158                 struct au_opt_xino_itrunc xino_itrunc;
 159                 struct au_opt_add       add;
 160                 struct au_opt_del       del;
 161                 struct au_opt_mod       mod;
 162                 int                     dirwh;
 163                 int                     rdcache;
 164                 unsigned int            rdblk;
 165                 unsigned int            rdhash;
 166                 int                     udba;
 167                 struct au_opt_wbr_create wbr_create;
 168                 int                     wbr_copyup;
 169                 unsigned int            fhsm_second;
 170         };
 171 };
 172
 173 /* opts flags */
 174 #define AuOpts_REMOUNT          1
 175 #define AuOpts_REFRESH          (1 << 1)
 176 #define AuOpts_TRUNC_XIB        (1 << 2)
 177 #define AuOpts_REFRESH_DYAOP    (1 << 3)
 178 #define AuOpts_REFRESH_IDOP     (1 << 4)
 179 #define au_ftest_opts(flags, name)      ((flags) & AuOpts_##name)
 180 #define au_fset_opts(flags, name) \
 181         do { (flags) |= AuOpts_##name; } while (0)
 182 #define au_fclr_opts(flags, name) \
 183         do { (flags) &= ~AuOpts_##name; } while (0)
 184
 185 struct au_opts {
 186         struct au_opt   *opt;
 187         int             max_opt;
 188
 189         unsigned int    given_udba;
 190         unsigned int    flags;
 191         unsigned long   sb_flags;
 192 };
 193
 194 /* ---------------------------------------------------------------------- */
 195
 196 /* opts.c */
 197 void au_optstr_br_perm(au_br_perm_str_t *str, int perm);
 198 const char *au_optstr_udba(int udba);
 199 const char *au_optstr_wbr_copyup(int wbr_copyup);
 200 const char *au_optstr_wbr_create(int wbr_create);
 201
 202 void au_opts_free(struct au_opts *opts);
 203 struct super_block;
 204 int au_opts_parse(struct super_block *sb, char *str, struct au_opts *opts);
 205 int au_opts_verify(struct super_block *sb, unsigned long sb_flags,
 206                    unsigned int pending);
 207 int au_opts_mount(struct super_block *sb, struct au_opts *opts);
 208 int au_opts_remount(struct super_block *sb, struct au_opts *opts);
 209
 210 unsigned int au_opt_udba(struct super_block *sb);
 211
 212 #endif /* __KERNEL__ */
 213 #endif /* __AUFS_OPTS_H__ */