1/*	$NetBSD: uvm_pdpolicy.h,v 1.9 2022/08/20 23:26:02 riastradh Exp $	*/
2
3/*-
4 * Copyright (c)2005, 2006 YAMAMOTO Takashi,
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _UVM_PDPOLICY_H_
30#define _UVM_PDPOLICY_H_
31
32#include <sys/mutex.h>
33#include <sys/stdint.h>
34
35#include <uvm/uvm_page.h>
36
37struct krwlock;
38struct uvm_cpu;
39struct vm_anon;
40struct vm_page;
41
42/*
43 * these API is for uvm internal use only.
44 * don't use them directly from outside of /sys/uvm.
45 */
46
47void uvmpdpol_idle(struct uvm_cpu *);
48void uvmpdpol_init(void);
49void uvmpdpol_init_cpu(struct uvm_cpu *);
50void uvmpdpol_reinit(void);
51void uvmpdpol_estimatepageable(int *, int *);
52bool uvmpdpol_needsscan_p(void);
53
54void uvmpdpol_pageactivate(struct vm_page *);
55void uvmpdpol_pagedeactivate(struct vm_page *);
56void uvmpdpol_pagedequeue(struct vm_page *);
57void uvmpdpol_pageenqueue(struct vm_page *);
58bool uvmpdpol_pageactivate_p(struct vm_page *);
59bool uvmpdpol_pageisqueued_p(struct vm_page *);
60void uvmpdpol_pagerealize(struct vm_page *);
61void uvmpdpol_anfree(struct vm_anon *);
62
63void uvmpdpol_tune(void);
64void uvmpdpol_scaninit(void);
65void uvmpdpol_scanfini(void);
66struct vm_page *uvmpdpol_selectvictim(struct krwlock **);
67void uvmpdpol_balancequeue(int);
68
69void uvmpdpol_sysctlsetup(void);
70
71/*
72 * uvmpdpol_set_intent: set an intended state for the page, taking care not
73 * to overwrite any of the other flags.
74 */
75
76static inline void
77uvmpdpol_set_intent(struct vm_page *pg, uint32_t i)
78{
79
80	KASSERT(mutex_owned(&pg->interlock));
81	pg->pqflags = PQ_INTENT_SET | (pg->pqflags & ~PQ_INTENT_MASK) | i;
82}
83
84#endif /* !_UVM_PDPOLICY_H_ */
85