path: root/src/stateless/rx/trex_stateless_capture.h

/*
 Itay Marom
 Cisco Systems, Inc.
*/

/*
Copyright (c) 2015-2016 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_STATELESS_CAPTURE_H__
#define __TREX_STATELESS_CAPTURE_H__

#include <stdint.h>
#include <assert.h>
#include <mutex>

#include "trex_stateless_pkt.h"
#include "trex_stateless_capture_rc.h"


/**************************************
 * Capture Filter 
 *  
 * specify which ports to capture and if TX/RX or both 
 *************************************/
class CaptureFilter {
public:
    CaptureFilter() {
        m_tx_active = 0;
        m_rx_active = 0;
    }
    
    /**
     * add a port to the active TX port list
     */
    void add_tx(uint8_t port_id) {
        m_tx_active |= (1LL << port_id);
    }

    /**
     * add a port to the active RX port list
     */
    void add_rx(uint8_t port_id) {
        m_rx_active |= (1LL << port_id);
    }
    
    void add(uint8_t port_id) {
        add_tx(port_id);
        add_rx(port_id);
    }
    
    bool in_x(uint8_t port_id, TrexPkt::origin_e origin) {
        return ( 
                 ( (origin == TrexPkt::ORIGIN_RX) && (in_rx(port_id)) )
                 ||
                 ( (origin == TrexPkt::ORIGIN_TX) && (in_tx(port_id)) )
               );
    }
    
    bool in_rx(uint8_t port_id) const {
        uint64_t bit = (1LL << port_id);
        return ((m_rx_active & bit) == bit);
    }
    
    bool in_tx(uint8_t port_id) const {
        uint64_t bit = (1LL << port_id);
        return ((m_tx_active & bit) == bit);
    }
    
    bool in_any(uint8_t port_id) const {
        return ( in_tx(port_id) || in_rx(port_id) );
    }
    
    /**
     * updates the current filter with another filter 
     * the result is the aggregation of TX /RX active lists 
     */
    CaptureFilter& operator +=(const CaptureFilter &other) {
        m_tx_active |= other.m_tx_active;
        m_rx_active |= other.m_rx_active;
        
        return *this;
    }
    
    Json::Value to_json() const {
        Json::Value output = Json::objectValue;
        output["tx"] = Json::UInt64(m_tx_active);
        output["rx"] = Json::UInt64(m_rx_active);

        return output;
    }

    uint64_t get_tx_active_map() const {
        return m_tx_active;
    }
    
    uint64_t get_rx_active_map() const {
        return m_rx_active;
    }
    
private:
    
    uint64_t  m_tx_active;
    uint64_t  m_rx_active;
};


/**************************************
 * Capture
 *  
 * A single instance of a capture
 *************************************/
class TrexStatelessCapture {
public:
    
    enum state_e {
        STATE_ACTIVE,
        STATE_STOPPED,
    };
    
    TrexStatelessCapture(capture_id_t id,
                         uint64_t limit,
                         const CaptureFilter &filter,
                         TrexPktBuffer::mode_e mode);
    
    ~TrexStatelessCapture();
    
    /**
     * handles a packet
     */
    void handle_pkt(const rte_mbuf_t *m, int port, TrexPkt::origin_e origin);
    
    
    uint64_t get_id() const {
        return m_id;
    }
    
    const CaptureFilter & get_filter() const {
        return m_filter;
    }
    

    /**
     * stop the capture - from now on all packets will be ignored
     * 
     * @author imarom (1/24/2017)
     */
    void stop() {
        m_state = STATE_STOPPED;
    }
    
    TrexPktBuffer * fetch(uint32_t pkt_limit, uint32_t &pending);
    
    bool is_active() const {
        return m_state == STATE_ACTIVE;
    }
    
    uint32_t get_pkt_count() const {
        return m_pkt_buffer->get_element_count();
    }
    
