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/* internal AFS stuff
2 *
3 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12#include <linux/compiler.h>
13#include <linux/kernel.h>
14#include <linux/fs.h>
15#include <linux/pagemap.h>
16#include <linux/skbuff.h>
17#include <linux/rxrpc.h>
18#include <linux/key.h>
19#include <linux/workqueue.h>
20#include <linux/sched.h>
21#include <linux/fscache.h>
22#include <linux/backing-dev.h>
23
24#include "afs.h"
25#include "afs_vl.h"
26
27#define AFS_CELL_MAX_ADDRS 15
28
29struct pagevec;
30struct afs_call;
31
32typedef enum {
33 AFS_VL_NEW, /* new, uninitialised record */
34 AFS_VL_CREATING, /* creating record */
35 AFS_VL_VALID, /* record is pending */
36 AFS_VL_NO_VOLUME, /* no such volume available */
37 AFS_VL_UPDATING, /* update in progress */
38 AFS_VL_VOLUME_DELETED, /* volume was deleted */
39 AFS_VL_UNCERTAIN, /* uncertain state (update failed) */
40} __attribute__((packed)) afs_vlocation_state_t;
41
42struct afs_mount_params {
43 bool rwpath; /* T if the parent should be considered R/W */
44 bool force; /* T to force cell type */
45 bool autocell; /* T if set auto mount operation */
46 afs_voltype_t type; /* type of volume requested */
47 int volnamesz; /* size of volume name */
48 const char *volname; /* name of volume to mount */
49 struct afs_cell *cell; /* cell in which to find volume */
50 struct afs_volume *volume; /* volume record */
51 struct key *key; /* key to use for secure mounting */
52};
53
54/*
55 * definition of how to wait for the completion of an operation
56 */
57struct afs_wait_mode {
58 /* RxRPC received message notification */
59 void (*rx_wakeup)(struct afs_call *call);
60
61 /* synchronous call waiter and call dispatched notification */
62 int (*wait)(struct afs_call *call);
63
64 /* asynchronous call completion */
65 void (*async_complete)(void *reply, int error);
66};
67
68extern const struct afs_wait_mode afs_sync_call;
69extern const struct afs_wait_mode afs_async_call;
70
71/*
72 * a record of an in-progress RxRPC call
73 */
74struct afs_call {
75 const struct afs_call_type *type; /* type of call */
76 const struct afs_wait_mode *wait_mode; /* completion wait mode */
77 wait_queue_head_t waitq; /* processes awaiting completion */
78 void (*async_workfn)(struct afs_call *call); /* asynchronous work function */
79 struct work_struct async_work; /* asynchronous work processor */
80 struct work_struct work; /* actual work processor */
81 struct sk_buff_head rx_queue; /* received packets */
82 struct rxrpc_call *rxcall; /* RxRPC call handle */
83 struct key *key; /* security for this call */
84 struct afs_server *server; /* server affected by incoming CM call */
85 void *request; /* request data (first part) */
86 struct address_space *mapping; /* page set */
87 struct afs_writeback *wb; /* writeback being performed */
88 void *buffer; /* reply receive buffer */
89 void *reply; /* reply buffer (first part) */
90 void *reply2; /* reply buffer (second part) */
91 void *reply3; /* reply buffer (third part) */
92 void *reply4; /* reply buffer (fourth part) */
93 pgoff_t first; /* first page in mapping to deal with */
94 pgoff_t last; /* last page in mapping to deal with */
95 enum { /* call state */
96 AFS_CALL_REQUESTING, /* request is being sent for outgoing call */
97 AFS_CALL_AWAIT_REPLY, /* awaiting reply to outgoing call */
98 AFS_CALL_AWAIT_OP_ID, /* awaiting op ID on incoming call */
99 AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
100 AFS_CALL_REPLYING, /* replying to incoming call */
101 AFS_CALL_AWAIT_ACK, /* awaiting final ACK of incoming call */
102 AFS_CALL_COMPLETE, /* successfully completed */
103 AFS_CALL_BUSY, /* server was busy */
104 AFS_CALL_ABORTED, /* call was aborted */
105 AFS_CALL_ERROR, /* call failed due to error */
106 } state;
107 int error; /* error code */
108 unsigned request_size; /* size of request data */
109 unsigned reply_max; /* maximum size of reply */
110 unsigned reply_size; /* current size of reply */
111 unsigned first_offset; /* offset into mapping[first] */
112 unsigned last_to; /* amount of mapping[last] */
113 unsigned offset; /* offset into received data store */
114 unsigned char unmarshall; /* unmarshalling phase */
115 bool incoming; /* T if incoming call */
116 bool send_pages; /* T if data from mapping should be sent */
117 u16 service_id; /* RxRPC service ID to call */
118 __be16 port; /* target UDP port */
119 __be32 operation_ID; /* operation ID for an incoming call */
120 u32 count; /* count for use in unmarshalling */
121 __be32 tmp; /* place to extract temporary data */
122 afs_dataversion_t store_version; /* updated version expected from store */
123};
124
125struct afs_call_type {
126 const char *name;
127
128 /* deliver request or reply data to an call
129 * - returning an error will cause the call to be aborted
130 */
131 int (*deliver)(struct afs_call *call, struct sk_buff *skb,
132 bool last);
133
134 /* map an abort code to an error number */
135 int (*abort_to_error)(u32 abort_code);
136
137 /* clean up a call */
138 void (*destructor)(struct afs_call *call);
139};
140
141/*
142 * record of an outstanding writeback on a vnode
143 */
144struct afs_writeback {
145 struct list_head link; /* link in vnode->writebacks */
146 struct work_struct writer; /* work item to perform the writeback */
147 struct afs_vnode *vnode; /* vnode to which this write applies */
148 struct key *key; /* owner of this write */
149 wait_queue_head_t waitq; /* completion and ready wait queue */
150 pgoff_t first; /* first page in batch */
151 pgoff_t point; /* last page in current store op */
152 pgoff_t last; /* last page in batch (inclusive) */
153 unsigned offset_first; /* offset into first page of start of write */
154 unsigned to_last; /* offset into last page of end of write */
155 int num_conflicts; /* count of conflicting writes in list */
156 int usage;
157 bool conflicts; /* T if has dependent conflicts */
158 enum {
159 AFS_WBACK_SYNCING, /* synchronisation being performed */
160 AFS_WBACK_PENDING, /* write pending */
161 AFS_WBACK_CONFLICTING, /* conflicting writes posted */
162 AFS_WBACK_WRITING, /* writing back */
163 AFS_WBACK_COMPLETE /* the writeback record has been unlinked */
164 } state __attribute__((packed));
165};
166
167/*
168 * AFS superblock private data
169 * - there's one superblock per volume
170 */
171struct afs_super_info {
172 struct afs_volume *volume; /* volume record */
173 char rwparent; /* T if parent is R/W AFS volume */
174};
175
176static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
177{
178 return sb->s_fs_info;
179}
180
181extern struct file_system_type afs_fs_type;
182
183/*
184 * entry in the cached cell catalogue
185 */
186struct afs_cache_cell {
187 char name[AFS_MAXCELLNAME]; /* cell name (padded with NULs) */
188 struct in_addr vl_servers[15]; /* cached cell VL servers */
189};
190
191/*
192 * AFS cell record
193 */
194struct afs_cell {
195 atomic_t usage;
196 struct list_head link; /* main cell list link */
197 struct key *anonymous_key; /* anonymous user key for this cell */
198 struct list_head proc_link; /* /proc cell list link */
199#ifdef CONFIG_AFS_FSCACHE
200 struct fscache_cookie *cache; /* caching cookie */
201#endif
202
203 /* server record management */
204 rwlock_t servers_lock; /* active server list lock */
205 struct list_head servers; /* active server list */
206
207 /* volume location record management */
208 struct rw_semaphore vl_sem; /* volume management serialisation semaphore */
209 struct list_head vl_list; /* cell's active VL record list */
210 spinlock_t vl_lock; /* vl_list lock */
211 unsigned short vl_naddrs; /* number of VL servers in addr list */
212 unsigned short vl_curr_svix; /* current server index */
213 struct in_addr vl_addrs[AFS_CELL_MAX_ADDRS]; /* cell VL server addresses */
214
215 char name[0]; /* cell name - must go last */
216};
217
218/*
219 * entry in the cached volume location catalogue
220 */
221struct afs_cache_vlocation {
222 /* volume name (lowercase, padded with NULs) */
223 uint8_t name[AFS_MAXVOLNAME + 1];
224
225 uint8_t nservers; /* number of entries used in servers[] */
226 uint8_t vidmask; /* voltype mask for vid[] */
227 uint8_t srvtmask[8]; /* voltype masks for servers[] */
228#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
229#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
230#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
231
232 afs_volid_t vid[3]; /* volume IDs for R/W, R/O and Bak volumes */
233 struct in_addr servers[8]; /* fileserver addresses */
234 time_t rtime; /* last retrieval time */
235};
236
237/*
238 * volume -> vnode hash table entry
239 */
240struct afs_cache_vhash {
241 afs_voltype_t vtype; /* which volume variation */
242 uint8_t hash_bucket; /* which hash bucket this represents */
243} __attribute__((packed));
244
245/*
246 * AFS volume location record
247 */
248struct afs_vlocation {
249 atomic_t usage;
250 time_t time_of_death; /* time at which put reduced usage to 0 */
251 struct list_head link; /* link in cell volume location list */
252 struct list_head grave; /* link in master graveyard list */
253 struct list_head update; /* link in master update list */
254 struct afs_cell *cell; /* cell to which volume belongs */
255#ifdef CONFIG_AFS_FSCACHE
256 struct fscache_cookie *cache; /* caching cookie */
257#endif
258 struct afs_cache_vlocation vldb; /* volume information DB record */
259 struct afs_volume *vols[3]; /* volume access record pointer (index by type) */
260 wait_queue_head_t waitq; /* status change waitqueue */
261 time_t update_at; /* time at which record should be updated */
262 spinlock_t lock; /* access lock */
263 afs_vlocation_state_t state; /* volume location state */
264 unsigned short upd_rej_cnt; /* ENOMEDIUM count during update */
265 unsigned short upd_busy_cnt; /* EBUSY count during update */
266 bool valid; /* T if valid */
267};
268
269/*
270 * AFS fileserver record
271 */
272struct afs_server {
273 atomic_t usage;
274 time_t time_of_death; /* time at which put reduced usage to 0 */
275 struct in_addr addr; /* server address */
276 struct afs_cell *cell; /* cell in which server resides */
277 struct list_head link; /* link in cell's server list */
278 struct list_head grave; /* link in master graveyard list */
279 struct rb_node master_rb; /* link in master by-addr tree */
280 struct rw_semaphore sem; /* access lock */
281
282 /* file service access */
283 struct rb_root fs_vnodes; /* vnodes backed by this server (ordered by FID) */
284 unsigned long fs_act_jif; /* time at which last activity occurred */
285 unsigned long fs_dead_jif; /* time at which no longer to be considered dead */
286 spinlock_t fs_lock; /* access lock */
287 int fs_state; /* 0 or reason FS currently marked dead (-errno) */
288
289 /* callback promise management */
290 struct rb_root cb_promises; /* vnode expiration list (ordered earliest first) */
291 struct delayed_work cb_updater; /* callback updater */
292 struct delayed_work cb_break_work; /* collected break dispatcher */
293 wait_queue_head_t cb_break_waitq; /* space available in cb_break waitqueue */
294 spinlock_t cb_lock; /* access lock */
295 struct afs_callback cb_break[64]; /* ring of callbacks awaiting breaking */
296 atomic_t cb_break_n; /* number of pending breaks */
297 u8 cb_break_head; /* head of callback breaking ring */
298 u8 cb_break_tail; /* tail of callback breaking ring */
299};
300
301/*
302 * AFS volume access record
303 */
304struct afs_volume {
305 atomic_t usage;
306 struct afs_cell *cell; /* cell to which belongs (unrefd ptr) */
307 struct afs_vlocation *vlocation; /* volume location */
308#ifdef CONFIG_AFS_FSCACHE
309 struct fscache_cookie *cache; /* caching cookie */
310#endif
311 afs_volid_t vid; /* volume ID */
312 afs_voltype_t type; /* type of volume */
313 char type_force; /* force volume type (suppress R/O -> R/W) */
314 unsigned short nservers; /* number of server slots filled */
315 unsigned short rjservers; /* number of servers discarded due to -ENOMEDIUM */
316 struct afs_server *servers[8]; /* servers on which volume resides (ordered) */
317 struct rw_semaphore server_sem; /* lock for accessing current server */
318 struct backing_dev_info bdi;
319};
320
321/*
322 * vnode catalogue entry
323 */
324struct afs_cache_vnode {
325 afs_vnodeid_t vnode_id; /* vnode ID */
326 unsigned vnode_unique; /* vnode ID uniquifier */
327 afs_dataversion_t data_version; /* data version */
328};
329
330/*
331 * AFS inode private data
332 */
333struct afs_vnode {
334 struct inode vfs_inode; /* the VFS's inode record */
335
336 struct afs_volume *volume; /* volume on which vnode resides */
337 struct afs_server *server; /* server currently supplying this file */
338 struct afs_fid fid; /* the file identifier for this inode */
339 struct afs_file_status status; /* AFS status info for this file */
340#ifdef CONFIG_AFS_FSCACHE
341 struct fscache_cookie *cache; /* caching cookie */
342#endif
343 struct afs_permits *permits; /* cache of permits so far obtained */
344 struct mutex permits_lock; /* lock for altering permits list */
345 struct mutex validate_lock; /* lock for validating this vnode */
346 wait_queue_head_t update_waitq; /* status fetch waitqueue */
347 int update_cnt; /* number of outstanding ops that will update the
348 * status */
349 spinlock_t writeback_lock; /* lock for writebacks */
350 spinlock_t lock; /* waitqueue/flags lock */
351 unsigned long flags;
352#define AFS_VNODE_CB_BROKEN 0 /* set if vnode's callback was broken */
353#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
354#define AFS_VNODE_MODIFIED 2 /* set if vnode's data modified */
355#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
356#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
357#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
358#define AFS_VNODE_LOCKING 6 /* set if waiting for lock on vnode */
359#define AFS_VNODE_READLOCKED 7 /* set if vnode is read-locked on the server */
360#define AFS_VNODE_WRITELOCKED 8 /* set if vnode is write-locked on the server */
361#define AFS_VNODE_UNLOCKING 9 /* set if vnode is being unlocked on the server */
362#define AFS_VNODE_AUTOCELL 10 /* set if Vnode is an auto mount point */
363#define AFS_VNODE_PSEUDODIR 11 /* set if Vnode is a pseudo directory */
364
365 long acl_order; /* ACL check count (callback break count) */
366
367 struct list_head writebacks; /* alterations in pagecache that need writing */
368 struct list_head pending_locks; /* locks waiting to be granted */
369 struct list_head granted_locks; /* locks granted on this file */
370 struct delayed_work lock_work; /* work to be done in locking */
371 struct key *unlock_key; /* key to be used in unlocking */
372
373 /* outstanding callback notification on this file */
374 struct rb_node server_rb; /* link in server->fs_vnodes */
375 struct rb_node cb_promise; /* link in server->cb_promises */
376 struct work_struct cb_broken_work; /* work to be done on callback break */
377 time_t cb_expires; /* time at which callback expires */
378 time_t cb_expires_at; /* time used to order cb_promise */
379 unsigned cb_version; /* callback version */
380 unsigned cb_expiry; /* callback expiry time */
381 afs_callback_type_t cb_type; /* type of callback */
382 bool cb_promised; /* true if promise still holds */
383};
384
385/*
386 * cached security record for one user's attempt to access a vnode
387 */
388struct afs_permit {
389 struct key *key; /* RxRPC ticket holding a security context */
390 afs_access_t access_mask; /* access mask for this key */
391};
392
393/*
394 * cache of security records from attempts to access a vnode
395 */
396struct afs_permits {
397 struct rcu_head rcu; /* disposal procedure */
398 int count; /* number of records */
399 struct afs_permit permits[0]; /* the permits so far examined */
400};
401
402/*
403 * record of one of a system's set of network interfaces
404 */
405struct afs_interface {
406 struct in_addr address; /* IPv4 address bound to interface */
407 struct in_addr netmask; /* netmask applied to address */
408 unsigned mtu; /* MTU of interface */
409};
410
411/*
412 * UUID definition [internet draft]
413 * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
414 * increments since midnight 15th October 1582
415 * - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
416 * time
417 * - the clock sequence is a 14-bit counter to avoid duplicate times
418 */
419struct afs_uuid {
420 u32 time_low; /* low part of timestamp */
421 u16 time_mid; /* mid part of timestamp */
422 u16 time_hi_and_version; /* high part of timestamp and version */
423#define AFS_UUID_TO_UNIX_TIME 0x01b21dd213814000ULL
424#define AFS_UUID_TIMEHI_MASK 0x0fff
425#define AFS_UUID_VERSION_TIME 0x1000 /* time-based UUID */
426#define AFS_UUID_VERSION_NAME 0x3000 /* name-based UUID */
427#define AFS_UUID_VERSION_RANDOM 0x4000 /* (pseudo-)random generated UUID */
428 u8 clock_seq_hi_and_reserved; /* clock seq hi and variant */
429#define AFS_UUID_CLOCKHI_MASK 0x3f
430#define AFS_UUID_VARIANT_STD 0x80
431 u8 clock_seq_low; /* clock seq low */
432 u8 node[6]; /* spatially unique node ID (MAC addr) */
433};
434
435/*****************************************************************************/
436/*
437 * cache.c
438 */
439#ifdef CONFIG_AFS_FSCACHE
440extern struct fscache_netfs afs_cache_netfs;
441extern struct fscache_cookie_def afs_cell_cache_index_def;
442extern struct fscache_cookie_def afs_vlocation_cache_index_def;
443extern struct fscache_cookie_def afs_volume_cache_index_def;
444extern struct fscache_cookie_def afs_vnode_cache_index_def;
445#else
446#define afs_cell_cache_index_def (*(struct fscache_cookie_def *) NULL)
447#define afs_vlocation_cache_index_def (*(struct fscache_cookie_def *) NULL)
448#define afs_volume_cache_index_def (*(struct fscache_cookie_def *) NULL)
449#define afs_vnode_cache_index_def (*(struct fscache_cookie_def *) NULL)
450#endif
451
452/*
453 * callback.c
454 */
455extern void afs_init_callback_state(struct afs_server *);
456extern void afs_broken_callback_work(struct work_struct *);
457extern void afs_break_callbacks(struct afs_server *, size_t,
458 struct afs_callback[]);
459extern void afs_discard_callback_on_delete(struct afs_vnode *);
460extern void afs_give_up_callback(struct afs_vnode *);
461extern void afs_dispatch_give_up_callbacks(struct work_struct *);
462extern void afs_flush_callback_breaks(struct afs_server *);
463extern int __init afs_callback_update_init(void);
464extern void afs_callback_update_kill(void);
465
466/*
467 * cell.c
468 */
469extern struct rw_semaphore afs_proc_cells_sem;
470extern struct list_head afs_proc_cells;
471
472#define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
473extern int afs_cell_init(char *);
474extern struct afs_cell *afs_cell_create(const char *, unsigned, char *, bool);
475extern struct afs_cell *afs_cell_lookup(const char *, unsigned, bool);
476extern struct afs_cell *afs_grab_cell(struct afs_cell *);
477extern void afs_put_cell(struct afs_cell *);
478extern void afs_cell_purge(void);
479
480/*
481 * cmservice.c
482 */
483extern bool afs_cm_incoming_call(struct afs_call *);
484
485/*
486 * dir.c
487 */
488extern const struct inode_operations afs_dir_inode_operations;
489extern const struct dentry_operations afs_fs_dentry_operations;
490extern const struct file_operations afs_dir_file_operations;
491
492/*
493 * file.c
494 */
495extern const struct address_space_operations afs_fs_aops;
496extern const struct inode_operations afs_file_inode_operations;
497extern const struct file_operations afs_file_operations;
498
499extern int afs_open(struct inode *, struct file *);
500extern int afs_release(struct inode *, struct file *);
501extern int afs_page_filler(void *, struct page *);
502
503/*
504 * flock.c
505 */
506extern void __exit afs_kill_lock_manager(void);
507extern void afs_lock_work(struct work_struct *);
508extern void afs_lock_may_be_available(struct afs_vnode *);
509extern int afs_lock(struct file *, int, struct file_lock *);
510extern int afs_flock(struct file *, int, struct file_lock *);
511
512/*
513 * fsclient.c
514 */
515extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
516 struct afs_vnode *, struct afs_volsync *,
517 const struct afs_wait_mode *);
518extern int afs_fs_give_up_callbacks(struct afs_server *,
519 const struct afs_wait_mode *);
520extern int afs_fs_fetch_data(struct afs_server *, struct key *,
521 struct afs_vnode *, off_t, size_t, struct page *,
522 const struct afs_wait_mode *);
523extern int afs_fs_create(struct afs_server *, struct key *,
524 struct afs_vnode *, const char *, umode_t,
525 struct afs_fid *, struct afs_file_status *,
526 struct afs_callback *,
527 const struct afs_wait_mode *);
528extern int afs_fs_remove(struct afs_server *, struct key *,
529 struct afs_vnode *, const char *, bool,
530 const struct afs_wait_mode *);
531extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
532 struct afs_vnode *, const char *,
533 const struct afs_wait_mode *);
534extern int afs_fs_symlink(struct afs_server *, struct key *,
535 struct afs_vnode *, const char *, const char *,
536 struct afs_fid *, struct afs_file_status *,
537 const struct afs_wait_mode *);
538extern int afs_fs_rename(struct afs_server *, struct key *,
539 struct afs_vnode *, const char *,
540 struct afs_vnode *, const char *,
541 const struct afs_wait_mode *);
542extern int afs_fs_store_data(struct afs_server *, struct afs_writeback *,
543 pgoff_t, pgoff_t, unsigned, unsigned,
544 const struct afs_wait_mode *);
545extern int afs_fs_setattr(struct afs_server *, struct key *,
546 struct afs_vnode *, struct iattr *,
547 const struct afs_wait_mode *);
548extern int afs_fs_get_volume_status(struct afs_server *, struct key *,
549 struct afs_vnode *,
550 struct afs_volume_status *,
551 const struct afs_wait_mode *);
552extern int afs_fs_set_lock(struct afs_server *, struct key *,
553 struct afs_vnode *, afs_lock_type_t,
554 const struct afs_wait_mode *);
555extern int afs_fs_extend_lock(struct afs_server *, struct key *,
556 struct afs_vnode *,
557 const struct afs_wait_mode *);
558extern int afs_fs_release_lock(struct afs_server *, struct key *,
559 struct afs_vnode *,
560 const struct afs_wait_mode *);
561
562/*
563 * inode.c
564 */
565extern struct inode *afs_iget_autocell(struct inode *, const char *, int,
566 struct key *);
567extern struct inode *afs_iget(struct super_block *, struct key *,
568 struct afs_fid *, struct afs_file_status *,
569 struct afs_callback *);
570extern void afs_zap_data(struct afs_vnode *);
571extern int afs_validate(struct afs_vnode *, struct key *);
572extern int afs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
573extern int afs_setattr(struct dentry *, struct iattr *);
574extern void afs_evict_inode(struct inode *);
575extern int afs_drop_inode(struct inode *);
576
577/*
578 * main.c
579 */
580extern struct workqueue_struct *afs_wq;
581extern struct afs_uuid afs_uuid;
582
583/*
584 * misc.c
585 */
586extern int afs_abort_to_error(u32);
587
588/*
589 * mntpt.c
590 */
591extern const struct inode_operations afs_mntpt_inode_operations;
592extern const struct inode_operations afs_autocell_inode_operations;
593extern const struct file_operations afs_mntpt_file_operations;
594
595extern struct vfsmount *afs_d_automount(struct path *);
596extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
597extern void afs_mntpt_kill_timer(void);
598
599/*
600 * proc.c
601 */
602extern int afs_proc_init(void);
603extern void afs_proc_cleanup(void);
604extern int afs_proc_cell_setup(struct afs_cell *);
605extern void afs_proc_cell_remove(struct afs_cell *);
606
607/*
608 * rxrpc.c
609 */
610extern int afs_open_socket(void);
611extern void afs_close_socket(void);
612extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
613 const struct afs_wait_mode *);
614extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
615 size_t, size_t);
616extern void afs_flat_call_destructor(struct afs_call *);
617extern void afs_transfer_reply(struct afs_call *, struct sk_buff *);
618extern void afs_send_empty_reply(struct afs_call *);
619extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
620extern int afs_extract_data(struct afs_call *, struct sk_buff *, bool, void *,
621 size_t);
622
623/*
624 * security.c
625 */
626extern void afs_clear_permits(struct afs_vnode *);
627extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
628extern void afs_zap_permits(struct rcu_head *);
629extern struct key *afs_request_key(struct afs_cell *);
630extern int afs_permission(struct inode *, int);
631
632/*
633 * server.c
634 */
635extern spinlock_t afs_server_peer_lock;
636
637#define afs_get_server(S) \
638do { \
639 _debug("GET SERVER %d", atomic_read(&(S)->usage)); \
640 atomic_inc(&(S)->usage); \
641} while(0)
642
643extern struct afs_server *afs_lookup_server(struct afs_cell *,
644 const struct in_addr *);
645extern struct afs_server *afs_find_server(const struct in_addr *);
646extern void afs_put_server(struct afs_server *);
647extern void __exit afs_purge_servers(void);
648
649/*
650 * super.c
651 */
652extern int afs_fs_init(void);
653extern void afs_fs_exit(void);
654
655/*
656 * use-rtnetlink.c
657 */
658extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
659extern int afs_get_MAC_address(u8 *, size_t);
660
661/*
662 * vlclient.c
663 */
664extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
665 const char *, struct afs_cache_vlocation *,
666 const struct afs_wait_mode *);
667extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
668 afs_volid_t, afs_voltype_t,
669 struct afs_cache_vlocation *,
670 const struct afs_wait_mode *);
671
672/*
673 * vlocation.c
674 */
675#define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
676
677extern int __init afs_vlocation_update_init(void);
678extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
679 struct key *,
680 const char *, size_t);
681extern void afs_put_vlocation(struct afs_vlocation *);
682extern void afs_vlocation_purge(void);
683
684/*
685 * vnode.c
686 */
687static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
688{
689 return container_of(inode, struct afs_vnode, vfs_inode);
690}
691
692static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
693{
694 return &vnode->vfs_inode;
695}
696
697extern void afs_vnode_finalise_status_update(struct afs_vnode *,
698 struct afs_server *);
699extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
700 struct key *);
701extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
702 off_t, size_t, struct page *);
703extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
704 umode_t, struct afs_fid *, struct afs_file_status *,
705 struct afs_callback *, struct afs_server **);
706extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
707 bool);
708extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
709 const char *);
710extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
711 const char *, struct afs_fid *,
712 struct afs_file_status *, struct afs_server **);
713extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
714 struct key *, const char *, const char *);
715extern int afs_vnode_store_data(struct afs_writeback *, pgoff_t, pgoff_t,
716 unsigned, unsigned);
717extern int afs_vnode_setattr(struct afs_vnode *, struct key *, struct iattr *);
718extern int afs_vnode_get_volume_status(struct afs_vnode *, struct key *,
719 struct afs_volume_status *);
720extern int afs_vnode_set_lock(struct afs_vnode *, struct key *,
721 afs_lock_type_t);
722extern int afs_vnode_extend_lock(struct afs_vnode *, struct key *);
723extern int afs_vnode_release_lock(struct afs_vnode *, struct key *);
724
725/*
726 * volume.c
727 */
728#define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
729
730extern void afs_put_volume(struct afs_volume *);
731extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
732extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
733extern int afs_volume_release_fileserver(struct afs_vnode *,
734 struct afs_server *, int);
735
736/*
737 * write.c
738 */
739extern int afs_set_page_dirty(struct page *);
740extern void afs_put_writeback(struct afs_writeback *);
741extern int afs_write_begin(struct file *file, struct address_space *mapping,
742 loff_t pos, unsigned len, unsigned flags,
743 struct page **pagep, void **fsdata);
744extern int afs_write_end(struct file *file, struct address_space *mapping,
745 loff_t pos, unsigned len, unsigned copied,
746 struct page *page, void *fsdata);
747extern int afs_writepage(struct page *, struct writeback_control *);
748extern int afs_writepages(struct address_space *, struct writeback_control *);
749extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
750extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
751extern int afs_writeback_all(struct afs_vnode *);
752extern int afs_fsync(struct file *, loff_t, loff_t, int);
753
754
755/*****************************************************************************/
756/*
757 * debug tracing
758 */
759extern unsigned afs_debug;
760
761#define dbgprintk(FMT,...) \
762 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
763
764#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
765#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
766#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
767
768
769#if defined(__KDEBUG)
770#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
771#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
772#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
773
774#elif defined(CONFIG_AFS_DEBUG)
775#define AFS_DEBUG_KENTER 0x01
776#define AFS_DEBUG_KLEAVE 0x02
777#define AFS_DEBUG_KDEBUG 0x04
778
779#define _enter(FMT,...) \
780do { \
781 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
782 kenter(FMT,##__VA_ARGS__); \
783} while (0)
784
785#define _leave(FMT,...) \
786do { \
787 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
788 kleave(FMT,##__VA_ARGS__); \
789} while (0)
790
791#define _debug(FMT,...) \
792do { \
793 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
794 kdebug(FMT,##__VA_ARGS__); \
795} while (0)
796
797#else
798#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
799#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
800#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
801#endif
802
803/*
804 * debug assertion checking
805 */
806#if 1 // defined(__KDEBUGALL)
807
808#define ASSERT(X) \
809do { \
810 if (unlikely(!(X))) { \
811 printk(KERN_ERR "\n"); \
812 printk(KERN_ERR "AFS: Assertion failed\n"); \
813 BUG(); \
814 } \
815} while(0)
816
817#define ASSERTCMP(X, OP, Y) \
818do { \
819 if (unlikely(!((X) OP (Y)))) { \
820 printk(KERN_ERR "\n"); \
821 printk(KERN_ERR "AFS: Assertion failed\n"); \
822 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
823 (unsigned long)(X), (unsigned long)(Y)); \
824 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
825 (unsigned long)(X), (unsigned long)(Y)); \
826 BUG(); \
827 } \
828} while(0)
829
830#define ASSERTRANGE(L, OP1, N, OP2, H) \
831do { \
832 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
833 printk(KERN_ERR "\n"); \
834 printk(KERN_ERR "AFS: Assertion failed\n"); \
835 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
836 (unsigned long)(L), (unsigned long)(N), \
837 (unsigned long)(H)); \
838 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
839 (unsigned long)(L), (unsigned long)(N), \
840 (unsigned long)(H)); \
841 BUG(); \
842 } \
843} while(0)
844
845#define ASSERTIF(C, X) \
846do { \
847 if (unlikely((C) && !(X))) { \
848 printk(KERN_ERR "\n"); \
849 printk(KERN_ERR "AFS: Assertion failed\n"); \
850 BUG(); \
851 } \
852} while(0)
853
854#define ASSERTIFCMP(C, X, OP, Y) \
855do { \
856 if (unlikely((C) && !((X) OP (Y)))) { \
857 printk(KERN_ERR "\n"); \
858 printk(KERN_ERR "AFS: Assertion failed\n"); \
859 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
860 (unsigned long)(X), (unsigned long)(Y)); \
861 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
862 (unsigned long)(X), (unsigned long)(Y)); \
863 BUG(); \
864 } \
865} while(0)
866
867#else
868
869#define ASSERT(X) \
870do { \
871} while(0)
872
873#define ASSERTCMP(X, OP, Y) \
874do { \
875} while(0)
876
877#define ASSERTRANGE(L, OP1, N, OP2, H) \
878do { \
879} while(0)
880
881#define ASSERTIF(C, X) \
882do { \
883} while(0)
884
885#define ASSERTIFCMP(C, X, OP, Y) \
886do { \
887} while(0)
888
889#endif /* __KDEBUGALL */