xref: /freebsd/sys/netlink/route/route_var.h (revision 9e79038c502433f077b4d3b5bb1c0838329f1ebc)

/*-
 * 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.
 */

/*
 * This file contains definitions shared among NETLINK_ROUTE family
 */
#ifndef _NETLINK_ROUTE_ROUTE_VAR_H_
#define _NETLINK_ROUTE_ROUTE_VAR_H_

#include <sys/priv.h> /* values for priv_check */

struct nlmsghdr;
struct nlpcb;
struct nl_pstate;

typedef int rtnl_msg_cb_f(struct nlmsghdr *hdr, struct nlpcb *nlp,
    struct nl_pstate *npt);

struct rtnl_cmd_handler {
	int		cmd;
	const char	*name;
	rtnl_msg_cb_f	*cb;
	int		priv;
	int		flags;
};

#define	RTNL_F_NOEPOCH			0x01	/* Do not enter epoch when handling command */
#define	RTNL_F_ALLOW_NONVNET_JAIL	0x02	/* Allow command execution inside non-VNET jail */

bool rtnl_register_messages(const struct rtnl_cmd_handler *handlers, int count);

/* route.c */
struct rib_cmd_info;
void rtnl_handle_route_event(uint32_t fibnum, const struct rib_cmd_info *rc);
void rtnl_routes_init(void);

/* neigh.c */
void rtnl_neighs_init(void);
void rtnl_neighs_destroy(void);

/* iface.c */
struct nl_parsed_link {
	char		*ifla_group;
	char		*ifla_ifname;
	char		*ifla_cloner;
	char		*ifla_ifalias;
	struct nlattr	*ifla_idata;
	unsigned short	ifi_type;
	int		ifi_index;
	uint32_t	ifla_link;
	uint32_t	ifla_mtu;
	uint32_t	ifi_flags;
	uint32_t	ifi_change;
};

#if defined(NETLINK) || defined(NETLINK_MODULE)
/* Provide optimized calls to the functions inside the same linking unit */

int _nl_modify_ifp_generic(struct ifnet *ifp, struct nl_parsed_link *lattrs,
    const struct nlattr_bmask *bm, struct nl_pstate *npt);
void _nl_store_ifp_cookie(struct nl_pstate *npt, struct ifnet *ifp);

static inline int
nl_modify_ifp_generic(struct ifnet *ifp, struct nl_parsed_link *lattrs,
    const struct nlattr_bmask *bm, struct nl_pstate *npt)
{
	return (_nl_modify_ifp_generic(ifp, lattrs, bm, npt));
}

static inline void
nl_store_ifp_cookie(struct nl_pstate *npt, struct ifnet *ifp)
{
	_nl_store_ifp_cookie(npt, ifp);
}
#else
/* Provide access to the functions via netlink_glue.c */
int nl_modify_ifp_generic(struct ifnet *ifp, struct nl_parsed_link *lattrs,
    const struct nlattr_bmask *bm, struct nl_pstate *npt);
void nl_store_ifp_cookie(struct nl_pstate *npt, struct ifnet *ifp);
#endif /* defined(NETLINK) || defined(NETLINK_MODULE) */


typedef int rtnl_iface_create_f(struct nl_parsed_link *lattrs,
    const struct nlattr_bmask *bm, struct nlpcb *nlp, struct nl_pstate *npt);
typedef int rtnl_iface_modify_f(struct ifnet *ifp, struct nl_parsed_link *lattrs,
    const struct nlattr_bmask *bm, struct nlpcb *nlp, struct nl_pstate *npt);
typedef int rtnl_iface_dump_f(struct ifnet *ifp, struct nl_writer *nw);

struct nl_cloner {
	const char		*name;
	rtnl_iface_create_f	*create_f;
	rtnl_iface_modify_f	*modify_f;
	rtnl_iface_dump_f	*dump_f;
	SLIST_ENTRY(nl_cloner)	next;
};

extern struct nl_cloner	generic_cloner;

void rtnl_ifaces_init(void);
void rtnl_ifaces_destroy(void);
void rtnl_iface_add_cloner(struct nl_cloner *cloner);
void rtnl_iface_del_cloner(struct nl_cloner *cloner);
void rtnl_handle_ifnet_event(struct ifnet *ifp, int if_change_mask);

/* iface_drivers.c */
void rtnl_iface_drivers_register(void);

/* nexthop.c */
void rtnl_nexthops_init(void);
struct nhop_object *nl_find_nhop(uint32_t fibnum, int family,
    uint32_t uidx, int nh_flags, int *perror);
int nl_set_nexthop_gw(struct nhop_object *nh, struct sockaddr *gw,
    struct ifnet *ifp, struct nl_pstate *npt);


#endif