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