include/linux/memregion.h
Source file repositories/reference/linux-study-clean/include/linux/memregion.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/memregion.h- Extension
.h- Size
- 2075 bytes
- Lines
- 72
- Domain
- Core OS
- Bucket
- Core Kernel Interface
- Inferred role
- Core OS: implementation source
- Status
- source implementation candidate
Why This File Exists
Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
- Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/types.hlinux/errno.hlinux/range.hlinux/bug.h
Detected Declarations
struct memregion_infofunction memregion_allocfunction memregion_freefunction cpu_cache_has_invalidate_memregionfunction cpu_cache_invalidate_memregionfunction cpu_cache_invalidate_all
Annotated Snippet
struct memregion_info {
int target_node;
struct range range;
};
#ifdef CONFIG_MEMREGION
int memregion_alloc(gfp_t gfp);
void memregion_free(int id);
#else
static inline int memregion_alloc(gfp_t gfp)
{
return -ENOMEM;
}
static inline void memregion_free(int id)
{
}
#endif
/**
* cpu_cache_invalidate_memregion - drop any CPU cached data for
* memregion
* @start: start physical address of the target memory region.
* @len: length of the target memory region. -1 for all the regions of
* the target type.
*
* Perform cache maintenance after a memory event / operation that
* changes the contents of physical memory in a cache-incoherent manner.
* For example, device memory technologies like NVDIMM and CXL have
* device secure erase, and dynamic region provision that can replace
* the memory mapped to a given physical address.
*
* Limit the functionality to architectures that have an efficient way
* to writeback and invalidate potentially terabytes of address space at
* once. Note that this routine may or may not write back any dirty
* contents while performing the invalidation. It is only exported for
* the explicit usage of the NVDIMM and CXL modules in the 'DEVMEM'
* symbol namespace on bare platforms.
*
* Returns 0 on success or negative error code on a failure to perform
* the cache maintenance.
*/
#ifdef CONFIG_ARCH_HAS_CPU_CACHE_INVALIDATE_MEMREGION
int cpu_cache_invalidate_memregion(phys_addr_t start, size_t len);
bool cpu_cache_has_invalidate_memregion(void);
#else
static inline bool cpu_cache_has_invalidate_memregion(void)
{
return false;
}
static inline int cpu_cache_invalidate_memregion(phys_addr_t start, size_t len)
{
WARN_ON_ONCE("CPU cache invalidation required");
return -ENXIO;
}
#endif
static inline int cpu_cache_invalidate_all(void)
{
return cpu_cache_invalidate_memregion(0, -1);
}
#endif /* _MEMREGION_H_ */
Annotation
- Immediate include surface: `linux/types.h`, `linux/errno.h`, `linux/range.h`, `linux/bug.h`.
- Detected declarations: `struct memregion_info`, `function memregion_alloc`, `function memregion_free`, `function cpu_cache_has_invalidate_memregion`, `function cpu_cache_invalidate_memregion`, `function cpu_cache_invalidate_all`.
- Atlas domain: Core OS / Core Kernel Interface.
- 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.