cleanup compat header inclusions

With symbols going though experimental/stable stages, we accumulated
a lot of discrepancies about inclusion of the rte_compat.h header.

Some headers are including it where unneeded, while others rely on
implicit inclusion.

Fix unneeded inclusions:
$ git grep -l include..rte_compat.h |
  xargs grep -LE '__rte_(internal|experimental)' |
  xargs sed -i -e '/#include..rte_compat.h/d'

Fix missing inclusion, by inserting rte_compat.h before the first
inclusion of a DPDK header:
$ git grep -lE '__rte_(internal|experimental)' |
  xargs grep -L include..rte_compat.h |
  xargs sed -i -e \
    '0,/#include..\(rte_\|.*pmd.h.$\)/{
      s/\(#include..\(rte_\|.*pmd.h.$\)\)/#include <rte_compat.h>\n\1/
    }'

Fix missing inclusion, by inserting rte_compat.h after the last
inclusion of a non DPDK header:
$ for file in $(git grep -lE '__rte_(internal|experimental)' |
  xargs grep -L include..rte_compat.h); do
    tac $file > $file.$$
    sed -i -e \
      '0,/#include../{
        s/\(#include..*$\)/#include <rte_compat.h>\n\n\1/
      }' $file.$$
    tac $file.$$ > $file
    rm $file.$$
  done

Fix missing inclusion, by inserting rte_compat.h after the header guard:
$ git grep -lE '__rte_(internal|experimental)' |
  xargs grep -L include..rte_compat.h |
  xargs sed -i -e \
    '0,/#define/{
      s/\(#define .*$\)/\1\n\n#include <rte_compat.h>/
    }'

And finally, exclude rte_compat.h itself.
$ git checkout lib/eal/include/rte_compat.h

At the end of all this, we have a clean tree:
$ git grep -lE '__rte_(internal|experimental)' |
  xargs grep -L include..rte_compat.h
buildtools/check-symbols.sh
devtools/checkpatches.sh
doc/guides/contributing/abi_policy.rst
doc/guides/rel_notes/release_20_11.rst
lib/eal/include/rte_compat.h

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
This commit is contained in:
David Marchand 2022-10-28 14:13:39 +02:00
parent 3af7276eaf
commit 1094dd940e
129 changed files with 127 additions and 22 deletions

View File

@ -18,6 +18,7 @@
#include <stdint.h>
#include <stdbool.h>
#include <rte_compat.h>
#include "rte_acc_common_cfg.h"
#ifdef __cplusplus

View File

@ -8,6 +8,8 @@
#include <stdint.h>
#include <stdbool.h>
#include <rte_compat.h>
/**
* @file rte_pmd_fpga_5gnr_fec.h
*

View File

@ -8,6 +8,8 @@
#include <stdint.h>
#include <stdbool.h>
#include <rte_compat.h>
/**
* @file fpga_lte_fec.h
*

View File

@ -7,6 +7,8 @@
#ifndef __FSL_BMAN_H
#define __FSL_BMAN_H
#include <rte_compat.h>
#ifdef __cplusplus
extern "C" {
#endif

View File

@ -13,6 +13,7 @@ extern "C" {
#endif
#include <dpaa_rbtree.h>
#include <rte_compat.h>
#include <rte_eventdev.h>
/* FQ lookups (turn this on for 64bit user-space) */

View File

