blob: 47c9eb401c083b5da16e8969a52332e2615dfe47 [file] [log] [blame]
Rusty Russell6b35e402008-02-04 23:50:12 -05001#ifndef _LINUX_VIRTIO_BALLOON_H
2#define _LINUX_VIRTIO_BALLOON_H
Rusty Russell674bfc22008-07-25 12:06:03 -05003/* This header is BSD licensed so anyone can use the definitions to implement
Rusty Russella1b38382011-05-30 11:14:13 -06004 * compatible drivers/servers.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of IBM nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE. */
Michael S. Tsirkindf81b292015-04-15 10:17:43 +093028#include <linux/types.h>
Mikko Rapeli8a7b19d2015-05-30 17:39:25 +020029#include <linux/virtio_types.h>
Christian Borntraegere95646c2009-09-30 11:17:21 +020030#include <linux/virtio_ids.h>
Rusty Russell6b35e402008-02-04 23:50:12 -050031#include <linux/virtio_config.h>
32
Rusty Russell6b35e402008-02-04 23:50:12 -050033/* The feature bitmap for virtio balloon */
34#define VIRTIO_BALLOON_F_MUST_TELL_HOST 0 /* Tell before reclaiming pages */
Adam Litke9564e132009-11-30 10:14:15 -060035#define VIRTIO_BALLOON_F_STATS_VQ 1 /* Memory Stats virtqueue */
Raushaniya Maksudova5a10b7d2014-11-10 09:36:29 +103036#define VIRTIO_BALLOON_F_DEFLATE_ON_OOM 2 /* Deflate balloon on OOM */
Wei Wang86a55972018-08-27 09:32:17 +080037#define VIRTIO_BALLOON_F_FREE_PAGE_HINT 3 /* VQ to report free pages */
Rusty Russell6b35e402008-02-04 23:50:12 -050038
Hollis Blanchard1b4aa2f2008-11-13 15:48:33 -060039/* Size of a PFN in the balloon interface. */
40#define VIRTIO_BALLOON_PFN_SHIFT 12
41
Wei Wang86a55972018-08-27 09:32:17 +080042#define VIRTIO_BALLOON_CMD_ID_STOP 0
43#define VIRTIO_BALLOON_CMD_ID_DONE 1
Michael S. Tsirkin25e65e42015-01-15 13:33:31 +020044struct virtio_balloon_config {
Rusty Russell6b35e402008-02-04 23:50:12 -050045 /* Number of pages host wants Guest to give up. */
Michael S. Tsirkindf81b292015-04-15 10:17:43 +093046 __u32 num_pages;
Rusty Russell6b35e402008-02-04 23:50:12 -050047 /* Number of pages we've actually got in balloon. */
Michael S. Tsirkindf81b292015-04-15 10:17:43 +093048 __u32 actual;
Wei Wang86a55972018-08-27 09:32:17 +080049 /* Free page report command id, readonly by guest */
50 __u32 free_page_report_cmd_id;
Rusty Russell6b35e402008-02-04 23:50:12 -050051};
Adam Litke9564e132009-11-30 10:14:15 -060052
53#define VIRTIO_BALLOON_S_SWAP_IN 0 /* Amount of memory swapped in */
54#define VIRTIO_BALLOON_S_SWAP_OUT 1 /* Amount of memory swapped out */
55#define VIRTIO_BALLOON_S_MAJFLT 2 /* Number of major faults */
56#define VIRTIO_BALLOON_S_MINFLT 3 /* Number of minor faults */
57#define VIRTIO_BALLOON_S_MEMFREE 4 /* Total amount of free memory */
58#define VIRTIO_BALLOON_S_MEMTOT 5 /* Total amount of memory */
Igor Redko5057dcd2016-03-17 14:19:08 -070059#define VIRTIO_BALLOON_S_AVAIL 6 /* Available memory as in /proc */
Tomáš Golembiovský4d320292017-11-12 13:05:38 +010060#define VIRTIO_BALLOON_S_CACHES 7 /* Disk caches */
Jonathan Helman6c64fe72018-03-19 15:14:14 -070061#define VIRTIO_BALLOON_S_HTLB_PGALLOC 8 /* Hugetlb page allocations */
62#define VIRTIO_BALLOON_S_HTLB_PGFAIL 9 /* Hugetlb page allocation failures */
63#define VIRTIO_BALLOON_S_NR 10
Adam Litke9564e132009-11-30 10:14:15 -060064
Michael S. Tsirkinb4000032018-04-13 16:37:04 +030065#define VIRTIO_BALLOON_S_NAMES_WITH_PREFIX(VIRTIO_BALLOON_S_NAMES_prefix) { \
66 VIRTIO_BALLOON_S_NAMES_prefix "swap-in", \
67 VIRTIO_BALLOON_S_NAMES_prefix "swap-out", \
68 VIRTIO_BALLOON_S_NAMES_prefix "major-faults", \
69 VIRTIO_BALLOON_S_NAMES_prefix "minor-faults", \
70 VIRTIO_BALLOON_S_NAMES_prefix "free-memory", \
71 VIRTIO_BALLOON_S_NAMES_prefix "total-memory", \
72 VIRTIO_BALLOON_S_NAMES_prefix "available-memory", \
73 VIRTIO_BALLOON_S_NAMES_prefix "disk-caches", \
74 VIRTIO_BALLOON_S_NAMES_prefix "hugetlb-allocations", \
75 VIRTIO_BALLOON_S_NAMES_prefix "hugetlb-failures" \
76}
77
78#define VIRTIO_BALLOON_S_NAMES VIRTIO_BALLOON_S_NAMES_WITH_PREFIX("")
79
Michael S. Tsirkindf81b292015-04-15 10:17:43 +093080/*
81 * Memory statistics structure.
82 * Driver fills an array of these structures and passes to device.
83 *
84 * NOTE: fields are laid out in a way that would make compiler add padding
85 * between and after fields, so we have to use compiler-specific attributes to
86 * pack it, to disable this padding. This also often causes compiler to
87 * generate suboptimal code.
88 *
89 * We maintain this statistics structure format for backwards compatibility,
90 * but don't follow this example.
91 *
92 * If implementing a similar structure, do something like the below instead:
93 * struct virtio_balloon_stat {
94 * __virtio16 tag;
95 * __u8 reserved[6];
96 * __virtio64 val;
97 * };
98 *
99 * In other words, add explicit reserved fields to align field and
100 * structure boundaries at field size, avoiding compiler padding
101 * without the packed attribute.
102 */
Adam Litke9564e132009-11-30 10:14:15 -0600103struct virtio_balloon_stat {
Michael S. Tsirkindf81b292015-04-15 10:17:43 +0930104 __virtio16 tag;
105 __virtio64 val;
Adam Litke9564e132009-11-30 10:14:15 -0600106} __attribute__((packed));
107
Rusty Russell6b35e402008-02-04 23:50:12 -0500108#endif /* _LINUX_VIRTIO_BALLOON_H */