/*
 * netifd - network interface daemon
 * Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */
#ifndef __NETIFD_DEVICE_H
#define __NETIFD_DEVICE_H

#include <libubox/avl.h>
#include <libubox/safe_list.h>
#include <libubox/kvlist.h>
#include <netinet/in.h>

struct device;
struct device_type;
struct device_user;
struct device_hotplug_ops;
struct bridge_vlan;
struct interface;

typedef int (*device_state_cb)(struct device *, bool up);

enum {
	/*
	 * Live-applicable: pure per-netdev sysctls. A diff limited to these
	 * can be pushed via system_if_apply_settings() without tearing the
	 * device down. Keep this group first so DEV_OPT_LIVE_APPLY_MASK
	 * stays a contiguous low-bit mask.
	 */
	DEV_ATTR_IPV6,
	DEV_ATTR_IP6SEGMENTROUTING,
	DEV_ATTR_RPFILTER,
	DEV_ATTR_ACCEPTLOCAL,
	DEV_ATTR_IGMPVERSION,
	DEV_ATTR_MLDVERSION,
	DEV_ATTR_NEIGHREACHABLETIME,
	DEV_ATTR_NEIGHGCSTALETIME,
	DEV_ATTR_NEIGHLOCKTIME,
	DEV_ATTR_DADTRANSMITS,
	DEV_ATTR_SENDREDIRECTS,
	DEV_ATTR_DROP_V4_UNICAST_IN_L2_MULTICAST,
	DEV_ATTR_DROP_V6_UNICAST_IN_L2_MULTICAST,
	DEV_ATTR_DROP_GRATUITOUS_ARP,
	DEV_ATTR_DROP_UNSOLICITED_NA,
	DEV_ATTR_ARP_ACCEPT,
	DEV_ATTR_MTU6,
	DEV_ATTR_TXQUEUELEN,
	DEV_ATTR_PROMISC,
	DEV_ATTR_MULTICAST,
	__DEV_ATTR_LIVE_APPLY_MAX,

	/* Have a DEV_OPT_* flag but require teardown to re-apply. */
	DEV_ATTR_MTU = __DEV_ATTR_LIVE_APPLY_MAX,
	DEV_ATTR_MACADDR,
	DEV_ATTR_MULTICAST_TO_UNICAST,
	DEV_ATTR_MULTICAST_ROUTER,
	DEV_ATTR_MULTICAST_FAST_LEAVE,
	DEV_ATTR_LEARNING,
	DEV_ATTR_UNICAST_FLOOD,
	DEV_ATTR_BROADCAST_FLOOD,
	DEV_ATTR_ISOLATE,
	DEV_ATTR_AUTH,
	DEV_ATTR_SPEED,
	DEV_ATTR_DUPLEX,
	DEV_ATTR_PAUSE,
	DEV_ATTR_ASYM_PAUSE,
	DEV_ATTR_RXPAUSE,
	DEV_ATTR_TXPAUSE,
	DEV_ATTR_AUTONEG,
	DEV_ATTR_GRO,
	DEV_ATTR_MASTER,
	DEV_ATTR_EEE,
	DEV_ATTR_PSE,
	DEV_ATTR_PSE_PODL,
	DEV_ATTR_PSE_POWER_LIMIT,
	DEV_ATTR_PSE_PRIORITY,

	/* No DEV_OPT_* counterpart; carry data consumed outside flags. */
	DEV_ATTR_TYPE,
	DEV_ATTR_ENABLED,
	DEV_ATTR_VLAN,
	DEV_ATTR_AUTH_VLAN,
	DEV_ATTR_TAGS,

	__DEV_ATTR_MAX,
};

enum dev_change_type {
	DEV_CONFIG_NO_CHANGE,
	DEV_CONFIG_APPLIED,
	DEV_CONFIG_RESTART,
	DEV_CONFIG_RECREATE,
};

struct device_type {
	struct list_head list;
	const char *name;

