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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*
* Copyright (c) 2013-2014 TRUSTONIC LIMITED
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. Neither the name of the TRUSTONIC LIMITED 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 HOLDERS 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 MCVERSIONHELPER_H_
#define MCVERSIONHELPER_H_
#include <stdio.h>
/** Create a version number given major and minor numbers. */
#define MC_MAKE_VERSION(major,minor) \
( (((major) & 0xffff) << 16) |\
((minor) & 0xffff))
/** Get major version number from complete version. */
#define MC_GET_MAJOR_VERSION(version) ((version) >> 16)
/** Get minor version number from complete version. */
#define MC_GET_MINOR_VERSION(version) ((version) & 0xffff)
// Asserts expression at compile-time (to be used outside a function body).
#define ASSERT_VERSION_IMPLEMENTATION(comp, versionpart, requiredV, actualV, expression) \
extern int Actual_##comp##_##versionpart##_VERSION_##actualV##_does_not_match_required_version_##requiredV[(expression) ? 0:-1]
#define ASSERT_VERSION_EVALUATOR(comp, versionpart, requiredV, actualV, expression) \
ASSERT_VERSION_IMPLEMENTATION(comp, versionpart, requiredV, actualV, expression)
#define ASSERT_VERSION(required, comparator, comp, versionpart) \
ASSERT_VERSION_EVALUATOR(comp, versionpart, required, comp ##_VERSION_## versionpart, required comparator comp ##_VERSION_## versionpart)
/** Checks at compile-time that an interface version provided by component
* 'comp' is identical to the required version of a component using this interface.
* Note! This check is useful for components that IMPLEMENT a particular
* interface to be alerted of changes to the interface which are likely to
* require adaptations in the implementation. */
#define MC_CHECK_VERSION_EQUALS(comp, major, minor) \
ASSERT_VERSION(major, ==, comp, MAJOR); \
ASSERT_VERSION(minor, ==, comp, MINOR);
/** Checks at compile-time that an interface version provided by component 'comp' meets the
* required version of a component using this interface. */
#define MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
ASSERT_VERSION(majorRequired, ==, comp, MAJOR); \
ASSERT_VERSION(minorRequired, <=, comp, MINOR);
/** Version check helper macro for an interface consumer against an interface
* provider.
* @param comp Name of Interface to check.
* @param majorRequired Required major version of interface provider.
* @param minorRequired Required minor version of interface provider.
* Performs a compile-time interface version check that comp_VERSION_MAJOR
* equals majorRequired and that comp_VERSION_MINOR is at least minorRequired.
* On success, compilation goes through.
* On error, compilation breaks, telling the component that did not match in the
* error message.
*
* Additionally, a function is created:
*
* checkVersionOk##component(uint32_t version, char** errmsg)
*
* Compares version against majorRequired and minorRequired.
* Additionally, it creates a message string that can be printed out using printf("%s", errmsg).
* It returns either only the actual version, or on mismatch, actual and required version.
*
* @param version[in] component version as returned by layer-specific getVersion.
* @param errmsg[out] a message string that contains a log.
*
*/
#if !defined(NDEBUG)
#if !defined(TRUSTLET)
#define MC_CHECK_VERSION(comp, majorRequired, minorRequired) \
MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
static uint32_t checkVersionOk##comp(uint32_t version, char** errmsg) { \
static char msgBuf[100]; \
uint32_t major = MC_GET_MAJOR_VERSION(version); \
uint32_t minor = MC_GET_MINOR_VERSION(version); \
uint32_t ret = 0; \
*errmsg = msgBuf; \
if ((major == majorRequired) && (minor >= minorRequired)) { \
snprintf(msgBuf, sizeof(msgBuf), \
#comp " version is %u.%u", major, minor); \
ret = 1; \
} else { \
snprintf(msgBuf, sizeof(msgBuf), \
#comp " version error. Got: %u.%u, want >= %u.%u", major, minor, majorRequired, minorRequired); \
} \
msgBuf[sizeof(msgBuf) - 1] = '\0'; \
return ret; \
}
#else /* TRUSTLET */
#define MC_CHECK_VERSION(comp, majorRequired, minorRequired) \
MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
static uint32_t checkVersionOk##comp(uint32_t version, char** errmsg) { \
uint32_t major = MC_GET_MAJOR_VERSION(version); \
uint32_t minor = MC_GET_MINOR_VERSION(version); \
*errmsg = NULL; \
if ((major == majorRequired) && (minor >= minorRequired)) { \
tlDbgPrintf(#comp " version is %u.%u", major, minor); \
return 1; \
} else { \
tlDbgPrintf( \
#comp " version error. Got: %u.%u, want >= %u.%u", major, minor, majorRequired, minorRequired); \
} \
return 0; \
}
#endif /* TRUSTLET */
#else
#define MC_CHECK_VERSION(comp, majorRequired, minorRequired) \
MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
static uint32_t checkVersionOk##comp(uint32_t version, char** errmsg) { \
uint32_t major = MC_GET_MAJOR_VERSION(version); \
uint32_t minor = MC_GET_MINOR_VERSION(version); \
*errmsg = NULL; \
if ((major == majorRequired) && ((minor == minorRequired) || (minor > minorRequired))) { \
return 1; \
}; \
return 0; \
}
#endif
/** Version check helper macro for version checks of a data object version
* against an data object consumer.
*
* @param comp Name of Interface to check.
* @param majorRequired Major data object version supported by component.
* @param minorRequired Minor data object version supported by component.
* Performs a compile-time interface version check that comp_VERSION_MAJOR
* equals majorRequired and that comp_VERSION_MINOR is at least minorRequired.
* On success, compilation goes through.
* On error, compilation breaks, telling the component that did not match in the
* error message.
*
* Additionally, the following function is created:
*
* checkVersionOkDataObject##component(uint32_t version, char** errmsg)
*
* This function checks that the data object version is compatible with the
* interface version; that is, the major version of the data object must match
* exactly and the minor version of the data object MUST BE LESS OR EQUAL to the
* required interface version.
* Additionally, it creates a message string that can be printed out using printf("%s", errmsg).
* It returns either only the actual version, or on mismatch, actual and
* provided version.
*
* @param version[in] Data object version of data object.
* @param errmsg[out] a message string that contains a log.
*
*/
#if !defined(NDEBUG)
#if !defined(TRUSTLET)
#define MC_CHECK_DATA_OBJECT_VERSION(comp, majorRequired, minorRequired) \
MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
static uint32_t checkVersionOkDataObject##comp(uint32_t version, char** errmsg) { \
static char msgBuf[100]; \
uint32_t major = MC_GET_MAJOR_VERSION(version); \
uint32_t minor = MC_GET_MINOR_VERSION(version); \
uint32_t ret = 0; \
*errmsg = msgBuf; \
if ((major == majorRequired) && (minor <= minorRequired)) { \
snprintf(msgBuf, sizeof(msgBuf), \
#comp " version is %u.%u", major, minor); \
ret = 1; \
} else { \
snprintf(msgBuf, sizeof(msgBuf), \
#comp " version error. Got: %u.%u, want <= %u.%u", major, minor, majorRequired, minorRequired); \
} \
msgBuf[sizeof(msgBuf) - 1] = '\0'; \
return ret; \
}
#else /* TRUSTLET */
#define MC_CHECK_DATA_OBJECT_VERSION(comp, majorRequired, minorRequired) \
MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
static uint32_t checkVersionOkDataObject##comp(uint32_t version, char** errmsg) { \
uint32_t major = MC_GET_MAJOR_VERSION(version); \
uint32_t minor = MC_GET_MINOR_VERSION(version); \
*errmsg = NULL; \
if ((major == majorRequired) && (minor <= minorRequired)) { \
tlDbgPrintf(#comp " version is %u.%u", major, minor); \
return 1; \
} else { \
tlDbgPrintf( \
#comp " version error. Got: %u.%u, want <= %u.%u", major, minor, majorRequired, minorRequired); \
} \
return 0; \
}
#endif /* TRUSTLET */
#else
#define MC_CHECK_DATA_OBJECT_VERSION(comp, majorRequired, minorRequired) \
MC_CHECK_VERSION_STATIC(comp, majorRequired, minorRequired) \
static uint32_t checkVersionOkDataObject##comp(uint32_t version, char** errmsg) { \
uint32_t major = MC_GET_MAJOR_VERSION(version); \
uint32_t minor = MC_GET_MINOR_VERSION(version); \
*errmsg = NULL; \
if ((major == majorRequired) && (minor <= minorRequired)) { \
return 1; \
}; \
return 0; \
}
#endif
#endif // MCVERSIONHELPER_H_
|
