18218713bf
Putting a '__attribute__((deprecated))' in the middle of a function
prototype does not result in the expected result with gcc (while clang
is fine with this syntax).
$ cat deprecated.c
void * __attribute__((deprecated)) incorrect() { return 0; }
__attribute__((deprecated)) void *correct(void) { return 0; }
int main(int argc, char *argv[]) { incorrect(); correct(); return 0; }
$ gcc -o deprecated.o -c deprecated.c
deprecated.c: In function ‘main’:
deprecated.c:3:1: warning: ‘correct’ is deprecated (declared at
deprecated.c:2) [-Wdeprecated-declarations]
int main(int argc, char *argv[]) { incorrect(); correct(); return 0; }
^
Move the tag on a separate line and make it the first thing of function
prototypes.
This is not perfect but we will trust reviewers to catch the other not
so easy to detect patterns.
sed -i \
-e '/^\([^#].*\)\?__rte_experimental */{' \
-e 's//\1/; s/ *$//; i\' \
-e __rte_experimental \
-e '/^$/d}' \
$(git grep -l __rte_experimental -- '*.h')
Special mention for rte_mbuf_data_addr_default():
There is either a bug or a (not yet understood) issue with gcc.
gcc won't drop this inline when unused and rte_mbuf_data_addr_default()
calls rte_mbuf_buf_addr() which itself is experimental.
This results in a build warning when not accepting experimental apis
from sources just including rte_mbuf.h.
For this specific case, we hide the call to rte_mbuf_buf_addr() under
the ALLOW_EXPERIMENTAL_API flag.
Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
Signed-off-by: David Marchand <david.marchand@redhat.com>
70 lines
1.3 KiB
C
70 lines
1.3 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2018 Intel Corporation
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifndef _RTE_TELEMETRY_H_
|
|
#define _RTE_TELEMETRY_H_
|
|
|
|
/**
|
|
* @file
|
|
* RTE Telemetry
|
|
*
|
|
* The telemetry library provides a method to retrieve statistics from
|
|
* DPDK by sending a JSON encoded message over a socket. DPDK will send
|
|
* a JSON encoded response containing telemetry data.
|
|
***/
|
|
|
|
/**
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*
|
|
* Initialize Telemetry
|
|
*
|
|
* @return
|
|
* 0 on successful initialisation.
|
|
* @return
|
|
* -ENOMEM on memory allocation error
|
|
* @return
|
|
* -EPERM on unknown error failure
|
|
* @return
|
|
* -EALREADY if Telemetry is already initialised.
|
|
*/
|
|
__rte_experimental
|
|
int32_t
|
|
rte_telemetry_init(void);
|
|
|
|
/**
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*
|
|
* Clean up and free memory.
|
|
*
|
|
* @return
|
|
* 0 on success
|
|
* @return
|
|
* -EPERM on failure
|
|
*/
|
|
__rte_experimental
|
|
int32_t
|
|
rte_telemetry_cleanup(void);
|
|
|
|
/**
|
|
* @warning
|
|
* @b EXPERIMENTAL: this API may change without prior notice
|
|
*
|
|
* Runs various tests to ensure telemetry initialisation and register/unregister
|
|
* functions are working correctly.
|
|
*
|
|
* @return
|
|
* 0 on success when all tests have passed
|
|
* @return
|
|
* -1 on failure when the test has failed
|
|
*/
|
|
__rte_experimental
|
|
int32_t
|
|
rte_telemetry_selftest(void);
|
|
|
|
#endif
|