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