/* -*- C++ -*-; c-basic-offset: 4; indent-tabs-mode: nil */
/*
 * Include file for VppRenderer
 *
 * Copyright (c) 2018 Cisco Systems, Inc. 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
 */

#pragma once
#ifndef __VPP_RENDERER_H__
#define __VPP_RENDERER_H__

#include <boost/property_tree/ptree.hpp>

#include <opflex/ofcore/OFFramework.h>
#include <opflexagent/IdGenerator.h>
#include <opflexagent/Renderer.h>
#include <opflexagent/TunnelEpManager.h>

#include <vom/hw.hpp>

#include "VppInspect.hpp"
#include "VppManager.hpp"

using namespace opflexagent;

namespace VPP
{
/**
 * The vpp renderer demonstrates how to create a renderer plugin
 * for OpFlex agent.
 */
class VppRenderer : public opflexagent::Renderer
{
  public:
    /**
     * Instantiate a vpp renderer
     *
     * @param agent the agent object
     */
    VppRenderer(opflexagent::Agent &agent,
                IdGenerator &idGen,
                VppManager *vppManager);

    /**
     * Destroy the renderer and clean up all state
     */
    virtual ~VppRenderer();

    // ********
    // Renderer
    // ********

    virtual void setProperties(const boost::property_tree::ptree &properties);
    virtual void start();
    virtual void stop();

    /**
     * Is uplink address owned by renderer
     */
    virtual bool
    isUplinkAddressImplemented()
    {
        return true;
    }

    /**
     * Get uplink address from renderer
     */
    virtual boost::asio::ip::address getUplinkAddress();

    /**
     * Get uplink l2 address from renderer
     */
    virtual std::string getUplinkMac();

  private:
    /**
     * The socket used for inspecting the state built in VPP-manager
     */
    std::unique_ptr<VppInspect> inspector;

    /**
     * ID generator
     */
    IdGenerator &idGen;

    /**
     * Single instance of the VPP manager
     */
    VppManager *vppManager;

    /**
     * Opflex Tunnel EP Manager
     */
    TunnelEpManager tunnelEpManager;

    std::string uplinkIface;
    uint16_t uplinkVlan;

    enum EncapType
    {
        encapTypeNone,
        encapTypeVlan,
        encapTypeVxlan,
        encapTypeIvxlan
    };
    EncapType encapType;

    /**
     * has this party started.
     */
    bool started;
};

/**
 * Plugin implementation for dynamically loading vpp
 * renderer.
 */
class VppRendererPlugin : public opflexagent::RendererPlugin
{
  public:
    VppRendererPlugin();

    // **************
    // RendererPlugin
    // **************
    virtual std::unordered_set<std::string> getNames() const;
    virtual opflexagent::Renderer *create(opflexagent::Agent &agent) const;
};

} /* namespace vpprenderer */

/**
 * Return a non-owning pointer to the renderer plugin instance.
 */
extern "C" const opflexagent::RendererPlugin *init_renderer_plugin();

#endif /* __VPP__RENDERER_H__ */