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