X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_compat%2Frte_compat.h;h=92ff28faf8e6656d6b2b6995cc7bd0d1bd82820f;hb=6de3219c058877b87c5637096cd3f2025655ba39;hp=3a0fd2d352e701a1b948ae7eca09c6287e06aae2;hpb=166a743c53fa6cde255c5e0e3bb34d4a7c54d0bf;p=dpdk.git diff --git a/lib/librte_compat/rte_compat.h b/lib/librte_compat/rte_compat.h index 3a0fd2d352..92ff28faf8 100644 --- a/lib/librte_compat/rte_compat.h +++ b/lib/librte_compat/rte_compat.h @@ -1,31 +1,6 @@ -/*- - * BSD LICENSE - * - * Copyright(c) 2015 Neil Horman . - * 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. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2015 Neil Horman . + * All rights reserved. */ #ifndef _RTE_COMPAT_H_ @@ -39,32 +14,16 @@ * When a symol is exported from a library to provide an API, it also provides a * calling convention (ABI) that is embodied in its name, return type, * arguments, etc. On occasion that function may need to change to accommodate - * new functionality, behavior, etc. When that occurs, it is desireable to + * new functionality, behavior, etc. When that occurs, it is desirable to * allow for backwards compatibility for a time with older binaries that are * dynamically linked to the dpdk. To support that, the __vsym and * VERSION_SYMBOL macros are created. They, in conjunction with the * _version.map file for a given library allow for multiple versions of * a symbol to exist in a shared library so that older binaries need not be - * immediately recompiled. Their use is outlined in the following example: - * Assumptions: DPDK 2.(X) contains a function int foo(char *string) - * DPDK 2.(X+1) needs to change foo to be int foo(int index) - * - * To accomplish this: - * 1) Edit lib//library_version.map to add a DPDK_2.(X+1) node, in which - * foo is exported as a global symbol. - * - * 2) rename the existing function int foo(char *string) to - * int __vsym foo_v20(char *string) - * - * 3) Add this macro immediately below the function - * VERSION_SYMBOL(foo, _v20, 2.0); - * - * 4) Implement a new version of foo. - * char foo(int value, int otherval) { ...} - * - * 5) Mark the newest version as the default version - * BIND_DEFAULT_SYMBOL(foo, 2.1); + * immediately recompiled. * + * Refer to the guidelines document in the docs subdirectory for details on the + * use of these macros */ /* @@ -72,6 +31,8 @@ * b - function base name * e - function version extension, to be concatenated with base name * n - function symbol version string to be applied + * f - function prototype + * p - full function symbol name */ /* @@ -79,36 +40,53 @@ * Creates a symbol version table entry binding symbol @DPDK_ to the internal * function name _ */ -#define VERSION_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", "RTE_STR(b)"@DPDK_"RTE_STR(n)) - -/* - * BASE_SYMBOL - * Creates a symbol version table entry binding unversioned symbol - * to the internal function _ - */ -#define BASE_SYMBOL(b, e) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", "RTE_STR(b)"@") +#define VERSION_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", " RTE_STR(b) "@DPDK_" RTE_STR(n)) /* - * BNID_DEFAULT_SYMBOL + * BIND_DEFAULT_SYMBOL * Creates a symbol version entry instructing the linker to bind references to * symbol to the internal symbol _ */ -#define BIND_DEFAULT_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", "RTE_STR(b)"@@DPDK_"RTE_STR(n)) +#define BIND_DEFAULT_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", " RTE_STR(b) "@@DPDK_" RTE_STR(n)) #define __vsym __attribute__((used)) +/* + * MAP_STATIC_SYMBOL + * If a function has been bifurcated into multiple versions, none of which + * are defined as the exported symbol name in the map file, this macro can be + * used to alias a specific version of the symbol to its exported name. For + * example, if you have 2 versions of a function foo_v1 and foo_v2, where the + * former is mapped to foo@DPDK_1 and the latter is mapped to foo@DPDK_2 when + * building a shared library, this macro can be used to map either foo_v1 or + * foo_v2 to the symbol foo when building a static library, e.g.: + * MAP_STATIC_SYMBOL(void foo(), foo_v2); + */ +#define MAP_STATIC_SYMBOL(f, p) + #else /* * No symbol versioning in use */ -#define VERSION_SYMBOL(b, e, v) +#define VERSION_SYMBOL(b, e, n) #define __vsym -#define BASE_SYMBOL(b, n) -#define BIND_DEFAULT_SYMBOL(b, v) - +#define BIND_DEFAULT_SYMBOL(b, e, n) +#define MAP_STATIC_SYMBOL(f, p) f __attribute__((alias(RTE_STR(p)))) /* * RTE_BUILD_SHARED_LIB=n */ #endif +#ifndef ALLOW_EXPERIMENTAL_API + +#define __rte_experimental \ +__attribute__((deprecated("Symbol is not yet part of stable ABI"), \ +section(".text.experimental"))) + +#else + +#define __rte_experimental \ +__attribute__((section(".text.experimental"))) + +#endif #endif /* _RTE_COMPAT_H_ */