drivers/md/bcache/debug.c

File Facts

System

Linux kernel

Corpus path

drivers/md/bcache/debug.c

Extension

.c

Size

5674 bytes

Lines

263

Domain

Driver Families

Bucket

drivers/md

Inferred role

Driver Families: operation-table or driver-model contract

Status

pattern 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 an operation table; this is where Linux turns generic core objects into subsystem-specific behavior.
• Touches user memory; correctness depends on fault-safe copying and privilege boundary handling.
• Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
• Allocates kernel memory; connect allocation flags and lifetime to context constraints.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• bcache.h
• btree.h
• debug.h
• extents.h
• linux/console.h
• linux/debugfs.h
• linux/module.h
• linux/random.h
• linux/seq_file.h

Detected Declarations

• struct dump_iterator
• function block_bytes
• function for_each_written_bset
• function bch_data_verify
• function dump_pred
• function bch_dump_read
• function bch_dump_open
• function bch_dump_release
• function bch_debug_init_cache_set
• function bch_debug_exit
• function bch_debug_init

Annotated Snippet

static const struct file_operations cache_set_debug_ops = {
	.owner		= THIS_MODULE,
	.open		= bch_dump_open,
	.read		= bch_dump_read,
	.release	= bch_dump_release
};

void bch_debug_init_cache_set(struct cache_set *c)
{
	if (!IS_ERR_OR_NULL(bcache_debug)) {
		char name[50];

		snprintf(name, 50, "bcache-%pU", c->set_uuid);
		c->debug = debugfs_create_file(name, 0400, bcache_debug, c,
					       &cache_set_debug_ops);
	}
}

#endif

void bch_debug_exit(void)
{
	debugfs_remove_recursive(bcache_debug);
}

void __init bch_debug_init(void)
{
	/*
	 * it is unnecessary to check return value of
	 * debugfs_create_file(), we should not care
	 * about this.
	 */
	bcache_debug = debugfs_create_dir("bcache", NULL);
}

Annotation

• Immediate include surface: `bcache.h`, `btree.h`, `debug.h`, `extents.h`, `linux/console.h`, `linux/debugfs.h`, `linux/module.h`, `linux/random.h`.
• Detected declarations: `struct dump_iterator`, `function block_bytes`, `function for_each_written_bset`, `function bch_data_verify`, `function dump_pred`, `function bch_dump_read`, `function bch_dump_open`, `function bch_dump_release`, `function bch_debug_init_cache_set`, `function bch_debug_exit`.
• Atlas domain: Driver Families / drivers/md.
• Implementation status: pattern implementation candidate.
• This snippet crosses the user/kernel memory boundary; validate fault handling and access checks before translating the pattern.
• Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.

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.