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