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>
19 #define NFSDBG_FACILITY NFSDBG_MOUNT
22 * Defined by RFC 1094, section A.3; and RFC 1813, section 5.1.4
24 #define MNTPATHLEN (1024)
29 #define encode_dirpath_sz (1 + XDR_QUADLEN(MNTPATHLEN))
30 #define MNT_status_sz (1)
31 #define MNT_fhs_status_sz (1)
32 #define MNT_fhandle_sz XDR_QUADLEN(NFS2_FHSIZE)
33 #define MNT_fhandle3_sz (1 + XDR_QUADLEN(NFS3_FHSIZE))
34 #define MNT_authflav3_sz (1 + NFS_MAX_SECFLAVORS)
37 * XDR argument and result sizes
39 #define MNT_enc_dirpath_sz encode_dirpath_sz
40 #define MNT_dec_mountres_sz (MNT_status_sz + MNT_fhandle_sz)
41 #define MNT_dec_mountres3_sz (MNT_status_sz + MNT_fhandle_sz + \
45 * Defined by RFC 1094, section A.5
52 MOUNTPROC_UMNTALL
= 4,
57 * Defined by RFC 1813, section 5.2
64 MOUNTPROC3_UMNTALL
= 4,
65 MOUNTPROC3_EXPORT
= 5,
68 static const struct rpc_program mnt_program
;
71 * Defined by OpenGroup XNFS Version 3W, chapter 8
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
, },
93 * Defined by RFC 1813, section 5.1.5
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 */
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
, },
121 { .status
= MNT3ERR_SERVERFAULT
, .errno
= -EREMOTEIO
, },
127 unsigned int *auth_count
;
128 rpc_authflavor_t
*auth_flavors
;
131 struct mnt_fhstatus
{
137 * nfs_mount - Obtain an NFS file handle for the given host and path
138 * @info: pointer to mount request arguments
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
145 int nfs_mount(struct nfs_mount_request
*info
)
147 struct mountres result
= {
149 .auth_count
= info
->auth_flav_len
,
150 .auth_flavors
= info
->auth_flavs
,
152 struct rpc_message msg
= {
153 .rpc_argp
= info
->dirpath
,
156 struct rpc_create_args args
= {
158 .protocol
= info
->protocol
,
159 .address
= info
->sap
,
160 .addrsize
= info
->salen
,
161 .servername
= info
->hostname
,
162 .program
= &mnt_program
,
163 .version
= info
->version
,
164 .authflavor
= RPC_AUTH_UNIX
,
166 struct rpc_clnt
*mnt_clnt
;
169 dprintk("NFS: sending MNT request for %s:%s\n",
170 (info
->hostname
? info
->hostname
: "server"),
173 if (strlen(info
->dirpath
) > MNTPATHLEN
)
174 return -ENAMETOOLONG
;
176 if (info
->noresvport
)
177 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
179 mnt_clnt
= rpc_create(&args
);
180 if (IS_ERR(mnt_clnt
))
183 if (info
->version
== NFS_MNT3_VERSION
)
184 msg
.rpc_proc
= &mnt_clnt
->cl_procinfo
[MOUNTPROC3_MNT
];
186 msg
.rpc_proc
= &mnt_clnt
->cl_procinfo
[MOUNTPROC_MNT
];
188 status
= rpc_call_sync(mnt_clnt
, &msg
, RPC_TASK_SOFT
|RPC_TASK_TIMEOUT
);
189 rpc_shutdown_client(mnt_clnt
);
193 if (result
.errno
!= 0)
196 dprintk("NFS: MNT request succeeded\n");
200 * If the server didn't provide a flavor list, allow the
201 * client to try any flavor.
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;
212 status
= PTR_ERR(mnt_clnt
);
213 dprintk("NFS: failed to create MNT RPC client, status=%d\n", status
);
217 dprintk("NFS: MNT request failed, status=%d\n", status
);
221 dprintk("NFS: MNT server returned result %d\n", result
.errno
);
222 status
= result
.errno
;
227 * nfs_umount - Notify a server that we have unmounted this export
228 * @info: pointer to umount request arguments
230 * MOUNTPROC_UMNT is advisory, so we set a short timeout, and always
233 void nfs_umount(const struct nfs_mount_request
*info
)
235 static const struct rpc_timeout nfs_umnt_timeout
= {
236 .to_initval
= 1 * HZ
,
240 struct rpc_create_args args
= {
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
,
252 struct rpc_message msg
= {
253 .rpc_argp
= info
->dirpath
,
255 struct rpc_clnt
*clnt
;
258 if (strlen(info
->dirpath
) > MNTPATHLEN
)
261 if (info
->noresvport
)
262 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
264 clnt
= rpc_create(&args
);
268 dprintk("NFS: sending UMNT request for %s:%s\n",
269 (info
->hostname
? info
->hostname
: "server"), info
->dirpath
);
271 if (info
->version
== NFS_MNT3_VERSION
)
272 msg
.rpc_proc
= &clnt
->cl_procinfo
[MOUNTPROC3_UMNT
];
274 msg
.rpc_proc
= &clnt
->cl_procinfo
[MOUNTPROC_UMNT
];
276 status
= rpc_call_sync(clnt
, &msg
, 0);
277 rpc_shutdown_client(clnt
);
279 if (unlikely(status
< 0))
285 dprintk("NFS: failed to create UMNT RPC client, status=%ld\n",
290 dprintk("NFS: UMNT request failed, status=%d\n", status
);
294 * XDR encode/decode functions for MOUNT
297 static void encode_mntdirpath(struct xdr_stream
*xdr
, const char *pathname
)
299 const u32 pathname_len
= strlen(pathname
);
302 p
= xdr_reserve_space(xdr
, 4 + pathname_len
);
303 xdr_encode_opaque(p
, pathname
, pathname_len
);
306 static void mnt_xdr_enc_dirpath(struct rpc_rqst
*req
, struct xdr_stream
*xdr
,
309 encode_mntdirpath(xdr
, dirpath
);
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
318 * However, the OpenGroup XNFS spec provides a simple mapping that is
319 * independent of local errno values on the server and the client.
321 static int decode_status(struct xdr_stream
*xdr
, struct mountres
*res
)
327 p
= xdr_inline_decode(xdr
, 4);
328 if (unlikely(p
== NULL
))
330 status
= be32_to_cpup(p
);
332 for (i
= 0; i
< ARRAY_SIZE(mnt_errtbl
); i
++) {
333 if (mnt_errtbl
[i
].status
== status
) {
334 res
->errno
= mnt_errtbl
[i
].errno
;
339 dprintk("NFS: unrecognized MNT status code: %u\n", status
);
340 res
->errno
= -EACCES
;
344 static int decode_fhandle(struct xdr_stream
*xdr
, struct mountres
*res
)
346 struct nfs_fh
*fh
= res
->fh
;
349 p
= xdr_inline_decode(xdr
, NFS2_FHSIZE
);
350 if (unlikely(p
== NULL
))
353 fh
->size
= NFS2_FHSIZE
;
354 memcpy(fh
->data
, p
, NFS2_FHSIZE
);
358 static int mnt_xdr_dec_mountres(struct rpc_rqst
*req
,
359 struct xdr_stream
*xdr
,
362 struct mountres
*res
= data
;
365 status
= decode_status(xdr
, res
);
366 if (unlikely(status
!= 0 || res
->errno
!= 0))
368 return decode_fhandle(xdr
, res
);
371 static int decode_fhs_status(struct xdr_stream
*xdr
, struct mountres
*res
)
377 p
= xdr_inline_decode(xdr
, 4);
378 if (unlikely(p
== NULL
))
380 status
= be32_to_cpup(p
);
382 for (i
= 0; i
< ARRAY_SIZE(mnt3_errtbl
); i
++) {
383 if (mnt3_errtbl
[i
].status
== status
) {
384 res
->errno
= mnt3_errtbl
[i
].errno
;
389 dprintk("NFS: unrecognized MNT3 status code: %u\n", status
);
390 res
->errno
= -EACCES
;
394 static int decode_fhandle3(struct xdr_stream
*xdr
, struct mountres
*res
)
396 struct nfs_fh
*fh
= res
->fh
;
400 p
= xdr_inline_decode(xdr
, 4);
401 if (unlikely(p
== NULL
))
404 size
= be32_to_cpup(p
);
405 if (size
> NFS3_FHSIZE
|| size
== 0)
408 p
= xdr_inline_decode(xdr
, size
);
409 if (unlikely(p
== NULL
))
413 memcpy(fh
->data
, p
, size
);
417 static int decode_auth_flavors(struct xdr_stream
*xdr
, struct mountres
*res
)
419 rpc_authflavor_t
*flavors
= res
->auth_flavors
;
420 unsigned int *count
= res
->auth_count
;
427 p
= xdr_inline_decode(xdr
, 4);
428 if (unlikely(p
== NULL
))
430 entries
= be32_to_cpup(p
);
431 dprintk("NFS: received %u auth flavors\n", entries
);
432 if (entries
> NFS_MAX_SECFLAVORS
)
433 entries
= NFS_MAX_SECFLAVORS
;
435 p
= xdr_inline_decode(xdr
, 4 * entries
);
436 if (unlikely(p
== NULL
))
439 if (entries
> *count
)
442 for (i
= 0; i
< entries
; i
++) {
443 flavors
[i
] = be32_to_cpup(p
++);
444 dprintk("NFS: auth flavor[%u]: %d\n", i
, flavors
[i
]);
451 static int mnt_xdr_dec_mountres3(struct rpc_rqst
*req
,
452 struct xdr_stream
*xdr
,
455 struct mountres
*res
= data
;
458 status
= decode_fhs_status(xdr
, res
);
459 if (unlikely(status
!= 0 || res
->errno
!= 0))
461 status
= decode_fhandle3(xdr
, res
);
462 if (unlikely(status
!= 0)) {
463 res
->errno
= -EBADHANDLE
;
466 return decode_auth_flavors(xdr
, res
);
469 static const struct rpc_procinfo mnt_procedures
[] = {
471 .p_proc
= MOUNTPROC_MNT
,
472 .p_encode
= mnt_xdr_enc_dirpath
,
473 .p_decode
= mnt_xdr_dec_mountres
,
474 .p_arglen
= MNT_enc_dirpath_sz
,
475 .p_replen
= MNT_dec_mountres_sz
,
476 .p_statidx
= MOUNTPROC_MNT
,
480 .p_proc
= MOUNTPROC_UMNT
,
481 .p_encode
= mnt_xdr_enc_dirpath
,
482 .p_arglen
= MNT_enc_dirpath_sz
,
483 .p_statidx
= MOUNTPROC_UMNT
,
488 static const struct rpc_procinfo mnt3_procedures
[] = {
490 .p_proc
= MOUNTPROC3_MNT
,
491 .p_encode
= mnt_xdr_enc_dirpath
,
492 .p_decode
= mnt_xdr_dec_mountres3
,
493 .p_arglen
= MNT_enc_dirpath_sz
,
494 .p_replen
= MNT_dec_mountres3_sz
,
495 .p_statidx
= MOUNTPROC3_MNT
,
498 [MOUNTPROC3_UMNT
] = {
499 .p_proc
= MOUNTPROC3_UMNT
,
500 .p_encode
= mnt_xdr_enc_dirpath
,
501 .p_arglen
= MNT_enc_dirpath_sz
,
502 .p_statidx
= MOUNTPROC3_UMNT
,
507 static unsigned int mnt_counts
[ARRAY_SIZE(mnt_procedures
)];
508 static const struct rpc_version mnt_version1
= {
510 .nrprocs
= ARRAY_SIZE(mnt_procedures
),
511 .procs
= mnt_procedures
,
512 .counts
= mnt_counts
,
515 static unsigned int mnt3_counts
[ARRAY_SIZE(mnt3_procedures
)];
516 static const struct rpc_version mnt_version3
= {
518 .nrprocs
= ARRAY_SIZE(mnt3_procedures
),
519 .procs
= mnt3_procedures
,
520 .counts
= mnt3_counts
,
523 static const struct rpc_version
*mnt_version
[] = {
530 static struct rpc_stat mnt_stats
;
532 static const struct rpc_program mnt_program
= {
534 .number
= NFS_MNT_PROGRAM
,
535 .nrvers
= ARRAY_SIZE(mnt_version
),
536 .version
= mnt_version
,