1 /* 2 * Copyright 2019-2024 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the Apache License 2.0 (the "License"). You may not use 5 * this file except in compliance with the License. You can obtain a copy 6 * in the file LICENSE in the source distribution or at 7 * https://www.openssl.org/source/license.html 8 */ 9 10 #ifndef OPENSSL_MACROS_H 11 # define OPENSSL_MACROS_H 12 # pragma once 13 14 #include <openssl/opensslconf.h> 15 #include <openssl/opensslv.h> 16 17 18 /* Helper macros for CPP string composition */ 19 # define OPENSSL_MSTR_HELPER(x) #x 20 # define OPENSSL_MSTR(x) OPENSSL_MSTR_HELPER(x) 21 22 /* 23 * Sometimes OPENSSL_NO_xxx ends up with an empty file and some compilers 24 * don't like that. This will hopefully silence them. 25 */ 26 # define NON_EMPTY_TRANSLATION_UNIT static void *dummy = &dummy; 27 28 /* 29 * Generic deprecation macro 30 * 31 * If OPENSSL_SUPPRESS_DEPRECATED is defined, then OSSL_DEPRECATED and 32 * OSSL_DEPRECATED_FOR become no-ops 33 */ 34 # ifndef OSSL_DEPRECATED 35 # undef OSSL_DEPRECATED_FOR 36 # ifndef OPENSSL_SUPPRESS_DEPRECATED 37 # if defined(_MSC_VER) 38 /* 39 * MSVC supports __declspec(deprecated) since MSVC 2003 (13.10), 40 * and __declspec(deprecated(message)) since MSVC 2005 (14.00) 41 */ 42 # if _MSC_VER >= 1400 43 # define OSSL_DEPRECATED(since) \ 44 __declspec(deprecated("Since OpenSSL " # since)) 45 # define OSSL_DEPRECATED_FOR(since, message) \ 46 __declspec(deprecated("Since OpenSSL " # since ";" message)) 47 # elif _MSC_VER >= 1310 48 # define OSSL_DEPRECATED(since) __declspec(deprecated) 49 # define OSSL_DEPRECATED_FOR(since, message) __declspec(deprecated) 50 # endif 51 # elif defined(__GNUC__) 52 /* 53 * According to GCC documentation, deprecations with message appeared in 54 * GCC 4.5.0 55 */ 56 # if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) 57 # define OSSL_DEPRECATED(since) \ 58 __attribute__((deprecated("Since OpenSSL " # since))) 59 # define OSSL_DEPRECATED_FOR(since, message) \ 60 __attribute__((deprecated("Since OpenSSL " # since ";" message))) 61 # elif __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 0) 62 # define OSSL_DEPRECATED(since) __attribute__((deprecated)) 63 # define OSSL_DEPRECATED_FOR(since, message) __attribute__((deprecated)) 64 # endif 65 # elif defined(__SUNPRO_C) 66 # if (__SUNPRO_C >= 0x5130) 67 # define OSSL_DEPRECATED(since) __attribute__ ((deprecated)) 68 # define OSSL_DEPRECATED_FOR(since, message) __attribute__ ((deprecated)) 69 # endif 70 # endif 71 # endif 72 # endif 73 74 /* 75 * Still not defined? Then define no-op macros. This means these macros 76 * are unsuitable for use in a typedef. 77 */ 78 # ifndef OSSL_DEPRECATED 79 # define OSSL_DEPRECATED(since) extern 80 # define OSSL_DEPRECATED_FOR(since, message) extern 81 # endif 82 83 /* 84 * Applications should use -DOPENSSL_API_COMPAT=<version> to suppress the 85 * declarations of functions deprecated in or before <version>. If this is 86 * undefined, the value of the macro OPENSSL_CONFIGURED_API (defined in 87 * <openssl/opensslconf.h>) is the default. 88 * 89 * For any version number up until version 1.1.x, <version> is expected to be 90 * the calculated version number 0xMNNFFPPSL. 91 * For version numbers 3.0 and on, <version> is expected to be a computation 92 * of the major and minor numbers in decimal using this formula: 93 * 94 * MAJOR * 10000 + MINOR * 100 95 * 96 * So version 3.0 becomes 30000, version 3.2 becomes 30200, etc. 97 */ 98 99 /* 100 * We use the OPENSSL_API_COMPAT value to define API level macros. These 101 * macros are used to enable or disable features at that API version boundary. 102 */ 103 104 # ifdef OPENSSL_API_LEVEL 105 # error "OPENSSL_API_LEVEL must not be defined by application" 106 # endif 107 108 /* 109 * We figure out what API level was intended by simple numeric comparison. 110 * The lowest old style number we recognise is 0x00908000L, so we take some 111 * safety margin and assume that anything below 0x00900000L is a new style 112 * number. This allows new versions up to and including v943.71.83. 113 */ 114 # ifdef OPENSSL_API_COMPAT 115 # if OPENSSL_API_COMPAT < 0x900000L 116 # define OPENSSL_API_LEVEL (OPENSSL_API_COMPAT) 117 # else 118 # define OPENSSL_API_LEVEL \ 119 (((OPENSSL_API_COMPAT >> 28) & 0xF) * 10000 \ 120 + ((OPENSSL_API_COMPAT >> 20) & 0xFF) * 100 \ 121 + ((OPENSSL_API_COMPAT >> 12) & 0xFF)) 122 # endif 123 # endif 124 125 /* 126 * If OPENSSL_API_COMPAT wasn't given, we use default numbers to set 127 * the API compatibility level. 128 */ 129 # ifndef OPENSSL_API_LEVEL 130 # if OPENSSL_CONFIGURED_API > 0 131 # define OPENSSL_API_LEVEL (OPENSSL_CONFIGURED_API) 132 # else 133 # define OPENSSL_API_LEVEL \ 134 (OPENSSL_VERSION_MAJOR * 10000 + OPENSSL_VERSION_MINOR * 100) 135 # endif 136 # endif 137 138 # if OPENSSL_API_LEVEL > OPENSSL_CONFIGURED_API 139 # error "The requested API level higher than the configured API compatibility level" 140 # endif 141 142 /* 143 * Check of sane values. 144 */ 145 /* Can't go higher than the current version. */ 146 # if OPENSSL_API_LEVEL > (OPENSSL_VERSION_MAJOR * 10000 + OPENSSL_VERSION_MINOR * 100) 147 # error "OPENSSL_API_COMPAT expresses an impossible API compatibility level" 148 # endif 149 /* OpenSSL will have no version 2.y.z */ 150 # if OPENSSL_API_LEVEL < 30000 && OPENSSL_API_LEVEL >= 20000 151 # error "OPENSSL_API_COMPAT expresses an impossible API compatibility level" 152 # endif 153 /* Below 0.9.8 is unacceptably low */ 154 # if OPENSSL_API_LEVEL < 908 155 # error "OPENSSL_API_COMPAT expresses an impossible API compatibility level" 156 # endif 157 158 /* 159 * Define macros for deprecation and simulated removal purposes. 160 * 161 * The macros OSSL_DEPRECATEDIN_{major}_{minor} are always defined for 162 * all OpenSSL versions we care for. They can be used as attributes 163 * in function declarations where appropriate. 164 * 165 * The macros OPENSSL_NO_DEPRECATED_{major}_{minor} are defined for 166 * all OpenSSL versions up to or equal to the version given with 167 * OPENSSL_API_COMPAT. They are used as guards around anything that's 168 * deprecated up to that version, as an effect of the developer option 169 * 'no-deprecated'. 170 */ 171 172 # undef OPENSSL_NO_DEPRECATED_3_6 173 # undef OPENSSL_NO_DEPRECATED_3_4 174 # undef OPENSSL_NO_DEPRECATED_3_1 175 # undef OPENSSL_NO_DEPRECATED_3_0 176 # undef OPENSSL_NO_DEPRECATED_1_1_1 177 # undef OPENSSL_NO_DEPRECATED_1_1_0 178 # undef OPENSSL_NO_DEPRECATED_1_0_2 179 # undef OPENSSL_NO_DEPRECATED_1_0_1 180 # undef OPENSSL_NO_DEPRECATED_1_0_0 181 # undef OPENSSL_NO_DEPRECATED_0_9_8 182 183 # if OPENSSL_API_LEVEL >= 30600 184 # ifndef OPENSSL_NO_DEPRECATED 185 # define OSSL_DEPRECATEDIN_3_6 OSSL_DEPRECATED(3.6) 186 # define OSSL_DEPRECATEDIN_3_6_FOR(msg) OSSL_DEPRECATED_FOR(3.6, msg) 187 # else 188 # define OPENSSL_NO_DEPRECATED_3_6 189 # endif 190 # else 191 # define OSSL_DEPRECATEDIN_3_6 192 # define OSSL_DEPRECATEDIN_3_6_FOR(msg) 193 # endif 194 # if OPENSSL_API_LEVEL >= 30500 195 # ifndef OPENSSL_NO_DEPRECATED 196 # define OSSL_DEPRECATEDIN_3_5 OSSL_DEPRECATED(3.5) 197 # define OSSL_DEPRECATEDIN_3_5_FOR(msg) OSSL_DEPRECATED_FOR(3.5, msg) 198 # else 199 # define OPENSSL_NO_DEPRECATED_3_5 200 # endif 201 # else 202 # define OSSL_DEPRECATEDIN_3_5 203 # define OSSL_DEPRECATEDIN_3_5_FOR(msg) 204 # endif 205 # if OPENSSL_API_LEVEL >= 30400 206 # ifndef OPENSSL_NO_DEPRECATED 207 # define OSSL_DEPRECATEDIN_3_4 OSSL_DEPRECATED(3.4) 208 # define OSSL_DEPRECATEDIN_3_4_FOR(msg) OSSL_DEPRECATED_FOR(3.4, msg) 209 # else 210 # define OPENSSL_NO_DEPRECATED_3_4 211 # endif 212 # else 213 # define OSSL_DEPRECATEDIN_3_4 214 # define OSSL_DEPRECATEDIN_3_4_FOR(msg) 215 # endif 216 # if OPENSSL_API_LEVEL >= 30100 217 # ifndef OPENSSL_NO_DEPRECATED 218 # define OSSL_DEPRECATEDIN_3_1 OSSL_DEPRECATED(3.1) 219 # define OSSL_DEPRECATEDIN_3_1_FOR(msg) OSSL_DEPRECATED_FOR(3.1, msg) 220 # else 221 # define OPENSSL_NO_DEPRECATED_3_1 222 # endif 223 # else 224 # define OSSL_DEPRECATEDIN_3_1 225 # define OSSL_DEPRECATEDIN_3_1_FOR(msg) 226 # endif 227 # if OPENSSL_API_LEVEL >= 30000 228 # ifndef OPENSSL_NO_DEPRECATED 229 # define OSSL_DEPRECATEDIN_3_0 OSSL_DEPRECATED(3.0) 230 # define OSSL_DEPRECATEDIN_3_0_FOR(msg) OSSL_DEPRECATED_FOR(3.0, msg) 231 # else 232 # define OPENSSL_NO_DEPRECATED_3_0 233 # endif 234 # else 235 # define OSSL_DEPRECATEDIN_3_0 236 # define OSSL_DEPRECATEDIN_3_0_FOR(msg) 237 # endif 238 # if OPENSSL_API_LEVEL >= 10101 239 # ifndef OPENSSL_NO_DEPRECATED 240 # define OSSL_DEPRECATEDIN_1_1_1 OSSL_DEPRECATED(1.1.1) 241 # define OSSL_DEPRECATEDIN_1_1_1_FOR(msg) OSSL_DEPRECATED_FOR(1.1.1, msg) 242 # else 243 # define OPENSSL_NO_DEPRECATED_1_1_1 244 # endif 245 # else 246 # define OSSL_DEPRECATEDIN_1_1_1 247 # define OSSL_DEPRECATEDIN_1_1_1_FOR(msg) 248 # endif 249 # if OPENSSL_API_LEVEL >= 10100 250 # ifndef OPENSSL_NO_DEPRECATED 251 # define OSSL_DEPRECATEDIN_1_1_0 OSSL_DEPRECATED(1.1.0) 252 # define OSSL_DEPRECATEDIN_1_1_0_FOR(msg) OSSL_DEPRECATED_FOR(1.1.0, msg) 253 # else 254 # define OPENSSL_NO_DEPRECATED_1_1_0 255 # endif 256 # else 257 # define OSSL_DEPRECATEDIN_1_1_0 258 # define OSSL_DEPRECATEDIN_1_1_0_FOR(msg) 259 # endif 260 # if OPENSSL_API_LEVEL >= 10002 261 # ifndef OPENSSL_NO_DEPRECATED 262 # define OSSL_DEPRECATEDIN_1_0_2 OSSL_DEPRECATED(1.0.2) 263 # define OSSL_DEPRECATEDIN_1_0_2_FOR(msg) OSSL_DEPRECATED_FOR(1.0.2, msg) 264 # else 265 # define OPENSSL_NO_DEPRECATED_1_0_2 266 # endif 267 # else 268 # define OSSL_DEPRECATEDIN_1_0_2 269 # define OSSL_DEPRECATEDIN_1_0_2_FOR(msg) 270 # endif 271 # if OPENSSL_API_LEVEL >= 10001 272 # ifndef OPENSSL_NO_DEPRECATED 273 # define OSSL_DEPRECATEDIN_1_0_1 OSSL_DEPRECATED(1.0.1) 274 # define OSSL_DEPRECATEDIN_1_0_1_FOR(msg) OSSL_DEPRECATED_FOR(1.0.1, msg) 275 # else 276 # define OPENSSL_NO_DEPRECATED_1_0_1 277 # endif 278 # else 279 # define OSSL_DEPRECATEDIN_1_0_1 280 # define OSSL_DEPRECATEDIN_1_0_1_FOR(msg) 281 # endif 282 # if OPENSSL_API_LEVEL >= 10000 283 # ifndef OPENSSL_NO_DEPRECATED 284 # define OSSL_DEPRECATEDIN_1_0_0 OSSL_DEPRECATED(1.0.0) 285 # define OSSL_DEPRECATEDIN_1_0_0_FOR(msg) OSSL_DEPRECATED_FOR(1.0.0, msg) 286 # else 287 # define OPENSSL_NO_DEPRECATED_1_0_0 288 # endif 289 # else 290 # define OSSL_DEPRECATEDIN_1_0_0 291 # define OSSL_DEPRECATEDIN_1_0_0_FOR(msg) 292 # endif 293 # if OPENSSL_API_LEVEL >= 908 294 # ifndef OPENSSL_NO_DEPRECATED 295 # define OSSL_DEPRECATEDIN_0_9_8 OSSL_DEPRECATED(0.9.8) 296 # define OSSL_DEPRECATEDIN_0_9_8_FOR(msg) OSSL_DEPRECATED_FOR(0.9.8, msg) 297 # else 298 # define OPENSSL_NO_DEPRECATED_0_9_8 299 # endif 300 # else 301 # define OSSL_DEPRECATEDIN_0_9_8 302 # define OSSL_DEPRECATEDIN_0_9_8_FOR(msg) 303 # endif 304 305 /* 306 * Make our own variants of __FILE__ and __LINE__, depending on configuration 307 */ 308 309 # ifndef OPENSSL_FILE 310 # ifdef OPENSSL_NO_FILENAMES 311 # define OPENSSL_FILE "" 312 # define OPENSSL_LINE 0 313 # else 314 # define OPENSSL_FILE __FILE__ 315 # define OPENSSL_LINE __LINE__ 316 # endif 317 # endif 318 319 /* 320 * __func__ was standardized in C99, so for any compiler that claims 321 * to implement that language level or newer, we assume we can safely 322 * use that symbol. 323 * 324 * GNU C also provides __FUNCTION__ since version 2, which predates 325 * C99. We can, however, only use this if __STDC_VERSION__ exists, 326 * as it's otherwise not allowed according to ISO C standards (C90). 327 * (compiling with GNU C's -pedantic tells us so) 328 * 329 * If none of the above applies, we check if the compiler is MSVC, 330 * and use __FUNCTION__ if that's the case. 331 */ 332 # ifndef OPENSSL_FUNC 333 # if defined(__STDC_VERSION__) 334 # if __STDC_VERSION__ >= 199901L 335 # define OPENSSL_FUNC __func__ 336 # elif defined(__GNUC__) && __GNUC__ >= 2 337 # define OPENSSL_FUNC __FUNCTION__ 338 # endif 339 # elif defined(_MSC_VER) 340 # define OPENSSL_FUNC __FUNCTION__ 341 # endif 342 /* 343 * If all these possibilities are exhausted, we give up and use a 344 * static string. 345 */ 346 # ifndef OPENSSL_FUNC 347 # define OPENSSL_FUNC "(unknown function)" 348 # endif 349 # endif 350 351 # ifndef OSSL_CRYPTO_ALLOC 352 # if defined(__GNUC__) 353 # define OSSL_CRYPTO_ALLOC __attribute__((__malloc__)) 354 # elif defined(_MSC_VER) 355 # define OSSL_CRYPTO_ALLOC __declspec(restrict) 356 # else 357 # define OSSL_CRYPTO_ALLOC 358 # endif 359 # endif 360 361 #endif /* OPENSSL_MACROS_H */ 362