1 /* ==================================================================== 2 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in 13 * the documentation and/or other materials provided with the 14 * distribution. 15 * 16 * 3. All advertising materials mentioning features or use of this 17 * software must display the following acknowledgment: 18 * "This product includes software developed by the OpenSSL Project 19 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 20 * 21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 22 * endorse or promote products derived from this software without 23 * prior written permission. For written permission, please contact 24 * openssl-core@openssl.org. 25 * 26 * 5. Products derived from this software may not be called "OpenSSL" 27 * nor may "OpenSSL" appear in their names without prior written 28 * permission of the OpenSSL Project. 29 * 30 * 6. Redistributions of any form whatsoever must retain the following 31 * acknowledgment: 32 * "This product includes software developed by the OpenSSL Project 33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 34 * 35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 46 * OF THE POSSIBILITY OF SUCH DAMAGE. 47 * ==================================================================== 48 * 49 * This product includes cryptographic software written by Eric Young 50 * (eay@cryptsoft.com). This product includes software written by Tim 51 * Hudson (tjh@cryptsoft.com). */ 52 53 #ifndef OPENSSL_HEADER_BASE_H 54 #define OPENSSL_HEADER_BASE_H 55 56 57 // This file should be the first included by all BoringSSL headers. 58 59 #include <stddef.h> 60 #include <stdint.h> 61 #include <sys/types.h> 62 63 #if defined(__MINGW32__) 64 // stdio.h is needed on MinGW for __MINGW_PRINTF_FORMAT. 65 #include <stdio.h> 66 #endif 67 68 #if defined(__APPLE__) 69 #include <TargetConditionals.h> 70 #endif 71 72 // Include a BoringSSL-only header so consumers including this header without 73 // setting up include paths do not accidentally pick up the system 74 // opensslconf.h. 75 #include <openssl/is_boringssl.h> 76 #include <openssl/opensslconf.h> 77 78 #if defined(BORINGSSL_PREFIX) 79 #include <boringssl_prefix_symbols.h> 80 #endif 81 82 #if defined(__cplusplus) 83 extern "C" { 84 #endif 85 86 87 #if defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64) 88 #define OPENSSL_64_BIT 89 #define OPENSSL_X86_64 90 #elif defined(__x86) || defined(__i386) || defined(__i386__) || defined(_M_IX86) 91 #define OPENSSL_32_BIT 92 #define OPENSSL_X86 93 #elif defined(__AARCH64EL__) || defined(_M_ARM64) 94 #define OPENSSL_64_BIT 95 #define OPENSSL_AARCH64 96 #elif defined(__ARMEL__) || defined(_M_ARM) 97 #define OPENSSL_32_BIT 98 #define OPENSSL_ARM 99 #elif (defined(__PPC64__) || defined(__powerpc64__)) && defined(_LITTLE_ENDIAN) 100 #define OPENSSL_64_BIT 101 #define OPENSSL_PPC64LE 102 #elif defined(__MIPSEL__) && !defined(__LP64__) 103 #define OPENSSL_32_BIT 104 #define OPENSSL_MIPS 105 #elif defined(__MIPSEL__) && defined(__LP64__) 106 #define OPENSSL_64_BIT 107 #define OPENSSL_MIPS64 108 #elif defined(__pnacl__) 109 #define OPENSSL_32_BIT 110 #define OPENSSL_PNACL 111 #elif defined(__wasm__) 112 #define OPENSSL_32_BIT 113 #elif defined(__asmjs__) 114 #define OPENSSL_32_BIT 115 #elif defined(__myriad2__) 116 #define OPENSSL_32_BIT 117 #else 118 // Note BoringSSL only supports standard 32-bit and 64-bit two's-complement, 119 // little-endian architectures. Functions will not produce the correct answer 120 // on other systems. Run the crypto_test binary, notably 121 // crypto/compiler_test.cc, before adding a new architecture. 122 #error "Unknown target CPU" 123 #endif 124 125 #if defined(__APPLE__) 126 #define OPENSSL_APPLE 127 // Note |TARGET_OS_MAC| is set for all Apple OS variants. |TARGET_OS_OSX| 128 // targets macOS specifically. 129 #if defined(TARGET_OS_OSX) && TARGET_OS_OSX 130 #define OPENSSL_MACOS 131 #endif 132 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE 133 #define OPENSSL_IOS 134 #endif 135 #endif 136 137 #if defined(_WIN32) 138 #define OPENSSL_WINDOWS 139 #endif 140 141 // Trusty isn't Linux but currently defines __linux__. As a workaround, we 142 // exclude it here. 143 // TODO(b/169780122): Remove this workaround once Trusty no longer defines it. 144 #if defined(__linux__) && !defined(TRUSTY) 145 #define OPENSSL_LINUX 146 #endif 147 148 #if defined(__Fuchsia__) 149 #define OPENSSL_FUCHSIA 150 #endif 151 152 #if defined(TRUSTY) 153 #define OPENSSL_TRUSTY 154 #define OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED 155 #endif 156 157 #if defined(__ANDROID_API__) 158 #define OPENSSL_ANDROID 159 #if defined(BORINGSSL_FIPS) 160 // The FIPS module on Android passively receives entropy. 161 #define BORINGSSL_FIPS_PASSIVE_ENTROPY 162 #endif 163 #endif 164 165 // BoringSSL requires platform's locking APIs to make internal global state 166 // thread-safe, including the PRNG. On some single-threaded embedded platforms, 167 // locking APIs may not exist, so this dependency may be disabled with the 168 // following build flag. 169 // 170 // IMPORTANT: Doing so means the consumer promises the library will never be 171 // used in any multi-threaded context. It causes BoringSSL to be globally 172 // thread-unsafe. Setting it inappropriately will subtly and unpredictably 173 // corrupt memory and leak secret keys. 174 // 175 // Do not set this flag on any platform where threads are possible. BoringSSL 176 // maintainers will not provide support for any consumers that do so. Changes 177 // which break such unsupported configurations will not be reverted. 178 #if !defined(OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED) 179 #define OPENSSL_THREADS 180 #endif 181 182 #define OPENSSL_IS_BORINGSSL 183 #define OPENSSL_VERSION_NUMBER 0x1010107f 184 #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER 185 186 // BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL 187 // changes over time. The value itself is not meaningful. It will be incremented 188 // whenever is convenient to coordinate an API change with consumers. This will 189 // not denote any special point in development. 190 // 191 // A consumer may use this symbol in the preprocessor to temporarily build 192 // against multiple revisions of BoringSSL at the same time. It is not 193 // recommended to do so for longer than is necessary. 194 #define BORINGSSL_API_VERSION 14 195 196 #if defined(BORINGSSL_SHARED_LIBRARY) 197 198 #if defined(OPENSSL_WINDOWS) 199 200 #if defined(BORINGSSL_IMPLEMENTATION) 201 #define OPENSSL_EXPORT __declspec(dllexport) 202 #else 203 #define OPENSSL_EXPORT __declspec(dllimport) 204 #endif 205 206 #else // defined(OPENSSL_WINDOWS) 207 208 #if defined(BORINGSSL_IMPLEMENTATION) 209 #define OPENSSL_EXPORT __attribute__((visibility("default"))) 210 #else 211 #define OPENSSL_EXPORT 212 #endif 213 214 #endif // defined(OPENSSL_WINDOWS) 215 216 #else // defined(BORINGSSL_SHARED_LIBRARY) 217 218 #define OPENSSL_EXPORT 219 220 #endif // defined(BORINGSSL_SHARED_LIBRARY) 221 222 223 #if defined(__GNUC__) || defined(__clang__) 224 // MinGW has two different printf implementations. Ensure the format macro 225 // matches the selected implementation. See 226 // https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/. 227 #if defined(__MINGW_PRINTF_FORMAT) 228 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \ 229 __attribute__( \ 230 (__format__(__MINGW_PRINTF_FORMAT, string_index, first_to_check))) 231 #else 232 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \ 233 __attribute__((__format__(__printf__, string_index, first_to_check))) 234 #endif 235 #else 236 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) 237 #endif 238 239 // OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers. 240 #if defined(_MSC_VER) 241 #define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg) 242 #else 243 #define OPENSSL_MSVC_PRAGMA(arg) 244 #endif 245 246 #if defined(__GNUC__) || defined(__clang__) 247 #define OPENSSL_UNUSED __attribute__((unused)) 248 #else 249 #define OPENSSL_UNUSED 250 #endif 251 252 // C and C++ handle inline functions differently. In C++, an inline function is 253 // defined in just the header file, potentially emitted in multiple compilation 254 // units (in cases the compiler did not inline), but each copy must be identical 255 // to satsify ODR. In C, a non-static inline must be manually emitted in exactly 256 // one compilation unit with a separate extern inline declaration. 257 // 258 // In both languages, exported inline functions referencing file-local symbols 259 // are problematic. C forbids this altogether (though GCC and Clang seem not to 260 // enforce it). It works in C++, but ODR requires the definitions be identical, 261 // including all names in the definitions resolving to the "same entity". In 262 // practice, this is unlikely to be a problem, but an inline function that 263 // returns a pointer to a file-local symbol 264 // could compile oddly. 265 // 266 // Historically, we used static inline in headers. However, to satisfy ODR, use 267 // plain inline in C++, to allow inline consumer functions to call our header 268 // functions. Plain inline would also work better with C99 inline, but that is 269 // not used much in practice, extern inline is tedious, and there are conflicts 270 // with the old gnu89 model: 271 // https://stackoverflow.com/questions/216510/extern-inline 272 #if defined(__cplusplus) 273 #define OPENSSL_INLINE inline 274 #else 275 // Add OPENSSL_UNUSED so that, should an inline function be emitted via macro 276 // (e.g. a |STACK_OF(T)| implementation) in a source file without tripping 277 // clang's -Wunused-function. 278 #define OPENSSL_INLINE static inline OPENSSL_UNUSED 279 #endif 280 281 #if defined(BORINGSSL_UNSAFE_FUZZER_MODE) && \ 282 !defined(BORINGSSL_UNSAFE_DETERMINISTIC_MODE) 283 #define BORINGSSL_UNSAFE_DETERMINISTIC_MODE 284 #endif 285 286 #if defined(__has_feature) 287 #if __has_feature(address_sanitizer) 288 #define OPENSSL_ASAN 289 #endif 290 #if __has_feature(thread_sanitizer) 291 #define OPENSSL_TSAN 292 #endif 293 #if __has_feature(memory_sanitizer) 294 #define OPENSSL_MSAN 295 #define OPENSSL_ASM_INCOMPATIBLE 296 #endif 297 #endif 298 299 #if defined(OPENSSL_ASM_INCOMPATIBLE) 300 #undef OPENSSL_ASM_INCOMPATIBLE 301 #if !defined(OPENSSL_NO_ASM) 302 #define OPENSSL_NO_ASM 303 #endif 304 #endif // OPENSSL_ASM_INCOMPATIBLE 305 306 #if defined(__cplusplus) 307 // enums can be predeclared, but only in C++ and only if given an explicit type. 308 // C doesn't support setting an explicit type for enums thus a #define is used 309 // to do this only for C++. However, the ABI type between C and C++ need to have 310 // equal sizes, which is confirmed in a unittest. 311 #define BORINGSSL_ENUM_INT : int 312 enum ssl_early_data_reason_t BORINGSSL_ENUM_INT; 313 enum ssl_encryption_level_t BORINGSSL_ENUM_INT; 314 enum ssl_private_key_result_t BORINGSSL_ENUM_INT; 315 enum ssl_renegotiate_mode_t BORINGSSL_ENUM_INT; 316 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT; 317 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT; 318 enum ssl_ticket_aead_result_t BORINGSSL_ENUM_INT; 319 enum ssl_verify_result_t BORINGSSL_ENUM_INT; 320 #else 321 #define BORINGSSL_ENUM_INT 322 #endif 323 324 // CRYPTO_THREADID is a dummy value. 325 typedef int CRYPTO_THREADID; 326 327 typedef int ASN1_BOOLEAN; 328 typedef int ASN1_NULL; 329 typedef struct ASN1_ITEM_st ASN1_ITEM; 330 typedef struct asn1_object_st ASN1_OBJECT; 331 typedef struct asn1_pctx_st ASN1_PCTX; 332 typedef struct asn1_string_st ASN1_BIT_STRING; 333 typedef struct asn1_string_st ASN1_BMPSTRING; 334 typedef struct asn1_string_st ASN1_ENUMERATED; 335 typedef struct asn1_string_st ASN1_GENERALIZEDTIME; 336 typedef struct asn1_string_st ASN1_GENERALSTRING; 337 typedef struct asn1_string_st ASN1_IA5STRING; 338 typedef struct asn1_string_st ASN1_INTEGER; 339 typedef struct asn1_string_st ASN1_OCTET_STRING; 340 typedef struct asn1_string_st ASN1_PRINTABLESTRING; 341 typedef struct asn1_string_st ASN1_STRING; 342 typedef struct asn1_string_st ASN1_T61STRING; 343 typedef struct asn1_string_st ASN1_TIME; 344 typedef struct asn1_string_st ASN1_UNIVERSALSTRING; 345 typedef struct asn1_string_st ASN1_UTCTIME; 346 typedef struct asn1_string_st ASN1_UTF8STRING; 347 typedef struct asn1_string_st ASN1_VISIBLESTRING; 348 typedef struct asn1_type_st ASN1_TYPE; 349 typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID; 350 typedef struct BASIC_CONSTRAINTS_st BASIC_CONSTRAINTS; 351 typedef struct DIST_POINT_st DIST_POINT; 352 typedef struct DSA_SIG_st DSA_SIG; 353 typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT; 354 typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS; 355 typedef struct Netscape_spkac_st NETSCAPE_SPKAC; 356 typedef struct Netscape_spki_st NETSCAPE_SPKI; 357 typedef struct RIPEMD160state_st RIPEMD160_CTX; 358 typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE; 359 typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL; 360 typedef struct X509_POLICY_NODE_st X509_POLICY_NODE; 361 typedef struct X509_POLICY_TREE_st X509_POLICY_TREE; 362 typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM; 363 typedef struct X509_algor_st X509_ALGOR; 364 typedef struct X509_crl_info_st X509_CRL_INFO; 365 typedef struct X509_crl_st X509_CRL; 366 typedef struct X509_extension_st X509_EXTENSION; 367 typedef struct X509_info_st X509_INFO; 368 typedef struct X509_name_entry_st X509_NAME_ENTRY; 369 typedef struct X509_name_st X509_NAME; 370 typedef struct X509_pubkey_st X509_PUBKEY; 371 typedef struct X509_req_info_st X509_REQ_INFO; 372 typedef struct X509_req_st X509_REQ; 373 typedef struct X509_sig_st X509_SIG; 374 typedef struct X509_val_st X509_VAL; 375 typedef struct bignum_ctx BN_CTX; 376 typedef struct bignum_st BIGNUM; 377 typedef struct bio_method_st BIO_METHOD; 378 typedef struct bio_st BIO; 379 typedef struct blake2b_state_st BLAKE2B_CTX; 380 typedef struct bn_gencb_st BN_GENCB; 381 typedef struct bn_mont_ctx_st BN_MONT_CTX; 382 typedef struct buf_mem_st BUF_MEM; 383 typedef struct cbb_st CBB; 384 typedef struct cbs_st CBS; 385 typedef struct cmac_ctx_st CMAC_CTX; 386 typedef struct conf_st CONF; 387 typedef struct conf_value_st CONF_VALUE; 388 typedef struct crypto_buffer_pool_st CRYPTO_BUFFER_POOL; 389 typedef struct crypto_buffer_st CRYPTO_BUFFER; 390 typedef struct dh_st DH; 391 typedef struct dsa_st DSA; 392 typedef struct ec_group_st EC_GROUP; 393 typedef struct ec_key_st EC_KEY; 394 typedef struct ec_point_st EC_POINT; 395 typedef struct ecdsa_method_st ECDSA_METHOD; 396 typedef struct ecdsa_sig_st ECDSA_SIG; 397 typedef struct engine_st ENGINE; 398 typedef struct env_md_ctx_st EVP_MD_CTX; 399 typedef struct env_md_st EVP_MD; 400 typedef struct evp_aead_st EVP_AEAD; 401 typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX; 402 typedef struct evp_cipher_st EVP_CIPHER; 403 typedef struct evp_encode_ctx_st EVP_ENCODE_CTX; 404 typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD; 405 typedef struct evp_pkey_ctx_st EVP_PKEY_CTX; 406 typedef struct evp_pkey_method_st EVP_PKEY_METHOD; 407 typedef struct evp_pkey_st EVP_PKEY; 408 typedef struct hmac_ctx_st HMAC_CTX; 409 typedef struct md4_state_st MD4_CTX; 410 typedef struct md5_state_st MD5_CTX; 411 typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS; 412 typedef struct pkcs12_st PKCS12; 413 typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO; 414 typedef struct private_key_st X509_PKEY; 415 typedef struct rand_meth_st RAND_METHOD; 416 typedef struct rc4_key_st RC4_KEY; 417 typedef struct rsa_meth_st RSA_METHOD; 418 typedef struct rsa_st RSA; 419 typedef struct sha256_state_st SHA256_CTX; 420 typedef struct sha512_state_st SHA512_CTX; 421 typedef struct sha_state_st SHA_CTX; 422 typedef struct spake2_ctx_st SPAKE2_CTX; 423 typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE; 424 typedef struct ssl_cipher_st SSL_CIPHER; 425 typedef struct ssl_ctx_st SSL_CTX; 426 typedef struct ssl_method_st SSL_METHOD; 427 typedef struct ssl_private_key_method_st SSL_PRIVATE_KEY_METHOD; 428 typedef struct ssl_quic_method_st SSL_QUIC_METHOD; 429 typedef struct ssl_session_st SSL_SESSION; 430 typedef struct ssl_st SSL; 431 typedef struct ssl_ticket_aead_method_st SSL_TICKET_AEAD_METHOD; 432 typedef struct st_ERR_FNS ERR_FNS; 433 typedef struct trust_token_st TRUST_TOKEN; 434 typedef struct trust_token_client_st TRUST_TOKEN_CLIENT; 435 typedef struct trust_token_issuer_st TRUST_TOKEN_ISSUER; 436 typedef struct trust_token_method_st TRUST_TOKEN_METHOD; 437 typedef struct v3_ext_ctx X509V3_CTX; 438 typedef struct x509_attributes_st X509_ATTRIBUTE; 439 typedef struct x509_cert_aux_st X509_CERT_AUX; 440 typedef struct x509_cinf_st X509_CINF; 441 typedef struct x509_crl_method_st X509_CRL_METHOD; 442 typedef struct x509_lookup_st X509_LOOKUP; 443 typedef struct x509_revoked_st X509_REVOKED; 444 typedef struct x509_st X509; 445 typedef struct x509_store_ctx_st X509_STORE_CTX; 446 typedef struct x509_store_st X509_STORE; 447 typedef struct x509_trust_st X509_TRUST; 448 449 typedef void *OPENSSL_BLOCK; 450 451 452 #if defined(__cplusplus) 453 } // extern C 454 #elif !defined(BORINGSSL_NO_CXX) 455 #define BORINGSSL_NO_CXX 456 #endif 457 458 #if defined(BORINGSSL_PREFIX) 459 #define BSSL_NAMESPACE_BEGIN \ 460 namespace bssl { \ 461 inline namespace BORINGSSL_PREFIX { 462 #define BSSL_NAMESPACE_END \ 463 } \ 464 } 465 #else 466 #define BSSL_NAMESPACE_BEGIN namespace bssl { 467 #define BSSL_NAMESPACE_END } 468 #endif 469 470 // MSVC doesn't set __cplusplus to 201103 to indicate C++11 support (see 471 // https://connect.microsoft.com/VisualStudio/feedback/details/763051/a-value-of-predefined-macro-cplusplus-is-still-199711l) 472 // so MSVC is just assumed to support C++11. 473 #if !defined(BORINGSSL_NO_CXX) && __cplusplus < 201103L && !defined(_MSC_VER) 474 #define BORINGSSL_NO_CXX 475 #endif 476 477 #if !defined(BORINGSSL_NO_CXX) 478 479 extern "C++" { 480 481 #include <memory> 482 483 // STLPort, used by some Android consumers, not have std::unique_ptr. 484 #if defined(_STLPORT_VERSION) 485 #define BORINGSSL_NO_CXX 486 #endif 487 488 } // extern C++ 489 #endif // !BORINGSSL_NO_CXX 490 491 #if defined(BORINGSSL_NO_CXX) 492 493 #define BORINGSSL_MAKE_DELETER(type, deleter) 494 #define BORINGSSL_MAKE_UP_REF(type, up_ref_func) 495 496 #else 497 498 extern "C++" { 499 500 BSSL_NAMESPACE_BEGIN 501 502 namespace internal { 503 504 // The Enable parameter is ignored and only exists so specializations can use 505 // SFINAE. 506 template <typename T, typename Enable = void> 507 struct DeleterImpl {}; 508 509 template <typename T> 510 struct Deleter { operatorDeleter511 void operator()(T *ptr) { 512 // Rather than specialize Deleter for each type, we specialize 513 // DeleterImpl. This allows bssl::UniquePtr<T> to be used while only 514 // including base.h as long as the destructor is not emitted. This matches 515 // std::unique_ptr's behavior on forward-declared types. 516 // 517 // DeleterImpl itself is specialized in the corresponding module's header 518 // and must be included to release an object. If not included, the compiler 519 // will error that DeleterImpl<T> does not have a method Free. 520 DeleterImpl<T>::Free(ptr); 521 } 522 }; 523 524 template <typename T, typename CleanupRet, void (*init)(T *), 525 CleanupRet (*cleanup)(T *)> 526 class StackAllocated { 527 public: StackAllocated()528 StackAllocated() { init(&ctx_); } ~StackAllocated()529 ~StackAllocated() { cleanup(&ctx_); } 530 531 StackAllocated(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete; 532 T& operator=(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete; 533 get()534 T *get() { return &ctx_; } get()535 const T *get() const { return &ctx_; } 536 537 T *operator->() { return &ctx_; } 538 const T *operator->() const { return &ctx_; } 539 Reset()540 void Reset() { 541 cleanup(&ctx_); 542 init(&ctx_); 543 } 544 545 private: 546 T ctx_; 547 }; 548 549 } // namespace internal 550 551 #define BORINGSSL_MAKE_DELETER(type, deleter) \ 552 namespace internal { \ 553 template <> \ 554 struct DeleterImpl<type> { \ 555 static void Free(type *ptr) { deleter(ptr); } \ 556 }; \ 557 } 558 559 // Holds ownership of heap-allocated BoringSSL structures. Sample usage: 560 // bssl::UniquePtr<RSA> rsa(RSA_new()); 561 // bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_mem())); 562 template <typename T> 563 using UniquePtr = std::unique_ptr<T, internal::Deleter<T>>; 564 565 #define BORINGSSL_MAKE_UP_REF(type, up_ref_func) \ 566 inline UniquePtr<type> UpRef(type *v) { \ 567 if (v != nullptr) { \ 568 up_ref_func(v); \ 569 } \ 570 return UniquePtr<type>(v); \ 571 } \ 572 \ 573 inline UniquePtr<type> UpRef(const UniquePtr<type> &ptr) { \ 574 return UpRef(ptr.get()); \ 575 } 576 577 BSSL_NAMESPACE_END 578 579 } // extern C++ 580 581 #endif // !BORINGSSL_NO_CXX 582 583 #endif // OPENSSL_HEADER_BASE_H 584