ngap_gNB_defs.h

/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.1  (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.openairinterface.org/?page_id=698
 *
 * 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.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */

#include <stdint.h>

#include "queue.h"
#include "tree.h"

#include "sctp_gNB_defs.h"

#ifndef NGAP_GNB_DEFS_H_
#define NGAP_GNB_DEFS_H_

#define NGAP_GNB_NAME_LENGTH_MAX    (150)

typedef enum {
  /* Disconnected state: initial state for any association. */
  NGAP_GNB_STATE_DISCONNECTED = 0x0,
  /* State waiting for S1 Setup response message if gNB is AMF accepted or
   * S1 Setup failure if AMF rejects the gNB.
   */
  NGAP_GNB_STATE_WAITING     = 0x1,
  /* The gNB is successfully connected to AMF, UE contexts can be created. */
  NGAP_GNB_STATE_CONNECTED   = 0x2,
  /* The AMF has sent an overload start message. Once the AMF disables the
   * OVERLOAD marker, the state of the association will be
   * NGAP_GNB_STATE_CONNECTED.
   */
  NGAP_GNB_OVERLOAD          = 0x3,
  /* Max number of states available */
  NGAP_GNB_STATE_MAX,
} ngap_gNB_state_t;

/* If the Overload Action IE in the OVERLOAD START message is set to
 * - “reject all RRC connection establishments for non-emergency mobile
 *    originated data transfer  E(i.e. reject traffic corresponding to RRC cause
 *    “mo-data  E(TS 36.331 [16])), or
 * - “reject all RRC connection establishments for signalling  E(i.e. reject
 *    traffic corresponding to RRC cause “modata Eand “mo-signalling E *    (TS 38.331 [16])),or
 * - “only permit RRC connection establishments for emergency sessions and
 *    mobile terminated services E(i.e. only permit traffic corresponding to RRC
 *    cause “emergency Eand “mt-Access E(TS 36.331 [16])).
 *
 * NOTE: When the Overload Action IE is set to “only permit RRC connection
 * establishments for emergency sessions and mobile terminated services E
 * emergency calls with RRC cause “highPriorityAcess Efrom high priority users
 * are rejected (TS 24.301 [24]).
 */
typedef enum {
  NGAP_OVERLOAD_REJECT_MO_DATA        = 0x0,
  NGAP_OVERLOAD_REJECT_ALL_SIGNALLING = 0x1,
  NGAP_OVERLOAD_ONLY_EMERGENCY_AND_MT = 0x2,
  NGAP_NO_OVERLOAD                    = 0x3,
  NGAP_OVERLOAD_MAX,
} ngap_overload_state_t;

/* Served PLMN identity element */
struct plmn_identity_s {
  uint16_t mcc;
  uint16_t mnc;
  uint8_t  mnc_digit_length;
  STAILQ_ENTRY(plmn_identity_s) next;
};

/* Served amf region id for a particular AMF */
struct served_region_id_s {
  uint8_t amf_region_id;
  STAILQ_ENTRY(served_region_id_s) next;
};

/* Served amf set id for a particular AMF */
struct amf_set_id_s {
  uint16_t amf_set_id;
  STAILQ_ENTRY(amf_set_id_s) next;
};

/* Served amf pointer for a particular AMF */
struct amf_pointer_s {
  uint8_t amf_pointer;
  STAILQ_ENTRY(amf_pointer_s) next;
};


/* Served guami element */
struct served_guami_s {
  /* Number of AMF served PLMNs */
  uint8_t nb_served_plmns;
  /* List of served PLMNs by AMF */
  STAILQ_HEAD(served_plmns_s, plmn_identity_s) served_plmns;

  /* Number of region id in list */
  uint8_t nb_region_id;
  /* Served group id list */
  STAILQ_HEAD(served_region_ids_s, served_region_id_s) served_region_ids;

  /* Number of AMF set id */
  uint8_t nb_amf_set_id;
  /* AMF Set id to uniquely identify an AMF within an AMF pool area */
  STAILQ_HEAD(amf_set_ids_s, amf_set_id_s) amf_set_ids;

  /* Number of AMF pointer */
  uint8_t nb_amf_pointer;
  /* AMF pointer to uniquely identify an AMF within an AMF pool area */
  STAILQ_HEAD(amf_pointers_s, amf_pointer_s) amf_pointers;
    
  /* Next GUAMI element */
  STAILQ_ENTRY(served_guami_s) next;
};

/* NSSAI element */
typedef struct ngap_gNB_NSSAI_s{
  uint8_t sST;
  uint8_t sD_flag;
  uint8_t sD[3];
}ngap_gNB_NSSAI_t, slice_support_s;


/* plmn support element */
struct plmn_support_s {
  plmn_identity_s plmn_identity;

  /* Number of slice support in list */
  uint8_t nb_slice_s;
  /* Served group id list */
  STAILQ_HEAD(slice_supports_s, slice_support_s) slice_supports;

  /* Next plmn support element */
  STAILQ_ENTRY(plmn_support_s) next;
};


struct ngap_gNB_instance_s;

/* This structure describes association of a gNB to a AMF */
typedef struct ngap_gNB_amf_data_s {
  /* AMF descriptors tree, ordered by sctp assoc id */
  RB_ENTRY(ngap_gNB_amf_data_s) entry;

  /* This is the optional name provided by the AMF */
  char *amf_name;

  /* AMF NGAP IP address */
  net_ip_address_t amf_s1_ip;

  /* List of served GUAMI per AMF. There is one GUAMI per RAT with a max
   * number of 8 RATs but in our case only one is used. The LTE related pool
   * configuration is included on the first place in the list.
   */
  STAILQ_HEAD(served_guamis_s, served_guami_s) served_guami;

  /* Relative processing capacity of an AMF with respect to the other AMFs
   * in the pool in order to load-balance AMFs within a pool as defined
   * in TS 23.401.
   */
  uint8_t relative_amf_capacity;

  /*
   * List of PLMN Support per AMF.
   *
   */
  STAILQ_HEAD(plmn_supports_s, plmn_support_s) plmn_supports;

  /* Current AMF overload information (if any). */
  ngap_overload_state_t overload_state;
  /* Current gNB->AMF NGAP association state */
  ngap_gNB_state_t state;

  /* Next usable stream for UE signalling */
  int32_t nextstream;

  /* Number of input/ouput streams */
  uint16_t in_streams;
  uint16_t out_streams;

  /* Connexion id used between SCTP/NGAP */
  uint16_t cnx_id;

  /* SCTP association id */
  int32_t  assoc_id;

  /* This is served PLMN IDs communicated to the AMF via an index over the
   * MCC/MNC array in ngap_gNB_instance */
  uint8_t  broadcast_plmn_num;
  uint8_t  broadcast_plmn_index[PLMN_LIST_MAX_SIZE];


  /* Only meaningfull in virtual mode */
  struct ngap_gNB_instance_s *ngap_gNB_instance;
} ngap_gNB_amf_data_t;

typedef struct ngap_gNB_instance_s {
  /* Next ngap gNB association.
   * Only used for virtual mode.
   */
  STAILQ_ENTRY(ngap_gNB_instance_s) ngap_gNB_entries;

  /* Number of AMF requested by gNB (tree size) */
  uint32_t ngap_amf_nb;
  /* Number of AMF for which association is pending */
  uint32_t ngap_amf_pending_nb;
  /* Number of AMF successfully associated to gNB */
  uint32_t ngap_amf_associated_nb;
  /* Tree of NGAP AMF associations ordered by association ID */
  RB_HEAD(ngap_amf_map, ngap_gNB_amf_data_s) ngap_amf_head;

  /* TODO: add a map ordered by relative AMF capacity */

  /* Tree of UE ordered by gNB_ue_ngap_id's */
  RB_HEAD(ngap_ue_map, ngap_gNB_ue_context_s) ngap_ue_head;

  /* For virtual mode, mod_id as defined in the rest of the L1/L2 stack */
  instance_t instance;

  /* Displayable name of gNB */
  char *gNB_name;

  /* Unique gNB_id to identify the gNB within EPC.
   * In our case the gNB is a macro gNB so the id will be 20 bits long.
   * For Home gNB id, this field should be 36 bits long.
   */
  uint64_t gNB_id;
  /* The type of the cell */
  enum cell_type_e cell_type;

  /* Tracking area code */
  uint32_t tac;

  /* gNB NGAP IP address */
  net_ip_address_t gNB_ng_ip;
  
  /* Mobile Country Code
   * Mobile Network Code
   */
  uint16_t  mcc[PLMN_LIST_MAX_SIZE];
  uint16_t  mnc[PLMN_LIST_MAX_SIZE];
  uint8_t   mnc_digit_length[PLMN_LIST_MAX_SIZE];
  uint8_t   num_plmn;

  uint16_t   num_nssai[PLMN_LIST_MAX_SIZE];
  ngap_gNB_NSSAI_t s_nssai[PLMN_LIST_MAX_SIZE][1024];
  
  /* Default Paging DRX of the gNB as defined in TS 36.304 */
  ngap_paging_drx_t default_drx;
} ngap_gNB_instance_t;

typedef struct {
  /* List of served gNBs
   * Only used for virtual mode
   */
  STAILQ_HEAD(ngap_gNB_instances_head_s, ngap_gNB_instance_s) ngap_gNB_instances_head;
  /* Nb of registered gNBs */
  uint8_t nb_registered_gNBs;

  /* Generate a unique connexion id used between NGAP and SCTP */
  uint16_t global_cnx_id;
} ngap_gNB_internal_data_t;

int ngap_gNB_compare_assoc_id(
  struct ngap_gNB_amf_data_s *p1, struct ngap_gNB_amf_data_s *p2);

/* Generate the tree management functions */
RB_PROTOTYPE(ngap_amf_map, ngap_gNB_amf_data_s, entry,
             ngap_gNB_compare_assoc_id);

#endif /* NGAP_GNB_DEFS_H_ */