/*
 * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.netvirt.aclservice.utils;

import com.google.common.collect.ImmutableList;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.List;
import org.opendaylight.genius.mdsalutil.NwConstants;
import org.opendaylight.genius.mdsalutil.packet.IPProtocols;
import org.opendaylight.yangtools.yang.common.Uint64;

/**
 * The class to have ACL related constants.
 */
public interface AclConstants {

    // TODO: Temporarily having below two constants until they are renamed in NwConstants itself.
    String INGRESS_ACL_SERVICE_NAME = NwConstants.ACL_SERVICE_NAME;
    short INGRESS_ACL_SERVICE_INDEX = NwConstants.ACL_SERVICE_INDEX;

    Integer PROTO_IPV6_DROP_PRIORITY = 63020;
    Integer PROTO_IPV6_ALLOWED_PRIORITY = 63010;
    Integer PROTO_DHCP_SERVER_MATCH_PRIORITY = 63010;
    Integer PROTO_DHCP_SERVER_DROP_PRIORITY = 62020;
    Integer PROTO_DHCP_CLIENT_TRAFFIC_MATCH_PRIORITY = 63010;
    Integer PROTO_ARP_TRAFFIC_MATCH_PRIORITY = 63010;
    Integer PROTO_ARP_TRAFFIC_DROP_PRIORITY = 63009;
    Integer PROTO_L2BROADCAST_TRAFFIC_MATCH_PRIORITY = 61005;
    Integer PROTO_MATCH_PRIORITY = 61010;
    Integer PROTO_IP_TRAFFIC_DROP_PRIORITY = 61009;
    Integer PROTO_PREFIX_MATCH_PRIORITY = 61008;

    Integer CT_STATE_UNTRACKED_PRIORITY = 340;
    Integer CT_STATE_TRACKED_EXIST_PRIORITY = 62030;
    Integer CT_STATE_TRACKED_INVALID_PRIORITY = 62020;
    Integer CT_STATE_TRACKED_NEW_PRIORITY = 310;
    Integer CT_STATE_TRACKED_NEW_DROP_PRIORITY = 50;
    Integer NO_PRIORITY = 50;

    Integer COMMITTER_TABLE_DROP_PRIORITY = 62019;

    Integer ACE_DEFAULT_PRIORITY = 1000;
    Integer ACE_LAST_REMOTE_ACL_PRIORITY = 230;
    Integer ACE_GOTO_NEXT_REMOTE_ACL_PRIORITY = 220;
    Integer ACE_FIRST_REMOTE_ACL_PRIORITY = 210;
    Integer ACL_DEFAULT_PRIORITY = 100;
    Integer ACL_PORT_SPECIFIC_DROP_PRIORITY = 50;
    Integer ACL_TABLE_MISS_PRIORITY = 0;

    short DHCP_CLIENT_PORT_IPV4 = 68;
    short DHCP_SERVER_PORT_IPV4 = 67;
    short DHCP_CLIENT_PORT_IPV6 = 546;
    short DHCP_SERVER_PORT_IPV6 = 547;

    Uint64 COOKIE_ACL_BASE = Uint64.valueOf("6900000", 16).intern();
    Uint64 COOKIE_ACL_DROP_FLOW = Uint64.valueOf("6900001", 16).intern();
    Uint64 METADATA_DROP_FLAG = Uint64.valueOf(BigInteger.ONE).intern();

    int TRACKED_EST_CT_STATE = 0x22;
    int TRACKED_REL_CT_STATE = 0x24;
    int TRACKED_NEW_CT_STATE = 0x21;
    int TRACKED_INV_CT_STATE = 0x30;
    int TRACKED_RPL_CT_STATE = 0x20;
    int TRACKED_CT_STATE = 0x20;
    int UNTRACKED_CT_STATE = 0x00;

