afs: Defer volume record destruction to a workqueue
[linux-2.6-block.git] / fs / afs / internal.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
ec26815a 2/* internal AFS stuff
1da177e4 3 *
08e0e7c8 4 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
1da177e4 5 * Written by David Howells (dhowells@redhat.com)
1da177e4
LT
6 */
7
1da177e4
LT
8#include <linux/compiler.h>
9#include <linux/kernel.h>
8a79790b 10#include <linux/ktime.h>
1da177e4 11#include <linux/fs.h>
5970e15d 12#include <linux/filelock.h>
1da177e4 13#include <linux/pagemap.h>
08e0e7c8 14#include <linux/rxrpc.h>
00d3b7a4 15#include <linux/key.h>
e8edc6e0 16#include <linux/workqueue.h>
00c541ea 17#include <linux/sched.h>
80e50be4 18#include <linux/fscache.h>
e1da0222 19#include <linux/backing-dev.h>
ff548773 20#include <linux/uuid.h>
0722f186 21#include <linux/mm_types.h>
0a5143f2 22#include <linux/dns_resolver.h>
f044c884 23#include <net/net_namespace.h>
5b86d4ff
DH
24#include <net/netns/generic.h>
25#include <net/sock.h>
8324f0bc 26#include <net/af_rxrpc.h>
00c541ea 27
08e0e7c8
DH
28#include "afs.h"
29#include "afs_vl.h"
30
31#define AFS_CELL_MAX_ADDRS 15
32
31143d5d 33struct pagevec;
08e0e7c8 34struct afs_call;
c4508464 35struct afs_vnode;
f49b594d 36struct afs_server_probe;
08e0e7c8 37
6c6c1d63
DH
38/*
39 * Partial file-locking emulation mode. (The problem being that AFS3 only
40 * allows whole-file locks and no upgrading/downgrading).
41 */
42enum afs_flock_mode {
43 afs_flock_mode_unset,
44 afs_flock_mode_local, /* Local locking only */
45 afs_flock_mode_openafs, /* Don't get server lock for a partial lock */
46 afs_flock_mode_strict, /* Always get a server lock for a partial lock */
47 afs_flock_mode_write, /* Get an exclusive server lock for a partial lock */
48};
49
13fcc683 50struct afs_fs_context {
00d3b7a4 51 bool force; /* T to force cell type */
bec5eb61 52 bool autocell; /* T if set auto mount operation */
4d673da1 53 bool dyn_root; /* T if dynamic root */
13fcc683 54 bool no_cell; /* T if the source is "none" (for dynroot) */
6c6c1d63 55 enum afs_flock_mode flock_mode; /* Partial file-locking emulation mode */
00d3b7a4 56 afs_voltype_t type; /* type of volume requested */
13fcc683 57 unsigned int volnamesz; /* size of volume name */
00d3b7a4 58 const char *volname; /* name of volume to mount */
5b86d4ff 59 struct afs_net *net; /* the AFS net namespace stuff */
00d3b7a4
DH
60 struct afs_cell *cell; /* cell in which to find volume */
61 struct afs_volume *volume; /* volume record */
62 struct key *key; /* key to use for secure mounting */
63};
64
8e8d7f13 65enum afs_call_state {
98bf40cd
DH
66 AFS_CALL_CL_REQUESTING, /* Client: Request is being sent */
67 AFS_CALL_CL_AWAIT_REPLY, /* Client: Awaiting reply */
68 AFS_CALL_CL_PROC_REPLY, /* Client: rxrpc call complete; processing reply */
69 AFS_CALL_SV_AWAIT_OP_ID, /* Server: Awaiting op ID */
70 AFS_CALL_SV_AWAIT_REQUEST, /* Server: Awaiting request data */
71 AFS_CALL_SV_REPLYING, /* Server: Replying */
72 AFS_CALL_SV_AWAIT_ACK, /* Server: Awaiting final ACK */
73 AFS_CALL_COMPLETE, /* Completed or failed */
8e8d7f13 74};
f044c884 75
f94f70d3
DH
76/*
77 * Address preferences.
78 */
79struct afs_addr_preference {
80 union {
81 struct in_addr ipv4_addr; /* AF_INET address to compare against */
82 struct in6_addr ipv6_addr; /* AF_INET6 address to compare against */
83 };
84 sa_family_t family; /* Which address to use */
85 u16 prio; /* Priority */
86 u8 subnet_mask; /* How many bits to compare */
87};
88
89struct afs_addr_preference_list {
90 struct rcu_head rcu;
91 u16 version; /* Incremented when prefs list changes */
92 u8 ipv6_off; /* Offset of IPv6 addresses */
93 u8 nr; /* Number of addresses in total */
94 u8 max_prefs; /* Number of prefs allocated */
95 struct afs_addr_preference prefs[] __counted_by(max_prefs);
96};
97
72904d7b
DH
98struct afs_address {
99 struct rxrpc_peer *peer;
aa453bec 100 short last_error; /* Last error from this address */
d14cf8ed 101 u16 prio; /* Address priority */
72904d7b
DH
102};
103
8b2a464c
DH
104/*
105 * List of server addresses.
106 */
107struct afs_addr_list {
ddd2b85f 108 struct rcu_head rcu;
8b2a464c 109 refcount_t usage;
d2ddc776 110 u32 version; /* Version */
1e5d8493 111 unsigned int debug_id;
d14cf8ed 112 unsigned int addr_pref_version; /* Version of address preference list */
68eb64c3
DH
113 unsigned char max_addrs;
114 unsigned char nr_addrs;
3bf0fb6f 115 unsigned char preferred; /* Preferred address */
68eb64c3 116 unsigned char nr_ipv4; /* Number of IPv4 addresses */
0a5143f2
DH
117 enum dns_record_source source:8;
118 enum dns_lookup_status status:8;
aa4917d6 119 unsigned long probe_failed; /* Mask of addrs that failed locally/ICMP */
3bf0fb6f 120 unsigned long responded; /* Mask of addrs that responded */
72904d7b 121 struct afs_address addrs[] __counted_by(max_addrs);
68eb64c3 122#define AFS_MAX_ADDRESSES ((unsigned int)(sizeof(unsigned long) * 8))
8b2a464c
DH
123};
124
08e0e7c8
DH
125/*
126 * a record of an in-progress RxRPC call
127 */
128struct afs_call {
129 const struct afs_call_type *type; /* type of call */
08e0e7c8 130 wait_queue_head_t waitq; /* processes awaiting completion */
341f741f 131 struct work_struct async_work; /* async I/O processor */
08e0e7c8 132 struct work_struct work; /* actual work processor */
08e0e7c8 133 struct rxrpc_call *rxcall; /* RxRPC call handle */
e38f299e 134 struct rxrpc_peer *peer; /* Remote endpoint */
08e0e7c8 135 struct key *key; /* security for this call */
f044c884 136 struct afs_net *net; /* The network namespace */
a6853b9c
DH
137 struct afs_server *server; /* The fileserver record if fs op (pins ref) */
138 struct afs_vlserver *vlserver; /* The vlserver record if vl op */
08e0e7c8 139 void *request; /* request data (first part) */
f105da1a 140 size_t iov_len; /* Size of *iter to be used */
fc276122 141 struct iov_iter def_iter; /* Default buffer/data iterator */
bd80d8a8 142 struct iov_iter *write_iter; /* Iterator defining write to be made */
fc276122
DH
143 struct iov_iter *iter; /* Iterator currently in use */
144 union { /* Convenience for ->def_iter */
12bdcf33
DH
145 struct kvec kvec[1];
146 struct bio_vec bvec[1];
147 };
08e0e7c8 148 void *buffer; /* reply receive buffer */
ffba718e 149 union {
f49b594d
DH
150 struct afs_endpoint_state *probe;
151 struct afs_addr_list *vl_probe;
ffba718e
DH
152 struct afs_addr_list *ret_alist;
153 struct afs_vldb_entry *ret_vldb;
c3e9f888 154 char *ret_str;
ffba718e 155 };
f49b594d 156 unsigned char probe_index; /* Address in ->probe_alist */
e49c7b2f 157 struct afs_operation *op;
ffba718e 158 unsigned int server_index;
c56f9ec8 159 refcount_t ref;
8e8d7f13 160 enum afs_call_state state;
98bf40cd 161 spinlock_t state_lock;
08e0e7c8 162 int error; /* error code */
d001648e 163 u32 abort_code; /* Remote abort ID or 0 */
db099c62 164 unsigned int max_lifespan; /* Maximum lifespan in secs to set if not 0 */
08e0e7c8
DH
165 unsigned request_size; /* size of request data */
166 unsigned reply_max; /* maximum size of reply */
e49c7b2f 167 unsigned count2; /* count used in unmarshalling */
08e0e7c8 168 unsigned char unmarshall; /* unmarshalling phase */
dde9f095 169 bool drop_ref; /* T if need to drop ref for incoming call */
d001648e 170 bool need_attention; /* T if RxRPC poked us */
56ff9c83 171 bool async; /* T if asynchronous */
a68f4a27 172 bool upgrade; /* T to request service upgrade */
20b8391f 173 bool intr; /* T if interruptible */
38355eec 174 bool unmarshalling_error; /* T if an unmarshalling error occurred */
aa453bec 175 bool responded; /* Got a response from the call (may be abort) */
bf99a53c 176 u16 service_id; /* Actual service ID (after upgrade) */
a25e21f0 177 unsigned int debug_id; /* Trace ID */
50a2c953 178 u32 operation_ID; /* operation ID for an incoming call */
08e0e7c8 179 u32 count; /* count for use in unmarshalling */
12bdcf33
DH
180 union { /* place to extract temporary data */
181 struct {
182 __be32 tmp_u;
183 __be32 tmp;
184 } __attribute__((packed));
185 __be64 tmp64;
186 };
7903192c 187 ktime_t issue_time; /* Time of issue of operation */
08e0e7c8
DH
188};
189
190struct afs_call_type {
00d3b7a4 191 const char *name;
025db80c 192 unsigned int op; /* Really enum afs_fs_operation */
00d3b7a4 193
08e0e7c8
DH
194 /* deliver request or reply data to an call
195 * - returning an error will cause the call to be aborted
196 */
d001648e 197 int (*deliver)(struct afs_call *call);
08e0e7c8 198
08e0e7c8
DH
199 /* clean up a call */
200 void (*destructor)(struct afs_call *call);
341f741f
DH
201
202 /* Work function */
203 void (*work)(struct work_struct *work);
3bf0fb6f
DH
204
205 /* Call done function (gets called immediately on success or failure) */
206 void (*done)(struct afs_call *call);
08e0e7c8
DH
207};
208
4343d008
DH
209/*
210 * Key available for writeback on a file.
211 */
212struct afs_wb_key {
213 refcount_t usage;
214 struct key *key;
215 struct list_head vnode_link; /* Link in vnode->wb_keys */
216};
217
215804a9
DH
218/*
219 * AFS open file information record. Pointed to by file->private_data.
220 */
221struct afs_file {
222 struct key *key; /* The key this file was opened with */
4343d008 223 struct afs_wb_key *wb; /* Writeback key record for this file */
215804a9
DH
224};
225
226static inline struct key *afs_file_key(struct file *file)
227{
228 struct afs_file *af = file->private_data;
229
230 return af->key;
231}
232
196ee9cd
DH
233/*
234 * Record of an outstanding read operation on a vnode.
235 */
236struct afs_read {
237 loff_t pos; /* Where to start reading */
e8e581a8 238 loff_t len; /* How much we're asking for */
196ee9cd 239 loff_t actual_len; /* How much we're actually getting */
f3ddee8d 240 loff_t file_size; /* File size returned by server */
c69bf479 241 struct key *key; /* The key to use to reissue the read */
c4508464 242 struct afs_vnode *vnode; /* The file being read into. */
6a19114b 243 struct netfs_io_subrequest *subreq; /* Fscache helper read request this belongs to */
f3ddee8d
DH
244 afs_dataversion_t data_version; /* Version number returned by server */
245 refcount_t usage;
c4508464 246 unsigned int call_debug_id;
196ee9cd 247 unsigned int nr_pages;
c4508464
DH
248 int error;
249 void (*done)(struct afs_read *);
250 void (*cleanup)(struct afs_read *);
251 struct iov_iter *iter; /* Iterator representing the buffer */
252 struct iov_iter def_iter; /* Default iterator */
196ee9cd
DH
253};
254
08e0e7c8
DH
255/*
256 * AFS superblock private data
257 * - there's one superblock per volume
258 */
259struct afs_super_info {
5b86d4ff 260 struct net *net_ns; /* Network namespace */
49566f6f 261 struct afs_cell *cell; /* The cell in which the volume resides */
08e0e7c8 262 struct afs_volume *volume; /* volume record */
6c6c1d63 263 enum afs_flock_mode flock_mode:8; /* File locking emulation mode */
4d673da1 264 bool dyn_root; /* True if dynamic root */
08e0e7c8 265};
1da177e4 266
08e0e7c8
DH
267static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
268{
269 return sb->s_fs_info;
1da177e4
LT
270}
271
08e0e7c8
DH
272extern struct file_system_type afs_fs_type;
273
6f8880d8
DH
274/*
275 * Set of substitutes for @sys.
276 */
277struct afs_sysnames {
278#define AFS_NR_SYSNAME 16
279 char *subs[AFS_NR_SYSNAME];
280 refcount_t usage;
281 unsigned short nr;
6f8880d8
DH
282 char blank[1];
283};
284
f044c884
DH
285/*
286 * AFS network namespace record.
287 */
288struct afs_net {
5b86d4ff 289 struct net *net; /* Backpointer to the owning net namespace */
f044c884
DH
290 struct afs_uuid uuid;
291 bool live; /* F if this namespace is being removed */
292
293 /* AF_RXRPC I/O stuff */
294 struct socket *socket;
295 struct afs_call *spare_incoming_call;
296 struct work_struct charge_preallocation_work;
297 struct mutex socket_mutex;
298 atomic_t nr_outstanding_calls;
299 atomic_t nr_superblocks;
300
301 /* Cell database */
989782dc 302 struct rb_root cells;
92e3cc91 303 struct afs_cell *ws_cell;
989782dc
DH
304 struct work_struct cells_manager;
305 struct timer_list cells_timer;
306 atomic_t cells_outstanding;
92e3cc91 307 struct rw_semaphore cells_lock;
8a070a96 308 struct mutex cells_alias_lock;
f044c884 309
0da0b7fd 310 struct mutex proc_cells_lock;
6b3944e4 311 struct hlist_head proc_cells;
f044c884 312
d2ddc776
DH
313 /* Known servers. Theoretically each fileserver can only be in one
314 * cell, but in practice, people create aliases and subsets and there's
315 * no easy way to distinguish them.
316 */
f6cbb368 317 seqlock_t fs_lock; /* For fs_servers, fs_probe_*, fs_proc */
d2ddc776 318 struct rb_root fs_servers; /* afs_server (by server UUID or address) */
f6cbb368
DH
319 struct list_head fs_probe_fast; /* List of afs_server to probe at 30s intervals */
320 struct list_head fs_probe_slow; /* List of afs_server to probe at 5m intervals */
d2ddc776 321 struct hlist_head fs_proc; /* procfs servers list */
f044c884 322
d2ddc776
DH
323 struct hlist_head fs_addresses4; /* afs_server (by lowest IPv4 addr) */
324 struct hlist_head fs_addresses6; /* afs_server (by lowest IPv6 addr) */
325 seqlock_t fs_addr_lock; /* For fs_addresses[46] */
f044c884 326
d2ddc776
DH
327 struct work_struct fs_manager;
328 struct timer_list fs_timer;
f6cbb368
DH
329
330 struct work_struct fs_prober;
331 struct timer_list fs_probe_timer;
59fa1c4a 332 atomic_t servers_outstanding;
f044c884 333
d2ddc776
DH
334 /* File locking renewal management */
335 struct mutex lock_manager_mutex;
336
f044c884 337 /* Misc */
0da0b7fd 338 struct super_block *dynroot_sb; /* Dynamic root mount superblock */
d55b4da4 339 struct proc_dir_entry *proc_afs; /* /proc/net/afs directory */
6f8880d8
DH
340 struct afs_sysnames *sysnames;
341 rwlock_t sysnames_lock;
f94f70d3
DH
342 struct afs_addr_preference_list __rcu *address_prefs;
343 u16 address_pref_version;
d55b4da4
DH
344
345 /* Statistics counters */
346 atomic_t n_lookup; /* Number of lookups done */
347 atomic_t n_reval; /* Number of dentries needing revalidation */
348 atomic_t n_inval; /* Number of invalidations by the server */
508cae68 349 atomic_t n_relpg; /* Number of invalidations by release_folio */
d55b4da4 350 atomic_t n_read_dir; /* Number of directory pages read */
63a4681f
DH
351 atomic_t n_dir_cr; /* Number of directory entry creation edits */
352 atomic_t n_dir_rm; /* Number of directory entry removal edits */
76a5cb6f
DH
353 atomic_t n_stores; /* Number of store ops */
354 atomic_long_t n_store_bytes; /* Number of bytes stored */
355 atomic_long_t n_fetch_bytes; /* Number of bytes fetched */
356 atomic_t n_fetches; /* Number of data fetch ops */
f044c884
DH
357};
358
6f8880d8 359extern const char afs_init_sysname[];
f044c884 360
989782dc
DH
361enum afs_cell_state {
362 AFS_CELL_UNSET,
363 AFS_CELL_ACTIVATING,
364 AFS_CELL_ACTIVE,
365 AFS_CELL_DEACTIVATING,
366 AFS_CELL_INACTIVE,
367 AFS_CELL_FAILED,
1d0e850a 368 AFS_CELL_REMOVED,
989782dc
DH
369};
370
08e0e7c8 371/*
d2ddc776
DH
372 * AFS cell record.
373 *
374 * This is a tricky concept to get right as it is possible to create aliases
375 * simply by pointing AFSDB/SRV records for two names at the same set of VL
376 * servers; it is also possible to do things like setting up two sets of VL
377 * servers, one of which provides a superset of the volumes provided by the
378 * other (for internal/external division, for example).
379 *
380 * Cells only exist in the sense that (a) a cell's name maps to a set of VL
381 * servers and (b) a cell's name is used by the client to select the key to use
382 * for authentication and encryption. The cell name is not typically used in
383 * the protocol.
384 *
8a070a96
DH
385 * Two cells are determined to be aliases if they have an explicit alias (YFS
386 * only), share any VL servers in common or have at least one volume in common.
387 * "In common" means that the address list of the VL servers or the fileservers
388 * share at least one endpoint.
08e0e7c8
DH
389 */
390struct afs_cell {
989782dc
DH
391 union {
392 struct rcu_head rcu;
393 struct rb_node net_node; /* Node in net->cells */
394 };
395 struct afs_net *net;
8a070a96
DH
396 struct afs_cell *alias_of; /* The cell this is an alias of */
397 struct afs_volume *root_volume; /* The root.cell volume if there is one */
00d3b7a4 398 struct key *anonymous_key; /* anonymous user key for this cell */
989782dc 399 struct work_struct manager; /* Manager for init/deinit/dns */
6b3944e4 400 struct hlist_node proc_link; /* /proc cell list link */
989782dc
DH
401 time64_t dns_expiry; /* Time AFSDB/SRV record expires */
402 time64_t last_inactive; /* Time of last drop of usage count */
c56f9ec8 403 refcount_t ref; /* Struct refcount */
88c853c3 404 atomic_t active; /* Active usage counter */
989782dc 405 unsigned long flags;
d5c32c89
DH
406#define AFS_CELL_FL_NO_GC 0 /* The cell was added manually, don't auto-gc */
407#define AFS_CELL_FL_DO_LOOKUP 1 /* DNS lookup requested */
8a070a96 408#define AFS_CELL_FL_CHECK_ALIAS 2 /* Need to check for aliases */
989782dc
DH
409 enum afs_cell_state state;
410 short error;
d5c32c89
DH
411 enum dns_record_source dns_source:8; /* Latest source of data from lookup */
412 enum dns_lookup_status dns_status:8; /* Latest status of data from lookup */
413 unsigned int dns_lookup_count; /* Counter of DNS lookups */
dca54a7b 414 unsigned int debug_id;
989782dc 415
20325960 416 /* The volumes belonging to this cell */
ca0e79a4 417 spinlock_t vs_lock; /* Lock for server->volumes */
20325960
DH
418 struct rb_root volumes; /* Tree of volumes on this server */
419 struct hlist_head proc_volumes; /* procfs volume list */
420 seqlock_t volume_lock; /* For volumes */
421
d2ddc776 422 /* Active fileserver interaction state. */
20325960
DH
423 struct rb_root fs_servers; /* afs_server (by server UUID) */
424 seqlock_t fs_lock; /* For fs_servers */
6e0e99d5
DH
425 struct rw_semaphore fs_open_mmaps_lock;
426 struct list_head fs_open_mmaps; /* List of vnodes that are mmapped */
4fe6a946 427 atomic_t fs_s_break; /* Counter of CB.InitCallBackState messages */
989782dc 428
d2ddc776 429 /* VL server list. */
0a5143f2
DH
430 rwlock_t vl_servers_lock; /* Lock on vl_servers */
431 struct afs_vlserver_list __rcu *vl_servers;
432
989782dc 433 u8 name_len; /* Length of name */
719fdd32 434 char *name; /* Cell name, case-flattened and NUL-padded */
08e0e7c8
DH
435};
436
0a5143f2
DH
437/*
438 * Volume Location server record.
439 */
440struct afs_vlserver {
441 struct rcu_head rcu;
442 struct afs_addr_list __rcu *addresses; /* List of addresses for this VL server */
443 unsigned long flags;
444#define AFS_VLSERVER_FL_PROBED 0 /* The VL server has been probed */
445#define AFS_VLSERVER_FL_PROBING 1 /* VL server is being probed */
3bf0fb6f 446#define AFS_VLSERVER_FL_IS_YFS 2 /* Server is YFS not AFS */
b95b3094 447#define AFS_VLSERVER_FL_RESPONDING 3 /* VL server is responding */
0a5143f2 448 rwlock_t lock; /* Lock on addresses */
c56f9ec8 449 refcount_t ref;
b95b3094 450 unsigned int rtt; /* Server's current RTT in uS */
e6a7d7f7 451 unsigned int debug_id;
3bf0fb6f
DH
452
453 /* Probe state */
454 wait_queue_head_t probe_wq;
455 atomic_t probe_outstanding;
456 spinlock_t probe_lock;
457 struct {
72904d7b 458 unsigned int rtt; /* Best RTT in uS (or UINT_MAX) */
3bf0fb6f
DH
459 u32 abort_code;
460 short error;
fb72cd3d
DH
461 unsigned short flags;
462#define AFS_VLSERVER_PROBE_RESPONDED 0x01 /* At least once response (may be abort) */
463#define AFS_VLSERVER_PROBE_IS_YFS 0x02 /* The peer appears to be YFS */
464#define AFS_VLSERVER_PROBE_NOT_YFS 0x04 /* The peer appears not to be YFS */
465#define AFS_VLSERVER_PROBE_LOCAL_FAILURE 0x08 /* A local failure prevented a probe */
3bf0fb6f
DH
466 } probe;
467
e38f299e 468 u16 service_id; /* Service ID we're using */
0a5143f2 469 u16 port;
3bf0fb6f 470 u16 name_len; /* Length of name */
0a5143f2
DH
471 char name[]; /* Server name, case-flattened */
472};
473
474/*
475 * Weighted list of Volume Location servers.
476 */
477struct afs_vlserver_entry {
478 u16 priority; /* Preference (as SRV) */
479 u16 weight; /* Weight (as SRV) */
480 enum dns_record_source source:8;
481 enum dns_lookup_status status:8;
482 struct afs_vlserver *server;
483};
484
485struct afs_vlserver_list {
486 struct rcu_head rcu;
c56f9ec8 487 refcount_t ref;
0a5143f2
DH
488 u8 nr_servers;
489 u8 index; /* Server currently in use */
3bf0fb6f 490 u8 preferred; /* Preferred server */
0a5143f2
DH
491 enum dns_record_source source:8;
492 enum dns_lookup_status status:8;
493 rwlock_t lock;
494 struct afs_vlserver_entry servers[];
495};
496
08e0e7c8 497/*
d2ddc776
DH
498 * Cached VLDB entry.
499 *
500 * This is pointed to by cell->vldb_entries, indexed by name.
08e0e7c8 501 */
d2ddc776
DH
502struct afs_vldb_entry {
503 afs_volid_t vid[3]; /* Volume IDs for R/W, R/O and Bak volumes */
00d3b7a4 504
d2ddc776
DH
505 unsigned long flags;
506#define AFS_VLDB_HAS_RW 0 /* - R/W volume exists */
507#define AFS_VLDB_HAS_RO 1 /* - R/O volume exists */
508#define AFS_VLDB_HAS_BAK 2 /* - Backup volume exists */
509#define AFS_VLDB_QUERY_VALID 3 /* - Record is valid */
510#define AFS_VLDB_QUERY_ERROR 4 /* - VL server returned error */
511
512 uuid_t fs_server[AFS_NMAXNSERVERS];
81006805 513 u32 addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
d2ddc776 514 u8 fs_mask[AFS_NMAXNSERVERS];
08e0e7c8
DH
515#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
516#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
517#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
d2ddc776
DH
518 short error;
519 u8 nr_servers; /* Number of server records */
520 u8 name_len;
521 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
08e0e7c8
DH
522};
523
f49b594d
DH
524/*
525 * Fileserver endpoint state. The records the addresses of a fileserver's
526 * endpoints and the state and result of a round of probing on them. This
527 * allows the rotation algorithm to access those results without them being
528 * erased by a subsequent round of probing.
529 */
530struct afs_endpoint_state {
531 struct rcu_head rcu;
532 struct afs_addr_list *addresses; /* The addresses being probed */
533 unsigned long responsive_set; /* Bitset of responsive endpoints */
534 unsigned long failed_set; /* Bitset of endpoints we failed to probe */
535 refcount_t ref;
536 unsigned int server_id; /* Debug ID of server */
537 unsigned int probe_seq; /* Probe sequence (from server::probe_counter) */
f49b594d
DH
538 atomic_t nr_probing; /* Number of outstanding probes */
539 unsigned int rtt; /* Best RTT in uS (or UINT_MAX) */
540 s32 abort_code;
541 short error;
21c1f410
DH
542 unsigned long flags;
543#define AFS_ESTATE_RESPONDED 0 /* Set if the server responded */
544#define AFS_ESTATE_SUPERSEDED 1 /* Set if this record has been superseded */
545#define AFS_ESTATE_IS_YFS 2 /* Set if probe upgraded to YFS */
546#define AFS_ESTATE_NOT_YFS 3 /* Set if probe didn't upgrade to YFS */
547#define AFS_ESTATE_LOCAL_FAILURE 4 /* Set if there was a local failure (eg. ENOMEM) */
f49b594d
DH
548};
549
08e0e7c8 550/*
d2ddc776 551 * Record of fileserver with which we're actively communicating.
08e0e7c8
DH
552 */
553struct afs_server {
d2ddc776
DH
554 struct rcu_head rcu;
555 union {
556 uuid_t uuid; /* Server ID */
557 struct afs_uuid _uuid;
558 };
559
20325960 560 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
3c4c4075
DH
561 struct rb_node uuid_rb; /* Link in net->fs_servers */
562 struct afs_server __rcu *uuid_next; /* Next server with same UUID */
563 struct afs_server *uuid_prev; /* Previous server with same UUID */
f6cbb368 564 struct list_head probe_link; /* Link in net->fs_probe_list */
d2ddc776
DH
565 struct hlist_node addr4_link; /* Link in net->fs_addresses4 */
566 struct hlist_node addr6_link; /* Link in net->fs_addresses6 */
567 struct hlist_node proc_link; /* Link in net->fs_proc */
ca0e79a4 568 struct list_head volumes; /* RCU list of afs_server_entry objects */
6e0e99d5 569 struct work_struct initcb_work; /* Work for CB.InitCallBackState* */
d2ddc776 570 struct afs_server *gc_next; /* Next server in manager's list */
977e5f8e 571 time64_t unuse_time; /* Time at which last unused */
c435ee34 572 unsigned long flags;
f3c130e6 573#define AFS_SERVER_FL_RESPONDING 0 /* The server is responding */
32275d3f
DH
574#define AFS_SERVER_FL_UPDATING 1
575#define AFS_SERVER_FL_NEEDS_UPDATE 2 /* Fileserver address list is out of date */
576#define AFS_SERVER_FL_NOT_READY 4 /* The record is not ready for use */
577#define AFS_SERVER_FL_NOT_FOUND 5 /* VL server says no such server */
578#define AFS_SERVER_FL_VL_FAIL 6 /* Failed to access VL server */
f2686b09 579#define AFS_SERVER_FL_MAY_HAVE_CB 8 /* May have callbacks on this fileserver */
32275d3f
DH
580#define AFS_SERVER_FL_IS_YFS 16 /* Server is YFS not AFS */
581#define AFS_SERVER_FL_NO_IBULK 17 /* Fileserver doesn't support FS.InlineBulkStatus */
582#define AFS_SERVER_FL_NO_RM2 18 /* Fileserver doesn't support YFS.RemoveFile2 */
b537a3c2 583#define AFS_SERVER_FL_HAS_FS64 19 /* Fileserver supports FS.{Fetch,Store}Data64 */
c56f9ec8 584 refcount_t ref; /* Object refcount */
977e5f8e 585 atomic_t active; /* Active user count */
d2ddc776 586 u32 addr_version; /* Address list version */
e38f299e 587 u16 service_id; /* Service ID we're using. */
f3c130e6 588 unsigned int rtt; /* Server's current RTT in uS */
45218193 589 unsigned int debug_id; /* Debugging ID for traces */
08e0e7c8
DH
590
591 /* file service access */
d2ddc776 592 rwlock_t fs_lock; /* access lock */
08e0e7c8
DH
593
594 /* callback promise management */
c435ee34 595 unsigned cb_s_break; /* Break-everything counter. */
3bf0fb6f
DH
596
597 /* Probe state */
f49b594d 598 struct afs_endpoint_state __rcu *endpoint_state; /* Latest endpoint/probe state */
f6cbb368 599 unsigned long probed_at; /* Time last probe was dispatched (jiffies) */
3bf0fb6f 600 wait_queue_head_t probe_wq;
f49b594d 601 unsigned int probe_counter; /* Number of probes issued */
3bf0fb6f 602 spinlock_t probe_lock;
c435ee34
DH
603};
604
08e0e7c8 605/*
194d28cf 606 * Replaceable volume server list.
d2ddc776
DH
607 */
608struct afs_server_entry {
609 struct afs_server *server;
ca0e79a4
DH
610 struct afs_volume *volume;
611 struct list_head slink; /* Link in server->volumes */
d2ddc776
DH
612};
613
614struct afs_server_list {
e6bace73 615 struct rcu_head rcu;
d2ddc776 616 refcount_t usage;
ca0e79a4 617 bool attached; /* T if attached to servers */
3bf0fb6f
DH
618 unsigned char nr_servers;
619 unsigned char preferred; /* Preferred server */
d2ddc776
DH
620 unsigned short vnovol_mask; /* Servers to be skipped due to VNOVOL */
621 unsigned int seq; /* Set to ->servers_seq when installed */
d4a96bec 622 rwlock_t lock;
d2ddc776
DH
623 struct afs_server_entry servers[];
624};
625
626/*
627 * Live AFS volume management.
08e0e7c8
DH
628 */
629struct afs_volume {
ca0e79a4
DH
630 struct rcu_head rcu;
631 afs_volid_t vid; /* The volume ID of this volume */
632 afs_volid_t vids[AFS_MAXTYPES]; /* All associated volume IDs */
c56f9ec8 633 refcount_t ref;
d2ddc776
DH
634 time64_t update_at; /* Time at which to next update */
635 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
20325960
DH
636 struct rb_node cell_node; /* Link in cell->volumes */
637 struct hlist_node proc_link; /* Link in cell->proc_volumes */
638 struct super_block __rcu *sb; /* Superblock on which inodes reside */
445f9b69 639 struct work_struct destructor; /* Deferred destructor */
d2ddc776
DH
640 unsigned long flags;
641#define AFS_VOLUME_NEEDS_UPDATE 0 /* - T if an update needs performing */
642#define AFS_VOLUME_UPDATING 1 /* - T if an update is in progress */
643#define AFS_VOLUME_WAIT 2 /* - T if users must wait for update */
644#define AFS_VOLUME_DELETED 3 /* - T if volume appears deleted */
645#define AFS_VOLUME_OFFLINE 4 /* - T if volume offline notice given */
646#define AFS_VOLUME_BUSY 5 /* - T if volume busy notice given */
20325960 647#define AFS_VOLUME_MAYBE_NO_IBULK 6 /* - T if some servers don't have InlineBulkStatus */
9a6b294a 648#define AFS_VOLUME_RM_TREE 7 /* - Set if volume removed from cell->volumes */
9b3f26c9 649#ifdef CONFIG_AFS_FSCACHE
523d27cd 650 struct fscache_volume *cache; /* Caching cookie */
08e0e7c8 651#endif
8a070a96 652 struct afs_server_list __rcu *servers; /* List of servers on which volume resides */
d2ddc776
DH
653 rwlock_t servers_lock; /* Lock for ->servers */
654 unsigned int servers_seq; /* Incremented each time ->servers changes */
655
68251f0a 656 unsigned cb_v_break; /* Break-everything counter. */
90fa9b64 657 rwlock_t cb_v_break_lock;
68251f0a 658
08e0e7c8
DH
659 afs_voltype_t type; /* type of volume */
660 char type_force; /* force volume type (suppress R/O -> R/W) */
d2ddc776
DH
661 u8 name_len;
662 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
08e0e7c8
DH
663};
664
0fafdc9f
DH
665enum afs_lock_state {
666 AFS_VNODE_LOCK_NONE, /* The vnode has no lock on the server */
667 AFS_VNODE_LOCK_WAITING_FOR_CB, /* We're waiting for the server to break the callback */
668 AFS_VNODE_LOCK_SETTING, /* We're asking the server for a lock */
669 AFS_VNODE_LOCK_GRANTED, /* We have a lock on the server */
670 AFS_VNODE_LOCK_EXTENDING, /* We're extending a lock on the server */
671 AFS_VNODE_LOCK_NEED_UNLOCK, /* We need to unlock on the server */
672 AFS_VNODE_LOCK_UNLOCKING, /* We're telling the server to unlock */
cdfb26b4 673 AFS_VNODE_LOCK_DELETED, /* The vnode has been deleted whilst we have a lock */
0fafdc9f
DH
674};
675
08e0e7c8 676/*
f8de483e
DH
677 * AFS inode private data.
678 *
679 * Note that afs_alloc_inode() *must* reset anything that could incorrectly
680 * leak from one inode to another.
08e0e7c8
DH
681 */
682struct afs_vnode {
874c8ca1 683 struct netfs_inode netfs; /* Netfslib context and vfs inode */
08e0e7c8 684 struct afs_volume *volume; /* volume on which vnode resides */
08e0e7c8
DH
685 struct afs_fid fid; /* the file identifier for this inode */
686 struct afs_file_status status; /* AFS status info for this file */
a4ff7401 687 afs_dataversion_t invalid_before; /* Child dentries are invalid before this */
fe342cf7 688 struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
d2ddc776 689 struct mutex io_lock; /* Lock for serialising I/O on this mutex */
b61f7dcf 690 struct rw_semaphore validate_lock; /* lock for validating this vnode */
79ddbfa5
DH
691 struct rw_semaphore rmdir_lock; /* Lock for rmdir vs sillyrename */
692 struct key *silly_key; /* Silly rename key */
4343d008 693 spinlock_t wb_lock; /* lock for wb_keys */
08e0e7c8
DH
694 spinlock_t lock; /* waitqueue/flags lock */
695 unsigned long flags;
c435ee34 696#define AFS_VNODE_CB_PROMISED 0 /* Set if vnode has a callback promise */
260a9803 697#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
f3ddee8d 698#define AFS_VNODE_DIR_VALID 2 /* Set if dir contents are valid */
08e0e7c8
DH
699#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
700#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
701#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
0fafdc9f
DH
702#define AFS_VNODE_AUTOCELL 6 /* set if Vnode is an auto mount point */
703#define AFS_VNODE_PSEUDODIR 7 /* set if Vnode is a pseudo directory */
5a813276 704#define AFS_VNODE_NEW_CONTENT 8 /* Set if file has new content (create/trunc-0) */
b6489a49 705#define AFS_VNODE_SILLY_DELETED 9 /* Set if file has been silly-deleted */
22650f14 706#define AFS_VNODE_MODIFYING 10 /* Set if we're performing a modification op */
08e0e7c8 707
4343d008 708 struct list_head wb_keys; /* List of keys available for writeback */
e8d6c554
DH
709 struct list_head pending_locks; /* locks waiting to be granted */
710 struct list_head granted_locks; /* locks granted on this file */
711 struct delayed_work lock_work; /* work to be done in locking */
0fafdc9f 712 struct key *lock_key; /* Key to be used in lock ops */
a690f60a 713 ktime_t locked_at; /* Time at which lock obtained */
0fafdc9f
DH
714 enum afs_lock_state lock_state : 8;
715 afs_lock_type_t lock_type : 8;
31143d5d 716
08e0e7c8 717 /* outstanding callback notification on this file */
6e0e99d5
DH
718 struct work_struct cb_work; /* Work for mmap'd files */
719 struct list_head cb_mmap_link; /* Link in cell->fs_open_mmaps */
20325960 720 void *cb_server; /* Server with callback/filelock */
6e0e99d5 721 atomic_t cb_nr_mmap; /* Number of mmaps */
4fe6a946 722 unsigned int cb_fs_s_break; /* Mass server break counter (cell->fs_s_break) */
c435ee34 723 unsigned int cb_s_break; /* Mass break counter on ->server */
68251f0a 724 unsigned int cb_v_break; /* Mass break counter on ->volume */
c435ee34 725 unsigned int cb_break; /* Break counter on vnode */
20325960 726 seqlock_t cb_lock; /* Lock for ->cb_server, ->status, ->cb_*break */
c435ee34
DH
727
728 time64_t cb_expires_at; /* time at which callback expires */
08e0e7c8
DH
729};
730
12bdcf33
DH
731static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
732{
733#ifdef CONFIG_AFS_FSCACHE
e81fb419 734 return netfs_i_cookie(&vnode->netfs);
12bdcf33
DH
735#else
736 return NULL;
737#endif
738}
739
bc899ee1
DH
740static inline void afs_vnode_set_cache(struct afs_vnode *vnode,
741 struct fscache_cookie *cookie)
742{
743#ifdef CONFIG_AFS_FSCACHE
874c8ca1 744 vnode->netfs.cache = cookie;
b4fa966f
DH
745 if (cookie)
746 mapping_set_release_always(vnode->netfs.inode.i_mapping);
bc899ee1
DH
747#endif
748}
749
00d3b7a4
DH
750/*
751 * cached security record for one user's attempt to access a vnode
752 */
753struct afs_permit {
754 struct key *key; /* RxRPC ticket holding a security context */
be080a6f 755 afs_access_t access; /* CallerAccess value for this key */
00d3b7a4
DH
756};
757
758/*
be080a6f
DH
759 * Immutable cache of CallerAccess records from attempts to access vnodes.
760 * These may be shared between multiple vnodes.
00d3b7a4
DH
761 */
762struct afs_permits {
be080a6f
DH
763 struct rcu_head rcu;
764 struct hlist_node hash_node; /* Link in hash */
765 unsigned long h; /* Hash value for this permit list */
766 refcount_t usage;
767 unsigned short nr_permits; /* Number of records */
768 bool invalidated; /* Invalidated due to key change */
aade1533 769 struct afs_permit permits[] __counted_by(nr_permits); /* List of permits sorted by key pointer */
00d3b7a4
DH
770};
771
4584ae96
DH
772/*
773 * Error prioritisation and accumulation.
774 */
775struct afs_error {
aa453bec
DH
776 s32 abort_code; /* Cumulative abort code */
777 short error; /* Cumulative error */
4584ae96 778 bool responded; /* T if server responded */
aa453bec 779 bool aborted; /* T if ->error is from an abort */
4584ae96
DH
780};
781
0a5143f2
DH
782/*
783 * Cursor for iterating over a set of volume location servers.
784 */
785struct afs_vl_cursor {
0a5143f2
DH
786 struct afs_cell *cell; /* The cell we're querying */
787 struct afs_vlserver_list *server_list; /* Current server list (pins ref) */
3bf0fb6f 788 struct afs_vlserver *server; /* Server on which this resides */
98f9fda2 789 struct afs_addr_list *alist; /* Current address list (pins ref) */
0a5143f2 790 struct key *key; /* Key for the server */
905b8615 791 unsigned long untried_servers; /* Bitmask of untried servers */
98f9fda2 792 unsigned long addr_tried; /* Tried addresses */
aa453bec 793 struct afs_error cumul_error; /* Cumulative error */
98f9fda2 794 unsigned int debug_id;
aa453bec 795 s32 call_abort_code;
aa453bec 796 short call_error; /* Error from single call */
905b8615 797 short server_index; /* Current server */
98f9fda2 798 signed char addr_index; /* Current address */
0a5143f2
DH
799 unsigned short flags;
800#define AFS_VL_CURSOR_STOP 0x0001 /* Set to cease iteration */
801#define AFS_VL_CURSOR_RETRY 0x0002 /* Set to do a retry */
802#define AFS_VL_CURSOR_RETRIED 0x0004 /* Set if started a retry */
aa453bec
DH
803 short nr_iterations; /* Number of server iterations */
804 bool call_responded; /* T if the current address responded */
0a5143f2
DH
805};
806
8b2a464c 807/*
e49c7b2f
DH
808 * Fileserver operation methods.
809 */
810struct afs_operation_ops {
811 void (*issue_afs_rpc)(struct afs_operation *op);
812 void (*issue_yfs_rpc)(struct afs_operation *op);
813 void (*success)(struct afs_operation *op);
814 void (*aborted)(struct afs_operation *op);
dc419184 815 void (*failed)(struct afs_operation *op);
e49c7b2f
DH
816 void (*edit_dir)(struct afs_operation *op);
817 void (*put)(struct afs_operation *op);
818};
819
820struct afs_vnode_param {
821 struct afs_vnode *vnode;
822 struct afs_fid fid; /* Fid to access */
823 struct afs_status_cb scb; /* Returned status and callback promise */
824 afs_dataversion_t dv_before; /* Data version before the call */
825 unsigned int cb_break_before; /* cb_break + cb_s_break before the call */
826 u8 dv_delta; /* Expected change in data version */
793fe82e
DH
827 bool put_vnode:1; /* T if we have a ref on the vnode */
828 bool need_io_lock:1; /* T if we need the I/O lock on this */
829 bool update_ctime:1; /* Need to update the ctime */
830 bool set_size:1; /* Must update i_size */
b6489a49 831 bool op_unlinked:1; /* True if file was unlinked by op */
a9e5c87c 832 bool speculative:1; /* T if speculative status fetch (no vnode lock) */
22650f14 833 bool modification:1; /* Set if the content gets modified */
e49c7b2f
DH
834};
835
836/*
837 * Fileserver operation wrapper, handling server and address rotation
838 * asynchronously. May make simultaneous calls to multiple servers.
8b2a464c 839 */
a310082f 840struct afs_operation {
e49c7b2f
DH
841 struct afs_net *net; /* Network namespace */
842 struct key *key; /* Key for the cell */
a58823ac 843 const struct afs_call_type *type; /* Type of call done */
e49c7b2f
DH
844 const struct afs_operation_ops *ops;
845
846 /* Parameters/results for the operation */
847 struct afs_volume *volume; /* Volume being accessed */
848 struct afs_vnode_param file[2];
849 struct afs_vnode_param *more_files;
850 struct afs_volsync volsync;
851 struct dentry *dentry; /* Dentry to be altered */
852 struct dentry *dentry_2; /* Second dentry to be altered */
853 struct timespec64 mtime; /* Modification time to record */
da8d0755 854 struct timespec64 ctime; /* Change time to set */
aa453bec 855 struct afs_error cumul_error; /* Cumulative error */
e49c7b2f 856 short nr_files; /* Number of entries in file[], more_files */
e49c7b2f
DH
857 unsigned int debug_id;
858
859 unsigned int cb_v_break; /* Volume break counter before op */
860 unsigned int cb_s_break; /* Server break counter before op */
861
862 union {
863 struct {
864 int which; /* Which ->file[] to fetch for */
865 } fetch_status;
866 struct {
867 int reason; /* enum afs_edit_dir_reason */
868 mode_t mode;
869 const char *symlink;
870 } create;
871 struct {
872 bool need_rehash;
873 } unlink;
874 struct {
875 struct dentry *rehash;
876 struct dentry *tmp;
877 bool new_negative;
878 } rename;
879 struct {
880 struct afs_read *req;
881 } fetch;
882 struct {
e49c7b2f
DH
883 afs_lock_type_t type;
884 } lock;
885 struct {
bd80d8a8
DH
886 struct iov_iter *write_iter;
887 loff_t pos;
888 loff_t size;
889 loff_t i_size;
bd80d8a8 890 bool laundering; /* Laundering page, PG_writeback not set */
e49c7b2f
DH
891 } store;
892 struct {
893 struct iattr *attr;
ec0fa0b6 894 loff_t old_i_size;
e49c7b2f
DH
895 } setattr;
896 struct afs_acl *acl;
897 struct yfs_acl *yacl;
898 struct {
899 struct afs_volume_status vs;
900 struct kstatfs *buf;
901 } volstatus;
902 };
903
904 /* Fileserver iteration state */
d2ddc776 905 struct afs_server_list *server_list; /* Current server list (pins ref) */
20325960 906 struct afs_server *server; /* Server we're using (ref pinned by server_list) */
f49b594d 907 struct afs_endpoint_state *estate; /* Current endpoint state (pins ref) */
e49c7b2f 908 struct afs_call *call;
905b8615 909 unsigned long untried_servers; /* Bitmask of untried servers */
98f9fda2
DH
910 unsigned long addr_tried; /* Tried addresses */
911 s32 call_abort_code; /* Abort code from single call */
912 short call_error; /* Error from single call */
905b8615 913 short server_index; /* Current server */
075171fd 914 short nr_iterations; /* Number of server iterations */
98f9fda2 915 signed char addr_index; /* Current address */
aa453bec
DH
916 bool call_responded; /* T if the current address responded */
917
e49c7b2f 918 unsigned int flags;
8409f67b
DH
919#define AFS_OPERATION_STOP 0x0001 /* Set to cease iteration */
920#define AFS_OPERATION_VBUSY 0x0002 /* Set if seen VBUSY */
921#define AFS_OPERATION_VMOVED 0x0004 /* Set if seen VMOVED */
922#define AFS_OPERATION_VNOVOL 0x0008 /* Set if seen VNOVOL */
923#define AFS_OPERATION_CUR_ONLY 0x0010 /* Set if current server only (file lock held) */
924#define AFS_OPERATION_NO_VSLEEP 0x0020 /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
925#define AFS_OPERATION_UNINTR 0x0040 /* Set if op is uninterruptible */
926#define AFS_OPERATION_DOWNGRADE 0x0080 /* Set to retry with downgraded opcode */
927#define AFS_OPERATION_LOCK_0 0x0100 /* Set if have io_lock on file[0] */
928#define AFS_OPERATION_LOCK_1 0x0200 /* Set if have io_lock on file[1] */
929#define AFS_OPERATION_TRIED_ALL 0x0400 /* Set if we've tried all the fileservers */
930#define AFS_OPERATION_RETRY_SERVER 0x0800 /* Set if we should retry the current server */
b6489a49 931#define AFS_OPERATION_DIR_CONFLICT 0x1000 /* Set if we detected a 3rd-party dir change */
8b2a464c
DH
932};
933
402cb8dd
DH
934/*
935 * Cache auxiliary data.
936 */
937struct afs_vnode_cache_aux {
523d27cd 938 __be64 data_version;
402cb8dd
DH
939} __packed;
940
523d27cd
DH
941static inline void afs_set_cache_aux(struct afs_vnode *vnode,
942 struct afs_vnode_cache_aux *aux)
943{
944 aux->data_version = cpu_to_be64(vnode->status.data_version);
945}
946
947static inline void afs_invalidate_cache(struct afs_vnode *vnode, unsigned int flags)
948{
949 struct afs_vnode_cache_aux aux;
950
951 afs_set_cache_aux(vnode, &aux);
952 fscache_invalidate(afs_vnode_cache(vnode), &aux,
874c8ca1 953 i_size_read(&vnode->netfs.inode), flags);
523d27cd
DH
954}
955
185f0c70 956/*
78525c74 957 * We use folio->private to hold the amount of the folio that we've written to,
185f0c70 958 * splitting the field into two parts. However, we need to represent a range
78525c74 959 * 0...FOLIO_SIZE, so we reduce the resolution if the size of the folio
2d9900f2 960 * exceeds what we can encode.
185f0c70 961 */
65dd2d60 962#ifdef CONFIG_64BIT
78525c74
DH
963#define __AFS_FOLIO_PRIV_MASK 0x7fffffffUL
964#define __AFS_FOLIO_PRIV_SHIFT 32
965#define __AFS_FOLIO_PRIV_MMAPPED 0x80000000UL
185f0c70 966#else
78525c74
DH
967#define __AFS_FOLIO_PRIV_MASK 0x7fffUL
968#define __AFS_FOLIO_PRIV_SHIFT 16
969#define __AFS_FOLIO_PRIV_MMAPPED 0x8000UL
185f0c70
DH
970#endif
971
78525c74 972static inline unsigned int afs_folio_dirty_resolution(struct folio *folio)
2d9900f2 973{
78525c74 974 int shift = folio_shift(folio) - (__AFS_FOLIO_PRIV_SHIFT - 1);
2d9900f2
DH
975 return (shift > 0) ? shift : 0;
976}
977
78525c74 978static inline size_t afs_folio_dirty_from(struct folio *folio, unsigned long priv)
185f0c70 979{
78525c74 980 unsigned long x = priv & __AFS_FOLIO_PRIV_MASK;
2d9900f2
DH
981
982 /* The lower bound is inclusive */
78525c74 983 return x << afs_folio_dirty_resolution(folio);
185f0c70
DH
984}
985
78525c74 986static inline size_t afs_folio_dirty_to(struct folio *folio, unsigned long priv)
185f0c70 987{
78525c74 988 unsigned long x = (priv >> __AFS_FOLIO_PRIV_SHIFT) & __AFS_FOLIO_PRIV_MASK;
2d9900f2
DH
989
990 /* The upper bound is immediately beyond the region */
78525c74 991 return (x + 1) << afs_folio_dirty_resolution(folio);
185f0c70
DH
992}
993
78525c74 994static inline unsigned long afs_folio_dirty(struct folio *folio, size_t from, size_t to)
185f0c70 995{
78525c74 996 unsigned int res = afs_folio_dirty_resolution(folio);
2d9900f2
DH
997 from >>= res;
998 to = (to - 1) >> res;
78525c74 999 return (to << __AFS_FOLIO_PRIV_SHIFT) | from;
185f0c70
DH
1000}
1001
78525c74 1002static inline unsigned long afs_folio_dirty_mmapped(unsigned long priv)
f86726a6 1003{
78525c74 1004 return priv | __AFS_FOLIO_PRIV_MMAPPED;
f86726a6
DH
1005}
1006
78525c74 1007static inline bool afs_is_folio_dirty_mmapped(unsigned long priv)
f86726a6 1008{
78525c74 1009 return priv & __AFS_FOLIO_PRIV_MMAPPED;
f86726a6
DH
1010}
1011
98bf40cd
DH
1012#include <trace/events/afs.h>
1013
08e0e7c8 1014/*****************************************************************************/
8b2a464c
DH
1015/*
1016 * addr_list.c
1017 */
1e5d8493 1018struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
e38f299e 1019extern struct afs_addr_list *afs_alloc_addrlist(unsigned int nr);
1e5d8493 1020extern void afs_put_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
0a5143f2
DH
1021extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
1022 const char *, size_t, char,
1023 unsigned short, unsigned short);
07f3502b
DH
1024bool afs_addr_list_same(const struct afs_addr_list *a,
1025 const struct afs_addr_list *b);
0a5143f2 1026extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
8b2a464c 1027
72904d7b
DH
1028extern int afs_merge_fs_addr4(struct afs_net *net, struct afs_addr_list *addr,
1029 __be32 xdr, u16 port);
1030extern int afs_merge_fs_addr6(struct afs_net *net, struct afs_addr_list *addr,
1031 __be32 *xdr, u16 port);
d2ddc776 1032
f94f70d3
DH
1033/*
1034 * addr_prefs.c
1035 */
1036int afs_proc_addr_prefs_write(struct file *file, char *buf, size_t size);
d14cf8ed
DH
1037void afs_get_address_preferences_rcu(struct afs_net *net, struct afs_addr_list *alist);
1038void afs_get_address_preferences(struct afs_net *net, struct afs_addr_list *alist);
f94f70d3 1039
08e0e7c8
DH
1040/*
1041 * callback.c
1042 */
6e0e99d5
DH
1043extern void afs_invalidate_mmap_work(struct work_struct *);
1044extern void afs_server_init_callback_work(struct work_struct *work);
08e0e7c8 1045extern void afs_init_callback_state(struct afs_server *);
051d2525
DH
1046extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1047extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1048extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
c435ee34 1049
68251f0a
DH
1050static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
1051{
eeba1e9c 1052 return vnode->cb_break + vnode->cb_v_break;
68251f0a
DH
1053}
1054
18ac6185 1055static inline bool afs_cb_is_broken(unsigned int cb_break,
20325960 1056 const struct afs_vnode *vnode)
68251f0a 1057{
20325960 1058 return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
68251f0a
DH
1059}
1060
1da177e4
LT
1061/*
1062 * cell.c
1063 */
989782dc 1064extern int afs_cell_init(struct afs_net *, const char *);
dca54a7b
DH
1065extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1066 enum afs_cell_trace);
989782dc
DH
1067extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1068 const char *, bool);
dca54a7b
DH
1069extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1070extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1071extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1072extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1073extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1074extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
989782dc
DH
1075extern void afs_manage_cells(struct work_struct *);
1076extern void afs_cells_timer(struct timer_list *);
f044c884 1077extern void __net_exit afs_cell_purge(struct afs_net *);
08e0e7c8
DH
1078
1079/*
1080 * cmservice.c
1081 */
1082extern bool afs_cm_incoming_call(struct afs_call *);
1083
1da177e4
LT
1084/*
1085 * dir.c
1086 */
4d673da1 1087extern const struct file_operations afs_dir_file_operations;
754661f1 1088extern const struct inode_operations afs_dir_inode_operations;
f3ddee8d 1089extern const struct address_space_operations afs_dir_aops;
d61dcce2 1090extern const struct dentry_operations afs_fs_dentry_operations;
4d673da1 1091
66c7e1d3 1092extern void afs_d_release(struct dentry *);
728279a5 1093extern void afs_check_for_remote_deletion(struct afs_operation *);
66c7e1d3 1094
63a4681f
DH
1095/*
1096 * dir_edit.c
1097 */
1098extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1099 enum afs_edit_dir_reason);
1100extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1101
79ddbfa5
DH
1102/*
1103 * dir_silly.c
1104 */
1105extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1106 struct dentry *, struct key *);
1107extern int afs_silly_iput(struct dentry *, struct inode *);
1108
66c7e1d3
DH
1109/*
1110 * dynroot.c
1111 */
66c7e1d3
DH
1112extern const struct inode_operations afs_dynroot_inode_operations;
1113extern const struct dentry_operations afs_dynroot_dentry_operations;
1114
1115extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
0da0b7fd
DH
1116extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1117extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1118extern int afs_dynroot_populate(struct super_block *);
1119extern void afs_dynroot_depopulate(struct super_block *);
1da177e4
LT
1120
1121/*
1122 * file.c
1123 */
75bd228d
DH
1124extern const struct address_space_operations afs_file_aops;
1125extern const struct address_space_operations afs_symlink_aops;
754661f1 1126extern const struct inode_operations afs_file_inode_operations;
00d3b7a4 1127extern const struct file_operations afs_file_operations;
6a19114b 1128extern const struct netfs_request_ops afs_req_ops;
00d3b7a4 1129
4343d008
DH
1130extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1131extern void afs_put_wb_key(struct afs_wb_key *);
00d3b7a4
DH
1132extern int afs_open(struct inode *, struct file *);
1133extern int afs_release(struct inode *, struct file *);
c69bf479 1134extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
5cbf0398 1135extern struct afs_read *afs_alloc_read(gfp_t);
196ee9cd 1136extern void afs_put_read(struct afs_read *);
c7f75ef3 1137extern int afs_write_inode(struct inode *, struct writeback_control *);
1da177e4 1138
d4438a25
DH
1139static inline struct afs_read *afs_get_read(struct afs_read *req)
1140{
1141 refcount_inc(&req->usage);
1142 return req;
1143}
1144
e8d6c554
DH
1145/*
1146 * flock.c
1147 */
f044c884
DH
1148extern struct workqueue_struct *afs_lock_manager;
1149
a690f60a 1150extern void afs_lock_op_done(struct afs_call *);
e8d6c554
DH
1151extern void afs_lock_work(struct work_struct *);
1152extern void afs_lock_may_be_available(struct afs_vnode *);
1153extern int afs_lock(struct file *, int, struct file_lock *);
1154extern int afs_flock(struct file *, int, struct file_lock *);
1155
08e0e7c8
DH
1156/*
1157 * fsclient.c
1158 */
e49c7b2f
DH
1159extern void afs_fs_fetch_status(struct afs_operation *);
1160extern void afs_fs_fetch_data(struct afs_operation *);
1161extern void afs_fs_create_file(struct afs_operation *);
1162extern void afs_fs_make_dir(struct afs_operation *);
1163extern void afs_fs_remove_file(struct afs_operation *);
1164extern void afs_fs_remove_dir(struct afs_operation *);
1165extern void afs_fs_link(struct afs_operation *);
1166extern void afs_fs_symlink(struct afs_operation *);
1167extern void afs_fs_rename(struct afs_operation *);
1168extern void afs_fs_store_data(struct afs_operation *);
1169extern void afs_fs_setattr(struct afs_operation *);
1170extern void afs_fs_get_volume_status(struct afs_operation *);
1171extern void afs_fs_set_lock(struct afs_operation *);
1172extern void afs_fs_extend_lock(struct afs_operation *);
1173extern void afs_fs_release_lock(struct afs_operation *);
98f9fda2
DH
1174int afs_fs_give_up_all_callbacks(struct afs_net *net, struct afs_server *server,
1175 struct afs_address *addr, struct key *key);
1176bool afs_fs_get_capabilities(struct afs_net *net, struct afs_server *server,
f49b594d 1177 struct afs_endpoint_state *estate, unsigned int addr_index,
98f9fda2 1178 struct key *key);
e49c7b2f 1179extern void afs_fs_inline_bulk_status(struct afs_operation *);
08e0e7c8 1180
260f082b
DH
1181struct afs_acl {
1182 u32 size;
1183 u8 data[];
1184};
1185
e49c7b2f
DH
1186extern void afs_fs_fetch_acl(struct afs_operation *);
1187extern void afs_fs_store_acl(struct afs_operation *);
1188
1189/*
1190 * fs_operation.c
1191 */
1192extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1193extern int afs_put_operation(struct afs_operation *);
1194extern bool afs_begin_vnode_operation(struct afs_operation *);
1195extern void afs_wait_for_operation(struct afs_operation *);
1196extern int afs_do_sync_operation(struct afs_operation *);
1197
e49c7b2f
DH
1198static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1199 struct afs_vnode *vnode)
1200{
1201 op->file[n].vnode = vnode;
1202 op->file[n].need_io_lock = true;
1203}
1204
1205static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1206 const struct afs_fid *fid)
1207{
1208 op->file[n].fid = *fid;
1209}
260f082b 1210
3bf0fb6f
DH
1211/*
1212 * fs_probe.c
1213 */
f49b594d
DH
1214struct afs_endpoint_state *afs_get_endpoint_state(struct afs_endpoint_state *estate,
1215 enum afs_estate_trace where);
1216void afs_put_endpoint_state(struct afs_endpoint_state *estate, enum afs_estate_trace where);
3bf0fb6f 1217extern void afs_fileserver_probe_result(struct afs_call *);
f49b594d
DH
1218void afs_fs_probe_fileserver(struct afs_net *net, struct afs_server *server,
1219 struct afs_addr_list *new_addrs, struct key *key);
3bf0fb6f 1220extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
8409f67b 1221extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
f6cbb368 1222extern void afs_fs_probe_dispatcher(struct work_struct *);
f49b594d
DH
1223int afs_wait_for_one_fs_probe(struct afs_server *server, struct afs_endpoint_state *estate,
1224 bool is_intr);
5481fc6e 1225extern void afs_fs_probe_cleanup(struct afs_net *);
3bf0fb6f 1226
1da177e4
LT
1227/*
1228 * inode.c
1229 */
b6489a49
DH
1230extern const struct afs_operation_ops afs_fetch_status_operation;
1231
e49c7b2f 1232extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
a58823ac 1233extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
e49c7b2f 1234extern int afs_ilookup5_test_by_fid(struct inode *, void *);
4d673da1 1235extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
e49c7b2f
DH
1236extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1237extern struct inode *afs_root_iget(struct super_block *, struct key *);
c925bd0a 1238extern bool afs_check_validity(struct afs_vnode *);
260a9803 1239extern int afs_validate(struct afs_vnode *, struct key *);
0050d7f5 1240bool afs_pagecache_valid(struct afs_vnode *);
b74d24f7 1241extern int afs_getattr(struct mnt_idmap *idmap, const struct path *,
549c7297 1242 struct kstat *, u32, unsigned int);
c1632a0f 1243extern int afs_setattr(struct mnt_idmap *idmap, struct dentry *, struct iattr *);
b57922d9 1244extern void afs_evict_inode(struct inode *);
bec5eb61 1245extern int afs_drop_inode(struct inode *);
1da177e4
LT
1246
1247/*
1248 * main.c
1249 */
0ad53eee 1250extern struct workqueue_struct *afs_wq;
5b86d4ff 1251extern int afs_net_id;
f044c884 1252
5b86d4ff 1253static inline struct afs_net *afs_net(struct net *net)
f044c884 1254{
5b86d4ff 1255 return net_generic(net, afs_net_id);
f044c884
DH
1256}
1257
5b86d4ff 1258static inline struct afs_net *afs_sb2net(struct super_block *sb)
f044c884 1259{
5b86d4ff 1260 return afs_net(AFS_FS_S(sb)->net_ns);
f044c884
DH
1261}
1262
5b86d4ff 1263static inline struct afs_net *afs_d2net(struct dentry *dentry)
f044c884 1264{
5b86d4ff 1265 return afs_sb2net(dentry->d_sb);
f044c884
DH
1266}
1267
5b86d4ff 1268static inline struct afs_net *afs_i2net(struct inode *inode)
f044c884 1269{
5b86d4ff 1270 return afs_sb2net(inode->i_sb);
f044c884
DH
1271}
1272
5b86d4ff 1273static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
f044c884 1274{
874c8ca1 1275 return afs_i2net(&vnode->netfs.inode);
f044c884
DH
1276}
1277
5b86d4ff 1278static inline struct afs_net *afs_sock2net(struct sock *sk)
f044c884 1279{
5b86d4ff 1280 return net_generic(sock_net(sk), afs_net_id);
f044c884 1281}
1da177e4 1282
d55b4da4
DH
1283static inline void __afs_stat(atomic_t *s)
1284{
1285 atomic_inc(s);
1286}
1287
1288#define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1289
08e0e7c8
DH
1290/*
1291 * misc.c
1292 */
1293extern int afs_abort_to_error(u32);
4584ae96 1294extern void afs_prioritise_error(struct afs_error *, int, u32);
08e0e7c8 1295
2de5599f
DH
1296static inline void afs_op_nomem(struct afs_operation *op)
1297{
aa453bec 1298 op->cumul_error.error = -ENOMEM;
2de5599f
DH
1299}
1300
1301static inline int afs_op_error(const struct afs_operation *op)
1302{
aa453bec
DH
1303 return op->cumul_error.error;
1304}
1305
1306static inline s32 afs_op_abort_code(const struct afs_operation *op)
1307{
1308 return op->cumul_error.abort_code;
2de5599f
DH
1309}
1310
1311static inline int afs_op_set_error(struct afs_operation *op, int error)
1312{
aa453bec
DH
1313 return op->cumul_error.error = error;
1314}
1315
1316static inline void afs_op_accumulate_error(struct afs_operation *op, int error, s32 abort_code)
1317{
1318 afs_prioritise_error(&op->cumul_error, error, abort_code);
2de5599f
DH
1319}
1320
1da177e4
LT
1321/*
1322 * mntpt.c
1323 */
754661f1 1324extern const struct inode_operations afs_mntpt_inode_operations;
bec5eb61 1325extern const struct inode_operations afs_autocell_inode_operations;
4b6f5d20 1326extern const struct file_operations afs_mntpt_file_operations;
1da177e4 1327
d18610b0 1328extern struct vfsmount *afs_d_automount(struct path *);
08e0e7c8 1329extern void afs_mntpt_kill_timer(void);
1da177e4 1330
1da177e4
LT
1331/*
1332 * proc.c
1333 */
b6cfbeca 1334#ifdef CONFIG_PROC_FS
f044c884
DH
1335extern int __net_init afs_proc_init(struct afs_net *);
1336extern void __net_exit afs_proc_cleanup(struct afs_net *);
5b86d4ff
DH
1337extern int afs_proc_cell_setup(struct afs_cell *);
1338extern void afs_proc_cell_remove(struct afs_cell *);
6f8880d8 1339extern void afs_put_sysnames(struct afs_sysnames *);
b6cfbeca
DH
1340#else
1341static inline int afs_proc_init(struct afs_net *net) { return 0; }
1342static inline void afs_proc_cleanup(struct afs_net *net) {}
1343static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1344static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1345static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1346#endif
1da177e4 1347
d2ddc776
DH
1348/*
1349 * rotate.c
1350 */
a310082f 1351extern bool afs_select_fileserver(struct afs_operation *);
e49c7b2f 1352extern void afs_dump_edestaddrreq(const struct afs_operation *);
d2ddc776 1353
08e0e7c8
DH
1354/*
1355 * rxrpc.c
1356 */
f044c884 1357extern struct workqueue_struct *afs_async_calls;
8324f0bc 1358
f044c884
DH
1359extern int __net_init afs_open_socket(struct afs_net *);
1360extern void __net_exit afs_close_socket(struct afs_net *);
1361extern void afs_charge_preallocation(struct work_struct *);
341f741f 1362extern void afs_put_call(struct afs_call *);
98f9fda2
DH
1363void afs_make_call(struct afs_call *call, gfp_t gfp);
1364void afs_wait_for_call_to_complete(struct afs_call *call);
f044c884
DH
1365extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1366 const struct afs_call_type *,
08e0e7c8
DH
1367 size_t, size_t);
1368extern void afs_flat_call_destructor(struct afs_call *);
08e0e7c8 1369extern void afs_send_empty_reply(struct afs_call *);
b908fe6b 1370extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
12bdcf33 1371extern int afs_extract_data(struct afs_call *, bool);
7126ead9 1372extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
08e0e7c8 1373
e49c7b2f
DH
1374static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1375 gfp_t gfp)
20b8391f 1376{
f49b594d
DH
1377 struct afs_addr_list *alist = op->estate->addresses;
1378
e38f299e
DH
1379 op->call = call;
1380 op->type = call->type;
1381 call->op = op;
1382 call->key = op->key;
1383 call->intr = !(op->flags & AFS_OPERATION_UNINTR);
f49b594d 1384 call->peer = rxrpc_kernel_get_peer(alist->addrs[op->addr_index].peer);
e38f299e 1385 call->service_id = op->server->service_id;
98f9fda2 1386 afs_make_call(call, gfp);
20b8391f
DH
1387}
1388
12bdcf33
DH
1389static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1390{
f105da1a 1391 call->iov_len = size;
12bdcf33
DH
1392 call->kvec[0].iov_base = buf;
1393 call->kvec[0].iov_len = size;
de4eda9d 1394 iov_iter_kvec(&call->def_iter, ITER_DEST, call->kvec, 1, size);
12bdcf33
DH
1395}
1396
1397static inline void afs_extract_to_tmp(struct afs_call *call)
1398{
f105da1a 1399 call->iov_len = sizeof(call->tmp);
12bdcf33
DH
1400 afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1401}
1402
1403static inline void afs_extract_to_tmp64(struct afs_call *call)
1404{
f105da1a 1405 call->iov_len = sizeof(call->tmp64);
12bdcf33
DH
1406 afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1407}
1408
1409static inline void afs_extract_discard(struct afs_call *call, size_t size)
1410{
f105da1a 1411 call->iov_len = size;
de4eda9d 1412 iov_iter_discard(&call->def_iter, ITER_DEST, size);
12bdcf33
DH
1413}
1414
1415static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1416{
f105da1a 1417 call->iov_len = size;
12bdcf33
DH
1418 afs_extract_begin(call, call->buffer, size);
1419}
1420
d001648e 1421static inline int afs_transfer_reply(struct afs_call *call)
372ee163 1422{
12bdcf33 1423 return afs_extract_data(call, false);
372ee163
DH
1424}
1425
98bf40cd
DH
1426static inline bool afs_check_call_state(struct afs_call *call,
1427 enum afs_call_state state)
1428{
1429 return READ_ONCE(call->state) == state;
1430}
1431
1432static inline bool afs_set_call_state(struct afs_call *call,
1433 enum afs_call_state from,
1434 enum afs_call_state to)
1435{
1436 bool ok = false;
1437
1438 spin_lock_bh(&call->state_lock);
1439 if (call->state == from) {
1440 call->state = to;
1441 trace_afs_call_state(call, from, to, 0, 0);
1442 ok = true;
1443 }
1444 spin_unlock_bh(&call->state_lock);
1445 return ok;
1446}
1447
1448static inline void afs_set_call_complete(struct afs_call *call,
1449 int error, u32 remote_abort)
1450{
1451 enum afs_call_state state;
1452 bool ok = false;
1453
1454 spin_lock_bh(&call->state_lock);
1455 state = call->state;
1456 if (state != AFS_CALL_COMPLETE) {
1457 call->abort_code = remote_abort;
1458 call->error = error;
1459 call->state = AFS_CALL_COMPLETE;
1460 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1461 error, remote_abort);
1462 ok = true;
1463 }
1464 spin_unlock_bh(&call->state_lock);
dde9f095 1465 if (ok) {
98bf40cd 1466 trace_afs_call_done(call);
dde9f095
DH
1467
1468 /* Asynchronous calls have two refs to release - one from the alloc and
1469 * one queued with the work item - and we can't just deallocate the
1470 * call because the work item may be queued again.
1471 */
1472 if (call->drop_ref)
1473 afs_put_call(call);
1474 }
98bf40cd
DH
1475}
1476
00d3b7a4
DH
1477/*
1478 * security.c
1479 */
be080a6f 1480extern void afs_put_permits(struct afs_permits *);
00d3b7a4 1481extern void afs_clear_permits(struct afs_vnode *);
a58823ac
DH
1482extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1483 struct afs_status_cb *);
00d3b7a4 1484extern struct key *afs_request_key(struct afs_cell *);
8b6a666a 1485extern struct key *afs_request_key_rcu(struct afs_cell *);
0fafdc9f 1486extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
4609e1f1 1487extern int afs_permission(struct mnt_idmap *, struct inode *, int);
be080a6f 1488extern void __exit afs_clean_up_permit_cache(void);
00d3b7a4 1489
08e0e7c8
DH
1490/*
1491 * server.c
1492 */
1493extern spinlock_t afs_server_peer_lock;
1494
72904d7b 1495extern struct afs_server *afs_find_server(struct afs_net *, const struct rxrpc_peer *);
d2ddc776 1496extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
81006805 1497extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
45218193 1498extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
977e5f8e
DH
1499extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1500extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1501extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
45218193 1502extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
d2ddc776
DH
1503extern void afs_manage_servers(struct work_struct *);
1504extern void afs_servers_timer(struct timer_list *);
f6cbb368 1505extern void afs_fs_probe_timer(struct timer_list *);
f044c884 1506extern void __net_exit afs_purge_servers(struct afs_net *);
f49b594d 1507bool afs_check_server_record(struct afs_operation *op, struct afs_server *server, struct key *key);
08e0e7c8 1508
f6cbb368
DH
1509static inline void afs_inc_servers_outstanding(struct afs_net *net)
1510{
1511 atomic_inc(&net->servers_outstanding);
1512}
1513
1514static inline void afs_dec_servers_outstanding(struct afs_net *net)
1515{
1516 if (atomic_dec_and_test(&net->servers_outstanding))
1517 wake_up_var(&net->servers_outstanding);
1518}
1519
1520static inline bool afs_is_probing_server(struct afs_server *server)
1521{
1522 return list_empty(&server->probe_link);
1523}
1524
00d3b7a4 1525/*
d2ddc776 1526 * server_list.c
00d3b7a4 1527 */
d2ddc776
DH
1528static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1529{
1530 refcount_inc(&slist->usage);
1531 return slist;
1532}
00d3b7a4 1533
d2ddc776 1534extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
ca0e79a4
DH
1535struct afs_server_list *afs_alloc_server_list(struct afs_volume *volume,
1536 struct key *key,
1537 struct afs_vldb_entry *vldb);
d2ddc776 1538extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
ca0e79a4
DH
1539void afs_attach_volume_to_servers(struct afs_volume *volume, struct afs_server_list *slist);
1540void afs_reattach_volume_to_servers(struct afs_volume *volume, struct afs_server_list *slist,
1541 struct afs_server_list *old);
1542void afs_detach_volume_from_servers(struct afs_volume *volume, struct afs_server_list *slist);
08e0e7c8
DH
1543
1544/*
d2ddc776 1545 * super.c
08e0e7c8 1546 */
d2ddc776 1547extern int __init afs_fs_init(void);
5b86d4ff 1548extern void afs_fs_exit(void);
08e0e7c8
DH
1549
1550/*
d2ddc776 1551 * vlclient.c
08e0e7c8 1552 */
0a5143f2
DH
1553extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1554 const char *, int);
1555extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
98f9fda2
DH
1556struct afs_call *afs_vl_get_capabilities(struct afs_net *net,
1557 struct afs_addr_list *alist,
1558 unsigned int addr_index,
1559 struct key *key,
1560 struct afs_vlserver *server,
1561 unsigned int server_index);
0a5143f2 1562extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
c3e9f888 1563extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
0a5143f2 1564
8a070a96
DH
1565/*
1566 * vl_alias.c
1567 */
1568extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1569
3bf0fb6f
DH
1570/*
1571 * vl_probe.c
1572 */
1573extern void afs_vlserver_probe_result(struct afs_call *);
1574extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1575extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1576
0a5143f2
DH
1577/*
1578 * vl_rotate.c
1579 */
1580extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1581 struct afs_cell *, struct key *);
1582extern bool afs_select_vlserver(struct afs_vl_cursor *);
1583extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1584extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1585
1586/*
1587 * vlserver_list.c
1588 */
1589static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1590{
c56f9ec8 1591 refcount_inc(&vlserver->ref);
0a5143f2
DH
1592 return vlserver;
1593}
1594
1595static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1596{
1597 if (vllist)
c56f9ec8 1598 refcount_inc(&vllist->ref);
0a5143f2
DH
1599 return vllist;
1600}
1601
1602extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1603extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1604extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1605extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1606extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1607 const void *, size_t);
08e0e7c8
DH
1608
1609/*
1610 * volume.c
1611 */
13fcc683 1612extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
523d27cd 1613extern int afs_activate_volume(struct afs_volume *);
d2ddc776 1614extern void afs_deactivate_volume(struct afs_volume *);
9a6b294a 1615bool afs_try_get_volume(struct afs_volume *volume, enum afs_volume_trace reason);
cca37d45 1616extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
445f9b69 1617void afs_put_volume(struct afs_volume *volume, enum afs_volume_trace reason);
a310082f 1618extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
08e0e7c8 1619
31143d5d
DH
1620/*
1621 * write.c
1622 */
c7f75ef3 1623#ifdef CONFIG_AFS_FSCACHE
8fb72b4a 1624bool afs_dirty_folio(struct address_space *, struct folio *);
c7f75ef3 1625#else
8fb72b4a 1626#define afs_dirty_folio filemap_dirty_folio
c7f75ef3 1627#endif
15b4650e 1628extern int afs_write_begin(struct file *file, struct address_space *mapping,
9d6b0cd7 1629 loff_t pos, unsigned len,
15b4650e
NP
1630 struct page **pagep, void **fsdata);
1631extern int afs_write_end(struct file *file, struct address_space *mapping,
1632 loff_t pos, unsigned len, unsigned copied,
1633 struct page *page, void *fsdata);
31143d5d
DH
1634extern int afs_writepage(struct page *, struct writeback_control *);
1635extern int afs_writepages(struct address_space *, struct writeback_control *);
50b5551d 1636extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
02c24a82 1637extern int afs_fsync(struct file *, loff_t, loff_t, int);
0722f186 1638extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
4343d008 1639extern void afs_prune_wb_keys(struct afs_vnode *);
a42442dd 1640int afs_launder_folio(struct folio *);
31143d5d 1641
d3e3b7ea
DH
1642/*
1643 * xattr.c
1644 */
f710c2e4 1645extern const struct xattr_handler * const afs_xattr_handlers[];
31143d5d 1646
30062bd1
DH
1647/*
1648 * yfsclient.c
1649 */
e49c7b2f
DH
1650extern void yfs_fs_fetch_data(struct afs_operation *);
1651extern void yfs_fs_create_file(struct afs_operation *);
1652extern void yfs_fs_make_dir(struct afs_operation *);
1653extern void yfs_fs_remove_file2(struct afs_operation *);
1654extern void yfs_fs_remove_file(struct afs_operation *);
1655extern void yfs_fs_remove_dir(struct afs_operation *);
1656extern void yfs_fs_link(struct afs_operation *);
1657extern void yfs_fs_symlink(struct afs_operation *);
1658extern void yfs_fs_rename(struct afs_operation *);
1659extern void yfs_fs_store_data(struct afs_operation *);
1660extern void yfs_fs_setattr(struct afs_operation *);
1661extern void yfs_fs_get_volume_status(struct afs_operation *);
1662extern void yfs_fs_set_lock(struct afs_operation *);
1663extern void yfs_fs_extend_lock(struct afs_operation *);
1664extern void yfs_fs_release_lock(struct afs_operation *);
1665extern void yfs_fs_fetch_status(struct afs_operation *);
1666extern void yfs_fs_inline_bulk_status(struct afs_operation *);
d2ddc776 1667
ae46578b
DH
1668struct yfs_acl {
1669 struct afs_acl *acl; /* Dir/file/symlink ACL */
1670 struct afs_acl *vol_acl; /* Whole volume ACL */
1671 u32 inherit_flag; /* True if ACL is inherited from parent dir */
1672 u32 num_cleaned; /* Number of ACEs removed due to subject removal */
1673 unsigned int flags;
1674#define YFS_ACL_WANT_ACL 0x01 /* Set if caller wants ->acl */
1675#define YFS_ACL_WANT_VOL_ACL 0x02 /* Set if caller wants ->vol_acl */
1676};
1677
1678extern void yfs_free_opaque_acl(struct yfs_acl *);
e49c7b2f
DH
1679extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1680extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
ae46578b 1681
d2ddc776
DH
1682/*
1683 * Miscellaneous inline functions.
1684 */
1685static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1686{
874c8ca1 1687 return container_of(inode, struct afs_vnode, netfs.inode);
d2ddc776
DH
1688}
1689
1690static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1691{
874c8ca1 1692 return &vnode->netfs.inode;
d2ddc776
DH
1693}
1694
e49c7b2f
DH
1695/*
1696 * Note that a dentry got changed. We need to set d_fsdata to the data version
1697 * number derived from the result of the operation. It doesn't matter if
1698 * d_fsdata goes backwards as we'll just revalidate.
1699 */
1700static inline void afs_update_dentry_version(struct afs_operation *op,
1701 struct afs_vnode_param *dir_vp,
1702 struct dentry *dentry)
1703{
aa453bec 1704 if (!op->cumul_error.error)
e49c7b2f
DH
1705 dentry->d_fsdata =
1706 (void *)(unsigned long)dir_vp->scb.status.data_version;
1707}
1708
9d37e1ca
DH
1709/*
1710 * Set the file size and block count. Estimate the number of 512 bytes blocks
1711 * used, rounded up to nearest 1K for consistency with other AFS clients.
1712 */
1713static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
1714{
874c8ca1
DH
1715 i_size_write(&vnode->netfs.inode, size);
1716 vnode->netfs.inode.i_blocks = ((size + 1023) >> 10) << 1;
9d37e1ca
DH
1717}
1718
b6489a49
DH
1719/*
1720 * Check for a conflicting operation on a directory that we just unlinked from.
1721 * If someone managed to sneak a link or an unlink in on the file we just
1722 * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1723 */
1724static inline void afs_check_dir_conflict(struct afs_operation *op,
1725 struct afs_vnode_param *dvp)
1726{
1727 if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1728 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1729}
1730
f51375cd
DH
1731static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1732{
1733 trace_afs_io_error(call->debug_id, -EIO, where);
1734 return -EIO;
1735}
1736
1737static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1738{
1739 trace_afs_file_error(vnode, -EIO, where);
1740 return -EIO;
1741}
d2ddc776 1742
08e0e7c8
DH
1743/*****************************************************************************/
1744/*
1745 * debug tracing
1746 */
1747extern unsigned afs_debug;
1748
1749#define dbgprintk(FMT,...) \
ad16df84 1750 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
08e0e7c8 1751
530b6412
HH
1752#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1753#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
08e0e7c8
DH
1754#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1755
1756
1757#if defined(__KDEBUG)
1758#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1759#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1760#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1761
1762#elif defined(CONFIG_AFS_DEBUG)
1763#define AFS_DEBUG_KENTER 0x01
1764#define AFS_DEBUG_KLEAVE 0x02
1765#define AFS_DEBUG_KDEBUG 0x04
1766
1767#define _enter(FMT,...) \
1768do { \
1769 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
1770 kenter(FMT,##__VA_ARGS__); \
1771} while (0)
1772
1773#define _leave(FMT,...) \
1774do { \
1775 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
1776 kleave(FMT,##__VA_ARGS__); \
1777} while (0)
1778
1779#define _debug(FMT,...) \
1780do { \
1781 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
1782 kdebug(FMT,##__VA_ARGS__); \
1783} while (0)
1784
1785#else
12fdff3f
DH
1786#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1787#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1788#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
08e0e7c8
DH
1789#endif
1790
1791/*
1792 * debug assertion checking
1793 */
1794#if 1 // defined(__KDEBUGALL)
1795
1796#define ASSERT(X) \
1797do { \
1798 if (unlikely(!(X))) { \
1799 printk(KERN_ERR "\n"); \
1800 printk(KERN_ERR "AFS: Assertion failed\n"); \
1801 BUG(); \
1802 } \
1803} while(0)
1804
1805#define ASSERTCMP(X, OP, Y) \
1806do { \
1807 if (unlikely(!((X) OP (Y)))) { \
1808 printk(KERN_ERR "\n"); \
1809 printk(KERN_ERR "AFS: Assertion failed\n"); \
1810 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1811 (unsigned long)(X), (unsigned long)(Y)); \
1812 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1813 (unsigned long)(X), (unsigned long)(Y)); \
1814 BUG(); \
1815 } \
1816} while(0)
1817
416351f2
DH
1818#define ASSERTRANGE(L, OP1, N, OP2, H) \
1819do { \
1820 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
1821 printk(KERN_ERR "\n"); \
1822 printk(KERN_ERR "AFS: Assertion failed\n"); \
1823 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1824 (unsigned long)(L), (unsigned long)(N), \
1825 (unsigned long)(H)); \
1826 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1827 (unsigned long)(L), (unsigned long)(N), \
1828 (unsigned long)(H)); \
1829 BUG(); \
1830 } \
1831} while(0)
1832
08e0e7c8
DH
1833#define ASSERTIF(C, X) \
1834do { \
1835 if (unlikely((C) && !(X))) { \
1836 printk(KERN_ERR "\n"); \
1837 printk(KERN_ERR "AFS: Assertion failed\n"); \
1838 BUG(); \
1839 } \
1840} while(0)
1841
1842#define ASSERTIFCMP(C, X, OP, Y) \
1843do { \
1844 if (unlikely((C) && !((X) OP (Y)))) { \
1845 printk(KERN_ERR "\n"); \
1846 printk(KERN_ERR "AFS: Assertion failed\n"); \
1847 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1848 (unsigned long)(X), (unsigned long)(Y)); \
1849 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1850 (unsigned long)(X), (unsigned long)(Y)); \
1851 BUG(); \
1852 } \
1853} while(0)
1854
1855#else
1856
1857#define ASSERT(X) \
1858do { \
1859} while(0)
1860
1861#define ASSERTCMP(X, OP, Y) \
1862do { \
1863} while(0)
1864
416351f2
DH
1865#define ASSERTRANGE(L, OP1, N, OP2, H) \
1866do { \
1867} while(0)
1868
08e0e7c8
DH
1869#define ASSERTIF(C, X) \
1870do { \
1871} while(0)
1872
1873#define ASSERTIFCMP(C, X, OP, Y) \
1874do { \
1875} while(0)
1876
1877#endif /* __KDEBUGALL */