fs/afs/internal.h

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