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