From: Colin Vidal <colin@isc.org>
Date: Thu, 5 Jun 2025 15:31:12 +0000 (+0200)
Subject: update hook developer documentation
X-Git-Tag: v9.21.14~56^2~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=91cd7b865ca6114e2626473555c1501080cf77ec;p=thirdparty%2Fbind9.git

update hook developer documentation

Attempt to add zone plugin specificities into the hook developer
documentation. In particular about the hook call order and hookpoint
which can't be called on a zone plugin.
---

diff --git a/lib/ns/include/ns/hooks.h b/lib/ns/include/ns/hooks.h
index ee371dfdc10..713b9fb3c61 100644
--- a/lib/ns/include/ns/hooks.h
+++ b/lib/ns/include/ns/hooks.h
@@ -342,6 +342,30 @@
  *   actions. As long as hook actions have side effects, including
  *   modifying the internal query state, it's not guaranteed safe
  *   to use multiple independent hooks at the same time.)
+ *
+ * ZONE-SPECIFIC PLUGINS
+ *
+ * A plugin can be configured at the zone level instead of the view level
+ * (either directly inside a zone, or through zone template inclusion). Each
+ * zone has its own hooktable and plugin list, so the mechanism described
+ * above works in the same way. There are two differences, however:
+ *
+ * - Zone plugin hooks are called first. Zone template hooks are called
+ *   second. View hooks are called third. If any plugin hook at any level
+ *   returns NS_HOOK_RETURN, the whole calling chain is stopped and no
+ *   subsequent hooks are called. (See the `ns__query_hookchain` unit test
+ *   in `tests/ns/query_test.c`.)
+ *
+ * - When a query hook is called, the `qctx->client->query.authzone`
+ *   pointer is checked to determine whether an authoritative zone is
+ *   being used to answer the query; if so, the zone's hooktable is used to
+ *   call the hooks. As a consequence, a zone plugin won't be called by all
+ *   the hook points defined below in `ns_hookpoint_t`. For instance,
+ *   `NS_QUERY_SETUP` and `NS_QUERY_QCTX_INITIALIZED` will never be
+ *   called in a zone plugin, as they occur before the zone has been
+ *   looked up.  `NS_QUERY_DONE_BEGIN` could be called if an
+ *   authoritative zone has been used, but in some flows (for
+ *   instance, bad cookie handling), it would be skipped.
  */
 
 /*!