pimd: abstract addresses for IPv4/IPv6 PIM

Depending on whether we're compiling pimd or pim6d, these types take on
the appropriate AF being used.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>

5 files changed, 133 insertions, 1 deletions

diff --git a/pimd/pim_addr.c b/pimd/pim_addr.c
new file mode 100644
index 0000000000..bc9beca4ef
--- /dev/null
+++ b/pimd/pim_addr.c
@@ -0,0 +1,66 @@
+/*
+ * PIM address generalizations
+ * Copyright (C) 2022  David Lamparter for NetDEF, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; see the file COPYING; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include <zebra.h>
+
+#include "pim_addr.h"
+#include "printfrr.h"
+#include "prefix.h"
+
+
+printfrr_ext_autoreg_p("PA", printfrr_pimaddr)
+static ssize_t printfrr_pimaddr(struct fbuf *buf, struct printfrr_eargs *ea,
+				const void *vptr)
+{
+	const pim_addr *addr = vptr;
+	bool use_star = false;
+
+	if (ea->fmt[0] == 's') {
+		use_star = true;
+		ea->fmt++;
+	}
+
+	if (!addr)
+		return bputs(buf, "(null)");
+
+	if (use_star) {
+		pim_addr zero = {};
+
+		if (memcmp(addr, &zero, sizeof(zero)) == 0)
+			return bputch(buf, '*');
+	}
+
+#if PIM_IPV == 4
+	return bprintfrr(buf, "%pI4", addr);
+#else
+	return bprintfrr(buf, "%pI6", addr);
+#endif
+}
+
+printfrr_ext_autoreg_p("SG", printfrr_sgaddr)
+static ssize_t printfrr_sgaddr(struct fbuf *buf, struct printfrr_eargs *ea,
+			       const void *vptr)
+{
+	const pim_sgaddr *sga = vptr;
+
+	if (!sga)
+		return bputs(buf, "(null)");
+
+	return bprintfrr(buf, "(%pPAs,%pPAs)", &sga->src, &sga->grp);
+}
diff --git a/pimd/pim_addr.h b/pimd/pim_addr.h
new file mode 100644
index 0000000000..1e9da77779
--- /dev/null
+++ b/pimd/pim_addr.h
@@ -0,0 +1,63 @@
+/*
+ * PIM address generalizations
+ * Copyright (C) 2022  David Lamparter for NetDEF, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; see the file COPYING; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef _PIMD_PIM_ADDR_H
+#define _PIMD_PIM_ADDR_H
+
+#include "jhash.h"
+
+#if PIM_IPV == 4
+typedef struct in_addr pim_addr;
+#define PIM_ADDRSTRLEN INET_ADDRSTRLEN
+#else
+typedef struct in6_addr pim_addr;
+#define PIM_ADDRSTRLEN INET6_ADDRSTRLEN
+#endif
+
+/* don't use this struct directly, use the pim_sgaddr typedef */
+struct _pim_sgaddr {
+	pim_addr grp;
+	pim_addr src;
+};
+
+typedef struct _pim_sgaddr pim_sgaddr;
+
+static inline int pim_sgaddr_cmp(const pim_sgaddr a, const pim_sgaddr b)
+{
+	/* memcmp over the entire struct = memcmp(grp) + memcmp(src) */
+	return memcmp(&a, &b, sizeof(a));
+}
+
+static inline uint32_t pim_sgaddr_hash(const pim_sgaddr a, uint32_t initval)
+{
+	return jhash2((uint32_t *)&a, sizeof(a) / sizeof(uint32_t), initval);
+}
+
+#ifdef _FRR_ATTRIBUTE_PRINTFRR
+#pragma FRR printfrr_ext "%pPA" (pim_addr *)
+#pragma FRR printfrr_ext "%pSG" (pim_sgaddr *)
+#endif
+
+/*
+ * There is no pim_sgaddr2str().  This is intentional.  Instead, use:
+ *	snprintfrr(buf, sizeof(buf), "%pPA", sgaddr)
+ * (and note that snprintfrr is implicit for vty_out and zlog_*)
+ */
+
+#endif /* _PIMD_PIM_ADDR_H */
diff --git a/pimd/pim_str.h b/pimd/pim_str.h
index 3510d994b9..ec25db810a 100644
--- a/pimd/pim_str.h
+++ b/pimd/pim_str.h
@@ -26,7 +26,7 @@
 
 #include <prefix.h>
 
-typedef struct in_addr pim_addr;
+#include "pim_addr.h"
 
 /*
  * Longest possible length of a (S,G) string is 36 bytes
diff --git a/pimd/pimd.h b/pimd/pimd.h
index 675c0ebc6b..5ba29f9c41 100644
--- a/pimd/pimd.h
+++ b/pimd/pimd.h
@@ -27,6 +27,7 @@
 #include "vty.h"
 #include "plist.h"
 
+#include "pim_addr.h"
 #include "pim_instance.h"
 #include "pim_str.h"
 #include "pim_memory.h"
diff --git a/pimd/subdir.am b/pimd/subdir.am
index 520b1aa187..355389ed74 100644
--- a/pimd/subdir.am
+++ b/pimd/subdir.am
@@ -13,6 +13,7 @@ man8 += $(MANBUILD)/mtracebis.8
 endif
 
 pim_common = \
+	pimd/pim_addr.c \
 	pimd/pim_assert.c \
 	pimd/pim_bfd.c \
 	pimd/pim_br.c \
@@ -87,6 +88,7 @@ nodist_pimd_pim6d_SOURCES = \
 	# end
 
 noinst_HEADERS += \
+	pimd/pim_addr.h \
 	pimd/pim_assert.h \
 	pimd/pim_bfd.h \
 	pimd/pim_br.h \