	bool bridge_capability;
	const char *name_prefix;

	const struct uci_blob_param_list *config_params;

	struct device *(*create)(const char *name, struct device_type *devtype,
		struct blob_attr *attr);
	void (*config_init)(struct device *);
	enum dev_change_type (*reload)(struct device *, struct blob_attr *,
				       struct blob_attr **tb_dev);
	void (*vlan_update)(struct device *);
	void (*dump_info)(struct device *, struct blob_buf *buf);
	void (*dump_stats)(struct device *, struct blob_buf *buf);
	int (*check_state)(struct device *);
	void (*stp_init)(struct device *);
	void (*free)(struct device *);
};

/*
 * DEV_OPT_X is the bit in device_settings.flags that marks attribute X
 * as configured. Aligned with DEV_ATTR_X so the diff bitmap produced
 * by uci_blob_diff(&device_attr_list, ...) is directly usable as a
 * DEV_OPT_* mask. DEV_OPT_DEFAULT_MACADDR has no DEV_ATTR_* peer (it
 * is synthesised by system_if_get_settings()) and is parked above the
 * attr range.
 */
enum {
	DEV_OPT_IPV6				= 1ULL << DEV_ATTR_IPV6,
	DEV_OPT_IP6SEGMENTROUTING		= 1ULL << DEV_ATTR_IP6SEGMENTROUTING,
	DEV_OPT_RPFILTER			= 1ULL << DEV_ATTR_RPFILTER,
	DEV_OPT_ACCEPTLOCAL			= 1ULL << DEV_ATTR_ACCEPTLOCAL,
	DEV_OPT_IGMPVERSION			= 1ULL << DEV_ATTR_IGMPVERSION,
	DEV_OPT_MLDVERSION			= 1ULL << DEV_ATTR_MLDVERSION,
	DEV_OPT_NEIGHREACHABLETIME		= 1ULL << DEV_ATTR_NEIGHREACHABLETIME,
	DEV_OPT_NEIGHGCSTALETIME		= 1ULL << DEV_ATTR_NEIGHGCSTALETIME,
	DEV_OPT_NEIGHLOCKTIME			= 1ULL << DEV_ATTR_NEIGHLOCKTIME,
	DEV_OPT_DADTRANSMITS			= 1ULL << DEV_ATTR_DADTRANSMITS,
	DEV_OPT_SENDREDIRECTS			= 1ULL << DEV_ATTR_SENDREDIRECTS,
	DEV_OPT_DROP_V4_UNICAST_IN_L2_MULTICAST	= 1ULL << DEV_ATTR_DROP_V4_UNICAST_IN_L2_MULTICAST,
	DEV_OPT_DROP_V6_UNICAST_IN_L2_MULTICAST	= 1ULL << DEV_ATTR_DROP_V6_UNICAST_IN_L2_MULTICAST,
	DEV_OPT_DROP_GRATUITOUS_ARP		= 1ULL << DEV_ATTR_DROP_GRATUITOUS_ARP,
	DEV_OPT_DROP_UNSOLICITED_NA		= 1ULL << DEV_ATTR_DROP_UNSOLICITED_NA,
	DEV_OPT_ARP_ACCEPT			= 1ULL << DEV_ATTR_ARP_ACCEPT,
	DEV_OPT_MTU6				= 1ULL << DEV_ATTR_MTU6,
	DEV_OPT_TXQUEUELEN			= 1ULL << DEV_ATTR_TXQUEUELEN,
	DEV_OPT_PROMISC				= 1ULL << DEV_ATTR_PROMISC,
	DEV_OPT_MULTICAST			= 1ULL << DEV_ATTR_MULTICAST,

