[CIFS] cifs: Rename cERROR and cFYI to cifs_dbg
[deliverable/linux.git] / fs / cifs / cifs_dfs_ref.c
CommitLineData
6d5ae0de
IM
1/*
2 * Contains the CIFS DFS referral mounting routines used for handling
3 * traversal via DFS junction point
4 *
5 * Copyright (c) 2007 Igor Mammedov
366781c1 6 * Copyright (C) International Business Machines Corp., 2008
6d5ae0de 7 * Author(s): Igor Mammedov (niallain@gmail.com)
366781c1 8 * Steve French (sfrench@us.ibm.com)
6d5ae0de
IM
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.
13 */
14
15#include <linux/dcache.h>
16#include <linux/mount.h>
17#include <linux/namei.h>
5a0e3ad6 18#include <linux/slab.h>
6d5ae0de
IM
19#include <linux/vfs.h>
20#include <linux/fs.h>
21#include "cifsglob.h"
22#include "cifsproto.h"
23#include "cifsfs.h"
24#include "dns_resolve.h"
25#include "cifs_debug.h"
26
8d142137 27static LIST_HEAD(cifs_dfs_automount_list);
6d5ae0de 28
78d31a3a
IM
29static void cifs_dfs_expire_automounts(struct work_struct *work);
30static DECLARE_DELAYED_WORK(cifs_dfs_automount_task,
31 cifs_dfs_expire_automounts);
32static int cifs_dfs_mountpoint_expiry_timeout = 500 * HZ;
33
34static void cifs_dfs_expire_automounts(struct work_struct *work)
35{
36 struct list_head *list = &cifs_dfs_automount_list;
37
38 mark_mounts_for_expiry(list);
39 if (!list_empty(list))
40 schedule_delayed_work(&cifs_dfs_automount_task,
41 cifs_dfs_mountpoint_expiry_timeout);
42}
6d5ae0de 43
78d31a3a 44void cifs_dfs_release_automount_timer(void)
6d5ae0de 45{
78d31a3a 46 BUG_ON(!list_empty(&cifs_dfs_automount_list));
3e24e132 47 cancel_delayed_work_sync(&cifs_dfs_automount_task);
6d5ae0de
IM
48}
49
50/**
51 * cifs_get_share_name - extracts share name from UNC
52 * @node_name: pointer to UNC string
53 *
54 * Extracts sharename form full UNC.
55 * i.e. strips from UNC trailing path that is not part of share
25985edc 56 * name and fixup missing '\' in the beginning of DFS node refferal
3ad2f3fb 57 * if necessary.
7b91e266 58 * Returns pointer to share name on success or ERR_PTR on error.
6d5ae0de
IM
59 * Caller is responsible for freeing returned string.
60 */
61static char *cifs_get_share_name(const char *node_name)
62{
63 int len;
64 char *UNC;
65 char *pSep;
66
67 len = strlen(node_name);
68 UNC = kmalloc(len+2 /*for term null and additional \ if it's missed */,
69 GFP_KERNEL);
70 if (!UNC)
7b91e266 71 return ERR_PTR(-ENOMEM);
6d5ae0de
IM
72
73 /* get share name and server name */
74 if (node_name[1] != '\\') {
75 UNC[0] = '\\';
76 strncpy(UNC+1, node_name, len);
77 len++;
78 UNC[len] = 0;
79 } else {
80 strncpy(UNC, node_name, len);
81 UNC[len] = 0;
82 }
83
84 /* find server name end */
85 pSep = memchr(UNC+2, '\\', len-2);
86 if (!pSep) {
f96637be
JP
87 cifs_dbg(VFS, "%s: no server name end in node name: %s\n",
88 __func__, node_name);
6d5ae0de 89 kfree(UNC);
7b91e266 90 return ERR_PTR(-EINVAL);
6d5ae0de
IM
91 }
92
93 /* find sharename end */
94 pSep++;
95 pSep = memchr(UNC+(pSep-UNC), '\\', len-(pSep-UNC));
bf62fd88
IM
96 if (pSep) {
97 /* trim path up to sharename end
98 * now we have share name in UNC */
99 *pSep = 0;
6d5ae0de 100 }
6d5ae0de
IM
101
102 return UNC;
103}
104
105
106/**
c6c00919 107 * cifs_compose_mount_options - creates mount options for refferral
6d5ae0de 108 * @sb_mountdata: parent/root DFS mount options (template)
c6c00919 109 * @fullpath: full path in UNC format
2c55608f 110 * @ref: server's referral
6d5ae0de
IM
111 * @devname: pointer for saving device name
112 *
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.
115 *
116 * Returns: pointer to new mount options or ERR_PTR.
117 * Caller is responcible for freeing retunrned value if it is not error.
118 */
c6c00919
SF
119char *cifs_compose_mount_options(const char *sb_mountdata,
120 const char *fullpath,
2c55608f 121 const struct dfs_info3_param *ref,
366781c1 122 char **devname)
6d5ae0de
IM
123{
124 int rc;
c6fbba05 125 char *mountdata = NULL;
6d5ae0de
IM
126 int md_len;
127 char *tkn_e;
128 char *srvIP = NULL;
129 char sep = ',';
130 int off, noff;
131
132 if (sb_mountdata == NULL)
133 return ERR_PTR(-EINVAL);
134
2c55608f 135 *devname = cifs_get_share_name(ref->node_name);
7b91e266
JL
136 if (IS_ERR(*devname)) {
137 rc = PTR_ERR(*devname);
138 *devname = NULL;
139 goto compose_mount_options_err;
140 }
141
6d5ae0de 142 rc = dns_resolve_server_name_to_ip(*devname, &srvIP);
67b7626a 143 if (rc < 0) {
f96637be
JP
144 cifs_dbg(FYI, "%s: Failed to resolve server part of %s to IP: %d\n",
145 __func__, *devname, rc);
c6fbba05 146 goto compose_mount_options_err;
6d5ae0de 147 }
b8028983 148
2c55608f
IM
149 /* md_len = strlen(...) + 12 for 'sep+prefixpath='
150 * assuming that we have 'unc=' and 'ip=' in
151 * the original sb_mountdata
152 */
67b7626a 153 md_len = strlen(sb_mountdata) + rc + strlen(ref->node_name) + 12;
6d5ae0de
IM
154 mountdata = kzalloc(md_len+1, GFP_KERNEL);
155 if (mountdata == NULL) {
c6fbba05
SF
156 rc = -ENOMEM;
157 goto compose_mount_options_err;
6d5ae0de
IM
158 }
159
160 /* copy all options except of unc,ip,prefixpath */
161 off = 0;
162 if (strncmp(sb_mountdata, "sep=", 4) == 0) {
163 sep = sb_mountdata[4];
164 strncpy(mountdata, sb_mountdata, 5);
165 off += 5;
166 }
2c55608f
IM
167
168 do {
169 tkn_e = strchr(sb_mountdata + off, sep);
170 if (tkn_e == NULL)
171 noff = strlen(sb_mountdata + off);
172 else
173 noff = tkn_e - (sb_mountdata + off) + 1;
174
175 if (strnicmp(sb_mountdata + off, "unc=", 4) == 0) {
6d5ae0de
IM
176 off += noff;
177 continue;
178 }
2c55608f 179 if (strnicmp(sb_mountdata + off, "ip=", 3) == 0) {
6d5ae0de
IM
180 off += noff;
181 continue;
182 }
2c55608f 183 if (strnicmp(sb_mountdata + off, "prefixpath=", 11) == 0) {
6d5ae0de
IM
184 off += noff;
185 continue;
186 }
2c55608f 187 strncat(mountdata, sb_mountdata + off, noff);
6d5ae0de 188 off += noff;
2c55608f
IM
189 } while (tkn_e);
190 strcat(mountdata, sb_mountdata + off);
6d5ae0de
IM
191 mountdata[md_len] = '\0';
192
193 /* copy new IP and ref share name */
2c55608f
IM
194 if (mountdata[strlen(mountdata) - 1] != sep)
195 strncat(mountdata, &sep, 1);
196 strcat(mountdata, "ip=");
6d5ae0de 197 strcat(mountdata, srvIP);
2c55608f
IM
198 strncat(mountdata, &sep, 1);
199 strcat(mountdata, "unc=");
6d5ae0de
IM
200 strcat(mountdata, *devname);
201
202 /* find & copy prefixpath */
2c55608f 203 tkn_e = strchr(ref->node_name + 2, '\\');
c6fbba05
SF
204 if (tkn_e == NULL) {
205 /* invalid unc, missing share name*/
206 rc = -EINVAL;
207 goto compose_mount_options_err;
208 }
2c55608f 209
2c55608f 210 tkn_e = strchr(tkn_e + 1, '\\');
c6fbba05 211 if (tkn_e || (strlen(fullpath) - ref->path_consumed)) {
2c55608f
IM
212 strncat(mountdata, &sep, 1);
213 strcat(mountdata, "prefixpath=");
214 if (tkn_e)
215 strcat(mountdata, tkn_e + 1);
c6fbba05 216 strcat(mountdata, fullpath + ref->path_consumed);
6d5ae0de
IM
217 }
218
f96637be
JP
219 /*cifs_dbg(FYI, "%s: parent mountdata: %s\n", __func__, sb_mountdata);*/
220 /*cifs_dbg(FYI, "%s: submount mountdata: %s\n", __func__, mountdata );*/
6d5ae0de
IM
221
222compose_mount_options_out:
223 kfree(srvIP);
224 return mountdata;
c6fbba05
SF
225
226compose_mount_options_err:
227 kfree(mountdata);
228 mountdata = ERR_PTR(rc);
10b8c7df
CD
229 kfree(*devname);
230 *devname = NULL;
c6fbba05 231 goto compose_mount_options_out;
6d5ae0de
IM
232}
233
f67909cf
SF
234/**
235 * cifs_dfs_do_refmount - mounts specified path using provided refferal
236 * @cifs_sb: parent/root superblock
237 * @fullpath: full path in UNC format
238 * @ref: server's referral
239 */
240static struct vfsmount *cifs_dfs_do_refmount(struct cifs_sb_info *cifs_sb,
241 const char *fullpath, const struct dfs_info3_param *ref)
6d5ae0de 242{
6d5ae0de
IM
243 struct vfsmount *mnt;
244 char *mountdata;
366781c1 245 char *devname = NULL;
c6c00919 246
f67909cf 247 /* strip first '\' from fullpath */
c6c00919
SF
248 mountdata = cifs_compose_mount_options(cifs_sb->mountdata,
249 fullpath + 1, ref, &devname);
6d5ae0de
IM
250
251 if (IS_ERR(mountdata))
252 return (struct vfsmount *)mountdata;
253
254 mnt = vfs_kern_mount(&cifs_fs_type, 0, devname, mountdata);
255 kfree(mountdata);
256 kfree(devname);
257 return mnt;
258
259}
260
366781c1 261static void dump_referral(const struct dfs_info3_param *ref)
6d5ae0de 262{
f96637be
JP
263 cifs_dbg(FYI, "DFS: ref path: %s\n", ref->path_name);
264 cifs_dbg(FYI, "DFS: node path: %s\n", ref->node_name);
265 cifs_dbg(FYI, "DFS: fl: %hd, srv_type: %hd\n",
266 ref->flags, ref->server_type);
267 cifs_dbg(FYI, "DFS: ref_flags: %hd, path_consumed: %hd\n",
268 ref->ref_flag, ref->path_consumed);
6d5ae0de
IM
269}
270
01c64fea
DH
271/*
272 * Create a vfsmount that we can automount
273 */
274static struct vfsmount *cifs_dfs_do_automount(struct dentry *mntpt)
6d5ae0de
IM
275{
276 struct dfs_info3_param *referrals = NULL;
277 unsigned int num_referrals = 0;
278 struct cifs_sb_info *cifs_sb;
96daf2b0 279 struct cifs_ses *ses;
01c64fea 280 char *full_path;
6d5786a3
PS
281 unsigned int xid;
282 int i;
01c64fea
DH
283 int rc;
284 struct vfsmount *mnt;
7ffec372 285 struct tcon_link *tlink;
6d5ae0de 286
f96637be 287 cifs_dbg(FYI, "in %s\n", __func__);
01c64fea 288 BUG_ON(IS_ROOT(mntpt));
6d5ae0de 289
c6fbba05
SF
290 /*
291 * The MSDFS spec states that paths in DFS referral requests and
292 * responses must be prefixed by a single '\' character instead of
293 * the double backslashes usually used in the UNC. This function
294 * gives us the latter, so we must adjust the result.
295 */
01c64fea
DH
296 mnt = ERR_PTR(-ENOMEM);
297 full_path = build_path_from_dentry(mntpt);
298 if (full_path == NULL)
31c2659d 299 goto cdda_exit;
6d5ae0de 300
01c64fea 301 cifs_sb = CIFS_SB(mntpt->d_inode->i_sb);
7ffec372
JL
302 tlink = cifs_sb_tlink(cifs_sb);
303 if (IS_ERR(tlink)) {
01c64fea
DH
304 mnt = ERR_CAST(tlink);
305 goto free_full_path;
7ffec372
JL
306 }
307 ses = tlink_tcon(tlink)->ses;
308
6d5786a3 309 xid = get_xid();
7ffec372 310 rc = get_dfs_path(xid, ses, full_path + 1, cifs_sb->local_nls,
6d5ae0de
IM
311 &num_referrals, &referrals,
312 cifs_sb->mnt_cifs_flags & CIFS_MOUNT_MAP_SPECIAL_CHR);
6d5786a3 313 free_xid(xid);
6d5ae0de 314
7ffec372
JL
315 cifs_put_tlink(tlink);
316
01c64fea 317 mnt = ERR_PTR(-ENOENT);
6d5ae0de 318 for (i = 0; i < num_referrals; i++) {
cf398e3a 319 int len;
01c64fea 320 dump_referral(referrals + i);
1af28ceb 321 /* connect to a node */
1af28ceb
IM
322 len = strlen(referrals[i].node_name);
323 if (len < 2) {
f96637be
JP
324 cifs_dbg(VFS, "%s: Net Address path too short: %s\n",
325 __func__, referrals[i].node_name);
01c64fea
DH
326 mnt = ERR_PTR(-EINVAL);
327 break;
1af28ceb 328 }
f67909cf
SF
329 mnt = cifs_dfs_do_refmount(cifs_sb,
330 full_path, referrals + i);
f96637be
JP
331 cifs_dbg(FYI, "%s: cifs_dfs_do_refmount:%s , mnt:%p\n",
332 __func__, referrals[i].node_name, mnt);
1af28ceb 333 if (!IS_ERR(mnt))
01c64fea 334 goto success;
6d5ae0de
IM
335 }
336
01c64fea
DH
337 /* no valid submounts were found; return error from get_dfs_path() by
338 * preference */
339 if (rc != 0)
340 mnt = ERR_PTR(rc);
6d5ae0de 341
01c64fea 342success:
6d5ae0de 343 free_dfs_info_array(referrals, num_referrals);
01c64fea 344free_full_path:
6d5ae0de 345 kfree(full_path);
31c2659d 346cdda_exit:
f96637be 347 cifs_dbg(FYI, "leaving %s\n" , __func__);
01c64fea
DH
348 return mnt;
349}
350
351/*
352 * Attempt to automount the referral
353 */
354struct vfsmount *cifs_dfs_d_automount(struct path *path)
355{
356 struct vfsmount *newmnt;
01c64fea 357
f96637be 358 cifs_dbg(FYI, "in %s\n", __func__);
01c64fea
DH
359
360 newmnt = cifs_dfs_do_automount(path->dentry);
361 if (IS_ERR(newmnt)) {
f96637be 362 cifs_dbg(FYI, "leaving %s [automount failed]\n" , __func__);
01c64fea
DH
363 return newmnt;
364 }
365
ea5b778a
DH
366 mntget(newmnt); /* prevent immediate expiration */
367 mnt_set_expiry(newmnt, &cifs_dfs_automount_list);
368 schedule_delayed_work(&cifs_dfs_automount_task,
369 cifs_dfs_mountpoint_expiry_timeout);
f96637be 370 cifs_dbg(FYI, "leaving %s [ok]\n" , __func__);
ea5b778a 371 return newmnt;
6d5ae0de
IM
372}
373
6e1d5dcc 374const struct inode_operations cifs_dfs_referral_inode_operations = {
6d5ae0de 375};
This page took 0.328405 seconds and 5 git commands to generate.