Lines Matching +full:wait +full:- +full:pin

1 .. SPDX-License-Identifier: GPL-2.0
7 The FS-Cache system provides an API by which actual caches can be supplied to
8 FS-Cache for it to then serve out to network filesystems and other interested
11 	#include <linux/fscache-cache.h>.
29 pin the cache during access in addition to acting as reference points for the
34 The cache backend and the network filesystem can both ask for cache cookies -
102 This moves the cache to the withdrawn state to prevent new cache- and
103 volume-level accesses from starting and then waits for outstanding cache-level
113 wait for completion by calling::
152    * ``cache`` - The parent cache cookie.
154    * ``cache_priv`` - A place for the cache to stash private data.
156    * ``debug_id`` - A debugging ID for logging in tracepoints.
158    * ``key`` - A printable string with no '/' characters in it that represents
159      the index key for the volume.  The key is NUL-terminated and padded out to
162    * ``key_hash`` - A hash of the index key.  This should work out the same, no
165    * ``coherency`` - A piece of coherency data that should be checked when the
168    * ``coherency_len`` - The amount of data in the coherency buffer.
194    * ``volume`` - The parent volume cookie.
196    * ``cache_priv`` - A place for the cache to stash private data.
198    * ``flags`` - A collection of bit flags, including:
200       * FSCACHE_COOKIE_NO_DATA_TO_READ - There is no data available in the
203       * FSCACHE_COOKIE_NEEDS_UPDATE - The coherency data and/or object size has
206       * FSCACHE_COOKIE_LOCAL_WRITE - The netfs's data has been modified
210       * FSCACHE_COOKIE_HAVE_DATA - The backend should set this if it
213       * FSCACHE_COOKIE_RETIRED - The cookie was invalidated when it was
216    * ``debug_id`` - A debugging ID for logging in tracepoints.
218    * ``inval_counter`` - The number of invalidations done on the cookie.
220    * ``advice`` - Information about how the cookie is to be used.
222    * ``key_hash`` - A hash of the index key.  This should work out the same, no
225    * ``key_len`` - The length of the index key.
227    * ``aux_len`` - The length of the coherency data buffer.
259 The wait function can be used during the withdrawal procedure to wait for
285      holds a cache-level access pin to prevent the cache from going away for
306      volume-level access pin in the cache to prevent it from being withdrawn.
320      If successful, ``cookie->cache_priv`` can be set.
329      by the cache backend or closed after a period of non-use by fscache.
332      non-reentrant work item to manage races between the various ways
349      The caller holds a cookie-level access pin to prevent a race with
350      withdrawal and the netfs must have the cookie marked in-use to prevent
358      This is called when the network filesystem detects a third-party
390      or resize).  The caller holds an access pin on the cookie and must have
391      marked the cookie as in-use.
401 	* ``FSCACHE_WANT_PARAMS`` - The caller just wants to access cache
404 	* ``FSCACHE_WANT_READ`` - The caller wants to read data.
406 	* ``FSCACHE_WANT_WRITE`` - The caller wants to write to or resize the
426 FS-Cache provides some utilities that a cache backend may make use of:
432      This tells FS-Cache that an I/O error occurred in the cache.  This
454    * Count out-of-space errors::
479 .. kernel-doc:: include/linux/fscache-cache.h