	DEV_OPT_MTU				= 1ULL << DEV_ATTR_MTU,
	DEV_OPT_MACADDR				= 1ULL << DEV_ATTR_MACADDR,
	DEV_OPT_MULTICAST_TO_UNICAST		= 1ULL << DEV_ATTR_MULTICAST_TO_UNICAST,
	DEV_OPT_MULTICAST_ROUTER		= 1ULL << DEV_ATTR_MULTICAST_ROUTER,
	DEV_OPT_MULTICAST_FAST_LEAVE		= 1ULL << DEV_ATTR_MULTICAST_FAST_LEAVE,
	DEV_OPT_LEARNING			= 1ULL << DEV_ATTR_LEARNING,
	DEV_OPT_UNICAST_FLOOD			= 1ULL << DEV_ATTR_UNICAST_FLOOD,
	DEV_OPT_BROADCAST_FLOOD			= 1ULL << DEV_ATTR_BROADCAST_FLOOD,
	DEV_OPT_ISOLATE				= 1ULL << DEV_ATTR_ISOLATE,
	DEV_OPT_AUTH				= 1ULL << DEV_ATTR_AUTH,
	DEV_OPT_SPEED				= 1ULL << DEV_ATTR_SPEED,
	DEV_OPT_DUPLEX				= 1ULL << DEV_ATTR_DUPLEX,
	DEV_OPT_PAUSE				= 1ULL << DEV_ATTR_PAUSE,
	DEV_OPT_ASYM_PAUSE			= 1ULL << DEV_ATTR_ASYM_PAUSE,
	DEV_OPT_RXPAUSE				= 1ULL << DEV_ATTR_RXPAUSE,
	DEV_OPT_TXPAUSE				= 1ULL << DEV_ATTR_TXPAUSE,
	DEV_OPT_AUTONEG				= 1ULL << DEV_ATTR_AUTONEG,
	DEV_OPT_GRO				= 1ULL << DEV_ATTR_GRO,
	DEV_OPT_MASTER				= 1ULL << DEV_ATTR_MASTER,
	DEV_OPT_EEE				= 1ULL << DEV_ATTR_EEE,
	DEV_OPT_PSE				= 1ULL << DEV_ATTR_PSE,
	DEV_OPT_PSE_PODL			= 1ULL << DEV_ATTR_PSE_PODL,
	DEV_OPT_PSE_POWER_LIMIT			= 1ULL << DEV_ATTR_PSE_POWER_LIMIT,
	DEV_OPT_PSE_PRIORITY			= 1ULL << DEV_ATTR_PSE_PRIORITY,

	DEV_OPT_DEFAULT_MACADDR			= 1ULL << 63,
};

#define DEV_OPT_LIVE_APPLY_MASK \
	(((uint64_t)1 << __DEV_ATTR_LIVE_APPLY_MAX) - 1)

/* events broadcasted to all users of a device */
enum device_event {
	DEV_EVENT_ADD,
	DEV_EVENT_REMOVE,

	DEV_EVENT_UPDATE_IFNAME,
	DEV_EVENT_UPDATE_IFINDEX,

	DEV_EVENT_SETUP,
	DEV_EVENT_TEARDOWN,
	DEV_EVENT_UP,
	DEV_EVENT_DOWN,

	DEV_EVENT_AUTH_UP,
	DEV_EVENT_LINK_UP,
	DEV_EVENT_LINK_DOWN,

	/* Topology changed (i.e. bridge member added) */
	DEV_EVENT_TOPO_CHANGE,

	/* the vlan list of the device was updated */
	DEV_EVENT_VLAN_UPDATE,

	__DEV_EVENT_MAX
};

/*
 * device dependency with callbacks
 */
struct device_user {
	struct safe_list list;

	bool claimed;
	bool hotplug;
	bool alias;

	uint8_t ev_idx[__DEV_EVENT_MAX];

	struct device *dev;
	void (*cb)(struct device_user *, enum device_event);
};

