From patchwork Thu May 8 17:47:43 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexey Abramov X-Patchwork-Id: 42466 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 2866627BC4D; Thu, 8 May 2025 18:51:40 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-7.4 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H2, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 3312627BC49 for ; Thu, 8 May 2025 18:51:36 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uD5P2-0005QZ-Ov; Thu, 08 May 2025 13:51:25 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uD5Oj-0005Di-Il for guix-patches@gnu.org; Thu, 08 May 2025 13:51:12 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1uD5Oh-0001ur-Uo; Thu, 08 May 2025 13:51:04 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:References:In-Reply-To:Date:From:To:Subject; bh=YbrxUh/HT77zH5g0OEdWMWI+E/t1u8bYxuTaI2+WAkw=; b=uWvVlgScWH70Xyo+2IE6bNNqd6H8RDQQVpFeHkW9tISMwhyzWZX12SMxi0i1XGb5XP54bQSqQVPP+oRSTI2tYds2Pvkigv/+MGG9ldqiX5Eht0NWBNGaaRWpYczW6ixEdrd3nsV+3Cj8zFjPeAJ9By59Sszkt7fn5iiIhnmpfLr6KgLx3yLs7MSwoucJ+JGiC+iGkALyDMTiti2AtxE17WNNc2pqIZCRMkT5mrtvb2Mu/DJ20G6hZpK4nOrfCQr9gUrtRZQUdAa/cT4x3QEHb3tQH/GpnS2p9NdVUnUNo6WUMgJzeKikrpBrTQhiDfz9be4ioHLO1HjVBgg92EP59w==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1uD5Oh-0007gU-NH; Thu, 08 May 2025 13:51:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#77204] [PATCH v4 3/3] services: dnsmasq: Add stats and reload shepherd actions. Resent-From: Alexey Abramov Original-Sender: "Debbugs-submit" Resent-CC: gabriel@erlikon.ch, ludo@gnu.org, maxim.cournoyer@gmail.com, guix-patches@gnu.org Resent-Date: Thu, 08 May 2025 17:51:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 77204 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 77204@debbugs.gnu.org Cc: Gabriel Wicki , Ludovic =?utf-8?q?Court=C3=A8s?= , Maxim Cournoyer X-Debbugs-Original-Xcc: Gabriel Wicki , Ludovic =?utf-8?q?Court=C3=A8s?= , Maxim Cournoyer Received: via spool by 77204-submit@debbugs.gnu.org id=B77204.174672663829445 (code B ref 77204); Thu, 08 May 2025 17:51:03 +0000 Received: (at 77204) by debbugs.gnu.org; 8 May 2025 17:50:38 +0000 Received: from localhost ([127.0.0.1]:59721 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1uD5OH-0007em-RI for submit@debbugs.gnu.org; Thu, 08 May 2025 13:50:38 -0400 Received: from mail.mmer.org ([178.22.65.174]:51192) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1uD5OE-0007dp-CL for 77204@debbugs.gnu.org; Thu, 08 May 2025 13:50:35 -0400 Received: from mail.mmer.org (localhost [127.0.0.1]) by mail.mmer.org (OpenSMTPD) with ESMTP id 56ba2924 for <77204@debbugs.gnu.org>; Thu, 8 May 2025 17:50:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=mmer.org; h=from:to :subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; s=dkim; bh=hjkpYhLz3nO4nCid3HAjVGLsZ I5kVK+2gr7GZ/FyksU=; b=Jv1fHwvTf+0hjqTvN+vxdszLixw8GKlOQNQPOMBo6 PvwR3QcbhNv7D5yS+X81IYLjI4FYt+8CrjRko3YH3CC+5lA3Zot1uqjpqQV3afmH Rwul1pd8BXMpm7UVza2EXHIsxxHtsWiq2o7z97TKGWnkxYfFjDU/DFu83DxufIFB Qs= Received: from delta (208-91-20-31.ftth.glasoperator.nl [31.20.91.208]) by mail.mmer.org (OpenSMTPD) with ESMTPSA id fc22e554 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO) for <77204@debbugs.gnu.org>; Thu, 8 May 2025 17:50:23 +0000 (UTC) Date: Thu, 8 May 2025 19:47:43 +0200 Message-ID: <0780b834d037ca669f1f6edfb67b4b671aac8d58.1746726463.git.levenson@mmer.org> X-Mailer: git-send-email 2.49.0 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-to: Alexey Abramov X-ACL-Warn: , Alexey Abramov via Guix-patches X-Patchwork-Original-From: Alexey Abramov via Guix-patches via From: Alexey Abramov Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * gnu/services/dns.scm (dnsmasq-service-reload-action): New function. Implements SIGHUP handling for reloading configurations. (dnsmasq-service-stats-action): New function. Implements SIGUSR1 handling for dumping statistics. (dnsmasq-shepherd-service): Use new actions. * doc/guix.texi: Document new actions with examples. * gnu/tests/networking.scm (%test-dnsmasq): Add tests to verify the functionality of new actions. --- doc/guix.texi | 52 +++++++++++++++++++++ gnu/services/dns.scm | 22 +++++++++ gnu/tests/networking.scm | 98 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 172 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index ec096643eaa..fa34eb4a8bc 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -36077,6 +36077,58 @@ DNS Services (no-resolv? #t) (servers '("192.168.1.1")))) @end lisp + +@code{dnsmasq-service-type} provides two actions: + +@table @code +@item reload +Send a @code{SIGHUP} signal to @command{dnsmasq} to clear cache and +reload hosts files which triggers the following actions: + +@itemize @bullet +@item +Clears the DNS cache +@item +Reloads @file{/etc/hosts} and @file{/etc/ethers} +@item +Reloads files specified by @option{--dhcp-hostsfile}, @option{--dhcp-hostsdir}, +@option{--dhcp-optsfile}, @option{--dhcp-optsdir}, @option{--addn-hosts}, +or @option{--hostsdir} +@item +Executes DHCP lease change scripts for all existing leases +@item +Rereads @file{/etc/resolv.conf} (only if @option{--no-poll} is configured) +@end itemize + +@emph{Note:} The @code{SIGHUP} signal does not trigger a reread of the main +configuration file. + +Example usage: +@example +herd reload dnsmasq +@end example + +@item stats +When @command{dnsmasq} receives a @code{SIGUSR1} signal, it writes +statistics to the system log including: + +@itemize @bullet +@item +Cache size and number of evicted entries +@item +Cache hits, misses, and authoritative queries answered +@item +For each upstream server: queries sent and errors received +@item +TCP connection fork statistics +@end itemize + +Example usage: +@example +herd stats dnsmasq +@end example +@end table + @end defvar @deftp {Data Type} dnsmasq-configuration diff --git a/gnu/services/dns.scm b/gnu/services/dns.scm index d55ee3e4fcb..9a9b78d877b 100644 --- a/gnu/services/dns.scm +++ b/gnu/services/dns.scm @@ -874,6 +874,8 @@ (define (dnsmasq-shepherd-service config) (provision (or provision shepherd-provision)) (requirement shepherd-requirement) (documentation "Run the dnsmasq DNS server.") + (actions (list (dnsmasq-service-reload-action config) + (dnsmasq-service-stats-action config))) (start #~(make-forkexec-constructor (list #$(file-append package "/sbin/dnsmasq") @@ -965,6 +967,26 @@ (define (dnsmasq-activation config) ;; create directory to store dnsmasq lease file (mkdir-p "/var/lib/misc"))) +(define (dnsmasq-service-reload-action config) + (match-record config () + (shepherd-action + (name 'reload) + (documentation "Send a @code{SIGHUP} signal to @command{dnsmasq} to clear +cache and reload hosts files.") + (procedure #~(lambda (running) + (let ((pid (process-id running))) + (kill pid SIGHUP))))))) + +(define (dnsmasq-service-stats-action config) + (match-record config () + (shepherd-action + (name 'stats) + (documentation "Send a @code{SIGUSR1} to write statistics to the system +log.") + (procedure #~(lambda (running) + (let ((pid (process-id running))) + (kill pid SIGUSR1))))))) + (define dnsmasq-service-type (service-type (name 'dnsmasq) diff --git a/gnu/tests/networking.scm b/gnu/tests/networking.scm index 7d54ebba50e..fdc515ceb04 100644 --- a/gnu/tests/networking.scm +++ b/gnu/tests/networking.scm @@ -27,6 +27,7 @@ (define-module (gnu tests networking) #:use-module (gnu system vm) #:use-module (gnu services) #:use-module (gnu services base) + #:use-module (gnu services dns) #:use-module (gnu services networking) #:use-module (guix gexp) #:use-module (guix store) @@ -46,6 +47,7 @@ (define-module (gnu tests networking) %test-openvswitch %test-dhcpd %test-dhcpcd + %test-dnsmasq %test-tor %test-iptables %test-ipfs)) @@ -675,6 +677,102 @@ (define %test-dhcpd (description "Test a running DHCP daemon configuration.") (value (run-dhcpd-test)))) + + +;;; +;;; dnsmasq tests +;;; + + +(define dnsmasq-os-configuration + (dnsmasq-configuration)) + +(define %dnsmasq-os + (simple-operating-system + (service dhcp-client-service-type) + (service dnsmasq-service-type + (dnsmasq-configuration + (extra-options + (list "--log-facility=/tmp/dnsmasq.log")))))) + + +(define (run-dnsmasq-test) + (define os + (marionette-operating-system %dnsmasq-os + #:imported-modules '((gnu services herd)))) + + (define test + (with-imported-modules '((gnu build marionette)) + #~(begin + (use-modules (gnu build marionette) + (srfi srfi-64)) + + (define marionette + (make-marionette (list #$(virtual-machine os)))) + + (test-runner-current (system-test-runner #$output)) + (test-begin "dnsmasq") + + (test-assert "dnsmasq is alive" + (marionette-eval + '(begin + (use-modules (gnu services herd)) + (wait-for-service 'dnsmasq)) + marionette)) + + (test-assert "pid file exists" + (wait-for-file + '#$(dnsmasq-configuration-pid-file dnsmasq-os-configuration) + marionette)) + + (test-assert "send SIGHUP" + (positive? + (marionette-eval + '(begin + (use-modules (ice-9 rdelim)) + (system* "sync") + (let* ((port (open-input-file "/tmp/dnsmasq.log"))) + (seek port 0 SEEK_END) + (system* "herd" "reload" "dnsmasq") + (system* "sync") + (let ((line (read-line port))) + (close-port port) + (string-contains line "read /etc/hosts")))) + marionette))) + + (test-assert "send SIGUSR1" + (positive? + (marionette-eval + '(begin + (use-modules (ice-9 rdelim)) + (system* "sync") + (let* ((port (open-input-file "/tmp/dnsmasq.log"))) + (seek port 0 SEEK_END) + (system* "herd" "stats" "dnsmasq") + (system* "sync") + (let ((line (read-line port))) + (close-port port) + (string-contains-ci line "time")))) + marionette))) + + (test-assert "dnsmasq is alive" + (marionette-eval + '(begin + (use-modules (gnu services herd)) + (wait-for-service 'dnsmasq)) + marionette)) + + (test-end)))) + + (gexp->derivation "dnsmasq-test" test)) + +(define %test-dnsmasq + (system-test + (name "dnsmasq") + (description "Test a running dnsmasq daemon configuration.") + (value (run-dnsmasq-test)))) + + ;;; ;;; DHCPCD Daemon