1 /* Copyright (c) 2016, Google Inc. 2 * 3 * Permission to use, copy, modify, and/or distribute this software for any 4 * purpose with or without fee is hereby granted, provided that the above 5 * copyright notice and this permission notice appear in all copies. 6 * 7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 8 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 9 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 10 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 11 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 12 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 13 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ 14 15 #ifndef OPENSSL_HEADER_POOL_H 16 #define OPENSSL_HEADER_POOL_H 17 18 #include <openssl/base.h> 19 20 #include <openssl/stack.h> 21 22 #if defined(__cplusplus) 23 extern "C" { 24 #endif 25 26 27 /* Buffers and buffer pools. 28 * 29 * |CRYPTO_BUFFER|s are simply reference-counted blobs. A |CRYPTO_BUFFER_POOL| 30 * is an intern table for |CRYPTO_BUFFER|s. This allows for a single copy of a 31 * given blob to be kept in memory and referenced from multiple places. */ 32 33 34 DEFINE_STACK_OF(CRYPTO_BUFFER) 35 36 /* CRYPTO_BUFFER_POOL_new returns a freshly allocated |CRYPTO_BUFFER_POOL| or 37 * NULL on error. */ 38 OPENSSL_EXPORT CRYPTO_BUFFER_POOL* CRYPTO_BUFFER_POOL_new(void); 39 40 /* CRYPTO_BUFFER_POOL_free frees |pool|, which must be empty. */ 41 OPENSSL_EXPORT void CRYPTO_BUFFER_POOL_free(CRYPTO_BUFFER_POOL *pool); 42 43 /* CRYPTO_BUFFER_new returns a |CRYPTO_BUFFER| containing a copy of |data|, or 44 * else NULL on error. If |pool| is not NULL then the returned value may be a 45 * reference to a previously existing |CRYPTO_BUFFER| that contained the same 46 * data. Otherwise, the returned, fresh |CRYPTO_BUFFER| will be added to the 47 * pool. */ 48 OPENSSL_EXPORT CRYPTO_BUFFER *CRYPTO_BUFFER_new(const uint8_t *data, size_t len, 49 CRYPTO_BUFFER_POOL *pool); 50 51 /* CRYPTO_BUFFER_new_from_CBS acts the same as |CRYPTO_BUFFER_new|. */ 52 OPENSSL_EXPORT CRYPTO_BUFFER *CRYPTO_BUFFER_new_from_CBS( 53 CBS *cbs, CRYPTO_BUFFER_POOL *pool); 54 55 /* CRYPTO_BUFFER_free decrements the reference count of |buf|. If there are no 56 * other references, or if the only remaining reference is from a pool, then 57 * |buf| will be freed. */ 58 OPENSSL_EXPORT void CRYPTO_BUFFER_free(CRYPTO_BUFFER *buf); 59 60 /* CRYPTO_BUFFER_up_ref increments the reference count of |buf| and returns 61 * one. */ 62 OPENSSL_EXPORT int CRYPTO_BUFFER_up_ref(CRYPTO_BUFFER *buf); 63 64 /* CRYPTO_BUFFER_data returns a pointer to the data contained in |buf|. */ 65 OPENSSL_EXPORT const uint8_t *CRYPTO_BUFFER_data(const CRYPTO_BUFFER *buf); 66 67 /* CRYPTO_BUFFER_len returns the length, in bytes, of the data contained in 68 * |buf|. */ 69 OPENSSL_EXPORT size_t CRYPTO_BUFFER_len(const CRYPTO_BUFFER *buf); 70 71 /* CRYPTO_BUFFER_init_CBS initialises |out| to point at the data from |buf|. */ 72 OPENSSL_EXPORT void CRYPTO_BUFFER_init_CBS(const CRYPTO_BUFFER *buf, CBS *out); 73 74 75 #if defined(__cplusplus) 76 } /* extern C */ 77 78 extern "C++" { 79 80 namespace bssl { 81 82 BORINGSSL_MAKE_DELETER(CRYPTO_BUFFER_POOL, CRYPTO_BUFFER_POOL_free) 83 BORINGSSL_MAKE_DELETER(CRYPTO_BUFFER, CRYPTO_BUFFER_free) 84 85 } // namespace bssl 86 87 } /* extern C++ */ 88 89 #endif 90 91 #endif // OPENSSL_HEADER_POOL_H 92