1 /*
2    Copyright (C) 2009 Red Hat, Inc.
3 
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions are
6    met:
7 
8        * Redistributions of source code must retain the above copyright
9          notice, this list of conditions and the following disclaimer.
10        * Redistributions in binary form must reproduce the above copyright
11          notice, this list of conditions and the following disclaimer in
12          the documentation and/or other materials provided with the
13          distribution.
14        * Neither the name of the copyright holder nor the names of its
15          contributors may be used to endorse or promote products derived
16          from this software without specific prior written permission.
17 
18    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
19    IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
21    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22    HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 
31 #ifndef _H_SPICE_STATS
32 #define _H_SPICE_STATS
33 
34 #include <spice/macros.h>
35 #include <spice/types.h>
36 
37 #define SPICE_STAT_SHM_NAME "/spice.%u"
38 #define SPICE_STAT_NODE_NAME_MAX 20
39 #define SPICE_STAT_MAGIC SPICE_MAGIC_CONST("STAT")
40 #define SPICE_STAT_VERSION 1
41 
42 enum {
43     SPICE_STAT_NODE_FLAG_ENABLED = (1 << 0),
44     SPICE_STAT_NODE_FLAG_VISIBLE = (1 << 1),
45     SPICE_STAT_NODE_FLAG_VALUE = (1 << 2),
46 };
47 
48 #define SPICE_STAT_NODE_MASK_SHOW (SPICE_STAT_NODE_FLAG_ENABLED | SPICE_STAT_NODE_FLAG_VISIBLE)
49 #define SPICE_STAT_NODE_MASK_SHOW_VALUE (SPICE_STAT_NODE_MASK_SHOW | SPICE_STAT_NODE_FLAG_VALUE)
50 
51 typedef struct SpiceStatNode {
52     uint64_t value;
53     uint32_t flags;
54     uint32_t next_sibling_index;
55     uint32_t first_child_index;
56     char name[SPICE_STAT_NODE_NAME_MAX];
57 } SpiceStatNode;
58 
59 typedef struct SpiceStat {
60     uint32_t magic;
61     uint32_t version;
62     uint32_t generation;
63     uint32_t num_of_nodes;
64     uint32_t root_index;
65     /* to avoid holes in the structure on some platforms */
66     uint32_t padding;
67     SpiceStatNode nodes[];
68 } SpiceStat;
69 
70 #endif /* _H_SPICE_STATS */
71