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 ([email protected])
   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 <net/net_namespace.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 struct afs_mount_params {
  36         bool                    rwpath;         /* T if the parent should be considered R/W */
  37         bool                    force;          /* T to force cell type */
  38         bool                    autocell;       /* T if set auto mount operation */
  39         bool                    dyn_root;       /* T if dynamic root */
  40         afs_voltype_t           type;           /* type of volume requested */
  41         int                     volnamesz;      /* size of volume name */
  42         const char              *volname;       /* name of volume to mount */
  43         struct afs_net          *net;           /* Network namespace in effect */
  44         struct afs_cell         *cell;          /* cell in which to find volume */
  45         struct afs_volume       *volume;        /* volume record */
  46         struct key              *key;           /* key to use for secure mounting */
  47 };
  48
  49 struct afs_iget_data {
  50         struct afs_fid          fid;
  51         struct afs_volume       *volume;        /* volume on which resides */
  52 };
  53
  54 enum afs_call_state {
  55         AFS_CALL_CL_REQUESTING,         /* Client: Request is being sent */
  56         AFS_CALL_CL_AWAIT_REPLY,        /* Client: Awaiting reply */
  57         AFS_CALL_CL_PROC_REPLY,         /* Client: rxrpc call complete; processing reply */
  58         AFS_CALL_SV_AWAIT_OP_ID,        /* Server: Awaiting op ID */
  59         AFS_CALL_SV_AWAIT_REQUEST,      /* Server: Awaiting request data */
  60         AFS_CALL_SV_REPLYING,           /* Server: Replying */
  61         AFS_CALL_SV_AWAIT_ACK,          /* Server: Awaiting final ACK */
  62         AFS_CALL_COMPLETE,              /* Completed or failed */
  63 };
  64
  65 /*
  66  * List of server addresses.
  67  */
  68 struct afs_addr_list {
  69         struct rcu_head         rcu;            /* Must be first */
  70         refcount_t              usage;
  71         u32                     version;        /* Version */
  72         unsigned short          nr_addrs;
  73         unsigned short          index;          /* Address currently in use */
  74         unsigned short          nr_ipv4;        /* Number of IPv4 addresses */
  75         unsigned long           probed;         /* Mask of servers that have been probed */
  76         unsigned long           yfs;            /* Mask of servers that are YFS */
  77         struct sockaddr_rxrpc   addrs[];
  78 };
  79
  80 /*
  81  * a record of an in-progress RxRPC call
  82  */
  83 struct afs_call {
  84         const struct afs_call_type *type;       /* type of call */
  85         wait_queue_head_t       waitq;          /* processes awaiting completion */
  86         struct work_struct      async_work;     /* async I/O processor */
  87         struct work_struct      work;           /* actual work processor */
  88         struct rxrpc_call       *rxcall;        /* RxRPC call handle */
  89         struct key              *key;           /* security for this call */
  90         struct afs_net          *net;           /* The network namespace */
  91         struct afs_server       *cm_server;     /* Server affected by incoming CM call */
  92         struct afs_cb_interest  *cbi;           /* Callback interest for server used */
  93         void                    *request;       /* request data (first part) */
  94         struct address_space    *mapping;       /* Pages being written from */
  95         void                    *buffer;        /* reply receive buffer */
  96         void                    *reply[4];      /* Where to put the reply */
  97         pgoff_t                 first;          /* first page in mapping to deal with */
  98         pgoff_t                 last;           /* last page in mapping to deal with */
  99         size_t                  offset;         /* offset into received data store */
 100         atomic_t                usage;
 101         enum afs_call_state     state;
 102         spinlock_t              state_lock;
 103         int                     error;          /* error code */
 104         u32                     abort_code;     /* Remote abort ID or 0 */
 105         unsigned                request_size;   /* size of request data */
 106         unsigned                reply_max;      /* maximum size of reply */
 107         unsigned                first_offset;   /* offset into mapping[first] */
 108         unsigned int            cb_break;       /* cb_break + cb_s_break before the call */
 109         union {
 110                 unsigned        last_to;        /* amount of mapping[last] */
 111                 unsigned        count2;         /* count used in unmarshalling */
 112         };
 113         unsigned char           unmarshall;     /* unmarshalling phase */
 114         bool                    incoming;       /* T if incoming call */
 115         bool                    send_pages;     /* T if data from mapping should be sent */
 116         bool                    need_attention; /* T if RxRPC poked us */
 117         bool                    async;          /* T if asynchronous */
 118         bool                    ret_reply0;     /* T if should return reply[0] on success */
 119         bool                    upgrade;        /* T to request service upgrade */
 120         u16                     service_id;     /* Actual service ID (after upgrade) */
 121         unsigned int            debug_id;       /* Trace ID */
 122         u32                     operation_ID;   /* operation ID for an incoming call */
 123         u32                     count;          /* count for use in unmarshalling */
 124         __be32                  tmp;            /* place to extract temporary data */
 125         afs_dataversion_t       expected_version; /* Updated version expected from store */
 126         afs_dataversion_t       expected_version_2; /* 2nd updated version expected from store */
 127 };
 128
 129 struct afs_call_type {
 130         const char *name;
 131         unsigned int op; /* Really enum afs_fs_operation */
 132
 133         /* deliver request or reply data to an call
 134          * - returning an error will cause the call to be aborted
 135          */
 136         int (*deliver)(struct afs_call *call);
 137
 138         /* clean up a call */
 139         void (*destructor)(struct afs_call *call);
 140
 141         /* Work function */
 142         void (*work)(struct work_struct *work);
 143 };
 144
 145 /*
 146  * Key available for writeback on a file.
 147  */
 148 struct afs_wb_key {
 149         refcount_t              usage;
 150         struct key              *key;
 151         struct list_head        vnode_link;     /* Link in vnode->wb_keys */
 152 };
 153
 154 /*
 155  * AFS open file information record.  Pointed to by file->private_data.
 156  */
 157 struct afs_file {
 158         struct key              *key;           /* The key this file was opened with */
 159         struct afs_wb_key       *wb;            /* Writeback key record for this file */
 160 };
 161
 162 static inline struct key *afs_file_key(struct file *file)
 163 {
 164         struct afs_file *af = file->private_data;
 165
 166         return af->key;
 167 }
 168
 169 /*
 170  * Record of an outstanding read operation on a vnode.
 171  */
 172 struct afs_read {
 173         loff_t                  pos;            /* Where to start reading */
 174         loff_t                  len;            /* How much we're asking for */
 175         loff_t                  actual_len;     /* How much we're actually getting */
 176         loff_t                  remain;         /* Amount remaining */
 177         loff_t                  file_size;      /* File size returned by server */
 178         afs_dataversion_t       data_version;   /* Version number returned by server */
 179         refcount_t              usage;
 180         unsigned int            index;          /* Which page we're reading into */
 181         unsigned int            nr_pages;
 182         void (*page_done)(struct afs_call *, struct afs_read *);
 183         struct page             **pages;
 184         struct page             *array[];
 185 };
 186
 187 /*
 188  * AFS superblock private data
 189  * - there's one superblock per volume
 190  */
 191 struct afs_super_info {
 192         struct afs_net          *net;           /* Network namespace */
 193         struct afs_cell         *cell;          /* The cell in which the volume resides */
 194         struct afs_volume       *volume;        /* volume record */
 195         bool                    dyn_root;       /* True if dynamic root */
 196 };
 197
 198 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
 199 {
 200         return sb->s_fs_info;
 201 }
 202
 203 extern struct file_system_type afs_fs_type;
 204
 205 /*
 206  * Set of substitutes for @sys.
 207  */
 208 struct afs_sysnames {
 209 #define AFS_NR_SYSNAME 16
 210         char                    *subs[AFS_NR_SYSNAME];
 211         refcount_t              usage;
 212         unsigned short          nr;
 213         short                   error;
 214         char                    blank[1];
 215 };
 216
 217 /*
 218  * AFS network namespace record.
 219  */
 220 struct afs_net {
 221         struct afs_uuid         uuid;
 222         bool                    live;           /* F if this namespace is being removed */
 223
 224         /* AF_RXRPC I/O stuff */
 225         struct socket           *socket;
 226         struct afs_call         *spare_incoming_call;
 227         struct work_struct      charge_preallocation_work;
 228         struct mutex            socket_mutex;
 229         atomic_t                nr_outstanding_calls;
 230         atomic_t                nr_superblocks;
 231
 232         /* Cell database */
 233         struct rb_root          cells;
 234         struct afs_cell         *ws_cell;
 235         struct work_struct      cells_manager;
 236         struct timer_list       cells_timer;
 237         atomic_t                cells_outstanding;
 238         seqlock_t               cells_lock;
 239
 240         spinlock_t              proc_cells_lock;
 241         struct list_head        proc_cells;
 242
 243         /* Known servers.  Theoretically each fileserver can only be in one
 244          * cell, but in practice, people create aliases and subsets and there's
 245          * no easy way to distinguish them.
 246          */
 247         seqlock_t               fs_lock;        /* For fs_servers */
 248         struct rb_root          fs_servers;     /* afs_server (by server UUID or address) */
 249         struct list_head        fs_updates;     /* afs_server (by update_at) */
 250         struct hlist_head       fs_proc;        /* procfs servers list */
 251
 252         struct hlist_head       fs_addresses4;  /* afs_server (by lowest IPv4 addr) */
 253         struct hlist_head       fs_addresses6;  /* afs_server (by lowest IPv6 addr) */
 254         seqlock_t               fs_addr_lock;   /* For fs_addresses[46] */
 255
 256         struct work_struct      fs_manager;
 257         struct timer_list       fs_timer;
 258         atomic_t                servers_outstanding;
 259
 260         /* File locking renewal management */
 261         struct mutex            lock_manager_mutex;
 262
 263         /* Misc */
 264         struct proc_dir_entry   *proc_afs;      /* /proc/net/afs directory */
 265         struct afs_sysnames     *sysnames;
 266         rwlock_t                sysnames_lock;
 267
 268         /* Statistics counters */
 269         atomic_t                n_lookup;       /* Number of lookups done */
 270         atomic_t                n_reval;        /* Number of dentries needing revalidation */
 271         atomic_t                n_inval;        /* Number of invalidations by the server */
 272         atomic_t                n_relpg;        /* Number of invalidations by releasepage */
 273         atomic_t                n_read_dir;     /* Number of directory pages read */
 274         atomic_t                n_dir_cr;       /* Number of directory entry creation edits */
 275         atomic_t                n_dir_rm;       /* Number of directory entry removal edits */
 276         atomic_t                n_stores;       /* Number of store ops */
 277         atomic_long_t           n_store_bytes;  /* Number of bytes stored */
 278         atomic_long_t           n_fetch_bytes;  /* Number of bytes fetched */
 279         atomic_t                n_fetches;      /* Number of data fetch ops */
 280 };
 281
 282 extern const char afs_init_sysname[];
 283 extern struct afs_net __afs_net;// Dummy AFS network namespace; TODO: replace with real netns
 284
 285 enum afs_cell_state {
 286         AFS_CELL_UNSET,
 287         AFS_CELL_ACTIVATING,
 288         AFS_CELL_ACTIVE,
 289         AFS_CELL_DEACTIVATING,
 290         AFS_CELL_INACTIVE,
 291         AFS_CELL_FAILED,
 292 };
 293
 294 /*
 295  * AFS cell record.
 296  *
 297  * This is a tricky concept to get right as it is possible to create aliases
 298  * simply by pointing AFSDB/SRV records for two names at the same set of VL
 299  * servers; it is also possible to do things like setting up two sets of VL
 300  * servers, one of which provides a superset of the volumes provided by the
 301  * other (for internal/external division, for example).
 302  *
 303  * Cells only exist in the sense that (a) a cell's name maps to a set of VL
 304  * servers and (b) a cell's name is used by the client to select the key to use
 305  * for authentication and encryption.  The cell name is not typically used in
 306  * the protocol.
 307  *
 308  * There is no easy way to determine if two cells are aliases or one is a
 309  * subset of another.
 310  */
 311 struct afs_cell {
 312         union {
 313                 struct rcu_head rcu;
 314                 struct rb_node  net_node;       /* Node in net->cells */
 315         };
 316         struct afs_net          *net;
 317         struct key              *anonymous_key; /* anonymous user key for this cell */
 318         struct work_struct      manager;        /* Manager for init/deinit/dns */
 319         struct list_head        proc_link;      /* /proc cell list link */
 320 #ifdef CONFIG_AFS_FSCACHE
 321         struct fscache_cookie   *cache;         /* caching cookie */
 322 #endif
 323         time64_t                dns_expiry;     /* Time AFSDB/SRV record expires */
 324         time64_t                last_inactive;  /* Time of last drop of usage count */
 325         atomic_t                usage;
 326         unsigned long           flags;
 327 #define AFS_CELL_FL_NOT_READY   0               /* The cell record is not ready for use */
 328 #define AFS_CELL_FL_NO_GC       1               /* The cell was added manually, don't auto-gc */
 329 #define AFS_CELL_FL_NOT_FOUND   2               /* Permanent DNS error */
 330 #define AFS_CELL_FL_DNS_FAIL    3               /* Failed to access DNS */
 331 #define AFS_CELL_FL_NO_LOOKUP_YET 4             /* Not completed first DNS lookup yet */
 332         enum afs_cell_state     state;
 333         short                   error;
 334
 335         /* Active fileserver interaction state. */
 336         struct list_head        proc_volumes;   /* procfs volume list */
 337         rwlock_t                proc_lock;
 338
 339         /* VL server list. */
 340         rwlock_t                vl_addrs_lock;  /* Lock on vl_addrs */
 341         struct afs_addr_list    __rcu *vl_addrs; /* List of VL servers */
 342         u8                      name_len;       /* Length of name */
 343         char                    name[64 + 1];   /* Cell name, case-flattened and NUL-padded */
 344 };
 345
 346 /*
 347  * Cached VLDB entry.
 348  *
 349  * This is pointed to by cell->vldb_entries, indexed by name.
 350  */
 351 struct afs_vldb_entry {
 352         afs_volid_t             vid[3];         /* Volume IDs for R/W, R/O and Bak volumes */
 353
 354         unsigned long           flags;
 355 #define AFS_VLDB_HAS_RW         0               /* - R/W volume exists */
 356 #define AFS_VLDB_HAS_RO         1               /* - R/O volume exists */
 357 #define AFS_VLDB_HAS_BAK        2               /* - Backup volume exists */
 358 #define AFS_VLDB_QUERY_VALID    3               /* - Record is valid */
 359 #define AFS_VLDB_QUERY_ERROR    4               /* - VL server returned error */
 360
 361         uuid_t                  fs_server[AFS_NMAXNSERVERS];
 362         u8                      fs_mask[AFS_NMAXNSERVERS];
 363 #define AFS_VOL_VTM_RW  0x01 /* R/W version of the volume is available (on this server) */
 364 #define AFS_VOL_VTM_RO  0x02 /* R/O version of the volume is available (on this server) */
 365 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
 366         short                   error;
 367         u8                      nr_servers;     /* Number of server records */
 368         u8                      name_len;
 369         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
 370 };
 371
 372 /*
 373  * Record of fileserver with which we're actively communicating.
 374  */
 375 struct afs_server {
 376         struct rcu_head         rcu;
 377         union {
 378                 uuid_t          uuid;           /* Server ID */
 379                 struct afs_uuid _uuid;
 380         };
 381
 382         struct afs_addr_list    __rcu *addresses;
 383         struct rb_node          uuid_rb;        /* Link in net->servers */
 384         struct hlist_node       addr4_link;     /* Link in net->fs_addresses4 */
 385         struct hlist_node       addr6_link;     /* Link in net->fs_addresses6 */
 386         struct hlist_node       proc_link;      /* Link in net->fs_proc */
 387         struct afs_server       *gc_next;       /* Next server in manager's list */
 388         time64_t                put_time;       /* Time at which last put */
 389         time64_t                update_at;      /* Time at which to next update the record */
 390         unsigned long           flags;
 391 #define AFS_SERVER_FL_NEW       0               /* New server, don't inc cb_s_break */
 392 #define AFS_SERVER_FL_NOT_READY 1               /* The record is not ready for use */
 393 #define AFS_SERVER_FL_NOT_FOUND 2               /* VL server says no such server */
 394 #define AFS_SERVER_FL_VL_FAIL   3               /* Failed to access VL server */
 395 #define AFS_SERVER_FL_UPDATING  4
 396 #define AFS_SERVER_FL_PROBED    5               /* The fileserver has been probed */
 397 #define AFS_SERVER_FL_PROBING   6               /* Fileserver is being probed */
 398 #define AFS_SERVER_FL_NO_IBULK  7               /* Fileserver doesn't support FS.InlineBulkStatus */
 399 #define AFS_SERVER_FL_MAY_HAVE_CB 8             /* May have callbacks on this fileserver */
 400         atomic_t                usage;
 401         u32                     addr_version;   /* Address list version */
 402
 403         /* file service access */
 404         rwlock_t                fs_lock;        /* access lock */
 405
 406         /* callback promise management */
 407         struct list_head        cb_interests;   /* List of superblocks using this server */
 408         unsigned                cb_s_break;     /* Break-everything counter. */
 409         rwlock_t                cb_break_lock;  /* Volume finding lock */
 410 };
 411
 412 /*
 413  * Interest by a superblock on a server.
 414  */
 415 struct afs_cb_interest {
 416         struct list_head        cb_link;        /* Link in server->cb_interests */
 417         struct afs_server       *server;        /* Server on which this interest resides */
 418         struct super_block      *sb;            /* Superblock on which inodes reside */
 419         afs_volid_t             vid;            /* Volume ID to match */
 420         refcount_t              usage;
 421 };
 422
 423 /*
 424  * Replaceable server list.
 425  */
 426 struct afs_server_entry {
 427         struct afs_server       *server;
 428         struct afs_cb_interest  *cb_interest;
 429 };
 430
 431 struct afs_server_list {
 432         refcount_t              usage;
 433         unsigned short          nr_servers;
 434         unsigned short          index;          /* Server currently in use */
 435         unsigned short          vnovol_mask;    /* Servers to be skipped due to VNOVOL */
 436         unsigned int            seq;            /* Set to ->servers_seq when installed */
 437         rwlock_t                lock;
 438         struct afs_server_entry servers[];
 439 };
 440
 441 /*
 442  * Live AFS volume management.
 443  */
 444 struct afs_volume {
 445         afs_volid_t             vid;            /* volume ID */
 446         atomic_t                usage;
 447         time64_t                update_at;      /* Time at which to next update */
 448         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
 449         struct list_head        proc_link;      /* Link in cell->vl_proc */
 450         unsigned long           flags;
 451 #define AFS_VOLUME_NEEDS_UPDATE 0       /* - T if an update needs performing */
 452 #define AFS_VOLUME_UPDATING     1       /* - T if an update is in progress */
 453 #define AFS_VOLUME_WAIT         2       /* - T if users must wait for update */
 454 #define AFS_VOLUME_DELETED      3       /* - T if volume appears deleted */
 455 #define AFS_VOLUME_OFFLINE      4       /* - T if volume offline notice given */
 456 #define AFS_VOLUME_BUSY         5       /* - T if volume busy notice given */
 457 #ifdef CONFIG_AFS_FSCACHE
 458         struct fscache_cookie   *cache;         /* caching cookie */
 459 #endif
 460         struct afs_server_list  *servers;       /* List of servers on which volume resides */
 461         rwlock_t                servers_lock;   /* Lock for ->servers */
 462         unsigned int            servers_seq;    /* Incremented each time ->servers changes */
 463
 464         unsigned                cb_v_break;     /* Break-everything counter. */
 465         rwlock_t                cb_break_lock;
 466
 467         afs_voltype_t           type;           /* type of volume */
 468         short                   error;
 469         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
 470         u8                      name_len;
 471         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
 472 };
 473
 474 enum afs_lock_state {
 475         AFS_VNODE_LOCK_NONE,            /* The vnode has no lock on the server */
 476         AFS_VNODE_LOCK_WAITING_FOR_CB,  /* We're waiting for the server to break the callback */
 477         AFS_VNODE_LOCK_SETTING,         /* We're asking the server for a lock */
 478         AFS_VNODE_LOCK_GRANTED,         /* We have a lock on the server */
 479         AFS_VNODE_LOCK_EXTENDING,       /* We're extending a lock on the server */
 480         AFS_VNODE_LOCK_NEED_UNLOCK,     /* We need to unlock on the server */
 481         AFS_VNODE_LOCK_UNLOCKING,       /* We're telling the server to unlock */
 482 };
 483
 484 /*
 485  * AFS inode private data.
 486  *
 487  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
 488  * leak from one inode to another.
 489  */
 490 struct afs_vnode {
 491         struct inode            vfs_inode;      /* the VFS's inode record */
 492
 493         struct afs_volume       *volume;        /* volume on which vnode resides */
 494         struct afs_fid          fid;            /* the file identifier for this inode */
 495         struct afs_file_status  status;         /* AFS status info for this file */
 496         afs_dataversion_t       invalid_before; /* Child dentries are invalid before this */
 497 #ifdef CONFIG_AFS_FSCACHE
 498         struct fscache_cookie   *cache;         /* caching cookie */
 499 #endif
 500         struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
 501         struct mutex            io_lock;        /* Lock for serialising I/O on this mutex */
 502         struct rw_semaphore     validate_lock;  /* lock for validating this vnode */
 503         spinlock_t              wb_lock;        /* lock for wb_keys */
 504         spinlock_t              lock;           /* waitqueue/flags lock */
 505         unsigned long           flags;
 506 #define AFS_VNODE_CB_PROMISED   0               /* Set if vnode has a callback promise */
 507 #define AFS_VNODE_UNSET         1               /* set if vnode attributes not yet set */
 508 #define AFS_VNODE_DIR_VALID     2               /* Set if dir contents are valid */
 509 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
 510 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
 511 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
 512 #define AFS_VNODE_AUTOCELL      6               /* set if Vnode is an auto mount point */
 513 #define AFS_VNODE_PSEUDODIR     7               /* set if Vnode is a pseudo directory */
 514 #define AFS_VNODE_NEW_CONTENT   8               /* Set if file has new content (create/trunc-0) */
 515
 516         struct list_head        wb_keys;        /* List of keys available for writeback */
 517         struct list_head        pending_locks;  /* locks waiting to be granted */
 518         struct list_head        granted_locks;  /* locks granted on this file */
 519         struct delayed_work     lock_work;      /* work to be done in locking */
 520         struct key              *lock_key;      /* Key to be used in lock ops */
 521         enum afs_lock_state     lock_state : 8;
 522         afs_lock_type_t         lock_type : 8;
 523
 524         /* outstanding callback notification on this file */
 525         struct afs_cb_interest  *cb_interest;   /* Server on which this resides */
 526         unsigned int            cb_s_break;     /* Mass break counter on ->server */
 527         unsigned int            cb_v_break;     /* Mass break counter on ->volume */
 528         unsigned int            cb_break;       /* Break counter on vnode */
 529         seqlock_t               cb_lock;        /* Lock for ->cb_interest, ->status, ->cb_*break */
 530
 531         time64_t                cb_expires_at;  /* time at which callback expires */
 532         unsigned                cb_version;     /* callback version */
 533         afs_callback_type_t     cb_type;        /* type of callback */
 534 };
 535
 536 /*
 537  * cached security record for one user's attempt to access a vnode
 538  */
 539 struct afs_permit {
 540         struct key              *key;           /* RxRPC ticket holding a security context */
 541         afs_access_t            access;         /* CallerAccess value for this key */
 542 };
 543
 544 /*
 545  * Immutable cache of CallerAccess records from attempts to access vnodes.
 546  * These may be shared between multiple vnodes.
 547  */
 548 struct afs_permits {
 549         struct rcu_head         rcu;
 550         struct hlist_node       hash_node;      /* Link in hash */
 551         unsigned long           h;              /* Hash value for this permit list */
 552         refcount_t              usage;
 553         unsigned short          nr_permits;     /* Number of records */
 554         bool                    invalidated;    /* Invalidated due to key change */
 555         struct afs_permit       permits[];      /* List of permits sorted by key pointer */
 556 };
 557
 558 /*
 559  * record of one of a system's set of network interfaces
 560  */
 561 struct afs_interface {
 562         struct in_addr  address;        /* IPv4 address bound to interface */
 563         struct in_addr  netmask;        /* netmask applied to address */
 564         unsigned        mtu;            /* MTU of interface */
 565 };
 566
 567 /*
 568  * Cursor for iterating over a server's address list.
 569  */
 570 struct afs_addr_cursor {
 571         struct afs_addr_list    *alist;         /* Current address list (pins ref) */
 572         struct sockaddr_rxrpc   *addr;
 573         u32                     abort_code;
 574         unsigned short          start;          /* Starting point in alist->addrs[] */
 575         unsigned short          index;          /* Wrapping offset from start to current addr */
 576         short                   error;
 577         bool                    begun;          /* T if we've begun iteration */
 578         bool                    responded;      /* T if the current address responded */
 579 };
 580
 581 /*
 582  * Cursor for iterating over a set of fileservers.
 583  */
 584 struct afs_fs_cursor {
 585         struct afs_addr_cursor  ac;
 586         struct afs_vnode        *vnode;
 587         struct afs_server_list  *server_list;   /* Current server list (pins ref) */
 588         struct afs_cb_interest  *cbi;           /* Server on which this resides (pins ref) */
 589         struct key              *key;           /* Key for the server */
 590         unsigned int            cb_break;       /* cb_break + cb_s_break before the call */
 591         unsigned int            cb_break_2;     /* cb_break + cb_s_break (2nd vnode) */
 592         unsigned char           start;          /* Initial index in server list */
 593         unsigned char           index;          /* Number of servers tried beyond start */
 594         unsigned short          flags;
 595 #define AFS_FS_CURSOR_STOP      0x0001          /* Set to cease iteration */
 596 #define AFS_FS_CURSOR_VBUSY     0x0002          /* Set if seen VBUSY */
 597 #define AFS_FS_CURSOR_VMOVED    0x0004          /* Set if seen VMOVED */
 598 #define AFS_FS_CURSOR_VNOVOL    0x0008          /* Set if seen VNOVOL */
 599 #define AFS_FS_CURSOR_CUR_ONLY  0x0010          /* Set if current server only (file lock held) */
 600 #define AFS_FS_CURSOR_NO_VSLEEP 0x0020          /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
 601 };
 602
 603 /*
 604  * Cache auxiliary data.
 605  */
 606 struct afs_vnode_cache_aux {
 607         u64                     data_version;
 608 } __packed;
 609
 610 #include <trace/events/afs.h>
 611
 612 /*****************************************************************************/
 613 /*
 614  * addr_list.c
 615  */
 616 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
 617 {
 618         if (alist)
 619                 refcount_inc(&alist->usage);
 620         return alist;
 621 }
 622 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
 623                                                 unsigned short,
 624                                                 unsigned short);
 625 extern void afs_put_addrlist(struct afs_addr_list *);
 626 extern struct afs_addr_list *afs_parse_text_addrs(const char *, size_t, char,
 627                                                   unsigned short, unsigned short);
 628 extern struct afs_addr_list *afs_dns_query(struct afs_cell *, time64_t *);
 629 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
 630 extern int afs_end_cursor(struct afs_addr_cursor *);
 631 extern int afs_set_vl_cursor(struct afs_addr_cursor *, struct afs_cell *);
 632
 633 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
 634 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
 635
 636 /*
 637  * cache.c
 638  */
 639 #ifdef CONFIG_AFS_FSCACHE
 640 extern struct fscache_netfs afs_cache_netfs;
 641 extern struct fscache_cookie_def afs_cell_cache_index_def;
 642 extern struct fscache_cookie_def afs_volume_cache_index_def;
 643 extern struct fscache_cookie_def afs_vnode_cache_index_def;
 644 #else
 645 #define afs_cell_cache_index_def        (*(struct fscache_cookie_def *) NULL)
 646 #define afs_volume_cache_index_def      (*(struct fscache_cookie_def *) NULL)
 647 #define afs_vnode_cache_index_def       (*(struct fscache_cookie_def *) NULL)
 648 #endif
 649
 650 /*
 651  * callback.c
 652  */
 653 extern void afs_init_callback_state(struct afs_server *);
 654 extern void afs_break_callback(struct afs_vnode *);
 655 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break*);
 656
 657 extern int afs_register_server_cb_interest(struct afs_vnode *,
 658                                            struct afs_server_list *, unsigned int);
 659 extern void afs_put_cb_interest(struct afs_net *, struct afs_cb_interest *);
 660 extern void afs_clear_callback_interests(struct afs_net *, struct afs_server_list *);
 661
 662 static inline struct afs_cb_interest *afs_get_cb_interest(struct afs_cb_interest *cbi)
 663 {
 664         if (cbi)
 665                 refcount_inc(&cbi->usage);
 666         return cbi;
 667 }
 668
 669 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
 670 {
 671         return vnode->cb_break + vnode->cb_s_break + vnode->cb_v_break;
 672 }
 673
 674 static inline unsigned int afs_cb_break_sum(struct afs_vnode *vnode,
 675                                             struct afs_cb_interest *cbi)
 676 {
 677         return vnode->cb_break + cbi->server->cb_s_break + vnode->volume->cb_v_break;
 678 }
 679
 680 /*
 681  * cell.c
 682  */
 683 extern int afs_cell_init(struct afs_net *, const char *);
 684 extern struct afs_cell *afs_lookup_cell_rcu(struct afs_net *, const char *, unsigned);
 685 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
 686                                         const char *, bool);
 687 extern struct afs_cell *afs_get_cell(struct afs_cell *);
 688 extern void afs_put_cell(struct afs_net *, struct afs_cell *);
 689 extern void afs_manage_cells(struct work_struct *);
 690 extern void afs_cells_timer(struct timer_list *);
 691 extern void __net_exit afs_cell_purge(struct afs_net *);
 692
 693 /*
 694  * cmservice.c
 695  */
 696 extern bool afs_cm_incoming_call(struct afs_call *);
 697
 698 /*
 699  * dir.c
 700  */
 701 extern const struct file_operations afs_dir_file_operations;
 702 extern const struct inode_operations afs_dir_inode_operations;
 703 extern const struct address_space_operations afs_dir_aops;
 704 extern const struct dentry_operations afs_fs_dentry_operations;
 705
 706 extern void afs_d_release(struct dentry *);
 707
 708 /*
 709  * dir_edit.c
 710  */
 711 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
 712                              enum afs_edit_dir_reason);
 713 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
 714
 715 /*
 716  * dynroot.c
 717  */
 718 extern const struct file_operations afs_dynroot_file_operations;
 719 extern const struct inode_operations afs_dynroot_inode_operations;
 720 extern const struct dentry_operations afs_dynroot_dentry_operations;
 721
 722 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
 723
 724 /*
 725  * file.c
 726  */
 727 extern const struct address_space_operations afs_fs_aops;
 728 extern const struct inode_operations afs_file_inode_operations;
 729 extern const struct file_operations afs_file_operations;
 730
 731 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
 732 extern void afs_put_wb_key(struct afs_wb_key *);
 733 extern int afs_open(struct inode *, struct file *);
 734 extern int afs_release(struct inode *, struct file *);
 735 extern int afs_fetch_data(struct afs_vnode *, struct key *, struct afs_read *);
 736 extern int afs_page_filler(void *, struct page *);
 737 extern void afs_put_read(struct afs_read *);
 738
 739 /*
 740  * flock.c
 741  */
 742 extern struct workqueue_struct *afs_lock_manager;
 743
 744 extern void afs_lock_work(struct work_struct *);
 745 extern void afs_lock_may_be_available(struct afs_vnode *);
 746 extern int afs_lock(struct file *, int, struct file_lock *);
 747 extern int afs_flock(struct file *, int, struct file_lock *);
 748
 749 /*
 750  * fsclient.c
 751  */
 752 #define AFS_VNODE_NOT_YET_SET   0x01
 753 #define AFS_VNODE_META_CHANGED  0x02
 754 #define AFS_VNODE_DATA_CHANGED  0x04
 755 extern void afs_update_inode_from_status(struct afs_vnode *, struct afs_file_status *,
 756                                          const afs_dataversion_t *, u8);
 757
 758 extern int afs_fs_fetch_file_status(struct afs_fs_cursor *, struct afs_volsync *, bool);
 759 extern int afs_fs_give_up_callbacks(struct afs_net *, struct afs_server *);
 760 extern int afs_fs_fetch_data(struct afs_fs_cursor *, struct afs_read *);
 761 extern int afs_fs_create(struct afs_fs_cursor *, const char *, umode_t, u64,
 762                          struct afs_fid *, struct afs_file_status *, struct afs_callback *);
 763 extern int afs_fs_remove(struct afs_fs_cursor *, const char *, bool, u64);
 764 extern int afs_fs_link(struct afs_fs_cursor *, struct afs_vnode *, const char *, u64);
 765 extern int afs_fs_symlink(struct afs_fs_cursor *, const char *, const char *, u64,
 766                           struct afs_fid *, struct afs_file_status *);
 767 extern int afs_fs_rename(struct afs_fs_cursor *, const char *,
 768                          struct afs_vnode *, const char *, u64, u64);
 769 extern int afs_fs_store_data(struct afs_fs_cursor *, struct address_space *,
 770                              pgoff_t, pgoff_t, unsigned, unsigned);
 771 extern int afs_fs_setattr(struct afs_fs_cursor *, struct iattr *);
 772 extern int afs_fs_get_volume_status(struct afs_fs_cursor *, struct afs_volume_status *);
 773 extern int afs_fs_set_lock(struct afs_fs_cursor *, afs_lock_type_t);
 774 extern int afs_fs_extend_lock(struct afs_fs_cursor *);
 775 extern int afs_fs_release_lock(struct afs_fs_cursor *);
 776 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
 777                                         struct afs_addr_cursor *, struct key *);
 778 extern int afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
 779                                    struct afs_addr_cursor *, struct key *);
 780 extern int afs_fs_inline_bulk_status(struct afs_fs_cursor *, struct afs_net *,
 781                                      struct afs_fid *, struct afs_file_status *,
 782                                      struct afs_callback *, unsigned int,
 783                                      struct afs_volsync *);
 784 extern int afs_fs_fetch_status(struct afs_fs_cursor *, struct afs_net *,
 785                                struct afs_fid *, struct afs_file_status *,
 786                                struct afs_callback *, struct afs_volsync *);
 787
 788 /*
 789  * inode.c
 790  */
 791 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool);
 792 extern int afs_iget5_test(struct inode *, void *);
 793 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
 794 extern struct inode *afs_iget(struct super_block *, struct key *,
 795                               struct afs_fid *, struct afs_file_status *,
 796                               struct afs_callback *,
 797                               struct afs_cb_interest *);
 798 extern void afs_zap_data(struct afs_vnode *);
 799 extern int afs_validate(struct afs_vnode *, struct key *);
 800 extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
 801 extern int afs_setattr(struct dentry *, struct iattr *);
 802 extern void afs_evict_inode(struct inode *);
 803 extern int afs_drop_inode(struct inode *);
 804
 805 /*
 806  * main.c
 807  */
 808 extern struct workqueue_struct *afs_wq;
 809
 810 static inline struct afs_net *afs_d2net(struct dentry *dentry)
 811 {
 812         return &__afs_net;
 813 }
 814
 815 static inline struct afs_net *afs_i2net(struct inode *inode)
 816 {
 817         return &__afs_net;
 818 }
 819
 820 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
 821 {
 822         return &__afs_net;
 823 }
 824
 825 static inline struct afs_net *afs_sock2net(struct sock *sk)
 826 {
 827         return &__afs_net;
 828 }
 829
 830 static inline struct afs_net *afs_get_net(struct afs_net *net)
 831 {
 832         return net;
 833 }
 834
 835 static inline void afs_put_net(struct afs_net *net)
 836 {
 837 }
 838
 839 static inline void __afs_stat(atomic_t *s)
 840 {
 841         atomic_inc(s);
 842 }
 843
 844 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
 845
 846 /*
 847  * misc.c
 848  */
 849 extern int afs_abort_to_error(u32);
 850
 851 /*
 852  * mntpt.c
 853  */
 854 extern const struct inode_operations afs_mntpt_inode_operations;
 855 extern const struct inode_operations afs_autocell_inode_operations;
 856 extern const struct file_operations afs_mntpt_file_operations;
 857
 858 extern struct vfsmount *afs_d_automount(struct path *);
 859 extern void afs_mntpt_kill_timer(void);
 860
 861 /*
 862  * netdevices.c
 863  */
 864 extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
 865
 866 /*
 867  * proc.c
 868  */
 869 extern int __net_init afs_proc_init(struct afs_net *);
 870 extern void __net_exit afs_proc_cleanup(struct afs_net *);
 871 extern int afs_proc_cell_setup(struct afs_net *, struct afs_cell *);
 872 extern void afs_proc_cell_remove(struct afs_net *, struct afs_cell *);
 873 extern void afs_put_sysnames(struct afs_sysnames *);
 874
 875 /*
 876  * rotate.c
 877  */
 878 extern bool afs_begin_vnode_operation(struct afs_fs_cursor *, struct afs_vnode *,
 879                                       struct key *);
 880 extern bool afs_select_fileserver(struct afs_fs_cursor *);
 881 extern bool afs_select_current_fileserver(struct afs_fs_cursor *);
 882 extern int afs_end_vnode_operation(struct afs_fs_cursor *);
 883
 884 /*
 885  * rxrpc.c
 886  */
 887 extern struct workqueue_struct *afs_async_calls;
 888
 889 extern int __net_init afs_open_socket(struct afs_net *);
 890 extern void __net_exit afs_close_socket(struct afs_net *);
 891 extern void afs_charge_preallocation(struct work_struct *);
 892 extern void afs_put_call(struct afs_call *);
 893 extern int afs_queue_call_work(struct afs_call *);
 894 extern long afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t, bool);
 895 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
 896                                             const struct afs_call_type *,
 897                                             size_t, size_t);
 898 extern void afs_flat_call_destructor(struct afs_call *);
 899 extern void afs_send_empty_reply(struct afs_call *);
 900 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
 901 extern int afs_extract_data(struct afs_call *, void *, size_t, bool);
 902 extern int afs_protocol_error(struct afs_call *, int);
 903
 904 static inline int afs_transfer_reply(struct afs_call *call)
 905 {
 906         return afs_extract_data(call, call->buffer, call->reply_max, false);
 907 }
 908
 909 static inline bool afs_check_call_state(struct afs_call *call,
 910                                         enum afs_call_state state)
 911 {
 912         return READ_ONCE(call->state) == state;
 913 }
 914
 915 static inline bool afs_set_call_state(struct afs_call *call,
 916                                       enum afs_call_state from,
 917                                       enum afs_call_state to)
 918 {
 919         bool ok = false;
 920
 921         spin_lock_bh(&call->state_lock);
 922         if (call->state == from) {
 923                 call->state = to;
 924                 trace_afs_call_state(call, from, to, 0, 0);
 925                 ok = true;
 926         }
 927         spin_unlock_bh(&call->state_lock);
 928         return ok;
 929 }
 930
 931 static inline void afs_set_call_complete(struct afs_call *call,
 932                                          int error, u32 remote_abort)
 933 {
 934         enum afs_call_state state;
 935         bool ok = false;
 936
 937         spin_lock_bh(&call->state_lock);
 938         state = call->state;
 939         if (state != AFS_CALL_COMPLETE) {
 940                 call->abort_code = remote_abort;
 941                 call->error = error;
 942                 call->state = AFS_CALL_COMPLETE;
 943                 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
 944                                      error, remote_abort);
 945                 ok = true;
 946         }
 947         spin_unlock_bh(&call->state_lock);
 948         if (ok)
 949                 trace_afs_call_done(call);
 950 }
 951
 952 /*
 953  * security.c
 954  */
 955 extern void afs_put_permits(struct afs_permits *);
 956 extern void afs_clear_permits(struct afs_vnode *);
 957 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int);
 958 extern void afs_zap_permits(struct rcu_head *);
 959 extern struct key *afs_request_key(struct afs_cell *);
 960 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
 961 extern int afs_permission(struct inode *, int);
 962 extern void __exit afs_clean_up_permit_cache(void);
 963
 964 /*
 965  * server.c
 966  */
 967 extern spinlock_t afs_server_peer_lock;
 968
 969 static inline struct afs_server *afs_get_server(struct afs_server *server)
 970 {
 971         atomic_inc(&server->usage);
 972         return server;
 973 }
 974
 975 extern struct afs_server *afs_find_server(struct afs_net *,
 976                                           const struct sockaddr_rxrpc *);
 977 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
 978 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *);
 979 extern void afs_put_server(struct afs_net *, struct afs_server *);
 980 extern void afs_manage_servers(struct work_struct *);
 981 extern void afs_servers_timer(struct timer_list *);
 982 extern void __net_exit afs_purge_servers(struct afs_net *);
 983 extern bool afs_probe_fileserver(struct afs_fs_cursor *);
 984 extern bool afs_check_server_record(struct afs_fs_cursor *, struct afs_server *);
 985
 986 /*
 987  * server_list.c
 988  */
 989 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
 990 {
 991         refcount_inc(&slist->usage);
 992         return slist;
 993 }
 994
 995 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
 996 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
 997                                                      struct afs_vldb_entry *,
 998                                                      u8);
 999 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1000
