x15/vm/rset.h

/*
 * Copyright (c) 2024 Agustina Arzille.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Reverse sets.
 *
 * These sets contain all the virtual -> physical translations that
 * exist for a specific page. They allow users to know whether a page
 * is dirty or has been recently accesed, for instance.
 */

#ifndef VM_RSET_H
#define VM_RSET_H

#include <stdint.h>

#include <kern/init.h>
#include <kern/slist_types.h>
#include <kern/work.h>

struct vm_rset_entry
{
  struct slist_node link;
  struct work work;
  void *pte;
  uintptr_t va;
  uint32_t cpu;
};

struct vm_page;

// Link a page to a PTE.
int vm_rset_page_link (struct vm_page *page, void *pte,
                       uintptr_t va, uint32_t cpu);

/*
 * Remove an RSET entry corresponding to a PTE.
 * The caller is responsible for any locking.
 */
void vm_rset_del (struct vm_page *page, void *pte);

// Mark an RSET - and therefore the page - as read-only.
void vm_rset_mark_ro (struct vm_page *page);

/*
 * This init operation provides :
 *  - module fully initialized
 */
INIT_OP_DECLARE (vm_rset_setup);

#endif