From nobody Thu Apr 9 17:39:33 2026 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4fs6d21X3qz6YH8v for ; Thu, 09 Apr 2026 17:39:34 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R12" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4fs6d20GmFz4PNV for ; Thu, 09 Apr 2026 17:39:34 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1775756374; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=an7bPHOKOwIJL713DSryLbX1xKlcq2P5ppzlW6aWTqQ=; b=H74YZAE3UyAvM0QVl0IhXd64NOycphUVxlvYuRyNJk3MVGKNtiiexfxtawDJm6pC3DhzfR 29d18s9mKsVg/VhePXmunYJaaoS9qZDRxDzMcr/7BYgxxV3o1o+E1QevXzh6EzsvwUcgpA b62U3TBp40DilJc+JljPaJoD4cnBe2WM4erJHybD6yOUdM3xpl5lbyhxExDXFLIMfevlql n0MVIoYl+ccyHzO/WeVMmbzd0IaeAtJACsVCCW4lT23ziT8VwpmK9HEQTeH6jDyLFocR+K YlweQvW6uQ+hv1fsD6xmezvF1kkJWQ7fQWyHiyvY3TOygVs/vwC+Yrabkzi0yQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1775756374; a=rsa-sha256; cv=none; b=cw8O4j1i0Y0kb98/pjQry5GAIzUZDGPun9aVWEqKY6YAr+BEpXwSe01LKVe664l/YPhzmW OX8LMjbwuGKaORiMSe9neOBmZgtLToUYAjRdXtBFbksLSv/+CIYh+DmFD5DPeJtmBScpnh h6dzHLjnue8777iiFBy0GLK8owlTzaugeFhdXTP1pVMAT3fsalYbdh7p+PAa++TYbseOKA 2M+ZmTR4MypHmyLH9rxYQoUw+CgQ50W/X/obwqmr8YxbfgZNglccmzdEBnh6AIFdtH1pjf 9N6FoVz6heNvUgTh1GgLMQZzKmts3k0ff9D6dUymDFFPO7D6Y5SMVKqRu+vKtg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1775756374; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=an7bPHOKOwIJL713DSryLbX1xKlcq2P5ppzlW6aWTqQ=; b=qqIEfrSdTus/52Ty0+KuoJPFn4XF06EGCOBtIov92QsxlHNDma4nfWQYmLOmofpVx33mik LBNPMwkWS5odTl62ixjfxuKM33fDmAUGDvdCok8FXDvwg51nnTBelSeivILo1Lg9UXJqUM MYLlyRNG/VHtlfQhUmtyc7R8pbGoANZaKc2bzfR7fMSORlkcOvmxTZh6WTQvn0uxIenu/J bovdk7XDgHRfW71FLGlN/Bm+qK5tHAEXinA2LGR7O7bq3FN0d2AePEf18BQfrlq+bekc5s F18664OZTbRc8xx8sKhsYlyc/PX+BaXNsb6ENb7maLhk0Ih6RfMuJSZvK8sHDw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4fs6d16hp9z1MSP for ; Thu, 09 Apr 2026 17:39:33 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 32a5f by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Thu, 09 Apr 2026 17:39:33 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Baptiste Daroussin Subject: git: 72d701eb1d83 - main - nlsysevent: add manpage List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bapt X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 72d701eb1d83cfb3479e4c839412325ff9efc97c Auto-Submitted: auto-generated Date: Thu, 09 Apr 2026 17:39:33 +0000 Message-Id: <69d7e455.32a5f.7dad4d3b@gitrepo.freebsd.org> The branch main has been updated by bapt: URL: https://cgit.FreeBSD.org/src/commit/?id=72d701eb1d83cfb3479e4c839412325ff9efc97c commit 72d701eb1d83cfb3479e4c839412325ff9efc97c Author: Baptiste Daroussin AuthorDate: 2026-04-09 08:50:41 +0000 Commit: Baptiste Daroussin CommitDate: 2026-04-09 17:39:28 +0000 nlsysevent: add manpage Reviewed by: des --- share/man/man4/Makefile | 1 + share/man/man4/nlsysevent.4 | 132 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 133 insertions(+) diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index c35859b30b60..6883cdd7d6cf 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -428,6 +428,7 @@ MAN= aac.4 \ ng_vjc.4 \ ng_vlan.4 \ ng_vlan_rotate.4 \ + nlsysevent.4 \ nmdm.4 \ ${_ntb.4} \ ${_ntb_hw_amd.4} \ diff --git a/share/man/man4/nlsysevent.4 b/share/man/man4/nlsysevent.4 new file mode 100644 index 000000000000..3b46ab65f568 --- /dev/null +++ b/share/man/man4/nlsysevent.4 @@ -0,0 +1,132 @@ +.\" +.\" Copyright (c) 2026 Baptiste Daroussin +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.Dd April 9, 2026 +.Dt NLSYSEVENT 4 +.Os +.Sh NAME +.Nm nlsysevent +.Nd Netlink-based kernel event notification module +.Sh SYNOPSIS +To load the driver as a module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +nlsysevent_load="YES" +.Ed +.Pp +Alternatively, to load the module at runtime: +.Bd -literal -offset indent +kldload nlsysevent +.Ed +.Sh DESCRIPTION +The +.Nm +kernel module provides a +.Xr netlink 4 +Generic Netlink interface for receiving kernel device events. +It hooks into the +.Xr devctl 4 +notification system and re-publishes all kernel events as Generic Netlink +multicast messages under the +.Dv NETLINK_GENERIC +protocol family. +.Pp +This provides an alternative to reading events from +.Pa /dev/devctl +.Pq used by Xr devd 8 , +with the advantage that multiple consumers can subscribe to events +simultaneously, and consumers can selectively subscribe to specific +event groups. +.Ss Generic Netlink Family +The module registers a Generic Netlink family named +.Dq Li nlsysevent . +The dynamically-assigned family identifier can be resolved using the +standard +.Dv CTRL_CMD_GETFAMILY +request as described in +.Xr genetlink 4 . +.Ss Commands +The following command is defined: +.Bl -tag -width indent +.It Dv NLSE_CMD_NEWEVENT +Sent when a kernel event occurs. +This message is never solicited by userland; it is only delivered to +sockets that have subscribed to one or more multicast groups. +.El +.Ss Attributes +Each +.Dv NLSE_CMD_NEWEVENT +message contains the following TLV attributes: +.Bl -tag -width indent +.It Dv NLSE_ATTR_SYSTEM +(string) The system name that generated the event +.Pq e.g., Dq Li ACPI , Dq Li IFNET , Dq Li USB . +.It Dv NLSE_ATTR_SUBSYSTEM +(string) The subsystem name within the system. +.It Dv NLSE_ATTR_TYPE +(string) The type of the event. +.It Dv NLSE_ATTR_DATA +(string) Optional extra data associated with the event. +This attribute may be absent if no extra data was provided. +.El +.Ss Multicast Groups +The module creates one multicast group per system name. +The following groups are pre-registered when the module is loaded: +.Pp +.Bl -column "HYPERV_NIC_VF" -offset indent -compact +.It Li ACPI +.It Li AEON +.It Li CAM +.It Li CARP +.It Li coretemp +.It Li DEVFS +.It Li device +.It Li ETHERNET +.It Li GEOM +.It Li HYPERV_NIC_VF +.It Li IFNET +.It Li INFINIBAND +.It Li KERNEL +.It Li nvme +.It Li PMU +.It Li RCTL +.It Li USB +.It Li VFS +.It Li VT +.It Li ZFS +.El +.Pp +Additional groups are created dynamically as new system names appear in +kernel events, up to a maximum of 64 groups. +.Pp +The group identifier for a given system name can be resolved via +.Dv CTRL_CMD_GETFAMILY +and then subscribed to using the +.Dv NETLINK_ADD_MEMBERSHIP +socket option. +.Sh EXAMPLES +The +.Xr genl 1 +utility can be used to monitor events: +.Bd -literal -offset indent +genl monitor nlsysevent +.Ed +.Sh SEE ALSO +.Xr genl 1 , +.Xr snl 3 , +.Xr devctl 4 , +.Xr genetlink 4 , +.Xr netlink 4 , +.Xr devd 8 +.Sh HISTORY +The +.Nm +module first appeared in +.Fx 15.0 . +.Sh AUTHORS +The +.Nm +kernel module and this manual page were written by +.An Baptiste Daroussin Aq Mt bapt@FreeBSD.org .