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