Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* internal AFS stuff
3 *
4 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8#include <linux/compiler.h>
9#include <linux/kernel.h>
10#include <linux/ktime.h>
11#include <linux/fs.h>
12#include <linux/pagemap.h>
13#include <linux/rxrpc.h>
14#include <linux/key.h>
15#include <linux/workqueue.h>
16#include <linux/sched.h>
17#include <linux/fscache.h>
18#include <linux/backing-dev.h>
19#include <linux/uuid.h>
20#include <linux/mm_types.h>
21#include <linux/dns_resolver.h>
22#include <net/net_namespace.h>
23#include <net/netns/generic.h>
24#include <net/sock.h>
25#include <net/af_rxrpc.h>
26
27#include "afs.h"
28#include "afs_vl.h"
29
30#define AFS_CELL_MAX_ADDRS 15
31
32struct pagevec;
33struct afs_call;
34
35/*
36 * Partial file-locking emulation mode. (The problem being that AFS3 only
37 * allows whole-file locks and no upgrading/downgrading).
38 */
39enum afs_flock_mode {
40 afs_flock_mode_unset,
41 afs_flock_mode_local, /* Local locking only */
42 afs_flock_mode_openafs, /* Don't get server lock for a partial lock */
43 afs_flock_mode_strict, /* Always get a server lock for a partial lock */
44 afs_flock_mode_write, /* Get an exclusive server lock for a partial lock */
45};
46
47struct afs_fs_context {
48 bool force; /* T to force cell type */
49 bool autocell; /* T if set auto mount operation */
50 bool dyn_root; /* T if dynamic root */
51 bool no_cell; /* T if the source is "none" (for dynroot) */
52 enum afs_flock_mode flock_mode; /* Partial file-locking emulation mode */
53 afs_voltype_t type; /* type of volume requested */
54 unsigned int volnamesz; /* size of volume name */
55 const char *volname; /* name of volume to mount */
56 struct afs_net *net; /* the AFS net namespace stuff */
57 struct afs_cell *cell; /* cell in which to find volume */
58 struct afs_volume *volume; /* volume record */
59 struct key *key; /* key to use for secure mounting */
60};
61
62enum afs_call_state {
63 AFS_CALL_CL_REQUESTING, /* Client: Request is being sent */
64 AFS_CALL_CL_AWAIT_REPLY, /* Client: Awaiting reply */
65 AFS_CALL_CL_PROC_REPLY, /* Client: rxrpc call complete; processing reply */
66 AFS_CALL_SV_AWAIT_OP_ID, /* Server: Awaiting op ID */
67 AFS_CALL_SV_AWAIT_REQUEST, /* Server: Awaiting request data */
68 AFS_CALL_SV_REPLYING, /* Server: Replying */
69 AFS_CALL_SV_AWAIT_ACK, /* Server: Awaiting final ACK */
70 AFS_CALL_COMPLETE, /* Completed or failed */
71};
72
73/*
74 * List of server addresses.
75 */
76struct afs_addr_list {
77 struct rcu_head rcu;
78 refcount_t usage;
79 u32 version; /* Version */
80 unsigned char max_addrs;
81 unsigned char nr_addrs;
82 unsigned char preferred; /* Preferred address */
83 unsigned char nr_ipv4; /* Number of IPv4 addresses */
84 enum dns_record_source source:8;
85 enum dns_lookup_status status:8;
86 unsigned long failed; /* Mask of addrs that failed locally/ICMP */
87 unsigned long responded; /* Mask of addrs that responded */
88 struct sockaddr_rxrpc addrs[];
89#define AFS_MAX_ADDRESSES ((unsigned int)(sizeof(unsigned long) * 8))
90};
91
92/*
93 * a record of an in-progress RxRPC call
94 */
95struct afs_call {
96 const struct afs_call_type *type; /* type of call */
97 struct afs_addr_list *alist; /* Address is alist[addr_ix] */
98 wait_queue_head_t waitq; /* processes awaiting completion */
99 struct work_struct async_work; /* async I/O processor */
100 struct work_struct work; /* actual work processor */
101 struct rxrpc_call *rxcall; /* RxRPC call handle */
102 struct key *key; /* security for this call */
103 struct afs_net *net; /* The network namespace */
104 struct afs_server *server; /* The fileserver record if fs op (pins ref) */
105 struct afs_vlserver *vlserver; /* The vlserver record if vl op */
106 void *request; /* request data (first part) */
107 struct iov_iter def_iter; /* Default buffer/data iterator */
108 struct iov_iter *iter; /* Iterator currently in use */
109 union { /* Convenience for ->def_iter */
110 struct kvec kvec[1];
111 struct bio_vec bvec[1];
112 };
113 void *buffer; /* reply receive buffer */
114 union {
115 long ret0; /* Value to reply with instead of 0 */
116 struct afs_addr_list *ret_alist;
117 struct afs_vldb_entry *ret_vldb;
118 char *ret_str;
119 };
120 struct afs_operation *op;
121 unsigned int server_index;
122 atomic_t usage;
123 enum afs_call_state state;
124 spinlock_t state_lock;
125 int error; /* error code */
126 u32 abort_code; /* Remote abort ID or 0 */
127 unsigned int max_lifespan; /* Maximum lifespan to set if not 0 */
128 unsigned request_size; /* size of request data */
129 unsigned reply_max; /* maximum size of reply */
130 unsigned count2; /* count used in unmarshalling */
131 unsigned char unmarshall; /* unmarshalling phase */
132 unsigned char addr_ix; /* Address in ->alist */
133 bool drop_ref; /* T if need to drop ref for incoming call */
134 bool send_pages; /* T if data from mapping should be sent */
135 bool need_attention; /* T if RxRPC poked us */
136 bool async; /* T if asynchronous */
137 bool upgrade; /* T to request service upgrade */
138 bool have_reply_time; /* T if have got reply_time */
139 bool intr; /* T if interruptible */
140 bool unmarshalling_error; /* T if an unmarshalling error occurred */
141 u16 service_id; /* Actual service ID (after upgrade) */
142 unsigned int debug_id; /* Trace ID */
143 u32 operation_ID; /* operation ID for an incoming call */
144 u32 count; /* count for use in unmarshalling */
145 union { /* place to extract temporary data */
146 struct {
147 __be32 tmp_u;
148 __be32 tmp;
149 } __attribute__((packed));
150 __be64 tmp64;
151 };
152 ktime_t reply_time; /* Time of first reply packet */
153};
154
155struct afs_call_type {
156 const char *name;
157 unsigned int op; /* Really enum afs_fs_operation */
158
159 /* deliver request or reply data to an call
160 * - returning an error will cause the call to be aborted
161 */
162 int (*deliver)(struct afs_call *call);
163
164 /* clean up a call */
165 void (*destructor)(struct afs_call *call);
166
167 /* Work function */
168 void (*work)(struct work_struct *work);
169
170 /* Call done function (gets called immediately on success or failure) */
171 void (*done)(struct afs_call *call);
172};
173
174/*
175 * Key available for writeback on a file.
176 */
177struct afs_wb_key {
178 refcount_t usage;
179 struct key *key;
180 struct list_head vnode_link; /* Link in vnode->wb_keys */
181};
182
183/*
184 * AFS open file information record. Pointed to by file->private_data.
185 */
186struct afs_file {
187 struct key *key; /* The key this file was opened with */
188 struct afs_wb_key *wb; /* Writeback key record for this file */
189};
190
191static inline struct key *afs_file_key(struct file *file)
192{
193 struct afs_file *af = file->private_data;
194
195 return af->key;
196}
197
198/*
199 * Record of an outstanding read operation on a vnode.
200 */
201struct afs_read {
202 loff_t pos; /* Where to start reading */
203 loff_t len; /* How much we're asking for */
204 loff_t actual_len; /* How much we're actually getting */
205 loff_t remain; /* Amount remaining */
206 loff_t file_size; /* File size returned by server */
207 afs_dataversion_t data_version; /* Version number returned by server */
208 refcount_t usage;
209 unsigned int index; /* Which page we're reading into */
210 unsigned int nr_pages;
211 unsigned int offset; /* offset into current page */
212 struct afs_vnode *vnode;
213 void (*page_done)(struct afs_read *);
214 struct page **pages;
215 struct page *array[];
216};
217
218/*
219 * AFS superblock private data
220 * - there's one superblock per volume
221 */
222struct afs_super_info {
223 struct net *net_ns; /* Network namespace */
224 struct afs_cell *cell; /* The cell in which the volume resides */
225 struct afs_volume *volume; /* volume record */
226 enum afs_flock_mode flock_mode:8; /* File locking emulation mode */
227 bool dyn_root; /* True if dynamic root */
228};
229
230static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
231{
232 return sb->s_fs_info;
233}
234
235extern struct file_system_type afs_fs_type;
236
237/*
238 * Set of substitutes for @sys.
239 */
240struct afs_sysnames {
241#define AFS_NR_SYSNAME 16
242 char *subs[AFS_NR_SYSNAME];
243 refcount_t usage;
244 unsigned short nr;
245 char blank[1];
246};
247
248/*
249 * AFS network namespace record.
250 */
251struct afs_net {
252 struct net *net; /* Backpointer to the owning net namespace */
253 struct afs_uuid uuid;
254 bool live; /* F if this namespace is being removed */
255
256 /* AF_RXRPC I/O stuff */
257 struct socket *socket;
258 struct afs_call *spare_incoming_call;
259 struct work_struct charge_preallocation_work;
260 struct mutex socket_mutex;
261 atomic_t nr_outstanding_calls;
262 atomic_t nr_superblocks;
263
264 /* Cell database */
265 struct rb_root cells;
266 struct afs_cell __rcu *ws_cell;
267 struct work_struct cells_manager;
268 struct timer_list cells_timer;
269 atomic_t cells_outstanding;
270 seqlock_t cells_lock;
271 struct mutex cells_alias_lock;
272
273 struct mutex proc_cells_lock;
274 struct hlist_head proc_cells;
275
276 /* Known servers. Theoretically each fileserver can only be in one
277 * cell, but in practice, people create aliases and subsets and there's
278 * no easy way to distinguish them.
279 */
280 seqlock_t fs_lock; /* For fs_servers, fs_probe_*, fs_proc */
281 struct rb_root fs_servers; /* afs_server (by server UUID or address) */
282 struct list_head fs_probe_fast; /* List of afs_server to probe at 30s intervals */
283 struct list_head fs_probe_slow; /* List of afs_server to probe at 5m intervals */
284 struct hlist_head fs_proc; /* procfs servers list */
285
286 struct hlist_head fs_addresses4; /* afs_server (by lowest IPv4 addr) */
287 struct hlist_head fs_addresses6; /* afs_server (by lowest IPv6 addr) */
288 seqlock_t fs_addr_lock; /* For fs_addresses[46] */
289
290 struct work_struct fs_manager;
291 struct timer_list fs_timer;
292
293 struct work_struct fs_prober;
294 struct timer_list fs_probe_timer;
295 atomic_t servers_outstanding;
296
297 /* File locking renewal management */
298 struct mutex lock_manager_mutex;
299
300 /* Misc */
301 struct super_block *dynroot_sb; /* Dynamic root mount superblock */
302 struct proc_dir_entry *proc_afs; /* /proc/net/afs directory */
303 struct afs_sysnames *sysnames;
304 rwlock_t sysnames_lock;
305
306 /* Statistics counters */
307 atomic_t n_lookup; /* Number of lookups done */
308 atomic_t n_reval; /* Number of dentries needing revalidation */
309 atomic_t n_inval; /* Number of invalidations by the server */
310 atomic_t n_relpg; /* Number of invalidations by releasepage */
311 atomic_t n_read_dir; /* Number of directory pages read */
312 atomic_t n_dir_cr; /* Number of directory entry creation edits */
313 atomic_t n_dir_rm; /* Number of directory entry removal edits */
314 atomic_t n_stores; /* Number of store ops */
315 atomic_long_t n_store_bytes; /* Number of bytes stored */
316 atomic_long_t n_fetch_bytes; /* Number of bytes fetched */
317 atomic_t n_fetches; /* Number of data fetch ops */
318};
319
320extern const char afs_init_sysname[];
321
322enum afs_cell_state {
323 AFS_CELL_UNSET,
324 AFS_CELL_ACTIVATING,
325 AFS_CELL_ACTIVE,
326 AFS_CELL_DEACTIVATING,
327 AFS_CELL_INACTIVE,
328 AFS_CELL_FAILED,
329};
330
331/*
332 * AFS cell record.
333 *
334 * This is a tricky concept to get right as it is possible to create aliases
335 * simply by pointing AFSDB/SRV records for two names at the same set of VL
336 * servers; it is also possible to do things like setting up two sets of VL
337 * servers, one of which provides a superset of the volumes provided by the
338 * other (for internal/external division, for example).
339 *
340 * Cells only exist in the sense that (a) a cell's name maps to a set of VL
341 * servers and (b) a cell's name is used by the client to select the key to use
342 * for authentication and encryption. The cell name is not typically used in
343 * the protocol.
344 *
345 * Two cells are determined to be aliases if they have an explicit alias (YFS
346 * only), share any VL servers in common or have at least one volume in common.
347 * "In common" means that the address list of the VL servers or the fileservers
348 * share at least one endpoint.
349 */
350struct afs_cell {
351 union {
352 struct rcu_head rcu;
353 struct rb_node net_node; /* Node in net->cells */
354 };
355 struct afs_net *net;
356 struct afs_cell *alias_of; /* The cell this is an alias of */
357 struct afs_volume *root_volume; /* The root.cell volume if there is one */
358 struct key *anonymous_key; /* anonymous user key for this cell */
359 struct work_struct manager; /* Manager for init/deinit/dns */
360 struct hlist_node proc_link; /* /proc cell list link */
361#ifdef CONFIG_AFS_FSCACHE
362 struct fscache_cookie *cache; /* caching cookie */
363#endif
364 time64_t dns_expiry; /* Time AFSDB/SRV record expires */
365 time64_t last_inactive; /* Time of last drop of usage count */
366 atomic_t usage;
367 unsigned long flags;
368#define AFS_CELL_FL_NO_GC 0 /* The cell was added manually, don't auto-gc */
369#define AFS_CELL_FL_DO_LOOKUP 1 /* DNS lookup requested */
370#define AFS_CELL_FL_CHECK_ALIAS 2 /* Need to check for aliases */
371 enum afs_cell_state state;
372 short error;
373 enum dns_record_source dns_source:8; /* Latest source of data from lookup */
374 enum dns_lookup_status dns_status:8; /* Latest status of data from lookup */
375 unsigned int dns_lookup_count; /* Counter of DNS lookups */
376
377 /* The volumes belonging to this cell */
378 struct rb_root volumes; /* Tree of volumes on this server */
379 struct hlist_head proc_volumes; /* procfs volume list */
380 seqlock_t volume_lock; /* For volumes */
381
382 /* Active fileserver interaction state. */
383 struct rb_root fs_servers; /* afs_server (by server UUID) */
384 seqlock_t fs_lock; /* For fs_servers */
385
386 /* VL server list. */
387 rwlock_t vl_servers_lock; /* Lock on vl_servers */
388 struct afs_vlserver_list __rcu *vl_servers;
389
390 u8 name_len; /* Length of name */
391 char *name; /* Cell name, case-flattened and NUL-padded */
392};
393
394/*
395 * Volume Location server record.
396 */
397struct afs_vlserver {
398 struct rcu_head rcu;
399 struct afs_addr_list __rcu *addresses; /* List of addresses for this VL server */
400 unsigned long flags;
401#define AFS_VLSERVER_FL_PROBED 0 /* The VL server has been probed */
402#define AFS_VLSERVER_FL_PROBING 1 /* VL server is being probed */
403#define AFS_VLSERVER_FL_IS_YFS 2 /* Server is YFS not AFS */
404#define AFS_VLSERVER_FL_RESPONDING 3 /* VL server is responding */
405 rwlock_t lock; /* Lock on addresses */
406 atomic_t usage;
407 unsigned int rtt; /* Server's current RTT in uS */
408
409 /* Probe state */
410 wait_queue_head_t probe_wq;
411 atomic_t probe_outstanding;
412 spinlock_t probe_lock;
413 struct {
414 unsigned int rtt; /* RTT in uS */
415 u32 abort_code;
416 short error;
417 unsigned short flags;
418#define AFS_VLSERVER_PROBE_RESPONDED 0x01 /* At least once response (may be abort) */
419#define AFS_VLSERVER_PROBE_IS_YFS 0x02 /* The peer appears to be YFS */
420#define AFS_VLSERVER_PROBE_NOT_YFS 0x04 /* The peer appears not to be YFS */
421#define AFS_VLSERVER_PROBE_LOCAL_FAILURE 0x08 /* A local failure prevented a probe */
422 } probe;
423
424 u16 port;
425 u16 name_len; /* Length of name */
426 char name[]; /* Server name, case-flattened */
427};
428
429/*
430 * Weighted list of Volume Location servers.
431 */
432struct afs_vlserver_entry {
433 u16 priority; /* Preference (as SRV) */
434 u16 weight; /* Weight (as SRV) */
435 enum dns_record_source source:8;
436 enum dns_lookup_status status:8;
437 struct afs_vlserver *server;
438};
439
440struct afs_vlserver_list {
441 struct rcu_head rcu;
442 atomic_t usage;
443 u8 nr_servers;
444 u8 index; /* Server currently in use */
445 u8 preferred; /* Preferred server */
446 enum dns_record_source source:8;
447 enum dns_lookup_status status:8;
448 rwlock_t lock;
449 struct afs_vlserver_entry servers[];
450};
451
452/*
453 * Cached VLDB entry.
454 *
455 * This is pointed to by cell->vldb_entries, indexed by name.
456 */
457struct afs_vldb_entry {
458 afs_volid_t vid[3]; /* Volume IDs for R/W, R/O and Bak volumes */
459
460 unsigned long flags;
461#define AFS_VLDB_HAS_RW 0 /* - R/W volume exists */
462#define AFS_VLDB_HAS_RO 1 /* - R/O volume exists */
463#define AFS_VLDB_HAS_BAK 2 /* - Backup volume exists */
464#define AFS_VLDB_QUERY_VALID 3 /* - Record is valid */
465#define AFS_VLDB_QUERY_ERROR 4 /* - VL server returned error */
466
467 uuid_t fs_server[AFS_NMAXNSERVERS];
468 u32 addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
469 u8 fs_mask[AFS_NMAXNSERVERS];
470#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
471#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
472#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
473 short error;
474 u8 nr_servers; /* Number of server records */
475 u8 name_len;
476 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
477};
478
479/*
480 * Record of fileserver with which we're actively communicating.
481 */
482struct afs_server {
483 struct rcu_head rcu;
484 union {
485 uuid_t uuid; /* Server ID */
486 struct afs_uuid _uuid;
487 };
488
489 struct afs_addr_list __rcu *addresses;
490 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
491 struct rb_node uuid_rb; /* Link in net->fs_servers */
492 struct afs_server __rcu *uuid_next; /* Next server with same UUID */
493 struct afs_server *uuid_prev; /* Previous server with same UUID */
494 struct list_head probe_link; /* Link in net->fs_probe_list */
495 struct hlist_node addr4_link; /* Link in net->fs_addresses4 */
496 struct hlist_node addr6_link; /* Link in net->fs_addresses6 */
497 struct hlist_node proc_link; /* Link in net->fs_proc */
498 struct afs_server *gc_next; /* Next server in manager's list */
499 time64_t unuse_time; /* Time at which last unused */
500 unsigned long flags;
501#define AFS_SERVER_FL_RESPONDING 0 /* The server is responding */
502#define AFS_SERVER_FL_UPDATING 1
503#define AFS_SERVER_FL_NEEDS_UPDATE 2 /* Fileserver address list is out of date */
504#define AFS_SERVER_FL_NOT_READY 4 /* The record is not ready for use */
505#define AFS_SERVER_FL_NOT_FOUND 5 /* VL server says no such server */
506#define AFS_SERVER_FL_VL_FAIL 6 /* Failed to access VL server */
507#define AFS_SERVER_FL_MAY_HAVE_CB 8 /* May have callbacks on this fileserver */
508#define AFS_SERVER_FL_IS_YFS 16 /* Server is YFS not AFS */
509#define AFS_SERVER_FL_NO_IBULK 17 /* Fileserver doesn't support FS.InlineBulkStatus */
510#define AFS_SERVER_FL_NO_RM2 18 /* Fileserver doesn't support YFS.RemoveFile2 */
511 atomic_t ref; /* Object refcount */
512 atomic_t active; /* Active user count */
513 u32 addr_version; /* Address list version */
514 unsigned int rtt; /* Server's current RTT in uS */
515 unsigned int debug_id; /* Debugging ID for traces */
516
517 /* file service access */
518 rwlock_t fs_lock; /* access lock */
519
520 /* callback promise management */
521 unsigned cb_s_break; /* Break-everything counter. */
522
523 /* Probe state */
524 unsigned long probed_at; /* Time last probe was dispatched (jiffies) */
525 wait_queue_head_t probe_wq;
526 atomic_t probe_outstanding;
527 spinlock_t probe_lock;
528 struct {
529 unsigned int rtt; /* RTT in uS */
530 u32 abort_code;
531 short error;
532 bool responded:1;
533 bool is_yfs:1;
534 bool not_yfs:1;
535 bool local_failure:1;
536 } probe;
537};
538
539/*
540 * Replaceable volume server list.
541 */
542struct afs_server_entry {
543 struct afs_server *server;
544};
545
546struct afs_server_list {
547 afs_volid_t vids[AFS_MAXTYPES]; /* Volume IDs */
548 refcount_t usage;
549 unsigned char nr_servers;
550 unsigned char preferred; /* Preferred server */
551 unsigned short vnovol_mask; /* Servers to be skipped due to VNOVOL */
552 unsigned int seq; /* Set to ->servers_seq when installed */
553 rwlock_t lock;
554 struct afs_server_entry servers[];
555};
556
557/*
558 * Live AFS volume management.
559 */
560struct afs_volume {
561 union {
562 struct rcu_head rcu;
563 afs_volid_t vid; /* volume ID */
564 };
565 atomic_t usage;
566 time64_t update_at; /* Time at which to next update */
567 struct afs_cell *cell; /* Cell to which belongs (pins ref) */
568 struct rb_node cell_node; /* Link in cell->volumes */
569 struct hlist_node proc_link; /* Link in cell->proc_volumes */
570 struct super_block __rcu *sb; /* Superblock on which inodes reside */
571 unsigned long flags;
572#define AFS_VOLUME_NEEDS_UPDATE 0 /* - T if an update needs performing */
573#define AFS_VOLUME_UPDATING 1 /* - T if an update is in progress */
574#define AFS_VOLUME_WAIT 2 /* - T if users must wait for update */
575#define AFS_VOLUME_DELETED 3 /* - T if volume appears deleted */
576#define AFS_VOLUME_OFFLINE 4 /* - T if volume offline notice given */
577#define AFS_VOLUME_BUSY 5 /* - T if volume busy notice given */
578#define AFS_VOLUME_MAYBE_NO_IBULK 6 /* - T if some servers don't have InlineBulkStatus */
579#ifdef CONFIG_AFS_FSCACHE
580 struct fscache_cookie *cache; /* caching cookie */
581#endif
582 struct afs_server_list __rcu *servers; /* List of servers on which volume resides */
583 rwlock_t servers_lock; /* Lock for ->servers */
584 unsigned int servers_seq; /* Incremented each time ->servers changes */
585
586 unsigned cb_v_break; /* Break-everything counter. */
587 rwlock_t cb_v_break_lock;
588
589 afs_voltype_t type; /* type of volume */
590 char type_force; /* force volume type (suppress R/O -> R/W) */
591 u8 name_len;
592 u8 name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
593};
594
595enum afs_lock_state {
596 AFS_VNODE_LOCK_NONE, /* The vnode has no lock on the server */
597 AFS_VNODE_LOCK_WAITING_FOR_CB, /* We're waiting for the server to break the callback */
598 AFS_VNODE_LOCK_SETTING, /* We're asking the server for a lock */
599 AFS_VNODE_LOCK_GRANTED, /* We have a lock on the server */
600 AFS_VNODE_LOCK_EXTENDING, /* We're extending a lock on the server */
601 AFS_VNODE_LOCK_NEED_UNLOCK, /* We need to unlock on the server */
602 AFS_VNODE_LOCK_UNLOCKING, /* We're telling the server to unlock */
603 AFS_VNODE_LOCK_DELETED, /* The vnode has been deleted whilst we have a lock */
604};
605
606/*
607 * AFS inode private data.
608 *
609 * Note that afs_alloc_inode() *must* reset anything that could incorrectly
610 * leak from one inode to another.
611 */
612struct afs_vnode {
613 struct inode vfs_inode; /* the VFS's inode record */
614
615 struct afs_volume *volume; /* volume on which vnode resides */
616 struct afs_fid fid; /* the file identifier for this inode */
617 struct afs_file_status status; /* AFS status info for this file */
618 afs_dataversion_t invalid_before; /* Child dentries are invalid before this */
619#ifdef CONFIG_AFS_FSCACHE
620 struct fscache_cookie *cache; /* caching cookie */
621#endif
622 struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
623 struct mutex io_lock; /* Lock for serialising I/O on this mutex */
624 struct rw_semaphore validate_lock; /* lock for validating this vnode */
625 struct rw_semaphore rmdir_lock; /* Lock for rmdir vs sillyrename */
626 struct key *silly_key; /* Silly rename key */
627 spinlock_t wb_lock; /* lock for wb_keys */
628 spinlock_t lock; /* waitqueue/flags lock */
629 unsigned long flags;
630#define AFS_VNODE_CB_PROMISED 0 /* Set if vnode has a callback promise */
631#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
632#define AFS_VNODE_DIR_VALID 2 /* Set if dir contents are valid */
633#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
634#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
635#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
636#define AFS_VNODE_AUTOCELL 6 /* set if Vnode is an auto mount point */
637#define AFS_VNODE_PSEUDODIR 7 /* set if Vnode is a pseudo directory */
638#define AFS_VNODE_NEW_CONTENT 8 /* Set if file has new content (create/trunc-0) */
639#define AFS_VNODE_SILLY_DELETED 9 /* Set if file has been silly-deleted */
640
641 struct list_head wb_keys; /* List of keys available for writeback */
642 struct list_head pending_locks; /* locks waiting to be granted */
643 struct list_head granted_locks; /* locks granted on this file */
644 struct delayed_work lock_work; /* work to be done in locking */
645 struct key *lock_key; /* Key to be used in lock ops */
646 ktime_t locked_at; /* Time at which lock obtained */
647 enum afs_lock_state lock_state : 8;
648 afs_lock_type_t lock_type : 8;
649
650 /* outstanding callback notification on this file */
651 void *cb_server; /* Server with callback/filelock */
652 unsigned int cb_s_break; /* Mass break counter on ->server */
653 unsigned int cb_v_break; /* Mass break counter on ->volume */
654 unsigned int cb_break; /* Break counter on vnode */
655 seqlock_t cb_lock; /* Lock for ->cb_server, ->status, ->cb_*break */
656
657 time64_t cb_expires_at; /* time at which callback expires */
658};
659
660static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
661{
662#ifdef CONFIG_AFS_FSCACHE
663 return vnode->cache;
664#else
665 return NULL;
666#endif
667}
668
669/*
670 * cached security record for one user's attempt to access a vnode
671 */
672struct afs_permit {
673 struct key *key; /* RxRPC ticket holding a security context */
674 afs_access_t access; /* CallerAccess value for this key */
675};
676
677/*
678 * Immutable cache of CallerAccess records from attempts to access vnodes.
679 * These may be shared between multiple vnodes.
680 */
681struct afs_permits {
682 struct rcu_head rcu;
683 struct hlist_node hash_node; /* Link in hash */
684 unsigned long h; /* Hash value for this permit list */
685 refcount_t usage;
686 unsigned short nr_permits; /* Number of records */
687 bool invalidated; /* Invalidated due to key change */
688 struct afs_permit permits[]; /* List of permits sorted by key pointer */
689};
690
691/*
692 * Error prioritisation and accumulation.
693 */
694struct afs_error {
695 short error; /* Accumulated error */
696 bool responded; /* T if server responded */
697};
698
699/*
700 * Cursor for iterating over a server's address list.
701 */
702struct afs_addr_cursor {
703 struct afs_addr_list *alist; /* Current address list (pins ref) */
704 unsigned long tried; /* Tried addresses */
705 signed char index; /* Current address */
706 bool responded; /* T if the current address responded */
707 unsigned short nr_iterations; /* Number of address iterations */
708 short error;
709 u32 abort_code;
710};
711
712/*
713 * Cursor for iterating over a set of volume location servers.
714 */
715struct afs_vl_cursor {
716 struct afs_addr_cursor ac;
717 struct afs_cell *cell; /* The cell we're querying */
718 struct afs_vlserver_list *server_list; /* Current server list (pins ref) */
719 struct afs_vlserver *server; /* Server on which this resides */
720 struct key *key; /* Key for the server */
721 unsigned long untried; /* Bitmask of untried servers */
722 short index; /* Current server */
723 short error;
724 unsigned short flags;
725#define AFS_VL_CURSOR_STOP 0x0001 /* Set to cease iteration */
726#define AFS_VL_CURSOR_RETRY 0x0002 /* Set to do a retry */
727#define AFS_VL_CURSOR_RETRIED 0x0004 /* Set if started a retry */
728 unsigned short nr_iterations; /* Number of server iterations */
729};
730
731/*
732 * Fileserver operation methods.
733 */
734struct afs_operation_ops {
735 void (*issue_afs_rpc)(struct afs_operation *op);
736 void (*issue_yfs_rpc)(struct afs_operation *op);
737 void (*success)(struct afs_operation *op);
738 void (*aborted)(struct afs_operation *op);
739 void (*edit_dir)(struct afs_operation *op);
740 void (*put)(struct afs_operation *op);
741};
742
743struct afs_vnode_param {
744 struct afs_vnode *vnode;
745 struct afs_fid fid; /* Fid to access */
746 struct afs_status_cb scb; /* Returned status and callback promise */
747 afs_dataversion_t dv_before; /* Data version before the call */
748 unsigned int cb_break_before; /* cb_break + cb_s_break before the call */
749 u8 dv_delta; /* Expected change in data version */
750 bool put_vnode:1; /* T if we have a ref on the vnode */
751 bool need_io_lock:1; /* T if we need the I/O lock on this */
752 bool update_ctime:1; /* Need to update the ctime */
753 bool set_size:1; /* Must update i_size */
754 bool op_unlinked:1; /* True if file was unlinked by op */
755};
756
757/*
758 * Fileserver operation wrapper, handling server and address rotation
759 * asynchronously. May make simultaneous calls to multiple servers.
760 */
761struct afs_operation {
762 struct afs_net *net; /* Network namespace */
763 struct key *key; /* Key for the cell */
764 const struct afs_call_type *type; /* Type of call done */
765 const struct afs_operation_ops *ops;
766
767 /* Parameters/results for the operation */
768 struct afs_volume *volume; /* Volume being accessed */
769 struct afs_vnode_param file[2];
770 struct afs_vnode_param *more_files;
771 struct afs_volsync volsync;
772 struct dentry *dentry; /* Dentry to be altered */
773 struct dentry *dentry_2; /* Second dentry to be altered */
774 struct timespec64 mtime; /* Modification time to record */
775 struct timespec64 ctime; /* Change time to set */
776 short nr_files; /* Number of entries in file[], more_files */
777 short error;
778 unsigned int debug_id;
779
780 unsigned int cb_v_break; /* Volume break counter before op */
781 unsigned int cb_s_break; /* Server break counter before op */
782
783 union {
784 struct {
785 int which; /* Which ->file[] to fetch for */
786 } fetch_status;
787 struct {
788 int reason; /* enum afs_edit_dir_reason */
789 mode_t mode;
790 const char *symlink;
791 } create;
792 struct {
793 bool need_rehash;
794 } unlink;
795 struct {
796 struct dentry *rehash;
797 struct dentry *tmp;
798 bool new_negative;
799 } rename;
800 struct {
801 struct afs_read *req;
802 } fetch;
803 struct {
804 afs_lock_type_t type;
805 } lock;
806 struct {
807 struct address_space *mapping; /* Pages being written from */
808 pgoff_t first; /* first page in mapping to deal with */
809 pgoff_t last; /* last page in mapping to deal with */
810 unsigned first_offset; /* offset into mapping[first] */
811 unsigned last_to; /* amount of mapping[last] */
812 } store;
813 struct {
814 struct iattr *attr;
815 loff_t old_i_size;
816 } setattr;
817 struct afs_acl *acl;
818 struct yfs_acl *yacl;
819 struct {
820 struct afs_volume_status vs;
821 struct kstatfs *buf;
822 } volstatus;
823 };
824
825 /* Fileserver iteration state */
826 struct afs_addr_cursor ac;
827 struct afs_server_list *server_list; /* Current server list (pins ref) */
828 struct afs_server *server; /* Server we're using (ref pinned by server_list) */
829 struct afs_call *call;
830 unsigned long untried; /* Bitmask of untried servers */
831 short index; /* Current server */
832 unsigned short nr_iterations; /* Number of server iterations */
833
834 unsigned int flags;
835#define AFS_OPERATION_STOP 0x0001 /* Set to cease iteration */
836#define AFS_OPERATION_VBUSY 0x0002 /* Set if seen VBUSY */
837#define AFS_OPERATION_VMOVED 0x0004 /* Set if seen VMOVED */
838#define AFS_OPERATION_VNOVOL 0x0008 /* Set if seen VNOVOL */
839#define AFS_OPERATION_CUR_ONLY 0x0010 /* Set if current server only (file lock held) */
840#define AFS_OPERATION_NO_VSLEEP 0x0020 /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
841#define AFS_OPERATION_UNINTR 0x0040 /* Set if op is uninterruptible */
842#define AFS_OPERATION_DOWNGRADE 0x0080 /* Set to retry with downgraded opcode */
843#define AFS_OPERATION_LOCK_0 0x0100 /* Set if have io_lock on file[0] */
844#define AFS_OPERATION_LOCK_1 0x0200 /* Set if have io_lock on file[1] */
845#define AFS_OPERATION_TRIED_ALL 0x0400 /* Set if we've tried all the fileservers */
846#define AFS_OPERATION_RETRY_SERVER 0x0800 /* Set if we should retry the current server */
847#define AFS_OPERATION_DIR_CONFLICT 0x1000 /* Set if we detected a 3rd-party dir change */
848};
849
850/*
851 * Cache auxiliary data.
852 */
853struct afs_vnode_cache_aux {
854 u64 data_version;
855} __packed;
856
857#include <trace/events/afs.h>
858
859/*****************************************************************************/
860/*
861 * addr_list.c
862 */
863static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
864{
865 if (alist)
866 refcount_inc(&alist->usage);
867 return alist;
868}
869extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
870 unsigned short,
871 unsigned short);
872extern void afs_put_addrlist(struct afs_addr_list *);
873extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
874 const char *, size_t, char,
875 unsigned short, unsigned short);
876extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
877extern bool afs_iterate_addresses(struct afs_addr_cursor *);
878extern int afs_end_cursor(struct afs_addr_cursor *);
879
880extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
881extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
882
883/*
884 * cache.c
885 */
886#ifdef CONFIG_AFS_FSCACHE
887extern struct fscache_netfs afs_cache_netfs;
888extern struct fscache_cookie_def afs_cell_cache_index_def;
889extern struct fscache_cookie_def afs_volume_cache_index_def;
890extern struct fscache_cookie_def afs_vnode_cache_index_def;
891#else
892#define afs_cell_cache_index_def (*(struct fscache_cookie_def *) NULL)
893#define afs_volume_cache_index_def (*(struct fscache_cookie_def *) NULL)
894#define afs_vnode_cache_index_def (*(struct fscache_cookie_def *) NULL)
895#endif
896
897/*
898 * callback.c
899 */
900extern void afs_init_callback_state(struct afs_server *);
901extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
902extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
903extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
904
905static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
906{
907 return vnode->cb_break + vnode->cb_v_break;
908}
909
910static inline bool afs_cb_is_broken(unsigned int cb_break,
911 const struct afs_vnode *vnode)
912{
913 return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
914}
915
916/*
917 * cell.c
918 */
919extern int afs_cell_init(struct afs_net *, const char *);
920extern struct afs_cell *afs_lookup_cell_rcu(struct afs_net *, const char *, unsigned);
921extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
922 const char *, bool);
923extern struct afs_cell *afs_get_cell(struct afs_cell *);
924extern void afs_put_cell(struct afs_net *, struct afs_cell *);
925extern void afs_manage_cells(struct work_struct *);
926extern void afs_cells_timer(struct timer_list *);
927extern void __net_exit afs_cell_purge(struct afs_net *);
928
929/*
930 * cmservice.c
931 */
932extern bool afs_cm_incoming_call(struct afs_call *);
933
934/*
935 * dir.c
936 */
937extern const struct file_operations afs_dir_file_operations;
938extern const struct inode_operations afs_dir_inode_operations;
939extern const struct address_space_operations afs_dir_aops;
940extern const struct dentry_operations afs_fs_dentry_operations;
941
942extern void afs_d_release(struct dentry *);
943extern void afs_check_for_remote_deletion(struct afs_operation *);
944
945/*
946 * dir_edit.c
947 */
948extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
949 enum afs_edit_dir_reason);
950extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
951
952/*
953 * dir_silly.c
954 */
955extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
956 struct dentry *, struct key *);
957extern int afs_silly_iput(struct dentry *, struct inode *);
958
959/*
960 * dynroot.c
961 */
962extern const struct inode_operations afs_dynroot_inode_operations;
963extern const struct dentry_operations afs_dynroot_dentry_operations;
964
965extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
966extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
967extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
968extern int afs_dynroot_populate(struct super_block *);
969extern void afs_dynroot_depopulate(struct super_block *);
970
971/*
972 * file.c
973 */
974extern const struct address_space_operations afs_fs_aops;
975extern const struct inode_operations afs_file_inode_operations;
976extern const struct file_operations afs_file_operations;
977
978extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
979extern void afs_put_wb_key(struct afs_wb_key *);
980extern int afs_open(struct inode *, struct file *);
981extern int afs_release(struct inode *, struct file *);
982extern int afs_fetch_data(struct afs_vnode *, struct key *, struct afs_read *);
983extern int afs_page_filler(void *, struct page *);
984extern void afs_put_read(struct afs_read *);
985
986static inline struct afs_read *afs_get_read(struct afs_read *req)
987{
988 refcount_inc(&req->usage);
989 return req;
990}
991
992/*
993 * flock.c
994 */
995extern struct workqueue_struct *afs_lock_manager;
996
997extern void afs_lock_op_done(struct afs_call *);
998extern void afs_lock_work(struct work_struct *);
999extern void afs_lock_may_be_available(struct afs_vnode *);
1000extern int afs_lock(struct file *, int, struct file_lock *);
1001extern int afs_flock(struct file *, int, struct file_lock *);
1002
1003/*
1004 * fsclient.c
1005 */
1006extern void afs_fs_fetch_status(struct afs_operation *);
1007extern void afs_fs_fetch_data(struct afs_operation *);
1008extern void afs_fs_create_file(struct afs_operation *);
1009extern void afs_fs_make_dir(struct afs_operation *);
1010extern void afs_fs_remove_file(struct afs_operation *);
1011extern void afs_fs_remove_dir(struct afs_operation *);
1012extern void afs_fs_link(struct afs_operation *);
1013extern void afs_fs_symlink(struct afs_operation *);
1014extern void afs_fs_rename(struct afs_operation *);
1015extern void afs_fs_store_data(struct afs_operation *);
1016extern void afs_fs_setattr(struct afs_operation *);
1017extern void afs_fs_get_volume_status(struct afs_operation *);
1018extern void afs_fs_set_lock(struct afs_operation *);
1019extern void afs_fs_extend_lock(struct afs_operation *);
1020extern void afs_fs_release_lock(struct afs_operation *);
1021extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
1022 struct afs_addr_cursor *, struct key *);
1023extern bool afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
1024 struct afs_addr_cursor *, struct key *);
1025extern void afs_fs_inline_bulk_status(struct afs_operation *);
1026
1027struct afs_acl {
1028 u32 size;
1029 u8 data[];
1030};
1031
1032extern void afs_fs_fetch_acl(struct afs_operation *);
1033extern void afs_fs_store_acl(struct afs_operation *);
1034
1035/*
1036 * fs_operation.c
1037 */
1038extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1039extern int afs_put_operation(struct afs_operation *);
1040extern bool afs_begin_vnode_operation(struct afs_operation *);
1041extern void afs_wait_for_operation(struct afs_operation *);
1042extern int afs_do_sync_operation(struct afs_operation *);
1043
1044static inline void afs_op_nomem(struct afs_operation *op)
1045{
1046 op->error = -ENOMEM;
1047}
1048
1049static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1050 struct afs_vnode *vnode)
1051{
1052 op->file[n].vnode = vnode;
1053 op->file[n].need_io_lock = true;
1054}
1055
1056static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1057 const struct afs_fid *fid)
1058{
1059 op->file[n].fid = *fid;
1060}
1061
1062/*
1063 * fs_probe.c
1064 */
1065extern void afs_fileserver_probe_result(struct afs_call *);
1066extern void afs_fs_probe_fileserver(struct afs_net *, struct afs_server *, struct key *, bool);
1067extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
1068extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1069extern void afs_fs_probe_dispatcher(struct work_struct *);
1070extern int afs_wait_for_one_fs_probe(struct afs_server *, bool);
1071extern void afs_fs_probe_cleanup(struct afs_net *);
1072
1073/*
1074 * inode.c
1075 */
1076extern const struct afs_operation_ops afs_fetch_status_operation;
1077
1078extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1079extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1080extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1081extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1082extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1083extern struct inode *afs_root_iget(struct super_block *, struct key *);
1084extern bool afs_check_validity(struct afs_vnode *);
1085extern int afs_validate(struct afs_vnode *, struct key *);
1086extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
1087extern int afs_setattr(struct dentry *, struct iattr *);
1088extern void afs_evict_inode(struct inode *);
1089extern int afs_drop_inode(struct inode *);
1090
1091/*
1092 * main.c
1093 */
1094extern struct workqueue_struct *afs_wq;
1095extern int afs_net_id;
1096
1097static inline struct afs_net *afs_net(struct net *net)
1098{
1099 return net_generic(net, afs_net_id);
1100}
1101
1102static inline struct afs_net *afs_sb2net(struct super_block *sb)
1103{
1104 return afs_net(AFS_FS_S(sb)->net_ns);
1105}
1106
1107static inline struct afs_net *afs_d2net(struct dentry *dentry)
1108{
1109 return afs_sb2net(dentry->d_sb);
1110}
1111
1112static inline struct afs_net *afs_i2net(struct inode *inode)
1113{
1114 return afs_sb2net(inode->i_sb);
1115}
1116
1117static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1118{
1119 return afs_i2net(&vnode->vfs_inode);
1120}
1121
1122static inline struct afs_net *afs_sock2net(struct sock *sk)
1123{
1124 return net_generic(sock_net(sk), afs_net_id);
1125}
1126
1127static inline void __afs_stat(atomic_t *s)
1128{
1129 atomic_inc(s);
1130}
1131
1132#define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1133
1134/*
1135 * misc.c
1136 */
1137extern int afs_abort_to_error(u32);
1138extern void afs_prioritise_error(struct afs_error *, int, u32);
1139
1140/*
1141 * mntpt.c
1142 */
1143extern const struct inode_operations afs_mntpt_inode_operations;
1144extern const struct inode_operations afs_autocell_inode_operations;
1145extern const struct file_operations afs_mntpt_file_operations;
1146
1147extern struct vfsmount *afs_d_automount(struct path *);
1148extern void afs_mntpt_kill_timer(void);
1149
1150/*
1151 * proc.c
1152 */
1153#ifdef CONFIG_PROC_FS
1154extern int __net_init afs_proc_init(struct afs_net *);
1155extern void __net_exit afs_proc_cleanup(struct afs_net *);
1156extern int afs_proc_cell_setup(struct afs_cell *);
1157extern void afs_proc_cell_remove(struct afs_cell *);
1158extern void afs_put_sysnames(struct afs_sysnames *);
1159#else
1160static inline int afs_proc_init(struct afs_net *net) { return 0; }
1161static inline void afs_proc_cleanup(struct afs_net *net) {}
1162static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1163static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1164static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1165#endif
1166
1167/*
1168 * rotate.c
1169 */
1170extern bool afs_select_fileserver(struct afs_operation *);
1171extern void afs_dump_edestaddrreq(const struct afs_operation *);
1172
1173/*
1174 * rxrpc.c
1175 */
1176extern struct workqueue_struct *afs_async_calls;
1177
1178extern int __net_init afs_open_socket(struct afs_net *);
1179extern void __net_exit afs_close_socket(struct afs_net *);
1180extern void afs_charge_preallocation(struct work_struct *);
1181extern void afs_put_call(struct afs_call *);
1182extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
1183extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1184extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1185 const struct afs_call_type *,
1186 size_t, size_t);
1187extern void afs_flat_call_destructor(struct afs_call *);
1188extern void afs_send_empty_reply(struct afs_call *);
1189extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1190extern int afs_extract_data(struct afs_call *, bool);
1191extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1192
1193static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1194 gfp_t gfp)
1195{
1196 op->call = call;
1197 op->type = call->type;
1198 call->op = op;
1199 call->key = op->key;
1200 call->intr = !(op->flags & AFS_OPERATION_UNINTR);
1201 afs_make_call(&op->ac, call, gfp);
1202}
1203
1204static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1205{
1206 call->kvec[0].iov_base = buf;
1207 call->kvec[0].iov_len = size;
1208 iov_iter_kvec(&call->def_iter, READ, call->kvec, 1, size);
1209}
1210
1211static inline void afs_extract_to_tmp(struct afs_call *call)
1212{
1213 afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1214}
1215
1216static inline void afs_extract_to_tmp64(struct afs_call *call)
1217{
1218 afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1219}
1220
1221static inline void afs_extract_discard(struct afs_call *call, size_t size)
1222{
1223 iov_iter_discard(&call->def_iter, READ, size);
1224}
1225
1226static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1227{
1228 afs_extract_begin(call, call->buffer, size);
1229}
1230
1231static inline int afs_transfer_reply(struct afs_call *call)
1232{
1233 return afs_extract_data(call, false);
1234}
1235
1236static inline bool afs_check_call_state(struct afs_call *call,
1237 enum afs_call_state state)
1238{
1239 return READ_ONCE(call->state) == state;
1240}
1241
1242static inline bool afs_set_call_state(struct afs_call *call,
1243 enum afs_call_state from,
1244 enum afs_call_state to)
1245{
1246 bool ok = false;
1247
1248 spin_lock_bh(&call->state_lock);
1249 if (call->state == from) {
1250 call->state = to;
1251 trace_afs_call_state(call, from, to, 0, 0);
1252 ok = true;
1253 }
1254 spin_unlock_bh(&call->state_lock);
1255 return ok;
1256}
1257
1258static inline void afs_set_call_complete(struct afs_call *call,
1259 int error, u32 remote_abort)
1260{
1261 enum afs_call_state state;
1262 bool ok = false;
1263
1264 spin_lock_bh(&call->state_lock);
1265 state = call->state;
1266 if (state != AFS_CALL_COMPLETE) {
1267 call->abort_code = remote_abort;
1268 call->error = error;
1269 call->state = AFS_CALL_COMPLETE;
1270 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1271 error, remote_abort);
1272 ok = true;
1273 }
1274 spin_unlock_bh(&call->state_lock);
1275 if (ok) {
1276 trace_afs_call_done(call);
1277
1278 /* Asynchronous calls have two refs to release - one from the alloc and
1279 * one queued with the work item - and we can't just deallocate the
1280 * call because the work item may be queued again.
1281 */
1282 if (call->drop_ref)
1283 afs_put_call(call);
1284 }
1285}
1286
1287/*
1288 * security.c
1289 */
1290extern void afs_put_permits(struct afs_permits *);
1291extern void afs_clear_permits(struct afs_vnode *);
1292extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1293 struct afs_status_cb *);
1294extern void afs_zap_permits(struct rcu_head *);
1295extern struct key *afs_request_key(struct afs_cell *);
1296extern struct key *afs_request_key_rcu(struct afs_cell *);
1297extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1298extern int afs_permission(struct inode *, int);
1299extern void __exit afs_clean_up_permit_cache(void);
1300
1301/*
1302 * server.c
1303 */
1304extern spinlock_t afs_server_peer_lock;
1305
1306extern struct afs_server *afs_find_server(struct afs_net *,
1307 const struct sockaddr_rxrpc *);
1308extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1309extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1310extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1311extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1312extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1313extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1314extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1315extern void afs_manage_servers(struct work_struct *);
1316extern void afs_servers_timer(struct timer_list *);
1317extern void afs_fs_probe_timer(struct timer_list *);
1318extern void __net_exit afs_purge_servers(struct afs_net *);
1319extern bool afs_check_server_record(struct afs_operation *, struct afs_server *);
1320
1321static inline void afs_inc_servers_outstanding(struct afs_net *net)
1322{
1323 atomic_inc(&net->servers_outstanding);
1324}
1325
1326static inline void afs_dec_servers_outstanding(struct afs_net *net)
1327{
1328 if (atomic_dec_and_test(&net->servers_outstanding))
1329 wake_up_var(&net->servers_outstanding);
1330}
1331
1332static inline bool afs_is_probing_server(struct afs_server *server)
1333{
1334 return list_empty(&server->probe_link);
1335}
1336
1337/*
1338 * server_list.c
1339 */
1340static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1341{
1342 refcount_inc(&slist->usage);
1343 return slist;
1344}
1345
1346extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1347extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1348 struct afs_vldb_entry *,
1349 u8);
1350extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1351
1352/*
1353 * super.c
1354 */
1355extern int __init afs_fs_init(void);
1356extern void afs_fs_exit(void);
1357
1358/*
1359 * vlclient.c
1360 */
1361extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1362 const char *, int);
1363extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1364extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
1365 struct key *, struct afs_vlserver *, unsigned int);
1366extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1367extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1368
1369/*
1370 * vl_alias.c
1371 */
1372extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1373
1374/*
1375 * vl_probe.c
1376 */
1377extern void afs_vlserver_probe_result(struct afs_call *);
1378extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1379extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1380
1381/*
1382 * vl_rotate.c
1383 */
1384extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1385 struct afs_cell *, struct key *);
1386extern bool afs_select_vlserver(struct afs_vl_cursor *);
1387extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1388extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1389
1390/*
1391 * vlserver_list.c
1392 */
1393static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1394{
1395 atomic_inc(&vlserver->usage);
1396 return vlserver;
1397}
1398
1399static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1400{
1401 if (vllist)
1402 atomic_inc(&vllist->usage);
1403 return vllist;
1404}
1405
1406extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1407extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1408extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1409extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1410extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1411 const void *, size_t);
1412
1413/*
1414 * volume.c
1415 */
1416extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1417extern void afs_activate_volume(struct afs_volume *);
1418extern void afs_deactivate_volume(struct afs_volume *);
1419extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1420extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
1421extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1422
1423/*
1424 * write.c
1425 */
1426extern int afs_set_page_dirty(struct page *);
1427extern int afs_write_begin(struct file *file, struct address_space *mapping,
1428 loff_t pos, unsigned len, unsigned flags,
1429 struct page **pagep, void **fsdata);
1430extern int afs_write_end(struct file *file, struct address_space *mapping,
1431 loff_t pos, unsigned len, unsigned copied,
1432 struct page *page, void *fsdata);
1433extern int afs_writepage(struct page *, struct writeback_control *);
1434extern int afs_writepages(struct address_space *, struct writeback_control *);
1435extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1436extern int afs_fsync(struct file *, loff_t, loff_t, int);
1437extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1438extern void afs_prune_wb_keys(struct afs_vnode *);
1439extern int afs_launder_page(struct page *);
1440
1441/*
1442 * xattr.c
1443 */
1444extern const struct xattr_handler *afs_xattr_handlers[];
1445extern ssize_t afs_listxattr(struct dentry *, char *, size_t);
1446
1447/*
1448 * yfsclient.c
1449 */
1450extern void yfs_fs_fetch_data(struct afs_operation *);
1451extern void yfs_fs_create_file(struct afs_operation *);
1452extern void yfs_fs_make_dir(struct afs_operation *);
1453extern void yfs_fs_remove_file2(struct afs_operation *);
1454extern void yfs_fs_remove_file(struct afs_operation *);
1455extern void yfs_fs_remove_dir(struct afs_operation *);
1456extern void yfs_fs_link(struct afs_operation *);
1457extern void yfs_fs_symlink(struct afs_operation *);
1458extern void yfs_fs_rename(struct afs_operation *);
1459extern void yfs_fs_store_data(struct afs_operation *);
1460extern void yfs_fs_setattr(struct afs_operation *);
1461extern void yfs_fs_get_volume_status(struct afs_operation *);
1462extern void yfs_fs_set_lock(struct afs_operation *);
1463extern void yfs_fs_extend_lock(struct afs_operation *);
1464extern void yfs_fs_release_lock(struct afs_operation *);
1465extern void yfs_fs_fetch_status(struct afs_operation *);
1466extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1467
1468struct yfs_acl {
1469 struct afs_acl *acl; /* Dir/file/symlink ACL */
1470 struct afs_acl *vol_acl; /* Whole volume ACL */
1471 u32 inherit_flag; /* True if ACL is inherited from parent dir */
1472 u32 num_cleaned; /* Number of ACEs removed due to subject removal */
1473 unsigned int flags;
1474#define YFS_ACL_WANT_ACL 0x01 /* Set if caller wants ->acl */
1475#define YFS_ACL_WANT_VOL_ACL 0x02 /* Set if caller wants ->vol_acl */
1476};
1477
1478extern void yfs_free_opaque_acl(struct yfs_acl *);
1479extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1480extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1481
1482/*
1483 * Miscellaneous inline functions.
1484 */
1485static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1486{
1487 return container_of(inode, struct afs_vnode, vfs_inode);
1488}
1489
1490static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1491{
1492 return &vnode->vfs_inode;
1493}
1494
1495/*
1496 * Note that a dentry got changed. We need to set d_fsdata to the data version
1497 * number derived from the result of the operation. It doesn't matter if
1498 * d_fsdata goes backwards as we'll just revalidate.
1499 */
1500static inline void afs_update_dentry_version(struct afs_operation *op,
1501 struct afs_vnode_param *dir_vp,
1502 struct dentry *dentry)
1503{
1504 if (!op->error)
1505 dentry->d_fsdata =
1506 (void *)(unsigned long)dir_vp->scb.status.data_version;
1507}
1508
1509/*
1510 * Check for a conflicting operation on a directory that we just unlinked from.
1511 * If someone managed to sneak a link or an unlink in on the file we just
1512 * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1513 */
1514static inline void afs_check_dir_conflict(struct afs_operation *op,
1515 struct afs_vnode_param *dvp)
1516{
1517 if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1518 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1519}
1520
1521static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1522{
1523 trace_afs_io_error(call->debug_id, -EIO, where);
1524 return -EIO;
1525}
1526
1527static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1528{
1529 trace_afs_file_error(vnode, -EIO, where);
1530 return -EIO;
1531}
1532
1533/*****************************************************************************/
1534/*
1535 * debug tracing
1536 */
1537extern unsigned afs_debug;
1538
1539#define dbgprintk(FMT,...) \
1540 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1541
1542#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1543#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1544#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1545
1546
1547#if defined(__KDEBUG)
1548#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1549#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1550#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1551
1552#elif defined(CONFIG_AFS_DEBUG)
1553#define AFS_DEBUG_KENTER 0x01
1554#define AFS_DEBUG_KLEAVE 0x02
1555#define AFS_DEBUG_KDEBUG 0x04
1556
1557#define _enter(FMT,...) \
1558do { \
1559 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
1560 kenter(FMT,##__VA_ARGS__); \
1561} while (0)
1562
1563#define _leave(FMT,...) \
1564do { \
1565 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
1566 kleave(FMT,##__VA_ARGS__); \
1567} while (0)
1568
1569#define _debug(FMT,...) \
1570do { \
1571 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
1572 kdebug(FMT,##__VA_ARGS__); \
1573} while (0)
1574
1575#else
1576#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1577#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1578#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1579#endif
1580
1581/*
1582 * debug assertion checking
1583 */
1584#if 1 // defined(__KDEBUGALL)
1585
1586#define ASSERT(X) \
1587do { \
1588 if (unlikely(!(X))) { \
1589 printk(KERN_ERR "\n"); \
1590 printk(KERN_ERR "AFS: Assertion failed\n"); \
1591 BUG(); \
1592 } \
1593} while(0)
1594
1595#define ASSERTCMP(X, OP, Y) \
1596do { \
1597 if (unlikely(!((X) OP (Y)))) { \
1598 printk(KERN_ERR "\n"); \
1599 printk(KERN_ERR "AFS: Assertion failed\n"); \
1600 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1601 (unsigned long)(X), (unsigned long)(Y)); \
1602 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1603 (unsigned long)(X), (unsigned long)(Y)); \
1604 BUG(); \
1605 } \
1606} while(0)
1607
1608#define ASSERTRANGE(L, OP1, N, OP2, H) \
1609do { \
1610 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
1611 printk(KERN_ERR "\n"); \
1612 printk(KERN_ERR "AFS: Assertion failed\n"); \
1613 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1614 (unsigned long)(L), (unsigned long)(N), \
1615 (unsigned long)(H)); \
1616 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1617 (unsigned long)(L), (unsigned long)(N), \
1618 (unsigned long)(H)); \
1619 BUG(); \
1620 } \
1621} while(0)
1622
1623#define ASSERTIF(C, X) \
1624do { \
1625 if (unlikely((C) && !(X))) { \
1626 printk(KERN_ERR "\n"); \
1627 printk(KERN_ERR "AFS: Assertion failed\n"); \
1628 BUG(); \
1629 } \
1630} while(0)
1631
1632#define ASSERTIFCMP(C, X, OP, Y) \
1633do { \
1634 if (unlikely((C) && !((X) OP (Y)))) { \
1635 printk(KERN_ERR "\n"); \
1636 printk(KERN_ERR "AFS: Assertion failed\n"); \
1637 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
1638 (unsigned long)(X), (unsigned long)(Y)); \
1639 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
1640 (unsigned long)(X), (unsigned long)(Y)); \
1641 BUG(); \
1642 } \
1643} while(0)
1644
1645#else
1646
1647#define ASSERT(X) \
1648do { \
1649} while(0)
1650
1651#define ASSERTCMP(X, OP, Y) \
1652do { \
1653} while(0)
1654
1655#define ASSERTRANGE(L, OP1, N, OP2, H) \
1656do { \
1657} while(0)
1658
1659#define ASSERTIF(C, X) \
1660do { \
1661} while(0)
1662
1663#define ASSERTIFCMP(C, X, OP, Y) \
1664do { \
1665} while(0)
1666
1667#endif /* __KDEBUGALL */
1/* internal AFS stuff
2 *
3 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12#include <linux/compiler.h>
13#include <linux/kernel.h>
14#include <linux/fs.h>
15#include <linux/pagemap.h>
16#include <linux/rxrpc.h>
17#include <linux/key.h>
18#include <linux/workqueue.h>
19#include <linux/sched.h>
20#include <linux/fscache.h>
21#include <linux/backing-dev.h>
22#include <net/af_rxrpc.h>
23
24#include "afs.h"
25#include "afs_vl.h"
26
27#define AFS_CELL_MAX_ADDRS 15
28
29struct pagevec;
30struct afs_call;
31
32typedef enum {
33 AFS_VL_NEW, /* new, uninitialised record */
34 AFS_VL_CREATING, /* creating record */
35 AFS_VL_VALID, /* record is pending */
36 AFS_VL_NO_VOLUME, /* no such volume available */
37 AFS_VL_UPDATING, /* update in progress */
38 AFS_VL_VOLUME_DELETED, /* volume was deleted */
39 AFS_VL_UNCERTAIN, /* uncertain state (update failed) */
40} __attribute__((packed)) afs_vlocation_state_t;
41
42struct afs_mount_params {
43 bool rwpath; /* T if the parent should be considered R/W */
44 bool force; /* T to force cell type */
45 bool autocell; /* T if set auto mount operation */
46 afs_voltype_t type; /* type of volume requested */
47 int volnamesz; /* size of volume name */
48 const char *volname; /* name of volume to mount */
49 struct afs_cell *cell; /* cell in which to find volume */
50 struct afs_volume *volume; /* volume record */
51 struct key *key; /* key to use for secure mounting */
52};
53
54/*
55 * definition of how to wait for the completion of an operation
56 */
57struct afs_wait_mode {
58 /* RxRPC received message notification */
59 rxrpc_notify_rx_t notify_rx;
60
61 /* synchronous call waiter and call dispatched notification */
62 int (*wait)(struct afs_call *call);
63
64 /* asynchronous call completion */
65 void (*async_complete)(void *reply, int error);
66};
67
68extern const struct afs_wait_mode afs_sync_call;
69extern const struct afs_wait_mode afs_async_call;
70
71/*
72 * a record of an in-progress RxRPC call
73 */
74struct afs_call {
75 const struct afs_call_type *type; /* type of call */
76 const struct afs_wait_mode *wait_mode; /* completion wait mode */
77 wait_queue_head_t waitq; /* processes awaiting completion */
78 struct work_struct async_work; /* asynchronous work processor */
79 struct work_struct work; /* actual work processor */
80 struct rxrpc_call *rxcall; /* RxRPC call handle */
81 struct key *key; /* security for this call */
82 struct afs_server *server; /* server affected by incoming CM call */
83 void *request; /* request data (first part) */
84 struct address_space *mapping; /* page set */
85 struct afs_writeback *wb; /* writeback being performed */
86 void *buffer; /* reply receive buffer */
87 void *reply; /* reply buffer (first part) */
88 void *reply2; /* reply buffer (second part) */
89 void *reply3; /* reply buffer (third part) */
90 void *reply4; /* reply buffer (fourth part) */
91 pgoff_t first; /* first page in mapping to deal with */
92 pgoff_t last; /* last page in mapping to deal with */
93 size_t offset; /* offset into received data store */
94 enum { /* call state */
95 AFS_CALL_REQUESTING, /* request is being sent for outgoing call */
96 AFS_CALL_AWAIT_REPLY, /* awaiting reply to outgoing call */
97 AFS_CALL_AWAIT_OP_ID, /* awaiting op ID on incoming call */
98 AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
99 AFS_CALL_REPLYING, /* replying to incoming call */
100 AFS_CALL_AWAIT_ACK, /* awaiting final ACK of incoming call */
101 AFS_CALL_COMPLETE, /* Completed or failed */
102 } state;
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 last_to; /* amount of mapping[last] */
109 unsigned char unmarshall; /* unmarshalling phase */
110 bool incoming; /* T if incoming call */
111 bool send_pages; /* T if data from mapping should be sent */
112 bool need_attention; /* T if RxRPC poked us */
113 u16 service_id; /* RxRPC service ID to call */
114 __be16 port; /* target UDP port */
115 u32 operation_ID; /* operation ID for an incoming call */
116 u32 count; /* count for use in unmarshalling */
117 __be32 tmp; /* place to extract temporary data */
118 afs_dataversion_t store_version; /* updated version expected from store */
119};
120
121struct afs_call_type {
122 const char *name;
123
124 /* deliver request or reply data to an call
125 * - returning an error will cause the call to be aborted
126 */
127 int (*deliver)(struct afs_call *call);
128
129 /* map an abort code to an error number */
130 int (*abort_to_error)(u32 abort_code);
131
132 /* clean up a call */
133 void (*destructor)(struct afs_call *call);
134};
135
136/*
137 * record of an outstanding writeback on a vnode
138 */
139struct afs_writeback {
140 struct list_head link; /* link in vnode->writebacks */
141 struct work_struct writer; /* work item to perform the writeback */
142 struct afs_vnode *vnode; /* vnode to which this write applies */
143 struct key *key; /* owner of this write */
144 wait_queue_head_t waitq; /* completion and ready wait queue */
145 pgoff_t first; /* first page in batch */
146 pgoff_t point; /* last page in current store op */
147 pgoff_t last; /* last page in batch (inclusive) */
148 unsigned offset_first; /* offset into first page of start of write */
149 unsigned to_last; /* offset into last page of end of write */
150 int num_conflicts; /* count of conflicting writes in list */
151 int usage;
152 bool conflicts; /* T if has dependent conflicts */
153 enum {
154 AFS_WBACK_SYNCING, /* synchronisation being performed */
155 AFS_WBACK_PENDING, /* write pending */
156 AFS_WBACK_CONFLICTING, /* conflicting writes posted */
157 AFS_WBACK_WRITING, /* writing back */
158 AFS_WBACK_COMPLETE /* the writeback record has been unlinked */
159 } state __attribute__((packed));
160};
161
162/*
163 * AFS superblock private data
164 * - there's one superblock per volume
165 */
166struct afs_super_info {
167 struct afs_volume *volume; /* volume record */
168 char rwparent; /* T if parent is R/W AFS volume */
169};
170
171static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
172{
173 return sb->s_fs_info;
174}
175
176extern struct file_system_type afs_fs_type;
177
178/*
179 * entry in the cached cell catalogue
180 */
181struct afs_cache_cell {
182 char name[AFS_MAXCELLNAME]; /* cell name (padded with NULs) */
183 struct in_addr vl_servers[15]; /* cached cell VL servers */
184};
185
186/*
187 * AFS cell record
188 */
189struct afs_cell {
190 atomic_t usage;
191 struct list_head link; /* main cell list link */
192 struct key *anonymous_key; /* anonymous user key for this cell */
193 struct list_head proc_link; /* /proc cell list link */
194#ifdef CONFIG_AFS_FSCACHE
195 struct fscache_cookie *cache; /* caching cookie */
196#endif
197
198 /* server record management */
199 rwlock_t servers_lock; /* active server list lock */
200 struct list_head servers; /* active server list */
201
202 /* volume location record management */
203 struct rw_semaphore vl_sem; /* volume management serialisation semaphore */
204 struct list_head vl_list; /* cell's active VL record list */
205 spinlock_t vl_lock; /* vl_list lock */
206 unsigned short vl_naddrs; /* number of VL servers in addr list */
207 unsigned short vl_curr_svix; /* current server index */
208 struct in_addr vl_addrs[AFS_CELL_MAX_ADDRS]; /* cell VL server addresses */
209
210 char name[0]; /* cell name - must go last */
211};
212
213/*
214 * entry in the cached volume location catalogue
215 */
216struct afs_cache_vlocation {
217 /* volume name (lowercase, padded with NULs) */
218 uint8_t name[AFS_MAXVOLNAME + 1];
219
220 uint8_t nservers; /* number of entries used in servers[] */
221 uint8_t vidmask; /* voltype mask for vid[] */
222 uint8_t srvtmask[8]; /* voltype masks for servers[] */
223#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
224#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
225#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
226
227 afs_volid_t vid[3]; /* volume IDs for R/W, R/O and Bak volumes */
228 struct in_addr servers[8]; /* fileserver addresses */
229 time_t rtime; /* last retrieval time */
230};
231
232/*
233 * volume -> vnode hash table entry
234 */
235struct afs_cache_vhash {
236 afs_voltype_t vtype; /* which volume variation */
237 uint8_t hash_bucket; /* which hash bucket this represents */
238} __attribute__((packed));
239
240/*
241 * AFS volume location record
242 */
243struct afs_vlocation {
244 atomic_t usage;
245 time_t time_of_death; /* time at which put reduced usage to 0 */
246 struct list_head link; /* link in cell volume location list */
247 struct list_head grave; /* link in master graveyard list */
248 struct list_head update; /* link in master update list */
249 struct afs_cell *cell; /* cell to which volume belongs */
250#ifdef CONFIG_AFS_FSCACHE
251 struct fscache_cookie *cache; /* caching cookie */
252#endif
253 struct afs_cache_vlocation vldb; /* volume information DB record */
254 struct afs_volume *vols[3]; /* volume access record pointer (index by type) */
255 wait_queue_head_t waitq; /* status change waitqueue */
256 time_t update_at; /* time at which record should be updated */
257 spinlock_t lock; /* access lock */
258 afs_vlocation_state_t state; /* volume location state */
259 unsigned short upd_rej_cnt; /* ENOMEDIUM count during update */
260 unsigned short upd_busy_cnt; /* EBUSY count during update */
261 bool valid; /* T if valid */
262};
263
264/*
265 * AFS fileserver record
266 */
267struct afs_server {
268 atomic_t usage;
269 time_t time_of_death; /* time at which put reduced usage to 0 */
270 struct in_addr addr; /* server address */
271 struct afs_cell *cell; /* cell in which server resides */
272 struct list_head link; /* link in cell's server list */
273 struct list_head grave; /* link in master graveyard list */
274 struct rb_node master_rb; /* link in master by-addr tree */
275 struct rw_semaphore sem; /* access lock */
276
277 /* file service access */
278 struct rb_root fs_vnodes; /* vnodes backed by this server (ordered by FID) */
279 unsigned long fs_act_jif; /* time at which last activity occurred */
280 unsigned long fs_dead_jif; /* time at which no longer to be considered dead */
281 spinlock_t fs_lock; /* access lock */
282 int fs_state; /* 0 or reason FS currently marked dead (-errno) */
283
284 /* callback promise management */
285 struct rb_root cb_promises; /* vnode expiration list (ordered earliest first) */
286 struct delayed_work cb_updater; /* callback updater */
287 struct delayed_work cb_break_work; /* collected break dispatcher */
288 wait_queue_head_t cb_break_waitq; /* space available in cb_break waitqueue */
289 spinlock_t cb_lock; /* access lock */
290 struct afs_callback cb_break[64]; /* ring of callbacks awaiting breaking */
291 atomic_t cb_break_n; /* number of pending breaks */
292 u8 cb_break_head; /* head of callback breaking ring */
293 u8 cb_break_tail; /* tail of callback breaking ring */
294};
295
296/*
297 * AFS volume access record
298 */
299struct afs_volume {
300 atomic_t usage;
301 struct afs_cell *cell; /* cell to which belongs (unrefd ptr) */
302 struct afs_vlocation *vlocation; /* volume location */
303#ifdef CONFIG_AFS_FSCACHE
304 struct fscache_cookie *cache; /* caching cookie */
305#endif
306 afs_volid_t vid; /* volume ID */
307 afs_voltype_t type; /* type of volume */
308 char type_force; /* force volume type (suppress R/O -> R/W) */
309 unsigned short nservers; /* number of server slots filled */
310 unsigned short rjservers; /* number of servers discarded due to -ENOMEDIUM */
311 struct afs_server *servers[8]; /* servers on which volume resides (ordered) */
312 struct rw_semaphore server_sem; /* lock for accessing current server */
313 struct backing_dev_info bdi;
314};
315
316/*
317 * vnode catalogue entry
318 */
319struct afs_cache_vnode {
320 afs_vnodeid_t vnode_id; /* vnode ID */
321 unsigned vnode_unique; /* vnode ID uniquifier */
322 afs_dataversion_t data_version; /* data version */
323};
324
325/*
326 * AFS inode private data
327 */
328struct afs_vnode {
329 struct inode vfs_inode; /* the VFS's inode record */
330
331 struct afs_volume *volume; /* volume on which vnode resides */
332 struct afs_server *server; /* server currently supplying this file */
333 struct afs_fid fid; /* the file identifier for this inode */
334 struct afs_file_status status; /* AFS status info for this file */
335#ifdef CONFIG_AFS_FSCACHE
336 struct fscache_cookie *cache; /* caching cookie */
337#endif
338 struct afs_permits *permits; /* cache of permits so far obtained */
339 struct mutex permits_lock; /* lock for altering permits list */
340 struct mutex validate_lock; /* lock for validating this vnode */
341 wait_queue_head_t update_waitq; /* status fetch waitqueue */
342 int update_cnt; /* number of outstanding ops that will update the
343 * status */
344 spinlock_t writeback_lock; /* lock for writebacks */
345 spinlock_t lock; /* waitqueue/flags lock */
346 unsigned long flags;
347#define AFS_VNODE_CB_BROKEN 0 /* set if vnode's callback was broken */
348#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
349#define AFS_VNODE_MODIFIED 2 /* set if vnode's data modified */
350#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
351#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
352#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
353#define AFS_VNODE_LOCKING 6 /* set if waiting for lock on vnode */
354#define AFS_VNODE_READLOCKED 7 /* set if vnode is read-locked on the server */
355#define AFS_VNODE_WRITELOCKED 8 /* set if vnode is write-locked on the server */
356#define AFS_VNODE_UNLOCKING 9 /* set if vnode is being unlocked on the server */
357#define AFS_VNODE_AUTOCELL 10 /* set if Vnode is an auto mount point */
358#define AFS_VNODE_PSEUDODIR 11 /* set if Vnode is a pseudo directory */
359
360 long acl_order; /* ACL check count (callback break count) */
361
362 struct list_head writebacks; /* alterations in pagecache that need writing */
363 struct list_head pending_locks; /* locks waiting to be granted */
364 struct list_head granted_locks; /* locks granted on this file */
365 struct delayed_work lock_work; /* work to be done in locking */
366 struct key *unlock_key; /* key to be used in unlocking */
367
368 /* outstanding callback notification on this file */
369 struct rb_node server_rb; /* link in server->fs_vnodes */
370 struct rb_node cb_promise; /* link in server->cb_promises */
371 struct work_struct cb_broken_work; /* work to be done on callback break */
372 time_t cb_expires; /* time at which callback expires */
373 time_t cb_expires_at; /* time used to order cb_promise */
374 unsigned cb_version; /* callback version */
375 unsigned cb_expiry; /* callback expiry time */
376 afs_callback_type_t cb_type; /* type of callback */
377 bool cb_promised; /* true if promise still holds */
378};
379
380/*
381 * cached security record for one user's attempt to access a vnode
382 */
383struct afs_permit {
384 struct key *key; /* RxRPC ticket holding a security context */
385 afs_access_t access_mask; /* access mask for this key */
386};
387
388/*
389 * cache of security records from attempts to access a vnode
390 */
391struct afs_permits {
392 struct rcu_head rcu; /* disposal procedure */
393 int count; /* number of records */
394 struct afs_permit permits[0]; /* the permits so far examined */
395};
396
397/*
398 * record of one of a system's set of network interfaces
399 */
400struct afs_interface {
401 struct in_addr address; /* IPv4 address bound to interface */
402 struct in_addr netmask; /* netmask applied to address */
403 unsigned mtu; /* MTU of interface */
404};
405
406/*
407 * UUID definition [internet draft]
408 * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
409 * increments since midnight 15th October 1582
410 * - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
411 * time
412 * - the clock sequence is a 14-bit counter to avoid duplicate times
413 */
414struct afs_uuid {
415 u32 time_low; /* low part of timestamp */
416 u16 time_mid; /* mid part of timestamp */
417 u16 time_hi_and_version; /* high part of timestamp and version */
418#define AFS_UUID_TO_UNIX_TIME 0x01b21dd213814000ULL
419#define AFS_UUID_TIMEHI_MASK 0x0fff
420#define AFS_UUID_VERSION_TIME 0x1000 /* time-based UUID */
421#define AFS_UUID_VERSION_NAME 0x3000 /* name-based UUID */
422#define AFS_UUID_VERSION_RANDOM 0x4000 /* (pseudo-)random generated UUID */
423 u8 clock_seq_hi_and_reserved; /* clock seq hi and variant */
424#define AFS_UUID_CLOCKHI_MASK 0x3f
425#define AFS_UUID_VARIANT_STD 0x80
426 u8 clock_seq_low; /* clock seq low */
427 u8 node[6]; /* spatially unique node ID (MAC addr) */
428};
429
430/*****************************************************************************/
431/*
432 * cache.c
433 */
434#ifdef CONFIG_AFS_FSCACHE
435extern struct fscache_netfs afs_cache_netfs;
436extern struct fscache_cookie_def afs_cell_cache_index_def;
437extern struct fscache_cookie_def afs_vlocation_cache_index_def;
438extern struct fscache_cookie_def afs_volume_cache_index_def;
439extern struct fscache_cookie_def afs_vnode_cache_index_def;
440#else
441#define afs_cell_cache_index_def (*(struct fscache_cookie_def *) NULL)
442#define afs_vlocation_cache_index_def (*(struct fscache_cookie_def *) NULL)
443#define afs_volume_cache_index_def (*(struct fscache_cookie_def *) NULL)
444#define afs_vnode_cache_index_def (*(struct fscache_cookie_def *) NULL)
445#endif
446
447/*
448 * callback.c
449 */
450extern void afs_init_callback_state(struct afs_server *);
451extern void afs_broken_callback_work(struct work_struct *);
452extern void afs_break_callbacks(struct afs_server *, size_t,
453 struct afs_callback[]);
454extern void afs_discard_callback_on_delete(struct afs_vnode *);
455extern void afs_give_up_callback(struct afs_vnode *);
456extern void afs_dispatch_give_up_callbacks(struct work_struct *);
457extern void afs_flush_callback_breaks(struct afs_server *);
458extern int __init afs_callback_update_init(void);
459extern void afs_callback_update_kill(void);
460
461/*
462 * cell.c
463 */
464extern struct rw_semaphore afs_proc_cells_sem;
465extern struct list_head afs_proc_cells;
466
467#define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
468extern int afs_cell_init(char *);
469extern struct afs_cell *afs_cell_create(const char *, unsigned, char *, bool);
470extern struct afs_cell *afs_cell_lookup(const char *, unsigned, bool);
471extern struct afs_cell *afs_grab_cell(struct afs_cell *);
472extern void afs_put_cell(struct afs_cell *);
473extern void afs_cell_purge(void);
474
475/*
476 * cmservice.c
477 */
478extern bool afs_cm_incoming_call(struct afs_call *);
479
480/*
481 * dir.c
482 */
483extern const struct inode_operations afs_dir_inode_operations;
484extern const struct dentry_operations afs_fs_dentry_operations;
485extern const struct file_operations afs_dir_file_operations;
486
487/*
488 * file.c
489 */
490extern const struct address_space_operations afs_fs_aops;
491extern const struct inode_operations afs_file_inode_operations;
492extern const struct file_operations afs_file_operations;
493
494extern int afs_open(struct inode *, struct file *);
495extern int afs_release(struct inode *, struct file *);
496extern int afs_page_filler(void *, struct page *);
497
498/*
499 * flock.c
500 */
501extern void __exit afs_kill_lock_manager(void);
502extern void afs_lock_work(struct work_struct *);
503extern void afs_lock_may_be_available(struct afs_vnode *);
504extern int afs_lock(struct file *, int, struct file_lock *);
505extern int afs_flock(struct file *, int, struct file_lock *);
506
507/*
508 * fsclient.c
509 */
510extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
511 struct afs_vnode *, struct afs_volsync *,
512 const struct afs_wait_mode *);
513extern int afs_fs_give_up_callbacks(struct afs_server *,
514 const struct afs_wait_mode *);
515extern int afs_fs_fetch_data(struct afs_server *, struct key *,
516 struct afs_vnode *, off_t, size_t, struct page *,
517 const struct afs_wait_mode *);
518extern int afs_fs_create(struct afs_server *, struct key *,
519 struct afs_vnode *, const char *, umode_t,
520 struct afs_fid *, struct afs_file_status *,
521 struct afs_callback *,
522 const struct afs_wait_mode *);
523extern int afs_fs_remove(struct afs_server *, struct key *,
524 struct afs_vnode *, const char *, bool,
525 const struct afs_wait_mode *);
526extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
527 struct afs_vnode *, const char *,
528 const struct afs_wait_mode *);
529extern int afs_fs_symlink(struct afs_server *, struct key *,
530 struct afs_vnode *, const char *, const char *,
531 struct afs_fid *, struct afs_file_status *,
532 const struct afs_wait_mode *);
533extern int afs_fs_rename(struct afs_server *, struct key *,
534 struct afs_vnode *, const char *,
535 struct afs_vnode *, const char *,
536 const struct afs_wait_mode *);
537extern int afs_fs_store_data(struct afs_server *, struct afs_writeback *,
538 pgoff_t, pgoff_t, unsigned, unsigned,
539 const struct afs_wait_mode *);
540extern int afs_fs_setattr(struct afs_server *, struct key *,
541 struct afs_vnode *, struct iattr *,
542 const struct afs_wait_mode *);
543extern int afs_fs_get_volume_status(struct afs_server *, struct key *,
544 struct afs_vnode *,
545 struct afs_volume_status *,
546 const struct afs_wait_mode *);
547extern int afs_fs_set_lock(struct afs_server *, struct key *,
548 struct afs_vnode *, afs_lock_type_t,
549 const struct afs_wait_mode *);
550extern int afs_fs_extend_lock(struct afs_server *, struct key *,
551 struct afs_vnode *,
552 const struct afs_wait_mode *);
553extern int afs_fs_release_lock(struct afs_server *, struct key *,
554 struct afs_vnode *,
555 const struct afs_wait_mode *);
556
557/*
558 * inode.c
559 */
560extern struct inode *afs_iget_autocell(struct inode *, const char *, int,
561 struct key *);
562extern struct inode *afs_iget(struct super_block *, struct key *,
563 struct afs_fid *, struct afs_file_status *,
564 struct afs_callback *);
565extern void afs_zap_data(struct afs_vnode *);
566extern int afs_validate(struct afs_vnode *, struct key *);
567extern int afs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
568extern int afs_setattr(struct dentry *, struct iattr *);
569extern void afs_evict_inode(struct inode *);
570extern int afs_drop_inode(struct inode *);
571
572/*
573 * main.c
574 */
575extern struct workqueue_struct *afs_wq;
576extern struct afs_uuid afs_uuid;
577
578/*
579 * misc.c
580 */
581extern int afs_abort_to_error(u32);
582
583/*
584 * mntpt.c
585 */
586extern const struct inode_operations afs_mntpt_inode_operations;
587extern const struct inode_operations afs_autocell_inode_operations;
588extern const struct file_operations afs_mntpt_file_operations;
589
590extern struct vfsmount *afs_d_automount(struct path *);
591extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
592extern void afs_mntpt_kill_timer(void);
593
594/*
595 * proc.c
596 */
597extern int afs_proc_init(void);
598extern void afs_proc_cleanup(void);
599extern int afs_proc_cell_setup(struct afs_cell *);
600extern void afs_proc_cell_remove(struct afs_cell *);
601
602/*
603 * rxrpc.c
604 */
605extern struct socket *afs_socket;
606
607extern int afs_open_socket(void);
608extern void afs_close_socket(void);
609extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
610 const struct afs_wait_mode *);
611extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
612 size_t, size_t);
613extern void afs_flat_call_destructor(struct afs_call *);
614extern void afs_send_empty_reply(struct afs_call *);
615extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
616extern int afs_extract_data(struct afs_call *, void *, size_t, bool);
617
618static inline int afs_transfer_reply(struct afs_call *call)
619{
620 return afs_extract_data(call, call->buffer, call->reply_max, false);
621}
622
623/*
624 * security.c
625 */
626extern void afs_clear_permits(struct afs_vnode *);
627extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
628extern void afs_zap_permits(struct rcu_head *);
629extern struct key *afs_request_key(struct afs_cell *);
630extern int afs_permission(struct inode *, int);
631
632/*
633 * server.c
634 */
635extern spinlock_t afs_server_peer_lock;
636
637#define afs_get_server(S) \
638do { \
639 _debug("GET SERVER %d", atomic_read(&(S)->usage)); \
640 atomic_inc(&(S)->usage); \
641} while(0)
642
643extern struct afs_server *afs_lookup_server(struct afs_cell *,
644 const struct in_addr *);
645extern struct afs_server *afs_find_server(const struct sockaddr_rxrpc *);
646extern void afs_put_server(struct afs_server *);
647extern void __exit afs_purge_servers(void);
648
649/*
650 * super.c
651 */
652extern int afs_fs_init(void);
653extern void afs_fs_exit(void);
654
655/*
656 * use-rtnetlink.c
657 */
658extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
659extern int afs_get_MAC_address(u8 *, size_t);
660
661/*
662 * vlclient.c
663 */
664extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
665 const char *, struct afs_cache_vlocation *,
666 const struct afs_wait_mode *);
667extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
668 afs_volid_t, afs_voltype_t,
669 struct afs_cache_vlocation *,
670 const struct afs_wait_mode *);
671
672/*
673 * vlocation.c
674 */
675#define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
676
677extern int __init afs_vlocation_update_init(void);
678extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
679 struct key *,
680 const char *, size_t);
681extern void afs_put_vlocation(struct afs_vlocation *);
682extern void afs_vlocation_purge(void);
683
684/*
685 * vnode.c
686 */
687static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
688{
689 return container_of(inode, struct afs_vnode, vfs_inode);
690}
691
692static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
693{
694 return &vnode->vfs_inode;
695}
696
697extern void afs_vnode_finalise_status_update(struct afs_vnode *,
698 struct afs_server *);
699extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
700 struct key *);
701extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
702 off_t, size_t, struct page *);
703extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
704 umode_t, struct afs_fid *, struct afs_file_status *,
705 struct afs_callback *, struct afs_server **);
706extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
707 bool);
708extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
709 const char *);
710extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
711 const char *, struct afs_fid *,
712 struct afs_file_status *, struct afs_server **);
713extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
714 struct key *, const char *, const char *);
715extern int afs_vnode_store_data(struct afs_writeback *, pgoff_t, pgoff_t,
716 unsigned, unsigned);
717extern int afs_vnode_setattr(struct afs_vnode *, struct key *, struct iattr *);
718extern int afs_vnode_get_volume_status(struct afs_vnode *, struct key *,
719 struct afs_volume_status *);
720extern int afs_vnode_set_lock(struct afs_vnode *, struct key *,
721 afs_lock_type_t);
722extern int afs_vnode_extend_lock(struct afs_vnode *, struct key *);
723extern int afs_vnode_release_lock(struct afs_vnode *, struct key *);
724
725/*
726 * volume.c
727 */
728#define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
729
730extern void afs_put_volume(struct afs_volume *);
731extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
732extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
733extern int afs_volume_release_fileserver(struct afs_vnode *,
734 struct afs_server *, int);
735
736/*
737 * write.c
738 */
739extern int afs_set_page_dirty(struct page *);
740extern void afs_put_writeback(struct afs_writeback *);
741extern int afs_write_begin(struct file *file, struct address_space *mapping,
742 loff_t pos, unsigned len, unsigned flags,
743 struct page **pagep, void **fsdata);
744extern int afs_write_end(struct file *file, struct address_space *mapping,
745 loff_t pos, unsigned len, unsigned copied,
746 struct page *page, void *fsdata);
747extern int afs_writepage(struct page *, struct writeback_control *);
748extern int afs_writepages(struct address_space *, struct writeback_control *);
749extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
750extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
751extern int afs_writeback_all(struct afs_vnode *);
752extern int afs_fsync(struct file *, loff_t, loff_t, int);
753
754
755/*****************************************************************************/
756/*
757 * debug tracing
758 */
759extern unsigned afs_debug;
760
761#define dbgprintk(FMT,...) \
762 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
763
764#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
765#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
766#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
767
768
769#if defined(__KDEBUG)
770#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
771#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
772#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
773
774#elif defined(CONFIG_AFS_DEBUG)
775#define AFS_DEBUG_KENTER 0x01
776#define AFS_DEBUG_KLEAVE 0x02
777#define AFS_DEBUG_KDEBUG 0x04
778
779#define _enter(FMT,...) \
780do { \
781 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
782 kenter(FMT,##__VA_ARGS__); \
783} while (0)
784
785#define _leave(FMT,...) \
786do { \
787 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
788 kleave(FMT,##__VA_ARGS__); \
789} while (0)
790
791#define _debug(FMT,...) \
792do { \
793 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
794 kdebug(FMT,##__VA_ARGS__); \
795} while (0)
796
797#else
798#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
799#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
800#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
801#endif
802
803/*
804 * debug assertion checking
805 */
806#if 1 // defined(__KDEBUGALL)
807
808#define ASSERT(X) \
809do { \
810 if (unlikely(!(X))) { \
811 printk(KERN_ERR "\n"); \
812 printk(KERN_ERR "AFS: Assertion failed\n"); \
813 BUG(); \
814 } \
815} while(0)
816
817#define ASSERTCMP(X, OP, Y) \
818do { \
819 if (unlikely(!((X) OP (Y)))) { \
820 printk(KERN_ERR "\n"); \
821 printk(KERN_ERR "AFS: Assertion failed\n"); \
822 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
823 (unsigned long)(X), (unsigned long)(Y)); \
824 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
825 (unsigned long)(X), (unsigned long)(Y)); \
826 BUG(); \
827 } \
828} while(0)
829
830#define ASSERTRANGE(L, OP1, N, OP2, H) \
831do { \
832 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
833 printk(KERN_ERR "\n"); \
834 printk(KERN_ERR "AFS: Assertion failed\n"); \
835 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
836 (unsigned long)(L), (unsigned long)(N), \
837 (unsigned long)(H)); \
838 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
839 (unsigned long)(L), (unsigned long)(N), \
840 (unsigned long)(H)); \
841 BUG(); \
842 } \
843} while(0)
844
845#define ASSERTIF(C, X) \
846do { \
847 if (unlikely((C) && !(X))) { \
848 printk(KERN_ERR "\n"); \
849 printk(KERN_ERR "AFS: Assertion failed\n"); \
850 BUG(); \
851 } \
852} while(0)
853
854#define ASSERTIFCMP(C, X, OP, Y) \
855do { \
856 if (unlikely((C) && !((X) OP (Y)))) { \
857 printk(KERN_ERR "\n"); \
858 printk(KERN_ERR "AFS: Assertion failed\n"); \
859 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
860 (unsigned long)(X), (unsigned long)(Y)); \
861 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
862 (unsigned long)(X), (unsigned long)(Y)); \
863 BUG(); \
864 } \
865} while(0)
866
867#else
868
869#define ASSERT(X) \
870do { \
871} while(0)
872
873#define ASSERTCMP(X, OP, Y) \
874do { \
875} while(0)
876
877#define ASSERTRANGE(L, OP1, N, OP2, H) \
878do { \
879} while(0)
880
881#define ASSERTIF(C, X) \
882do { \
883} while(0)
884
885#define ASSERTIFCMP(C, X, OP, Y) \
886do { \
887} while(0)
888
889#endif /* __KDEBUGALL */