mm/readahead: add kerneldoc for read_pages
Subsystems (3)
PATCH 1/1 mm/readahead: add kerneldoc for read_pages
Formalize one of the invariants provided by the current implementation so that callers can depend on it, as discussed in [1].
Cc Andrew Morton <[email protected]>
Signed-off-by Frederick Mayle <[email protected]>
--- mm/readahead.c | 11 +++++++++++ 1 file changed, 11 insertions(+)
mm/readahead.c +11 -0
@@ -146,6 +146,17 @@ file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping) }EXPORT_SYMBOL_GPL (file_ra_state_init); +/** +* read_pages() - Start IO for a contiguous range of allocated folios in the +* page cache. +* @rac: Readahead control. +* +* When read_pages() returns, it is guaranteed that all of the folios will have +* been processed or removed so that ``readahead_count(rac) == 0``. However, +* that does not imply that ``readahead_index(rac)`` will be updated to point +* to the end of the originally requested range because, for example, the +* filesystem may expand the range upwards. +*/ static void read_pages (struct readahead_control *rac) {const struct address_space_operations *aops = rac->mapping->a_ops;
base-commit: 2d565cbaafd43b10b75da56e43e5db9852a56afd
Signature · 1 line
2.54.0.563.g4f69b47b94-goog