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