1 // SPDX-License-Identifier: GPL-2.0-only
2 #include <linux/kernel.h>
3 #include <linux/init.h>
4 #include <linux/module.h>
5 #include <linux/proc_fs.h>
6 #include <linux/skbuff.h>
7 #include <linux/netfilter.h>
8 #include <linux/seq_file.h>
9 #include <net/protocol.h>
10 #include <net/netfilter/nf_log.h>
12 #include "nf_internals.h"
14 /* Internal logging interface, which relies on the real
17 #define NFLOGGER_NAME_LEN 64
19 int sysctl_nf_log_all_netns __read_mostly;
20 EXPORT_SYMBOL(sysctl_nf_log_all_netns);
22 static struct nf_logger __rcu *loggers[NFPROTO_NUMPROTO][NF_LOG_TYPE_MAX] __read_mostly;
23 static DEFINE_MUTEX(nf_log_mutex);
25 #define nft_log_dereference(logger) \
26 rcu_dereference_protected(logger, lockdep_is_held(&nf_log_mutex))
28 static struct nf_logger *__find_logger(int pf, const char *str_logger)
30 struct nf_logger *log;
33 for (i = 0; i < NF_LOG_TYPE_MAX; i++) {
34 if (loggers[pf][i] == NULL)
37 log = nft_log_dereference(loggers[pf][i]);
38 if (!strncasecmp(str_logger, log->name, strlen(log->name)))
45 int nf_log_set(struct net *net, u_int8_t pf, const struct nf_logger *logger)
47 const struct nf_logger *log;
49 if (pf == NFPROTO_UNSPEC || pf >= ARRAY_SIZE(net->nf.nf_loggers))
52 mutex_lock(&nf_log_mutex);
53 log = nft_log_dereference(net->nf.nf_loggers[pf]);
55 rcu_assign_pointer(net->nf.nf_loggers[pf], logger);
57 mutex_unlock(&nf_log_mutex);
61 EXPORT_SYMBOL(nf_log_set);
63 void nf_log_unset(struct net *net, const struct nf_logger *logger)
66 const struct nf_logger *log;
68 mutex_lock(&nf_log_mutex);
69 for (i = 0; i < NFPROTO_NUMPROTO; i++) {
70 log = nft_log_dereference(net->nf.nf_loggers[i]);
72 RCU_INIT_POINTER(net->nf.nf_loggers[i], NULL);
74 mutex_unlock(&nf_log_mutex);
76 EXPORT_SYMBOL(nf_log_unset);
78 /* return EEXIST if the same logger is registered, 0 on success. */
79 int nf_log_register(u_int8_t pf, struct nf_logger *logger)
84 if (pf >= ARRAY_SIZE(init_net.nf.nf_loggers))
87 mutex_lock(&nf_log_mutex);
89 if (pf == NFPROTO_UNSPEC) {
90 for (i = NFPROTO_UNSPEC; i < NFPROTO_NUMPROTO; i++) {
91 if (rcu_access_pointer(loggers[i][logger->type])) {
96 for (i = NFPROTO_UNSPEC; i < NFPROTO_NUMPROTO; i++)
97 rcu_assign_pointer(loggers[i][logger->type], logger);
99 if (rcu_access_pointer(loggers[pf][logger->type])) {
103 rcu_assign_pointer(loggers[pf][logger->type], logger);
107 mutex_unlock(&nf_log_mutex);
110 EXPORT_SYMBOL(nf_log_register);
112 void nf_log_unregister(struct nf_logger *logger)
114 const struct nf_logger *log;
117 mutex_lock(&nf_log_mutex);
118 for (i = 0; i < NFPROTO_NUMPROTO; i++) {
119 log = nft_log_dereference(loggers[i][logger->type]);
121 RCU_INIT_POINTER(loggers[i][logger->type], NULL);
123 mutex_unlock(&nf_log_mutex);
126 EXPORT_SYMBOL(nf_log_unregister);
128 int nf_log_bind_pf(struct net *net, u_int8_t pf,
129 const struct nf_logger *logger)
131 if (pf >= ARRAY_SIZE(net->nf.nf_loggers))
133 mutex_lock(&nf_log_mutex);
134 if (__find_logger(pf, logger->name) == NULL) {
135 mutex_unlock(&nf_log_mutex);
138 rcu_assign_pointer(net->nf.nf_loggers[pf], logger);
139 mutex_unlock(&nf_log_mutex);
142 EXPORT_SYMBOL(nf_log_bind_pf);
144 void nf_log_unbind_pf(struct net *net, u_int8_t pf)
146 if (pf >= ARRAY_SIZE(net->nf.nf_loggers))
148 mutex_lock(&nf_log_mutex);
149 RCU_INIT_POINTER(net->nf.nf_loggers[pf], NULL);
150 mutex_unlock(&nf_log_mutex);
152 EXPORT_SYMBOL(nf_log_unbind_pf);
154 void nf_logger_request_module(int pf, enum nf_log_type type)
156 if (loggers[pf][type] == NULL)
157 request_module("nf-logger-%u-%u", pf, type);
159 EXPORT_SYMBOL_GPL(nf_logger_request_module);
161 int nf_logger_find_get(int pf, enum nf_log_type type)
163 struct nf_logger *logger;
166 if (pf == NFPROTO_INET) {
167 ret = nf_logger_find_get(NFPROTO_IPV4, type);
171 ret = nf_logger_find_get(NFPROTO_IPV6, type);
173 nf_logger_put(NFPROTO_IPV4, type);
180 if (rcu_access_pointer(loggers[pf][type]) == NULL)
181 request_module("nf-logger-%u-%u", pf, type);
184 logger = rcu_dereference(loggers[pf][type]);
188 if (try_module_get(logger->me))
194 EXPORT_SYMBOL_GPL(nf_logger_find_get);
196 void nf_logger_put(int pf, enum nf_log_type type)
198 struct nf_logger *logger;
200 if (pf == NFPROTO_INET) {
201 nf_logger_put(NFPROTO_IPV4, type);
202 nf_logger_put(NFPROTO_IPV6, type);
206 BUG_ON(loggers[pf][type] == NULL);
209 logger = rcu_dereference(loggers[pf][type]);
210 module_put(logger->me);
213 EXPORT_SYMBOL_GPL(nf_logger_put);
215 void nf_log_packet(struct net *net,
217 unsigned int hooknum,
218 const struct sk_buff *skb,
219 const struct net_device *in,
220 const struct net_device *out,
221 const struct nf_loginfo *loginfo,
222 const char *fmt, ...)
225 char prefix[NF_LOG_PREFIXLEN];
226 const struct nf_logger *logger;
230 logger = rcu_dereference(loggers[pf][loginfo->type]);
232 logger = rcu_dereference(net->nf.nf_loggers[pf]);
236 vsnprintf(prefix, sizeof(prefix), fmt, args);
238 logger->logfn(net, pf, hooknum, skb, in, out, loginfo, prefix);
242 EXPORT_SYMBOL(nf_log_packet);
244 void nf_log_trace(struct net *net,
246 unsigned int hooknum,
247 const struct sk_buff *skb,
248 const struct net_device *in,
249 const struct net_device *out,
250 const struct nf_loginfo *loginfo, const char *fmt, ...)
253 char prefix[NF_LOG_PREFIXLEN];
254 const struct nf_logger *logger;
257 logger = rcu_dereference(net->nf.nf_loggers[pf]);
260 vsnprintf(prefix, sizeof(prefix), fmt, args);
262 logger->logfn(net, pf, hooknum, skb, in, out, loginfo, prefix);
266 EXPORT_SYMBOL(nf_log_trace);
268 #define S_SIZE (1024 - (sizeof(unsigned int) + 1))
272 char buf[S_SIZE + 1];
274 static struct nf_log_buf emergency, *emergency_ptr = &emergency;
276 __printf(2, 3) int nf_log_buf_add(struct nf_log_buf *m, const char *f, ...)
281 if (likely(m->count < S_SIZE)) {
283 len = vsnprintf(m->buf + m->count, S_SIZE - m->count, f, args);
285 if (likely(m->count + len < S_SIZE)) {
291 printk_once(KERN_ERR KBUILD_MODNAME " please increase S_SIZE\n");
294 EXPORT_SYMBOL_GPL(nf_log_buf_add);
296 struct nf_log_buf *nf_log_buf_open(void)
298 struct nf_log_buf *m = kmalloc(sizeof(*m), GFP_ATOMIC);
303 m = xchg(&emergency_ptr, NULL);
309 EXPORT_SYMBOL_GPL(nf_log_buf_open);
311 void nf_log_buf_close(struct nf_log_buf *m)
313 m->buf[m->count] = 0;
314 printk("%s\n", m->buf);
316 if (likely(m != &emergency))
323 EXPORT_SYMBOL_GPL(nf_log_buf_close);
325 #ifdef CONFIG_PROC_FS
326 static void *seq_start(struct seq_file *seq, loff_t *pos)
328 struct net *net = seq_file_net(seq);
330 mutex_lock(&nf_log_mutex);
332 if (*pos >= ARRAY_SIZE(net->nf.nf_loggers))
338 static void *seq_next(struct seq_file *s, void *v, loff_t *pos)
340 struct net *net = seq_file_net(s);
344 if (*pos >= ARRAY_SIZE(net->nf.nf_loggers))
350 static void seq_stop(struct seq_file *s, void *v)
352 mutex_unlock(&nf_log_mutex);
355 static int seq_show(struct seq_file *s, void *v)
358 const struct nf_logger *logger;
360 struct net *net = seq_file_net(s);
362 logger = nft_log_dereference(net->nf.nf_loggers[*pos]);
365 seq_printf(s, "%2lld NONE (", *pos);
367 seq_printf(s, "%2lld %s (", *pos, logger->name);
369 if (seq_has_overflowed(s))
372 for (i = 0; i < NF_LOG_TYPE_MAX; i++) {
373 if (loggers[*pos][i] == NULL)
376 logger = nft_log_dereference(loggers[*pos][i]);
377 seq_puts(s, logger->name);
378 if (i == 0 && loggers[*pos][i + 1] != NULL)
381 if (seq_has_overflowed(s))
387 if (seq_has_overflowed(s))
392 static const struct seq_operations nflog_seq_ops = {
401 static char nf_log_sysctl_fnames[NFPROTO_NUMPROTO-NFPROTO_UNSPEC][3];
402 static struct ctl_table nf_log_sysctl_table[NFPROTO_NUMPROTO+1];
403 static struct ctl_table_header *nf_log_sysctl_fhdr;
405 static struct ctl_table nf_log_sysctl_ftable[] = {
407 .procname = "nf_log_all_netns",
408 .data = &sysctl_nf_log_all_netns,
409 .maxlen = sizeof(sysctl_nf_log_all_netns),
411 .proc_handler = proc_dointvec,
416 static int nf_log_proc_dostring(struct ctl_table *table, int write,
417 void *buffer, size_t *lenp, loff_t *ppos)
419 const struct nf_logger *logger;
420 char buf[NFLOGGER_NAME_LEN];
422 int tindex = (unsigned long)table->extra1;
423 struct net *net = table->extra2;
426 struct ctl_table tmp = *table;
428 /* proc_dostring() can append to existing strings, so we need to
429 * initialize it as an empty string.
433 r = proc_dostring(&tmp, write, buffer, lenp, ppos);
437 if (!strcmp(buf, "NONE")) {
438 nf_log_unbind_pf(net, tindex);
441 mutex_lock(&nf_log_mutex);
442 logger = __find_logger(tindex, buf);
443 if (logger == NULL) {
444 mutex_unlock(&nf_log_mutex);
447 rcu_assign_pointer(net->nf.nf_loggers[tindex], logger);
448 mutex_unlock(&nf_log_mutex);
450 struct ctl_table tmp = *table;
453 mutex_lock(&nf_log_mutex);
454 logger = nft_log_dereference(net->nf.nf_loggers[tindex]);
456 strlcpy(buf, "NONE", sizeof(buf));
458 strlcpy(buf, logger->name, sizeof(buf));
459 mutex_unlock(&nf_log_mutex);
460 r = proc_dostring(&tmp, write, buffer, lenp, ppos);
466 static int netfilter_log_sysctl_init(struct net *net)
469 struct ctl_table *table;
471 table = nf_log_sysctl_table;
472 if (!net_eq(net, &init_net)) {
473 table = kmemdup(nf_log_sysctl_table,
474 sizeof(nf_log_sysctl_table),
479 for (i = NFPROTO_UNSPEC; i < NFPROTO_NUMPROTO; i++) {
480 snprintf(nf_log_sysctl_fnames[i],
482 nf_log_sysctl_table[i].procname =
483 nf_log_sysctl_fnames[i];
484 nf_log_sysctl_table[i].maxlen = NFLOGGER_NAME_LEN;
485 nf_log_sysctl_table[i].mode = 0644;
486 nf_log_sysctl_table[i].proc_handler =
487 nf_log_proc_dostring;
488 nf_log_sysctl_table[i].extra1 =
489 (void *)(unsigned long) i;
491 nf_log_sysctl_fhdr = register_net_sysctl(net, "net/netfilter",
492 nf_log_sysctl_ftable);
493 if (!nf_log_sysctl_fhdr)
497 for (i = NFPROTO_UNSPEC; i < NFPROTO_NUMPROTO; i++)
498 table[i].extra2 = net;
500 net->nf.nf_log_dir_header = register_net_sysctl(net,
501 "net/netfilter/nf_log",
503 if (!net->nf.nf_log_dir_header)
509 if (!net_eq(net, &init_net))
512 unregister_net_sysctl_table(nf_log_sysctl_fhdr);
518 static void netfilter_log_sysctl_exit(struct net *net)
520 struct ctl_table *table;
522 table = net->nf.nf_log_dir_header->ctl_table_arg;
523 unregister_net_sysctl_table(net->nf.nf_log_dir_header);
524 if (!net_eq(net, &init_net))
527 unregister_net_sysctl_table(nf_log_sysctl_fhdr);
530 static int netfilter_log_sysctl_init(struct net *net)
535 static void netfilter_log_sysctl_exit(struct net *net)
538 #endif /* CONFIG_SYSCTL */
540 static int __net_init nf_log_net_init(struct net *net)
544 #ifdef CONFIG_PROC_FS
545 if (!proc_create_net("nf_log", 0444, net->nf.proc_netfilter,
546 &nflog_seq_ops, sizeof(struct seq_net_private)))
549 ret = netfilter_log_sysctl_init(net);
556 #ifdef CONFIG_PROC_FS
557 remove_proc_entry("nf_log", net->nf.proc_netfilter);
562 static void __net_exit nf_log_net_exit(struct net *net)
564 netfilter_log_sysctl_exit(net);
565 #ifdef CONFIG_PROC_FS
566 remove_proc_entry("nf_log", net->nf.proc_netfilter);
570 static struct pernet_operations nf_log_net_ops = {
571 .init = nf_log_net_init,
572 .exit = nf_log_net_exit,
575 int __init netfilter_log_init(void)
577 return register_pernet_subsys(&nf_log_net_ops);