| 1 | /** @file
|
|---|
| 2 | * VD: common definitions for the registration, backend and interface structures.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2016-2022 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef VBOX_INCLUDED_vd_common_h
|
|---|
| 27 | #define VBOX_INCLUDED_vd_common_h
|
|---|
| 28 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 29 | # pragma once
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | #include <VBox/types.h>
|
|---|
| 33 |
|
|---|
| 34 | /** Makes a VD structure version out of an unique magic value and major &
|
|---|
| 35 | * minor version numbers.
|
|---|
| 36 | *
|
|---|
| 37 | * @returns 32-bit structure version number.
|
|---|
| 38 | *
|
|---|
| 39 | * @param uMagic 16-bit magic value. This must be unique.
|
|---|
| 40 | * @param uMajor 12-bit major version number. Structures with different
|
|---|
| 41 | * major numbers are not compatible.
|
|---|
| 42 | * @param uMinor 4-bit minor version number. When only the minor version
|
|---|
| 43 | * differs, the structures will be 100% backwards
|
|---|
| 44 | * compatible.
|
|---|
| 45 | */
|
|---|
| 46 | #define VD_VERSION_MAKE(uMagic, uMajor, uMinor) \
|
|---|
| 47 | ( ((uint32_t)(uMagic) << 16) | ((uint32_t)((uMajor) & 0xff) << 4) | ((uint32_t)((uMinor) & 0xf) << 0) )
|
|---|
| 48 |
|
|---|
| 49 | /** Checks if @a uVerMagic1 is compatible with @a uVerMagic2.
|
|---|
| 50 | *
|
|---|
| 51 | * @returns true / false.
|
|---|
| 52 | * @param uVerMagic1 Typically the runtime version of the struct. This must
|
|---|
| 53 | * have the same magic and major version as @a uVerMagic2
|
|---|
| 54 | * and the minor version must be greater or equal to that
|
|---|
| 55 | * of @a uVerMagic2.
|
|---|
| 56 | * @param uVerMagic2 Typically the version the code was compiled against.
|
|---|
| 57 | *
|
|---|
| 58 | * @remarks The parameters will be referenced more than once.
|
|---|
| 59 | */
|
|---|
| 60 | #define VD_VERSION_ARE_COMPATIBLE(uVerMagic1, uVerMagic2) \
|
|---|
| 61 | ( (uVerMagic1) == (uVerMagic2) \
|
|---|
| 62 | || ( (uVerMagic1) >= (uVerMagic2) \
|
|---|
| 63 | && ((uVerMagic1) & UINT32_C(0xfffffff0)) == ((uVerMagic2) & UINT32_C(0xfffffff0)) ) \
|
|---|
| 64 | )
|
|---|
| 65 |
|
|---|
| 66 | #endif /* !VBOX_INCLUDED_vd_common_h */
|
|---|
