Merge branches 'pm-cpuidle', 'pm-core' and 'pm-sleep'
[linux-block.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         afs_volid_t             vids[AFS_MAXTYPES]; /* Volume IDs */
556         refcount_t              usage;
557         unsigned char           nr_servers;
558         unsigned char           preferred;      /* Preferred server */
559         unsigned short          vnovol_mask;    /* Servers to be skipped due to VNOVOL */
560         unsigned int            seq;            /* Set to ->servers_seq when installed */
561         rwlock_t                lock;
562         struct afs_server_entry servers[];
563 };
564
565 /*
566  * Live AFS volume management.
567  */
568 struct afs_volume {
569         union {
570                 struct rcu_head rcu;
571                 afs_volid_t     vid;            /* volume ID */
572         };
573         refcount_t              ref;
574         time64_t                update_at;      /* Time at which to next update */
575         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
576         struct rb_node          cell_node;      /* Link in cell->volumes */
577         struct hlist_node       proc_link;      /* Link in cell->proc_volumes */
578         struct super_block __rcu *sb;           /* Superblock on which inodes reside */
579         unsigned long           flags;
580 #define AFS_VOLUME_NEEDS_UPDATE 0       /* - T if an update needs performing */
581 #define AFS_VOLUME_UPDATING     1       /* - T if an update is in progress */
582 #define AFS_VOLUME_WAIT         2       /* - T if users must wait for update */
583 #define AFS_VOLUME_DELETED      3       /* - T if volume appears deleted */
584 #define AFS_VOLUME_OFFLINE      4       /* - T if volume offline notice given */
585 #define AFS_VOLUME_BUSY         5       /* - T if volume busy notice given */
586 #define AFS_VOLUME_MAYBE_NO_IBULK 6     /* - T if some servers don't have InlineBulkStatus */
587 #ifdef CONFIG_AFS_FSCACHE
588         struct fscache_volume   *cache;         /* Caching cookie */
589 #endif
590         struct afs_server_list __rcu *servers;  /* List of servers on which volume resides */
591         rwlock_t                servers_lock;   /* Lock for ->servers */
592         unsigned int            servers_seq;    /* Incremented each time ->servers changes */
593
594         unsigned                cb_v_break;     /* Break-everything counter. */
595         rwlock_t                cb_v_break_lock;
596
597         afs_voltype_t           type;           /* type of volume */
598         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
599         u8                      name_len;
600         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
601 };
602
603 enum afs_lock_state {
604         AFS_VNODE_LOCK_NONE,            /* The vnode has no lock on the server */
605         AFS_VNODE_LOCK_WAITING_FOR_CB,  /* We're waiting for the server to break the callback */
606         AFS_VNODE_LOCK_SETTING,         /* We're asking the server for a lock */
607         AFS_VNODE_LOCK_GRANTED,         /* We have a lock on the server */
608         AFS_VNODE_LOCK_EXTENDING,       /* We're extending a lock on the server */
609         AFS_VNODE_LOCK_NEED_UNLOCK,     /* We need to unlock on the server */
610         AFS_VNODE_LOCK_UNLOCKING,       /* We're telling the server to unlock */
611         AFS_VNODE_LOCK_DELETED,         /* The vnode has been deleted whilst we have a lock */
612 };
613
614 /*
615  * AFS inode private data.
616  *
617  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
618  * leak from one inode to another.
619  */
620 struct afs_vnode {
621         struct netfs_inode      netfs;          /* Netfslib context and vfs inode */
622         struct afs_volume       *volume;        /* volume on which vnode resides */
623         struct afs_fid          fid;            /* the file identifier for this inode */
624         struct afs_file_status  status;         /* AFS status info for this file */
625         afs_dataversion_t       invalid_before; /* Child dentries are invalid before this */
626         struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
627         struct mutex            io_lock;        /* Lock for serialising I/O on this mutex */
628         struct rw_semaphore     validate_lock;  /* lock for validating this vnode */
629         struct rw_semaphore     rmdir_lock;     /* Lock for rmdir vs sillyrename */
630         struct key              *silly_key;     /* Silly rename key */
631         spinlock_t              wb_lock;        /* lock for wb_keys */
632         spinlock_t              lock;           /* waitqueue/flags lock */
633         unsigned long           flags;
634 #define AFS_VNODE_CB_PROMISED   0               /* Set if vnode has a callback promise */
635 #define AFS_VNODE_UNSET         1               /* set if vnode attributes not yet set */
636 #define AFS_VNODE_DIR_VALID     2               /* Set if dir contents are valid */
637 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
638 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
639 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
640 #define AFS_VNODE_AUTOCELL      6               /* set if Vnode is an auto mount point */
641 #define AFS_VNODE_PSEUDODIR     7               /* set if Vnode is a pseudo directory */
642 #define AFS_VNODE_NEW_CONTENT   8               /* Set if file has new content (create/trunc-0) */
643 #define AFS_VNODE_SILLY_DELETED 9               /* Set if file has been silly-deleted */
644 #define AFS_VNODE_MODIFYING     10              /* Set if we're performing a modification op */
645
646         struct list_head        wb_keys;        /* List of keys available for writeback */
647         struct list_head        pending_locks;  /* locks waiting to be granted */
648         struct list_head        granted_locks;  /* locks granted on this file */
649         struct delayed_work     lock_work;      /* work to be done in locking */
650         struct key              *lock_key;      /* Key to be used in lock ops */
651         ktime_t                 locked_at;      /* Time at which lock obtained */
652         enum afs_lock_state     lock_state : 8;
653         afs_lock_type_t         lock_type : 8;
654
655         /* outstanding callback notification on this file */
656         struct work_struct      cb_work;        /* Work for mmap'd files */
657         struct list_head        cb_mmap_link;   /* Link in cell->fs_open_mmaps */
658         void                    *cb_server;     /* Server with callback/filelock */
659         atomic_t                cb_nr_mmap;     /* Number of mmaps */
660         unsigned int            cb_fs_s_break;  /* Mass server break counter (cell->fs_s_break) */
661         unsigned int            cb_s_break;     /* Mass break counter on ->server */
662         unsigned int            cb_v_break;     /* Mass break counter on ->volume */
663         unsigned int            cb_break;       /* Break counter on vnode */
664         seqlock_t               cb_lock;        /* Lock for ->cb_server, ->status, ->cb_*break */
665
666         time64_t                cb_expires_at;  /* time at which callback expires */
667 };
668
669 static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
670 {
671 #ifdef CONFIG_AFS_FSCACHE
672         return netfs_i_cookie(&vnode->netfs);
673 #else
674         return NULL;
675 #endif
676 }
677
678 static inline void afs_vnode_set_cache(struct afs_vnode *vnode,
679                                        struct fscache_cookie *cookie)
680 {
681 #ifdef CONFIG_AFS_FSCACHE
682         vnode->netfs.cache = cookie;
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         __be64                  data_version;
875 } __packed;
876
877 static inline void afs_set_cache_aux(struct afs_vnode *vnode,
878                                      struct afs_vnode_cache_aux *aux)
879 {
880         aux->data_version = cpu_to_be64(vnode->status.data_version);
881 }
882
883 static inline void afs_invalidate_cache(struct afs_vnode *vnode, unsigned int flags)
884 {
885         struct afs_vnode_cache_aux aux;
886
887         afs_set_cache_aux(vnode, &aux);
888         fscache_invalidate(afs_vnode_cache(vnode), &aux,
889                            i_size_read(&vnode->netfs.inode), flags);
890 }
891
892 /*
893  * We use folio->private to hold the amount of the folio that we've written to,
894  * splitting the field into two parts.  However, we need to represent a range
895  * 0...FOLIO_SIZE, so we reduce the resolution if the size of the folio
896  * exceeds what we can encode.
897  */
898 #ifdef CONFIG_64BIT
899 #define __AFS_FOLIO_PRIV_MASK           0x7fffffffUL
900 #define __AFS_FOLIO_PRIV_SHIFT          32
901 #define __AFS_FOLIO_PRIV_MMAPPED        0x80000000UL
902 #else
903 #define __AFS_FOLIO_PRIV_MASK           0x7fffUL
904 #define __AFS_FOLIO_PRIV_SHIFT          16
905 #define __AFS_FOLIO_PRIV_MMAPPED        0x8000UL
906 #endif
907
908 static inline unsigned int afs_folio_dirty_resolution(struct folio *folio)
909 {
910         int shift = folio_shift(folio) - (__AFS_FOLIO_PRIV_SHIFT - 1);
911         return (shift > 0) ? shift : 0;
912 }
913
914 static inline size_t afs_folio_dirty_from(struct folio *folio, unsigned long priv)
915 {
916         unsigned long x = priv & __AFS_FOLIO_PRIV_MASK;
917
918         /* The lower bound is inclusive */
919         return x << afs_folio_dirty_resolution(folio);
920 }
921
922 static inline size_t afs_folio_dirty_to(struct folio *folio, unsigned long priv)
923 {
924         unsigned long x = (priv >> __AFS_FOLIO_PRIV_SHIFT) & __AFS_FOLIO_PRIV_MASK;
925
926         /* The upper bound is immediately beyond the region */
927         return (x + 1) << afs_folio_dirty_resolution(folio);
928 }
929
930 static inline unsigned long afs_folio_dirty(struct folio *folio, size_t from, size_t to)
931 {
932         unsigned int res = afs_folio_dirty_resolution(folio);
933         from >>= res;
934         to = (to - 1) >> res;
935         return (to << __AFS_FOLIO_PRIV_SHIFT) | from;
936 }
937
938 static inline unsigned long afs_folio_dirty_mmapped(unsigned long priv)
939 {
940         return priv | __AFS_FOLIO_PRIV_MMAPPED;
941 }
942
943 static inline bool afs_is_folio_dirty_mmapped(unsigned long priv)
944 {
945         return priv & __AFS_FOLIO_PRIV_MMAPPED;
946 }
947
948 #include <trace/events/afs.h>
949
950 /*****************************************************************************/
951 /*
952  * addr_list.c
953  */
954 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
955 {
956         if (alist)
957                 refcount_inc(&alist->usage);
958         return alist;
959 }
960 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
961                                                 unsigned short,
962                                                 unsigned short);
963 extern void afs_put_addrlist(struct afs_addr_list *);
964 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
965                                                       const char *, size_t, char,
966                                                       unsigned short, unsigned short);
967 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
968 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
969 extern int afs_end_cursor(struct afs_addr_cursor *);
970
971 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
972 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
973
974 /*
975  * callback.c
976  */
977 extern void afs_invalidate_mmap_work(struct work_struct *);
978 extern void afs_server_init_callback_work(struct work_struct *work);
979 extern void afs_init_callback_state(struct afs_server *);
980 extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
981 extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
982 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
983
984 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
985 {
986         return vnode->cb_break + vnode->cb_v_break;
987 }
988
989 static inline bool afs_cb_is_broken(unsigned int cb_break,
990                                     const struct afs_vnode *vnode)
991 {
992         return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
993 }
994
995 /*
996  * cell.c
997  */
998 extern int afs_cell_init(struct afs_net *, const char *);
999 extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1000                                       enum afs_cell_trace);
1001 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1002                                         const char *, bool);
1003 extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1004 extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1005 extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1006 extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1007 extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1008 extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
1009 extern void afs_manage_cells(struct work_struct *);
1010 extern void afs_cells_timer(struct timer_list *);
1011 extern void __net_exit afs_cell_purge(struct afs_net *);
1012
1013 /*
1014  * cmservice.c
1015  */
1016 extern bool afs_cm_incoming_call(struct afs_call *);
1017
1018 /*
1019  * dir.c
1020  */
1021 extern const struct file_operations afs_dir_file_operations;
1022 extern const struct inode_operations afs_dir_inode_operations;
1023 extern const struct address_space_operations afs_dir_aops;
1024 extern const struct dentry_operations afs_fs_dentry_operations;
1025
1026 extern void afs_d_release(struct dentry *);
1027 extern void afs_check_for_remote_deletion(struct afs_operation *);
1028
1029 /*
1030  * dir_edit.c
1031  */
1032 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1033                              enum afs_edit_dir_reason);
1034 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1035
1036 /*
1037  * dir_silly.c
1038  */
1039 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1040                            struct dentry *, struct key *);
1041 extern int afs_silly_iput(struct dentry *, struct inode *);
1042
1043 /*
1044  * dynroot.c
1045  */
1046 extern const struct inode_operations afs_dynroot_inode_operations;
1047 extern const struct dentry_operations afs_dynroot_dentry_operations;
1048
1049 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
1050 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1051 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1052 extern int afs_dynroot_populate(struct super_block *);
1053 extern void afs_dynroot_depopulate(struct super_block *);
1054
1055 /*
1056  * file.c
1057  */
1058 extern const struct address_space_operations afs_file_aops;
1059 extern const struct address_space_operations afs_symlink_aops;
1060 extern const struct inode_operations afs_file_inode_operations;
1061 extern const struct file_operations afs_file_operations;
1062 extern const struct netfs_request_ops afs_req_ops;
1063
1064 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1065 extern void afs_put_wb_key(struct afs_wb_key *);
1066 extern int afs_open(struct inode *, struct file *);
1067 extern int afs_release(struct inode *, struct file *);
1068 extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
1069 extern struct afs_read *afs_alloc_read(gfp_t);
1070 extern void afs_put_read(struct afs_read *);
1071 extern int afs_write_inode(struct inode *, struct writeback_control *);
1072
1073 static inline struct afs_read *afs_get_read(struct afs_read *req)
1074 {
1075         refcount_inc(&req->usage);
1076         return req;
1077 }
1078
1079 /*
1080  * flock.c
1081  */
1082 extern struct workqueue_struct *afs_lock_manager;
1083
1084 extern void afs_lock_op_done(struct afs_call *);
1085 extern void afs_lock_work(struct work_struct *);
1086 extern void afs_lock_may_be_available(struct afs_vnode *);
1087 extern int afs_lock(struct file *, int, struct file_lock *);
1088 extern int afs_flock(struct file *, int, struct file_lock *);
1089
1090 /*
1091  * fsclient.c
1092  */
1093 extern void afs_fs_fetch_status(struct afs_operation *);
1094 extern void afs_fs_fetch_data(struct afs_operation *);
1095 extern void afs_fs_create_file(struct afs_operation *);
1096 extern void afs_fs_make_dir(struct afs_operation *);
1097 extern void afs_fs_remove_file(struct afs_operation *);
1098 extern void afs_fs_remove_dir(struct afs_operation *);
1099 extern void afs_fs_link(struct afs_operation *);
1100 extern void afs_fs_symlink(struct afs_operation *);
1101 extern void afs_fs_rename(struct afs_operation *);
1102 extern void afs_fs_store_data(struct afs_operation *);
1103 extern void afs_fs_setattr(struct afs_operation *);
1104 extern void afs_fs_get_volume_status(struct afs_operation *);
1105 extern void afs_fs_set_lock(struct afs_operation *);
1106 extern void afs_fs_extend_lock(struct afs_operation *);
1107 extern void afs_fs_release_lock(struct afs_operation *);
1108 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
1109                                         struct afs_addr_cursor *, struct key *);
1110 extern bool afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
1111                                     struct afs_addr_cursor *, struct key *);
1112 extern void afs_fs_inline_bulk_status(struct afs_operation *);
1113
1114 struct afs_acl {
1115         u32     size;
1116         u8      data[];
1117 };
1118
1119 extern void afs_fs_fetch_acl(struct afs_operation *);
1120 extern void afs_fs_store_acl(struct afs_operation *);
1121
1122 /*
1123  * fs_operation.c
1124  */
1125 extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1126 extern int afs_put_operation(struct afs_operation *);
1127 extern bool afs_begin_vnode_operation(struct afs_operation *);
1128 extern void afs_wait_for_operation(struct afs_operation *);
1129 extern int afs_do_sync_operation(struct afs_operation *);
1130
1131 static inline void afs_op_nomem(struct afs_operation *op)
1132 {
1133         op->error = -ENOMEM;
1134 }
1135
1136 static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1137                                     struct afs_vnode *vnode)
1138 {
1139         op->file[n].vnode = vnode;
1140         op->file[n].need_io_lock = true;
1141 }
1142
1143 static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1144                                   const struct afs_fid *fid)
1145 {
1146         op->file[n].fid = *fid;
1147 }
1148
1149 /*
1150  * fs_probe.c
1151  */
1152 extern void afs_fileserver_probe_result(struct afs_call *);
1153 extern void afs_fs_probe_fileserver(struct afs_net *, struct afs_server *, struct key *, bool);
1154 extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
1155 extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1156 extern void afs_fs_probe_dispatcher(struct work_struct *);
1157 extern int afs_wait_for_one_fs_probe(struct afs_server *, bool);
1158 extern void afs_fs_probe_cleanup(struct afs_net *);
1159
1160 /*
1161  * inode.c
1162  */
1163 extern const struct afs_operation_ops afs_fetch_status_operation;
1164
1165 extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1166 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1167 extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1168 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1169 extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1170 extern struct inode *afs_root_iget(struct super_block *, struct key *);
1171 extern bool afs_check_validity(struct afs_vnode *);
1172 extern int afs_validate(struct afs_vnode *, struct key *);
1173 extern int afs_getattr(struct user_namespace *mnt_userns, const struct path *,
1174                        struct kstat *, u32, unsigned int);
1175 extern int afs_setattr(struct user_namespace *mnt_userns, struct dentry *, struct iattr *);
1176 extern void afs_evict_inode(struct inode *);
1177 extern int afs_drop_inode(struct inode *);
1178
1179 /*
1180  * main.c
1181  */
1182 extern struct workqueue_struct *afs_wq;
1183 extern int afs_net_id;
1184
1185 static inline struct afs_net *afs_net(struct net *net)
1186 {
1187         return net_generic(net, afs_net_id);
1188 }
1189
1190 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1191 {
1192         return afs_net(AFS_FS_S(sb)->net_ns);
1193 }
1194
1195 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1196 {
1197         return afs_sb2net(dentry->d_sb);
1198 }
1199
1200 static inline struct afs_net *afs_i2net(struct inode *inode)
1201 {
1202         return afs_sb2net(inode->i_sb);
1203 }
1204
1205 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1206 {
1207         return afs_i2net(&vnode->netfs.inode);
1208 }
1209
1210 static inline struct afs_net *afs_sock2net(struct sock *sk)
1211 {
1212         return net_generic(sock_net(sk), afs_net_id);
1213 }
1214
1215 static inline void __afs_stat(atomic_t *s)
1216 {
1217         atomic_inc(s);
1218 }
1219
1220 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1221
1222 /*
1223  * misc.c
1224  */
1225 extern int afs_abort_to_error(u32);
1226 extern void afs_prioritise_error(struct afs_error *, int, u32);
1227
1228 /*
1229  * mntpt.c
1230  */
1231 extern const struct inode_operations afs_mntpt_inode_operations;
1232 extern const struct inode_operations afs_autocell_inode_operations;
1233 extern const struct file_operations afs_mntpt_file_operations;
1234
1235 extern struct vfsmount *afs_d_automount(struct path *);
1236 extern void afs_mntpt_kill_timer(void);
1237
1238 /*
1239  * proc.c
1240  */
1241 #ifdef CONFIG_PROC_FS
1242 extern int __net_init afs_proc_init(struct afs_net *);
1243 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1244 extern int afs_proc_cell_setup(struct afs_cell *);
1245 extern void afs_proc_cell_remove(struct afs_cell *);
1246 extern void afs_put_sysnames(struct afs_sysnames *);
1247 #else
1248 static inline int afs_proc_init(struct afs_net *net) { return 0; }
1249 static inline void afs_proc_cleanup(struct afs_net *net) {}
1250 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1251 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1252 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1253 #endif
1254
1255 /*
1256  * rotate.c
1257  */
1258 extern bool afs_select_fileserver(struct afs_operation *);
1259 extern void afs_dump_edestaddrreq(const struct afs_operation *);
1260
1261 /*
1262  * rxrpc.c
1263  */
1264 extern struct workqueue_struct *afs_async_calls;
1265
1266 extern int __net_init afs_open_socket(struct afs_net *);
1267 extern void __net_exit afs_close_socket(struct afs_net *);
1268 extern void afs_charge_preallocation(struct work_struct *);
1269 extern void afs_put_call(struct afs_call *);
1270 extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
1271 extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1272 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1273                                             const struct afs_call_type *,
1274                                             size_t, size_t);
1275 extern void afs_flat_call_destructor(struct afs_call *);
1276 extern void afs_send_empty_reply(struct afs_call *);
1277 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1278 extern int afs_extract_data(struct afs_call *, bool);
1279 extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1280
1281 static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1282                                     gfp_t gfp)
1283 {
1284         op->call = call;
1285         op->type = call->type;
1286         call->op = op;
1287         call->key = op->key;
1288         call->intr = !(op->flags & AFS_OPERATION_UNINTR);
1289         afs_make_call(&op->ac, call, gfp);
1290 }
1291
1292 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1293 {
1294         call->iov_len = size;
1295         call->kvec[0].iov_base = buf;
1296         call->kvec[0].iov_len = size;
1297         iov_iter_kvec(&call->def_iter, ITER_DEST, call->kvec, 1, size);
1298 }
1299
1300 static inline void afs_extract_to_tmp(struct afs_call *call)
1301 {
1302         call->iov_len = sizeof(call->tmp);
1303         afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1304 }
1305
1306 static inline void afs_extract_to_tmp64(struct afs_call *call)
1307 {
1308         call->iov_len = sizeof(call->tmp64);
1309         afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1310 }
1311
1312 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1313 {
1314         call->iov_len = size;
1315         iov_iter_discard(&call->def_iter, ITER_DEST, size);
1316 }
1317
1318 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1319 {
1320         call->iov_len = size;
1321         afs_extract_begin(call, call->buffer, size);
1322 }
1323
1324 static inline int afs_transfer_reply(struct afs_call *call)
1325 {
1326         return afs_extract_data(call, false);
1327 }
1328
1329 static inline bool afs_check_call_state(struct afs_call *call,
1330                                         enum afs_call_state state)
1331 {
1332         return READ_ONCE(call->state) == state;
1333 }
1334
1335 static inline bool afs_set_call_state(struct afs_call *call,
1336                                       enum afs_call_state from,
1337                                       enum afs_call_state to)
1338 {
1339         bool ok = false;
1340
1341         spin_lock_bh(&call->state_lock);
1342         if (call->state == from) {
1343                 call->state = to;
1344                 trace_afs_call_state(call, from, to, 0, 0);
1345                 ok = true;
1346         }
1347         spin_unlock_bh(&call->state_lock);
1348         return ok;
1349 }
1350
1351 static inline void afs_set_call_complete(struct afs_call *call,
1352                                          int error, u32 remote_abort)
1353 {
1354         enum afs_call_state state;
1355         bool ok = false;
1356
1357         spin_lock_bh(&call->state_lock);
1358         state = call->state;
1359         if (state != AFS_CALL_COMPLETE) {
1360                 call->abort_code = remote_abort;
1361                 call->error = error;
1362                 call->state = AFS_CALL_COMPLETE;
1363                 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1364                                      error, remote_abort);
1365                 ok = true;
1366         }
1367         spin_unlock_bh(&call->state_lock);
1368         if (ok) {
1369                 trace_afs_call_done(call);
1370
1371                 /* Asynchronous calls have two refs to release - one from the alloc and
1372                  * one queued with the work item - and we can't just deallocate the
1373                  * call because the work item may be queued again.
1374                  */
1375                 if (call->drop_ref)
1376                         afs_put_call(call);
1377         }
1378 }
1379
1380 /*
1381  * security.c
1382  */
1383 extern void afs_put_permits(struct afs_permits *);
1384 extern void afs_clear_permits(struct afs_vnode *);
1385 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1386                              struct afs_status_cb *);
1387 extern struct key *afs_request_key(struct afs_cell *);
1388 extern struct key *afs_request_key_rcu(struct afs_cell *);
1389 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1390 extern int afs_permission(struct user_namespace *, struct inode *, int);
1391 extern void __exit afs_clean_up_permit_cache(void);
1392
1393 /*
1394  * server.c
1395  */
1396 extern spinlock_t afs_server_peer_lock;
1397
1398 extern struct afs_server *afs_find_server(struct afs_net *,
1399                                           const struct sockaddr_rxrpc *);
1400 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1401 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1402 extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1403 extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1404 extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1405 extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1406 extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1407 extern void afs_manage_servers(struct work_struct *);
1408 extern void afs_servers_timer(struct timer_list *);
1409 extern void afs_fs_probe_timer(struct timer_list *);
1410 extern void __net_exit afs_purge_servers(struct afs_net *);
1411 extern bool afs_check_server_record(struct afs_operation *, struct afs_server *);
1412
1413 static inline void afs_inc_servers_outstanding(struct afs_net *net)
1414 {
1415         atomic_inc(&net->servers_outstanding);
1416 }
1417
1418 static inline void afs_dec_servers_outstanding(struct afs_net *net)
1419 {
1420         if (atomic_dec_and_test(&net->servers_outstanding))
1421                 wake_up_var(&net->servers_outstanding);
1422 }
1423
1424 static inline bool afs_is_probing_server(struct afs_server *server)
1425 {
1426         return list_empty(&server->probe_link);
1427 }
1428
1429 /*
1430  * server_list.c
1431  */
1432 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1433 {
1434         refcount_inc(&slist->usage);
1435         return slist;
1436 }
1437
1438 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1439 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1440                                                      struct afs_vldb_entry *,
1441                                                      u8);
1442 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1443
1444 /*
1445  * super.c
1446  */
1447 extern int __init afs_fs_init(void);
1448 extern void afs_fs_exit(void);
1449
1450 /*
1451  * vlclient.c
1452  */
1453 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1454                                                          const char *, int);
1455 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1456 extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
1457                                                 struct key *, struct afs_vlserver *, unsigned int);
1458 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1459 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1460
1461 /*
1462  * vl_alias.c
1463  */
1464 extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1465
1466 /*
1467  * vl_probe.c
1468  */
1469 extern void afs_vlserver_probe_result(struct afs_call *);
1470 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1471 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1472
1473 /*
1474  * vl_rotate.c
1475  */
1476 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1477                                          struct afs_cell *, struct key *);
1478 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1479 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1480 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1481
1482 /*
1483  * vlserver_list.c
1484  */
1485 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1486 {
1487         refcount_inc(&vlserver->ref);
1488         return vlserver;
1489 }
1490
1491 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1492 {
1493         if (vllist)
1494                 refcount_inc(&vllist->ref);
1495         return vllist;
1496 }
1497
1498 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1499 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1500 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1501 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1502 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1503                                                            const void *, size_t);
1504
1505 /*
1506  * volume.c
1507  */
1508 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1509 extern int afs_activate_volume(struct afs_volume *);
1510 extern void afs_deactivate_volume(struct afs_volume *);
1511 extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1512 extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
1513 extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1514
1515 /*
1516  * write.c
1517  */
1518 #ifdef CONFIG_AFS_FSCACHE
1519 bool afs_dirty_folio(struct address_space *, struct folio *);
1520 #else
1521 #define afs_dirty_folio filemap_dirty_folio
1522 #endif
1523 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1524                         loff_t pos, unsigned len,
1525                         struct page **pagep, void **fsdata);
1526 extern int afs_write_end(struct file *file, struct address_space *mapping,
1527                         loff_t pos, unsigned len, unsigned copied,
1528                         struct page *page, void *fsdata);
1529 extern int afs_writepage(struct page *, struct writeback_control *);
1530 extern int afs_writepages(struct address_space *, struct writeback_control *);
1531 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1532 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1533 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1534 extern void afs_prune_wb_keys(struct afs_vnode *);
1535 int afs_launder_folio(struct folio *);
1536
1537 /*
1538  * xattr.c
1539  */
1540 extern const struct xattr_handler *afs_xattr_handlers[];
1541
1542 /*
1543  * yfsclient.c
1544  */
1545 extern void yfs_fs_fetch_data(struct afs_operation *);
1546 extern void yfs_fs_create_file(struct afs_operation *);
1547 extern void yfs_fs_make_dir(struct afs_operation *);
1548 extern void yfs_fs_remove_file2(struct afs_operation *);
1549 extern void yfs_fs_remove_file(struct afs_operation *);
1550 extern void yfs_fs_remove_dir(struct afs_operation *);
1551 extern void yfs_fs_link(struct afs_operation *);
1552 extern void yfs_fs_symlink(struct afs_operation *);
1553 extern void yfs_fs_rename(struct afs_operation *);
1554 extern void yfs_fs_store_data(struct afs_operation *);
1555 extern void yfs_fs_setattr(struct afs_operation *);
1556 extern void yfs_fs_get_volume_status(struct afs_operation *);
1557 extern void yfs_fs_set_lock(struct afs_operation *);
1558 extern void yfs_fs_extend_lock(struct afs_operation *);
1559 extern void yfs_fs_release_lock(struct afs_operation *);
1560 extern void yfs_fs_fetch_status(struct afs_operation *);
1561 extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1562
1563 struct yfs_acl {
1564         struct afs_acl  *acl;           /* Dir/file/symlink ACL */
1565         struct afs_acl  *vol_acl;       /* Whole volume ACL */
1566         u32             inherit_flag;   /* True if ACL is inherited from parent dir */
1567         u32             num_cleaned;    /* Number of ACEs removed due to subject removal */
1568         unsigned int    flags;
1569 #define YFS_ACL_WANT_ACL        0x01    /* Set if caller wants ->acl */
1570 #define YFS_ACL_WANT_VOL_ACL    0x02    /* Set if caller wants ->vol_acl */
1571 };
1572
1573 extern void yfs_free_opaque_acl(struct yfs_acl *);
1574 extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1575 extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1576
1577 /*
1578  * Miscellaneous inline functions.
1579  */
1580 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1581 {
1582         return container_of(inode, struct afs_vnode, netfs.inode);
1583 }
1584
1585 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1586 {
1587         return &vnode->netfs.inode;
1588 }
1589
1590 /*
1591  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1592  * number derived from the result of the operation.  It doesn't matter if
1593  * d_fsdata goes backwards as we'll just revalidate.
1594  */
1595 static inline void afs_update_dentry_version(struct afs_operation *op,
1596                                              struct afs_vnode_param *dir_vp,
1597                                              struct dentry *dentry)
1598 {
1599         if (!op->error)
1600                 dentry->d_fsdata =
1601                         (void *)(unsigned long)dir_vp->scb.status.data_version;
1602 }
1603
1604 /*
1605  * Set the file size and block count.  Estimate the number of 512 bytes blocks
1606  * used, rounded up to nearest 1K for consistency with other AFS clients.
1607  */
1608 static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
1609 {
1610         i_size_write(&vnode->netfs.inode, size);
1611         vnode->netfs.inode.i_blocks = ((size + 1023) >> 10) << 1;
1612 }
1613
1614 /*
1615  * Check for a conflicting operation on a directory that we just unlinked from.
1616  * If someone managed to sneak a link or an unlink in on the file we just
1617  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1618  */
1619 static inline void afs_check_dir_conflict(struct afs_operation *op,
1620                                           struct afs_vnode_param *dvp)
1621 {
1622         if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1623                 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1624 }
1625
1626 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1627 {
1628         trace_afs_io_error(call->debug_id, -EIO, where);
1629         return -EIO;
1630 }
1631
1632 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1633 {
1634         trace_afs_file_error(vnode, -EIO, where);
1635         return -EIO;
1636 }
1637
1638 /*****************************************************************************/
1639 /*
1640  * debug tracing
1641  */
1642 extern unsigned afs_debug;
1643
1644 #define dbgprintk(FMT,...) \
1645         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1646
1647 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1648 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1649 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1650
1651
1652 #if defined(__KDEBUG)
1653 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1654 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1655 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1656
1657 #elif defined(CONFIG_AFS_DEBUG)
1658 #define AFS_DEBUG_KENTER        0x01
1659 #define AFS_DEBUG_KLEAVE        0x02
1660 #define AFS_DEBUG_KDEBUG        0x04
1661
1662 #define _enter(FMT,...)                                 \
1663 do {                                                    \
1664         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
1665                 kenter(FMT,##__VA_ARGS__);              \
1666 } while (0)
1667
1668 #define _leave(FMT,...)                                 \
1669 do {                                                    \
1670         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
1671                 kleave(FMT,##__VA_ARGS__);              \
1672 } while (0)
1673
1674 #define _debug(FMT,...)                                 \
1675 do {                                                    \
1676         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
1677                 kdebug(FMT,##__VA_ARGS__);              \
1678 } while (0)
1679
1680 #else
1681 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1682 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1683 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1684 #endif
1685
1686 /*
1687  * debug assertion checking
1688  */
1689 #if 1 // defined(__KDEBUGALL)
1690
1691 #define ASSERT(X)                                               \
1692 do {                                                            \
1693         if (unlikely(!(X))) {                                   \
1694                 printk(KERN_ERR "\n");                          \
1695                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1696                 BUG();                                          \
1697         }                                                       \
1698 } while(0)
1699
1700 #define ASSERTCMP(X, OP, Y)                                             \
1701 do {                                                                    \
1702         if (unlikely(!((X) OP (Y)))) {                                  \
1703                 printk(KERN_ERR "\n");                                  \
1704                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1705                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1706                        (unsigned long)(X), (unsigned long)(Y));         \
1707                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1708                        (unsigned long)(X), (unsigned long)(Y));         \
1709                 BUG();                                                  \
1710         }                                                               \
1711 } while(0)
1712
1713 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
1714 do {                                                                    \
1715         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
1716                 printk(KERN_ERR "\n");                                  \
1717                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1718                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1719                        (unsigned long)(L), (unsigned long)(N),          \
1720                        (unsigned long)(H));                             \
1721                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1722                        (unsigned long)(L), (unsigned long)(N),          \
1723                        (unsigned long)(H));                             \
1724                 BUG();                                                  \
1725         }                                                               \
1726 } while(0)
1727
1728 #define ASSERTIF(C, X)                                          \
1729 do {                                                            \
1730         if (unlikely((C) && !(X))) {                            \
1731                 printk(KERN_ERR "\n");                          \
1732                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1733                 BUG();                                          \
1734         }                                                       \
1735 } while(0)
1736
1737 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1738 do {                                                                    \
1739         if (unlikely((C) && !((X) OP (Y)))) {                           \
1740                 printk(KERN_ERR "\n");                                  \
1741                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1742                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1743                        (unsigned long)(X), (unsigned long)(Y));         \
1744                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1745                        (unsigned long)(X), (unsigned long)(Y));         \
1746                 BUG();                                                  \
1747         }                                                               \
1748 } while(0)
1749
1750 #else
1751
1752 #define ASSERT(X)                               \
1753 do {                                            \
1754 } while(0)
1755
1756 #define ASSERTCMP(X, OP, Y)                     \
1757 do {                                            \
1758 } while(0)
1759
1760 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
1761 do {                                            \
1762 } while(0)
1763
1764 #define ASSERTIF(C, X)                          \
1765 do {                                            \
1766 } while(0)
1767
1768 #define ASSERTIFCMP(C, X, OP, Y)                \
1769 do {                                            \
1770 } while(0)
1771
1772 #endif /* __KDEBUGALL */