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