apps/openstacktelemetry/app/src/main/java/org/onosproject/openstacktelemetry/util/OpenstackTelemetryUtil.java

/*
 * Copyright 2018-present Open Networking Foundation
 *
 * 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.
 */
package org.onosproject.openstacktelemetry.util;

import com.google.common.base.Strings;
import com.google.common.collect.Sets;
import org.onlab.packet.IPv4;
import org.onosproject.cfg.ConfigProperty;
import org.onosproject.openstacktelemetry.api.DefaultLinkInfo;
import org.onosproject.openstacktelemetry.api.DefaultLinkStatsInfo;
import org.onosproject.openstacktelemetry.api.FlowInfo;
import org.onosproject.openstacktelemetry.api.LinkInfo;
import org.onosproject.openstacktelemetry.api.LinkStatsInfo;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.Socket;
import java.net.SocketAddress;
import java.util.Dictionary;
import java.util.Optional;
import java.util.Set;

import static org.onlab.packet.IPv4.PROTOCOL_ICMP;
import static org.onlab.packet.IPv4.PROTOCOL_TCP;
import static org.onlab.packet.IPv4.PROTOCOL_UDP;
import static org.onlab.util.Tools.get;

/**
 * An utility that used in openstack telemetry app.
 */
public final class OpenstackTelemetryUtil {

    private static final String PROTOCOL_NAME_TCP = "tcp";
    private static final String PROTOCOL_NAME_UDP = "udp";
    private static final String PROTOCOL_NAME_ICMP = "icmp";
    private static final String PROTOCOL_NAME_ANY = "any";
    private static final int ARBITRARY_PROTOCOL = 0x0;
    private static final int TIMEOUT = 2000;

    private static final String ALL_IP_ADDRESSES = "0.0.0.0";
    private static final String LINK_ID_DELIMITER = "_";

    /**
     * Prevents object instantiation from external.
     */
    private OpenstackTelemetryUtil() {
    }

    /**
     * Gets Boolean property from the propertyName
     * Return null if propertyName is not found.
     *
     * @param properties   properties to be looked up
     * @param propertyName the name of the property to look up
     * @return value when the propertyName is defined or return null
     */
    public static Boolean getBooleanProperty(Dictionary<?, ?> properties,
                                              String propertyName) {
        Boolean value;
        try {
            String s = get(properties, propertyName);
            value = Strings.isNullOrEmpty(s) ? null : Boolean.valueOf(s);
        } catch (ClassCastException e) {
            value = null;
        }
        return value;
    }

    /**
     * Obtains the property value with specified property key name.
     *
     * @param properties    a collection of properties
     * @param name          key name
     * @return mapping value
     */
    public static boolean getPropertyValueAsBoolean(Set<ConfigProperty> properties, String name) {
        Optional<ConfigProperty> property =
                properties.stream().filter(p -> p.name().equals(name)).findFirst();

        return property.map(ConfigProperty::asBoolean).orElse(false);
    }

    /**
     * Obtains transport protocol type from the given string.
     *
     * @param str transport protocol name
     * @return transport protocol type
     */
    public static byte getProtocolTypeFromString(String str) {
        switch (str.toLowerCase()) {
            case PROTOCOL_NAME_TCP:
                return IPv4.PROTOCOL_TCP;
            case PROTOCOL_NAME_UDP:
                return IPv4.PROTOCOL_UDP;
            case PROTOCOL_NAME_ANY:
            default:
                return ARBITRARY_PROTOCOL;
        }
    }

    /**
     * Obtains protocol name from the protocol type.
     *
     * @param type transport protocol type
     * @return transport protocol name
     */
    public static String getProtocolNameFromType(byte type) {
        switch (type) {
            case IPv4.PROTOCOL_TCP:
                return PROTOCOL_NAME_TCP;
            case IPv4.PROTOCOL_UDP:
                return PROTOCOL_NAME_UDP;
            case ARBITRARY_PROTOCOL:
            default:
                return PROTOCOL_NAME_ANY;
        }
    }

    /**
     * Tests the connectivity with the given address and port.
     *
     * @param address address
     * @param port port number
     * @return true if the given address and port is accessible, false otherwise
     */
    public static boolean testConnectivity(String address, int port) {

        boolean isConnected = false;
        SocketAddress socketAddress = new InetSocketAddress(address, port);
        Socket socket = new Socket();
        try {
            socket.connect(socketAddress, TIMEOUT);
            socket.close();
            isConnected = true;
        } catch (IOException ignored) {
        }

        return isConnected;
    }

    /**
     * Converts flow info to link info.
     *
     * @param flowInfos a set of flow infos
     * @return converted link infos
     */
    public static Set<LinkInfo> flowsToLinks(Set<FlowInfo> flowInfos) {

        Set<LinkInfo> linkInfos = Sets.newConcurrentHashSet();

        for (FlowInfo flowInfo : flowInfos) {
            if (!ALL_IP_ADDRESSES.equals(flowInfo.srcIp().address().toString()) &&
                 ALL_IP_ADDRESSES.equals(flowInfo.dstIp().address().toString())) {
                FlowInfo dstFlowInfo = flowInfos.stream()
                        .filter(f -> f.dstIp().address().toString()
                                .equals(flowInfo.srcIp().address().toString()))
                        .findFirst().orElse(null);

                if (dstFlowInfo == null) {
                    continue;
                }

                String linkId = flowInfo.deviceId().toString() +
                        LINK_ID_DELIMITER + flowInfo.inputInterfaceId();
                String srcIp = flowInfo.srcIp().address().toString();
                String dstIp = flowInfo.dstIp().address().toString();
                int srcPort = flowInfo.srcPort() == null ? 0 : flowInfo.srcPort().toInt();
                int dstPort = flowInfo.dstPort() == null ? 0 : flowInfo.dstPort().toInt();
                String protocol = protocolByteToString(flowInfo.protocol());

                long txPacket = flowInfo.statsInfo().currAccPkts();
                long txByte = flowInfo.statsInfo().currAccBytes();
                long txDrop = flowInfo.statsInfo().dropPkts();

                long rxPacket = dstFlowInfo.statsInfo().currAccPkts();
                long rxByte = dstFlowInfo.statsInfo().currAccBytes();
                long rxDrop = dstFlowInfo.statsInfo().dropPkts();

                LinkStatsInfo statsInfo = DefaultLinkStatsInfo.builder()
                        .withTxPacket(txPacket)
                        .withRxPacket(rxPacket)
                        .withTxByte(txByte)
                        .withRxByte(rxByte)
                        .withTxDrop(txDrop)
                        .withRxDrop(rxDrop)
                        .withTimestamp(System.currentTimeMillis())
                        .build();

                LinkInfo linkInfo = DefaultLinkInfo.builder()
                        .withLinkId(linkId)
                        .withSrcIp(srcIp)
                        .withDstIp(dstIp)
                        .withSrcPort(srcPort)
                        .withDstPort(dstPort)
                        .withProtocol(protocol)
                        .withLinkStats(statsInfo)
                        .build();

                linkInfos.add(linkInfo);
            }
        }

        return linkInfos;
    }

    /**
     * Converts byte formatted protocol to string type.
     *
     * @param protocol byte formatted protocol
     * @return string formatted protocol
     */
    public static String protocolByteToString(byte protocol) {
        switch (protocol) {
            case PROTOCOL_TCP:
                return PROTOCOL_NAME_TCP;
            case PROTOCOL_UDP:
                return PROTOCOL_NAME_UDP;
            case PROTOCOL_ICMP:
                return PROTOCOL_NAME_ICMP;
            default:
                return "";
        }
    }
}