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