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         bool                    speculative:1;  /* T if speculative status fetch (no vnode lock) */
 759 };
 760
 761 /*
 762  * Fileserver operation wrapper, handling server and address rotation
 763  * asynchronously.  May make simultaneous calls to multiple servers.
 764  */
 765 struct afs_operation {
 766         struct afs_net          *net;           /* Network namespace */
 767         struct key              *key;           /* Key for the cell */
 768         const struct afs_call_type *type;       /* Type of call done */
 769         const struct afs_operation_ops *ops;
 770
 771         /* Parameters/results for the operation */
 772         struct afs_volume       *volume;        /* Volume being accessed */
 773         struct afs_vnode_param  file[2];
 774         struct afs_vnode_param  *more_files;
 775         struct afs_volsync      volsync;
 776         struct dentry           *dentry;        /* Dentry to be altered */
 777         struct dentry           *dentry_2;      /* Second dentry to be altered */
 778         struct timespec64       mtime;          /* Modification time to record */
 779         struct timespec64       ctime;          /* Change time to set */
 780         short                   nr_files;       /* Number of entries in file[], more_files */
 781         short                   error;
 782         unsigned int            debug_id;
 783
 784         unsigned int            cb_v_break;     /* Volume break counter before op */
 785         unsigned int            cb_s_break;     /* Server break counter before op */
 786
 787         union {
 788                 struct {
 789                         int     which;          /* Which ->file[] to fetch for */
 790                 } fetch_status;
 791                 struct {
 792                         int     reason;         /* enum afs_edit_dir_reason */
 793                         mode_t  mode;
 794                         const char *symlink;
 795                 } create;
 796                 struct {
 797                         bool    need_rehash;
 798                 } unlink;
 799                 struct {
 800                         struct dentry *rehash;
 801                         struct dentry *tmp;
 802                         bool    new_negative;
 803                 } rename;
 804                 struct {
 805                         struct afs_read *req;
 806                 } fetch;
 807                 struct {
 808                         afs_lock_type_t type;
 809                 } lock;
 810                 struct {
 811                         struct address_space *mapping;  /* Pages being written from */
 812                         pgoff_t         first;          /* first page in mapping to deal with */
 813                         pgoff_t         last;           /* last page in mapping to deal with */
 814                         unsigned        first_offset;   /* offset into mapping[first] */
 815                         unsigned        last_to;        /* amount of mapping[last] */
 816                         bool            laundering;     /* Laundering page, PG_writeback not set */
 817                 } store;
 818                 struct {
 819                         struct iattr    *attr;
 820                         loff_t          old_i_size;
 821                 } setattr;
 822                 struct afs_acl  *acl;
 823                 struct yfs_acl  *yacl;
 824                 struct {
 825                         struct afs_volume_status vs;
 826                         struct kstatfs          *buf;
 827                 } volstatus;
 828         };
 829
 830         /* Fileserver iteration state */
 831         struct afs_addr_cursor  ac;
 832         struct afs_server_list  *server_list;   /* Current server list (pins ref) */
 833         struct afs_server       *server;        /* Server we're using (ref pinned by server_list) */
 834         struct afs_call         *call;
 835         unsigned long           untried;        /* Bitmask of untried servers */
 836         short                   index;          /* Current server */
 837         unsigned short          nr_iterations;  /* Number of server iterations */
 838
 839         unsigned int            flags;
 840 #define AFS_OPERATION_STOP              0x0001  /* Set to cease iteration */
 841 #define AFS_OPERATION_VBUSY             0x0002  /* Set if seen VBUSY */
 842 #define AFS_OPERATION_VMOVED            0x0004  /* Set if seen VMOVED */
 843 #define AFS_OPERATION_VNOVOL            0x0008  /* Set if seen VNOVOL */
 844 #define AFS_OPERATION_CUR_ONLY          0x0010  /* Set if current server only (file lock held) */
 845 #define AFS_OPERATION_NO_VSLEEP         0x0020  /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
 846 #define AFS_OPERATION_UNINTR            0x0040  /* Set if op is uninterruptible */
 847 #define AFS_OPERATION_DOWNGRADE         0x0080  /* Set to retry with downgraded opcode */
 848 #define AFS_OPERATION_LOCK_0            0x0100  /* Set if have io_lock on file[0] */
 849 #define AFS_OPERATION_LOCK_1            0x0200  /* Set if have io_lock on file[1] */
 850 #define AFS_OPERATION_TRIED_ALL         0x0400  /* Set if we've tried all the fileservers */
 851 #define AFS_OPERATION_RETRY_SERVER      0x0800  /* Set if we should retry the current server */
 852 #define AFS_OPERATION_DIR_CONFLICT      0x1000  /* Set if we detected a 3rd-party dir change */
 853 };
 854
 855 /*
 856  * Cache auxiliary data.
 857  */
 858 struct afs_vnode_cache_aux {
 859         u64                     data_version;
 860 } __packed;
 861
 862 /*
 863  * We use page->private to hold the amount of the page that we've written to,
 864  * splitting the field into two parts.  However, we need to represent a range
 865  * 0...PAGE_SIZE, so we reduce the resolution if the size of the page
 866  * exceeds what we can encode.
 867  */
 868 #ifdef CONFIG_64BIT
 869 #define __AFS_PAGE_PRIV_MASK    0x7fffffffUL
 870 #define __AFS_PAGE_PRIV_SHIFT   32
 871 #define __AFS_PAGE_PRIV_MMAPPED 0x80000000UL
 872 #else
 873 #define __AFS_PAGE_PRIV_MASK    0x7fffUL
 874 #define __AFS_PAGE_PRIV_SHIFT   16
 875 #define __AFS_PAGE_PRIV_MMAPPED 0x8000UL
 876 #endif
 877
 878 static inline unsigned int afs_page_dirty_resolution(void)
 879 {
 880         int shift = PAGE_SHIFT - (__AFS_PAGE_PRIV_SHIFT - 1);
 881         return (shift > 0) ? shift : 0;
 882 }
 883
 884 static inline size_t afs_page_dirty_from(unsigned long priv)
 885 {
 886         unsigned long x = priv & __AFS_PAGE_PRIV_MASK;
 887
 888         /* The lower bound is inclusive */
 889         return x << afs_page_dirty_resolution();
 890 }
 891
 892 static inline size_t afs_page_dirty_to(unsigned long priv)
 893 {
 894         unsigned long x = (priv >> __AFS_PAGE_PRIV_SHIFT) & __AFS_PAGE_PRIV_MASK;
 895
 896         /* The upper bound is immediately beyond the region */
 897         return (x + 1) << afs_page_dirty_resolution();
 898 }
 899
 900 static inline unsigned long afs_page_dirty(size_t from, size_t to)
 901 {
 902         unsigned int res = afs_page_dirty_resolution();
 903         from >>= res;
 904         to = (to - 1) >> res;
 905         return (to << __AFS_PAGE_PRIV_SHIFT) | from;
 906 }
 907
 908 static inline unsigned long afs_page_dirty_mmapped(unsigned long priv)
 909 {
 910         return priv | __AFS_PAGE_PRIV_MMAPPED;
 911 }
 912
 913 static inline bool afs_is_page_dirty_mmapped(unsigned long priv)
 914 {
 915         return priv & __AFS_PAGE_PRIV_MMAPPED;
 916 }
 917
 918 #include <trace/events/afs.h>
 919
 920 /*****************************************************************************/
 921 /*
 922  * addr_list.c
 923  */
 924 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
 925 {
 926         if (alist)
 927                 refcount_inc(&alist->usage);
 928         return alist;
 929 }
 930 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
 931                                                 unsigned short,
 932                                                 unsigned short);
 933 extern void afs_put_addrlist(struct afs_addr_list *);
 934 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
 935                                                       const char *, size_t, char,
 936                                                       unsigned short, unsigned short);
 937 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
 938 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
 939 extern int afs_end_cursor(struct afs_addr_cursor *);
 940
 941 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
 942 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
 943
 944 /*
 945  * cache.c
 946  */
 947 #ifdef CONFIG_AFS_FSCACHE
 948 extern struct fscache_netfs afs_cache_netfs;
 949 extern struct fscache_cookie_def afs_cell_cache_index_def;
 950 extern struct fscache_cookie_def afs_volume_cache_index_def;
 951 extern struct fscache_cookie_def afs_vnode_cache_index_def;
 952 #else
 953 #define afs_cell_cache_index_def        (*(struct fscache_cookie_def *) NULL)
 954 #define afs_volume_cache_index_def      (*(struct fscache_cookie_def *) NULL)
 955 #define afs_vnode_cache_index_def       (*(struct fscache_cookie_def *) NULL)
 956 #endif
 957
 958 /*
 959  * callback.c
 960  */
 961 extern void afs_init_callback_state(struct afs_server *);
 962 extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
 963 extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
 964 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
 965
 966 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
 967 {
 968         return vnode->cb_break + vnode->cb_v_break;
 969 }
 970
 971 static inline bool afs_cb_is_broken(unsigned int cb_break,
 972                                     const struct afs_vnode *vnode)
 973 {
 974         return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
 975 }
 976
 977 /*
 978  * cell.c
 979  */
 980 extern int afs_cell_init(struct afs_net *, const char *);
 981 extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
 982                                       enum afs_cell_trace);
 983 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
 984                                         const char *, bool);
 985 extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
 986 extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
 987 extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
 988 extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
 989 extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
 990 extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
 991 extern void afs_manage_cells(struct work_struct *);
 992 extern void afs_cells_timer(struct timer_list *);
 993 extern void __net_exit afs_cell_purge(struct afs_net *);
 994
 995 /*
 996  * cmservice.c
 997  */
 998 extern bool afs_cm_incoming_call(struct afs_call *);
 999