    int TRACKED_EST_CT_STATE_MASK = 0x37;
    int TRACKED_REL_CT_STATE_MASK = 0x37;
    int TRACKED_NEW_CT_STATE_MASK = 0x21;
    int TRACKED_INV_CT_STATE_MASK = 0x30;
    int TRACKED_RPL_CT_STATE_MASK = 0x28;
    int TRACKED_CT_STATE_MASK = 0x20;

    int CT_MARK_NEW_STATE = 0x0;
    int CT_MARK_EST_STATE = 0x1;
    int CT_MARK_EST_STATE_MASK = 0x1;

    String IPV4_ALL_NETWORK = "0.0.0.0/0";
    String IPV6_ALL_NETWORK = "::/0";
    String IPV6_LINK_LOCAL_PREFIX = "fe80::/10";
    String BROADCAST_MAC = "ff:ff:ff:ff:ff:ff";
    String IPV4_ALL_SUBNET_BROADCAST_ADDR = "255.255.255.255";

    long TCP_FLAG_SYN = 1 << 1;
    long TCP_FLAG_ACK = 1 << 4;
    long TCP_FLAG_SYN_ACK = TCP_FLAG_SYN + TCP_FLAG_ACK;
    int ALL_LAYER4_PORT = 65535;
    int ALL_LAYER4_PORT_MASK = 0x0000;

    Short IP_PROT_ICMPV6 = 58;
    int ICMPV4_TYPE_ECHO_REQUEST = 8;
    int ICMPV4_TYPE_ECHO_REPLY = 0;
    int ICMPV6_TYPE_ECHO_REQUEST = 128;
    int ICMPV6_TYPE_ECHO_REPLY = 129;
    int ICMPV6_TYPE_MLD_QUERY = 130;
    int ICMPV6_TYPE_RS = 133;
    int ICMPV6_TYPE_RA = 134;
    int ICMPV6_TYPE_NS = 135;
    int ICMPV6_TYPE_NA = 136;
    int ICMPV6_TYPE_MLD2_REPORT = 143;

    int SECURITY_GROUP_ICMP_IDLE_TIME_OUT = 30;

    int SOURCE_LOWER_PORT_UNSPECIFIED = -1;
    int SOURCE_UPPER_PORT_UNSPECIFIED = -1;
    int DEST_LOWER_PORT_UNSPECIFIED = -1;
    int DEST_UPPER_PORT_UNSPECIFIED = -1;
    int DEST_LOWER_PORT_HTTP = 80;
    int DEST_LOWER_PORT_2 = 2;
    int DEST_UPPER_PORT_3 = 3;
    int DEST_UPPER_PORT_HTTP = 80;
    int SOURCE_REMOTE_IP_PREFIX_SPECIFIED = 1;
    int SOURCE_REMOTE_IP_PREFIX_UNSPECIFIED = -1;
    int DEST_REMOTE_IP_PREFIX_SPECIFIED = 1;
    int DEST_REMOTE_IP_PREFIX_UNSPECIFIED = -1;
    int INVALID_ACL_TAG = -1;

    String ACL_SYNC_KEY_EXT = "-acl";
    int JOB_MAX_RETRIES = 3;
    int ACEDELETE_MAX_RETRIES = 3;
    int FLOWS_PER_TRANSACTION = 30;
    int ACES_PER_TRANSACTION = 30;

    String ACL_JOB_KEY_PREFIX = "ACL-";

    List<IPProtocols> PROTOCOLS_SUPPORTED_BY_CONNTRACK =
            ImmutableList.of(IPProtocols.TCP, IPProtocols.UDP, IPProtocols.ICMP, IPProtocols.IPV6ICMP);

    static List<Integer> allowedIcmpv6NdList() {
        List<Integer> icmpv6NdList = new ArrayList<>();
        icmpv6NdList.add(ICMPV6_TYPE_RS);
        icmpv6NdList.add(ICMPV6_TYPE_NS);
        icmpv6NdList.add(ICMPV6_TYPE_NA);
        return icmpv6NdList;
    }
}