struct device_settings {
	uint64_t flags;
	uint64_t valid_flags;
	unsigned int mtu;
	unsigned int mtu6;
	unsigned int txqueuelen;
	uint8_t macaddr[6];
	bool ipv6;
	bool promisc;
	unsigned int rpfilter;
	bool acceptlocal;
	unsigned int igmpversion;
	unsigned int mldversion;
	unsigned int neigh4reachabletime;
	unsigned int neigh6reachabletime;
	unsigned int neigh4gcstaletime;
	unsigned int neigh6gcstaletime;
	int neigh4locktime;
	unsigned int dadtransmits;
	bool multicast_to_unicast;
	unsigned int multicast_router;
	bool multicast_fast_leave;
	bool multicast;
	bool learning;
	bool unicast_flood;
	bool broadcast_flood;
	bool sendredirects;
	bool ip6segmentrouting;
	bool isolate;
	bool drop_v4_unicast_in_l2_multicast;
	bool drop_v6_unicast_in_l2_multicast;
	bool drop_gratuitous_arp;
	bool drop_unsolicited_na;
	bool arp_accept;
	bool auth;
	unsigned int speed;
	bool duplex;
	bool pause;
	bool asym_pause;
	bool rxpause;
	bool txpause;
	bool autoneg;
	bool gro;
	int master_ifindex;
	bool eee;
	bool pse;
	bool pse_podl;
	unsigned int pse_power_limit;
	unsigned int pse_priority;
};

struct device_vlan_range {
	uint16_t start, end;
};

/*
 * link layer device. typically represents a linux network device.
 * can be used to support VLANs as well
 */
struct device {
	struct device_type *type;

	struct avl_node avl;
	struct safe_list users;
	struct safe_list aliases;

	struct vlist_tree vlans;
	struct kvlist vlan_aliases;
	struct blob_attr *config_auth_vlans;
	struct blob_attr *auth_vlans;
	struct blob_attr *tags;

	char ifname[IFNAMSIZ];
	int ifindex;

	struct blob_attr *config;
	bool config_pending;
	bool sys_present;
	/* DEV_EVENT_ADD */
	bool present;
	/* DEV_EVENT_UP */
	int active;
	/* DEV_EVENT_LINK_UP */
	bool link_active;
	bool auth_status;

	bool external;
	bool disabled;
	bool deferred;
	bool hidden;

	bool current_config;
	bool iface_config;
	bool default_config;
	bool wireless;
	bool wireless_ap;
	bool wireless_proxyarp;
	bool wireless_isolate;
	bool bpdu_filter;

	struct interface *config_iface;
	struct device_vlan_range *extra_vlan;
	int n_extra_vlan;

	/* set interface up or down */
	device_state_cb set_state;

	const struct device_hotplug_ops *hotplug_ops;
	struct blob_attr *hotplug_link;

	struct device_user parent;

	struct device_settings orig_settings;
	struct device_settings settings;
};

struct device_hotplug_ops {
	int (*prepare)(struct device *dev, struct device **bridge_dev);
	int (*add)(struct device *main, struct device *member, struct blob_attr *vlan);
	int (*del)(struct device *main, struct device *member, struct blob_attr *vlan);
};

enum bridge_vlan_flags {
	BRVLAN_F_SELF =		(1 << 0),
	BRVLAN_F_PVID =		(1 << 1),
	BRVLAN_F_UNTAGGED =	(1 << 2),
};

struct bridge_vlan_port {
	const char *ifname;
	uint16_t flags;
	int8_t check;
};

struct bridge_vlan_hotplug_port {
	struct list_head list;
	struct bridge_vlan_port port;
};

struct bridge_vlan {
	struct vlist_node node;

	struct bridge_vlan_port *ports;
	int n_ports;

	struct list_head hotplug_ports;

	uint16_t vid;
	bool local;
	bool pending;
};

extern const struct uci_blob_param_list device_attr_list;
extern struct device_type simple_device_type;
extern struct device_type tunnel_device_type;

void device_vlan_update(bool done);
void device_stp_init(void);
void device_type_for_each(const struct device_type *type,
			  void (*cb)(struct device *dev));

int device_type_add(struct device_type *devtype);
struct device_type *device_type_get(const char *tname);
struct device *device_create(const char *name, struct device_type *type,
			     struct blob_attr *config);
