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         struct rw_semaphore     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
 426         /* VL server list. */
 427         rwlock_t                vl_servers_lock; /* Lock on vl_servers */
 428         struct afs_vlserver_list __rcu *vl_servers;
 429
 430         u8                      name_len;       /* Length of name */
 431         char                    *name;          /* Cell name, case-flattened and NUL-padded */
 432 };
 433
 434 /*
 435  * Volume Location server record.
 436  */
 437 struct afs_vlserver {
 438         struct rcu_head         rcu;
 439         struct afs_addr_list    __rcu *addresses; /* List of addresses for this VL server */
 440         unsigned long           flags;
 441 #define AFS_VLSERVER_FL_PROBED  0               /* The VL server has been probed */
 442 #define AFS_VLSERVER_FL_PROBING 1               /* VL server is being probed */
 443 #define AFS_VLSERVER_FL_IS_YFS  2               /* Server is YFS not AFS */
 444 #define AFS_VLSERVER_FL_RESPONDING 3            /* VL server is responding */
 445         rwlock_t                lock;           /* Lock on addresses */
 446         refcount_t              ref;
 447         unsigned int            rtt;            /* Server's current RTT in uS */
 448         unsigned int            debug_id;
 449
 450         /* Probe state */
 451         wait_queue_head_t       probe_wq;
 452         atomic_t                probe_outstanding;
 453         spinlock_t              probe_lock;
 454         struct {
 455                 unsigned int    rtt;            /* Best RTT in uS (or UINT_MAX) */
 456                 u32             abort_code;
 457                 short           error;
 458                 unsigned short  flags;
 459 #define AFS_VLSERVER_PROBE_RESPONDED            0x01 /* At least once response (may be abort) */
 460 #define AFS_VLSERVER_PROBE_IS_YFS               0x02 /* The peer appears to be YFS */
 461 #define AFS_VLSERVER_PROBE_NOT_YFS              0x04 /* The peer appears not to be YFS */
 462 #define AFS_VLSERVER_PROBE_LOCAL_FAILURE        0x08 /* A local failure prevented a probe */
 463         } probe;
 464
 465         u16                     service_id;     /* Service ID we're using */
 466         u16                     port;
 467         u16                     name_len;       /* Length of name */
 468         char                    name[];         /* Server name, case-flattened */
 469 };
 470
 471 /*
 472  * Weighted list of Volume Location servers.
 473  */
 474 struct afs_vlserver_entry {
 475         u16                     priority;       /* Preference (as SRV) */
 476         u16                     weight;         /* Weight (as SRV) */
 477         enum dns_record_source  source:8;
 478         enum dns_lookup_status  status:8;
 479         struct afs_vlserver     *server;
 480 };
 481
 482 struct afs_vlserver_list {
 483         struct rcu_head         rcu;
 484         refcount_t              ref;
 485         u8                      nr_servers;
 486         u8                      index;          /* Server currently in use */
 487         u8                      preferred;      /* Preferred server */
 488         enum dns_record_source  source:8;
 489         enum dns_lookup_status  status:8;
 490         rwlock_t                lock;
 491         struct afs_vlserver_entry servers[];
 492 };
 493
 494 /*
 495  * Cached VLDB entry.
 496  *
 497  * This is pointed to by cell->vldb_entries, indexed by name.
 498  */
 499 struct afs_vldb_entry {
 500         afs_volid_t             vid[3];         /* Volume IDs for R/W, R/O and Bak volumes */
 501
 502         unsigned long           flags;
 503 #define AFS_VLDB_HAS_RW         0               /* - R/W volume exists */
 504 #define AFS_VLDB_HAS_RO         1               /* - R/O volume exists */
 505 #define AFS_VLDB_HAS_BAK        2               /* - Backup volume exists */
 506 #define AFS_VLDB_QUERY_VALID    3               /* - Record is valid */
 507 #define AFS_VLDB_QUERY_ERROR    4               /* - VL server returned error */
 508
 509         uuid_t                  fs_server[AFS_NMAXNSERVERS];
 510         u32                     addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
 511         u8                      fs_mask[AFS_NMAXNSERVERS];
 512 #define AFS_VOL_VTM_RW  0x01 /* R/W version of the volume is available (on this server) */
 513 #define AFS_VOL_VTM_RO  0x02 /* R/O version of the volume is available (on this server) */
 514 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
 515         u8                      vlsf_flags[AFS_NMAXNSERVERS];
 516         short                   error;
 517         u8                      nr_servers;     /* Number of server records */
 518         u8                      name_len;
 519         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
 520 };
 521
 522 /*
 523  * Fileserver endpoint state.  The records the addresses of a fileserver's
 524  * endpoints and the state and result of a round of probing on them.  This
 525  * allows the rotation algorithm to access those results without them being
 526  * erased by a subsequent round of probing.
 527  */
 528 struct afs_endpoint_state {
 529         struct rcu_head         rcu;
 530         struct afs_addr_list    *addresses;     /* The addresses being probed */
 531         unsigned long           responsive_set; /* Bitset of responsive endpoints */
 532         unsigned long           failed_set;     /* Bitset of endpoints we failed to probe */
 533         refcount_t              ref;
 534         unsigned int            server_id;      /* Debug ID of server */
 535         unsigned int            probe_seq;      /* Probe sequence (from server::probe_counter) */
 536         atomic_t                nr_probing;     /* Number of outstanding probes */
 537         unsigned int            rtt;            /* Best RTT in uS (or UINT_MAX) */
 538         s32                     abort_code;
 539         short                   error;
 540         unsigned long           flags;
 541 #define AFS_ESTATE_RESPONDED    0               /* Set if the server responded */
 542 #define AFS_ESTATE_SUPERSEDED   1               /* Set if this record has been superseded */
 543 #define AFS_ESTATE_IS_YFS       2               /* Set if probe upgraded to YFS */
 544 #define AFS_ESTATE_NOT_YFS      3               /* Set if probe didn't upgrade to YFS */
 545 #define AFS_ESTATE_LOCAL_FAILURE 4              /* Set if there was a local failure (eg. ENOMEM) */
 546 };
 547
 548 /*
 549  * Record of fileserver with which we're actively communicating.
 550  */
 551 struct afs_server {
 552         struct rcu_head         rcu;
 553         union {
 554                 uuid_t          uuid;           /* Server ID */
 555                 struct afs_uuid _uuid;
 556         };
 557
 558         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
 559         struct rb_node          uuid_rb;        /* Link in net->fs_servers */
 560         struct afs_server __rcu *uuid_next;     /* Next server with same UUID */
 561         struct afs_server       *uuid_prev;     /* Previous server with same UUID */
 562         struct list_head        probe_link;     /* Link in net->fs_probe_list */
 563         struct hlist_node       addr4_link;     /* Link in net->fs_addresses4 */
 564         struct hlist_node       addr6_link;     /* Link in net->fs_addresses6 */
 565         struct hlist_node       proc_link;      /* Link in net->fs_proc */
 566         struct list_head        volumes;        /* RCU list of afs_server_entry objects */
 567         struct afs_server       *gc_next;       /* Next server in manager's list */
 568         time64_t                unuse_time;     /* Time at which last unused */
 569         unsigned long           flags;
 570 #define AFS_SERVER_FL_RESPONDING 0              /* The server is responding */
 571 #define AFS_SERVER_FL_UPDATING  1
 572 #define AFS_SERVER_FL_NEEDS_UPDATE 2            /* Fileserver address list is out of date */
 573 #define AFS_SERVER_FL_NOT_READY 4               /* The record is not ready for use */
 574 #define AFS_SERVER_FL_NOT_FOUND 5               /* VL server says no such server */
 575 #define AFS_SERVER_FL_VL_FAIL   6               /* Failed to access VL server */
 576 #define AFS_SERVER_FL_MAY_HAVE_CB 8             /* May have callbacks on this fileserver */
 577 #define AFS_SERVER_FL_IS_YFS    16              /* Server is YFS not AFS */
 578 #define AFS_SERVER_FL_NO_IBULK  17              /* Fileserver doesn't support FS.InlineBulkStatus */
 579 #define AFS_SERVER_FL_NO_RM2    18              /* Fileserver doesn't support YFS.RemoveFile2 */
 580 #define AFS_SERVER_FL_HAS_FS64  19              /* Fileserver supports FS.{Fetch,Store}Data64 */
 581         refcount_t              ref;            /* Object refcount */
 582         atomic_t                active;         /* Active user count */
 583         u32                     addr_version;   /* Address list version */
 584         u16                     service_id;     /* Service ID we're using. */
 585         unsigned int            rtt;            /* Server's current RTT in uS */
 586         unsigned int            debug_id;       /* Debugging ID for traces */
 587
 588         /* file service access */
 589         rwlock_t                fs_lock;        /* access lock */
 590
 591         /* Probe state */
 592         struct afs_endpoint_state __rcu *endpoint_state; /* Latest endpoint/probe state */
 593         unsigned long           probed_at;      /* Time last probe was dispatched (jiffies) */
 594         wait_queue_head_t       probe_wq;
 595         unsigned int            probe_counter;  /* Number of probes issued */
 596         spinlock_t              probe_lock;
 597 };
 598
 599 enum afs_ro_replicating {
 600         AFS_RO_NOT_REPLICATING,                 /* Not doing replication */
 601         AFS_RO_REPLICATING_USE_OLD,             /* Replicating; use old version */
 602         AFS_RO_REPLICATING_USE_NEW,             /* Replicating; switch to new version */
 603 } __mode(byte);
 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         time64_t                cb_expires_at;  /* Time at which volume-level callback expires */
 613         unsigned long           flags;
 614 #define AFS_SE_EXCLUDED         0               /* Set if server is to be excluded in rotation */
 615 #define AFS_SE_VOLUME_OFFLINE   1               /* Set if volume offline notice given */
 616 #define AFS_SE_VOLUME_BUSY      2               /* Set if volume busy notice given */
 617 };
 618
 619 struct afs_server_list {
 620         struct rcu_head         rcu;
 621         refcount_t              usage;
 622         bool                    attached;       /* T if attached to servers */
 623         enum afs_ro_replicating ro_replicating; /* RW->RO update (probably) in progress */
 624         unsigned char           nr_servers;
 625         unsigned short          vnovol_mask;    /* Servers to be skipped due to VNOVOL */
 626         unsigned int            seq;            /* Set to ->servers_seq when installed */
 627         rwlock_t                lock;
 628         struct afs_server_entry servers[];
 629 };
 630
 631 /*
 632  * Live AFS volume management.
 633  */
 634 struct afs_volume {
 635         struct rcu_head rcu;
 636         afs_volid_t             vid;            /* The volume ID of this volume */
 637         afs_volid_t             vids[AFS_MAXTYPES]; /* All associated volume IDs */
 638         refcount_t              ref;
 639         time64_t                update_at;      /* Time at which to next update */
 640         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
 641         struct rb_node          cell_node;      /* Link in cell->volumes */
 642         struct hlist_node       proc_link;      /* Link in cell->proc_volumes */
 643         struct super_block __rcu *sb;           /* Superblock on which inodes reside */
 644         struct work_struct      destructor;     /* Deferred destructor */
 645         unsigned long           flags;
 646 #define AFS_VOLUME_NEEDS_UPDATE 0       /* - T if an update needs performing */
 647 #define AFS_VOLUME_UPDATING     1       /* - T if an update is in progress */
 648 #define AFS_VOLUME_WAIT         2       /* - T if users must wait for update */
 649 #define AFS_VOLUME_DELETED      3       /* - T if volume appears deleted */
 650 #define AFS_VOLUME_MAYBE_NO_IBULK 4     /* - T if some servers don't have InlineBulkStatus */
 651 #define AFS_VOLUME_RM_TREE      5       /* - Set if volume removed from cell->volumes */
 652 #ifdef CONFIG_AFS_FSCACHE
 653         struct fscache_volume   *cache;         /* Caching cookie */
 654 #endif
 655         struct afs_server_list __rcu *servers;  /* List of servers on which volume resides */
 656         rwlock_t                servers_lock;   /* Lock for ->servers */
 657         unsigned int            servers_seq;    /* Incremented each time ->servers changes */
 658
 659         /* RO release tracking */
 660         struct mutex            volsync_lock;   /* Time/state evaluation lock */
 661         time64_t                creation_time;  /* Volume creation time (or TIME64_MIN) */
 662         time64_t                update_time;    /* Volume update time (or TIME64_MIN) */
 663
 664         /* Callback management */
 665         struct mutex            cb_check_lock;  /* Lock to control race to check after v_break */
 666         time64_t                cb_expires_at;  /* Earliest volume callback expiry time */
 667         atomic_t                cb_ro_snapshot; /* RO volume update-from-snapshot counter */
 668         atomic_t                cb_v_break;     /* Volume-break event counter. */
 669         atomic_t                cb_v_check;     /* Volume-break has-been-checked counter. */
 670         atomic_t                cb_scrub;       /* Scrub-all-data event counter. */
 671         rwlock_t                cb_v_break_lock;
 672         struct rw_semaphore     open_mmaps_lock;
 673         struct list_head        open_mmaps;     /* List of vnodes that are mmapped */
 674
 675         afs_voltype_t           type;           /* type of volume */
 676         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
 677         u8                      name_len;
 678         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
 679 };
 680
 681 enum afs_lock_state {
 682         AFS_VNODE_LOCK_NONE,            /* The vnode has no lock on the server */
 683         AFS_VNODE_LOCK_WAITING_FOR_CB,  /* We're waiting for the server to break the callback */
 684         AFS_VNODE_LOCK_SETTING,         /* We're asking the server for a lock */
 685         AFS_VNODE_LOCK_GRANTED,         /* We have a lock on the server */
 686         AFS_VNODE_LOCK_EXTENDING,       /* We're extending a lock on the server */
 687         AFS_VNODE_LOCK_NEED_UNLOCK,     /* We need to unlock on the server */
 688         AFS_VNODE_LOCK_UNLOCKING,       /* We're telling the server to unlock */
 689         AFS_VNODE_LOCK_DELETED,         /* The vnode has been deleted whilst we have a lock */
 690 };
 691
 692 /*
 693  * AFS inode private data.
 694  *
 695  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
 696  * leak from one inode to another.
 697  */
 698 struct afs_vnode {
 699         struct netfs_inode      netfs;          /* Netfslib context and vfs inode */
 700         struct afs_volume       *volume;        /* volume on which vnode resides */
 701         struct afs_fid          fid;            /* the file identifier for this inode */
 702         struct afs_file_status  status;         /* AFS status info for this file */
 703         afs_dataversion_t       invalid_before; /* Child dentries are invalid before this */
 704         struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
 705         struct mutex            io_lock;        /* Lock for serialising I/O on this mutex */
 706         struct rw_semaphore     validate_lock;  /* lock for validating this vnode */
 707         struct rw_semaphore     rmdir_lock;     /* Lock for rmdir vs sillyrename */
 708         struct key              *silly_key;     /* Silly rename key */
 709         spinlock_t              wb_lock;        /* lock for wb_keys */
 710         spinlock_t              lock;           /* waitqueue/flags lock */
 711         unsigned long           flags;
 712 #define AFS_VNODE_UNSET         1               /* set if vnode attributes not yet set */
 713 #define AFS_VNODE_DIR_VALID     2               /* Set if dir contents are valid */
 714 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
 715 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
 716 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
 717 #define AFS_VNODE_AUTOCELL      6               /* set if Vnode is an auto mount point */
 718 #define AFS_VNODE_PSEUDODIR     7               /* set if Vnode is a pseudo directory */
 719 #define AFS_VNODE_NEW_CONTENT   8               /* Set if file has new content (create/trunc-0) */
 720 #define AFS_VNODE_SILLY_DELETED 9               /* Set if file has been silly-deleted */
 721 #define AFS_VNODE_MODIFYING     10              /* Set if we're performing a modification op */
 722
 723         struct list_head        wb_keys;        /* List of keys available for writeback */
 724         struct list_head        pending_locks;  /* locks waiting to be granted */
 725         struct list_head        granted_locks;  /* locks granted on this file */
 726         struct delayed_work     lock_work;      /* work to be done in locking */
 727         struct key              *lock_key;      /* Key to be used in lock ops */
 728         ktime_t                 locked_at;      /* Time at which lock obtained */
 729         enum afs_lock_state     lock_state : 8;
 730         afs_lock_type_t         lock_type : 8;
 731
 732         /* outstanding callback notification on this file */
 733         struct work_struct      cb_work;        /* Work for mmap'd files */
 734         struct list_head        cb_mmap_link;   /* Link in cell->fs_open_mmaps */
 735         void                    *cb_server;     /* Server with callback/filelock */
 736         atomic_t                cb_nr_mmap;     /* Number of mmaps */
 737         unsigned int            cb_ro_snapshot; /* RO volume release counter on ->volume */
 738         unsigned int            cb_scrub;       /* Scrub counter on ->volume */
 739         unsigned int            cb_break;       /* Break counter on vnode */
 740         unsigned int            cb_v_check;     /* Break check counter on ->volume */
 741         seqlock_t               cb_lock;        /* Lock for ->cb_server, ->status, ->cb_*break */
 742
 743         atomic64_t              cb_expires_at;  /* time at which callback expires */
 744 #define AFS_NO_CB_PROMISE TIME64_MIN
 745 };
 746
 747 static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
 748 {
 749 #ifdef CONFIG_AFS_FSCACHE
 750         return netfs_i_cookie(&vnode->netfs);
 751 #else
 752         return NULL;
 753 #endif
 754 }
 755
 756 static inline void afs_vnode_set_cache(struct afs_vnode *vnode,
 757                                        struct fscache_cookie *cookie)
 758 {
 759 #ifdef CONFIG_AFS_FSCACHE
 760         vnode->netfs.cache = cookie;
 761         if (cookie)
 762                 mapping_set_release_always(vnode->netfs.inode.i_mapping);
 763 #endif
 764 }
 765
 766 /*
 767  * cached security record for one user's attempt to access a vnode
 768  */
 769 struct afs_permit {
 770         struct key              *key;           /* RxRPC ticket holding a security context */
 771         afs_access_t            access;         /* CallerAccess value for this key */
 772 };
 773
 774 /*
 775  * Immutable cache of CallerAccess records from attempts to access vnodes.
 776  * These may be shared between multiple vnodes.
 777  */
 778 struct afs_permits {
 779         struct rcu_head         rcu;
 780         struct hlist_node       hash_node;      /* Link in hash */
 781         unsigned long           h;              /* Hash value for this permit list */
 782         refcount_t              usage;
 783         unsigned short          nr_permits;     /* Number of records */
 784         bool                    invalidated;    /* Invalidated due to key change */
 785         struct afs_permit       permits[] __counted_by(nr_permits);     /* List of permits sorted by key pointer */
 786 };
 787
 788 /*
 789  * Error prioritisation and accumulation.
 790  */
 791 struct afs_error {
 792         s32     abort_code;             /* Cumulative abort code */
 793         short   error;                  /* Cumulative error */
 794         bool    responded;              /* T if server responded */
 795         bool    aborted;                /* T if ->error is from an abort */
 796 };
 797
 798 /*
 799  * Cursor for iterating over a set of volume location servers.
 800  */
 801 struct afs_vl_cursor {
 802         struct afs_cell         *cell;          /* The cell we're querying */
 803         struct afs_vlserver_list *server_list;  /* Current server list (pins ref) */
 804         struct afs_vlserver     *server;        /* Server on which this resides */
 805         struct afs_addr_list    *alist;         /* Current address list (pins ref) */
 806         struct key              *key;           /* Key for the server */
 807         unsigned long           untried_servers; /* Bitmask of untried servers */
 808         unsigned long           addr_tried;     /* Tried addresses */
 809         struct afs_error        cumul_error;    /* Cumulative error */
 810         unsigned int            debug_id;
 811         s32                     call_abort_code;
 812         short                   call_error;     /* Error from single call */
 813         short                   server_index;   /* Current server */
 814         signed char             addr_index;     /* Current address */
 815         unsigned short          flags;
 816 #define AFS_VL_CURSOR_STOP      0x0001          /* Set to cease iteration */
 817 #define AFS_VL_CURSOR_RETRY     0x0002          /* Set to do a retry */
 818 #define AFS_VL_CURSOR_RETRIED   0x0004          /* Set if started a retry */
 819         short                   nr_iterations;  /* Number of server iterations */
 820         bool                    call_responded; /* T if the current address responded */
 821 };
 822
 823 /*
 824  * Fileserver state tracking for an operation.  An array of these is kept,
 825  * indexed by server index.
 826  */
 827 struct afs_server_state {
 828         /* Tracking of fileserver probe state.  Other operations may interfere
 829          * by probing a fileserver when accessing other volumes.
 830          */
 831         unsigned int            probe_seq;
 832         unsigned long           untried_addrs;  /* Addresses we haven't tried yet */
 833         struct wait_queue_entry probe_waiter;
 834         struct afs_endpoint_state *endpoint_state; /* Endpoint state being monitored */
 835 };
 836
 837 /*
 838  * Fileserver operation methods.
 839  */
 840 struct afs_operation_ops {
 841         void (*issue_afs_rpc)(struct afs_operation *op);
 842         void (*issue_yfs_rpc)(struct afs_operation *op);
 843         void (*success)(struct afs_operation *op);
 844         void (*aborted)(struct afs_operation *op);
 845         void (*failed)(struct afs_operation *op);
 846         void (*edit_dir)(struct afs_operation *op);
 847         void (*put)(struct afs_operation *op);
 848 };
 849
 850 struct afs_vnode_param {
 851         struct afs_vnode        *vnode;
 852         struct afs_fid          fid;            /* Fid to access */
 853         struct afs_status_cb    scb;            /* Returned status and callback promise */
 854         afs_dataversion_t       dv_before;      /* Data version before the call */
 855         unsigned int            cb_break_before; /* cb_break before the call */
 856         u8                      dv_delta;       /* Expected change in data version */
 857         bool                    put_vnode:1;    /* T if we have a ref on the vnode */
 858         bool                    need_io_lock:1; /* T if we need the I/O lock on this */
 859         bool                    update_ctime:1; /* Need to update the ctime */
 860         bool                    set_size:1;     /* Must update i_size */
 861         bool                    op_unlinked:1;  /* True if file was unlinked by op */
 862         bool                    speculative:1;  /* T if speculative status fetch (no vnode lock) */
 863         bool                    modification:1; /* Set if the content gets modified */
 864 };
 865
 866 /*
 867  * Fileserver operation wrapper, handling server and address rotation
 868  * asynchronously.  May make simultaneous calls to multiple servers.
 869  */
 870 struct afs_operation {
 871         struct afs_net          *net;           /* Network namespace */
 872         struct key              *key;           /* Key for the cell */
 873         const struct afs_call_type *type;       /* Type of call done */
 874         const struct afs_operation_ops *ops;
 875
 876         /* Parameters/results for the operation */
 877         struct afs_volume       *volume;        /* Volume being accessed */
 878         struct afs_vnode_param  file[2];
 879         struct afs_vnode_param  *more_files;
 880         struct afs_volsync      pre_volsync;    /* Volsync before op */
 881         struct afs_volsync      volsync;        /* Volsync returned by op */
 882         struct dentry           *dentry;        /* Dentry to be altered */
 883         struct dentry           *dentry_2;      /* Second dentry to be altered */
 884         struct timespec64       mtime;          /* Modification time to record */
 885         struct timespec64       ctime;          /* Change time to set */
 886         struct afs_error        cumul_error;    /* Cumulative error */
 887         short                   nr_files;       /* Number of entries in file[], more_files */
 888         unsigned int            debug_id;
 889
 890         unsigned int            cb_v_break;     /* Volume break counter before op */
 891
 892         union {
 893                 struct {
 894                         int     which;          /* Which ->file[] to fetch for */
 895                 } fetch_status;
 896                 struct {
 897                         int     reason;         /* enum afs_edit_dir_reason */
 898                         mode_t  mode;
 899                         const char *symlink;
 900                 } create;
 901                 struct {
 902                         bool    need_rehash;
 903                 } unlink;
 904                 struct {
 905                         struct dentry *rehash;
 906                         struct dentry *tmp;
 907                         bool    new_negative;
 908                 } rename;
 909                 struct {
 910                         struct afs_read *req;
 911                 } fetch;
 912                 struct {
 913                         afs_lock_type_t type;
 914                 } lock;
 915                 struct {
 916                         struct iov_iter *write_iter;
 917                         loff_t  pos;
 918                         loff_t  size;
 919                         loff_t  i_size;
 920                         bool    laundering;     /* Laundering page, PG_writeback not set */
 921                 } store;
 922                 struct {
 923                         struct iattr    *attr;
 924                         loff_t          old_i_size;
 925                 } setattr;
 926                 struct afs_acl  *acl;
 927                 struct yfs_acl  *yacl;
 928                 struct {
 929                         struct afs_volume_status vs;
 930                         struct kstatfs          *buf;
 931                 } volstatus;
 932         };
 933
 934         /* Fileserver iteration state */
 935         struct afs_server_list  *server_list;   /* Current server list (pins ref) */
 936         struct afs_server       *server;        /* Server we're using (ref pinned by server_list) */
 937         struct afs_endpoint_state *estate;      /* Current endpoint state (doesn't pin ref) */
 938         struct afs_server_state *server_states; /* States of the servers involved */
 939         struct afs_call         *call;
 940         unsigned long           untried_servers; /* Bitmask of untried servers */
 941         unsigned long           addr_tried;     /* Tried addresses */
 942         s32                     call_abort_code; /* Abort code from single call */
 943         short                   call_error;     /* Error from single call */
 944         short                   server_index;   /* Current server */
 945         short                   nr_iterations;  /* Number of server iterations */
 946         signed char             addr_index;     /* Current address */
 947         bool                    call_responded; /* T if the current address responded */
 948
 949         unsigned int            flags;
 950 #define AFS_OPERATION_STOP              0x0001  /* Set to cease iteration */
 951 #define AFS_OPERATION_VBUSY             0x0002  /* Set if seen VBUSY */
 952 #define AFS_OPERATION_VMOVED            0x0004  /* Set if seen VMOVED */
 953 #define AFS_OPERATION_VNOVOL            0x0008  /* Set if seen VNOVOL */
 954 #define AFS_OPERATION_CUR_ONLY          0x0010  /* Set if current server only (file lock held) */
 955 #define AFS_OPERATION_NO_VSLEEP         0x0020  /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
 956 #define AFS_OPERATION_UNINTR            0x0040  /* Set if op is uninterruptible */
 957 #define AFS_OPERATION_DOWNGRADE         0x0080  /* Set to retry with downgraded opcode */
 958 #define AFS_OPERATION_LOCK_0            0x0100  /* Set if have io_lock on file[0] */
 959 #define AFS_OPERATION_LOCK_1            0x0200  /* Set if have io_lock on file[1] */
 960 #define AFS_OPERATION_TRIED_ALL         0x0400  /* Set if we've tried all the fileservers */
 961 #define AFS_OPERATION_RETRY_SERVER      0x0800  /* Set if we should retry the current server */
 962 #define AFS_OPERATION_DIR_CONFLICT      0x1000  /* Set if we detected a 3rd-party dir change */
 963 };
 964
 965 /*
 966  * Cache auxiliary data.
 967  */
 968 struct afs_vnode_cache_aux {
 969         __be64                  data_version;
 970 } __packed;
 971
 972 static inline void afs_set_cache_aux(struct afs_vnode *vnode,
 973                                      struct afs_vnode_cache_aux *aux)
 974 {
 975         aux->data_version = cpu_to_be64(vnode->status.data_version);
 976 }
 977
 978 static inline void afs_invalidate_cache(struct afs_vnode *vnode, unsigned int flags)
 979 {
 980         struct afs_vnode_cache_aux aux;
 981
 982         afs_set_cache_aux(vnode, &aux);
 983         fscache_invalidate(afs_vnode_cache(vnode), &aux,
 984                            i_size_read(&vnode->netfs.inode), flags);
 985 }
 986
 987 /*
 988  * We use folio->private to hold the amount of the folio that we've written to,
 989  * splitting the field into two parts.  However, we need to represent a range
 990  * 0...FOLIO_SIZE, so we reduce the resolution if the size of the folio
 991  * exceeds what we can encode.
 992  */
 993 #ifdef CONFIG_64BIT
 994 #define __AFS_FOLIO_PRIV_MASK           0x7fffffffUL
 995 #define __AFS_FOLIO_PRIV_SHIFT          32
 996 #define __AFS_FOLIO_PRIV_MMAPPED        0x80000000UL
 997 #else
 998 #define __AFS_FOLIO_PRIV_MASK           0x7fffUL
 999 #define __AFS_FOLIO_PRIV_SHIFT          16
