Merge branch 'fixes' of git://git.armlinux.org.uk/~rmk/linux-arm
[deliverable/linux.git] / fs / nfs / mount_clnt.c
CommitLineData
1da177e4 1/*
19207231 2 * In-kernel MOUNT protocol client
1da177e4
LT
3 *
4 * Copyright (C) 1997, Olaf Kirch <okir@monad.swb.de>
5 */
6
7#include <linux/types.h>
8#include <linux/socket.h>
9#include <linux/kernel.h>
10#include <linux/errno.h>
11#include <linux/uio.h>
12#include <linux/net.h>
13#include <linux/in.h>
14#include <linux/sunrpc/clnt.h>
1da177e4
LT
15#include <linux/sunrpc/sched.h>
16#include <linux/nfs_fs.h>
8491945f 17#include "internal.h"
1da177e4 18
39de493e 19#define NFSDBG_FACILITY NFSDBG_MOUNT
1da177e4 20
29a1bd6b
CL
21/*
22 * Defined by RFC 1094, section A.3; and RFC 1813, section 5.1.4
23 */
24#define MNTPATHLEN (1024)
25
26/*
27 * XDR data type sizes
28 */
29#define encode_dirpath_sz (1 + XDR_QUADLEN(MNTPATHLEN))
fb125295
CL
30#define MNT_status_sz (1)
31#define MNT_fhs_status_sz (1)
4fdcd996
CL
32#define MNT_fhandle_sz XDR_QUADLEN(NFS2_FHSIZE)
33#define MNT_fhandle3_sz (1 + XDR_QUADLEN(NFS3_FHSIZE))
a14017db 34#define MNT_authflav3_sz (1 + NFS_MAX_SECFLAVORS)
29a1bd6b
CL
35
36/*
37 * XDR argument and result sizes
38 */
39#define MNT_enc_dirpath_sz encode_dirpath_sz
8e02f6b9
CL
40#define MNT_dec_mountres_sz (MNT_status_sz + MNT_fhandle_sz)
41#define MNT_dec_mountres3_sz (MNT_status_sz + MNT_fhandle_sz + \
42 MNT_authflav3_sz)
29a1bd6b 43
2ad78097
CL
44/*
45 * Defined by RFC 1094, section A.5
46 */
47enum {
48 MOUNTPROC_NULL = 0,
49 MOUNTPROC_MNT = 1,
50 MOUNTPROC_DUMP = 2,
51 MOUNTPROC_UMNT = 3,
52 MOUNTPROC_UMNTALL = 4,
53 MOUNTPROC_EXPORT = 5,
54};
55
56/*
57 * Defined by RFC 1813, section 5.2
58 */
59enum {
60 MOUNTPROC3_NULL = 0,
61 MOUNTPROC3_MNT = 1,
62 MOUNTPROC3_DUMP = 2,
63 MOUNTPROC3_UMNT = 3,
64 MOUNTPROC3_UMNTALL = 4,
65 MOUNTPROC3_EXPORT = 5,
66};
67
a613fa16 68static const struct rpc_program mnt_program;
1da177e4 69
fb125295
CL
70/*
71 * Defined by OpenGroup XNFS Version 3W, chapter 8
72 */
73enum mountstat {
74 MNT_OK = 0,
75 MNT_EPERM = 1,
76 MNT_ENOENT = 2,
77 MNT_EACCES = 13,
78 MNT_EINVAL = 22,
79};
80
81static struct {
82 u32 status;
83 int errno;
84} mnt_errtbl[] = {
85 { .status = MNT_OK, .errno = 0, },
86 { .status = MNT_EPERM, .errno = -EPERM, },
87 { .status = MNT_ENOENT, .errno = -ENOENT, },
88 { .status = MNT_EACCES, .errno = -EACCES, },
89 { .status = MNT_EINVAL, .errno = -EINVAL, },
90};
91
92/*
93 * Defined by RFC 1813, section 5.1.5
94 */
95enum mountstat3 {
96 MNT3_OK = 0, /* no error */
97 MNT3ERR_PERM = 1, /* Not owner */
98 MNT3ERR_NOENT = 2, /* No such file or directory */
99 MNT3ERR_IO = 5, /* I/O error */
100 MNT3ERR_ACCES = 13, /* Permission denied */
101 MNT3ERR_NOTDIR = 20, /* Not a directory */
102 MNT3ERR_INVAL = 22, /* Invalid argument */
103 MNT3ERR_NAMETOOLONG = 63, /* Filename too long */
104 MNT3ERR_NOTSUPP = 10004, /* Operation not supported */
105 MNT3ERR_SERVERFAULT = 10006, /* A failure on the server */
106};
107
108static struct {
109 u32 status;
110 int errno;
111} mnt3_errtbl[] = {
112 { .status = MNT3_OK, .errno = 0, },
113 { .status = MNT3ERR_PERM, .errno = -EPERM, },
114 { .status = MNT3ERR_NOENT, .errno = -ENOENT, },
115 { .status = MNT3ERR_IO, .errno = -EIO, },
116 { .status = MNT3ERR_ACCES, .errno = -EACCES, },
117 { .status = MNT3ERR_NOTDIR, .errno = -ENOTDIR, },
118 { .status = MNT3ERR_INVAL, .errno = -EINVAL, },
119 { .status = MNT3ERR_NAMETOOLONG, .errno = -ENAMETOOLONG, },
120 { .status = MNT3ERR_NOTSUPP, .errno = -ENOTSUPP, },
fdcb4577 121 { .status = MNT3ERR_SERVERFAULT, .errno = -EREMOTEIO, },
fb125295
CL
122};
123
124struct mountres {
125 int errno;
126 struct nfs_fh *fh;
a14017db
CL
127 unsigned int *auth_count;
128 rpc_authflavor_t *auth_flavors;
fb125295
CL
129};
130
1da177e4 131struct mnt_fhstatus {
19207231
CL
132 u32 status;
133 struct nfs_fh *fh;
1da177e4
LT
134};
135
3ea97309
CL
136/**
137 * nfs_mount - Obtain an NFS file handle for the given host and path
c5d120f8 138 * @info: pointer to mount request arguments
3ea97309 139 *
fb9b02fd
JL
140 * Uses default timeout parameters specified by underlying transport. On
141 * successful return, the auth_flavs list and auth_flav_len will be populated
142 * with the list from the server or a faked-up list if the server didn't
143 * provide one.
1da177e4 144 */
c5d120f8 145int nfs_mount(struct nfs_mount_request *info)
1da177e4 146{
8e02f6b9
CL
147 struct mountres result = {
148 .fh = info->fh,
149 .auth_count = info->auth_flav_len,
150 .auth_flavors = info->auth_flavs,
1da177e4 151 };
dead28da 152 struct rpc_message msg = {
c5d120f8 153 .rpc_argp = info->dirpath,
dead28da
CL
154 .rpc_resp = &result,
155 };
3ea97309 156 struct rpc_create_args args = {
6d59b8d5 157 .net = info->net,
c5d120f8
CL
158 .protocol = info->protocol,
159 .address = info->sap,
160 .addrsize = info->salen,
161 .servername = info->hostname,
3ea97309 162 .program = &mnt_program,
c5d120f8 163 .version = info->version,
3ea97309 164 .authflavor = RPC_AUTH_UNIX,
3ea97309
CL
165 };
166 struct rpc_clnt *mnt_clnt;
1da177e4 167 int status;
1da177e4 168
3ea97309 169 dprintk("NFS: sending MNT request for %s:%s\n",
c5d120f8
CL
170 (info->hostname ? info->hostname : "server"),
171 info->dirpath);
1da177e4 172
28d79ea3
TM
173 if (strlen(info->dirpath) > MNTPATHLEN)
174 return -ENAMETOOLONG;
175
50a737f8
CL
176 if (info->noresvport)
177 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
178
3ea97309 179 mnt_clnt = rpc_create(&args);
1da177e4 180 if (IS_ERR(mnt_clnt))
013a8c1a 181 goto out_clnt_err;
1da177e4 182
c5d120f8 183 if (info->version == NFS_MNT3_VERSION)
dead28da
CL
184 msg.rpc_proc = &mnt_clnt->cl_procinfo[MOUNTPROC3_MNT];
185 else
2ad78097 186 msg.rpc_proc = &mnt_clnt->cl_procinfo[MOUNTPROC_MNT];
dead28da 187
acce94e6 188 status = rpc_call_sync(mnt_clnt, &msg, RPC_TASK_SOFT|RPC_TASK_TIMEOUT);
90c5755f 189 rpc_shutdown_client(mnt_clnt);
013a8c1a
CL
190
191 if (status < 0)
192 goto out_call_err;
8e02f6b9 193 if (result.errno != 0)
013a8c1a
CL
194 goto out_mnt_err;
195
196 dprintk("NFS: MNT request succeeded\n");
197 status = 0;
198
fb9b02fd
JL
199 /*
200 * If the server didn't provide a flavor list, allow the
201 * client to try any flavor.
202 */
203 if (info->version != NFS_MNT3_VERSION || *info->auth_flav_len == 0) {
204 dprintk("NFS: Faking up auth_flavs list\n");
205 info->auth_flavs[0] = RPC_AUTH_NULL;
206 *info->auth_flav_len = 1;
207 }
013a8c1a
CL
208out:
209 return status;
210
211out_clnt_err:
212 status = PTR_ERR(mnt_clnt);
8e02f6b9 213 dprintk("NFS: failed to create MNT RPC client, status=%d\n", status);
013a8c1a
CL
214 goto out;
215
216out_call_err:
8e02f6b9 217 dprintk("NFS: MNT request failed, status=%d\n", status);
013a8c1a
CL
218 goto out;
219
220out_mnt_err:
8e02f6b9
CL
221 dprintk("NFS: MNT server returned result %d\n", result.errno);
222 status = result.errno;
013a8c1a 223 goto out;
1da177e4
LT
224}
225
0b524123
CL
226/**
227 * nfs_umount - Notify a server that we have unmounted this export
228 * @info: pointer to umount request arguments
229 *
230 * MOUNTPROC_UMNT is advisory, so we set a short timeout, and always
231 * use UDP.
232 */
233void nfs_umount(const struct nfs_mount_request *info)
234{
235 static const struct rpc_timeout nfs_umnt_timeout = {
236 .to_initval = 1 * HZ,
237 .to_maxval = 3 * HZ,
238 .to_retries = 2,
239 };
240 struct rpc_create_args args = {
6d59b8d5 241 .net = info->net,
0b524123
CL
242 .protocol = IPPROTO_UDP,
243 .address = info->sap,
244 .addrsize = info->salen,
245 .timeout = &nfs_umnt_timeout,
246 .servername = info->hostname,
247 .program = &mnt_program,
248 .version = info->version,
249 .authflavor = RPC_AUTH_UNIX,
250 .flags = RPC_CLNT_CREATE_NOPING,
251 };
0b524123
CL
252 struct rpc_message msg = {
253 .rpc_argp = info->dirpath,
0b524123
CL
254 };
255 struct rpc_clnt *clnt;
256 int status;
257
28d79ea3
TM
258 if (strlen(info->dirpath) > MNTPATHLEN)
259 return;
260
0b524123
CL
261 if (info->noresvport)
262 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
263
264 clnt = rpc_create(&args);
c8b031eb 265 if (IS_ERR(clnt))
0b524123
CL
266 goto out_clnt_err;
267
268 dprintk("NFS: sending UMNT request for %s:%s\n",
269 (info->hostname ? info->hostname : "server"), info->dirpath);
270
271 if (info->version == NFS_MNT3_VERSION)
272 msg.rpc_proc = &clnt->cl_procinfo[MOUNTPROC3_UMNT];
273 else
274 msg.rpc_proc = &clnt->cl_procinfo[MOUNTPROC_UMNT];
275
276 status = rpc_call_sync(clnt, &msg, 0);
277 rpc_shutdown_client(clnt);
278
279 if (unlikely(status < 0))
280 goto out_call_err;
281
282 return;
283
284out_clnt_err:
285 dprintk("NFS: failed to create UMNT RPC client, status=%ld\n",
286 PTR_ERR(clnt));
287 return;
288
289out_call_err:
290 dprintk("NFS: UMNT request failed, status=%d\n", status);
291}
292
1da177e4
LT
293/*
294 * XDR encode/decode functions for MOUNT
295 */
1da177e4 296
98eb2b4f 297static void encode_mntdirpath(struct xdr_stream *xdr, const char *pathname)
29a1bd6b
CL
298{
299 const u32 pathname_len = strlen(pathname);
300 __be32 *p;
301
98eb2b4f 302 p = xdr_reserve_space(xdr, 4 + pathname_len);
29a1bd6b 303 xdr_encode_opaque(p, pathname, pathname_len);
29a1bd6b
CL
304}
305
9f06c719
CL
306static void mnt_xdr_enc_dirpath(struct rpc_rqst *req, struct xdr_stream *xdr,
307 const char *dirpath)
29a1bd6b 308{
9f06c719 309 encode_mntdirpath(xdr, dirpath);
29a1bd6b
CL
310}
311
fb125295
CL
312/*
313 * RFC 1094: "A non-zero status indicates some sort of error. In this
314 * case, the status is a UNIX error number." This can be problematic
315 * if the server and client use different errno values for the same
316 * error.
317 *
318 * However, the OpenGroup XNFS spec provides a simple mapping that is
319 * independent of local errno values on the server and the client.
320 */
321static int decode_status(struct xdr_stream *xdr, struct mountres *res)
322{
323 unsigned int i;
324 u32 status;
325 __be32 *p;
326
98eb2b4f 327 p = xdr_inline_decode(xdr, 4);
fb125295
CL
328 if (unlikely(p == NULL))
329 return -EIO;
98eb2b4f 330 status = be32_to_cpup(p);
fb125295 331
dd8ac1da 332 for (i = 0; i < ARRAY_SIZE(mnt_errtbl); i++) {
fb125295
CL
333 if (mnt_errtbl[i].status == status) {
334 res->errno = mnt_errtbl[i].errno;
335 return 0;
336 }
337 }
338
339 dprintk("NFS: unrecognized MNT status code: %u\n", status);
340 res->errno = -EACCES;
341 return 0;
342}
343
4fdcd996
CL
344static int decode_fhandle(struct xdr_stream *xdr, struct mountres *res)
345{
346 struct nfs_fh *fh = res->fh;
347 __be32 *p;
348
349 p = xdr_inline_decode(xdr, NFS2_FHSIZE);
350 if (unlikely(p == NULL))
351 return -EIO;
352
353 fh->size = NFS2_FHSIZE;
354 memcpy(fh->data, p, NFS2_FHSIZE);
355 return 0;
356}
357
bf269551
CL
358static int mnt_xdr_dec_mountres(struct rpc_rqst *req,
359 struct xdr_stream *xdr,
360 struct mountres *res)
8e02f6b9 361{
8e02f6b9
CL
362 int status;
363
bf269551 364 status = decode_status(xdr, res);
8e02f6b9
CL
365 if (unlikely(status != 0 || res->errno != 0))
366 return status;
bf269551 367 return decode_fhandle(xdr, res);
8e02f6b9
CL
368}
369
fb125295
CL
370static int decode_fhs_status(struct xdr_stream *xdr, struct mountres *res)
371{
372 unsigned int i;
373 u32 status;
374 __be32 *p;
375
98eb2b4f 376 p = xdr_inline_decode(xdr, 4);
fb125295
CL
377 if (unlikely(p == NULL))
378 return -EIO;
98eb2b4f 379 status = be32_to_cpup(p);
fb125295 380
dd8ac1da 381 for (i = 0; i < ARRAY_SIZE(mnt3_errtbl); i++) {
fb125295
CL
382 if (mnt3_errtbl[i].status == status) {
383 res->errno = mnt3_errtbl[i].errno;
384 return 0;
385 }
386 }
387
388 dprintk("NFS: unrecognized MNT3 status code: %u\n", status);
389 res->errno = -EACCES;
390 return 0;
391}
392
4fdcd996
CL
393static int decode_fhandle3(struct xdr_stream *xdr, struct mountres *res)
394{
395 struct nfs_fh *fh = res->fh;
396 u32 size;
397 __be32 *p;
398
98eb2b4f 399 p = xdr_inline_decode(xdr, 4);
4fdcd996
CL
400 if (unlikely(p == NULL))
401 return -EIO;
402
98eb2b4f 403 size = be32_to_cpup(p);
4fdcd996
CL
404 if (size > NFS3_FHSIZE || size == 0)
405 return -EIO;
406
407 p = xdr_inline_decode(xdr, size);
408 if (unlikely(p == NULL))
409 return -EIO;
410
411 fh->size = size;
412 memcpy(fh->data, p, size);
413 return 0;
414}
415
a14017db
CL
416static int decode_auth_flavors(struct xdr_stream *xdr, struct mountres *res)
417{
418 rpc_authflavor_t *flavors = res->auth_flavors;
419 unsigned int *count = res->auth_count;
420 u32 entries, i;
421 __be32 *p;
422
423 if (*count == 0)
424 return 0;
425
98eb2b4f 426 p = xdr_inline_decode(xdr, 4);
a14017db
CL
427 if (unlikely(p == NULL))
428 return -EIO;
98eb2b4f 429 entries = be32_to_cpup(p);
a14017db
CL
430 dprintk("NFS: received %u auth flavors\n", entries);
431 if (entries > NFS_MAX_SECFLAVORS)
432 entries = NFS_MAX_SECFLAVORS;
433
98eb2b4f 434 p = xdr_inline_decode(xdr, 4 * entries);
a14017db
CL
435 if (unlikely(p == NULL))
436 return -EIO;
437
438 if (entries > *count)
439 entries = *count;
440
441 for (i = 0; i < entries; i++) {
98eb2b4f 442 flavors[i] = be32_to_cpup(p++);
ed58b291 443 dprintk("NFS: auth flavor[%u]: %d\n", i, flavors[i]);
a14017db
CL
444 }
445 *count = i;
446
447 return 0;
448}
449
bf269551
CL
450static int mnt_xdr_dec_mountres3(struct rpc_rqst *req,
451 struct xdr_stream *xdr,
452 struct mountres *res)
8e02f6b9 453{
8e02f6b9
CL
454 int status;
455
bf269551 456 status = decode_fhs_status(xdr, res);
8e02f6b9
CL
457 if (unlikely(status != 0 || res->errno != 0))
458 return status;
bf269551 459 status = decode_fhandle3(xdr, res);
8e02f6b9
CL
460 if (unlikely(status != 0)) {
461 res->errno = -EBADHANDLE;
462 return 0;
463 }
bf269551 464 return decode_auth_flavors(xdr, res);
8e02f6b9
CL
465}
466
19207231 467static struct rpc_procinfo mnt_procedures[] = {
2ad78097
CL
468 [MOUNTPROC_MNT] = {
469 .p_proc = MOUNTPROC_MNT,
9f06c719 470 .p_encode = (kxdreproc_t)mnt_xdr_enc_dirpath,
bf269551 471 .p_decode = (kxdrdproc_t)mnt_xdr_dec_mountres,
29a1bd6b 472 .p_arglen = MNT_enc_dirpath_sz,
8e02f6b9 473 .p_replen = MNT_dec_mountres_sz,
2ad78097 474 .p_statidx = MOUNTPROC_MNT,
19207231 475 .p_name = "MOUNT",
1da177e4 476 },
0b524123
CL
477 [MOUNTPROC_UMNT] = {
478 .p_proc = MOUNTPROC_UMNT,
9f06c719 479 .p_encode = (kxdreproc_t)mnt_xdr_enc_dirpath,
0b524123
CL
480 .p_arglen = MNT_enc_dirpath_sz,
481 .p_statidx = MOUNTPROC_UMNT,
482 .p_name = "UMOUNT",
483 },
1da177e4
LT
484};
485
486static struct rpc_procinfo mnt3_procedures[] = {
19207231
CL
487 [MOUNTPROC3_MNT] = {
488 .p_proc = MOUNTPROC3_MNT,
9f06c719 489 .p_encode = (kxdreproc_t)mnt_xdr_enc_dirpath,
bf269551 490 .p_decode = (kxdrdproc_t)mnt_xdr_dec_mountres3,
29a1bd6b 491 .p_arglen = MNT_enc_dirpath_sz,
8e02f6b9 492 .p_replen = MNT_dec_mountres3_sz,
19207231
CL
493 .p_statidx = MOUNTPROC3_MNT,
494 .p_name = "MOUNT",
1da177e4 495 },
0b524123
CL
496 [MOUNTPROC3_UMNT] = {
497 .p_proc = MOUNTPROC3_UMNT,
9f06c719 498 .p_encode = (kxdreproc_t)mnt_xdr_enc_dirpath,
0b524123
CL
499 .p_arglen = MNT_enc_dirpath_sz,
500 .p_statidx = MOUNTPROC3_UMNT,
501 .p_name = "UMOUNT",
502 },
1da177e4
LT
503};
504
505
a613fa16 506static const struct rpc_version mnt_version1 = {
19207231 507 .number = 1,
5b362ac3 508 .nrprocs = ARRAY_SIZE(mnt_procedures),
19207231 509 .procs = mnt_procedures,
1da177e4
LT
510};
511
a613fa16 512static const struct rpc_version mnt_version3 = {
19207231 513 .number = 3,
5b362ac3 514 .nrprocs = ARRAY_SIZE(mnt3_procedures),
19207231 515 .procs = mnt3_procedures,
1da177e4
LT
516};
517
a613fa16 518static const struct rpc_version *mnt_version[] = {
1da177e4
LT
519 NULL,
520 &mnt_version1,
521 NULL,
522 &mnt_version3,
523};
524
19207231 525static struct rpc_stat mnt_stats;
1da177e4 526
a613fa16 527static const struct rpc_program mnt_program = {
1da177e4
LT
528 .name = "mount",
529 .number = NFS_MNT_PROGRAM,
e8c96f8c 530 .nrvers = ARRAY_SIZE(mnt_version),
1da177e4
LT
531 .version = mnt_version,
532 .stats = &mnt_stats,
533};
This page took 0.743108 seconds and 5 git commands to generate.