1001 /*
1002  * super.c
1003  */
1004 extern int __init afs_fs_init(void);
1005 extern void __exit afs_fs_exit(void);
1006
1007 /*
1008  * vlclient.c
1009  */
1010 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_net *,
1011                                                          struct afs_addr_cursor *,
1012                                                          struct key *, const char *, int);
1013 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_net *, struct afs_addr_cursor *,
1014                                                 struct key *, const uuid_t *);
1015 extern int afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *, struct key *);
1016 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_net *, struct afs_addr_cursor *,
1017                                                      struct key *, const uuid_t *);
1018
1019 /*
1020  * volume.c
1021  */
1022 static inline struct afs_volume *__afs_get_volume(struct afs_volume *volume)
1023 {
1024         if (volume)
1025                 atomic_inc(&volume->usage);
1026         return volume;
1027 }
1028
1029 extern struct afs_volume *afs_create_volume(struct afs_mount_params *);
1030 extern void afs_activate_volume(struct afs_volume *);
1031 extern void afs_deactivate_volume(struct afs_volume *);
1032 extern void afs_put_volume(struct afs_cell *, struct afs_volume *);
1033 extern int afs_check_volume_status(struct afs_volume *, struct key *);
1034
1035 /*
1036  * write.c
1037  */
1038 extern int afs_set_page_dirty(struct page *);
1039 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1040                         loff_t pos, unsigned len, unsigned flags,
1041                         struct page **pagep, void **fsdata);
1042 extern int afs_write_end(struct file *file, struct address_space *mapping,
1043                         loff_t pos, unsigned len, unsigned copied,
1044                         struct page *page, void *fsdata);
1045 extern int afs_writepage(struct page *, struct writeback_control *);
1046 extern int afs_writepages(struct address_space *, struct writeback_control *);
1047 extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
1048 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1049 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1050 extern int afs_page_mkwrite(struct vm_fault *);
1051 extern void afs_prune_wb_keys(struct afs_vnode *);
1052 extern int afs_launder_page(struct page *);
1053
1054 /*
1055  * xattr.c
1056  */
1057 extern const struct xattr_handler *afs_xattr_handlers[];
1058 extern ssize_t afs_listxattr(struct dentry *, char *, size_t);
1059
1060
1061 /*
1062  * Miscellaneous inline functions.
1063  */
1064 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1065 {
1066         return container_of(inode, struct afs_vnode, vfs_inode);
1067 }
1068
1069 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1070 {
1071         return &vnode->vfs_inode;
1072 }
1073
1074 static inline void afs_vnode_commit_status(struct afs_fs_cursor *fc,
1075                                            struct afs_vnode *vnode,
1076                                            unsigned int cb_break)
1077 {
1078         if (fc->ac.error == 0)
1079                 afs_cache_permit(vnode, fc->key, cb_break);
1080 }
1081
1082 static inline void afs_check_for_remote_deletion(struct afs_fs_cursor *fc,
1083                                                  struct afs_vnode *vnode)
1084 {
1085         if (fc->ac.error == -ENOENT) {
1086                 set_bit(AFS_VNODE_DELETED, &vnode->flags);
1087                 afs_break_callback(vnode);
1088         }
1089 }
1090
1091
1092 /*****************************************************************************/
1093 /*
1094  * debug tracing
1095  */
1096 extern unsigned afs_debug;
1097
1098 #define dbgprintk(FMT,...) \
1099         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1100
1101 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1102 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1103 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1104
1105
1106 #if defined(__KDEBUG)
1107 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1108 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1109 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1110
1111 #elif defined(CONFIG_AFS_DEBUG)
1112 #define AFS_DEBUG_KENTER        0x01
1113 #define AFS_DEBUG_KLEAVE        0x02
1114 #define AFS_DEBUG_KDEBUG        0x04
1115
1116 #define _enter(FMT,...)                                 \
1117 do {                                                    \
1118         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
1119                 kenter(FMT,##__VA_ARGS__);              \
1120 } while (0)
1121
1122 #define _leave(FMT,...)                                 \
1123 do {                                                    \
1124         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
1125                 kleave(FMT,##__VA_ARGS__);              \
1126 } while (0)
1127
1128 #define _debug(FMT,...)                                 \
1129 do {                                                    \
1130         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
1131                 kdebug(FMT,##__VA_ARGS__);              \
1132 } while (0)
1133
1134 #else
1135 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1136 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1137 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1138 #endif
1139
1140 /*
1141  * debug assertion checking
1142  */
1143 #if 1 // defined(__KDEBUGALL)
1144
1145 #define ASSERT(X)                                               \
1146 do {                                                            \
1147         if (unlikely(!(X))) {                                   \
1148                 printk(KERN_ERR "\n");                          \
1149                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1150                 BUG();                                          \
1151         }                                                       \
1152 } while(0)
1153
1154 #define ASSERTCMP(X, OP, Y)                                             \
1155 do {                                                                    \
1156         if (unlikely(!((X) OP (Y)))) {                                  \
1157                 printk(KERN_ERR "\n");                                  \
1158                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1159                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1160                        (unsigned long)(X), (unsigned long)(Y));         \
1161                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1162                        (unsigned long)(X), (unsigned long)(Y));         \
1163                 BUG();                                                  \
1164         }                                                               \
1165 } while(0)
1166
1167 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
1168 do {                                                                    \
1169         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
1170                 printk(KERN_ERR "\n");                                  \
1171                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1172                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1173                        (unsigned long)(L), (unsigned long)(N),          \
1174                        (unsigned long)(H));                             \
1175                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1176                        (unsigned long)(L), (unsigned long)(N),          \
1177                        (unsigned long)(H));                             \
1178                 BUG();                                                  \
1179         }                                                               \
1180 } while(0)
1181
1182 #define ASSERTIF(C, X)                                          \
1183 do {                                                            \
1184         if (unlikely((C) && !(X))) {                            \
1185                 printk(KERN_ERR "\n");                          \
1186                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1187                 BUG();                                          \
1188         }                                                       \
1189 } while(0)
1190
1191 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1192 do {                                                                    \
1193         if (unlikely((C) && !((X) OP (Y)))) {                           \
1194                 printk(KERN_ERR "\n");                                  \
1195                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1196                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1197                        (unsigned long)(X), (unsigned long)(Y));         \
1198                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1199                        (unsigned long)(X), (unsigned long)(Y));         \
1200                 BUG();                                                  \
1201         }                                                               \
1202 } while(0)
1203
1204 #else
1205
1206 #define ASSERT(X)                               \
1207 do {                                            \
1208 } while(0)
1209
1210 #define ASSERTCMP(X, OP, Y)                     \
1211 do {                                            \
1212 } while(0)
1213
1214 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
1215 do {                                            \
1216 } while(0)
1217
1218 #define ASSERTIF(C, X)                          \
1219 do {                                            \
1220 } while(0)
1221
1222 #define ASSERTIFCMP(C, X, OP, Y)                \
1223 do {                                            \
1224 } while(0)
1225
1226 #endif /* __KDEBUGALL */