fs/afs/internal.h

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