]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - fs/afs/internal.h
projects / mirror_ubuntu-artful-kernel.git / blob
? search:


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