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