1000 #define __AFS_FOLIO_PRIV_MMAPPED        0x8000UL
1001 #endif
1002
1003 static inline unsigned int afs_folio_dirty_resolution(struct folio *folio)
1004 {
1005         int shift = folio_shift(folio) - (__AFS_FOLIO_PRIV_SHIFT - 1);
1006         return (shift > 0) ? shift : 0;
1007 }
1008
1009 static inline size_t afs_folio_dirty_from(struct folio *folio, unsigned long priv)
1010 {
1011         unsigned long x = priv & __AFS_FOLIO_PRIV_MASK;
1012
1013         /* The lower bound is inclusive */
1014         return x << afs_folio_dirty_resolution(folio);
1015 }
1016
1017 static inline size_t afs_folio_dirty_to(struct folio *folio, unsigned long priv)
1018 {
1019         unsigned long x = (priv >> __AFS_FOLIO_PRIV_SHIFT) & __AFS_FOLIO_PRIV_MASK;
1020
1021         /* The upper bound is immediately beyond the region */
1022         return (x + 1) << afs_folio_dirty_resolution(folio);
1023 }
1024
1025 static inline unsigned long afs_folio_dirty(struct folio *folio, size_t from, size_t to)
1026 {
1027         unsigned int res = afs_folio_dirty_resolution(folio);
1028         from >>= res;
1029         to = (to - 1) >> res;
1030         return (to << __AFS_FOLIO_PRIV_SHIFT) | from;
1031 }
1032
1033 static inline unsigned long afs_folio_dirty_mmapped(unsigned long priv)
1034 {
1035         return priv | __AFS_FOLIO_PRIV_MMAPPED;
1036 }
1037
1038 static inline bool afs_is_folio_dirty_mmapped(unsigned long priv)
1039 {
1040         return priv & __AFS_FOLIO_PRIV_MMAPPED;
1041 }
1042
1043 #include <trace/events/afs.h>
1044
1045 /*****************************************************************************/
1046 /*
1047  * addr_list.c
1048  */
1049 struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
1050 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int nr);
1051 extern void afs_put_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
1052 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
1053                                                       const char *, size_t, char,
1054                                                       unsigned short, unsigned short);
1055 bool afs_addr_list_same(const struct afs_addr_list *a,
1056                         const struct afs_addr_list *b);
1057 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
1058
1059 extern int afs_merge_fs_addr4(struct afs_net *net, struct afs_addr_list *addr,
1060                               __be32 xdr, u16 port);
1061 extern int afs_merge_fs_addr6(struct afs_net *net, struct afs_addr_list *addr,
1062                               __be32 *xdr, u16 port);
1063
1064 /*
1065  * addr_prefs.c
1066  */
1067 int afs_proc_addr_prefs_write(struct file *file, char *buf, size_t size);
1068 void afs_get_address_preferences_rcu(struct afs_net *net, struct afs_addr_list *alist);
1069 void afs_get_address_preferences(struct afs_net *net, struct afs_addr_list *alist);
1070
1071 /*
1072  * callback.c
1073  */
1074 extern void afs_invalidate_mmap_work(struct work_struct *);
1075 extern void afs_init_callback_state(struct afs_server *);
1076 extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1077 extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1078 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
1079
1080 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
1081 {
1082         return vnode->cb_break + vnode->cb_ro_snapshot + vnode->cb_scrub;
1083 }
1084
1085 static inline bool afs_cb_is_broken(unsigned int cb_break,
1086                                     const struct afs_vnode *vnode)
1087 {
1088         return cb_break != (vnode->cb_break +
1089                             atomic_read(&vnode->volume->cb_ro_snapshot) +
1090                             atomic_read(&vnode->volume->cb_scrub));
1091 }
1092
1093 /*
1094  * cell.c
1095  */
1096 extern int afs_cell_init(struct afs_net *, const char *);
1097 extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1098                                       enum afs_cell_trace);
1099 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1100                                         const char *, bool);
1101 extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1102 extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1103 extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1104 extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1105 extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1106 extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
1107 extern void afs_manage_cells(struct work_struct *);
1108 extern void afs_cells_timer(struct timer_list *);
1109 extern void __net_exit afs_cell_purge(struct afs_net *);
1110
1111 /*
1112  * cmservice.c
1113  */
1114 extern bool afs_cm_incoming_call(struct afs_call *);
1115
1116 /*
1117  * dir.c
1118  */
1119 extern const struct file_operations afs_dir_file_operations;
1120 extern const struct inode_operations afs_dir_inode_operations;
1121 extern const struct address_space_operations afs_dir_aops;
1122 extern const struct dentry_operations afs_fs_dentry_operations;
1123
1124 extern void afs_d_release(struct dentry *);
1125 extern void afs_check_for_remote_deletion(struct afs_operation *);
1126
1127 /*
1128  * dir_edit.c
1129  */
1130 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1131                              enum afs_edit_dir_reason);
1132 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1133
1134 /*
1135  * dir_silly.c
1136  */
1137 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1138                            struct dentry *, struct key *);
1139 extern int afs_silly_iput(struct dentry *, struct inode *);
1140
1141 /*
1142  * dynroot.c
1143  */
1144 extern const struct inode_operations afs_dynroot_inode_operations;
1145 extern const struct dentry_operations afs_dynroot_dentry_operations;
1146
1147 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
1148 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1149 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1150 extern int afs_dynroot_populate(struct super_block *);
1151 extern void afs_dynroot_depopulate(struct super_block *);
1152
1153 /*
1154  * file.c
1155  */
1156 extern const struct address_space_operations afs_file_aops;
1157 extern const struct address_space_operations afs_symlink_aops;
1158 extern const struct inode_operations afs_file_inode_operations;
1159 extern const struct file_operations afs_file_operations;
1160 extern const struct netfs_request_ops afs_req_ops;
1161
1162 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1163 extern void afs_put_wb_key(struct afs_wb_key *);
1164 extern int afs_open(struct inode *, struct file *);
1165 extern int afs_release(struct inode *, struct file *);
1166 extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
1167 extern struct afs_read *afs_alloc_read(gfp_t);
1168 extern void afs_put_read(struct afs_read *);
1169 extern int afs_write_inode(struct inode *, struct writeback_control *);
1170
1171 static inline struct afs_read *afs_get_read(struct afs_read *req)
1172 {
1173         refcount_inc(&req->usage);
1174         return req;
1175 }
1176
1177 /*
1178  * flock.c
1179  */
1180 extern struct workqueue_struct *afs_lock_manager;
1181
1182 extern void afs_lock_op_done(struct afs_call *);
1183 extern void afs_lock_work(struct work_struct *);
1184 extern void afs_lock_may_be_available(struct afs_vnode *);
1185 extern int afs_lock(struct file *, int, struct file_lock *);
1186 extern int afs_flock(struct file *, int, struct file_lock *);
1187
1188 /*
1189  * fsclient.c
1190  */
1191 extern void afs_fs_fetch_status(struct afs_operation *);
1192 extern void afs_fs_fetch_data(struct afs_operation *);
1193 extern void afs_fs_create_file(struct afs_operation *);
1194 extern void afs_fs_make_dir(struct afs_operation *);
1195 extern void afs_fs_remove_file(struct afs_operation *);
1196 extern void afs_fs_remove_dir(struct afs_operation *);
1197 extern void afs_fs_link(struct afs_operation *);
1198 extern void afs_fs_symlink(struct afs_operation *);
1199 extern void afs_fs_rename(struct afs_operation *);
1200 extern void afs_fs_store_data(struct afs_operation *);
1201 extern void afs_fs_setattr(struct afs_operation *);
1202 extern void afs_fs_get_volume_status(struct afs_operation *);
1203 extern void afs_fs_set_lock(struct afs_operation *);
1204 extern void afs_fs_extend_lock(struct afs_operation *);
1205 extern void afs_fs_release_lock(struct afs_operation *);
1206 int afs_fs_give_up_all_callbacks(struct afs_net *net, struct afs_server *server,
1207                                  struct afs_address *addr, struct key *key);
1208 bool afs_fs_get_capabilities(struct afs_net *net, struct afs_server *server,
1209                              struct afs_endpoint_state *estate, unsigned int addr_index,
1210                              struct key *key);
1211 extern void afs_fs_inline_bulk_status(struct afs_operation *);
1212
1213 struct afs_acl {
1214         u32     size;
1215         u8      data[];
1216 };
1217
1218 extern void afs_fs_fetch_acl(struct afs_operation *);
1219 extern void afs_fs_store_acl(struct afs_operation *);
1220
1221 /*
1222  * fs_operation.c
1223  */
1224 extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1225 extern int afs_put_operation(struct afs_operation *);
1226 extern bool afs_begin_vnode_operation(struct afs_operation *);
1227 extern void afs_wait_for_operation(struct afs_operation *);
1228 extern int afs_do_sync_operation(struct afs_operation *);
1229
1230 static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1231                                     struct afs_vnode *vnode)
1232 {
1233         op->file[n].vnode = vnode;
1234         op->file[n].need_io_lock = true;
1235 }
1236
1237 static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1238                                   const struct afs_fid *fid)
1239 {
1240         op->file[n].fid = *fid;
1241 }
1242
1243 /*
1244  * fs_probe.c
1245  */
1246 struct afs_endpoint_state *afs_get_endpoint_state(struct afs_endpoint_state *estate,
1247                                                   enum afs_estate_trace where);
1248 void afs_put_endpoint_state(struct afs_endpoint_state *estate, enum afs_estate_trace where);
1249 extern void afs_fileserver_probe_result(struct afs_call *);
1250 void afs_fs_probe_fileserver(struct afs_net *net, struct afs_server *server,
1251                              struct afs_addr_list *new_addrs, struct key *key);
1252 int afs_wait_for_fs_probes(struct afs_operation *op, struct afs_server_state *states, bool intr);
1253 extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1254 extern void afs_fs_probe_dispatcher(struct work_struct *);
1255 int afs_wait_for_one_fs_probe(struct afs_server *server, struct afs_endpoint_state *estate,
1256                               unsigned long exclude, bool is_intr);
1257 extern void afs_fs_probe_cleanup(struct afs_net *);
1258
1259 /*
1260  * inode.c
1261  */
1262 extern const struct afs_operation_ops afs_fetch_status_operation;
1263
1264 extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1265 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1266 extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1267 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1268 extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1269 extern struct inode *afs_root_iget(struct super_block *, struct key *);
1270 extern int afs_getattr(struct mnt_idmap *idmap, const struct path *,
1271                        struct kstat *, u32, unsigned int);
1272 extern int afs_setattr(struct mnt_idmap *idmap, struct dentry *, struct iattr *);
1273 extern void afs_evict_inode(struct inode *);
1274 extern int afs_drop_inode(struct inode *);
1275
1276 /*
1277  * main.c
1278  */
1279 extern struct workqueue_struct *afs_wq;
1280 extern int afs_net_id;
1281
1282 static inline struct afs_net *afs_net(struct net *net)
1283 {
1284         return net_generic(net, afs_net_id);
1285 }
1286
1287 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1288 {
1289         return afs_net(AFS_FS_S(sb)->net_ns);
1290 }
1291
1292 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1293 {
1294         return afs_sb2net(dentry->d_sb);
1295 }
1296
1297 static inline struct afs_net *afs_i2net(struct inode *inode)
1298 {
1299         return afs_sb2net(inode->i_sb);
1300 }
1301
1302 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1303 {
1304         return afs_i2net(&vnode->netfs.inode);
1305 }
1306
1307 static inline struct afs_net *afs_sock2net(struct sock *sk)
1308 {
1309         return net_generic(sock_net(sk), afs_net_id);
1310 }
1311
1312 static inline void __afs_stat(atomic_t *s)
1313 {
1314         atomic_inc(s);
1315 }
1316
1317 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1318
1319 /*
1320  * misc.c
1321  */
1322 extern int afs_abort_to_error(u32);
1323 extern void afs_prioritise_error(struct afs_error *, int, u32);
1324
1325 static inline void afs_op_nomem(struct afs_operation *op)
1326 {
1327         op->cumul_error.error = -ENOMEM;
1328 }
1329
1330 static inline int afs_op_error(const struct afs_operation *op)
1331 {
1332         return op->cumul_error.error;
1333 }
1334
1335 static inline s32 afs_op_abort_code(const struct afs_operation *op)
1336 {
1337         return op->cumul_error.abort_code;
1338 }
1339
1340 static inline int afs_op_set_error(struct afs_operation *op, int error)
1341 {
1342         return op->cumul_error.error = error;
1343 }
1344
1345 static inline void afs_op_accumulate_error(struct afs_operation *op, int error, s32 abort_code)
1346 {
1347         afs_prioritise_error(&op->cumul_error, error, abort_code);
1348 }
1349
1350 /*
1351  * mntpt.c
1352  */
1353 extern const struct inode_operations afs_mntpt_inode_operations;
1354 extern const struct inode_operations afs_autocell_inode_operations;
1355 extern const struct file_operations afs_mntpt_file_operations;
1356
1357 extern struct vfsmount *afs_d_automount(struct path *);
1358 extern void afs_mntpt_kill_timer(void);
1359
1360 /*
1361  * proc.c
1362  */
1363 #ifdef CONFIG_PROC_FS
1364 extern int __net_init afs_proc_init(struct afs_net *);
1365 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1366 extern int afs_proc_cell_setup(struct afs_cell *);
1367 extern void afs_proc_cell_remove(struct afs_cell *);
1368 extern void afs_put_sysnames(struct afs_sysnames *);
1369 #else
1370 static inline int afs_proc_init(struct afs_net *net) { return 0; }
1371 static inline void afs_proc_cleanup(struct afs_net *net) {}
1372 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1373 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1374 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1375 #endif
1376
1377 /*
1378  * rotate.c
1379  */
1380 void afs_clear_server_states(struct afs_operation *op);
1381 extern bool afs_select_fileserver(struct afs_operation *);
1382 extern void afs_dump_edestaddrreq(const struct afs_operation *);
1383
1384 /*
1385  * rxrpc.c
1386  */
1387 extern struct workqueue_struct *afs_async_calls;
1388
1389 extern int __net_init afs_open_socket(struct afs_net *);
1390 extern void __net_exit afs_close_socket(struct afs_net *);
1391 extern void afs_charge_preallocation(struct work_struct *);
1392 extern void afs_put_call(struct afs_call *);
1393 void afs_make_call(struct afs_call *call, gfp_t gfp);
1394 void afs_wait_for_call_to_complete(struct afs_call *call);
1395 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1396                                             const struct afs_call_type *,
1397                                             size_t, size_t);
1398 extern void afs_flat_call_destructor(struct afs_call *);
1399 extern void afs_send_empty_reply(struct afs_call *);
1400 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1401 extern int afs_extract_data(struct afs_call *, bool);
1402 extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1403
1404 static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1405                                     gfp_t gfp)
1406 {
1407         struct afs_addr_list *alist = op->estate->addresses;
1408
1409         op->call        = call;
1410         op->type        = call->type;
1411         call->op        = op;
1412         call->key       = op->key;
1413         call->intr      = !(op->flags & AFS_OPERATION_UNINTR);
1414         call->peer      = rxrpc_kernel_get_peer(alist->addrs[op->addr_index].peer);
1415         call->service_id = op->server->service_id;
1416         afs_make_call(call, gfp);
1417 }
1418
1419 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1420 {
1421         call->iov_len = size;
1422         call->kvec[0].iov_base = buf;
1423         call->kvec[0].iov_len = size;
1424         iov_iter_kvec(&call->def_iter, ITER_DEST, call->kvec, 1, size);
1425 }
1426
1427 static inline void afs_extract_to_tmp(struct afs_call *call)
1428 {
1429         call->iov_len = sizeof(call->tmp);
1430         afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1431 }
1432
1433 static inline void afs_extract_to_tmp64(struct afs_call *call)
1434 {
1435         call->iov_len = sizeof(call->tmp64);
1436         afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1437 }
1438
1439 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1440 {
1441         call->iov_len = size;
1442         iov_iter_discard(&call->def_iter, ITER_DEST, size);
1443 }
1444
1445 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1446 {
1447         call->iov_len = size;
1448         afs_extract_begin(call, call->buffer, size);
1449 }
1450
1451 static inline int afs_transfer_reply(struct afs_call *call)
1452 {
1453         return afs_extract_data(call, false);
1454 }
1455
1456 static inline bool afs_check_call_state(struct afs_call *call,
1457                                         enum afs_call_state state)
1458 {
1459         return READ_ONCE(call->state) == state;
1460 }
1461
1462 static inline bool afs_set_call_state(struct afs_call *call,
1463                                       enum afs_call_state from,
1464                                       enum afs_call_state to)
1465 {
1466         bool ok = false;
1467
1468         spin_lock_bh(&call->state_lock);
1469         if (call->state == from) {
1470                 call->state = to;
1471                 trace_afs_call_state(call, from, to, 0, 0);
1472                 ok = true;
1473         }
1474         spin_unlock_bh(&call->state_lock);
1475         return ok;
1476 }
1477
1478 static inline void afs_set_call_complete(struct afs_call *call,
1479                                          int error, u32 remote_abort)
1480 {
1481         enum afs_call_state state;
1482         bool ok = false;
1483
1484         spin_lock_bh(&call->state_lock);
1485         state = call->state;
1486         if (state != AFS_CALL_COMPLETE) {
1487                 call->abort_code = remote_abort;
1488                 call->error = error;
1489                 call->state = AFS_CALL_COMPLETE;
1490                 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1491                                      error, remote_abort);
1492                 ok = true;
1493         }
1494         spin_unlock_bh(&call->state_lock);
1495         if (ok) {
1496                 trace_afs_call_done(call);
1497
1498                 /* Asynchronous calls have two refs to release - one from the alloc and
1499                  * one queued with the work item - and we can't just deallocate the
1500                  * call because the work item may be queued again.
1501                  */
1502                 if (call->drop_ref)
1503                         afs_put_call(call);
1504         }
1505 }
1506
1507 /*
1508  * security.c
1509  */
1510 extern void afs_put_permits(struct afs_permits *);
1511 extern void afs_clear_permits(struct afs_vnode *);
1512 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1513                              struct afs_status_cb *);
1514 extern struct key *afs_request_key(struct afs_cell *);
1515 extern struct key *afs_request_key_rcu(struct afs_cell *);
1516 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1517 extern int afs_permission(struct mnt_idmap *, struct inode *, int);
1518 extern void __exit afs_clean_up_permit_cache(void);
1519
1520 /*
1521  * server.c
1522  */
1523 extern spinlock_t afs_server_peer_lock;
1524
1525 extern struct afs_server *afs_find_server(struct afs_net *, const struct rxrpc_peer *);
1526 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1527 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1528 extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1529 extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1530 extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1531 extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1532 extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1533 extern void afs_manage_servers(struct work_struct *);
1534 extern void afs_servers_timer(struct timer_list *);
1535 extern void afs_fs_probe_timer(struct timer_list *);
1536 extern void __net_exit afs_purge_servers(struct afs_net *);
1537 bool afs_check_server_record(struct afs_operation *op, struct afs_server *server, struct key *key);
1538
1539 static inline void afs_inc_servers_outstanding(struct afs_net *net)
1540 {
1541         atomic_inc(&net->servers_outstanding);
1542 }
1543
1544 static inline void afs_dec_servers_outstanding(struct afs_net *net)
1545 {
1546         if (atomic_dec_and_test(&net->servers_outstanding))
1547                 wake_up_var(&net->servers_outstanding);
1548 }
1549
1550 static inline bool afs_is_probing_server(struct afs_server *server)
1551 {
1552         return list_empty(&server->probe_link);
1553 }
1554
1555 /*
1556  * server_list.c
1557  */
1558 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1559 {
1560         refcount_inc(&slist->usage);
1561         return slist;
1562 }
1563
1564 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1565 struct afs_server_list *afs_alloc_server_list(struct afs_volume *volume,
1566                                               struct key *key,
1567                                               struct afs_vldb_entry *vldb);
1568 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1569 void afs_attach_volume_to_servers(struct afs_volume *volume, struct afs_server_list *slist);
1570 void afs_reattach_volume_to_servers(struct afs_volume *volume, struct afs_server_list *slist,
1571                                     struct afs_server_list *old);
1572 void afs_detach_volume_from_servers(struct afs_volume *volume, struct afs_server_list *slist);
1573
1574 /*
1575  * super.c
1576  */
1577 extern int __init afs_fs_init(void);
1578 extern void afs_fs_exit(void);
1579
1580 /*
1581  * validation.c
1582  */
1583 bool afs_check_validity(const struct afs_vnode *vnode);
1584 int afs_update_volume_state(struct afs_operation *op);
1585 int afs_validate(struct afs_vnode *vnode, struct key *key);
1586
1587 /*
1588  * vlclient.c
1589  */
1590 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1591                                                          const char *, int);
1592 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1593 struct afs_call *afs_vl_get_capabilities(struct afs_net *net,
1594                                          struct afs_addr_list *alist,
1595                                          unsigned int addr_index,
1596                                          struct key *key,
1597                                          struct afs_vlserver *server,
1598                                          unsigned int server_index);
1599 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1600 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1601
1602 /*
1603  * vl_alias.c
1604  */
1605 extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1606
1607 /*
1608  * vl_probe.c
1609  */
1610 extern void afs_vlserver_probe_result(struct afs_call *);
1611 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1612 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1613
1614 /*
1615  * vl_rotate.c
1616  */
1617 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1618                                          struct afs_cell *, struct key *);
1619 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1620 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1621 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1622
1623 /*
1624  * vlserver_list.c
1625  */
1626 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1627 {
1628         refcount_inc(&vlserver->ref);
1629         return vlserver;
1630 }
1631
1632 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1633 {
1634         if (vllist)
1635                 refcount_inc(&vllist->ref);
1636         return vllist;
1637 }
1638
1639 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1640 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1641 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1642 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1643 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1644                                                            const void *, size_t);
1645
1646 /*
1647  * volume.c
1648  */
1649 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1650 extern int afs_activate_volume(struct afs_volume *);
1651 extern void afs_deactivate_volume(struct afs_volume *);
1652 bool afs_try_get_volume(struct afs_volume *volume, enum afs_volume_trace reason);
1653 extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1654 void afs_put_volume(struct afs_volume *volume, enum afs_volume_trace reason);
1655 extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1656
1657 /*
1658  * write.c
1659  */
1660 #ifdef CONFIG_AFS_FSCACHE
1661 bool afs_dirty_folio(struct address_space *, struct folio *);
1662 #else
1663 #define afs_dirty_folio filemap_dirty_folio
1664 #endif
1665 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1666                         loff_t pos, unsigned len,
1667                         struct page **pagep, void **fsdata);
1668 extern int afs_write_end(struct file *file, struct address_space *mapping,
1669                         loff_t pos, unsigned len, unsigned copied,
1670                         struct page *page, void *fsdata);
1671 extern int afs_writepage(struct page *, struct writeback_control *);
1672 extern int afs_writepages(struct address_space *, struct writeback_control *);
1673 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1674 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1675 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1676 extern void afs_prune_wb_keys(struct afs_vnode *);
1677 int afs_launder_folio(struct folio *);
1678
1679 /*
1680  * xattr.c
1681  */
1682 extern const struct xattr_handler * const afs_xattr_handlers[];
1683
1684 /*
1685  * yfsclient.c
1686  */
1687 extern void yfs_fs_fetch_data(struct afs_operation *);
1688 extern void yfs_fs_create_file(struct afs_operation *);
1689 extern void yfs_fs_make_dir(struct afs_operation *);
1690 extern void yfs_fs_remove_file2(struct afs_operation *);
1691 extern void yfs_fs_remove_file(struct afs_operation *);
1692 extern void yfs_fs_remove_dir(struct afs_operation *);
1693 extern void yfs_fs_link(struct afs_operation *);
1694 extern void yfs_fs_symlink(struct afs_operation *);
1695 extern void yfs_fs_rename(struct afs_operation *);
1696 extern void yfs_fs_store_data(struct afs_operation *);
1697 extern void yfs_fs_setattr(struct afs_operation *);
1698 extern void yfs_fs_get_volume_status(struct afs_operation *);
1699 extern void yfs_fs_set_lock(struct afs_operation *);
1700 extern void yfs_fs_extend_lock(struct afs_operation *);
1701 extern void yfs_fs_release_lock(struct afs_operation *);
1702 extern void yfs_fs_fetch_status(struct afs_operation *);
1703 extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1704
1705 struct yfs_acl {
1706         struct afs_acl  *acl;           /* Dir/file/symlink ACL */
1707         struct afs_acl  *vol_acl;       /* Whole volume ACL */
1708         u32             inherit_flag;   /* True if ACL is inherited from parent dir */
1709         u32             num_cleaned;    /* Number of ACEs removed due to subject removal */
1710         unsigned int    flags;
1711 #define YFS_ACL_WANT_ACL        0x01    /* Set if caller wants ->acl */
1712 #define YFS_ACL_WANT_VOL_ACL    0x02    /* Set if caller wants ->vol_acl */
1713 };
1714
1715 extern void yfs_free_opaque_acl(struct yfs_acl *);
1716 extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1717 extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1718
1719 /*
1720  * Miscellaneous inline functions.
1721  */
1722 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1723 {
1724         return container_of(inode, struct afs_vnode, netfs.inode);
1725 }
1726
1727 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1728 {
1729         return &vnode->netfs.inode;
1730 }
1731
1732 /*
1733  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1734  * number derived from the result of the operation.  It doesn't matter if
1735  * d_fsdata goes backwards as we'll just revalidate.
1736  */
1737 static inline void afs_update_dentry_version(struct afs_operation *op,
1738                                              struct afs_vnode_param *dir_vp,
1739                                              struct dentry *dentry)
1740 {
1741         if (!op->cumul_error.error)
1742                 dentry->d_fsdata =
1743                         (void *)(unsigned long)dir_vp->scb.status.data_version;
1744 }
1745
1746 /*
1747  * Set the file size and block count.  Estimate the number of 512 bytes blocks
1748  * used, rounded up to nearest 1K for consistency with other AFS clients.
1749  */
1750 static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
1751 {
1752         i_size_write(&vnode->netfs.inode, size);
1753         vnode->netfs.inode.i_blocks = ((size + 1023) >> 10) << 1;
1754 }
1755
1756 /*
1757  * Check for a conflicting operation on a directory that we just unlinked from.
1758  * If someone managed to sneak a link or an unlink in on the file we just
1759  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1760  */
1761 static inline void afs_check_dir_conflict(struct afs_operation *op,
1762                                           struct afs_vnode_param *dvp)
1763 {
1764         if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1765                 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1766 }
1767
1768 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1769 {
1770         trace_afs_io_error(call->debug_id, -EIO, where);
1771         return -EIO;
1772 }
1773
1774 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1775 {
1776         trace_afs_file_error(vnode, -EIO, where);
1777         return -EIO;
1778 }
1779
1780 /*****************************************************************************/
1781 /*
1782  * debug tracing
1783  */
1784 extern unsigned afs_debug;
1785
1786 #define dbgprintk(FMT,...) \
1787         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1788
1789 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1790 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1791 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1792
1793
1794 #if defined(__KDEBUG)
1795 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1796 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1797 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1798
1799 #elif defined(CONFIG_AFS_DEBUG)
1800 #define AFS_DEBUG_KENTER        0x01
1801 #define AFS_DEBUG_KLEAVE        0x02
1802 #define AFS_DEBUG_KDEBUG        0x04
1803
1804 #define _enter(FMT,...)                                 \
1805 do {                                                    \
1806         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
1807                 kenter(FMT,##__VA_ARGS__);              \
1808 } while (0)
1809
1810 #define _leave(FMT,...)                                 \
1811 do {                                                    \
1812         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
1813                 kleave(FMT,##__VA_ARGS__);              \
1814 } while (0)
1815
1816 #define _debug(FMT,...)                                 \
1817 do {                                                    \
1818         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
1819                 kdebug(FMT,##__VA_ARGS__);              \
1820 } while (0)
1821
1822 #else
1823 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1824 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1825 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1826 #endif
1827
1828 /*
1829  * debug assertion checking
1830  */
1831 #if 1 // defined(__KDEBUGALL)
1832
1833 #define ASSERT(X)                                               \
1834 do {                                                            \
1835         if (unlikely(!(X))) {                                   \
1836                 printk(KERN_ERR "\n");                          \
1837                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1838                 BUG();                                          \
1839         }                                                       \
1840 } while(0)
1841
1842 #define ASSERTCMP(X, OP, Y)                                             \
1843 do {                                                                    \
1844         if (unlikely(!((X) OP (Y)))) {                                  \
1845                 printk(KERN_ERR "\n");                                  \
1846                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1847                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1848                        (unsigned long)(X), (unsigned long)(Y));         \
1849                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1850                        (unsigned long)(X), (unsigned long)(Y));         \
1851                 BUG();                                                  \
1852         }                                                               \
1853 } while(0)
1854
1855 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
1856 do {                                                                    \
1857         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
1858                 printk(KERN_ERR "\n");                                  \
1859                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1860                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1861                        (unsigned long)(L), (unsigned long)(N),          \
1862                        (unsigned long)(H));                             \
1863                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1864                        (unsigned long)(L), (unsigned long)(N),          \
1865                        (unsigned long)(H));                             \
1866                 BUG();                                                  \
1867         }                                                               \
1868 } while(0)
1869
1870 #define ASSERTIF(C, X)                                          \
1871 do {                                                            \
1872         if (unlikely((C) && !(X))) {                            \
1873                 printk(KERN_ERR "\n");                          \
1874                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1875                 BUG();                                          \
1876         }                                                       \
1877 } while(0)
1878
1879 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1880 do {                                                                    \
1881         if (unlikely((C) && !((X) OP (Y)))) {                           \
1882                 printk(KERN_ERR "\n");                                  \
1883                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1884                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1885                        (unsigned long)(X), (unsigned long)(Y));         \
1886                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1887                        (unsigned long)(X), (unsigned long)(Y));         \
1888                 BUG();                                                  \
1889         }                                                               \
1890 } while(0)
1891
1892 #else
1893
1894 #define ASSERT(X)                               \
1895 do {                                            \
1896 } while(0)
1897
1898 #define ASSERTCMP(X, OP, Y)                     \
1899 do {                                            \
1900 } while(0)
1901
1902 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
1903 do {                                            \
1904 } while(0)
1905
1906 #define ASSERTIF(C, X)                          \
1907 do {                                            \
1908 } while(0)
1909
1910 #define ASSERTIFCMP(C, X, OP, Y)                \
1911 do {                                            \
1912 } while(0)
1913
1914 #endif /* __KDEBUGALL */