2 * In-kernel MOUNT protocol client
4 * Copyright (C) 1997, Olaf Kirch <okir@monad.swb.de>
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>
14 #include <linux/sunrpc/clnt.h>
15 #include <linux/sunrpc/sched.h>
16 #include <linux/nfs_fs.h>
20 # define NFSDBG_FACILITY NFSDBG_MOUNT
24 * Defined by RFC 1094, section A.3; and RFC 1813, section 5.1.4
26 #define MNTPATHLEN (1024)
31 #define encode_dirpath_sz (1 + XDR_QUADLEN(MNTPATHLEN))
32 #define MNT_status_sz (1)
33 #define MNT_fhs_status_sz (1)
34 #define MNT_fhandle_sz XDR_QUADLEN(NFS2_FHSIZE)
35 #define MNT_fhandle3_sz (1 + XDR_QUADLEN(NFS3_FHSIZE))
36 #define MNT_authflav3_sz (1 + NFS_MAX_SECFLAVORS)
39 * XDR argument and result sizes
41 #define MNT_enc_dirpath_sz encode_dirpath_sz
44 * Defined by RFC 1094, section A.5
51 MOUNTPROC_UMNTALL = 4,
56 * Defined by RFC 1813, section 5.2
63 MOUNTPROC3_UMNTALL = 4,
64 MOUNTPROC3_EXPORT = 5,
67 static struct rpc_program mnt_program;
70 * Defined by OpenGroup XNFS Version 3W, chapter 8
84 { .status = MNT_OK, .errno = 0, },
85 { .status = MNT_EPERM, .errno = -EPERM, },
86 { .status = MNT_ENOENT, .errno = -ENOENT, },
87 { .status = MNT_EACCES, .errno = -EACCES, },
88 { .status = MNT_EINVAL, .errno = -EINVAL, },
92 * Defined by RFC 1813, section 5.1.5
95 MNT3_OK = 0, /* no error */
96 MNT3ERR_PERM = 1, /* Not owner */
97 MNT3ERR_NOENT = 2, /* No such file or directory */
98 MNT3ERR_IO = 5, /* I/O error */
99 MNT3ERR_ACCES = 13, /* Permission denied */
100 MNT3ERR_NOTDIR = 20, /* Not a directory */
101 MNT3ERR_INVAL = 22, /* Invalid argument */
102 MNT3ERR_NAMETOOLONG = 63, /* Filename too long */
103 MNT3ERR_NOTSUPP = 10004, /* Operation not supported */
104 MNT3ERR_SERVERFAULT = 10006, /* A failure on the server */
111 { .status = MNT3_OK, .errno = 0, },
112 { .status = MNT3ERR_PERM, .errno = -EPERM, },
113 { .status = MNT3ERR_NOENT, .errno = -ENOENT, },
114 { .status = MNT3ERR_IO, .errno = -EIO, },
115 { .status = MNT3ERR_ACCES, .errno = -EACCES, },
116 { .status = MNT3ERR_NOTDIR, .errno = -ENOTDIR, },
117 { .status = MNT3ERR_INVAL, .errno = -EINVAL, },
118 { .status = MNT3ERR_NAMETOOLONG, .errno = -ENAMETOOLONG, },
119 { .status = MNT3ERR_NOTSUPP, .errno = -ENOTSUPP, },
120 { .status = MNT3ERR_SERVERFAULT, .errno = -ESERVERFAULT, },
126 unsigned int *auth_count;
127 rpc_authflavor_t *auth_flavors;
130 struct mnt_fhstatus {
136 * nfs_mount - Obtain an NFS file handle for the given host and path
137 * @info: pointer to mount request arguments
139 * Uses default timeout parameters specified by underlying transport.
141 int nfs_mount(struct nfs_mount_request *info)
143 struct mnt_fhstatus result = {
146 struct rpc_message msg = {
147 .rpc_argp = info->dirpath,
150 struct rpc_create_args args = {
151 .protocol = info->protocol,
152 .address = info->sap,
153 .addrsize = info->salen,
154 .servername = info->hostname,
155 .program = &mnt_program,
156 .version = info->version,
157 .authflavor = RPC_AUTH_UNIX,
159 struct rpc_clnt *mnt_clnt;
162 dprintk("NFS: sending MNT request for %s:%s\n",
163 (info->hostname ? info->hostname : "server"),
166 if (info->noresvport)
167 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
169 mnt_clnt = rpc_create(&args);
170 if (IS_ERR(mnt_clnt))
173 if (info->version == NFS_MNT3_VERSION)
174 msg.rpc_proc = &mnt_clnt->cl_procinfo[MOUNTPROC3_MNT];
176 msg.rpc_proc = &mnt_clnt->cl_procinfo[MOUNTPROC_MNT];
178 status = rpc_call_sync(mnt_clnt, &msg, 0);
179 rpc_shutdown_client(mnt_clnt);
183 if (result.status != 0)
186 dprintk("NFS: MNT request succeeded\n");
193 status = PTR_ERR(mnt_clnt);
194 dprintk("NFS: failed to create RPC client, status=%d\n", status);
198 dprintk("NFS: failed to start MNT request, status=%d\n", status);
202 dprintk("NFS: MNT server returned result %d\n", result.status);
203 status = nfs_stat_to_errno(result.status);
208 * XDR encode/decode functions for MOUNT
211 static int encode_mntdirpath(struct xdr_stream *xdr, const char *pathname)
213 const u32 pathname_len = strlen(pathname);
216 if (unlikely(pathname_len > MNTPATHLEN))
219 p = xdr_reserve_space(xdr, sizeof(u32) + pathname_len);
220 if (unlikely(p == NULL))
222 xdr_encode_opaque(p, pathname, pathname_len);
227 static int mnt_enc_dirpath(struct rpc_rqst *req, __be32 *p,
230 struct xdr_stream xdr;
232 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
233 return encode_mntdirpath(&xdr, dirpath);
236 static int xdr_decode_fhstatus(struct rpc_rqst *req, __be32 *p,
237 struct mnt_fhstatus *res)
239 struct nfs_fh *fh = res->fh;
241 if ((res->status = ntohl(*p++)) == 0) {
242 fh->size = NFS2_FHSIZE;
243 memcpy(fh->data, p, NFS2_FHSIZE);
249 * RFC 1094: "A non-zero status indicates some sort of error. In this
250 * case, the status is a UNIX error number." This can be problematic
251 * if the server and client use different errno values for the same
254 * However, the OpenGroup XNFS spec provides a simple mapping that is
255 * independent of local errno values on the server and the client.
257 static int decode_status(struct xdr_stream *xdr, struct mountres *res)
263 p = xdr_inline_decode(xdr, sizeof(status));
264 if (unlikely(p == NULL))
268 for (i = 0; i <= ARRAY_SIZE(mnt_errtbl); i++) {
269 if (mnt_errtbl[i].status == status) {
270 res->errno = mnt_errtbl[i].errno;
275 dprintk("NFS: unrecognized MNT status code: %u\n", status);
276 res->errno = -EACCES;
280 static int decode_fhandle(struct xdr_stream *xdr, struct mountres *res)
282 struct nfs_fh *fh = res->fh;
285 p = xdr_inline_decode(xdr, NFS2_FHSIZE);
286 if (unlikely(p == NULL))
289 fh->size = NFS2_FHSIZE;
290 memcpy(fh->data, p, NFS2_FHSIZE);
294 static int decode_fhs_status(struct xdr_stream *xdr, struct mountres *res)
300 p = xdr_inline_decode(xdr, sizeof(status));
301 if (unlikely(p == NULL))
305 for (i = 0; i <= ARRAY_SIZE(mnt3_errtbl); i++) {
306 if (mnt3_errtbl[i].status == status) {
307 res->errno = mnt3_errtbl[i].errno;
312 dprintk("NFS: unrecognized MNT3 status code: %u\n", status);
313 res->errno = -EACCES;
317 static int decode_fhandle3(struct xdr_stream *xdr, struct mountres *res)
319 struct nfs_fh *fh = res->fh;
323 p = xdr_inline_decode(xdr, sizeof(size));
324 if (unlikely(p == NULL))
328 if (size > NFS3_FHSIZE || size == 0)
331 p = xdr_inline_decode(xdr, size);
332 if (unlikely(p == NULL))
336 memcpy(fh->data, p, size);
340 static int decode_auth_flavors(struct xdr_stream *xdr, struct mountres *res)
342 rpc_authflavor_t *flavors = res->auth_flavors;
343 unsigned int *count = res->auth_count;
350 p = xdr_inline_decode(xdr, sizeof(entries));
351 if (unlikely(p == NULL))
354 dprintk("NFS: received %u auth flavors\n", entries);
355 if (entries > NFS_MAX_SECFLAVORS)
356 entries = NFS_MAX_SECFLAVORS;
358 p = xdr_inline_decode(xdr, sizeof(u32) * entries);
359 if (unlikely(p == NULL))
362 if (entries > *count)
365 for (i = 0; i < entries; i++) {
366 flavors[i] = ntohl(*p++);
367 dprintk("NFS:\tflavor %u: %d\n", i, flavors[i]);
374 static int xdr_decode_fhstatus3(struct rpc_rqst *req, __be32 *p,
375 struct mnt_fhstatus *res)
377 struct nfs_fh *fh = res->fh;
380 if ((res->status = ntohl(*p++)) == 0) {
382 if (size <= NFS3_FHSIZE && size != 0) {
384 memcpy(fh->data, p, size);
386 res->status = -EBADHANDLE;
391 #define MNT_fhstatus_sz (1 + 8)
392 #define MNT_fhstatus3_sz (1 + 16)
394 static struct rpc_procinfo mnt_procedures[] = {
396 .p_proc = MOUNTPROC_MNT,
397 .p_encode = (kxdrproc_t)mnt_enc_dirpath,
398 .p_decode = (kxdrproc_t) xdr_decode_fhstatus,
399 .p_arglen = MNT_enc_dirpath_sz,
400 .p_replen = MNT_fhstatus_sz,
401 .p_statidx = MOUNTPROC_MNT,
406 static struct rpc_procinfo mnt3_procedures[] = {
408 .p_proc = MOUNTPROC3_MNT,
409 .p_encode = (kxdrproc_t)mnt_enc_dirpath,
410 .p_decode = (kxdrproc_t) xdr_decode_fhstatus3,
411 .p_arglen = MNT_enc_dirpath_sz,
412 .p_replen = MNT_fhstatus3_sz,
413 .p_statidx = MOUNTPROC3_MNT,
419 static struct rpc_version mnt_version1 = {
422 .procs = mnt_procedures,
425 static struct rpc_version mnt_version3 = {
428 .procs = mnt3_procedures,
431 static struct rpc_version *mnt_version[] = {
438 static struct rpc_stat mnt_stats;
440 static struct rpc_program mnt_program = {
442 .number = NFS_MNT_PROGRAM,
443 .nrvers = ARRAY_SIZE(mnt_version),
444 .version = mnt_version,