2 * Contains the CIFS DFS referral mounting routines used for handling
3 * traversal via DFS junction point
5 * Copyright (c) 2007 Igor Mammedov
6 * Copyright (C) International Business Machines Corp., 2008
7 * Author(s): Igor Mammedov (niallain@gmail.com)
8 * Steve French (sfrench@us.ibm.com)
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
15 #include <linux/dcache.h>
16 #include <linux/mount.h>
17 #include <linux/namei.h>
18 #include <linux/vfs.h>
21 #include "cifsproto.h"
23 #include "dns_resolve.h"
24 #include "cifs_debug.h"
26 static LIST_HEAD(cifs_dfs_automount_list);
28 static void cifs_dfs_expire_automounts(struct work_struct *work);
29 static DECLARE_DELAYED_WORK(cifs_dfs_automount_task,
30 cifs_dfs_expire_automounts);
31 static int cifs_dfs_mountpoint_expiry_timeout = 500 * HZ;
33 static void cifs_dfs_expire_automounts(struct work_struct *work)
35 struct list_head *list = &cifs_dfs_automount_list;
37 mark_mounts_for_expiry(list);
38 if (!list_empty(list))
39 schedule_delayed_work(&cifs_dfs_automount_task,
40 cifs_dfs_mountpoint_expiry_timeout);
43 void cifs_dfs_release_automount_timer(void)
45 BUG_ON(!list_empty(&cifs_dfs_automount_list));
46 cancel_delayed_work(&cifs_dfs_automount_task);
47 flush_scheduled_work();
51 * cifs_get_share_name - extracts share name from UNC
52 * @node_name: pointer to UNC string
54 * Extracts sharename form full UNC.
55 * i.e. strips from UNC trailing path that is not part of share
56 * name and fixup missing '\' in the begining of DFS node refferal
58 * Returns pointer to share name on success or NULL on error.
59 * Caller is responsible for freeing returned string.
61 static char *cifs_get_share_name(const char *node_name)
67 len = strlen(node_name);
68 UNC = kmalloc(len+2 /*for term null and additional \ if it's missed */,
73 /* get share name and server name */
74 if (node_name[1] != '\\') {
76 strncpy(UNC+1, node_name, len);
80 strncpy(UNC, node_name, len);
84 /* find server name end */
85 pSep = memchr(UNC+2, '\\', len-2);
87 cERROR(1, ("%s: no server name end in node name: %s",
88 __func__, node_name));
93 /* find sharename end */
95 pSep = memchr(UNC+(pSep-UNC), '\\', len-(pSep-UNC));
97 /* trim path up to sharename end
98 * now we have share name in UNC */
107 * cifs_compose_mount_options - creates mount options for refferral
108 * @sb_mountdata: parent/root DFS mount options (template)
109 * @fullpath: full path in UNC format
110 * @ref: server's referral
111 * @devname: pointer for saving device name
113 * creates mount options for submount based on template options sb_mountdata
114 * and replacing unc,ip,prefixpath options with ones we've got form ref_unc.
116 * Returns: pointer to new mount options or ERR_PTR.
117 * Caller is responcible for freeing retunrned value if it is not error.
119 char *cifs_compose_mount_options(const char *sb_mountdata,
120 const char *fullpath,
121 const struct dfs_info3_param *ref,
125 char *mountdata = NULL;
132 if (sb_mountdata == NULL)
133 return ERR_PTR(-EINVAL);
135 *devname = cifs_get_share_name(ref->node_name);
136 rc = dns_resolve_server_name_to_ip(*devname, &srvIP);
138 cERROR(1, ("%s: Failed to resolve server part of %s to IP: %d",
139 __func__, *devname, rc));;
140 goto compose_mount_options_err;
142 /* md_len = strlen(...) + 12 for 'sep+prefixpath='
143 * assuming that we have 'unc=' and 'ip=' in
144 * the original sb_mountdata
146 md_len = strlen(sb_mountdata) + strlen(srvIP) +
147 strlen(ref->node_name) + 12;
148 mountdata = kzalloc(md_len+1, GFP_KERNEL);
149 if (mountdata == NULL) {
151 goto compose_mount_options_err;
154 /* copy all options except of unc,ip,prefixpath */
156 if (strncmp(sb_mountdata, "sep=", 4) == 0) {
157 sep = sb_mountdata[4];
158 strncpy(mountdata, sb_mountdata, 5);
163 tkn_e = strchr(sb_mountdata + off, sep);
165 noff = strlen(sb_mountdata + off);
167 noff = tkn_e - (sb_mountdata + off) + 1;
169 if (strnicmp(sb_mountdata + off, "unc=", 4) == 0) {
173 if (strnicmp(sb_mountdata + off, "ip=", 3) == 0) {
177 if (strnicmp(sb_mountdata + off, "prefixpath=", 11) == 0) {
181 strncat(mountdata, sb_mountdata + off, noff);
184 strcat(mountdata, sb_mountdata + off);
185 mountdata[md_len] = '\0';
187 /* copy new IP and ref share name */
188 if (mountdata[strlen(mountdata) - 1] != sep)
189 strncat(mountdata, &sep, 1);
190 strcat(mountdata, "ip=");
191 strcat(mountdata, srvIP);
192 strncat(mountdata, &sep, 1);
193 strcat(mountdata, "unc=");
194 strcat(mountdata, *devname);
196 /* find & copy prefixpath */
197 tkn_e = strchr(ref->node_name + 2, '\\');
199 /* invalid unc, missing share name*/
201 goto compose_mount_options_err;
204 tkn_e = strchr(tkn_e + 1, '\\');
205 if (tkn_e || (strlen(fullpath) - ref->path_consumed)) {
206 strncat(mountdata, &sep, 1);
207 strcat(mountdata, "prefixpath=");
209 strcat(mountdata, tkn_e + 1);
210 strcat(mountdata, fullpath + ref->path_consumed);
213 /*cFYI(1,("%s: parent mountdata: %s", __func__,sb_mountdata));*/
214 /*cFYI(1, ("%s: submount mountdata: %s", __func__, mountdata ));*/
216 compose_mount_options_out:
220 compose_mount_options_err:
222 mountdata = ERR_PTR(rc);
223 goto compose_mount_options_out;
227 static struct vfsmount *cifs_dfs_do_refmount(const struct vfsmount *mnt_parent,
228 struct dentry *dentry, const struct dfs_info3_param *ref)
230 struct cifs_sb_info *cifs_sb;
231 struct vfsmount *mnt;
233 char *devname = NULL;
236 cifs_sb = CIFS_SB(dentry->d_inode->i_sb);
238 * this function gives us a path with a double backslash prefix. We
239 * require a single backslash for DFS.
241 fullpath = build_path_from_dentry(dentry);
243 return ERR_PTR(-ENOMEM);
245 mountdata = cifs_compose_mount_options(cifs_sb->mountdata,
246 fullpath + 1, ref, &devname);
249 if (IS_ERR(mountdata))
250 return (struct vfsmount *)mountdata;
252 mnt = vfs_kern_mount(&cifs_fs_type, 0, devname, mountdata);
259 static int add_mount_helper(struct vfsmount *newmnt, struct nameidata *nd,
260 struct list_head *mntlist)
262 /* stolen from afs code */
266 err = do_add_mount(newmnt, &nd->path, nd->path.mnt->mnt_flags, mntlist);
270 nd->path.mnt = newmnt;
271 nd->path.dentry = dget(newmnt->mnt_root);
272 schedule_delayed_work(&cifs_dfs_automount_task,
273 cifs_dfs_mountpoint_expiry_timeout);
276 /* someone else made a mount here whilst we were busy */
277 while (d_mountpoint(nd->path.dentry) &&
278 follow_down(&nd->path))
288 static void dump_referral(const struct dfs_info3_param *ref)
290 cFYI(1, ("DFS: ref path: %s", ref->path_name));
291 cFYI(1, ("DFS: node path: %s", ref->node_name));
292 cFYI(1, ("DFS: fl: %hd, srv_type: %hd", ref->flags, ref->server_type));
293 cFYI(1, ("DFS: ref_flags: %hd, path_consumed: %hd", ref->ref_flag,
294 ref->path_consumed));
299 cifs_dfs_follow_mountpoint(struct dentry *dentry, struct nameidata *nd)
301 struct dfs_info3_param *referrals = NULL;
302 unsigned int num_referrals = 0;
303 struct cifs_sb_info *cifs_sb;
304 struct cifsSesInfo *ses;
305 char *full_path = NULL;
308 struct vfsmount *mnt = ERR_PTR(-ENOENT);
310 cFYI(1, ("in %s", __func__));
311 BUG_ON(IS_ROOT(dentry));
315 dput(nd->path.dentry);
316 nd->path.dentry = dget(dentry);
318 cifs_sb = CIFS_SB(dentry->d_inode->i_sb);
319 ses = cifs_sb->tcon->ses;
327 * The MSDFS spec states that paths in DFS referral requests and
328 * responses must be prefixed by a single '\' character instead of
329 * the double backslashes usually used in the UNC. This function
330 * gives us the latter, so we must adjust the result.
332 full_path = build_path_from_dentry(dentry);
333 if (full_path == NULL) {
338 rc = get_dfs_path(xid, ses , full_path + 1, cifs_sb->local_nls,
339 &num_referrals, &referrals,
340 cifs_sb->mnt_cifs_flags & CIFS_MOUNT_MAP_SPECIAL_CHR);
342 for (i = 0; i < num_referrals; i++) {
344 dump_referral(referrals+i);
345 /* connect to a node */
346 len = strlen(referrals[i].node_name);
348 cERROR(1, ("%s: Net Address path too short: %s",
349 __func__, referrals[i].node_name));
353 mnt = cifs_dfs_do_refmount(nd->path.mnt,
354 nd->path.dentry, referrals + i);
355 cFYI(1, ("%s: cifs_dfs_do_refmount:%s , mnt:%p", __func__,
356 referrals[i].node_name, mnt));
358 /* complete mount procedure if we accured submount */
363 /* we need it cause for() above could exit without valid submount */
368 nd->path.mnt->mnt_flags |= MNT_SHRINKABLE;
369 rc = add_mount_helper(mnt, nd, &cifs_dfs_automount_list);
373 free_dfs_info_array(referrals, num_referrals);
375 cFYI(1, ("leaving %s" , __func__));
382 struct inode_operations cifs_dfs_referral_inode_operations = {
383 .follow_link = cifs_dfs_follow_mountpoint,