lib/cache_maint.c
Source file repositories/reference/linux-study-clean/lib/cache_maint.c
File Facts
- System
- Linux kernel
- Corpus path
lib/cache_maint.c- Extension
.c- Size
- 3782 bytes
- Lines
- 139
- Domain
- Kernel Services
- Bucket
- lib
- Inferred role
- Kernel Services: exported/initcall integration point
- Status
- integration implementation candidate
Why This File Exists
Shared kernel service surface used by multiple subsystems, including helpers, cryptography, virtualization support, and async I/O infrastructure.
- Shared kernel service surface used by multiple subsystems, including helpers, cryptography, virtualization support, and async I/O infrastructure.
- Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
- 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
linux/cache_coherency.hlinux/cleanup.hlinux/container_of.hlinux/export.hlinux/kref.hlinux/list.hlinux/memregion.hlinux/module.hlinux/rwsem.hlinux/slab.h
Detected Declarations
function __cache_coherency_ops_instance_freefunction cache_coherency_ops_instance_putfunction cache_inval_onefunction cache_inval_done_onefunction cache_invalidate_memregionfunction _cache_coherency_ops_instance_allocfunction cache_coherency_ops_instance_registerfunction cache_coherency_ops_instance_unregisterfunction cpu_cache_invalidate_memregionfunction cpu_cache_has_invalidate_memregionexport cache_coherency_ops_instance_put
Annotated Snippet
// SPDX-License-Identifier: GPL-2.0
/*
* Generic support for Memory System Cache Maintenance operations.
*
* Coherency maintenance drivers register with this simple framework that will
* iterate over each registered instance to first kick off invalidation and
* then to wait until it is complete.
*
* If no implementations are registered yet cpu_cache_has_invalidate_memregion()
* will return false. If this runs concurrently with unregistration then a
* race exists but this is no worse than the case where the operations instance
* responsible for a given memory region has not yet registered.
*/
#include <linux/cache_coherency.h>
#include <linux/cleanup.h>
#include <linux/container_of.h>
#include <linux/export.h>
#include <linux/kref.h>
#include <linux/list.h>
#include <linux/memregion.h>
#include <linux/module.h>
#include <linux/rwsem.h>
#include <linux/slab.h>
static LIST_HEAD(cache_ops_instance_list);
static DECLARE_RWSEM(cache_ops_instance_list_lock);
static void __cache_coherency_ops_instance_free(struct kref *kref)
{
struct cache_coherency_ops_inst *cci =
container_of(kref, struct cache_coherency_ops_inst, kref);
kfree(cci);
}
void cache_coherency_ops_instance_put(struct cache_coherency_ops_inst *cci)
{
kref_put(&cci->kref, __cache_coherency_ops_instance_free);
}
EXPORT_SYMBOL_GPL(cache_coherency_ops_instance_put);
static int cache_inval_one(struct cache_coherency_ops_inst *cci, void *data)
{
if (!cci->ops)
return -EINVAL;
return cci->ops->wbinv(cci, data);
}
static int cache_inval_done_one(struct cache_coherency_ops_inst *cci)
{
if (!cci->ops)
return -EINVAL;
if (!cci->ops->done)
return 0;
return cci->ops->done(cci);
}
static int cache_invalidate_memregion(phys_addr_t addr, size_t size)
{
int ret;
struct cache_coherency_ops_inst *cci;
struct cc_inval_params params = {
.addr = addr,
.size = size,
};
guard(rwsem_read)(&cache_ops_instance_list_lock);
list_for_each_entry(cci, &cache_ops_instance_list, node) {
ret = cache_inval_one(cci, ¶ms);
if (ret)
return ret;
}
list_for_each_entry(cci, &cache_ops_instance_list, node) {
ret = cache_inval_done_one(cci);
if (ret)
return ret;
}
return 0;
}
struct cache_coherency_ops_inst *
_cache_coherency_ops_instance_alloc(const struct cache_coherency_ops *ops,
size_t size)
{
struct cache_coherency_ops_inst *cci;
if (!ops || !ops->wbinv)
Annotation
- Immediate include surface: `linux/cache_coherency.h`, `linux/cleanup.h`, `linux/container_of.h`, `linux/export.h`, `linux/kref.h`, `linux/list.h`, `linux/memregion.h`, `linux/module.h`.
- Detected declarations: `function __cache_coherency_ops_instance_free`, `function cache_coherency_ops_instance_put`, `function cache_inval_one`, `function cache_inval_done_one`, `function cache_invalidate_memregion`, `function _cache_coherency_ops_instance_alloc`, `function cache_coherency_ops_instance_register`, `function cache_coherency_ops_instance_unregister`, `function cpu_cache_invalidate_memregion`, `function cpu_cache_has_invalidate_memregion`.
- Atlas domain: Kernel Services / lib.
- Implementation status: integration 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.