blob: a2c8a1e72690b4c287e7773d27ad3ab0a4711fd6 [file] [log] [blame]
* \file common.h
* \brief Utility macros for internal use in the library
* Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0
* Licensed under the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
#include "mbedtls/build_info.h"
/** Helper to define a function as static except when building invasive tests.
* If a function is only used inside its own source file and should be
* declared `static` to allow the compiler to optimize for code size,
* but that function has unit tests, define it with
* ```
* MBEDTLS_STATIC_TESTABLE int mbedtls_foo(...) { ... }
* ```
* and declare it in a header in the `library/` directory with
* ```
* #if defined(MBEDTLS_TEST_HOOKS)
* int mbedtls_foo(...);
* #endif
* ```
/** Allow library to access its structs' private members.
* Although structs defined in header files are publicly available,
* their members are private and should not be accessed by the user.