/*
 Itay Marom
 Cisco Systems, Inc.
*/

/*
Copyright (c) 2015-2015 Cisco Systems, 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 __TREX_STREAM_API_H__
#define __TREX_STREAM_API_H__

#include <unordered_map>
#include <vector>
#include <stdint.h>
#include <string>

#include <json/json.h>

#include <trex_stream_vm.h>

class TrexRpcCmdAddStream;

/**
 * Stateless Stream
 * 
 */
class TrexStream {
    /* provide the RPC parser a way to access private fields */
    friend class TrexRpcCmdAddStream;
    friend class TrexRpcCmdGetStream;
    friend class TrexStreamTable;

public:
    TrexStream(uint8_t port_id, uint32_t stream_id);
    virtual ~TrexStream() = 0;

    /* defines the min max per packet supported */
    static const uint32_t MIN_PKT_SIZE_BYTES = 1;
    static const uint32_t MAX_PKT_SIZE_BYTES = 9000;

    /* provides storage for the stream json*/
    void store_stream_json(const Json::Value &stream_json);

    /* access the stream json */
    const Json::Value & get_stream_json();

protected:
    /* basic */
    uint8_t       m_port_id;
    uint32_t      m_stream_id;
    

    /* config fields */
    double        m_isg_usec;
    int           m_next_stream_id;

    /* indicators */
    bool          m_enabled;
    bool          m_self_start;
    
    /* pkt */
    struct {
        uint8_t      *binary;
        uint16_t      len;
        std::string   meta;
    } m_pkt;

    /* VM */
    StreamVm m_vm;

    /* RX check */
    struct {
        bool      m_enable;
        bool      m_seq_enabled;
        bool      m_latency;
        uint32_t  m_stream_id;

    } m_rx_check;


    /* original template provided by requester */
    Json::Value m_stream_json;
};

/**
 * continuous stream
 * 
 */
class TrexStreamContinuous : public TrexStream {
public:
    TrexStreamContinuous(uint8_t port_id, uint32_t stream_id, double pps) : TrexStream(port_id, stream_id), m_pps(pps) {
    }

    double get_pps() {
        return m_pps;
    }

protected:
    double m_pps;
};

/**
 * single burst
 * 
 */
class TrexStreamBurst : public TrexStream {
public:
    TrexStreamBurst(uint8_t port_id, uint32_t stream_id, uint32_t total_pkts, double pps) : 
        TrexStream(port_id, stream_id),
        m_total_pkts(total_pkts),
        m_pps(pps) {
    }

protected:
    uint32_t   m_total_pkts;
    double     m_pps;
};

/**
 * multi burst
 * 
 */
class TrexStreamMultiBurst : public TrexStreamBurst {
public:
    TrexStreamMultiBurst(uint8_t  port_id,
                         uint32_t stream_id,
                         uint32_t pkts_per_burst,
                         double   pps,
                         uint32_t num_bursts,
                         double   ibg_usec) : TrexStreamBurst(port_id, stream_id, pkts_per_burst, pps), m_num_bursts(num_bursts), m_ibg_usec(ibg_usec) {

    }
protected:
    uint32_t m_num_bursts;
    double   m_ibg_usec;
    
};

/**
 * holds all the streams 
 *  
 */
class TrexStreamTable {
public:

    TrexStreamTable();
    ~TrexStreamTable();

    /**
     * add a stream 
     * if a previous one exists, the old one  will be deleted 
     */
    void add_stream(TrexStream *stream);

    /**
     * remove a stream
     */
    void remove_stream(TrexStream *stream);

    /**
     * remove all streams on the table
     * memory will be deleted
     */
    void remove_and_delete_all_streams();

    /**
     * fetch a stream if exists 
     * o.w NULL 
     *  
     */
    TrexStream * get_stream_by_id(uint32_t stream_id);

    /**
     * populate a list with all the stream IDs
     * 
     * @author imarom (06-Sep-15)
     * 
     * @param stream_list 
     */
    void get_stream_list(std::vector<uint32_t> &stream_list);

    /**
     * get the table size
     * 
     */
    int size();

private:
    /**
     * holds all the stream in a hash table by stream id
     * 
     */
    std::unordered_map<int, TrexStream *> m_stream_table;
};

#endif /* __TREX_STREAM_API_H__ */