// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2024 Robin Jarry

#pragma once

#include <gr_bitops.h>
#include <gr_clock.h>
#include <gr_infra.h>
#include <gr_macro.h>
#include <gr_net_types.h>

// Nexthop reachability states.
typedef enum : uint8_t {
	GR_NH_S_NEW = 0, // Initial state.
	GR_NH_S_PENDING, // Probe sent, awaiting reply.
	GR_NH_S_REACHABLE, // Probe reply received.
	GR_NH_S_STALE, // Reachable lifetime expired, needs refresh.
	GR_NH_S_FAILED, // All probes sent without reply.
} gr_nh_state_t;

// Nexthop configuration flags.
typedef enum : uint8_t {
	GR_NH_F_LOCAL = GR_BIT8(0), // Local address.
	GR_NH_F_GATEWAY = GR_BIT8(1), // Gateway route.
	GR_NH_F_LINK = GR_BIT8(2), // Connected link route.
	GR_NH_F_MCAST = GR_BIT8(3), // Multicast address.
	GR_NH_F_REMOTE = GR_BIT8(4), // Remote VTEP nexthop (EVPN).
	GR_NH_F_NEIGH = GR_BIT8(5), // Learned from ARP/NDP traffic.
} gr_nh_flags_t;

// Nexthop types for different forwarding behaviors.
typedef enum : uint8_t {
	GR_NH_T_L3 = 1, // Standard L3 forwarding.
	GR_NH_T_SR6_OUTPUT, // SRv6 output nexthop.
	GR_NH_T_SR6_LOCAL, // SRv6 local nexthop.
	GR_NH_T_DNAT, // DNAT transformation.
	GR_NH_T_BLACKHOLE, // Drop packets silently.
	GR_NH_T_REJECT, // Drop packets with ICMP error.
	GR_NH_T_GROUP, // ECMP for multipath routing.
#define GR_NH_T_ALL UINT8_C(0xff) // Match all types in list operations.
} gr_nh_type_t;

// Route install origin values shared by IPv4 and IPv6.
// See NH_ORIGIN_* in sys/route/nhop.h (BSD) and RTPROT_* in zebra/rt_netlink.h (FRR).
typedef enum : uint8_t {
	GR_NH_ORIGIN_UNSPEC = 0, // (NH_ORIGIN_UNSPEC).
	GR_NH_ORIGIN_REDIRECT = 1, // Installed implicitly by ICMP redirect (NH_ORIGIN_REDIRECT).
	GR_NH_ORIGIN_LINK = 2, // For local addresses, no ID allocation (NH_ORIGIN_KERNEL).
	GR_NH_ORIGIN_LEARN = 3, // Learned from ARP/NDP traffic (NH_ORIGIN_BOOT).
	GR_NH_ORIGIN_STATIC = 4, // Installed explicitly by user (NH_ORIGIN_STATIC).
	// Values 5 to 254 are allowed and are used by routing daemons.
	GR_NH_ORIGIN_GATED = 8, // (RTPROT_GATED)
	GR_NH_ORIGIN_RA = 9, // (RTPROT_RA)
	GR_NH_ORIGIN_MRT = 10, // (RTPROT_MRT)
	GR_NH_ORIGIN_ZEBRA = 11, // (RTPROT_ZEBRA)
	GR_NH_ORIGIN_BIRD = 12, // (RTPROT_BIRD)
	GR_NH_ORIGIN_DNROUTED = 13, // (RTPROT_DNROUTED)
	GR_NH_ORIGIN_XORP = 14, // (RTPROT_XORP)
	GR_NH_ORIGIN_NTK = 15, // (RTPROT_NTK)
	GR_NH_ORIGIN_DHCP = 16, // (RTPROT_DHCP)
	GR_NH_ORIGIN_MROUTED = 17, // (RTPROT_MROUTED)
	GR_NH_ORIGIN_KEEPALIVED = 18, // (RTPROT_KEEPALIVED)
	GR_NH_ORIGIN_BABEL = 42, // (RTPROT_BABEL)
	GR_NH_ORIGIN_OPENR = 99, // (RTPROT_OPENR)
	GR_NH_ORIGIN_BGP = 186, // (RTPROT_BGP)
	GR_NH_ORIGIN_ISIS = 187, // (RTPROT_ISIS)
	GR_NH_ORIGIN_OSPF = 188, // (RTPROT_OSPF)
	GR_NH_ORIGIN_RIP = 189, // (RTPROT_RIP)
	GR_NH_ORIGIN_RIPNG = 190, // (RTPROT_RIPNG from zebra)
	GR_NH_ORIGIN_NHRP = 191, // (RTPROT_NHRP from zebra)
	GR_NH_ORIGIN_EIGRP = 192, // (RTPROT_EIGRP)
	GR_NH_ORIGIN_LDP = 193, // (RTPROT_LDP from zebra)
	GR_NH_ORIGIN_SHARP = 194, // (RTPROT_SHARP from zebra)
	GR_NH_ORIGIN_PBR = 195, // (RTPROT_PBR from zebra)
	GR_NH_ORIGIN_ZSTATIC = 196, // (RTPROT_ZSTATIC from zebra)
	GR_NH_ORIGIN_OPENFABRIC = 197, // (RTPROT_OPENFABIC from zebra)
	GR_NH_ORIGIN_SRTE = 198, // (RTPROT_SRTE from zebra)
	GR_NH_ORIGIN_INTERNAL = 255, // Reserved for internal use (no events, no ID allocation).
} gr_nh_origin_t;

