GNU Linux-libre 4.4.289-gnu1
[releases.git] / fs / nfs / namespace.c
1 /*
2  * linux/fs/nfs/namespace.c
3  *
4  * Copyright (C) 2005 Trond Myklebust <Trond.Myklebust@netapp.com>
5  * - Modified by David Howells <dhowells@redhat.com>
6  *
7  * NFS namespace
8  */
9
10 #include <linux/module.h>
11 #include <linux/dcache.h>
12 #include <linux/gfp.h>
13 #include <linux/mount.h>
14 #include <linux/namei.h>
15 #include <linux/nfs_fs.h>
16 #include <linux/string.h>
17 #include <linux/sunrpc/clnt.h>
18 #include <linux/vfs.h>
19 #include <linux/sunrpc/gss_api.h>
20 #include "internal.h"
21
22 #define NFSDBG_FACILITY         NFSDBG_VFS
23
24 static void nfs_expire_automounts(struct work_struct *work);
25
26 static LIST_HEAD(nfs_automount_list);
27 static DECLARE_DELAYED_WORK(nfs_automount_task, nfs_expire_automounts);
28 int nfs_mountpoint_expiry_timeout = 500 * HZ;
29
30 /*
31  * nfs_path - reconstruct the path given an arbitrary dentry
32  * @base - used to return pointer to the end of devname part of path
33  * @dentry_in - pointer to dentry
34  * @buffer - result buffer
35  * @buflen_in - length of buffer
36  * @flags - options (see below)
37  *
38  * Helper function for constructing the server pathname
39  * by arbitrary hashed dentry.
40  *
41  * This is mainly for use in figuring out the path on the
42  * server side when automounting on top of an existing partition
43  * and in generating /proc/mounts and friends.
44  *
45  * Supported flags:
46  * NFS_PATH_CANONICAL: ensure there is exactly one slash after
47  *                     the original device (export) name
48  *                     (if unset, the original name is returned verbatim)
49  */
50 char *nfs_path(char **p, struct dentry *dentry_in, char *buffer,
51                ssize_t buflen_in, unsigned flags)
52 {
53         char *end;
54         int namelen;
55         unsigned seq;
56         const char *base;
57         struct dentry *dentry;
58         ssize_t buflen;
59
60 rename_retry:
61         buflen = buflen_in;
62         dentry = dentry_in;
63         end = buffer+buflen;
64         *--end = '\0';
65         buflen--;
66
67         seq = read_seqbegin(&rename_lock);
68         rcu_read_lock();
69         while (1) {
70                 spin_lock(&dentry->d_lock);
71                 if (IS_ROOT(dentry))
72                         break;
73                 namelen = dentry->d_name.len;
74                 buflen -= namelen + 1;
75                 if (buflen < 0)
76                         goto Elong_unlock;
77                 end -= namelen;
78                 memcpy(end, dentry->d_name.name, namelen);
79                 *--end = '/';
80                 spin_unlock(&dentry->d_lock);
81                 dentry = dentry->d_parent;
82         }
83         if (read_seqretry(&rename_lock, seq)) {
84                 spin_unlock(&dentry->d_lock);
85                 rcu_read_unlock();
86                 goto rename_retry;
87         }
88         if ((flags & NFS_PATH_CANONICAL) && *end != '/') {
89                 if (--buflen < 0) {
90                         spin_unlock(&dentry->d_lock);
91                         rcu_read_unlock();
92                         goto Elong;
93                 }
94                 *--end = '/';
95         }
96         *p = end;
97         base = dentry->d_fsdata;
98         if (!base) {
99                 spin_unlock(&dentry->d_lock);
100                 rcu_read_unlock();
101                 WARN_ON(1);
102                 return end;
103         }
104         namelen = strlen(base);
105         if (flags & NFS_PATH_CANONICAL) {
106                 /* Strip off excess slashes in base string */
107                 while (namelen > 0 && base[namelen - 1] == '/')
108                         namelen--;
109         }
110         buflen -= namelen;
111         if (buflen < 0) {
112                 spin_unlock(&dentry->d_lock);
113                 rcu_read_unlock();
114                 goto Elong;
115         }
116         end -= namelen;
117         memcpy(end, base, namelen);
118         spin_unlock(&dentry->d_lock);
119         rcu_read_unlock();
120         return end;
121 Elong_unlock:
122         spin_unlock(&dentry->d_lock);
123         rcu_read_unlock();
124         if (read_seqretry(&rename_lock, seq))
125                 goto rename_retry;
126 Elong:
127         return ERR_PTR(-ENAMETOOLONG);
128 }
129 EXPORT_SYMBOL_GPL(nfs_path);
130
131 /*
132  * nfs_d_automount - Handle crossing a mountpoint on the server
133  * @path - The mountpoint
134  *
135  * When we encounter a mountpoint on the server, we want to set up
136  * a mountpoint on the client too, to prevent inode numbers from
137  * colliding, and to allow "df" to work properly.
138  * On NFSv4, we also want to allow for the fact that different
139  * filesystems may be migrated to different servers in a failover
140  * situation, and that different filesystems may want to use
141  * different security flavours.
142  */
143 struct vfsmount *nfs_d_automount(struct path *path)
144 {
145         struct vfsmount *mnt;
146         struct nfs_server *server = NFS_SERVER(d_inode(path->dentry));
147         struct nfs_fh *fh = NULL;
148         struct nfs_fattr *fattr = NULL;
149
150         dprintk("--> nfs_d_automount()\n");
151
152         mnt = ERR_PTR(-ESTALE);
153         if (IS_ROOT(path->dentry))
154                 goto out_nofree;
155
156         mnt = ERR_PTR(-ENOMEM);
157         fh = nfs_alloc_fhandle();
158         fattr = nfs_alloc_fattr();
159         if (fh == NULL || fattr == NULL)
160                 goto out;
161
162         dprintk("%s: enter\n", __func__);
163
164         mnt = server->nfs_client->rpc_ops->submount(server, path->dentry, fh, fattr);
165         if (IS_ERR(mnt))
166                 goto out;
167
168         dprintk("%s: done, success\n", __func__);
169         mntget(mnt); /* prevent immediate expiration */
170         mnt_set_expiry(mnt, &nfs_automount_list);
171         schedule_delayed_work(&nfs_automount_task, nfs_mountpoint_expiry_timeout);
172
173 out:
174         nfs_free_fattr(fattr);
175         nfs_free_fhandle(fh);
176 out_nofree:
177         if (IS_ERR(mnt))
178                 dprintk("<-- %s(): error %ld\n", __func__, PTR_ERR(mnt));
179         else
180                 dprintk("<-- %s() = %p\n", __func__, mnt);
181         return mnt;
182 }
183
184 static int
185 nfs_namespace_getattr(struct vfsmount *mnt, struct dentry *dentry, struct kstat *stat)
186 {
187         if (NFS_FH(d_inode(dentry))->size != 0)
188                 return nfs_getattr(mnt, dentry, stat);
189         generic_fillattr(d_inode(dentry), stat);
190         return 0;
191 }
192
193 static int
194 nfs_namespace_setattr(struct dentry *dentry, struct iattr *attr)
195 {
196         if (NFS_FH(d_inode(dentry))->size != 0)
197                 return nfs_setattr(dentry, attr);
198         return -EACCES;
199 }
200
201 const struct inode_operations nfs_mountpoint_inode_operations = {
202         .getattr        = nfs_getattr,
203         .setattr        = nfs_setattr,
204 };
205
206 const struct inode_operations nfs_referral_inode_operations = {
207         .getattr        = nfs_namespace_getattr,
208         .setattr        = nfs_namespace_setattr,
209 };
210
211 static void nfs_expire_automounts(struct work_struct *work)
212 {
213         struct list_head *list = &nfs_automount_list;
214
215         mark_mounts_for_expiry(list);
216         if (!list_empty(list))
217                 schedule_delayed_work(&nfs_automount_task, nfs_mountpoint_expiry_timeout);
218 }
219
220 void nfs_release_automount_timer(void)
221 {
222         if (list_empty(&nfs_automount_list))
223                 cancel_delayed_work(&nfs_automount_task);
224 }
225
226 /*
227  * Clone a mountpoint of the appropriate type
228  */
229 static struct vfsmount *nfs_do_clone_mount(struct nfs_server *server,
230                                            const char *devname,
231                                            struct nfs_clone_mount *mountdata)
232 {
233         return vfs_kern_mount(&nfs_xdev_fs_type, 0, devname, mountdata);
234 }
235
236 /**
237  * nfs_do_submount - set up mountpoint when crossing a filesystem boundary
238  * @dentry - parent directory
239  * @fh - filehandle for new root dentry
240  * @fattr - attributes for new root inode
241  * @authflavor - security flavor to use when performing the mount
242  *
243  */
244 struct vfsmount *nfs_do_submount(struct dentry *dentry, struct nfs_fh *fh,
245                                  struct nfs_fattr *fattr, rpc_authflavor_t authflavor)
246 {
247         struct nfs_clone_mount mountdata = {
248                 .sb = dentry->d_sb,
249                 .dentry = dentry,
250                 .fh = fh,
251                 .fattr = fattr,
252                 .authflavor = authflavor,
253         };
254         struct vfsmount *mnt = ERR_PTR(-ENOMEM);
255         char *page = (char *) __get_free_page(GFP_USER);
256         char *devname;
257
258         dprintk("--> nfs_do_submount()\n");
259
260         dprintk("%s: submounting on %pd2\n", __func__,
261                         dentry);
262         if (page == NULL)
263                 goto out;
264         devname = nfs_devname(dentry, page, PAGE_SIZE);
265         mnt = (struct vfsmount *)devname;
266         if (IS_ERR(devname))
267                 goto free_page;
268         mnt = nfs_do_clone_mount(NFS_SB(dentry->d_sb), devname, &mountdata);
269 free_page:
270         free_page((unsigned long)page);
271 out:
272         dprintk("%s: done\n", __func__);
273
274         dprintk("<-- nfs_do_submount() = %p\n", mnt);
275         return mnt;
276 }
277 EXPORT_SYMBOL_GPL(nfs_do_submount);
278
279 struct vfsmount *nfs_submount(struct nfs_server *server, struct dentry *dentry,
280                               struct nfs_fh *fh, struct nfs_fattr *fattr)
281 {
282         int err;
283         struct dentry *parent = dget_parent(dentry);
284
285         /* Look it up again to get its attributes */
286         err = server->nfs_client->rpc_ops->lookup(d_inode(parent), &dentry->d_name, fh, fattr, NULL);
287         dput(parent);
288         if (err != 0)
289                 return ERR_PTR(err);
290
291         return nfs_do_submount(dentry, fh, fattr, server->client->cl_auth->au_flavor);
292 }
293 EXPORT_SYMBOL_GPL(nfs_submount);