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