1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _NF_LOG_H
3#define _NF_LOG_H
4
5#include <linux/netfilter.h>
6#include <linux/netfilter/nf_log.h>
7
8/* Log tcp sequence, tcp options, ip options and uid owning local socket */
9#define NF_LOG_DEFAULT_MASK	0x0f
10
11/* This flag indicates that copy_len field in nf_loginfo is set */
12#define NF_LOG_F_COPY_LEN	0x1
13
14enum nf_log_type {
15	NF_LOG_TYPE_LOG		= 0,
16	NF_LOG_TYPE_ULOG,
17	NF_LOG_TYPE_MAX
18};
19
20struct nf_loginfo {
21	u_int8_t type;
22	union {
23		struct {
24			/* copy_len will be used iff you set
25			 * NF_LOG_F_COPY_LEN in flags
26			 */
27			u_int32_t copy_len;
28			u_int16_t group;
29			u_int16_t qthreshold;
30			u_int16_t flags;
31		} ulog;
32		struct {
33			u_int8_t level;
34			u_int8_t logflags;
35		} log;
36	} u;
37};
38
39typedef void nf_logfn(struct net *net,
40		      u_int8_t pf,
41		      unsigned int hooknum,
42		      const struct sk_buff *skb,
43		      const struct net_device *in,
44		      const struct net_device *out,
45		      const struct nf_loginfo *li,
46		      const char *prefix);
47
48struct nf_logger {
49	char			*name;
50	enum nf_log_type	type;
51	nf_logfn 		*logfn;
52	struct module		*me;
53};
54
55/* sysctl_nf_log_all_netns - allow LOG target in all network namespaces */
56extern int sysctl_nf_log_all_netns;
57
58/* Function to register/unregister log function. */
59int nf_log_register(u_int8_t pf, struct nf_logger *logger);
60void nf_log_unregister(struct nf_logger *logger);
61
62int nf_log_set(struct net *net, u_int8_t pf, const struct nf_logger *logger);
63void nf_log_unset(struct net *net, const struct nf_logger *logger);
64
65int nf_log_bind_pf(struct net *net, u_int8_t pf,
66		   const struct nf_logger *logger);
67void nf_log_unbind_pf(struct net *net, u_int8_t pf);
68
69int nf_logger_find_get(int pf, enum nf_log_type type);
70void nf_logger_put(int pf, enum nf_log_type type);
71
72#define MODULE_ALIAS_NF_LOGGER(family, type) \
73	MODULE_ALIAS("nf-logger-" __stringify(family) "-" __stringify(type))
74
75/* Calls the registered backend logging function */
76__printf(8, 9)
77void nf_log_packet(struct net *net,
78		   u_int8_t pf,
79		   unsigned int hooknum,
80		   const struct sk_buff *skb,
81		   const struct net_device *in,
82		   const struct net_device *out,
83		   const struct nf_loginfo *li,
84		   const char *fmt, ...);
85
86__printf(8, 9)
87void nf_log_trace(struct net *net,
88		  u_int8_t pf,
89		  unsigned int hooknum,
90		  const struct sk_buff *skb,
91		  const struct net_device *in,
92		  const struct net_device *out,
93		  const struct nf_loginfo *li,
94		  const char *fmt, ...);
95
96struct nf_log_buf;
97
98struct nf_log_buf *nf_log_buf_open(void);
99__printf(2, 3) int nf_log_buf_add(struct nf_log_buf *m, const char *f, ...);
100void nf_log_buf_close(struct nf_log_buf *m);
101#endif /* _NF_LOG_H */
102