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/rxrpc.h>
17#include <linux/key.h>
18#include <linux/workqueue.h>
19#include <linux/sched.h>
20#include <linux/fscache.h>
21#include <linux/backing-dev.h>
22#include <net/af_rxrpc.h>
23
24#include "afs.h"
25#include "afs_vl.h"
26
27#define AFS_CELL_MAX_ADDRS 15
28
29struct pagevec;
30struct afs_call;
31
32typedef enum {
33 AFS_VL_NEW, /* new, uninitialised record */
34 AFS_VL_CREATING, /* creating record */
35 AFS_VL_VALID, /* record is pending */
36 AFS_VL_NO_VOLUME, /* no such volume available */
37 AFS_VL_UPDATING, /* update in progress */
38 AFS_VL_VOLUME_DELETED, /* volume was deleted */
39 AFS_VL_UNCERTAIN, /* uncertain state (update failed) */
40} __attribute__((packed)) afs_vlocation_state_t;
41
42struct afs_mount_params {
43 bool rwpath; /* T if the parent should be considered R/W */
44 bool force; /* T to force cell type */
45 bool autocell; /* T if set auto mount operation */
46 afs_voltype_t type; /* type of volume requested */
47 int volnamesz; /* size of volume name */
48 const char *volname; /* name of volume to mount */
49 struct afs_cell *cell; /* cell in which to find volume */
50 struct afs_volume *volume; /* volume record */
51 struct key *key; /* key to use for secure mounting */
52};
53
54/*
55 * definition of how to wait for the completion of an operation
56 */
57struct afs_wait_mode {
58 /* RxRPC received message notification */
59 rxrpc_notify_rx_t notify_rx;
60
61 /* synchronous call waiter and call dispatched notification */
62 int (*wait)(struct afs_call *call);
63
64 /* asynchronous call completion */
65 void (*async_complete)(void *reply, int error);
66};
67
68extern const struct afs_wait_mode afs_sync_call;
69extern const struct afs_wait_mode afs_async_call;
70
71/*
72 * a record of an in-progress RxRPC call
73 */
74struct afs_call {
75 const struct afs_call_type *type; /* type of call */
76 const struct afs_wait_mode *wait_mode; /* completion wait mode */
77 wait_queue_head_t waitq; /* processes awaiting completion */
78 struct work_struct async_work; /* asynchronous work processor */
79 struct work_struct work; /* actual work processor */
80 struct rxrpc_call *rxcall; /* RxRPC call handle */
81 struct key *key; /* security for this call */
82 struct afs_server *server; /* server affected by incoming CM call */
83 void *request; /* request data (first part) */
84 struct address_space *mapping; /* page set */
85 struct afs_writeback *wb; /* writeback being performed */
86 void *buffer; /* reply receive buffer */
87 void *reply; /* reply buffer (first part) */
88 void *reply2; /* reply buffer (second part) */
89 void *reply3; /* reply buffer (third part) */
90 void *reply4; /* reply buffer (fourth part) */
91 pgoff_t first; /* first page in mapping to deal with */
92 pgoff_t last; /* last page in mapping to deal with */
93 size_t offset; /* offset into received data store */
94 enum { /* call state */
95 AFS_CALL_REQUESTING, /* request is being sent for outgoing call */
96 AFS_CALL_AWAIT_REPLY, /* awaiting reply to outgoing call */
97 AFS_CALL_AWAIT_OP_ID, /* awaiting op ID on incoming call */
98 AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
99 AFS_CALL_REPLYING, /* replying to incoming call */
100 AFS_CALL_AWAIT_ACK, /* awaiting final ACK of incoming call */
101 AFS_CALL_COMPLETE, /* Completed or failed */
102 } state;
103 int error; /* error code */
104 u32 abort_code; /* Remote abort ID or 0 */
105 unsigned request_size; /* size of request data */
106 unsigned reply_max; /* maximum size of reply */
107 unsigned first_offset; /* offset into mapping[first] */
108 unsigned last_to; /* amount of mapping[last] */
109 unsigned char unmarshall; /* unmarshalling phase */
110 bool incoming; /* T if incoming call */
111 bool send_pages; /* T if data from mapping should be sent */
112 bool need_attention; /* T if RxRPC poked us */
113 u16 service_id; /* RxRPC service ID to call */
114 __be16 port; /* target UDP port */
115 u32 operation_ID; /* operation ID for an incoming call */
116 u32 count; /* count for use in unmarshalling */
117 __be32 tmp; /* place to extract temporary data */
118 afs_dataversion_t store_version; /* updated version expected from store */
119};
120
121struct afs_call_type {
122 const char *name;
123
124 /* deliver request or reply data to an call
125 * - returning an error will cause the call to be aborted
126 */
127 int (*deliver)(struct afs_call *call);
128
129 /* map an abort code to an error number */
130 int (*abort_to_error)(u32 abort_code);
131
132 /* clean up a call */
133 void (*destructor)(struct afs_call *call);
134};
135
136/*
137 * record of an outstanding writeback on a vnode
138 */
139struct afs_writeback {
140 struct list_head link; /* link in vnode->writebacks */
141 struct work_struct writer; /* work item to perform the writeback */
142 struct afs_vnode *vnode; /* vnode to which this write applies */
143 struct key *key; /* owner of this write */
144 wait_queue_head_t waitq; /* completion and ready wait queue */
145 pgoff_t first; /* first page in batch */
146 pgoff_t point; /* last page in current store op */
147 pgoff_t last; /* last page in batch (inclusive) */
148 unsigned offset_first; /* offset into first page of start of write */
149 unsigned to_last; /* offset into last page of end of write */
150 int num_conflicts; /* count of conflicting writes in list */
151 int usage;
152 bool conflicts; /* T if has dependent conflicts */
153 enum {
154 AFS_WBACK_SYNCING, /* synchronisation being performed */
155 AFS_WBACK_PENDING, /* write pending */
156 AFS_WBACK_CONFLICTING, /* conflicting writes posted */
157 AFS_WBACK_WRITING, /* writing back */
158 AFS_WBACK_COMPLETE /* the writeback record has been unlinked */
159 } state __attribute__((packed));
160};
161
162/*
163 * AFS superblock private data
164 * - there's one superblock per volume
165 */
166struct afs_super_info {
167 struct afs_volume *volume; /* volume record */
168 char rwparent; /* T if parent is R/W AFS volume */
169};
170
171static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
172{
173 return sb->s_fs_info;
174}
175
176extern struct file_system_type afs_fs_type;
177
178/*
179 * entry in the cached cell catalogue
180 */
181struct afs_cache_cell {
182 char name[AFS_MAXCELLNAME]; /* cell name (padded with NULs) */
183 struct in_addr vl_servers[15]; /* cached cell VL servers */
184};
185
186/*
187 * AFS cell record
188 */
189struct afs_cell {
190 atomic_t usage;
191 struct list_head link; /* main cell list link */
192 struct key *anonymous_key; /* anonymous user key for this cell */
193 struct list_head proc_link; /* /proc cell list link */
194#ifdef CONFIG_AFS_FSCACHE
195 struct fscache_cookie *cache; /* caching cookie */
196#endif
197
198 /* server record management */
199 rwlock_t servers_lock; /* active server list lock */
200 struct list_head servers; /* active server list */
201
202 /* volume location record management */
203 struct rw_semaphore vl_sem; /* volume management serialisation semaphore */
204 struct list_head vl_list; /* cell's active VL record list */
205 spinlock_t vl_lock; /* vl_list lock */
206 unsigned short vl_naddrs; /* number of VL servers in addr list */
207 unsigned short vl_curr_svix; /* current server index */
208 struct in_addr vl_addrs[AFS_CELL_MAX_ADDRS]; /* cell VL server addresses */
209
210 char name[0]; /* cell name - must go last */
211};
212
213/*
214 * entry in the cached volume location catalogue
215 */
216struct afs_cache_vlocation {
217 /* volume name (lowercase, padded with NULs) */
218 uint8_t name[AFS_MAXVOLNAME + 1];
219
220 uint8_t nservers; /* number of entries used in servers[] */
221 uint8_t vidmask; /* voltype mask for vid[] */
222 uint8_t srvtmask[8]; /* voltype masks for servers[] */
223#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
224#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
225#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
226
227 afs_volid_t vid[3]; /* volume IDs for R/W, R/O and Bak volumes */
228 struct in_addr servers[8]; /* fileserver addresses */
229 time_t rtime; /* last retrieval time */
230};
231
232/*
233 * volume -> vnode hash table entry
234 */
235struct afs_cache_vhash {
236 afs_voltype_t vtype; /* which volume variation */
237 uint8_t hash_bucket; /* which hash bucket this represents */
238} __attribute__((packed));
239
240/*
241 * AFS volume location record
242 */
243struct afs_vlocation {
244 atomic_t usage;
245 time_t time_of_death; /* time at which put reduced usage to 0 */
246 struct list_head link; /* link in cell volume location list */
247 struct list_head grave; /* link in master graveyard list */
248 struct list_head update; /* link in master update list */
249 struct afs_cell *cell; /* cell to which volume belongs */
250#ifdef CONFIG_AFS_FSCACHE
251 struct fscache_cookie *cache; /* caching cookie */
252#endif
253 struct afs_cache_vlocation vldb; /* volume information DB record */
254 struct afs_volume *vols[3]; /* volume access record pointer (index by type) */
255 wait_queue_head_t waitq; /* status change waitqueue */
256 time_t update_at; /* time at which record should be updated */
257 spinlock_t lock; /* access lock */
258 afs_vlocation_state_t state; /* volume location state */
259 unsigned short upd_rej_cnt; /* ENOMEDIUM count during update */
260 unsigned short upd_busy_cnt; /* EBUSY count during update */
261 bool valid; /* T if valid */
262};
263
264/*
265 * AFS fileserver record
266 */
267struct afs_server {
268 atomic_t usage;
269 time_t time_of_death; /* time at which put reduced usage to 0 */
270 struct in_addr addr; /* server address */
271 struct afs_cell *cell; /* cell in which server resides */
272 struct list_head link; /* link in cell's server list */
273 struct list_head grave; /* link in master graveyard list */
274 struct rb_node master_rb; /* link in master by-addr tree */
275 struct rw_semaphore sem; /* access lock */
276
277 /* file service access */
278 struct rb_root fs_vnodes; /* vnodes backed by this server (ordered by FID) */
279 unsigned long fs_act_jif; /* time at which last activity occurred */
280 unsigned long fs_dead_jif; /* time at which no longer to be considered dead */
281 spinlock_t fs_lock; /* access lock */
282 int fs_state; /* 0 or reason FS currently marked dead (-errno) */
283
284 /* callback promise management */
285 struct rb_root cb_promises; /* vnode expiration list (ordered earliest first) */
286 struct delayed_work cb_updater; /* callback updater */
287 struct delayed_work cb_break_work; /* collected break dispatcher */
288 wait_queue_head_t cb_break_waitq; /* space available in cb_break waitqueue */
289 spinlock_t cb_lock; /* access lock */
290 struct afs_callback cb_break[64]; /* ring of callbacks awaiting breaking */
291 atomic_t cb_break_n; /* number of pending breaks */
292 u8 cb_break_head; /* head of callback breaking ring */
293 u8 cb_break_tail; /* tail of callback breaking ring */
294};
295
296/*
297 * AFS volume access record
298 */
299struct afs_volume {
300 atomic_t usage;
301 struct afs_cell *cell; /* cell to which belongs (unrefd ptr) */
302 struct afs_vlocation *vlocation; /* volume location */
303#ifdef CONFIG_AFS_FSCACHE
304 struct fscache_cookie *cache; /* caching cookie */
305#endif
306 afs_volid_t vid; /* volume ID */
307 afs_voltype_t type; /* type of volume */
308 char type_force; /* force volume type (suppress R/O -> R/W) */
309 unsigned short nservers; /* number of server slots filled */
310 unsigned short rjservers; /* number of servers discarded due to -ENOMEDIUM */
311 struct afs_server *servers[8]; /* servers on which volume resides (ordered) */
312 struct rw_semaphore server_sem; /* lock for accessing current server */
313 struct backing_dev_info bdi;
314};
315
316/*
317 * vnode catalogue entry
318 */
319struct afs_cache_vnode {
320 afs_vnodeid_t vnode_id; /* vnode ID */
321 unsigned vnode_unique; /* vnode ID uniquifier */
322 afs_dataversion_t data_version; /* data version */
323};
324
325/*
326 * AFS inode private data
327 */
328struct afs_vnode {
329 struct inode vfs_inode; /* the VFS's inode record */
330
331 struct afs_volume *volume; /* volume on which vnode resides */
332 struct afs_server *server; /* server currently supplying this file */
333 struct afs_fid fid; /* the file identifier for this inode */
334 struct afs_file_status status; /* AFS status info for this file */
335#ifdef CONFIG_AFS_FSCACHE
336 struct fscache_cookie *cache; /* caching cookie */
337#endif
338 struct afs_permits *permits; /* cache of permits so far obtained */
339 struct mutex permits_lock; /* lock for altering permits list */
340 struct mutex validate_lock; /* lock for validating this vnode */
341 wait_queue_head_t update_waitq; /* status fetch waitqueue */
342 int update_cnt; /* number of outstanding ops that will update the
343 * status */
344 spinlock_t writeback_lock; /* lock for writebacks */
345 spinlock_t lock; /* waitqueue/flags lock */
346 unsigned long flags;
347#define AFS_VNODE_CB_BROKEN 0 /* set if vnode's callback was broken */
348#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
349#define AFS_VNODE_MODIFIED 2 /* set if vnode's data modified */
350#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
351#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
352#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
353#define AFS_VNODE_LOCKING 6 /* set if waiting for lock on vnode */
354#define AFS_VNODE_READLOCKED 7 /* set if vnode is read-locked on the server */
355#define AFS_VNODE_WRITELOCKED 8 /* set if vnode is write-locked on the server */
356#define AFS_VNODE_UNLOCKING 9 /* set if vnode is being unlocked on the server */
357#define AFS_VNODE_AUTOCELL 10 /* set if Vnode is an auto mount point */
358#define AFS_VNODE_PSEUDODIR 11 /* set if Vnode is a pseudo directory */
359
360 long acl_order; /* ACL check count (callback break count) */
361
362 struct list_head writebacks; /* alterations in pagecache that need writing */
363 struct list_head pending_locks; /* locks waiting to be granted */
364 struct list_head granted_locks; /* locks granted on this file */
365 struct delayed_work lock_work; /* work to be done in locking */
366 struct key *unlock_key; /* key to be used in unlocking */
367
368 /* outstanding callback notification on this file */
369 struct rb_node server_rb; /* link in server->fs_vnodes */
370 struct rb_node cb_promise; /* link in server->cb_promises */
371 struct work_struct cb_broken_work; /* work to be done on callback break */
372 time_t cb_expires; /* time at which callback expires */
373 time_t cb_expires_at; /* time used to order cb_promise */
374 unsigned cb_version; /* callback version */
375 unsigned cb_expiry; /* callback expiry time */
376 afs_callback_type_t cb_type; /* type of callback */
377 bool cb_promised; /* true if promise still holds */
378};
379
380/*
381 * cached security record for one user's attempt to access a vnode
382 */
383struct afs_permit {
384 struct key *key; /* RxRPC ticket holding a security context */
385 afs_access_t access_mask; /* access mask for this key */
386};
387
388/*
389 * cache of security records from attempts to access a vnode
390 */
391struct afs_permits {
392 struct rcu_head rcu; /* disposal procedure */
393 int count; /* number of records */
394 struct afs_permit permits[0]; /* the permits so far examined */
395};
396
397/*
398 * record of one of a system's set of network interfaces
399 */
400struct afs_interface {
401 struct in_addr address; /* IPv4 address bound to interface */
402 struct in_addr netmask; /* netmask applied to address */
403 unsigned mtu; /* MTU of interface */
404};
405
406/*
407 * UUID definition [internet draft]
408 * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
409 * increments since midnight 15th October 1582
410 * - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
411 * time
412 * - the clock sequence is a 14-bit counter to avoid duplicate times
413 */
414struct afs_uuid {
415 u32 time_low; /* low part of timestamp */
416 u16 time_mid; /* mid part of timestamp */
417 u16 time_hi_and_version; /* high part of timestamp and version */
418#define AFS_UUID_TO_UNIX_TIME 0x01b21dd213814000ULL
419#define AFS_UUID_TIMEHI_MASK 0x0fff
420#define AFS_UUID_VERSION_TIME 0x1000 /* time-based UUID */
421#define AFS_UUID_VERSION_NAME 0x3000 /* name-based UUID */
422#define AFS_UUID_VERSION_RANDOM 0x4000 /* (pseudo-)random generated UUID */
423 u8 clock_seq_hi_and_reserved; /* clock seq hi and variant */
424#define AFS_UUID_CLOCKHI_MASK 0x3f
425#define AFS_UUID_VARIANT_STD 0x80
426 u8 clock_seq_low; /* clock seq low */
427 u8 node[6]; /* spatially unique node ID (MAC addr) */
428};
429
430/*****************************************************************************/
431/*
432 * cache.c
433 */
434#ifdef CONFIG_AFS_FSCACHE
435extern struct fscache_netfs afs_cache_netfs;
436extern struct fscache_cookie_def afs_cell_cache_index_def;
437extern struct fscache_cookie_def afs_vlocation_cache_index_def;
438extern struct fscache_cookie_def afs_volume_cache_index_def;
439extern struct fscache_cookie_def afs_vnode_cache_index_def;
440#else
441#define afs_cell_cache_index_def (*(struct fscache_cookie_def *) NULL)
442#define afs_vlocation_cache_index_def (*(struct fscache_cookie_def *) NULL)
443#define afs_volume_cache_index_def (*(struct fscache_cookie_def *) NULL)
444#define afs_vnode_cache_index_def (*(struct fscache_cookie_def *) NULL)
445#endif
446
447/*
448 * callback.c
449 */
450extern void afs_init_callback_state(struct afs_server *);
451extern void afs_broken_callback_work(struct work_struct *);
452extern void afs_break_callbacks(struct afs_server *, size_t,
453 struct afs_callback[]);
454extern void afs_discard_callback_on_delete(struct afs_vnode *);
455extern void afs_give_up_callback(struct afs_vnode *);
456extern void afs_dispatch_give_up_callbacks(struct work_struct *);
457extern void afs_flush_callback_breaks(struct afs_server *);
458extern int __init afs_callback_update_init(void);
459extern void afs_callback_update_kill(void);
460
461/*
462 * cell.c
463 */
464extern struct rw_semaphore afs_proc_cells_sem;
465extern struct list_head afs_proc_cells;
466
467#define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
468extern int afs_cell_init(char *);
469extern struct afs_cell *afs_cell_create(const char *, unsigned, char *, bool);
470extern struct afs_cell *afs_cell_lookup(const char *, unsigned, bool);
471extern struct afs_cell *afs_grab_cell(struct afs_cell *);
472extern void afs_put_cell(struct afs_cell *);
473extern void afs_cell_purge(void);
474
475/*
476 * cmservice.c
477 */
478extern bool afs_cm_incoming_call(struct afs_call *);
479
480/*
481 * dir.c
482 */
483extern const struct inode_operations afs_dir_inode_operations;
484extern const struct dentry_operations afs_fs_dentry_operations;
485extern const struct file_operations afs_dir_file_operations;
486
487/*
488 * file.c
489 */
490extern const struct address_space_operations afs_fs_aops;
491extern const struct inode_operations afs_file_inode_operations;
492extern const struct file_operations afs_file_operations;
493
494extern int afs_open(struct inode *, struct file *);
495extern int afs_release(struct inode *, struct file *);
496extern int afs_page_filler(void *, struct page *);
497
498/*
499 * flock.c
500 */
501extern void __exit afs_kill_lock_manager(void);
502extern void afs_lock_work(struct work_struct *);
503extern void afs_lock_may_be_available(struct afs_vnode *);
504extern int afs_lock(struct file *, int, struct file_lock *);
505extern int afs_flock(struct file *, int, struct file_lock *);
506
507/*
508 * fsclient.c
509 */
510extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
511 struct afs_vnode *, struct afs_volsync *,
512 const struct afs_wait_mode *);
513extern int afs_fs_give_up_callbacks(struct afs_server *,
514 const struct afs_wait_mode *);
515extern int afs_fs_fetch_data(struct afs_server *, struct key *,
516 struct afs_vnode *, off_t, size_t, struct page *,
517 const struct afs_wait_mode *);
518extern int afs_fs_create(struct afs_server *, struct key *,
519 struct afs_vnode *, const char *, umode_t,
520 struct afs_fid *, struct afs_file_status *,
521 struct afs_callback *,
522 const struct afs_wait_mode *);
523extern int afs_fs_remove(struct afs_server *, struct key *,
524 struct afs_vnode *, const char *, bool,
525 const struct afs_wait_mode *);
526extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
527 struct afs_vnode *, const char *,
528 const struct afs_wait_mode *);
529extern int afs_fs_symlink(struct afs_server *, struct key *,
530 struct afs_vnode *, const char *, const char *,
531 struct afs_fid *, struct afs_file_status *,
532 const struct afs_wait_mode *);
533extern int afs_fs_rename(struct afs_server *, struct key *,
534 struct afs_vnode *, const char *,
535 struct afs_vnode *, const char *,
536 const struct afs_wait_mode *);
537extern int afs_fs_store_data(struct afs_server *, struct afs_writeback *,
538 pgoff_t, pgoff_t, unsigned, unsigned,
539 const struct afs_wait_mode *);
540extern int afs_fs_setattr(struct afs_server *, struct key *,
541 struct afs_vnode *, struct iattr *,
542 const struct afs_wait_mode *);
543extern int afs_fs_get_volume_status(struct afs_server *, struct key *,
544 struct afs_vnode *,
545 struct afs_volume_status *,
546 const struct afs_wait_mode *);
547extern int afs_fs_set_lock(struct afs_server *, struct key *,
548 struct afs_vnode *, afs_lock_type_t,
549 const struct afs_wait_mode *);
550extern int afs_fs_extend_lock(struct afs_server *, struct key *,
551 struct afs_vnode *,
552 const struct afs_wait_mode *);
553extern int afs_fs_release_lock(struct afs_server *, struct key *,
554 struct afs_vnode *,
555 const struct afs_wait_mode *);
556
557/*
558 * inode.c
559 */
560extern struct inode *afs_iget_autocell(struct inode *, const char *, int,
561 struct key *);
562extern struct inode *afs_iget(struct super_block *, struct key *,
563 struct afs_fid *, struct afs_file_status *,
564 struct afs_callback *);
565extern void afs_zap_data(struct afs_vnode *);
566extern int afs_validate(struct afs_vnode *, struct key *);
567extern int afs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
568extern int afs_setattr(struct dentry *, struct iattr *);
569extern void afs_evict_inode(struct inode *);
570extern int afs_drop_inode(struct inode *);
571
572/*
573 * main.c
574 */
575extern struct workqueue_struct *afs_wq;
576extern struct afs_uuid afs_uuid;
577
578/*
579 * misc.c
580 */
581extern int afs_abort_to_error(u32);
582
583/*
584 * mntpt.c
585 */
586extern const struct inode_operations afs_mntpt_inode_operations;
587extern const struct inode_operations afs_autocell_inode_operations;
588extern const struct file_operations afs_mntpt_file_operations;
589
590extern struct vfsmount *afs_d_automount(struct path *);
591extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
592extern void afs_mntpt_kill_timer(void);
593
594/*
595 * proc.c
596 */
597extern int afs_proc_init(void);
598extern void afs_proc_cleanup(void);
599extern int afs_proc_cell_setup(struct afs_cell *);
600extern void afs_proc_cell_remove(struct afs_cell *);
601
602/*
603 * rxrpc.c
604 */
605extern struct socket *afs_socket;
606
607extern int afs_open_socket(void);
608extern void afs_close_socket(void);
609extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
610 const struct afs_wait_mode *);
611extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
612 size_t, size_t);
613extern void afs_flat_call_destructor(struct afs_call *);
614extern void afs_send_empty_reply(struct afs_call *);
615extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
616extern int afs_extract_data(struct afs_call *, void *, size_t, bool);
617
618static inline int afs_transfer_reply(struct afs_call *call)
619{
620 return afs_extract_data(call, call->buffer, call->reply_max, false);
621}
622
623/*
624 * security.c
625 */
626extern void afs_clear_permits(struct afs_vnode *);
627extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
628extern void afs_zap_permits(struct rcu_head *);
629extern struct key *afs_request_key(struct afs_cell *);
630extern int afs_permission(struct inode *, int);
631
632/*
633 * server.c
634 */
635extern spinlock_t afs_server_peer_lock;
636
637#define afs_get_server(S) \
638do { \
639 _debug("GET SERVER %d", atomic_read(&(S)->usage)); \
640 atomic_inc(&(S)->usage); \
641} while(0)
642
643extern struct afs_server *afs_lookup_server(struct afs_cell *,
644 const struct in_addr *);
645extern struct afs_server *afs_find_server(const struct sockaddr_rxrpc *);
646extern void afs_put_server(struct afs_server *);
647extern void __exit afs_purge_servers(void);
648
649/*
650 * super.c
651 */
652extern int afs_fs_init(void);
653extern void afs_fs_exit(void);
654
655/*
656 * use-rtnetlink.c
657 */
658extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
659extern int afs_get_MAC_address(u8 *, size_t);
660
661/*
662 * vlclient.c
663 */
664extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
665 const char *, struct afs_cache_vlocation *,
666 const struct afs_wait_mode *);
667extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
668 afs_volid_t, afs_voltype_t,
669 struct afs_cache_vlocation *,
670 const struct afs_wait_mode *);
671
672/*
673 * vlocation.c
674 */
675#define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
676
677extern int __init afs_vlocation_update_init(void);
678extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
679 struct key *,
680 const char *, size_t);
681extern void afs_put_vlocation(struct afs_vlocation *);
682extern void afs_vlocation_purge(void);
683
684/*
685 * vnode.c
686 */
687static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
688{
689 return container_of(inode, struct afs_vnode, vfs_inode);
690}
691
692static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
693{
694 return &vnode->vfs_inode;
695}
696
697extern void afs_vnode_finalise_status_update(struct afs_vnode *,
698 struct afs_server *);
699extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
700 struct key *);
701extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
702 off_t, size_t, struct page *);
703extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
704 umode_t, struct afs_fid *, struct afs_file_status *,
705 struct afs_callback *, struct afs_server **);
706extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
707 bool);
708extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
709 const char *);
710extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
711 const char *, struct afs_fid *,
712 struct afs_file_status *, struct afs_server **);
713extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
714 struct key *, const char *, const char *);
715extern int afs_vnode_store_data(struct afs_writeback *, pgoff_t, pgoff_t,
716 unsigned, unsigned);
717extern int afs_vnode_setattr(struct afs_vnode *, struct key *, struct iattr *);
718extern int afs_vnode_get_volume_status(struct afs_vnode *, struct key *,
719 struct afs_volume_status *);
720extern int afs_vnode_set_lock(struct afs_vnode *, struct key *,
721 afs_lock_type_t);
722extern int afs_vnode_extend_lock(struct afs_vnode *, struct key *);
723extern int afs_vnode_release_lock(struct afs_vnode *, struct key *);
724
725/*
726 * volume.c
727 */
728#define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
729
730extern void afs_put_volume(struct afs_volume *);
731extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
732extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
733extern int afs_volume_release_fileserver(struct afs_vnode *,
734 struct afs_server *, int);
735
736/*
737 * write.c
738 */
739extern int afs_set_page_dirty(struct page *);
740extern void afs_put_writeback(struct afs_writeback *);
741extern int afs_write_begin(struct file *file, struct address_space *mapping,
742 loff_t pos, unsigned len, unsigned flags,
743 struct page **pagep, void **fsdata);
744extern int afs_write_end(struct file *file, struct address_space *mapping,
745 loff_t pos, unsigned len, unsigned copied,
746 struct page *page, void *fsdata);
747extern int afs_writepage(struct page *, struct writeback_control *);
748extern int afs_writepages(struct address_space *, struct writeback_control *);
749extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
750extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
751extern int afs_writeback_all(struct afs_vnode *);
752extern int afs_fsync(struct file *, loff_t, loff_t, int);
753
754
755/*****************************************************************************/
756/*
757 * debug tracing
758 */
759extern unsigned afs_debug;
760
761#define dbgprintk(FMT,...) \
762 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
763
764#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
765#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
766#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
767
768
769#if defined(__KDEBUG)
770#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
771#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
772#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
773
774#elif defined(CONFIG_AFS_DEBUG)
775#define AFS_DEBUG_KENTER 0x01
776#define AFS_DEBUG_KLEAVE 0x02
777#define AFS_DEBUG_KDEBUG 0x04
778
779#define _enter(FMT,...) \
780do { \
781 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
782 kenter(FMT,##__VA_ARGS__); \
783} while (0)
784
785#define _leave(FMT,...) \
786do { \
787 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
788 kleave(FMT,##__VA_ARGS__); \
789} while (0)
790
791#define _debug(FMT,...) \
792do { \
793 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
794 kdebug(FMT,##__VA_ARGS__); \
795} while (0)
796
797#else
798#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
799#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
800#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
801#endif
802
803/*
804 * debug assertion checking
805 */
806#if 1 // defined(__KDEBUGALL)
807
808#define ASSERT(X) \
809do { \
810 if (unlikely(!(X))) { \
811 printk(KERN_ERR "\n"); \
812 printk(KERN_ERR "AFS: Assertion failed\n"); \
813 BUG(); \
814 } \
815} while(0)
816
817#define ASSERTCMP(X, OP, Y) \
818do { \
819 if (unlikely(!((X) OP (Y)))) { \
820 printk(KERN_ERR "\n"); \
821 printk(KERN_ERR "AFS: Assertion failed\n"); \
822 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
823 (unsigned long)(X), (unsigned long)(Y)); \
824 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
825 (unsigned long)(X), (unsigned long)(Y)); \
826 BUG(); \
827 } \
828} while(0)
829
830#define ASSERTRANGE(L, OP1, N, OP2, H) \
831do { \
832 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
833 printk(KERN_ERR "\n"); \
834 printk(KERN_ERR "AFS: Assertion failed\n"); \
835 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
836 (unsigned long)(L), (unsigned long)(N), \
837 (unsigned long)(H)); \
838 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
839 (unsigned long)(L), (unsigned long)(N), \
840 (unsigned long)(H)); \
841 BUG(); \
842 } \
843} while(0)
844
845#define ASSERTIF(C, X) \
846do { \
847 if (unlikely((C) && !(X))) { \
848 printk(KERN_ERR "\n"); \
849 printk(KERN_ERR "AFS: Assertion failed\n"); \
850 BUG(); \
851 } \
852} while(0)
853
854#define ASSERTIFCMP(C, X, OP, Y) \
855do { \
856 if (unlikely((C) && !((X) OP (Y)))) { \
857 printk(KERN_ERR "\n"); \
858 printk(KERN_ERR "AFS: Assertion failed\n"); \
859 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
860 (unsigned long)(X), (unsigned long)(Y)); \
861 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
862 (unsigned long)(X), (unsigned long)(Y)); \
863 BUG(); \
864 } \
865} while(0)
866
867#else
868
869#define ASSERT(X) \
870do { \
871} while(0)
872
873#define ASSERTCMP(X, OP, Y) \
874do { \
875} while(0)
876
877#define ASSERTRANGE(L, OP1, N, OP2, H) \
878do { \
879} while(0)
880
881#define ASSERTIF(C, X) \
882do { \
883} while(0)
884
885#define ASSERTIFCMP(C, X, OP, Y) \
886do { \
887} while(0)
888
889#endif /* __KDEBUGALL */
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 short 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 */