freebsd-dev/sys/netlink/route/ifaddrs.h
Alexander V. Chernikov 7e5bf68495 netlink: add netlink support
Netlinks is a communication protocol currently used in Linux kernel to modify,
 read and subscribe for nearly all networking state. Interfaces, addresses, routes,
 firewall, fibs, vnets, etc are controlled via netlink.
It is async, TLV-based protocol, providing 1-1 and 1-many communications.

The current implementation supports the subset of NETLINK_ROUTE
family. To be more specific, the following is supported:
* Dumps:
 - routes
 - nexthops / nexthop groups
 - interfaces
 - interface addresses
 - neighbors (arp/ndp)
* Notifications:
 - interface arrival/departure
 - interface address arrival/departure
 - route addition/deletion
* Modifications:
 - adding/deleting routes
 - adding/deleting nexthops/nexthops groups
 - adding/deleting neghbors
 - adding/deleting interfaces (basic support only)
* Rtsock interaction
 - route events are bridged both ways

The implementation also supports the NETLINK_GENERIC family framework.

Implementation notes:
Netlink is implemented via loadable/unloadable kernel module,
 not touching many kernel parts.
Each netlink socket uses dedicated taskqueue to support async operations
 that can sleep, such as interface creation. All message processing is
 performed within these taskqueues.

Compatibility:
Most of the Netlink data models specified above maps to FreeBSD concepts
 nicely. Unmodified ip(8) binary correctly works with
interfaces, addresses, routes, nexthops and nexthop groups. Some
software such as net/bird require header-only modifications to compile
and work with FreeBSD netlink.

Reviewed by:	imp
Differential Revision: https://reviews.freebsd.org/D36002
MFC after:	2 months
2022-10-01 14:15:35 +00:00

91 lines
3.2 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2022 Alexander V. Chernikov <melifaro@FreeBSD.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Interface address-related (RTM_<NEW|DEL|GET>ADDR) message header and attributes.
*/
#ifndef _NETLINK_ROUTE_IFADDRS_H_
#define _NETLINK_ROUTE_IFADDRS_H_
/* Base header for all of the relevant messages */
struct ifaddrmsg {
uint8_t ifa_family; /* Address family */
uint8_t ifa_prefixlen; /* Prefix length */
uint8_t ifa_flags; /* Address-specific flags */
uint8_t ifa_scope; /* Address scope */
uint32_t ifa_index; /* Link ifindex */
};
#ifndef _KERNEL
#define _NL_IFA_HDRLEN ((int)sizeof(struct ifaddrmsg))
#define IFA_RTA(_ifa) ((struct rtattr *)(NL_ITEM_DATA(_ifa, _NL_IFA_HDRLEN)))
#define IFA_PAYLOAD(_hdr) NLMSG_PAYLOAD(_hdr, _NL_IFA_HDRLEN)
#endif
/* Defined attributes */
enum {
IFA_UNSPEC,
IFA_ADDRESS = 1, /* binary, prefix address (destination for p2p) */
IFA_LOCAL = 2, /* binary, interface address */
IFA_LABEL = 3, /* not supported */
IFA_BROADCAST = 4, /* binary, broadcast ifa */
IFA_ANYCAST = 5, /* not supported */
IFA_CACHEINFO = 6, /* not supported */
IFA_MULTICAST = 7, /* not supported */
IFA_FLAGS = 8, /* not supported */
IFA_RT_PRIORITY = 9, /* not supported */
IFA_TARGET_NETNSID = 10, /* not supported */
__IFA_MAX,
};
#define IFA_MAX (__IFA_MAX - 1)
/* IFA_FLAGS attribute flags */
#define IFA_F_SECONDARY 0x0001
#define IFA_F_TEMPORARY IFA_F_SECONDARY
#define IFA_F_NODAD 0x0002
#define IFA_F_OPTIMISTIC 0x0004
#define IFA_F_DADFAILED 0x0008
#define IFA_F_HOMEADDRESS 0x0010
#define IFA_F_DEPRECATED 0x0020
#define IFA_F_TENTATIVE 0x0040
#define IFA_F_PERMANENT 0x0080
#define IFA_F_MANAGETEMPADDR 0x0100
#define IFA_F_NOPREFIXROUTE 0x0200
#define IFA_F_MCAUTOJOIN 0x0400
#define IFA_F_STABLE_PRIVACY 0x0800
/* IFA_CACHEINFO value */
struct ifa_cacheinfo {
uint32_t ifa_prefered;
uint32_t ifa_valid;
uint32_t cstamp;
uint32_t tstamp;
};
#endif