1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* AFS cell and server record management
4 * Copyright (C) 2002, 2017 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #include <linux/slab.h>
10 #include <linux/ctype.h>
11 #include <linux/dns_resolver.h>
12 #include <linux/sched.h>
13 #include <linux/inet.h>
14 #include <linux/namei.h>
15 #include <keys/rxrpc-type.h>
18 static unsigned __read_mostly afs_cell_gc_delay = 10;
19 static unsigned __read_mostly afs_cell_min_ttl = 10 * 60;
20 static unsigned __read_mostly afs_cell_max_ttl = 24 * 60 * 60;
22 static void afs_manage_cell(struct work_struct *);
24 static void afs_dec_cells_outstanding(struct afs_net *net)
26 if (atomic_dec_and_test(&net->cells_outstanding))
27 wake_up_var(&net->cells_outstanding);
31 * Set the cell timer to fire after a given delay, assuming it's not already
32 * set for an earlier time.
34 static void afs_set_cell_timer(struct afs_net *net, time64_t delay)
37 atomic_inc(&net->cells_outstanding);
38 if (timer_reduce(&net->cells_timer, jiffies + delay * HZ))
39 afs_dec_cells_outstanding(net);
44 * Look up and get an activation reference on a cell record under RCU
45 * conditions. The caller must hold the RCU read lock.
47 struct afs_cell *afs_lookup_cell_rcu(struct afs_net *net,
48 const char *name, unsigned int namesz)
50 struct afs_cell *cell = NULL;
52 int n, seq = 0, ret = 0;
54 _enter("%*.*s", namesz, namesz, name);
56 if (name && namesz == 0)
57 return ERR_PTR(-EINVAL);
58 if (namesz > AFS_MAXCELLNAME)
59 return ERR_PTR(-ENAMETOOLONG);
62 /* Unfortunately, rbtree walking doesn't give reliable results
63 * under just the RCU read lock, so we have to check for
67 afs_put_cell(net, cell);
71 read_seqbegin_or_lock(&net->cells_lock, &seq);
74 cell = rcu_dereference_raw(net->ws_cell);
84 p = rcu_dereference_raw(net->cells.rb_node);
86 cell = rb_entry(p, struct afs_cell, net_node);
88 n = strncasecmp(cell->name, name,
89 min_t(size_t, cell->name_len, namesz));
91 n = cell->name_len - namesz;
93 p = rcu_dereference_raw(p->rb_left);
95 p = rcu_dereference_raw(p->rb_right);
97 if (atomic_inc_not_zero(&cell->usage)) {
101 /* We want to repeat the search, this time with
102 * the lock properly locked.
108 } while (need_seqretry(&net->cells_lock, seq));
110 done_seqretry(&net->cells_lock, seq);
112 if (ret != 0 && cell)
113 afs_put_cell(net, cell);
115 return ret == 0 ? cell : ERR_PTR(ret);
119 * Set up a cell record and fill in its name, VL server address list and
120 * allocate an anonymous key
122 static struct afs_cell *afs_alloc_cell(struct afs_net *net,
123 const char *name, unsigned int namelen,
124 const char *addresses)
126 struct afs_vlserver_list *vllist;
127 struct afs_cell *cell;
132 return ERR_PTR(-EINVAL);
133 if (namelen > AFS_MAXCELLNAME) {
134 _leave(" = -ENAMETOOLONG");
135 return ERR_PTR(-ENAMETOOLONG);
137 if (namelen == 5 && memcmp(name, "@cell", 5) == 0)
138 return ERR_PTR(-EINVAL);
140 _enter("%*.*s,%s", namelen, namelen, name, addresses);
142 cell = kzalloc(sizeof(struct afs_cell), GFP_KERNEL);
144 _leave(" = -ENOMEM");
145 return ERR_PTR(-ENOMEM);
149 cell->name_len = namelen;
150 for (i = 0; i < namelen; i++)
151 cell->name[i] = tolower(name[i]);
153 atomic_set(&cell->usage, 2);
154 INIT_WORK(&cell->manager, afs_manage_cell);
155 INIT_LIST_HEAD(&cell->proc_volumes);
156 rwlock_init(&cell->proc_lock);
157 rwlock_init(&cell->vl_servers_lock);
159 /* Provide a VL server list, filling it in if we were given a list of
163 vllist = afs_parse_text_addrs(net,
164 addresses, strlen(addresses), ':',
165 VL_SERVICE, AFS_VL_PORT);
166 if (IS_ERR(vllist)) {
167 ret = PTR_ERR(vllist);
171 vllist->source = DNS_RECORD_FROM_CONFIG;
172 vllist->status = DNS_LOOKUP_NOT_DONE;
173 cell->dns_expiry = TIME64_MAX;
176 vllist = afs_alloc_vlserver_list(0);
179 vllist->source = DNS_RECORD_UNAVAILABLE;
180 vllist->status = DNS_LOOKUP_NOT_DONE;
181 cell->dns_expiry = ktime_get_real_seconds();
184 rcu_assign_pointer(cell->vl_servers, vllist);
186 cell->dns_source = vllist->source;
187 cell->dns_status = vllist->status;
188 smp_store_release(&cell->dns_lookup_count, 1); /* vs source/status */
190 _leave(" = %p", cell);
195 printk(KERN_ERR "kAFS: bad VL server IP address\n");
198 _leave(" = %d", ret);
203 * afs_lookup_cell - Look up or create a cell record.
204 * @net: The network namespace
205 * @name: The name of the cell.
206 * @namesz: The strlen of the cell name.
207 * @vllist: A colon/comma separated list of numeric IP addresses or NULL.
208 * @excl: T if an error should be given if the cell name already exists.
210 * Look up a cell record by name and query the DNS for VL server addresses if
211 * needed. Note that that actual DNS query is punted off to the manager thread
212 * so that this function can return immediately if interrupted whilst allowing
213 * cell records to be shared even if not yet fully constructed.
215 struct afs_cell *afs_lookup_cell(struct afs_net *net,
216 const char *name, unsigned int namesz,
217 const char *vllist, bool excl)
219 struct afs_cell *cell, *candidate, *cursor;
220 struct rb_node *parent, **pp;
221 enum afs_cell_state state;
224 _enter("%s,%s", name, vllist);
228 cell = afs_lookup_cell_rcu(net, name, namesz);
234 /* Assume we're probably going to create a cell and preallocate and
235 * mostly set up a candidate record. We can then use this to stash the
236 * name, the net namespace and VL server addresses.
238 * We also want to do this before we hold any locks as it may involve
239 * upcalling to userspace to make DNS queries.
241 candidate = afs_alloc_cell(net, name, namesz, vllist);
242 if (IS_ERR(candidate)) {
243 _leave(" = %ld", PTR_ERR(candidate));
247 /* Find the insertion point and check to see if someone else added a
248 * cell whilst we were allocating.
250 write_seqlock(&net->cells_lock);
252 pp = &net->cells.rb_node;
256 cursor = rb_entry(parent, struct afs_cell, net_node);
258 n = strncasecmp(cursor->name, name,
259 min_t(size_t, cursor->name_len, namesz));
261 n = cursor->name_len - namesz;
263 pp = &(*pp)->rb_left;
265 pp = &(*pp)->rb_right;
267 goto cell_already_exists;
272 rb_link_node_rcu(&cell->net_node, parent, pp);
273 rb_insert_color(&cell->net_node, &net->cells);
274 atomic_inc(&net->cells_outstanding);
275 write_sequnlock(&net->cells_lock);
277 queue_work(afs_wq, &cell->manager);
280 _debug("wait_for_cell");
281 wait_var_event(&cell->state,
283 state = smp_load_acquire(&cell->state); /* vs error */
284 state == AFS_CELL_ACTIVE || state == AFS_CELL_FAILED;
287 /* Check the state obtained from the wait check. */
288 if (state == AFS_CELL_FAILED) {
293 _leave(" = %p [cell]", cell);
297 _debug("cell exists");
302 afs_get_cell(cursor);
305 write_sequnlock(&net->cells_lock);
311 afs_put_cell(net, cell);
313 _leave(" = %d [error]", ret);
318 * set the root cell information
319 * - can be called with a module parameter string
320 * - can be called from a write to /proc/fs/afs/rootcell
322 int afs_cell_init(struct afs_net *net, const char *rootcell)
324 struct afs_cell *old_root, *new_root;
325 const char *cp, *vllist;
331 /* module is loaded with no parameters, or built statically.
332 * - in the future we might initialize cell DB here.
334 _leave(" = 0 [no root]");
338 cp = strchr(rootcell, ':');
340 _debug("kAFS: no VL server IP addresses specified");
342 len = strlen(rootcell);
348 /* allocate a cell record for the root cell */
349 new_root = afs_lookup_cell(net, rootcell, len, vllist, false);
350 if (IS_ERR(new_root)) {
351 _leave(" = %ld", PTR_ERR(new_root));
352 return PTR_ERR(new_root);
355 if (!test_and_set_bit(AFS_CELL_FL_NO_GC, &new_root->flags))
356 afs_get_cell(new_root);
358 /* install the new cell */
359 write_seqlock(&net->cells_lock);
360 old_root = rcu_access_pointer(net->ws_cell);
361 rcu_assign_pointer(net->ws_cell, new_root);
362 write_sequnlock(&net->cells_lock);
364 afs_put_cell(net, old_root);
370 * Update a cell's VL server address list from the DNS.
372 static int afs_update_cell(struct afs_cell *cell)
374 struct afs_vlserver_list *vllist, *old = NULL, *p;
375 unsigned int min_ttl = READ_ONCE(afs_cell_min_ttl);
376 unsigned int max_ttl = READ_ONCE(afs_cell_max_ttl);
377 time64_t now, expiry = 0;
380 _enter("%s", cell->name);
382 vllist = afs_dns_query(cell, &expiry);
383 if (IS_ERR(vllist)) {
384 ret = PTR_ERR(vllist);
386 _debug("%s: fail %d", cell->name, ret);
391 vllist = afs_alloc_vlserver_list(0);
398 vllist->status = DNS_LOOKUP_GOT_NOT_FOUND;
402 vllist->status = DNS_LOOKUP_GOT_TEMP_FAILURE;
405 vllist->status = DNS_LOOKUP_GOT_LOCAL_FAILURE;
410 _debug("%s: got list %d %d", cell->name, vllist->source, vllist->status);
411 cell->dns_status = vllist->status;
413 now = ktime_get_real_seconds();
414 if (min_ttl > max_ttl)
416 if (expiry < now + min_ttl)
417 expiry = now + min_ttl;
418 else if (expiry > now + max_ttl)
419 expiry = now + max_ttl;
421 _debug("%s: status %d", cell->name, vllist->status);
422 if (vllist->source == DNS_RECORD_UNAVAILABLE) {
423 switch (vllist->status) {
424 case DNS_LOOKUP_GOT_NOT_FOUND:
425 /* The DNS said that the cell does not exist or there
426 * weren't any addresses to be had.
428 cell->dns_expiry = expiry;
432 case DNS_LOOKUP_GOT_LOCAL_FAILURE:
433 case DNS_LOOKUP_GOT_TEMP_FAILURE:
434 case DNS_LOOKUP_GOT_NS_FAILURE:
436 cell->dns_expiry = now + 10;
440 cell->dns_expiry = expiry;
443 /* Replace the VL server list if the new record has servers or the old
446 write_lock(&cell->vl_servers_lock);
447 p = rcu_dereference_protected(cell->vl_servers, true);
448 if (vllist->nr_servers > 0 || p->nr_servers == 0) {
449 rcu_assign_pointer(cell->vl_servers, vllist);
450 cell->dns_source = vllist->source;
453 write_unlock(&cell->vl_servers_lock);
454 afs_put_vlserverlist(cell->net, old);
457 smp_store_release(&cell->dns_lookup_count,
458 cell->dns_lookup_count + 1); /* vs source/status */
459 wake_up_var(&cell->dns_lookup_count);
460 _leave(" = %d", ret);
465 * Destroy a cell record
467 static void afs_cell_destroy(struct rcu_head *rcu)
469 struct afs_cell *cell = container_of(rcu, struct afs_cell, rcu);
471 _enter("%p{%s}", cell, cell->name);
473 ASSERTCMP(atomic_read(&cell->usage), ==, 0);
475 afs_put_vlserverlist(cell->net, rcu_access_pointer(cell->vl_servers));
476 key_put(cell->anonymous_key);
479 _leave(" [destroyed]");
483 * Queue the cell manager.
485 static void afs_queue_cell_manager(struct afs_net *net)
487 int outstanding = atomic_inc_return(&net->cells_outstanding);
489 _enter("%d", outstanding);
491 if (!queue_work(afs_wq, &net->cells_manager))
492 afs_dec_cells_outstanding(net);
496 * Cell management timer. We have an increment on cells_outstanding that we
497 * need to pass along to the work item.
499 void afs_cells_timer(struct timer_list *timer)
501 struct afs_net *net = container_of(timer, struct afs_net, cells_timer);
504 if (!queue_work(afs_wq, &net->cells_manager))
505 afs_dec_cells_outstanding(net);
509 * Get a reference on a cell record.
511 struct afs_cell *afs_get_cell(struct afs_cell *cell)
513 atomic_inc(&cell->usage);
518 * Drop a reference on a cell record.
520 void afs_put_cell(struct afs_net *net, struct afs_cell *cell)
522 time64_t now, expire_delay;
527 _enter("%s", cell->name);
529 now = ktime_get_real_seconds();
530 cell->last_inactive = now;
532 if (cell->vl_servers->nr_servers)
533 expire_delay = afs_cell_gc_delay;
535 if (atomic_dec_return(&cell->usage) > 1)
538 /* 'cell' may now be garbage collected. */
539 afs_set_cell_timer(net, expire_delay);
543 * Allocate a key to use as a placeholder for anonymous user security.
545 static int afs_alloc_anon_key(struct afs_cell *cell)
548 char keyname[4 + AFS_MAXCELLNAME + 1], *cp, *dp;
550 /* Create a key to represent an anonymous user. */
551 memcpy(keyname, "afs@", 4);
555 *dp++ = tolower(*cp);
558 key = rxrpc_get_null_key(keyname);
562 cell->anonymous_key = key;
564 _debug("anon key %p{%x}",
565 cell->anonymous_key, key_serial(cell->anonymous_key));
572 static int afs_activate_cell(struct afs_net *net, struct afs_cell *cell)
574 struct hlist_node **p;
575 struct afs_cell *pcell;
578 if (!cell->anonymous_key) {
579 ret = afs_alloc_anon_key(cell);
584 #ifdef CONFIG_AFS_FSCACHE
585 cell->cache = fscache_acquire_cookie(afs_cache_netfs.primary_index,
586 &afs_cell_cache_index_def,
587 cell->name, strlen(cell->name),
591 ret = afs_proc_cell_setup(cell);
595 mutex_lock(&net->proc_cells_lock);
596 for (p = &net->proc_cells.first; *p; p = &(*p)->next) {
597 pcell = hlist_entry(*p, struct afs_cell, proc_link);
598 if (strcmp(cell->name, pcell->name) < 0)
602 cell->proc_link.pprev = p;
603 cell->proc_link.next = *p;
604 rcu_assign_pointer(*p, &cell->proc_link.next);
605 if (cell->proc_link.next)
606 cell->proc_link.next->pprev = &cell->proc_link.next;
608 afs_dynroot_mkdir(net, cell);
609 mutex_unlock(&net->proc_cells_lock);
616 static void afs_deactivate_cell(struct afs_net *net, struct afs_cell *cell)
618 _enter("%s", cell->name);
620 afs_proc_cell_remove(cell);
622 mutex_lock(&net->proc_cells_lock);
623 hlist_del_rcu(&cell->proc_link);
624 afs_dynroot_rmdir(net, cell);
625 mutex_unlock(&net->proc_cells_lock);
627 #ifdef CONFIG_AFS_FSCACHE
628 fscache_relinquish_cookie(cell->cache, NULL, false);
636 * Manage a cell record, initialising and destroying it, maintaining its DNS
639 static void afs_manage_cell(struct work_struct *work)
641 struct afs_cell *cell = container_of(work, struct afs_cell, manager);
642 struct afs_net *net = cell->net;
646 _enter("%s", cell->name);
649 _debug("state %u", cell->state);
650 switch (cell->state) {
651 case AFS_CELL_INACTIVE:
652 case AFS_CELL_FAILED:
653 write_seqlock(&net->cells_lock);
655 deleted = atomic_try_cmpxchg_relaxed(&cell->usage, &usage, 0);
657 rb_erase(&cell->net_node, &net->cells);
658 write_sequnlock(&net->cells_lock);
660 goto final_destruction;
661 if (cell->state == AFS_CELL_FAILED)
663 smp_store_release(&cell->state, AFS_CELL_UNSET);
664 wake_up_var(&cell->state);
668 smp_store_release(&cell->state, AFS_CELL_ACTIVATING);
669 wake_up_var(&cell->state);
672 case AFS_CELL_ACTIVATING:
673 ret = afs_activate_cell(net, cell);
675 goto activation_failed;
677 smp_store_release(&cell->state, AFS_CELL_ACTIVE);
678 wake_up_var(&cell->state);
681 case AFS_CELL_ACTIVE:
682 if (atomic_read(&cell->usage) > 1) {
683 if (test_and_clear_bit(AFS_CELL_FL_DO_LOOKUP, &cell->flags)) {
684 ret = afs_update_cell(cell);
690 smp_store_release(&cell->state, AFS_CELL_DEACTIVATING);
691 wake_up_var(&cell->state);
694 case AFS_CELL_DEACTIVATING:
695 if (atomic_read(&cell->usage) > 1)
696 goto reverse_deactivation;
697 afs_deactivate_cell(net, cell);
698 smp_store_release(&cell->state, AFS_CELL_INACTIVE);
699 wake_up_var(&cell->state);
705 _debug("bad state %u", cell->state);
706 BUG(); /* Unhandled state */
710 afs_deactivate_cell(net, cell);
712 smp_store_release(&cell->state, AFS_CELL_FAILED); /* vs error */
713 wake_up_var(&cell->state);
716 reverse_deactivation:
717 smp_store_release(&cell->state, AFS_CELL_ACTIVE);
718 wake_up_var(&cell->state);
719 _leave(" [deact->act]");
723 _leave(" [done %u]", cell->state);
727 call_rcu(&cell->rcu, afs_cell_destroy);
728 afs_dec_cells_outstanding(net);
729 _leave(" [destruct %d]", atomic_read(&net->cells_outstanding));
733 * Manage the records of cells known to a network namespace. This includes
734 * updating the DNS records and garbage collecting unused cells that were
735 * automatically added.
737 * Note that constructed cell records may only be removed from net->cells by
738 * this work item, so it is safe for this work item to stash a cursor pointing
739 * into the tree and then return to caller (provided it skips cells that are
740 * still under construction).
742 * Note also that we were given an increment on net->cells_outstanding by
743 * whoever queued us that we need to deal with before returning.
745 void afs_manage_cells(struct work_struct *work)
747 struct afs_net *net = container_of(work, struct afs_net, cells_manager);
748 struct rb_node *cursor;
749 time64_t now = ktime_get_real_seconds(), next_manage = TIME64_MAX;
750 bool purging = !net->live;
754 /* Trawl the cell database looking for cells that have expired from
755 * lack of use and cells whose DNS results have expired and dispatch
758 read_seqlock_excl(&net->cells_lock);
760 for (cursor = rb_first(&net->cells); cursor; cursor = rb_next(cursor)) {
761 struct afs_cell *cell =
762 rb_entry(cursor, struct afs_cell, net_node);
764 bool sched_cell = false;
766 usage = atomic_read(&cell->usage);
767 _debug("manage %s %u", cell->name, usage);
769 ASSERTCMP(usage, >=, 1);
772 if (test_and_clear_bit(AFS_CELL_FL_NO_GC, &cell->flags))
773 usage = atomic_dec_return(&cell->usage);
774 ASSERTCMP(usage, ==, 1);
778 struct afs_vlserver_list *vllist;
779 time64_t expire_at = cell->last_inactive;
781 read_lock(&cell->vl_servers_lock);
782 vllist = rcu_dereference_protected(
784 lockdep_is_held(&cell->vl_servers_lock));
785 if (vllist->nr_servers > 0)
786 expire_at += afs_cell_gc_delay;
787 read_unlock(&cell->vl_servers_lock);
788 if (purging || expire_at <= now)
790 else if (expire_at < next_manage)
791 next_manage = expire_at;
795 if (test_bit(AFS_CELL_FL_DO_LOOKUP, &cell->flags))
800 queue_work(afs_wq, &cell->manager);
803 read_sequnlock_excl(&net->cells_lock);
805 /* Update the timer on the way out. We have to pass an increment on
806 * cells_outstanding in the namespace that we are in to the timer or
807 * the work scheduler.
809 if (!purging && next_manage < TIME64_MAX) {
810 now = ktime_get_real_seconds();
812 if (next_manage - now <= 0) {
813 if (queue_work(afs_wq, &net->cells_manager))
814 atomic_inc(&net->cells_outstanding);
816 afs_set_cell_timer(net, next_manage - now);
820 afs_dec_cells_outstanding(net);
821 _leave(" [%d]", atomic_read(&net->cells_outstanding));
825 * Purge in-memory cell database.
827 void afs_cell_purge(struct afs_net *net)
833 write_seqlock(&net->cells_lock);
834 ws = rcu_access_pointer(net->ws_cell);
835 RCU_INIT_POINTER(net->ws_cell, NULL);
836 write_sequnlock(&net->cells_lock);
837 afs_put_cell(net, ws);
840 if (del_timer_sync(&net->cells_timer))
841 atomic_dec(&net->cells_outstanding);
844 afs_queue_cell_manager(net);
847 wait_var_event(&net->cells_outstanding,
848 !atomic_read(&net->cells_outstanding));