fs: switch ->s_uuid to uuid_t
[linux-block.git] / fs / overlayfs / overlayfs.h
CommitLineData
e9be9d5e
MS
1/*
2 *
3 * Copyright (C) 2011 Novell Inc.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
8 */
9
10#include <linux/kernel.h>
3a1e819b 11#include <linux/uuid.h>
e9be9d5e 12
e9be9d5e 13enum ovl_path_type {
38e813db
MS
14 __OVL_PATH_UPPER = (1 << 0),
15 __OVL_PATH_MERGE = (1 << 1),
59548503 16 __OVL_PATH_ORIGIN = (1 << 2),
e9be9d5e
MS
17};
18
1afaba1e
MS
19#define OVL_TYPE_UPPER(type) ((type) & __OVL_PATH_UPPER)
20#define OVL_TYPE_MERGE(type) ((type) & __OVL_PATH_MERGE)
59548503 21#define OVL_TYPE_ORIGIN(type) ((type) & __OVL_PATH_ORIGIN)
d837a49b 22
fe2b7595
AG
23#define OVL_XATTR_PREFIX XATTR_TRUSTED_PREFIX "overlay."
24#define OVL_XATTR_OPAQUE OVL_XATTR_PREFIX "opaque"
02b69b28 25#define OVL_XATTR_REDIRECT OVL_XATTR_PREFIX "redirect"
3a1e819b 26#define OVL_XATTR_ORIGIN OVL_XATTR_PREFIX "origin"
ee1d6d37 27#define OVL_XATTR_IMPURE OVL_XATTR_PREFIX "impure"
3a1e819b
AG
28
29/*
30 * The tuple (fh,uuid) is a universal unique identifier for a copy up origin,
31 * where:
32 * origin.fh - exported file handle of the lower file
33 * origin.uuid - uuid of the lower filesystem
34 */
35#define OVL_FH_VERSION 0
36#define OVL_FH_MAGIC 0xfb
37
38/* CPU byte order required for fid decoding: */
39#define OVL_FH_FLAG_BIG_ENDIAN (1 << 0)
40#define OVL_FH_FLAG_ANY_ENDIAN (1 << 1)
41
42#define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN)
43
44#if defined(__LITTLE_ENDIAN)
45#define OVL_FH_FLAG_CPU_ENDIAN 0
46#elif defined(__BIG_ENDIAN)
47#define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN
48#else
49#error Endianness not defined
50#endif
51
52/* On-disk and in-memeory format for redirect by file handle */
53struct ovl_fh {
54 u8 version; /* 0 */
55 u8 magic; /* 0xfb */
56 u8 len; /* size of this header + size of fid */
57 u8 flags; /* OVL_FH_FLAG_* */
58 u8 type; /* fid_type of fid */
59 uuid_be uuid; /* uuid of filesystem */
60 u8 fid[0]; /* file identifier */
61} __packed;
e9be9d5e 62
39b681f8
MS
63#define OVL_ISUPPER_MASK 1UL
64
e9be9d5e
MS
65static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry)
66{
67 int err = vfs_rmdir(dir, dentry);
68 pr_debug("rmdir(%pd2) = %i\n", dentry, err);
69 return err;
70}
71
72static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry)
73{
74 int err = vfs_unlink(dir, dentry, NULL);
75 pr_debug("unlink(%pd2) = %i\n", dentry, err);
76 return err;
77}
78
79static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir,
80 struct dentry *new_dentry, bool debug)
81{
82 int err = vfs_link(old_dentry, dir, new_dentry, NULL);
83 if (debug) {
84 pr_debug("link(%pd2, %pd2) = %i\n",
85 old_dentry, new_dentry, err);
86 }
87 return err;
88}
89
90static inline int ovl_do_create(struct inode *dir, struct dentry *dentry,
91 umode_t mode, bool debug)
92{
93 int err = vfs_create(dir, dentry, mode, true);
94 if (debug)
95 pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
96 return err;
97}
98
99static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry,
100 umode_t mode, bool debug)
101{
102 int err = vfs_mkdir(dir, dentry, mode);
103 if (debug)
104 pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
105 return err;
106}
107
108static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry,
109 umode_t mode, dev_t dev, bool debug)
110{
111 int err = vfs_mknod(dir, dentry, mode, dev);
112 if (debug) {
113 pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n",
114 dentry, mode, dev, err);
115 }
116 return err;
117}
118
119static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry,
120 const char *oldname, bool debug)
121{
122 int err = vfs_symlink(dir, dentry, oldname);
123 if (debug)
124 pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
125 return err;
126}
127
128static inline int ovl_do_setxattr(struct dentry *dentry, const char *name,
129 const void *value, size_t size, int flags)
130{
131 int err = vfs_setxattr(dentry, name, value, size, flags);
132 pr_debug("setxattr(%pd2, \"%s\", \"%*s\", 0x%x) = %i\n",
133 dentry, name, (int) size, (char *) value, flags, err);
134 return err;
135}
136
137static inline int ovl_do_removexattr(struct dentry *dentry, const char *name)
138{
139 int err = vfs_removexattr(dentry, name);
140 pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
141 return err;
142}
143
144static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry,
145 struct inode *newdir, struct dentry *newdentry,
146 unsigned int flags)
147{
148 int err;
149
2773bf00 150 pr_debug("rename(%pd2, %pd2, 0x%x)\n",
e9be9d5e
MS
151 olddentry, newdentry, flags);
152
153 err = vfs_rename(olddir, olddentry, newdir, newdentry, NULL, flags);
154
155 if (err) {
2773bf00 156 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
e9be9d5e
MS
157 olddentry, newdentry, err);
158 }
159 return err;
160}
161
162static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry)
163{
164 int err = vfs_whiteout(dir, dentry);
165 pr_debug("whiteout(%pd2) = %i\n", dentry, err);
166 return err;
167}
168
e7f52429
AG
169static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode)
170{
171 struct dentry *ret = vfs_tmpfile(dentry, mode, 0);
172 int err = IS_ERR(ret) ? PTR_ERR(ret) : 0;
173
174 pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
175 return ret;
176}
177
39b681f8
MS
178static inline struct inode *ovl_inode_real(struct inode *inode, bool *is_upper)
179{
180 unsigned long x = (unsigned long) READ_ONCE(inode->i_private);
181
182 if (is_upper)
183 *is_upper = x & OVL_ISUPPER_MASK;
184
185 return (struct inode *) (x & ~OVL_ISUPPER_MASK);
186}
187
bbb1e54d
MS
188/* util.c */
189int ovl_want_write(struct dentry *dentry);
190void ovl_drop_write(struct dentry *dentry);
191struct dentry *ovl_workdir(struct dentry *dentry);
192const struct cred *ovl_override_creds(struct super_block *sb);
7bcd74b9 193struct super_block *ovl_same_sb(struct super_block *sb);
bbb1e54d
MS
194struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
195bool ovl_dentry_remote(struct dentry *dentry);
196bool ovl_dentry_weird(struct dentry *dentry);
e9be9d5e 197enum ovl_path_type ovl_path_type(struct dentry *dentry);
e9be9d5e
MS
198void ovl_path_upper(struct dentry *dentry, struct path *path);
199void ovl_path_lower(struct dentry *dentry, struct path *path);
200enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
201struct dentry *ovl_dentry_upper(struct dentry *dentry);
202struct dentry *ovl_dentry_lower(struct dentry *dentry);
203struct dentry *ovl_dentry_real(struct dentry *dentry);
e9be9d5e
MS
204struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry);
205void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache);
e9be9d5e 206bool ovl_dentry_is_opaque(struct dentry *dentry);
ee1d6d37 207bool ovl_dentry_is_impure(struct dentry *dentry);
c412ce49 208bool ovl_dentry_is_whiteout(struct dentry *dentry);
5cf5b477 209void ovl_dentry_set_opaque(struct dentry *dentry);
a6c60655 210bool ovl_redirect_dir(struct super_block *sb);
a6c60655
MS
211const char *ovl_dentry_get_redirect(struct dentry *dentry);
212void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
e9be9d5e 213void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry);
bbb1e54d
MS
214void ovl_inode_init(struct inode *inode, struct inode *realinode,
215 bool is_upper);
39b681f8 216void ovl_inode_update(struct inode *inode, struct inode *upperinode);
bbb1e54d
MS
217void ovl_dentry_version_inc(struct dentry *dentry);
218u64 ovl_dentry_version_get(struct dentry *dentry);
219bool ovl_is_whiteout(struct dentry *dentry);
e9be9d5e 220struct file *ovl_path_open(struct path *path, int flags);
39d3d60a
AG
221int ovl_copy_up_start(struct dentry *dentry);
222void ovl_copy_up_end(struct dentry *dentry);
f3a15685
AG
223bool ovl_check_dir_xattr(struct dentry *dentry, const char *name);
224int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry,
225 const char *name, const void *value, size_t size,
226 int xerr);
227int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry);
228
229static inline bool ovl_is_impuredir(struct dentry *dentry)
230{
231 return ovl_check_dir_xattr(dentry, OVL_XATTR_IMPURE);
232}
233
e9be9d5e 234
bbb1e54d
MS
235/* namei.c */
236int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
237struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags);
238bool ovl_lower_positive(struct dentry *dentry);
e9be9d5e
MS
239
240/* readdir.c */
241extern const struct file_operations ovl_dir_operations;
242int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
243void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list);
244void ovl_cache_free(struct list_head *list);
45aebeaf 245int ovl_check_d_type_supported(struct path *realpath);
eea2fb48
MS
246void ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt,
247 struct dentry *dentry, int level);
e9be9d5e
MS
248
249/* inode.c */
250int ovl_setattr(struct dentry *dentry, struct iattr *attr);
5b712091
MS
251int ovl_getattr(const struct path *path, struct kstat *stat,
252 u32 request_mask, unsigned int flags);
e9be9d5e 253int ovl_permission(struct inode *inode, int mask);
0e585ccc
AG
254int ovl_xattr_set(struct dentry *dentry, const char *name, const void *value,
255 size_t size, int flags);
0eb45fc3
AG
256int ovl_xattr_get(struct dentry *dentry, const char *name,
257 void *value, size_t size);
e9be9d5e 258ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
39a25b2b 259struct posix_acl *ovl_get_acl(struct inode *inode, int type);
2d902671 260int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags);
d719e8f2 261int ovl_update_time(struct inode *inode, struct timespec *ts, int flags);
0956254a 262bool ovl_is_private_xattr(const char *name);
e9be9d5e 263
ca4c8a3a 264struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
51f7e52d 265struct inode *ovl_get_inode(struct super_block *sb, struct inode *realinode);
e9be9d5e
MS
266static inline void ovl_copyattr(struct inode *from, struct inode *to)
267{
268 to->i_uid = from->i_uid;
269 to->i_gid = from->i_gid;
07a2daab 270 to->i_mode = from->i_mode;
d719e8f2
MS
271 to->i_atime = from->i_atime;
272 to->i_mtime = from->i_mtime;
273 to->i_ctime = from->i_ctime;
e9be9d5e
MS
274}
275
276/* dir.c */
277extern const struct inode_operations ovl_dir_inode_operations;
3d27573c 278struct dentry *ovl_lookup_temp(struct dentry *workdir);
32a3d848
AV
279struct cattr {
280 dev_t rdev;
281 umode_t mode;
282 const char *link;
283};
e9be9d5e 284int ovl_create_real(struct inode *dir, struct dentry *newdentry,
32a3d848 285 struct cattr *attr,
e9be9d5e
MS
286 struct dentry *hardlink, bool debug);
287void ovl_cleanup(struct inode *dir, struct dentry *dentry);
288
289/* copy_up.c */
290int ovl_copy_up(struct dentry *dentry);
9aba6521 291int ovl_copy_up_flags(struct dentry *dentry, int flags);
e9be9d5e
MS
292int ovl_copy_xattr(struct dentry *old, struct dentry *new);
293int ovl_set_attr(struct dentry *upper, struct kstat *stat);