/*
 * Copyright (c) 2025, Red Hat, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef OVN_EN_MULTICAST_H
#define OVN_EN_MULTICAST_H

#include <stdint.h>

/* OVS includes. */
#include "openvswitch/hmap.h"

/* OVN includes. */
#include "lib/ovn-sb-idl.h"
#include "northd.h"

#define MC_FLOOD "_MC_flood"
#define MC_MROUTER_FLOOD "_MC_mrouter_flood"
#define MC_STATIC "_MC_static"
#define MC_UNKNOWN "_MC_unknown"
#define MC_FLOOD_L2 "_MC_flood_l2"

struct multicast_group {
    const char *name;
    uint16_t key;               /* OVN_MIN_MULTICAST...OVN_MAX_MULTICAST. */
};

/* Multicast group entry. */
struct ovn_multicast {
    struct hmap_node hmap_node; /* Index on 'datapath' and 'key'. */
    struct ovn_datapath *datapath;
    const struct multicast_group *group;

    struct vector ports; /* Vector of struct ovn_port *. */
};

/*
 * IGMP group entry (1:1 mapping to SB database).
 */
struct ovn_igmp_group_entry {
    struct ovs_list list_node; /* Linkage in the list of entries. */
    size_t n_ports;
    struct ovn_port **ports;
};

/*
 * IGMP group entry (aggregate of all entries from the SB database
 * corresponding to the multicast group).
 */
struct ovn_igmp_group {
    struct hmap_node hmap_node; /* Index on 'datapath' and 'address'. */

    struct ovn_datapath *datapath;
    struct in6_addr address; /* Multicast IPv6-mapped-IPv4 or IPv4 address. */
    struct multicast_group mcgroup;

    struct ovs_list entries; /* List of SB entries for this group. */
};

struct multicast_igmp_data {
    struct hmap mcast_groups;
    struct hmap igmp_groups;
    struct lflow_ref *lflow_ref;
};

struct ovn_mcast_sw_stats {
    uint64_t active_v4_flows;   /* Current number of active IPv4 multicast
                                 * flows. */
    uint64_t active_v6_flows;   /* Current number of active IPv6 multicast
                                 * flows. */
};

void *en_multicast_igmp_init(struct engine_node *,struct engine_arg *);
enum engine_node_state en_multicast_igmp_run(struct engine_node *, void *);
enum engine_input_handler_result
multicast_igmp_northd_handler(struct engine_node *, void *);
void en_multicast_igmp_cleanup(void *);
struct sbrec_multicast_group *create_sb_multicast_group(
    struct ovsdb_idl_txn *ovnsb_txn, const struct sbrec_datapath_binding *,
    const char *name, int64_t tunnel_key);

#endif /* OVN_EN_MULTICAST_H */
