diff options
Diffstat (limited to 'static/freebsd/man4/genetlink.4 3.html')
| -rw-r--r-- | static/freebsd/man4/genetlink.4 3.html | 147 |
1 files changed, 0 insertions, 147 deletions
diff --git a/static/freebsd/man4/genetlink.4 3.html b/static/freebsd/man4/genetlink.4 3.html deleted file mode 100644 index df0a66c7..00000000 --- a/static/freebsd/man4/genetlink.4 3.html +++ /dev/null @@ -1,147 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">GENETLINK(4)</td> - <td class="head-vol">Device Drivers Manual</td> - <td class="head-rtitle">GENETLINK(4)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">genetlink</code> — - <span class="Nd">Generic Netlink</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="In">#include - <<a class="In">netlink/netlink.h</a>></code> - <br/> - <code class="In">#include - <<a class="In">netlink/netlink_generic.h</a>></code></p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">socket</code>(<var class="Fa" style="white-space: nowrap;">AF_NETLINK</var>, - <var class="Fa" style="white-space: nowrap;">SOCK_DGRAM</var>, - <var class="Fa" style="white-space: nowrap;">NETLINK_GENERIC</var>);</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Dv">NETLINK_GENERIC</code> is a - "container" family, used for dynamic registration of other - families belonging to the various subsystems. These subsystems provide a - string family name during registration and receive a dynamically-allocated - family id. Allocated family identifiers are then used by applications to get - access to functions provided by that subsystem via netlink. There are - standard methods for resolving string family names to family identifiers. A - similar mechanism works for the notification groups provided by those - families.</p> -<p class="Pp">All generic netlink families share a common header:</p> -<div class="Bd Pp Li"> -<pre>struct genlmsghdr { - uint8_t cmd; /* command within the family */ - uint8_t version; /* ABI version for the cmd */ - uint16_t reserved; /* reserved: set to 0 */ -};</pre> -</div> -The family id is encoded in the <code class="Dv">nlmsg_type</code> of the base - netlink header. The <var class="Va">cmd</var> field is the command identifier - within the family. The <var class="Va">version</var> field is the command - version. -</section> -<section class="Sh"> -<h1 class="Sh" id="METHODS"><a class="permalink" href="#METHODS">METHODS</a></h1> -<p class="Pp">The generic Netlink framework provides the base family, - <code class="Dv">GENL_ID_CTRL</code> ("nlctrl") with a fixed - family id. This family is used to list the details of all registered - families.</p> -<p class="Pp">The following messages are supported by the framework:</p> -<section class="Ss"> -<h2 class="Ss" id="CTRL_CMD_GETFAMILY"><a class="permalink" href="#CTRL_CMD_GETFAMILY">CTRL_CMD_GETFAMILY</a></h2> -<p class="Pp">Fetches a single family or all registered families, depending on - the <code class="Dv">NLM_F_DUMP</code> flag. Each family is reported as - <code class="Dv">CTRL_CMD_NEWFAMILY</code> message. The following filters - are recognised by the kernel:</p> -<p class="Pp"></p> -<div class="Bd Bd-indent Li"> -<pre>CTRL_ATTR_FAMILY_ID (uint16_t) current family id assigned by kernel -CTRL_ATTR_FAMILY_NAME (string) family name</pre> -</div> -</section> -<section class="Ss"> -<h2 class="Ss" id="TLVs"><a class="permalink" href="#TLVs">TLVs</a></h2> -<dl class="Bl-tag"> - <dt id="CTRL_ATTR_FAMILY_ID"><a class="permalink" href="#CTRL_ATTR_FAMILY_ID"><code class="Dv">CTRL_ATTR_FAMILY_ID</code></a></dt> - <dd>(uint16_t) Dynamically-assigned family identifier.</dd> - <dt id="CTRL_ATTR_FAMILY_NAME"><a class="permalink" href="#CTRL_ATTR_FAMILY_NAME"><code class="Dv">CTRL_ATTR_FAMILY_NAME</code></a></dt> - <dd>(string) Family name.</dd> - <dt id="CTRL_ATTR_HDRSIZE"><a class="permalink" href="#CTRL_ATTR_HDRSIZE"><code class="Dv">CTRL_ATTR_HDRSIZE</code></a></dt> - <dd>(uint32_t) Family mandatory header size (typically 0).</dd> - <dt id="CTRL_ATTR_MAXATTR"><a class="permalink" href="#CTRL_ATTR_MAXATTR"><code class="Dv">CTRL_ATTR_MAXATTR</code></a></dt> - <dd>(uint32_t) Maximum attribute number valid for the family.</dd> - <dt id="CTRL_ATTR_OPS"><a class="permalink" href="#CTRL_ATTR_OPS"><code class="Dv">CTRL_ATTR_OPS</code></a></dt> - <dd>(nested) List of the operations supported by the family. The attribute - consists of a list of nested TLVs, with attribute values monotonically - incremented, starting from 0. The following attributes are present in each - TLV: - <dl class="Bl-tag"> - <dt id="CTRL_ATTR_OP_ID"><a class="permalink" href="#CTRL_ATTR_OP_ID"><code class="Dv">CTRL_ATTR_OP_ID</code></a></dt> - <dd>Operation (message) number.</dd> - <dt id="CTRL_ATTR_OP_FLAGS"><a class="permalink" href="#CTRL_ATTR_OP_FLAGS"><code class="Dv">CTRL_ATTR_OP_FLAGS</code></a></dt> - <dd>Operation flags. The following flags are supported: - <div class="Bd Bd-indent Li"> - <pre>GENL_ADMIN_PERM requires elevated permissions -GENL_CMD_CAP_DO operation is a modification request -GENL_CMD_CAP_DUMP operation is a get/dump request</pre> - </div> - </dd> - </dl> - </dd> - <dt id="CTRL_ATTR_MCAST_GROUPS"><a class="permalink" href="#CTRL_ATTR_MCAST_GROUPS"><code class="Dv">CTRL_ATTR_MCAST_GROUPS</code></a></dt> - <dd>(nested) List of the notification groups supported by the family. The - attribute consists of a list of nested TLVs, with attribute values - monotonically incremented, starting from 0. The following attributes are - present in each TLV: - <dl class="Bl-tag"> - <dt id="CTRL_ATTR_MCAST_GRP_ID"><a class="permalink" href="#CTRL_ATTR_MCAST_GRP_ID"><code class="Dv">CTRL_ATTR_MCAST_GRP_ID</code></a></dt> - <dd>Group id that can be used in - <code class="Dv">NETLINK_ADD_MEMBERSHIP</code> - <a class="Xr">setsockopt(2)</a>.</dd> - <dt id="CTRL_ATTR_MCAST_GRP_NAME"><a class="permalink" href="#CTRL_ATTR_MCAST_GRP_NAME"><code class="Dv">CTRL_ATTR_MCAST_GRP_NAME</code></a></dt> - <dd>(string) Human-readable name of the group.</dd> - </dl> - </dd> -</dl> -</section> -<section class="Ss"> -<h2 class="Ss" id="Groups"><a class="permalink" href="#Groups">Groups</a></h2> -<p class="Pp">The following groups are defined:</p> -<div class="Bd Bd-indent Li"> -<pre>"notify" Notifies on family registrations/removal.</pre> -</div> -</section> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">snl(3)</a>, <a class="Xr">netlink(4)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> -<p class="Pp">The <code class="Dv">NETLINK_GENERIC</code> protocol family - appeared in <span class="Ux">FreeBSD 13.2</span>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -<p class="Pp">The netlink was implemented by <span class="An">Alexander - Chernikov</span> - <<a class="Mt" href="mailto:melifaro@FreeBSD.org">melifaro@FreeBSD.org</a>>. - It was derived from the Google Summer of Code 2021 project by - <span class="An">Ng Peng Nam Sean</span>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">November 1, 2022</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |