fs/afs/internal.h

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