This commit was generated by cvs2svn to compensate for changes in r786,
[libnl.git] / lib / route / rule.c
diff --git a/lib/route/rule.c b/lib/route/rule.c
new file mode 100644 (file)
index 0000000..3e04f3f
--- /dev/null
@@ -0,0 +1,1015 @@
+/*
+ * lib/route/rule.c          Routing Rules
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation version 2.1
+ *     of the License.
+ *
+ * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
+ */
+
+/**
+ * @ingroup rtnl
+ * @defgroup rule Routing Rules
+ * @brief
+ * @{
+ */
+
+#include <netlink-local.h>
+#include <netlink/netlink.h>
+#include <netlink/utils.h>
+#include <netlink/route/rtnl.h>
+#include <netlink/route/rule.h>
+#include <inttypes.h>
+
+/** @cond SKIP */
+#define RULE_ATTR_FAMILY  0x0001
+#define RULE_ATTR_PRIO    0x0002
+#define RULE_ATTR_FWMARK  0x0004
+#define RULE_ATTR_IIF     0x0008
+#define RULE_ATTR_REALMS  0x0010
+#define RULE_ATTR_SRC     0x0020
+#define RULE_ATTR_DST     0x0040
+#define RULE_ATTR_DSFIELD 0x0080
+#define RULE_ATTR_TABLE   0x0100
+#define RULE_ATTR_TYPE    0x0200
+#define RULE_ATTR_SRC_LEN 0x0400
+#define RULE_ATTR_DST_LEN 0x0800
+#define RULE_ATTR_SRCMAP  0x1000
+
+static struct nl_cache_ops rtnl_rule_ops;
+/** @endcond */
+
+static void rule_free_data(struct nl_object *c)
+{
+       struct rtnl_rule *rule = nl_object_priv(c);
+
+       if (!rule)
+               return;
+
+       nl_addr_put(rule->r_src);
+       nl_addr_put(rule->r_dst);
+}
+
+static struct nla_policy rule_policy[RTA_MAX+1] = {
+       [RTA_PRIORITY]  = { .type = NLA_U32 },
+       [RTA_FLOW]      = { .type = NLA_U32 },
+       [RTA_PROTOINFO] = { .type = NLA_U32 },
+       [RTA_IIF]       = { .type = NLA_STRING,
+                           .maxlen = IFNAMSIZ, },
+};
+
+static int rule_msg_parser(struct sockaddr_nl *who, struct nlmsghdr *n,
+                          void *arg)
+{
+       struct rtnl_rule *rule;
+       struct rtmsg *r;
+       struct nlattr *tb[RTA_MAX+1];
+       struct nl_parser_param *pp = arg;
+       int err = 1;
+
+       rule = rtnl_rule_alloc();
+       if (!rule) {
+               err = nl_errno(ENOMEM);
+               goto errout;
+       }
+
+       rule->ce_msgtype = n->nlmsg_type;
+       r = nlmsg_data(n);
+
+       err = nlmsg_parse(n, sizeof(*r), tb, RTA_MAX, rule_policy);
+       if (err < 0)
+               goto errout;
+
+       rule->r_family = r->rtm_family;
+       rule->r_type = r->rtm_type;
+       rule->r_dsfield = r->rtm_tos;
+       rule->r_src_len = r->rtm_src_len;
+       rule->r_dst_len = r->rtm_dst_len;
+       rule->r_table = r->rtm_table;
+       rule->r_mask = (RULE_ATTR_FAMILY | RULE_ATTR_TYPE | RULE_ATTR_DSFIELD |
+                       RULE_ATTR_SRC_LEN | RULE_ATTR_DST_LEN | RULE_ATTR_TYPE);
+
+       if (tb[RTA_PRIORITY]) {
+               rule->r_prio = nla_get_u32(tb[RTA_PRIORITY]);
+               rule->r_mask |= RULE_ATTR_PRIO;
+       }
+
+       if (tb[RTA_SRC]) {
+               rule->r_src = nla_get_addr(tb[RTA_SRC], r->rtm_family);
+               if (!rule->r_src) {
+                       err = nl_errno(ENOMEM);
+                       goto errout;
+               }
+               nl_addr_set_prefixlen(rule->r_src, r->rtm_src_len);
+               rule->r_mask |= RULE_ATTR_SRC;
+       }
+
+       if (tb[RTA_DST]) {
+               rule->r_dst = nla_get_addr(tb[RTA_DST], r->rtm_family);
+               if (!rule->r_dst) {
+                       err = nl_errno(ENOMEM);
+                       goto errout;
+               }
+               nl_addr_set_prefixlen(rule->r_dst, r->rtm_dst_len);
+               rule->r_mask |= RULE_ATTR_DST;
+       }
+
+       if (tb[RTA_PROTOINFO]) {
+               rule->r_fwmark = nla_get_u32(tb[RTA_PROTOINFO]);
+               rule->r_mask |= RULE_ATTR_FWMARK;
+       }
+
+       if (tb[RTA_IIF]) {
+               nla_strlcpy(rule->r_iif, tb[RTA_IIF], IFNAMSIZ);
+               rule->r_mask |= RULE_ATTR_IIF;
+       }
+
+       if (tb[RTA_FLOW]) {
+               rule->r_realms = nla_get_u32(tb[RTA_FLOW]);
+               rule->r_mask |= RULE_ATTR_REALMS;
+       }
+
+       if (tb[RTA_GATEWAY]) {
+               rule->r_srcmap = nla_get_addr(tb[RTA_GATEWAY], r->rtm_family);
+               if (!rule->r_srcmap) {
+                       err = nl_errno(ENOMEM);
+                       goto errout;
+               }
+               rule->r_mask |= RULE_ATTR_SRCMAP;
+       }
+
+       err = pp->pp_cb((struct nl_object *) rule, pp);
+       if (err < 0)
+               goto errout;
+
+       return P_ACCEPT;
+
+errout:
+       rtnl_rule_put(rule);
+       return err;
+}
+
+static int rule_request_update(struct nl_cache *c, struct nl_handle *h)
+{
+       return nl_rtgen_request(h, RTM_GETRULE, AF_UNSPEC, NLM_F_DUMP);
+}
+
+static int rule_dump_brief(struct nl_object *o, struct nl_dump_params *p)
+{
+       struct rtnl_rule *r = (struct rtnl_rule *) o;
+       char buf[128];
+
+       if (r->r_mask & RULE_ATTR_PRIO)
+               dp_dump(p, "%d:\t", r->r_prio);
+       else
+               dp_dump(p, "0:\t");
+
+       if (r->r_mask & RULE_ATTR_SRC)
+               dp_dump(p, "from %s ",
+                       nl_addr2str(r->r_src, buf, sizeof(buf)));
+       else if (r->r_mask & RULE_ATTR_SRC_LEN && r->r_src_len)
+               dp_dump(p, "from 0/%d ", r->r_src_len);
+
+       if (r->r_mask & RULE_ATTR_DST)
+               dp_dump(p, "to %s ",
+                       nl_addr2str(r->r_dst, buf, sizeof(buf)));
+       else if (r->r_mask & RULE_ATTR_DST_LEN && r->r_dst_len)
+               dp_dump(p, "to 0/%d ", r->r_dst_len);
+
+       if (r->r_mask & RULE_ATTR_DSFIELD && r->r_dsfield)
+               dp_dump(p, "tos %d ", r->r_dsfield);
+
+       if (r->r_mask & RULE_ATTR_FWMARK)
+               dp_dump(p, "fwmark %" PRIx64 , r->r_fwmark);
+
+       if (r->r_mask & RULE_ATTR_IIF)
+               dp_dump(p, "iif %s ", r->r_iif);
+
+       if (r->r_mask & RULE_ATTR_TABLE)
+               dp_dump(p, "lookup %s ",
+                       rtnl_route_table2str(r->r_table, buf, sizeof(buf)));
+
+       if (r->r_mask & RULE_ATTR_REALMS)
+               dp_dump(p, "realms %s ",
+                       rtnl_realms2str(r->r_realms, buf, sizeof(buf)));
+
+       dp_dump(p, "action %s\n",
+               nl_rtntype2str(r->r_type, buf, sizeof(buf)));
+
+       return 1;
+}
+
+static int rule_dump_full(struct nl_object *obj, struct nl_dump_params *p)
+{
+       struct rtnl_rule *rule = (struct rtnl_rule *) obj;
+       char buf[128];
+       int line;
+
+       line = rule_dump_brief(obj, p);
+
+       dp_dump_line(p, line++, "  family %s",
+                    nl_af2str(rule->r_family, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_SRCMAP)
+               dp_dump(p, " srcmap %s",
+                       nl_addr2str(rule->r_srcmap, buf, sizeof(buf)));
+
+       dp_dump(p, "\n");
+
+       return line;
+}
+
+static int rule_dump_stats(struct nl_object *obj, struct nl_dump_params *p)
+{
+       return rule_dump_full(obj, p);
+}
+
+static int rule_dump_xml(struct nl_object *obj, struct nl_dump_params *p)
+{
+       struct rtnl_rule *rule = (struct rtnl_rule *) obj;
+       char buf[128];
+       int line = 0;
+       
+       dp_dump_line(p, line++, "<rule>\n");
+
+       dp_dump_line(p, line++, "  <priority>%u</priority>\n",
+                    rule->r_prio);
+       dp_dump_line(p, line++, "  <family>%s</family>\n",
+                    nl_af2str(rule->r_family, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_DST)
+               dp_dump_line(p, line++, "  <dst>%s</dst>\n",
+                            nl_addr2str(rule->r_dst, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_DST_LEN)
+               dp_dump_line(p, line++, "  <dstlen>%u</dstlen>\n",
+                            rule->r_dst_len);
+
+       if (rule->r_mask & RULE_ATTR_SRC)
+               dp_dump_line(p, line++, "  <src>%s</src>\n",
+                            nl_addr2str(rule->r_src, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_SRC_LEN)
+               dp_dump_line(p, line++, "  <srclen>%u</srclen>\n",
+                            rule->r_src_len);
+
+       if (rule->r_mask & RULE_ATTR_IIF)
+               dp_dump_line(p, line++, "  <iif>%s</iif>\n", rule->r_iif);
+
+       if (rule->r_mask & RULE_ATTR_TABLE)
+               dp_dump_line(p, line++, "  <table>%u</table>\n",
+                            rule->r_table);
+
+       if (rule->r_mask & RULE_ATTR_REALMS)
+               dp_dump_line(p, line++, "  <realms>%u</realms>\n",
+                            rule->r_realms);
+
+       if (rule->r_mask & RULE_ATTR_FWMARK)
+               dp_dump_line(p, line++, "  <fwmark>%" PRIx64 "</fwmark>\n",
+                            rule->r_fwmark);
+
+       if (rule->r_mask & RULE_ATTR_DSFIELD)
+               dp_dump_line(p, line++, "  <dsfield>%u</dsfield>\n",
+                            rule->r_dsfield);
+
+       if (rule->r_mask & RULE_ATTR_TYPE)
+               dp_dump_line(p, line++, "<type>%s</type>\n",
+                            nl_rtntype2str(rule->r_type, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_SRCMAP)
+               dp_dump_line(p, line++, "<srcmap>%s</srcmap>\n",
+                            nl_addr2str(rule->r_srcmap, buf, sizeof(buf)));
+
+       dp_dump_line(p, line++, "</rule>\n");
+
+       return line;
+}
+
+static int rule_dump_env(struct nl_object *obj, struct nl_dump_params *p)
+{
+       struct rtnl_rule *rule = (struct rtnl_rule *) obj;
+       char buf[128];
+       int line = 0;
+
+       dp_dump_line(p, line++, "RULE_PRIORITY=%u\n",
+                    rule->r_prio);
+       dp_dump_line(p, line++, "RULE_FAMILY=%s\n",
+                    nl_af2str(rule->r_family, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_DST)
+               dp_dump_line(p, line++, "RULE_DST=%s\n",
+                            nl_addr2str(rule->r_dst, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_DST_LEN)
+               dp_dump_line(p, line++, "RULE_DSTLEN=%u\n",
+                            rule->r_dst_len);
+
+       if (rule->r_mask & RULE_ATTR_SRC)
+               dp_dump_line(p, line++, "RULE_SRC=%s\n",
+                            nl_addr2str(rule->r_src, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_SRC_LEN)
+               dp_dump_line(p, line++, "RULE_SRCLEN=%u\n",
+                            rule->r_src_len);
+
+       if (rule->r_mask & RULE_ATTR_IIF)
+               dp_dump_line(p, line++, "RULE_IIF=%s\n", rule->r_iif);
+
+       if (rule->r_mask & RULE_ATTR_TABLE)
+               dp_dump_line(p, line++, "RULE_TABLE=%u\n",
+                            rule->r_table);
+
+       if (rule->r_mask & RULE_ATTR_REALMS)
+               dp_dump_line(p, line++, "RULE_REALM=%u\n",
+                            rule->r_realms);
+
+       if (rule->r_mask & RULE_ATTR_FWMARK)
+               dp_dump_line(p, line++, "RULE_FWMARK=0x%" PRIx64 "\n",
+                            rule->r_fwmark);
+
+       if (rule->r_mask & RULE_ATTR_DSFIELD)
+               dp_dump_line(p, line++, "RULE_DSFIELD=%u\n",
+                            rule->r_dsfield);
+
+       if (rule->r_mask & RULE_ATTR_TYPE)
+               dp_dump_line(p, line++, "RULE_TYPE=%s\n",
+                            nl_rtntype2str(rule->r_type, buf, sizeof(buf)));
+
+       if (rule->r_mask & RULE_ATTR_SRCMAP)
+               dp_dump_line(p, line++, "RULE_SRCMAP=%s\n",
+                            nl_addr2str(rule->r_srcmap, buf, sizeof(buf)));
+
+       return line;
+}
+
+
+static int rule_filter(struct nl_object *obj, struct nl_object *filter)
+{
+       struct rtnl_rule *o = (struct rtnl_rule *) obj;
+       struct rtnl_rule *f = (struct rtnl_rule *) filter;
+
+#define REQ(F) (f->r_mask & RULE_ATTR_##F)
+#define AVAIL(F) (o->r_mask & RULE_ATTR_##F)
+#define _O(F, EXPR) (REQ(F) && (!AVAIL(F) || (EXPR)))
+#define _C(F, N) (REQ(F) && (!AVAIL(F) || (o->N != f->N)))
+       if (_C(FAMILY,  r_family)                                       ||
+           _C(TABLE,   r_table)                                        ||
+           _C(REALMS,  r_realms)                                       ||
+           _C(DSFIELD, r_dsfield)                                      ||
+           _C(TYPE,    r_type)                                         ||
+           _C(PRIO,    r_prio)                                         ||
+           _C(FWMARK,  r_fwmark)                                       ||
+           _C(SRC_LEN, r_src_len)                                      ||
+           _C(DST_LEN, r_dst_len)                                      ||
+           _O(SRC,     nl_addr_cmp(o->r_src, f->r_src))                ||
+           _O(DST,     nl_addr_cmp(o->r_dst, f->r_dst))                ||
+           _O(IIF,     strcmp(o->r_iif, f->r_iif)))
+               return 0;
+#undef REQ
+#undef AVAIL
+#undef _O
+#undef _C
+
+       return 1;
+}
+
+/**
+ * @name Routing Rule Object Allocation/Freeage
+ * @{
+ */
+
+/**
+ * Allocate a new rule object
+ * @return New rule object
+ */
+struct rtnl_rule *rtnl_rule_alloc(void)
+{
+       return (struct rtnl_rule *) nl_object_alloc_from_ops(&rtnl_rule_ops);
+}
+
+/**
+ * Give back reference on routing rule object.
+ * @arg rule           Routing rule object to be given back.
+ *
+ * Decrements the reference counter and frees the object if the
+ * last reference has been released.
+ */
+void rtnl_rule_put(struct rtnl_rule *rule)
+{
+       nl_object_put((struct nl_object *) rule);
+}
+/**
+ * Free routing rule object.
+ * @arg rule           Routing rule object to be freed.
+ *
+ * @note Always use rtnl_rule_put() unless you're absolutely sure
+ *       that no other user may have a reference on this object.
+ */
+void rtnl_rule_free(struct rtnl_rule *rule)
+{
+       nl_object_free((struct nl_object *) rule);
+}
+
+/** @} */
+
+/**
+ * @name Routing Rule Cache Management
+ * @{
+ */
+
+/**
+ * Build a rule cache including all rules of the specified family currently configured in the kernel.
+ * @arg handle         netlink handle
+ * @arg family         address family
+ *
+ * Allocates a new rule cache, initializes it properly and updates it
+ * to include all rules of the specified address family currently
+ * configured in the kernel.
+ *
+ * @note The caller is responsible for destroying and freeing the
+ *       cache after using it. (nl_cache_destroy_and_free())
+ * @return The new cache or NULL if an error occured.
+ */
+struct nl_cache * rtnl_rule_alloc_cache_by_family(struct nl_handle *handle,
+                                                 int family)
+{
+       struct nl_cache * cache = nl_cache_alloc_from_ops(&rtnl_rule_ops);
+
+       if (cache == NULL)
+               return NULL;
+
+       /* XXX RULE_CACHE_FAMILY(cache) = family; */
+
+       if (nl_cache_update(handle, cache) < 0) {
+               free(cache);
+               return NULL;
+       }
+
+       return cache;
+}
+
+/**
+ * Build a rule cache including all rules currently configured in the kernel.
+ * @arg handle         netlink handle
+ *
+ * Allocates a new rule cache, initializes it properly and updates it
+ * to include all rules currently configured in the kernel.
+ *
+ * @note The caller is responsible for destroying and freeing the
+ *       cache after using it. (nl_cache_destroy_and_free())
+ * @return The new cache or NULL if an error occured.
+ */
+struct nl_cache * rtnl_rule_alloc_cache(struct nl_handle *handle)
+{
+       return rtnl_rule_alloc_cache_by_family(handle, AF_UNSPEC);
+}
+
+/** @} */
+
+/**
+ * @name Rule Addition
+ * @{
+ */
+
+static struct nl_msg *build_rule_msg(struct rtnl_rule *tmpl, int cmd, int flags)
+{
+       struct nl_msg *msg;
+       struct rtmsg rtm = {
+               .rtm_type = RTN_UNSPEC
+       };
+
+       if (cmd == RTM_NEWRULE)
+               rtm.rtm_type = RTN_UNICAST;
+               
+       if (tmpl->r_mask & RULE_ATTR_FAMILY)
+               rtm.rtm_family = tmpl->r_family;
+
+       if (tmpl->r_mask & RULE_ATTR_TABLE)
+               rtm.rtm_table = tmpl->r_table;
+
+       if (tmpl->r_mask & RULE_ATTR_DSFIELD)
+               rtm.rtm_tos = tmpl->r_dsfield;
+
+       if (tmpl->r_mask & RULE_ATTR_TYPE)
+               rtm.rtm_type = tmpl->r_type;
+
+       if (tmpl->r_mask & RULE_ATTR_SRC_LEN)
+               rtm.rtm_src_len = tmpl->r_src_len;
+
+       if (tmpl->r_mask & RULE_ATTR_DST_LEN)
+               rtm.rtm_dst_len = tmpl->r_dst_len;
+
+       msg = nlmsg_build_simple(cmd, flags);
+       if (!msg)
+               goto nla_put_failure;
+
+       if (nlmsg_append(msg, &rtm, sizeof(rtm), 1) < 0)
+               goto nla_put_failure;
+
+       if (tmpl->r_mask & RULE_ATTR_SRC)
+               NLA_PUT_ADDR(msg, RTA_SRC, tmpl->r_src);
+
+       if (tmpl->r_mask & RULE_ATTR_DST)
+               NLA_PUT_ADDR(msg, RTA_DST, tmpl->r_dst);
+
+       if (tmpl->r_mask & RULE_ATTR_PRIO)
+               NLA_PUT_U32(msg, RTA_PRIORITY, tmpl->r_prio);
+
+       if (tmpl->r_mask & RULE_ATTR_FWMARK)
+               NLA_PUT_U32(msg, RTA_PROTOINFO, tmpl->r_fwmark);
+
+       if (tmpl->r_mask & RULE_ATTR_REALMS)
+               NLA_PUT_U32(msg, RTA_FLOW, tmpl->r_realms);
+
+       if (tmpl->r_mask & RULE_ATTR_IIF)
+               NLA_PUT_STRING(msg, RTA_IIF, tmpl->r_iif);
+
+       return msg;
+
+nla_put_failure:
+       nlmsg_free(msg);
+       return NULL;
+}
+
+/**
+ * Build netlink request message to add a new rule
+ * @arg tmpl           template with data of new rule
+ * @arg flags          additional netlink message flags
+ *
+ * Builds a new netlink message requesting a addition of a new
+ * rule. The netlink message header isn't fully equipped with
+ * all relevant fields and must thus be sent out via nl_send_auto_complete()
+ * or supplemented as needed. \a tmpl must contain the attributes of the new
+ * address set via \c rtnl_rule_set_* functions.
+ * 
+ * @return The netlink message
+ */
+struct nl_msg *rtnl_rule_build_add_request(struct rtnl_rule *tmpl, int flags)
+{
+       return build_rule_msg(tmpl, RTM_NEWRULE, NLM_F_CREATE | flags);
+}
+
+/**
+ * Add a new rule
+ * @arg handle         netlink handle
+ * @arg tmpl           template with requested changes
+ * @arg flags          additional netlink message flags
+ *
+ * Builds a netlink message by calling rtnl_rule_build_add_request(),
+ * sends the request to the kernel and waits for the next ACK to be
+ * received and thus blocks until the request has been fullfilled.
+ *
+ * @return 0 on sucess or a negative error if an error occured.
+ */
+int rtnl_rule_add(struct nl_handle *handle, struct rtnl_rule *tmpl, int flags)
+{
+       int err;
+       struct nl_msg *msg;
+       
+       msg = rtnl_rule_build_add_request(tmpl, flags);
+       if (!msg)
+               return nl_errno(ENOMEM);
+
+       err = nl_send_auto_complete(handle, msg);
+       if (err < 0)
+               return err;
+
+       nlmsg_free(msg);
+       return nl_wait_for_ack(handle);
+}
+
+/** @} */
+
+/**
+ * @name Rule Deletion
+ * @{
+ */
+
+/**
+ * Build a netlink request message to delete a rule
+ * @arg rule           rule to delete
+ * @arg flags          additional netlink message flags
+ *
+ * Builds a new netlink message requesting a deletion of a rule.
+ * The netlink message header isn't fully equipped with all relevant
+ * fields and must thus be sent out via nl_send_auto_complete()
+ * or supplemented as needed. \a rule must point to an existing
+ * address.
+ *
+ * @return The netlink message
+ */
+struct nl_msg *rtnl_rule_build_delete_request(struct rtnl_rule *rule, int flags)
+{
+       return build_rule_msg(rule, RTM_DELRULE, flags);
+}
+
+/**
+ * Delete a rule
+ * @arg handle         netlink handle
+ * @arg rule           rule to delete
+ * @arg flags          additional netlink message flags
+ *
+ * Builds a netlink message by calling rtnl_rule_build_delete_request(),
+ * sends the request to the kernel and waits for the next ACK to be
+ * received and thus blocks until the request has been fullfilled.
+ *
+ * @return 0 on sucess or a negative error if an error occured.
+ */
+int rtnl_rule_delete(struct nl_handle *handle, struct rtnl_rule *rule,
+                    int flags)
+{
+       int err;
+       struct nl_msg *msg;
+       
+       msg = rtnl_rule_build_delete_request(rule, flags);
+       if (!msg)
+               return nl_errno(ENOMEM);
+
+       err = nl_send_auto_complete(handle, msg);
+       if (err < 0)
+               return err;
+
+       nlmsg_free(msg);
+       return nl_wait_for_ack(handle);
+}
+
+/** @} */
+
+/**
+ * @name Attribute Modification
+ * @{
+ */
+
+/**
+ * Set the address family of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg family         new address family
+ */
+void rtnl_rule_set_family(struct rtnl_rule *rule, int family)
+{
+       rule->r_family = family;
+       rule->r_mask |= RULE_ATTR_FAMILY;
+}
+
+/**
+ * Get the address family of a rule
+ * @arg rule           rule handle
+ * @return Address family or AF_UNSPEC if not set
+ */
+int rtnl_rule_get_family(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_FAMILY)
+               return rule->r_family;
+       else
+               return AF_UNSPEC;
+}
+
+/**
+ * Set the priority of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg prio           new priority
+ */
+void rtnl_rule_set_prio(struct rtnl_rule *rule, int prio)
+{
+       rule->r_prio = prio;
+       rule->r_mask |= RULE_ATTR_PRIO;
+}
+
+/**
+ * Get the priority of a rule
+ * @arg rule           rule handle
+ * @return Priority or -1 if not set
+ */
+int rtnl_rule_get_prio(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_PRIO)
+               return rule->r_prio;
+       else
+               return -1;
+}
+
+/**
+ * Set the firewall mark of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg fwmark         new firewall mark
+ */
+void rtnl_rule_set_fwmark(struct rtnl_rule *rule, uint64_t fwmark)
+{
+       rule->r_fwmark = fwmark;
+       rule->r_mask |= RULE_ATTR_FWMARK;
+}
+
+/**
+ * Get the firewall mark of a rule
+ * @arg rule           rule handle
+ * @return Firewall mark or UINT_LEAST64_MAX if not set
+ */
+uint64_t rtnl_rule_get_fwmark(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_FWMARK)
+               return rule->r_fwmark;
+       else
+               return UINT_LEAST64_MAX;
+}
+
+/**
+ * Set the table index of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg table          new table
+ */
+void rtnl_rule_set_table(struct rtnl_rule *rule, int table)
+{
+       rule->r_table = table;
+       rule->r_mask |= RULE_ATTR_TABLE;
+}
+
+/**
+ * Get the table index of a rule
+ * @arg rule           rule handle
+ * @return Table index or -1 if not set
+ */
+int rtnl_rule_get_table(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_TABLE)
+               return rule->r_table;
+       else
+               return -1;
+}
+
+/**
+ * Set the dsfield of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg dsfield                new dsfield value
+ */
+void rtnl_rule_set_dsfield(struct rtnl_rule *rule, int dsfield)
+{
+       rule->r_dsfield = dsfield;
+       rule->r_mask |= RULE_ATTR_DSFIELD;
+}
+
+/**
+ * Get the dsfield of a rule
+ * @arg rule           rule handle
+ * @return dsfield or -1 if not set
+ */
+int rtnl_rule_get_dsfield(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_DSFIELD)
+               return rule->r_dsfield;
+       else
+               return -1;
+}
+
+/**
+ * Set the source address prefix length of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg len            new source address length
+ */
+void rtnl_rule_set_src_len(struct rtnl_rule *rule, int len)
+{
+       rule->r_src_len = len;
+       if (rule->r_mask & RULE_ATTR_SRC)
+               nl_addr_set_prefixlen(rule->r_src, len);
+       rule->r_mask |= RULE_ATTR_SRC_LEN;
+}
+
+/**
+ * Get the source address prefix length of a rule
+ * @arg rule           rule handle
+ * @return Prefix length of source address or -1 if not set
+ */
+int rtnl_rule_get_src_len(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_SRC_LEN)
+               return rule->r_src_len;
+       else
+               return -1;
+}
+
+/**
+ * Set the destination address prefix length of a rule to the specified value
+ * @arg rule           rule to change
+ * @arg len            new destination address length
+ */
+void rtnl_rule_set_dst_len(struct rtnl_rule *rule, int len)
+{
+       rule->r_dst_len = len;
+       if (rule->r_mask & RULE_ATTR_DST)
+               nl_addr_set_prefixlen(rule->r_dst, len);
+       rule->r_mask |= RULE_ATTR_DST_LEN;
+}
+
+/**
+ * Get the destination address prefix length of a rule
+ * @arg rule           rule handle
+ * @return Prefix length of destination address or -1 if not set
+ */
+int rtnl_rule_get_dst_len(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_DST_LEN)
+               return rule->r_dst_len;
+       else
+               return -1;
+}
+
+static inline int __assign_addr(struct rtnl_rule *rule, struct nl_addr **pos,
+                               struct nl_addr *new, uint8_t *len, int flag)
+{
+       if (rule->r_mask & RULE_ATTR_FAMILY) {
+               if (new->a_family != rule->r_family)
+                       return nl_error(EINVAL, "Address family mismatch");
+       } else
+               rule->r_family = new->a_family;
+
+       if (*pos)
+               nl_addr_put(*pos);
+
+       nl_addr_get(new);
+       *pos = new;
+       *len = nl_addr_get_prefixlen(new);
+
+       rule->r_mask |= (flag | RULE_ATTR_FAMILY);
+
+       return 0;
+}
+/**
+ * Set the source address of a rule
+ * @arg rule           rule to change
+ * @arg src            new source address
+ *
+ * Assigns the new source address to the specified rule handle. The
+ * address is validated against the address family if set already via
+ * either rtnl_rule_set_family() or by setting one of the other addresses.
+ * The assignment fails if the address families mismatch. In case the
+ * address family has not been specified yet, the address family of this
+ * new address is elected to be the requirement.
+ * 
+ * @return 0 on success or a negative error code.
+ */
+int rtnl_rule_set_src(struct rtnl_rule *rule, struct nl_addr *src)
+{
+       return __assign_addr(rule, &rule->r_src, src, &rule->r_src_len,
+                            RULE_ATTR_SRC | RULE_ATTR_SRC_LEN);
+}
+
+/**
+ * Get the source address of a rule
+ * @arg rule           rule handle
+ * @return Source address or NULL if not set
+ */
+struct nl_addr *rtnl_rule_get_src(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_SRC)
+               return rule->r_src;
+       else
+               return NULL;
+}
+
+/**
+ * Set the destination address of a rule
+ * @arg rule           rule to change
+ * @arg dst            new destination address
+ *
+ * Assigns the new destination address to the specified rule handle. The
+ * address is validated against the address family if set already via
+ * either rtnl_rule_set_family() or by setting one of the other addresses.
+ * The assignment fails if the address families mismatch. In case the
+ * address family has not been specified yet, the address family of this
+ * new address is elected to be the requirement.
+ * 
+ * @return 0 on success or a negative error code.
+ */
+int rtnl_rule_set_dst(struct rtnl_rule *rule, struct nl_addr *dst)
+{
+       return __assign_addr(rule, &rule->r_dst, dst, &rule->r_dst_len,
+                            RULE_ATTR_DST | RULE_ATTR_DST_LEN);
+}
+
+/**
+ * Get the destination address of a rule
+ * @arg rule           rule handle
+ * @return Destination address or NULL if not set
+ */
+struct nl_addr *rtnl_rule_get_dst(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_DST)
+               return rule->r_dst;
+       else
+               return NULL;
+}
+
+/**
+ * Set incoming interface of routing rule object.
+ * @arg rule           Routing rule object to be modified.
+ * @arg dev            Name of incoming interface.
+ *
+ * @return 0 on success or a negative error code.
+ */
+int rtnl_rule_set_iif(struct rtnl_rule *rule, const char *dev)
+{
+       if (strlen(dev) > IFNAMSIZ-1)
+               return nl_errno(ERANGE);
+
+       strcpy(rule->r_iif, dev);
+       rule->r_mask |= RULE_ATTR_IIF;
+       return 0;
+}
+
+/**
+ * Get incoming interface of routing rule object.
+ * @arg rule           Routing rule object.
+ * @return Name of incoming interface or NULL if not available.
+ */
+char *rtnl_rule_get_iif(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_IIF)
+               return rule->r_iif;
+       else
+               return NULL;
+}
+
+/**
+ * Set action of routing rule object.
+ * @arg rule           Routing rule object to be modified.
+ * @arg type           New routing type specifying an action.
+ */
+void rtnl_rule_set_action(struct rtnl_rule *rule, int type)
+{
+       rule->r_type = type;
+       rule->r_mask |= RULE_ATTR_TYPE;
+}
+
+/**
+ * Get action of routing rule object.
+ * @arg rule           Routing rule object.
+ * @return Routing type or a negative error code.
+ */
+int rtnl_rule_get_action(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_TYPE)
+               return rule->r_type;
+       else
+               return nl_errno(ENOENT);
+}
+
+/**
+ * Set realms of routing rule object.
+ * @arg rule           Routing rule object to be modified.
+ * @arg realms         New realms value.
+ */
+void rtnl_rule_set_realms(struct rtnl_rule *rule, realm_t realms)
+{
+       rule->r_realms = realms;
+       rule->r_mask |= RULE_ATTR_REALMS;
+}
+
+/**
+ * Get realms of routing rule object.
+ * @arg rule           Routing rule object.
+ * @return Realms value or 0 if not set.
+ */
+realm_t rtnl_rule_get_realms(struct rtnl_rule *rule)
+{
+       if (rule->r_mask & RULE_ATTR_REALMS)
+               return rule->r_realms;
+       else
+               return 0;
+}
+
+/** @} */
+
+static struct nl_cache_ops rtnl_rule_ops = {
+       .co_name                = "route/rule",
+       .co_size                = sizeof(struct rtnl_rule),
+       .co_hdrsize             = sizeof(struct rtmsg),
+       .co_msgtypes            = {
+                                       { RTM_NEWRULE, "new" },
+                                       { RTM_DELRULE, "delete" },
+                                       { RTM_GETRULE, "get" },
+                                       { -1, NULL },
+                                 },
+       .co_protocol            = NETLINK_ROUTE,
+       .co_request_update      = rule_request_update,
+       .co_msg_parser          = rule_msg_parser,
+       .co_free_data           = rule_free_data,
+       .co_dump[NL_DUMP_BRIEF] = rule_dump_brief,
+       .co_dump[NL_DUMP_FULL]  = rule_dump_full,
+       .co_dump[NL_DUMP_STATS] = rule_dump_stats,
+       .co_dump[NL_DUMP_XML]   = rule_dump_xml,
+       .co_dump[NL_DUMP_ENV]   = rule_dump_env,
+       .co_filter              = rule_filter,
+};
+
+static void __init rule_init(void)
+{
+       nl_cache_mngt_register(&rtnl_rule_ops);
+}
+
+static void __exit rule_exit(void)
+{
+       nl_cache_mngt_unregister(&rtnl_rule_ops);
+}
+
+/** @} */