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