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