3 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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 afs_voltype_t type
; /* type of volume requested */
40 int volnamesz
; /* size of volume name */
41 const char *volname
; /* name of volume to mount */
42 struct afs_net
*net
; /* Network namespace in effect */
43 struct afs_cell
*cell
; /* cell in which to find volume */
44 struct afs_volume
*volume
; /* volume record */
45 struct key
*key
; /* key to use for secure mounting */
48 struct afs_iget_data
{
50 struct afs_volume
*volume
; /* volume on which resides */
54 AFS_CALL_CL_REQUESTING
, /* Client: Request is being sent */
55 AFS_CALL_CL_AWAIT_REPLY
, /* Client: Awaiting reply */
56 AFS_CALL_CL_PROC_REPLY
, /* Client: rxrpc call complete; processing reply */
57 AFS_CALL_SV_AWAIT_OP_ID
, /* Server: Awaiting op ID */
58 AFS_CALL_SV_AWAIT_REQUEST
, /* Server: Awaiting request data */
59 AFS_CALL_SV_REPLYING
, /* Server: Replying */
60 AFS_CALL_SV_AWAIT_ACK
, /* Server: Awaiting final ACK */
61 AFS_CALL_COMPLETE
, /* Completed or failed */
65 * List of server addresses.
67 struct afs_addr_list
{
68 struct rcu_head rcu
; /* Must be first */
70 u32 version
; /* Version */
71 unsigned short nr_addrs
;
72 unsigned short index
; /* Address currently in use */
73 unsigned short nr_ipv4
; /* Number of IPv4 addresses */
74 unsigned long probed
; /* Mask of servers that have been probed */
75 unsigned long yfs
; /* Mask of servers that are YFS */
76 struct sockaddr_rxrpc addrs
[];
80 * a record of an in-progress RxRPC call
83 const struct afs_call_type
*type
; /* type of call */
84 wait_queue_head_t waitq
; /* processes awaiting completion */
85 struct work_struct async_work
; /* async I/O processor */
86 struct work_struct work
; /* actual work processor */
87 struct rxrpc_call
*rxcall
; /* RxRPC call handle */
88 struct key
*key
; /* security for this call */
89 struct afs_net
*net
; /* The network namespace */
90 struct afs_server
*cm_server
; /* Server affected by incoming CM call */
91 struct afs_cb_interest
*cbi
; /* Callback interest for server used */
92 void *request
; /* request data (first part) */
93 struct address_space
*mapping
; /* Pages being written from */
94 void *buffer
; /* reply receive buffer */
95 void *reply
[4]; /* Where to put the reply */
96 pgoff_t first
; /* first page in mapping to deal with */
97 pgoff_t last
; /* last page in mapping to deal with */
98 size_t offset
; /* offset into received data store */
100 enum afs_call_state state
;
101 spinlock_t state_lock
;
102 int error
; /* error code */
103 u32 abort_code
; /* Remote abort ID or 0 */
104 unsigned request_size
; /* size of request data */
105 unsigned reply_max
; /* maximum size of reply */
106 unsigned first_offset
; /* offset into mapping[first] */
107 unsigned int cb_break
; /* cb_break + cb_s_break before the call */
109 unsigned last_to
; /* amount of mapping[last] */
110 unsigned count2
; /* count used in unmarshalling */
112 unsigned char unmarshall
; /* unmarshalling phase */
113 bool incoming
; /* T if incoming call */
114 bool send_pages
; /* T if data from mapping should be sent */
115 bool need_attention
; /* T if RxRPC poked us */
116 bool async
; /* T if asynchronous */
117 bool ret_reply0
; /* T if should return reply[0] on success */
118 bool upgrade
; /* T to request service upgrade */
119 u16 service_id
; /* Actual service ID (after upgrade) */
120 u32 operation_ID
; /* operation ID for an incoming call */
121 u32 count
; /* count for use in unmarshalling */
122 __be32 tmp
; /* place to extract temporary data */
123 afs_dataversion_t store_version
; /* updated version expected from store */
126 struct afs_call_type
{
128 unsigned int op
; /* Really enum afs_fs_operation */
130 /* deliver request or reply data to an call
131 * - returning an error will cause the call to be aborted
133 int (*deliver
)(struct afs_call
*call
);
135 /* clean up a call */
136 void (*destructor
)(struct afs_call
*call
);
139 void (*work
)(struct work_struct
*work
);
143 * Key available for writeback on a file.
148 struct list_head vnode_link
; /* Link in vnode->wb_keys */
152 * AFS open file information record. Pointed to by file->private_data.
155 struct key
*key
; /* The key this file was opened with */
156 struct afs_wb_key
*wb
; /* Writeback key record for this file */
159 static inline struct key
*afs_file_key(struct file
*file
)
161 struct afs_file
*af
= file
->private_data
;
167 * Record of an outstanding read operation on a vnode.
170 loff_t pos
; /* Where to start reading */
171 loff_t len
; /* How much we're asking for */
172 loff_t actual_len
; /* How much we're actually getting */
173 loff_t remain
; /* Amount remaining */
175 unsigned int index
; /* Which page we're reading into */
176 unsigned int nr_pages
;
177 void (*page_done
)(struct afs_call
*, struct afs_read
*);
178 struct page
*pages
[];
182 * AFS superblock private data
183 * - there's one superblock per volume
185 struct afs_super_info
{
186 struct afs_net
*net
; /* Network namespace */
187 struct afs_cell
*cell
; /* The cell in which the volume resides */
188 struct afs_volume
*volume
; /* volume record */
191 static inline struct afs_super_info
*AFS_FS_S(struct super_block
*sb
)
193 return sb
->s_fs_info
;
196 extern struct file_system_type afs_fs_type
;
199 * AFS network namespace record.
202 struct afs_uuid uuid
;
203 bool live
; /* F if this namespace is being removed */
205 /* AF_RXRPC I/O stuff */
206 struct socket
*socket
;
207 struct afs_call
*spare_incoming_call
;
208 struct work_struct charge_preallocation_work
;
209 struct mutex socket_mutex
;
210 atomic_t nr_outstanding_calls
;
211 atomic_t nr_superblocks
;
214 struct rb_root cells
;
215 struct afs_cell
*ws_cell
;
216 struct work_struct cells_manager
;
217 struct timer_list cells_timer
;
218 atomic_t cells_outstanding
;
219 seqlock_t cells_lock
;
221 spinlock_t proc_cells_lock
;
222 struct list_head proc_cells
;
224 /* Known servers. Theoretically each fileserver can only be in one
225 * cell, but in practice, people create aliases and subsets and there's
226 * no easy way to distinguish them.
228 seqlock_t fs_lock
; /* For fs_servers */
229 struct rb_root fs_servers
; /* afs_server (by server UUID or address) */
230 struct list_head fs_updates
; /* afs_server (by update_at) */
231 struct hlist_head fs_proc
; /* procfs servers list */
233 struct hlist_head fs_addresses4
; /* afs_server (by lowest IPv4 addr) */
234 struct hlist_head fs_addresses6
; /* afs_server (by lowest IPv6 addr) */
235 seqlock_t fs_addr_lock
; /* For fs_addresses[46] */
237 struct work_struct fs_manager
;
238 struct timer_list fs_timer
;
239 atomic_t servers_outstanding
;
241 /* File locking renewal management */
242 struct mutex lock_manager_mutex
;
245 struct proc_dir_entry
*proc_afs
; /* /proc/net/afs directory */
248 extern struct afs_net __afs_net
;// Dummy AFS network namespace; TODO: replace with real netns
250 enum afs_cell_state
{
254 AFS_CELL_DEACTIVATING
,
262 * This is a tricky concept to get right as it is possible to create aliases
263 * simply by pointing AFSDB/SRV records for two names at the same set of VL
264 * servers; it is also possible to do things like setting up two sets of VL
265 * servers, one of which provides a superset of the volumes provided by the
266 * other (for internal/external division, for example).
268 * Cells only exist in the sense that (a) a cell's name maps to a set of VL
269 * servers and (b) a cell's name is used by the client to select the key to use
270 * for authentication and encryption. The cell name is not typically used in
273 * There is no easy way to determine if two cells are aliases or one is a
279 struct rb_node net_node
; /* Node in net->cells */
282 struct key
*anonymous_key
; /* anonymous user key for this cell */
283 struct work_struct manager
; /* Manager for init/deinit/dns */
284 struct list_head proc_link
; /* /proc cell list link */
285 #ifdef CONFIG_AFS_FSCACHE
286 struct fscache_cookie
*cache
; /* caching cookie */
288 time64_t dns_expiry
; /* Time AFSDB/SRV record expires */
289 time64_t last_inactive
; /* Time of last drop of usage count */
292 #define AFS_CELL_FL_NOT_READY 0 /* The cell record is not ready for use */
293 #define AFS_CELL_FL_NO_GC 1 /* The cell was added manually, don't auto-gc */
294 #define AFS_CELL_FL_NOT_FOUND 2 /* Permanent DNS error */
295 #define AFS_CELL_FL_DNS_FAIL 3 /* Failed to access DNS */
296 #define AFS_CELL_FL_NO_LOOKUP_YET 4 /* Not completed first DNS lookup yet */
297 enum afs_cell_state state
;
300 /* Active fileserver interaction state. */
301 struct list_head proc_volumes
; /* procfs volume list */
304 /* VL server list. */
305 rwlock_t vl_addrs_lock
; /* Lock on vl_addrs */
306 struct afs_addr_list __rcu
*vl_addrs
; /* List of VL servers */
307 u8 name_len
; /* Length of name */
308 char name
[64 + 1]; /* Cell name, case-flattened and NUL-padded */
314 * This is pointed to by cell->vldb_entries, indexed by name.
316 struct afs_vldb_entry
{
317 afs_volid_t vid
[3]; /* Volume IDs for R/W, R/O and Bak volumes */
320 #define AFS_VLDB_HAS_RW 0 /* - R/W volume exists */
321 #define AFS_VLDB_HAS_RO 1 /* - R/O volume exists */
322 #define AFS_VLDB_HAS_BAK 2 /* - Backup volume exists */
323 #define AFS_VLDB_QUERY_VALID 3 /* - Record is valid */
324 #define AFS_VLDB_QUERY_ERROR 4 /* - VL server returned error */
326 uuid_t fs_server
[AFS_NMAXNSERVERS
];
327 u8 fs_mask
[AFS_NMAXNSERVERS
];
328 #define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
329 #define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
330 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
332 u8 nr_servers
; /* Number of server records */
334 u8 name
[AFS_MAXVOLNAME
+ 1]; /* NUL-padded volume name */
338 * Record of fileserver with which we're actively communicating.
343 uuid_t uuid
; /* Server ID */
344 struct afs_uuid _uuid
;
347 struct afs_addr_list __rcu
*addresses
;
348 struct rb_node uuid_rb
; /* Link in net->servers */
349 struct hlist_node addr4_link
; /* Link in net->fs_addresses4 */
350 struct hlist_node addr6_link
; /* Link in net->fs_addresses6 */
351 struct hlist_node proc_link
; /* Link in net->fs_proc */
352 struct afs_server
*gc_next
; /* Next server in manager's list */
353 time64_t put_time
; /* Time at which last put */
354 time64_t update_at
; /* Time at which to next update the record */
356 #define AFS_SERVER_FL_NEW 0 /* New server, don't inc cb_s_break */
357 #define AFS_SERVER_FL_NOT_READY 1 /* The record is not ready for use */
358 #define AFS_SERVER_FL_NOT_FOUND 2 /* VL server says no such server */
359 #define AFS_SERVER_FL_VL_FAIL 3 /* Failed to access VL server */
360 #define AFS_SERVER_FL_UPDATING 4
361 #define AFS_SERVER_FL_PROBED 5 /* The fileserver has been probed */
362 #define AFS_SERVER_FL_PROBING 6 /* Fileserver is being probed */
364 u32 addr_version
; /* Address list version */
366 /* file service access */
367 rwlock_t fs_lock
; /* access lock */
369 /* callback promise management */
370 struct list_head cb_interests
; /* List of superblocks using this server */
371 unsigned cb_s_break
; /* Break-everything counter. */
372 rwlock_t cb_break_lock
; /* Volume finding lock */
376 * Interest by a superblock on a server.
378 struct afs_cb_interest
{
379 struct list_head cb_link
; /* Link in server->cb_interests */
380 struct afs_server
*server
; /* Server on which this interest resides */
381 struct super_block
*sb
; /* Superblock on which inodes reside */
382 afs_volid_t vid
; /* Volume ID to match */
387 * Replaceable server list.
389 struct afs_server_entry
{
390 struct afs_server
*server
;
391 struct afs_cb_interest
*cb_interest
;
394 struct afs_server_list
{
396 unsigned short nr_servers
;
397 unsigned short index
; /* Server currently in use */
398 unsigned short vnovol_mask
; /* Servers to be skipped due to VNOVOL */
399 unsigned int seq
; /* Set to ->servers_seq when installed */
400 struct afs_server_entry servers
[];
404 * Live AFS volume management.
407 afs_volid_t vid
; /* volume ID */
409 time64_t update_at
; /* Time at which to next update */
410 struct afs_cell
*cell
; /* Cell to which belongs (pins ref) */
411 struct list_head proc_link
; /* Link in cell->vl_proc */
413 #define AFS_VOLUME_NEEDS_UPDATE 0 /* - T if an update needs performing */
414 #define AFS_VOLUME_UPDATING 1 /* - T if an update is in progress */
415 #define AFS_VOLUME_WAIT 2 /* - T if users must wait for update */
416 #define AFS_VOLUME_DELETED 3 /* - T if volume appears deleted */
417 #define AFS_VOLUME_OFFLINE 4 /* - T if volume offline notice given */
418 #define AFS_VOLUME_BUSY 5 /* - T if volume busy notice given */
419 #ifdef CONFIG_AFS_FSCACHE
420 struct fscache_cookie
*cache
; /* caching cookie */
422 struct afs_server_list
*servers
; /* List of servers on which volume resides */
423 rwlock_t servers_lock
; /* Lock for ->servers */
424 unsigned int servers_seq
; /* Incremented each time ->servers changes */
426 afs_voltype_t type
; /* type of volume */
428 char type_force
; /* force volume type (suppress R/O -> R/W) */
430 u8 name
[AFS_MAXVOLNAME
+ 1]; /* NUL-padded volume name */
433 enum afs_lock_state
{
434 AFS_VNODE_LOCK_NONE
, /* The vnode has no lock on the server */
435 AFS_VNODE_LOCK_WAITING_FOR_CB
, /* We're waiting for the server to break the callback */
436 AFS_VNODE_LOCK_SETTING
, /* We're asking the server for a lock */
437 AFS_VNODE_LOCK_GRANTED
, /* We have a lock on the server */
438 AFS_VNODE_LOCK_EXTENDING
, /* We're extending a lock on the server */
439 AFS_VNODE_LOCK_NEED_UNLOCK
, /* We need to unlock on the server */
440 AFS_VNODE_LOCK_UNLOCKING
, /* We're telling the server to unlock */
444 * AFS inode private data.
446 * Note that afs_alloc_inode() *must* reset anything that could incorrectly
447 * leak from one inode to another.
450 struct inode vfs_inode
; /* the VFS's inode record */
452 struct afs_volume
*volume
; /* volume on which vnode resides */
453 struct afs_fid fid
; /* the file identifier for this inode */
454 struct afs_file_status status
; /* AFS status info for this file */
455 #ifdef CONFIG_AFS_FSCACHE
456 struct fscache_cookie
*cache
; /* caching cookie */
458 struct afs_permits
*permit_cache
; /* cache of permits so far obtained */
459 struct mutex io_lock
; /* Lock for serialising I/O on this mutex */
460 struct mutex validate_lock
; /* lock for validating this vnode */
461 spinlock_t wb_lock
; /* lock for wb_keys */
462 spinlock_t lock
; /* waitqueue/flags lock */
464 #define AFS_VNODE_CB_PROMISED 0 /* Set if vnode has a callback promise */
465 #define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
466 #define AFS_VNODE_DIR_MODIFIED 2 /* set if dir vnode's data modified */
467 #define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
468 #define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
469 #define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
470 #define AFS_VNODE_AUTOCELL 6 /* set if Vnode is an auto mount point */
471 #define AFS_VNODE_PSEUDODIR 7 /* set if Vnode is a pseudo directory */
473 struct list_head wb_keys
; /* List of keys available for writeback */
474 struct list_head pending_locks
; /* locks waiting to be granted */
475 struct list_head granted_locks
; /* locks granted on this file */
476 struct delayed_work lock_work
; /* work to be done in locking */
477 struct key
*lock_key
; /* Key to be used in lock ops */
478 enum afs_lock_state lock_state
: 8;
479 afs_lock_type_t lock_type
: 8;
481 /* outstanding callback notification on this file */
482 struct afs_cb_interest
*cb_interest
; /* Server on which this resides */
483 unsigned int cb_s_break
; /* Mass break counter on ->server */
484 unsigned int cb_break
; /* Break counter on vnode */
485 seqlock_t cb_lock
; /* Lock for ->cb_interest, ->status, ->cb_*break */
487 time64_t cb_expires_at
; /* time at which callback expires */
488 unsigned cb_version
; /* callback version */
489 afs_callback_type_t cb_type
; /* type of callback */
493 * cached security record for one user's attempt to access a vnode
496 struct key
*key
; /* RxRPC ticket holding a security context */
497 afs_access_t access
; /* CallerAccess value for this key */
501 * Immutable cache of CallerAccess records from attempts to access vnodes.
502 * These may be shared between multiple vnodes.
506 struct hlist_node hash_node
; /* Link in hash */
507 unsigned long h
; /* Hash value for this permit list */
509 unsigned short nr_permits
; /* Number of records */
510 bool invalidated
; /* Invalidated due to key change */
511 struct afs_permit permits
[]; /* List of permits sorted by key pointer */
515 * record of one of a system's set of network interfaces
517 struct afs_interface
{
518 struct in_addr address
; /* IPv4 address bound to interface */
519 struct in_addr netmask
; /* netmask applied to address */
520 unsigned mtu
; /* MTU of interface */
524 * Cursor for iterating over a server's address list.
526 struct afs_addr_cursor
{
527 struct afs_addr_list
*alist
; /* Current address list (pins ref) */
528 struct sockaddr_rxrpc
*addr
;
530 unsigned short start
; /* Starting point in alist->addrs[] */
531 unsigned short index
; /* Wrapping offset from start to current addr */
533 bool begun
; /* T if we've begun iteration */
534 bool responded
; /* T if the current address responded */
538 * Cursor for iterating over a set of fileservers.
540 struct afs_fs_cursor
{
541 struct afs_addr_cursor ac
;
542 struct afs_vnode
*vnode
;
543 struct afs_server_list
*server_list
; /* Current server list (pins ref) */
544 struct afs_cb_interest
*cbi
; /* Server on which this resides (pins ref) */
545 struct key
*key
; /* Key for the server */
546 unsigned int cb_break
; /* cb_break + cb_s_break before the call */
547 unsigned int cb_break_2
; /* cb_break + cb_s_break (2nd vnode) */
548 unsigned char start
; /* Initial index in server list */
549 unsigned char index
; /* Number of servers tried beyond start */
550 unsigned short flags
;
551 #define AFS_FS_CURSOR_STOP 0x0001 /* Set to cease iteration */
552 #define AFS_FS_CURSOR_VBUSY 0x0002 /* Set if seen VBUSY */
553 #define AFS_FS_CURSOR_VMOVED 0x0004 /* Set if seen VMOVED */
554 #define AFS_FS_CURSOR_VNOVOL 0x0008 /* Set if seen VNOVOL */
555 #define AFS_FS_CURSOR_CUR_ONLY 0x0010 /* Set if current server only (file lock held) */
556 #define AFS_FS_CURSOR_NO_VSLEEP 0x0020 /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
559 #include <trace/events/afs.h>
561 /*****************************************************************************/
565 static inline struct afs_addr_list
*afs_get_addrlist(struct afs_addr_list
*alist
)
568 refcount_inc(&alist
->usage
);
571 extern struct afs_addr_list
*afs_alloc_addrlist(unsigned int,
574 extern void afs_put_addrlist(struct afs_addr_list
*);
575 extern struct afs_addr_list
*afs_parse_text_addrs(const char *, size_t, char,
576 unsigned short, unsigned short);
577 extern struct afs_addr_list
*afs_dns_query(struct afs_cell
*, time64_t
*);
578 extern bool afs_iterate_addresses(struct afs_addr_cursor
*);
579 extern int afs_end_cursor(struct afs_addr_cursor
*);
580 extern int afs_set_vl_cursor(struct afs_addr_cursor
*, struct afs_cell
*);
582 extern void afs_merge_fs_addr4(struct afs_addr_list
*, __be32
, u16
);
583 extern void afs_merge_fs_addr6(struct afs_addr_list
*, __be32
*, u16
);
588 #ifdef CONFIG_AFS_FSCACHE
589 extern struct fscache_netfs afs_cache_netfs
;
590 extern struct fscache_cookie_def afs_cell_cache_index_def
;
591 extern struct fscache_cookie_def afs_volume_cache_index_def
;
592 extern struct fscache_cookie_def afs_vnode_cache_index_def
;
594 #define afs_cell_cache_index_def (*(struct fscache_cookie_def *) NULL)
595 #define afs_volume_cache_index_def (*(struct fscache_cookie_def *) NULL)
596 #define afs_vnode_cache_index_def (*(struct fscache_cookie_def *) NULL)
602 extern void afs_init_callback_state(struct afs_server
*);
603 extern void afs_break_callback(struct afs_vnode
*);
604 extern void afs_break_callbacks(struct afs_server
*, size_t,struct afs_callback
[]);
606 extern int afs_register_server_cb_interest(struct afs_vnode
*, struct afs_server_entry
*);
607 extern void afs_put_cb_interest(struct afs_net
*, struct afs_cb_interest
*);
608 extern void afs_clear_callback_interests(struct afs_net
*, struct afs_server_list
*);
610 static inline struct afs_cb_interest
*afs_get_cb_interest(struct afs_cb_interest
*cbi
)
612 refcount_inc(&cbi
->usage
);
619 extern int afs_cell_init(struct afs_net
*, const char *);
620 extern struct afs_cell
*afs_lookup_cell_rcu(struct afs_net
*, const char *, unsigned);
621 extern struct afs_cell
*afs_lookup_cell(struct afs_net
*, const char *, unsigned,
623 extern struct afs_cell
*afs_get_cell(struct afs_cell
*);
624 extern void afs_put_cell(struct afs_net
*, struct afs_cell
*);
625 extern void afs_manage_cells(struct work_struct
*);
626 extern void afs_cells_timer(struct timer_list
*);
627 extern void __net_exit
afs_cell_purge(struct afs_net
*);
632 extern bool afs_cm_incoming_call(struct afs_call
*);
637 extern bool afs_dir_check_page(struct inode
*, struct page
*);
638 extern const struct inode_operations afs_dir_inode_operations
;
639 extern const struct dentry_operations afs_fs_dentry_operations
;
640 extern const struct file_operations afs_dir_file_operations
;
645 extern const struct address_space_operations afs_fs_aops
;
646 extern const struct inode_operations afs_file_inode_operations
;
647 extern const struct file_operations afs_file_operations
;
649 extern int afs_cache_wb_key(struct afs_vnode
*, struct afs_file
*);
650 extern void afs_put_wb_key(struct afs_wb_key
*);
651 extern int afs_open(struct inode
*, struct file
*);
652 extern int afs_release(struct inode
*, struct file
*);
653 extern int afs_fetch_data(struct afs_vnode
*, struct key
*, struct afs_read
*);
654 extern int afs_page_filler(void *, struct page
*);
655 extern void afs_put_read(struct afs_read
*);
660 extern struct workqueue_struct
*afs_lock_manager
;
662 extern void afs_lock_work(struct work_struct
*);
663 extern void afs_lock_may_be_available(struct afs_vnode
*);
664 extern int afs_lock(struct file
*, int, struct file_lock
*);
665 extern int afs_flock(struct file
*, int, struct file_lock
*);
670 extern int afs_fs_fetch_file_status(struct afs_fs_cursor
*, struct afs_volsync
*);
671 extern int afs_fs_give_up_callbacks(struct afs_net
*, struct afs_server
*);
672 extern int afs_fs_fetch_data(struct afs_fs_cursor
*, struct afs_read
*);
673 extern int afs_fs_create(struct afs_fs_cursor
*, const char *, umode_t
,
674 struct afs_fid
*, struct afs_file_status
*, struct afs_callback
*);
675 extern int afs_fs_remove(struct afs_fs_cursor
*, const char *, bool);
676 extern int afs_fs_link(struct afs_fs_cursor
*, struct afs_vnode
*, const char *);
677 extern int afs_fs_symlink(struct afs_fs_cursor
*, const char *, const char *,
678 struct afs_fid
*, struct afs_file_status
*);
679 extern int afs_fs_rename(struct afs_fs_cursor
*, const char *,
680 struct afs_vnode
*, const char *);
681 extern int afs_fs_store_data(struct afs_fs_cursor
*, struct address_space
*,
682 pgoff_t
, pgoff_t
, unsigned, unsigned);
683 extern int afs_fs_setattr(struct afs_fs_cursor
*, struct iattr
*);
684 extern int afs_fs_get_volume_status(struct afs_fs_cursor
*, struct afs_volume_status
*);
685 extern int afs_fs_set_lock(struct afs_fs_cursor
*, afs_lock_type_t
);
686 extern int afs_fs_extend_lock(struct afs_fs_cursor
*);
687 extern int afs_fs_release_lock(struct afs_fs_cursor
*);
688 extern int afs_fs_give_up_all_callbacks(struct afs_net
*, struct afs_server
*,
689 struct afs_addr_cursor
*, struct key
*);
690 extern int afs_fs_get_capabilities(struct afs_net
*, struct afs_server
*,
691 struct afs_addr_cursor
*, struct key
*);
696 extern int afs_fetch_status(struct afs_vnode
*, struct key
*);
697 extern int afs_iget5_test(struct inode
*, void *);
698 extern struct inode
*afs_iget_autocell(struct inode
*, const char *, int,
700 extern struct inode
*afs_iget(struct super_block
*, struct key
*,
701 struct afs_fid
*, struct afs_file_status
*,
702 struct afs_callback
*,
703 struct afs_cb_interest
*);
704 extern void afs_zap_data(struct afs_vnode
*);
705 extern int afs_validate(struct afs_vnode
*, struct key
*);
706 extern int afs_getattr(const struct path
*, struct kstat
*, u32
, unsigned int);
707 extern int afs_setattr(struct dentry
*, struct iattr
*);
708 extern void afs_evict_inode(struct inode
*);
709 extern int afs_drop_inode(struct inode
*);
714 extern struct workqueue_struct
*afs_wq
;
716 static inline struct afs_net
*afs_d2net(struct dentry
*dentry
)
721 static inline struct afs_net
*afs_i2net(struct inode
*inode
)
726 static inline struct afs_net
*afs_v2net(struct afs_vnode
*vnode
)
731 static inline struct afs_net
*afs_sock2net(struct sock
*sk
)
736 static inline struct afs_net
*afs_get_net(struct afs_net
*net
)
741 static inline void afs_put_net(struct afs_net
*net
)
748 extern int afs_abort_to_error(u32
);
753 extern const struct inode_operations afs_mntpt_inode_operations
;
754 extern const struct inode_operations afs_autocell_inode_operations
;
755 extern const struct file_operations afs_mntpt_file_operations
;
757 extern struct vfsmount
*afs_d_automount(struct path
*);
758 extern void afs_mntpt_kill_timer(void);
763 extern int afs_get_ipv4_interfaces(struct afs_interface
*, size_t, bool);
768 extern int __net_init
afs_proc_init(struct afs_net
*);
769 extern void __net_exit
afs_proc_cleanup(struct afs_net
*);
770 extern int afs_proc_cell_setup(struct afs_net
*, struct afs_cell
*);
771 extern void afs_proc_cell_remove(struct afs_net
*, struct afs_cell
*);
776 extern bool afs_begin_vnode_operation(struct afs_fs_cursor
*, struct afs_vnode
*,
778 extern bool afs_select_fileserver(struct afs_fs_cursor
*);
779 extern bool afs_select_current_fileserver(struct afs_fs_cursor
*);
780 extern int afs_end_vnode_operation(struct afs_fs_cursor
*);
785 extern struct workqueue_struct
*afs_async_calls
;
787 extern int __net_init
afs_open_socket(struct afs_net
*);
788 extern void __net_exit
afs_close_socket(struct afs_net
*);
789 extern void afs_charge_preallocation(struct work_struct
*);
790 extern void afs_put_call(struct afs_call
*);
791 extern int afs_queue_call_work(struct afs_call
*);
792 extern long afs_make_call(struct afs_addr_cursor
*, struct afs_call
*, gfp_t
, bool);
793 extern struct afs_call
*afs_alloc_flat_call(struct afs_net
*,
794 const struct afs_call_type
*,
796 extern void afs_flat_call_destructor(struct afs_call
*);
797 extern void afs_send_empty_reply(struct afs_call
*);
798 extern void afs_send_simple_reply(struct afs_call
*, const void *, size_t);
799 extern int afs_extract_data(struct afs_call
*, void *, size_t, bool);
801 static inline int afs_transfer_reply(struct afs_call
*call
)
803 return afs_extract_data(call
, call
->buffer
, call
->reply_max
, false);
806 static inline bool afs_check_call_state(struct afs_call
*call
,
807 enum afs_call_state state
)
809 return READ_ONCE(call
->state
) == state
;
812 static inline bool afs_set_call_state(struct afs_call
*call
,
813 enum afs_call_state from
,
814 enum afs_call_state to
)
818 spin_lock_bh(&call
->state_lock
);
819 if (call
->state
== from
) {
821 trace_afs_call_state(call
, from
, to
, 0, 0);
824 spin_unlock_bh(&call
->state_lock
);
828 static inline void afs_set_call_complete(struct afs_call
*call
,
829 int error
, u32 remote_abort
)
831 enum afs_call_state state
;
834 spin_lock_bh(&call
->state_lock
);
836 if (state
!= AFS_CALL_COMPLETE
) {
837 call
->abort_code
= remote_abort
;
839 call
->state
= AFS_CALL_COMPLETE
;
840 trace_afs_call_state(call
, state
, AFS_CALL_COMPLETE
,
841 error
, remote_abort
);
844 spin_unlock_bh(&call
->state_lock
);
846 trace_afs_call_done(call
);
852 extern void afs_put_permits(struct afs_permits
*);
853 extern void afs_clear_permits(struct afs_vnode
*);
854 extern void afs_cache_permit(struct afs_vnode
*, struct key
*, unsigned int);
855 extern void afs_zap_permits(struct rcu_head
*);
856 extern struct key
*afs_request_key(struct afs_cell
*);
857 extern int afs_check_permit(struct afs_vnode
*, struct key
*, afs_access_t
*);
858 extern int afs_permission(struct inode
*, int);
859 extern void __exit
afs_clean_up_permit_cache(void);
864 extern spinlock_t afs_server_peer_lock
;
866 static inline struct afs_server
*afs_get_server(struct afs_server
*server
)
868 atomic_inc(&server
->usage
);
872 extern struct afs_server
*afs_find_server(struct afs_net
*,
873 const struct sockaddr_rxrpc
*);
874 extern struct afs_server
*afs_find_server_by_uuid(struct afs_net
*, const uuid_t
*);
875 extern struct afs_server
*afs_lookup_server(struct afs_cell
*, struct key
*, const uuid_t
*);
876 extern void afs_put_server(struct afs_net
*, struct afs_server
*);
877 extern void afs_manage_servers(struct work_struct
*);
878 extern void afs_servers_timer(struct timer_list
*);
879 extern void __net_exit
afs_purge_servers(struct afs_net
*);
880 extern bool afs_probe_fileserver(struct afs_fs_cursor
*);
881 extern bool afs_check_server_record(struct afs_fs_cursor
*, struct afs_server
*);
886 static inline struct afs_server_list
*afs_get_serverlist(struct afs_server_list
*slist
)
888 refcount_inc(&slist
->usage
);
892 extern void afs_put_serverlist(struct afs_net
*, struct afs_server_list
*);
893 extern struct afs_server_list
*afs_alloc_server_list(struct afs_cell
*, struct key
*,
894 struct afs_vldb_entry
*,
896 extern bool afs_annotate_server_list(struct afs_server_list
*, struct afs_server_list
*);
901 extern int __init
afs_fs_init(void);
902 extern void __exit
afs_fs_exit(void);
907 extern struct afs_vldb_entry
*afs_vl_get_entry_by_name_u(struct afs_net
*,
908 struct afs_addr_cursor
*,
909 struct key
*, const char *, int);
910 extern struct afs_addr_list
*afs_vl_get_addrs_u(struct afs_net
*, struct afs_addr_cursor
*,
911 struct key
*, const uuid_t
*);
912 extern int afs_vl_get_capabilities(struct afs_net
*, struct afs_addr_cursor
*, struct key
*);
913 extern struct afs_addr_list
*afs_yfsvl_get_endpoints(struct afs_net
*, struct afs_addr_cursor
*,
914 struct key
*, const uuid_t
*);
919 static inline struct afs_volume
*__afs_get_volume(struct afs_volume
*volume
)
922 atomic_inc(&volume
->usage
);
926 extern struct afs_volume
*afs_create_volume(struct afs_mount_params
*);
927 extern void afs_activate_volume(struct afs_volume
*);
928 extern void afs_deactivate_volume(struct afs_volume
*);
929 extern void afs_put_volume(struct afs_cell
*, struct afs_volume
*);
930 extern int afs_check_volume_status(struct afs_volume
*, struct key
*);
935 extern int afs_set_page_dirty(struct page
*);
936 extern int afs_write_begin(struct file
*file
, struct address_space
*mapping
,
937 loff_t pos
, unsigned len
, unsigned flags
,
938 struct page
**pagep
, void **fsdata
);
939 extern int afs_write_end(struct file
*file
, struct address_space
*mapping
,
940 loff_t pos
, unsigned len
, unsigned copied
,
941 struct page
*page
, void *fsdata
);
942 extern int afs_writepage(struct page
*, struct writeback_control
*);
943 extern int afs_writepages(struct address_space
*, struct writeback_control
*);
944 extern void afs_pages_written_back(struct afs_vnode
*, struct afs_call
*);
945 extern ssize_t
afs_file_write(struct kiocb
*, struct iov_iter
*);
946 extern int afs_flush(struct file
*, fl_owner_t
);
947 extern int afs_fsync(struct file
*, loff_t
, loff_t
, int);
948 extern int afs_page_mkwrite(struct vm_fault
*);
949 extern void afs_prune_wb_keys(struct afs_vnode
*);
950 extern int afs_launder_page(struct page
*);
955 extern const struct xattr_handler
*afs_xattr_handlers
[];
956 extern ssize_t
afs_listxattr(struct dentry
*, char *, size_t);
960 * Miscellaneous inline functions.
962 static inline struct afs_vnode
*AFS_FS_I(struct inode
*inode
)
964 return container_of(inode
, struct afs_vnode
, vfs_inode
);
967 static inline struct inode
*AFS_VNODE_TO_I(struct afs_vnode
*vnode
)
969 return &vnode
->vfs_inode
;
972 static inline void afs_vnode_commit_status(struct afs_fs_cursor
*fc
,
973 struct afs_vnode
*vnode
,
974 unsigned int cb_break
)
976 if (fc
->ac
.error
== 0)
977 afs_cache_permit(vnode
, fc
->key
, cb_break
);
980 static inline void afs_check_for_remote_deletion(struct afs_fs_cursor
*fc
,
981 struct afs_vnode
*vnode
)
983 if (fc
->ac
.error
== -ENOENT
) {
984 set_bit(AFS_VNODE_DELETED
, &vnode
->flags
);
985 afs_break_callback(vnode
);
990 /*****************************************************************************/
994 extern unsigned afs_debug
;
996 #define dbgprintk(FMT,...) \
997 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
999 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1000 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1001 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1004 #if defined(__KDEBUG)
1005 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1006 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1007 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1009 #elif defined(CONFIG_AFS_DEBUG)
1010 #define AFS_DEBUG_KENTER 0x01
1011 #define AFS_DEBUG_KLEAVE 0x02
1012 #define AFS_DEBUG_KDEBUG 0x04
1014 #define _enter(FMT,...) \
1016 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
1017 kenter(FMT,##__VA_ARGS__); \
1020 #define _leave(FMT,...) \
1022 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
1023 kleave(FMT,##__VA_ARGS__); \
1026 #define _debug(FMT,...) \
1028 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
1029 kdebug(FMT,##__VA_ARGS__); \
1033 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1034 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1035 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1039 * debug assertion checking
1041 #if 1 // defined(__KDEBUGALL)
1045 if (unlikely(!(X))) { \
1046 printk(KERN_ERR "\n"); \
1047 printk(KERN_ERR "AFS: Assertion failed\n"); \
1052 #define ASSERTCMP(X, OP, Y) \
1054 if (unlikely(!((X) OP (Y)))) { \
1055 printk(KERN_ERR "\n"); \
1056 printk(KERN_ERR "AFS: Assertion failed\n"); \
1057 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1058 (unsigned long)(X), (unsigned long)(Y)); \
1059 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1060 (unsigned long)(X), (unsigned long)(Y)); \
1065 #define ASSERTRANGE(L, OP1, N, OP2, H) \
1067 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
1068 printk(KERN_ERR "\n"); \
1069 printk(KERN_ERR "AFS: Assertion failed\n"); \
1070 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1071 (unsigned long)(L), (unsigned long)(N), \
1072 (unsigned long)(H)); \
1073 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1074 (unsigned long)(L), (unsigned long)(N), \
1075 (unsigned long)(H)); \
1080 #define ASSERTIF(C, X) \
1082 if (unlikely((C) && !(X))) { \
1083 printk(KERN_ERR "\n"); \
1084 printk(KERN_ERR "AFS: Assertion failed\n"); \
1089 #define ASSERTIFCMP(C, X, OP, Y) \
1091 if (unlikely((C) && !((X) OP (Y)))) { \
1092 printk(KERN_ERR "\n"); \
1093 printk(KERN_ERR "AFS: Assertion failed\n"); \
1094 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1095 (unsigned long)(X), (unsigned long)(Y)); \
1096 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1097 (unsigned long)(X), (unsigned long)(Y)); \
1108 #define ASSERTCMP(X, OP, Y) \
1112 #define ASSERTRANGE(L, OP1, N, OP2, H) \
1116 #define ASSERTIF(C, X) \
1120 #define ASSERTIFCMP(C, X, OP, Y) \
1124 #endif /* __KDEBUGALL */