• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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(__aarch64__)
94 #define OPENSSL_64_BIT
95 #define OPENSSL_AARCH64
96 #elif defined(__arm) || defined(__arm__) || 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(__mips__) && !defined(__LP64__)
103 #define OPENSSL_32_BIT
104 #define OPENSSL_MIPS
105 #elif defined(__mips__) && 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 #if defined(__linux__)
142 #define OPENSSL_LINUX
143 #endif
144 
145 #if defined(__Fuchsia__)
146 #define OPENSSL_FUCHSIA
147 #endif
148 
149 #if defined(TRUSTY)
150 #define OPENSSL_TRUSTY
151 #define OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED
152 #endif
153 
154 #if defined(__ANDROID_API__)
155 #define OPENSSL_ANDROID
156 #endif
157 
158 // BoringSSL requires platform's locking APIs to make internal global state
159 // thread-safe, including the PRNG. On some single-threaded embedded platforms,
160 // locking APIs may not exist, so this dependency may be disabled with the
161 // following build flag.
162 //
163 // IMPORTANT: Doing so means the consumer promises the library will never be
164 // used in any multi-threaded context. It causes BoringSSL to be globally
165 // thread-unsafe. Setting it inappropriately will subtly and unpredictably
166 // corrupt memory and leak secret keys.
167 //
168 // Do not set this flag on any platform where threads are possible. BoringSSL
169 // maintainers will not provide support for any consumers that do so. Changes
170 // which break such unsupported configurations will not be reverted.
171 #if !defined(OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED)
172 #define OPENSSL_THREADS
173 #endif
174 
175 #define OPENSSL_IS_BORINGSSL
176 #define OPENSSL_VERSION_NUMBER 0x1010007f
177 #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
178 
179 // BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL
180 // changes over time. The value itself is not meaningful. It will be incremented
181 // whenever is convenient to coordinate an API change with consumers. This will
182 // not denote any special point in development.
183 //
184 // A consumer may use this symbol in the preprocessor to temporarily build
185 // against multiple revisions of BoringSSL at the same time. It is not
186 // recommended to do so for longer than is necessary.
187 #define BORINGSSL_API_VERSION 9
188 
189 #if defined(BORINGSSL_SHARED_LIBRARY)
190 
191 #if defined(OPENSSL_WINDOWS)
192 
193 #if defined(BORINGSSL_IMPLEMENTATION)
194 #define OPENSSL_EXPORT __declspec(dllexport)
195 #else
196 #define OPENSSL_EXPORT __declspec(dllimport)
197 #endif
198 
199 #else  // defined(OPENSSL_WINDOWS)
200 
201 #if defined(BORINGSSL_IMPLEMENTATION)
202 #define OPENSSL_EXPORT __attribute__((visibility("default")))
203 #else
204 #define OPENSSL_EXPORT
205 #endif
206 
207 #endif  // defined(OPENSSL_WINDOWS)
208 
209 #else  // defined(BORINGSSL_SHARED_LIBRARY)
210 
211 #define OPENSSL_EXPORT
212 
213 #endif  // defined(BORINGSSL_SHARED_LIBRARY)
214 
215 
216 #if defined(__GNUC__) || defined(__clang__)
217 // MinGW has two different printf implementations. Ensure the format macro
218 // matches the selected implementation. See
219 // https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/.
220 #if defined(__MINGW_PRINTF_FORMAT)
221 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
222   __attribute__(                                                 \
223       (__format__(__MINGW_PRINTF_FORMAT, string_index, first_to_check)))
224 #else
225 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
226   __attribute__((__format__(__printf__, string_index, first_to_check)))
227 #endif
228 #else
229 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check)
230 #endif
231 
232 // OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers.
233 #if defined(_MSC_VER)
234 #define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg)
235 #else
236 #define OPENSSL_MSVC_PRAGMA(arg)
237 #endif
238 
239 #if defined(__GNUC__) || defined(__clang__)
240 #define OPENSSL_UNUSED __attribute__((unused))
241 #else
242 #define OPENSSL_UNUSED
243 #endif
244 
245 // C and C++ handle inline functions differently. In C++, an inline function is
246 // defined in just the header file, potentially emitted in multiple compilation
247 // units (in cases the compiler did not inline), but each copy must be identical
248 // to satsify ODR. In C, a non-static inline must be manually emitted in exactly
249 // one compilation unit with a separate extern inline declaration.
250 //
251 // In both languages, exported inline functions referencing file-local symbols
252 // are problematic. C forbids this altogether (though GCC and Clang seem not to
253 // enforce it). It works in C++, but ODR requires the definitions be identical,
254 // including all names in the definitions resolving to the "same entity". In
255 // practice, this is unlikely to be a problem, but an inline function that
256 // returns a pointer to a file-local symbol
257 // could compile oddly.
258 //
259 // Historically, we used static inline in headers. However, to satisfy ODR, use
260 // plain inline in C++, to allow inline consumer functions to call our header
261 // functions. Plain inline would also work better with C99 inline, but that is
262 // not used much in practice, extern inline is tedious, and there are conflicts
263 // with the old gnu89 model:
264 // https://stackoverflow.com/questions/216510/extern-inline
265 #if defined(__cplusplus)
266 #define OPENSSL_INLINE inline
267 #else
268 // Add OPENSSL_UNUSED so that, should an inline function be emitted via macro
269 // (e.g. a |STACK_OF(T)| implementation) in a source file without tripping
270 // clang's -Wunused-function.
271 #define OPENSSL_INLINE static inline OPENSSL_UNUSED
272 #endif
273 
274 #if defined(BORINGSSL_UNSAFE_FUZZER_MODE) && \
275     !defined(BORINGSSL_UNSAFE_DETERMINISTIC_MODE)
276 #define BORINGSSL_UNSAFE_DETERMINISTIC_MODE
277 #endif
278 
279 #if defined(__has_feature)
280 #if __has_feature(address_sanitizer)
281 #define OPENSSL_ASAN
282 #endif
283 #if __has_feature(thread_sanitizer)
284 #define OPENSSL_TSAN
285 #endif
286 #if __has_feature(memory_sanitizer)
287 #define OPENSSL_MSAN
288 #define OPENSSL_ASM_INCOMPATIBLE
289 #endif
290 #endif
291 
292 #if defined(OPENSSL_ASM_INCOMPATIBLE)
293 #undef OPENSSL_ASM_INCOMPATIBLE
294 #if !defined(OPENSSL_NO_ASM)
295 #define OPENSSL_NO_ASM
296 #endif
297 #endif  // OPENSSL_ASM_INCOMPATIBLE
298 
299 #if defined(__cplusplus)
300 // enums can be predeclared, but only in C++ and only if given an explicit type.
301 // C doesn't support setting an explicit type for enums thus a #define is used
302 // to do this only for C++. However, the ABI type between C and C++ need to have
303 // equal sizes, which is confirmed in a unittest.
304 #define BORINGSSL_ENUM_INT : int
305 enum ssl_early_data_reason_t BORINGSSL_ENUM_INT;
306 enum ssl_encryption_level_t BORINGSSL_ENUM_INT;
307 enum ssl_private_key_result_t BORINGSSL_ENUM_INT;
308 enum ssl_renegotiate_mode_t BORINGSSL_ENUM_INT;
309 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT;
310 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT;
311 enum ssl_ticket_aead_result_t BORINGSSL_ENUM_INT;
312 enum ssl_verify_result_t BORINGSSL_ENUM_INT;
313 #else
314 #define BORINGSSL_ENUM_INT
315 #endif
316 
317 // CRYPTO_THREADID is a dummy value.
318 typedef int CRYPTO_THREADID;
319 
320 typedef int ASN1_BOOLEAN;
321 typedef int ASN1_NULL;
322 typedef struct ASN1_ITEM_st ASN1_ITEM;
323 typedef struct asn1_object_st ASN1_OBJECT;
324 typedef struct asn1_pctx_st ASN1_PCTX;
325 typedef struct asn1_string_st ASN1_BIT_STRING;
326 typedef struct asn1_string_st ASN1_BMPSTRING;
327 typedef struct asn1_string_st ASN1_ENUMERATED;
328 typedef struct asn1_string_st ASN1_GENERALIZEDTIME;
329 typedef struct asn1_string_st ASN1_GENERALSTRING;
330 typedef struct asn1_string_st ASN1_IA5STRING;
331 typedef struct asn1_string_st ASN1_INTEGER;
332 typedef struct asn1_string_st ASN1_OCTET_STRING;
333 typedef struct asn1_string_st ASN1_PRINTABLESTRING;
334 typedef struct asn1_string_st ASN1_STRING;
335 typedef struct asn1_string_st ASN1_T61STRING;
336 typedef struct asn1_string_st ASN1_TIME;
337 typedef struct asn1_string_st ASN1_UNIVERSALSTRING;
338 typedef struct asn1_string_st ASN1_UTCTIME;
339 typedef struct asn1_string_st ASN1_UTF8STRING;
340 typedef struct asn1_string_st ASN1_VISIBLESTRING;
341 typedef struct asn1_type_st ASN1_TYPE;
342 typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID;
343 typedef struct BASIC_CONSTRAINTS_st BASIC_CONSTRAINTS;
344 typedef struct DIST_POINT_st DIST_POINT;
345 typedef struct DSA_SIG_st DSA_SIG;
346 typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT;
347 typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS;
348 typedef struct Netscape_spkac_st NETSCAPE_SPKAC;
349 typedef struct Netscape_spki_st NETSCAPE_SPKI;
350 typedef struct RIPEMD160state_st RIPEMD160_CTX;
351 typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE;
352 typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL;
353 typedef struct X509_POLICY_NODE_st X509_POLICY_NODE;
354 typedef struct X509_POLICY_TREE_st X509_POLICY_TREE;
355 typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM;
356 typedef struct X509_algor_st X509_ALGOR;
357 typedef struct X509_crl_info_st X509_CRL_INFO;
358 typedef struct X509_crl_st X509_CRL;
359 typedef struct X509_extension_st X509_EXTENSION;
360 typedef struct X509_info_st X509_INFO;
361 typedef struct X509_name_entry_st X509_NAME_ENTRY;
362 typedef struct X509_name_st X509_NAME;
363 typedef struct X509_pubkey_st X509_PUBKEY;
364 typedef struct X509_req_info_st X509_REQ_INFO;
365 typedef struct X509_req_st X509_REQ;
366 typedef struct X509_sig_st X509_SIG;
367 typedef struct X509_val_st X509_VAL;
368 typedef struct bignum_ctx BN_CTX;
369 typedef struct bignum_st BIGNUM;
370 typedef struct bio_method_st BIO_METHOD;
371 typedef struct bio_st BIO;
372 typedef struct bn_gencb_st BN_GENCB;
373 typedef struct bn_mont_ctx_st BN_MONT_CTX;
374 typedef struct buf_mem_st BUF_MEM;
375 typedef struct cbb_st CBB;
376 typedef struct cbs_st CBS;
377 typedef struct cmac_ctx_st CMAC_CTX;
378 typedef struct conf_st CONF;
379 typedef struct conf_value_st CONF_VALUE;
380 typedef struct crypto_buffer_pool_st CRYPTO_BUFFER_POOL;
381 typedef struct crypto_buffer_st CRYPTO_BUFFER;
382 typedef struct dh_st DH;
383 typedef struct dsa_st DSA;
384 typedef struct ec_group_st EC_GROUP;
385 typedef struct ec_key_st EC_KEY;
386 typedef struct ec_point_st EC_POINT;
387 typedef struct ecdsa_method_st ECDSA_METHOD;
388 typedef struct ecdsa_sig_st ECDSA_SIG;
389 typedef struct engine_st ENGINE;
390 typedef struct env_md_ctx_st EVP_MD_CTX;
391 typedef struct env_md_st EVP_MD;
392 typedef struct evp_aead_st EVP_AEAD;
393 typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX;
394 typedef struct evp_cipher_st EVP_CIPHER;
395 typedef struct evp_encode_ctx_st EVP_ENCODE_CTX;
396 typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD;
397 typedef struct evp_pkey_ctx_st EVP_PKEY_CTX;
398 typedef struct evp_pkey_method_st EVP_PKEY_METHOD;
399 typedef struct evp_pkey_st EVP_PKEY;
400 typedef struct hmac_ctx_st HMAC_CTX;
401 typedef struct md4_state_st MD4_CTX;
402 typedef struct md5_state_st MD5_CTX;
403 typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS;
404 typedef struct pkcs12_st PKCS12;
405 typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO;
406 typedef struct private_key_st X509_PKEY;
407 typedef struct rand_meth_st RAND_METHOD;
408 typedef struct rc4_key_st RC4_KEY;
409 typedef struct rsa_meth_st RSA_METHOD;
410 typedef struct rsa_st RSA;
411 typedef struct sha256_state_st SHA256_CTX;
412 typedef struct sha512_state_st SHA512_CTX;
413 typedef struct sha_state_st SHA_CTX;
414 typedef struct spake2_ctx_st SPAKE2_CTX;
415 typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE;
416 typedef struct ssl_cipher_st SSL_CIPHER;
417 typedef struct ssl_ctx_st SSL_CTX;
418 typedef struct ssl_method_st SSL_METHOD;
419 typedef struct ssl_private_key_method_st SSL_PRIVATE_KEY_METHOD;
420 typedef struct ssl_quic_method_st SSL_QUIC_METHOD;
421 typedef struct ssl_session_st SSL_SESSION;
422 typedef struct ssl_st SSL;
423 typedef struct ssl_ticket_aead_method_st SSL_TICKET_AEAD_METHOD;
424 typedef struct st_ERR_FNS ERR_FNS;
425 typedef struct v3_ext_ctx X509V3_CTX;
426 typedef struct x509_attributes_st X509_ATTRIBUTE;
427 typedef struct x509_cert_aux_st X509_CERT_AUX;
428 typedef struct x509_cinf_st X509_CINF;
429 typedef struct x509_crl_method_st X509_CRL_METHOD;
430 typedef struct x509_lookup_st X509_LOOKUP;
431 typedef struct x509_revoked_st X509_REVOKED;
432 typedef struct x509_st X509;
433 typedef struct x509_store_ctx_st X509_STORE_CTX;
434 typedef struct x509_store_st X509_STORE;
435 typedef struct x509_trust_st X509_TRUST;
436 
437 typedef void *OPENSSL_BLOCK;
438 
439 
440 #if defined(__cplusplus)
441 }  // extern C
442 #elif !defined(BORINGSSL_NO_CXX)
443 #define BORINGSSL_NO_CXX
444 #endif
445 
446 #if defined(BORINGSSL_PREFIX)
447 #define BSSL_NAMESPACE_BEGIN \
448   namespace bssl {           \
449   inline namespace BORINGSSL_PREFIX {
450 #define BSSL_NAMESPACE_END \
451   }                        \
452   }
453 #else
454 #define BSSL_NAMESPACE_BEGIN namespace bssl {
455 #define BSSL_NAMESPACE_END }
456 #endif
457 
458 // MSVC doesn't set __cplusplus to 201103 to indicate C++11 support (see
459 // https://connect.microsoft.com/VisualStudio/feedback/details/763051/a-value-of-predefined-macro-cplusplus-is-still-199711l)
460 // so MSVC is just assumed to support C++11.
461 #if !defined(BORINGSSL_NO_CXX) && __cplusplus < 201103L && !defined(_MSC_VER)
462 #define BORINGSSL_NO_CXX
463 #endif
464 
465 #if !defined(BORINGSSL_NO_CXX)
466 
467 extern "C++" {
468 
469 #include <memory>
470 
471 // STLPort, used by some Android consumers, not have std::unique_ptr.
472 #if defined(_STLPORT_VERSION)
473 #define BORINGSSL_NO_CXX
474 #endif
475 
476 }  // extern C++
477 #endif  // !BORINGSSL_NO_CXX
478 
479 #if defined(BORINGSSL_NO_CXX)
480 
481 #define BORINGSSL_MAKE_DELETER(type, deleter)
482 #define BORINGSSL_MAKE_UP_REF(type, up_ref_func)
483 
484 #else
485 
486 extern "C++" {
487 
488 BSSL_NAMESPACE_BEGIN
489 
490 namespace internal {
491 
492 // The Enable parameter is ignored and only exists so specializations can use
493 // SFINAE.
494 template <typename T, typename Enable = void>
495 struct DeleterImpl {};
496 
497 template <typename T>
498 struct Deleter {
operatorDeleter499   void operator()(T *ptr) {
500     // Rather than specialize Deleter for each type, we specialize
501     // DeleterImpl. This allows bssl::UniquePtr<T> to be used while only
502     // including base.h as long as the destructor is not emitted. This matches
503     // std::unique_ptr's behavior on forward-declared types.
504     //
505     // DeleterImpl itself is specialized in the corresponding module's header
506     // and must be included to release an object. If not included, the compiler
507     // will error that DeleterImpl<T> does not have a method Free.
508     DeleterImpl<T>::Free(ptr);
509   }
510 };
511 
512 template <typename T, typename CleanupRet, void (*init)(T *),
513           CleanupRet (*cleanup)(T *)>
514 class StackAllocated {
515  public:
StackAllocated()516   StackAllocated() { init(&ctx_); }
~StackAllocated()517   ~StackAllocated() { cleanup(&ctx_); }
518 
519   StackAllocated(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete;
520   T& operator=(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete;
521 
get()522   T *get() { return &ctx_; }
get()523   const T *get() const { return &ctx_; }
524 
525   T *operator->() { return &ctx_; }
526   const T *operator->() const { return &ctx_; }
527 
Reset()528   void Reset() {
529     cleanup(&ctx_);
530     init(&ctx_);
531   }
532 
533  private:
534   T ctx_;
535 };
536 
537 }  // namespace internal
538 
539 #define BORINGSSL_MAKE_DELETER(type, deleter)     \
540   namespace internal {                            \
541   template <>                                     \
542   struct DeleterImpl<type> {                      \
543     static void Free(type *ptr) { deleter(ptr); } \
544   };                                              \
545   }
546 
547 // Holds ownership of heap-allocated BoringSSL structures. Sample usage:
548 //   bssl::UniquePtr<RSA> rsa(RSA_new());
549 //   bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_mem()));
550 template <typename T>
551 using UniquePtr = std::unique_ptr<T, internal::Deleter<T>>;
552 
553 #define BORINGSSL_MAKE_UP_REF(type, up_ref_func)             \
554   inline UniquePtr<type> UpRef(type *v) {                    \
555     if (v != nullptr) {                                      \
556       up_ref_func(v);                                        \
557     }                                                        \
558     return UniquePtr<type>(v);                               \
559   }                                                          \
560                                                              \
561   inline UniquePtr<type> UpRef(const UniquePtr<type> &ptr) { \
562     return UpRef(ptr.get());                                 \
563   }
564 
565 BSSL_NAMESPACE_END
566 
567 }  // extern C++
568 
569 #endif  // !BORINGSSL_NO_CXX
570 
571 #endif  // OPENSSL_HEADER_BASE_H
572