fs/afs/internal.h

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