Robert Schmidt
0b91791f67
OAI is riddled with boolean_t, FALSE, TRUE, etc. This makes no sense, as there is a standard bool type, and could lead to nasty bugs if a definition of a bool is non-standard (0 == false, true == !false). This commit removes all non-standard bools in the whole project.
475 lines
20 KiB
C
475 lines
20 KiB
C
/*
|
|
* 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
|
|
*/
|
|
|
|
/*****************************************************************************
|
|
Source Detach.c
|
|
|
|
Version 0.1
|
|
|
|
Date 2013/05/07
|
|
|
|
Product NAS stack
|
|
|
|
Subsystem EPS Mobility Management
|
|
|
|
Author Frederic Maurel
|
|
|
|
Description Defines the detach related EMM procedure executed by the
|
|
Non-Access Stratum.
|
|
|
|
The detach procedure is used by the UE to detach for EPS servi-
|
|
ces, to disconnect from the last PDN it is connected to; by the
|
|
network to inform the UE that it is detached for EPS services
|
|
or non-EPS services or both, to disconnect the UE from the last
|
|
PDN to which it is connected and to inform the UE to re-attach
|
|
to the network and re-establish all PDN connections.
|
|
|
|
*****************************************************************************/
|
|
|
|
#include "emm_proc.h"
|
|
#include "nas_log.h"
|
|
#include "nas_timer.h"
|
|
|
|
#include "emmData.h"
|
|
#include "emm_timers.h"
|
|
|
|
#include "emm_sap.h"
|
|
#include "esm_sap.h"
|
|
|
|
#include <stdlib.h> // free
|
|
|
|
/****************************************************************************/
|
|
/**************** E X T E R N A L D E F I N I T I O N S ****************/
|
|
/****************************************************************************/
|
|
|
|
/****************************************************************************/
|
|
/******************* L O C A L D E F I N I T I O N S *******************/
|
|
/****************************************************************************/
|
|
|
|
/* String representation of the detach type */
|
|
char *emm_detach_type2str(int type) {
|
|
static char *_emm_detach_type_str[] = {
|
|
"EPS", "IMSI", "EPS/IMSI",
|
|
"RE-ATTACH REQUIRED", "RE-ATTACH NOT REQUIRED", "RESERVED"
|
|
};
|
|
return _emm_detach_type_str[type];
|
|
}
|
|
/*
|
|
* --------------------------------------------------------------------------
|
|
* Internal data handled by the detach procedure in the UE
|
|
* --------------------------------------------------------------------------
|
|
*/
|
|
|
|
/*
|
|
* Abnormal case detach procedures
|
|
*/
|
|
static int _emm_detach_abort(nas_user_t *user, emm_proc_detach_type_t type);
|
|
|
|
/****************************************************************************/
|
|
/****************** E X P O R T E D F U N C T I O N S ******************/
|
|
/****************************************************************************/
|
|
|
|
/*
|
|
* --------------------------------------------------------------------------
|
|
* Detach procedure executed by the UE
|
|
* --------------------------------------------------------------------------
|
|
*/
|
|
/****************************************************************************
|
|
** **
|
|
** Name: emm_proc_detach() **
|
|
** **
|
|
** Description: Initiates the detach procedure in order for the UE to de- **
|
|
** tach for EPS services. **
|
|
** **
|
|
** 3GPP TS 24.301, section 5.5.2.2.1 **
|
|
** In state EMM-REGISTERED or EMM-REGISTERED-INITIATED, the **
|
|
** UE initiates the detach procedure by sending a DETACH RE- **
|
|
** QUEST message to the network, starting timer T3421 and **
|
|
** entering state EMM-DEREGISTERED-INITIATED. **
|
|
** **
|
|
** Inputs: type: Type of the requested detach **
|
|
** switch_off: Indicates whether the detach is required **
|
|
** because the UE is switched off or not **
|
|
** Others: user->emm_data-> **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: RETURNok, RETURNerror **
|
|
** **
|
|
***************************************************************************/
|
|
int emm_proc_detach(nas_user_t *user, emm_proc_detach_type_t type, bool switch_off)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
emm_sap_t emm_sap;
|
|
emm_as_data_t *emm_as = &emm_sap.u.emm_as.u.data;
|
|
emm_detach_data_t *emm_detach_data = user->emm_data->emm_detach_data;
|
|
int rc;
|
|
|
|
LOG_TRACE(INFO, "EMM-PROC - Initiate EPS detach type = %s (%d)",
|
|
emm_detach_type2str(type), type);
|
|
|
|
/* Initialize the detach procedure internal data */
|
|
emm_detach_data->count = 0;
|
|
emm_detach_data->switch_off = switch_off;
|
|
emm_detach_data->type = type;
|
|
|
|
/* Setup EMM procedure handler to be executed upon receiving
|
|
* lower layer notification */
|
|
rc = emm_proc_lowerlayer_initialize(user->lowerlayer_data, emm_proc_detach_request,
|
|
emm_proc_detach_failure,
|
|
emm_proc_detach_release, user);
|
|
|
|
if (rc != RETURNok) {
|
|
LOG_TRACE(WARNING, "Failed to initialize EMM procedure handler");
|
|
LOG_FUNC_RETURN (RETURNerror);
|
|
}
|
|
|
|
/* Setup NAS information message to transfer */
|
|
emm_as->NASinfo = EMM_AS_NAS_INFO_DETACH;
|
|
emm_as->NASmsg.length = 0;
|
|
emm_as->NASmsg.value = NULL;
|
|
/* Set the detach type */
|
|
emm_as->type = type;
|
|
/* Set the switch-off indicator */
|
|
emm_as->switch_off = switch_off;
|
|
/* Set the EPS mobile identity */
|
|
emm_as->guti = user->emm_data->guti;
|
|
emm_as->ueid = user->ueid;
|
|
/* Setup EPS NAS security data */
|
|
emm_as_set_security_data(&emm_as->sctx, user->emm_data->security, false, true);
|
|
|
|
/*
|
|
* Notify EMM-AS SAP that Detach Request message has to
|
|
* be sent to the network
|
|
*/
|
|
emm_sap.primitive = EMMAS_DATA_REQ;
|
|
rc = emm_sap_send(user, &emm_sap);
|
|
|
|
LOG_FUNC_RETURN(rc);
|
|
}
|
|
|
|
/****************************************************************************
|
|
** **
|
|
** Name: emm_proc_detach_request() **
|
|
** **
|
|
** Description: Performs the detach procedure upon receipt of indication **
|
|
** from lower layers that Detach Request message has been **
|
|
** successfully delivered to the network. **
|
|
** **
|
|
** Inputs: args: Not used **
|
|
** Others: None **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: RETURNok, RETURNerror **
|
|
** Others: T3421 **
|
|
** **
|
|
***************************************************************************/
|
|
int emm_proc_detach_request(void *args)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
nas_user_t *user = args;
|
|
emm_timers_t *emm_timers = user->emm_data->emm_timers;
|
|
emm_detach_data_t *emm_detach_data = user->emm_data->emm_detach_data;
|
|
emm_sap_t emm_sap;
|
|
int rc;
|
|
|
|
if ( !emm_detach_data->switch_off ) {
|
|
/* Start T3421 timer */
|
|
emm_timers->T3421.id = nas_timer_start(emm_timers->T3421.sec, emm_detach_t3421_handler, user);
|
|
LOG_TRACE(INFO, "EMM-PROC - Timer T3421 (%d) expires in %ld seconds",
|
|
emm_timers->T3421.id, emm_timers->T3421.sec);
|
|
}
|
|
|
|
/*
|
|
* Notify EMM that Detach Request has been sent to the network
|
|
*/
|
|
emm_sap.primitive = EMMREG_DETACH_REQ;
|
|
rc = emm_sap_send(user, &emm_sap);
|
|
|
|
LOG_FUNC_RETURN(rc);
|
|
}
|
|
|
|
/****************************************************************************
|
|
** **
|
|
** Name: emm_proc_detach_accept() **
|
|
** **
|
|
** Description: Performs the UE initiated detach procedure for EPS servi- **
|
|
** ces only When the DETACH ACCEPT message is received from **
|
|
** the network. **
|
|
** **
|
|
** 3GPP TS 24.301, section 5.5.2.2.2 **
|
|
** Upon receiving the DETACH ACCEPT message, the UE shall **
|
|
** stop timer T3421, locally deactivate all EPS bearer con- **
|
|
** texts without peer-to-peer signalling and enter state EMM-**
|
|
** DEREGISTERED. **
|
|
** **
|
|
** Inputs: None **
|
|
** Others: None **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: RETURNok, RETURNerror **
|
|
** Others: T3421 **
|
|
** **
|
|
***************************************************************************/
|
|
int emm_proc_detach_accept(void* args)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
nas_user_t *user=args;
|
|
emm_timers_t *emm_timers = user->emm_data->emm_timers;
|
|
int rc;
|
|
|
|
LOG_TRACE(INFO, "EMM-PROC - UE initiated detach procedure completion");
|
|
|
|
/* Reset EMM procedure handler */
|
|
(void) emm_proc_lowerlayer_initialize(user->lowerlayer_data, NULL, NULL, NULL, NULL);
|
|
|
|
/* Stop timer T3421 */
|
|
emm_timers->T3421.id = nas_timer_stop(emm_timers->T3421.id);
|
|
|
|
/*
|
|
* Notify ESM that all EPS bearer contexts have to be locally deactivated
|
|
*/
|
|
esm_sap_t esm_sap;
|
|
esm_sap.primitive = ESM_EPS_BEARER_CONTEXT_DEACTIVATE_REQ;
|
|
esm_sap.data.eps_bearer_context_deactivate.ebi = ESM_SAP_ALL_EBI;
|
|
rc = esm_sap_send(user, &esm_sap);
|
|
|
|
/*
|
|
* XXX - Upon receiving notification from ESM that all EPS bearer
|
|
* contexts are locally deactivated, the UE is considered as
|
|
* detached from the network and is entered state EMM-DEREGISTERED
|
|
*/
|
|
LOG_FUNC_RETURN(rc);
|
|
}
|
|
|
|
/****************************************************************************
|
|
** **
|
|
** Name: emm_proc_detach_failure() **
|
|
** **
|
|
** Description: Performs the detach procedure abnormal case upon receipt **
|
|
** of transmission failure of Detach Request message. **
|
|
** **
|
|
** 3GPP TS 24.301, section 5.5.2.2.4, case h **
|
|
** The UE shall restart the detach procedure. **
|
|
** **
|
|
** Inputs: is_initial: Not used **
|
|
** args: Not used **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: RETURNok, RETURNerror **
|
|
** Others: None **
|
|
** **
|
|
***************************************************************************/
|
|
int emm_proc_detach_failure(bool is_initial, void *args)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
nas_user_t *user = args;
|
|
emm_detach_data_t *emm_detach_data = user->emm_data->emm_detach_data;
|
|
emm_timers_t *emm_timers = user->emm_data->emm_timers;
|
|
emm_sap_t emm_sap;
|
|
int rc;
|
|
|
|
LOG_TRACE(WARNING, "EMM-PROC - Network detach failure");
|
|
|
|
/* Reset EMM procedure handler */
|
|
(void) emm_proc_lowerlayer_initialize(user->lowerlayer_data, NULL, NULL, NULL, NULL);
|
|
|
|
/* Stop timer T3421 */
|
|
emm_timers->T3421.id = nas_timer_stop(emm_timers->T3421.id);
|
|
|
|
/*
|
|
* Notify EMM that detach procedure has to be restarted
|
|
*/
|
|
emm_sap.primitive = EMMREG_DETACH_INIT;
|
|
emm_sap.u.emm_reg.u.detach.switch_off = emm_detach_data->switch_off;
|
|
rc = emm_sap_send(user, &emm_sap);
|
|
|
|
LOG_FUNC_RETURN(rc);
|
|
}
|
|
|
|
/****************************************************************************
|
|
** **
|
|
** Name: emm_proc_detach_release() **
|
|
** **
|
|
** Description: Performs the detach procedure abnormal case upon receipt **
|
|
** of NAS signalling connection release indication before **
|
|
** reception of Detach Accept message. **
|
|
** **
|
|
** 3GPP TS 24.301, section 5.5.2.2.4, case b **
|
|
** The detach procedure shall be aborted. **
|
|
** **
|
|
** Inputs: args: not used **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: RETURNok, RETURNerror **
|
|
** Others: None **
|
|
** **
|
|
***************************************************************************/
|
|
int emm_proc_detach_release(void *args)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
LOG_TRACE(WARNING, "EMM-PROC - NAS signalling connection released");
|
|
|
|
nas_user_t *user = args;
|
|
emm_detach_data_t *emm_detach_data = user->emm_data->emm_detach_data;
|
|
/* Abort the detach procedure */
|
|
int rc = _emm_detach_abort(user, emm_detach_data->type);
|
|
|
|
LOG_FUNC_RETURN(rc);
|
|
}
|
|
|
|
|
|
/****************************************************************************/
|
|
/********************* L O C A L F U N C T I O N S *********************/
|
|
/****************************************************************************/
|
|
|
|
/*
|
|
* --------------------------------------------------------------------------
|
|
* Timer handlers
|
|
* --------------------------------------------------------------------------
|
|
*/
|
|
|
|
/****************************************************************************
|
|
** **
|
|
** Name: _emm_detach_t3421_handler() **
|
|
** **
|
|
** Description: T3421 timeout handler **
|
|
** **
|
|
** 3GPP TS 24.301, section 5.5.2.2.4 case c **
|
|
** On the first four expiries of the timer, the UE shall re- **
|
|
** transmit the DETACH REQUEST message and shall reset and **
|
|
** restart timer emm_timers->T3421. On the fifth expiry of timer T3421, **
|
|
** the detach procedure shall be aborted. **
|
|
** **
|
|
** Inputs: args: handler parameters **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: None **
|
|
** Others: None **
|
|
** **
|
|
***************************************************************************/
|
|
void *emm_detach_t3421_handler(void *args)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
nas_user_t *user = args;
|
|
emm_detach_data_t *emm_detach_data = user->emm_data->emm_detach_data;
|
|
emm_timers_t *emm_timers = user->emm_data->emm_timers;
|
|
int rc;
|
|
|
|
/* Increment the retransmission counter */
|
|
emm_detach_data->count += 1;
|
|
|
|
LOG_TRACE(WARNING, "EMM-PROC - T3421 timer expired, "
|
|
"retransmission counter = %d", emm_detach_data->count);
|
|
|
|
if (emm_detach_data->count < EMM_DETACH_COUNTER_MAX) {
|
|
/* Retransmit the Detach Request message */
|
|
emm_sap_t emm_sap;
|
|
emm_as_data_t *emm_as = &emm_sap.u.emm_as.u.data;
|
|
|
|
/* Stop timer T3421 */
|
|
emm_timers->T3421.id = nas_timer_stop(emm_timers->T3421.id);
|
|
|
|
/* Setup NAS information message to transfer */
|
|
emm_as->NASinfo = EMM_AS_NAS_INFO_DETACH;
|
|
emm_as->NASmsg.length = 0;
|
|
emm_as->NASmsg.value = NULL;
|
|
/* Set the detach type */
|
|
emm_as->type = emm_detach_data->type;
|
|
/* Set the switch-off indicator */
|
|
emm_as->switch_off = emm_detach_data->switch_off;
|
|
/* Set the EPS mobile identity */
|
|
emm_as->guti = user->emm_data->guti;
|
|
emm_as->ueid = user->ueid;
|
|
/* Setup EPS NAS security data */
|
|
emm_as_set_security_data(&emm_as->sctx, user->emm_data->security, false, true);
|
|
|
|
/*
|
|
* Notify EMM-AS SAP that Detach Request message has to
|
|
* be sent to the network
|
|
*/
|
|
emm_sap.primitive = EMMAS_DATA_REQ;
|
|
rc = emm_sap_send(user, &emm_sap);
|
|
|
|
if (rc != RETURNerror) {
|
|
/* Start T3421 timer */
|
|
emm_timers->T3421.id = nas_timer_start(emm_timers->T3421.sec, emm_detach_t3421_handler, user);
|
|
LOG_TRACE(INFO, "EMM-PROC - Timer T3421 (%d) expires in %ld "
|
|
"seconds", emm_timers->T3421.id, emm_timers->T3421.sec);
|
|
}
|
|
} else {
|
|
/* Abort the detach procedure */
|
|
rc = _emm_detach_abort(user, emm_detach_data->type);
|
|
}
|
|
|
|
LOG_FUNC_RETURN(NULL);
|
|
}
|
|
|
|
/*
|
|
* --------------------------------------------------------------------------
|
|
* Abnormal cases in the UE
|
|
* --------------------------------------------------------------------------
|
|
*/
|
|
|
|
/****************************************************************************
|
|
** **
|
|
** Name: _emm_detach_abort() **
|
|
** **
|
|
** Description: Aborts the detach procedure **
|
|
** **
|
|
** Inputs: type: not used **
|
|
** **
|
|
** Outputs: None **
|
|
** Return: RETURNok, RETURNerror **
|
|
** Others: T3421 **
|
|
** **
|
|
***************************************************************************/
|
|
static int _emm_detach_abort(nas_user_t *user, emm_proc_detach_type_t type)
|
|
{
|
|
LOG_FUNC_IN;
|
|
|
|
emm_timers_t *emm_timers = user->emm_data->emm_timers;
|
|
emm_sap_t emm_sap;
|
|
int rc ;
|
|
|
|
LOG_TRACE(WARNING, "EMM-PROC - Abort the detach procedure");
|
|
|
|
/* Reset EMM procedure handler */
|
|
emm_proc_lowerlayer_initialize(user->lowerlayer_data, NULL, NULL, NULL, NULL);
|
|
|
|
/* Stop timer T3421 */
|
|
emm_timers->T3421.id = nas_timer_stop(emm_timers->T3421.id);
|
|
|
|
/*
|
|
* Notify EMM that detach procedure failed
|
|
*/
|
|
emm_sap.primitive = EMMREG_DETACH_FAILED;
|
|
emm_sap.u.emm_reg.u.detach.type = type;
|
|
rc = emm_sap_send(user, &emm_sap);
|
|
|
|
LOG_FUNC_RETURN (rc);
|
|
}
|