srsRAN_4G/lib/test/pdcp/pdcp_lte_test_discard_sdu.cc

/**
 * Copyright 2013-2022 Software Radio Systems Limited
 *
 * This file is part of srsRAN.
 *
 * srsRAN is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsRAN is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */
#include "pdcp_lte_test.h"
#include <numeric>

/*
 * Test of imediate notification from RLC
 */
int test_tx_sdu_notify(const srsran::pdcp_lte_state_t& init_state,
                       srsran::pdcp_discard_timer_t    discard_timeout,
                       srslog::basic_logger&           logger)
{
  srsran::pdcp_config_t cfg = {1,
                               srsran::PDCP_RB_IS_DRB,
                               srsran::SECURITY_DIRECTION_UPLINK,
                               srsran::SECURITY_DIRECTION_DOWNLINK,
                               srsran::PDCP_SN_LEN_12,
                               srsran::pdcp_t_reordering_t::ms500,
                               discard_timeout,
                               false,
                               srsran::srsran_rat_t::lte};

  pdcp_lte_test_helper     pdcp_hlp(cfg, sec_cfg, logger);
  srsran::pdcp_entity_lte* pdcp  = &pdcp_hlp.pdcp;
  rlc_dummy*               rlc   = &pdcp_hlp.rlc;
  srsue::stack_test_dummy* stack = &pdcp_hlp.stack;

  pdcp_hlp.set_pdcp_initial_state(init_state);

  // Write test SDU
  srsran::unique_byte_buffer_t sdu = srsran::make_byte_buffer();
  TESTASSERT(sdu != nullptr);
  sdu->append_bytes(sdu1, sizeof(sdu1));
  pdcp->write_sdu(std::move(sdu));

  srsran::unique_byte_buffer_t out_pdu = srsran::make_byte_buffer();
  TESTASSERT(out_pdu != nullptr);
  rlc->get_last_sdu(out_pdu);
  TESTASSERT(out_pdu->N_bytes == 4);

  TESTASSERT(pdcp->nof_discard_timers() == 1); // One timer should be running
  srsran::pdcp_sn_vector_t sns_notified;
  sns_notified.push_back(0);
  pdcp->notify_delivery(sns_notified);
  TESTASSERT(pdcp->nof_discard_timers() == 0); // Timer should have been difused after

  // RLC should not be notified of SDU discard
  TESTASSERT(rlc->discard_count == 0);

  // Make sure there are no timers still left on the map
  TESTASSERT(pdcp->nof_discard_timers() == 0);

  return 0;
}

/*
 * Test discard timer expiry
 */
int test_tx_sdu_discard(const srsran::pdcp_lte_state_t& init_state,
                        srsran::pdcp_discard_timer_t    discard_timeout,
                        srslog::basic_logger&           logger)
{
  srsran::pdcp_config_t cfg = {1,
                               srsran::PDCP_RB_IS_DRB,
                               srsran::SECURITY_DIRECTION_UPLINK,
                               srsran::SECURITY_DIRECTION_DOWNLINK,
                               srsran::PDCP_SN_LEN_12,
                               srsran::pdcp_t_reordering_t::ms500,
                               discard_timeout,
                               false,
                               srsran::srsran_rat_t::lte};

  pdcp_lte_test_helper     pdcp_hlp(cfg, sec_cfg, logger);
  srsran::pdcp_entity_lte* pdcp  = &pdcp_hlp.pdcp;
  rlc_dummy*               rlc   = &pdcp_hlp.rlc;
  srsue::stack_test_dummy* stack = &pdcp_hlp.stack;

  pdcp_hlp.set_pdcp_initial_state(init_state);

  // Write test SDU
  srsran::unique_byte_buffer_t sdu = srsran::make_byte_buffer();
  TESTASSERT(sdu != nullptr);
  sdu->append_bytes(sdu1, sizeof(sdu1));
  pdcp->write_sdu(std::move(sdu));

  srsran::unique_byte_buffer_t out_pdu = srsran::make_byte_buffer();
  TESTASSERT(out_pdu != nullptr);
  rlc->get_last_sdu(out_pdu);
  TESTASSERT(out_pdu->N_bytes == 4);

  // Run TTIs for Discard timers
  for (uint32_t i = 0; i < static_cast<uint32_t>(cfg.discard_timer) - 1; ++i) {
    stack->run_tti();
  }
  TESTASSERT(pdcp->nof_discard_timers() == 1); // One timer should be running
  TESTASSERT(rlc->discard_count == 0);         // No discard yet

  // Last timer step
  stack->run_tti();

  TESTASSERT(pdcp->nof_discard_timers() == 0); // Timer should have been difused after expiry
  TESTASSERT(rlc->discard_count == 1);         // RLC should be notified of discard

  srsran::pdcp_sn_vector_t sns_notified;
  sns_notified.push_back(0);
  pdcp->notify_delivery(sns_notified); // PDCP should not find PDU to notify.
  return 0;
}
/*
 * TX Test: PDCP Entity with SN LEN = 12 and 18.
 * PDCP entity configured with EIA2 and EEA2
 */
int test_tx_discard_all(srslog::basic_logger& logger)
{
  /*
   * TX Test 1: PDCP Entity with SN LEN = 12
   * Test TX PDU discard.
   */
  TESTASSERT(test_tx_sdu_notify(normal_init_state, srsran::pdcp_discard_timer_t::ms50, logger) == 0);

  /*
   * TX Test 2: PDCP Entity with SN LEN = 12
   * Test TX PDU discard.
   */
  TESTASSERT(test_tx_sdu_discard(normal_init_state, srsran::pdcp_discard_timer_t::ms50, logger) == 0);
  return 0;
}

// Setup all tests
int run_all_tests()
{
  // Setup log
  auto& logger = srslog::fetch_basic_logger("PDCP LTE Test", false);
  logger.set_level(srslog::basic_levels::debug);
  logger.set_hex_dump_max_size(128);

  TESTASSERT(test_tx_discard_all(logger) == 0);
  return 0;
}

int main()
{
  srslog::init();

  if (run_all_tests() != SRSRAN_SUCCESS) {
    fprintf(stderr, "pdcp_lte_tests() failed\n");
    return SRSRAN_ERROR;
  }

  return SRSRAN_SUCCESS;
}