fs/afs/internal.h

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