drivers/md/dm-vdo/indexer/chapter-index.h

File Facts

System

Linux kernel

Corpus path

drivers/md/dm-vdo/indexer/chapter-index.h

Extension

.h

Size

2153 bytes

Lines

62

Domain

Driver Families

Bucket

drivers/md

Inferred role

Driver Families: implementation source

Status

source implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

• Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• linux/limits.h
• delta-index.h
• geometry.h

Detected Declarations

• struct open_chapter_index

Annotated Snippet

struct open_chapter_index {
	const struct index_geometry *geometry;
	struct delta_index delta_index;
	u64 virtual_chapter_number;
	u64 volume_nonce;
	size_t memory_size;
};

int __must_check uds_make_open_chapter_index(struct open_chapter_index **chapter_index,
					     const struct index_geometry *geometry,
					     u64 volume_nonce);

void uds_free_open_chapter_index(struct open_chapter_index *chapter_index);

void uds_empty_open_chapter_index(struct open_chapter_index *chapter_index,
				  u64 virtual_chapter_number);

int __must_check uds_put_open_chapter_index_record(struct open_chapter_index *chapter_index,
						   const struct uds_record_name *name,
						   u32 page_number);

int __must_check uds_pack_open_chapter_index_page(struct open_chapter_index *chapter_index,
						  u8 *memory, u32 first_list,
						  bool last_page, u32 *lists_packed);

int __must_check uds_initialize_chapter_index_page(struct delta_index_page *index_page,
						   const struct index_geometry *geometry,
						   u8 *page_buffer, u64 volume_nonce);

int __must_check uds_validate_chapter_index_page(const struct delta_index_page *index_page,
						 const struct index_geometry *geometry);

int __must_check uds_search_chapter_index_page(struct delta_index_page *index_page,
					       const struct index_geometry *geometry,
					       const struct uds_record_name *name,
					       u16 *record_page_ptr);

#endif /* UDS_CHAPTER_INDEX_H */

Annotation

• Immediate include surface: `linux/limits.h`, `delta-index.h`, `geometry.h`.
• Detected declarations: `struct open_chapter_index`.
• Atlas domain: Driver Families / drivers/md.
• Implementation status: source implementation candidate.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.