VirtualBox

source: vbox/trunk/include/VBox/vd-common.h@ 69198

Last change on this file since 69198 was 69107, checked in by vboxsync, 7 years ago

include/VBox/: (C) year

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.6 KB
Line 
1/** @file
2 * VD: common definitions for the registration, backend and interface structures.
3 */
4
5/*
6 * Copyright (C) 2016-2017 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 __vd_common_h__
27#define __vd_common_h__
28
29#include <VBox/types.h>
30
31/** Makes a VD structure version out of an unique magic value and major &
32 * minor version numbers.
33 *
34 * @returns 32-bit structure version number.
35 *
36 * @param uMagic 16-bit magic value. This must be unique.
37 * @param uMajor 12-bit major version number. Structures with different
38 * major numbers are not compatible.
39 * @param uMinor 4-bit minor version number. When only the minor version
40 * differs, the structures will be 100% backwards
41 * compatible.
42 */
43#define VD_VERSION_MAKE(uMagic, uMajor, uMinor) \
44 ( ((uint32_t)(uMagic) << 16) | ((uint32_t)((uMajor) & 0xff) << 4) | ((uint32_t)((uMinor) & 0xf) << 0) )
45
46/** Checks if @a uVerMagic1 is compatible with @a uVerMagic2.
47 *
48 * @returns true / false.
49 * @param uVerMagic1 Typically the runtime version of the struct. This must
50 * have the same magic and major version as @a uVerMagic2
51 * and the minor version must be greater or equal to that
52 * of @a uVerMagic2.
53 * @param uVerMagic2 Typically the version the code was compiled against.
54 *
55 * @remarks The parameters will be referenced more than once.
56 */
57#define VD_VERSION_ARE_COMPATIBLE(uVerMagic1, uVerMagic2) \
58 ( (uVerMagic1) == (uVerMagic2) \
59 || ( (uVerMagic1) >= (uVerMagic2) \
60 && ((uVerMagic1) & UINT32_C(0xfffffff0)) == ((uVerMagic2) & UINT32_C(0xfffffff0)) ) \
61 )
62
63#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette