blob: 39f156bb1c3b97d0d6ca5b9197cd6fb743fb64ad (
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
|
/** @file
* VD: common definitions for the registration, backend and interface structures.
*/
/*
* Copyright (C) 2016-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* 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, in version 3 of the
* License.
*
* 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, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_vd_common_h
#define VBOX_INCLUDED_vd_common_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/types.h>
/** Makes a VD structure version out of an unique magic value and major &
* minor version numbers.
*
* @returns 32-bit structure version number.
*
* @param uMagic 16-bit magic value. This must be unique.
* @param uMajor 12-bit major version number. Structures with different
* major numbers are not compatible.
* @param uMinor 4-bit minor version number. When only the minor version
* differs, the structures will be 100% backwards
* compatible.
*/
#define VD_VERSION_MAKE(uMagic, uMajor, uMinor) \
( ((uint32_t)(uMagic) << 16) | ((uint32_t)((uMajor) & 0xff) << 4) | ((uint32_t)((uMinor) & 0xf) << 0) )
/** Checks if @a uVerMagic1 is compatible with @a uVerMagic2.
*
* @returns true / false.
* @param uVerMagic1 Typically the runtime version of the struct. This must
* have the same magic and major version as @a uVerMagic2
* and the minor version must be greater or equal to that
* of @a uVerMagic2.
* @param uVerMagic2 Typically the version the code was compiled against.
*
* @remarks The parameters will be referenced more than once.
*/
#define VD_VERSION_ARE_COMPATIBLE(uVerMagic1, uVerMagic2) \
( (uVerMagic1) == (uVerMagic2) \
|| ( (uVerMagic1) >= (uVerMagic2) \
&& ((uVerMagic1) & UINT32_C(0xfffffff0)) == ((uVerMagic2) & UINT32_C(0xfffffff0)) ) \
)
#endif /* !VBOX_INCLUDED_vd_common_h */
|