#define GR_NH_ID_UNSET UINT32_C(0)

// Generic base structure for all nexthops.
struct gr_nexthop_base {
	gr_nh_type_t type;
	gr_nh_origin_t origin;
	uint16_t iface_id; // Overrides vrf_id with interface's VRF if specified.
	uint16_t vrf_id;
	uint32_t nh_id; // User-assigned (0 = auto-allocate from pool).
};

// Info structure for GR_NH_T_L3 nexthops.
struct gr_nexthop_info_l3 {
	gr_nh_state_t state;
	gr_nh_flags_t flags;
	addr_family_t af;
	uint8_t prefixlen; // Only meaningful with GR_NH_F_LOCAL.
	union {
		struct {
		} addr;
		ip4_addr_t ipv4;
		struct rte_ipv6_addr ipv6;
	};
	struct rte_ether_addr mac; // Auto-sets GR_NH_S_REACHABLE.
};

// Info for GR_NH_T_GROUP nexthops
struct gr_nexthop_group_member {
	uint32_t nh_id;
	uint32_t weight;
};

struct gr_nexthop_info_group {
	uint32_t n_members;
	struct gr_nexthop_group_member members[];
};

// Nexthop structure exposed to the API.
struct gr_nexthop {
	BASE(gr_nexthop_base);
	uint8_t info[]; // Type specific nexthop info.
};

enum gr_nexthop_requests : uint32_t {
	GR_NH_CONFIG_GET = GR_MSG_TYPE(GR_INFRA_MODULE, 0x2001),
	GR_NH_CONFIG_SET,
	GR_NH_ADD,
	GR_NH_DEL,
	GR_NH_LIST,
	GR_NH_GET,
	GR_NH_FLUSH,
};

// Nexthop events (not generated for GR_NH_ORIGIN_INTERNAL nexthops).
enum gr_nexthop_events : uint32_t {
	GR_EVENT_NEXTHOP_NEW = GR_MSG_TYPE(GR_INFRA_MODULE, 0x3001),
	GR_EVENT_NEXTHOP_DELETE,
	GR_EVENT_NEXTHOP_UPDATE,
};

GR_EVENT(GR_EVENT_NEXTHOP_NEW, struct gr_nexthop);
GR_EVENT(GR_EVENT_NEXTHOP_DELETE, struct gr_nexthop);
GR_EVENT(GR_EVENT_NEXTHOP_UPDATE, struct gr_nexthop);

// Convert nexthop state enum to string representation.
static inline const char *gr_nh_state_name(const gr_nh_state_t state) {
	switch (state) {
	case GR_NH_S_NEW:
		return "new";
	case GR_NH_S_PENDING:
		return "pending";
	case GR_NH_S_REACHABLE:
		return "reachable";
	case GR_NH_S_STALE:
		return "stale";
	case GR_NH_S_FAILED:
		return "failed";
	}
	return "?";
}

// Convert nexthop flag enum to string representation.
// For flag masks, iterate individual flags using gr_flags_foreach.
static inline const char *gr_nh_flag_name(const gr_nh_flags_t flag) {
	switch (flag) {
	case GR_NH_F_LOCAL:
		return "local";
	case GR_NH_F_GATEWAY:
		return "gateway";
	case GR_NH_F_LINK:
		return "link";
	case GR_NH_F_MCAST:
		return "multicast";
	case GR_NH_F_REMOTE:
		return "remote";
	case GR_NH_F_NEIGH:
		return "neigh";
	}
	return "?";
}

// Convert nexthop type enum to string representation.
static inline const char *gr_nh_type_name(const gr_nh_type_t type) {
	switch (type) {
	case GR_NH_T_L3:
		return "L3";
	case GR_NH_T_SR6_OUTPUT:
		return "SRv6";
	case GR_NH_T_SR6_LOCAL:
		return "SRv6-local";
	case GR_NH_T_DNAT:
		return "DNAT";
	case GR_NH_T_BLACKHOLE:
		return "blackhole";
	case GR_NH_T_REJECT:
		return "reject";
	case GR_NH_T_GROUP:
		return "group";
	}
	return "?";
}

