fs/afs/internal.h

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