From 85b09765c45e3fcfc1eb1400eff659454850a42f Mon Sep 17 00:00:00 2001
From: David Lamparter <equinox@opensourcerouting.org>
Date: Thu, 2 May 2024 10:57:31 +0200
Subject: [PATCH] build: warn/fail on missing `XREF_SETUP()`

While clippy tries really, really hard to work under adverse conditions,
and this catches missing XREF_SETUP() on almost all CPU architectures,
this doesn't quite work on hppa.  So, make it a warning on *all*
platforms (or error for --enable-dev-build) in order to catch it before
shipping off to Debian's buildd and blowing up there...

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
---
 lib/elf_py.c              |  9 +++++++++
 python/clippy/__init__.py |  1 +
 python/xrelfo.py          | 15 ++++++++++++++-
 3 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/lib/elf_py.c b/lib/elf_py.c
index 643495d8c7..2b4fea373f 100644
--- a/lib/elf_py.c
+++ b/lib/elf_py.c
@@ -1358,6 +1358,15 @@ bool elf_py_init(PyObject *pymod)
 	(void)methods_elfpy;
 #endif
 
+#if defined(HAVE_GELF_GETNOTE) && defined(HAVE_ELF_GETDATA_RAWCHUNK)
+	PyObject *elf_notes = Py_True;
+#else
+	PyObject *elf_notes = Py_False;
+#endif
+	Py_INCREF(elf_notes);
+	if (PyModule_AddObject(pymod, "elf_notes", elf_notes))
+		Py_DECREF(elf_notes);
+
 	ELFFormatError = PyErr_NewException("_clippy.ELFFormatError",
 					    PyExc_ValueError, NULL);
 	PyModule_AddObject(pymod, "ELFFormatError", ELFFormatError);
diff --git a/python/clippy/__init__.py b/python/clippy/__init__.py
index 60119fbac0..668724ab2a 100644
--- a/python/clippy/__init__.py
+++ b/python/clippy/__init__.py
@@ -20,6 +20,7 @@ from _clippy import (
     CMD_ATTR_HIDDEN,
     CMD_ATTR_DEPRECATED,
     CMD_ATTR_NOSH,
+    elf_notes,
 )
 
 
diff --git a/python/xrelfo.py b/python/xrelfo.py
index a40b19e5fb..07cd74071f 100644
--- a/python/xrelfo.py
+++ b/python/xrelfo.py
@@ -22,7 +22,7 @@ import argparse
 
 from clippy.uidhash import uidhash
 from clippy.elf import *
-from clippy import frr_top_src, CmdAttr
+from clippy import frr_top_src, CmdAttr, elf_notes
 from tiabwarfo import FieldApplicator
 from xref2vtysh import CommandEntry
 
@@ -327,6 +327,7 @@ class Xrelfo(dict):
             }
         )
         self._xrefs = []
+        self.note_warn = False
 
     def load_file(self, filename):
         orig_filename = filename
@@ -395,6 +396,15 @@ class Xrelfo(dict):
             ptrs = edf.iter_data(XrefPtr, slice(start, end))
 
         else:
+            if elf_notes:
+                self.note_warn = True
+                sys.stderr.write(
+                    """%s: warning: binary has no FRRouting.XREF note
+%s-   one of FRR_MODULE_SETUP, FRR_DAEMON_INFO or XREF_SETUP must be used
+"""
+                    % (orig_filename, orig_filename)
+                )
+
             xrefarray = edf.get_section("xref_array")
             if xrefarray is None:
                 raise ValueError("file has neither xref note nor xref_array section")
@@ -471,6 +481,9 @@ def _main(args):
             sys.stderr.write("while processing %s:\n" % (fn))
             traceback.print_exc()
 
+    if xrelfo.note_warn and args.Werror:
+        errors += 1
+
     for option in dir(args):
         if option.startswith("W") and option != "Werror":
             checks = sorted(xrelfo.check(args))
-- 
2.39.5