Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2026-08-22 07:01:30 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[common] protocol: define stream descriptors

Browse Source 
Add a transport-neutral wire copy of the LGMP stream descriptor for
embedding in KVMFR subsystem status records.

Keep the common protocol independent of LGMP headers and assert the
field offsets and total size at both C and C++ integration points.
This commit is contained in:
Geoffrey McRae
2026-08-15 13:45:14 +10:00
parent ca5593b139
commit 5ddaa98ea9
1 changed files with 68 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
common/include/common/KVMFRStream.h Normal file
View File

@@ -0,0 +1,68 @@
/**
* Looking Glass
* Copyright © 2017-2026 The Looking Glass Authors
* https://looking-glass.io
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _H_LG_COMMON_KVMFR_STREAM_
#define _H_LG_COMMON_KVMFR_STREAM_
#pragma once
#include <stddef.h>
#include <stdint.h>
/*
* Transport-neutral wire copy of an exported LGMP stream descriptor. Keep
* common protocol headers independent of LGMP; the LGMP transports convert
* this structure field by field at their integration boundary.
*/
typedef struct KVMFRStreamDescriptor
{
uint32_t magic;
uint16_t version;
uint16_t size;
uint32_t offset;
uint32_t regionSize;
uint32_t direction;
uint32_t policy;
uint32_t slotCount;
uint32_t slotSize;
}
KVMFRStreamDescriptor;
#if defined(__cplusplus)
static_assert(offsetof(KVMFRStreamDescriptor, magic) == 0,
"KVMFR stream descriptor magic layout changed");
static_assert(offsetof(KVMFRStreamDescriptor, offset) == 8,
"KVMFR stream descriptor offset layout changed");
static_assert(offsetof(KVMFRStreamDescriptor, slotSize) == 28,
"KVMFR stream descriptor geometry layout changed");
static_assert(sizeof(KVMFRStreamDescriptor) == 32,
"KVMFR stream descriptor layout changed");
#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
_Static_assert(offsetof(KVMFRStreamDescriptor, magic) == 0,
"KVMFR stream descriptor magic layout changed");
_Static_assert(offsetof(KVMFRStreamDescriptor, offset) == 8,
"KVMFR stream descriptor offset layout changed");
_Static_assert(offsetof(KVMFRStreamDescriptor, slotSize) == 28,
"KVMFR stream descriptor geometry layout changed");
_Static_assert(sizeof(KVMFRStreamDescriptor) == 32,
"KVMFR stream descriptor layout changed");
#endif
#endif