1000 /*
1001  * dir.c
1002  */
1003 extern const struct file_operations afs_dir_file_operations;
1004 extern const struct inode_operations afs_dir_inode_operations;
1005 extern const struct address_space_operations afs_dir_aops;
1006 extern const struct dentry_operations afs_fs_dentry_operations;
1007
1008 extern void afs_d_release(struct dentry *);
1009 extern void afs_check_for_remote_deletion(struct afs_operation *);
1010
1011 /*
1012  * dir_edit.c
1013  */
1014 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1015                              enum afs_edit_dir_reason);
1016 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1017
1018 /*
1019  * dir_silly.c
1020  */
1021 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1022                            struct dentry *, struct key *);
1023 extern int afs_silly_iput(struct dentry *, struct inode *);
1024
1025 /*
1026  * dynroot.c
1027  */
1028 extern const struct inode_operations afs_dynroot_inode_operations;
1029 extern const struct dentry_operations afs_dynroot_dentry_operations;
1030
1031 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
1032 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1033 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1034 extern int afs_dynroot_populate(struct super_block *);
1035 extern void afs_dynroot_depopulate(struct super_block *);
1036
1037 /*
1038  * file.c
1039  */
1040 extern const struct address_space_operations afs_fs_aops;
1041 extern const struct inode_operations afs_file_inode_operations;
1042 extern const struct file_operations afs_file_operations;
1043
1044 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1045 extern void afs_put_wb_key(struct afs_wb_key *);
1046 extern int afs_open(struct inode *, struct file *);
1047 extern int afs_release(struct inode *, struct file *);
1048 extern int afs_fetch_data(struct afs_vnode *, struct key *, struct afs_read *);
1049 extern int afs_page_filler(void *, struct page *);
1050 extern void afs_put_read(struct afs_read *);
1051
1052 static inline struct afs_read *afs_get_read(struct afs_read *req)
1053 {
1054         refcount_inc(&req->usage);
1055         return req;
1056 }
1057
1058 /*
1059  * flock.c
1060  */
1061 extern struct workqueue_struct *afs_lock_manager;
1062
1063 extern void afs_lock_op_done(struct afs_call *);
1064 extern void afs_lock_work(struct work_struct *);
1065 extern void afs_lock_may_be_available(struct afs_vnode *);
1066 extern int afs_lock(struct file *, int, struct file_lock *);
1067 extern int afs_flock(struct file *, int, struct file_lock *);
1068
1069 /*
1070  * fsclient.c
1071  */
1072 extern void afs_fs_fetch_status(struct afs_operation *);
1073 extern void afs_fs_fetch_data(struct afs_operation *);
1074 extern void afs_fs_create_file(struct afs_operation *);
1075 extern void afs_fs_make_dir(struct afs_operation *);
1076 extern void afs_fs_remove_file(struct afs_operation *);
1077 extern void afs_fs_remove_dir(struct afs_operation *);
1078 extern void afs_fs_link(struct afs_operation *);
1079 extern void afs_fs_symlink(struct afs_operation *);
1080 extern void afs_fs_rename(struct afs_operation *);
1081 extern void afs_fs_store_data(struct afs_operation *);
1082 extern void afs_fs_setattr(struct afs_operation *);
1083 extern void afs_fs_get_volume_status(struct afs_operation *);
1084 extern void afs_fs_set_lock(struct afs_operation *);
1085 extern void afs_fs_extend_lock(struct afs_operation *);
1086 extern void afs_fs_release_lock(struct afs_operation *);
1087 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
1088                                         struct afs_addr_cursor *, struct key *);
1089 extern bool afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
1090                                     struct afs_addr_cursor *, struct key *);
1091 extern void afs_fs_inline_bulk_status(struct afs_operation *);
1092
1093 struct afs_acl {
1094         u32     size;
1095         u8      data[];
1096 };
1097
1098 extern void afs_fs_fetch_acl(struct afs_operation *);
1099 extern void afs_fs_store_acl(struct afs_operation *);
1100
1101 /*
1102  * fs_operation.c
1103  */
1104 extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1105 extern int afs_put_operation(struct afs_operation *);
1106 extern bool afs_begin_vnode_operation(struct afs_operation *);
1107 extern void afs_wait_for_operation(struct afs_operation *);
1108 extern int afs_do_sync_operation(struct afs_operation *);
1109
1110 static inline void afs_op_nomem(struct afs_operation *op)
1111 {
1112         op->error = -ENOMEM;
1113 }
1114
1115 static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1116                                     struct afs_vnode *vnode)
1117 {
1118         op->file[n].vnode = vnode;
1119         op->file[n].need_io_lock = true;
1120 }
1121
1122 static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1123                                   const struct afs_fid *fid)
1124 {
1125         op->file[n].fid = *fid;
1126 }
1127
1128 /*
1129  * fs_probe.c
1130  */
1131 extern void afs_fileserver_probe_result(struct afs_call *);
1132 extern void afs_fs_probe_fileserver(struct afs_net *, struct afs_server *, struct key *, bool);
1133 extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
1134 extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1135 extern void afs_fs_probe_dispatcher(struct work_struct *);
1136 extern int afs_wait_for_one_fs_probe(struct afs_server *, bool);
1137 extern void afs_fs_probe_cleanup(struct afs_net *);
1138
1139 /*
1140  * inode.c
1141  */
1142 extern const struct afs_operation_ops afs_fetch_status_operation;
1143
1144 extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1145 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1146 extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1147 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1148 extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1149 extern struct inode *afs_root_iget(struct super_block *, struct key *);
1150 extern bool afs_check_validity(struct afs_vnode *);
1151 extern int afs_validate(struct afs_vnode *, struct key *);
1152 extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
1153 extern int afs_setattr(struct dentry *, struct iattr *);
1154 extern void afs_evict_inode(struct inode *);
1155 extern int afs_drop_inode(struct inode *);
1156
1157 /*
1158  * main.c
1159  */
1160 extern struct workqueue_struct *afs_wq;
1161 extern int afs_net_id;
1162
1163 static inline struct afs_net *afs_net(struct net *net)
1164 {
1165         return net_generic(net, afs_net_id);
1166 }
1167
1168 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1169 {
1170         return afs_net(AFS_FS_S(sb)->net_ns);
1171 }
1172
1173 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1174 {
1175         return afs_sb2net(dentry->d_sb);
1176 }
1177
1178 static inline struct afs_net *afs_i2net(struct inode *inode)
1179 {
1180         return afs_sb2net(inode->i_sb);
1181 }
1182
1183 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1184 {
1185         return afs_i2net(&vnode->vfs_inode);
1186 }
1187
1188 static inline struct afs_net *afs_sock2net(struct sock *sk)
1189 {
1190         return net_generic(sock_net(sk), afs_net_id);
1191 }
1192
1193 static inline void __afs_stat(atomic_t *s)
1194 {
1195         atomic_inc(s);
1196 }
1197
1198 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1199
1200 /*
1201  * misc.c
1202  */
1203 extern int afs_abort_to_error(u32);
1204 extern void afs_prioritise_error(struct afs_error *, int, u32);
1205
1206 /*
1207  * mntpt.c
1208  */
1209 extern const struct inode_operations afs_mntpt_inode_operations;
1210 extern const struct inode_operations afs_autocell_inode_operations;
1211 extern const struct file_operations afs_mntpt_file_operations;
1212
1213 extern struct vfsmount *afs_d_automount(struct path *);
1214 extern void afs_mntpt_kill_timer(void);
1215
1216 /*
1217  * proc.c
1218  */
1219 #ifdef CONFIG_PROC_FS
1220 extern int __net_init afs_proc_init(struct afs_net *);
1221 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1222 extern int afs_proc_cell_setup(struct afs_cell *);
1223 extern void afs_proc_cell_remove(struct afs_cell *);
1224 extern void afs_put_sysnames(struct afs_sysnames *);
1225 #else
1226 static inline int afs_proc_init(struct afs_net *net) { return 0; }
1227 static inline void afs_proc_cleanup(struct afs_net *net) {}
1228 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1229 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1230 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1231 #endif
1232
1233 /*
1234  * rotate.c
1235  */
1236 extern bool afs_select_fileserver(struct afs_operation *);
1237 extern void afs_dump_edestaddrreq(const struct afs_operation *);
1238
1239 /*
1240  * rxrpc.c
1241  */
1242 extern struct workqueue_struct *afs_async_calls;
1243
1244 extern int __net_init afs_open_socket(struct afs_net *);
1245 extern void __net_exit afs_close_socket(struct afs_net *);
1246 extern void afs_charge_preallocation(struct work_struct *);
1247 extern void afs_put_call(struct afs_call *);
1248 extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
1249 extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1250 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1251                                             const struct afs_call_type *,
1252                                             size_t, size_t);
1253 extern void afs_flat_call_destructor(struct afs_call *);
1254 extern void afs_send_empty_reply(struct afs_call *);
1255 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1256 extern int afs_extract_data(struct afs_call *, bool);
1257 extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1258
1259 static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1260                                     gfp_t gfp)
1261 {
1262         op->call = call;
1263         op->type = call->type;
1264         call->op = op;
1265         call->key = op->key;
1266         call->intr = !(op->flags & AFS_OPERATION_UNINTR);
1267         afs_make_call(&op->ac, call, gfp);
1268 }
1269
1270 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1271 {
1272         call->kvec[0].iov_base = buf;
1273         call->kvec[0].iov_len = size;
1274         iov_iter_kvec(&call->def_iter, READ, call->kvec, 1, size);
1275 }
1276
1277 static inline void afs_extract_to_tmp(struct afs_call *call)
1278 {
1279         afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1280 }
1281
1282 static inline void afs_extract_to_tmp64(struct afs_call *call)
1283 {
1284         afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1285 }
1286
1287 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1288 {
1289         iov_iter_discard(&call->def_iter, READ, size);
1290 }
1291
1292 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1293 {
1294         afs_extract_begin(call, call->buffer, size);
1295 }
1296
1297 static inline int afs_transfer_reply(struct afs_call *call)
1298 {
1299         return afs_extract_data(call, false);
1300 }
1301
1302 static inline bool afs_check_call_state(struct afs_call *call,
1303                                         enum afs_call_state state)
1304 {
1305         return READ_ONCE(call->state) == state;
1306 }
1307
1308 static inline bool afs_set_call_state(struct afs_call *call,
1309                                       enum afs_call_state from,
1310                                       enum afs_call_state to)
1311 {
1312         bool ok = false;
1313
1314         spin_lock_bh(&call->state_lock);
1315         if (call->state == from) {
1316                 call->state = to;
1317                 trace_afs_call_state(call, from, to, 0, 0);
1318                 ok = true;
1319         }
1320         spin_unlock_bh(&call->state_lock);
1321         return ok;
1322 }
1323
1324 static inline void afs_set_call_complete(struct afs_call *call,
1325                                          int error, u32 remote_abort)
1326 {
1327         enum afs_call_state state;
1328         bool ok = false;
1329
1330         spin_lock_bh(&call->state_lock);
1331         state = call->state;
1332         if (state != AFS_CALL_COMPLETE) {
1333                 call->abort_code = remote_abort;
1334                 call->error = error;
1335                 call->state = AFS_CALL_COMPLETE;
1336                 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1337                                      error, remote_abort);
1338                 ok = true;
1339         }
1340         spin_unlock_bh(&call->state_lock);
1341         if (ok) {
1342                 trace_afs_call_done(call);
1343
1344                 /* Asynchronous calls have two refs to release - one from the alloc and
1345                  * one queued with the work item - and we can't just deallocate the
1346                  * call because the work item may be queued again.
1347                  */
1348                 if (call->drop_ref)
1349                         afs_put_call(call);
1350         }
1351 }
1352
1353 /*
1354  * security.c
1355  */
1356 extern void afs_put_permits(struct afs_permits *);
1357 extern void afs_clear_permits(struct afs_vnode *);
1358 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1359                              struct afs_status_cb *);
1360 extern void afs_zap_permits(struct rcu_head *);
1361 extern struct key *afs_request_key(struct afs_cell *);
1362 extern struct key *afs_request_key_rcu(struct afs_cell *);
1363 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1364 extern int afs_permission(struct inode *, int);
1365 extern void __exit afs_clean_up_permit_cache(void);
1366
1367 /*
1368  * server.c
1369  */
1370 extern spinlock_t afs_server_peer_lock;
1371
1372 extern struct afs_server *afs_find_server(struct afs_net *,
1373                                           const struct sockaddr_rxrpc *);
1374 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1375 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1376 extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1377 extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1378 extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1379 extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1380 extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1381 extern void afs_manage_servers(struct work_struct *);
1382 extern void afs_servers_timer(struct timer_list *);
1383 extern void afs_fs_probe_timer(struct timer_list *);
1384 extern void __net_exit afs_purge_servers(struct afs_net *);
1385 extern bool afs_check_server_record(struct afs_operation *, struct afs_server *);
1386
1387 static inline void afs_inc_servers_outstanding(struct afs_net *net)
1388 {
1389         atomic_inc(&net->servers_outstanding);
1390 }
1391
1392 static inline void afs_dec_servers_outstanding(struct afs_net *net)
1393 {
1394         if (atomic_dec_and_test(&net->servers_outstanding))
1395                 wake_up_var(&net->servers_outstanding);
1396 }
1397
1398 static inline bool afs_is_probing_server(struct afs_server *server)
1399 {
1400         return list_empty(&server->probe_link);
1401 }
1402
1403 /*
1404  * server_list.c
1405  */
1406 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1407 {
1408         refcount_inc(&slist->usage);
1409         return slist;
1410 }
1411
1412 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1413 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1414                                                      struct afs_vldb_entry *,
1415                                                      u8);
1416 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1417
1418 /*
1419  * super.c
1420  */
1421 extern int __init afs_fs_init(void);
1422 extern void afs_fs_exit(void);
1423
1424 /*
1425  * vlclient.c
1426  */
1427 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1428                                                          const char *, int);
1429 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1430 extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
1431                                                 struct key *, struct afs_vlserver *, unsigned int);
1432 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1433 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1434
1435 /*
1436  * vl_alias.c
1437  */
1438 extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1439
1440 /*
1441  * vl_probe.c
1442  */
1443 extern void afs_vlserver_probe_result(struct afs_call *);
1444 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1445 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1446
1447 /*
1448  * vl_rotate.c
1449  */
1450 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1451                                          struct afs_cell *, struct key *);
1452 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1453 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1454 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1455
1456 /*
1457  * vlserver_list.c
1458  */
1459 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1460 {
1461         atomic_inc(&vlserver->usage);
1462         return vlserver;
1463 }
1464
1465 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1466 {
1467         if (vllist)
1468                 atomic_inc(&vllist->usage);
1469         return vllist;
1470 }
1471
1472 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1473 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1474 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1475 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1476 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1477                                                            const void *, size_t);
1478
1479 /*
1480  * volume.c
1481  */
1482 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1483 extern void afs_activate_volume(struct afs_volume *);
1484 extern void afs_deactivate_volume(struct afs_volume *);
1485 extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1486 extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
1487 extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1488
1489 /*
1490  * write.c
1491  */
1492 extern int afs_set_page_dirty(struct page *);
1493 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1494                         loff_t pos, unsigned len, unsigned flags,
1495                         struct page **pagep, void **fsdata);
1496 extern int afs_write_end(struct file *file, struct address_space *mapping,
1497                         loff_t pos, unsigned len, unsigned copied,
1498                         struct page *page, void *fsdata);
1499 extern int afs_writepage(struct page *, struct writeback_control *);
1500 extern int afs_writepages(struct address_space *, struct writeback_control *);
1501 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1502 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1503 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1504 extern void afs_prune_wb_keys(struct afs_vnode *);
1505 extern int afs_launder_page(struct page *);
1506
1507 /*
1508  * xattr.c
1509  */
1510 extern const struct xattr_handler *afs_xattr_handlers[];
1511 extern ssize_t afs_listxattr(struct dentry *, char *, size_t);
1512
1513 /*
1514  * yfsclient.c
1515  */
1516 extern void yfs_fs_fetch_data(struct afs_operation *);
1517 extern void yfs_fs_create_file(struct afs_operation *);
1518 extern void yfs_fs_make_dir(struct afs_operation *);
1519 extern void yfs_fs_remove_file2(struct afs_operation *);
1520 extern void yfs_fs_remove_file(struct afs_operation *);
1521 extern void yfs_fs_remove_dir(struct afs_operation *);
1522 extern void yfs_fs_link(struct afs_operation *);
1523 extern void yfs_fs_symlink(struct afs_operation *);
1524 extern void yfs_fs_rename(struct afs_operation *);
1525 extern void yfs_fs_store_data(struct afs_operation *);
1526 extern void yfs_fs_setattr(struct afs_operation *);
1527 extern void yfs_fs_get_volume_status(struct afs_operation *);
1528 extern void yfs_fs_set_lock(struct afs_operation *);
1529 extern void yfs_fs_extend_lock(struct afs_operation *);
1530 extern void yfs_fs_release_lock(struct afs_operation *);
1531 extern void yfs_fs_fetch_status(struct afs_operation *);
1532 extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1533
1534 struct yfs_acl {
1535         struct afs_acl  *acl;           /* Dir/file/symlink ACL */
1536         struct afs_acl  *vol_acl;       /* Whole volume ACL */
1537         u32             inherit_flag;   /* True if ACL is inherited from parent dir */
1538         u32             num_cleaned;    /* Number of ACEs removed due to subject removal */
1539         unsigned int    flags;
1540 #define YFS_ACL_WANT_ACL        0x01    /* Set if caller wants ->acl */
1541 #define YFS_ACL_WANT_VOL_ACL    0x02    /* Set if caller wants ->vol_acl */
1542 };
1543
1544 extern void yfs_free_opaque_acl(struct yfs_acl *);
1545 extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1546 extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1547
1548 /*
1549  * Miscellaneous inline functions.
1550  */
1551 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1552 {
1553         return container_of(inode, struct afs_vnode, vfs_inode);
1554 }
1555
1556 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1557 {
1558         return &vnode->vfs_inode;
1559 }
1560
1561 /*
1562  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1563  * number derived from the result of the operation.  It doesn't matter if
1564  * d_fsdata goes backwards as we'll just revalidate.
1565  */
1566 static inline void afs_update_dentry_version(struct afs_operation *op,
1567                                              struct afs_vnode_param *dir_vp,
1568                                              struct dentry *dentry)
1569 {
1570         if (!op->error)
1571                 dentry->d_fsdata =
1572                         (void *)(unsigned long)dir_vp->scb.status.data_version;
1573 }
1574
1575 /*
1576  * Check for a conflicting operation on a directory that we just unlinked from.
1577  * If someone managed to sneak a link or an unlink in on the file we just
1578  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1579  */
1580 static inline void afs_check_dir_conflict(struct afs_operation *op,
1581                                           struct afs_vnode_param *dvp)
1582 {
1583         if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1584                 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1585 }
1586
1587 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1588 {
1589         trace_afs_io_error(call->debug_id, -EIO, where);
1590         return -EIO;
1591 }
1592
1593 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1594 {
1595         trace_afs_file_error(vnode, -EIO, where);
1596         return -EIO;
1597 }
1598
1599 /*****************************************************************************/
1600 /*
1601  * debug tracing
1602  */
1603 extern unsigned afs_debug;
1604
1605 #define dbgprintk(FMT,...) \
1606         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1607
1608 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1609 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1610 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1611
1612
1613 #if defined(__KDEBUG)
1614 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1615 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1616 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1617
1618 #elif defined(CONFIG_AFS_DEBUG)
1619 #define AFS_DEBUG_KENTER        0x01
1620 #define AFS_DEBUG_KLEAVE        0x02
1621 #define AFS_DEBUG_KDEBUG        0x04
1622
1623 #define _enter(FMT,...)                                 \
1624 do {                                                    \
1625         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
1626                 kenter(FMT,##__VA_ARGS__);              \
1627 } while (0)
1628
1629 #define _leave(FMT,...)                                 \
1630 do {                                                    \
1631         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
1632                 kleave(FMT,##__VA_ARGS__);              \
1633 } while (0)
1634
1635 #define _debug(FMT,...)                                 \
1636 do {                                                    \
1637         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
1638                 kdebug(FMT,##__VA_ARGS__);              \
1639 } while (0)
1640
1641 #else
1642 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1643 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1644 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1645 #endif
1646
1647 /*
1648  * debug assertion checking
1649  */
1650 #if 1 // defined(__KDEBUGALL)
1651
1652 #define ASSERT(X)                                               \
1653 do {                                                            \
1654         if (unlikely(!(X))) {                                   \
1655                 printk(KERN_ERR "\n");                          \
1656                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1657                 BUG();                                          \
1658         }                                                       \
1659 } while(0)
1660
1661 #define ASSERTCMP(X, OP, Y)                                             \
1662 do {                                                                    \
1663         if (unlikely(!((X) OP (Y)))) {                                  \
1664                 printk(KERN_ERR "\n");                                  \
1665                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1666                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1667                        (unsigned long)(X), (unsigned long)(Y));         \
1668                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1669                        (unsigned long)(X), (unsigned long)(Y));         \
1670                 BUG();                                                  \
1671         }                                                               \
1672 } while(0)
1673
1674 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
1675 do {                                                                    \
1676         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
1677                 printk(KERN_ERR "\n");                                  \
1678                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1679                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1680                        (unsigned long)(L), (unsigned long)(N),          \
1681                        (unsigned long)(H));                             \
1682                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1683                        (unsigned long)(L), (unsigned long)(N),          \
1684                        (unsigned long)(H));                             \
1685                 BUG();                                                  \
1686         }                                                               \
1687 } while(0)
1688
1689 #define ASSERTIF(C, X)                                          \
1690 do {                                                            \
1691         if (unlikely((C) && !(X))) {                            \
1692                 printk(KERN_ERR "\n");                          \
1693                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1694                 BUG();                                          \
1695         }                                                       \
1696 } while(0)
1697
1698 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1699 do {                                                                    \
1700         if (unlikely((C) && !((X) OP (Y)))) {                           \
1701                 printk(KERN_ERR "\n");                                  \
1702                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1703                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1704                        (unsigned long)(X), (unsigned long)(Y));         \
1705                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1706                        (unsigned long)(X), (unsigned long)(Y));         \
1707                 BUG();                                                  \
1708         }                                                               \
1709 } while(0)
1710
1711 #else
1712
1713 #define ASSERT(X)                               \
1714 do {                                            \
1715 } while(0)
1716
1717 #define ASSERTCMP(X, OP, Y)                     \
1718 do {                                            \
1719 } while(0)
1720
1721 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
1722 do {                                            \
1723 } while(0)
1724
1725 #define ASSERTIF(C, X)                          \
1726 do {                                            \
1727 } while(0)
1728
1729 #define ASSERTIFCMP(C, X, OP, Y)                \
1730 do {                                            \
1731 } while(0)
1732
1733 #endif /* __KDEBUGALL */