gnunet-android

GNUnet for Android
Log | Files | Refs | README

pool.h (4079B)

      1 // Copyright 2016 The BoringSSL Authors
      2 //
      3 // Licensed under the Apache License, Version 2.0 (the "License");
      4 // you may not use this file except in compliance with the License.
      5 // You may obtain a copy of the License at
      6 //
      7 //     https://www.apache.org/licenses/LICENSE-2.0
      8 //
      9 // Unless required by applicable law or agreed to in writing, software
     10 // distributed under the License is distributed on an "AS IS" BASIS,
     11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     12 // See the License for the specific language governing permissions and
     13 // limitations under the License.
     14 
     15 #ifndef OPENSSL_HEADER_POOL_H
     16 #define OPENSSL_HEADER_POOL_H
     17 
     18 #include <openssl/base.h>   // IWYU pragma: export
     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_alloc creates an unpooled |CRYPTO_BUFFER| of the given size and
     52 // writes the underlying data pointer to |*out_data|. It returns NULL on error.
     53 //
     54 // After calling this function, |len| bytes of contents must be written to
     55 // |out_data| before passing the returned pointer to any other BoringSSL
     56 // functions. Once initialized, the |CRYPTO_BUFFER| should be treated as
     57 // immutable.
     58 OPENSSL_EXPORT CRYPTO_BUFFER *CRYPTO_BUFFER_alloc(uint8_t **out_data,
     59                                                   size_t len);
     60 
     61 // CRYPTO_BUFFER_new_from_CBS acts the same as |CRYPTO_BUFFER_new|.
     62 OPENSSL_EXPORT CRYPTO_BUFFER *CRYPTO_BUFFER_new_from_CBS(
     63     const CBS *cbs, CRYPTO_BUFFER_POOL *pool);
     64 
     65 // CRYPTO_BUFFER_new_from_static_data_unsafe behaves like |CRYPTO_BUFFER_new|
     66 // but does not copy |data|. |data| must be immutable and last for the lifetime
     67 // of the address space.
     68 OPENSSL_EXPORT CRYPTO_BUFFER *CRYPTO_BUFFER_new_from_static_data_unsafe(
     69     const uint8_t *data, size_t len, CRYPTO_BUFFER_POOL *pool);
     70 
     71 // CRYPTO_BUFFER_free decrements the reference count of |buf|. If there are no
     72 // other references, or if the only remaining reference is from a pool, then
     73 // |buf| will be freed.
     74 OPENSSL_EXPORT void CRYPTO_BUFFER_free(CRYPTO_BUFFER *buf);
     75 
     76 // CRYPTO_BUFFER_up_ref increments the reference count of |buf| and returns
     77 // one.
     78 OPENSSL_EXPORT int CRYPTO_BUFFER_up_ref(CRYPTO_BUFFER *buf);
     79 
     80 // CRYPTO_BUFFER_data returns a pointer to the data contained in |buf|.
     81 OPENSSL_EXPORT const uint8_t *CRYPTO_BUFFER_data(const CRYPTO_BUFFER *buf);
     82 
     83 // CRYPTO_BUFFER_len returns the length, in bytes, of the data contained in
     84 // |buf|.
     85 OPENSSL_EXPORT size_t CRYPTO_BUFFER_len(const CRYPTO_BUFFER *buf);
     86 
     87 // CRYPTO_BUFFER_init_CBS initialises |out| to point at the data from |buf|.
     88 OPENSSL_EXPORT void CRYPTO_BUFFER_init_CBS(const CRYPTO_BUFFER *buf, CBS *out);
     89 
     90 
     91 #if defined(__cplusplus)
     92 }  // extern C
     93 
     94 extern "C++" {
     95 
     96 BSSL_NAMESPACE_BEGIN
     97 
     98 BORINGSSL_MAKE_DELETER(CRYPTO_BUFFER_POOL, CRYPTO_BUFFER_POOL_free)
     99 BORINGSSL_MAKE_DELETER(CRYPTO_BUFFER, CRYPTO_BUFFER_free)
    100 BORINGSSL_MAKE_UP_REF(CRYPTO_BUFFER, CRYPTO_BUFFER_up_ref)
    101 
    102 BSSL_NAMESPACE_END
    103 
    104 }  // extern C++
    105 
    106 #endif
    107 
    108 #endif  // OPENSSL_HEADER_POOL_H