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