demand_paging.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_KERNEL_MM_DEMAND_PAGING_H
#define ZEPHYR_INCLUDE_KERNEL_MM_DEMAND_PAGING_H
 
#include <zephyr/kernel/mm.h>
 
#include <zephyr/sys/util.h>
#include <zephyr/toolchain.h>
 
#ifndef _ASMLANGUAGE
#include <stdint.h>
#include <stddef.h>
#include <inttypes.h>
#include <zephyr/sys/__assert.h>
 
struct k_mem_page_frame;
 
struct k_mem_paging_stats_t {
#if defined(CONFIG_DEMAND_PAGING_STATS) || defined(__DOXYGEN__)
        struct {
                unsigned long                   cnt;
 
                unsigned long                   irq_locked;
 
                unsigned long                   irq_unlocked;
 
#if !defined(CONFIG_DEMAND_PAGING_ALLOW_IRQ) || defined(__DOXYGEN__)
                unsigned long                   in_isr;
#endif /* !CONFIG_DEMAND_PAGING_ALLOW_IRQ */
        } pagefaults;
 
        struct {
                unsigned long                   clean;
 
                unsigned long                   dirty;
        } eviction;
#endif /* CONFIG_DEMAND_PAGING_STATS */
};
 
struct k_mem_paging_histogram_t {
#if defined(CONFIG_DEMAND_PAGING_TIMING_HISTOGRAM) || defined(__DOXYGEN__)
        /* Counts for each bin in timing histogram */
        unsigned long   counts[CONFIG_DEMAND_PAGING_TIMING_HISTOGRAM_NUM_BINS];
 
        /* Bounds for the bins in timing histogram,
         * excluding the first and last (hence, NUM_SLOTS - 1).
         */
        unsigned long   bounds[CONFIG_DEMAND_PAGING_TIMING_HISTOGRAM_NUM_BINS];
#endif /* CONFIG_DEMAND_PAGING_TIMING_HISTOGRAM */
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
int k_mem_page_out(void *addr, size_t size);
 
void k_mem_page_in(void *addr, size_t size);
 
void k_mem_pin(void *addr, size_t size);
 
void k_mem_unpin(void *addr, size_t size);
 
__syscall void k_mem_paging_stats_get(struct k_mem_paging_stats_t *stats);
 
struct k_thread;
__syscall
void k_mem_paging_thread_stats_get(struct k_thread *thread,
                                   struct k_mem_paging_stats_t *stats);
 
__syscall void k_mem_paging_histogram_eviction_get(
        struct k_mem_paging_histogram_t *hist);
 
__syscall void k_mem_paging_histogram_backing_store_page_in_get(
        struct k_mem_paging_histogram_t *hist);
 
__syscall void k_mem_paging_histogram_backing_store_page_out_get(
        struct k_mem_paging_histogram_t *hist);
 
#include <zephyr/syscalls/demand_paging.h>
 
#if defined(CONFIG_EVICTION_TRACKING) || defined(__DOXYGEN__)
 
void k_mem_paging_eviction_add(struct k_mem_page_frame *pf);
 
void k_mem_paging_eviction_remove(struct k_mem_page_frame *pf);
 
void k_mem_paging_eviction_accessed(uintptr_t phys);
 
#else /* CONFIG_EVICTION_TRACKING || __DOXYGEN__ */
 
static inline void k_mem_paging_eviction_add(struct k_mem_page_frame *pf)
{
        ARG_UNUSED(pf);
}
 
static inline void k_mem_paging_eviction_remove(struct k_mem_page_frame *pf)
{
        ARG_UNUSED(pf);
}
 
static inline void k_mem_paging_eviction_accessed(uintptr_t phys)
{
        ARG_UNUSED(phys);
}
 
#endif /* CONFIG_EVICTION_TRACKING || __DOXYGEN__ */
 
struct k_mem_page_frame *k_mem_paging_eviction_select(bool *dirty);
 
void k_mem_paging_eviction_init(void);
 
int k_mem_paging_backing_store_location_get(struct k_mem_page_frame *pf,
                                            uintptr_t *location,
                                            bool page_fault);
 
void k_mem_paging_backing_store_location_free(uintptr_t location);
 
int k_mem_paging_backing_store_location_query(void *addr, uintptr_t *location);
 
void k_mem_paging_backing_store_page_out(uintptr_t location);
 
void k_mem_paging_backing_store_page_in(uintptr_t location);
 
void k_mem_paging_backing_store_page_finalize(struct k_mem_page_frame *pf,
                                              uintptr_t location);
 
void k_mem_paging_backing_store_init(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* !_ASMLANGUAGE */
#endif /* ZEPHYR_INCLUDE_KERNEL_MM_DEMAND_PAGING_H */