refactor RLC AM, add tx/rx subclasses

7 years ago · c0899ddda9
parent 6c896c4962
commit c0899ddda9
3 changed files with 950 additions and 632 deletions
--- a/lib/include/srslte/upper/rlc_am.h
+++ b/lib/include/srslte/upper/rlc_am.h
@ -100,109 +100,204 @@ public:

 private:

-  byte_buffer_pool          *pool;
-  srslte::log               *log;
-  uint32_t                   lcid;
-  srsue::pdcp_interface_rlc *pdcp;
-  srsue::rrc_interface_rlc  *rrc;
+  // Transmitter sub-class
+  class rlc_am_tx : public timer_callback
+  {
+  public:
+    rlc_am_tx(rlc_am *parent_, uint32_t queue_len);
+    ~rlc_am_tx();

-  // TX SDU buffers
-  rlc_tx_queue      tx_sdu_queue;
-  byte_buffer_t *tx_sdu;
-
-  // PDU being resegmented
-  rlc_amd_tx_pdu_t tx_pdu_segments;
-
-  // Tx and Rx windows
-  std::map<uint32_t, rlc_amd_tx_pdu_t>          tx_window;
-  std::deque<rlc_amd_retx_t>                    retx_queue;
-  std::map<uint32_t, rlc_amd_rx_pdu_t>          rx_window;
-  std::map<uint32_t, rlc_amd_rx_pdu_segments_t> rx_segments;
-
-  // RX SDU buffers
-  byte_buffer_t *rx_sdu;
-
-  // Mutexes
-  pthread_mutex_t     mutex;
-
-  bool                tx_enabled;
-  bool                poll_received;
-  bool                do_status;
-  rlc_status_pdu_t    status;
-
-  // Metrics
-  uint32_t            num_tx_bytes;
-  uint32_t            num_rx_bytes;
-
-  /****************************************************************************
-   * Configurable parameters
-   * Ref: 3GPP TS 36.322 v10.0.0 Section 7
-   ***************************************************************************/
-
-  srslte_rlc_am_config_t cfg;
-
-  /****************************************************************************
-   * State variables and counters
-   * Ref: 3GPP TS 36.322 v10.0.0 Section 7
-   ***************************************************************************/
-
-  // Tx state variables
-  uint32_t vt_a;    // ACK state. SN of next PDU in sequence to be ACKed. Low edge of tx window.
-  uint32_t vt_ms;   // Max send state. High edge of tx window. vt_a + window_size.
-  uint32_t vt_s;    // Send state. SN to be assigned for next PDU.
-  uint32_t poll_sn; // Poll send state. SN of most recent PDU txed with poll bit set.
-
-  // Tx counters
-  uint32_t pdu_without_poll;
-  uint32_t byte_without_poll;
-
-  // Rx state variables
-  uint32_t vr_r;  // Receive state. SN following last in-sequence received PDU. Low edge of rx window
-  uint32_t vr_mr; // Max acceptable receive state. High edge of rx window. vr_r + window size.
-  uint32_t vr_x;  // t_reordering state. SN following PDU which triggered t_reordering.
-  uint32_t vr_ms; // Max status tx state. Highest possible value of SN for ACK_SN in status PDU.
-  uint32_t vr_h;  // Highest rx state. SN following PDU with highest SN among rxed PDUs.
-
-  /****************************************************************************
-   * Timers
-   * Ref: 3GPP TS 36.322 v10.0.0 Section 7
-   ***************************************************************************/
-  timeout poll_retx_timeout;
-  timeout reordering_timeout;
-  timeout status_prohibit_timeout;
-
-  static const int reordering_timeout_id = 1;
+    void init();
+    bool configure(srslte_rlc_am_config_t cfg_);

-  static const int poll_periodicity = 8; // After how many data PDUs a status PDU shall be requested
+    void empty_queue();
+    void reestablish();
+    void stop();
+
+    void write_sdu(byte_buffer_t *sdu, bool blocking);
+    int read_pdu(uint8_t *payload, uint32_t nof_bytes);
+
+    uint32_t get_buffer_state();
+    uint32_t get_total_buffer_state();
+    uint32_t get_num_tx_bytes();
+    void reset_metrics();
+
+    // Timeout callback interface
+    void timer_expired(uint32_t timeout_id);
+
+    // Interface for Rx subclass
+    void handle_control_pdu(uint8_t *payload, uint32_t nof_bytes);
+
+  private:
+
+    int  build_status_pdu(uint8_t *payload, uint32_t nof_bytes);
+    int  build_retx_pdu(uint8_t *payload, uint32_t nof_bytes);
+    int  build_segment(uint8_t *payload, uint32_t nof_bytes, rlc_amd_retx_t retx);
+    int  build_data_pdu(uint8_t *payload, uint32_t nof_bytes);
+
+    void debug_state();
+
+    bool retx_queue_has_sn(uint32_t sn);
+    int  required_buffer_size(rlc_amd_retx_t retx);
+
+    // Timer checks
+    bool status_prohibited;
+
+    // Helpers
+    bool poll_required();
+    bool do_status();
+
+    rlc_am                    *parent;
+    byte_buffer_pool          *pool;
+    srslte::log               *log;
+
+    /****************************************************************************
+     * Configurable parameters
+     * Ref: 3GPP TS 36.322 v10.0.0 Section 7
+     ***************************************************************************/
+
+    srslte_rlc_am_config_t cfg;
+
+    // TX SDU buffers
+    rlc_tx_queue   tx_sdu_queue;
+    byte_buffer_t *tx_sdu;;
+
+    bool           tx_enabled;
+
+    /****************************************************************************
+     * State variables and counters
+     * Ref: 3GPP TS 36.322 v10.0.0 Section 7
+     ***************************************************************************/

-  // Timer checks
-  bool status_prohibited();
-  bool poll_retx();
-  void check_reordering_timeout();
+    // Tx state variables
+    uint32_t vt_a;    // ACK state. SN of next PDU in sequence to be ACKed. Low edge of tx window.
+    uint32_t vt_ms;   // Max send state. High edge of tx window. vt_a + window_size.
+    uint32_t vt_s;    // Send state. SN to be assigned for next PDU.
+    uint32_t poll_sn; // Poll send state. SN of most recent PDU txed with poll bit set.

-  // Helpers
-  bool poll_required();
+    // Tx counters
+    uint32_t pdu_without_poll;
+    uint32_t byte_without_poll;

-  int  prepare_status();
-  int  build_status_pdu(uint8_t *payload, uint32_t nof_bytes);
-  int  build_retx_pdu(uint8_t *payload, uint32_t nof_bytes);
-  int  build_segment(uint8_t *payload, uint32_t nof_bytes, rlc_amd_retx_t retx);
-  int  build_data_pdu(uint8_t *payload, uint32_t nof_bytes);
+    rlc_status_pdu_t tx_status;

-  void handle_data_pdu(uint8_t *payload, uint32_t nof_bytes, rlc_amd_pdu_header_t &header);
-  void handle_data_pdu_segment(uint8_t *payload, uint32_t nof_bytes, rlc_amd_pdu_header_t &header);
-  void handle_control_pdu(uint8_t *payload, uint32_t nof_bytes);
+    /****************************************************************************
+     * Timers
+     * Ref: 3GPP TS 36.322 v10.0.0 Section 7
+     ***************************************************************************/

-  void reassemble_rx_sdus();
+    srslte::timers::timer *poll_retx_timer;
+    uint32_t               poll_retx_timer_id;

-  bool inside_tx_window(uint16_t sn);
-  bool inside_rx_window(uint16_t sn);
-  void debug_state();
-  void print_rx_segments();
+    srslte::timers::timer *status_prohibit_timer;
+    uint32_t               status_prohibit_timer_id;

-  bool add_segment_and_check(rlc_amd_rx_pdu_segments_t *pdu, rlc_amd_rx_pdu_t *segment);
-  int  required_buffer_size(rlc_amd_retx_t retx);
-  bool retx_queue_has_sn(uint32_t sn);
+    // Tx windows
+    std::map<uint32_t, rlc_amd_tx_pdu_t>          tx_window;
+    std::deque<rlc_amd_retx_t>                    retx_queue;
+
+    // Mutexes
+    pthread_mutex_t     mutex;
+
+    // Metrics
+    uint32_t            num_tx_bytes;
+  };
+
+  // Receiver sub-class
+  class rlc_am_rx : public timer_callback
+  {
+  public:
+    rlc_am_rx(rlc_am* parent_);
+    ~rlc_am_rx();
+
+    void init();
+    bool configure(srslte_rlc_am_config_t cfg_);
+    void reestablish();
+    void stop();
+
+    void write_pdu(uint8_t *payload, uint32_t nof_bytes);
+
+    uint32_t get_num_rx_bytes();
+    void reset_metrics();
+
+    // Timeout callback interface
+    void timer_expired(uint32_t timeout_id);
+
+    // Functions needed by Tx subclass to query rx state
+    int get_status(rlc_status_pdu_t* status);
+    bool get_do_status();
+    void reset_status(); // called when status PDU has been sent
+
+  private:
+    void handle_data_pdu(uint8_t *payload, uint32_t nof_bytes, rlc_amd_pdu_header_t &header);
+    void handle_data_pdu_segment(uint8_t *payload, uint32_t nof_bytes, rlc_amd_pdu_header_t &header);
+    void reassemble_rx_sdus();
+    bool inside_rx_window(uint16_t sn);
+    void debug_state();
+    void print_rx_segments();
+    bool add_segment_and_check(rlc_amd_rx_pdu_segments_t *pdu, rlc_amd_rx_pdu_t *segment);
+
+    rlc_am                    *parent;
+    byte_buffer_pool          *pool;
+    srslte::log               *log;
+
+    /****************************************************************************
+     * Configurable parameters
+     * Ref: 3GPP TS 36.322 v10.0.0 Section 7
+     ***************************************************************************/
+    srslte_rlc_am_config_t cfg;
+
+    // RX SDU buffers
+    byte_buffer_t *rx_sdu;
+
+    /****************************************************************************
+     * State variables and counters
+     * Ref: 3GPP TS 36.322 v10.0.0 Section 7
+     ***************************************************************************/
+
+    // Rx state variables
+    uint32_t vr_r;  // Receive state. SN following last in-sequence received PDU. Low edge of rx window
+    uint32_t vr_mr; // Max acceptable receive state. High edge of rx window. vr_r + window size.
+    uint32_t vr_x;  // t_reordering state. SN following PDU which triggered t_reordering.
+    uint32_t vr_ms; // Max status tx state. Highest possible value of SN for ACK_SN in status PDU.
+    uint32_t vr_h;  // Highest rx state. SN following PDU with highest SN among rxed PDUs.
+
+    // Mutexes
+    pthread_mutex_t     mutex;
+
+    // Rx windows
+    std::map<uint32_t, rlc_amd_rx_pdu_t>          rx_window;
+    std::map<uint32_t, rlc_amd_rx_pdu_segments_t> rx_segments;
+
+    // Metrics
+    uint32_t            num_rx_bytes;
+
+    bool                poll_received;
+    bool                do_status;
+
+    /****************************************************************************
+     * Timers
+     * Ref: 3GPP TS 36.322 v10.0.0 Section 7
+     ***************************************************************************/
+
+    srslte::timers::timer *reordering_timer;
+    uint32_t               reordering_timer_id;
+  };
+
+  // Rx and Tx objects
+  rlc_am_tx           tx;
+  rlc_am_rx           rx;
+
+  // Common variables needed/provided by parent class
+  srsue::rrc_interface_rlc  *rrc;
+  srslte::log               *log;
+  srsue::pdcp_interface_rlc *pdcp;
+  mac_interface_timers      *mac_timers;
+  uint32_t                  lcid;
+  srslte_rlc_am_config_t    cfg;
+  std::string               rb_name;
+
+  static const int poll_periodicity = 8; // After how many data PDUs a status PDU shall be requested
 };

 /****************************************************************************
--- a/lib/src/upper/rlc_am.cc
+++ b/lib/src/upper/rlc_am.cc
--- a/lib/src/upper/rlc_um.cc
+++ b/lib/src/upper/rlc_um.cc
@ -149,7 +149,6 @@ void rlc_um::write_sdu(byte_buffer_t *sdu, bool blocking)
  } else {
    tx.try_write_sdu(sdu);
  }
-
 }

 /****************************************************************************
@ -199,7 +198,7 @@ void rlc_um::reset_metrics()

 std::string rlc_um::get_rb_name(srsue::rrc_interface_rlc *rrc, uint32_t lcid, bool is_mrb)
 {
-  if(is_mrb) {
+  if (is_mrb) {
    std::stringstream ss;
    ss << "MRB" << lcid;
    return ss.str();