void device_merge_settings(struct device *dev, struct device_settings *n);
void device_init_settings(struct device *dev, struct blob_attr **tb);
/*
 * Parse device-attr blob into tb_dev, seed dev->settings, and invoke the
 * type-specific reload hook for initial configuration during *_create().
 */
void device_init_config(struct device *dev, struct blob_attr *attr);
void device_init_pending(void);

/*
 * Inspect a DEV_ATTR_* diff bitmap produced by uci_blob_diff against
 * &device_attr_list. If every set bit falls into the live-applicable
 * group, return true and set *apply_mask to the corresponding DEV_OPT_*
 * bits. Return false with *apply_mask = 0 if any other bit is set.
 */
bool device_diff_live_apply(unsigned long *diff, uint64_t *apply_mask);

/*
 * Push dev->settings values for the attributes covered by apply_mask to
 * the kernel via system_if_apply_settings(), restoring originals for
 * attributes that have been dropped from UCI. Caller must guarantee
 * dev->active.
 */
void device_apply_live_settings(struct device *dev, uint64_t apply_mask);

enum dev_change_type
device_apply_config(struct device *dev, struct device_type *type,
		    struct blob_attr *config);

void device_reset_config(void);
void device_reset_old(void);

int device_init_virtual(struct device *dev, struct device_type *type, const char *name);
int device_init(struct device *dev, struct device_type *type, const char *ifname);
void device_cleanup(struct device *dev);
struct device *device_find(const char *name);

struct device *__device_get(const char *name, int create, bool check_vlan);
static inline struct device *device_get(const char *name, int create)
{
	return __device_get(name, create, true);
}

void device_add_user(struct device_user *dep, struct device *dev);
void device_remove_user(struct device_user *dep);
const char *device_event_name(enum device_event ev);
void __device_broadcast_event(struct device *dev, enum device_event ev);
#define device_broadcast_event(dev, ev) do {					\
	struct device *__ev_dev = (dev);					\
	D(DEVICE, "%s: event (%s)",						\
	  (__ev_dev && __ev_dev->ifname[0] ? __ev_dev->ifname : "(none)"),	\
	  device_event_name(ev));						\
	__device_broadcast_event(__ev_dev, ev);					\
} while (0)

void _device_set_present(struct device *dev, bool state);
#define device_set_present(dev, state) do {					\
	struct device *__ev_dev = (dev);					\
	bool __ev_state = state;						\
	D(DEVICE, "%s: set present=%d",						\
	  (__ev_dev && __ev_dev->ifname[0] ? __ev_dev->ifname : "(none)"),	\
	  __ev_state);								\
	_device_set_present(__ev_dev, __ev_state);				\
} while (0)

void device_set_link(struct device *dev, bool state);
void device_set_ifindex(struct device *dev, int ifindex);
int device_set_ifname(struct device *dev, const char *name);
void device_refresh_present(struct device *dev);
int device_claim(struct device_user *dep);
void device_release(struct device_user *dep);
int device_check_state(struct device *dev);
void device_dump_status(struct blob_buf *b, struct device *dev);

void device_free_unused(void);

struct device *get_vlan_device_chain(const char *ifname, int create);
void alias_notify_device(const char *name, struct device *dev);
struct device *device_alias_get(const char *name);

void device_set_auth_status(struct device *dev, bool value, struct blob_attr *vlans);

static inline void
device_set_deferred(struct device *dev, bool value)
{
	dev->deferred = value;
	device_refresh_present(dev);
}

static inline void
device_set_disabled(struct device *dev, bool value)
{
	dev->disabled = value;
	device_refresh_present(dev);
}

static inline bool
device_link_active(struct device *dev)
{
	if (dev->settings.auth && !dev->auth_status)
		return false;

	return dev->link_active;
}

bool device_check_ip6segmentrouting(void);
void device_hotplug_event(const char *name, bool add);

#endif