From nobody Thu May 07 20:19:14 2026 X-Original-To: dev-commits-src-branches@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 4gBNrM1wZMz6d7fP for ; Thu, 07 May 2026 20:19:15 +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 "R13" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4gBNrM01TWz3Hmt for ; Thu, 07 May 2026 20:19:15 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1778185155; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ucO2mZDRpDlYUN94oyP+ZngcJML0iYz9auZI7wyr0xE=; b=Oye5XDDsAXdtNPSQsuHUsWje1Ra7DMWayz33Kdf/lfE+rzQAD7vJfbZCErR0lOYpy3jIE6 A+WDbqkGmnG9+Gy18YrdJ7QeQzMxqfzdephQdZSdAtldsdj2JBMxEio5aQnmfuj0cx/kb4 PrBaoFhOAKir/MI3x75DnsWrwk2iIAOgSh9H3iC7qlNv8R8tMj6UXR8EtdSwDZ9wsWqzMY xfh2/Qiuir2V9hP04JFez0JYSqxpX/ENVId594r3ITJBYwoCTJm5zMttWZwsRr2HU0lT97 zlamuznyUaIraIkAqcYsmbVvbxIC9HftVK0GAAhnKR90q6JQer1riF3R2C8VCg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1778185155; a=rsa-sha256; cv=none; b=fT1oFd5Zi1+M9w7XdpLRGwDMlFWb/1V9VCxHKDtC//qvg/Z2s5D0XFe6R0EBX0nwVXObV4 uhEKgx/vRAYSmw9+aE/0tHSbrLNXaQRfxAnodihkcC/3vjeUqXuiz9kOtE5XJ0A/HOKBxs a/YbhJjYPAXDmS5MytVwLGpp1xh/Yr1SGtPvnj265MgLV4IUBu3uRdbAB4RS++jV/zE0SX CCBtp32askuNnekG2O/s/k3EczczAbDKJ8gcunpta17tmvzWTlFQ1mxf5d1qFEdc0e0604 owgV5EQJ3oX4NWhVtL+t60NuVg8Y+pTZZf3kS47bdxqttm1yxsvBTn09GvfIbQ== 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=1778185155; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ucO2mZDRpDlYUN94oyP+ZngcJML0iYz9auZI7wyr0xE=; b=R9z9VTmWFcEW3PJ1tYvAAe6wve14zPJz+nMJxKcVPmm/izv8P/Q5tMFXnfgkqvfH9uAfK0 h0X5+rI5ENQLbB6u5xDCL+YnN6UCmtRxUAdSzlRxKWKelEv3lSpEZ0//lu1OLcbB0ejA58 GM+1KzwGbVYfAPNuThdZUYfoEgHKtx1yiu5uNNOkgDevxBFKrS9/LdwiRCzM8FbRYtgTKe iT6rdPNo2THhrIyaK8FsBZYMmP+wIMINlj3d2dsCJmBy92rV1YQxIHeiK6qrSyzPonK0EN 4863Cp/1bhcYBdF6TbK4aMml+sTRzlcHBwn6PmfwQaU5R0Tqsuuqp/ZsQUMLvA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4gBNrL6LJSzhLS for ; Thu, 07 May 2026 20:19:14 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 1f0e8 by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Thu, 07 May 2026 20:19:14 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org Cc: Baptiste Daroussin From: Colin Percival Subject: git: 56a5d11dd69f - releng/15.1 - nlsysevent: add manpage List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@FreeBSD.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: cperciva X-Git-Repository: src X-Git-Refname: refs/heads/releng/15.1 X-Git-Reftype: branch X-Git-Commit: 56a5d11dd69f726ca2455139c885146906c53de0 Auto-Submitted: auto-generated Date: Thu, 07 May 2026 20:19:14 +0000 Message-Id: <69fcf3c2.1f0e8.575f2296@gitrepo.freebsd.org> The branch releng/15.1 has been updated by cperciva: URL: https://cgit.FreeBSD.org/src/commit/?id=56a5d11dd69f726ca2455139c885146906c53de0 commit 56a5d11dd69f726ca2455139c885146906c53de0 Author: Baptiste Daroussin AuthorDate: 2026-04-09 08:50:41 +0000 Commit: Colin Percival CommitDate: 2026-05-07 20:18:46 +0000 nlsysevent: add manpage Approved by: re (cperciva) Reviewed by: des (cherry picked from commit 72d701eb1d83cfb3479e4c839412325ff9efc97c) (cherry picked from commit ee2fc974e0716040622926c7c8ca8df09284e6f9) --- 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 62d0b8f77f0f..23057e016f7d 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 .