3 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
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.
12 #include <linux/compiler.h>
13 #include <linux/kernel.h>
14 #include <linux/ktime.h>
16 #include <linux/pagemap.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 #include <linux/uuid.h>
24 #include <net/net_namespace.h>
25 #include <net/af_rxrpc.h>
30 #define AFS_CELL_MAX_ADDRS 15
35 struct afs_mount_params {
36 bool rwpath; /* T if the parent should be considered R/W */
37 bool force; /* T to force cell type */
38 bool autocell; /* T if set auto mount operation */
39 bool dyn_root; /* T if dynamic root */
40 afs_voltype_t type; /* type of volume requested */
41 int volnamesz; /* size of volume name */
42 const char *volname; /* name of volume to mount */
43 struct afs_net *net; /* Network namespace in effect */
44 struct afs_cell *cell; /* cell in which to find volume */
45 struct afs_volume *volume; /* volume record */
46 struct key *key; /* key to use for secure mounting */
49 struct afs_iget_data {
51 struct afs_volume *volume; /* volume on which resides */
55 AFS_CALL_CL_REQUESTING, /* Client: Request is being sent */
56 AFS_CALL_CL_AWAIT_REPLY, /* Client: Awaiting reply */
57 AFS_CALL_CL_PROC_REPLY, /* Client: rxrpc call complete; processing reply */
58 AFS_CALL_SV_AWAIT_OP_ID, /* Server: Awaiting op ID */
59 AFS_CALL_SV_AWAIT_REQUEST, /* Server: Awaiting request data */
60 AFS_CALL_SV_REPLYING, /* Server: Replying */
61 AFS_CALL_SV_AWAIT_ACK, /* Server: Awaiting final ACK */
62 AFS_CALL_COMPLETE, /* Completed or failed */
66 * List of server addresses.
68 struct afs_addr_list {
69 struct rcu_head rcu; /* Must be first */
71 u32 version; /* Version */
72 unsigned short nr_addrs;
73 unsigned short index; /* Address currently in use */
74 unsigned short nr_ipv4; /* Number of IPv4 addresses */
75 unsigned long probed; /* Mask of servers that have been probed */
76 unsigned long yfs; /* Mask of servers that are YFS */
77 struct sockaddr_rxrpc addrs[];
81 * a record of an in-progress RxRPC call
84 const struct afs_call_type *type; /* type of call */
85 wait_queue_head_t waitq; /* processes awaiting completion */
86 struct work_struct async_work; /* async I/O processor */
87 struct work_struct work; /* actual work processor */
88 struct rxrpc_call *rxcall; /* RxRPC call handle */
89 struct key *key; /* security for this call */
90 struct afs_net *net; /* The network namespace */
91 struct afs_server *cm_server; /* Server affected by incoming CM call */
92 struct afs_cb_interest *cbi; /* Callback interest for server used */
93 void *request; /* request data (first part) */
94 struct address_space *mapping; /* Pages being written from */
95 void *buffer; /* reply receive buffer */
96 void *reply[4]; /* Where to put the reply */
97 pgoff_t first; /* first page in mapping to deal with */
98 pgoff_t last; /* last page in mapping to deal with */
99 size_t offset; /* offset into received data store */
101 enum afs_call_state state;
102 spinlock_t state_lock;
103 int error; /* error code */
104 u32 abort_code; /* Remote abort ID or 0 */
105 unsigned request_size; /* size of request data */
106 unsigned reply_max; /* maximum size of reply */
107 unsigned first_offset; /* offset into mapping[first] */
108 unsigned int cb_break; /* cb_break + cb_s_break before the call */
110 unsigned last_to; /* amount of mapping[last] */
111 unsigned count2; /* count used in unmarshalling */
113 unsigned char unmarshall; /* unmarshalling phase */
114 bool incoming; /* T if incoming call */
115 bool send_pages; /* T if data from mapping should be sent */
116 bool need_attention; /* T if RxRPC poked us */
117 bool async; /* T if asynchronous */
118 bool ret_reply0; /* T if should return reply[0] on success */
119 bool upgrade; /* T to request service upgrade */
120 u16 service_id; /* Actual service ID (after upgrade) */
121 unsigned int debug_id; /* Trace ID */
122 u32 operation_ID; /* operation ID for an incoming call */
123 u32 count; /* count for use in unmarshalling */
124 __be32 tmp; /* place to extract temporary data */
125 afs_dataversion_t store_version; /* updated version expected from store */
128 struct afs_call_type {
130 unsigned int op; /* Really enum afs_fs_operation */
132 /* deliver request or reply data to an call
133 * - returning an error will cause the call to be aborted
135 int (*deliver)(struct afs_call *call);
137 /* clean up a call */
138 void (*destructor)(struct afs_call *call);
141 void (*work)(struct work_struct *work);
145 * Key available for writeback on a file.
150 struct list_head vnode_link; /* Link in vnode->wb_keys */
154 * AFS open file information record. Pointed to by file->private_data.
157 struct key *key; /* The key this file was opened with */
158 struct afs_wb_key *wb; /* Writeback key record for this file */
161 static inline struct key *afs_file_key(struct file *file)
163 struct afs_file *af = file->private_data;
169 * Record of an outstanding read operation on a vnode.
172 loff_t pos; /* Where to start reading */
173 loff_t len; /* How much we're asking for */
174 loff_t actual_len; /* How much we're actually getting */
175 loff_t remain; /* Amount remaining */
177 unsigned int index; /* Which page we're reading into */
178 unsigned int nr_pages;
179 void (*page_done)(struct afs_call *, struct afs_read *);
180 struct page *pages[];
184 * AFS superblock private data
185 * - there's one superblock per volume
187 struct afs_super_info {
188 struct afs_net *net; /* Network namespace */
189 struct afs_cell *cell; /* The cell in which the volume resides */
190 struct afs_volume *volume; /* volume record */
191 bool dyn_root; /* True if dynamic root */
194 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
196 return sb->s_fs_info;
199 extern struct file_system_type afs_fs_type;
202 * AFS network namespace record.
205 struct afs_uuid uuid;
206 bool live; /* F if this namespace is being removed */
208 /* AF_RXRPC I/O stuff */
209 struct socket *socket;
210 struct afs_call *spare_incoming_call;
211 struct work_struct charge_preallocation_work;
212 struct mutex socket_mutex;
213 atomic_t nr_outstanding_calls;
214 atomic_t nr_superblocks;
217 struct rb_root cells;
218 struct afs_cell *ws_cell;
219 struct work_struct cells_manager;
220 struct timer_list cells_timer;
221 atomic_t cells_outstanding;
222 seqlock_t cells_lock;
224 spinlock_t proc_cells_lock;
225 struct list_head proc_cells;
227 /* Known servers. Theoretically each fileserver can only be in one
228 * cell, but in practice, people create aliases and subsets and there's
229 * no easy way to distinguish them.
231 seqlock_t fs_lock; /* For fs_servers */
232 struct rb_root fs_servers; /* afs_server (by server UUID or address) */
233 struct list_head fs_updates; /* afs_server (by update_at) */
234 struct hlist_head fs_proc; /* procfs servers list */
236 struct hlist_head fs_addresses4; /* afs_server (by lowest IPv4 addr) */
237 struct hlist_head fs_addresses6; /* afs_server (by lowest IPv6 addr) */
238 seqlock_t fs_addr_lock; /* For fs_addresses[46] */
240 struct work_struct fs_manager;
241 struct timer_list fs_timer;
242 atomic_t servers_outstanding;
244 /* File locking renewal management */
245 struct mutex lock_manager_mutex;
248 struct proc_dir_entry *proc_afs; /* /proc/net/afs directory */
251 extern struct afs_net __afs_net;// Dummy AFS network namespace; TODO: replace with real netns
253 enum afs_cell_state {
257 AFS_CELL_DEACTIVATING,
265 * This is a tricky concept to get right as it is possible to create aliases
266 * simply by pointing AFSDB/SRV records for two names at the same set of VL
267 * servers; it is also possible to do things like setting up two sets of VL
268 * servers, one of which provides a superset of the volumes provided by the
269 * other (for internal/external division, for example).
271 * Cells only exist in the sense that (a) a cell's name maps to a set of VL
272 * servers and (b) a cell's name is used by the client to select the key to use
273 * for authentication and encryption. The cell name is not typically used in
276 * There is no easy way to determine if two cells are aliases or one is a
282 struct rb_node net_node; /* Node in net->cells */
285 struct key *anonymous_key; /* anonymous user key for this cell */
286 struct work_struct manager; /* Manager for init/deinit/dns */
287 struct list_head proc_link; /* /proc cell list link */
288 #ifdef CONFIG_AFS_FSCACHE
289 struct fscache_cookie *cache; /* caching cookie */
291 time64_t dns_expiry; /* Time AFSDB/SRV record expires */
292 time64_t last_inactive; /* Time of last drop of usage count */
295 #define AFS_CELL_FL_NOT_READY 0 /* The cell record is not ready for use */
296 #define AFS_CELL_FL_NO_GC 1 /* The cell was added manually, don't auto-gc */
297 #define AFS_CELL_FL_NOT_FOUND 2 /* Permanent DNS error */
298 #define AFS_CELL_FL_DNS_FAIL 3 /* Failed to access DNS */
299 #define AFS_CELL_FL_NO_LOOKUP_YET 4 /* Not completed first DNS lookup yet */
300 enum afs_cell_state state;
303 /* Active fileserver interaction state. */
304 struct list_head proc_volumes; /* procfs volume list */
307 /* VL server list. */
308 rwlock_t vl_addrs_lock; /* Lock on vl_addrs */
309 struct afs_addr_list __rcu *vl_addrs; /* List of VL servers */
310 u8 name_len; /* Length of name */
311 char name[64 + 1]; /* Cell name, case-flattened and NUL-padded */
317 * This is pointed to by cell->vldb_entries, indexed by name.
319 struct afs_vldb_entry {
320 afs_volid_t vid[3]; /* Volume IDs for R/W, R/O and Bak volumes */
323 #define AFS_VLDB_HAS_RW 0 /* - R/W volume exists */
324 #define AFS_VLDB_HAS_RO 1 /* - R/O volume exists */
325 #define AFS_VLDB_HAS_BAK 2 /* - Backup volume exists */
326 #define AFS_VLDB_QUERY_VALID 3 /* - Record is valid */
327 #define AFS_VLDB_QUERY_ERROR 4 /* - VL server returned error */
329 uuid_t fs_server[AFS_NMAXNSERVERS];
330 u8 fs_mask[AFS_NMAXNSERVERS];
331 #define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
332 #define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
333 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
335 u8 nr_servers; /* Number of server records */
337 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
341 * Record of fileserver with which we're actively communicating.
346 uuid_t uuid; /* Server ID */
347 struct afs_uuid _uuid;
350 struct afs_addr_list __rcu *addresses;
351 struct rb_node uuid_rb; /* Link in net->servers */
352 struct hlist_node addr4_link; /* Link in net->fs_addresses4 */
353 struct hlist_node addr6_link; /* Link in net->fs_addresses6 */
354 struct hlist_node proc_link; /* Link in net->fs_proc */
355 struct afs_server *gc_next; /* Next server in manager's list */
356 time64_t put_time; /* Time at which last put */
357 time64_t update_at; /* Time at which to next update the record */
359 #define AFS_SERVER_FL_NEW 0 /* New server, don't inc cb_s_break */
360 #define AFS_SERVER_FL_NOT_READY 1 /* The record is not ready for use */
361 #define AFS_SERVER_FL_NOT_FOUND 2 /* VL server says no such server */
362 #define AFS_SERVER_FL_VL_FAIL 3 /* Failed to access VL server */
363 #define AFS_SERVER_FL_UPDATING 4
364 #define AFS_SERVER_FL_PROBED 5 /* The fileserver has been probed */
365 #define AFS_SERVER_FL_PROBING 6 /* Fileserver is being probed */
367 u32 addr_version; /* Address list version */
369 /* file service access */
370 rwlock_t fs_lock; /* access lock */
372 /* callback promise management */
373 struct list_head cb_interests; /* List of superblocks using this server */
374 unsigned cb_s_break; /* Break-everything counter. */
375 rwlock_t cb_break_lock; /* Volume finding lock */
379 * Interest by a superblock on a server.
381 struct afs_cb_interest {
382 struct list_head cb_link; /* Link in server->cb_interests */
383 struct afs_server *server; /* Server on which this interest resides */
384 struct super_block *sb; /* Superblock on which inodes reside */
385 afs_volid_t vid; /* Volume ID to match */
390 * Replaceable server list.
392 struct afs_server_entry {
393 struct afs_server *server;
394 struct afs_cb_interest *cb_interest;
397 struct afs_server_list {
399 unsigned short nr_servers;
400 unsigned short index; /* Server currently in use */
401 unsigned short vnovol_mask; /* Servers to be skipped due to VNOVOL */
402 unsigned int seq; /* Set to ->servers_seq when installed */
403 struct afs_server_entry servers[];
407 * Live AFS volume management.
410 afs_volid_t vid; /* volume ID */
412 time64_t update_at; /* Time at which to next update */
413 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
414 struct list_head proc_link; /* Link in cell->vl_proc */
416 #define AFS_VOLUME_NEEDS_UPDATE 0 /* - T if an update needs performing */
417 #define AFS_VOLUME_UPDATING 1 /* - T if an update is in progress */
418 #define AFS_VOLUME_WAIT 2 /* - T if users must wait for update */
419 #define AFS_VOLUME_DELETED 3 /* - T if volume appears deleted */
420 #define AFS_VOLUME_OFFLINE 4 /* - T if volume offline notice given */
421 #define AFS_VOLUME_BUSY 5 /* - T if volume busy notice given */
422 #ifdef CONFIG_AFS_FSCACHE
423 struct fscache_cookie *cache; /* caching cookie */
425 struct afs_server_list *servers; /* List of servers on which volume resides */
426 rwlock_t servers_lock; /* Lock for ->servers */
427 unsigned int servers_seq; /* Incremented each time ->servers changes */
429 afs_voltype_t type; /* type of volume */
431 char type_force; /* force volume type (suppress R/O -> R/W) */
433 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
436 enum afs_lock_state {
437 AFS_VNODE_LOCK_NONE, /* The vnode has no lock on the server */
438 AFS_VNODE_LOCK_WAITING_FOR_CB, /* We're waiting for the server to break the callback */
439 AFS_VNODE_LOCK_SETTING, /* We're asking the server for a lock */
440 AFS_VNODE_LOCK_GRANTED, /* We have a lock on the server */
441 AFS_VNODE_LOCK_EXTENDING, /* We're extending a lock on the server */
442 AFS_VNODE_LOCK_NEED_UNLOCK, /* We need to unlock on the server */
443 AFS_VNODE_LOCK_UNLOCKING, /* We're telling the server to unlock */
447 * AFS inode private data.
449 * Note that afs_alloc_inode() *must* reset anything that could incorrectly
450 * leak from one inode to another.
453 struct inode vfs_inode; /* the VFS's inode record */
455 struct afs_volume *volume; /* volume on which vnode resides */
456 struct afs_fid fid; /* the file identifier for this inode */
457 struct afs_file_status status; /* AFS status info for this file */
458 #ifdef CONFIG_AFS_FSCACHE
459 struct fscache_cookie *cache; /* caching cookie */
461 struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
462 struct mutex io_lock; /* Lock for serialising I/O on this mutex */
463 struct mutex validate_lock; /* lock for validating this vnode */
464 spinlock_t wb_lock; /* lock for wb_keys */
465 spinlock_t lock; /* waitqueue/flags lock */
467 #define AFS_VNODE_CB_PROMISED 0 /* Set if vnode has a callback promise */
468 #define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
469 #define AFS_VNODE_DIR_MODIFIED 2 /* set if dir vnode's data modified */
470 #define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
471 #define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
472 #define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
473 #define AFS_VNODE_AUTOCELL 6 /* set if Vnode is an auto mount point */
474 #define AFS_VNODE_PSEUDODIR 7 /* set if Vnode is a pseudo directory */
476 struct list_head wb_keys; /* List of keys available for writeback */
477 struct list_head pending_locks; /* locks waiting to be granted */
478 struct list_head granted_locks; /* locks granted on this file */
479 struct delayed_work lock_work; /* work to be done in locking */
480 struct key *lock_key; /* Key to be used in lock ops */
481 enum afs_lock_state lock_state : 8;
482 afs_lock_type_t lock_type : 8;
484 /* outstanding callback notification on this file */
485 struct afs_cb_interest *cb_interest; /* Server on which this resides */
486 unsigned int cb_s_break; /* Mass break counter on ->server */
487 unsigned int cb_break; /* Break counter on vnode */
488 seqlock_t cb_lock; /* Lock for ->cb_interest, ->status, ->cb_*break */
490 time64_t cb_expires_at; /* time at which callback expires */
491 unsigned cb_version; /* callback version */
492 afs_callback_type_t cb_type; /* type of callback */
496 * cached security record for one user's attempt to access a vnode
499 struct key *key; /* RxRPC ticket holding a security context */
500 afs_access_t access; /* CallerAccess value for this key */
504 * Immutable cache of CallerAccess records from attempts to access vnodes.
505 * These may be shared between multiple vnodes.
509 struct hlist_node hash_node; /* Link in hash */
510 unsigned long h; /* Hash value for this permit list */
512 unsigned short nr_permits; /* Number of records */
513 bool invalidated; /* Invalidated due to key change */
514 struct afs_permit permits[]; /* List of permits sorted by key pointer */
518 * record of one of a system's set of network interfaces
520 struct afs_interface {
521 struct in_addr address; /* IPv4 address bound to interface */
522 struct in_addr netmask; /* netmask applied to address */
523 unsigned mtu; /* MTU of interface */
527 * Cursor for iterating over a server's address list.
529 struct afs_addr_cursor {
530 struct afs_addr_list *alist; /* Current address list (pins ref) */
531 struct sockaddr_rxrpc *addr;
533 unsigned short start; /* Starting point in alist->addrs[] */
534 unsigned short index; /* Wrapping offset from start to current addr */
536 bool begun; /* T if we've begun iteration */
537 bool responded; /* T if the current address responded */
541 * Cursor for iterating over a set of fileservers.
543 struct afs_fs_cursor {
544 struct afs_addr_cursor ac;
545 struct afs_vnode *vnode;
546 struct afs_server_list *server_list; /* Current server list (pins ref) */
547 struct afs_cb_interest *cbi; /* Server on which this resides (pins ref) */
548 struct key *key; /* Key for the server */
549 unsigned int cb_break; /* cb_break + cb_s_break before the call */
550 unsigned int cb_break_2; /* cb_break + cb_s_break (2nd vnode) */
551 unsigned char start; /* Initial index in server list */
552 unsigned char index; /* Number of servers tried beyond start */
553 unsigned short flags;
554 #define AFS_FS_CURSOR_STOP 0x0001 /* Set to cease iteration */
555 #define AFS_FS_CURSOR_VBUSY 0x0002 /* Set if seen VBUSY */
556 #define AFS_FS_CURSOR_VMOVED 0x0004 /* Set if seen VMOVED */
557 #define AFS_FS_CURSOR_VNOVOL 0x0008 /* Set if seen VNOVOL */
558 #define AFS_FS_CURSOR_CUR_ONLY 0x0010 /* Set if current server only (file lock held) */
559 #define AFS_FS_CURSOR_NO_VSLEEP 0x0020 /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
563 * Cache auxiliary data.
565 struct afs_vnode_cache_aux {
569 #include <trace/events/afs.h>
571 /*****************************************************************************/
575 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
578 refcount_inc(&alist->usage);
581 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
584 extern void afs_put_addrlist(struct afs_addr_list *);
585 extern struct afs_addr_list *afs_parse_text_addrs(const char *, size_t, char,
586 unsigned short, unsigned short);
587 extern struct afs_addr_list *afs_dns_query(struct afs_cell *, time64_t *);
588 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
589 extern int afs_end_cursor(struct afs_addr_cursor *);
590 extern int afs_set_vl_cursor(struct afs_addr_cursor *, struct afs_cell *);
592 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
593 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
598 #ifdef CONFIG_AFS_FSCACHE
599 extern struct fscache_netfs afs_cache_netfs;
600 extern struct fscache_cookie_def afs_cell_cache_index_def;
601 extern struct fscache_cookie_def afs_volume_cache_index_def;
602 extern struct fscache_cookie_def afs_vnode_cache_index_def;
604 #define afs_cell_cache_index_def (*(struct fscache_cookie_def *) NULL)
605 #define afs_volume_cache_index_def (*(struct fscache_cookie_def *) NULL)
606 #define afs_vnode_cache_index_def (*(struct fscache_cookie_def *) NULL)
612 extern void afs_init_callback_state(struct afs_server *);
613 extern void afs_break_callback(struct afs_vnode *);
614 extern void afs_break_callbacks(struct afs_server *, size_t,struct afs_callback[]);
616 extern int afs_register_server_cb_interest(struct afs_vnode *, struct afs_server_entry *);
617 extern void afs_put_cb_interest(struct afs_net *, struct afs_cb_interest *);
618 extern void afs_clear_callback_interests(struct afs_net *, struct afs_server_list *);
620 static inline struct afs_cb_interest *afs_get_cb_interest(struct afs_cb_interest *cbi)
622 refcount_inc(&cbi->usage);
629 extern int afs_cell_init(struct afs_net *, const char *);
630 extern struct afs_cell *afs_lookup_cell_rcu(struct afs_net *, const char *, unsigned);
631 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
633 extern struct afs_cell *afs_get_cell(struct afs_cell *);
634 extern void afs_put_cell(struct afs_net *, struct afs_cell *);
635 extern void afs_manage_cells(struct work_struct *);
636 extern void afs_cells_timer(struct timer_list *);
637 extern void __net_exit afs_cell_purge(struct afs_net *);
642 extern bool afs_cm_incoming_call(struct afs_call *);
647 extern const struct file_operations afs_dir_file_operations;
648 extern const struct inode_operations afs_dir_inode_operations;
649 extern const struct file_operations afs_dynroot_file_operations;
650 extern const struct inode_operations afs_dynroot_inode_operations;
651 extern const struct dentry_operations afs_fs_dentry_operations;
653 extern bool afs_dir_check_page(struct inode *, struct page *);
658 extern const struct address_space_operations afs_fs_aops;
659 extern const struct inode_operations afs_file_inode_operations;
660 extern const struct file_operations afs_file_operations;
662 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
663 extern void afs_put_wb_key(struct afs_wb_key *);
664 extern int afs_open(struct inode *, struct file *);
665 extern int afs_release(struct inode *, struct file *);
666 extern int afs_fetch_data(struct afs_vnode *, struct key *, struct afs_read *);
667 extern int afs_page_filler(void *, struct page *);
668 extern void afs_put_read(struct afs_read *);
673 extern struct workqueue_struct *afs_lock_manager;
675 extern void afs_lock_work(struct work_struct *);
676 extern void afs_lock_may_be_available(struct afs_vnode *);
677 extern int afs_lock(struct file *, int, struct file_lock *);
678 extern int afs_flock(struct file *, int, struct file_lock *);
683 extern int afs_fs_fetch_file_status(struct afs_fs_cursor *, struct afs_volsync *);
684 extern int afs_fs_give_up_callbacks(struct afs_net *, struct afs_server *);
685 extern int afs_fs_fetch_data(struct afs_fs_cursor *, struct afs_read *);
686 extern int afs_fs_create(struct afs_fs_cursor *, const char *, umode_t,
687 struct afs_fid *, struct afs_file_status *, struct afs_callback *);
688 extern int afs_fs_remove(struct afs_fs_cursor *, const char *, bool);
689 extern int afs_fs_link(struct afs_fs_cursor *, struct afs_vnode *, const char *);
690 extern int afs_fs_symlink(struct afs_fs_cursor *, const char *, const char *,
691 struct afs_fid *, struct afs_file_status *);
692 extern int afs_fs_rename(struct afs_fs_cursor *, const char *,
693 struct afs_vnode *, const char *);
694 extern int afs_fs_store_data(struct afs_fs_cursor *, struct address_space *,
695 pgoff_t, pgoff_t, unsigned, unsigned);
696 extern int afs_fs_setattr(struct afs_fs_cursor *, struct iattr *);
697 extern int afs_fs_get_volume_status(struct afs_fs_cursor *, struct afs_volume_status *);
698 extern int afs_fs_set_lock(struct afs_fs_cursor *, afs_lock_type_t);
699 extern int afs_fs_extend_lock(struct afs_fs_cursor *);
700 extern int afs_fs_release_lock(struct afs_fs_cursor *);
701 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
702 struct afs_addr_cursor *, struct key *);
703 extern int afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
704 struct afs_addr_cursor *, struct key *);
709 extern int afs_fetch_status(struct afs_vnode *, struct key *);
710 extern int afs_iget5_test(struct inode *, void *);
711 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
712 extern struct inode *afs_iget(struct super_block *, struct key *,
713 struct afs_fid *, struct afs_file_status *,
714 struct afs_callback *,
715 struct afs_cb_interest *);
716 extern void afs_zap_data(struct afs_vnode *);
717 extern int afs_validate(struct afs_vnode *, struct key *);
718 extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
719 extern int afs_setattr(struct dentry *, struct iattr *);
720 extern void afs_evict_inode(struct inode *);
721 extern int afs_drop_inode(struct inode *);
726 extern struct workqueue_struct *afs_wq;
728 static inline struct afs_net *afs_d2net(struct dentry *dentry)
733 static inline struct afs_net *afs_i2net(struct inode *inode)
738 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
743 static inline struct afs_net *afs_sock2net(struct sock *sk)
748 static inline struct afs_net *afs_get_net(struct afs_net *net)
753 static inline void afs_put_net(struct afs_net *net)
760 extern int afs_abort_to_error(u32);
765 extern const struct inode_operations afs_mntpt_inode_operations;
766 extern const struct inode_operations afs_autocell_inode_operations;
767 extern const struct file_operations afs_mntpt_file_operations;
769 extern struct vfsmount *afs_d_automount(struct path *);
770 extern void afs_mntpt_kill_timer(void);
775 extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
780 extern int __net_init afs_proc_init(struct afs_net *);
781 extern void __net_exit afs_proc_cleanup(struct afs_net *);
782 extern int afs_proc_cell_setup(struct afs_net *, struct afs_cell *);
783 extern void afs_proc_cell_remove(struct afs_net *, struct afs_cell *);
788 extern bool afs_begin_vnode_operation(struct afs_fs_cursor *, struct afs_vnode *,
790 extern bool afs_select_fileserver(struct afs_fs_cursor *);
791 extern bool afs_select_current_fileserver(struct afs_fs_cursor *);
792 extern int afs_end_vnode_operation(struct afs_fs_cursor *);
797 extern struct workqueue_struct *afs_async_calls;
799 extern int __net_init afs_open_socket(struct afs_net *);
800 extern void __net_exit afs_close_socket(struct afs_net *);
801 extern void afs_charge_preallocation(struct work_struct *);
802 extern void afs_put_call(struct afs_call *);
803 extern int afs_queue_call_work(struct afs_call *);
804 extern long afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t, bool);
805 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
806 const struct afs_call_type *,
808 extern void afs_flat_call_destructor(struct afs_call *);
809 extern void afs_send_empty_reply(struct afs_call *);
810 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
811 extern int afs_extract_data(struct afs_call *, void *, size_t, bool);
813 static inline int afs_transfer_reply(struct afs_call *call)
815 return afs_extract_data(call, call->buffer, call->reply_max, false);
818 static inline bool afs_check_call_state(struct afs_call *call,
819 enum afs_call_state state)
821 return READ_ONCE(call->state) == state;
824 static inline bool afs_set_call_state(struct afs_call *call,
825 enum afs_call_state from,
826 enum afs_call_state to)
830 spin_lock_bh(&call->state_lock);
831 if (call->state == from) {
833 trace_afs_call_state(call, from, to, 0, 0);
836 spin_unlock_bh(&call->state_lock);
840 static inline void afs_set_call_complete(struct afs_call *call,
841 int error, u32 remote_abort)
843 enum afs_call_state state;
846 spin_lock_bh(&call->state_lock);
848 if (state != AFS_CALL_COMPLETE) {
849 call->abort_code = remote_abort;
851 call->state = AFS_CALL_COMPLETE;
852 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
853 error, remote_abort);
856 spin_unlock_bh(&call->state_lock);
858 trace_afs_call_done(call);
864 extern void afs_put_permits(struct afs_permits *);
865 extern void afs_clear_permits(struct afs_vnode *);
866 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int);
867 extern void afs_zap_permits(struct rcu_head *);
868 extern struct key *afs_request_key(struct afs_cell *);
869 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
870 extern int afs_permission(struct inode *, int);
871 extern void __exit afs_clean_up_permit_cache(void);
876 extern spinlock_t afs_server_peer_lock;
878 static inline struct afs_server *afs_get_server(struct afs_server *server)
880 atomic_inc(&server->usage);
884 extern struct afs_server *afs_find_server(struct afs_net *,
885 const struct sockaddr_rxrpc *);
886 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
887 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *);
888 extern void afs_put_server(struct afs_net *, struct afs_server *);
889 extern void afs_manage_servers(struct work_struct *);
890 extern void afs_servers_timer(struct timer_list *);
891 extern void __net_exit afs_purge_servers(struct afs_net *);
892 extern bool afs_probe_fileserver(struct afs_fs_cursor *);
893 extern bool afs_check_server_record(struct afs_fs_cursor *, struct afs_server *);
898 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
900 refcount_inc(&slist->usage);
904 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
905 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
906 struct afs_vldb_entry *,
908 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
913 extern int __init afs_fs_init(void);
914 extern void __exit afs_fs_exit(void);
919 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_net *,
920 struct afs_addr_cursor *,
921 struct key *, const char *, int);
922 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_net *, struct afs_addr_cursor *,
923 struct key *, const uuid_t *);
924 extern int afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *, struct key *);
925 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_net *, struct afs_addr_cursor *,
926 struct key *, const uuid_t *);
931 static inline struct afs_volume *__afs_get_volume(struct afs_volume *volume)
934 atomic_inc(&volume->usage);
938 extern struct afs_volume *afs_create_volume(struct afs_mount_params *);
939 extern void afs_activate_volume(struct afs_volume *);
940 extern void afs_deactivate_volume(struct afs_volume *);
941 extern void afs_put_volume(struct afs_cell *, struct afs_volume *);
942 extern int afs_check_volume_status(struct afs_volume *, struct key *);
947 extern int afs_set_page_dirty(struct page *);
948 extern int afs_write_begin(struct file *file, struct address_space *mapping,
949 loff_t pos, unsigned len, unsigned flags,
950 struct page **pagep, void **fsdata);
951 extern int afs_write_end(struct file *file, struct address_space *mapping,
952 loff_t pos, unsigned len, unsigned copied,
953 struct page *page, void *fsdata);
954 extern int afs_writepage(struct page *, struct writeback_control *);
955 extern int afs_writepages(struct address_space *, struct writeback_control *);
956 extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
957 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
958 extern int afs_flush(struct file *, fl_owner_t);
959 extern int afs_fsync(struct file *, loff_t, loff_t, int);
960 extern int afs_page_mkwrite(struct vm_fault *);
961 extern void afs_prune_wb_keys(struct afs_vnode *);
962 extern int afs_launder_page(struct page *);
967 extern const struct xattr_handler *afs_xattr_handlers[];
968 extern ssize_t afs_listxattr(struct dentry *, char *, size_t);
972 * Miscellaneous inline functions.
974 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
976 return container_of(inode, struct afs_vnode, vfs_inode);
979 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
981 return &vnode->vfs_inode;
984 static inline void afs_vnode_commit_status(struct afs_fs_cursor *fc,
985 struct afs_vnode *vnode,
986 unsigned int cb_break)
988 if (fc->ac.error == 0)
989 afs_cache_permit(vnode, fc->key, cb_break);
992 static inline void afs_check_for_remote_deletion(struct afs_fs_cursor *fc,
993 struct afs_vnode *vnode)
995 if (fc->ac.error == -ENOENT) {
996 set_bit(AFS_VNODE_DELETED, &vnode->flags);
997 afs_break_callback(vnode);
1002 /*****************************************************************************/
1006 extern unsigned afs_debug;
1008 #define dbgprintk(FMT,...) \
1009 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1011 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1012 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1013 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1016 #if defined(__KDEBUG)
1017 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1018 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1019 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1021 #elif defined(CONFIG_AFS_DEBUG)
1022 #define AFS_DEBUG_KENTER 0x01
1023 #define AFS_DEBUG_KLEAVE 0x02
1024 #define AFS_DEBUG_KDEBUG 0x04
1026 #define _enter(FMT,...) \
1028 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
1029 kenter(FMT,##__VA_ARGS__); \
1032 #define _leave(FMT,...) \
1034 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
1035 kleave(FMT,##__VA_ARGS__); \
1038 #define _debug(FMT,...) \
1040 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
1041 kdebug(FMT,##__VA_ARGS__); \
1045 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1046 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1047 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1051 * debug assertion checking
1053 #if 1 // defined(__KDEBUGALL)
1057 if (unlikely(!(X))) { \
1058 printk(KERN_ERR "\n"); \
1059 printk(KERN_ERR "AFS: Assertion failed\n"); \
1064 #define ASSERTCMP(X, OP, Y) \
1066 if (unlikely(!((X) OP (Y)))) { \
1067 printk(KERN_ERR "\n"); \
1068 printk(KERN_ERR "AFS: Assertion failed\n"); \
1069 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1070 (unsigned long)(X), (unsigned long)(Y)); \
1071 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1072 (unsigned long)(X), (unsigned long)(Y)); \
1077 #define ASSERTRANGE(L, OP1, N, OP2, H) \
1079 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
1080 printk(KERN_ERR "\n"); \
1081 printk(KERN_ERR "AFS: Assertion failed\n"); \
1082 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1083 (unsigned long)(L), (unsigned long)(N), \
1084 (unsigned long)(H)); \
1085 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1086 (unsigned long)(L), (unsigned long)(N), \
1087 (unsigned long)(H)); \
1092 #define ASSERTIF(C, X) \
1094 if (unlikely((C) && !(X))) { \
1095 printk(KERN_ERR "\n"); \
1096 printk(KERN_ERR "AFS: Assertion failed\n"); \
1101 #define ASSERTIFCMP(C, X, OP, Y) \
1103 if (unlikely((C) && !((X) OP (Y)))) { \
1104 printk(KERN_ERR "\n"); \
1105 printk(KERN_ERR "AFS: Assertion failed\n"); \
1106 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1107 (unsigned long)(X), (unsigned long)(Y)); \
1108 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1109 (unsigned long)(X), (unsigned long)(Y)); \
1120 #define ASSERTCMP(X, OP, Y) \
1124 #define ASSERTRANGE(L, OP1, N, OP2, H) \
1128 #define ASSERTIF(C, X) \
1132 #define ASSERTIFCMP(C, X, OP, Y) \
1136 #endif /* __KDEBUGALL */