srsLTE/srsenb/hdr/stack/mac/ue.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2021 Software Radio Systems Limited
 *
 * By using this file, you agree to the terms and conditions set
 * forth in the LICENSE file which can be found at the top level of
 * the distribution.
 *
 */

#ifndef SRSENB_UE_H
#define SRSENB_UE_H

#include "mac_metrics.h"
#include "srsran/adt/circular_array.h"
#include "srsran/adt/circular_map.h"
#include "srsran/adt/pool/pool_interface.h"
#include "srsran/common/block_queue.h"
#include "srsran/common/mac_pcap.h"
#include "srsran/common/mac_pcap_net.h"
#include "srsran/common/tti_point.h"
#include "srsran/interfaces/sched_interface.h"
#include "srsran/mac/pdu.h"
#include "srsran/mac/pdu_queue.h"
#include "srsran/srslog/srslog.h"

#include "ta.h"
#include <pthread.h>
#include <vector>

namespace srsenb {

class rrc_interface_mac;
class rlc_interface_mac;
class phy_interface_stack_lte;

struct ue_cc_softbuffers {
  // List of Tx softbuffers for all HARQ processes of one carrier
  using cc_softbuffer_tx_list_t = std::vector<srsran_softbuffer_tx_t>;
  // List of Rx softbuffers for all HARQ processes of one carrier
  using cc_softbuffer_rx_list_t = std::vector<srsran_softbuffer_rx_t>;

  const uint32_t          nof_tx_harq_proc;
  const uint32_t          nof_rx_harq_proc;
  cc_softbuffer_tx_list_t softbuffer_tx_list;
  cc_softbuffer_rx_list_t softbuffer_rx_list;

  ue_cc_softbuffers(uint32_t nof_prb, uint32_t nof_tx_harq_proc_, uint32_t nof_rx_harq_proc_);
  ue_cc_softbuffers(ue_cc_softbuffers&&) noexcept = default;
  ~ue_cc_softbuffers();
  void clear();

  srsran_softbuffer_tx_t& get_tx(uint32_t pid, uint32_t tb_idx)
  {
    return softbuffer_tx_list.at(pid * SRSRAN_MAX_TB + tb_idx);
  }
  srsran_softbuffer_rx_t& get_rx(uint32_t tti) { return softbuffer_rx_list.at(tti % nof_rx_harq_proc); }
};

class cc_used_buffers_map
{
public:
  explicit cc_used_buffers_map(srsran::pdu_queue& shared_pdu_queue_);
  ~cc_used_buffers_map();

  uint8_t* request_pdu(tti_point tti, uint32_t len);

  bool push_pdu(tti_point tti, uint32_t len);

  void clear_old_pdus(tti_point current_tti);

  bool try_deallocate_pdu(tti_point tti);

  void clear();

  uint8_t*& operator[](tti_point tti);

  bool has_tti(tti_point tti) const;

private:
  void remove_pdu(tti_point tti);

  srslog::basic_logger* logger;
  srsran::pdu_queue*    shared_pdu_queue;

  srsran::static_circular_map<uint32_t, uint8_t*, SRSRAN_FDD_NOF_HARQ * 8> pdu_map;
};

class cc_buffer_handler
{
public:
  explicit cc_buffer_handler(srsran::pdu_queue& shared_pdu_queue_);
  ~cc_buffer_handler();

  void reset();
  void allocate_cc(srsran::unique_pool_ptr<ue_cc_softbuffers> cc_softbuffers_);
  void deallocate_cc();

  bool                    empty() const { return cc_softbuffers == nullptr; }
  srsran_softbuffer_tx_t& get_tx_softbuffer(uint32_t pid, uint32_t tb_idx)
  {
    return cc_softbuffers->get_tx(pid, tb_idx);
  }
  srsran_softbuffer_rx_t& get_rx_softbuffer(uint32_t tti) { return cc_softbuffers->get_rx(tti); }
  srsran::byte_buffer_t*  get_tx_payload_buffer(size_t harq_pid, size_t tb)
  {
    return tx_payload_buffer[harq_pid][tb].get();
  }
  cc_used_buffers_map& get_rx_used_buffers() { return rx_used_buffers; }

private:
  // CC softbuffers
  srsran::unique_pool_ptr<ue_cc_softbuffers> cc_softbuffers;

  // buffers
  cc_used_buffers_map rx_used_buffers;

