| .. | .. |
|---|
| 1 | +/* SPDX-License-Identifier: GPL-2.0-or-later */ |
|---|
| 1 | 2 | /* General filesystem caching interface |
|---|
| 2 | 3 | * |
|---|
| 3 | 4 | * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved. |
|---|
| 4 | 5 | * Written by David Howells (dhowells@redhat.com) |
|---|
| 5 | 6 | * |
|---|
| 6 | | - * This program is free software; you can redistribute it and/or |
|---|
| 7 | | - * modify it under the terms of the GNU General Public License |
|---|
| 8 | | - * as published by the Free Software Foundation; either version |
|---|
| 9 | | - * 2 of the License, or (at your option) any later version. |
|---|
| 10 | | - * |
|---|
| 11 | 7 | * NOTE!!! See: |
|---|
| 12 | 8 | * |
|---|
| 13 | | - * Documentation/filesystems/caching/netfs-api.txt |
|---|
| 9 | + * Documentation/filesystems/caching/netfs-api.rst |
|---|
| 14 | 10 | * |
|---|
| 15 | 11 | * for a description of the network filesystem interface declared here. |
|---|
| 16 | 12 | */ |
|---|
| .. | .. |
|---|
| 230 | 226 | extern void __fscache_disable_cookie(struct fscache_cookie *, const void *, bool); |
|---|
| 231 | 227 | extern void __fscache_enable_cookie(struct fscache_cookie *, const void *, loff_t, |
|---|
| 232 | 228 | bool (*)(void *), void *); |
|---|
| 233 | | -extern void fscache_cookie_init(void); |
|---|
| 234 | 229 | |
|---|
| 235 | 230 | /** |
|---|
| 236 | 231 | * fscache_register_netfs - Register a filesystem as desiring caching services |
|---|
| .. | .. |
|---|
| 238 | 233 | * |
|---|
| 239 | 234 | * Register a filesystem as desiring caching services if they're available. |
|---|
| 240 | 235 | * |
|---|
| 241 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 236 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 242 | 237 | * description. |
|---|
| 243 | 238 | */ |
|---|
| 244 | 239 | static inline |
|---|
| .. | .. |
|---|
| 258 | 253 | * Indicate that a filesystem no longer desires caching services for the |
|---|
| 259 | 254 | * moment. |
|---|
| 260 | 255 | * |
|---|
| 261 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 256 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 262 | 257 | * description. |
|---|
| 263 | 258 | */ |
|---|
| 264 | 259 | static inline |
|---|
| .. | .. |
|---|
| 275 | 270 | * Acquire a specific cache referral tag that can be used to select a specific |
|---|
| 276 | 271 | * cache in which to cache an index. |
|---|
| 277 | 272 | * |
|---|
| 278 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 273 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 279 | 274 | * description. |
|---|
| 280 | 275 | */ |
|---|
| 281 | 276 | static inline |
|---|
| .. | .. |
|---|
| 293 | 288 | * |
|---|
| 294 | 289 | * Release a reference to a cache referral tag previously looked up. |
|---|
| 295 | 290 | * |
|---|
| 296 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 291 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 297 | 292 | * description. |
|---|
| 298 | 293 | */ |
|---|
| 299 | 294 | static inline |
|---|
| .. | .. |
|---|
| 320 | 315 | * that can be used to locate files. This is done by requesting a cookie for |
|---|
| 321 | 316 | * each index in the path to the file. |
|---|
| 322 | 317 | * |
|---|
| 323 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 318 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 324 | 319 | * description. |
|---|
| 325 | 320 | */ |
|---|
| 326 | 321 | static inline |
|---|
| .. | .. |
|---|
| 356 | 351 | * provided to update the auxiliary data in the cache before the object is |
|---|
| 357 | 352 | * disconnected. |
|---|
| 358 | 353 | * |
|---|
| 359 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 354 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 360 | 355 | * description. |
|---|
| 361 | 356 | */ |
|---|
| 362 | 357 | static inline |
|---|
| .. | .. |
|---|
| 399 | 394 | * cookie. The auxiliary data on the cookie will be updated first if @aux_data |
|---|
| 400 | 395 | * is set. |
|---|
| 401 | 396 | * |
|---|
| 402 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 397 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 403 | 398 | * description. |
|---|
| 404 | 399 | */ |
|---|
| 405 | 400 | static inline |
|---|
| .. | .. |
|---|
| 415 | 410 | * |
|---|
| 416 | 411 | * Permit data-storage cache objects to be pinned in the cache. |
|---|
| 417 | 412 | * |
|---|
| 418 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 413 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 419 | 414 | * description. |
|---|
| 420 | 415 | */ |
|---|
| 421 | 416 | static inline |
|---|
| .. | .. |
|---|
| 430 | 425 | * |
|---|
| 431 | 426 | * Permit data-storage cache objects to be unpinned from the cache. |
|---|
| 432 | 427 | * |
|---|
| 433 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 428 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 434 | 429 | * description. |
|---|
| 435 | 430 | */ |
|---|
| 436 | 431 | static inline |
|---|
| .. | .. |
|---|
| 446 | 441 | * changed. This includes the data size. These attributes will be obtained |
|---|
| 447 | 442 | * through the get_attr() cookie definition op. |
|---|
| 448 | 443 | * |
|---|
| 449 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 444 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 450 | 445 | * description. |
|---|
| 451 | 446 | */ |
|---|
| 452 | 447 | static inline |
|---|
| .. | .. |
|---|
| 468 | 463 | * |
|---|
| 469 | 464 | * This can be called with spinlocks held. |
|---|
| 470 | 465 | * |
|---|
| 471 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 466 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 472 | 467 | * description. |
|---|
| 473 | 468 | */ |
|---|
| 474 | 469 | static inline |
|---|
| .. | .. |
|---|
| 484 | 479 | * |
|---|
| 485 | 480 | * Wait for the invalidation of an object to complete. |
|---|
| 486 | 481 | * |
|---|
| 487 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 482 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 488 | 483 | * description. |
|---|
| 489 | 484 | */ |
|---|
| 490 | 485 | static inline |
|---|
| .. | .. |
|---|
| 503 | 498 | * cookie so that a write to that object within the space can always be |
|---|
| 504 | 499 | * honoured. |
|---|
| 505 | 500 | * |
|---|
| 506 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 501 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 507 | 502 | * description. |
|---|
| 508 | 503 | */ |
|---|
| 509 | 504 | static inline |
|---|
| .. | .. |
|---|
| 538 | 533 | * Else, if the page is unbacked, -ENODATA is returned and a block may have |
|---|
| 539 | 534 | * been allocated in the cache. |
|---|
| 540 | 535 | * |
|---|
| 541 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 536 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 542 | 537 | * description. |
|---|
| 543 | 538 | */ |
|---|
| 544 | 539 | static inline |
|---|
| .. | .. |
|---|
| 587 | 582 | * regard to different pages, the return values are prioritised in that order. |
|---|
| 588 | 583 | * Any pages submitted for reading are removed from the pages list. |
|---|
| 589 | 584 | * |
|---|
| 590 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 585 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 591 | 586 | * description. |
|---|
| 592 | 587 | */ |
|---|
| 593 | 588 | static inline |
|---|
| .. | .. |
|---|
| 622 | 617 | * Else, a block will be allocated if one wasn't already, and 0 will be |
|---|
| 623 | 618 | * returned |
|---|
| 624 | 619 | * |
|---|
| 625 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 620 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 626 | 621 | * description. |
|---|
| 627 | 622 | */ |
|---|
| 628 | 623 | static inline |
|---|
| .. | .. |
|---|
| 672 | 667 | * be cleared at the completion of the write to indicate the success or failure |
|---|
| 673 | 668 | * of the operation. Note that the completion may happen before the return. |
|---|
| 674 | 669 | * |
|---|
| 675 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 670 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 676 | 671 | * description. |
|---|
| 677 | 672 | */ |
|---|
| 678 | 673 | static inline |
|---|
| .. | .. |
|---|
| 698 | 693 | * Note that this cannot cancel any outstanding I/O operations between this |
|---|
| 699 | 694 | * page and the cache. |
|---|
| 700 | 695 | * |
|---|
| 701 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 696 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 702 | 697 | * description. |
|---|
| 703 | 698 | */ |
|---|
| 704 | 699 | static inline |
|---|
| .. | .. |
|---|
| 716 | 711 | * |
|---|
| 717 | 712 | * Ask the cache if a page is being written to the cache. |
|---|
| 718 | 713 | * |
|---|
| 719 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 714 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 720 | 715 | * description. |
|---|
| 721 | 716 | */ |
|---|
| 722 | 717 | static inline |
|---|
| .. | .. |
|---|
| 736 | 731 | * Ask the cache to wake us up when a page is no longer being written to the |
|---|
| 737 | 732 | * cache. |
|---|
| 738 | 733 | * |
|---|
| 739 | | - * See Documentation/filesystems/caching/netfs-api.txt for a complete |
|---|
| 734 | + * See Documentation/filesystems/caching/netfs-api.rst for a complete |
|---|
| 740 | 735 | * description. |
|---|
| 741 | 736 | */ |
|---|
| 742 | 737 | static inline |
|---|