@ -13,6 +13,8 @@
#include <dpaa_list.h>
#include <fsl_qman.h>
#include <rte_compat.h>
#ifdef __cplusplus
extern "C" {
#endif

View File

@ -10,6 +10,8 @@
#include <fman.h>
#include <rte_compat.h>
/* Configuration information related to a specific ethernet port */
struct fm_eth_port_cfg {
/**< A list of PCD FQ ranges, obtained from FMC configuration */

View File

@ -10,6 +10,7 @@
#define __PROCESS_H
#include <compat.h>
#include <rte_compat.h>
#include <rte_ethdev.h>
/* The process device underlies process-wide user/kernel interactions, such as

View File

@ -9,6 +9,8 @@
#include <fsl_dpopr.h>
#include <rte_compat.h>
/* Data Path Communication Interface API
* Contains initialization APIs and runtime control APIs for DPCI
*/

View File

@ -7,6 +7,8 @@
#ifndef __FSL_DPCON_H
#define __FSL_DPCON_H
#include <rte_compat.h>
/* Data Path Concentrator API
* Contains initialization APIs and runtime control APIs for DPCON
*/

View File

@ -11,6 +11,8 @@
#include <mc/fsl_dpio.h>
#include <mc/fsl_mc_sys.h>
#include <rte_compat.h>
struct dpaa2_io_portal_t {
struct dpaa2_dpio_dev *dpio_dev;
struct dpaa2_dpio_dev *ethrx_dpio_dev;

View File

@ -8,6 +8,7 @@
#ifndef _DPAA2_HW_PVT_H_
#define _DPAA2_HW_PVT_H_
#include <rte_compat.h>
#include <rte_eventdev.h>
#include <dpaax_iova_table.h>

View File

@ -22,6 +22,7 @@ extern "C" {
#include <stdint.h>
#include <inttypes.h>
#include <rte_compat.h>
#include <rte_debug.h>
#include <rte_interrupts.h>
#include <rte_pci.h>

View File

@ -23,7 +23,6 @@ extern "C" {
#include <stdint.h>
#include <inttypes.h>
#include <rte_compat.h>
#include <rte_uuid.h>
#include <rte_debug.h>
#include <rte_interrupts.h>

View File

@ -5,6 +5,7 @@
#ifndef _ROC_PLATFORM_H_
#define _ROC_PLATFORM_H_
#include <rte_compat.h>
#include <rte_alarm.h>
#include <rte_bitmap.h>
#include <bus_pci_driver.h>

View File

@ -5,6 +5,8 @@
#ifndef _CPT_PMD_OPS_HELPER_H_
#define _CPT_PMD_OPS_HELPER_H_
#include <rte_compat.h>
/*
* This file defines the agreement between the common layer and the individual
* crypto drivers for OCTEON TX series. Control path in otx* directory can

View File

@ -19,6 +19,7 @@
#include <errno.h>
#include <arpa/inet.h>
#include <rte_compat.h>
#include <rte_eal.h>
#include <rte_branch_prediction.h>
#include <rte_memory.h>

View File

@ -9,6 +9,8 @@
#include "iavf_alloc.h"
#include "virtchnl.h"
#include <rte_compat.h>
/* Prototypes for shared code functions that are not in
* the standard function pointer structures. These are
* mostly because they are needed even before the init

View File

@ -9,6 +9,8 @@
#include "idpf_mem.h"
#else /* !__KERNEL__ */
#include "idpf_osdep.h"
#include <rte_compat.h>
#endif /* !__KERNEL__ */
struct idpf_hw;

View File

@ -8,6 +8,7 @@
#include <stdio.h>
#include <malloc.h>
#include <rte_compat.h>
#include <rte_pci.h>
#include <bus_pci_driver.h>
#include <rte_debug.h>

View File

@ -7,6 +7,7 @@
#include <linux/netlink.h>
#include <rte_compat.h>
#include <rte_ether.h>
#include "mlx5_common.h"

View File

@ -7,6 +7,7 @@
#include <stdio.h>
#include <rte_compat.h>
#include <rte_pci.h>
#include <bus_pci_driver.h>
#include <rte_debug.h>

View File

@ -7,6 +7,8 @@
#include "mlx5_devx_cmds.h"
#include <rte_compat.h>
/* The standard page size */
#define MLX5_LOG_PAGE_SIZE 12

View File

@ -7,6 +7,7 @@
#define RTE_PMD_MLX5_COMMON_MP_H_
#include <mlx5_glue.h>
#include <rte_compat.h>
#include <rte_eal.h>
#include <rte_string_fns.h>

View File

@ -11,6 +11,7 @@
#include <sys/queue.h>
#include <rte_compat.h>
#include <rte_rwlock.h>
#include <rte_bitmap.h>
#include <rte_mbuf.h>

View File

@ -5,6 +5,7 @@
#ifndef RTE_PMD_MLX5_COMMON_UTILS_H_
#define RTE_PMD_MLX5_COMMON_UTILS_H_
#include <rte_compat.h>
#include <rte_rwlock.h>
#include "mlx5_common.h"

View File

@ -5,6 +5,8 @@
#ifndef MLX5_MALLOC_H_
#define MLX5_MALLOC_H_
#include <rte_compat.h>
#ifdef __cplusplus
extern "C" {
#endif

View File

@ -8,6 +8,7 @@
#include <stdio.h>
#include <sys/types.h>
#include <rte_compat.h>
#include <rte_errno.h>
#include <rte_interrupts.h>

View File

@ -5,6 +5,7 @@
#ifndef __OCTEONTX_MBOX_H__
#define __OCTEONTX_MBOX_H__
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_spinlock.h>

View File

@ -12,6 +12,7 @@
#include <stdbool.h>
#include <rte_compat.h>
#include <rte_spinlock.h>
#include <rte_byteorder.h>
#include <rte_debug.h>

View File

@ -15,6 +15,8 @@
#include "efx.h"
#include "efsys.h"
#include <rte_compat.h>
#ifdef __cplusplus
extern "C" {
#endif

View File

@ -12,6 +12,7 @@
#include <stdint.h>
#include <rte_compat.h>
#include <rte_spinlock.h>
#include "efsys.h"

View File

@ -5,6 +5,7 @@
#ifndef _CN10K_CRYPTODEV_OPS_H_
#define _CN10K_CRYPTODEV_OPS_H_
#include <rte_compat.h>
#include <cryptodev_pmd.h>
#include <rte_cryptodev.h>
#include <rte_eventdev.h>

View File

@ -5,6 +5,7 @@
#ifndef _CN9K_CRYPTODEV_OPS_H_
#define _CN9K_CRYPTODEV_OPS_H_
#include <rte_compat.h>
#include <cryptodev_pmd.h>
extern struct rte_cryptodev_ops cn9k_cpt_ops;

View File

@ -6,6 +6,8 @@
#ifndef _DPAA2_SEC_EVENT_H_
#define _DPAA2_SEC_EVENT_H_
#include <rte_compat.h>
__rte_internal
int dpaa2_sec_eventq_attach(const struct rte_cryptodev *dev,
int qp_id,

View File

@ -6,6 +6,8 @@
#ifndef _DPAA_SEC_EVENT_H_
#define _DPAA_SEC_EVENT_H_
#include <rte_compat.h>
__rte_internal
int dpaa_sec_eventq_attach(const struct rte_cryptodev *dev,
int qp_id,

View File

@ -5,6 +5,7 @@
#ifndef _OTX_CRYPTODEV_OPS_H_
#define _OTX_CRYPTODEV_OPS_H_
#include <rte_compat.h>
#include <cryptodev_pmd.h>
#define OTX_CPT_MIN_HEADROOM_REQ (24)

View File

@ -5,6 +5,8 @@
#ifndef _RTE_PMD_DPAA2_QDMA_H_
#define _RTE_PMD_DPAA2_QDMA_H_
#include <rte_compat.h>
/** States if the source addresses is physical. */
#define RTE_DPAA2_QDMA_JOB_SRC_PHY (1ULL << 30)

View File

@ -17,6 +17,8 @@ extern "C" {
#include <stdint.h>
#include <rte_compat.h>
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice

View File

@ -8,6 +8,8 @@
#ifndef _DPAA2_HW_DPBP_H_
#define _DPAA2_HW_DPBP_H_
#include <rte_compat.h>
#define DPAA2_MAX_BUF_POOLS 8
struct buf_pool_cfg {

View File

@ -16,6 +16,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_mempool.h>
/**

View File

@ -10,7 +10,6 @@
#include <rte_malloc.h>
#include <rte_errno.h>
#include <rte_cycles.h>
#include <rte_compat.h>
#include "eth_bond_private.h"

View File

@ -9,6 +9,7 @@
#include <ethdev_driver.h>
#include <ethdev_pci.h>
#include <rte_compat.h>
#include <rte_kvargs.h>
#include <rte_mbuf.h>
#include <rte_mbuf_pool_ops.h>

View File

@ -10,6 +10,7 @@
/* System headers */
#include <stdbool.h>
#include <ethdev_driver.h>
#include <rte_compat.h>
#include <rte_event_eth_rx_adapter.h>
#include <fsl_usd.h>

View File

@ -8,6 +8,7 @@
#ifndef _DPAA2_ETHDEV_H
#define _DPAA2_ETHDEV_H
#include <rte_compat.h>
#include <rte_event_eth_rx_adapter.h>
#include <rte_pmd_dpaa2.h>

View File

@ -11,6 +11,7 @@
* NXP dpaa2 PMD specific functions.
*/
#include <rte_compat.h>
#include <rte_flow.h>
/**

View File

@ -15,6 +15,7 @@
*/
#include <stdio.h>
#include <rte_compat.h>
#include <rte_mbuf.h>
#include <rte_mbuf_dyn.h>

View File

@ -5,6 +5,7 @@
#ifndef _ICE_ETHDEV_H_
#define _ICE_ETHDEV_H_
#include <rte_compat.h>
#include <rte_kvargs.h>
#include <rte_time.h>

View File

@ -5,6 +5,8 @@
#ifndef RTE_PMD_PRIVATE_MLX5_H_
#define RTE_PMD_PRIVATE_MLX5_H_
#include <rte_compat.h>
/**
* @file
* MLX5 public header.

View File

@ -12,7 +12,6 @@
#ifndef _PMD_TXGBE_H_
#define _PMD_TXGBE_H_
#include <rte_compat.h>
#include <rte_ethdev.h>
#include <rte_ether.h>

View File

@ -27,6 +27,7 @@ extern "C" {
#include <stdint.h>
#include <stdbool.h>
#include <rte_compat.h>
#include <rte_cpuflags.h>
#include "rte_bbdev_op.h"

View File

@ -17,6 +17,7 @@ extern "C" {
#include <stdint.h>
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_mbuf.h>
#include <rte_memory.h>

View File

@ -16,6 +16,7 @@
* (https://www.kernel.org/doc/Documentation/networking/filter.txt).
*/
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_mbuf.h>
#include <bpf_def.h>

View File

@ -16,6 +16,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_mbuf.h>
/**

View File

@ -22,6 +22,7 @@ extern "C" {
#endif
#include <rte_compat.h>
#include "rte_comp.h"
/**

View File

@ -21,6 +21,7 @@ extern "C" {
#include <dev_driver.h>
#include <rte_compat.h>
#include "rte_compressdev.h"
#include "rte_compressdev_internal.h"

View File

@ -20,6 +20,7 @@ extern "C" {
#include <string.h>
#include <dev_driver.h>
#include <rte_compat.h>
#include <rte_malloc.h>
#include <rte_log.h>
#include <rte_common.h>

View File

@ -20,6 +20,7 @@ extern "C" {
#include <string.h>
#include <rte_compat.h>
#include <rte_mbuf.h>
#include <rte_memory.h>
#include <rte_mempool.h>

View File

@ -18,6 +18,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include "rte_kvargs.h"
#include "rte_crypto.h"
#include <rte_common.h>

View File

@ -16,6 +16,7 @@
#include <dev_driver.h>
#include <rte_compat.h>
#include "rte_dmadev.h"
#ifdef __cplusplus

View File

@ -14,6 +14,7 @@ extern "C" {
#define RTE_OVERRIDE_IO_H
#include "generic/rte_io.h"
#include <rte_compat.h>
#include "rte_atomic_64.h"
static __rte_always_inline uint8_t

View File

@ -9,6 +9,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include "generic/rte_prefetch.h"

View File

@ -9,6 +9,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include "generic/rte_prefetch.h"

View File

@ -21,7 +21,6 @@
#include <sys/queue.h>
#include <sys/stat.h>
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_debug.h>
#include <rte_memory.h>

View File

@ -3,7 +3,6 @@
*/
#include <rte_log.h>
#include <rte_compat.h>
#include <rte_dev.h>
int

View File

@ -13,6 +13,7 @@
*/
#include <stdint.h>
#include <rte_compat.h>
#include <rte_common.h>
#ifdef __DOXYGEN__

View File

@ -13,7 +13,6 @@
*/
#include <stdint.h>
#include <rte_compat.h>
#include <rte_debug.h>
#include <rte_atomic.h>

View File

@ -17,7 +17,6 @@
#include <assert.h>
#include <rte_common.h>
#include <rte_atomic.h>
#include <rte_compat.h>
/**
* Pause CPU execution for a short while

View File

@ -36,6 +36,7 @@ extern "C" {
***/
#include <string.h>
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_config.h>
#include <rte_debug.h>

View File

@ -22,6 +22,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_dev.h>
/** Double linked list of classes */

View File

@ -7,7 +7,6 @@
#include <stdbool.h>
#include <rte_compat.h>
/**
* @file

View File

@ -13,7 +13,6 @@
#include <stdint.h>
#include <rte_compat.h>
#ifdef __cplusplus
extern "C" {

View File

@ -36,7 +36,6 @@ extern "C" {
#include <stdio.h>
#include <rte_compat.h>
#include <rte_rwlock.h>
#define RTE_FBARRAY_NAME_LEN 64

View File

@ -13,6 +13,7 @@
*/
#include <stdio.h>
#include <rte_compat.h>
#include <rte_config.h>
#include <rte_per_lcore.h>
#include <rte_eal.h>

View File

@ -24,7 +24,6 @@ extern "C" {
#include <rte_common.h>
#include <rte_config.h>
#include <rte_compat.h>
/* SDK log type */
#define RTE_LOGTYPE_EAL 0 /**< Log related to eal. */

View File

@ -13,7 +13,6 @@
#include <stdio.h>
#include <stddef.h>
#include <rte_compat.h>
#include <rte_memory.h>
#ifdef __cplusplus

View File

@ -21,7 +21,6 @@ extern "C" {
#include <rte_bitops.h>
#include <rte_common.h>
#include <rte_compat.h>
#include <rte_config.h>
#include <rte_fbarray.h>

View File

@ -23,7 +23,6 @@
*/
#include <stdio.h>
#include <rte_compat.h>
#include <rte_memory.h>
#include <rte_common.h>

View File

@ -31,6 +31,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_pause.h>

View File

@ -30,6 +30,7 @@ extern "C" {
#include<stdio.h>
#include <stdint.h>
#include <rte_compat.h>
#include <rte_config.h>
#include <rte_lcore.h>

View File

@ -14,7 +14,6 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_service.h>
/**

View File

@ -9,6 +9,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include "generic/rte_prefetch.h"

View File

@ -17,7 +17,6 @@ extern "C" {
#endif
#include <stdint.h>
#include <rte_compat.h>
#include "generic/rte_atomic.h"
#define rte_mb() asm volatile("sync" : : : "memory")

View File

@ -10,6 +10,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include "generic/rte_prefetch.h"

View File

@ -12,6 +12,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include "generic/rte_prefetch.h"

View File

@ -9,6 +9,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include "rte_cpuflags.h"
#define RTE_NATIVE_WRITE32_WC

View File

@ -9,6 +9,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include "generic/rte_prefetch.h"

View File

@ -20,6 +20,7 @@ extern "C" {
*/
#include <dev_driver.h>
#include <rte_compat.h>
#include <rte_ethdev.h>
/**

View File

@ -17,6 +17,7 @@
#include <stddef.h>
#include <stdint.h>
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_ether.h>
#include <rte_icmp.h>

View File

@ -22,6 +22,7 @@
#include <stdint.h>
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_meter.h>

View File

@ -19,6 +19,7 @@ extern "C" {
#include <string.h>
#include <rte_compat.h>
#include <rte_config.h>
#include <rte_eal.h>
#include <rte_lcore.h>

View File

@ -19,6 +19,7 @@ extern "C" {
#include <string.h>
#include <rte_compat.h>
#include <rte_config.h>
#include <rte_debug.h>
#include <rte_eal.h>

View File

@ -87,6 +87,7 @@ extern "C" {
#include <stdint.h>
#include <rte_compat.h>
#include <rte_service.h>
#include "rte_eventdev.h"

View File

@ -79,6 +79,7 @@ extern "C" {
#include <stdint.h>
#include <rte_compat.h>
#include <rte_mbuf.h>
#include "rte_eventdev.h"

View File

@ -210,6 +210,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_errno.h>
#include <rte_mbuf_pool_ops.h>

View File

@ -16,6 +16,7 @@
#include <dev_driver.h>
#include <rte_compat.h>
#include "rte_gpudev.h"
/* Flags indicate current state of device. */

View File

@ -16,6 +16,7 @@
* process, enqueue and move streams of objects to the next nodes.
*/
#include <rte_compat.h>
#include <rte_common.h>
#include <rte_cycles.h>
#include <rte_prefetch.h>

View File

@ -14,7 +14,6 @@
#include <stdint.h>
#include <stddef.h>
#include <rte_compat.h>
#include <rte_rcu_qsbr.h>
#ifdef __cplusplus

View File

@ -20,6 +20,7 @@ extern "C" {
#endif
#include <stdint.h>
#include <rte_compat.h>
#include <rte_byteorder.h>
#include <rte_ip.h>
#include <rte_common.h>

View File

@ -9,6 +9,7 @@
extern "C" {
#endif
#include <rte_compat.h>
#include <rte_log.h>
#ifdef RTE_ARCH_X86

Some files were not shown because too many files have changed in this diff Show More