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 <sys/stat.h>
  28 #include <sys/wait.h>
  29 #include <sys/file.h>
  30
  31 #include <libubox/list.h>
  32 #include <uci.h>
  33
  34
  35 #define FW3_STATEFILE   "/var/run/fw3.state"
  36 #define FW3_LOCKFILE    "/var/run/fw3.lock"
  37
  38 extern bool fw3_pr_debug;
  39
  40 void warn_elem(struct uci_element *e, const char *format, ...);
  41 void warn(const char *format, ...);
  42 void error(const char *format, ...);
  43 void info(const char *format, ...);
  44
  45 #define setbit(field, flag) field |= (1 << (flag))
  46 #define delbit(field, flag) field &= ~(1 << (flag))
  47 #define hasbit(field, flag) (field & (1 << (flag)))
  48
  49 #define set(field, family, flag) setbit(field[family == FW3_FAMILY_V6], flag)
  50 #define del(field, family, flag) delbit(field[family == FW3_FAMILY_V6], flag)
  51 #define has(field, family, flag) hasbit(field[family == FW3_FAMILY_V6], flag)
  52
  53 #define fw3_foreach(p, h)                                                  \
  54         for (p = list_empty(h) ? NULL : list_first_entry(h, typeof(*p), list); \
  55          list_empty(h) ? (p == NULL) : (&p->list != (h));                  \
  56              p = list_empty(h) ? list_first_entry(h, typeof(*p), list)         \
  57                            : list_entry(p->list.next, typeof(*p), list))
  58
  59 #define fw3_is_family(p, f)                                                \
  60         (!p || (p)->family == FW3_FAMILY_ANY || (p)->family == f)
  61
  62 #define fw3_no_family(flags)                                               \
  63         (!(flags & ((1 << FW3_FAMILY_V4) | (1 << FW3_FAMILY_V6))))
  64
  65 #define fw3_no_table(flags)                                                \
  66     (!(flags & ((1<<FW3_TABLE_FILTER)|(1<<FW3_TABLE_NAT)|                  \
  67                 (1<<FW3_TABLE_MANGLE)|(1<<FW3_TABLE_RAW))))
  68
  69
  70 const char * fw3_find_command(const char *cmd);
  71
  72 bool fw3_stdout_pipe(void);
  73 bool __fw3_command_pipe(bool silent, const char *command, ...);
  74 #define fw3_command_pipe(...) __fw3_command_pipe(__VA_ARGS__, NULL)
  75
  76 void fw3_command_close(void);
  77 void fw3_pr(const char *fmt, ...);
  78
  79 bool fw3_has_table(bool ipv6, const char *table);
  80
  81 bool fw3_lock(void);
  82 void fw3_unlock(void);
  83
  84
  85 enum fw3_statefile_type
  86 {
  87         FW3_TYPE_DEFAULTS = 0,
  88         FW3_TYPE_ZONE     = 1,
  89         FW3_TYPE_IPSET    = 2,
  90 };
  91
  92 bool fw3_read_statefile(void *state);
  93 void fw3_write_statefile(void *state);
  94
  95 void fw3_set_running(void *object, struct list_head *dest);
  96
  97 void fw3_free_object(void *obj, const void *opts);
  98
  99 #endif