1 /* Handle fileserver selection and rotation.
3 * Copyright (C) 2017 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
15 #include <linux/sched.h>
16 #include <linux/delay.h>
17 #include <linux/sched/signal.h>
22 * Initialise a filesystem server cursor for iterating over FS servers.
24 static void afs_init_fs_cursor(struct afs_fs_cursor *fc, struct afs_vnode *vnode)
26 memset(fc, 0, sizeof(*fc));
30 * Begin an operation on the fileserver.
32 * Fileserver operations are serialised on the server by vnode, so we serialise
33 * them here also using the io_lock.
35 bool afs_begin_vnode_operation(struct afs_fs_cursor *fc, struct afs_vnode *vnode,
38 afs_init_fs_cursor(fc, vnode);
41 fc->ac.error = SHRT_MAX;
43 if (mutex_lock_interruptible(&vnode->io_lock) < 0) {
44 fc->ac.error = -EINTR;
45 fc->flags |= AFS_FS_CURSOR_STOP;
49 if (vnode->lock_state != AFS_VNODE_LOCK_NONE)
50 fc->flags |= AFS_FS_CURSOR_CUR_ONLY;
55 * Begin iteration through a server list, starting with the vnode's last used
56 * server if possible, or the last recorded good server if not.
58 static bool afs_start_fs_iteration(struct afs_fs_cursor *fc,
59 struct afs_vnode *vnode)
61 struct afs_cb_interest *cbi;
64 read_lock(&vnode->volume->servers_lock);
65 fc->server_list = afs_get_serverlist(vnode->volume->servers);
66 read_unlock(&vnode->volume->servers_lock);
68 cbi = vnode->cb_interest;
70 /* See if the vnode's preferred record is still available */
71 for (i = 0; i < fc->server_list->nr_servers; i++) {
72 if (fc->server_list->servers[i].cb_interest == cbi) {
78 /* If we have a lock outstanding on a server that's no longer
79 * serving this vnode, then we can't switch to another server
80 * and have to return an error.
82 if (fc->flags & AFS_FS_CURSOR_CUR_ONLY) {
83 fc->ac.error = -ESTALE;
87 /* Note that the callback promise is effectively broken */
88 write_seqlock(&vnode->cb_lock);
89 ASSERTCMP(cbi, ==, vnode->cb_interest);
90 vnode->cb_interest = NULL;
91 if (test_and_clear_bit(AFS_VNODE_CB_PROMISED, &vnode->flags))
93 write_sequnlock(&vnode->cb_lock);
95 afs_put_cb_interest(afs_v2net(vnode), cbi);
98 fc->start = READ_ONCE(fc->server_list->index);
102 fc->index = fc->start;
107 * Post volume busy note.
109 static void afs_busy(struct afs_volume *volume, u32 abort_code)
113 switch (abort_code) {
114 case VOFFLINE: m = "offline"; break;
115 case VRESTARTING: m = "restarting"; break;
116 case VSALVAGING: m = "being salvaged"; break;
117 default: m = "busy"; break;
120 pr_notice("kAFS: Volume %u '%s' is %s\n", volume->vid, volume->name, m);
124 * Sleep and retry the operation to the same fileserver.
126 static bool afs_sleep_and_retry(struct afs_fs_cursor *fc)
128 msleep_interruptible(1000);
129 if (signal_pending(current)) {
130 fc->ac.error = -ERESTARTSYS;
138 * Select the fileserver to use. May be called multiple times to rotate
139 * through the fileservers.
141 bool afs_select_fileserver(struct afs_fs_cursor *fc)
143 struct afs_addr_list *alist;
144 struct afs_server *server;
145 struct afs_vnode *vnode = fc->vnode;
147 _enter("%u/%u,%u/%u,%d,%d",
148 fc->index, fc->start,
149 fc->ac.index, fc->ac.start,
150 fc->ac.error, fc->ac.abort_code);
152 if (fc->flags & AFS_FS_CURSOR_STOP) {
153 _leave(" = f [stopped]");
157 /* Evaluate the result of the previous operation, if there was one. */
158 switch (fc->ac.error) {
164 /* Success or local failure. Stop. */
165 fc->flags |= AFS_FS_CURSOR_STOP;
166 _leave(" = f [okay/local %d]", fc->ac.error);
170 /* The far side rejected the operation on some grounds. This
171 * might involve the server being busy or the volume having been moved.
173 switch (fc->ac.abort_code) {
175 /* This fileserver doesn't know about the volume.
176 * - May indicate that the VL is wrong - retry once and compare
178 * - May indicate that the fileserver couldn't attach to the vol.
180 if (fc->flags & AFS_FS_CURSOR_VNOVOL) {
181 fc->ac.error = -EREMOTEIO;
185 write_lock(&vnode->volume->servers_lock);
186 fc->server_list->vnovol_mask |= 1 << fc->index;
187 write_unlock(&vnode->volume->servers_lock);
189 set_bit(AFS_VOLUME_NEEDS_UPDATE, &vnode->volume->flags);
190 fc->ac.error = afs_check_volume_status(vnode->volume, fc->key);
191 if (fc->ac.error < 0)
194 if (test_bit(AFS_VOLUME_DELETED, &vnode->volume->flags)) {
195 fc->ac.error = -ENOMEDIUM;
199 /* If the server list didn't change, then assume that
200 * it's the fileserver having trouble.
202 if (vnode->volume->servers == fc->server_list) {
203 fc->ac.error = -EREMOTEIO;
208 fc->flags |= AFS_FS_CURSOR_VNOVOL;
209 _leave(" = t [vnovol]");
212 case VSALVAGE: /* TODO: Should this return an error or iterate? */
218 fc->ac.error = afs_abort_to_error(fc->ac.abort_code);
222 if (!test_and_set_bit(AFS_VOLUME_OFFLINE, &vnode->volume->flags)) {
223 afs_busy(vnode->volume, fc->ac.abort_code);
224 clear_bit(AFS_VOLUME_BUSY, &vnode->volume->flags);
226 if (fc->flags & AFS_FS_CURSOR_NO_VSLEEP) {
227 fc->ac.error = -EADV;
230 if (fc->flags & AFS_FS_CURSOR_CUR_ONLY) {
231 fc->ac.error = -ESTALE;
239 /* Retry after going round all the servers unless we
240 * have a file lock we need to maintain.
242 if (fc->flags & AFS_FS_CURSOR_NO_VSLEEP) {
243 fc->ac.error = -EBUSY;
246 if (!test_and_set_bit(AFS_VOLUME_BUSY, &vnode->volume->flags)) {
247 afs_busy(vnode->volume, fc->ac.abort_code);
248 clear_bit(AFS_VOLUME_OFFLINE, &vnode->volume->flags);
251 if (fc->flags & AFS_FS_CURSOR_CUR_ONLY) {
252 if (!afs_sleep_and_retry(fc))
255 /* Retry with same server & address */
256 _leave(" = t [vbusy]");
260 fc->flags |= AFS_FS_CURSOR_VBUSY;
264 /* The volume migrated to another server. We consider
265 * consider all locks and callbacks broken and request
266 * an update from the VLDB.
268 * We also limit the number of VMOVED hops we will
269 * honour, just in case someone sets up a loop.
271 if (fc->flags & AFS_FS_CURSOR_VMOVED) {
272 fc->ac.error = -EREMOTEIO;
275 fc->flags |= AFS_FS_CURSOR_VMOVED;
277 set_bit(AFS_VOLUME_WAIT, &vnode->volume->flags);
278 set_bit(AFS_VOLUME_NEEDS_UPDATE, &vnode->volume->flags);
279 fc->ac.error = afs_check_volume_status(vnode->volume, fc->key);
280 if (fc->ac.error < 0)
283 /* If the server list didn't change, then the VLDB is
284 * out of sync with the fileservers. This is hopefully
285 * a temporary condition, however, so we don't want to
286 * permanently block access to the file.
288 * TODO: Try other fileservers if we can.
290 * TODO: Retry a few times with sleeps.
292 if (vnode->volume->servers == fc->server_list) {
293 fc->ac.error = -ENOMEDIUM;
297 goto restart_from_beginning;
300 clear_bit(AFS_VOLUME_OFFLINE, &vnode->volume->flags);
301 clear_bit(AFS_VOLUME_BUSY, &vnode->volume->flags);
302 fc->ac.error = afs_abort_to_error(fc->ac.abort_code);
312 goto iterate_address;
315 _debug("call reset");
319 restart_from_beginning:
321 afs_end_cursor(&fc->ac);
322 afs_put_cb_interest(afs_v2net(vnode), fc->cbi);
324 afs_put_serverlist(afs_v2net(vnode), fc->server_list);
325 fc->server_list = NULL;
328 /* See if we need to do an update of the volume record. Note that the
329 * volume may have moved or even have been deleted.
331 fc->ac.error = afs_check_volume_status(vnode->volume, fc->key);
332 if (fc->ac.error < 0)
335 if (!afs_start_fs_iteration(fc, vnode))
340 /* We're starting on a different fileserver from the list. We need to
341 * check it, create a callback intercept, find its address list and
342 * probe its capabilities before we use it.
344 ASSERTCMP(fc->ac.alist, ==, NULL);
345 server = fc->server_list->servers[fc->index].server;
347 if (!afs_check_server_record(fc, server))
350 _debug("USING SERVER: %pU", &server->uuid);
352 /* Make sure we've got a callback interest record for this server. We
353 * have to link it in before we send the request as we can be sent a
354 * break request before we've finished decoding the reply and
355 * installing the vnode.
357 fc->ac.error = afs_register_server_cb_interest(vnode, fc->server_list,
359 if (fc->ac.error < 0)
362 fc->cbi = afs_get_cb_interest(vnode->cb_interest);
364 read_lock(&server->fs_lock);
365 alist = rcu_dereference_protected(server->addresses,
366 lockdep_is_held(&server->fs_lock));
367 afs_get_addrlist(alist);
368 read_unlock(&server->fs_lock);
370 memset(&fc->ac, 0, sizeof(fc->ac));
372 /* Probe the current fileserver if we haven't done so yet. */
373 if (!test_bit(AFS_SERVER_FL_PROBED, &server->flags)) {
374 fc->ac.alist = afs_get_addrlist(alist);
376 if (!afs_probe_fileserver(fc)) {
377 switch (fc->ac.error) {
389 fc->ac.alist = alist;
391 afs_put_addrlist(alist);
393 fc->ac.start = READ_ONCE(alist->index);
394 fc->ac.index = fc->ac.start;
397 ASSERT(fc->ac.alist);
398 _debug("iterate %d/%d", fc->ac.index, fc->ac.alist->nr_addrs);
399 /* Iterate over the current server's address list to try and find an
400 * address on which it will respond to us.
402 if (!afs_iterate_addresses(&fc->ac))
410 afs_end_cursor(&fc->ac);
411 afs_put_cb_interest(afs_v2net(vnode), fc->cbi);
414 if (fc->index >= fc->server_list->nr_servers)
416 if (fc->index != fc->start)
419 /* That's all the servers poked to no good effect. Try again if some
422 if (fc->flags & AFS_FS_CURSOR_VBUSY)
423 goto restart_from_beginning;
425 fc->ac.error = -EDESTADDRREQ;
429 fc->flags |= AFS_FS_CURSOR_STOP;
430 afs_end_cursor(&fc->ac);
431 _leave(" = f [failed %d]", fc->ac.error);
436 * Select the same fileserver we used for a vnode before and only that
437 * fileserver. We use this when we have a lock on that file, which is backed
438 * only by the fileserver we obtained it from.
440 bool afs_select_current_fileserver(struct afs_fs_cursor *fc)
442 struct afs_vnode *vnode = fc->vnode;
443 struct afs_cb_interest *cbi = vnode->cb_interest;
444 struct afs_addr_list *alist;
448 switch (fc->ac.error) {
451 fc->ac.error = -ESTALE;
452 fc->flags |= AFS_FS_CURSOR_STOP;
456 fc->cbi = afs_get_cb_interest(vnode->cb_interest);
458 read_lock(&cbi->server->fs_lock);
459 alist = rcu_dereference_protected(cbi->server->addresses,
460 lockdep_is_held(&cbi->server->fs_lock));
461 afs_get_addrlist(alist);
462 read_unlock(&cbi->server->fs_lock);
464 fc->ac.error = -ESTALE;
465 fc->flags |= AFS_FS_CURSOR_STOP;
469 memset(&fc->ac, 0, sizeof(fc->ac));
470 fc->ac.alist = alist;
471 fc->ac.start = READ_ONCE(alist->index);
472 fc->ac.index = fc->ac.start;
473 goto iterate_address;
477 /* Success or local failure. Stop. */
478 fc->flags |= AFS_FS_CURSOR_STOP;
479 _leave(" = f [okay/local %d]", fc->ac.error);
483 fc->flags |= AFS_FS_CURSOR_STOP;
484 _leave(" = f [abort]");
493 goto iterate_address;
497 /* Iterate over the current server's address list to try and find an
498 * address on which it will respond to us.
500 if (afs_iterate_addresses(&fc->ac)) {
505 afs_end_cursor(&fc->ac);
510 * Tidy up a filesystem cursor and unlock the vnode.
512 int afs_end_vnode_operation(struct afs_fs_cursor *fc)
514 struct afs_net *net = afs_v2net(fc->vnode);
517 mutex_unlock(&fc->vnode->io_lock);
519 afs_end_cursor(&fc->ac);
520 afs_put_cb_interest(net, fc->cbi);
521 afs_put_serverlist(net, fc->server_list);
524 if (ret == -ECONNABORTED)
525 afs_abort_to_error(fc->ac.abort_code);