utils.h

   1 /*
   2  * firewall3 - 3rd OpenWrt UCI firewall implementation
   3  *
   4  *   Copyright (C) 2013 Jo-Philipp Wich <jo@mein.io>
   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 #include <sys/types.h>
  32 #include <ifaddrs.h>
  33 #include <netdb.h>
  34
  35 #include <libubox/list.h>
  36 #include <libubox/blob.h>
  37 #include <uci.h>
  38
  39
  40 #define FW3_STATEFILE   "/var/run/fw3.state"
  41 #define FW3_LOCKFILE    "/var/run/fw3.lock"
  42 #define FW3_HELPERCONF  "/usr/share/fw3/helpers.conf"
  43 #define FW3_HOTPLUG     "/sbin/hotplug-call"
  44
  45 extern bool fw3_pr_debug;
  46
  47 void warn_elem(struct uci_element *e, const char *format, ...);
  48 void warn(const char *format, ...);
  49 void error(const char *format, ...);
  50 void info(const char *format, ...);
  51
  52
  53 #define warn_section(t, r, e, fmt, ...)                                 \
  54         do {                                                                    \
  55                 if (e)                                                          \
  56                         warn_elem(e, fmt, ##__VA_ARGS__);                       \
  57                 else                                                            \
  58                         warn("Warning: ubus " t " (%s) " fmt,                   \
  59                                 (r && r->name) ? r->name : "?", ##__VA_ARGS__); \
  60         } while(0)
  61
  62 #define fw3_setbit(field, flag) field |= (1 << (flag))
  63 #define fw3_delbit(field, flag) field &= ~(1 << (flag))
  64 #define fw3_hasbit(field, flag) (field & (1 << (flag)))
  65
  66 #define set(field, family, flag) fw3_setbit(field[family == FW3_FAMILY_V6], flag)
  67 #define del(field, family, flag) fw3_delbit(field[family == FW3_FAMILY_V6], flag)
  68 #define has(field, family, flag) fw3_hasbit(field[family == FW3_FAMILY_V6], flag)
  69
  70 #define fw3_foreach(p, h)                                                  \
  71         for (p = list_empty(h) ? NULL : list_first_entry(h, typeof(*p), list); \
  72          list_empty(h) ? (p == NULL) : (&p->list != (h));                  \
  73              p = list_empty(h) ? list_first_entry(h, typeof(*p), list)         \
  74                            : list_entry(p->list.next, typeof(*p), list))
  75
  76 #define fw3_is_family(p, f)                                                \
  77         (!p || (p)->family == FW3_FAMILY_ANY || (p)->family == f)
  78
  79 #define fw3_no_family(flags)                                               \
  80         (!(flags & ((1 << FW3_FAMILY_V4) | (1 << FW3_FAMILY_V6))))
  81
  82 #define fw3_no_table(flags)                                                \
  83     (!(flags & ((1<<FW3_TABLE_FILTER)|(1<<FW3_TABLE_NAT)|                  \
  84                 (1<<FW3_TABLE_MANGLE)|(1<<FW3_TABLE_RAW))))
  85
  86
  87 void * fw3_alloc(size_t size);
  88 char * fw3_strdup(const char *s);
  89
  90 const char * fw3_find_command(const char *cmd);
  91
  92 bool fw3_stdout_pipe(void);
  93 bool __fw3_command_pipe(bool silent, const char *command, ...);
  94 #define fw3_command_pipe(...) __fw3_command_pipe(__VA_ARGS__, NULL)
  95
  96 void fw3_command_close(void);
  97 void fw3_pr(const char *fmt, ...);
  98
  99 bool fw3_has_table(bool ipv6, const char *table);
 100
 101 bool fw3_lock(void);
 102 void fw3_unlock(void);
 103
 104
 105 void fw3_write_statefile(void *state);
 106
 107 void fw3_free_object(void *obj, const void *opts);
 108
 109 void fw3_free_list(struct list_head *head);
 110
 111 bool fw3_hotplug(bool add, void *zone, void *device);
 112
 113 int fw3_netmask2bitlen(int family, void *mask);
 114
 115 bool fw3_bitlen2netmask(int family, int bits, void *mask);
 116
 117 void fw3_flush_conntrack(void *zone);
 118
 119 bool fw3_attr_parse_name_type(struct blob_attr *entry, const char **name, const char **type);
 120
 121 const char * fw3_protoname(void *proto);
 122
 123 #endif