zephyr/subsys/net/ip/tp_priv.h
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00

81 lines
1.4 KiB
C

/*
* Copyright (c) 2018-2019 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef TP_PRIV_H
#define TP_PRIV_H
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/types.h>
#include <string.h>
#include <zephyr/kernel.h>
#include <zephyr/net/net_pkt.h>
#define tp_dbg(fmt, args...) printk("%s: " fmt "\n", __func__, ## args)
#define tp_err(fmt, args...) do { \
printk("%s: Error: " fmt "\n", __func__, ## args); \
k_oops(); \
} while (0)
#define tp_assert(cond, fmt, args...) do { \
if ((cond) == false) { \
printk("%s: Assertion failed: %s, " fmt "\n", \
__func__, #cond, ## args); \
k_oops(); \
} \
} while (0)
#define is(_a, _b) (strcmp((_a), (_b)) == 0)
#define ip_get(_x) ((struct net_ipv4_hdr *) net_pkt_ip_data((_x)))
#define TP_MEM_HEADER_COOKIE 0xAAAAAAAA
#define TP_MEM_FOOTER_COOKIE 0xBBBBBBBB
struct tp_mem {
sys_snode_t next;
const char *file;
int line;
const char *func;
size_t size;
uint32_t *footer;
uint32_t header;
uint8_t mem[];
};
struct tp_nbuf {
sys_snode_t next;
struct net_buf *nbuf;
const char *file;
int line;
};
struct tp_pkt {
sys_snode_t next;
struct net_pkt *pkt;
const char *file;
int line;
};
struct tp_seq {
sys_snode_t next;
const char *file;
int line;
const char *func;
int kind;
int req;
uint32_t value;
uint32_t old_value;
int of;
};
#ifdef __cplusplus
}
#endif
#endif /* TP_PRIV_H */