  // One buffer per TB per HARQ process and per carrier is needed for each UE.
  std::array<std::array<srsran::unique_byte_buffer_t, SRSRAN_MAX_TB>, SRSRAN_FDD_NOF_HARQ> tx_payload_buffer;
};

class ue : public srsran::read_pdu_interface, public srsran::pdu_queue::process_callback, public mac_ta_ue_interface
{
public:
  ue(uint16_t                                 rnti,
     uint32_t                                 nof_prb,
     sched_interface*                         sched,
     rrc_interface_mac*                       rrc_,
     rlc_interface_mac*                       rlc,
     phy_interface_stack_lte*                 phy_,
     srslog::basic_logger&                    logger,
     uint32_t                                 nof_cells_,
     srsran::obj_pool_itf<ue_cc_softbuffers>* softbuffer_pool);

  virtual ~ue();
  void     reset();
  void     start_pcap(srsran::mac_pcap* pcap_);
  void     start_pcap_net(srsran::mac_pcap_net* pcap_net_);
  void     set_tti(uint32_t tti);
  uint16_t get_rnti() { return rnti; }
  uint32_t set_ta(int ta) override;
  void     start_ta() { ta_fsm.start(); };
  uint32_t set_ta_us(float ta_us) { return ta_fsm.push_value(ta_us); };
  void     tic();

  uint8_t* generate_pdu(uint32_t                              ue_cc_idx,
                        uint32_t                              harq_pid,
                        uint32_t                              tb_idx,
                        const sched_interface::dl_sched_pdu_t pdu[sched_interface::MAX_RLC_PDU_LIST],
                        uint32_t                              nof_pdu_elems,
                        uint32_t                              grant_size);
  uint8_t*
  generate_mch_pdu(uint32_t harq_pid, sched_interface::dl_pdu_mch_t sched, uint32_t nof_pdu_elems, uint32_t grant_size);

  srsran_softbuffer_tx_t*
                          get_tx_softbuffer(const uint32_t ue_cc_idx, const uint32_t harq_process, const uint32_t tb_idx);
  srsran_softbuffer_rx_t* get_rx_softbuffer(const uint32_t ue_cc_idx, const uint32_t tti);

  bool     process_pdus();
  uint8_t* request_buffer(uint32_t tti, uint32_t ue_cc_idx, const uint32_t len);
  void     process_pdu(uint8_t* pdu, uint32_t nof_bytes, srsran::pdu_queue::channel_t channel) override;
  void     push_pdu(uint32_t tti, uint32_t ue_cc_idx, uint32_t len);
  void     deallocate_pdu(uint32_t tti, uint32_t ue_cc_idx);
  void     clear_old_buffers(uint32_t tti);

  void metrics_read(mac_ue_metrics_t* metrics_);
  void metrics_rx(bool crc, uint32_t tbs);
  void metrics_tx(bool crc, uint32_t tbs);
  void metrics_phr(float phr);
  void metrics_dl_ri(uint32_t dl_cqi);
  void metrics_dl_pmi(uint32_t dl_cqi);
  void metrics_dl_cqi(uint32_t dl_cqi);
  void metrics_cnt();

  int read_pdu(uint32_t lcid, uint8_t* payload, uint32_t requested_bytes) final;

private:
  void allocate_sdu(srsran::sch_pdu* pdu, uint32_t lcid, uint32_t sdu_len);
  bool process_ce(srsran::sch_subh* subh);
  void allocate_ce(srsran::sch_pdu* pdu, uint32_t lcid);

  rlc_interface_mac*       rlc = nullptr;
  rrc_interface_mac*       rrc = nullptr;
  phy_interface_stack_lte* phy = nullptr;
  srslog::basic_logger&    logger;
  sched_interface*         sched = nullptr;

  srsran::mac_pcap*     pcap         = nullptr;
  srsran::mac_pcap_net* pcap_net     = nullptr;
  uint64_t              conres_id    = 0;
  uint16_t              rnti         = 0;
  uint32_t              last_tti     = 0;
  uint32_t              nof_failures = 0;

  uint32_t         phr_counter    = 0;
  uint32_t         dl_cqi_counter = 0;
  uint32_t         dl_ri_counter  = 0;
  uint32_t         dl_pmi_counter = 0;
  mac_ue_metrics_t ue_metrics     = {};

  srsran::obj_pool_itf<ue_cc_softbuffers>* softbuffer_pool = nullptr;

  srsran::block_queue<uint32_t> pending_ta_commands;
  ta                            ta_fsm;

  // For UL there are multiple buffers per PID and are managed by pdu_queue
  srsran::pdu_queue pdus;
  srsran::sch_pdu   mac_msg_dl, mac_msg_ul;
  srsran::mch_pdu   mch_mac_msg_dl;

  srsran::bounded_vector<cc_buffer_handler, SRSRAN_MAX_CARRIERS> cc_buffers;

  // Mutexes
  std::mutex mutex;
  std::mutex rx_buffers_mutex;

  const uint8_t UL_CC_IDX = 0; ///< Passed to write CC index in PCAP (TODO: use actual CC idx)
};

} // namespace srsenb

#endif // SRSENB_UE_H