NFS: Only initialize the ACL client in the v3 case
[linux-2.6-block.git] / fs / nfs / nfs4client.c
1 /*
2  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3  * Written by David Howells (dhowells@redhat.com)
4  */
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>
12 #include "internal.h"
13 #include "callback.h"
14 #include "delegation.h"
15 #include "pnfs.h"
16 #include "netns.h"
17
18 #define NFSDBG_FACILITY         NFSDBG_CLIENT
19
20 /*
21  * Turn off NFSv4 uid/gid mapping when using AUTH_SYS
22  */
23 static bool nfs4_disable_idmapping = true;
24
25 /*
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
28  */
29 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
30 {
31         int ret = 0;
32         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
33
34         if (clp->rpc_ops->version != 4 || minorversion != 0)
35                 return ret;
36 retry:
37         if (!idr_pre_get(&nn->cb_ident_idr, GFP_KERNEL))
38                 return -ENOMEM;
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);
42         if (ret == -EAGAIN)
43                 goto retry;
44         return ret;
45 }
46
47 #ifdef CONFIG_NFS_V4_1
48 static void nfs4_shutdown_session(struct nfs_client *clp)
49 {
50         if (nfs4_has_session(clp)) {
51                 nfs4_destroy_session(clp->cl_session);
52                 nfs4_destroy_clientid(clp);
53         }
54
55 }
56 #else /* CONFIG_NFS_V4_1 */
57 static void nfs4_shutdown_session(struct nfs_client *clp)
58 {
59 }
60 #endif /* CONFIG_NFS_V4_1 */
61
62 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *cl_init)
63 {
64         int err;
65         struct nfs_client *clp = nfs_alloc_client(cl_init);
66         if (IS_ERR(clp))
67                 return clp;
68
69         err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
70         if (err)
71                 goto error;
72
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];
79         return clp;
80
81 error:
82         kfree(clp);
83         return ERR_PTR(err);
84 }
85
86 /*
87  * Destroy the NFS4 callback service
88  */
89 static void nfs4_destroy_callback(struct nfs_client *clp)
90 {
91         if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
92                 nfs_callback_down(clp->cl_mvops->minor_version);
93 }
94
95 static void nfs4_shutdown_client(struct nfs_client *clp)
96 {
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);
103
104         rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
105         kfree(clp->cl_serverowner);
106         kfree(clp->cl_serverscope);
107         kfree(clp->cl_implid);
108 }
109
110 void nfs4_free_client(struct nfs_client *clp)
111 {
112         nfs4_shutdown_client(clp);
113         nfs_free_client(clp);
114 }
115
116 /*
117  * Initialize the NFS4 callback service
118  */
119 static int nfs4_init_callback(struct nfs_client *clp)
120 {
121         int error;
122
123         if (clp->rpc_ops->version == 4) {
124                 struct rpc_xprt *xprt;
125
126                 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
127
128                 if (nfs4_has_session(clp)) {
129                         error = xprt_setup_backchannel(xprt,
130                                                 NFS41_BC_MIN_CALLBACKS);
131                         if (error < 0)
132                                 return error;
133                 }
134
135                 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
136                 if (error < 0) {
137                         dprintk("%s: failed to start callback. Error = %d\n",
138                                 __func__, error);
139                         return error;
140                 }
141                 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
142         }
143         return 0;
144 }
145
146 /*
147  * Initialize the minor version specific parts of an NFS4 client record
148  */
149 static int nfs4_init_client_minor_version(struct nfs_client *clp)
150 {
151 #if defined(CONFIG_NFS_V4_1)
152         if (clp->cl_mvops->minor_version) {
153                 struct nfs4_session *session = NULL;
154                 /*
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.
158                  */
159                 session = nfs4_alloc_session(clp);
160                 if (!session)
161                         return -ENOMEM;
162
163                 clp->cl_session = session;
164                 /*
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
168                  * nfs_client struct
169                  */
170                 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
171         }
172 #endif /* CONFIG_NFS_V4_1 */
173
174         return nfs4_init_callback(clp);
175 }
176
177 /**
178  * nfs4_init_client - Initialise an NFS4 client record
179  *
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
184  *
185  * Returns pointer to an NFS client, or an ERR_PTR value.
186  */
187 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
188                                     const struct rpc_timeout *timeparms,
189                                     const char *ip_addr,
190                                     rpc_authflavor_t authflavour)
191 {
192         char buf[INET6_ADDRSTRLEN + 1];
193         int error;
194
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);
198                 return clp;
199         }
200
201         /* Check NFS protocol revision and initialize RPC op vector */
202         clp->rpc_ops = &nfs_v4_clientops;
203
204         __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
205         error = nfs_create_rpc_client(clp, timeparms, authflavour);
206         if (error < 0)
207                 goto error;
208
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;
213
214                 error = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
215                 if (error < 0)
216                         goto error;
217                 error = rpc_ntop(sap, buf, sizeof(buf));
218                 if (error < 0)
219                         goto error;
220                 ip_addr = (const char *)buf;
221         }
222         strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
223
224         error = nfs_idmap_new(clp);
225         if (error < 0) {
226                 dprintk("%s: failed to create idmapper. Error = %d\n",
227                         __func__, error);
228                 goto error;
229         }
230         __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
231
232         error = nfs4_init_client_minor_version(clp);
233         if (error < 0)
234                 goto error;
235
236         if (!nfs4_has_session(clp))
237                 nfs_mark_client_ready(clp, NFS_CS_READY);
238         return clp;
239
240 error:
241         nfs_mark_client_ready(clp, error);
242         nfs_put_client(clp);
243         dprintk("<-- nfs4_init_client() = xerror %d\n", error);
244         return ERR_PTR(error);
245 }
246
247 static void nfs4_destroy_server(struct nfs_server *server)
248 {
249         nfs_server_return_all_delegations(server);
250         unset_pnfs_layoutdriver(server);
251         nfs4_purge_state_owners(server);
252 }
253
254 /*
255  * NFSv4.0 callback thread helper
256  *
257  * Find a client by callback identifier
258  */
259 struct nfs_client *
260 nfs4_find_client_ident(struct net *net, int cb_ident)
261 {
262         struct nfs_client *clp;
263         struct nfs_net *nn = net_generic(net, nfs_net_id);
264
265         spin_lock(&nn->nfs_client_lock);
266         clp = idr_find(&nn->cb_ident_idr, cb_ident);
267         if (clp)
268                 atomic_inc(&clp->cl_count);
269         spin_unlock(&nn->nfs_client_lock);
270         return clp;
271 }
272
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)
277 {
278         struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
279
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))
283                 return false;
284
285         smp_rmb();
286
287         /* Match the version and minorversion */
288         if (clp->rpc_ops->version != 4 ||
289             clp->cl_minorversion != minorversion)
290                 return false;
291
292         /* Match only the IP address, not the port number */
293         if (!nfs_sockaddr_match_ipaddr(addr, clap))
294                 return false;
295
296         return true;
297 }
298
299 /*
300  * NFSv4.1 callback thread helper
301  * For CB_COMPOUND calls, find a client by IP address, protocol version,
302  * minorversion, and sessionID
303  *
304  * Returns NULL if no such client
305  */
306 struct nfs_client *
307 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
308                            struct nfs4_sessionid *sid)
309 {
310         struct nfs_client *clp;
311         struct nfs_net *nn = net_generic(net, nfs_net_id);
312
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)
316                         continue;
317
318                 if (!nfs4_has_session(clp))
319                         continue;
320
321                 /* Match sessionid*/
322                 if (memcmp(clp->cl_session->sess_id.data,
323                     sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
324                         continue;
325
326                 atomic_inc(&clp->cl_count);
327                 spin_unlock(&nn->nfs_client_lock);
328                 return clp;
329         }
330         spin_unlock(&nn->nfs_client_lock);
331         return NULL;
332 }
333
334 #else /* CONFIG_NFS_V4_1 */
335
336 struct nfs_client *
337 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
338                            struct nfs4_sessionid *sid)
339 {
340         return NULL;
341 }
342 #endif /* CONFIG_NFS_V4_1 */
343
344 /*
345  * Set up an NFS4 client
346  */
347 static int nfs4_set_client(struct nfs_server *server,
348                 const char *hostname,
349                 const struct sockaddr *addr,
350                 const size_t addrlen,
351                 const char *ip_addr,
352                 rpc_authflavor_t authflavour,
353                 int proto, const struct rpc_timeout *timeparms,
354                 u32 minorversion, struct net *net)
355 {
356         struct nfs_client_initdata cl_init = {
357                 .hostname = hostname,
358                 .addr = addr,
359                 .addrlen = addrlen,
360                 .nfs_mod = &nfs_v4,
361                 .proto = proto,
362                 .minorversion = minorversion,
363                 .net = net,
364         };
365         struct nfs_client *clp;
366         int error;
367
368         dprintk("--> nfs4_set_client()\n");
369
370         if (server->flags & NFS_MOUNT_NORESVPORT)
371                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
372
373         /* Allocate or find a client reference we can use */
374         clp = nfs_get_client(&cl_init, timeparms, ip_addr, authflavour);
375         if (IS_ERR(clp)) {
376                 error = PTR_ERR(clp);
377                 goto error;
378         }
379
380         /*
381          * Query for the lease time on clientid setup or renewal
382          *
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
385          * serve a dual role.
386          */
387         set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
388
389         server->nfs_client = clp;
390         dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
391         return 0;
392 error:
393         dprintk("<-- nfs4_set_client() = xerror %d\n", error);
394         return error;
395 }
396
397 /*
398  * Set up a pNFS Data Server client.
399  *
400  * Return any existing nfs_client that matches server address,port,version
401  * and minorversion.
402  *
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
405  * the MDS.
406  */
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)
410 {
411         struct nfs_client_initdata cl_init = {
412                 .addr = ds_addr,
413                 .addrlen = ds_addrlen,
414                 .nfs_mod = &nfs_v4,
415                 .proto = ds_proto,
416                 .minorversion = mds_clp->cl_minorversion,
417                 .net = mds_clp->cl_net,
418         };
419         struct rpc_timeout ds_timeout;
420         struct nfs_client *clp;
421
422         /*
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).
426          */
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);
430
431         dprintk("<-- %s %p\n", __func__, clp);
432         return clp;
433 }
434 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
435
436 /*
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.
440  */
441 static void nfs4_session_set_rwsize(struct nfs_server *server)
442 {
443 #ifdef CONFIG_NFS_V4_1
444         struct nfs4_session *sess;
445         u32 server_resp_sz;
446         u32 server_rqst_sz;
447
448         if (!nfs4_has_session(server->nfs_client))
449                 return;
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;
453
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 */
459 }
460
461 static int nfs4_server_common_setup(struct nfs_server *server,
462                 struct nfs_fh *mntfh)
463 {
464         struct nfs_fattr *fattr;
465         int error;
466
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);
470
471         /* data servers support only a subset of NFSv4.1 */
472         if (is_ds_only_client(server->nfs_client))
473                 return -EPROTONOSUPPORT;
474
475         fattr = nfs_alloc_fattr();
476         if (fattr == NULL)
477                 return -ENOMEM;
478
479         /* We must ensure the session is initialised first */
480         error = nfs4_init_session(server);
481         if (error < 0)
482                 goto out;
483
484         /* Probe the root fh to retrieve its FSID and filehandle */
485         error = nfs4_get_rootfh(server, mntfh);
486         if (error < 0)
487                 goto out;
488
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);
493
494         nfs4_session_set_rwsize(server);
495
496         error = nfs_probe_fsinfo(server, mntfh, fattr);
497         if (error < 0)
498                 goto out;
499
500         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
501                 server->namelen = NFS4_MAXNAMLEN;
502
503         nfs_server_insert_lists(server);
504         server->mount_time = jiffies;
505         server->destroy = nfs4_destroy_server;
506 out:
507         nfs_free_fattr(fattr);
508         return error;
509 }
510
511 /*
512  * Create a version 4 volume record
513  */
514 static int nfs4_init_server(struct nfs_server *server,
515                 const struct nfs_parsed_mount_data *data)
516 {
517         struct rpc_timeout timeparms;
518         int error;
519
520         dprintk("--> nfs4_init_server()\n");
521
522         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
523                         data->timeo, data->retrans);
524
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;
531
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,
540                         &timeparms,
541                         data->minorversion,
542                         data->net);
543         if (error < 0)
544                 goto error;
545
546         /*
547          * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
548          * authentication.
549          */
550         if (nfs4_disable_idmapping && data->auth_flavors[0] == RPC_AUTH_UNIX)
551                 server->caps |= NFS_CAP_UIDGID_NOMAP;
552
553         if (data->rsize)
554                 server->rsize = nfs_block_size(data->rsize, NULL);
555         if (data->wsize)
556                 server->wsize = nfs_block_size(data->wsize, NULL);
557
558         server->acregmin = data->acregmin * HZ;
559         server->acregmax = data->acregmax * HZ;
560         server->acdirmin = data->acdirmin * HZ;
561         server->acdirmax = data->acdirmax * HZ;
562
563         server->port = data->nfs_server.port;
564
565         error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
566
567 error:
568         /* Done */
569         dprintk("<-- nfs4_init_server() = %d\n", error);
570         return error;
571 }
572
573 /*
574  * Create a version 4 volume record
575  * - keyed on server and FSID
576  */
577 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
578                                       struct nfs_fh *mntfh)*/
579 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
580                                       struct nfs_subversion *nfs_mod)
581 {
582         struct nfs_server *server;
583         int error;
584
585         dprintk("--> nfs4_create_server()\n");
586
587         server = nfs_alloc_server();
588         if (!server)
589                 return ERR_PTR(-ENOMEM);
590
591         /* set up the general RPC client */
592         error = nfs4_init_server(server, mount_info->parsed);
593         if (error < 0)
594                 goto error;
595
596         error = nfs4_server_common_setup(server, mount_info->mntfh);
597         if (error < 0)
598                 goto error;
599
600         dprintk("<-- nfs4_create_server() = %p\n", server);
601         return server;
602
603 error:
604         nfs_free_server(server);
605         dprintk("<-- nfs4_create_server() = error %d\n", error);
606         return ERR_PTR(error);
607 }
608
609 /*
610  * Create an NFS4 referral server record
611  */
612 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
613                                                struct nfs_fh *mntfh)
614 {
615         struct nfs_client *parent_client;
616         struct nfs_server *server, *parent_server;
617         int error;
618
619         dprintk("--> nfs4_create_referral_server()\n");
620
621         server = nfs_alloc_server();
622         if (!server)
623                 return ERR_PTR(-ENOMEM);
624
625         parent_server = NFS_SB(data->sb);
626         parent_client = parent_server->nfs_client;
627
628         /* Initialise the client representation from the parent server */
629         nfs_server_copy_userdata(server, parent_server);
630         server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR;
631
632         /* Get a client representation.
633          * Note: NFSv4 always uses TCP, */
634         error = nfs4_set_client(server, data->hostname,
635                                 data->addr,
636                                 data->addrlen,
637                                 parent_client->cl_ipaddr,
638                                 data->authflavor,
639                                 rpc_protocol(parent_server->client),
640                                 parent_server->client->cl_timeout,
641                                 parent_client->cl_mvops->minor_version,
642                                 parent_client->cl_net);
643         if (error < 0)
644                 goto error;
645
646         error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
647         if (error < 0)
648                 goto error;
649
650         error = nfs4_server_common_setup(server, mntfh);
651         if (error < 0)
652                 goto error;
653
654         dprintk("<-- nfs_create_referral_server() = %p\n", server);
655         return server;
656
657 error:
658         nfs_free_server(server);
659         dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
660         return ERR_PTR(error);
661 }
662
663 module_param(nfs4_disable_idmapping, bool, 0644);
664 MODULE_PARM_DESC(nfs4_disable_idmapping,
665                 "Turn off NFSv4 idmapping when using 'sec=sys'");