mirror of
https://gitlab.uni-freiburg.de/opensourcevdi/spice-protocol
synced 2025-12-26 14:18:31 +00:00
f6e4cb65da
The SpiceStat structure can be 20 or 24 bytes depending on alignment. Being a memory mapped structure potentially used with lockless access, it is not good to have it unaligned. The only tool that we know of that reads this memory mapped file (reds_stats) is able to detect if the structure is either 20 or 24 bytes and act accordingly so changing this structure won't affect the behaviour (unless you have an old tool but as they are usually packaged together this is quite improbable). This will also help on Windows as in that system it is not possible for reds_stats to implement the same discovery trick implemented on Linux. On Windows it is not possible to read the size of the file mapping (on Windows to implement shared memory you can use a file mapping not associated to a file). The structure will change layout only on 32-bit architectures which is not recommended nowadays (the 64-bit platforms that we support align 64-bit integers to 64 bits). Signed-off-by: Frediano Ziglio <fziglio@redhat.com> Acked-by: Christophe Fergeau <cfergeau@redhat.com>
71 lines
2.6 KiB
C
71 lines
2.6 KiB
C
/*
|
|
Copyright (C) 2009 Red Hat, Inc.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in
|
|
the documentation and/or other materials provided with the
|
|
distribution.
|
|
* Neither the name of the copyright holder nor the names of its
|
|
contributors may be used to endorse or promote products derived
|
|
from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
|
|
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
|
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _H_SPICE_STATS
|
|
#define _H_SPICE_STATS
|
|
|
|
#include <spice/macros.h>
|
|
#include <spice/types.h>
|
|
|
|
#define SPICE_STAT_SHM_NAME "/spice.%u"
|
|
#define SPICE_STAT_NODE_NAME_MAX 20
|
|
#define SPICE_STAT_MAGIC SPICE_MAGIC_CONST("STAT")
|
|
#define SPICE_STAT_VERSION 1
|
|
|
|
enum {
|
|
SPICE_STAT_NODE_FLAG_ENABLED = (1 << 0),
|
|
SPICE_STAT_NODE_FLAG_VISIBLE = (1 << 1),
|
|
SPICE_STAT_NODE_FLAG_VALUE = (1 << 2),
|
|
};
|
|
|
|
#define SPICE_STAT_NODE_MASK_SHOW (SPICE_STAT_NODE_FLAG_ENABLED | SPICE_STAT_NODE_FLAG_VISIBLE)
|
|
#define SPICE_STAT_NODE_MASK_SHOW_VALUE (SPICE_STAT_NODE_MASK_SHOW | SPICE_STAT_NODE_FLAG_VALUE)
|
|
|
|
typedef struct SpiceStatNode {
|
|
uint64_t value;
|
|
uint32_t flags;
|
|
uint32_t next_sibling_index;
|
|
uint32_t first_child_index;
|
|
char name[SPICE_STAT_NODE_NAME_MAX];
|
|
} SpiceStatNode;
|
|
|
|
typedef struct SpiceStat {
|
|
uint32_t magic;
|
|
uint32_t version;
|
|
uint32_t generation;
|
|
uint32_t num_of_nodes;
|
|
uint32_t root_index;
|
|
/* to avoid holes in the structure on some platforms */
|
|
uint32_t padding;
|
|
SpiceStatNode nodes[];
|
|
} SpiceStat;
|
|
|
|
#endif /* _H_SPICE_STATS */
|