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