afs: Pass pre-fetch server and volume break counts into afs_iget5_set()
[sfrench/cifs-2.6.git] / fs / afs / internal.h
1 /* internal AFS stuff
2  *
3  * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
4  * Written by David Howells (dhowells@redhat.com)
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  */
11
12 #include <linux/compiler.h>
13 #include <linux/kernel.h>
14 #include <linux/ktime.h>
15 #include <linux/fs.h>
16 #include <linux/pagemap.h>
17 #include <linux/rxrpc.h>
18 #include <linux/key.h>
19 #include <linux/workqueue.h>
20 #include <linux/sched.h>
21 #include <linux/fscache.h>
22 #include <linux/backing-dev.h>
23 #include <linux/uuid.h>
24 #include <linux/mm_types.h>
25 #include <linux/dns_resolver.h>
26 #include <net/net_namespace.h>
27 #include <net/netns/generic.h>
28 #include <net/sock.h>
29 #include <net/af_rxrpc.h>
30
31 #include "afs.h"
32 #include "afs_vl.h"
33
34 #define AFS_CELL_MAX_ADDRS 15
35
36 struct pagevec;
37 struct afs_call;
38
39 /*
40  * Partial file-locking emulation mode.  (The problem being that AFS3 only
41  * allows whole-file locks and no upgrading/downgrading).
42  */
43 enum afs_flock_mode {
44         afs_flock_mode_unset,
45         afs_flock_mode_local,   /* Local locking only */
46         afs_flock_mode_openafs, /* Don't get server lock for a partial lock */
47         afs_flock_mode_strict,  /* Always get a server lock for a partial lock */
48         afs_flock_mode_write,   /* Get an exclusive server lock for a partial lock */
49 };
50
51 struct afs_fs_context {
52         bool                    force;          /* T to force cell type */
53         bool                    autocell;       /* T if set auto mount operation */
54         bool                    dyn_root;       /* T if dynamic root */
55         bool                    no_cell;        /* T if the source is "none" (for dynroot) */
56         enum afs_flock_mode     flock_mode;     /* Partial file-locking emulation mode */
57         afs_voltype_t           type;           /* type of volume requested */
58         unsigned int            volnamesz;      /* size of volume name */
59         const char              *volname;       /* name of volume to mount */
60         struct afs_net          *net;           /* the AFS net namespace stuff */
61         struct afs_cell         *cell;          /* cell in which to find volume */
62         struct afs_volume       *volume;        /* volume record */
63         struct key              *key;           /* key to use for secure mounting */
64 };
65
66 struct afs_iget_data {
67         struct afs_fid          fid;
68         struct afs_volume       *volume;        /* volume on which resides */
69         unsigned int            cb_v_break;     /* Pre-fetch volume break count */
70         unsigned int            cb_s_break;     /* Pre-fetch server break count */
71 };
72
73 enum afs_call_state {
74         AFS_CALL_CL_REQUESTING,         /* Client: Request is being sent */
75         AFS_CALL_CL_AWAIT_REPLY,        /* Client: Awaiting reply */
76         AFS_CALL_CL_PROC_REPLY,         /* Client: rxrpc call complete; processing reply */
77         AFS_CALL_SV_AWAIT_OP_ID,        /* Server: Awaiting op ID */
78         AFS_CALL_SV_AWAIT_REQUEST,      /* Server: Awaiting request data */
79         AFS_CALL_SV_REPLYING,           /* Server: Replying */
80         AFS_CALL_SV_AWAIT_ACK,          /* Server: Awaiting final ACK */
81         AFS_CALL_COMPLETE,              /* Completed or failed */
82 };
83
84 /*
85  * List of server addresses.
86  */
87 struct afs_addr_list {
88         struct rcu_head         rcu;            /* Must be first */
89         refcount_t              usage;
90         u32                     version;        /* Version */
91         unsigned char           max_addrs;
92         unsigned char           nr_addrs;
93         unsigned char           preferred;      /* Preferred address */
94         unsigned char           nr_ipv4;        /* Number of IPv4 addresses */
95         enum dns_record_source  source:8;
96         enum dns_lookup_status  status:8;
97         unsigned long           probed;         /* Mask of servers that have been probed */
98         unsigned long           failed;         /* Mask of addrs that failed locally/ICMP */
99         unsigned long           responded;      /* Mask of addrs that responded */
100         struct sockaddr_rxrpc   addrs[];
101 #define AFS_MAX_ADDRESSES ((unsigned int)(sizeof(unsigned long) * 8))
102 };
103
104 /*
105  * a record of an in-progress RxRPC call
106  */
107 struct afs_call {
108         const struct afs_call_type *type;       /* type of call */
109         struct afs_addr_list    *alist;         /* Address is alist[addr_ix] */
110         wait_queue_head_t       waitq;          /* processes awaiting completion */
111         struct work_struct      async_work;     /* async I/O processor */
112         struct work_struct      work;           /* actual work processor */
113         struct rxrpc_call       *rxcall;        /* RxRPC call handle */
114         struct key              *key;           /* security for this call */
115         struct afs_net          *net;           /* The network namespace */
116         union {
117                 struct afs_server       *server;
118                 struct afs_vlserver     *vlserver;
119         };
120         struct afs_cb_interest  *cbi;           /* Callback interest for server used */
121         struct afs_vnode        *lvnode;        /* vnode being locked */
122         void                    *request;       /* request data (first part) */
123         struct address_space    *mapping;       /* Pages being written from */
124         struct iov_iter         iter;           /* Buffer iterator */
125         struct iov_iter         *_iter;         /* Iterator currently in use */
126         union { /* Convenience for ->iter */
127                 struct kvec     kvec[1];
128                 struct bio_vec  bvec[1];
129         };
130         void                    *buffer;        /* reply receive buffer */
131         union {
132                 long                    ret0;   /* Value to reply with instead of 0 */
133                 struct afs_addr_list    *ret_alist;
134                 struct afs_vldb_entry   *ret_vldb;
135                 struct afs_acl          *ret_acl;
136         };
137         struct afs_fid          *out_fid;
138         struct afs_status_cb    *out_dir_scb;
139         struct afs_status_cb    *out_scb;
140         struct yfs_acl          *out_yacl;
141         struct afs_volsync      *out_volsync;
142         struct afs_volume_status *out_volstatus;
143         struct afs_read         *read_request;
144         unsigned int            server_index;
145         pgoff_t                 first;          /* first page in mapping to deal with */
146         pgoff_t                 last;           /* last page in mapping to deal with */
147         atomic_t                usage;
148         enum afs_call_state     state;
149         spinlock_t              state_lock;
150         int                     error;          /* error code */
151         u32                     abort_code;     /* Remote abort ID or 0 */
152         u32                     epoch;
153         unsigned int            max_lifespan;   /* Maximum lifespan to set if not 0 */
154         unsigned                request_size;   /* size of request data */
155         unsigned                reply_max;      /* maximum size of reply */
156         unsigned                first_offset;   /* offset into mapping[first] */
157         union {
158                 unsigned        last_to;        /* amount of mapping[last] */
159                 unsigned        count2;         /* count used in unmarshalling */
160         };
161         unsigned char           unmarshall;     /* unmarshalling phase */
162         unsigned char           addr_ix;        /* Address in ->alist */
163         bool                    incoming;       /* T if incoming call */
164         bool                    send_pages;     /* T if data from mapping should be sent */
165         bool                    need_attention; /* T if RxRPC poked us */
166         bool                    async;          /* T if asynchronous */
167         bool                    upgrade;        /* T to request service upgrade */
168         bool                    have_reply_time; /* T if have got reply_time */
169         bool                    intr;           /* T if interruptible */
170         u16                     service_id;     /* Actual service ID (after upgrade) */
171         unsigned int            debug_id;       /* Trace ID */
172         u32                     operation_ID;   /* operation ID for an incoming call */
173         u32                     count;          /* count for use in unmarshalling */
174         union {                                 /* place to extract temporary data */
175                 struct {
176                         __be32  tmp_u;
177                         __be32  tmp;
178                 } __attribute__((packed));
179                 __be64          tmp64;
180         };
181         ktime_t                 reply_time;     /* Time of first reply packet */
182 };
183
184 struct afs_call_type {
185         const char *name;
186         unsigned int op; /* Really enum afs_fs_operation */
187
188         /* deliver request or reply data to an call
189          * - returning an error will cause the call to be aborted
190          */
191         int (*deliver)(struct afs_call *call);
192
193         /* clean up a call */
194         void (*destructor)(struct afs_call *call);
195
196         /* Work function */
197         void (*work)(struct work_struct *work);
198
199         /* Call done function (gets called immediately on success or failure) */
200         void (*done)(struct afs_call *call);
201 };
202
203 /*
204  * Key available for writeback on a file.
205  */
206 struct afs_wb_key {
207         refcount_t              usage;
208         struct key              *key;
209         struct list_head        vnode_link;     /* Link in vnode->wb_keys */
210 };
211
212 /*
213  * AFS open file information record.  Pointed to by file->private_data.
214  */
215 struct afs_file {
216         struct key              *key;           /* The key this file was opened with */
217         struct afs_wb_key       *wb;            /* Writeback key record for this file */
218 };
219
220 static inline struct key *afs_file_key(struct file *file)
221 {
222         struct afs_file *af = file->private_data;
223
224         return af->key;
225 }
226
227 /*
228  * Record of an outstanding read operation on a vnode.
229  */
230 struct afs_read {
231         loff_t                  pos;            /* Where to start reading */
232         loff_t                  len;            /* How much we're asking for */
233         loff_t                  actual_len;     /* How much we're actually getting */
234         loff_t                  remain;         /* Amount remaining */
235         loff_t                  file_size;      /* File size returned by server */
236         afs_dataversion_t       data_version;   /* Version number returned by server */
237         refcount_t              usage;
238         unsigned int            index;          /* Which page we're reading into */
239         unsigned int            nr_pages;
240         unsigned int            offset;         /* offset into current page */
241         struct afs_vnode        *vnode;
242         void (*page_done)(struct afs_read *);
243         struct page             **pages;
244         struct page             *array[];
245 };
246
247 /*
248  * AFS superblock private data
249  * - there's one superblock per volume
250  */
251 struct afs_super_info {
252         struct net              *net_ns;        /* Network namespace */
253         struct afs_cell         *cell;          /* The cell in which the volume resides */
254         struct afs_volume       *volume;        /* volume record */
255         enum afs_flock_mode     flock_mode:8;   /* File locking emulation mode */
256         bool                    dyn_root;       /* True if dynamic root */
257 };
258
259 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
260 {
261         return sb->s_fs_info;
262 }
263
264 extern struct file_system_type afs_fs_type;
265
266 /*
267  * Set of substitutes for @sys.
268  */
269 struct afs_sysnames {
270 #define AFS_NR_SYSNAME 16
271         char                    *subs[AFS_NR_SYSNAME];
272         refcount_t              usage;
273         unsigned short          nr;
274         char                    blank[1];
275 };
276
277 /*
278  * AFS network namespace record.
279  */
280 struct afs_net {
281         struct net              *net;           /* Backpointer to the owning net namespace */
282         struct afs_uuid         uuid;
283         bool                    live;           /* F if this namespace is being removed */
284
285         /* AF_RXRPC I/O stuff */
286         struct socket           *socket;
287         struct afs_call         *spare_incoming_call;
288         struct work_struct      charge_preallocation_work;
289         struct mutex            socket_mutex;
290         atomic_t                nr_outstanding_calls;
291         atomic_t                nr_superblocks;
292
293         /* Cell database */
294         struct rb_root          cells;
295         struct afs_cell __rcu   *ws_cell;
296         struct work_struct      cells_manager;
297         struct timer_list       cells_timer;
298         atomic_t                cells_outstanding;
299         seqlock_t               cells_lock;
300
301         struct mutex            proc_cells_lock;
302         struct hlist_head       proc_cells;
303
304         /* Known servers.  Theoretically each fileserver can only be in one
305          * cell, but in practice, people create aliases and subsets and there's
306          * no easy way to distinguish them.
307          */
308         seqlock_t               fs_lock;        /* For fs_servers */
309         struct rb_root          fs_servers;     /* afs_server (by server UUID or address) */
310         struct list_head        fs_updates;     /* afs_server (by update_at) */
311         struct hlist_head       fs_proc;        /* procfs servers list */
312
313         struct hlist_head       fs_addresses4;  /* afs_server (by lowest IPv4 addr) */
314         struct hlist_head       fs_addresses6;  /* afs_server (by lowest IPv6 addr) */
315         seqlock_t               fs_addr_lock;   /* For fs_addresses[46] */
316
317         struct work_struct      fs_manager;
318         struct timer_list       fs_timer;
319         atomic_t                servers_outstanding;
320
321         /* File locking renewal management */
322         struct mutex            lock_manager_mutex;
323
324         /* Misc */
325         struct super_block      *dynroot_sb;    /* Dynamic root mount superblock */
326         struct proc_dir_entry   *proc_afs;      /* /proc/net/afs directory */
327         struct afs_sysnames     *sysnames;
328         rwlock_t                sysnames_lock;
329
330         /* Statistics counters */
331         atomic_t                n_lookup;       /* Number of lookups done */
332         atomic_t                n_reval;        /* Number of dentries needing revalidation */
333         atomic_t                n_inval;        /* Number of invalidations by the server */
334         atomic_t                n_relpg;        /* Number of invalidations by releasepage */
335         atomic_t                n_read_dir;     /* Number of directory pages read */
336         atomic_t                n_dir_cr;       /* Number of directory entry creation edits */
337         atomic_t                n_dir_rm;       /* Number of directory entry removal edits */
338         atomic_t                n_stores;       /* Number of store ops */
339         atomic_long_t           n_store_bytes;  /* Number of bytes stored */
340         atomic_long_t           n_fetch_bytes;  /* Number of bytes fetched */
341         atomic_t                n_fetches;      /* Number of data fetch ops */
342 };
343
344 extern const char afs_init_sysname[];
345
346 enum afs_cell_state {
347         AFS_CELL_UNSET,
348         AFS_CELL_ACTIVATING,
349         AFS_CELL_ACTIVE,
350         AFS_CELL_DEACTIVATING,
351         AFS_CELL_INACTIVE,
352         AFS_CELL_FAILED,
353 };
354
355 /*
356  * AFS cell record.
357  *
358  * This is a tricky concept to get right as it is possible to create aliases
359  * simply by pointing AFSDB/SRV records for two names at the same set of VL
360  * servers; it is also possible to do things like setting up two sets of VL
361  * servers, one of which provides a superset of the volumes provided by the
362  * other (for internal/external division, for example).
363  *
364  * Cells only exist in the sense that (a) a cell's name maps to a set of VL
365  * servers and (b) a cell's name is used by the client to select the key to use
366  * for authentication and encryption.  The cell name is not typically used in
367  * the protocol.
368  *
369  * There is no easy way to determine if two cells are aliases or one is a
370  * subset of another.
371  */
372 struct afs_cell {
373         union {
374                 struct rcu_head rcu;
375                 struct rb_node  net_node;       /* Node in net->cells */
376         };
377         struct afs_net          *net;
378         struct key              *anonymous_key; /* anonymous user key for this cell */
379         struct work_struct      manager;        /* Manager for init/deinit/dns */
380         struct hlist_node       proc_link;      /* /proc cell list link */
381 #ifdef CONFIG_AFS_FSCACHE
382         struct fscache_cookie   *cache;         /* caching cookie */
383 #endif
384         time64_t                dns_expiry;     /* Time AFSDB/SRV record expires */
385         time64_t                last_inactive;  /* Time of last drop of usage count */
386         atomic_t                usage;
387         unsigned long           flags;
388 #define AFS_CELL_FL_NO_GC       0               /* The cell was added manually, don't auto-gc */
389 #define AFS_CELL_FL_DO_LOOKUP   1               /* DNS lookup requested */
390         enum afs_cell_state     state;
391         short                   error;
392         enum dns_record_source  dns_source:8;   /* Latest source of data from lookup */
393         enum dns_lookup_status  dns_status:8;   /* Latest status of data from lookup */
394         unsigned int            dns_lookup_count; /* Counter of DNS lookups */
395
396         /* Active fileserver interaction state. */
397         struct list_head        proc_volumes;   /* procfs volume list */
398         rwlock_t                proc_lock;
399
400         /* VL server list. */
401         rwlock_t                vl_servers_lock; /* Lock on vl_servers */
402         struct afs_vlserver_list __rcu *vl_servers;
403
404         u8                      name_len;       /* Length of name */
405         char                    name[64 + 1];   /* Cell name, case-flattened and NUL-padded */
406 };
407
408 /*
409  * Volume Location server record.
410  */
411 struct afs_vlserver {
412         struct rcu_head         rcu;
413         struct afs_addr_list    __rcu *addresses; /* List of addresses for this VL server */
414         unsigned long           flags;
415 #define AFS_VLSERVER_FL_PROBED  0               /* The VL server has been probed */
416 #define AFS_VLSERVER_FL_PROBING 1               /* VL server is being probed */
417 #define AFS_VLSERVER_FL_IS_YFS  2               /* Server is YFS not AFS */
418         rwlock_t                lock;           /* Lock on addresses */
419         atomic_t                usage;
420
421         /* Probe state */
422         wait_queue_head_t       probe_wq;
423         atomic_t                probe_outstanding;
424         spinlock_t              probe_lock;
425         struct {
426                 unsigned int    rtt;            /* RTT as ktime/64 */
427                 u32             abort_code;
428                 short           error;
429                 bool            have_result;
430                 bool            responded:1;
431                 bool            is_yfs:1;
432                 bool            not_yfs:1;
433                 bool            local_failure:1;
434         } probe;
435
436         u16                     port;
437         u16                     name_len;       /* Length of name */
438         char                    name[];         /* Server name, case-flattened */
439 };
440
441 /*
442  * Weighted list of Volume Location servers.
443  */
444 struct afs_vlserver_entry {
445         u16                     priority;       /* Preference (as SRV) */
446         u16                     weight;         /* Weight (as SRV) */
447         enum dns_record_source  source:8;
448         enum dns_lookup_status  status:8;
449         struct afs_vlserver     *server;
450 };
451
452 struct afs_vlserver_list {
453         struct rcu_head         rcu;
454         atomic_t                usage;
455         u8                      nr_servers;
456         u8                      index;          /* Server currently in use */
457         u8                      preferred;      /* Preferred server */
458         enum dns_record_source  source:8;
459         enum dns_lookup_status  status:8;
460         rwlock_t                lock;
461         struct afs_vlserver_entry servers[];
462 };
463
464 /*
465  * Cached VLDB entry.
466  *
467  * This is pointed to by cell->vldb_entries, indexed by name.
468  */
469 struct afs_vldb_entry {
470         afs_volid_t             vid[3];         /* Volume IDs for R/W, R/O and Bak volumes */
471
472         unsigned long           flags;
473 #define AFS_VLDB_HAS_RW         0               /* - R/W volume exists */
474 #define AFS_VLDB_HAS_RO         1               /* - R/O volume exists */
475 #define AFS_VLDB_HAS_BAK        2               /* - Backup volume exists */
476 #define AFS_VLDB_QUERY_VALID    3               /* - Record is valid */
477 #define AFS_VLDB_QUERY_ERROR    4               /* - VL server returned error */
478
479         uuid_t                  fs_server[AFS_NMAXNSERVERS];
480         u8                      fs_mask[AFS_NMAXNSERVERS];
481 #define AFS_VOL_VTM_RW  0x01 /* R/W version of the volume is available (on this server) */
482 #define AFS_VOL_VTM_RO  0x02 /* R/O version of the volume is available (on this server) */
483 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
484         short                   error;
485         u8                      nr_servers;     /* Number of server records */
486         u8                      name_len;
487         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
488 };
489
490 /*
491  * Record of fileserver with which we're actively communicating.
492  */
493 struct afs_server {
494         struct rcu_head         rcu;
495         union {
496                 uuid_t          uuid;           /* Server ID */
497                 struct afs_uuid _uuid;
498         };
499
500         struct afs_addr_list    __rcu *addresses;
501         struct rb_node          uuid_rb;        /* Link in net->servers */
502         struct hlist_node       addr4_link;     /* Link in net->fs_addresses4 */
503         struct hlist_node       addr6_link;     /* Link in net->fs_addresses6 */
504         struct hlist_node       proc_link;      /* Link in net->fs_proc */
505         struct afs_server       *gc_next;       /* Next server in manager's list */
506         time64_t                put_time;       /* Time at which last put */
507         time64_t                update_at;      /* Time at which to next update the record */
508         unsigned long           flags;
509 #define AFS_SERVER_FL_NOT_READY 1               /* The record is not ready for use */
510 #define AFS_SERVER_FL_NOT_FOUND 2               /* VL server says no such server */
511 #define AFS_SERVER_FL_VL_FAIL   3               /* Failed to access VL server */
512 #define AFS_SERVER_FL_UPDATING  4
513 #define AFS_SERVER_FL_PROBED    5               /* The fileserver has been probed */
514 #define AFS_SERVER_FL_PROBING   6               /* Fileserver is being probed */
515 #define AFS_SERVER_FL_NO_IBULK  7               /* Fileserver doesn't support FS.InlineBulkStatus */
516 #define AFS_SERVER_FL_MAY_HAVE_CB 8             /* May have callbacks on this fileserver */
517 #define AFS_SERVER_FL_IS_YFS    9               /* Server is YFS not AFS */
518 #define AFS_SERVER_FL_NO_RM2    10              /* Fileserver doesn't support YFS.RemoveFile2 */
519 #define AFS_SERVER_FL_HAVE_EPOCH 11             /* ->epoch is valid */
520         atomic_t                usage;
521         u32                     addr_version;   /* Address list version */
522         u32                     cm_epoch;       /* Server RxRPC epoch */
523
524         /* file service access */
525         rwlock_t                fs_lock;        /* access lock */
526
527         /* callback promise management */
528         struct hlist_head       cb_volumes;     /* List of volume interests on this server */
529         unsigned                cb_s_break;     /* Break-everything counter. */
530         rwlock_t                cb_break_lock;  /* Volume finding lock */
531
532         /* Probe state */
533         wait_queue_head_t       probe_wq;
534         atomic_t                probe_outstanding;
535         spinlock_t              probe_lock;
536         struct {
537                 unsigned int    rtt;            /* RTT as ktime/64 */
538                 u32             abort_code;
539                 u32             cm_epoch;
540                 short           error;
541                 bool            have_result;
542                 bool            responded:1;
543                 bool            is_yfs:1;
544                 bool            not_yfs:1;
545                 bool            local_failure:1;
546                 bool            no_epoch:1;
547                 bool            cm_probed:1;
548                 bool            said_rebooted:1;
549                 bool            said_inconsistent:1;
550         } probe;
551 };
552
553 /*
554  * Volume collation in the server's callback interest list.
555  */
556 struct afs_vol_interest {
557         struct hlist_node       srv_link;       /* Link in server->cb_volumes */
558         struct hlist_head       cb_interests;   /* List of callback interests on the server */
559         union {
560                 struct rcu_head rcu;
561                 afs_volid_t     vid;            /* Volume ID to match */
562         };
563         unsigned int            usage;
564 };
565
566 /*
567  * Interest by a superblock on a server.
568  */
569 struct afs_cb_interest {
570         struct hlist_node       cb_vlink;       /* Link in vol_interest->cb_interests */
571         struct afs_vol_interest *vol_interest;
572         struct afs_server       *server;        /* Server on which this interest resides */
573         struct super_block      *sb;            /* Superblock on which inodes reside */
574         union {
575                 struct rcu_head rcu;
576                 afs_volid_t     vid;            /* Volume ID to match */
577         };
578         refcount_t              usage;
579 };
580
581 /*
582  * Replaceable server list.
583  */
584 struct afs_server_entry {
585         struct afs_server       *server;
586         struct afs_cb_interest  *cb_interest;
587 };
588
589 struct afs_server_list {
590         refcount_t              usage;
591         unsigned char           nr_servers;
592         unsigned char           preferred;      /* Preferred server */
593         unsigned short          vnovol_mask;    /* Servers to be skipped due to VNOVOL */
594         unsigned int            seq;            /* Set to ->servers_seq when installed */
595         rwlock_t                lock;
596         struct afs_server_entry servers[];
597 };
598
599 /*
600  * Live AFS volume management.
601  */
602 struct afs_volume {
603         afs_volid_t             vid;            /* volume ID */
604         atomic_t                usage;
605         time64_t                update_at;      /* Time at which to next update */
606         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
607         struct list_head        proc_link;      /* Link in cell->vl_proc */
608         unsigned long           flags;
609 #define AFS_VOLUME_NEEDS_UPDATE 0       /* - T if an update needs performing */
610 #define AFS_VOLUME_UPDATING     1       /* - T if an update is in progress */
611 #define AFS_VOLUME_WAIT         2       /* - T if users must wait for update */
612 #define AFS_VOLUME_DELETED      3       /* - T if volume appears deleted */
613 #define AFS_VOLUME_OFFLINE      4       /* - T if volume offline notice given */
614 #define AFS_VOLUME_BUSY         5       /* - T if volume busy notice given */
615 #ifdef CONFIG_AFS_FSCACHE
616         struct fscache_cookie   *cache;         /* caching cookie */
617 #endif
618         struct afs_server_list  *servers;       /* List of servers on which volume resides */
619         rwlock_t                servers_lock;   /* Lock for ->servers */
620         unsigned int            servers_seq;    /* Incremented each time ->servers changes */
621
622         unsigned                cb_v_break;     /* Break-everything counter. */
623         rwlock_t                cb_break_lock;
624
625         afs_voltype_t           type;           /* type of volume */
626         short                   error;
627         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
628         u8                      name_len;
629         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
630 };
631
632 enum afs_lock_state {
633         AFS_VNODE_LOCK_NONE,            /* The vnode has no lock on the server */
634         AFS_VNODE_LOCK_WAITING_FOR_CB,  /* We're waiting for the server to break the callback */
635         AFS_VNODE_LOCK_SETTING,         /* We're asking the server for a lock */
636         AFS_VNODE_LOCK_GRANTED,         /* We have a lock on the server */
637         AFS_VNODE_LOCK_EXTENDING,       /* We're extending a lock on the server */
638         AFS_VNODE_LOCK_NEED_UNLOCK,     /* We need to unlock on the server */
639         AFS_VNODE_LOCK_UNLOCKING,       /* We're telling the server to unlock */
640         AFS_VNODE_LOCK_DELETED,         /* The vnode has been deleted whilst we have a lock */
641 };
642
643 /*
644  * AFS inode private data.
645  *
646  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
647  * leak from one inode to another.
648  */
649 struct afs_vnode {
650         struct inode            vfs_inode;      /* the VFS's inode record */
651
652         struct afs_volume       *volume;        /* volume on which vnode resides */
653         struct afs_fid          fid;            /* the file identifier for this inode */
654         struct afs_file_status  status;         /* AFS status info for this file */
655         afs_dataversion_t       invalid_before; /* Child dentries are invalid before this */
656 #ifdef CONFIG_AFS_FSCACHE
657         struct fscache_cookie   *cache;         /* caching cookie */
658 #endif
659         struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
660         struct mutex            io_lock;        /* Lock for serialising I/O on this mutex */
661         struct rw_semaphore     validate_lock;  /* lock for validating this vnode */
662         struct rw_semaphore     rmdir_lock;     /* Lock for rmdir vs sillyrename */
663         struct key              *silly_key;     /* Silly rename key */
664         spinlock_t              wb_lock;        /* lock for wb_keys */
665         spinlock_t              lock;           /* waitqueue/flags lock */
666         unsigned long           flags;
667 #define AFS_VNODE_CB_PROMISED   0               /* Set if vnode has a callback promise */
668 #define AFS_VNODE_UNSET         1               /* set if vnode attributes not yet set */
669 #define AFS_VNODE_DIR_VALID     2               /* Set if dir contents are valid */
670 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
671 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
672 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
673 #define AFS_VNODE_AUTOCELL      6               /* set if Vnode is an auto mount point */
674 #define AFS_VNODE_PSEUDODIR     7               /* set if Vnode is a pseudo directory */
675 #define AFS_VNODE_NEW_CONTENT   8               /* Set if file has new content (create/trunc-0) */
676
677         struct list_head        wb_keys;        /* List of keys available for writeback */
678         struct list_head        pending_locks;  /* locks waiting to be granted */
679         struct list_head        granted_locks;  /* locks granted on this file */
680         struct delayed_work     lock_work;      /* work to be done in locking */
681         struct key              *lock_key;      /* Key to be used in lock ops */
682         ktime_t                 locked_at;      /* Time at which lock obtained */
683         enum afs_lock_state     lock_state : 8;
684         afs_lock_type_t         lock_type : 8;
685
686         /* outstanding callback notification on this file */
687         struct afs_cb_interest __rcu *cb_interest; /* Server on which this resides */
688         unsigned int            cb_s_break;     /* Mass break counter on ->server */
689         unsigned int            cb_v_break;     /* Mass break counter on ->volume */
690         unsigned int            cb_break;       /* Break counter on vnode */
691         seqlock_t               cb_lock;        /* Lock for ->cb_interest, ->status, ->cb_*break */
692
693         time64_t                cb_expires_at;  /* time at which callback expires */
694 };
695
696 static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
697 {
698 #ifdef CONFIG_AFS_FSCACHE
699         return vnode->cache;
700 #else
701         return NULL;
702 #endif
703 }
704
705 /*
706  * cached security record for one user's attempt to access a vnode
707  */
708 struct afs_permit {
709         struct key              *key;           /* RxRPC ticket holding a security context */
710         afs_access_t            access;         /* CallerAccess value for this key */
711 };
712
713 /*
714  * Immutable cache of CallerAccess records from attempts to access vnodes.
715  * These may be shared between multiple vnodes.
716  */
717 struct afs_permits {
718         struct rcu_head         rcu;
719         struct hlist_node       hash_node;      /* Link in hash */
720         unsigned long           h;              /* Hash value for this permit list */
721         refcount_t              usage;
722         unsigned short          nr_permits;     /* Number of records */
723         bool                    invalidated;    /* Invalidated due to key change */
724         struct afs_permit       permits[];      /* List of permits sorted by key pointer */
725 };
726
727 /*
728  * record of one of a system's set of network interfaces
729  */
730 struct afs_interface {
731         struct in_addr  address;        /* IPv4 address bound to interface */
732         struct in_addr  netmask;        /* netmask applied to address */
733         unsigned        mtu;            /* MTU of interface */
734 };
735
736 /*
737  * Error prioritisation and accumulation.
738  */
739 struct afs_error {
740         short   error;                  /* Accumulated error */
741         bool    responded;              /* T if server responded */
742 };
743
744 /*
745  * Cursor for iterating over a server's address list.
746  */
747 struct afs_addr_cursor {
748         struct afs_addr_list    *alist;         /* Current address list (pins ref) */
749         unsigned long           tried;          /* Tried addresses */
750         signed char             index;          /* Current address */
751         bool                    responded;      /* T if the current address responded */
752         unsigned short          nr_iterations;  /* Number of address iterations */
753         short                   error;
754         u32                     abort_code;
755 };
756
757 /*
758  * Cursor for iterating over a set of volume location servers.
759  */
760 struct afs_vl_cursor {
761         struct afs_addr_cursor  ac;
762         struct afs_cell         *cell;          /* The cell we're querying */
763         struct afs_vlserver_list *server_list;  /* Current server list (pins ref) */
764         struct afs_vlserver     *server;        /* Server on which this resides */
765         struct key              *key;           /* Key for the server */
766         unsigned long           untried;        /* Bitmask of untried servers */
767         short                   index;          /* Current server */
768         short                   error;
769         unsigned short          flags;
770 #define AFS_VL_CURSOR_STOP      0x0001          /* Set to cease iteration */
771 #define AFS_VL_CURSOR_RETRY     0x0002          /* Set to do a retry */
772 #define AFS_VL_CURSOR_RETRIED   0x0004          /* Set if started a retry */
773         unsigned short          nr_iterations;  /* Number of server iterations */
774 };
775
776 /*
777  * Cursor for iterating over a set of fileservers.
778  */
779 struct afs_fs_cursor {
780         const struct afs_call_type *type;       /* Type of call done */
781         struct afs_addr_cursor  ac;
782         struct afs_vnode        *vnode;
783         struct afs_server_list  *server_list;   /* Current server list (pins ref) */
784         struct afs_cb_interest  *cbi;           /* Server on which this resides (pins ref) */
785         struct key              *key;           /* Key for the server */
786         unsigned long           untried;        /* Bitmask of untried servers */
787         unsigned int            cb_break;       /* cb_break + cb_s_break before the call */
788         unsigned int            cb_break_2;     /* cb_break + cb_s_break (2nd vnode) */
789         short                   index;          /* Current server */
790         short                   error;
791         unsigned short          flags;
792 #define AFS_FS_CURSOR_STOP      0x0001          /* Set to cease iteration */
793 #define AFS_FS_CURSOR_VBUSY     0x0002          /* Set if seen VBUSY */
794 #define AFS_FS_CURSOR_VMOVED    0x0004          /* Set if seen VMOVED */
795 #define AFS_FS_CURSOR_VNOVOL    0x0008          /* Set if seen VNOVOL */
796 #define AFS_FS_CURSOR_CUR_ONLY  0x0010          /* Set if current server only (file lock held) */
797 #define AFS_FS_CURSOR_NO_VSLEEP 0x0020          /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
798 #define AFS_FS_CURSOR_INTR      0x0040          /* Set if op is interruptible */
799         unsigned short          nr_iterations;  /* Number of server iterations */
800 };
801
802 /*
803  * Cache auxiliary data.
804  */
805 struct afs_vnode_cache_aux {
806         u64                     data_version;
807 } __packed;
808
809 #include <trace/events/afs.h>
810
811 /*****************************************************************************/
812 /*
813  * addr_list.c
814  */
815 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
816 {
817         if (alist)
818                 refcount_inc(&alist->usage);
819         return alist;
820 }
821 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
822                                                 unsigned short,
823                                                 unsigned short);
824 extern void afs_put_addrlist(struct afs_addr_list *);
825 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
826                                                       const char *, size_t, char,
827                                                       unsigned short, unsigned short);
828 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
829 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
830 extern int afs_end_cursor(struct afs_addr_cursor *);
831
832 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
833 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
834
835 /*
836  * cache.c
837  */
838 #ifdef CONFIG_AFS_FSCACHE
839 extern struct fscache_netfs afs_cache_netfs;
840 extern struct fscache_cookie_def afs_cell_cache_index_def;
841 extern struct fscache_cookie_def afs_volume_cache_index_def;
842 extern struct fscache_cookie_def afs_vnode_cache_index_def;
843 #else
844 #define afs_cell_cache_index_def        (*(struct fscache_cookie_def *) NULL)
845 #define afs_volume_cache_index_def      (*(struct fscache_cookie_def *) NULL)
846 #define afs_vnode_cache_index_def       (*(struct fscache_cookie_def *) NULL)
847 #endif
848
849 /*
850  * callback.c
851  */
852 extern void afs_init_callback_state(struct afs_server *);
853 extern void __afs_break_callback(struct afs_vnode *);
854 extern void afs_break_callback(struct afs_vnode *);
855 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break*);
856
857 extern int afs_register_server_cb_interest(struct afs_vnode *,
858                                            struct afs_server_list *, unsigned int);
859 extern void afs_put_cb_interest(struct afs_net *, struct afs_cb_interest *);
860 extern void afs_clear_callback_interests(struct afs_net *, struct afs_server_list *);
861
862 static inline struct afs_cb_interest *afs_get_cb_interest(struct afs_cb_interest *cbi)
863 {
864         if (cbi)
865                 refcount_inc(&cbi->usage);
866         return cbi;
867 }
868
869 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
870 {
871         return vnode->cb_break + vnode->cb_v_break;
872 }
873
874 static inline bool afs_cb_is_broken(unsigned int cb_break,
875                                     const struct afs_vnode *vnode,
876                                     const struct afs_cb_interest *cbi)
877 {
878         return !cbi || cb_break != (vnode->cb_break +
879                                     vnode->volume->cb_v_break);
880 }
881
882 /*
883  * cell.c
884  */
885 extern int afs_cell_init(struct afs_net *, const char *);
886 extern struct afs_cell *afs_lookup_cell_rcu(struct afs_net *, const char *, unsigned);
887 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
888                                         const char *, bool);
889 extern struct afs_cell *afs_get_cell(struct afs_cell *);
890 extern void afs_put_cell(struct afs_net *, struct afs_cell *);
891 extern void afs_manage_cells(struct work_struct *);
892 extern void afs_cells_timer(struct timer_list *);
893 extern void __net_exit afs_cell_purge(struct afs_net *);
894
895 /*
896  * cmservice.c
897  */
898 extern bool afs_cm_incoming_call(struct afs_call *);
899
900 /*
901  * dir.c
902  */
903 extern const struct file_operations afs_dir_file_operations;
904 extern const struct inode_operations afs_dir_inode_operations;
905 extern const struct address_space_operations afs_dir_aops;
906 extern const struct dentry_operations afs_fs_dentry_operations;
907
908 extern void afs_d_release(struct dentry *);
909
910 /*
911  * dir_edit.c
912  */
913 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
914                              enum afs_edit_dir_reason);
915 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
916
917 /*
918  * dir_silly.c
919  */
920 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
921                            struct dentry *, struct key *);
922 extern int afs_silly_iput(struct dentry *, struct inode *);
923
924 /*
925  * dynroot.c
926  */
927 extern const struct file_operations afs_dynroot_file_operations;
928 extern const struct inode_operations afs_dynroot_inode_operations;
929 extern const struct dentry_operations afs_dynroot_dentry_operations;
930
931 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
932 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
933 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
934 extern int afs_dynroot_populate(struct super_block *);
935 extern void afs_dynroot_depopulate(struct super_block *);
936
937 /*
938  * file.c
939  */
940 extern const struct address_space_operations afs_fs_aops;
941 extern const struct inode_operations afs_file_inode_operations;
942 extern const struct file_operations afs_file_operations;
943
944 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
945 extern void afs_put_wb_key(struct afs_wb_key *);
946 extern int afs_open(struct inode *, struct file *);
947 extern int afs_release(struct inode *, struct file *);
948 extern int afs_fetch_data(struct afs_vnode *, struct key *, struct afs_read *);
949 extern int afs_page_filler(void *, struct page *);
950 extern void afs_put_read(struct afs_read *);
951
952 /*
953  * flock.c
954  */
955 extern struct workqueue_struct *afs_lock_manager;
956
957 extern void afs_lock_op_done(struct afs_call *);
958 extern void afs_lock_work(struct work_struct *);
959 extern void afs_lock_may_be_available(struct afs_vnode *);
960 extern int afs_lock(struct file *, int, struct file_lock *);
961 extern int afs_flock(struct file *, int, struct file_lock *);
962
963 /*
964  * fsclient.c
965  */
966 extern int afs_fs_fetch_file_status(struct afs_fs_cursor *, struct afs_status_cb *,
967                                     struct afs_volsync *);
968 extern int afs_fs_give_up_callbacks(struct afs_net *, struct afs_server *);
969 extern int afs_fs_fetch_data(struct afs_fs_cursor *, struct afs_status_cb *, struct afs_read *);
970 extern int afs_fs_create(struct afs_fs_cursor *, const char *, umode_t,
971                          struct afs_status_cb *, struct afs_fid *, struct afs_status_cb *);
972 extern int afs_fs_remove(struct afs_fs_cursor *, struct afs_vnode *, const char *, bool,
973                          struct afs_status_cb *);
974 extern int afs_fs_link(struct afs_fs_cursor *, struct afs_vnode *, const char *,
975                        struct afs_status_cb *, struct afs_status_cb *);
976 extern int afs_fs_symlink(struct afs_fs_cursor *, const char *, const char *,
977                           struct afs_status_cb *, struct afs_fid *, struct afs_status_cb *);
978 extern int afs_fs_rename(struct afs_fs_cursor *, const char *,
979                          struct afs_vnode *, const char *,
980                          struct afs_status_cb *, struct afs_status_cb *);
981 extern int afs_fs_store_data(struct afs_fs_cursor *, struct address_space *,
982                              pgoff_t, pgoff_t, unsigned, unsigned, struct afs_status_cb *);
983 extern int afs_fs_setattr(struct afs_fs_cursor *, struct iattr *, struct afs_status_cb *);
984 extern int afs_fs_get_volume_status(struct afs_fs_cursor *, struct afs_volume_status *);
985 extern int afs_fs_set_lock(struct afs_fs_cursor *, afs_lock_type_t, struct afs_status_cb *);
986 extern int afs_fs_extend_lock(struct afs_fs_cursor *, struct afs_status_cb *);
987 extern int afs_fs_release_lock(struct afs_fs_cursor *, struct afs_status_cb *);
988 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
989                                         struct afs_addr_cursor *, struct key *);
990 extern struct afs_call *afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
991                                                 struct afs_addr_cursor *, struct key *,
992                                                 unsigned int);
993 extern int afs_fs_inline_bulk_status(struct afs_fs_cursor *, struct afs_net *,
994                                      struct afs_fid *, struct afs_status_cb *,
995                                      unsigned int, struct afs_volsync *);
996 extern int afs_fs_fetch_status(struct afs_fs_cursor *, struct afs_net *,
997                                struct afs_fid *, struct afs_status_cb *,
998                                struct afs_volsync *);
999
1000 struct afs_acl {
1001         u32     size;
1002         u8      data[];
1003 };
1004
1005 extern struct afs_acl *afs_fs_fetch_acl(struct afs_fs_cursor *, struct afs_status_cb *);
1006 extern int afs_fs_store_acl(struct afs_fs_cursor *, const struct afs_acl *,
1007                             struct afs_status_cb *);
1008
1009 /*
1010  * fs_probe.c
1011  */
1012 extern void afs_fileserver_probe_result(struct afs_call *);
1013 extern int afs_probe_fileservers(struct afs_net *, struct key *, struct afs_server_list *);
1014 extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
1015
1016 /*
1017  * inode.c
1018  */
1019 extern void afs_vnode_commit_status(struct afs_fs_cursor *,
1020                                     struct afs_vnode *,
1021                                     unsigned int,
1022                                     const afs_dataversion_t *,
1023                                     struct afs_status_cb *);
1024 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1025 extern int afs_iget5_test(struct inode *, void *);
1026 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1027 extern struct inode *afs_iget(struct super_block *, struct key *,
1028                               struct afs_iget_data *, struct afs_status_cb *,
1029                               struct afs_cb_interest *,
1030                               struct afs_vnode *);
1031 extern void afs_zap_data(struct afs_vnode *);
1032 extern bool afs_check_validity(struct afs_vnode *);
1033 extern int afs_validate(struct afs_vnode *, struct key *);
1034 extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
1035 extern int afs_setattr(struct dentry *, struct iattr *);
1036 extern void afs_evict_inode(struct inode *);
1037 extern int afs_drop_inode(struct inode *);
1038
1039 /*
1040  * main.c
1041  */
1042 extern struct workqueue_struct *afs_wq;
1043 extern int afs_net_id;
1044
1045 static inline struct afs_net *afs_net(struct net *net)
1046 {
1047         return net_generic(net, afs_net_id);
1048 }
1049
1050 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1051 {
1052         return afs_net(AFS_FS_S(sb)->net_ns);
1053 }
1054
1055 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1056 {
1057         return afs_sb2net(dentry->d_sb);
1058 }
1059
1060 static inline struct afs_net *afs_i2net(struct inode *inode)
1061 {
1062         return afs_sb2net(inode->i_sb);
1063 }
1064
1065 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1066 {
1067         return afs_i2net(&vnode->vfs_inode);
1068 }
1069
1070 static inline struct afs_net *afs_sock2net(struct sock *sk)
1071 {
1072         return net_generic(sock_net(sk), afs_net_id);
1073 }
1074
1075 static inline void __afs_stat(atomic_t *s)
1076 {
1077         atomic_inc(s);
1078 }
1079
1080 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1081
1082 /*
1083  * misc.c
1084  */
1085 extern int afs_abort_to_error(u32);
1086 extern void afs_prioritise_error(struct afs_error *, int, u32);
1087
1088 /*
1089  * mntpt.c
1090  */
1091 extern const struct inode_operations afs_mntpt_inode_operations;
1092 extern const struct inode_operations afs_autocell_inode_operations;
1093 extern const struct file_operations afs_mntpt_file_operations;
1094
1095 extern struct vfsmount *afs_d_automount(struct path *);
1096 extern void afs_mntpt_kill_timer(void);
1097
1098 /*
1099  * netdevices.c
1100  */
1101 extern int afs_get_ipv4_interfaces(struct afs_net *, struct afs_interface *,
1102                                    size_t, bool);
1103
1104 /*
1105  * proc.c
1106  */
1107 #ifdef CONFIG_PROC_FS
1108 extern int __net_init afs_proc_init(struct afs_net *);
1109 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1110 extern int afs_proc_cell_setup(struct afs_cell *);
1111 extern void afs_proc_cell_remove(struct afs_cell *);
1112 extern void afs_put_sysnames(struct afs_sysnames *);
1113 #else
1114 static inline int afs_proc_init(struct afs_net *net) { return 0; }
1115 static inline void afs_proc_cleanup(struct afs_net *net) {}
1116 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1117 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1118 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1119 #endif
1120
1121 /*
1122  * rotate.c
1123  */
1124 extern bool afs_begin_vnode_operation(struct afs_fs_cursor *, struct afs_vnode *,
1125                                       struct key *, bool);
1126 extern bool afs_select_fileserver(struct afs_fs_cursor *);
1127 extern bool afs_select_current_fileserver(struct afs_fs_cursor *);
1128 extern int afs_end_vnode_operation(struct afs_fs_cursor *);
1129
1130 /*
1131  * rxrpc.c
1132  */
1133 extern struct workqueue_struct *afs_async_calls;
1134
1135 extern int __net_init afs_open_socket(struct afs_net *);
1136 extern void __net_exit afs_close_socket(struct afs_net *);
1137 extern void afs_charge_preallocation(struct work_struct *);
1138 extern void afs_put_call(struct afs_call *);
1139 extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
1140 extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1141 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1142                                             const struct afs_call_type *,
1143                                             size_t, size_t);
1144 extern void afs_flat_call_destructor(struct afs_call *);
1145 extern void afs_send_empty_reply(struct afs_call *);
1146 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1147 extern int afs_extract_data(struct afs_call *, bool);
1148 extern int afs_protocol_error(struct afs_call *, int, enum afs_eproto_cause);
1149
1150 static inline void afs_set_fc_call(struct afs_call *call, struct afs_fs_cursor *fc)
1151 {
1152         call->intr = fc->flags & AFS_FS_CURSOR_INTR;
1153         fc->type = call->type;
1154 }
1155
1156 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1157 {
1158         call->kvec[0].iov_base = buf;
1159         call->kvec[0].iov_len = size;
1160         iov_iter_kvec(&call->iter, READ, call->kvec, 1, size);
1161 }
1162
1163 static inline void afs_extract_to_tmp(struct afs_call *call)
1164 {
1165         afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1166 }
1167
1168 static inline void afs_extract_to_tmp64(struct afs_call *call)
1169 {
1170         afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1171 }
1172
1173 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1174 {
1175         iov_iter_discard(&call->iter, READ, size);
1176 }
1177
1178 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1179 {
1180         afs_extract_begin(call, call->buffer, size);
1181 }
1182
1183 static inline int afs_transfer_reply(struct afs_call *call)
1184 {
1185         return afs_extract_data(call, false);
1186 }
1187
1188 static inline bool afs_check_call_state(struct afs_call *call,
1189                                         enum afs_call_state state)
1190 {
1191         return READ_ONCE(call->state) == state;
1192 }
1193
1194 static inline bool afs_set_call_state(struct afs_call *call,
1195                                       enum afs_call_state from,
1196                                       enum afs_call_state to)
1197 {
1198         bool ok = false;
1199
1200         spin_lock_bh(&call->state_lock);
1201         if (call->state == from) {
1202                 call->state = to;
1203                 trace_afs_call_state(call, from, to, 0, 0);
1204                 ok = true;
1205         }
1206         spin_unlock_bh(&call->state_lock);
1207         return ok;
1208 }
1209
1210 static inline void afs_set_call_complete(struct afs_call *call,
1211                                          int error, u32 remote_abort)
1212 {
1213         enum afs_call_state state;
1214         bool ok = false;
1215
1216         spin_lock_bh(&call->state_lock);
1217         state = call->state;
1218         if (state != AFS_CALL_COMPLETE) {
1219                 call->abort_code = remote_abort;
1220                 call->error = error;
1221                 call->state = AFS_CALL_COMPLETE;
1222                 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1223                                      error, remote_abort);
1224                 ok = true;
1225         }
1226         spin_unlock_bh(&call->state_lock);
1227         if (ok)
1228                 trace_afs_call_done(call);
1229 }
1230
1231 /*
1232  * security.c
1233  */
1234 extern void afs_put_permits(struct afs_permits *);
1235 extern void afs_clear_permits(struct afs_vnode *);
1236 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1237                              struct afs_status_cb *);
1238 extern void afs_zap_permits(struct rcu_head *);
1239 extern struct key *afs_request_key(struct afs_cell *);
1240 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1241 extern int afs_permission(struct inode *, int);
1242 extern void __exit afs_clean_up_permit_cache(void);
1243
1244 /*
1245  * server.c
1246  */
1247 extern spinlock_t afs_server_peer_lock;
1248
1249 static inline struct afs_server *afs_get_server(struct afs_server *server)
1250 {
1251         atomic_inc(&server->usage);
1252         return server;
1253 }
1254
1255 extern struct afs_server *afs_find_server(struct afs_net *,
1256                                           const struct sockaddr_rxrpc *);
1257 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1258 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *);
1259 extern void afs_put_server(struct afs_net *, struct afs_server *);
1260 extern void afs_manage_servers(struct work_struct *);
1261 extern void afs_servers_timer(struct timer_list *);
1262 extern void __net_exit afs_purge_servers(struct afs_net *);
1263 extern bool afs_check_server_record(struct afs_fs_cursor *, struct afs_server *);
1264
1265 /*
1266  * server_list.c
1267  */
1268 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1269 {
1270         refcount_inc(&slist->usage);
1271         return slist;
1272 }
1273
1274 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1275 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1276                                                      struct afs_vldb_entry *,
1277                                                      u8);
1278 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1279
1280 /*
1281  * super.c
1282  */
1283 extern int __init afs_fs_init(void);
1284 extern void afs_fs_exit(void);
1285
1286 /*
1287  * vlclient.c
1288  */
1289 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1290                                                          const char *, int);
1291 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1292 extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
1293                                                 struct key *, struct afs_vlserver *, unsigned int);
1294 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1295
1296 /*
1297  * vl_probe.c
1298  */
1299 extern void afs_vlserver_probe_result(struct afs_call *);
1300 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1301 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1302
1303 /*
1304  * vl_rotate.c
1305  */
1306 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1307                                          struct afs_cell *, struct key *);
1308 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1309 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1310 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1311
1312 /*
1313  * vlserver_list.c
1314  */
1315 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1316 {
1317         atomic_inc(&vlserver->usage);
1318         return vlserver;
1319 }
1320
1321 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1322 {
1323         if (vllist)
1324                 atomic_inc(&vllist->usage);
1325         return vllist;
1326 }
1327
1328 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1329 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1330 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1331 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1332 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1333                                                            const void *, size_t);
1334
1335 /*
1336  * volume.c
1337  */
1338 static inline struct afs_volume *__afs_get_volume(struct afs_volume *volume)
1339 {
1340         if (volume)
1341                 atomic_inc(&volume->usage);
1342         return volume;
1343 }
1344
1345 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1346 extern void afs_activate_volume(struct afs_volume *);
1347 extern void afs_deactivate_volume(struct afs_volume *);
1348 extern void afs_put_volume(struct afs_cell *, struct afs_volume *);
1349 extern int afs_check_volume_status(struct afs_volume *, struct key *);
1350
1351 /*
1352  * write.c
1353  */
1354 extern int afs_set_page_dirty(struct page *);
1355 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1356                         loff_t pos, unsigned len, unsigned flags,
1357                         struct page **pagep, void **fsdata);
1358 extern int afs_write_end(struct file *file, struct address_space *mapping,
1359                         loff_t pos, unsigned len, unsigned copied,
1360                         struct page *page, void *fsdata);
1361 extern int afs_writepage(struct page *, struct writeback_control *);
1362 extern int afs_writepages(struct address_space *, struct writeback_control *);
1363 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1364 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1365 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1366 extern void afs_prune_wb_keys(struct afs_vnode *);
1367 extern int afs_launder_page(struct page *);
1368
1369 /*
1370  * xattr.c
1371  */
1372 extern const struct xattr_handler *afs_xattr_handlers[];
1373 extern ssize_t afs_listxattr(struct dentry *, char *, size_t);
1374
1375 /*
1376  * yfsclient.c
1377  */
1378 extern int yfs_fs_fetch_file_status(struct afs_fs_cursor *, struct afs_status_cb *,
1379                                     struct afs_volsync *);
1380 extern int yfs_fs_fetch_data(struct afs_fs_cursor *, struct afs_status_cb *, struct afs_read *);
1381 extern int yfs_fs_create_file(struct afs_fs_cursor *, const char *, umode_t, struct afs_status_cb *,
1382                               struct afs_fid *, struct afs_status_cb *);
1383 extern int yfs_fs_make_dir(struct afs_fs_cursor *, const char *, umode_t, struct afs_status_cb *,
1384                            struct afs_fid *, struct afs_status_cb *);
1385 extern int yfs_fs_remove_file2(struct afs_fs_cursor *, struct afs_vnode *, const char *,
1386                                struct afs_status_cb *, struct afs_status_cb *);
1387 extern int yfs_fs_remove(struct afs_fs_cursor *, struct afs_vnode *, const char *, bool,
1388                          struct afs_status_cb *);
1389 extern int yfs_fs_link(struct afs_fs_cursor *, struct afs_vnode *, const char *,
1390                        struct afs_status_cb *, struct afs_status_cb *);
1391 extern int yfs_fs_symlink(struct afs_fs_cursor *, const char *, const char *,
1392                           struct afs_status_cb *, struct afs_fid *, struct afs_status_cb *);
1393 extern int yfs_fs_rename(struct afs_fs_cursor *, const char *, struct afs_vnode *, const char *,
1394                          struct afs_status_cb *, struct afs_status_cb *);
1395 extern int yfs_fs_store_data(struct afs_fs_cursor *, struct address_space *,
1396                              pgoff_t, pgoff_t, unsigned, unsigned, struct afs_status_cb *);
1397 extern int yfs_fs_setattr(struct afs_fs_cursor *, struct iattr *, struct afs_status_cb *);
1398 extern int yfs_fs_get_volume_status(struct afs_fs_cursor *, struct afs_volume_status *);
1399 extern int yfs_fs_set_lock(struct afs_fs_cursor *, afs_lock_type_t, struct afs_status_cb *);
1400 extern int yfs_fs_extend_lock(struct afs_fs_cursor *, struct afs_status_cb *);
1401 extern int yfs_fs_release_lock(struct afs_fs_cursor *, struct afs_status_cb *);
1402 extern int yfs_fs_fetch_status(struct afs_fs_cursor *, struct afs_net *,
1403                                struct afs_fid *, struct afs_status_cb *,
1404                                struct afs_volsync *);
1405 extern int yfs_fs_inline_bulk_status(struct afs_fs_cursor *, struct afs_net *,
1406                                      struct afs_fid *, struct afs_status_cb *,
1407                                      unsigned int, struct afs_volsync *);
1408
1409 struct yfs_acl {
1410         struct afs_acl  *acl;           /* Dir/file/symlink ACL */
1411         struct afs_acl  *vol_acl;       /* Whole volume ACL */
1412         u32             inherit_flag;   /* True if ACL is inherited from parent dir */
1413         u32             num_cleaned;    /* Number of ACEs removed due to subject removal */
1414         unsigned int    flags;
1415 #define YFS_ACL_WANT_ACL        0x01    /* Set if caller wants ->acl */
1416 #define YFS_ACL_WANT_VOL_ACL    0x02    /* Set if caller wants ->vol_acl */
1417 };
1418
1419 extern void yfs_free_opaque_acl(struct yfs_acl *);
1420 extern struct yfs_acl *yfs_fs_fetch_opaque_acl(struct afs_fs_cursor *, struct yfs_acl *,
1421                                                struct afs_status_cb *);
1422 extern int yfs_fs_store_opaque_acl2(struct afs_fs_cursor *, const struct afs_acl *,
1423                                     struct afs_status_cb *);
1424
1425 /*
1426  * Miscellaneous inline functions.
1427  */
1428 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1429 {
1430         return container_of(inode, struct afs_vnode, vfs_inode);
1431 }
1432
1433 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1434 {
1435         return &vnode->vfs_inode;
1436 }
1437
1438 static inline void afs_check_for_remote_deletion(struct afs_fs_cursor *fc,
1439                                                  struct afs_vnode *vnode)
1440 {
1441         if (fc->ac.error == -ENOENT) {
1442                 set_bit(AFS_VNODE_DELETED, &vnode->flags);
1443                 afs_break_callback(vnode);
1444         }
1445 }
1446
1447 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1448 {
1449         trace_afs_io_error(call->debug_id, -EIO, where);
1450         return -EIO;
1451 }
1452
1453 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1454 {
1455         trace_afs_file_error(vnode, -EIO, where);
1456         return -EIO;
1457 }
1458
1459 /*****************************************************************************/
1460 /*
1461  * debug tracing
1462  */
1463 extern unsigned afs_debug;
1464
1465 #define dbgprintk(FMT,...) \
1466         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1467
1468 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1469 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1470 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1471
1472
1473 #if defined(__KDEBUG)
1474 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1475 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1476 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1477
1478 #elif defined(CONFIG_AFS_DEBUG)
1479 #define AFS_DEBUG_KENTER        0x01
1480 #define AFS_DEBUG_KLEAVE        0x02
1481 #define AFS_DEBUG_KDEBUG        0x04
1482
1483 #define _enter(FMT,...)                                 \
1484 do {                                                    \
1485         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
1486                 kenter(FMT,##__VA_ARGS__);              \
1487 } while (0)
1488
1489 #define _leave(FMT,...)                                 \
1490 do {                                                    \
1491         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
1492                 kleave(FMT,##__VA_ARGS__);              \
1493 } while (0)
1494
1495 #define _debug(FMT,...)                                 \
1496 do {                                                    \
1497         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
1498                 kdebug(FMT,##__VA_ARGS__);              \
1499 } while (0)
1500
1501 #else
1502 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1503 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1504 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1505 #endif
1506
1507 /*
1508  * debug assertion checking
1509  */
1510 #if 1 // defined(__KDEBUGALL)
1511
1512 #define ASSERT(X)                                               \
1513 do {                                                            \
1514         if (unlikely(!(X))) {                                   \
1515                 printk(KERN_ERR "\n");                          \
1516                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1517                 BUG();                                          \
1518         }                                                       \
1519 } while(0)
1520
1521 #define ASSERTCMP(X, OP, Y)                                             \
1522 do {                                                                    \
1523         if (unlikely(!((X) OP (Y)))) {                                  \
1524                 printk(KERN_ERR "\n");                                  \
1525                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1526                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1527                        (unsigned long)(X), (unsigned long)(Y));         \
1528                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1529                        (unsigned long)(X), (unsigned long)(Y));         \
1530                 BUG();                                                  \
1531         }                                                               \
1532 } while(0)
1533
1534 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
1535 do {                                                                    \
1536         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
1537                 printk(KERN_ERR "\n");                                  \
1538                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1539                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1540                        (unsigned long)(L), (unsigned long)(N),          \
1541                        (unsigned long)(H));                             \
1542                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1543                        (unsigned long)(L), (unsigned long)(N),          \
1544                        (unsigned long)(H));                             \
1545                 BUG();                                                  \
1546         }                                                               \
1547 } while(0)
1548
1549 #define ASSERTIF(C, X)                                          \
1550 do {                                                            \
1551         if (unlikely((C) && !(X))) {                            \
1552                 printk(KERN_ERR "\n");                          \
1553                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1554                 BUG();                                          \
1555         }                                                       \
1556 } while(0)
1557
1558 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1559 do {                                                                    \
1560         if (unlikely((C) && !((X) OP (Y)))) {                           \
1561                 printk(KERN_ERR "\n");                                  \
1562                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1563                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1564                        (unsigned long)(X), (unsigned long)(Y));         \
1565                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1566                        (unsigned long)(X), (unsigned long)(Y));         \
1567                 BUG();                                                  \
1568         }                                                               \
1569 } while(0)
1570
1571 #else
1572
1573 #define ASSERT(X)                               \
1574 do {                                            \
1575 } while(0)
1576
1577 #define ASSERTCMP(X, OP, Y)                     \
1578 do {                                            \
1579 } while(0)
1580
1581 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
1582 do {                                            \
1583 } while(0)
1584
1585 #define ASSERTIF(C, X)                          \
1586 do {                                            \
1587 } while(0)
1588
1589 #define ASSERTIFCMP(C, X, OP, Y)                \
1590 do {                                            \
1591 } while(0)
1592
1593 #endif /* __KDEBUGALL */