man7/netlink.7

   1 .\" This man page is Copyright (c) 1998 by Andi Kleen.
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" Subject to the GPL.
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Based on the original comments from Alexey Kuznetsov
   8 .\" Modified 2005-12-27 by Hasso Tepper <hasso@estpak.ee>
   9 .\" $Id: netlink.7,v 1.8 2000/06/22 13:23:00 ak Exp $
  10 .TH NETLINK  7 2021-03-22 "Linux" "Linux Programmer's Manual"
  11 .SH NAME
  12 netlink \- communication between kernel and user space (AF_NETLINK)
  13 .SH SYNOPSIS
  14 .nf
  15 .B #include <asm/types.h>
  16 .B #include <sys/socket.h>
  17 .B #include <linux/netlink.h>
  18 .PP
  19 .BI "netlink_socket = socket(AF_NETLINK, " socket_type ", " netlink_family );
  20 .fi
  21 .SH DESCRIPTION
  22 Netlink is used to transfer information between the kernel and
  23 user-space processes.
  24 It consists of a standard sockets-based interface for user space
  25 processes and an internal kernel API for kernel modules.
  26 The internal kernel interface is not documented in this manual page.
  27 There is also an obsolete netlink interface
  28 via netlink character devices; this interface is not documented here
  29 and is provided only for backward compatibility.
  30 .PP
  31 Netlink is a datagram-oriented service.
  32 Both
  33 .B SOCK_RAW
  34 and
  35 .B SOCK_DGRAM
  36 are valid values for
  37 .IR socket_type .
  38 However, the netlink protocol does not distinguish between datagram
  39 and raw sockets.
  40 .PP
  41 .I netlink_family
  42 selects the kernel module or netlink group to communicate with.
  43 The currently assigned netlink families are:
  44 .TP
  45 .BR NETLINK_ROUTE
  46 Receives routing and link updates and may be used to modify the routing
  47 tables (both IPv4 and IPv6), IP addresses, link parameters,
  48 neighbor setups, queueing disciplines, traffic classes, and
  49 packet classifiers (see
  50 .BR rtnetlink (7)).
  51 .TP
  52 .BR NETLINK_W1 " (Linux 2.6.13 to 2.16.17)"
  53 Messages from 1-wire subsystem.
  54 .TP
  55 .BR NETLINK_USERSOCK
  56 Reserved for user-mode socket protocols.
  57 .TP
  58 .BR NETLINK_FIREWALL " (up to and including Linux 3.4)"
  59 .\" removed by commit d16cf20e2f2f13411eece7f7fb72c17d141c4a84
  60 Transport IPv4 packets from netfilter to user space.
  61 Used by
  62 .I ip_queue
  63 kernel module.
  64 After a long period of being declared obsolete (in favor of the more advanced
  65 .I nfnetlink_queue
  66 feature),
  67 .BR NETLINK_FIREWALL
  68 was removed in Linux 3.5.
  69 .TP
  70 .BR NETLINK_SOCK_DIAG " (since Linux 3.3)"
  71 .\" commit 7f1fb60c4fc9fb29fbb406ac8c4cfb4e59e168d6
  72 Query information about sockets of various protocol families from the kernel
  73 (see
  74 .BR sock_diag (7)).
  75 .TP
  76 .BR NETLINK_INET_DIAG " (since Linux 2.6.14)"
  77 An obsolete synonym for
  78 .BR NETLINK_SOCK_DIAG .
  79 .TP
  80 .BR NETLINK_NFLOG " (up to and including Linux 3.16)"
  81 Netfilter/iptables ULOG.
  82 .TP
  83 .BR NETLINK_XFRM
  84 .\" FIXME More details on NETLINK_XFRM needed.
  85 IPsec.
  86 .TP
  87 .BR NETLINK_SELINUX " (since Linux 2.6.4)"
  88 SELinux event notifications.
  89 .TP
  90 .BR NETLINK_ISCSI " (since Linux 2.6.15)"
  91 .\" FIXME More details on NETLINK_ISCSI needed.
  92 Open-iSCSI.
  93 .TP
  94 .BR NETLINK_AUDIT " (since Linux 2.6.6)"
  95 .\" FIXME More details on NETLINK_AUDIT needed.
  96 Auditing.
  97 .TP
  98 .BR NETLINK_FIB_LOOKUP " (since Linux 2.6.13)"
  99 .\" FIXME More details on NETLINK_FIB_LOOKUP needed.
 100 Access to FIB lookup from user space.
 101 .TP
 102 .BR NETLINK_CONNECTOR " (since Linux 2.6.14)"
 103 Kernel connector.
 104 See
 105 .I Documentation/driver\-api/connector.rst
 106 (or
 107 .IR /Documentation/connector/connector.*
 108 .\" commit baa293e9544bea71361950d071579f0e4d5713ed
 109 in kernel 5.2 and earlier)
 110 in the Linux kernel source tree for further information.
 111 .TP
 112 .BR NETLINK_NETFILTER " (since Linux 2.6.14)"
 113 .\" FIXME More details on NETLINK_NETFILTER needed.
 114 Netfilter subsystem.
 115 .TP
 116 .BR NETLINK_SCSITRANSPORT " (since Linux 2.6.19)"
 117 .\" commit 84314fd4740ad73550c76dee4a9578979d84af48
 118 .\" FIXME More details on NETLINK_SCSITRANSPORT needed.
 119 SCSI Transports.
 120 .TP
 121 .BR NETLINK_RDMA " (since Linux 3.0)"
 122 .\" commit b2cbae2c248776d81cc265ff7d48405b6a4cc463
 123 .\" FIXME More details on NETLINK_RDMA needed.
 124 Infiniband RDMA.
 125 .TP
 126 .BR NETLINK_IP6_FW " (up to and including Linux 3.4)"
 127 Transport IPv6 packets from netfilter to user space.
 128 Used by
 129 .I ip6_queue
 130 kernel module.
 131 .TP
 132 .B NETLINK_DNRTMSG
 133 DECnet routing messages.
 134 .TP
 135 .BR NETLINK_KOBJECT_UEVENT " (since Linux 2.6.10)"
 136 .\" FIXME More details on NETLINK_KOBJECT_UEVENT needed.
 137 Kernel messages to user space.
 138 .TP
 139 .BR NETLINK_GENERIC " (since Linux 2.6.15)"
 140 Generic netlink family for simplified netlink usage.
 141 .TP
 142 .BR NETLINK_CRYPTO " (since Linux 3.2)"
 143 .\" commit a38f7907b926e4c6c7d389ad96cc38cec2e5a9e9
 144 .\" Author: Steffen Klassert <steffen.klassert@secunet.com>
 145 Netlink interface to request information about ciphers registered
 146 with the kernel crypto API as well as allow configuration of the
 147 kernel crypto API.
 148 .PP
 149 Netlink messages consist of a byte stream with one or multiple
 150 .I nlmsghdr
 151 headers and associated payload.
 152 The byte stream should be accessed only with the standard
 153 .B NLMSG_*
 154 macros.
 155 See
 156 .BR netlink (3)
 157 for further information.
 158 .PP
 159 In multipart messages (multiple
 160 .I nlmsghdr
 161 headers with associated payload in one byte stream) the first and all
 162 following headers have the
 163 .B NLM_F_MULTI
 164 flag set, except for the last header which has the type
 165 .BR NLMSG_DONE .
 166 .PP
 167 After each
 168 .I nlmsghdr
 169 the payload follows.
 170 .PP
 171 .in +4n
 172 .EX
 173 struct nlmsghdr {
 174     __u32 nlmsg_len;    /* Length of message including header */
 175     __u16 nlmsg_type;   /* Type of message content */
 176     __u16 nlmsg_flags;  /* Additional flags */
 177     __u32 nlmsg_seq;    /* Sequence number */
 178     __u32 nlmsg_pid;    /* Sender port ID */
 179 };
 180 .EE
 181 .in
 182 .PP
 183 .I nlmsg_type
 184 can be one of the standard message types:
 185 .B NLMSG_NOOP
 186 message is to be ignored,
 187 .B NLMSG_ERROR
 188 message signals an error and the payload contains an
 189 .I nlmsgerr
 190 structure,
 191 .B NLMSG_DONE
 192 message terminates a multipart message.
 193 Error messages get the
 194 original request appened, unless the user requests to cap the
 195 error message, and get extra error data if requested.
 196 .PP
 197 .in +4n
 198 .EX
 199 struct nlmsgerr {
 200     int error;        /* Negative errno or 0 for acknowledgements */
 201     struct nlmsghdr msg;  /* Message header that caused the error */
 202     /*
 203      * followed by the message contents unless NETLINK_CAP_ACK was set
 204      * or the ACK indicates success (error == 0).
 205      * For example Generic Netlink message with attributes.
 206      * message length is aligned with NLMSG_ALIGN()
 207      */
 208     /*
 209      * followed by TLVs defined in enum nlmsgerr_attrs
 210      * if NETLINK_EXT_ACK was set
 211      */
 212 };
 213 .EE
 214 .in
 215 .PP
 216 A netlink family usually specifies more message types, see the
 217 appropriate manual pages for that, for example,
 218 .BR rtnetlink (7)
 219 for
 220 .BR NETLINK_ROUTE .
 221 .nh
 222 .ad l
 223 .TS
 224 tab(:);
 225 l s
 226 lB lx.
 227 Standard flag bits in \fInlmsg_flags\fP
 228 _
 229 NLM_F_REQUEST:T{
 230 Must be set on all request messages.
 231 T}
 232 NLM_F_MULTI:T{
 233 The message is part of a multipart message terminated by
 234 .BR NLMSG_DONE .
 235 T}
 236 NLM_F_ACK:T{
 237 Request for an acknowledgement on success.
 238 T}
 239 NLM_F_ECHO:T{
 240 Echo this request.
 241 T}
 242 .TE
 243 .ad
 244 .hy
 245 .\" No right adjustment for text blocks in tables
 246 .nh
 247 .ad l
 248 .TS
 249 tab(:);
 250 l s
 251 lB lx.
 252 Additional flag bits for GET requests
 253 _
 254 NLM_F_ROOT:T{
 255 Return the complete table instead of a single entry.
 256 T}
 257 NLM_F_MATCH:T{
 258 Return all entries matching criteria passed in message content.
 259 Not implemented yet.
 260 T}
 261 NLM_F_ATOMIC:T{
 262 Return an atomic snapshot of the table.
 263 T}
 264 NLM_F_DUMP:T{
 265 Convenience macro; equivalent to
 266 (NLM_F_ROOT|NLM_F_MATCH).
 267 T}
 268 .TE
 269 .ad
 270 .hy
 271 .\" FIXME NLM_F_ATOMIC is not used anymore?
 272 .PP
 273 Note that
 274 .B NLM_F_ATOMIC
 275 requires the
 276 .B CAP_NET_ADMIN
 277 capability or an effective UID of 0.
 278 .nh
 279 .ad l
 280 .TS
 281 tab(:);
 282 l s
 283 lB lx.
 284 Additional flag bits for NEW requests
 285 _
 286 NLM_F_REPLACE:T{
 287 Replace existing matching object.
 288 T}
 289 NLM_F_EXCL:T{
 290 Don't replace if the object already exists.
 291 T}
 292 NLM_F_CREATE:T{
 293 Create object if it doesn't already exist.
 294 T}
 295 NLM_F_APPEND:T{
 296 Add to the end of the object list.
 297 T}
 298 .TE
 299 .ad
 300 .hy
 301 .PP
 302 .I nlmsg_seq
 303 and
 304 .I nlmsg_pid
 305 are used to track messages.
 306 .I nlmsg_pid
 307 shows the origin of the message.
 308 Note that there isn't a 1:1 relationship between
 309 .I nlmsg_pid
 310 and the PID of the process if the message originated from a netlink
 311 socket.
 312 See the
 313 .B ADDRESS FORMATS
 314 section for further information.
 315 .PP
 316 Both
 317 .I nlmsg_seq
 318 and
 319 .I nlmsg_pid
 320 .\" FIXME Explain more about nlmsg_seq and nlmsg_pid.
 321 are opaque to netlink core.
 322 .PP
 323 Netlink is not a reliable protocol.
 324 It tries its best to deliver a message to its destination(s),
 325 but may drop messages when an out-of-memory condition or
 326 other error occurs.
 327 For reliable transfer the sender can request an
 328 acknowledgement from the receiver by setting the
 329 .B NLM_F_ACK
 330 flag.
 331 An acknowledgement is an
 332 .B NLMSG_ERROR
 333 packet with the error field set to 0.
 334 The application must generate acknowledgements for
 335 received messages itself.
 336 The kernel tries to send an
 337 .B NLMSG_ERROR
 338 message for every failed packet.
 339 A user process should follow this convention too.
 340 .PP
 341 However, reliable transmissions from kernel to user are impossible
 342 in any case.
 343 The kernel can't send a netlink message if the socket buffer is full:
 344 the message will be dropped and the kernel and the user-space process will
 345 no longer have the same view of kernel state.
 346 It is up to the application to detect when this happens (via the
 347 .B ENOBUFS
 348 error returned by
 349 .BR recvmsg (2))
 350 and resynchronize.
 351 .SS Address formats
 352 The
 353 .I sockaddr_nl
 354 structure describes a netlink client in user space or in the kernel.
 355 A
 356 .I sockaddr_nl
 357 can be either unicast (only sent to one peer) or sent to
 358 netlink multicast groups
 359 .RI ( nl_groups
 360 not equal 0).
 361 .PP
 362 .in +4n
 363 .EX
 364 struct sockaddr_nl {
 365     sa_family_t     nl_family;  /* AF_NETLINK */
 366     unsigned short  nl_pad;     /* Zero */
 367     pid_t           nl_pid;     /* Port ID */
 368     __u32           nl_groups;  /* Multicast groups mask */
 369 };
 370 .EE
 371 .in
 372 .PP
 373 .I nl_pid
 374 is the unicast address of netlink socket.
 375 It's always 0 if the destination is in the kernel.
 376 For a user-space process,
 377 .I nl_pid
 378 is usually the PID of the process owning the destination socket.
 379 However,
 380 .I nl_pid
 381 identifies a netlink socket, not a process.
 382 If a process owns several netlink
 383 sockets, then
 384 .I nl_pid
 385 can be equal to the process ID only for at most one socket.
 386 There are two ways to assign
 387 .I nl_pid
 388 to a netlink socket.
 389 If the application sets
 390 .I nl_pid
 391 before calling
 392 .BR bind (2),
 393 then it is up to the application to make sure that
 394 .I nl_pid
 395 is unique.
 396 If the application sets it to 0, the kernel takes care of assigning it.
 397 The kernel assigns the process ID to the first netlink socket the process
 398 opens and assigns a unique
 399 .I nl_pid
 400 to every netlink socket that the process subsequently creates.
 401 .PP
 402 .I nl_groups
 403 is a bit mask with every bit representing a netlink group number.
 404 Each netlink family has a set of 32 multicast groups.
 405 When
 406 .BR bind (2)
 407 is called on the socket, the
 408 .I nl_groups
 409 field in the
 410 .I sockaddr_nl
 411 should be set to a bit mask of the groups which it wishes to listen to.
 412 The default value for this field is zero which means that no multicasts
 413 will be received.
 414 A socket may multicast messages to any of the multicast groups by setting
 415 .I nl_groups
 416 to a bit mask of the groups it wishes to send to when it calls
 417 .BR sendmsg (2)
 418 or does a
 419 .BR connect (2).
 420 Only processes with an effective UID of 0 or the
 421 .B CAP_NET_ADMIN
 422 capability may send or listen to a netlink multicast group.
 423 Since Linux 2.6.13,
 424 .\" commit d629b836d151d43332492651dd841d32e57ebe3b
 425 messages can't be broadcast to multiple groups.
 426 Any replies to a message received for a multicast group should be
 427 sent back to the sending PID and the multicast group.
 428 Some Linux kernel subsystems may additionally allow other users
 429 to send and/or receive messages.
 430 As at Linux 3.0, the
 431 .BR NETLINK_KOBJECT_UEVENT ,
 432 .BR NETLINK_GENERIC ,
 433 .BR NETLINK_ROUTE ,
 434 and
 435 .BR NETLINK_SELINUX
 436 groups allow other users to receive messages.
 437 No groups allow other users to send messages.
 438 .SS Socket options
 439 To set or get a netlink socket option, call
 440 .BR getsockopt (2)
 441 to read or
 442 .BR setsockopt (2)
 443 to write the option with the option level argument set to
 444 .BR SOL_NETLINK .
 445 Unless otherwise noted,
 446 .I optval
 447 is a pointer to an
 448 .IR int .
 449 .TP
 450 .BR NETLINK_PKTINFO " (since Linux 2.6.14)"
 451 .\"     commit 9a4595bc7e67962f13232ee55a64e063062c3a99
 452 .\"     Author: Patrick McHardy <kaber@trash.net>
 453 Enable
 454 .B nl_pktinfo
 455 control messages for received packets to get the extended
 456 destination group number.
 457 .TP
 458 .BR NETLINK_ADD_MEMBERSHIP ,\  NETLINK_DROP_MEMBERSHIP " (since Linux 2.6.14)"
 459 .\"     commit 9a4595bc7e67962f13232ee55a64e063062c3a99
 460 .\"     Author: Patrick McHardy <kaber@trash.net>
 461 Join/leave a group specified by
 462 .IR optval .
 463 .TP
 464 .BR NETLINK_LIST_MEMBERSHIPS " (since Linux 4.2)"
 465 .\"     commit b42be38b2778eda2237fc759e55e3b698b05b315
 466 .\"     Author: David Herrmann <dh.herrmann@gmail.com>
 467 Retrieve all groups a socket is a member of.
 468 .I optval
 469 is a pointer to
 470 .B __u32
 471 and
 472 .I optlen
 473 is the size of the array.
 474 The array is filled with the full membership set of the
 475 socket, and the required array size is returned in
 476 .IR optlen .
 477 .TP
 478 .BR NETLINK_BROADCAST_ERROR " (since Linux 2.6.30)"
 479 .\"     commit be0c22a46cfb79ab2342bb28fde99afa94ef868e
 480 .\"     Author: Pablo Neira Ayuso <pablo@netfilter.org>
 481 When not set,
 482 .B netlink_broadcast()
 483 only reports
 484 .B ESRCH
 485 errors and silently ignore
 486 .B ENOBUFS
 487 errors.
 488 .TP
 489 .BR NETLINK_NO_ENOBUFS " (since Linux 2.6.30)"
 490 .\"     commit 38938bfe3489394e2eed5e40c9bb8f66a2ce1405
 491 .\"     Author: Pablo Neira Ayuso <pablo@netfilter.org>
 492 This flag can be used by unicast and broadcast listeners to avoid receiving
 493 .B ENOBUFS
 494 errors.
 495 .TP
 496 .BR NETLINK_LISTEN_ALL_NSID " (since Linux 4.2)"
 497 .\"     commit 59324cf35aba5336b611074028777838a963d03b
 498 .\"     Author: Nicolas Dichtel <nicolas.dichtel@6wind.com>
 499 When set, this socket will receive netlink notifications from
 500 all network namespaces that have an
 501 .I nsid
 502 assigned into the network namespace where the socket has been opened.
 503 The
 504 .I nsid
 505 is sent to user space via an ancillary data.
 506 .TP
 507 .BR NETLINK_CAP_ACK " (since Linux 4.3)"
 508 .\"     commit 0a6a3a23ea6efde079a5b77688541a98bf202721
 509 .\"     Author: Christophe Ricard <christophe.ricard@gmail.com>
 510 The kernel may fail to allocate the necessary room for the acknowledgement
 511 message back to user space.
 512 This option trims off the payload of the original netlink message.
 513 The netlink message header is still included, so the user can guess from the
 514 sequence number which message triggered the acknowledgement.
 515 .SH VERSIONS
 516 The socket interface to netlink first appeared Linux 2.2.
 517 .PP
 518 Linux 2.0 supported a more primitive device-based netlink interface
 519 (which is still available as a compatibility option).
 520 This obsolete interface is not described here.
 521 .SH NOTES
 522 It is often better to use netlink via
 523 .I libnetlink
 524 or
 525 .I libnl
 526 than via the low-level kernel interface.
 527 .SH BUGS
 528 This manual page is not complete.
 529 .SH EXAMPLES
 530 The following example creates a
 531 .B NETLINK_ROUTE
 532 netlink socket which will listen to the
 533 .B RTMGRP_LINK
 534 (network interface create/delete/up/down events) and
 535 .B RTMGRP_IPV4_IFADDR
 536 (IPv4 addresses add/delete events) multicast groups.
 537 .PP
 538 .in +4n
 539 .EX
 540 struct sockaddr_nl sa;
 541
 542 memset(&sa, 0, sizeof(sa));
 543 sa.nl_family = AF_NETLINK;
 544 sa.nl_groups = RTMGRP_LINK | RTMGRP_IPV4_IFADDR;
 545
 546 fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);
 547 bind(fd, (struct sockaddr *) &sa, sizeof(sa));
 548 .EE
 549 .in
 550 .PP
 551 The next example demonstrates how to send a netlink message to the
 552 kernel (pid 0).
 553 Note that the application must take care of message sequence numbers
 554 in order to reliably track acknowledgements.
 555 .PP
 556 .in +4n
 557 .EX
 558 struct nlmsghdr *nh;    /* The nlmsghdr with payload to send */
 559 struct sockaddr_nl sa;
 560 struct iovec iov = { nh, nh\->nlmsg_len };
 561 struct msghdr msg;
 562
 563 msg = { &sa, sizeof(sa), &iov, 1, NULL, 0, 0 };
 564 memset(&sa, 0, sizeof(sa));
 565 sa.nl_family = AF_NETLINK;
 566 nh\->nlmsg_pid = 0;
 567 nh\->nlmsg_seq = ++sequence_number;
 568 /* Request an ack from kernel by setting NLM_F_ACK */
 569 nh\->nlmsg_flags |= NLM_F_ACK;
 570
 571 sendmsg(fd, &msg, 0);
 572 .EE
 573 .in
 574 .PP
 575 And the last example is about reading netlink message.
 576 .PP
 577 .in +4n
 578 .EX
 579 int len;
 580 /* 8192 to avoid message truncation on platforms with
 581    page size > 4096 */
 582 struct nlmsghdr buf[8192/sizeof(struct nlmsghdr)];
 583 struct iovec iov = { buf, sizeof(buf) };
 584 struct sockaddr_nl sa;
 585 struct msghdr msg;
 586 struct nlmsghdr *nh;
 587
 588 msg = { &sa, sizeof(sa), &iov, 1, NULL, 0, 0 };
 589 len = recvmsg(fd, &msg, 0);
 590
 591 for (nh = (struct nlmsghdr *) buf; NLMSG_OK (nh, len);
 592      nh = NLMSG_NEXT (nh, len)) {
 593     /* The end of multipart message */
 594     if (nh\->nlmsg_type == NLMSG_DONE)
 595         return;
 596
 597     if (nh\->nlmsg_type == NLMSG_ERROR)
 598         /* Do some error handling */
 599     ...
 600
 601     /* Continue with parsing payload */
 602     ...
 603 }
 604 .EE
 605 .in
 606 .SH SEE ALSO
 607 .BR cmsg (3),
 608 .BR netlink (3),
 609 .BR capabilities (7),
 610 .BR rtnetlink (7),
 611 .BR sock_diag (7)
 612 .PP
 613 .UR ftp://ftp.inr.ac.ru\:/ip\-routing\:/iproute2*
 614 information about libnetlink
 615 .UE
 616 .PP
 617 .UR http://www.infradead.org\:/\(titgr\:/libnl/
 618 information about libnl
 619 .UE
 620 .PP
 621 RFC 3549 "Linux Netlink as an IP Services Protocol"