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