diff options
Diffstat (limited to 'src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-require.h')
| -rw-r--r-- | src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-require.h | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-require.h b/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-require.h new file mode 100644 index 0000000000..ac65134077 --- /dev/null +++ b/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-require.h @@ -0,0 +1,107 @@ +/***********************license start*********************************** +* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). All rights +* reserved. +* +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are +* met: +* +* * Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* * Redistributions in binary form must reproduce the above +* copyright notice, this list of conditions and the following +* disclaimer in the documentation and/or other materials provided +* with the distribution. +* +* * Neither the name of Cavium Inc. nor the names of +* its contributors may be used to endorse or promote products +* derived from this software without specific prior written +* permission. +* +* This Software, including technical data, may be subject to U.S. export +* control laws, including the U.S. Export Administration Act and its +* associated regulations, and may be subject to export or import +* regulations in other countries. +* +* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" +* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR +* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT +* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY +* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT +* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES +* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR +* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, +* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK +* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. +***********************license end**************************************/ + +/** + * @file + * + * Functions and macros to control what parts of the BDK are linked in + * + * <hr>$Revision: 49448 $<hr> + * @defgroup require Component linking control + * @{ + */ + +/** + * Optional parts of the BDK code are pulled in by adding + * BDK_REQUIRE() lines to the function bdk_require_depends(). + * Component symbols are defined as weak so that they are not + * linked in unless a BDK_REQUIRE() pulls them in. + */ +#define BDK_REQUIRE(component) \ + do \ + { \ + extern char __bdk_require_symbol_##component; \ + bdk_warn_if(__bdk_require_symbol_##component, \ + "Require of %s failed\n", #component); \ + } while (0) + +/** + * The following macro defines a special symbol in a C file to + * define it as a require component. Referencing this symbol + * causes all objects defined in the C file to be pulled in. This + * symbol should only be referenced by using the BDK_REQUIRE() + * macro in the function bdk_require_depends(). + */ +#define BDK_REQUIRE_DEFINE(component) \ + char __bdk_require_symbol_##component; \ + char __bdk_is_required_symbol_##component + +/** + * Return if a component has been required. Useful for if + * statements around referencing of weak symbols. + */ +#define BDK_IS_REQUIRED(component) \ + ({int is_required; \ + do \ + { \ + extern char __bdk_is_required_symbol_##component __attribute__((weak));\ + is_required = (&__bdk_is_required_symbol_##component != NULL); \ + } while (0); \ + is_required;}) + + +/** + * The require macros use weak symbols to control if components + * are linked in. All directly referenced symbols in a component + * must be defined a weak. This causes the component to only be + * pulled in by the linker if the symbol defined by + * BDK_REQUIRE_DEFINE is used. + */ +#define BDK_WEAK __attribute__((weak)) + +/** + * This function is not defined by the BDK libraries. It must be + * defined by all BDK applications. It should be empty except for + * containing BDK_REQUIRE() lines. The bdk-init code has a strong + * reference to bdk_requires_depends() which then contains strong + * references to all needed components. + */ +extern void __bdk_require_depends(void); + +/** @} */ |