1 // SPDX-License-Identifier: GPL-2.0
3 * In-kernel MOUNT protocol client
5 * Copyright (C) 1997, Olaf Kirch <okir@monad.swb.de>
8 #include <linux/types.h>
9 #include <linux/socket.h>
10 #include <linux/kernel.h>
11 #include <linux/errno.h>
12 #include <linux/uio.h>
13 #include <linux/net.h>
15 #include <linux/sunrpc/clnt.h>
16 #include <linux/sunrpc/sched.h>
17 #include <linux/nfs_fs.h>
20 #define NFSDBG_FACILITY NFSDBG_MOUNT
23 * Defined by RFC 1094, section A.3; and RFC 1813, section 5.1.4
25 #define MNTPATHLEN (1024)
30 #define encode_dirpath_sz (1 + XDR_QUADLEN(MNTPATHLEN))
31 #define MNT_status_sz (1)
32 #define MNT_fhandle_sz XDR_QUADLEN(NFS2_FHSIZE)
33 #define MNT_fhandlev3_sz 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_fhandlev3_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
139 * @timeo: deciseconds the mount waits for a response before it retries
140 * @retrans: number of times the mount retries a request
142 * Uses timeout parameters specified by caller. On successful return, the
143 * auth_flavs list and auth_flav_len will be populated with the list from the
144 * server or a faked-up list if the server didn't provide one.
146 int nfs_mount(struct nfs_mount_request
*info
, int timeo
, int retrans
)
148 struct rpc_timeout mnt_timeout
;
149 struct mountres result
= {
151 .auth_count
= info
->auth_flav_len
,
152 .auth_flavors
= info
->auth_flavs
,
154 struct rpc_message msg
= {
155 .rpc_argp
= info
->dirpath
,
158 struct rpc_create_args args
= {
160 .protocol
= info
->protocol
,
161 .address
= info
->sap
,
162 .addrsize
= info
->salen
,
163 .timeout
= &mnt_timeout
,
164 .servername
= info
->hostname
,
165 .program
= &mnt_program
,
166 .version
= info
->version
,
167 .authflavor
= RPC_AUTH_UNIX
,
168 .cred
= current_cred(),
170 struct rpc_clnt
*mnt_clnt
;
173 dprintk("NFS: sending MNT request for %s:%s\n",
174 (info
->hostname
? info
->hostname
: "server"),
177 if (strlen(info
->dirpath
) > MNTPATHLEN
)
178 return -ENAMETOOLONG
;
180 if (info
->noresvport
)
181 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
183 nfs_init_timeout_values(&mnt_timeout
, info
->protocol
, timeo
, retrans
);
184 mnt_clnt
= rpc_create(&args
);
185 if (IS_ERR(mnt_clnt
))
188 if (info
->version
== NFS_MNT3_VERSION
)
189 msg
.rpc_proc
= &mnt_clnt
->cl_procinfo
[MOUNTPROC3_MNT
];
191 msg
.rpc_proc
= &mnt_clnt
->cl_procinfo
[MOUNTPROC_MNT
];
193 status
= rpc_call_sync(mnt_clnt
, &msg
, RPC_TASK_SOFT
|RPC_TASK_TIMEOUT
);
194 rpc_shutdown_client(mnt_clnt
);
198 if (result
.errno
!= 0)
201 dprintk("NFS: MNT request succeeded\n");
205 * If the server didn't provide a flavor list, allow the
206 * client to try any flavor.
208 if (info
->version
!= NFS_MNT3_VERSION
|| *info
->auth_flav_len
== 0) {
209 dprintk("NFS: Faking up auth_flavs list\n");
210 info
->auth_flavs
[0] = RPC_AUTH_NULL
;
211 *info
->auth_flav_len
= 1;
217 status
= PTR_ERR(mnt_clnt
);
218 dprintk("NFS: failed to create MNT RPC client, status=%d\n", status
);
222 dprintk("NFS: MNT request failed, status=%d\n", status
);
226 dprintk("NFS: MNT server returned result %d\n", result
.errno
);
227 status
= result
.errno
;
232 * nfs_umount - Notify a server that we have unmounted this export
233 * @info: pointer to umount request arguments
235 * MOUNTPROC_UMNT is advisory, so we set a short timeout, and always
238 void nfs_umount(const struct nfs_mount_request
*info
)
240 static const struct rpc_timeout nfs_umnt_timeout
= {
241 .to_initval
= 1 * HZ
,
245 struct rpc_create_args args
= {
247 .protocol
= IPPROTO_UDP
,
248 .address
= info
->sap
,
249 .addrsize
= info
->salen
,
250 .timeout
= &nfs_umnt_timeout
,
251 .servername
= info
->hostname
,
252 .program
= &mnt_program
,
253 .version
= info
->version
,
254 .authflavor
= RPC_AUTH_UNIX
,
255 .flags
= RPC_CLNT_CREATE_NOPING
,
256 .cred
= current_cred(),
258 struct rpc_message msg
= {
259 .rpc_argp
= info
->dirpath
,
261 struct rpc_clnt
*clnt
;
264 if (strlen(info
->dirpath
) > MNTPATHLEN
)
267 if (info
->noresvport
)
268 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
270 clnt
= rpc_create(&args
);
274 dprintk("NFS: sending UMNT request for %s:%s\n",
275 (info
->hostname
? info
->hostname
: "server"), info
->dirpath
);
277 if (info
->version
== NFS_MNT3_VERSION
)
278 msg
.rpc_proc
= &clnt
->cl_procinfo
[MOUNTPROC3_UMNT
];
280 msg
.rpc_proc
= &clnt
->cl_procinfo
[MOUNTPROC_UMNT
];
282 status
= rpc_call_sync(clnt
, &msg
, 0);
283 rpc_shutdown_client(clnt
);
285 if (unlikely(status
< 0))
291 dprintk("NFS: failed to create UMNT RPC client, status=%ld\n",
296 dprintk("NFS: UMNT request failed, status=%d\n", status
);
300 * XDR encode/decode functions for MOUNT
303 static void encode_mntdirpath(struct xdr_stream
*xdr
, const char *pathname
)
305 const u32 pathname_len
= strlen(pathname
);
308 p
= xdr_reserve_space(xdr
, 4 + pathname_len
);
309 xdr_encode_opaque(p
, pathname
, pathname_len
);
312 static void mnt_xdr_enc_dirpath(struct rpc_rqst
*req
, struct xdr_stream
*xdr
,
315 encode_mntdirpath(xdr
, dirpath
);
319 * RFC 1094: "A non-zero status indicates some sort of error. In this
320 * case, the status is a UNIX error number." This can be problematic
321 * if the server and client use different errno values for the same
324 * However, the OpenGroup XNFS spec provides a simple mapping that is
325 * independent of local errno values on the server and the client.
327 static int decode_status(struct xdr_stream
*xdr
, struct mountres
*res
)
333 p
= xdr_inline_decode(xdr
, 4);
334 if (unlikely(p
== NULL
))
336 status
= be32_to_cpup(p
);
338 for (i
= 0; i
< ARRAY_SIZE(mnt_errtbl
); i
++) {
339 if (mnt_errtbl
[i
].status
== status
) {
340 res
->errno
= mnt_errtbl
[i
].errno
;
345 dprintk("NFS: unrecognized MNT status code: %u\n", status
);
346 res
->errno
= -EACCES
;
350 static int decode_fhandle(struct xdr_stream
*xdr
, struct mountres
*res
)
352 struct nfs_fh
*fh
= res
->fh
;
355 p
= xdr_inline_decode(xdr
, NFS2_FHSIZE
);
356 if (unlikely(p
== NULL
))
359 fh
->size
= NFS2_FHSIZE
;
360 memcpy(fh
->data
, p
, NFS2_FHSIZE
);
364 static int mnt_xdr_dec_mountres(struct rpc_rqst
*req
,
365 struct xdr_stream
*xdr
,
368 struct mountres
*res
= data
;
371 status
= decode_status(xdr
, res
);
372 if (unlikely(status
!= 0 || res
->errno
!= 0))
374 return decode_fhandle(xdr
, res
);
377 static int decode_fhs_status(struct xdr_stream
*xdr
, struct mountres
*res
)
383 p
= xdr_inline_decode(xdr
, 4);
384 if (unlikely(p
== NULL
))
386 status
= be32_to_cpup(p
);
388 for (i
= 0; i
< ARRAY_SIZE(mnt3_errtbl
); i
++) {
389 if (mnt3_errtbl
[i
].status
== status
) {
390 res
->errno
= mnt3_errtbl
[i
].errno
;
395 dprintk("NFS: unrecognized MNT3 status code: %u\n", status
);
396 res
->errno
= -EACCES
;
400 static int decode_fhandle3(struct xdr_stream
*xdr
, struct mountres
*res
)
402 struct nfs_fh
*fh
= res
->fh
;
406 p
= xdr_inline_decode(xdr
, 4);
407 if (unlikely(p
== NULL
))
410 size
= be32_to_cpup(p
);
411 if (size
> NFS3_FHSIZE
|| size
== 0)
414 p
= xdr_inline_decode(xdr
, size
);
415 if (unlikely(p
== NULL
))
419 memcpy(fh
->data
, p
, size
);
423 static int decode_auth_flavors(struct xdr_stream
*xdr
, struct mountres
*res
)
425 rpc_authflavor_t
*flavors
= res
->auth_flavors
;
426 unsigned int *count
= res
->auth_count
;
433 p
= xdr_inline_decode(xdr
, 4);
434 if (unlikely(p
== NULL
))
436 entries
= be32_to_cpup(p
);
437 dprintk("NFS: received %u auth flavors\n", entries
);
438 if (entries
> NFS_MAX_SECFLAVORS
)
439 entries
= NFS_MAX_SECFLAVORS
;
441 p
= xdr_inline_decode(xdr
, 4 * entries
);
442 if (unlikely(p
== NULL
))
445 if (entries
> *count
)
448 for (i
= 0; i
< entries
; i
++) {
449 flavors
[i
] = be32_to_cpup(p
++);
450 dprintk("NFS: auth flavor[%u]: %d\n", i
, flavors
[i
]);
457 static int mnt_xdr_dec_mountres3(struct rpc_rqst
*req
,
458 struct xdr_stream
*xdr
,
461 struct mountres
*res
= data
;
464 status
= decode_fhs_status(xdr
, res
);
465 if (unlikely(status
!= 0 || res
->errno
!= 0))
467 status
= decode_fhandle3(xdr
, res
);
468 if (unlikely(status
!= 0)) {
469 res
->errno
= -EBADHANDLE
;
472 return decode_auth_flavors(xdr
, res
);
475 static const struct rpc_procinfo mnt_procedures
[] = {
477 .p_proc
= MOUNTPROC_MNT
,
478 .p_encode
= mnt_xdr_enc_dirpath
,
479 .p_decode
= mnt_xdr_dec_mountres
,
480 .p_arglen
= MNT_enc_dirpath_sz
,
481 .p_replen
= MNT_dec_mountres_sz
,
482 .p_statidx
= MOUNTPROC_MNT
,
486 .p_proc
= MOUNTPROC_UMNT
,
487 .p_encode
= mnt_xdr_enc_dirpath
,
488 .p_arglen
= MNT_enc_dirpath_sz
,
489 .p_statidx
= MOUNTPROC_UMNT
,
494 static const struct rpc_procinfo mnt3_procedures
[] = {
496 .p_proc
= MOUNTPROC3_MNT
,
497 .p_encode
= mnt_xdr_enc_dirpath
,
498 .p_decode
= mnt_xdr_dec_mountres3
,
499 .p_arglen
= MNT_enc_dirpath_sz
,
500 .p_replen
= MNT_dec_mountres3_sz
,
501 .p_statidx
= MOUNTPROC3_MNT
,
504 [MOUNTPROC3_UMNT
] = {
505 .p_proc
= MOUNTPROC3_UMNT
,
506 .p_encode
= mnt_xdr_enc_dirpath
,
507 .p_arglen
= MNT_enc_dirpath_sz
,
508 .p_statidx
= MOUNTPROC3_UMNT
,
513 static unsigned int mnt_counts
[ARRAY_SIZE(mnt_procedures
)];
514 static const struct rpc_version mnt_version1
= {
516 .nrprocs
= ARRAY_SIZE(mnt_procedures
),
517 .procs
= mnt_procedures
,
518 .counts
= mnt_counts
,
521 static unsigned int mnt3_counts
[ARRAY_SIZE(mnt3_procedures
)];
522 static const struct rpc_version mnt_version3
= {
524 .nrprocs
= ARRAY_SIZE(mnt3_procedures
),
525 .procs
= mnt3_procedures
,
526 .counts
= mnt3_counts
,
529 static const struct rpc_version
*mnt_version
[] = {
536 static struct rpc_stat mnt_stats
;
538 static const struct rpc_program mnt_program
= {
540 .number
= NFS_MNT_PROGRAM
,
541 .nrvers
= ARRAY_SIZE(mnt_version
),
542 .version
= mnt_version
,