blob: 2c55dd94a1de573c9e4169a3cbb3c993dc6422b9 [file] [log] [blame]
David Howellsec268152007-04-26 15:49:28 -07001/* internal AFS stuff
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
David Howells08e0e7c2007-04-26 15:55:03 -07003 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/compiler.h>
13#include <linux/kernel.h>
14#include <linux/fs.h>
15#include <linux/pagemap.h>
David Howells08e0e7c2007-04-26 15:55:03 -070016#include <linux/skbuff.h>
17#include <linux/rxrpc.h>
David Howells00d3b7a2007-04-26 15:57:07 -070018#include <linux/key.h>
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040019#include <linux/workqueue.h>
Andrew Morton00c541e2007-05-31 00:40:52 -070020#include <linux/sched.h>
21
David Howells08e0e7c2007-04-26 15:55:03 -070022#include "afs.h"
23#include "afs_vl.h"
24
25#define AFS_CELL_MAX_ADDRS 15
26
David Howells31143d52007-05-09 02:33:46 -070027struct pagevec;
David Howells08e0e7c2007-04-26 15:55:03 -070028struct afs_call;
29
30typedef enum {
31 AFS_VL_NEW, /* new, uninitialised record */
32 AFS_VL_CREATING, /* creating record */
33 AFS_VL_VALID, /* record is pending */
34 AFS_VL_NO_VOLUME, /* no such volume available */
35 AFS_VL_UPDATING, /* update in progress */
36 AFS_VL_VOLUME_DELETED, /* volume was deleted */
37 AFS_VL_UNCERTAIN, /* uncertain state (update failed) */
38} __attribute__((packed)) afs_vlocation_state_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
David Howells00d3b7a2007-04-26 15:57:07 -070040struct afs_mount_params {
41 bool rwpath; /* T if the parent should be considered R/W */
42 bool force; /* T to force cell type */
43 afs_voltype_t type; /* type of volume requested */
44 int volnamesz; /* size of volume name */
45 const char *volname; /* name of volume to mount */
46 struct afs_cell *cell; /* cell in which to find volume */
47 struct afs_volume *volume; /* volume record */
48 struct key *key; /* key to use for secure mounting */
49};
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051/*
David Howells08e0e7c2007-04-26 15:55:03 -070052 * definition of how to wait for the completion of an operation
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 */
David Howells08e0e7c2007-04-26 15:55:03 -070054struct afs_wait_mode {
55 /* RxRPC received message notification */
56 void (*rx_wakeup)(struct afs_call *call);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
David Howells08e0e7c2007-04-26 15:55:03 -070058 /* synchronous call waiter and call dispatched notification */
59 int (*wait)(struct afs_call *call);
60
61 /* asynchronous call completion */
62 void (*async_complete)(void *reply, int error);
63};
64
65extern const struct afs_wait_mode afs_sync_call;
66extern const struct afs_wait_mode afs_async_call;
67
68/*
69 * a record of an in-progress RxRPC call
70 */
71struct afs_call {
72 const struct afs_call_type *type; /* type of call */
73 const struct afs_wait_mode *wait_mode; /* completion wait mode */
74 wait_queue_head_t waitq; /* processes awaiting completion */
75 struct work_struct async_work; /* asynchronous work processor */
76 struct work_struct work; /* actual work processor */
77 struct sk_buff_head rx_queue; /* received packets */
78 struct rxrpc_call *rxcall; /* RxRPC call handle */
79 struct key *key; /* security for this call */
80 struct afs_server *server; /* server affected by incoming CM call */
81 void *request; /* request data (first part) */
David Howells31143d52007-05-09 02:33:46 -070082 struct address_space *mapping; /* page set */
83 struct afs_writeback *wb; /* writeback being performed */
David Howells08e0e7c2007-04-26 15:55:03 -070084 void *buffer; /* reply receive buffer */
85 void *reply; /* reply buffer (first part) */
86 void *reply2; /* reply buffer (second part) */
87 void *reply3; /* reply buffer (third part) */
David Howells260a9802007-04-26 15:59:35 -070088 void *reply4; /* reply buffer (fourth part) */
David Howells31143d52007-05-09 02:33:46 -070089 pgoff_t first; /* first page in mapping to deal with */
90 pgoff_t last; /* last page in mapping to deal with */
David Howells08e0e7c2007-04-26 15:55:03 -070091 enum { /* call state */
92 AFS_CALL_REQUESTING, /* request is being sent for outgoing call */
93 AFS_CALL_AWAIT_REPLY, /* awaiting reply to outgoing call */
94 AFS_CALL_AWAIT_OP_ID, /* awaiting op ID on incoming call */
95 AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
96 AFS_CALL_REPLYING, /* replying to incoming call */
97 AFS_CALL_AWAIT_ACK, /* awaiting final ACK of incoming call */
98 AFS_CALL_COMPLETE, /* successfully completed */
99 AFS_CALL_BUSY, /* server was busy */
100 AFS_CALL_ABORTED, /* call was aborted */
101 AFS_CALL_ERROR, /* call failed due to error */
102 } state;
103 int error; /* error code */
104 unsigned request_size; /* size of request data */
105 unsigned reply_max; /* maximum size of reply */
106 unsigned reply_size; /* current size of reply */
David Howells31143d52007-05-09 02:33:46 -0700107 unsigned first_offset; /* offset into mapping[first] */
108 unsigned last_to; /* amount of mapping[last] */
David Howells08e0e7c2007-04-26 15:55:03 -0700109 unsigned short offset; /* offset into received data store */
110 unsigned char unmarshall; /* unmarshalling phase */
111 bool incoming; /* T if incoming call */
David Howells31143d52007-05-09 02:33:46 -0700112 bool send_pages; /* T if data from mapping should be sent */
David Howells08e0e7c2007-04-26 15:55:03 -0700113 u16 service_id; /* RxRPC service ID to call */
114 __be16 port; /* target UDP port */
115 __be32 operation_ID; /* operation ID for an incoming call */
116 u32 count; /* count for use in unmarshalling */
117 __be32 tmp; /* place to extract temporary data */
David Howells31143d52007-05-09 02:33:46 -0700118 afs_dataversion_t store_version; /* updated version expected from store */
David Howells08e0e7c2007-04-26 15:55:03 -0700119};
120
121struct afs_call_type {
David Howells00d3b7a2007-04-26 15:57:07 -0700122 const char *name;
123
David Howells08e0e7c2007-04-26 15:55:03 -0700124 /* 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, struct sk_buff *skb,
128 bool last);
129
130 /* map an abort code to an error number */
131 int (*abort_to_error)(u32 abort_code);
132
133 /* clean up a call */
134 void (*destructor)(struct afs_call *call);
135};
136
137/*
David Howells31143d52007-05-09 02:33:46 -0700138 * record of an outstanding writeback on a vnode
139 */
140struct afs_writeback {
141 struct list_head link; /* link in vnode->writebacks */
142 struct work_struct writer; /* work item to perform the writeback */
143 struct afs_vnode *vnode; /* vnode to which this write applies */
144 struct key *key; /* owner of this write */
145 wait_queue_head_t waitq; /* completion and ready wait queue */
146 pgoff_t first; /* first page in batch */
147 pgoff_t point; /* last page in current store op */
148 pgoff_t last; /* last page in batch (inclusive) */
149 unsigned offset_first; /* offset into first page of start of write */
150 unsigned to_last; /* offset into last page of end of write */
151 int num_conflicts; /* count of conflicting writes in list */
152 int usage;
153 bool conflicts; /* T if has dependent conflicts */
154 enum {
155 AFS_WBACK_SYNCING, /* synchronisation being performed */
156 AFS_WBACK_PENDING, /* write pending */
157 AFS_WBACK_CONFLICTING, /* conflicting writes posted */
158 AFS_WBACK_WRITING, /* writing back */
159 AFS_WBACK_COMPLETE /* the writeback record has been unlinked */
160 } state __attribute__((packed));
161};
162
163/*
David Howells08e0e7c2007-04-26 15:55:03 -0700164 * AFS superblock private data
165 * - there's one superblock per volume
166 */
167struct afs_super_info {
168 struct afs_volume *volume; /* volume record */
169 char rwparent; /* T if parent is R/W AFS volume */
170};
171
172static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
173{
174 return sb->s_fs_info;
175}
176
177extern struct file_system_type afs_fs_type;
178
179/*
180 * entry in the cached cell catalogue
181 */
182struct afs_cache_cell {
David Howells00d3b7a2007-04-26 15:57:07 -0700183 char name[AFS_MAXCELLNAME]; /* cell name (padded with NULs) */
184 struct in_addr vl_servers[15]; /* cached cell VL servers */
David Howells08e0e7c2007-04-26 15:55:03 -0700185};
186
187/*
188 * AFS cell record
189 */
190struct afs_cell {
191 atomic_t usage;
192 struct list_head link; /* main cell list link */
David Howells00d3b7a2007-04-26 15:57:07 -0700193 struct key *anonymous_key; /* anonymous user key for this cell */
David Howells08e0e7c2007-04-26 15:55:03 -0700194 struct list_head proc_link; /* /proc cell list link */
195 struct proc_dir_entry *proc_dir; /* /proc dir for this cell */
196#ifdef AFS_CACHING_SUPPORT
197 struct cachefs_cookie *cache; /* caching cookie */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198#endif
199
David Howells08e0e7c2007-04-26 15:55:03 -0700200 /* server record management */
201 rwlock_t servers_lock; /* active server list lock */
202 struct list_head servers; /* active server list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
David Howells08e0e7c2007-04-26 15:55:03 -0700204 /* volume location record management */
205 struct rw_semaphore vl_sem; /* volume management serialisation semaphore */
206 struct list_head vl_list; /* cell's active VL record list */
207 spinlock_t vl_lock; /* vl_list lock */
208 unsigned short vl_naddrs; /* number of VL servers in addr list */
209 unsigned short vl_curr_svix; /* current server index */
210 struct in_addr vl_addrs[AFS_CELL_MAX_ADDRS]; /* cell VL server addresses */
211
212 char name[0]; /* cell name - must go last */
213};
214
215/*
216 * entry in the cached volume location catalogue
217 */
218struct afs_cache_vlocation {
David Howells00d3b7a2007-04-26 15:57:07 -0700219 /* volume name (lowercase, padded with NULs) */
220 uint8_t name[AFS_MAXVOLNAME + 1];
221
David Howells08e0e7c2007-04-26 15:55:03 -0700222 uint8_t nservers; /* number of entries used in servers[] */
223 uint8_t vidmask; /* voltype mask for vid[] */
224 uint8_t srvtmask[8]; /* voltype masks for servers[] */
225#define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
226#define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
227#define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
228
229 afs_volid_t vid[3]; /* volume IDs for R/W, R/O and Bak volumes */
230 struct in_addr servers[8]; /* fileserver addresses */
231 time_t rtime; /* last retrieval time */
232};
233
234/*
235 * volume -> vnode hash table entry
236 */
237struct afs_cache_vhash {
238 afs_voltype_t vtype; /* which volume variation */
239 uint8_t hash_bucket; /* which hash bucket this represents */
240} __attribute__((packed));
241
242/*
243 * AFS volume location record
244 */
245struct afs_vlocation {
246 atomic_t usage;
247 time_t time_of_death; /* time at which put reduced usage to 0 */
248 struct list_head link; /* link in cell volume location list */
249 struct list_head grave; /* link in master graveyard list */
250 struct list_head update; /* link in master update list */
251 struct afs_cell *cell; /* cell to which volume belongs */
252#ifdef AFS_CACHING_SUPPORT
253 struct cachefs_cookie *cache; /* caching cookie */
254#endif
255 struct afs_cache_vlocation vldb; /* volume information DB record */
256 struct afs_volume *vols[3]; /* volume access record pointer (index by type) */
257 wait_queue_head_t waitq; /* status change waitqueue */
258 time_t update_at; /* time at which record should be updated */
David S. Miller39bf0942007-04-26 20:39:14 -0700259 spinlock_t lock; /* access lock */
David Howells08e0e7c2007-04-26 15:55:03 -0700260 afs_vlocation_state_t state; /* volume location state */
261 unsigned short upd_rej_cnt; /* ENOMEDIUM count during update */
262 unsigned short upd_busy_cnt; /* EBUSY count during update */
263 bool valid; /* T if valid */
264};
265
266/*
267 * AFS fileserver record
268 */
269struct afs_server {
270 atomic_t usage;
271 time_t time_of_death; /* time at which put reduced usage to 0 */
272 struct in_addr addr; /* server address */
273 struct afs_cell *cell; /* cell in which server resides */
274 struct list_head link; /* link in cell's server list */
275 struct list_head grave; /* link in master graveyard list */
276 struct rb_node master_rb; /* link in master by-addr tree */
277 struct rw_semaphore sem; /* access lock */
278
279 /* file service access */
280 struct rb_root fs_vnodes; /* vnodes backed by this server (ordered by FID) */
281 unsigned long fs_act_jif; /* time at which last activity occurred */
282 unsigned long fs_dead_jif; /* time at which no longer to be considered dead */
283 spinlock_t fs_lock; /* access lock */
284 int fs_state; /* 0 or reason FS currently marked dead (-errno) */
285
286 /* callback promise management */
287 struct rb_root cb_promises; /* vnode expiration list (ordered earliest first) */
288 struct delayed_work cb_updater; /* callback updater */
289 struct delayed_work cb_break_work; /* collected break dispatcher */
290 wait_queue_head_t cb_break_waitq; /* space available in cb_break waitqueue */
291 spinlock_t cb_lock; /* access lock */
292 struct afs_callback cb_break[64]; /* ring of callbacks awaiting breaking */
293 atomic_t cb_break_n; /* number of pending breaks */
294 u8 cb_break_head; /* head of callback breaking ring */
295 u8 cb_break_tail; /* tail of callback breaking ring */
296};
297
298/*
299 * AFS volume access record
300 */
301struct afs_volume {
302 atomic_t usage;
303 struct afs_cell *cell; /* cell to which belongs (unrefd ptr) */
304 struct afs_vlocation *vlocation; /* volume location */
305#ifdef AFS_CACHING_SUPPORT
306 struct cachefs_cookie *cache; /* caching cookie */
307#endif
308 afs_volid_t vid; /* volume ID */
309 afs_voltype_t type; /* type of volume */
310 char type_force; /* force volume type (suppress R/O -> R/W) */
311 unsigned short nservers; /* number of server slots filled */
312 unsigned short rjservers; /* number of servers discarded due to -ENOMEDIUM */
313 struct afs_server *servers[8]; /* servers on which volume resides (ordered) */
314 struct rw_semaphore server_sem; /* lock for accessing current server */
315};
316
317/*
318 * vnode catalogue entry
319 */
320struct afs_cache_vnode {
321 afs_vnodeid_t vnode_id; /* vnode ID */
322 unsigned vnode_unique; /* vnode ID uniquifier */
323 afs_dataversion_t data_version; /* data version */
324};
325
326/*
327 * AFS inode private data
328 */
329struct afs_vnode {
330 struct inode vfs_inode; /* the VFS's inode record */
331
332 struct afs_volume *volume; /* volume on which vnode resides */
333 struct afs_server *server; /* server currently supplying this file */
334 struct afs_fid fid; /* the file identifier for this inode */
335 struct afs_file_status status; /* AFS status info for this file */
336#ifdef AFS_CACHING_SUPPORT
337 struct cachefs_cookie *cache; /* caching cookie */
338#endif
David Howells00d3b7a2007-04-26 15:57:07 -0700339 struct afs_permits *permits; /* cache of permits so far obtained */
340 struct mutex permits_lock; /* lock for altering permits list */
David Howells260a9802007-04-26 15:59:35 -0700341 struct mutex validate_lock; /* lock for validating this vnode */
David Howells08e0e7c2007-04-26 15:55:03 -0700342 wait_queue_head_t update_waitq; /* status fetch waitqueue */
David Howells260a9802007-04-26 15:59:35 -0700343 int update_cnt; /* number of outstanding ops that will update the
David Howells08e0e7c2007-04-26 15:55:03 -0700344 * status */
David Howells31143d52007-05-09 02:33:46 -0700345 spinlock_t writeback_lock; /* lock for writebacks */
David Howells08e0e7c2007-04-26 15:55:03 -0700346 spinlock_t lock; /* waitqueue/flags lock */
347 unsigned long flags;
348#define AFS_VNODE_CB_BROKEN 0 /* set if vnode's callback was broken */
David Howells260a9802007-04-26 15:59:35 -0700349#define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
David Howells08e0e7c2007-04-26 15:55:03 -0700350#define AFS_VNODE_MODIFIED 2 /* set if vnode's data modified */
351#define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
352#define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
353#define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
David Howells08e0e7c2007-04-26 15:55:03 -0700354
David Howells00d3b7a2007-04-26 15:57:07 -0700355 long acl_order; /* ACL check count (callback break count) */
356
David Howells31143d52007-05-09 02:33:46 -0700357 struct list_head writebacks; /* alterations in pagecache that need writing */
358
David Howells08e0e7c2007-04-26 15:55:03 -0700359 /* outstanding callback notification on this file */
360 struct rb_node server_rb; /* link in server->fs_vnodes */
361 struct rb_node cb_promise; /* link in server->cb_promises */
362 struct work_struct cb_broken_work; /* work to be done on callback break */
David Howells08e0e7c2007-04-26 15:55:03 -0700363 time_t cb_expires; /* time at which callback expires */
364 time_t cb_expires_at; /* time used to order cb_promise */
365 unsigned cb_version; /* callback version */
366 unsigned cb_expiry; /* callback expiry time */
367 afs_callback_type_t cb_type; /* type of callback */
368 bool cb_promised; /* true if promise still holds */
369};
370
David Howells00d3b7a2007-04-26 15:57:07 -0700371/*
372 * cached security record for one user's attempt to access a vnode
373 */
374struct afs_permit {
375 struct key *key; /* RxRPC ticket holding a security context */
376 afs_access_t access_mask; /* access mask for this key */
377};
378
379/*
380 * cache of security records from attempts to access a vnode
381 */
382struct afs_permits {
383 struct rcu_head rcu; /* disposal procedure */
384 int count; /* number of records */
385 struct afs_permit permits[0]; /* the permits so far examined */
386};
387
David Howellsb908fe62007-04-26 15:58:17 -0700388/*
389 * record of one of a system's set of network interfaces
390 */
391struct afs_interface {
David Howellsb908fe62007-04-26 15:58:17 -0700392 struct in_addr address; /* IPv4 address bound to interface */
393 struct in_addr netmask; /* netmask applied to address */
394 unsigned mtu; /* MTU of interface */
395};
396
397/*
398 * UUID definition [internet draft]
399 * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
400 * increments since midnight 15th October 1582
401 * - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
402 * time
403 * - the clock sequence is a 14-bit counter to avoid duplicate times
404 */
405struct afs_uuid {
406 u32 time_low; /* low part of timestamp */
407 u16 time_mid; /* mid part of timestamp */
408 u16 time_hi_and_version; /* high part of timestamp and version */
David Howellsb1bdb692007-04-27 15:28:45 -0700409#define AFS_UUID_TO_UNIX_TIME 0x01b21dd213814000ULL
David Howellsb908fe62007-04-26 15:58:17 -0700410#define AFS_UUID_TIMEHI_MASK 0x0fff
411#define AFS_UUID_VERSION_TIME 0x1000 /* time-based UUID */
412#define AFS_UUID_VERSION_NAME 0x3000 /* name-based UUID */
413#define AFS_UUID_VERSION_RANDOM 0x4000 /* (pseudo-)random generated UUID */
414 u8 clock_seq_hi_and_reserved; /* clock seq hi and variant */
415#define AFS_UUID_CLOCKHI_MASK 0x3f
416#define AFS_UUID_VARIANT_STD 0x80
417 u8 clock_seq_low; /* clock seq low */
418 u8 node[6]; /* spatially unique node ID (MAC addr) */
419};
420
David Howells08e0e7c2007-04-26 15:55:03 -0700421/*****************************************************************************/
422/*
423 * callback.c
424 */
425extern void afs_init_callback_state(struct afs_server *);
426extern void afs_broken_callback_work(struct work_struct *);
427extern void afs_break_callbacks(struct afs_server *, size_t,
428 struct afs_callback[]);
David Howells260a9802007-04-26 15:59:35 -0700429extern void afs_discard_callback_on_delete(struct afs_vnode *);
David Howells08e0e7c2007-04-26 15:55:03 -0700430extern void afs_give_up_callback(struct afs_vnode *);
431extern void afs_dispatch_give_up_callbacks(struct work_struct *);
432extern void afs_flush_callback_breaks(struct afs_server *);
433extern int __init afs_callback_update_init(void);
David Howellsfbb3fcb2007-05-03 03:12:46 -0700434extern void afs_callback_update_kill(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436/*
437 * cell.c
438 */
439extern struct rw_semaphore afs_proc_cells_sem;
440extern struct list_head afs_proc_cells;
441#ifdef AFS_CACHING_SUPPORT
442extern struct cachefs_index_def afs_cache_cell_index_def;
443#endif
444
David Howells08e0e7c2007-04-26 15:55:03 -0700445#define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
446extern int afs_cell_init(char *);
447extern struct afs_cell *afs_cell_create(const char *, char *);
448extern struct afs_cell *afs_cell_lookup(const char *, unsigned);
449extern struct afs_cell *afs_grab_cell(struct afs_cell *);
450extern void afs_put_cell(struct afs_cell *);
451extern void afs_cell_purge(void);
452
453/*
454 * cmservice.c
455 */
456extern bool afs_cm_incoming_call(struct afs_call *);
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458/*
459 * dir.c
460 */
Arjan van de Ven754661f2007-02-12 00:55:38 -0800461extern const struct inode_operations afs_dir_inode_operations;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800462extern const struct file_operations afs_dir_file_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
David Howells00d3b7a2007-04-26 15:57:07 -0700464extern int afs_permission(struct inode *, int, struct nameidata *);
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466/*
467 * file.c
468 */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700469extern const struct address_space_operations afs_fs_aops;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800470extern const struct inode_operations afs_file_inode_operations;
David Howells00d3b7a2007-04-26 15:57:07 -0700471extern const struct file_operations afs_file_operations;
472
473extern int afs_open(struct inode *, struct file *);
474extern int afs_release(struct inode *, struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476/*
David Howells08e0e7c2007-04-26 15:55:03 -0700477 * fsclient.c
478 */
David Howells00d3b7a2007-04-26 15:57:07 -0700479extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
480 struct afs_vnode *, struct afs_volsync *,
David Howells08e0e7c2007-04-26 15:55:03 -0700481 const struct afs_wait_mode *);
482extern int afs_fs_give_up_callbacks(struct afs_server *,
483 const struct afs_wait_mode *);
David Howells00d3b7a2007-04-26 15:57:07 -0700484extern int afs_fs_fetch_data(struct afs_server *, struct key *,
485 struct afs_vnode *, off_t, size_t, struct page *,
David Howells08e0e7c2007-04-26 15:55:03 -0700486 const struct afs_wait_mode *);
David Howells260a9802007-04-26 15:59:35 -0700487extern int afs_fs_create(struct afs_server *, struct key *,
488 struct afs_vnode *, const char *, umode_t,
489 struct afs_fid *, struct afs_file_status *,
490 struct afs_callback *,
491 const struct afs_wait_mode *);
492extern int afs_fs_remove(struct afs_server *, struct key *,
493 struct afs_vnode *, const char *, bool,
494 const struct afs_wait_mode *);
495extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
496 struct afs_vnode *, const char *,
497 const struct afs_wait_mode *);
498extern int afs_fs_symlink(struct afs_server *, struct key *,
499 struct afs_vnode *, const char *, const char *,
500 struct afs_fid *, struct afs_file_status *,
501 const struct afs_wait_mode *);
502extern int afs_fs_rename(struct afs_server *, struct key *,
503 struct afs_vnode *, const char *,
504 struct afs_vnode *, const char *,
505 const struct afs_wait_mode *);
David Howells31143d52007-05-09 02:33:46 -0700506extern int afs_fs_store_data(struct afs_server *, struct afs_writeback *,
507 pgoff_t, pgoff_t, unsigned, unsigned,
508 const struct afs_wait_mode *);
509extern int afs_fs_setattr(struct afs_server *, struct key *,
510 struct afs_vnode *, struct iattr *,
511 const struct afs_wait_mode *);
David Howells45222b92007-05-10 22:22:20 -0700512extern int afs_fs_get_volume_status(struct afs_server *, struct key *,
513 struct afs_vnode *,
514 struct afs_volume_status *,
515 const struct afs_wait_mode *);
David Howells08e0e7c2007-04-26 15:55:03 -0700516
517/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 * inode.c
519 */
David Howells00d3b7a2007-04-26 15:57:07 -0700520extern struct inode *afs_iget(struct super_block *, struct key *,
David Howells260a9802007-04-26 15:59:35 -0700521 struct afs_fid *, struct afs_file_status *,
522 struct afs_callback *);
David Howells416351f2007-05-09 02:33:45 -0700523extern void afs_zap_data(struct afs_vnode *);
David Howells260a9802007-04-26 15:59:35 -0700524extern int afs_validate(struct afs_vnode *, struct key *);
David Howells416351f2007-05-09 02:33:45 -0700525extern int afs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells31143d52007-05-09 02:33:46 -0700526extern int afs_setattr(struct dentry *, struct iattr *);
David Howellsec268152007-04-26 15:49:28 -0700527extern void afs_clear_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529/*
530 * main.c
531 */
David Howellsb908fe62007-04-26 15:58:17 -0700532extern struct afs_uuid afs_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533#ifdef AFS_CACHING_SUPPORT
534extern struct cachefs_netfs afs_cache_netfs;
535#endif
536
537/*
David Howells08e0e7c2007-04-26 15:55:03 -0700538 * misc.c
539 */
540extern int afs_abort_to_error(u32);
541
542/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 * mntpt.c
544 */
Arjan van de Ven754661f2007-02-12 00:55:38 -0800545extern const struct inode_operations afs_mntpt_inode_operations;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800546extern const struct file_operations afs_mntpt_file_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547extern unsigned long afs_mntpt_expiry_timeout;
548
David Howells00d3b7a2007-04-26 15:57:07 -0700549extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
David Howells08e0e7c2007-04-26 15:55:03 -0700550extern void afs_mntpt_kill_timer(void);
551extern void afs_umount_begin(struct vfsmount *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 * proc.c
555 */
556extern int afs_proc_init(void);
557extern void afs_proc_cleanup(void);
David Howellsec268152007-04-26 15:49:28 -0700558extern int afs_proc_cell_setup(struct afs_cell *);
559extern void afs_proc_cell_remove(struct afs_cell *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
David Howells08e0e7c2007-04-26 15:55:03 -0700561/*
562 * rxrpc.c
563 */
564extern int afs_open_socket(void);
565extern void afs_close_socket(void);
566extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
567 const struct afs_wait_mode *);
568extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
569 size_t, size_t);
570extern void afs_flat_call_destructor(struct afs_call *);
571extern void afs_transfer_reply(struct afs_call *, struct sk_buff *);
572extern void afs_send_empty_reply(struct afs_call *);
David Howellsb908fe62007-04-26 15:58:17 -0700573extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
David Howells08e0e7c2007-04-26 15:55:03 -0700574extern int afs_extract_data(struct afs_call *, struct sk_buff *, bool, void *,
575 size_t);
576
577/*
David Howells00d3b7a2007-04-26 15:57:07 -0700578 * security.c
579 */
580extern void afs_clear_permits(struct afs_vnode *);
581extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
David Howells416351f2007-05-09 02:33:45 -0700582extern void afs_zap_permits(struct rcu_head *);
David Howells00d3b7a2007-04-26 15:57:07 -0700583extern struct key *afs_request_key(struct afs_cell *);
584extern int afs_permission(struct inode *, int, struct nameidata *);
585
586/*
David Howells08e0e7c2007-04-26 15:55:03 -0700587 * server.c
588 */
589extern spinlock_t afs_server_peer_lock;
590
David Howells260a9802007-04-26 15:59:35 -0700591#define afs_get_server(S) \
592do { \
593 _debug("GET SERVER %d", atomic_read(&(S)->usage)); \
594 atomic_inc(&(S)->usage); \
595} while(0)
David Howells08e0e7c2007-04-26 15:55:03 -0700596
597extern struct afs_server *afs_lookup_server(struct afs_cell *,
598 const struct in_addr *);
599extern struct afs_server *afs_find_server(const struct in_addr *);
600extern void afs_put_server(struct afs_server *);
601extern void __exit afs_purge_servers(void);
602
603/*
David Howells00d3b7a2007-04-26 15:57:07 -0700604 * super.c
605 */
606extern int afs_fs_init(void);
607extern void afs_fs_exit(void);
608
609/*
David Howellsb908fe62007-04-26 15:58:17 -0700610 * use-rtnetlink.c
611 */
612extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
David Howellsec9c9482007-05-03 03:29:41 -0700613extern int afs_get_MAC_address(u8 *, size_t);
David Howellsb908fe62007-04-26 15:58:17 -0700614
615/*
David Howells08e0e7c2007-04-26 15:55:03 -0700616 * vlclient.c
617 */
618#ifdef AFS_CACHING_SUPPORT
619extern struct cachefs_index_def afs_vlocation_cache_index_def;
620#endif
621
David Howells00d3b7a2007-04-26 15:57:07 -0700622extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
623 const char *, struct afs_cache_vlocation *,
David Howells08e0e7c2007-04-26 15:55:03 -0700624 const struct afs_wait_mode *);
David Howells00d3b7a2007-04-26 15:57:07 -0700625extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
626 afs_volid_t, afs_voltype_t,
David Howells08e0e7c2007-04-26 15:55:03 -0700627 struct afs_cache_vlocation *,
628 const struct afs_wait_mode *);
629
630/*
631 * vlocation.c
632 */
633#define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
634
635extern int __init afs_vlocation_update_init(void);
636extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
David Howells00d3b7a2007-04-26 15:57:07 -0700637 struct key *,
David Howells08e0e7c2007-04-26 15:55:03 -0700638 const char *, size_t);
639extern void afs_put_vlocation(struct afs_vlocation *);
David Howellsfbb3fcb2007-05-03 03:12:46 -0700640extern void afs_vlocation_purge(void);
David Howells08e0e7c2007-04-26 15:55:03 -0700641
642/*
643 * vnode.c
644 */
645#ifdef AFS_CACHING_SUPPORT
646extern struct cachefs_index_def afs_vnode_cache_index_def;
647#endif
648
649extern struct afs_timer_ops afs_vnode_cb_timed_out_ops;
650
651static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
652{
653 return container_of(inode, struct afs_vnode, vfs_inode);
654}
655
656static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
657{
658 return &vnode->vfs_inode;
659}
660
David Howells260a9802007-04-26 15:59:35 -0700661extern void afs_vnode_finalise_status_update(struct afs_vnode *,
662 struct afs_server *);
David Howells00d3b7a2007-04-26 15:57:07 -0700663extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
664 struct key *);
665extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
666 off_t, size_t, struct page *);
David Howells260a9802007-04-26 15:59:35 -0700667extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
668 umode_t, struct afs_fid *, struct afs_file_status *,
669 struct afs_callback *, struct afs_server **);
670extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
671 bool);
672extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
673 const char *);
674extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
675 const char *, struct afs_fid *,
676 struct afs_file_status *, struct afs_server **);
677extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
678 struct key *, const char *, const char *);
David Howells31143d52007-05-09 02:33:46 -0700679extern int afs_vnode_store_data(struct afs_writeback *, pgoff_t, pgoff_t,
680 unsigned, unsigned);
681extern int afs_vnode_setattr(struct afs_vnode *, struct key *, struct iattr *);
David Howells45222b92007-05-10 22:22:20 -0700682extern int afs_vnode_get_volume_status(struct afs_vnode *, struct key *,
683 struct afs_volume_status *);
David Howells08e0e7c2007-04-26 15:55:03 -0700684
685/*
686 * volume.c
687 */
688#ifdef AFS_CACHING_SUPPORT
689extern struct cachefs_index_def afs_volume_cache_index_def;
690#endif
691
692#define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
693
694extern void afs_put_volume(struct afs_volume *);
David Howells00d3b7a2007-04-26 15:57:07 -0700695extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
David Howells08e0e7c2007-04-26 15:55:03 -0700696extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
697extern int afs_volume_release_fileserver(struct afs_vnode *,
698 struct afs_server *, int);
699
David Howells31143d52007-05-09 02:33:46 -0700700/*
701 * write.c
702 */
703extern int afs_set_page_dirty(struct page *);
704extern void afs_put_writeback(struct afs_writeback *);
705extern int afs_prepare_write(struct file *, struct page *, unsigned, unsigned);
706extern int afs_commit_write(struct file *, struct page *, unsigned, unsigned);
707extern int afs_writepage(struct page *, struct writeback_control *);
708extern int afs_writepages(struct address_space *, struct writeback_control *);
709extern int afs_write_inode(struct inode *, int);
710extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
711extern ssize_t afs_file_write(struct kiocb *, const struct iovec *,
712 unsigned long, loff_t);
713extern int afs_writeback_all(struct afs_vnode *);
714extern int afs_fsync(struct file *, struct dentry *, int);
715
716
David Howells08e0e7c2007-04-26 15:55:03 -0700717/*****************************************************************************/
718/*
719 * debug tracing
720 */
721extern unsigned afs_debug;
722
723#define dbgprintk(FMT,...) \
724 printk("[%x%-6.6s] "FMT"\n", smp_processor_id(), current->comm ,##__VA_ARGS__)
725
726/* make sure we maintain the format strings, even when debugging is disabled */
727static inline __attribute__((format(printf,1,2)))
728void _dbprintk(const char *fmt, ...)
729{
730}
731
732#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__FUNCTION__ ,##__VA_ARGS__)
733#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__FUNCTION__ ,##__VA_ARGS__)
734#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
735
736
737#if defined(__KDEBUG)
738#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
739#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
740#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
741
742#elif defined(CONFIG_AFS_DEBUG)
743#define AFS_DEBUG_KENTER 0x01
744#define AFS_DEBUG_KLEAVE 0x02
745#define AFS_DEBUG_KDEBUG 0x04
746
747#define _enter(FMT,...) \
748do { \
749 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
750 kenter(FMT,##__VA_ARGS__); \
751} while (0)
752
753#define _leave(FMT,...) \
754do { \
755 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
756 kleave(FMT,##__VA_ARGS__); \
757} while (0)
758
759#define _debug(FMT,...) \
760do { \
761 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
762 kdebug(FMT,##__VA_ARGS__); \
763} while (0)
764
765#else
766#define _enter(FMT,...) _dbprintk("==> %s("FMT")",__FUNCTION__ ,##__VA_ARGS__)
767#define _leave(FMT,...) _dbprintk("<== %s()"FMT"",__FUNCTION__ ,##__VA_ARGS__)
768#define _debug(FMT,...) _dbprintk(" "FMT ,##__VA_ARGS__)
769#endif
770
771/*
772 * debug assertion checking
773 */
774#if 1 // defined(__KDEBUGALL)
775
776#define ASSERT(X) \
777do { \
778 if (unlikely(!(X))) { \
779 printk(KERN_ERR "\n"); \
780 printk(KERN_ERR "AFS: Assertion failed\n"); \
781 BUG(); \
782 } \
783} while(0)
784
785#define ASSERTCMP(X, OP, Y) \
786do { \
787 if (unlikely(!((X) OP (Y)))) { \
788 printk(KERN_ERR "\n"); \
789 printk(KERN_ERR "AFS: Assertion failed\n"); \
790 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
791 (unsigned long)(X), (unsigned long)(Y)); \
792 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
793 (unsigned long)(X), (unsigned long)(Y)); \
794 BUG(); \
795 } \
796} while(0)
797
David Howells416351f2007-05-09 02:33:45 -0700798#define ASSERTRANGE(L, OP1, N, OP2, H) \
799do { \
800 if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) { \
801 printk(KERN_ERR "\n"); \
802 printk(KERN_ERR "AFS: Assertion failed\n"); \
803 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
804 (unsigned long)(L), (unsigned long)(N), \
805 (unsigned long)(H)); \
806 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
807 (unsigned long)(L), (unsigned long)(N), \
808 (unsigned long)(H)); \
809 BUG(); \
810 } \
811} while(0)
812
David Howells08e0e7c2007-04-26 15:55:03 -0700813#define ASSERTIF(C, X) \
814do { \
815 if (unlikely((C) && !(X))) { \
816 printk(KERN_ERR "\n"); \
817 printk(KERN_ERR "AFS: Assertion failed\n"); \
818 BUG(); \
819 } \
820} while(0)
821
822#define ASSERTIFCMP(C, X, OP, Y) \
823do { \
824 if (unlikely((C) && !((X) OP (Y)))) { \
825 printk(KERN_ERR "\n"); \
826 printk(KERN_ERR "AFS: Assertion failed\n"); \
827 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
828 (unsigned long)(X), (unsigned long)(Y)); \
829 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
830 (unsigned long)(X), (unsigned long)(Y)); \
831 BUG(); \
832 } \
833} while(0)
834
835#else
836
837#define ASSERT(X) \
838do { \
839} while(0)
840
841#define ASSERTCMP(X, OP, Y) \
842do { \
843} while(0)
844
David Howells416351f2007-05-09 02:33:45 -0700845#define ASSERTRANGE(L, OP1, N, OP2, H) \
846do { \
847} while(0)
848
David Howells08e0e7c2007-04-26 15:55:03 -0700849#define ASSERTIF(C, X) \
850do { \
851} while(0)
852
853#define ASSERTIFCMP(C, X, OP, Y) \
854do { \
855} while(0)
856
857#endif /* __KDEBUGALL */