    dsec_t get_start_ts() const {
        return m_start_ts;
    }
    
    
    Json::Value to_json() const;
    
private:
    state_e          m_state;
    TrexPktBuffer   *m_pkt_buffer;
    dsec_t           m_start_ts;
    CaptureFilter    m_filter;
    uint64_t         m_id;
    uint64_t         m_pkt_index;
};


/**************************************
 * Capture Manager
 * Handles all the captures in 
 * the system 
 *  
 * the design is a singleton 
 *************************************/
class TrexStatelessCaptureMngr {
    
public:
    
    static TrexStatelessCaptureMngr g_instance;
    static TrexStatelessCaptureMngr& getInstance() {
        return g_instance;
    }

    
    ~TrexStatelessCaptureMngr() {
        reset();
    }
    
    /**
     * starts a new capture
     */
    void start(const CaptureFilter &filter,
               uint64_t limit,
               TrexPktBuffer::mode_e mode,
               TrexCaptureRCStart &rc);
   
    /**
     * stops an existing capture
     * 
     */
    void stop(capture_id_t capture_id, TrexCaptureRCStop &rc);
    
    /**
     * fetch packets from an existing capture
     * 
     */
    void fetch(capture_id_t capture_id, uint32_t pkt_limit, TrexCaptureRCFetch &rc);

    /** 
     * removes an existing capture 
     * all packets captured will be detroyed 
     */
    void remove(capture_id_t capture_id, TrexCaptureRCRemove &rc);
    
    
    /**
     * removes all captures
     * 
     */
    void reset();
    
    
    /**
     * return true if any filter is active 
     * on a specific port 
     * 
     * @author imarom (1/3/2017)
     * 
     * @return bool 
     */
    bool is_active(uint8_t port) const {
        return m_global_filter.in_any(port);
    }
    
    /**
     * handle packet on TX side 
     * always with a lock 
     */
    inline void handle_pkt_tx(const rte_mbuf_t *m, int port) {

        /* fast path */
        if (likely(!m_global_filter.in_tx(port))) {
            return;
        }
        
        /* TX core always locks */
        std::unique_lock<std::mutex> ulock(m_lock);
        
        /* check again the global filter (because of RX fast path might not lock) */
        if (m_global_filter.in_tx(port)) {
            handle_pkt_slow_path(m, port, TrexPkt::ORIGIN_TX);
        }
        
        ulock.unlock();
        
    }
    
    /** 
     * handle packet on RX side 
     * RX side might or might not use a lock - depends if there are 
     * other TX cores being captured 
     */
    inline void handle_pkt_rx(const rte_mbuf_t *m, int port) {
        
        /* fast path */
        if (likely(!m_global_filter.in_rx(port))) {
            return;
        }
        
        /* create a RAII object lock but do not lock yet */
        std::unique_lock<std::mutex> ulock(m_lock, std::defer_lock);
        
        /* if we are not alone - lock */
        if (m_global_filter.get_tx_active_map() != 0) {
            ulock.lock();
        }
        
        /* fast bail out IF */
        if (m_global_filter.in_rx(port)) {
            handle_pkt_slow_path(m, port, TrexPkt::ORIGIN_RX);
        }
        
    }
    
    Json::Value to_json();
        
private:
    
    TrexStatelessCaptureMngr() {
        /* init this to 1 */
        m_id_counter = 1;
    }
    
    
    TrexStatelessCapture * lookup(capture_id_t capture_id) const;
    int lookup_index(capture_id_t capture_id) const;
    
    void handle_pkt_slow_path(const rte_mbuf_t *m, int port, TrexPkt::origin_e origin);
   
    void update_global_filter();
    
    std::vector<TrexStatelessCapture *> m_captures;
    
    capture_id_t m_id_counter;
    
    /* a union of all the filters curently active */
    CaptureFilter m_global_filter;
    
    /* slow path lock*/
    std::mutex    m_lock;
    
    static const int MAX_CAPTURE_SIZE = 10;
    
};

#endif /* __TREX_STATELESS_CAPTURE_H__ */