Add common fw3_address_to_string() helper function
[project/firewall3.git] / utils.h
1 /*
2  * firewall3 - 3rd OpenWrt UCI firewall implementation
3  *
4  *   Copyright (C) 2013 Jo-Philipp Wich <jow@openwrt.org>
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18
19 #ifndef __FW3_UTILS_H
20 #define __FW3_UTILS_H
21
22 #include <stdlib.h>
23 #include <stdbool.h>
24 #include <unistd.h>
25 #include <signal.h>
26 #include <fcntl.h>
27 #include <limits.h>
28 #include <sys/stat.h>
29 #include <sys/wait.h>
30 #include <sys/file.h>
31
32 #include <libubox/list.h>
33 #include <uci.h>
34
35
36 #define FW3_STATEFILE   "/var/run/fw3.state"
37 #define FW3_LOCKFILE    "/var/run/fw3.lock"
38 #define FW3_HOTPLUG     "/sbin/hotplug-call"
39
40 extern bool fw3_pr_debug;
41
42 void warn_elem(struct uci_element *e, const char *format, ...);
43 void warn(const char *format, ...);
44 void error(const char *format, ...);
45 void info(const char *format, ...);
46
47 #define setbit(field, flag) field |= (1 << (flag))
48 #define delbit(field, flag) field &= ~(1 << (flag))
49 #define hasbit(field, flag) (field & (1 << (flag)))
50
51 #define set(field, family, flag) setbit(field[family == FW3_FAMILY_V6], flag)
52 #define del(field, family, flag) delbit(field[family == FW3_FAMILY_V6], flag)
53 #define has(field, family, flag) hasbit(field[family == FW3_FAMILY_V6], flag)
54
55 #define fw3_foreach(p, h)                                                  \
56         for (p = list_empty(h) ? NULL : list_first_entry(h, typeof(*p), list); \
57          list_empty(h) ? (p == NULL) : (&p->list != (h));                  \
58              p = list_empty(h) ? list_first_entry(h, typeof(*p), list)         \
59                            : list_entry(p->list.next, typeof(*p), list))
60
61 #define fw3_is_family(p, f)                                                \
62         (!p || (p)->family == FW3_FAMILY_ANY || (p)->family == f)
63
64 #define fw3_no_family(flags)                                               \
65         (!(flags & ((1 << FW3_FAMILY_V4) | (1 << FW3_FAMILY_V6))))
66
67 #define fw3_no_table(flags)                                                \
68     (!(flags & ((1<<FW3_TABLE_FILTER)|(1<<FW3_TABLE_NAT)|                  \
69                 (1<<FW3_TABLE_MANGLE)|(1<<FW3_TABLE_RAW))))
70
71
72 const char * fw3_find_command(const char *cmd);
73
74 bool fw3_stdout_pipe(void);
75 bool __fw3_command_pipe(bool silent, const char *command, ...);
76 #define fw3_command_pipe(...) __fw3_command_pipe(__VA_ARGS__, NULL)
77
78 void fw3_command_close(void);
79 void fw3_pr(const char *fmt, ...);
80
81 bool fw3_has_table(bool ipv6, const char *table);
82
83 bool fw3_lock(void);
84 void fw3_unlock(void);
85
86
87 void fw3_write_statefile(void *state);
88
89 void fw3_free_object(void *obj, const void *opts);
90
91
92 struct fw3_rule_spec {
93         int family;
94         int table;
95         int flag;
96         const char *format;
97 };
98
99 bool fw3_pr_rulespec(int table, int family, uint32_t *flags, uint32_t mask,
100                      const struct fw3_rule_spec *r, const char *fmt, ...);
101
102 bool fw3_hotplug(bool add, void *zone, void *device);
103
104 #endif