uvm_page_array.h revision 1.1.2.5 1 1.1.2.3 yamt /* $NetBSD: uvm_page_array.h,v 1.1.2.5 2012/04/18 13:39:28 yamt Exp $ */
2 1.1.2.1 yamt
3 1.1.2.1 yamt /*-
4 1.1.2.1 yamt * Copyright (c)2011 YAMAMOTO Takashi,
5 1.1.2.1 yamt * All rights reserved.
6 1.1.2.1 yamt *
7 1.1.2.1 yamt * Redistribution and use in source and binary forms, with or without
8 1.1.2.1 yamt * modification, are permitted provided that the following conditions
9 1.1.2.1 yamt * are met:
10 1.1.2.1 yamt * 1. Redistributions of source code must retain the above copyright
11 1.1.2.1 yamt * notice, this list of conditions and the following disclaimer.
12 1.1.2.1 yamt * 2. Redistributions in binary form must reproduce the above copyright
13 1.1.2.1 yamt * notice, this list of conditions and the following disclaimer in the
14 1.1.2.1 yamt * documentation and/or other materials provided with the distribution.
15 1.1.2.1 yamt *
16 1.1.2.1 yamt * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 1.1.2.1 yamt * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 1.1.2.1 yamt * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 1.1.2.1 yamt * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 1.1.2.1 yamt * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 1.1.2.1 yamt * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 1.1.2.1 yamt * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 1.1.2.1 yamt * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 1.1.2.1 yamt * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 1.1.2.1 yamt * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 1.1.2.1 yamt * SUCH DAMAGE.
27 1.1.2.1 yamt */
28 1.1.2.1 yamt
29 1.1.2.1 yamt #if !defined(_UVM_UVM_PAGE_ARRAY_H_)
30 1.1.2.1 yamt #define _UVM_UVM_PAGE_ARRAY_H_
31 1.1.2.1 yamt
32 1.1.2.1 yamt /*
33 1.1.2.1 yamt * uvm_page_array: an array of pages.
34 1.1.2.1 yamt *
35 1.1.2.1 yamt * these structure and functions simply manipulate struct vm_page pointers.
36 1.1.2.1 yamt * it's caller's responsibity to acquire and keep the object lock so that
37 1.1.2.1 yamt * the result is valid.
38 1.1.2.1 yamt *
39 1.1.2.1 yamt * typical usage:
40 1.1.2.1 yamt *
41 1.1.2.5 yamt * struct uvm_page_array a;
42 1.1.2.1 yamt *
43 1.1.2.5 yamt * uvm_page_array_init(&a);
44 1.1.2.5 yamt * while ((pg = uvm_page_array_fill_and_peek(&a, uobj, off, ....))
45 1.1.2.2 yamt * != NULL) {
46 1.1.2.3 yamt * off = pg->offset + PAGE_SIZE;
47 1.1.2.1 yamt * do_something(pg);
48 1.1.2.5 yamt * uvm_page_array_advance(&a);
49 1.1.2.1 yamt * }
50 1.1.2.5 yamt * uvm_page_array_fini(&a);
51 1.1.2.1 yamt */
52 1.1.2.1 yamt
53 1.1.2.1 yamt struct vm_page;
54 1.1.2.1 yamt
55 1.1.2.1 yamt struct uvm_page_array {
56 1.1.2.1 yamt struct vm_page *ar_pages[16]; /* XXX tune */
57 1.1.2.1 yamt unsigned int ar_npages; /* valid elements in ar_pages */
58 1.1.2.1 yamt unsigned int ar_idx; /* index in ar_pages */
59 1.1.2.1 yamt };
60 1.1.2.1 yamt
61 1.1.2.1 yamt void uvm_page_array_init(struct uvm_page_array *);
62 1.1.2.1 yamt void uvm_page_array_fini(struct uvm_page_array *);
63 1.1.2.1 yamt void uvm_page_array_clear(struct uvm_page_array *);
64 1.1.2.1 yamt struct vm_page *uvm_page_array_peek(struct uvm_page_array *);
65 1.1.2.1 yamt void uvm_page_array_advance(struct uvm_page_array *);
66 1.1.2.1 yamt int uvm_page_array_fill(struct uvm_page_array *, struct uvm_object *,
67 1.1.2.4 yamt voff_t, unsigned int, unsigned int);
68 1.1.2.2 yamt struct vm_page *uvm_page_array_fill_and_peek(struct uvm_page_array *,
69 1.1.2.4 yamt struct uvm_object *, voff_t, unsigned int, unsigned int);
70 1.1.2.4 yamt
71 1.1.2.4 yamt /*
72 1.1.2.4 yamt * flags for uvm_page_array_fill and uvm_page_array_fill_and_peek
73 1.1.2.4 yamt */
74 1.1.2.4 yamt #define UVM_PAGE_ARRAY_FILL_DIRTYONLY 1 /* skip known-clean pages */
75 1.1.2.4 yamt #define UVM_PAGE_ARRAY_FILL_DENSE 2 /* stop on a hole */
76 1.1.2.4 yamt #define UVM_PAGE_ARRAY_FILL_BACKWARD 4 /* descend order */
77 1.1.2.1 yamt
78 1.1.2.1 yamt #endif /* defined(_UVM_UVM_ARRAY_H_) */
79