Folio

include/mem/folio.h View source View on GitHub

Structs

folio

struct folio {
    struct page               *base_page;
    _Atomic enum folio_flags  flags;
    uint8_t                   order;
    refcount_t                refcount;
    mapcount_t                mapcount;
    void                      *mapping;
    pgoff_t                   index;
    struct list_head          lru;
};

Enums

folio_flags

enum folio_flags : uint32_t {
    FOLIO_FLAGS_NONE = 0,
    FOLIO_FLAG_ON_LRU = (1u << 0),
    FOLIO_FLAG_ANON = (1u << 1),
    FOLIO_FLAG_MAPPED = (1u << 2),
    FOLIO_FLAG_DIRTY = (1u << 3),
    FOLIO_FLAG_UPTODATE = (1u << 4),
    FOLIO_FLAG_LOCKED = (1u << 5),
};

folio_tag

enum folio_tag : uintptr_t {
    FOLIO_TAG_ADDRESS_SPACE = 0,
    FOLIO_TAG_ANON = 1,
};

Functions

page_get_folio_index

uint32_t page_get_folio_index(struct page *p);

page_is_folio_head

bool page_is_folio_head(struct page *p);

folio_alloc_folio_struct

struct folio * folio_alloc_folio_struct();

folio_free_folio_struct

void folio_free_folio_struct(struct folio *f);

folio_alloc_internal

struct folio * folio_alloc_internal(uint8_t order, enum alloc_flags flags, enum alloc_behavior bh);

folio_free

void folio_free(struct folio *folio);

folio_bind_pages

void folio_bind_pages(struct folio *f);

folio_unbind_pages

void folio_unbind_pages(struct folio *f);

folio_zero

void folio_zero(struct folio *f);

folio_copy

void folio_copy(const struct folio *src, struct folio *dst);

folio_add_lru

void folio_add_lru(struct folio *f);

folio_del_lru

void folio_del_lru(struct folio *f);

page_set_folio

void page_set_folio(struct page *p, struct folio *f);

page_get_folio

struct folio page_get_folio(const struct page *p);

page_clear_folio

void page_clear_folio(struct page *p);

folio_mapped

bool folio_mapped(const struct folio *f);

folio_nr_pages

unsigned long folio_nr_pages(const struct folio *f);

folio_set_tag

void folio_set_tag(struct folio *f, enum folio_tag t);

folio_get_tag

enum folio_tag folio_get_tag(const struct folio *f);

folio_test_flag

bool folio_test_flag(const struct folio *f, enum folio_flags m);

folio_set_flag

void folio_set_flag(struct folio *f, enum folio_flags m);

folio_clear_flag

void folio_clear_flag(struct folio *f, enum folio_flags m);

folio_test_set_flag

bool folio_test_set_flag(struct folio *f, enum folio_flags m);

folio_get

bool folio_get(struct folio *f);

folio_put

void folio_put(struct folio *f);

folio_get_page

struct page folio_get_page(const struct folio *f, size_t n);

folio_get_pfn

pfn_t folio_get_pfn(const struct folio *f);

folio_from_page

struct folio folio_from_page(const struct page *p);

folio_from_paddr

struct folio folio_from_paddr(paddr_t pa);

folio_get_paddr

paddr_t folio_get_paddr(const struct folio *f);

folio_get_vaddr

vaddr_t folio_get_vaddr(const struct folio *f);

folio_get_paddr_for

paddr_t folio_get_paddr_for(const struct folio *f, size_t n);

folio_get_vaddr_for

vaddr_t folio_get_vaddr_for(const struct folio *f, size_t n);

folio_mark_dirty

void folio_mark_dirty(struct folio *f);

folio_mark_uptodate

void folio_mark_uptodate(struct folio *f);

folio_set_anon

void folio_set_anon(struct folio *f, struct anon_vma *av, pgoff_t index);

folio_is_anon

bool folio_is_anon(const struct folio *f);

folio_is_file_vma_range

bool folio_is_file_vma_range(const struct folio *f);

folio_get_anon_vma

struct anon_vma folio_get_anon_vma(const struct folio *f);

folio_get_file_vma_range

struct file_vma_range folio_get_file_vma_range(const struct folio *f);

folio_trylock

bool folio_trylock(struct folio *f);

folio_lock

void folio_lock(struct folio *f);

folio_unlock

void folio_unlock(struct folio *f);

folio_mapcount_inc

void folio_mapcount_inc(struct folio *f);

folio_mapcount_dec

bool folio_mapcount_dec(struct folio *f);

Macros

FOLIO_TAG_BITS

#define FOLIO_TAG_BITS 0x7

folio_for_each_page_struct

#define folio_for_each_page_struct(f, p) \
    for (size_t __i = 0; \
         __i < folio_nr_pages(f) && ((p) = folio_get_page((f), __i), true); \
         __i++)

folio_for_each_page_paddr

#define folio_for_each_page_paddr(f, p) \
    for (size_t __i = 0; __i < folio_nr_pages(f) && \
                         ((p) = folio_get_paddr_for((f), __i), true); \
         __i++)

folio_for_each_page_vaddr

#define folio_for_each_page_vaddr(f, p) \
    for (size_t __i = 0; __i < folio_nr_pages(f) && \
                         ((p) = folio_get_vaddr_for((f), __i), true); \
         __i++)

folio_alloc_1

#define folio_alloc_1(sz) \
    folio_alloc_internal((sz), ALLOC_FLAGS_DEFAULT, ALLOC_BEHAVIOR_DEFAULT)

folio_alloc_2

#define folio_alloc_2(sz, fl) \
    folio_alloc_internal((sz), (fl), ALLOC_BEHAVIOR_DEFAULT)

folio_alloc_3

#define folio_alloc_3(sz, fl, bh) folio_alloc_internal((sz), (fl), (bh))

folio_alloc

#define folio_alloc(...) \
    _DISPATCH(folio_alloc, PP_NARG(__VA_ARGS__))(__VA_ARGS__)

---