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