summaryrefslogtreecommitdiff
path: root/include/migration/page_cache.h
blob: 87894fea9f11fe73337b9cec7c44995be011fabb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * Page cache for QEMU
 * The cache is base on a hash of the page address
 *
 * Copyright 2012 Red Hat, Inc. and/or its affiliates
 *
 * Authors:
 *  Orit Wasserman  <owasserm@redhat.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */

#ifndef PAGE_CACHE_H
#define PAGE_CACHE_H

/* Page cache for storing guest pages */
typedef struct PageCache PageCache;

/**
 * cache_init: Initialize the page cache
 *
 *
 * Returns new allocated cache or NULL on error
 *
 * @cache pointer to the PageCache struct
 * @num_pages: cache maximal number of cached pages
 * @page_size: cache page size
 */
PageCache *cache_init(int64_t num_pages, unsigned int page_size);

/**
 * cache_fini: free all cache resources
 * @cache pointer to the PageCache struct
 */
void cache_fini(PageCache *cache);

/**
 * cache_is_cached: Checks to see if the page is cached
 *
 * Returns %true if page is cached
 *
 * @cache pointer to the PageCache struct
 * @addr: page addr
 */
bool cache_is_cached(const PageCache *cache, uint64_t addr);

/**
 * get_cached_data: Get the data cached for an addr
 *
 * Returns pointer to the data cached or NULL if not cached
 *
 * @cache pointer to the PageCache struct
 * @addr: page addr
 */
uint8_t *get_cached_data(const PageCache *cache, uint64_t addr);

/**
 * cache_insert: insert the page into the cache. the page cache
 * will dup the data on insert. the previous value will be overwritten
 *
 * @cache pointer to the PageCache struct
 * @addr: page address
 * @pdata: pointer to the page
 */
void cache_insert(PageCache *cache, uint64_t addr, uint8_t *pdata);

/**
 * cache_resize: resize the page cache. In case of size reduction the extra
 * pages will be freed
 *
 * Returns -1 on error new cache size on success
 *
 * @cache pointer to the PageCache struct
 * @num_pages: new page cache size (in pages)
 */
int64_t cache_resize(PageCache *cache, int64_t num_pages);

#endif