2 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3 * Written by David Howells (dhowells@redhat.com)
5 #include <linux/module.h>
6 #include <linux/nfs_fs.h>
7 #include <linux/nfs_idmap.h>
8 #include <linux/nfs_mount.h>
9 #include <linux/sunrpc/auth.h>
10 #include <linux/sunrpc/xprt.h>
11 #include <linux/sunrpc/bc_xprt.h>
14 #include "delegation.h"
18 #define NFSDBG_FACILITY NFSDBG_CLIENT
21 * Turn off NFSv4 uid/gid mapping when using AUTH_SYS
23 static bool nfs4_disable_idmapping
= true;
26 * Get a unique NFSv4.0 callback identifier which will be used
27 * by the V4.0 callback service to lookup the nfs_client struct
29 static int nfs_get_cb_ident_idr(struct nfs_client
*clp
, int minorversion
)
32 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
34 if (clp
->rpc_ops
->version
!= 4 || minorversion
!= 0)
37 if (!idr_pre_get(&nn
->cb_ident_idr
, GFP_KERNEL
))
39 spin_lock(&nn
->nfs_client_lock
);
40 ret
= idr_get_new(&nn
->cb_ident_idr
, clp
, &clp
->cl_cb_ident
);
41 spin_unlock(&nn
->nfs_client_lock
);
47 #ifdef CONFIG_NFS_V4_1
48 static void nfs4_shutdown_session(struct nfs_client
*clp
)
50 if (nfs4_has_session(clp
)) {
51 nfs4_destroy_session(clp
->cl_session
);
52 nfs4_destroy_clientid(clp
);
56 #else /* CONFIG_NFS_V4_1 */
57 static void nfs4_shutdown_session(struct nfs_client
*clp
)
60 #endif /* CONFIG_NFS_V4_1 */
62 struct nfs_client
*nfs4_alloc_client(const struct nfs_client_initdata
*cl_init
)
65 struct nfs_client
*clp
= nfs_alloc_client(cl_init
);
69 err
= nfs_get_cb_ident_idr(clp
, cl_init
->minorversion
);
73 spin_lock_init(&clp
->cl_lock
);
74 INIT_DELAYED_WORK(&clp
->cl_renewd
, nfs4_renew_state
);
75 rpc_init_wait_queue(&clp
->cl_rpcwaitq
, "NFS client");
76 clp
->cl_state
= 1 << NFS4CLNT_LEASE_EXPIRED
;
77 clp
->cl_minorversion
= cl_init
->minorversion
;
78 clp
->cl_mvops
= nfs_v4_minor_ops
[cl_init
->minorversion
];
87 * Destroy the NFS4 callback service
89 static void nfs4_destroy_callback(struct nfs_client
*clp
)
91 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
92 nfs_callback_down(clp
->cl_mvops
->minor_version
);
95 static void nfs4_shutdown_client(struct nfs_client
*clp
)
97 if (__test_and_clear_bit(NFS_CS_RENEWD
, &clp
->cl_res_state
))
98 nfs4_kill_renewd(clp
);
99 nfs4_shutdown_session(clp
);
100 nfs4_destroy_callback(clp
);
101 if (__test_and_clear_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
))
102 nfs_idmap_delete(clp
);
104 rpc_destroy_wait_queue(&clp
->cl_rpcwaitq
);
105 kfree(clp
->cl_serverowner
);
106 kfree(clp
->cl_serverscope
);
107 kfree(clp
->cl_implid
);
110 void nfs4_free_client(struct nfs_client
*clp
)
112 nfs4_shutdown_client(clp
);
113 nfs_free_client(clp
);
117 * Initialize the NFS4 callback service
119 static int nfs4_init_callback(struct nfs_client
*clp
)
123 if (clp
->rpc_ops
->version
== 4) {
124 struct rpc_xprt
*xprt
;
126 xprt
= rcu_dereference_raw(clp
->cl_rpcclient
->cl_xprt
);
128 if (nfs4_has_session(clp
)) {
129 error
= xprt_setup_backchannel(xprt
,
130 NFS41_BC_MIN_CALLBACKS
);
135 error
= nfs_callback_up(clp
->cl_mvops
->minor_version
, xprt
);
137 dprintk("%s: failed to start callback. Error = %d\n",
141 __set_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
);
147 * Initialize the minor version specific parts of an NFS4 client record
149 static int nfs4_init_client_minor_version(struct nfs_client
*clp
)
151 #if defined(CONFIG_NFS_V4_1)
152 if (clp
->cl_mvops
->minor_version
) {
153 struct nfs4_session
*session
= NULL
;
155 * Create the session and mark it expired.
156 * When a SEQUENCE operation encounters the expired session
157 * it will do session recovery to initialize it.
159 session
= nfs4_alloc_session(clp
);
163 clp
->cl_session
= session
;
165 * The create session reply races with the server back
166 * channel probe. Mark the client NFS_CS_SESSION_INITING
167 * so that the client back channel can find the
170 nfs_mark_client_ready(clp
, NFS_CS_SESSION_INITING
);
172 #endif /* CONFIG_NFS_V4_1 */
174 return nfs4_init_callback(clp
);
178 * nfs4_init_client - Initialise an NFS4 client record
180 * @clp: nfs_client to initialise
181 * @timeparms: timeout parameters for underlying RPC transport
182 * @ip_addr: callback IP address in presentation format
183 * @authflavor: authentication flavor for underlying RPC transport
185 * Returns pointer to an NFS client, or an ERR_PTR value.
187 struct nfs_client
*nfs4_init_client(struct nfs_client
*clp
,
188 const struct rpc_timeout
*timeparms
,
190 rpc_authflavor_t authflavour
)
192 char buf
[INET6_ADDRSTRLEN
+ 1];
195 if (clp
->cl_cons_state
== NFS_CS_READY
) {
196 /* the client is initialised already */
197 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp
);
201 /* Check NFS protocol revision and initialize RPC op vector */
202 clp
->rpc_ops
= &nfs_v4_clientops
;
204 __set_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
);
205 error
= nfs_create_rpc_client(clp
, timeparms
, authflavour
);
209 /* If no clientaddr= option was specified, find a usable cb address */
210 if (ip_addr
== NULL
) {
211 struct sockaddr_storage cb_addr
;
212 struct sockaddr
*sap
= (struct sockaddr
*)&cb_addr
;
214 error
= rpc_localaddr(clp
->cl_rpcclient
, sap
, sizeof(cb_addr
));
217 error
= rpc_ntop(sap
, buf
, sizeof(buf
));
220 ip_addr
= (const char *)buf
;
222 strlcpy(clp
->cl_ipaddr
, ip_addr
, sizeof(clp
->cl_ipaddr
));
224 error
= nfs_idmap_new(clp
);
226 dprintk("%s: failed to create idmapper. Error = %d\n",
230 __set_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
);
232 error
= nfs4_init_client_minor_version(clp
);
236 if (!nfs4_has_session(clp
))
237 nfs_mark_client_ready(clp
, NFS_CS_READY
);
241 nfs_mark_client_ready(clp
, error
);
243 dprintk("<-- nfs4_init_client() = xerror %d\n", error
);
244 return ERR_PTR(error
);
247 static void nfs4_destroy_server(struct nfs_server
*server
)
249 nfs_server_return_all_delegations(server
);
250 unset_pnfs_layoutdriver(server
);
251 nfs4_purge_state_owners(server
);
255 * NFSv4.0 callback thread helper
257 * Find a client by callback identifier
260 nfs4_find_client_ident(struct net
*net
, int cb_ident
)
262 struct nfs_client
*clp
;
263 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
265 spin_lock(&nn
->nfs_client_lock
);
266 clp
= idr_find(&nn
->cb_ident_idr
, cb_ident
);
268 atomic_inc(&clp
->cl_count
);
269 spin_unlock(&nn
->nfs_client_lock
);
273 #if defined(CONFIG_NFS_V4_1)
274 /* Common match routine for v4.0 and v4.1 callback services */
275 static bool nfs4_cb_match_client(const struct sockaddr
*addr
,
276 struct nfs_client
*clp
, u32 minorversion
)
278 struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
280 /* Don't match clients that failed to initialise */
281 if (!(clp
->cl_cons_state
== NFS_CS_READY
||
282 clp
->cl_cons_state
== NFS_CS_SESSION_INITING
))
287 /* Match the version and minorversion */
288 if (clp
->rpc_ops
->version
!= 4 ||
289 clp
->cl_minorversion
!= minorversion
)
292 /* Match only the IP address, not the port number */
293 if (!nfs_sockaddr_match_ipaddr(addr
, clap
))
300 * NFSv4.1 callback thread helper
301 * For CB_COMPOUND calls, find a client by IP address, protocol version,
302 * minorversion, and sessionID
304 * Returns NULL if no such client
307 nfs4_find_client_sessionid(struct net
*net
, const struct sockaddr
*addr
,
308 struct nfs4_sessionid
*sid
)
310 struct nfs_client
*clp
;
311 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
313 spin_lock(&nn
->nfs_client_lock
);
314 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
315 if (nfs4_cb_match_client(addr
, clp
, 1) == false)
318 if (!nfs4_has_session(clp
))
322 if (memcmp(clp
->cl_session
->sess_id
.data
,
323 sid
->data
, NFS4_MAX_SESSIONID_LEN
) != 0)
326 atomic_inc(&clp
->cl_count
);
327 spin_unlock(&nn
->nfs_client_lock
);
330 spin_unlock(&nn
->nfs_client_lock
);
334 #else /* CONFIG_NFS_V4_1 */
337 nfs4_find_client_sessionid(struct net
*net
, const struct sockaddr
*addr
,
338 struct nfs4_sessionid
*sid
)
342 #endif /* CONFIG_NFS_V4_1 */
345 * Set up an NFS4 client
347 static int nfs4_set_client(struct nfs_server
*server
,
348 const char *hostname
,
349 const struct sockaddr
*addr
,
350 const size_t addrlen
,
352 rpc_authflavor_t authflavour
,
353 int proto
, const struct rpc_timeout
*timeparms
,
354 u32 minorversion
, struct net
*net
)
356 struct nfs_client_initdata cl_init
= {
357 .hostname
= hostname
,
360 .rpc_ops
= &nfs_v4_clientops
,
362 .minorversion
= minorversion
,
365 struct nfs_client
*clp
;
368 dprintk("--> nfs4_set_client()\n");
370 if (server
->flags
& NFS_MOUNT_NORESVPORT
)
371 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
373 /* Allocate or find a client reference we can use */
374 clp
= nfs_get_client(&cl_init
, timeparms
, ip_addr
, authflavour
);
376 error
= PTR_ERR(clp
);
381 * Query for the lease time on clientid setup or renewal
383 * Note that this will be set on nfs_clients that were created
384 * only for the DS role and did not set this bit, but now will
387 set_bit(NFS_CS_CHECK_LEASE_TIME
, &clp
->cl_res_state
);
389 server
->nfs_client
= clp
;
390 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp
);
393 dprintk("<-- nfs4_set_client() = xerror %d\n", error
);
398 * Set up a pNFS Data Server client.
400 * Return any existing nfs_client that matches server address,port,version
403 * For a new nfs_client, use a soft mount (default), a low retrans and a
404 * low timeout interval so that if a connection is lost, we retry through
407 struct nfs_client
*nfs4_set_ds_client(struct nfs_client
* mds_clp
,
408 const struct sockaddr
*ds_addr
, int ds_addrlen
,
409 int ds_proto
, unsigned int ds_timeo
, unsigned int ds_retrans
)
411 struct nfs_client_initdata cl_init
= {
413 .addrlen
= ds_addrlen
,
414 .rpc_ops
= &nfs_v4_clientops
,
416 .minorversion
= mds_clp
->cl_minorversion
,
417 .net
= mds_clp
->cl_net
,
419 struct rpc_timeout ds_timeout
;
420 struct nfs_client
*clp
;
423 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
424 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
425 * (section 13.1 RFC 5661).
427 nfs_init_timeout_values(&ds_timeout
, ds_proto
, ds_timeo
, ds_retrans
);
428 clp
= nfs_get_client(&cl_init
, &ds_timeout
, mds_clp
->cl_ipaddr
,
429 mds_clp
->cl_rpcclient
->cl_auth
->au_flavor
);
431 dprintk("<-- %s %p\n", __func__
, clp
);
434 EXPORT_SYMBOL_GPL(nfs4_set_ds_client
);
437 * Session has been established, and the client marked ready.
438 * Set the mount rsize and wsize with negotiated fore channel
439 * attributes which will be bound checked in nfs_server_set_fsinfo.
441 static void nfs4_session_set_rwsize(struct nfs_server
*server
)
443 #ifdef CONFIG_NFS_V4_1
444 struct nfs4_session
*sess
;
448 if (!nfs4_has_session(server
->nfs_client
))
450 sess
= server
->nfs_client
->cl_session
;
451 server_resp_sz
= sess
->fc_attrs
.max_resp_sz
- nfs41_maxread_overhead
;
452 server_rqst_sz
= sess
->fc_attrs
.max_rqst_sz
- nfs41_maxwrite_overhead
;
454 if (server
->rsize
> server_resp_sz
)
455 server
->rsize
= server_resp_sz
;
456 if (server
->wsize
> server_rqst_sz
)
457 server
->wsize
= server_rqst_sz
;
458 #endif /* CONFIG_NFS_V4_1 */
461 static int nfs4_server_common_setup(struct nfs_server
*server
,
462 struct nfs_fh
*mntfh
)
464 struct nfs_fattr
*fattr
;
467 BUG_ON(!server
->nfs_client
);
468 BUG_ON(!server
->nfs_client
->rpc_ops
);
469 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
471 /* data servers support only a subset of NFSv4.1 */
472 if (is_ds_only_client(server
->nfs_client
))
473 return -EPROTONOSUPPORT
;
475 fattr
= nfs_alloc_fattr();
479 /* We must ensure the session is initialised first */
480 error
= nfs4_init_session(server
);
484 /* Probe the root fh to retrieve its FSID and filehandle */
485 error
= nfs4_get_rootfh(server
, mntfh
);
489 dprintk("Server FSID: %llx:%llx\n",
490 (unsigned long long) server
->fsid
.major
,
491 (unsigned long long) server
->fsid
.minor
);
492 dprintk("Mount FH: %d\n", mntfh
->size
);
494 nfs4_session_set_rwsize(server
);
496 error
= nfs_probe_fsinfo(server
, mntfh
, fattr
);
500 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
501 server
->namelen
= NFS4_MAXNAMLEN
;
503 nfs_server_insert_lists(server
);
504 server
->mount_time
= jiffies
;
505 server
->destroy
= nfs4_destroy_server
;
507 nfs_free_fattr(fattr
);
512 * Create a version 4 volume record
514 static int nfs4_init_server(struct nfs_server
*server
,
515 const struct nfs_parsed_mount_data
*data
)
517 struct rpc_timeout timeparms
;
520 dprintk("--> nfs4_init_server()\n");
522 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
523 data
->timeo
, data
->retrans
);
525 /* Initialise the client representation from the mount data */
526 server
->flags
= data
->flags
;
527 server
->caps
|= NFS_CAP_ATOMIC_OPEN
|NFS_CAP_CHANGE_ATTR
|NFS_CAP_POSIX_LOCK
;
528 if (!(data
->flags
& NFS_MOUNT_NORDIRPLUS
))
529 server
->caps
|= NFS_CAP_READDIRPLUS
;
530 server
->options
= data
->options
;
532 /* Get a client record */
533 error
= nfs4_set_client(server
,
534 data
->nfs_server
.hostname
,
535 (const struct sockaddr
*)&data
->nfs_server
.address
,
536 data
->nfs_server
.addrlen
,
537 data
->client_address
,
538 data
->auth_flavors
[0],
539 data
->nfs_server
.protocol
,
547 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
550 if (nfs4_disable_idmapping
&& data
->auth_flavors
[0] == RPC_AUTH_UNIX
)
551 server
->caps
|= NFS_CAP_UIDGID_NOMAP
;
554 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
556 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
558 server
->acregmin
= data
->acregmin
* HZ
;
559 server
->acregmax
= data
->acregmax
* HZ
;
560 server
->acdirmin
= data
->acdirmin
* HZ
;
561 server
->acdirmax
= data
->acdirmax
* HZ
;
563 server
->port
= data
->nfs_server
.port
;
565 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
569 dprintk("<-- nfs4_init_server() = %d\n", error
);
574 * Create a version 4 volume record
575 * - keyed on server and FSID
577 struct nfs_server
*nfs4_create_server(const struct nfs_parsed_mount_data
*data
,
578 struct nfs_fh
*mntfh
)
580 struct nfs_server
*server
;
583 dprintk("--> nfs4_create_server()\n");
585 server
= nfs_alloc_server();
587 return ERR_PTR(-ENOMEM
);
589 /* set up the general RPC client */
590 error
= nfs4_init_server(server
, data
);
594 error
= nfs4_server_common_setup(server
, mntfh
);
598 dprintk("<-- nfs4_create_server() = %p\n", server
);
602 nfs_free_server(server
);
603 dprintk("<-- nfs4_create_server() = error %d\n", error
);
604 return ERR_PTR(error
);
608 * Create an NFS4 referral server record
610 struct nfs_server
*nfs4_create_referral_server(struct nfs_clone_mount
*data
,
611 struct nfs_fh
*mntfh
)
613 struct nfs_client
*parent_client
;
614 struct nfs_server
*server
, *parent_server
;
617 dprintk("--> nfs4_create_referral_server()\n");
619 server
= nfs_alloc_server();
621 return ERR_PTR(-ENOMEM
);
623 parent_server
= NFS_SB(data
->sb
);
624 parent_client
= parent_server
->nfs_client
;
626 /* Initialise the client representation from the parent server */
627 nfs_server_copy_userdata(server
, parent_server
);
628 server
->caps
|= NFS_CAP_ATOMIC_OPEN
|NFS_CAP_CHANGE_ATTR
;
630 /* Get a client representation.
631 * Note: NFSv4 always uses TCP, */
632 error
= nfs4_set_client(server
, data
->hostname
,
635 parent_client
->cl_ipaddr
,
637 rpc_protocol(parent_server
->client
),
638 parent_server
->client
->cl_timeout
,
639 parent_client
->cl_mvops
->minor_version
,
640 parent_client
->cl_net
);
644 error
= nfs_init_server_rpcclient(server
, parent_server
->client
->cl_timeout
, data
->authflavor
);
648 error
= nfs4_server_common_setup(server
, mntfh
);
652 dprintk("<-- nfs_create_referral_server() = %p\n", server
);
656 nfs_free_server(server
);
657 dprintk("<-- nfs4_create_referral_server() = error %d\n", error
);
658 return ERR_PTR(error
);
661 module_param(nfs4_disable_idmapping
, bool, 0644);
662 MODULE_PARM_DESC(nfs4_disable_idmapping
,
663 "Turn off NFSv4 idmapping when using 'sec=sys'");