src/cu_stub/cu_stub.c

   1 /*******************************************************************************
   2 ################################################################################
   3 #   Copyright (c) [2017-2019] [Radisys]                                        #
   4 #                                                                              #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");            #
   6 #   you may not use this file except in compliance with the License.           #
   7 #   You may obtain a copy of the License at                                    #
   8 #                                                                              #
   9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
  10 #                                                                              #
  11 #   Unless required by applicable law or agreed to in writing, software        #
  12 #   distributed under the License is distributed on an "AS IS" BASIS,          #
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
  14 #   See the License for the specific language governing permissions and        #
  15 #   limitations under the License.                                             #
  16 ################################################################################
  17 *******************************************************************************/
  18
  19 /* This functions contains main() for cu_app */
  20 #include "common_def.h"
  21 #include "cu_stub_sctp.h"
  22 #include "cu_stub_egtp.h"
  23 #include "OCTET_STRING.h"
  24 #include "cu_f1ap_msg_hdl.h"
  25 #include "cu_stub.h"
  26
  27 #ifdef O1_ENABLE
  28 #include "CmInterface.h"
  29 #endif
  30
  31
  32 #ifdef O1_ENABLE
  33 extern StartupConfig g_cfg;
  34 #endif
  35
  36 /*******************************************************************
  37  *
  38  * @brief Handles SCTP notification
  39  *
  40  * @details
  41  *
  42  *    Function : sctpNtfyInd
  43  *
  44  *    Functionality:
  45  *         Handles SCTP notification
  46  *
  47  * @params[in] sctp notification
  48  * @return void
  49  *
  50  ******************************************************************/
  51 void sctpNtfyInd(CmInetSctpNotification *ntfy)
  52 {
  53 //TODO
  54 }
  55
  56 void init_log()
  57 {
  58     openlog("CU_STUB",LOG_CONS | LOG_PID | LOG_NDELAY, LOG_LOCAL1);
  59 }
  60 /*******************************************************************
  61  *
  62  * @brief Main function of CU APP
  63  *
  64  * @details
  65  *
  66  *    Function : main
  67  *
  68  *    Functionality:
  69  *         - Reads CU related configurations
  70  *         - Initialize SCTP Parameters
  71  *         - Start SCTP receiver thread
  72  *
  73  * @params[in]
  74  * @return ROK     - success
  75  *         RFAILED - failure
  76  *
  77  * ****************************************************************/
  78
  79 uint8_t tst()
  80 {
  81    int retVal=0;
  82    pthread_t conThrdId;
  83    pthread_attr_t attr;
  84
  85    init_log();
  86    DU_LOG("\nINFO   -->  CU_STUB : Starting CU_STUB\n");
  87
  88    /* Start thread to receive console input */
  89    pthread_attr_init(&attr);
  90    pthread_attr_setstacksize(&attr, (size_t)NULLD);
  91    pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
  92    pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
  93    retVal = pthread_create(&conThrdId, &attr, cuConsoleHandler, NULLP);
  94    if(retVal != 0)
  95    {
  96       DU_LOG("\nERROR  -->  CU_STUB :  Thread creation failed. Cause %d", retVal);
  97    }
  98    pthread_attr_destroy(&attr);
  99
 100    /* Read CU configurations */
 101    readCuCfg();
 102
 103    /* Start CU-EGTP */
 104    egtpActvInit();
 105    egtpInitReq();
 106
 107    /* Initializing SCTP global parameters */
 108    sctpActvInit();
 109
 110    /* Start CU-SCTP to listen on incoming connection */
 111    sctpCfgReq();
 112    sctpStartReq();
 113
 114    return ROK;
 115 }
 116
 117 /*******************************************************************
 118  *
 119  * @brief Read CU related configuration
 120  *
 121  * @details
 122  *
 123  *    Function : readCuCfg
 124  *
 125  *    Functionality:
 126  *            - RRead CU related configuration
 127  *
 128  * @params[in]
 129  * @return ROK     - success
 130  *         RFAILED - failure
 131  *
 132  * ****************************************************************/
 133
 134 void readCuCfg()
 135 {
 136    uint8_t  numDu, *numRemoteCu;
 137    uint32_t ipv4_du, ipv4_cu, ipv4_remote_cu;
 138
 139    DU_LOG("\nDEBUG  -->  CU_STUB : Reading CU configurations");
 140
 141    cuCb.cuCfgParams.cuId = CU_ID;
 142    strcpy(cuCb.cuCfgParams.cuName, CU_NAME);
 143
 144 #ifdef O1_ENABLE
 145    if( getStartupConfigForStub(&g_cfg) != ROK )
 146    {
 147       DU_LOG("\nError  -->  CU_STUB : Could not fetch startup "\
 148              "configurations from Netconf interface\n");
 149       exit(1);
 150    }
 151
 152    cmInetAddr((S8*)g_cfg.DU_IPV4_Addr, &ipv4_du);
 153    cuCb.cuCfgParams.sctpParams.destCb[0].destIpAddr.ipV4Addr = ipv4_du;
 154    cuCb.cuCfgParams.sctpParams.destCb[0].destIpAddr.ipV6Pres = false;
 155
 156    cmInetAddr((S8*)g_cfg.CU_IPV4_Addr, &ipv4_cu);
 157    cuCb.cuCfgParams.sctpParams.localIpAddr.ipV4Addr = ipv4_cu;
 158    cuCb.cuCfgParams.sctpParams.localIpAddr.ipV6Pres = false;
 159
 160    cuCb.cuCfgParams.sctpParams.destCb[0].destPort = g_cfg.DU_Port;
 161    cuCb.cuCfgParams.sctpParams.f1SctpPort = g_cfg.CU_Port;
 162    cuCb.cuCfgParams.sctpParams.numDestNode = 1;
 163
 164    cuCb.cuCfgParams.egtpParams.localIp.ipV4Pres = TRUE;
 165    cuCb.cuCfgParams.egtpParams.localIp.ipV4Addr = ipv4_cu;
 166    cuCb.cuCfgParams.egtpParams.localPort = F1_EGTP_PORT;
 167    cuCb.cuCfgParams.egtpParams.dstCfg[0].dstIp.ipV4Pres = TRUE;
 168    cuCb.cuCfgParams.egtpParams.dstCfg[0].dstIp.ipV4Addr = ipv4_du;
 169    cuCb.cuCfgParams.egtpParams.dstCfg[0].dstPort = F1_EGTP_PORT;
 170    cuCb.cuCfgParams.egtpParams.minTunnelId = MIN_TEID;
 171    cuCb.cuCfgParams.egtpParams.currTunnelId = cuCb.cuCfgParams.egtpParams.minTunnelId;
 172    cuCb.cuCfgParams.egtpParams.maxTunnelId = MAX_TEID;
 173    cuCb.cuCfgParams.egtpParams.numDu = 1;
 174
 175 #else
 176    /* CU IP Address and Port*/
 177    memset(&ipv4_du, 0, sizeof(uint32_t));
 178    cmInetAddr((S8*)LOCAL_IP_CU, &ipv4_cu);
 179
 180    cuCb.cuCfgParams.sctpParams.localIpAddr.ipV4Addr = ipv4_cu;
 181    cuCb.cuCfgParams.sctpParams.localIpAddr.ipV6Pres = false;
 182
 183    /* SCTP and EGTP configuration for F1 Interface */
 184    cuCb.cuCfgParams.sctpParams.f1SctpInfo.port = F1_SCTP_PORT;
 185
 186    cuCb.cuCfgParams.egtpParams.localIp.ipV4Pres = TRUE;
 187    cuCb.cuCfgParams.egtpParams.localIp.ipV4Addr = ipv4_cu;
 188    cuCb.cuCfgParams.egtpParams.localPort = F1_EGTP_PORT;
 189
 190    cuCb.cuCfgParams.sctpParams.f1SctpInfo.numDestNode = 0;
 191    cuCb.cuCfgParams.egtpParams.numDu = 0;
 192
 193    numDu = 0;
 194    while(numDu < NUM_F1_ASSOC)
 195    {
 196       /* DU IP Address */
 197       memset(&ipv4_du, 0, sizeof(uint32_t));
 198       cmInetAddr((S8*)REMOTE_IP_DU[numDu], &ipv4_du);
 199
 200       /* SCTP Parameters */
 201       cuCb.cuCfgParams.sctpParams.f1SctpInfo.destCb[numDu].destIpAddr.ipV4Addr = ipv4_du;
 202       cuCb.cuCfgParams.sctpParams.f1SctpInfo.destCb[numDu].destIpAddr.ipV6Pres = false;
 203       cuCb.cuCfgParams.sctpParams.f1SctpInfo.destCb[numDu].destPort = F1_SCTP_PORT;
 204
 205       /* EGTP Parameters */
 206       cuCb.cuCfgParams.egtpParams.dstCfg[numDu].dstIp.ipV4Pres = TRUE;
 207       cuCb.cuCfgParams.egtpParams.dstCfg[numDu].dstIp.ipV4Addr = ipv4_du;
 208       cuCb.cuCfgParams.egtpParams.dstCfg[numDu].dstPort = F1_EGTP_PORT;
 209
 210       (numDu)++;
 211    }
 212
 213    cuCb.cuCfgParams.egtpParams.minTunnelId = MIN_TEID;
 214    cuCb.cuCfgParams.egtpParams.currTunnelId = cuCb.cuCfgParams.egtpParams.minTunnelId;
 215    cuCb.cuCfgParams.egtpParams.maxTunnelId = MAX_TEID;
 216    cuCb.cuCfgParams.egtpParams.numDu = numDu;
 217    cuCb.cuCfgParams.sctpParams.f1SctpInfo.numDestNode = numDu;
 218
 219    /* SCTP configuration for Xn interface */
 220    cuCb.cuCfgParams.sctpParams.xnSctpInfo.port = XN_SCTP_PORT;
 221    cuCb.cuCfgParams.sctpParams.xnSctpInfo.localNodeType = LOCAL_NODE_TYPE;
 222    numRemoteCu = &cuCb.cuCfgParams.sctpParams.xnSctpInfo.numDestNode;
 223    (*numRemoteCu) = 0;
 224    while((*numRemoteCu) < NUM_XN_ASSOC)
 225    {
 226       /* Remote CU IP address */
 227       memset(&ipv4_remote_cu, 0, sizeof(uint32_t));
 228       cmInetAddr((S8*)REMOTE_IP_CU[*numRemoteCu], &ipv4_remote_cu);
 229
 230       /* SCTP Parameters */
 231       cuCb.cuCfgParams.sctpParams.xnSctpInfo.destCb[*numRemoteCu].destIpAddr.ipV4Addr = ipv4_remote_cu;
 232       cuCb.cuCfgParams.sctpParams.xnSctpInfo.destCb[*numRemoteCu].destIpAddr.ipV6Pres = false;
 233       cuCb.cuCfgParams.sctpParams.xnSctpInfo.destCb[*numRemoteCu].destPort = XN_SCTP_PORT;
 234
 235       (*numRemoteCu)++;
 236    }
 237 #endif
 238
 239    /*PLMN*/
 240    cuCb.cuCfgParams.plmn.mcc[0] = PLMN_MCC0;
 241    cuCb.cuCfgParams.plmn.mcc[1] = PLMN_MCC1;
 242    cuCb.cuCfgParams.plmn.mcc[2] = PLMN_MCC2;
 243    cuCb.cuCfgParams.plmn.mnc[0] = PLMN_MNC0;
 244    cuCb.cuCfgParams.plmn.mnc[1] = PLMN_MNC1;
 245    cuCb.cuCfgParams.plmn.mnc[2] = PLMN_MNC2;
 246
 247    /*RRC Version*/
 248    cuCb.cuCfgParams.rrcVersion.rrcVer = RRC_VER;
 249    cuCb.cuCfgParams.rrcVersion.extRrcVer = EXT_RRC_VER;
 250
 251
 252
 253 } /* End of readCuCfg */
 254
 255 /*******************************************************************
 256  *
 257  * @brief Initiates inter DU handover
 258  *
 259  * @details
 260  *
 261  *    Function : initiateInterDuHandover
 262  *
 263  *    Functionality: Initiates the first procedure of inter-DU
 264  *    handover i.eG GNB-DU configuration query to source DU
 265  *
 266  * @params[in] Source DU Id
 267  *             Target DU Id
 268  *             UE Id to be handed off
 269  * @return ROK     - success
 270  *         RFAILED - failure
 271  *
 272  * ****************************************************************/
 273 void initiateInterDuHandover(uint32_t sourceDuId, uint32_t targetDuId, uint32_t ueId)
 274 {
 275     uint8_t duIdx = 0;
 276     DuDb *duDb = NULLP;
 277     CuUeCb *ueCb = NULLP;
 278
 279     SEARCH_DU_DB(duIdx, sourceDuId, duDb);
 280     if(duDb)
 281        ueCb = &duDb->ueCb[ueId-1];
 282     if(ueCb)
 283     {
 284        ueCb->state = UE_HANDOVER_IN_PROGRESS;
 285        ueCb->hoInfo.sourceDuId = sourceDuId;
 286        ueCb->hoInfo.targetDuId = targetDuId;
 287     }
 288
 289     DU_LOG("\nINFO  --> CU_STUB: Inter-DU Handover Started for ueId [%d] from DU ID [%d] to DU ID [%d]", \
 290           ueId, sourceDuId, targetDuId);
 291     BuildAndSendUeContextModificationReq(sourceDuId, ueCb, QUERY_CONFIG);
 292 }
 293
 294
 295 /*******************************************************************
 296  *
 297  * @brief Initiates inter CU handover
 298  *
 299  * @details
 300  *
 301  *    Function : initiateInterCuHandover
 302  *
 303  *    Functionality: Initiates the first procedure of inter-CU
 304  *    handover
 305  *
 306  * @params[in] Source CU Id
 307  *             Target CU Id
 308  *             UE Id to be handed off
 309  * @return ROK     - success
 310  *         RFAILED - failure
 311  *
 312  * ****************************************************************/
 313 void initiateInterCuHandover(uint32_t sourceCuId, uint32_t targetCuId, uint32_t ueId)
 314 {
 315     DU_LOG("\nINFO  --> CU_STUB: Inter-CU Handover Started for ueId [%d] from CU ID [%d] to CU ID [%d]", \
 316           ueId, sourceCuId, targetCuId);
 317     //TODO : First message of HO procedure to be triggered here. Changes to be done in next commit.
 318 }
 319
 320 /*******************************************************************
 321  *
 322  * @brief start Dl data
 323  *
 324  * @details
 325  *
 326  *    Function : startDlData
 327  *
 328  *    Functionality: start the downlink data
 329  *
 330  * @params[in]
 331  * @return ROK     - success
 332  *         RFAILED - failure
 333  *
 334  * ****************************************************************/
 335
 336 uint8_t startDlData()
 337 {
 338    uint32_t teId = 0;
 339    uint32_t duId;
 340    uint8_t ret = ROK;
 341    uint8_t cnt = 0;
 342    int32_t totalNumOfTestFlow = 20;
 343    EgtpTeIdCb *teidCb = NULLP;
 344
 345    while(totalNumOfTestFlow)
 346    {
 347       for(duId = 1; duId <= cuCb.cuCfgParams.egtpParams.numDu; duId++)
 348       {
 349          for(teId = 1; teId <= NUM_TUNNEL_TO_PUMP_DATA; teId++)
 350          {
 351             teidCb = NULLP;
 352             cmHashListFind(&(egtpCb.dstCb[duId-1].teIdLst), (uint8_t *)&(teId), sizeof(uint32_t), 0, (PTR *)&teidCb);
 353             if(teidCb)
 354             {
 355                cnt =0;
 356                DU_LOG("\nDEBUG  -->  EGTP: Sending DL User Data(duId %d, teId:%d)\n", duId, teId);
 357                while(cnt < NUM_DL_PACKETS)
 358                {
 359                   ret =  cuEgtpDatReq(duId, teId);
 360                   if(ret != ROK)
 361                   {
 362                      DU_LOG("\nERROR --> EGTP: Issue with teid=%d\n",teId);
 363                      break;
 364                   }
 365                   /* TODO : sleep(1) will be removed later once we will be able to
 366                    * support the continuous data pack transfer */
 367                   sleep(1);
 368                   cnt++;
 369                }
 370             }
 371             else
 372             {
 373                DU_LOG("\nDEBUG  -->  EGTP: TunnelId Not Found for (duId %d, teId:%d)\n", duId, teId);
 374             }
 375          }
 376       }
 377       totalNumOfTestFlow--;
 378    }
 379
 380    return ROK;
 381 }
 382
 383 /*******************************************************************
 384  *
 385  * @brief Handles Console input
 386  *
 387  * @details
 388  *
 389  *    Function : cuConsoleHandler
 390  *
 391  *    Functionality: Handles Console input
 392  *
 393  * @params[in]
 394  * @return ROK     - success
 395  *         RFAILED - failure
 396  *
 397  * ****************************************************************/
 398 void *cuConsoleHandler(void *args)
 399 {
 400    char ch;
 401
 402    while(true)
 403    {
 404       ch = getchar();
 405       /* Send DL user data to CU when user enters 'd' on console */
 406       if(ch == 'd')
 407       {
 408
 409          /* Change #if 0 to #if 1 to take input from user */
 410 #if 0
 411          DU_LOG("\n EGTP --> : Enter TEID id(1..10) where DL Data to be sent\n");
 412          scanf("%d",&teId);
 413
 414          if(teId > MAX_TEID || teId < MIN_TEID)
 415          {
 416             DU_LOG("\nERROR  -->  EGTP : TEID(%x) OUT Of Range",teId);
 417             printf("\n");
 418             continue;
 419          }
 420          /* Start Pumping data from CU to DU */
 421          DU_LOG("\nDEBUG  -->  EGTP: Sending DL User Data(teId:%d)\n",teId);
 422
 423          cnt =0;
 424          while(cnt < NUM_DL_PACKETS)
 425          {
 426             ret =  cuEgtpDatReq(teId);
 427             if(ret != ROK)
 428             {
 429                DU_LOG("\nERROR --> EGTP: Issue with teid=%d\n",teId);
 430                break;
 431             }
 432             cnt++;
 433          }
 434 #else
 435
 436          /* This variable is taken for sending specific number of downlink data packet.
 437           * Presently the code is supporting total 4500 data packets trasfer for 3 UEs only with sleep(1).
 438           * If you wants to pump data for 3 UE change the following macro values
 439           * NUM_TUNNEL_TO_PUMP_DATA = 9, NUM_DL_PACKETS = 1.
 440           * totalDataPacket = totalNumOfTestFlow * NUM_TUNNEL_TO_PUMP_DATA * NUM_DL_PACKETS
 441           * totalDataPacket = [500*9*1] */
 442
 443          startDlData();
 444 #endif
 445          continue;
 446       }
 447
 448       /* Start Handover procedure towards DU when 'h' is received from console input */
 449       else if(ch == 'h')
 450       {
 451          HandoverType hoType;
 452          uint32_t sourceId, targetId, ueId;
 453
 454          DU_LOG("\n\nChoose the type of handover to initiate : \nEnter 1 for Inter-CU Handover over Xn interface\nEnter 2 for Inter-DU Handover\n");
 455          scanf("%d", &hoType);
 456
 457          if(hoType == Xn_Based_Inter_CU_HO)
 458          {
 459             DU_LOG("\nEnter Source CU ID for Inter-CU Handover : ");
 460             scanf("%d", &sourceId);
 461             DU_LOG("\nEnter Target CU ID for Inter-CU Handover : ");
 462             scanf("%d", &targetId);
 463             DU_LOG("\nEnter CU UE F1AP ID to be handed over : ");
 464             scanf("%d", &ueId);
 465
 466             initiateInterCuHandover(sourceId, targetId, ueId);
 467          }
 468          else if(hoType == Inter_DU_HO)
 469          {
 470             DU_LOG("\nEnter Source DU ID for Inter-DU Handover : ");
 471             scanf("%d", &sourceId);
 472             DU_LOG("\nEnter Target DU ID for Inter-DU Handover : ");
 473             scanf("%d", &targetId);
 474             DU_LOG("\nEnter DU UE F1AP ID to be handed over : ");
 475             scanf("%d", &ueId);
 476
 477             initiateInterDuHandover(sourceId, targetId, ueId);
 478          }
 479       }
 480       /* Start Idle mode paging when 'p' is received from console input */
 481       else if(ch == 'p')
 482       {
 483          uint64_t sTmsi = 0;
 484          uint8_t duId = 0;
 485
 486          DU_LOG("\nEnter DU ID on which this UE to be pagged");
 487          scanf("%d", &duId);
 488          DU_LOG("\nEnter 5g-S-TMSI");
 489          scanf("%lu", &sTmsi);
 490
 491          if(BuildAndSendPagingMsg(sTmsi, duId) != ROK)
 492          {
 493             DU_LOG("\nERROR --> EGTP: Failed to build and send paging message for 5gsTmsi[%lu]\n", sTmsi);
 494          }
 495          continue;
 496       }
 497       else if(ch == 'm')
 498       {
 499          uint8_t ueId = 1;
 500          uint8_t duId = 1;
 501          uint8_t duIdx = 0;
 502
 503          DU_LOG("\nINFO  --> CU_STUB: UE Context Mod for ueId [%d] at DU ID [%d]", \
 504                   ueId, duId );
 505          DuDb *duDb = NULLP;
 506          CuUeCb *ueCb = NULLP;
 507
 508          SEARCH_DU_DB(duIdx, duId, duDb);
 509          if(duDb)
 510             ueCb = &duDb->ueCb[ueId-1];
 511          BuildAndSendUeContextModificationReq(duId, ueCb, MODIFY_UE);
 512
 513       }
 514    }
 515 }
 516 /**********************************************************************
 517          End of file
 518 **********************************************************************/