afs: Combine the endpoint state bools into a bitmask
[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
DH
416 /* The volumes belonging to this cell */
417 struct rb_root volumes; /* Tree of volumes on this server */
418 struct hlist_head proc_volumes; /* procfs volume list */
419 seqlock_t volume_lock; /* For volumes */
420
d2ddc776 421 /* Active fileserver interaction state. */
20325960
DH
422 struct rb_root fs_servers; /* afs_server (by server UUID) */
423 seqlock_t fs_lock; /* For fs_servers */
6e0e99d5
DH
424 struct rw_semaphore fs_open_mmaps_lock;
425 struct list_head fs_open_mmaps; /* List of vnodes that are mmapped */
4fe6a946 426 atomic_t fs_s_break; /* Counter of CB.InitCallBackState messages */
989782dc 427
d2ddc776 428 /* VL server list. */
0a5143f2
DH
429 rwlock_t vl_servers_lock; /* Lock on vl_servers */
430 struct afs_vlserver_list __rcu *vl_servers;
431
989782dc 432 u8 name_len; /* Length of name */
719fdd32 433 char *name; /* Cell name, case-flattened and NUL-padded */
08e0e7c8
DH
434};
435
0a5143f2
DH
436/*
437 * Volume Location server record.
438 */
439struct afs_vlserver {
440 struct rcu_head rcu;
441 struct afs_addr_list __rcu *addresses; /* List of addresses for this VL server */
442 unsigned long flags;
443#define AFS_VLSERVER_FL_PROBED 0 /* The VL server has been probed */
444#define AFS_VLSERVER_FL_PROBING 1 /* VL server is being probed */
3bf0fb6f 445#define AFS_VLSERVER_FL_IS_YFS 2 /* Server is YFS not AFS */
b95b3094 446#define AFS_VLSERVER_FL_RESPONDING 3 /* VL server is responding */
0a5143f2 447 rwlock_t lock; /* Lock on addresses */
c56f9ec8 448 refcount_t ref;
b95b3094 449 unsigned int rtt; /* Server's current RTT in uS */
e6a7d7f7 450 unsigned int debug_id;
3bf0fb6f
DH
451
452 /* Probe state */
453 wait_queue_head_t probe_wq;
454 atomic_t probe_outstanding;
455 spinlock_t probe_lock;
456 struct {
72904d7b 457 unsigned int rtt; /* Best RTT in uS (or UINT_MAX) */
3bf0fb6f
DH
458 u32 abort_code;
459 short error;
fb72cd3d
DH
460 unsigned short flags;
461#define AFS_VLSERVER_PROBE_RESPONDED 0x01 /* At least once response (may be abort) */
462#define AFS_VLSERVER_PROBE_IS_YFS 0x02 /* The peer appears to be YFS */
463#define AFS_VLSERVER_PROBE_NOT_YFS 0x04 /* The peer appears not to be YFS */
464#define AFS_VLSERVER_PROBE_LOCAL_FAILURE 0x08 /* A local failure prevented a probe */
3bf0fb6f
DH
465 } probe;
466
e38f299e 467 u16 service_id; /* Service ID we're using */
0a5143f2 468 u16 port;
3bf0fb6f 469 u16 name_len; /* Length of name */
0a5143f2
DH
470 char name[]; /* Server name, case-flattened */
471};
472
473/*
474 * Weighted list of Volume Location servers.
475 */
476struct afs_vlserver_entry {
477 u16 priority; /* Preference (as SRV) */
478 u16 weight; /* Weight (as SRV) */
479 enum dns_record_source source:8;
480 enum dns_lookup_status status:8;
481 struct afs_vlserver *server;
482};
483
484struct afs_vlserver_list {
485 struct rcu_head rcu;
c56f9ec8 486 refcount_t ref;
0a5143f2
DH
487 u8 nr_servers;
488 u8 index; /* Server currently in use */
3bf0fb6f 489 u8 preferred; /* Preferred server */
0a5143f2
DH
490 enum dns_record_source source:8;
491 enum dns_lookup_status status:8;
492 rwlock_t lock;
493 struct afs_vlserver_entry servers[];
494};
495
08e0e7c8 496/*
d2ddc776
DH
497 * Cached VLDB entry.
498 *
499 * This is pointed to by cell->vldb_entries, indexed by name.
08e0e7c8 500 */
d2ddc776
DH
501struct afs_vldb_entry {
502 afs_volid_t vid[3]; /* Volume IDs for R/W, R/O and Bak volumes */
00d3b7a4 503
d2ddc776
DH
504 unsigned long flags;
505#define AFS_VLDB_HAS_RW 0 /* - R/W volume exists */
506#define AFS_VLDB_HAS_RO 1 /* - R/O volume exists */
507#define AFS_VLDB_HAS_BAK 2 /* - Backup volume exists */
508#define AFS_VLDB_QUERY_VALID 3 /* - Record is valid */
509#define AFS_VLDB_QUERY_ERROR 4 /* - VL server returned error */
510
511 uuid_t fs_server[AFS_NMAXNSERVERS];
81006805 512 u32 addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
d2ddc776 513 u8 fs_mask[AFS_NMAXNSERVERS];
08e0e7c8
DH
514#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
515#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
516#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
d2ddc776
DH
517 short error;
518 u8 nr_servers; /* Number of server records */
519 u8 name_len;
520 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
08e0e7c8
DH
521};
522
f49b594d
DH
523/*
524 * Fileserver endpoint state. The records the addresses of a fileserver's
525 * endpoints and the state and result of a round of probing on them. This
526 * allows the rotation algorithm to access those results without them being
527 * erased by a subsequent round of probing.
528 */
529struct afs_endpoint_state {
530 struct rcu_head rcu;
531 struct afs_addr_list *addresses; /* The addresses being probed */
532 unsigned long responsive_set; /* Bitset of responsive endpoints */
533 unsigned long failed_set; /* Bitset of endpoints we failed to probe */
534 refcount_t ref;
535 unsigned int server_id; /* Debug ID of server */
536 unsigned int probe_seq; /* Probe sequence (from server::probe_counter) */
f49b594d
DH
537 atomic_t nr_probing; /* Number of outstanding probes */
538 unsigned int rtt; /* Best RTT in uS (or UINT_MAX) */
539 s32 abort_code;
540 short error;
21c1f410
DH
541 unsigned long flags;
542#define AFS_ESTATE_RESPONDED 0 /* Set if the server responded */
543#define AFS_ESTATE_SUPERSEDED 1 /* Set if this record has been superseded */
544#define AFS_ESTATE_IS_YFS 2 /* Set if probe upgraded to YFS */
545#define AFS_ESTATE_NOT_YFS 3 /* Set if probe didn't upgrade to YFS */
546#define AFS_ESTATE_LOCAL_FAILURE 4 /* Set if there was a local failure (eg. ENOMEM) */
f49b594d
DH
547};
548
08e0e7c8 549/*
d2ddc776 550 * Record of fileserver with which we're actively communicating.
08e0e7c8
DH
551 */
552struct afs_server {
d2ddc776
DH
553 struct rcu_head rcu;
554 union {
555 uuid_t uuid; /* Server ID */
556 struct afs_uuid _uuid;
557 };
558
20325960 559 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
3c4c4075
DH
560 struct rb_node uuid_rb; /* Link in net->fs_servers */
561 struct afs_server __rcu *uuid_next; /* Next server with same UUID */
562 struct afs_server *uuid_prev; /* Previous server with same UUID */
f6cbb368 563 struct list_head probe_link; /* Link in net->fs_probe_list */
d2ddc776
DH
564 struct hlist_node addr4_link; /* Link in net->fs_addresses4 */
565 struct hlist_node addr6_link; /* Link in net->fs_addresses6 */
566 struct hlist_node proc_link; /* Link in net->fs_proc */
6e0e99d5 567 struct work_struct initcb_work; /* Work for CB.InitCallBackState* */
d2ddc776 568 struct afs_server *gc_next; /* Next server in manager's list */
977e5f8e 569 time64_t unuse_time; /* Time at which last unused */
c435ee34 570 unsigned long flags;
f3c130e6 571#define AFS_SERVER_FL_RESPONDING 0 /* The server is responding */
32275d3f
DH
572#define AFS_SERVER_FL_UPDATING 1
573#define AFS_SERVER_FL_NEEDS_UPDATE 2 /* Fileserver address list is out of date */
574#define AFS_SERVER_FL_NOT_READY 4 /* The record is not ready for use */
575#define AFS_SERVER_FL_NOT_FOUND 5 /* VL server says no such server */
576#define AFS_SERVER_FL_VL_FAIL 6 /* Failed to access VL server */
f2686b09 577#define AFS_SERVER_FL_MAY_HAVE_CB 8 /* May have callbacks on this fileserver */
32275d3f
DH
578#define AFS_SERVER_FL_IS_YFS 16 /* Server is YFS not AFS */
579#define AFS_SERVER_FL_NO_IBULK 17 /* Fileserver doesn't support FS.InlineBulkStatus */
580#define AFS_SERVER_FL_NO_RM2 18 /* Fileserver doesn't support YFS.RemoveFile2 */
b537a3c2 581#define AFS_SERVER_FL_HAS_FS64 19 /* Fileserver supports FS.{Fetch,Store}Data64 */
c56f9ec8 582 refcount_t ref; /* Object refcount */
977e5f8e 583 atomic_t active; /* Active user count */
d2ddc776 584 u32 addr_version; /* Address list version */
e38f299e 585 u16 service_id; /* Service ID we're using. */
f3c130e6 586 unsigned int rtt; /* Server's current RTT in uS */
45218193 587 unsigned int debug_id; /* Debugging ID for traces */
08e0e7c8
DH
588
589 /* file service access */
d2ddc776 590 rwlock_t fs_lock; /* access lock */
08e0e7c8
DH
591
592 /* callback promise management */
c435ee34 593 unsigned cb_s_break; /* Break-everything counter. */
3bf0fb6f
DH
594
595 /* Probe state */
f49b594d 596 struct afs_endpoint_state __rcu *endpoint_state; /* Latest endpoint/probe state */
f6cbb368 597 unsigned long probed_at; /* Time last probe was dispatched (jiffies) */
3bf0fb6f 598 wait_queue_head_t probe_wq;
f49b594d 599 unsigned int probe_counter; /* Number of probes issued */
3bf0fb6f 600 spinlock_t probe_lock;
c435ee34
DH
601};
602
08e0e7c8 603/*
194d28cf 604 * Replaceable volume server list.
d2ddc776
DH
605 */
606struct afs_server_entry {
607 struct afs_server *server;
d2ddc776
DH
608};
609
610struct afs_server_list {
e6bace73 611 struct rcu_head rcu;
194d28cf 612 afs_volid_t vids[AFS_MAXTYPES]; /* Volume IDs */
d2ddc776 613 refcount_t usage;
3bf0fb6f
DH
614 unsigned char nr_servers;
615 unsigned char preferred; /* Preferred server */
d2ddc776
DH
616 unsigned short vnovol_mask; /* Servers to be skipped due to VNOVOL */
617 unsigned int seq; /* Set to ->servers_seq when installed */
d4a96bec 618 rwlock_t lock;
d2ddc776
DH
619 struct afs_server_entry servers[];
620};
621
622/*
623 * Live AFS volume management.
08e0e7c8
DH
624 */
625struct afs_volume {
20325960
DH
626 union {
627 struct rcu_head rcu;
628 afs_volid_t vid; /* volume ID */
629 };
c56f9ec8 630 refcount_t ref;
d2ddc776
DH
631 time64_t update_at; /* Time at which to next update */
632 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
20325960
DH
633 struct rb_node cell_node; /* Link in cell->volumes */
634 struct hlist_node proc_link; /* Link in cell->proc_volumes */
635 struct super_block __rcu *sb; /* Superblock on which inodes reside */
d2ddc776
DH
636 unsigned long flags;
637#define AFS_VOLUME_NEEDS_UPDATE 0 /* - T if an update needs performing */
638#define AFS_VOLUME_UPDATING 1 /* - T if an update is in progress */
639#define AFS_VOLUME_WAIT 2 /* - T if users must wait for update */
640#define AFS_VOLUME_DELETED 3 /* - T if volume appears deleted */
641#define AFS_VOLUME_OFFLINE 4 /* - T if volume offline notice given */
642#define AFS_VOLUME_BUSY 5 /* - T if volume busy notice given */
20325960 643#define AFS_VOLUME_MAYBE_NO_IBULK 6 /* - T if some servers don't have InlineBulkStatus */
9a6b294a 644#define AFS_VOLUME_RM_TREE 7 /* - Set if volume removed from cell->volumes */
9b3f26c9 645#ifdef CONFIG_AFS_FSCACHE
523d27cd 646 struct fscache_volume *cache; /* Caching cookie */
08e0e7c8 647#endif
8a070a96 648 struct afs_server_list __rcu *servers; /* List of servers on which volume resides */
d2ddc776
DH
649 rwlock_t servers_lock; /* Lock for ->servers */
650 unsigned int servers_seq; /* Incremented each time ->servers changes */
651
68251f0a 652 unsigned cb_v_break; /* Break-everything counter. */
90fa9b64 653 rwlock_t cb_v_break_lock;
68251f0a 654
08e0e7c8
DH
655 afs_voltype_t type; /* type of volume */
656 char type_force; /* force volume type (suppress R/O -> R/W) */
d2ddc776
DH
657 u8 name_len;
658 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
08e0e7c8
DH
659};
660
0fafdc9f
DH
661enum afs_lock_state {
662 AFS_VNODE_LOCK_NONE, /* The vnode has no lock on the server */
663 AFS_VNODE_LOCK_WAITING_FOR_CB, /* We're waiting for the server to break the callback */
664 AFS_VNODE_LOCK_SETTING, /* We're asking the server for a lock */
665 AFS_VNODE_LOCK_GRANTED, /* We have a lock on the server */
666 AFS_VNODE_LOCK_EXTENDING, /* We're extending a lock on the server */
667 AFS_VNODE_LOCK_NEED_UNLOCK, /* We need to unlock on the server */
668 AFS_VNODE_LOCK_UNLOCKING, /* We're telling the server to unlock */
cdfb26b4 669 AFS_VNODE_LOCK_DELETED, /* The vnode has been deleted whilst we have a lock */
0fafdc9f
DH
670};
671
08e0e7c8 672/*
f8de483e
DH
673 * AFS inode private data.
674 *
675 * Note that afs_alloc_inode() *must* reset anything that could incorrectly
676 * leak from one inode to another.
08e0e7c8
DH
677 */
678struct afs_vnode {
874c8ca1 679 struct netfs_inode netfs; /* Netfslib context and vfs inode */
08e0e7c8 680 struct afs_volume *volume; /* volume on which vnode resides */
08e0e7c8
DH
681 struct afs_fid fid; /* the file identifier for this inode */
682 struct afs_file_status status; /* AFS status info for this file */
a4ff7401 683 afs_dataversion_t invalid_before; /* Child dentries are invalid before this */
fe342cf7 684 struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
d2ddc776 685 struct mutex io_lock; /* Lock for serialising I/O on this mutex */
b61f7dcf 686 struct rw_semaphore validate_lock; /* lock for validating this vnode */
79ddbfa5
DH
687 struct rw_semaphore rmdir_lock; /* Lock for rmdir vs sillyrename */
688 struct key *silly_key; /* Silly rename key */
4343d008 689 spinlock_t wb_lock; /* lock for wb_keys */
08e0e7c8
DH
690 spinlock_t lock; /* waitqueue/flags lock */
691 unsigned long flags;
c435ee34 692#define AFS_VNODE_CB_PROMISED 0 /* Set if vnode has a callback promise */
260a9803 693#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
f3ddee8d 694#define AFS_VNODE_DIR_VALID 2 /* Set if dir contents are valid */
08e0e7c8
DH
695#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
696#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
697#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
0fafdc9f
DH
698#define AFS_VNODE_AUTOCELL 6 /* set if Vnode is an auto mount point */
699#define AFS_VNODE_PSEUDODIR 7 /* set if Vnode is a pseudo directory */
5a813276 700#define AFS_VNODE_NEW_CONTENT 8 /* Set if file has new content (create/trunc-0) */
b6489a49 701#define AFS_VNODE_SILLY_DELETED 9 /* Set if file has been silly-deleted */
22650f14 702#define AFS_VNODE_MODIFYING 10 /* Set if we're performing a modification op */
08e0e7c8 703
4343d008 704 struct list_head wb_keys; /* List of keys available for writeback */
e8d6c554
DH
705 struct list_head pending_locks; /* locks waiting to be granted */
706 struct list_head granted_locks; /* locks granted on this file */
707 struct delayed_work lock_work; /* work to be done in locking */
0fafdc9f 708 struct key *lock_key; /* Key to be used in lock ops */
a690f60a 709 ktime_t locked_at; /* Time at which lock obtained */
0fafdc9f
DH
710 enum afs_lock_state lock_state : 8;
711 afs_lock_type_t lock_type : 8;
31143d5d 712
08e0e7c8 713 /* outstanding callback notification on this file */
6e0e99d5
DH
714 struct work_struct cb_work; /* Work for mmap'd files */
715 struct list_head cb_mmap_link; /* Link in cell->fs_open_mmaps */
20325960 716 void *cb_server; /* Server with callback/filelock */
6e0e99d5 717 atomic_t cb_nr_mmap; /* Number of mmaps */
4fe6a946 718 unsigned int cb_fs_s_break; /* Mass server break counter (cell->fs_s_break) */
c435ee34 719 unsigned int cb_s_break; /* Mass break counter on ->server */
68251f0a 720 unsigned int cb_v_break; /* Mass break counter on ->volume */
c435ee34 721 unsigned int cb_break; /* Break counter on vnode */
20325960 722 seqlock_t cb_lock; /* Lock for ->cb_server, ->status, ->cb_*break */
c435ee34
DH
723
724 time64_t cb_expires_at; /* time at which callback expires */
08e0e7c8
DH
725};
726
12bdcf33
DH
727static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
728{
729#ifdef CONFIG_AFS_FSCACHE
e81fb419 730 return netfs_i_cookie(&vnode->netfs);
12bdcf33
DH
731#else
732 return NULL;
733#endif
734}
735
bc899ee1
DH
736static inline void afs_vnode_set_cache(struct afs_vnode *vnode,
737 struct fscache_cookie *cookie)
738{
739#ifdef CONFIG_AFS_FSCACHE
874c8ca1 740 vnode->netfs.cache = cookie;
b4fa966f
DH
741 if (cookie)
742 mapping_set_release_always(vnode->netfs.inode.i_mapping);
bc899ee1
DH
743#endif
744}
745
00d3b7a4
DH
746/*
747 * cached security record for one user's attempt to access a vnode
748 */
749struct afs_permit {
750 struct key *key; /* RxRPC ticket holding a security context */
be080a6f 751 afs_access_t access; /* CallerAccess value for this key */
00d3b7a4
DH
752};
753
754/*
be080a6f
DH
755 * Immutable cache of CallerAccess records from attempts to access vnodes.
756 * These may be shared between multiple vnodes.
00d3b7a4
DH
757 */
758struct afs_permits {
be080a6f
DH
759 struct rcu_head rcu;
760 struct hlist_node hash_node; /* Link in hash */
761 unsigned long h; /* Hash value for this permit list */
762 refcount_t usage;
763 unsigned short nr_permits; /* Number of records */
764 bool invalidated; /* Invalidated due to key change */
aade1533 765 struct afs_permit permits[] __counted_by(nr_permits); /* List of permits sorted by key pointer */
00d3b7a4
DH
766};
767
4584ae96
DH
768/*
769 * Error prioritisation and accumulation.
770 */
771struct afs_error {
aa453bec
DH
772 s32 abort_code; /* Cumulative abort code */
773 short error; /* Cumulative error */
4584ae96 774 bool responded; /* T if server responded */
aa453bec 775 bool aborted; /* T if ->error is from an abort */
4584ae96
DH
776};
777
0a5143f2
DH
778/*
779 * Cursor for iterating over a set of volume location servers.
780 */
781struct afs_vl_cursor {
0a5143f2
DH
782 struct afs_cell *cell; /* The cell we're querying */
783 struct afs_vlserver_list *server_list; /* Current server list (pins ref) */
3bf0fb6f 784 struct afs_vlserver *server; /* Server on which this resides */
98f9fda2 785 struct afs_addr_list *alist; /* Current address list (pins ref) */
0a5143f2 786 struct key *key; /* Key for the server */
905b8615 787 unsigned long untried_servers; /* Bitmask of untried servers */
98f9fda2 788 unsigned long addr_tried; /* Tried addresses */
aa453bec 789 struct afs_error cumul_error; /* Cumulative error */
98f9fda2 790 unsigned int debug_id;
aa453bec 791 s32 call_abort_code;
aa453bec 792 short call_error; /* Error from single call */
905b8615 793 short server_index; /* Current server */
98f9fda2 794 signed char addr_index; /* Current address */
0a5143f2
DH
795 unsigned short flags;
796#define AFS_VL_CURSOR_STOP 0x0001 /* Set to cease iteration */
797#define AFS_VL_CURSOR_RETRY 0x0002 /* Set to do a retry */
798#define AFS_VL_CURSOR_RETRIED 0x0004 /* Set if started a retry */
aa453bec
DH
799 short nr_iterations; /* Number of server iterations */
800 bool call_responded; /* T if the current address responded */
0a5143f2
DH
801};
802
8b2a464c 803/*
e49c7b2f
DH
804 * Fileserver operation methods.
805 */
806struct afs_operation_ops {
807 void (*issue_afs_rpc)(struct afs_operation *op);
808 void (*issue_yfs_rpc)(struct afs_operation *op);
809 void (*success)(struct afs_operation *op);
810 void (*aborted)(struct afs_operation *op);
dc419184 811 void (*failed)(struct afs_operation *op);
e49c7b2f
DH
812 void (*edit_dir)(struct afs_operation *op);
813 void (*put)(struct afs_operation *op);
814};
815
816struct afs_vnode_param {
817 struct afs_vnode *vnode;
818 struct afs_fid fid; /* Fid to access */
819 struct afs_status_cb scb; /* Returned status and callback promise */
820 afs_dataversion_t dv_before; /* Data version before the call */
821 unsigned int cb_break_before; /* cb_break + cb_s_break before the call */
822 u8 dv_delta; /* Expected change in data version */
793fe82e
DH
823 bool put_vnode:1; /* T if we have a ref on the vnode */
824 bool need_io_lock:1; /* T if we need the I/O lock on this */
825 bool update_ctime:1; /* Need to update the ctime */
826 bool set_size:1; /* Must update i_size */
b6489a49 827 bool op_unlinked:1; /* True if file was unlinked by op */
a9e5c87c 828 bool speculative:1; /* T if speculative status fetch (no vnode lock) */
22650f14 829 bool modification:1; /* Set if the content gets modified */
e49c7b2f
DH
830};
831
832/*
833 * Fileserver operation wrapper, handling server and address rotation
834 * asynchronously. May make simultaneous calls to multiple servers.
8b2a464c 835 */
a310082f 836struct afs_operation {
e49c7b2f
DH
837 struct afs_net *net; /* Network namespace */
838 struct key *key; /* Key for the cell */
a58823ac 839 const struct afs_call_type *type; /* Type of call done */
e49c7b2f
DH
840 const struct afs_operation_ops *ops;
841
842 /* Parameters/results for the operation */
843 struct afs_volume *volume; /* Volume being accessed */
844 struct afs_vnode_param file[2];
845 struct afs_vnode_param *more_files;
846 struct afs_volsync volsync;
847 struct dentry *dentry; /* Dentry to be altered */
848 struct dentry *dentry_2; /* Second dentry to be altered */
849 struct timespec64 mtime; /* Modification time to record */
da8d0755 850 struct timespec64 ctime; /* Change time to set */
aa453bec 851 struct afs_error cumul_error; /* Cumulative error */
e49c7b2f 852 short nr_files; /* Number of entries in file[], more_files */
e49c7b2f
DH
853 unsigned int debug_id;
854
855 unsigned int cb_v_break; /* Volume break counter before op */
856 unsigned int cb_s_break; /* Server break counter before op */
857
858 union {
859 struct {
860 int which; /* Which ->file[] to fetch for */
861 } fetch_status;
862 struct {
863 int reason; /* enum afs_edit_dir_reason */
864 mode_t mode;
865 const char *symlink;
866 } create;
867 struct {
868 bool need_rehash;
869 } unlink;
870 struct {
871 struct dentry *rehash;
872 struct dentry *tmp;
873 bool new_negative;
874 } rename;
875 struct {
876 struct afs_read *req;
877 } fetch;
878 struct {
e49c7b2f
DH
879 afs_lock_type_t type;
880 } lock;
881 struct {
bd80d8a8
DH
882 struct iov_iter *write_iter;
883 loff_t pos;
884 loff_t size;
885 loff_t i_size;
bd80d8a8 886 bool laundering; /* Laundering page, PG_writeback not set */
e49c7b2f
DH
887 } store;
888 struct {
889 struct iattr *attr;
ec0fa0b6 890 loff_t old_i_size;
e49c7b2f
DH
891 } setattr;
892 struct afs_acl *acl;
893 struct yfs_acl *yacl;
894 struct {
895 struct afs_volume_status vs;
896 struct kstatfs *buf;
897 } volstatus;
898 };
899
900 /* Fileserver iteration state */
d2ddc776 901 struct afs_server_list *server_list; /* Current server list (pins ref) */
20325960 902 struct afs_server *server; /* Server we're using (ref pinned by server_list) */
f49b594d 903 struct afs_endpoint_state *estate; /* Current endpoint state (pins ref) */
e49c7b2f 904 struct afs_call *call;
905b8615 905 unsigned long untried_servers; /* Bitmask of untried servers */
98f9fda2
DH
906 unsigned long addr_tried; /* Tried addresses */
907 s32 call_abort_code; /* Abort code from single call */
908 short call_error; /* Error from single call */
905b8615 909 short server_index; /* Current server */
075171fd 910 short nr_iterations; /* Number of server iterations */
98f9fda2 911 signed char addr_index; /* Current address */
aa453bec
DH
912 bool call_responded; /* T if the current address responded */
913
e49c7b2f 914 unsigned int flags;
8409f67b
DH
915#define AFS_OPERATION_STOP 0x0001 /* Set to cease iteration */
916#define AFS_OPERATION_VBUSY 0x0002 /* Set if seen VBUSY */
917#define AFS_OPERATION_VMOVED 0x0004 /* Set if seen VMOVED */
918#define AFS_OPERATION_VNOVOL 0x0008 /* Set if seen VNOVOL */
919#define AFS_OPERATION_CUR_ONLY 0x0010 /* Set if current server only (file lock held) */
920#define AFS_OPERATION_NO_VSLEEP 0x0020 /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
921#define AFS_OPERATION_UNINTR 0x0040 /* Set if op is uninterruptible */
922#define AFS_OPERATION_DOWNGRADE 0x0080 /* Set to retry with downgraded opcode */
923#define AFS_OPERATION_LOCK_0 0x0100 /* Set if have io_lock on file[0] */
924#define AFS_OPERATION_LOCK_1 0x0200 /* Set if have io_lock on file[1] */
925#define AFS_OPERATION_TRIED_ALL 0x0400 /* Set if we've tried all the fileservers */
926#define AFS_OPERATION_RETRY_SERVER 0x0800 /* Set if we should retry the current server */
b6489a49 927#define AFS_OPERATION_DIR_CONFLICT 0x1000 /* Set if we detected a 3rd-party dir change */
8b2a464c
DH
928};
929
402cb8dd
DH
930/*
931 * Cache auxiliary data.
932 */
933struct afs_vnode_cache_aux {
523d27cd 934 __be64 data_version;
402cb8dd
DH
935} __packed;
936
523d27cd
DH
937static inline void afs_set_cache_aux(struct afs_vnode *vnode,
938 struct afs_vnode_cache_aux *aux)
939{
940 aux->data_version = cpu_to_be64(vnode->status.data_version);
941}
942
943static inline void afs_invalidate_cache(struct afs_vnode *vnode, unsigned int flags)
944{
945 struct afs_vnode_cache_aux aux;
946
947 afs_set_cache_aux(vnode, &aux);
948 fscache_invalidate(afs_vnode_cache(vnode), &aux,
874c8ca1 949 i_size_read(&vnode->netfs.inode), flags);
523d27cd
DH
950}
951
185f0c70 952/*
78525c74 953 * We use folio->private to hold the amount of the folio that we've written to,
185f0c70 954 * splitting the field into two parts. However, we need to represent a range
78525c74 955 * 0...FOLIO_SIZE, so we reduce the resolution if the size of the folio
2d9900f2 956 * exceeds what we can encode.
185f0c70 957 */
65dd2d60 958#ifdef CONFIG_64BIT
78525c74
DH
959#define __AFS_FOLIO_PRIV_MASK 0x7fffffffUL
960#define __AFS_FOLIO_PRIV_SHIFT 32
961#define __AFS_FOLIO_PRIV_MMAPPED 0x80000000UL
185f0c70 962#else
78525c74
DH
963#define __AFS_FOLIO_PRIV_MASK 0x7fffUL
964#define __AFS_FOLIO_PRIV_SHIFT 16
965#define __AFS_FOLIO_PRIV_MMAPPED 0x8000UL
185f0c70
DH
966#endif
967
78525c74 968static inline unsigned int afs_folio_dirty_resolution(struct folio *folio)
2d9900f2 969{
78525c74 970 int shift = folio_shift(folio) - (__AFS_FOLIO_PRIV_SHIFT - 1);
2d9900f2
DH
971 return (shift > 0) ? shift : 0;
972}
973
78525c74 974static inline size_t afs_folio_dirty_from(struct folio *folio, unsigned long priv)
185f0c70 975{
78525c74 976 unsigned long x = priv & __AFS_FOLIO_PRIV_MASK;
2d9900f2
DH
977
978 /* The lower bound is inclusive */
78525c74 979 return x << afs_folio_dirty_resolution(folio);
185f0c70
DH
980}
981
78525c74 982static inline size_t afs_folio_dirty_to(struct folio *folio, unsigned long priv)
185f0c70 983{
78525c74 984 unsigned long x = (priv >> __AFS_FOLIO_PRIV_SHIFT) & __AFS_FOLIO_PRIV_MASK;
2d9900f2
DH
985
986 /* The upper bound is immediately beyond the region */
78525c74 987 return (x + 1) << afs_folio_dirty_resolution(folio);
185f0c70
DH
988}
989
78525c74 990static inline unsigned long afs_folio_dirty(struct folio *folio, size_t from, size_t to)
185f0c70 991{
78525c74 992 unsigned int res = afs_folio_dirty_resolution(folio);
2d9900f2
DH
993 from >>= res;
994 to = (to - 1) >> res;
78525c74 995 return (to << __AFS_FOLIO_PRIV_SHIFT) | from;
185f0c70
DH
996}
997
78525c74 998static inline unsigned long afs_folio_dirty_mmapped(unsigned long priv)
f86726a6 999{
78525c74 1000 return priv | __AFS_FOLIO_PRIV_MMAPPED;
f86726a6
DH
1001}
1002
78525c74 1003static inline bool afs_is_folio_dirty_mmapped(unsigned long priv)
f86726a6 1004{
78525c74 1005 return priv & __AFS_FOLIO_PRIV_MMAPPED;
f86726a6
DH
1006}
1007
98bf40cd
DH
1008#include <trace/events/afs.h>
1009
08e0e7c8 1010/*****************************************************************************/
8b2a464c
DH
1011/*
1012 * addr_list.c
1013 */
1e5d8493 1014struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
e38f299e 1015extern struct afs_addr_list *afs_alloc_addrlist(unsigned int nr);
1e5d8493 1016extern void afs_put_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
0a5143f2
DH
1017extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
1018 const char *, size_t, char,
1019 unsigned short, unsigned short);
07f3502b
DH
1020bool afs_addr_list_same(const struct afs_addr_list *a,
1021 const struct afs_addr_list *b);
0a5143f2 1022extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
8b2a464c 1023
72904d7b
DH
1024extern int afs_merge_fs_addr4(struct afs_net *net, struct afs_addr_list *addr,
1025 __be32 xdr, u16 port);
1026extern int afs_merge_fs_addr6(struct afs_net *net, struct afs_addr_list *addr,
1027 __be32 *xdr, u16 port);
d2ddc776 1028
f94f70d3
DH
1029/*
1030 * addr_prefs.c
1031 */
1032int afs_proc_addr_prefs_write(struct file *file, char *buf, size_t size);
d14cf8ed
DH
1033void afs_get_address_preferences_rcu(struct afs_net *net, struct afs_addr_list *alist);
1034void afs_get_address_preferences(struct afs_net *net, struct afs_addr_list *alist);
f94f70d3 1035
08e0e7c8
DH
1036/*
1037 * callback.c
1038 */
6e0e99d5
DH
1039extern void afs_invalidate_mmap_work(struct work_struct *);
1040extern void afs_server_init_callback_work(struct work_struct *work);
08e0e7c8 1041extern void afs_init_callback_state(struct afs_server *);
051d2525
DH
1042extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1043extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1044extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
c435ee34 1045
68251f0a
DH
1046static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
1047{
eeba1e9c 1048 return vnode->cb_break + vnode->cb_v_break;
68251f0a
DH
1049}
1050
18ac6185 1051static inline bool afs_cb_is_broken(unsigned int cb_break,
20325960 1052 const struct afs_vnode *vnode)
68251f0a 1053{
20325960 1054 return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
68251f0a
DH
1055}
1056
1da177e4
LT
1057/*
1058 * cell.c
1059 */
989782dc 1060extern int afs_cell_init(struct afs_net *, const char *);
dca54a7b
DH
1061extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1062 enum afs_cell_trace);
989782dc
DH
1063extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1064 const char *, bool);
dca54a7b
DH
1065extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1066extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1067extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1068extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1069extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1070extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
989782dc
DH
1071extern void afs_manage_cells(struct work_struct *);
1072extern void afs_cells_timer(struct timer_list *);
f044c884 1073extern void __net_exit afs_cell_purge(struct afs_net *);
08e0e7c8
DH
1074
1075/*
1076 * cmservice.c
1077 */
1078extern bool afs_cm_incoming_call(struct afs_call *);
1079
1da177e4
LT
1080/*
1081 * dir.c
1082 */
4d673da1 1083extern const struct file_operations afs_dir_file_operations;
754661f1 1084extern const struct inode_operations afs_dir_inode_operations;
f3ddee8d 1085extern const struct address_space_operations afs_dir_aops;
d61dcce2 1086extern const struct dentry_operations afs_fs_dentry_operations;
4d673da1 1087
66c7e1d3 1088extern void afs_d_release(struct dentry *);
728279a5 1089extern void afs_check_for_remote_deletion(struct afs_operation *);
66c7e1d3 1090
63a4681f
DH
1091/*
1092 * dir_edit.c
1093 */
1094extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1095 enum afs_edit_dir_reason);
1096extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1097
79ddbfa5
DH
1098/*
1099 * dir_silly.c
1100 */
1101extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1102 struct dentry *, struct key *);
1103extern int afs_silly_iput(struct dentry *, struct inode *);
1104
66c7e1d3
DH
1105/*
1106 * dynroot.c
1107 */
66c7e1d3
DH
1108extern const struct inode_operations afs_dynroot_inode_operations;
1109extern const struct dentry_operations afs_dynroot_dentry_operations;
1110
1111extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
0da0b7fd
DH
1112extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1113extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1114extern int afs_dynroot_populate(struct super_block *);
1115extern void afs_dynroot_depopulate(struct super_block *);
1da177e4
LT
1116
1117/*
1118 * file.c
1119 */
75bd228d
DH
1120extern const struct address_space_operations afs_file_aops;
1121extern const struct address_space_operations afs_symlink_aops;
754661f1 1122extern const struct inode_operations afs_file_inode_operations;
00d3b7a4 1123extern const struct file_operations afs_file_operations;
6a19114b 1124extern const struct netfs_request_ops afs_req_ops;
00d3b7a4 1125
4343d008
DH
1126extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1127extern void afs_put_wb_key(struct afs_wb_key *);
00d3b7a4
DH
1128extern int afs_open(struct inode *, struct file *);
1129extern int afs_release(struct inode *, struct file *);
c69bf479 1130extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
5cbf0398 1131extern struct afs_read *afs_alloc_read(gfp_t);
196ee9cd 1132extern void afs_put_read(struct afs_read *);
c7f75ef3 1133extern int afs_write_inode(struct inode *, struct writeback_control *);
1da177e4 1134
d4438a25
DH
1135static inline struct afs_read *afs_get_read(struct afs_read *req)
1136{
1137 refcount_inc(&req->usage);
1138 return req;
1139}
1140
e8d6c554
DH
1141/*
1142 * flock.c
1143 */
f044c884
DH
1144extern struct workqueue_struct *afs_lock_manager;
1145
a690f60a 1146extern void afs_lock_op_done(struct afs_call *);
e8d6c554
DH
1147extern void afs_lock_work(struct work_struct *);
1148extern void afs_lock_may_be_available(struct afs_vnode *);
1149extern int afs_lock(struct file *, int, struct file_lock *);
1150extern int afs_flock(struct file *, int, struct file_lock *);
1151
08e0e7c8
DH
1152/*
1153 * fsclient.c
1154 */
e49c7b2f
DH
1155extern void afs_fs_fetch_status(struct afs_operation *);
1156extern void afs_fs_fetch_data(struct afs_operation *);
1157extern void afs_fs_create_file(struct afs_operation *);
1158extern void afs_fs_make_dir(struct afs_operation *);
1159extern void afs_fs_remove_file(struct afs_operation *);
1160extern void afs_fs_remove_dir(struct afs_operation *);
1161extern void afs_fs_link(struct afs_operation *);
1162extern void afs_fs_symlink(struct afs_operation *);
1163extern void afs_fs_rename(struct afs_operation *);
1164extern void afs_fs_store_data(struct afs_operation *);
1165extern void afs_fs_setattr(struct afs_operation *);
1166extern void afs_fs_get_volume_status(struct afs_operation *);
1167extern void afs_fs_set_lock(struct afs_operation *);
1168extern void afs_fs_extend_lock(struct afs_operation *);
1169extern void afs_fs_release_lock(struct afs_operation *);
98f9fda2
DH
1170int afs_fs_give_up_all_callbacks(struct afs_net *net, struct afs_server *server,
1171 struct afs_address *addr, struct key *key);
1172bool afs_fs_get_capabilities(struct afs_net *net, struct afs_server *server,
f49b594d 1173 struct afs_endpoint_state *estate, unsigned int addr_index,
98f9fda2 1174 struct key *key);
e49c7b2f 1175extern void afs_fs_inline_bulk_status(struct afs_operation *);
08e0e7c8 1176
260f082b
DH
1177struct afs_acl {
1178 u32 size;
1179 u8 data[];
1180};
1181
e49c7b2f
DH
1182extern void afs_fs_fetch_acl(struct afs_operation *);
1183extern void afs_fs_store_acl(struct afs_operation *);
1184
1185/*
1186 * fs_operation.c
1187 */
1188extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1189extern int afs_put_operation(struct afs_operation *);
1190extern bool afs_begin_vnode_operation(struct afs_operation *);
1191extern void afs_wait_for_operation(struct afs_operation *);
1192extern int afs_do_sync_operation(struct afs_operation *);
1193
e49c7b2f
DH
1194static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1195 struct afs_vnode *vnode)
1196{
1197 op->file[n].vnode = vnode;
1198 op->file[n].need_io_lock = true;
1199}
1200
1201static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1202 const struct afs_fid *fid)
1203{
1204 op->file[n].fid = *fid;
1205}
260f082b 1206
3bf0fb6f
DH
1207/*
1208 * fs_probe.c
1209 */
f49b594d
DH
1210struct afs_endpoint_state *afs_get_endpoint_state(struct afs_endpoint_state *estate,
1211 enum afs_estate_trace where);
1212void afs_put_endpoint_state(struct afs_endpoint_state *estate, enum afs_estate_trace where);
3bf0fb6f 1213extern void afs_fileserver_probe_result(struct afs_call *);
f49b594d
DH
1214void afs_fs_probe_fileserver(struct afs_net *net, struct afs_server *server,
1215 struct afs_addr_list *new_addrs, struct key *key);
3bf0fb6f 1216extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
8409f67b 1217extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
f6cbb368 1218extern void afs_fs_probe_dispatcher(struct work_struct *);
f49b594d
DH
1219int afs_wait_for_one_fs_probe(struct afs_server *server, struct afs_endpoint_state *estate,
1220 bool is_intr);
5481fc6e 1221extern void afs_fs_probe_cleanup(struct afs_net *);
3bf0fb6f 1222
1da177e4
LT
1223/*
1224 * inode.c
1225 */
b6489a49
DH
1226extern const struct afs_operation_ops afs_fetch_status_operation;
1227
e49c7b2f 1228extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
a58823ac 1229extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
e49c7b2f 1230extern int afs_ilookup5_test_by_fid(struct inode *, void *);
4d673da1 1231extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
e49c7b2f
DH
1232extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1233extern struct inode *afs_root_iget(struct super_block *, struct key *);
c925bd0a 1234extern bool afs_check_validity(struct afs_vnode *);
260a9803 1235extern int afs_validate(struct afs_vnode *, struct key *);
0050d7f5 1236bool afs_pagecache_valid(struct afs_vnode *);
b74d24f7 1237extern int afs_getattr(struct mnt_idmap *idmap, const struct path *,
549c7297 1238 struct kstat *, u32, unsigned int);
c1632a0f 1239extern int afs_setattr(struct mnt_idmap *idmap, struct dentry *, struct iattr *);
b57922d9 1240extern void afs_evict_inode(struct inode *);
bec5eb61 1241extern int afs_drop_inode(struct inode *);
1da177e4
LT
1242
1243/*
1244 * main.c
1245 */
0ad53eee 1246extern struct workqueue_struct *afs_wq;
5b86d4ff 1247extern int afs_net_id;
f044c884 1248
5b86d4ff 1249static inline struct afs_net *afs_net(struct net *net)
f044c884 1250{
5b86d4ff 1251 return net_generic(net, afs_net_id);
f044c884
DH
1252}
1253
5b86d4ff 1254static inline struct afs_net *afs_sb2net(struct super_block *sb)
f044c884 1255{
5b86d4ff 1256 return afs_net(AFS_FS_S(sb)->net_ns);
f044c884
DH
1257}
1258
5b86d4ff 1259static inline struct afs_net *afs_d2net(struct dentry *dentry)
f044c884 1260{
5b86d4ff 1261 return afs_sb2net(dentry->d_sb);
f044c884
DH
1262}
1263
5b86d4ff 1264static inline struct afs_net *afs_i2net(struct inode *inode)
f044c884 1265{
5b86d4ff 1266 return afs_sb2net(inode->i_sb);
f044c884
DH
1267}
1268
5b86d4ff 1269static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
f044c884 1270{
874c8ca1 1271 return afs_i2net(&vnode->netfs.inode);
f044c884
DH
1272}
1273
5b86d4ff 1274static inline struct afs_net *afs_sock2net(struct sock *sk)
f044c884 1275{
5b86d4ff 1276 return net_generic(sock_net(sk), afs_net_id);
f044c884 1277}
1da177e4 1278
d55b4da4
DH
1279static inline void __afs_stat(atomic_t *s)
1280{
1281 atomic_inc(s);
1282}
1283
1284#define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1285
08e0e7c8
DH
1286/*
1287 * misc.c
1288 */
1289extern int afs_abort_to_error(u32);
4584ae96 1290extern void afs_prioritise_error(struct afs_error *, int, u32);
08e0e7c8 1291
2de5599f
DH
1292static inline void afs_op_nomem(struct afs_operation *op)
1293{
aa453bec 1294 op->cumul_error.error = -ENOMEM;
2de5599f
DH
1295}
1296
1297static inline int afs_op_error(const struct afs_operation *op)
1298{
aa453bec
DH
1299 return op->cumul_error.error;
1300}
1301
1302static inline s32 afs_op_abort_code(const struct afs_operation *op)
1303{
1304 return op->cumul_error.abort_code;
2de5599f
DH
1305}
1306
1307static inline int afs_op_set_error(struct afs_operation *op, int error)
1308{
aa453bec
DH
1309 return op->cumul_error.error = error;
1310}
1311
1312static inline void afs_op_accumulate_error(struct afs_operation *op, int error, s32 abort_code)
1313{
1314 afs_prioritise_error(&op->cumul_error, error, abort_code);
2de5599f
DH
1315}
1316
1da177e4
LT
1317/*
1318 * mntpt.c
1319 */
754661f1 1320extern const struct inode_operations afs_mntpt_inode_operations;
bec5eb61 1321extern const struct inode_operations afs_autocell_inode_operations;
4b6f5d20 1322extern const struct file_operations afs_mntpt_file_operations;
1da177e4 1323
d18610b0 1324extern struct vfsmount *afs_d_automount(struct path *);
08e0e7c8 1325extern void afs_mntpt_kill_timer(void);
1da177e4 1326
1da177e4
LT
1327/*
1328 * proc.c
1329 */
b6cfbeca 1330#ifdef CONFIG_PROC_FS
f044c884
DH
1331extern int __net_init afs_proc_init(struct afs_net *);
1332extern void __net_exit afs_proc_cleanup(struct afs_net *);
5b86d4ff
DH
1333extern int afs_proc_cell_setup(struct afs_cell *);
1334extern void afs_proc_cell_remove(struct afs_cell *);
6f8880d8 1335extern void afs_put_sysnames(struct afs_sysnames *);
b6cfbeca
DH
1336#else
1337static inline int afs_proc_init(struct afs_net *net) { return 0; }
1338static inline void afs_proc_cleanup(struct afs_net *net) {}
1339static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1340static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1341static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1342#endif
1da177e4 1343
d2ddc776
DH
1344/*
1345 * rotate.c
1346 */
a310082f 1347extern bool afs_select_fileserver(struct afs_operation *);
e49c7b2f 1348extern void afs_dump_edestaddrreq(const struct afs_operation *);
d2ddc776 1349
08e0e7c8
DH
1350/*
1351 * rxrpc.c
1352 */
f044c884 1353extern struct workqueue_struct *afs_async_calls;
8324f0bc 1354
f044c884
DH
1355extern int __net_init afs_open_socket(struct afs_net *);
1356extern void __net_exit afs_close_socket(struct afs_net *);
1357extern void afs_charge_preallocation(struct work_struct *);
341f741f 1358extern void afs_put_call(struct afs_call *);
98f9fda2
DH
1359void afs_make_call(struct afs_call *call, gfp_t gfp);
1360void afs_wait_for_call_to_complete(struct afs_call *call);
f044c884
DH
1361extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1362 const struct afs_call_type *,
08e0e7c8
DH
1363 size_t, size_t);
1364extern void afs_flat_call_destructor(struct afs_call *);
08e0e7c8 1365extern void afs_send_empty_reply(struct afs_call *);
b908fe6b 1366extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
12bdcf33 1367extern int afs_extract_data(struct afs_call *, bool);
7126ead9 1368extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
08e0e7c8 1369
e49c7b2f
DH
1370static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1371 gfp_t gfp)
20b8391f 1372{
f49b594d
DH
1373 struct afs_addr_list *alist = op->estate->addresses;
1374
e38f299e
DH
1375 op->call = call;
1376 op->type = call->type;
1377 call->op = op;
1378 call->key = op->key;
1379 call->intr = !(op->flags & AFS_OPERATION_UNINTR);
f49b594d 1380 call->peer = rxrpc_kernel_get_peer(alist->addrs[op->addr_index].peer);
e38f299e 1381 call->service_id = op->server->service_id;
98f9fda2 1382 afs_make_call(call, gfp);
20b8391f
DH
1383}
1384
12bdcf33
DH
1385static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1386{
f105da1a 1387 call->iov_len = size;
12bdcf33
DH
1388 call->kvec[0].iov_base = buf;
1389 call->kvec[0].iov_len = size;
de4eda9d 1390 iov_iter_kvec(&call->def_iter, ITER_DEST, call->kvec, 1, size);
12bdcf33
DH
1391}
1392
1393static inline void afs_extract_to_tmp(struct afs_call *call)
1394{
f105da1a 1395 call->iov_len = sizeof(call->tmp);
12bdcf33
DH
1396 afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1397}
1398
1399static inline void afs_extract_to_tmp64(struct afs_call *call)
1400{
f105da1a 1401 call->iov_len = sizeof(call->tmp64);
12bdcf33
DH
1402 afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1403}
1404
1405static inline void afs_extract_discard(struct afs_call *call, size_t size)
1406{
f105da1a 1407 call->iov_len = size;
de4eda9d 1408 iov_iter_discard(&call->def_iter, ITER_DEST, size);
12bdcf33
DH
1409}
1410
1411static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1412{
f105da1a 1413 call->iov_len = size;
12bdcf33
DH
1414 afs_extract_begin(call, call->buffer, size);
1415}
1416
d001648e 1417static inline int afs_transfer_reply(struct afs_call *call)
372ee163 1418{
12bdcf33 1419 return afs_extract_data(call, false);
372ee163
DH
1420}
1421
98bf40cd
DH
1422static inline bool afs_check_call_state(struct afs_call *call,
1423 enum afs_call_state state)
1424{
1425 return READ_ONCE(call->state) == state;
1426}
1427
1428static inline bool afs_set_call_state(struct afs_call *call,
1429 enum afs_call_state from,
1430 enum afs_call_state to)
1431{
1432 bool ok = false;
1433
1434 spin_lock_bh(&call->state_lock);
1435 if (call->state == from) {
1436 call->state = to;
1437 trace_afs_call_state(call, from, to, 0, 0);
1438 ok = true;
1439 }
1440 spin_unlock_bh(&call->state_lock);
1441 return ok;
1442}
1443
1444static inline void afs_set_call_complete(struct afs_call *call,
1445 int error, u32 remote_abort)
1446{
1447 enum afs_call_state state;
1448 bool ok = false;
1449
1450 spin_lock_bh(&call->state_lock);
1451 state = call->state;
1452 if (state != AFS_CALL_COMPLETE) {
1453 call->abort_code = remote_abort;
1454 call->error = error;
1455 call->state = AFS_CALL_COMPLETE;
1456 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1457 error, remote_abort);
1458 ok = true;
1459 }
1460 spin_unlock_bh(&call->state_lock);
dde9f095 1461 if (ok) {
98bf40cd 1462 trace_afs_call_done(call);
dde9f095
DH
1463
1464 /* Asynchronous calls have two refs to release - one from the alloc and
1465 * one queued with the work item - and we can't just deallocate the
1466 * call because the work item may be queued again.
1467 */
1468 if (call->drop_ref)
1469 afs_put_call(call);
1470 }
98bf40cd
DH
1471}
1472
00d3b7a4
DH
1473/*
1474 * security.c
1475 */
be080a6f 1476extern void afs_put_permits(struct afs_permits *);
00d3b7a4 1477extern void afs_clear_permits(struct afs_vnode *);
a58823ac
DH
1478extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1479 struct afs_status_cb *);
00d3b7a4 1480extern struct key *afs_request_key(struct afs_cell *);
8b6a666a 1481extern struct key *afs_request_key_rcu(struct afs_cell *);
0fafdc9f 1482extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
4609e1f1 1483extern int afs_permission(struct mnt_idmap *, struct inode *, int);
be080a6f 1484extern void __exit afs_clean_up_permit_cache(void);
00d3b7a4 1485
08e0e7c8
DH
1486/*
1487 * server.c
1488 */
1489extern spinlock_t afs_server_peer_lock;
1490
72904d7b 1491extern struct afs_server *afs_find_server(struct afs_net *, const struct rxrpc_peer *);
d2ddc776 1492extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
81006805 1493extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
45218193 1494extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
977e5f8e
DH
1495extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1496extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1497extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
45218193 1498extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
d2ddc776
DH
1499extern void afs_manage_servers(struct work_struct *);
1500extern void afs_servers_timer(struct timer_list *);
f6cbb368 1501extern void afs_fs_probe_timer(struct timer_list *);
f044c884 1502extern void __net_exit afs_purge_servers(struct afs_net *);
f49b594d 1503bool afs_check_server_record(struct afs_operation *op, struct afs_server *server, struct key *key);
08e0e7c8 1504
f6cbb368
DH
1505static inline void afs_inc_servers_outstanding(struct afs_net *net)
1506{
1507 atomic_inc(&net->servers_outstanding);
1508}
1509
1510static inline void afs_dec_servers_outstanding(struct afs_net *net)
1511{
1512 if (atomic_dec_and_test(&net->servers_outstanding))
1513 wake_up_var(&net->servers_outstanding);
1514}
1515
1516static inline bool afs_is_probing_server(struct afs_server *server)
1517{
1518 return list_empty(&server->probe_link);
1519}
1520
00d3b7a4 1521/*
d2ddc776 1522 * server_list.c
00d3b7a4 1523 */
d2ddc776
DH
1524static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1525{
1526 refcount_inc(&slist->usage);
1527 return slist;
1528}
00d3b7a4 1529
d2ddc776
DH
1530extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1531extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1532 struct afs_vldb_entry *,
1533 u8);
1534extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
08e0e7c8
DH
1535
1536/*
d2ddc776 1537 * super.c
08e0e7c8 1538 */
d2ddc776 1539extern int __init afs_fs_init(void);
5b86d4ff 1540extern void afs_fs_exit(void);
08e0e7c8
DH
1541
1542/*
d2ddc776 1543 * vlclient.c
08e0e7c8 1544 */
0a5143f2
DH
1545extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1546 const char *, int);
1547extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
98f9fda2
DH
1548struct afs_call *afs_vl_get_capabilities(struct afs_net *net,
1549 struct afs_addr_list *alist,
1550 unsigned int addr_index,
1551 struct key *key,
1552 struct afs_vlserver *server,
1553 unsigned int server_index);
0a5143f2 1554extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
c3e9f888 1555extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
0a5143f2 1556
8a070a96
DH
1557/*
1558 * vl_alias.c
1559 */
1560extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1561
3bf0fb6f
DH
1562/*
1563 * vl_probe.c
1564 */
1565extern void afs_vlserver_probe_result(struct afs_call *);
1566extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1567extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1568
0a5143f2
DH
1569/*
1570 * vl_rotate.c
1571 */
1572extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1573 struct afs_cell *, struct key *);
1574extern bool afs_select_vlserver(struct afs_vl_cursor *);
1575extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1576extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1577
1578/*
1579 * vlserver_list.c
1580 */
1581static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1582{
c56f9ec8 1583 refcount_inc(&vlserver->ref);
0a5143f2
DH
1584 return vlserver;
1585}
1586
1587static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1588{
1589 if (vllist)
c56f9ec8 1590 refcount_inc(&vllist->ref);
0a5143f2
DH
1591 return vllist;
1592}
1593
1594extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1595extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1596extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1597extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1598extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1599 const void *, size_t);
08e0e7c8
DH
1600
1601/*
1602 * volume.c
1603 */
13fcc683 1604extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
523d27cd 1605extern int afs_activate_volume(struct afs_volume *);
d2ddc776 1606extern void afs_deactivate_volume(struct afs_volume *);
9a6b294a 1607bool afs_try_get_volume(struct afs_volume *volume, enum afs_volume_trace reason);
cca37d45
DH
1608extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1609extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
a310082f 1610extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
08e0e7c8 1611
31143d5d
DH
1612/*
1613 * write.c
1614 */
c7f75ef3 1615#ifdef CONFIG_AFS_FSCACHE
8fb72b4a 1616bool afs_dirty_folio(struct address_space *, struct folio *);
c7f75ef3 1617#else
8fb72b4a 1618#define afs_dirty_folio filemap_dirty_folio
c7f75ef3 1619#endif
15b4650e 1620extern int afs_write_begin(struct file *file, struct address_space *mapping,
9d6b0cd7 1621 loff_t pos, unsigned len,
15b4650e
NP
1622 struct page **pagep, void **fsdata);
1623extern int afs_write_end(struct file *file, struct address_space *mapping,
1624 loff_t pos, unsigned len, unsigned copied,
1625 struct page *page, void *fsdata);
31143d5d
DH
1626extern int afs_writepage(struct page *, struct writeback_control *);
1627extern int afs_writepages(struct address_space *, struct writeback_control *);
50b5551d 1628extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
02c24a82 1629extern int afs_fsync(struct file *, loff_t, loff_t, int);
0722f186 1630extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
4343d008 1631extern void afs_prune_wb_keys(struct afs_vnode *);
a42442dd 1632int afs_launder_folio(struct folio *);
31143d5d 1633
d3e3b7ea
DH
1634/*
1635 * xattr.c
1636 */
f710c2e4 1637extern const struct xattr_handler * const afs_xattr_handlers[];
31143d5d 1638
30062bd1
DH
1639/*
1640 * yfsclient.c
1641 */
e49c7b2f
DH
1642extern void yfs_fs_fetch_data(struct afs_operation *);
1643extern void yfs_fs_create_file(struct afs_operation *);
1644extern void yfs_fs_make_dir(struct afs_operation *);
1645extern void yfs_fs_remove_file2(struct afs_operation *);
1646extern void yfs_fs_remove_file(struct afs_operation *);
1647extern void yfs_fs_remove_dir(struct afs_operation *);
1648extern void yfs_fs_link(struct afs_operation *);
1649extern void yfs_fs_symlink(struct afs_operation *);
1650extern void yfs_fs_rename(struct afs_operation *);
1651extern void yfs_fs_store_data(struct afs_operation *);
1652extern void yfs_fs_setattr(struct afs_operation *);
1653extern void yfs_fs_get_volume_status(struct afs_operation *);
1654extern void yfs_fs_set_lock(struct afs_operation *);
1655extern void yfs_fs_extend_lock(struct afs_operation *);
1656extern void yfs_fs_release_lock(struct afs_operation *);
1657extern void yfs_fs_fetch_status(struct afs_operation *);
1658extern void yfs_fs_inline_bulk_status(struct afs_operation *);
d2ddc776 1659
ae46578b
DH
1660struct yfs_acl {
1661 struct afs_acl *acl; /* Dir/file/symlink ACL */
1662 struct afs_acl *vol_acl; /* Whole volume ACL */
1663 u32 inherit_flag; /* True if ACL is inherited from parent dir */
1664 u32 num_cleaned; /* Number of ACEs removed due to subject removal */
1665 unsigned int flags;
1666#define YFS_ACL_WANT_ACL 0x01 /* Set if caller wants ->acl */
1667#define YFS_ACL_WANT_VOL_ACL 0x02 /* Set if caller wants ->vol_acl */
1668};
1669
1670extern void yfs_free_opaque_acl(struct yfs_acl *);
e49c7b2f
DH
1671extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1672extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
ae46578b 1673
d2ddc776
DH
1674/*
1675 * Miscellaneous inline functions.
1676 */
1677static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1678{
874c8ca1 1679 return container_of(inode, struct afs_vnode, netfs.inode);
d2ddc776
DH
1680}
1681
1682static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1683{
874c8ca1 1684 return &vnode->netfs.inode;
d2ddc776
DH
1685}
1686
e49c7b2f
DH
1687/*
1688 * Note that a dentry got changed. We need to set d_fsdata to the data version
1689 * number derived from the result of the operation. It doesn't matter if
1690 * d_fsdata goes backwards as we'll just revalidate.
1691 */
1692static inline void afs_update_dentry_version(struct afs_operation *op,
1693 struct afs_vnode_param *dir_vp,
1694 struct dentry *dentry)
1695{
aa453bec 1696 if (!op->cumul_error.error)
e49c7b2f
DH
1697 dentry->d_fsdata =
1698 (void *)(unsigned long)dir_vp->scb.status.data_version;
1699}
1700
9d37e1ca
DH
1701/*
1702 * Set the file size and block count. Estimate the number of 512 bytes blocks
1703 * used, rounded up to nearest 1K for consistency with other AFS clients.
1704 */
1705static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
1706{
874c8ca1
DH
1707 i_size_write(&vnode->netfs.inode, size);
1708 vnode->netfs.inode.i_blocks = ((size + 1023) >> 10) << 1;
9d37e1ca
DH
1709}
1710
b6489a49
DH
1711/*
1712 * Check for a conflicting operation on a directory that we just unlinked from.
1713 * If someone managed to sneak a link or an unlink in on the file we just
1714 * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1715 */
1716static inline void afs_check_dir_conflict(struct afs_operation *op,
1717 struct afs_vnode_param *dvp)
1718{
1719 if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1720 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1721}
1722
f51375cd
DH
1723static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1724{
1725 trace_afs_io_error(call->debug_id, -EIO, where);
1726 return -EIO;
1727}
1728
1729static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1730{
1731 trace_afs_file_error(vnode, -EIO, where);
1732 return -EIO;
1733}
d2ddc776 1734
08e0e7c8
DH
1735/*****************************************************************************/
1736/*
1737 * debug tracing
1738 */
1739extern unsigned afs_debug;
1740
1741#define dbgprintk(FMT,...) \
ad16df84 1742 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
08e0e7c8 1743
530b6412
HH
1744#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1745#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
08e0e7c8
DH
1746#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1747
1748
1749#if defined(__KDEBUG)
1750#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1751#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1752#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1753
1754#elif defined(CONFIG_AFS_DEBUG)
1755#define AFS_DEBUG_KENTER 0x01
1756#define AFS_DEBUG_KLEAVE 0x02
1757#define AFS_DEBUG_KDEBUG 0x04
1758
1759#define _enter(FMT,...) \
1760do { \
1761 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
1762 kenter(FMT,##__VA_ARGS__); \
1763} while (0)
1764
1765#define _leave(FMT,...) \
1766do { \
1767 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
1768 kleave(FMT,##__VA_ARGS__); \
1769} while (0)
1770
1771#define _debug(FMT,...) \
1772do { \
1773 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
1774 kdebug(FMT,##__VA_ARGS__); \
1775} while (0)
1776
1777#else
12fdff3f
DH
1778#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1779#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1780#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
08e0e7c8
DH
1781#endif
1782
1783/*
1784 * debug assertion checking
1785 */
1786#if 1 // defined(__KDEBUGALL)
1787
1788#define ASSERT(X) \
1789do { \
1790 if (unlikely(!(X))) { \
1791 printk(KERN_ERR "\n"); \
1792 printk(KERN_ERR "AFS: Assertion failed\n"); \
1793 BUG(); \
1794 } \
1795} while(0)
1796
1797#define ASSERTCMP(X, OP, Y) \
1798do { \
1799 if (unlikely(!((X) OP (Y)))) { \
1800 printk(KERN_ERR "\n"); \
1801 printk(KERN_ERR "AFS: Assertion failed\n"); \
1802 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1803 (unsigned long)(X), (unsigned long)(Y)); \
1804 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1805 (unsigned long)(X), (unsigned long)(Y)); \
1806 BUG(); \
1807 } \
1808} while(0)
1809
416351f2
DH
1810#define ASSERTRANGE(L, OP1, N, OP2, H) \
1811do { \
1812 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
1813 printk(KERN_ERR "\n"); \
1814 printk(KERN_ERR "AFS: Assertion failed\n"); \
1815 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1816 (unsigned long)(L), (unsigned long)(N), \
1817 (unsigned long)(H)); \
1818 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1819 (unsigned long)(L), (unsigned long)(N), \
1820 (unsigned long)(H)); \
1821 BUG(); \
1822 } \
1823} while(0)
1824
08e0e7c8
DH
1825#define ASSERTIF(C, X) \
1826do { \
1827 if (unlikely((C) && !(X))) { \
1828 printk(KERN_ERR "\n"); \
1829 printk(KERN_ERR "AFS: Assertion failed\n"); \
1830 BUG(); \
1831 } \
1832} while(0)
1833
1834#define ASSERTIFCMP(C, X, OP, Y) \
1835do { \
1836 if (unlikely((C) && !((X) OP (Y)))) { \
1837 printk(KERN_ERR "\n"); \
1838 printk(KERN_ERR "AFS: Assertion failed\n"); \
1839 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1840 (unsigned long)(X), (unsigned long)(Y)); \
1841 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1842 (unsigned long)(X), (unsigned long)(Y)); \
1843 BUG(); \
1844 } \
1845} while(0)
1846
1847#else
1848
1849#define ASSERT(X) \
1850do { \
1851} while(0)
1852
1853#define ASSERTCMP(X, OP, Y) \
1854do { \
1855} while(0)
1856
416351f2
DH
1857#define ASSERTRANGE(L, OP1, N, OP2, H) \
1858do { \
1859} while(0)
1860
08e0e7c8
DH
1861#define ASSERTIF(C, X) \
1862do { \
1863} while(0)
1864
1865#define ASSERTIFCMP(C, X, OP, Y) \
1866do { \
1867} while(0)
1868
1869#endif /* __KDEBUGALL */