1 /* SPDX-License-Identifier: GPL-2.0-or-later */
4 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #include <linux/compiler.h>
9 #include <linux/kernel.h>
10 #include <linux/ktime.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>
26 #include <net/af_rxrpc.h>
31 #define AFS_CELL_MAX_ADDRS 15
36 struct afs_server_probe
;
39 * Partial file-locking emulation mode. (The problem being that AFS3 only
40 * allows whole-file locks and no upgrading/downgrading).
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 */
50 struct 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 */
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 */
77 * Address preferences.
79 struct afs_addr_preference
{
81 struct in_addr ipv4_addr
; /* AF_INET address to compare against */
82 struct in6_addr ipv6_addr
; /* AF_INET6 address to compare against */
84 sa_family_t family
; /* Which address to use */
85 u16 prio
; /* Priority */
86 u8 subnet_mask
; /* How many bits to compare */
89 struct afs_addr_preference_list
{
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
);
99 struct rxrpc_peer
*peer
;
100 short last_error
; /* Last error from this address */
101 u16 prio
; /* Address priority */
105 * List of server addresses.
107 struct afs_addr_list
{
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))
126 * a record of an in-progress RxRPC 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 rxrpc_call
*rxcall
; /* RxRPC call handle */
134 struct rxrpc_peer
*peer
; /* Remote endpoint */
135 struct key
*key
; /* security for this call */
136 struct afs_net
*net
; /* The network namespace */
137 struct afs_server
*server
; /* The fileserver record if fs op (pins ref) */
138 struct afs_vlserver
*vlserver
; /* The vlserver record if vl op */
139 void *request
; /* request data (first part) */
140 size_t iov_len
; /* Size of *iter to be used */
141 struct iov_iter def_iter
; /* Default buffer/data iterator */
142 struct iov_iter
*write_iter
; /* Iterator defining write to be made */
143 struct iov_iter
*iter
; /* Iterator currently in use */
144 union { /* Convenience for ->def_iter */
146 struct bio_vec bvec
[1];
148 void *buffer
; /* reply receive buffer */
150 struct afs_endpoint_state
*probe
;
151 struct afs_addr_list
*vl_probe
;
152 struct afs_addr_list
*ret_alist
;
153 struct afs_vldb_entry
*ret_vldb
;
156 struct afs_fid fid
; /* Primary vnode ID (or all zeroes) */
157 unsigned char probe_index
; /* Address in ->probe_alist */
158 struct afs_operation
*op
;
159 unsigned int server_index
;
161 enum afs_call_state state
;
162 spinlock_t state_lock
;
163 int error
; /* error code */
164 u32 abort_code
; /* Remote abort ID or 0 */
165 unsigned int max_lifespan
; /* Maximum lifespan in secs to set if not 0 */
166 unsigned request_size
; /* size of request data */
167 unsigned reply_max
; /* maximum size of reply */
168 unsigned count2
; /* count used in unmarshalling */
169 unsigned char unmarshall
; /* unmarshalling phase */
170 bool drop_ref
; /* T if need to drop ref for incoming call */
171 bool need_attention
; /* T if RxRPC poked us */
172 bool async
; /* T if asynchronous */
173 bool upgrade
; /* T to request service upgrade */
174 bool intr
; /* T if interruptible */
175 bool unmarshalling_error
; /* T if an unmarshalling error occurred */
176 bool responded
; /* Got a response from the call (may be abort) */
177 u16 service_id
; /* Actual service ID (after upgrade) */
178 unsigned int debug_id
; /* Trace ID */
179 u32 operation_ID
; /* operation ID for an incoming call */
180 u32 count
; /* count for use in unmarshalling */
181 union { /* place to extract temporary data */
185 } __attribute__((packed
));
188 ktime_t issue_time
; /* Time of issue of operation */
191 struct afs_call_type
{
193 unsigned int op
; /* Really enum afs_fs_operation */
195 /* deliver request or reply data to an call
196 * - returning an error will cause the call to be aborted
198 int (*deliver
)(struct afs_call
*call
);
200 /* clean up a call */
201 void (*destructor
)(struct afs_call
*call
);
204 void (*work
)(struct work_struct
*work
);
206 /* Call done function (gets called immediately on success or failure) */
207 void (*done
)(struct afs_call
*call
);
211 * Key available for writeback on a file.
216 struct list_head vnode_link
; /* Link in vnode->wb_keys */
220 * AFS open file information record. Pointed to by file->private_data.
223 struct key
*key
; /* The key this file was opened with */
224 struct afs_wb_key
*wb
; /* Writeback key record for this file */
227 static inline struct key
*afs_file_key(struct file
*file
)
229 struct afs_file
*af
= file
->private_data
;
235 * Record of an outstanding read operation on a vnode.
238 loff_t pos
; /* Where to start reading */
239 loff_t len
; /* How much we're asking for */
240 loff_t actual_len
; /* How much we're actually getting */
241 loff_t file_size
; /* File size returned by server */
242 struct key
*key
; /* The key to use to reissue the read */
243 struct afs_vnode
*vnode
; /* The file being read into. */
244 struct netfs_io_subrequest
*subreq
; /* Fscache helper read request this belongs to */
245 afs_dataversion_t data_version
; /* Version number returned by server */
247 unsigned int call_debug_id
;
248 unsigned int nr_pages
;
250 void (*done
)(struct afs_read
*);
251 void (*cleanup
)(struct afs_read
*);
252 struct iov_iter
*iter
; /* Iterator representing the buffer */
253 struct iov_iter def_iter
; /* Default iterator */
257 * AFS superblock private data
258 * - there's one superblock per volume
260 struct afs_super_info
{
261 struct net
*net_ns
; /* Network namespace */
262 struct afs_cell
*cell
; /* The cell in which the volume resides */
263 struct afs_volume
*volume
; /* volume record */
264 enum afs_flock_mode flock_mode
:8; /* File locking emulation mode */
265 bool dyn_root
; /* True if dynamic root */
268 static inline struct afs_super_info
*AFS_FS_S(struct super_block
*sb
)
270 return sb
->s_fs_info
;
273 extern struct file_system_type afs_fs_type
;
276 * Set of substitutes for @sys.
278 struct afs_sysnames
{
279 #define AFS_NR_SYSNAME 16
280 char *subs
[AFS_NR_SYSNAME
];
287 * AFS network namespace record.
290 struct net
*net
; /* Backpointer to the owning net namespace */
291 struct afs_uuid uuid
;
292 bool live
; /* F if this namespace is being removed */
294 /* AF_RXRPC I/O stuff */
295 struct socket
*socket
;
296 struct afs_call
*spare_incoming_call
;
297 struct work_struct charge_preallocation_work
;
298 struct mutex socket_mutex
;
299 atomic_t nr_outstanding_calls
;
300 atomic_t nr_superblocks
;
303 struct rb_root cells
;
304 struct afs_cell
*ws_cell
;
305 struct work_struct cells_manager
;
306 struct timer_list cells_timer
;
307 atomic_t cells_outstanding
;
308 struct rw_semaphore cells_lock
;
309 struct mutex cells_alias_lock
;
311 struct mutex proc_cells_lock
;
312 struct hlist_head proc_cells
;
314 /* Known servers. Theoretically each fileserver can only be in one
315 * cell, but in practice, people create aliases and subsets and there's
316 * no easy way to distinguish them.
318 seqlock_t fs_lock
; /* For fs_servers, fs_probe_*, fs_proc */
319 struct rb_root fs_servers
; /* afs_server (by server UUID or address) */
320 struct list_head fs_probe_fast
; /* List of afs_server to probe at 30s intervals */
321 struct list_head fs_probe_slow
; /* List of afs_server to probe at 5m intervals */
322 struct hlist_head fs_proc
; /* procfs servers list */
324 struct hlist_head fs_addresses
; /* afs_server (by lowest IPv6 addr) */
325 seqlock_t fs_addr_lock
; /* For fs_addresses[46] */
327 struct work_struct fs_manager
;
328 struct timer_list fs_timer
;
330 struct work_struct fs_prober
;
331 struct timer_list fs_probe_timer
;
332 atomic_t servers_outstanding
;
334 /* File locking renewal management */
335 struct mutex lock_manager_mutex
;
338 struct super_block
*dynroot_sb
; /* Dynamic root mount superblock */
339 struct proc_dir_entry
*proc_afs
; /* /proc/net/afs directory */
340 struct afs_sysnames
*sysnames
;
341 rwlock_t sysnames_lock
;
342 struct afs_addr_preference_list __rcu
*address_prefs
;
343 u16 address_pref_version
;
345 /* Statistics counters */
346 atomic_t n_lookup
; /* Number of lookups done */
347 atomic_t n_reval
; /* Number of dentries needing revalidation */
348 atomic_t n_inval
; /* Number of invalidations by the server */
349 atomic_t n_relpg
; /* Number of invalidations by release_folio */
350 atomic_t n_read_dir
; /* Number of directory pages read */
351 atomic_t n_dir_cr
; /* Number of directory entry creation edits */
352 atomic_t n_dir_rm
; /* Number of directory entry removal edits */
353 atomic_t n_stores
; /* Number of store ops */
354 atomic_long_t n_store_bytes
; /* Number of bytes stored */
355 atomic_long_t n_fetch_bytes
; /* Number of bytes fetched */
356 atomic_t n_fetches
; /* Number of data fetch ops */
359 extern const char afs_init_sysname
[];
361 enum afs_cell_state
{
365 AFS_CELL_DEACTIVATING
,
374 * This is a tricky concept to get right as it is possible to create aliases
375 * simply by pointing AFSDB/SRV records for two names at the same set of VL
376 * servers; it is also possible to do things like setting up two sets of VL
377 * servers, one of which provides a superset of the volumes provided by the
378 * other (for internal/external division, for example).
380 * Cells only exist in the sense that (a) a cell's name maps to a set of VL
381 * servers and (b) a cell's name is used by the client to select the key to use
382 * for authentication and encryption. The cell name is not typically used in
385 * Two cells are determined to be aliases if they have an explicit alias (YFS
386 * only), share any VL servers in common or have at least one volume in common.
387 * "In common" means that the address list of the VL servers or the fileservers
388 * share at least one endpoint.
393 struct rb_node net_node
; /* Node in net->cells */
396 struct afs_cell
*alias_of
; /* The cell this is an alias of */
397 struct afs_volume
*root_volume
; /* The root.cell volume if there is one */
398 struct key
*anonymous_key
; /* anonymous user key for this cell */
399 struct work_struct manager
; /* Manager for init/deinit/dns */
400 struct hlist_node proc_link
; /* /proc cell list link */
401 time64_t dns_expiry
; /* Time AFSDB/SRV record expires */
402 time64_t last_inactive
; /* Time of last drop of usage count */
403 refcount_t ref
; /* Struct refcount */
404 atomic_t active
; /* Active usage counter */
406 #define AFS_CELL_FL_NO_GC 0 /* The cell was added manually, don't auto-gc */
407 #define AFS_CELL_FL_DO_LOOKUP 1 /* DNS lookup requested */
408 #define AFS_CELL_FL_CHECK_ALIAS 2 /* Need to check for aliases */
409 enum afs_cell_state state
;
411 enum dns_record_source dns_source
:8; /* Latest source of data from lookup */
412 enum dns_lookup_status dns_status
:8; /* Latest status of data from lookup */
413 unsigned int dns_lookup_count
; /* Counter of DNS lookups */
414 unsigned int debug_id
;
416 /* The volumes belonging to this cell */
417 struct rw_semaphore vs_lock
; /* Lock for server->volumes */
418 struct rb_root volumes
; /* Tree of volumes on this server */
419 struct hlist_head proc_volumes
; /* procfs volume list */
420 seqlock_t volume_lock
; /* For volumes */
422 /* Active fileserver interaction state. */
423 struct rb_root fs_servers
; /* afs_server (by server UUID) */
424 seqlock_t fs_lock
; /* For fs_servers */
426 /* VL server list. */
427 rwlock_t vl_servers_lock
; /* Lock on vl_servers */
428 struct afs_vlserver_list __rcu
*vl_servers
;
430 u8 name_len
; /* Length of name */
431 char *name
; /* Cell name, case-flattened and NUL-padded */
435 * Volume Location server record.
437 struct afs_vlserver
{
439 struct afs_addr_list __rcu
*addresses
; /* List of addresses for this VL server */
441 #define AFS_VLSERVER_FL_PROBED 0 /* The VL server has been probed */
442 #define AFS_VLSERVER_FL_PROBING 1 /* VL server is being probed */
443 #define AFS_VLSERVER_FL_IS_YFS 2 /* Server is YFS not AFS */
444 #define AFS_VLSERVER_FL_RESPONDING 3 /* VL server is responding */
445 rwlock_t lock
; /* Lock on addresses */
447 unsigned int rtt
; /* Server's current RTT in uS */
448 unsigned int debug_id
;
451 wait_queue_head_t probe_wq
;
452 atomic_t probe_outstanding
;
453 spinlock_t probe_lock
;
455 unsigned int rtt
; /* Best RTT in uS (or UINT_MAX) */
458 unsigned short flags
;
459 #define AFS_VLSERVER_PROBE_RESPONDED 0x01 /* At least once response (may be abort) */
460 #define AFS_VLSERVER_PROBE_IS_YFS 0x02 /* The peer appears to be YFS */
461 #define AFS_VLSERVER_PROBE_NOT_YFS 0x04 /* The peer appears not to be YFS */
462 #define AFS_VLSERVER_PROBE_LOCAL_FAILURE 0x08 /* A local failure prevented a probe */
465 u16 service_id
; /* Service ID we're using */
467 u16 name_len
; /* Length of name */
468 char name
[]; /* Server name, case-flattened */
472 * Weighted list of Volume Location servers.
474 struct afs_vlserver_entry
{
475 u16 priority
; /* Preference (as SRV) */
476 u16 weight
; /* Weight (as SRV) */
477 enum dns_record_source source
:8;
478 enum dns_lookup_status status
:8;
479 struct afs_vlserver
*server
;
482 struct afs_vlserver_list
{
486 u8 index
; /* Server currently in use */
487 u8 preferred
; /* Preferred server */
488 enum dns_record_source source
:8;
489 enum dns_lookup_status status
:8;
491 struct afs_vlserver_entry servers
[];
497 * This is pointed to by cell->vldb_entries, indexed by name.
499 struct afs_vldb_entry
{
500 afs_volid_t vid
[3]; /* Volume IDs for R/W, R/O and Bak volumes */
503 #define AFS_VLDB_HAS_RW 0 /* - R/W volume exists */
504 #define AFS_VLDB_HAS_RO 1 /* - R/O volume exists */
505 #define AFS_VLDB_HAS_BAK 2 /* - Backup volume exists */
506 #define AFS_VLDB_QUERY_VALID 3 /* - Record is valid */
507 #define AFS_VLDB_QUERY_ERROR 4 /* - VL server returned error */
509 uuid_t fs_server
[AFS_NMAXNSERVERS
];
510 u32 addr_version
[AFS_NMAXNSERVERS
]; /* Registration change counters */
511 u8 fs_mask
[AFS_NMAXNSERVERS
];
512 #define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
513 #define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
514 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
515 u8 vlsf_flags
[AFS_NMAXNSERVERS
];
517 u8 nr_servers
; /* Number of server records */
519 u8 name
[AFS_MAXVOLNAME
+ 1]; /* NUL-padded volume name */
523 * Fileserver endpoint state. The records the addresses of a fileserver's
524 * endpoints and the state and result of a round of probing on them. This
525 * allows the rotation algorithm to access those results without them being
526 * erased by a subsequent round of probing.
528 struct afs_endpoint_state
{
530 struct afs_addr_list
*addresses
; /* The addresses being probed */
531 unsigned long responsive_set
; /* Bitset of responsive endpoints */
532 unsigned long failed_set
; /* Bitset of endpoints we failed to probe */
534 unsigned int server_id
; /* Debug ID of server */
535 unsigned int probe_seq
; /* Probe sequence (from server::probe_counter) */
536 atomic_t nr_probing
; /* Number of outstanding probes */
537 unsigned int rtt
; /* Best RTT in uS (or UINT_MAX) */
541 #define AFS_ESTATE_RESPONDED 0 /* Set if the server responded */
542 #define AFS_ESTATE_SUPERSEDED 1 /* Set if this record has been superseded */
543 #define AFS_ESTATE_IS_YFS 2 /* Set if probe upgraded to YFS */
544 #define AFS_ESTATE_NOT_YFS 3 /* Set if probe didn't upgrade to YFS */
545 #define AFS_ESTATE_LOCAL_FAILURE 4 /* Set if there was a local failure (eg. ENOMEM) */
549 * Record of fileserver with which we're actively communicating.
554 uuid_t uuid
; /* Server ID */
555 struct afs_uuid _uuid
;
558 struct afs_cell
*cell
; /* Cell to which belongs (pins ref) */
559 struct rb_node uuid_rb
; /* Link in net->fs_servers */
560 struct afs_server __rcu
*uuid_next
; /* Next server with same UUID */
561 struct afs_server
*uuid_prev
; /* Previous server with same UUID */
562 struct list_head probe_link
; /* Link in net->fs_probe_list */
563 struct hlist_node addr_link
; /* Link in net->fs_addresses6 */
564 struct hlist_node proc_link
; /* Link in net->fs_proc */
565 struct list_head volumes
; /* RCU list of afs_server_entry objects */
566 struct afs_server
*gc_next
; /* Next server in manager's list */
567 time64_t unuse_time
; /* Time at which last unused */
569 #define AFS_SERVER_FL_RESPONDING 0 /* The server is responding */
570 #define AFS_SERVER_FL_UPDATING 1
571 #define AFS_SERVER_FL_NEEDS_UPDATE 2 /* Fileserver address list is out of date */
572 #define AFS_SERVER_FL_NOT_READY 4 /* The record is not ready for use */
573 #define AFS_SERVER_FL_NOT_FOUND 5 /* VL server says no such server */
574 #define AFS_SERVER_FL_VL_FAIL 6 /* Failed to access VL server */
575 #define AFS_SERVER_FL_MAY_HAVE_CB 8 /* May have callbacks on this fileserver */
576 #define AFS_SERVER_FL_IS_YFS 16 /* Server is YFS not AFS */
577 #define AFS_SERVER_FL_NO_IBULK 17 /* Fileserver doesn't support FS.InlineBulkStatus */
578 #define AFS_SERVER_FL_NO_RM2 18 /* Fileserver doesn't support YFS.RemoveFile2 */
579 #define AFS_SERVER_FL_HAS_FS64 19 /* Fileserver supports FS.{Fetch,Store}Data64 */
580 refcount_t ref
; /* Object refcount */
581 atomic_t active
; /* Active user count */
582 u32 addr_version
; /* Address list version */
583 u16 service_id
; /* Service ID we're using. */
584 unsigned int rtt
; /* Server's current RTT in uS */
585 unsigned int debug_id
; /* Debugging ID for traces */
587 /* file service access */
588 rwlock_t fs_lock
; /* access lock */
591 struct afs_endpoint_state __rcu
*endpoint_state
; /* Latest endpoint/probe state */
592 unsigned long probed_at
; /* Time last probe was dispatched (jiffies) */
593 wait_queue_head_t probe_wq
;
594 unsigned int probe_counter
; /* Number of probes issued */
595 spinlock_t probe_lock
;
598 enum afs_ro_replicating
{
599 AFS_RO_NOT_REPLICATING
, /* Not doing replication */
600 AFS_RO_REPLICATING_USE_OLD
, /* Replicating; use old version */
601 AFS_RO_REPLICATING_USE_NEW
, /* Replicating; switch to new version */
605 * Replaceable volume server list.
607 struct afs_server_entry
{
608 struct afs_server
*server
;
609 struct afs_volume
*volume
;
610 struct list_head slink
; /* Link in server->volumes */
611 time64_t cb_expires_at
; /* Time at which volume-level callback expires */
613 #define AFS_SE_EXCLUDED 0 /* Set if server is to be excluded in rotation */
614 #define AFS_SE_VOLUME_OFFLINE 1 /* Set if volume offline notice given */
615 #define AFS_SE_VOLUME_BUSY 2 /* Set if volume busy notice given */
618 struct afs_server_list
{
621 bool attached
; /* T if attached to servers */
622 enum afs_ro_replicating ro_replicating
; /* RW->RO update (probably) in progress */
623 unsigned char nr_servers
;
624 unsigned short vnovol_mask
; /* Servers to be skipped due to VNOVOL */
625 unsigned int seq
; /* Set to ->servers_seq when installed */
627 struct afs_server_entry servers
[];
631 * Live AFS volume management.
635 afs_volid_t vid
; /* The volume ID of this volume */
636 afs_volid_t vids
[AFS_MAXTYPES
]; /* All associated volume IDs */
638 time64_t update_at
; /* Time at which to next update */
639 struct afs_cell
*cell
; /* Cell to which belongs (pins ref) */
640 struct rb_node cell_node
; /* Link in cell->volumes */
641 struct hlist_node proc_link
; /* Link in cell->proc_volumes */
642 struct super_block __rcu
*sb
; /* Superblock on which inodes reside */
643 struct work_struct destructor
; /* Deferred destructor */
645 #define AFS_VOLUME_NEEDS_UPDATE 0 /* - T if an update needs performing */
646 #define AFS_VOLUME_UPDATING 1 /* - T if an update is in progress */
647 #define AFS_VOLUME_WAIT 2 /* - T if users must wait for update */
648 #define AFS_VOLUME_DELETED 3 /* - T if volume appears deleted */
649 #define AFS_VOLUME_MAYBE_NO_IBULK 4 /* - T if some servers don't have InlineBulkStatus */
650 #define AFS_VOLUME_RM_TREE 5 /* - Set if volume removed from cell->volumes */
651 #ifdef CONFIG_AFS_FSCACHE
652 struct fscache_volume
*cache
; /* Caching cookie */
654 struct afs_server_list __rcu
*servers
; /* List of servers on which volume resides */
655 rwlock_t servers_lock
; /* Lock for ->servers */
656 unsigned int servers_seq
; /* Incremented each time ->servers changes */
658 /* RO release tracking */
659 struct mutex volsync_lock
; /* Time/state evaluation lock */
660 time64_t creation_time
; /* Volume creation time (or TIME64_MIN) */
661 time64_t update_time
; /* Volume update time (or TIME64_MIN) */
663 /* Callback management */
664 struct mutex cb_check_lock
; /* Lock to control race to check after v_break */
665 time64_t cb_expires_at
; /* Earliest volume callback expiry time */
666 atomic_t cb_ro_snapshot
; /* RO volume update-from-snapshot counter */
667 atomic_t cb_v_break
; /* Volume-break event counter. */
668 atomic_t cb_v_check
; /* Volume-break has-been-checked counter. */
669 atomic_t cb_scrub
; /* Scrub-all-data event counter. */
670 rwlock_t cb_v_break_lock
;
671 struct rw_semaphore open_mmaps_lock
;
672 struct list_head open_mmaps
; /* List of vnodes that are mmapped */
674 afs_voltype_t type
; /* type of volume */
675 char type_force
; /* force volume type (suppress R/O -> R/W) */
677 u8 name
[AFS_MAXVOLNAME
+ 1]; /* NUL-padded volume name */
680 enum afs_lock_state
{
681 AFS_VNODE_LOCK_NONE
, /* The vnode has no lock on the server */
682 AFS_VNODE_LOCK_WAITING_FOR_CB
, /* We're waiting for the server to break the callback */
683 AFS_VNODE_LOCK_SETTING
, /* We're asking the server for a lock */
684 AFS_VNODE_LOCK_GRANTED
, /* We have a lock on the server */
685 AFS_VNODE_LOCK_EXTENDING
, /* We're extending a lock on the server */
686 AFS_VNODE_LOCK_NEED_UNLOCK
, /* We need to unlock on the server */
687 AFS_VNODE_LOCK_UNLOCKING
, /* We're telling the server to unlock */
688 AFS_VNODE_LOCK_DELETED
, /* The vnode has been deleted whilst we have a lock */
692 * AFS inode private data.
694 * Note that afs_alloc_inode() *must* reset anything that could incorrectly
695 * leak from one inode to another.
698 struct netfs_inode netfs
; /* Netfslib context and vfs inode */
699 struct afs_volume
*volume
; /* volume on which vnode resides */
700 struct afs_fid fid
; /* the file identifier for this inode */
701 struct afs_file_status status
; /* AFS status info for this file */
702 afs_dataversion_t invalid_before
; /* Child dentries are invalid before this */
703 struct afs_permits __rcu
*permit_cache
; /* cache of permits so far obtained */
704 struct mutex io_lock
; /* Lock for serialising I/O on this mutex */
705 struct rw_semaphore validate_lock
; /* lock for validating this vnode */
706 struct rw_semaphore rmdir_lock
; /* Lock for rmdir vs sillyrename */
707 struct key
*silly_key
; /* Silly rename key */
708 spinlock_t wb_lock
; /* lock for wb_keys */
709 spinlock_t lock
; /* waitqueue/flags lock */
711 #define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
712 #define AFS_VNODE_DIR_VALID 2 /* Set if dir contents are valid */
713 #define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
714 #define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
715 #define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
716 #define AFS_VNODE_AUTOCELL 6 /* set if Vnode is an auto mount point */
717 #define AFS_VNODE_PSEUDODIR 7 /* set if Vnode is a pseudo directory */
718 #define AFS_VNODE_NEW_CONTENT 8 /* Set if file has new content (create/trunc-0) */
719 #define AFS_VNODE_SILLY_DELETED 9 /* Set if file has been silly-deleted */
720 #define AFS_VNODE_MODIFYING 10 /* Set if we're performing a modification op */
722 struct list_head wb_keys
; /* List of keys available for writeback */
723 struct list_head pending_locks
; /* locks waiting to be granted */
724 struct list_head granted_locks
; /* locks granted on this file */
725 struct delayed_work lock_work
; /* work to be done in locking */
726 struct key
*lock_key
; /* Key to be used in lock ops */
727 ktime_t locked_at
; /* Time at which lock obtained */
728 enum afs_lock_state lock_state
: 8;
729 afs_lock_type_t lock_type
: 8;
731 /* outstanding callback notification on this file */
732 struct work_struct cb_work
; /* Work for mmap'd files */
733 struct list_head cb_mmap_link
; /* Link in cell->fs_open_mmaps */
734 void *cb_server
; /* Server with callback/filelock */
735 atomic_t cb_nr_mmap
; /* Number of mmaps */
736 unsigned int cb_ro_snapshot
; /* RO volume release counter on ->volume */
737 unsigned int cb_scrub
; /* Scrub counter on ->volume */
738 unsigned int cb_break
; /* Break counter on vnode */
739 unsigned int cb_v_check
; /* Break check counter on ->volume */
740 seqlock_t cb_lock
; /* Lock for ->cb_server, ->status, ->cb_*break */
742 atomic64_t cb_expires_at
; /* time at which callback expires */
743 #define AFS_NO_CB_PROMISE TIME64_MIN
746 static inline struct fscache_cookie
*afs_vnode_cache(struct afs_vnode
*vnode
)
748 #ifdef CONFIG_AFS_FSCACHE
749 return netfs_i_cookie(&vnode
->netfs
);
755 static inline void afs_vnode_set_cache(struct afs_vnode
*vnode
,
756 struct fscache_cookie
*cookie
)
758 #ifdef CONFIG_AFS_FSCACHE
759 vnode
->netfs
.cache
= cookie
;
761 mapping_set_release_always(vnode
->netfs
.inode
.i_mapping
);
766 * cached security record for one user's attempt to access a vnode
769 struct key
*key
; /* RxRPC ticket holding a security context */
770 afs_access_t access
; /* CallerAccess value for this key */
774 * Immutable cache of CallerAccess records from attempts to access vnodes.
775 * These may be shared between multiple vnodes.
779 struct hlist_node hash_node
; /* Link in hash */
780 unsigned long h
; /* Hash value for this permit list */
782 unsigned short nr_permits
; /* Number of records */
783 bool invalidated
; /* Invalidated due to key change */
784 struct afs_permit permits
[] __counted_by(nr_permits
); /* List of permits sorted by key pointer */
788 * Error prioritisation and accumulation.
791 s32 abort_code
; /* Cumulative abort code */
792 short error
; /* Cumulative error */
793 bool responded
; /* T if server responded */
794 bool aborted
; /* T if ->error is from an abort */
798 * Cursor for iterating over a set of volume location servers.
800 struct afs_vl_cursor
{
801 struct afs_cell
*cell
; /* The cell we're querying */
802 struct afs_vlserver_list
*server_list
; /* Current server list (pins ref) */
803 struct afs_vlserver
*server
; /* Server on which this resides */
804 struct afs_addr_list
*alist
; /* Current address list (pins ref) */
805 struct key
*key
; /* Key for the server */
806 unsigned long untried_servers
; /* Bitmask of untried servers */
807 unsigned long addr_tried
; /* Tried addresses */
808 struct afs_error cumul_error
; /* Cumulative error */
809 unsigned int debug_id
;
811 short call_error
; /* Error from single call */
812 short server_index
; /* Current server */
813 signed char addr_index
; /* Current address */
814 unsigned short flags
;
815 #define AFS_VL_CURSOR_STOP 0x0001 /* Set to cease iteration */
816 #define AFS_VL_CURSOR_RETRY 0x0002 /* Set to do a retry */
817 #define AFS_VL_CURSOR_RETRIED 0x0004 /* Set if started a retry */
818 short nr_iterations
; /* Number of server iterations */
819 bool call_responded
; /* T if the current address responded */
823 * Fileserver state tracking for an operation. An array of these is kept,
824 * indexed by server index.
826 struct afs_server_state
{
827 /* Tracking of fileserver probe state. Other operations may interfere
828 * by probing a fileserver when accessing other volumes.
830 unsigned int probe_seq
;
831 unsigned long untried_addrs
; /* Addresses we haven't tried yet */
832 struct wait_queue_entry probe_waiter
;
833 struct afs_endpoint_state
*endpoint_state
; /* Endpoint state being monitored */
837 * Fileserver operation methods.
839 struct afs_operation_ops
{
840 void (*issue_afs_rpc
)(struct afs_operation
*op
);
841 void (*issue_yfs_rpc
)(struct afs_operation
*op
);
842 void (*success
)(struct afs_operation
*op
);
843 void (*aborted
)(struct afs_operation
*op
);
844 void (*failed
)(struct afs_operation
*op
);
845 void (*edit_dir
)(struct afs_operation
*op
);
846 void (*put
)(struct afs_operation
*op
);
849 struct afs_vnode_param
{
850 struct afs_vnode
*vnode
;
851 struct afs_fid fid
; /* Fid to access */
852 struct afs_status_cb scb
; /* Returned status and callback promise */
853 afs_dataversion_t dv_before
; /* Data version before the call */
854 unsigned int cb_break_before
; /* cb_break before the call */
855 u8 dv_delta
; /* Expected change in data version */
856 bool put_vnode
:1; /* T if we have a ref on the vnode */
857 bool need_io_lock
:1; /* T if we need the I/O lock on this */
858 bool update_ctime
:1; /* Need to update the ctime */
859 bool set_size
:1; /* Must update i_size */
860 bool op_unlinked
:1; /* True if file was unlinked by op */
861 bool speculative
:1; /* T if speculative status fetch (no vnode lock) */
862 bool modification
:1; /* Set if the content gets modified */
866 * Fileserver operation wrapper, handling server and address rotation
867 * asynchronously. May make simultaneous calls to multiple servers.
869 struct afs_operation
{
870 struct afs_net
*net
; /* Network namespace */
871 struct key
*key
; /* Key for the cell */
872 const struct afs_call_type
*type
; /* Type of call done */
873 const struct afs_operation_ops
*ops
;
875 /* Parameters/results for the operation */
876 struct afs_volume
*volume
; /* Volume being accessed */
877 struct afs_vnode_param file
[2];
878 struct afs_vnode_param
*more_files
;
879 struct afs_volsync pre_volsync
; /* Volsync before op */
880 struct afs_volsync volsync
; /* Volsync returned by op */
881 struct dentry
*dentry
; /* Dentry to be altered */
882 struct dentry
*dentry_2
; /* Second dentry to be altered */
883 struct timespec64 mtime
; /* Modification time to record */
884 struct timespec64 ctime
; /* Change time to set */
885 struct afs_error cumul_error
; /* Cumulative error */
886 short nr_files
; /* Number of entries in file[], more_files */
887 unsigned int debug_id
;
889 unsigned int cb_v_break
; /* Volume break counter before op */
893 int which
; /* Which ->file[] to fetch for */
896 int reason
; /* enum afs_edit_dir_reason */
904 struct dentry
*rehash
;
909 struct afs_read
*req
;
912 afs_lock_type_t type
;
915 struct iov_iter
*write_iter
;
925 struct yfs_acl
*yacl
;
927 struct afs_volume_status vs
;
932 /* Fileserver iteration state */
933 struct afs_server_list
*server_list
; /* Current server list (pins ref) */
934 struct afs_server
*server
; /* Server we're using (ref pinned by server_list) */
935 struct afs_endpoint_state
*estate
; /* Current endpoint state (doesn't pin ref) */
936 struct afs_server_state
*server_states
; /* States of the servers involved */
937 struct afs_call
*call
;
938 unsigned long untried_servers
; /* Bitmask of untried servers */
939 unsigned long addr_tried
; /* Tried addresses */
940 s32 call_abort_code
; /* Abort code from single call */
941 short call_error
; /* Error from single call */
942 short server_index
; /* Current server */
943 short nr_iterations
; /* Number of server iterations */
944 signed char addr_index
; /* Current address */
945 bool call_responded
; /* T if the current address responded */
948 #define AFS_OPERATION_STOP 0x0001 /* Set to cease iteration */
949 #define AFS_OPERATION_VBUSY 0x0002 /* Set if seen VBUSY */
950 #define AFS_OPERATION_VMOVED 0x0004 /* Set if seen VMOVED */
951 #define AFS_OPERATION_VNOVOL 0x0008 /* Set if seen VNOVOL */
952 #define AFS_OPERATION_CUR_ONLY 0x0010 /* Set if current server only (file lock held) */
953 #define AFS_OPERATION_NO_VSLEEP 0x0020 /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
954 #define AFS_OPERATION_UNINTR 0x0040 /* Set if op is uninterruptible */
955 #define AFS_OPERATION_DOWNGRADE 0x0080 /* Set to retry with downgraded opcode */
956 #define AFS_OPERATION_LOCK_0 0x0100 /* Set if have io_lock on file[0] */
957 #define AFS_OPERATION_LOCK_1 0x0200 /* Set if have io_lock on file[1] */
958 #define AFS_OPERATION_TRIED_ALL 0x0400 /* Set if we've tried all the fileservers */
959 #define AFS_OPERATION_RETRY_SERVER 0x0800 /* Set if we should retry the current server */
960 #define AFS_OPERATION_DIR_CONFLICT 0x1000 /* Set if we detected a 3rd-party dir change */
964 * Cache auxiliary data.
966 struct afs_vnode_cache_aux
{
970 static inline void afs_set_cache_aux(struct afs_vnode
*vnode
,
971 struct afs_vnode_cache_aux
*aux
)
973 aux
->data_version
= cpu_to_be64(vnode
->status
.data_version
);
976 static inline void afs_invalidate_cache(struct afs_vnode
*vnode
, unsigned int flags
)
978 struct afs_vnode_cache_aux aux
;
980 afs_set_cache_aux(vnode
, &aux
);
981 fscache_invalidate(afs_vnode_cache(vnode
), &aux
,
982 i_size_read(&vnode
->netfs
.inode
), flags
);
985 #include <trace/events/afs.h>
987 /*****************************************************************************/
991 struct afs_addr_list
*afs_get_addrlist(struct afs_addr_list
*alist
, enum afs_alist_trace reason
);
992 extern struct afs_addr_list
*afs_alloc_addrlist(unsigned int nr
);
993 extern void afs_put_addrlist(struct afs_addr_list
*alist
, enum afs_alist_trace reason
);
994 extern struct afs_vlserver_list
*afs_parse_text_addrs(struct afs_net
*,
995 const char *, size_t, char,
996 unsigned short, unsigned short);
997 bool afs_addr_list_same(const struct afs_addr_list
*a
,
998 const struct afs_addr_list
*b
);
999 extern struct afs_vlserver_list
*afs_dns_query(struct afs_cell
*, time64_t
*);
1001 extern int afs_merge_fs_addr4(struct afs_net
*net
, struct afs_addr_list
*addr
,
1002 __be32 xdr
, u16 port
);
1003 extern int afs_merge_fs_addr6(struct afs_net
*net
, struct afs_addr_list
*addr
,
1004 __be32
*xdr
, u16 port
);
1009 int afs_proc_addr_prefs_write(struct file
*file
, char *buf
, size_t size
);
1010 void afs_get_address_preferences_rcu(struct afs_net
*net
, struct afs_addr_list
*alist
);
1011 void afs_get_address_preferences(struct afs_net
*net
, struct afs_addr_list
*alist
);
1016 extern void afs_invalidate_mmap_work(struct work_struct
*);
1017 extern void afs_init_callback_state(struct afs_server
*);
1018 extern void __afs_break_callback(struct afs_vnode
*, enum afs_cb_break_reason
);
1019 extern void afs_break_callback(struct afs_vnode
*, enum afs_cb_break_reason
);
1020 extern void afs_break_callbacks(struct afs_server
*, size_t, struct afs_callback_break
*);
1022 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode
*vnode
)
1024 return vnode
->cb_break
+ vnode
->cb_ro_snapshot
+ vnode
->cb_scrub
;
1027 static inline bool afs_cb_is_broken(unsigned int cb_break
,
1028 const struct afs_vnode
*vnode
)
1030 return cb_break
!= (vnode
->cb_break
+
1031 atomic_read(&vnode
->volume
->cb_ro_snapshot
) +
1032 atomic_read(&vnode
->volume
->cb_scrub
));
1038 extern int afs_cell_init(struct afs_net
*, const char *);
1039 extern struct afs_cell
*afs_find_cell(struct afs_net
*, const char *, unsigned,
1040 enum afs_cell_trace
);
1041 extern struct afs_cell
*afs_lookup_cell(struct afs_net
*, const char *, unsigned,
1042 const char *, bool);
1043 extern struct afs_cell
*afs_use_cell(struct afs_cell
*, enum afs_cell_trace
);
1044 extern void afs_unuse_cell(struct afs_net
*, struct afs_cell
*, enum afs_cell_trace
);
1045 extern struct afs_cell
*afs_get_cell(struct afs_cell
*, enum afs_cell_trace
);
1046 extern void afs_see_cell(struct afs_cell
*, enum afs_cell_trace
);
1047 extern void afs_put_cell(struct afs_cell
*, enum afs_cell_trace
);
1048 extern void afs_queue_cell(struct afs_cell
*, enum afs_cell_trace
);
1049 extern void afs_manage_cells(struct work_struct
*);
1050 extern void afs_cells_timer(struct timer_list
*);
1051 extern void __net_exit
afs_cell_purge(struct afs_net
*);
1056 extern bool afs_cm_incoming_call(struct afs_call
*);
1061 extern const struct file_operations afs_dir_file_operations
;
1062 extern const struct inode_operations afs_dir_inode_operations
;
1063 extern const struct address_space_operations afs_dir_aops
;
1064 extern const struct dentry_operations afs_fs_dentry_operations
;
1066 extern void afs_d_release(struct dentry
*);
1067 extern void afs_check_for_remote_deletion(struct afs_operation
*);
1072 extern void afs_edit_dir_add(struct afs_vnode
*, struct qstr
*, struct afs_fid
*,
1073 enum afs_edit_dir_reason
);
1074 extern void afs_edit_dir_remove(struct afs_vnode
*, struct qstr
*, enum afs_edit_dir_reason
);
1079 extern int afs_sillyrename(struct afs_vnode
*, struct afs_vnode
*,
1080 struct dentry
*, struct key
*);
1081 extern int afs_silly_iput(struct dentry
*, struct inode
*);
1086 extern const struct inode_operations afs_dynroot_inode_operations
;
1087 extern const struct dentry_operations afs_dynroot_dentry_operations
;
1089 extern struct inode
*afs_try_auto_mntpt(struct dentry
*, struct inode
*);
1090 extern int afs_dynroot_mkdir(struct afs_net
*, struct afs_cell
*);
1091 extern void afs_dynroot_rmdir(struct afs_net
*, struct afs_cell
*);
1092 extern int afs_dynroot_populate(struct super_block
*);
1093 extern void afs_dynroot_depopulate(struct super_block
*);
1098 extern const struct address_space_operations afs_file_aops
;
1099 extern const struct address_space_operations afs_symlink_aops
;
1100 extern const struct inode_operations afs_file_inode_operations
;
1101 extern const struct file_operations afs_file_operations
;
1102 extern const struct netfs_request_ops afs_req_ops
;
1104 extern int afs_cache_wb_key(struct afs_vnode
*, struct afs_file
*);
1105 extern void afs_put_wb_key(struct afs_wb_key
*);
1106 extern int afs_open(struct inode
*, struct file
*);
1107 extern int afs_release(struct inode
*, struct file
*);
1108 extern int afs_fetch_data(struct afs_vnode
*, struct afs_read
*);
1109 extern struct afs_read
*afs_alloc_read(gfp_t
);
1110 extern void afs_put_read(struct afs_read
*);
1112 static inline struct afs_read
*afs_get_read(struct afs_read
*req
)
1114 refcount_inc(&req
->usage
);
1121 extern struct workqueue_struct
*afs_lock_manager
;
1123 extern void afs_lock_op_done(struct afs_call
*);
1124 extern void afs_lock_work(struct work_struct
*);
1125 extern void afs_lock_may_be_available(struct afs_vnode
*);
1126 extern int afs_lock(struct file
*, int, struct file_lock
*);
1127 extern int afs_flock(struct file
*, int, struct file_lock
*);
1132 extern void afs_fs_fetch_status(struct afs_operation
*);
1133 extern void afs_fs_fetch_data(struct afs_operation
*);
1134 extern void afs_fs_create_file(struct afs_operation
*);
1135 extern void afs_fs_make_dir(struct afs_operation
*);
1136 extern void afs_fs_remove_file(struct afs_operation
*);
1137 extern void afs_fs_remove_dir(struct afs_operation
*);
1138 extern void afs_fs_link(struct afs_operation
*);
1139 extern void afs_fs_symlink(struct afs_operation
*);
1140 extern void afs_fs_rename(struct afs_operation
*);
1141 extern void afs_fs_store_data(struct afs_operation
*);
1142 extern void afs_fs_setattr(struct afs_operation
*);
1143 extern void afs_fs_get_volume_status(struct afs_operation
*);
1144 extern void afs_fs_set_lock(struct afs_operation
*);
1145 extern void afs_fs_extend_lock(struct afs_operation
*);
1146 extern void afs_fs_release_lock(struct afs_operation
*);
1147 int afs_fs_give_up_all_callbacks(struct afs_net
*net
, struct afs_server
*server
,
1148 struct afs_address
*addr
, struct key
*key
);
1149 bool afs_fs_get_capabilities(struct afs_net
*net
, struct afs_server
*server
,
1150 struct afs_endpoint_state
*estate
, unsigned int addr_index
,
1152 extern void afs_fs_inline_bulk_status(struct afs_operation
*);
1156 u8 data
[] __counted_by(size
);
1159 extern void afs_fs_fetch_acl(struct afs_operation
*);
1160 extern void afs_fs_store_acl(struct afs_operation
*);
1165 extern struct afs_operation
*afs_alloc_operation(struct key
*, struct afs_volume
*);
1166 extern int afs_put_operation(struct afs_operation
*);
1167 extern bool afs_begin_vnode_operation(struct afs_operation
*);
1168 extern void afs_wait_for_operation(struct afs_operation
*);
1169 extern int afs_do_sync_operation(struct afs_operation
*);
1171 static inline void afs_op_set_vnode(struct afs_operation
*op
, unsigned int n
,
1172 struct afs_vnode
*vnode
)
1174 op
->file
[n
].vnode
= vnode
;
1175 op
->file
[n
].need_io_lock
= true;
1178 static inline void afs_op_set_fid(struct afs_operation
*op
, unsigned int n
,
1179 const struct afs_fid
*fid
)
1181 op
->file
[n
].fid
= *fid
;
1187 struct afs_endpoint_state
*afs_get_endpoint_state(struct afs_endpoint_state
*estate
,
1188 enum afs_estate_trace where
);
1189 void afs_put_endpoint_state(struct afs_endpoint_state
*estate
, enum afs_estate_trace where
);
1190 extern void afs_fileserver_probe_result(struct afs_call
*);
1191 void afs_fs_probe_fileserver(struct afs_net
*net
, struct afs_server
*server
,
1192 struct afs_addr_list
*new_addrs
, struct key
*key
);
1193 int afs_wait_for_fs_probes(struct afs_operation
*op
, struct afs_server_state
*states
, bool intr
);
1194 extern void afs_probe_fileserver(struct afs_net
*, struct afs_server
*);
1195 extern void afs_fs_probe_dispatcher(struct work_struct
*);
1196 int afs_wait_for_one_fs_probe(struct afs_server
*server
, struct afs_endpoint_state
*estate
,
1197 unsigned long exclude
, bool is_intr
);
1198 extern void afs_fs_probe_cleanup(struct afs_net
*);
1203 extern const struct afs_operation_ops afs_fetch_status_operation
;
1205 extern void afs_vnode_commit_status(struct afs_operation
*, struct afs_vnode_param
*);
1206 extern int afs_fetch_status(struct afs_vnode
*, struct key
*, bool, afs_access_t
*);
1207 extern int afs_ilookup5_test_by_fid(struct inode
*, void *);
1208 extern struct inode
*afs_iget_pseudo_dir(struct super_block
*, bool);
1209 extern struct inode
*afs_iget(struct afs_operation
*, struct afs_vnode_param
*);
1210 extern struct inode
*afs_root_iget(struct super_block
*, struct key
*);
1211 extern int afs_getattr(struct mnt_idmap
*idmap
, const struct path
*,
1212 struct kstat
*, u32
, unsigned int);
1213 extern int afs_setattr(struct mnt_idmap
*idmap
, struct dentry
*, struct iattr
*);
1214 extern void afs_evict_inode(struct inode
*);
1215 extern int afs_drop_inode(struct inode
*);
1220 extern struct workqueue_struct
*afs_wq
;
1221 extern int afs_net_id
;
1223 static inline struct afs_net
*afs_net(struct net
*net
)
1225 return net_generic(net
, afs_net_id
);
1228 static inline struct afs_net
*afs_sb2net(struct super_block
*sb
)
1230 return afs_net(AFS_FS_S(sb
)->net_ns
);
1233 static inline struct afs_net
*afs_d2net(struct dentry
*dentry
)
1235 return afs_sb2net(dentry
->d_sb
);
1238 static inline struct afs_net
*afs_i2net(struct inode
*inode
)
1240 return afs_sb2net(inode
->i_sb
);
1243 static inline struct afs_net
*afs_v2net(struct afs_vnode
*vnode
)
1245 return afs_i2net(&vnode
->netfs
.inode
);
1248 static inline struct afs_net
*afs_sock2net(struct sock
*sk
)
1250 return net_generic(sock_net(sk
), afs_net_id
);
1253 static inline void __afs_stat(atomic_t
*s
)
1258 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1263 extern int afs_abort_to_error(u32
);
1264 extern void afs_prioritise_error(struct afs_error
*, int, u32
);
1266 static inline void afs_op_nomem(struct afs_operation
*op
)
1268 op
->cumul_error
.error
= -ENOMEM
;
1271 static inline int afs_op_error(const struct afs_operation
*op
)
1273 return op
->cumul_error
.error
;
1276 static inline s32
afs_op_abort_code(const struct afs_operation
*op
)
1278 return op
->cumul_error
.abort_code
;
1281 static inline int afs_op_set_error(struct afs_operation
*op
, int error
)
1283 return op
->cumul_error
.error
= error
;
1286 static inline void afs_op_accumulate_error(struct afs_operation
*op
, int error
, s32 abort_code
)
1288 afs_prioritise_error(&op
->cumul_error
, error
, abort_code
);
1294 extern const struct inode_operations afs_mntpt_inode_operations
;
1295 extern const struct inode_operations afs_autocell_inode_operations
;
1296 extern const struct file_operations afs_mntpt_file_operations
;
1298 extern struct vfsmount
*afs_d_automount(struct path
*);
1299 extern void afs_mntpt_kill_timer(void);
1304 #ifdef CONFIG_PROC_FS
1305 extern int __net_init
afs_proc_init(struct afs_net
*);
1306 extern void __net_exit
afs_proc_cleanup(struct afs_net
*);
1307 extern int afs_proc_cell_setup(struct afs_cell
*);
1308 extern void afs_proc_cell_remove(struct afs_cell
*);
1309 extern void afs_put_sysnames(struct afs_sysnames
*);
1311 static inline int afs_proc_init(struct afs_net
*net
) { return 0; }
1312 static inline void afs_proc_cleanup(struct afs_net
*net
) {}
1313 static inline int afs_proc_cell_setup(struct afs_cell
*cell
) { return 0; }
1314 static inline void afs_proc_cell_remove(struct afs_cell
*cell
) {}
1315 static inline void afs_put_sysnames(struct afs_sysnames
*sysnames
) {}
1321 void afs_clear_server_states(struct afs_operation
*op
);
1322 extern bool afs_select_fileserver(struct afs_operation
*);
1323 extern void afs_dump_edestaddrreq(const struct afs_operation
*);
1328 extern struct workqueue_struct
*afs_async_calls
;
1330 extern int __net_init
afs_open_socket(struct afs_net
*);
1331 extern void __net_exit
afs_close_socket(struct afs_net
*);
1332 extern void afs_charge_preallocation(struct work_struct
*);
1333 extern void afs_put_call(struct afs_call
*);
1334 void afs_make_call(struct afs_call
*call
, gfp_t gfp
);
1335 void afs_wait_for_call_to_complete(struct afs_call
*call
);
1336 extern struct afs_call
*afs_alloc_flat_call(struct afs_net
*,
1337 const struct afs_call_type
*,
1339 extern void afs_flat_call_destructor(struct afs_call
*);
1340 extern void afs_send_empty_reply(struct afs_call
*);
1341 extern void afs_send_simple_reply(struct afs_call
*, const void *, size_t);
1342 extern int afs_extract_data(struct afs_call
*, bool);
1343 extern int afs_protocol_error(struct afs_call
*, enum afs_eproto_cause
);
1345 static inline void afs_make_op_call(struct afs_operation
*op
, struct afs_call
*call
,
1348 struct afs_addr_list
*alist
= op
->estate
->addresses
;
1351 op
->type
= call
->type
;
1353 call
->key
= op
->key
;
1354 call
->intr
= !(op
->flags
& AFS_OPERATION_UNINTR
);
1355 call
->peer
= rxrpc_kernel_get_peer(alist
->addrs
[op
->addr_index
].peer
);
1356 call
->service_id
= op
->server
->service_id
;
1357 afs_make_call(call
, gfp
);
1360 static inline void afs_extract_begin(struct afs_call
*call
, void *buf
, size_t size
)
1362 call
->iov_len
= size
;
1363 call
->kvec
[0].iov_base
= buf
;
1364 call
->kvec
[0].iov_len
= size
;
1365 iov_iter_kvec(&call
->def_iter
, ITER_DEST
, call
->kvec
, 1, size
);
1368 static inline void afs_extract_to_tmp(struct afs_call
*call
)
1370 call
->iov_len
= sizeof(call
->tmp
);
1371 afs_extract_begin(call
, &call
->tmp
, sizeof(call
->tmp
));
1374 static inline void afs_extract_to_tmp64(struct afs_call
*call
)
1376 call
->iov_len
= sizeof(call
->tmp64
);
1377 afs_extract_begin(call
, &call
->tmp64
, sizeof(call
->tmp64
));
1380 static inline void afs_extract_discard(struct afs_call
*call
, size_t size
)
1382 call
->iov_len
= size
;
1383 iov_iter_discard(&call
->def_iter
, ITER_DEST
, size
);
1386 static inline void afs_extract_to_buf(struct afs_call
*call
, size_t size
)
1388 call
->iov_len
= size
;
1389 afs_extract_begin(call
, call
->buffer
, size
);
1392 static inline int afs_transfer_reply(struct afs_call
*call
)
1394 return afs_extract_data(call
, false);
1397 static inline bool afs_check_call_state(struct afs_call
*call
,
1398 enum afs_call_state state
)
1400 return READ_ONCE(call
->state
) == state
;
1403 static inline bool afs_set_call_state(struct afs_call
*call
,
1404 enum afs_call_state from
,
1405 enum afs_call_state to
)
1409 spin_lock_bh(&call
->state_lock
);
1410 if (call
->state
== from
) {
1412 trace_afs_call_state(call
, from
, to
, 0, 0);
1415 spin_unlock_bh(&call
->state_lock
);
1419 static inline void afs_set_call_complete(struct afs_call
*call
,
1420 int error
, u32 remote_abort
)
1422 enum afs_call_state state
;
1425 spin_lock_bh(&call
->state_lock
);
1426 state
= call
->state
;
1427 if (state
!= AFS_CALL_COMPLETE
) {
1428 call
->abort_code
= remote_abort
;
1429 call
->error
= error
;
1430 call
->state
= AFS_CALL_COMPLETE
;
1431 trace_afs_call_state(call
, state
, AFS_CALL_COMPLETE
,
1432 error
, remote_abort
);
1435 spin_unlock_bh(&call
->state_lock
);
1437 trace_afs_call_done(call
);
1439 /* Asynchronous calls have two refs to release - one from the alloc and
1440 * one queued with the work item - and we can't just deallocate the
1441 * call because the work item may be queued again.
1451 extern void afs_put_permits(struct afs_permits
*);
1452 extern void afs_clear_permits(struct afs_vnode
*);
1453 extern void afs_cache_permit(struct afs_vnode
*, struct key
*, unsigned int,
1454 struct afs_status_cb
*);
1455 extern struct key
*afs_request_key(struct afs_cell
*);
1456 extern struct key
*afs_request_key_rcu(struct afs_cell
*);
1457 extern int afs_check_permit(struct afs_vnode
*, struct key
*, afs_access_t
*);
1458 extern int afs_permission(struct mnt_idmap
*, struct inode
*, int);
1459 extern void __exit
afs_clean_up_permit_cache(void);
1464 extern spinlock_t afs_server_peer_lock
;
1466 extern struct afs_server
*afs_find_server(struct afs_net
*, const struct rxrpc_peer
*);
1467 extern struct afs_server
*afs_find_server_by_uuid(struct afs_net
*, const uuid_t
*);
1468 extern struct afs_server
*afs_lookup_server(struct afs_cell
*, struct key
*, const uuid_t
*, u32
);
1469 extern struct afs_server
*afs_get_server(struct afs_server
*, enum afs_server_trace
);
1470 extern struct afs_server
*afs_use_server(struct afs_server
*, enum afs_server_trace
);
1471 extern void afs_unuse_server(struct afs_net
*, struct afs_server
*, enum afs_server_trace
);
1472 extern void afs_unuse_server_notime(struct afs_net
*, struct afs_server
*, enum afs_server_trace
);
1473 extern void afs_put_server(struct afs_net
*, struct afs_server
*, enum afs_server_trace
);
1474 extern void afs_manage_servers(struct work_struct
*);
1475 extern void afs_servers_timer(struct timer_list
*);
1476 extern void afs_fs_probe_timer(struct timer_list
*);
1477 extern void __net_exit
afs_purge_servers(struct afs_net
*);
1478 bool afs_check_server_record(struct afs_operation
*op
, struct afs_server
*server
, struct key
*key
);
1480 static inline void afs_inc_servers_outstanding(struct afs_net
*net
)
1482 atomic_inc(&net
->servers_outstanding
);
1485 static inline void afs_dec_servers_outstanding(struct afs_net
*net
)
1487 if (atomic_dec_and_test(&net
->servers_outstanding
))
1488 wake_up_var(&net
->servers_outstanding
);
1491 static inline bool afs_is_probing_server(struct afs_server
*server
)
1493 return list_empty(&server
->probe_link
);
1499 static inline struct afs_server_list
*afs_get_serverlist(struct afs_server_list
*slist
)
1501 refcount_inc(&slist
->usage
);
1505 extern void afs_put_serverlist(struct afs_net
*, struct afs_server_list
*);
1506 struct afs_server_list
*afs_alloc_server_list(struct afs_volume
*volume
,
1508 struct afs_vldb_entry
*vldb
);
1509 extern bool afs_annotate_server_list(struct afs_server_list
*, struct afs_server_list
*);
1510 void afs_attach_volume_to_servers(struct afs_volume
*volume
, struct afs_server_list
*slist
);
1511 void afs_reattach_volume_to_servers(struct afs_volume
*volume
, struct afs_server_list
*slist
,
1512 struct afs_server_list
*old
);
1513 void afs_detach_volume_from_servers(struct afs_volume
*volume
, struct afs_server_list
*slist
);
1518 extern int __init
afs_fs_init(void);
1519 extern void afs_fs_exit(void);
1524 bool afs_check_validity(const struct afs_vnode
*vnode
);
1525 int afs_update_volume_state(struct afs_operation
*op
);
1526 int afs_validate(struct afs_vnode
*vnode
, struct key
*key
);
1531 extern struct afs_vldb_entry
*afs_vl_get_entry_by_name_u(struct afs_vl_cursor
*,
1533 extern struct afs_addr_list
*afs_vl_get_addrs_u(struct afs_vl_cursor
*, const uuid_t
*);
1534 struct afs_call
*afs_vl_get_capabilities(struct afs_net
*net
,
1535 struct afs_addr_list
*alist
,
1536 unsigned int addr_index
,
1538 struct afs_vlserver
*server
,
1539 unsigned int server_index
);
1540 extern struct afs_addr_list
*afs_yfsvl_get_endpoints(struct afs_vl_cursor
*, const uuid_t
*);
1541 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor
*);
1546 extern int afs_cell_detect_alias(struct afs_cell
*, struct key
*);
1551 extern void afs_vlserver_probe_result(struct afs_call
*);
1552 extern int afs_send_vl_probes(struct afs_net
*, struct key
*, struct afs_vlserver_list
*);
1553 extern int afs_wait_for_vl_probes(struct afs_vlserver_list
*, unsigned long);
1558 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor
*,
1559 struct afs_cell
*, struct key
*);
1560 extern bool afs_select_vlserver(struct afs_vl_cursor
*);
1561 extern bool afs_select_current_vlserver(struct afs_vl_cursor
*);
1562 extern int afs_end_vlserver_operation(struct afs_vl_cursor
*);
1567 static inline struct afs_vlserver
*afs_get_vlserver(struct afs_vlserver
*vlserver
)
1569 refcount_inc(&vlserver
->ref
);
1573 static inline struct afs_vlserver_list
*afs_get_vlserverlist(struct afs_vlserver_list
*vllist
)
1576 refcount_inc(&vllist
->ref
);
1580 extern struct afs_vlserver
*afs_alloc_vlserver(const char *, size_t, unsigned short);
1581 extern void afs_put_vlserver(struct afs_net
*, struct afs_vlserver
*);
1582 extern struct afs_vlserver_list
*afs_alloc_vlserver_list(unsigned int);
1583 extern void afs_put_vlserverlist(struct afs_net
*, struct afs_vlserver_list
*);
1584 extern struct afs_vlserver_list
*afs_extract_vlserver_list(struct afs_cell
*,
1585 const void *, size_t);
1590 extern struct afs_volume
*afs_create_volume(struct afs_fs_context
*);
1591 extern int afs_activate_volume(struct afs_volume
*);
1592 extern void afs_deactivate_volume(struct afs_volume
*);
1593 bool afs_try_get_volume(struct afs_volume
*volume
, enum afs_volume_trace reason
);
1594 extern struct afs_volume
*afs_get_volume(struct afs_volume
*, enum afs_volume_trace
);
1595 void afs_put_volume(struct afs_volume
*volume
, enum afs_volume_trace reason
);
1596 extern int afs_check_volume_status(struct afs_volume
*, struct afs_operation
*);
1601 void afs_prepare_write(struct netfs_io_subrequest
*subreq
);
1602 void afs_issue_write(struct netfs_io_subrequest
*subreq
);
1603 void afs_begin_writeback(struct netfs_io_request
*wreq
);
1604 void afs_retry_request(struct netfs_io_request
*wreq
, struct netfs_io_stream
*stream
);
1605 extern int afs_writepages(struct address_space
*, struct writeback_control
*);
1606 extern int afs_fsync(struct file
*, loff_t
, loff_t
, int);
1607 extern vm_fault_t
afs_page_mkwrite(struct vm_fault
*vmf
);
1608 extern void afs_prune_wb_keys(struct afs_vnode
*);
1613 extern const struct xattr_handler
* const afs_xattr_handlers
[];
1618 extern void yfs_fs_fetch_data(struct afs_operation
*);
1619 extern void yfs_fs_create_file(struct afs_operation
*);
1620 extern void yfs_fs_make_dir(struct afs_operation
*);
1621 extern void yfs_fs_remove_file2(struct afs_operation
*);
1622 extern void yfs_fs_remove_file(struct afs_operation
*);
1623 extern void yfs_fs_remove_dir(struct afs_operation
*);
1624 extern void yfs_fs_link(struct afs_operation
*);
1625 extern void yfs_fs_symlink(struct afs_operation
*);
1626 extern void yfs_fs_rename(struct afs_operation
*);
1627 extern void yfs_fs_store_data(struct afs_operation
*);
1628 extern void yfs_fs_setattr(struct afs_operation
*);
1629 extern void yfs_fs_get_volume_status(struct afs_operation
*);
1630 extern void yfs_fs_set_lock(struct afs_operation
*);
1631 extern void yfs_fs_extend_lock(struct afs_operation
*);
1632 extern void yfs_fs_release_lock(struct afs_operation
*);
1633 extern void yfs_fs_fetch_status(struct afs_operation
*);
1634 extern void yfs_fs_inline_bulk_status(struct afs_operation
*);
1637 struct afs_acl
*acl
; /* Dir/file/symlink ACL */
1638 struct afs_acl
*vol_acl
; /* Whole volume ACL */
1639 u32 inherit_flag
; /* True if ACL is inherited from parent dir */
1640 u32 num_cleaned
; /* Number of ACEs removed due to subject removal */
1642 #define YFS_ACL_WANT_ACL 0x01 /* Set if caller wants ->acl */
1643 #define YFS_ACL_WANT_VOL_ACL 0x02 /* Set if caller wants ->vol_acl */
1646 extern void yfs_free_opaque_acl(struct yfs_acl
*);
1647 extern void yfs_fs_fetch_opaque_acl(struct afs_operation
*);
1648 extern void yfs_fs_store_opaque_acl2(struct afs_operation
*);
1651 * Miscellaneous inline functions.
1653 static inline struct afs_vnode
*AFS_FS_I(struct inode
*inode
)
1655 return container_of(inode
, struct afs_vnode
, netfs
.inode
);
1658 static inline struct inode
*AFS_VNODE_TO_I(struct afs_vnode
*vnode
)
1660 return &vnode
->netfs
.inode
;
1664 * Note that a dentry got changed. We need to set d_fsdata to the data version
1665 * number derived from the result of the operation. It doesn't matter if
1666 * d_fsdata goes backwards as we'll just revalidate.
1668 static inline void afs_update_dentry_version(struct afs_operation
*op
,
1669 struct afs_vnode_param
*dir_vp
,
1670 struct dentry
*dentry
)
1672 if (!op
->cumul_error
.error
)
1674 (void *)(unsigned long)dir_vp
->scb
.status
.data_version
;
1678 * Set the file size and block count. Estimate the number of 512 bytes blocks
1679 * used, rounded up to nearest 1K for consistency with other AFS clients.
1681 static inline void afs_set_i_size(struct afs_vnode
*vnode
, u64 size
)
1683 i_size_write(&vnode
->netfs
.inode
, size
);
1684 vnode
->netfs
.inode
.i_blocks
= ((size
+ 1023) >> 10) << 1;
1688 * Check for a conflicting operation on a directory that we just unlinked from.
1689 * If someone managed to sneak a link or an unlink in on the file we just
1690 * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1692 static inline void afs_check_dir_conflict(struct afs_operation
*op
,
1693 struct afs_vnode_param
*dvp
)
1695 if (dvp
->dv_before
+ dvp
->dv_delta
!= dvp
->scb
.status
.data_version
)
1696 op
->flags
|= AFS_OPERATION_DIR_CONFLICT
;
1699 static inline int afs_io_error(struct afs_call
*call
, enum afs_io_error where
)
1701 trace_afs_io_error(call
->debug_id
, -EIO
, where
);
1705 static inline int afs_bad(struct afs_vnode
*vnode
, enum afs_file_error where
)
1707 trace_afs_file_error(vnode
, -EIO
, where
);
1711 /*****************************************************************************/
1715 extern unsigned afs_debug
;
1717 #define dbgprintk(FMT,...) \
1718 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1720 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1721 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1722 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1725 #if defined(__KDEBUG)
1726 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1727 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1728 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1730 #elif defined(CONFIG_AFS_DEBUG)
1731 #define AFS_DEBUG_KENTER 0x01
1732 #define AFS_DEBUG_KLEAVE 0x02
1733 #define AFS_DEBUG_KDEBUG 0x04
1735 #define _enter(FMT,...) \
1737 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
1738 kenter(FMT,##__VA_ARGS__); \
1741 #define _leave(FMT,...) \
1743 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
1744 kleave(FMT,##__VA_ARGS__); \
1747 #define _debug(FMT,...) \
1749 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
1750 kdebug(FMT,##__VA_ARGS__); \
1754 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1755 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1756 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1760 * debug assertion checking
1762 #if 1 // defined(__KDEBUGALL)
1766 if (unlikely(!(X))) { \
1767 printk(KERN_ERR "\n"); \
1768 printk(KERN_ERR "AFS: Assertion failed\n"); \
1773 #define ASSERTCMP(X, OP, Y) \
1775 if (unlikely(!((X) OP (Y)))) { \
1776 printk(KERN_ERR "\n"); \
1777 printk(KERN_ERR "AFS: Assertion failed\n"); \
1778 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1779 (unsigned long)(X), (unsigned long)(Y)); \
1780 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1781 (unsigned long)(X), (unsigned long)(Y)); \
1786 #define ASSERTRANGE(L, OP1, N, OP2, H) \
1788 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
1789 printk(KERN_ERR "\n"); \
1790 printk(KERN_ERR "AFS: Assertion failed\n"); \
1791 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1792 (unsigned long)(L), (unsigned long)(N), \
1793 (unsigned long)(H)); \
1794 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1795 (unsigned long)(L), (unsigned long)(N), \
1796 (unsigned long)(H)); \
1801 #define ASSERTIF(C, X) \
1803 if (unlikely((C) && !(X))) { \
1804 printk(KERN_ERR "\n"); \
1805 printk(KERN_ERR "AFS: Assertion failed\n"); \
1810 #define ASSERTIFCMP(C, X, OP, Y) \
1812 if (unlikely((C) && !((X) OP (Y)))) { \
1813 printk(KERN_ERR "\n"); \
1814 printk(KERN_ERR "AFS: Assertion failed\n"); \
1815 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1816 (unsigned long)(X), (unsigned long)(Y)); \
1817 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1818 (unsigned long)(X), (unsigned long)(Y)); \
1829 #define ASSERTCMP(X, OP, Y) \
1833 #define ASSERTRANGE(L, OP1, N, OP2, H) \
1837 #define ASSERTIF(C, X) \
1841 #define ASSERTIFCMP(C, X, OP, Y) \
1845 #endif /* __KDEBUGALL */