Merge tag 'at24-fixes-for-v5.9-rc5' of git://git.kernel.org/pub/scm/linux/kernel...
[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;          /* 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 #define AFS_VLSERVER_FL_RESPONDING 3            /* VL server is responding */
405         rwlock_t                lock;           /* Lock on addresses */
406         atomic_t                usage;
407         unsigned int            rtt;            /* Server's current RTT in uS */
408
409         /* Probe state */
410         wait_queue_head_t       probe_wq;
411         atomic_t                probe_outstanding;
412         spinlock_t              probe_lock;
413         struct {
414                 unsigned int    rtt;            /* RTT in uS */
415                 u32             abort_code;
416                 short           error;
417                 unsigned short  flags;
418 #define AFS_VLSERVER_PROBE_RESPONDED            0x01 /* At least once response (may be abort) */
419 #define AFS_VLSERVER_PROBE_IS_YFS               0x02 /* The peer appears to be YFS */
420 #define AFS_VLSERVER_PROBE_NOT_YFS              0x04 /* The peer appears not to be YFS */
421 #define AFS_VLSERVER_PROBE_LOCAL_FAILURE        0x08 /* A local failure prevented a probe */
422         } probe;
423
424         u16                     port;
425         u16                     name_len;       /* Length of name */
426         char                    name[];         /* Server name, case-flattened */
427 };
428
429 /*
430  * Weighted list of Volume Location servers.
431  */
432 struct afs_vlserver_entry {
433         u16                     priority;       /* Preference (as SRV) */
434         u16                     weight;         /* Weight (as SRV) */
435         enum dns_record_source  source:8;
436         enum dns_lookup_status  status:8;
437         struct afs_vlserver     *server;
438 };
439
440 struct afs_vlserver_list {
441         struct rcu_head         rcu;
442         atomic_t                usage;
443         u8                      nr_servers;
444         u8                      index;          /* Server currently in use */
445         u8                      preferred;      /* Preferred server */
446         enum dns_record_source  source:8;
447         enum dns_lookup_status  status:8;
448         rwlock_t                lock;
449         struct afs_vlserver_entry servers[];
450 };
451
452 /*
453  * Cached VLDB entry.
454  *
455  * This is pointed to by cell->vldb_entries, indexed by name.
456  */
457 struct afs_vldb_entry {
458         afs_volid_t             vid[3];         /* Volume IDs for R/W, R/O and Bak volumes */
459
460         unsigned long           flags;
461 #define AFS_VLDB_HAS_RW         0               /* - R/W volume exists */
462 #define AFS_VLDB_HAS_RO         1               /* - R/O volume exists */
463 #define AFS_VLDB_HAS_BAK        2               /* - Backup volume exists */
464 #define AFS_VLDB_QUERY_VALID    3               /* - Record is valid */
465 #define AFS_VLDB_QUERY_ERROR    4               /* - VL server returned error */
466
467         uuid_t                  fs_server[AFS_NMAXNSERVERS];
468         u32                     addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
469         u8                      fs_mask[AFS_NMAXNSERVERS];
470 #define AFS_VOL_VTM_RW  0x01 /* R/W version of the volume is available (on this server) */
471 #define AFS_VOL_VTM_RO  0x02 /* R/O version of the volume is available (on this server) */
472 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
473         short                   error;
474         u8                      nr_servers;     /* Number of server records */
475         u8                      name_len;
476         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
477 };
478
479 /*
480  * Record of fileserver with which we're actively communicating.
481  */
482 struct afs_server {
483         struct rcu_head         rcu;
484         union {
485                 uuid_t          uuid;           /* Server ID */
486                 struct afs_uuid _uuid;
487         };
488
489         struct afs_addr_list    __rcu *addresses;
490         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
491         struct rb_node          uuid_rb;        /* Link in net->fs_servers */
492         struct afs_server __rcu *uuid_next;     /* Next server with same UUID */
493         struct afs_server       *uuid_prev;     /* Previous server with same UUID */
494         struct list_head        probe_link;     /* Link in net->fs_probe_list */
495         struct hlist_node       addr4_link;     /* Link in net->fs_addresses4 */
496         struct hlist_node       addr6_link;     /* Link in net->fs_addresses6 */
497         struct hlist_node       proc_link;      /* Link in net->fs_proc */
498         struct afs_server       *gc_next;       /* Next server in manager's list */
499         time64_t                unuse_time;     /* Time at which last unused */
500         unsigned long           flags;
501 #define AFS_SERVER_FL_RESPONDING 0              /* The server is responding */
502 #define AFS_SERVER_FL_UPDATING  1
503 #define AFS_SERVER_FL_NEEDS_UPDATE 2            /* Fileserver address list is out of date */
504 #define AFS_SERVER_FL_NOT_READY 4               /* The record is not ready for use */
505 #define AFS_SERVER_FL_NOT_FOUND 5               /* VL server says no such server */
506 #define AFS_SERVER_FL_VL_FAIL   6               /* Failed to access VL server */
507 #define AFS_SERVER_FL_MAY_HAVE_CB 8             /* May have callbacks on this fileserver */
508 #define AFS_SERVER_FL_IS_YFS    16              /* Server is YFS not AFS */
509 #define AFS_SERVER_FL_NO_IBULK  17              /* Fileserver doesn't support FS.InlineBulkStatus */
510 #define AFS_SERVER_FL_NO_RM2    18              /* Fileserver doesn't support YFS.RemoveFile2 */
511         atomic_t                ref;            /* Object refcount */
512         atomic_t                active;         /* Active user count */
513         u32                     addr_version;   /* Address list version */
514         unsigned int            rtt;            /* Server's current RTT in uS */
515         unsigned int            debug_id;       /* Debugging ID for traces */
516
517         /* file service access */
518         rwlock_t                fs_lock;        /* access lock */
519
520         /* callback promise management */
521         unsigned                cb_s_break;     /* Break-everything counter. */
522
523         /* Probe state */
524         unsigned long           probed_at;      /* Time last probe was dispatched (jiffies) */
525         wait_queue_head_t       probe_wq;
526         atomic_t                probe_outstanding;
527         spinlock_t              probe_lock;
528         struct {
529                 unsigned int    rtt;            /* RTT in uS */
530                 u32             abort_code;
531                 short           error;
532                 bool            responded:1;
533                 bool            is_yfs:1;
534                 bool            not_yfs:1;
535                 bool            local_failure:1;
536         } probe;
537 };
538
539 /*
540  * Replaceable volume server list.
541  */
542 struct afs_server_entry {
543         struct afs_server       *server;
544 };
545
546 struct afs_server_list {
547         afs_volid_t             vids[AFS_MAXTYPES]; /* Volume IDs */
548         refcount_t              usage;
549         unsigned char           nr_servers;
550         unsigned char           preferred;      /* Preferred server */
551         unsigned short          vnovol_mask;    /* Servers to be skipped due to VNOVOL */
552         unsigned int            seq;            /* Set to ->servers_seq when installed */
553         rwlock_t                lock;
554         struct afs_server_entry servers[];
555 };
556
557 /*
558  * Live AFS volume management.
559  */
560 struct afs_volume {
561         union {
562                 struct rcu_head rcu;
563                 afs_volid_t     vid;            /* volume ID */
564         };
565         atomic_t                usage;
566         time64_t                update_at;      /* Time at which to next update */
567         struct afs_cell         *cell;          /* Cell to which belongs (pins ref) */
568         struct rb_node          cell_node;      /* Link in cell->volumes */
569         struct hlist_node       proc_link;      /* Link in cell->proc_volumes */
570         struct super_block __rcu *sb;           /* Superblock on which inodes reside */
571         unsigned long           flags;
572 #define AFS_VOLUME_NEEDS_UPDATE 0       /* - T if an update needs performing */
573 #define AFS_VOLUME_UPDATING     1       /* - T if an update is in progress */
574 #define AFS_VOLUME_WAIT         2       /* - T if users must wait for update */
575 #define AFS_VOLUME_DELETED      3       /* - T if volume appears deleted */
576 #define AFS_VOLUME_OFFLINE      4       /* - T if volume offline notice given */
577 #define AFS_VOLUME_BUSY         5       /* - T if volume busy notice given */
578 #define AFS_VOLUME_MAYBE_NO_IBULK 6     /* - T if some servers don't have InlineBulkStatus */
579 #ifdef CONFIG_AFS_FSCACHE
580         struct fscache_cookie   *cache;         /* caching cookie */
581 #endif
582         struct afs_server_list __rcu *servers;  /* List of servers on which volume resides */
583         rwlock_t                servers_lock;   /* Lock for ->servers */
584         unsigned int            servers_seq;    /* Incremented each time ->servers changes */
585
586         unsigned                cb_v_break;     /* Break-everything counter. */
587         rwlock_t                cb_v_break_lock;
588
589         afs_voltype_t           type;           /* type of volume */
590         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
591         u8                      name_len;
592         u8                      name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
593 };
594
595 enum afs_lock_state {
596         AFS_VNODE_LOCK_NONE,            /* The vnode has no lock on the server */
597         AFS_VNODE_LOCK_WAITING_FOR_CB,  /* We're waiting for the server to break the callback */
598         AFS_VNODE_LOCK_SETTING,         /* We're asking the server for a lock */
599         AFS_VNODE_LOCK_GRANTED,         /* We have a lock on the server */
600         AFS_VNODE_LOCK_EXTENDING,       /* We're extending a lock on the server */
601         AFS_VNODE_LOCK_NEED_UNLOCK,     /* We need to unlock on the server */
602         AFS_VNODE_LOCK_UNLOCKING,       /* We're telling the server to unlock */
603         AFS_VNODE_LOCK_DELETED,         /* The vnode has been deleted whilst we have a lock */
604 };
605
606 /*
607  * AFS inode private data.
608  *
609  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
610  * leak from one inode to another.
611  */
612 struct afs_vnode {
613         struct inode            vfs_inode;      /* the VFS's inode record */
614
615         struct afs_volume       *volume;        /* volume on which vnode resides */
616         struct afs_fid          fid;            /* the file identifier for this inode */
617         struct afs_file_status  status;         /* AFS status info for this file */
618         afs_dataversion_t       invalid_before; /* Child dentries are invalid before this */
619 #ifdef CONFIG_AFS_FSCACHE
620         struct fscache_cookie   *cache;         /* caching cookie */
621 #endif
622         struct afs_permits __rcu *permit_cache; /* cache of permits so far obtained */
623         struct mutex            io_lock;        /* Lock for serialising I/O on this mutex */
624         struct rw_semaphore     validate_lock;  /* lock for validating this vnode */
625         struct rw_semaphore     rmdir_lock;     /* Lock for rmdir vs sillyrename */
626         struct key              *silly_key;     /* Silly rename key */
627         spinlock_t              wb_lock;        /* lock for wb_keys */
628         spinlock_t              lock;           /* waitqueue/flags lock */
629         unsigned long           flags;
630 #define AFS_VNODE_CB_PROMISED   0               /* Set if vnode has a callback promise */
631 #define AFS_VNODE_UNSET         1               /* set if vnode attributes not yet set */
632 #define AFS_VNODE_DIR_VALID     2               /* Set if dir contents are valid */
633 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
634 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
635 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
636 #define AFS_VNODE_AUTOCELL      6               /* set if Vnode is an auto mount point */
637 #define AFS_VNODE_PSEUDODIR     7               /* set if Vnode is a pseudo directory */
638 #define AFS_VNODE_NEW_CONTENT   8               /* Set if file has new content (create/trunc-0) */
639 #define AFS_VNODE_SILLY_DELETED 9               /* Set if file has been silly-deleted */
640
641         struct list_head        wb_keys;        /* List of keys available for writeback */
642         struct list_head        pending_locks;  /* locks waiting to be granted */
643         struct list_head        granted_locks;  /* locks granted on this file */
644         struct delayed_work     lock_work;      /* work to be done in locking */
645         struct key              *lock_key;      /* Key to be used in lock ops */
646         ktime_t                 locked_at;      /* Time at which lock obtained */
647         enum afs_lock_state     lock_state : 8;
648         afs_lock_type_t         lock_type : 8;
649
650         /* outstanding callback notification on this file */
651         void                    *cb_server;     /* Server with callback/filelock */
652         unsigned int            cb_s_break;     /* Mass break counter on ->server */
653         unsigned int            cb_v_break;     /* Mass break counter on ->volume */
654         unsigned int            cb_break;       /* Break counter on vnode */
655         seqlock_t               cb_lock;        /* Lock for ->cb_server, ->status, ->cb_*break */
656
657         time64_t                cb_expires_at;  /* time at which callback expires */
658 };
659
660 static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
661 {
662 #ifdef CONFIG_AFS_FSCACHE
663         return vnode->cache;
664 #else
665         return NULL;
666 #endif
667 }
668
669 /*
670  * cached security record for one user's attempt to access a vnode
671  */
672 struct afs_permit {
673         struct key              *key;           /* RxRPC ticket holding a security context */
674         afs_access_t            access;         /* CallerAccess value for this key */
675 };
676
677 /*
678  * Immutable cache of CallerAccess records from attempts to access vnodes.
679  * These may be shared between multiple vnodes.
680  */
681 struct afs_permits {
682         struct rcu_head         rcu;
683         struct hlist_node       hash_node;      /* Link in hash */
684         unsigned long           h;              /* Hash value for this permit list */
685         refcount_t              usage;
686         unsigned short          nr_permits;     /* Number of records */
687         bool                    invalidated;    /* Invalidated due to key change */
688         struct afs_permit       permits[];      /* List of permits sorted by key pointer */
689 };
690
691 /*
692  * Error prioritisation and accumulation.
693  */
694 struct afs_error {
695         short   error;                  /* Accumulated error */
696         bool    responded;              /* T if server responded */
697 };
698
699 /*
700  * Cursor for iterating over a server's address list.
701  */
702 struct afs_addr_cursor {
703         struct afs_addr_list    *alist;         /* Current address list (pins ref) */
704         unsigned long           tried;          /* Tried addresses */
705         signed char             index;          /* Current address */
706         bool                    responded;      /* T if the current address responded */
707         unsigned short          nr_iterations;  /* Number of address iterations */
708         short                   error;
709         u32                     abort_code;
710 };
711
712 /*
713  * Cursor for iterating over a set of volume location servers.
714  */
715 struct afs_vl_cursor {
716         struct afs_addr_cursor  ac;
717         struct afs_cell         *cell;          /* The cell we're querying */
718         struct afs_vlserver_list *server_list;  /* Current server list (pins ref) */
719         struct afs_vlserver     *server;        /* Server on which this resides */
720         struct key              *key;           /* Key for the server */
721         unsigned long           untried;        /* Bitmask of untried servers */
722         short                   index;          /* Current server */
723         short                   error;
724         unsigned short          flags;
725 #define AFS_VL_CURSOR_STOP      0x0001          /* Set to cease iteration */
726 #define AFS_VL_CURSOR_RETRY     0x0002          /* Set to do a retry */
727 #define AFS_VL_CURSOR_RETRIED   0x0004          /* Set if started a retry */
728         unsigned short          nr_iterations;  /* Number of server iterations */
729 };
730
731 /*
732  * Fileserver operation methods.
733  */
734 struct afs_operation_ops {
735         void (*issue_afs_rpc)(struct afs_operation *op);
736         void (*issue_yfs_rpc)(struct afs_operation *op);
737         void (*success)(struct afs_operation *op);
738         void (*aborted)(struct afs_operation *op);
739         void (*edit_dir)(struct afs_operation *op);
740         void (*put)(struct afs_operation *op);
741 };
742
743 struct afs_vnode_param {
744         struct afs_vnode        *vnode;
745         struct afs_fid          fid;            /* Fid to access */
746         struct afs_status_cb    scb;            /* Returned status and callback promise */
747         afs_dataversion_t       dv_before;      /* Data version before the call */
748         unsigned int            cb_break_before; /* cb_break + cb_s_break before the call */
749         u8                      dv_delta;       /* Expected change in data version */
750         bool                    put_vnode:1;    /* T if we have a ref on the vnode */
751         bool                    need_io_lock:1; /* T if we need the I/O lock on this */
752         bool                    update_ctime:1; /* Need to update the ctime */
753         bool                    set_size:1;     /* Must update i_size */
754         bool                    op_unlinked:1;  /* True if file was unlinked by op */
755 };
756
757 /*
758  * Fileserver operation wrapper, handling server and address rotation
759  * asynchronously.  May make simultaneous calls to multiple servers.
760  */
761 struct afs_operation {
762         struct afs_net          *net;           /* Network namespace */
763         struct key              *key;           /* Key for the cell */
764         const struct afs_call_type *type;       /* Type of call done */
765         const struct afs_operation_ops *ops;
766
767         /* Parameters/results for the operation */
768         struct afs_volume       *volume;        /* Volume being accessed */
769         struct afs_vnode_param  file[2];
770         struct afs_vnode_param  *more_files;
771         struct afs_volsync      volsync;
772         struct dentry           *dentry;        /* Dentry to be altered */
773         struct dentry           *dentry_2;      /* Second dentry to be altered */
774         struct timespec64       mtime;          /* Modification time to record */
775         struct timespec64       ctime;          /* Change time to set */
776         short                   nr_files;       /* Number of entries in file[], more_files */
777         short                   error;
778         unsigned int            debug_id;
779
780         unsigned int            cb_v_break;     /* Volume break counter before op */
781         unsigned int            cb_s_break;     /* Server break counter before op */
782
783         union {
784                 struct {
785                         int     which;          /* Which ->file[] to fetch for */
786                 } fetch_status;
787                 struct {
788                         int     reason;         /* enum afs_edit_dir_reason */
789                         mode_t  mode;
790                         const char *symlink;
791                 } create;
792                 struct {
793                         bool    need_rehash;
794                 } unlink;
795                 struct {
796                         struct dentry *rehash;
797                         struct dentry *tmp;
798                         bool    new_negative;
799                 } rename;
800                 struct {
801                         struct afs_read *req;
802                 } fetch;
803                 struct {
804                         afs_lock_type_t type;
805                 } lock;
806                 struct {
807                         struct address_space *mapping;  /* Pages being written from */
808                         pgoff_t         first;          /* first page in mapping to deal with */
809                         pgoff_t         last;           /* last page in mapping to deal with */
810                         unsigned        first_offset;   /* offset into mapping[first] */
811                         unsigned        last_to;        /* amount of mapping[last] */
812                 } store;
813                 struct {
814                         struct iattr    *attr;
815                 } setattr;
816                 struct afs_acl  *acl;
817                 struct yfs_acl  *yacl;
818                 struct {
819                         struct afs_volume_status vs;
820                         struct kstatfs          *buf;
821                 } volstatus;
822         };
823
824         /* Fileserver iteration state */
825         struct afs_addr_cursor  ac;
826         struct afs_server_list  *server_list;   /* Current server list (pins ref) */
827         struct afs_server       *server;        /* Server we're using (ref pinned by server_list) */
828         struct afs_call         *call;
829         unsigned long           untried;        /* Bitmask of untried servers */
830         short                   index;          /* Current server */
831         unsigned short          nr_iterations;  /* Number of server iterations */
832
833         unsigned int            flags;
834 #define AFS_OPERATION_STOP              0x0001  /* Set to cease iteration */
835 #define AFS_OPERATION_VBUSY             0x0002  /* Set if seen VBUSY */
836 #define AFS_OPERATION_VMOVED            0x0004  /* Set if seen VMOVED */
837 #define AFS_OPERATION_VNOVOL            0x0008  /* Set if seen VNOVOL */
838 #define AFS_OPERATION_CUR_ONLY          0x0010  /* Set if current server only (file lock held) */
839 #define AFS_OPERATION_NO_VSLEEP         0x0020  /* Set to prevent sleep on VBUSY, VOFFLINE, ... */
840 #define AFS_OPERATION_UNINTR            0x0040  /* Set if op is uninterruptible */
841 #define AFS_OPERATION_DOWNGRADE         0x0080  /* Set to retry with downgraded opcode */
842 #define AFS_OPERATION_LOCK_0            0x0100  /* Set if have io_lock on file[0] */
843 #define AFS_OPERATION_LOCK_1            0x0200  /* Set if have io_lock on file[1] */
844 #define AFS_OPERATION_TRIED_ALL         0x0400  /* Set if we've tried all the fileservers */
845 #define AFS_OPERATION_RETRY_SERVER      0x0800  /* Set if we should retry the current server */
846 #define AFS_OPERATION_DIR_CONFLICT      0x1000  /* Set if we detected a 3rd-party dir change */
847 };
848
849 /*
850  * Cache auxiliary data.
851  */
852 struct afs_vnode_cache_aux {
853         u64                     data_version;
854 } __packed;
855
856 #include <trace/events/afs.h>
857
858 /*****************************************************************************/
859 /*
860  * addr_list.c
861  */
862 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
863 {
864         if (alist)
865                 refcount_inc(&alist->usage);
866         return alist;
867 }
868 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
869                                                 unsigned short,
870                                                 unsigned short);
871 extern void afs_put_addrlist(struct afs_addr_list *);
872 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
873                                                       const char *, size_t, char,
874                                                       unsigned short, unsigned short);
875 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
876 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
877 extern int afs_end_cursor(struct afs_addr_cursor *);
878
879 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
880 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
881
882 /*
883  * cache.c
884  */
885 #ifdef CONFIG_AFS_FSCACHE
886 extern struct fscache_netfs afs_cache_netfs;
887 extern struct fscache_cookie_def afs_cell_cache_index_def;
888 extern struct fscache_cookie_def afs_volume_cache_index_def;
889 extern struct fscache_cookie_def afs_vnode_cache_index_def;
890 #else
891 #define afs_cell_cache_index_def        (*(struct fscache_cookie_def *) NULL)
892 #define afs_volume_cache_index_def      (*(struct fscache_cookie_def *) NULL)
893 #define afs_vnode_cache_index_def       (*(struct fscache_cookie_def *) NULL)
894 #endif
895
896 /*
897  * callback.c
898  */
899 extern void afs_init_callback_state(struct afs_server *);
900 extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
901 extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
902 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
903
904 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
905 {
906         return vnode->cb_break + vnode->cb_v_break;
907 }
908
909 static inline bool afs_cb_is_broken(unsigned int cb_break,
910                                     const struct afs_vnode *vnode)
911 {
912         return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
913 }
914
915 /*
916  * cell.c
917  */
918 extern int afs_cell_init(struct afs_net *, const char *);
919 extern struct afs_cell *afs_lookup_cell_rcu(struct afs_net *, const char *, unsigned);
920 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
921                                         const char *, bool);
922 extern struct afs_cell *afs_get_cell(struct afs_cell *);
923 extern void afs_put_cell(struct afs_net *, struct afs_cell *);
924 extern void afs_manage_cells(struct work_struct *);
925 extern void afs_cells_timer(struct timer_list *);
926 extern void __net_exit afs_cell_purge(struct afs_net *);
927
928 /*
929  * cmservice.c
930  */
931 extern bool afs_cm_incoming_call(struct afs_call *);
932
933 /*
934  * dir.c
935  */
936 extern const struct file_operations afs_dir_file_operations;
937 extern const struct inode_operations afs_dir_inode_operations;
938 extern const struct address_space_operations afs_dir_aops;
939 extern const struct dentry_operations afs_fs_dentry_operations;
940
941 extern void afs_d_release(struct dentry *);
942 extern void afs_check_for_remote_deletion(struct afs_operation *);
943
944 /*
945  * dir_edit.c
946  */
947 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
948                              enum afs_edit_dir_reason);
949 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
950
951 /*
952  * dir_silly.c
953  */
954 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
955                            struct dentry *, struct key *);
956 extern int afs_silly_iput(struct dentry *, struct inode *);
957
958 /*
959  * dynroot.c
960  */
961 extern const struct inode_operations afs_dynroot_inode_operations;
962 extern const struct dentry_operations afs_dynroot_dentry_operations;
963
964 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
965 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
966 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
967 extern int afs_dynroot_populate(struct super_block *);
968 extern void afs_dynroot_depopulate(struct super_block *);
969
970 /*
971  * file.c
972  */
973 extern const struct address_space_operations afs_fs_aops;
974 extern const struct inode_operations afs_file_inode_operations;
975 extern const struct file_operations afs_file_operations;
976
977 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
978 extern void afs_put_wb_key(struct afs_wb_key *);
979 extern int afs_open(struct inode *, struct file *);
980 extern int afs_release(struct inode *, struct file *);
981 extern int afs_fetch_data(struct afs_vnode *, struct key *, struct afs_read *);
982 extern int afs_page_filler(void *, struct page *);
983 extern void afs_put_read(struct afs_read *);
984
985 static inline struct afs_read *afs_get_read(struct afs_read *req)
986 {
987         refcount_inc(&req->usage);
988         return req;
989 }
990
991 /*
992  * flock.c
993  */
994 extern struct workqueue_struct *afs_lock_manager;
995
996 extern void afs_lock_op_done(struct afs_call *);
997 extern void afs_lock_work(struct work_struct *);
998 extern void afs_lock_may_be_available(struct afs_vnode *);
999 extern int afs_lock(struct file *, int, struct file_lock *);
1000 extern int afs_flock(struct file *, int, struct file_lock *);
1001
1002 /*
1003  * fsclient.c
1004  */
1005 extern void afs_fs_fetch_status(struct afs_operation *);
1006 extern void afs_fs_fetch_data(struct afs_operation *);
1007 extern void afs_fs_create_file(struct afs_operation *);
1008 extern void afs_fs_make_dir(struct afs_operation *);
1009 extern void afs_fs_remove_file(struct afs_operation *);
1010 extern void afs_fs_remove_dir(struct afs_operation *);
1011 extern void afs_fs_link(struct afs_operation *);
1012 extern void afs_fs_symlink(struct afs_operation *);
1013 extern void afs_fs_rename(struct afs_operation *);
1014 extern void afs_fs_store_data(struct afs_operation *);
1015 extern void afs_fs_setattr(struct afs_operation *);
1016 extern void afs_fs_get_volume_status(struct afs_operation *);
1017 extern void afs_fs_set_lock(struct afs_operation *);
1018 extern void afs_fs_extend_lock(struct afs_operation *);
1019 extern void afs_fs_release_lock(struct afs_operation *);
1020 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
1021                                         struct afs_addr_cursor *, struct key *);
1022 extern bool afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
1023                                     struct afs_addr_cursor *, struct key *);
1024 extern void afs_fs_inline_bulk_status(struct afs_operation *);
1025
1026 struct afs_acl {
1027         u32     size;
1028         u8      data[];
1029 };
1030
1031 extern void afs_fs_fetch_acl(struct afs_operation *);
1032 extern void afs_fs_store_acl(struct afs_operation *);
1033
1034 /*
1035  * fs_operation.c
1036  */
1037 extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1038 extern int afs_put_operation(struct afs_operation *);
1039 extern bool afs_begin_vnode_operation(struct afs_operation *);
1040 extern void afs_wait_for_operation(struct afs_operation *);
1041 extern int afs_do_sync_operation(struct afs_operation *);
1042
1043 static inline void afs_op_nomem(struct afs_operation *op)
1044 {
1045         op->error = -ENOMEM;
1046 }
1047
1048 static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1049                                     struct afs_vnode *vnode)
1050 {
1051         op->file[n].vnode = vnode;
1052         op->file[n].need_io_lock = true;
1053 }
1054
1055 static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1056                                   const struct afs_fid *fid)
1057 {
1058         op->file[n].fid = *fid;
1059 }
1060
1061 /*
1062  * fs_probe.c
1063  */
1064 extern void afs_fileserver_probe_result(struct afs_call *);
1065 extern void afs_fs_probe_fileserver(struct afs_net *, struct afs_server *, struct key *, bool);
1066 extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
1067 extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1068 extern void afs_fs_probe_dispatcher(struct work_struct *);
1069 extern int afs_wait_for_one_fs_probe(struct afs_server *, bool);
1070 extern void afs_fs_probe_cleanup(struct afs_net *);
1071
1072 /*
1073  * inode.c
1074  */
1075 extern const struct afs_operation_ops afs_fetch_status_operation;
1076
1077 extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1078 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1079 extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1080 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1081 extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1082 extern struct inode *afs_root_iget(struct super_block *, struct key *);
1083 extern bool afs_check_validity(struct afs_vnode *);
1084 extern int afs_validate(struct afs_vnode *, struct key *);
1085 extern int afs_getattr(const struct path *, struct kstat *, u32, unsigned int);
1086 extern int afs_setattr(struct dentry *, struct iattr *);
1087 extern void afs_evict_inode(struct inode *);
1088 extern int afs_drop_inode(struct inode *);
1089
1090 /*
1091  * main.c
1092  */
1093 extern struct workqueue_struct *afs_wq;
1094 extern int afs_net_id;
1095
1096 static inline struct afs_net *afs_net(struct net *net)
1097 {
1098         return net_generic(net, afs_net_id);
1099 }
1100
1101 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1102 {
1103         return afs_net(AFS_FS_S(sb)->net_ns);
1104 }
1105
1106 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1107 {
1108         return afs_sb2net(dentry->d_sb);
1109 }
1110
1111 static inline struct afs_net *afs_i2net(struct inode *inode)
1112 {
1113         return afs_sb2net(inode->i_sb);
1114 }
1115
1116 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1117 {
1118         return afs_i2net(&vnode->vfs_inode);
1119 }
1120
1121 static inline struct afs_net *afs_sock2net(struct sock *sk)
1122 {
1123         return net_generic(sock_net(sk), afs_net_id);
1124 }
1125
1126 static inline void __afs_stat(atomic_t *s)
1127 {
1128         atomic_inc(s);
1129 }
1130
1131 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1132
1133 /*
1134  * misc.c
1135  */
1136 extern int afs_abort_to_error(u32);
1137 extern void afs_prioritise_error(struct afs_error *, int, u32);
1138
1139 /*
1140  * mntpt.c
1141  */
1142 extern const struct inode_operations afs_mntpt_inode_operations;
1143 extern const struct inode_operations afs_autocell_inode_operations;
1144 extern const struct file_operations afs_mntpt_file_operations;
1145
1146 extern struct vfsmount *afs_d_automount(struct path *);
1147 extern void afs_mntpt_kill_timer(void);
1148
1149 /*
1150  * proc.c
1151  */
1152 #ifdef CONFIG_PROC_FS
1153 extern int __net_init afs_proc_init(struct afs_net *);
1154 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1155 extern int afs_proc_cell_setup(struct afs_cell *);
1156 extern void afs_proc_cell_remove(struct afs_cell *);
1157 extern void afs_put_sysnames(struct afs_sysnames *);
1158 #else
1159 static inline int afs_proc_init(struct afs_net *net) { return 0; }
1160 static inline void afs_proc_cleanup(struct afs_net *net) {}
1161 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1162 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1163 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1164 #endif
1165
1166 /*
1167  * rotate.c
1168  */
1169 extern bool afs_select_fileserver(struct afs_operation *);
1170 extern void afs_dump_edestaddrreq(const struct afs_operation *);
1171
1172 /*
1173  * rxrpc.c
1174  */
1175 extern struct workqueue_struct *afs_async_calls;
1176
1177 extern int __net_init afs_open_socket(struct afs_net *);
1178 extern void __net_exit afs_close_socket(struct afs_net *);
1179 extern void afs_charge_preallocation(struct work_struct *);
1180 extern void afs_put_call(struct afs_call *);
1181 extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
1182 extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1183 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1184                                             const struct afs_call_type *,
1185                                             size_t, size_t);
1186 extern void afs_flat_call_destructor(struct afs_call *);
1187 extern void afs_send_empty_reply(struct afs_call *);
1188 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1189 extern int afs_extract_data(struct afs_call *, bool);
1190 extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1191
1192 static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1193                                     gfp_t gfp)
1194 {
1195         op->call = call;
1196         op->type = call->type;
1197         call->op = op;
1198         call->key = op->key;
1199         call->intr = !(op->flags & AFS_OPERATION_UNINTR);
1200         afs_make_call(&op->ac, call, gfp);
1201 }
1202
1203 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1204 {
1205         call->kvec[0].iov_base = buf;
1206         call->kvec[0].iov_len = size;
1207         iov_iter_kvec(&call->def_iter, READ, call->kvec, 1, size);
1208 }
1209
1210 static inline void afs_extract_to_tmp(struct afs_call *call)
1211 {
1212         afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1213 }
1214
1215 static inline void afs_extract_to_tmp64(struct afs_call *call)
1216 {
1217         afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1218 }
1219
1220 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1221 {
1222         iov_iter_discard(&call->def_iter, READ, size);
1223 }
1224
1225 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1226 {
1227         afs_extract_begin(call, call->buffer, size);
1228 }
1229
1230 static inline int afs_transfer_reply(struct afs_call *call)
1231 {
1232         return afs_extract_data(call, false);
1233 }
1234
1235 static inline bool afs_check_call_state(struct afs_call *call,
1236                                         enum afs_call_state state)
1237 {
1238         return READ_ONCE(call->state) == state;
1239 }
1240
1241 static inline bool afs_set_call_state(struct afs_call *call,
1242                                       enum afs_call_state from,
1243                                       enum afs_call_state to)
1244 {
1245         bool ok = false;
1246
1247         spin_lock_bh(&call->state_lock);
1248         if (call->state == from) {
1249                 call->state = to;
1250                 trace_afs_call_state(call, from, to, 0, 0);
1251                 ok = true;
1252         }
1253         spin_unlock_bh(&call->state_lock);
1254         return ok;
1255 }
1256
1257 static inline void afs_set_call_complete(struct afs_call *call,
1258                                          int error, u32 remote_abort)
1259 {
1260         enum afs_call_state state;
1261         bool ok = false;
1262
1263         spin_lock_bh(&call->state_lock);
1264         state = call->state;
1265         if (state != AFS_CALL_COMPLETE) {
1266                 call->abort_code = remote_abort;
1267                 call->error = error;
1268                 call->state = AFS_CALL_COMPLETE;
1269                 trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1270                                      error, remote_abort);
1271                 ok = true;
1272         }
1273         spin_unlock_bh(&call->state_lock);
1274         if (ok) {
1275                 trace_afs_call_done(call);
1276
1277                 /* Asynchronous calls have two refs to release - one from the alloc and
1278                  * one queued with the work item - and we can't just deallocate the
1279                  * call because the work item may be queued again.
1280                  */
1281                 if (call->drop_ref)
1282                         afs_put_call(call);
1283         }
1284 }
1285
1286 /*
1287  * security.c
1288  */
1289 extern void afs_put_permits(struct afs_permits *);
1290 extern void afs_clear_permits(struct afs_vnode *);
1291 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1292                              struct afs_status_cb *);
1293 extern void afs_zap_permits(struct rcu_head *);
1294 extern struct key *afs_request_key(struct afs_cell *);
1295 extern struct key *afs_request_key_rcu(struct afs_cell *);
1296 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1297 extern int afs_permission(struct inode *, int);
1298 extern void __exit afs_clean_up_permit_cache(void);
1299
1300 /*
1301  * server.c
1302  */
1303 extern spinlock_t afs_server_peer_lock;
1304
1305 extern struct afs_server *afs_find_server(struct afs_net *,
1306                                           const struct sockaddr_rxrpc *);
1307 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1308 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1309 extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1310 extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1311 extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1312 extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1313 extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1314 extern void afs_manage_servers(struct work_struct *);
1315 extern void afs_servers_timer(struct timer_list *);
1316 extern void afs_fs_probe_timer(struct timer_list *);
1317 extern void __net_exit afs_purge_servers(struct afs_net *);
1318 extern bool afs_check_server_record(struct afs_operation *, struct afs_server *);
1319
1320 static inline void afs_inc_servers_outstanding(struct afs_net *net)
1321 {
1322         atomic_inc(&net->servers_outstanding);
1323 }
1324
1325 static inline void afs_dec_servers_outstanding(struct afs_net *net)
1326 {
1327         if (atomic_dec_and_test(&net->servers_outstanding))
1328                 wake_up_var(&net->servers_outstanding);
1329 }
1330
1331 static inline bool afs_is_probing_server(struct afs_server *server)
1332 {
1333         return list_empty(&server->probe_link);
1334 }
1335
1336 /*
1337  * server_list.c
1338  */
1339 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1340 {
1341         refcount_inc(&slist->usage);
1342         return slist;
1343 }
1344
1345 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1346 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1347                                                      struct afs_vldb_entry *,
1348                                                      u8);
1349 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1350
1351 /*
1352  * super.c
1353  */
1354 extern int __init afs_fs_init(void);
1355 extern void afs_fs_exit(void);
1356
1357 /*
1358  * vlclient.c
1359  */
1360 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1361                                                          const char *, int);
1362 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1363 extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
1364                                                 struct key *, struct afs_vlserver *, unsigned int);
1365 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1366 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1367
1368 /*
1369  * vl_alias.c
1370  */
1371 extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1372
1373 /*
1374  * vl_probe.c
1375  */
1376 extern void afs_vlserver_probe_result(struct afs_call *);
1377 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1378 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1379
1380 /*
1381  * vl_rotate.c
1382  */
1383 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1384                                          struct afs_cell *, struct key *);
1385 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1386 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1387 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1388
1389 /*
1390  * vlserver_list.c
1391  */
1392 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1393 {
1394         atomic_inc(&vlserver->usage);
1395         return vlserver;
1396 }
1397
1398 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1399 {
1400         if (vllist)
1401                 atomic_inc(&vllist->usage);
1402         return vllist;
1403 }
1404
1405 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1406 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1407 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1408 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1409 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1410                                                            const void *, size_t);
1411
1412 /*
1413  * volume.c
1414  */
1415 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1416 extern void afs_activate_volume(struct afs_volume *);
1417 extern void afs_deactivate_volume(struct afs_volume *);
1418 extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1419 extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
1420 extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1421
1422 /*
1423  * write.c
1424  */
1425 extern int afs_set_page_dirty(struct page *);
1426 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1427                         loff_t pos, unsigned len, unsigned flags,
1428                         struct page **pagep, void **fsdata);
1429 extern int afs_write_end(struct file *file, struct address_space *mapping,
1430                         loff_t pos, unsigned len, unsigned copied,
1431                         struct page *page, void *fsdata);
1432 extern int afs_writepage(struct page *, struct writeback_control *);
1433 extern int afs_writepages(struct address_space *, struct writeback_control *);
1434 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1435 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1436 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1437 extern void afs_prune_wb_keys(struct afs_vnode *);
1438 extern int afs_launder_page(struct page *);
1439
1440 /*
1441  * xattr.c
1442  */
1443 extern const struct xattr_handler *afs_xattr_handlers[];
1444 extern ssize_t afs_listxattr(struct dentry *, char *, size_t);
1445
1446 /*
1447  * yfsclient.c
1448  */
1449 extern void yfs_fs_fetch_data(struct afs_operation *);
1450 extern void yfs_fs_create_file(struct afs_operation *);
1451 extern void yfs_fs_make_dir(struct afs_operation *);
1452 extern void yfs_fs_remove_file2(struct afs_operation *);
1453 extern void yfs_fs_remove_file(struct afs_operation *);
1454 extern void yfs_fs_remove_dir(struct afs_operation *);
1455 extern void yfs_fs_link(struct afs_operation *);
1456 extern void yfs_fs_symlink(struct afs_operation *);
1457 extern void yfs_fs_rename(struct afs_operation *);
1458 extern void yfs_fs_store_data(struct afs_operation *);
1459 extern void yfs_fs_setattr(struct afs_operation *);
1460 extern void yfs_fs_get_volume_status(struct afs_operation *);
1461 extern void yfs_fs_set_lock(struct afs_operation *);
1462 extern void yfs_fs_extend_lock(struct afs_operation *);
1463 extern void yfs_fs_release_lock(struct afs_operation *);
1464 extern void yfs_fs_fetch_status(struct afs_operation *);
1465 extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1466
1467 struct yfs_acl {
1468         struct afs_acl  *acl;           /* Dir/file/symlink ACL */
1469         struct afs_acl  *vol_acl;       /* Whole volume ACL */
1470         u32             inherit_flag;   /* True if ACL is inherited from parent dir */
1471         u32             num_cleaned;    /* Number of ACEs removed due to subject removal */
1472         unsigned int    flags;
1473 #define YFS_ACL_WANT_ACL        0x01    /* Set if caller wants ->acl */
1474 #define YFS_ACL_WANT_VOL_ACL    0x02    /* Set if caller wants ->vol_acl */
1475 };
1476
1477 extern void yfs_free_opaque_acl(struct yfs_acl *);
1478 extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1479 extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1480
1481 /*
1482  * Miscellaneous inline functions.
1483  */
1484 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1485 {
1486         return container_of(inode, struct afs_vnode, vfs_inode);
1487 }
1488
1489 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1490 {
1491         return &vnode->vfs_inode;
1492 }
1493
1494 /*
1495  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1496  * number derived from the result of the operation.  It doesn't matter if
1497  * d_fsdata goes backwards as we'll just revalidate.
1498  */
1499 static inline void afs_update_dentry_version(struct afs_operation *op,
1500                                              struct afs_vnode_param *dir_vp,
1501                                              struct dentry *dentry)
1502 {
1503         if (!op->error)
1504                 dentry->d_fsdata =
1505                         (void *)(unsigned long)dir_vp->scb.status.data_version;
1506 }
1507
1508 /*
1509  * Check for a conflicting operation on a directory that we just unlinked from.
1510  * If someone managed to sneak a link or an unlink in on the file we just
1511  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1512  */
1513 static inline void afs_check_dir_conflict(struct afs_operation *op,
1514                                           struct afs_vnode_param *dvp)
1515 {
1516         if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1517                 op->flags |= AFS_OPERATION_DIR_CONFLICT;
1518 }
1519
1520 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1521 {
1522         trace_afs_io_error(call->debug_id, -EIO, where);
1523         return -EIO;
1524 }
1525
1526 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1527 {
1528         trace_afs_file_error(vnode, -EIO, where);
1529         return -EIO;
1530 }
1531
1532 /*****************************************************************************/
1533 /*
1534  * debug tracing
1535  */
1536 extern unsigned afs_debug;
1537
1538 #define dbgprintk(FMT,...) \
1539         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1540
1541 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1542 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1543 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1544
1545
1546 #if defined(__KDEBUG)
1547 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1548 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1549 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1550
1551 #elif defined(CONFIG_AFS_DEBUG)
1552 #define AFS_DEBUG_KENTER        0x01
1553 #define AFS_DEBUG_KLEAVE        0x02
1554 #define AFS_DEBUG_KDEBUG        0x04
1555
1556 #define _enter(FMT,...)                                 \
1557 do {                                                    \
1558         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
1559                 kenter(FMT,##__VA_ARGS__);              \
1560 } while (0)
1561
1562 #define _leave(FMT,...)                                 \
1563 do {                                                    \
1564         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
1565                 kleave(FMT,##__VA_ARGS__);              \
1566 } while (0)
1567
1568 #define _debug(FMT,...)                                 \
1569 do {                                                    \
1570         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
1571                 kdebug(FMT,##__VA_ARGS__);              \
1572 } while (0)
1573
1574 #else
1575 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1576 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1577 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1578 #endif
1579
1580 /*
1581  * debug assertion checking
1582  */
1583 #if 1 // defined(__KDEBUGALL)
1584
1585 #define ASSERT(X)                                               \
1586 do {                                                            \
1587         if (unlikely(!(X))) {                                   \
1588                 printk(KERN_ERR "\n");                          \
1589                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1590                 BUG();                                          \
1591         }                                                       \
1592 } while(0)
1593
1594 #define ASSERTCMP(X, OP, Y)                                             \
1595 do {                                                                    \
1596         if (unlikely(!((X) OP (Y)))) {                                  \
1597                 printk(KERN_ERR "\n");                                  \
1598                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1599                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1600                        (unsigned long)(X), (unsigned long)(Y));         \
1601                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1602                        (unsigned long)(X), (unsigned long)(Y));         \
1603                 BUG();                                                  \
1604         }                                                               \
1605 } while(0)
1606
1607 #define ASSERTRANGE(L, OP1, N, OP2, H)                                  \
1608 do {                                                                    \
1609         if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {               \
1610                 printk(KERN_ERR "\n");                                  \
1611                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1612                 printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n", \
1613                        (unsigned long)(L), (unsigned long)(N),          \
1614                        (unsigned long)(H));                             \
1615                 printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1616                        (unsigned long)(L), (unsigned long)(N),          \
1617                        (unsigned long)(H));                             \
1618                 BUG();                                                  \
1619         }                                                               \
1620 } while(0)
1621
1622 #define ASSERTIF(C, X)                                          \
1623 do {                                                            \
1624         if (unlikely((C) && !(X))) {                            \
1625                 printk(KERN_ERR "\n");                          \
1626                 printk(KERN_ERR "AFS: Assertion failed\n");     \
1627                 BUG();                                          \
1628         }                                                       \
1629 } while(0)
1630
1631 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1632 do {                                                                    \
1633         if (unlikely((C) && !((X) OP (Y)))) {                           \
1634                 printk(KERN_ERR "\n");                                  \
1635                 printk(KERN_ERR "AFS: Assertion failed\n");             \
1636                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
1637                        (unsigned long)(X), (unsigned long)(Y));         \
1638                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
1639                        (unsigned long)(X), (unsigned long)(Y));         \
1640                 BUG();                                                  \
1641         }                                                               \
1642 } while(0)
1643
1644 #else
1645
1646 #define ASSERT(X)                               \
1647 do {                                            \
1648 } while(0)
1649
1650 #define ASSERTCMP(X, OP, Y)                     \
1651 do {                                            \
1652 } while(0)
1653
1654 #define ASSERTRANGE(L, OP1, N, OP2, H)          \
1655 do {                                            \
1656 } while(0)
1657
1658 #define ASSERTIF(C, X)                          \
1659 do {                                            \
1660 } while(0)
1661
1662 #define ASSERTIFCMP(C, X, OP, Y)                \
1663 do {                                            \
1664 } while(0)
1665
1666 #endif /* __KDEBUGALL */