numam-dpdk/lib/regexdev/rte_regexdev_driver.h
Thomas Monjalon 89e290eb8c regexdev: fix section attribute of symbols
The functions used by the drivers must be internal,
while the function and variables used in inline functions
must be experimental.

These are the changes done in the shared library:
- DF .text  Base          rte_regexdev_get_device_by_name
+ DF .text  INTERNAL      rte_regexdev_get_device_by_name
- DF .text  Base          rte_regexdev_register
+ DF .text  INTERNAL      rte_regexdev_register
- DF .text  Base          rte_regexdev_unregister
+ DF .text  INTERNAL      rte_regexdev_unregister
- DF .text  Base          rte_regexdev_is_valid_dev
+ DF .text  EXPERIMENTAL  rte_regexdev_is_valid_dev
- DO .bss   Base          rte_regex_devices
+ DO .bss   EXPERIMENTAL  rte_regex_devices
- DO .bss   Base          rte_regexdev_logtype
+ DO .bss   EXPERIMENTAL  rte_regexdev_logtype

Because these symbols were exported in the default section in DPDK 21.11,
any change in these functions would be seen as incompatible
by the ABI compatibility check.
An exception rule is added for this experimental library,
so the ABI check will skip it until the next ABI version.

Fixes: bab9497ef7 ("regexdev: introduce API")
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Ori Kam <orika@nvidia.com>
2022-03-08 15:22:28 +01:00

63 lines
1.1 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright 2020 Mellanox Technologies, Ltd
*/
#ifndef _RTE_REGEXDEV_DRIVER_H_
#define _RTE_REGEXDEV_DRIVER_H_
/**
* @file
*
* RTE RegEx Device PMD API
*
* APIs that are used by the RegEx drivers, to communicate with the
* RegEx lib.
*/
#include "rte_regexdev.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @internal
* Register a RegEx device slot for a RegEx device and return the
* pointer to that slot.
*
* @param name
* RegEx device name.
*
* @return
* A pointer to the RegEx device slot case of success,
* NULL otherwise.
*/
__rte_internal
struct rte_regexdev *rte_regexdev_register(const char *name);
/**
* @internal
* Unregister the specified regexdev port.
*
* @param dev
* Device to be released.
*/
__rte_internal
void rte_regexdev_unregister(struct rte_regexdev *dev);
/**
* @internal
* Return the RegEx device based on the device name.
*
* @param name
* The device name.
*/
__rte_internal
struct rte_regexdev *rte_regexdev_get_device_by_name(const char *name);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_REGEXDEV_DRIVER_H_ */