File size: 33,801 Bytes
258fb37 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 |
/*
* Copyright (C) 2019-2023 by Sukchan Lee <acetcom@gmail.com>
*
* This file is part of Open5GS.
*
* This program 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.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef AMF_CONTEXT_H
#define AMF_CONTEXT_H
#include "ogs-app.h"
#include "ogs-sbi.h"
#include "ogs-sctp.h"
#include "ogs-ngap.h"
#include "ogs-nas-5gs.h"
#include "amf-sm.h"
#include "timer.h"
#include "metrics.h"
#ifdef __cplusplus
extern "C" {
#endif
extern int __amf_log_domain;
extern int __gmm_log_domain;
#undef OGS_LOG_DOMAIN
#define OGS_LOG_DOMAIN __amf_log_domain
typedef struct ran_ue_s ran_ue_t;
typedef struct amf_ue_s amf_ue_t;
typedef uint32_t amf_m_tmsi_t;
typedef struct amf_context_s {
/* Served GUAMI */
int num_of_served_guami;
ogs_guami_t served_guami[OGS_MAX_NUM_OF_SERVED_GUAMI];
/* Served TAI */
int num_of_served_tai;
struct {
ogs_5gs_tai0_list_t list0;
ogs_5gs_tai1_list_t list1;
ogs_5gs_tai2_list_t list2;
} served_tai[OGS_MAX_NUM_OF_SUPPORTED_TA];
/* PLMN Support */
int num_of_plmn_support;
struct {
ogs_plmn_id_t plmn_id;
int num_of_s_nssai;
ogs_s_nssai_t s_nssai[OGS_MAX_NUM_OF_SLICE_SUPPORT];
} plmn_support[OGS_MAX_NUM_OF_PLMN];
/* Access Control */
int default_reject_cause;
int num_of_access_control;
struct {
int reject_cause;
ogs_plmn_id_t plmn_id;
} access_control[OGS_MAX_NUM_OF_PLMN];
/* defined in 'nas_ies.h'
* #define NAS_SECURITY_ALGORITHMS_EIA0 0
* #define NAS_SECURITY_ALGORITHMS_128_EEA1 1
* #define NAS_SECURITY_ALGORITHMS_128_EEA2 2
* #define NAS_SECURITY_ALGORITHMS_128_EEA3 3 */
int num_of_ciphering_order;
uint8_t ciphering_order[OGS_MAX_NUM_OF_ALGORITHM];
/* defined in 'nas_ies.h'
* #define NAS_SECURITY_ALGORITHMS_EIA0 0
* #define NAS_SECURITY_ALGORITHMS_128_EIA1 1
* #define NAS_SECURITY_ALGORITHMS_128_EIA1 2
* #define NAS_SECURITY_ALGORITHMS_128_EIA3 3 */
int num_of_integrity_order;
uint8_t integrity_order[OGS_MAX_NUM_OF_ALGORITHM];
/* Network Name */
ogs_nas_network_name_t short_name; /* Network short name */
ogs_nas_network_name_t full_name; /* Network Full Name */
/* AMF Name */
const char *amf_name;
/* NGSetupResponse */
uint8_t relative_capacity;
/* Generator for unique identification */
uint64_t amf_ue_ngap_id; /* amf_ue_ngap_id generator */
ogs_list_t gnb_list; /* GNB NGAP Client List */
ogs_list_t amf_ue_list;
ogs_hash_t *gnb_addr_hash; /* hash table for GNB Address */
ogs_hash_t *gnb_id_hash; /* hash table for GNB-ID */
ogs_hash_t *guti_ue_hash; /* hash table (GUTI : AMF_UE) */
ogs_hash_t *suci_hash; /* hash table (SUCI) */
ogs_hash_t *supi_hash; /* hash table (SUPI) */
uint16_t ngap_port; /* Default NGAP Port */
ogs_list_t ngap_list; /* AMF NGAP IPv4 Server List */
ogs_list_t ngap_list6; /* AMF NGAP IPv6 Server List */
struct {
struct {
ogs_time_t value; /* Timer Value(Seconds) */
} t3502, t3512;
} time;
} amf_context_t;
typedef struct amf_gnb_s {
ogs_lnode_t lnode;
ogs_pool_id_t id;
ogs_fsm_t sm; /* A state machine */
uint32_t gnb_id; /* gNB_ID received from gNB */
ogs_plmn_id_t plmn_id; /* gNB PLMN-ID received from gNB */
ogs_sctp_sock_t sctp; /* SCTP socket */
struct {
bool ng_setup_success; /* gNB NGAP Setup complete successfuly */
} state;
int max_num_of_ostreams;/* SCTP Max num of outbound streams */
uint16_t ostream_id; /* gnb_ostream_id generator */
int num_of_supported_ta_list;
struct {
ogs_uint24_t tac;
int num_of_bplmn_list;
struct {
ogs_plmn_id_t plmn_id;
int num_of_s_nssai;
ogs_s_nssai_t s_nssai[OGS_MAX_NUM_OF_SLICE_SUPPORT];
} bplmn_list[OGS_MAX_NUM_OF_BPLMN];
} supported_ta_list[OGS_MAX_NUM_OF_SUPPORTED_TA];
OpenAPI_rat_type_e rat_type;
ogs_pkbuf_t *ng_reset_ack; /* Reset message */
ogs_list_t ran_ue_list;
} amf_gnb_t;
struct ran_ue_s {
ogs_lnode_t lnode;
uint32_t index;
ogs_pool_id_t id;
/* UE identity */
#define INVALID_UE_NGAP_ID 0xffffffffffffffffULL /* Initial value of ran_ue_ngap_id */
uint64_t ran_ue_ngap_id; /* RAN-UE-NGAP-ID received from RAN */
uint64_t amf_ue_ngap_id; /* AMF-UE-NGAP-ID received from AMF */
uint16_t gnb_ostream_id; /* SCTP output stream id for eNB */
/* UE context */
bool ue_context_requested;
bool initial_context_setup_request_sent;
#define CONTEXT_SETUP_ESTABLISHED(__aMF) \
CM_CONNECTED(__aMF) && \
(ran_ue_find_by_id((__aMF)->ran_ue_id)-> \
initial_context_setup_response_received == true)
bool initial_context_setup_response_received;
bool ue_ambr_sent;
/* Handover Info */
ogs_pool_id_t source_ue_id;
ogs_pool_id_t target_ue_id;
/* Use amf_ue->nr_tai, amf_ue->nr_cgi.
* Do not access ran_ue->saved.tai ran_ue->saved.nr_cgi.
*
* Save TAI and CGI. And then, this will copy 'amf_ue_t' context later */
struct {
ogs_5gs_tai_t nr_tai;
ogs_nr_cgi_t nr_cgi;
} saved;
/* NG Holding timer for removing this context */
ogs_timer_t *t_ng_holding;
/* Store by UE Context Release Command
* Retrieve by UE Context Release Complete */
#define NGAP_UE_CTX_REL_INVALID_ACTION 0
#define NGAP_UE_CTX_REL_NG_CONTEXT_REMOVE 1
#define NGAP_UE_CTX_REL_NG_REMOVE_AND_UNLINK 2
#define NGAP_UE_CTX_REL_UE_CONTEXT_REMOVE 3
#define NGAP_UE_CTX_REL_NG_HANDOVER_COMPLETE 4
#define NGAP_UE_CTX_REL_NG_HANDOVER_CANCEL 5
#define NGAP_UE_CTX_REL_NG_HANDOVER_FAILURE 6
uint8_t ue_ctx_rel_action;
bool part_of_ng_reset_requested;
struct {
uint16_t activated; /* Activated PSI Mask */
} psimask;
/* Related Context */
ogs_pool_id_t gnb_id;
ogs_pool_id_t amf_ue_id;
};
struct amf_ue_s {
ogs_sbi_object_t sbi;
ogs_pool_id_t id;
ogs_fsm_t sm;
struct {
uint8_t message_type; /* Type of last specific NAS message received */
int access_type; /* 3GPP or Non-3GPP */
struct {
ED3(uint8_t tsc:1;,
uint8_t ksi:3;,
uint8_t spare:4;)
} amf, ue;
ogs_nas_5gs_registration_type_t registration;
ogs_nas_de_registration_type_t de_registration;
struct {
ED4(uint8_t uplink_data_status:1;,
uint8_t pdu_session_status:1;,
uint8_t allowed_pdu_session_status:1;,
uint8_t reserved:5;)
} present;
} __attribute__ ((packed)) nas;
/* UE identity */
#define AMF_UE_HAVE_SUCI(__aMF) \
((__aMF) && ((__aMF)->suci))
char *suci; /* TS33.501 : SUCI */
char *supi; /* TS33.501 : SUPI */
ogs_nas_5gs_mobile_identity_suci_t nas_mobile_identity_suci;
/* Home PLMN ID */
ogs_plmn_id_t home_plmn_id;
char *pei;
uint8_t masked_imeisv[OGS_MAX_IMEISV_LEN];
int masked_imeisv_len;
char imeisv_bcd[OGS_MAX_IMEISV_BCD_LEN+1];
ogs_nas_mobile_identity_imeisv_t nas_mobile_identity_imeisv;
int num_of_msisdn;
char *msisdn[OGS_MAX_NUM_OF_MSISDN];
struct {
amf_m_tmsi_t *m_tmsi;
ogs_nas_5gs_guti_t guti;
} current, next;
ogs_nas_5gs_guti_t old_guti;
/* UE Info */
ogs_guami_t *guami;
uint16_t gnb_ostream_id;
ogs_5gs_tai_t nr_tai;
ogs_nr_cgi_t nr_cgi;
ogs_time_t ue_location_timestamp;
ogs_plmn_id_t last_visited_plmn_id;
ogs_nas_ue_usage_setting_t ue_usage_setting;
struct {
int num_of_s_nssai;
ogs_nas_s_nssai_ie_t s_nssai[OGS_MAX_NUM_OF_SLICE];
} requested_nssai, allowed_nssai;
struct {
int num_of_s_nssai;
ogs_nas_rejected_s_nssai_t s_nssai[OGS_MAX_NUM_OF_SLICE];
} rejected_nssai;
/* PCF sends the RESPONSE
* of [POST] /npcf-am-polocy-control/v1/policies */
#define PCF_AM_POLICY_ASSOCIATED(__aMF) \
((__aMF) && ((__aMF)->policy_association.id))
#define PCF_AM_POLICY_CLEAR(__aMF) \
do { \
ogs_assert((__aMF)); \
if ((__aMF)->policy_association.resource_uri) \
ogs_free((__aMF)->policy_association.resource_uri); \
(__aMF)->policy_association.resource_uri = NULL; \
if ((__aMF)->policy_association.id) \
ogs_free((__aMF)->policy_association.id); \
(__aMF)->policy_association.id = NULL; \
} while(0)
#define PCF_AM_POLICY_STORE(__aMF, __rESOURCE_URI, __iD) \
do { \
ogs_assert((__aMF)); \
ogs_assert((__rESOURCE_URI)); \
ogs_assert((__iD)); \
PCF_AM_POLICY_CLEAR(__aMF); \
(__aMF)->policy_association.resource_uri = ogs_strdup(__rESOURCE_URI); \
ogs_assert((__aMF)->policy_association.resource_uri); \
(__aMF)->policy_association.id = ogs_strdup(__iD); \
ogs_assert((__aMF)->policy_association.id); \
} while(0)
struct {
char *resource_uri;
char *id;
ogs_sbi_client_t *client;
} policy_association;
/* 5GMM Capability */
struct {
bool lte_positioning_protocol_capability;
bool ho_attach;
bool s1_mode;
} gmm_capability;
#define SECURITY_CONTEXT_IS_VALID(__aMF) \
((__aMF) && \
((__aMF)->security_context_available == 1) && \
((__aMF)->mac_failed == 0) && \
((__aMF)->nas.ue.ksi != OGS_NAS_KSI_NO_KEY_IS_AVAILABLE))
#define CLEAR_SECURITY_CONTEXT(__aMF) \
do { \
ogs_assert((__aMF)); \
(__aMF)->security_context_available = 0; \
(__aMF)->mac_failed = 0; \
} while(0)
int security_context_available;
int mac_failed;
/* Security Context */
ogs_nas_ue_security_capability_t ue_security_capability;
ogs_nas_ue_network_capability_t ue_network_capability;
#define CHECK_5G_AKA_CONFIRMATION(__aMF) \
((__aMF) && ((__aMF)->confirmation_for_5g_aka.resource_uri))
#define STORE_5G_AKA_CONFIRMATION(__aMF, __rESOURCE_URI) \
do { \
ogs_assert((__aMF)); \
CLEAR_5G_AKA_CONFIRMATION(__aMF); \
(__aMF)->confirmation_for_5g_aka.resource_uri = \
ogs_strdup(__rESOURCE_URI); \
ogs_assert((__aMF)->confirmation_for_5g_aka.resource_uri); \
} while(0)
#define CLEAR_5G_AKA_CONFIRMATION(__aMF) \
do { \
ogs_assert((__aMF)); \
if ((__aMF)->confirmation_for_5g_aka.resource_uri) \
ogs_free((__aMF)->confirmation_for_5g_aka.resource_uri); \
(__aMF)->confirmation_for_5g_aka.resource_uri = NULL; \
} while(0)
struct {
char *resource_uri;
ogs_sbi_client_t *client;
} confirmation_for_5g_aka;
uint8_t rand[OGS_RAND_LEN];
uint8_t autn[OGS_AUTN_LEN];
uint8_t xres_star[OGS_MAX_RES_LEN];
uint8_t abba[OGS_NAS_MAX_ABBA_LEN];
uint8_t abba_len;
uint8_t hxres_star[OGS_MAX_RES_LEN];
uint8_t kamf[OGS_SHA256_DIGEST_SIZE];
OpenAPI_auth_result_e auth_result;
uint8_t knas_int[OGS_SHA256_DIGEST_SIZE/2];
uint8_t knas_enc[OGS_SHA256_DIGEST_SIZE/2];
uint32_t dl_count;
union {
struct {
ED3(uint8_t spare;,
uint16_t overflow;,
uint8_t sqn;)
} __attribute__ ((packed));
uint32_t i32;
} ul_count;
uint8_t kgnb[OGS_SHA256_DIGEST_SIZE];
struct {
ED2(uint8_t nhcc_spare:5;,
uint8_t nhcc:3;) /* Next Hop Channing Counter */
};
uint8_t nh[OGS_SHA256_DIGEST_SIZE]; /* NH Security Key */
/* defined in 'lib/nas/common/types.h'
* #define OGS_NAS_SECURITY_ALGORITHMS_NEA0 0
* #define OGS_NAS_SECURITY_ALGORITHMS_128_NEA1 1
* #define OGS_NAS_SECURITY_ALGORITHMS_128_NEA2 2
* #define OGS_NAS_SECURITY_ALGORITHMS_128_NEA3 3 */
uint8_t selected_enc_algorithm;
/* defined in 'lib/nas/common/types.h'
* #define OGS_NAS_SECURITY_ALGORITHMS_NIA0 0
* #define OGS_NAS_SECURITY_ALGORITHMS_128_NIA1 1
* #define OGS_NAS_SECURITY_ALGORITHMS_128_NIA1 2
* #define OGS_NAS_SECURITY_ALGORITHMS_128_NIA3 3 */
uint8_t selected_int_algorithm;
/* SubscribedInfo */
ogs_bitrate_t ue_ambr;
int num_of_slice;
OpenAPI_list_t *rat_restrictions;
ogs_slice_data_t slice[OGS_MAX_NUM_OF_SLICE];
uint64_t am_policy_control_features; /* SBI Features */
#define CM_CONNECTED(__aMF) \
((__aMF) && \
((__aMF)->ran_ue_id >= OGS_MIN_POOL_ID) && \
((__aMF)->ran_ue_id <= OGS_MAX_POOL_ID) && \
(ran_ue_find_by_id((__aMF)->ran_ue_id)))
#define CM_IDLE(__aMF) \
((__aMF) && \
(((__aMF)->ran_ue_id < OGS_MIN_POOL_ID) || \
((__aMF)->ran_ue_id > OGS_MAX_POOL_ID) || \
(ran_ue_find_by_id((__aMF)->ran_ue_id) == NULL)))
/* NG UE context */
ogs_pool_id_t ran_ue_id;
#define HOLDING_NG_CONTEXT(__aMF) \
do { \
ran_ue_t *ran_ue_holding = NULL; \
\
(__aMF)->ran_ue_holding_id = OGS_INVALID_POOL_ID; \
\
ran_ue_holding = ran_ue_find_by_id((__aMF)->ran_ue_id); \
if (ran_ue_holding) { \
ran_ue_deassociate(ran_ue_holding); \
\
ogs_warn("[%s] Holding NG Context", (__aMF)->suci); \
ogs_warn("[%s] RAN_UE_NGAP_ID[%lld] AMF_UE_NGAP_ID[%lld]", \
(__aMF)->suci, \
(long long)ran_ue_holding->ran_ue_ngap_id, \
(long long)ran_ue_holding->amf_ue_ngap_id); \
\
ran_ue_holding->ue_ctx_rel_action = \
NGAP_UE_CTX_REL_NG_CONTEXT_REMOVE; \
ogs_timer_start(ran_ue_holding->t_ng_holding, \
amf_timer_cfg(AMF_TIMER_NG_HOLDING)->duration); \
\
(__aMF)->ran_ue_holding_id = (__aMF)->ran_ue_id; \
} else \
ogs_error("[%s] NG Context has already been removed", \
(__aMF)->suci); \
} while(0)
#define CLEAR_NG_CONTEXT(__aMF) \
do { \
ran_ue_t *ran_ue_holding = NULL; \
\
ran_ue_holding = ran_ue_find_by_id((__aMF)->ran_ue_holding_id); \
if (ran_ue_holding) { \
int r; \
ogs_warn("[%s] Clear NG Context", (__aMF)->suci); \
ogs_warn("[%s] RAN_UE_NGAP_ID[%lld] AMF_UE_NGAP_ID[%lld]", \
(__aMF)->suci, \
(long long)ran_ue_holding->ran_ue_ngap_id, \
(long long)ran_ue_holding->amf_ue_ngap_id); \
\
r = ngap_send_ran_ue_context_release_command( \
ran_ue_holding, \
NGAP_Cause_PR_nas, NGAP_CauseNas_normal_release, \
NGAP_UE_CTX_REL_NG_CONTEXT_REMOVE, 0); \
ogs_expect(r == OGS_OK); \
ogs_assert(r != OGS_ERROR); \
} \
(__aMF)->ran_ue_holding_id = OGS_INVALID_POOL_ID; \
} while(0)
ogs_pool_id_t ran_ue_holding_id;
#define CLEAR_AMF_UE_ALL_TIMERS(__aMF) \
do { \
CLEAR_AMF_UE_TIMER((__aMF)->t3513); \
CLEAR_AMF_UE_TIMER((__aMF)->t3522); \
CLEAR_AMF_UE_TIMER((__aMF)->t3550); \
CLEAR_AMF_UE_TIMER((__aMF)->t3555); \
CLEAR_AMF_UE_TIMER((__aMF)->t3560); \
CLEAR_AMF_UE_TIMER((__aMF)->t3570); \
CLEAR_AMF_UE_TIMER((__aMF)->mobile_reachable); \
CLEAR_AMF_UE_TIMER((__aMF)->implicit_deregistration); \
} while(0);
#define CLEAR_AMF_UE_TIMER(__aMF_UE_TIMER) \
do { \
ogs_timer_stop((__aMF_UE_TIMER).timer); \
if ((__aMF_UE_TIMER).pkbuf) { \
ogs_pkbuf_free((__aMF_UE_TIMER).pkbuf); \
(__aMF_UE_TIMER).pkbuf = NULL; \
} \
(__aMF_UE_TIMER).retry_count = 0; \
} while(0);
struct {
ogs_pkbuf_t *pkbuf;
ogs_timer_t *timer;
uint32_t retry_count;;
} t3513, t3522, t3550, t3555, t3560, t3570, mobile_reachable, implicit_deregistration;
/* UE Radio Capability */
OCTET_STRING_t ueRadioCapability;
/* UEContextReleaseRequest or InitialContextSetupFailure */
struct {
NGAP_Cause_PR group;
long cause;
} deactivation;
/* Handover Info */
struct {
NGAP_HandoverType_t type;
OCTET_STRING_t container;
NGAP_Cause_PR group;
long cause;
} handover;
/* SubscriptionId of Subscription to Data Change Notification to UDM */
#define UDM_SDM_SUBSCRIBED(__aMF) \
((__aMF) && ((__aMF)->data_change_subscription.id))
#define UDM_SDM_CLEAR(__aMF) \
do { \
ogs_assert((__aMF)); \
if ((__aMF)->data_change_subscription.resource_uri) \
ogs_free((__aMF)->data_change_subscription.resource_uri); \
(__aMF)->data_change_subscription.resource_uri = NULL; \
if ((__aMF)->data_change_subscription.id) \
ogs_free((__aMF)->data_change_subscription.id); \
(__aMF)->data_change_subscription.id = NULL; \
} while(0)
#define UDM_SDM_STORE(__aMF, __rESOURCE_URI, __iD) \
do { \
ogs_assert((__aMF)); \
ogs_assert((__rESOURCE_URI)); \
ogs_assert((__iD)); \
UDM_SDM_CLEAR(__aMF); \
(__aMF)->data_change_subscription.resource_uri = \
ogs_strdup(__rESOURCE_URI); \
ogs_assert((__aMF)->data_change_subscription.resource_uri); \
(__aMF)->data_change_subscription.id = ogs_strdup(__iD); \
ogs_assert((__aMF)->data_change_subscription.id); \
} while(0)
struct {
char *resource_uri;
char *id;
ogs_sbi_client_t *client;
} data_change_subscription;
struct {
/*
* De-Registered Request
* De-Registered Accept
*/
bool n1_done;
/*
* Nudm_SDM_Unsubscribe
* PATCH Nudm_UECM/registration/amf-3gpp-access
* PDU Session Release
* N4 Release
* DELETE Nbpsf-management
* DELETE Npcf-am_policy-control
*/
bool sbi_done;
} explict_de_registered;
ogs_list_t sess_list;
};
typedef struct amf_sess_s {
ogs_sbi_object_t sbi;
ogs_pool_id_t id;
uint8_t psi; /* PDU Session Identity */
uint8_t pti; /* Procedure Trasaction Identity */
#define SESSION_CONTEXT_IN_SMF(__sESS) \
((__sESS) && (__sESS)->sm_context.ref)
#define STORE_SESSION_CONTEXT(__sESS, __rESOURCE_URI, __rEF) \
do { \
ogs_assert(__sESS); \
ogs_assert(__rESOURCE_URI); \
ogs_assert(__rEF); \
CLEAR_SESSION_CONTEXT(__sESS); \
(__sESS)->sm_context.resource_uri = ogs_strdup(__rESOURCE_URI); \
ogs_assert((__sESS)->sm_context.resource_uri); \
(__sESS)->sm_context.ref = ogs_strdup(__rEF); \
ogs_assert((__sESS)->sm_context.ref); \
} while(0);
#define CLEAR_SESSION_CONTEXT(__sESS) \
do { \
ogs_assert(__sESS); \
if ((__sESS)->sm_context.ref) \
ogs_free((__sESS)->sm_context.ref); \
(__sESS)->sm_context.ref = NULL; \
if ((__sESS)->sm_context.resource_uri) \
ogs_free((__sESS)->sm_context.resource_uri); \
(__sESS)->sm_context.resource_uri = NULL; \
} while(0);
/* SMF sends the RESPONSE
* of [POST] /nsmf-pdusession/v1/sm-contexts */
struct {
char *resource_uri;
char *ref;
ogs_sbi_client_t *client;
} sm_context;
bool pdu_session_release_complete_received;
bool pdu_session_resource_release_response_received;
/* SMF sends the REQUEST
* of [POST] /namf-comm/v1/ue-contexts/{supi}/n1-n2-messages */
ogs_pkbuf_t *pdu_session_establishment_accept;
/*
* [AMF]
* 1. PDUSessionResourceReleaseResponse
* REQUEST [POST] /nsmf-pdusession/v1/sm-contexts/{smContextRef}/modify
* 2. PDU Session release complete
* REQUEST [POST] /nsmf-pdusession/v1/sm-contexts/{smContextRef}/modify
*
* [SMF]
* 1. RESPONSE /nsmf-pdusession/v1/sm-contexts/{smContextRef}/modify
* sess->n2_released = true;
*
* 2. RESPONSE /nsmf-pdusession/v1/sm-contexts/{smContextRef}/modify
* sess->n1_released = true;
*
* 3. NOTIFY /namf-callback/v1/{supi}/sm-context-status/{psi})
* sess->resource_status = OpenAPI_resource_status_RELEASED;
*
* if (sess->n1_released == true &&
* sess->n2_released == true &&
* sess->resource_status == OpenAPI_resource_status_RELEASED) {
*
* REMOVE_SESSION_CONTEXT()
* }
*/
OpenAPI_resource_status_e resource_status;
bool n1_released;
bool n2_released;
/*
* To check if Reactivation Request has been used.
*
* During the PFCP recovery process,
* when a Reactivation Request is sent to PDU session release command,
* the UE simultaneously sends PDU session release complete and
* PDU session establishment request.
*
* In this case, old_gsm_type is PDU session release command and
* current_gsm_type is PDU session establishment request.
*/
uint8_t old_gsm_type, current_gsm_type;
struct {
ogs_pkbuf_t *pdu_session_resource_setup_request;
ogs_pkbuf_t *pdu_session_resource_modification_command;
ogs_pkbuf_t *path_switch_request_ack;
ogs_pkbuf_t *handover_request;
ogs_pkbuf_t *handover_command;
} transfer;
#define AMF_SESS_STORE_N2_TRANSFER(__sESS, __n2Type, __n2Buf) \
do { \
ogs_assert(__sESS); \
if ((__sESS)->transfer.__n2Type) { \
amf_ue_t *amf_ue = amf_ue_find_by_id((__sESS)->amf_ue_id); \
if (amf_ue) \
ogs_warn("[%s:%d] " \
"N2 transfer message duplicated. Overwritten", \
amf_ue->supi, (__sESS)->psi); \
ogs_pkbuf_free((__sESS)->transfer.__n2Type); \
} \
(__sESS)->transfer.__n2Type = __n2Buf; \
ogs_assert((__sESS)->transfer.__n2Type); \
} while(0);
#define AMF_SESS_CLEAR_N2_TRANSFER(__sESS, __n2Type) \
do { \
if ((__sESS)->transfer.__n2Type) \
ogs_pkbuf_free((__sESS)->transfer.__n2Type); \
(__sESS)->transfer.__n2Type = NULL; \
} while(0);
#define AMF_UE_CLEAR_N2_TRANSFER(__aMF, __n2Type) \
do { \
amf_sess_t *sess = NULL; \
ogs_list_for_each(&((__aMF)->sess_list), sess) { \
AMF_SESS_CLEAR_N2_TRANSFER(sess, __n2Type) \
} \
} while(0);
struct {
/* Paging Ongoing */
bool ongoing;
/* Location in N1N2MessageTransferRspData */
char *location;
/* last Received n1-n2-trasfer-failure-notification-uri from SMF */
char *n1n2_failure_txf_notif_uri;
/* notification client */
ogs_sbi_client_t *client;
} paging;
#define AMF_SESS_STORE_PAGING_INFO(__sESS, __lOCATION, __uRI) \
do { \
ogs_assert(__sESS); \
ogs_assert(__lOCATION); \
AMF_SESS_CLEAR_PAGING_INFO(__sESS) \
(__sESS)->paging.ongoing = true; \
((__sESS)->paging.location) = ogs_strdup(__lOCATION); \
ogs_assert((__sESS)->paging.location); \
if (__uRI) { \
((__sESS)->paging.n1n2_failure_txf_notif_uri) = ogs_strdup(__uRI); \
ogs_assert((__sESS)->paging.n1n2_failure_txf_notif_uri); \
} \
} while(0);
#define AMF_SESS_CLEAR_PAGING_INFO(__sESS) \
do { \
if ((__sESS)->paging.ongoing == true) { \
ogs_assert((__sESS)->paging.location); \
ogs_free((__sESS)->paging.location); \
((__sESS)->paging.location) = NULL; \
if ((__sESS)->paging.n1n2_failure_txf_notif_uri) { \
ogs_free((__sESS)->paging.n1n2_failure_txf_notif_uri); \
((__sESS)->paging.n1n2_failure_txf_notif_uri) = NULL; \
} \
((__sESS)->paging.ongoing) = false; \
} \
} while(0);
#define AMF_UE_CLEAR_PAGING_INFO(__aMF) \
do { \
amf_sess_t *sess = NULL; \
ogs_list_for_each(&((__aMF)->sess_list), sess) { \
AMF_SESS_CLEAR_PAGING_INFO(sess); \
} \
} while(0);
struct {
uint8_t type;
ogs_pkbuf_t *n1buf;
ogs_pkbuf_t *n2buf;
} gsm_message;
#define AMF_SESS_STORE_5GSM_MESSAGE(__sESS, __tYPE, __n1Buf, __n2Buf) \
do { \
amf_ue_t *amf_ue = NULL; \
ogs_assert(__sESS); \
amf_ue = amf_ue_find_by_id((__sESS)->amf_ue_id); \
if ((__sESS)->gsm_message.n1buf) { \
if (amf_ue) \
ogs_warn("[%s:%d] N1 message duplicated. Overwritten", \
amf_ue->supi, (__sESS)->psi); \
ogs_pkbuf_free((__sESS)->gsm_message.n1buf); \
} \
(__sESS)->gsm_message.n1buf = __n1Buf; \
\
if ((__sESS)->gsm_message.n2buf) { \
if (amf_ue) \
ogs_warn("[%s:%d] N2 message duplicated. Overwritten", \
amf_ue->supi, (__sESS)->psi); \
ogs_pkbuf_free((__sESS)->gsm_message.n2buf); \
} \
(__sESS)->gsm_message.n2buf = __n2Buf; \
\
ogs_assert((__sESS)->gsm_message.n2buf); \
\
(__sESS)->gsm_message.type = __tYPE; \
} while(0);
#define AMF_SESS_CLEAR_5GSM_MESSAGE(__sESS) \
do { \
if ((__sESS)->gsm_message.n1buf) \
ogs_pkbuf_free((__sESS)->gsm_message.n1buf); \
(__sESS)->gsm_message.n1buf = NULL; \
if ((__sESS)->gsm_message.n2buf) \
ogs_pkbuf_free((__sESS)->gsm_message.n2buf); \
(__sESS)->gsm_message.n2buf = NULL; \
(__sESS)->gsm_message.type = 0; \
} while(0);
#define AMF_UE_CLEAR_5GSM_MESSAGE(__aMF) \
do { \
amf_sess_t *sess = NULL; \
ogs_list_for_each(&((__aMF)->sess_list), sess) { \
AMF_SESS_CLEAR_5GSM_MESSAGE(sess) \
} \
} while(0);
struct {
char *nsi_id;
struct {
char *id;
ogs_sbi_client_t *client;
} nrf;
} nssf;
/* last payload for sending back to the UE */
uint8_t payload_container_type;
ogs_pkbuf_t *payload_container;
/* amf_bearer_first(sess) : Default Bearer Context */
ogs_list_t bearer_list;
/* Related Context */
ogs_pool_id_t amf_ue_id;
ogs_pool_id_t ran_ue_id;
ogs_s_nssai_t s_nssai;
ogs_s_nssai_t mapped_hplmn;
char *dnn;
} amf_sess_t;
void amf_context_init(void);
void amf_context_final(void);
amf_context_t *amf_self(void);
int amf_context_parse_config(void);
int amf_context_nf_info(void);
amf_gnb_t *amf_gnb_add(ogs_sock_t *sock, ogs_sockaddr_t *addr);
void amf_gnb_remove(amf_gnb_t *gnb);
void amf_gnb_remove_all(void);
amf_gnb_t *amf_gnb_find_by_addr(ogs_sockaddr_t *addr);
amf_gnb_t *amf_gnb_find_by_gnb_id(uint32_t gnb_id);
int amf_gnb_set_gnb_id(amf_gnb_t *gnb, uint32_t gnb_id);
int amf_gnb_sock_type(ogs_sock_t *sock);
amf_gnb_t *amf_gnb_find_by_id(ogs_pool_id_t id);
ran_ue_t *ran_ue_add(amf_gnb_t *gnb, uint64_t ran_ue_ngap_id);
void ran_ue_remove(ran_ue_t *ran_ue);
void ran_ue_switch_to_gnb(ran_ue_t *ran_ue, amf_gnb_t *new_gnb);
ran_ue_t *ran_ue_find_by_ran_ue_ngap_id(
amf_gnb_t *gnb, uint64_t ran_ue_ngap_id);
ran_ue_t *ran_ue_find(uint32_t index);
ran_ue_t *ran_ue_find_by_amf_ue_ngap_id(uint64_t amf_ue_ngap_id);
ran_ue_t *ran_ue_find_by_id(ogs_pool_id_t id);
void amf_ue_new_guti(amf_ue_t *amf_ue);
void amf_ue_confirm_guti(amf_ue_t *amf_ue);
amf_ue_t *amf_ue_add(ran_ue_t *ran_ue);
void amf_ue_remove(amf_ue_t *amf_ue);
void amf_ue_remove_all(void);
void amf_ue_fsm_init(amf_ue_t *amf_ue);
void amf_ue_fsm_fini(amf_ue_t *amf_ue);
amf_ue_t *amf_ue_find_by_guti(ogs_nas_5gs_guti_t *nas_guti);
amf_ue_t *amf_ue_find_by_suci(char *suci);
amf_ue_t *amf_ue_find_by_supi(char *supi);
amf_ue_t *amf_ue_find_by_ue_context_id(char *ue_context_id);
amf_ue_t *amf_ue_find_by_message(ogs_nas_5gs_message_t *message);
void amf_ue_set_suci(amf_ue_t *amf_ue,
ogs_nas_5gs_mobile_identity_t *mobile_identity);
void amf_ue_set_supi(amf_ue_t *amf_ue, char *supi);
OpenAPI_rat_type_e amf_ue_rat_type(amf_ue_t *amf_ue);
/*
* o RECV Initial UE-Message : S-TMSI
* o RECV Attach Request : IMSI, GUTI
* o RECV TAU Request : GUTI
* ### AMF_UE_ASSOCIATE_GNB_UE() ###
* ### AMF_UE_ECM_CONNECTED() ###
*
* o RECV Initial Context Setup Failure in EMM Registered State
* ### AMF_UE_DEASSOCIATE_GNB_UE() ###
* ### GNB_UE_REMOVE() ###
* ### AMF_UE_DEASSOCIATE() ###
*
* o SEND UE Context Release Command with NO_ACTION
* - RECV UE Context Release Complete
* ### GNB_UE_REMOVE() ###
* ### AMF_UE_DEASSOCIATE() ###
*
* o SEND UE Context Release Command with REMOVE_AMF_UE_CONTEXT
* - RECV UE Context Release Complete
* ### GNB_UE_REMOVE() ###
* ### AMF_UE_REMOVE() ###
*
*
* o RECV Handover Required
* ### SOURCE_UE_ASSOCIATE_TARGET_UE() ####
* - SEND Handover Request
*
* o RECV Handover Notify
* ### AMF_UE_ASSOCIATE_GNB_UE(TARGET) ###
* ### AMF_UE_ECM_CONNECTED(TARGET) ###
* - Modify Bearer Request/Response
* - UE Context Release Command/Complete
* ### SOURCE_UE_DEASSOCIATE_TARGET_UE() ####
* ### GNB_UE_REMOVE() ####
* - Delete Indirect Data Forwarding Tunnel Request/Response
*
* o RECV Handover Cancel
* - UE Context Release Command/Complete
* ### SOURCE_UE_DEASSOCIATE_TARGET_UE() ####
* ### GNB_UE_REMOVE() ####
* - Delete Indirect Data Forwarding Tunnel Request/Response
*
* o RECV Handover Failure
* - UE Context Release Command/Complete
* ### SOURCE_UE_DEASSOCIATE_TARGET_UE() ####
* ### GNB_UE_REMOVE() ####
* - Delete Indirect Data Forwarding Tunnel Request/Response
*/
void amf_ue_associate_ran_ue(amf_ue_t *amf_ue, ran_ue_t *ran_ue);
void ran_ue_deassociate(ran_ue_t *ran_ue);
void amf_ue_deassociate(amf_ue_t *amf_ue);
void source_ue_associate_target_ue(ran_ue_t *source_ue, ran_ue_t *target_ue);
void source_ue_deassociate_target_ue(ran_ue_t *ran_ue);
amf_sess_t *amf_sess_add(amf_ue_t *amf_ue, uint8_t psi);
/*
* If there is SBI transaction,
* we will not remove session context at this point.
*/
#define AMF_SESS_CLEAR(__sESS) \
do { \
ogs_sbi_object_t *sbi_object = NULL; \
ogs_assert(__sESS); \
sbi_object = &(__sESS)->sbi; \
ogs_assert(sbi_object); \
\
if (ogs_list_count(&sbi_object->xact_list)) { \
ogs_error("SBI running [%d]", \
ogs_list_count(&sbi_object->xact_list)); \
} else { \
amf_sess_remove(__sESS); \
} \
} while(0)
void amf_sess_remove(amf_sess_t *sess);
void amf_sess_remove_all(amf_ue_t *amf_ue);
amf_sess_t *amf_sess_find_by_psi(amf_ue_t *amf_ue, uint8_t psi);
amf_sess_t *amf_sess_find_by_dnn(amf_ue_t *amf_ue, char *dnn);
amf_ue_t *amf_ue_find_by_id(ogs_pool_id_t id);
amf_sess_t *amf_sess_find_by_id(ogs_pool_id_t id);
void amf_sbi_select_nf(
ogs_sbi_object_t *sbi_object,
ogs_sbi_service_type_e service_type,
OpenAPI_nf_type_e requester_nf_type,
ogs_sbi_discovery_option_t *discovery_option);
#define AMF_SESSION_SYNC_DONE(__aMF, __sTATE) \
(amf_sess_xact_state_count(__aMF, __sTATE) == 0)
int amf_sess_xact_count(amf_ue_t *amf_ue);
int amf_sess_xact_state_count(amf_ue_t *amf_ue, int state);
#define AMF_SESSION_RELEASE_PENDING(__aMF) \
(amf_ue_have_session_release_pending(__aMF) == true)
#define PDU_RES_SETUP_REQ_TRANSFER_NEEDED(__aMF) \
(amf_pdu_res_setup_req_transfer_needed(__aMF) == true)
bool amf_pdu_res_setup_req_transfer_needed(amf_ue_t *amf_ue);
#define HANDOVER_REQUEST_TRANSFER_NEEDED(__aMF) \
(amf_handover_request_transfer_needed(__aMF) == true)
bool amf_handover_request_transfer_needed(amf_ue_t *amf_ue);
#define PAGING_ONGOING(__aMF) \
(amf_paging_ongoing(__aMF) == true)
bool amf_paging_ongoing(amf_ue_t *amf_ue);
#define DOWNLINK_SIGNALLING_PENDING(__aMF) \
(amf_downlink_signalling_pending(__aMF) == true)
bool amf_downlink_signalling_pending(amf_ue_t *amf_ue);
int amf_find_served_tai(ogs_5gs_tai_t *nr_tai);
ogs_s_nssai_t *amf_find_s_nssai(
ogs_plmn_id_t *served_plmn_id, ogs_s_nssai_t *s_nssai);
amf_m_tmsi_t *amf_m_tmsi_alloc(void);
int amf_m_tmsi_free(amf_m_tmsi_t *tmsi);
uint8_t amf_selected_int_algorithm(amf_ue_t *amf_ue);
uint8_t amf_selected_enc_algorithm(amf_ue_t *amf_ue);
void amf_clear_subscribed_info(amf_ue_t *amf_ue);
bool amf_update_allowed_nssai(amf_ue_t *amf_ue);
bool amf_ue_is_rat_restricted(amf_ue_t *amf_ue);
int amf_instance_get_load(void);
#ifdef __cplusplus
}
#endif
#endif /* AMF_CONTEXT_H */
|