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