fs/afs/internal.h

   1 /* internal AFS stuff
   2  *
   3  * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/compiler.h>
  13 #include <linux/kernel.h>
  14 #include <linux/ktime.h>
  15 #include <linux/fs.h>
  16 #include <linux/pagemap.h>
  17 #include <linux/rxrpc.h>
  18 #include <linux/key.h>
  19 #include <linux/workqueue.h>
  20 #include <linux/sched.h>
  21 #include <linux/fscache.h>
  22 #include <linux/backing-dev.h>
  23 #include <linux/uuid.h>
  24 #include <net/af_rxrpc.h>
  25
  26 #include "afs.h"
  27 #include "afs_vl.h"
  28
  29 #define AFS_CELL_MAX_ADDRS 15
  30
  31 struct pagevec;
  32 struct afs_call;
  33
  34 typedef enum {
  35         AFS_VL_NEW,                     /* new, uninitialised record */
  36         AFS_VL_CREATING,                /* creating record */
  37         AFS_VL_VALID,                   /* record is pending */
  38         AFS_VL_NO_VOLUME,               /* no such volume available */
  39         AFS_VL_UPDATING,                /* update in progress */
  40         AFS_VL_VOLUME_DELETED,          /* volume was deleted */
  41         AFS_VL_UNCERTAIN,               /* uncertain state (update failed) */
  42 } __attribute__((packed)) afs_vlocation_state_t;
  43
  44 struct afs_mount_params {
  45         bool                    rwpath;         /* T if the parent should be considered R/W */
  46         bool                    force;          /* T to force cell type */
  47         bool                    autocell;       /* T if set auto mount operation */
  48         afs_voltype_t           type;           /* type of volume requested */
  49         int                     volnamesz;      /* size of volume name */
  50         const char              *volname;       /* name of volume to mount */
  51         struct afs_cell         *cell;          /* cell in which to find volume */
  52         struct afs_volume       *volume;        /* volume record */
  53         struct key              *key;           /* key to use for secure mounting */
  54 };
  55
  56 enum afs_call_state {
  57         AFS_CALL_REQUESTING,    /* request is being sent for outgoing call */
  58         AFS_CALL_AWAIT_REPLY,   /* awaiting reply to outgoing call */
  59         AFS_CALL_AWAIT_OP_ID,   /* awaiting op ID on incoming call */
  60         AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
  61         AFS_CALL_REPLYING,      /* replying to incoming call */
  62         AFS_CALL_AWAIT_ACK,     /* awaiting final ACK of incoming call */
  63         AFS_CALL_COMPLETE,      /* Completed or failed */
  64 };
  65 /*
  66  * a record of an in-progress RxRPC call
  67  */
  68 struct afs_call {
  69         const struct afs_call_type *type;       /* type of call */
  70         wait_queue_head_t       waitq;          /* processes awaiting completion */
  71         struct work_struct      async_work;     /* async I/O processor */
  72         struct work_struct      work;           /* actual work processor */
  73         struct rxrpc_call       *rxcall;        /* RxRPC call handle */
  74         struct key              *key;           /* security for this call */
  75         struct afs_server       *server;        /* server affected by incoming CM call */
  76         void                    *request;       /* request data (first part) */
  77         struct address_space    *mapping;       /* page set */
  78         struct afs_writeback    *wb;            /* writeback being performed */
  79         void                    *buffer;        /* reply receive buffer */
  80         void                    *reply;         /* reply buffer (first part) */
  81         void                    *reply2;        /* reply buffer (second part) */
  82         void                    *reply3;        /* reply buffer (third part) */
  83         void                    *reply4;        /* reply buffer (fourth part) */
  84         pgoff_t                 first;          /* first page in mapping to deal with */
  85         pgoff_t                 last;           /* last page in mapping to deal with */
  86         size_t                  offset;         /* offset into received data store */
  87         atomic_t                usage;
  88         enum afs_call_state     state;
  89         int                     error;          /* error code */
  90         u32                     abort_code;     /* Remote abort ID or 0 */
  91         unsigned                request_size;   /* size of request data */
  92         unsigned                reply_max;      /* maximum size of reply */
  93         unsigned                first_offset;   /* offset into mapping[first] */
  94         union {
  95                 unsigned        last_to;        /* amount of mapping[last] */
  96                 unsigned        count2;         /* count used in unmarshalling */
  97         };
  98         unsigned char           unmarshall;     /* unmarshalling phase */
  99         bool                    incoming;       /* T if incoming call */
 100         bool                    send_pages;     /* T if data from mapping should be sent */
 101         bool                    need_attention; /* T if RxRPC poked us */
 102         bool                    async;          /* T if asynchronous */
 103         u16                     service_id;     /* RxRPC service ID to call */
 104         __be16                  port;           /* target UDP port */
 105         u32                     operation_ID;   /* operation ID for an incoming call */
 106         u32                     count;          /* count for use in unmarshalling */
 107         __be32                  tmp;            /* place to extract temporary data */
 108         afs_dataversion_t       store_version;  /* updated version expected from store */
 109 };
 110
 111 struct afs_call_type {
 112         const char *name;
 113
 114         /* deliver request or reply data to an call
 115          * - returning an error will cause the call to be aborted
 116          */
 117         int (*deliver)(struct afs_call *call);
 118
 119         /* map an abort code to an error number */
 120         int (*abort_to_error)(u32 abort_code);
 121
 122         /* clean up a call */
 123         void (*destructor)(struct afs_call *call);
 124
 125         /* Work function */
 126         void (*work)(struct work_struct *work);
 127 };
 128
 129 /*
 130  * Record of an outstanding read operation on a vnode.
 131  */
 132 struct afs_read {
 133         loff_t                  pos;            /* Where to start reading */
 134         loff_t                  len;            /* How much we're asking for */
 135         loff_t                  actual_len;     /* How much we're actually getting */
 136         loff_t                  remain;         /* Amount remaining */
 137         atomic_t                usage;
 138         unsigned int            index;          /* Which page we're reading into */
 139         unsigned int            nr_pages;
 140         void (*page_done)(struct afs_call *, struct afs_read *);
 141         struct page             *pages[];
 142 };
 143
 144 /*
 145  * record of an outstanding writeback on a vnode
 146  */
 147 struct afs_writeback {
 148         struct list_head        link;           /* link in vnode->writebacks */
 149         struct work_struct      writer;         /* work item to perform the writeback */
 150         struct afs_vnode        *vnode;         /* vnode to which this write applies */
 151         struct key              *key;           /* owner of this write */
 152         wait_queue_head_t       waitq;          /* completion and ready wait queue */
 153         pgoff_t                 first;          /* first page in batch */
 154         pgoff_t                 point;          /* last page in current store op */
 155         pgoff_t                 last;           /* last page in batch (inclusive) */
 156         unsigned                offset_first;   /* offset into first page of start of write */
 157         unsigned                to_last;        /* offset into last page of end of write */
 158         int                     num_conflicts;  /* count of conflicting writes in list */
 159         int                     usage;
 160         bool                    conflicts;      /* T if has dependent conflicts */
 161         enum {
 162                 AFS_WBACK_SYNCING,              /* synchronisation being performed */
 163                 AFS_WBACK_PENDING,              /* write pending */
 164                 AFS_WBACK_CONFLICTING,          /* conflicting writes posted */
 165                 AFS_WBACK_WRITING,              /* writing back */
 166                 AFS_WBACK_COMPLETE              /* the writeback record has been unlinked */
 167         } state __attribute__((packed));
 168 };
 169
 170 /*
 171  * AFS superblock private data
 172  * - there's one superblock per volume
 173  */
 174 struct afs_super_info {
 175         struct afs_volume       *volume;        /* volume record */
 176         char                    rwparent;       /* T if parent is R/W AFS volume */
 177 };
 178
 179 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
 180 {
 181         return sb->s_fs_info;
 182 }
 183
 184 extern struct file_system_type afs_fs_type;
 185
 186 /*
 187  * entry in the cached cell catalogue
 188  */
 189 struct afs_cache_cell {
 190         char            name[AFS_MAXCELLNAME];  /* cell name (padded with NULs) */
 191         struct in_addr  vl_servers[15];         /* cached cell VL servers */
 192 };
 193
 194 /*
 195  * AFS cell record
 196  */
 197 struct afs_cell {
 198         atomic_t                usage;
 199         struct list_head        link;           /* main cell list link */
 200         struct key              *anonymous_key; /* anonymous user key for this cell */
 201         struct list_head        proc_link;      /* /proc cell list link */
 202 #ifdef CONFIG_AFS_FSCACHE
 203         struct fscache_cookie   *cache;         /* caching cookie */
 204 #endif
 205
 206         /* server record management */
 207         rwlock_t                servers_lock;   /* active server list lock */
 208         struct list_head        servers;        /* active server list */
 209
 210         /* volume location record management */
 211         struct rw_semaphore     vl_sem;         /* volume management serialisation semaphore */
 212         struct list_head        vl_list;        /* cell's active VL record list */
 213         spinlock_t              vl_lock;        /* vl_list lock */
 214         unsigned short          vl_naddrs;      /* number of VL servers in addr list */
 215         unsigned short          vl_curr_svix;   /* current server index */
 216         struct in_addr          vl_addrs[AFS_CELL_MAX_ADDRS];   /* cell VL server addresses */
 217
 218         char                    name[0];        /* cell name - must go last */
 219 };
 220
 221 /*
 222  * entry in the cached volume location catalogue
 223  */
 224 struct afs_cache_vlocation {
 225         /* volume name (lowercase, padded with NULs) */
 226         uint8_t                 name[AFS_MAXVOLNAME + 1];
 227
 228         uint8_t                 nservers;       /* number of entries used in servers[] */
 229         uint8_t                 vidmask;        /* voltype mask for vid[] */
 230         uint8_t                 srvtmask[8];    /* voltype masks for servers[] */
 231 #define AFS_VOL_VTM_RW  0x01 /* R/W version of the volume is available (on this server) */
 232 #define AFS_VOL_VTM_RO  0x02 /* R/O version of the volume is available (on this server) */
 233 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
 234
 235         afs_volid_t             vid[3];         /* volume IDs for R/W, R/O and Bak volumes */
 236         struct in_addr          servers[8];     /* fileserver addresses */
 237         time_t                  rtime;          /* last retrieval time */
 238 };
 239
 240 /*
 241  * volume -> vnode hash table entry
 242  */
 243 struct afs_cache_vhash {
 244         afs_voltype_t           vtype;          /* which volume variation */
 245         uint8_t                 hash_bucket;    /* which hash bucket this represents */
 246 } __attribute__((packed));
 247
 248 /*
 249  * AFS volume location record
 250  */
 251 struct afs_vlocation {
 252         atomic_t                usage;
 253         time64_t                time_of_death;  /* time at which put reduced usage to 0 */
 254         struct list_head        link;           /* link in cell volume location list */
 255         struct list_head        grave;          /* link in master graveyard list */
 256         struct list_head        update;         /* link in master update list */
 257         struct afs_cell         *cell;          /* cell to which volume belongs */
 258 #ifdef CONFIG_AFS_FSCACHE
 259         struct fscache_cookie   *cache;         /* caching cookie */
 260 #endif
 261         struct afs_cache_vlocation vldb;        /* volume information DB record */
 262         struct afs_volume       *vols[3];       /* volume access record pointer (index by type) */
 263         wait_queue_head_t       waitq;          /* status change waitqueue */
 264         time64_t                update_at;      /* time at which record should be updated */
 265         spinlock_t              lock;           /* access lock */
 266         afs_vlocation_state_t   state;          /* volume location state */
 267         unsigned short          upd_rej_cnt;    /* ENOMEDIUM count during update */
 268         unsigned short          upd_busy_cnt;   /* EBUSY count during update */
 269         bool                    valid;          /* T if valid */
 270 };
 271
 272 /*
 273  * AFS fileserver record
 274  */
 275 struct afs_server {
 276         atomic_t                usage;
 277         time64_t                time_of_death;  /* time at which put reduced usage to 0 */
 278         struct in_addr          addr;           /* server address */
 279         struct afs_cell         *cell;          /* cell in which server resides */
 280         struct list_head        link;           /* link in cell's server list */
 281         struct list_head        grave;          /* link in master graveyard list */
 282         struct rb_node          master_rb;      /* link in master by-addr tree */
 283         struct rw_semaphore     sem;            /* access lock */
 284
 285         /* file service access */
 286         struct rb_root          fs_vnodes;      /* vnodes backed by this server (ordered by FID) */
 287         unsigned long           fs_act_jif;     /* time at which last activity occurred */
 288         unsigned long           fs_dead_jif;    /* time at which no longer to be considered dead */
 289         spinlock_t              fs_lock;        /* access lock */
 290         int                     fs_state;       /* 0 or reason FS currently marked dead (-errno) */
 291
 292         /* callback promise management */
 293         struct rb_root          cb_promises;    /* vnode expiration list (ordered earliest first) */
 294         struct delayed_work     cb_updater;     /* callback updater */
 295         struct delayed_work     cb_break_work;  /* collected break dispatcher */
 296         wait_queue_head_t       cb_break_waitq; /* space available in cb_break waitqueue */
 297         spinlock_t              cb_lock;        /* access lock */
 298         struct afs_callback     cb_break[64];   /* ring of callbacks awaiting breaking */
 299         atomic_t                cb_break_n;     /* number of pending breaks */
 300         u8                      cb_break_head;  /* head of callback breaking ring */
 301         u8                      cb_break_tail;  /* tail of callback breaking ring */
 302 };
 303
 304 /*
 305  * AFS volume access record
 306  */
 307 struct afs_volume {
 308         atomic_t                usage;
 309         struct afs_cell         *cell;          /* cell to which belongs (unrefd ptr) */
 310         struct afs_vlocation    *vlocation;     /* volume location */
 311 #ifdef CONFIG_AFS_FSCACHE
 312         struct fscache_cookie   *cache;         /* caching cookie */
 313 #endif
 314         afs_volid_t             vid;            /* volume ID */
 315         afs_voltype_t           type;           /* type of volume */
 316         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
 317         unsigned short          nservers;       /* number of server slots filled */
 318         unsigned short          rjservers;      /* number of servers discarded due to -ENOMEDIUM */
 319         struct afs_server       *servers[8];    /* servers on which volume resides (ordered) */
 320         struct rw_semaphore     server_sem;     /* lock for accessing current server */
 321         struct backing_dev_info bdi;
 322 };
 323
 324 /*
 325  * vnode catalogue entry
 326  */
 327 struct afs_cache_vnode {
 328         afs_vnodeid_t           vnode_id;       /* vnode ID */
 329         unsigned                vnode_unique;   /* vnode ID uniquifier */
 330         afs_dataversion_t       data_version;   /* data version */
 331 };
 332
 333 /*
 334  * AFS inode private data
 335  */
 336 struct afs_vnode {
 337         struct inode            vfs_inode;      /* the VFS's inode record */
 338
 339         struct afs_volume       *volume;        /* volume on which vnode resides */
 340         struct afs_server       *server;        /* server currently supplying this file */
 341         struct afs_fid          fid;            /* the file identifier for this inode */
 342         struct afs_file_status  status;         /* AFS status info for this file */
 343 #ifdef CONFIG_AFS_FSCACHE
 344         struct fscache_cookie   *cache;         /* caching cookie */
 345 #endif
 346         struct afs_permits      *permits;       /* cache of permits so far obtained */
 347         struct mutex            permits_lock;   /* lock for altering permits list */
 348         struct mutex            validate_lock;  /* lock for validating this vnode */
 349         wait_queue_head_t       update_waitq;   /* status fetch waitqueue */
 350         int                     update_cnt;     /* number of outstanding ops that will update the
 351                                                  * status */
 352         spinlock_t              writeback_lock; /* lock for writebacks */
 353         spinlock_t              lock;           /* waitqueue/flags lock */
 354         unsigned long           flags;
 355 #define AFS_VNODE_CB_BROKEN     0               /* set if vnode's callback was broken */
 356 #define AFS_VNODE_UNSET         1               /* set if vnode attributes not yet set */
 357 #define AFS_VNODE_MODIFIED      2               /* set if vnode's data modified */
 358 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
 359 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
 360 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
 361 #define AFS_VNODE_LOCKING       6               /* set if waiting for lock on vnode */
 362 #define AFS_VNODE_READLOCKED    7               /* set if vnode is read-locked on the server */
 363 #define AFS_VNODE_WRITELOCKED   8               /* set if vnode is write-locked on the server */
 364 #define AFS_VNODE_UNLOCKING     9               /* set if vnode is being unlocked on the server */
 365 #define AFS_VNODE_AUTOCELL      10              /* set if Vnode is an auto mount point */
 366 #define AFS_VNODE_PSEUDODIR     11              /* set if Vnode is a pseudo directory */
 367
 368         long                    acl_order;      /* ACL check count (callback break count) */
 369
 370         struct list_head        writebacks;     /* alterations in pagecache that need writing */
 371         struct list_head        pending_locks;  /* locks waiting to be granted */
 372         struct list_head        granted_locks;  /* locks granted on this file */
 373         struct delayed_work     lock_work;      /* work to be done in locking */
 374         struct key              *unlock_key;    /* key to be used in unlocking */
 375
 376         /* outstanding callback notification on this file */
 377         struct rb_node          server_rb;      /* link in server->fs_vnodes */
 378         struct rb_node          cb_promise;     /* link in server->cb_promises */
 379         struct work_struct      cb_broken_work; /* work to be done on callback break */
 380         time64_t                cb_expires;     /* time at which callback expires */
 381         time64_t                cb_expires_at;  /* time used to order cb_promise */
 382         unsigned                cb_version;     /* callback version */
 383         unsigned                cb_expiry;      /* callback expiry time */
 384         afs_callback_type_t     cb_type;        /* type of callback */
 385         bool                    cb_promised;    /* true if promise still holds */
 386 };
 387
 388 /*
 389  * cached security record for one user's attempt to access a vnode
 390  */
 391 struct afs_permit {
 392         struct key              *key;           /* RxRPC ticket holding a security context */
 393         afs_access_t            access_mask;    /* access mask for this key */
 394 };
 395
 396 /*
 397  * cache of security records from attempts to access a vnode
 398  */
 399 struct afs_permits {
 400         struct rcu_head         rcu;            /* disposal procedure */
 401         int                     count;          /* number of records */
 402         struct afs_permit       permits[0];     /* the permits so far examined */
 403 };
 404
 405 /*
 406  * record of one of a system's set of network interfaces
 407  */
 408 struct afs_interface {
 409         struct in_addr  address;        /* IPv4 address bound to interface */
 410         struct in_addr  netmask;        /* netmask applied to address */
 411         unsigned        mtu;            /* MTU of interface */
 412 };
 413
 414 /*****************************************************************************/
 415 /*
 416  * cache.c
 417  */
 418 #ifdef CONFIG_AFS_FSCACHE
 419 extern struct fscache_netfs afs_cache_netfs;
 420 extern struct fscache_cookie_def afs_cell_cache_index_def;
 421 extern struct fscache_cookie_def afs_vlocation_cache_index_def;
 422 extern struct fscache_cookie_def afs_volume_cache_index_def;
 423 extern struct fscache_cookie_def afs_vnode_cache_index_def;
 424 #else
 425 #define afs_cell_cache_index_def        (*(struct fscache_cookie_def *) NULL)
 426 #define afs_vlocation_cache_index_def   (*(struct fscache_cookie_def *) NULL)
 427 #define afs_volume_cache_index_def      (*(struct fscache_cookie_def *) NULL)
 428 #define afs_vnode_cache_index_def       (*(struct fscache_cookie_def *) NULL)
 429 #endif
 430
 431 /*
 432  * callback.c
 433  */
 434 extern void afs_init_callback_state(struct afs_server *);
 435 extern void afs_broken_callback_work(struct work_struct *);
 436 extern void afs_break_callbacks(struct afs_server *, size_t,
 437                                 struct afs_callback[]);
 438 extern void afs_discard_callback_on_delete(struct afs_vnode *);
 439 extern void afs_give_up_callback(struct afs_vnode *);
 440 extern void afs_dispatch_give_up_callbacks(struct work_struct *);
 441 extern void afs_flush_callback_breaks(struct afs_server *);
 442 extern int __init afs_callback_update_init(void);
 443 extern void afs_callback_update_kill(void);
 444
 445 /*
 446  * cell.c
 447  */
 448 extern struct rw_semaphore afs_proc_cells_sem;
 449 extern struct list_head afs_proc_cells;
 450
 451 #define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
 452 extern int afs_cell_init(char *);
 453 extern struct afs_cell *afs_cell_create(const char *, unsigned, char *, bool);
 454 extern struct afs_cell *afs_cell_lookup(const char *, unsigned, bool);
 455 extern struct afs_cell *afs_grab_cell(struct afs_cell *);
 456 extern void afs_put_cell(struct afs_cell *);
 457 extern void afs_cell_purge(void);
 458
 459 /*
 460  * cmservice.c
 461  */
 462 extern bool afs_cm_incoming_call(struct afs_call *);
 463
 464 /*
 465  * dir.c
 466  */
 467 extern const struct inode_operations afs_dir_inode_operations;
 468 extern const struct dentry_operations afs_fs_dentry_operations;
 469 extern const struct file_operations afs_dir_file_operations;
 470
 471 /*
 472  * file.c
 473  */
 474 extern const struct address_space_operations afs_fs_aops;
 475 extern const struct inode_operations afs_file_inode_operations;
 476 extern const struct file_operations afs_file_operations;
 477
 478 extern int afs_open(struct inode *, struct file *);
 479 extern int afs_release(struct inode *, struct file *);
 480 extern int afs_page_filler(void *, struct page *);
 481 extern void afs_put_read(struct afs_read *);
 482
 483 /*
 484  * flock.c
 485  */
 486 extern void __exit afs_kill_lock_manager(void);
 487 extern void afs_lock_work(struct work_struct *);
 488 extern void afs_lock_may_be_available(struct afs_vnode *);
 489 extern int afs_lock(struct file *, int, struct file_lock *);
 490 extern int afs_flock(struct file *, int, struct file_lock *);
 491
 492 /*
 493  * fsclient.c
 494  */
 495 extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
 496                                     struct afs_vnode *, struct afs_volsync *,
 497                                     bool);
 498 extern int afs_fs_give_up_callbacks(struct afs_server *, bool);
 499 extern int afs_fs_fetch_data(struct afs_server *, struct key *,
 500                              struct afs_vnode *, struct afs_read *, bool);
 501 extern int afs_fs_create(struct afs_server *, struct key *,
 502                          struct afs_vnode *, const char *, umode_t,
 503                          struct afs_fid *, struct afs_file_status *,
 504                          struct afs_callback *, bool);
 505 extern int afs_fs_remove(struct afs_server *, struct key *,
 506                          struct afs_vnode *, const char *, bool, bool);
 507 extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
 508                        struct afs_vnode *, const char *, bool);
 509 extern int afs_fs_symlink(struct afs_server *, struct key *,
 510                           struct afs_vnode *, const char *, const char *,
 511                           struct afs_fid *, struct afs_file_status *, bool);
 512 extern int afs_fs_rename(struct afs_server *, struct key *,
 513                          struct afs_vnode *, const char *,
 514                          struct afs_vnode *, const char *, bool);
 515 extern int afs_fs_store_data(struct afs_server *, struct afs_writeback *,
 516                              pgoff_t, pgoff_t, unsigned, unsigned, bool);
 517 extern int afs_fs_setattr(struct afs_server *, struct key *,
 518                           struct afs_vnode *, struct iattr *, bool);
 519 extern int afs_fs_get_volume_status(struct afs_server *, struct key *,
 520                                     struct afs_vnode *,
 521                                     struct afs_volume_status *, bool);
 522 extern int afs_fs_set_lock(struct afs_server *, struct key *,
 523                            struct afs_vnode *, afs_lock_type_t, bool);
 524 extern int afs_fs_extend_lock(struct afs_server *, struct key *,
 525                               struct afs_vnode *, bool);
 526 extern int afs_fs_release_lock(struct afs_server *, struct key *,
 527                                struct afs_vnode *, bool);
 528
 529 /*
 530  * inode.c
 531  */
 532 extern struct inode *afs_iget_autocell(struct inode *, const char *, int,
 533                                        struct key *);
 534 extern struct inode *afs_iget(struct super_block *, struct key *,
 535                               struct afs_fid *, struct afs_file_status *,
 536                               struct afs_callback *);
 537 extern void afs_zap_data(struct afs_vnode *);
 538 extern int afs_validate(struct afs_vnode *, struct key *);
 539 extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
 540 extern int afs_setattr(struct dentry *, struct iattr *);
 541 extern void afs_evict_inode(struct inode *);
 542 extern int afs_drop_inode(struct inode *);
 543
 544 /*
 545  * main.c
 546  */
 547 extern struct workqueue_struct *afs_wq;
 548 extern struct uuid_v1 afs_uuid;
 549
 550 /*
 551  * misc.c
 552  */
 553 extern int afs_abort_to_error(u32);
 554
 555 /*
 556  * mntpt.c
 557  */
 558 extern const struct inode_operations afs_mntpt_inode_operations;
 559 extern const struct inode_operations afs_autocell_inode_operations;
 560 extern const struct file_operations afs_mntpt_file_operations;
 561
 562 extern struct vfsmount *afs_d_automount(struct path *);
 563 extern void afs_mntpt_kill_timer(void);
 564
 565 /*
 566  * netdevices.c
 567  */
 568 extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
 569
 570 /*
 571  * proc.c
 572  */
 573 extern int afs_proc_init(void);
 574 extern void afs_proc_cleanup(void);
 575 extern int afs_proc_cell_setup(struct afs_cell *);
 576 extern void afs_proc_cell_remove(struct afs_cell *);
 577
 578 /*
 579  * rxrpc.c
 580  */
 581 extern struct socket *afs_socket;
 582 extern atomic_t afs_outstanding_calls;
 583
 584 extern int afs_open_socket(void);
 585 extern void afs_close_socket(void);
 586 extern void afs_put_call(struct afs_call *);
 587 extern int afs_queue_call_work(struct afs_call *);
 588 extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t, bool);
 589 extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
 590                                             size_t, size_t);
 591 extern void afs_flat_call_destructor(struct afs_call *);
 592 extern void afs_send_empty_reply(struct afs_call *);
 593 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
 594 extern int afs_extract_data(struct afs_call *, void *, size_t, bool);
 595
 596 static inline int afs_transfer_reply(struct afs_call *call)
 597 {
 598         return afs_extract_data(call, call->buffer, call->reply_max, false);
 599 }
 600
 601 /*
 602  * security.c
 603  */
 604 extern void afs_clear_permits(struct afs_vnode *);
 605 extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
 606 extern void afs_zap_permits(struct rcu_head *);
 607 extern struct key *afs_request_key(struct afs_cell *);
 608 extern int afs_permission(struct inode *, int);
 609
 610 /*
 611  * server.c
 612  */
 613 extern spinlock_t afs_server_peer_lock;
 614
 615 #define afs_get_server(S)                                       \
 616 do {                                                            \
 617         _debug("GET SERVER %d", atomic_read(&(S)->usage));      \
 618         atomic_inc(&(S)->usage);                                \
 619 } while(0)
 620
 621 extern struct afs_server *afs_lookup_server(struct afs_cell *,
 622                                             const struct in_addr *);
 623 extern struct afs_server *afs_find_server(const struct sockaddr_rxrpc *);
 624 extern void afs_put_server(struct afs_server *);
 625 extern void __exit afs_purge_servers(void);
 626
 627 /*
 628  * super.c
 629  */
 630 extern int afs_fs_init(void);
 631 extern void afs_fs_exit(void);
 632
 633 /*
 634  * vlclient.c
 635  */
 636 extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
 637                                     const char *, struct afs_cache_vlocation *,
 638                                     bool);
 639 extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
 640                                   afs_volid_t, afs_voltype_t,
 641                                   struct afs_cache_vlocation *, bool);
 642
 643 /*
 644  * vlocation.c
 645  */
 646 #define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
 647
 648 extern int __init afs_vlocation_update_init(void);
 649 extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
 650                                                   struct key *,
 651                                                   const char *, size_t);
 652 extern void afs_put_vlocation(struct afs_vlocation *);
 653 extern void afs_vlocation_purge(void);
 654
 655 /*
 656  * vnode.c
 657  */
 658 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
 659 {
 660         return container_of(inode, struct afs_vnode, vfs_inode);
 661 }
 662
 663 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
 664 {
 665         return &vnode->vfs_inode;
 666 }
 667
 668 extern void afs_vnode_finalise_status_update(struct afs_vnode *,
 669                                              struct afs_server *);
 670 extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
 671                                   struct key *);
 672 extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
 673                                 struct afs_read *);
 674 extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
 675                             umode_t, struct afs_fid *, struct afs_file_status *,
 676                             struct afs_callback *, struct afs_server **);
 677 extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
 678                             bool);
 679 extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
 680                           const char *);
 681 extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
 682                              const char *, struct afs_fid *,
 683                              struct afs_file_status *, struct afs_server **);
 684 extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
 685                             struct key *, const char *, const char *);
 686 extern int afs_vnode_store_data(struct afs_writeback *, pgoff_t, pgoff_t,
 687                                 unsigned, unsigned);
 688 extern int afs_vnode_setattr(struct afs_vnode *, struct key *, struct iattr *);
 689 extern int afs_vnode_get_volume_status(struct afs_vnode *, struct key *,
 690                                        struct afs_volume_status *);
 691 extern int afs_vnode_set_lock(struct afs_vnode *, struct key *,
 692                               afs_lock_type_t);
 693 extern int afs_vnode_extend_lock(struct afs_vnode *, struct key *);
 694 extern int afs_vnode_release_lock(struct afs_vnode *, struct key *);
 695
 696 /*
 697  * volume.c
 698  */
 699 #define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
 700
 701 extern void afs_put_volume(struct afs_volume *);
 702 extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
 703 extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
 704 extern int afs_volume_release_fileserver(struct afs_vnode *,
 705                                          struct afs_server *, int);
 706
 707 /*
 708  * write.c
 709  */
 710 extern int afs_set_page_dirty(struct page *);
 711 extern void afs_put_writeback(struct afs_writeback *);
 712 extern int afs_write_begin(struct file *file, struct address_space *mapping,
 713                         loff_t pos, unsigned len, unsigned flags,
 714                         struct page **pagep, void **fsdata);
 715 extern int afs_write_end(struct file *file, struct address_space *mapping,
 716                         loff_t pos, unsigned len, unsigned copied,
 717                         struct page *page, void *fsdata);
 718 extern int afs_writepage(struct page *, struct writeback_control *);
 719 extern int afs_writepages(struct address_space *, struct writeback_control *);
 720 extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
 721 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
 722 extern int afs_writeback_all(struct afs_vnode *);
 723 extern int afs_flush(struct file *, fl_owner_t);
 724 extern int afs_fsync(struct file *, loff_t, loff_t, int);
 725
 726
 727 /*****************************************************************************/
 728 /*
 729  * debug tracing
 730  */
 731 #include <trace/events/afs.h>
 732
 733 extern unsigned afs_debug;
 734
 735 #define dbgprintk(FMT,...) \
 736         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
 737
 738 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
 739 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
 740 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
 741
 742
 743 #if defined(__KDEBUG)
 744 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
 745 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
 746 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
 747
 748 #elif defined(CONFIG_AFS_DEBUG)
 749 #define AFS_DEBUG_KENTER        0x01
 750 #define AFS_DEBUG_KLEAVE        0x02
 751 #define AFS_DEBUG_KDEBUG        0x04
 752
 753 #define _enter(FMT,...)                                 \
 754 do {                                                    \
 755         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
 756                 kenter(FMT,##__VA_ARGS__);              \
 757 } while (0)
 758
 759 #define _leave(FMT,...)                                 \
 760 do {                                                    \
 761         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
 762                 kleave(FMT,##__VA_ARGS__);              \
 763 } while (0)
 764
 765 #define _debug(FMT,...)                                 \
 766 do {                                                    \
 767         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
 768                 kdebug(FMT,##__VA_ARGS__);              \
 769 } while (0)
 770
 771 #else
 772 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
 773 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
 774 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
 775 #endif
 776
 777 /*
 778  * debug assertion checking
 779  */
 780 #if 1 // defined(__KDEBUGALL)
 781
 782 #define ASSERT(X)                                               \
 783 do {                                                            \
 784         if (unlikely(!(X))) {                                   \
 785                 printk(KERN_ERR "\n");                          \
 786                 printk(KERN_ERR "AFS: Assertion failed\n");     \
 787                 BUG();                                          \
 788         }                                                       \
 789 } while(0)
 790
 791 #define ASSERTCMP(X, OP, Y)                                             \
 792 do {                                                                    \
 793         if (unlikely(!((X) OP (Y)))) {                                  \
 794                 printk(KERN_ERR "\n");                                  \
 795                 printk(KERN_ERR "AFS: Assertion failed\n");             \
 796                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
 797                        (unsigned long)(X), (unsigned long)(Y));         \
 798                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
 799                        (unsigned long)(X), (unsigned long)(Y));         \
 800                 BUG();                                                  \
 801         }                                                               \
 802 } while(0)
 803
 804 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
 805 do {                                                                    \
 806         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
 807                 printk(KERN_ERR "\n");                                  \
 808                 printk(KERN_ERR "AFS: Assertion failed\n");             \
 809                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
 810                        (unsigned long)(L), (unsigned long)(N),          \
 811                        (unsigned long)(H));                             \
 812                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
 813                        (unsigned long)(L), (unsigned long)(N),          \
 814                        (unsigned long)(H));                             \
 815                 BUG();                                                  \
 816         }                                                               \
 817 } while(0)
 818
 819 #define ASSERTIF(C, X)                                          \
 820 do {                                                            \
 821         if (unlikely((C) && !(X))) {                            \
 822                 printk(KERN_ERR "\n");                          \
 823                 printk(KERN_ERR "AFS: Assertion failed\n");     \
 824                 BUG();                                          \
 825         }                                                       \
 826 } while(0)
 827
 828 #define ASSERTIFCMP(C, X, OP, Y)                                        \
 829 do {                                                                    \
 830         if (unlikely((C) && !((X) OP (Y)))) {                           \
 831                 printk(KERN_ERR "\n");                                  \
 832                 printk(KERN_ERR "AFS: Assertion failed\n");             \
 833                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
 834                        (unsigned long)(X), (unsigned long)(Y));         \
 835                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
 836                        (unsigned long)(X), (unsigned long)(Y));         \
 837                 BUG();                                                  \
 838         }                                                               \
 839 } while(0)
 840
 841 #else
 842
 843 #define ASSERT(X)                               \
 844 do {                                            \
 845 } while(0)
 846
 847 #define ASSERTCMP(X, OP, Y)                     \
 848 do {                                            \
 849 } while(0)
 850
 851 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
 852 do {                                            \
 853 } while(0)
 854
 855 #define ASSERTIF(C, X)                          \
 856 do {                                            \
 857 } while(0)
 858
 859 #define ASSERTIFCMP(C, X, OP, Y)                \
 860 do {                                            \
 861 } while(0)
 862
 863 #endif /* __KDEBUGALL */