// Convert nexthop origin enum to string representation.
static inline const char *gr_nh_origin_name(gr_nh_origin_t origin) {
	switch (origin) {
	case GR_NH_ORIGIN_UNSPEC:
		return "UNSPEC";
	case GR_NH_ORIGIN_REDIRECT:
		return "redirect";
	case GR_NH_ORIGIN_LINK:
		return "link";
	case GR_NH_ORIGIN_LEARN:
		return "learn";
	case GR_NH_ORIGIN_STATIC:
		return "static";
	case GR_NH_ORIGIN_GATED:
		return "gated";
	case GR_NH_ORIGIN_RA:
		return "ra";
	case GR_NH_ORIGIN_MRT:
		return "mrt";
	case GR_NH_ORIGIN_ZEBRA:
		return "zebra";
	case GR_NH_ORIGIN_BIRD:
		return "bird";
	case GR_NH_ORIGIN_DNROUTED:
		return "dnrouted";
	case GR_NH_ORIGIN_XORP:
		return "xorp";
	case GR_NH_ORIGIN_NTK:
		return "ntk";
	case GR_NH_ORIGIN_DHCP:
		return "dhcp";
	case GR_NH_ORIGIN_MROUTED:
		return "mrouted";
	case GR_NH_ORIGIN_KEEPALIVED:
		return "keepalived";
	case GR_NH_ORIGIN_BABEL:
		return "babel";
	case GR_NH_ORIGIN_OPENR:
		return "openr";
	case GR_NH_ORIGIN_BGP:
		return "bgp";
	case GR_NH_ORIGIN_ISIS:
		return "isis";
	case GR_NH_ORIGIN_OSPF:
		return "ospf";
	case GR_NH_ORIGIN_RIP:
		return "rip";
	case GR_NH_ORIGIN_RIPNG:
		return "ripng";
	case GR_NH_ORIGIN_NHRP:
		return "nhrp";
	case GR_NH_ORIGIN_EIGRP:
		return "eigrp";
	case GR_NH_ORIGIN_LDP:
		return "ldp";
	case GR_NH_ORIGIN_SHARP:
		return "sharp";
	case GR_NH_ORIGIN_PBR:
		return "pbr";
	case GR_NH_ORIGIN_ZSTATIC:
		return "zebra_static";
	case GR_NH_ORIGIN_OPENFABRIC:
		return "openfabric";
	case GR_NH_ORIGIN_SRTE:
		return "srte";
	case GR_NH_ORIGIN_INTERNAL:
		return "INTERNAL";
	}
	return "?";
}

// nexthop config //////////////////////////////////////////////////////////////
struct gr_nexthop_config {
	// Maximum number of nexthops for all address families (default: 128K).
	uint32_t max_count;
	// Reachable next hop lifetime after last probe reply received (default: 20 min).
	uint32_t lifetime_reachable_sec;
	// Unreachable next hop lifetime after last unreplied probe was sent (default: 1 min).
	uint32_t lifetime_unreachable_sec;
	// Max number of packets to hold per next hop waiting for resolution (default: 256).
	uint16_t max_held_pkts;
	// Max number of unicast probes to send after NH_LIFETIME_REACHABLE.
	uint8_t max_ucast_probes;
	// Max number of multicast/broadcast probes to send after unicast probes failed.
	uint8_t max_bcast_probes;
};

// Get nexthop subsystem configuration and usage.
struct gr_nh_config_get_resp {
	BASE(gr_nexthop_config);
	uint32_t used_count;
};

GR_REQ(GR_NH_CONFIG_GET, struct gr_empty, struct gr_nh_config_get_resp);

// Set nexthop subsystem configuration.
// Only non-zero values are applied. Changing max_count requires no nexthops in use.
struct gr_nh_config_set_req {
	BASE(gr_nexthop_config);
};

GR_REQ(GR_NH_CONFIG_SET, struct gr_nh_config_set_req, struct gr_empty);

// next hops ///////////////////////////////////////////////////////////////////

// Add a new nexthop.
// If iface_id is specified, vrf_id is overridden with interface's VRF.
// MAC address automatically sets GR_NH_S_REACHABLE.
struct gr_nh_add_req {
	uint8_t exist_ok;
	struct gr_nexthop nh;
};

GR_REQ(GR_NH_ADD, struct gr_nh_add_req, struct gr_empty);

// Delete an existing nexthop.
// Automatically removes all routes referencing this nexthop.
// Protected nexthops (Local+Static, Link origin) cannot be deleted.
struct gr_nh_del_req {
	uint8_t missing_ok;
	struct gr_nexthop nh;
};

GR_REQ(GR_NH_DEL, struct gr_nh_del_req, struct gr_empty);

// List nexthops with optional filtering.
struct gr_nh_list_req {
	uint16_t vrf_id;
	gr_nh_type_t type;
	uint16_t max_count;
	bool include_internal;
};

GR_REQ_STREAM(GR_NH_LIST, struct gr_nh_list_req, struct gr_nexthop);

// Get a single nexthop by ID.
struct gr_nh_get_req {
	uint32_t nh_id;
};

GR_REQ(GR_NH_GET, struct gr_nh_get_req, struct gr_nexthop);

// Flush nexthops matching the given origin.
struct gr_nh_flush_req {
	gr_nh_origin_t origin;
};

GR_REQ(GR_NH_FLUSH, struct gr_nh_flush_req, struct gr_empty);
