Registration state (including changes in capable/available features) with duration shorter * than this will be ignored as they are considered transient states. */ private static final long MIN_REGISTRATION_DURATION_MILLIS = 1L * SECOND_IN_MILLIS; /** * Maximum length of the extra message in the termination reason. * *
If the extra message is longer than this length, it will be truncated.
*/
private static final int MAX_EXTRA_MESSAGE_LENGTH = 128;
/** Pattern used to match UUIDs in IMS extra messages for filtering. */
private static final Pattern PATTERN_UUID =
Pattern.compile(
"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}");
/** Replacement for UUIDs. */
private static final String REPLACEMENT_UUID = " NOTE: this simple pattern aims to catch the most common URI schemes. It is not meant to be
* RFC-complaint.
*/
private static final Pattern PATTERN_URI =
Pattern.compile("([a-zA-Z]{2,}:)" + EMAIL_ADDRESS.pattern());
/** Replacement for URI. */
private static final String REPLACEMENT_URI = "$1 This is a copy of {@code android.util.Patterns.IP_ADDRESS}, which is deprecated and might
* be removed in the future.
*/
private static final Pattern PATTERN_IPV4 =
Pattern.compile(
"((25[0-5]|2[0-4][0-9]|[0-1][0-9]{2}|[1-9][0-9]|[1-9])\\.(25[0-5]|2[0-4]"
+ "[0-9]|[0-1][0-9]{2}|[1-9][0-9]|[1-9]|0)\\.(25[0-5]|2[0-4][0-9]|[0-1]"
+ "[0-9]{2}|[1-9][0-9]|[1-9]|0)\\.(25[0-5]|2[0-4][0-9]|[0-1][0-9]{2}"
+ "|[1-9][0-9]|[0-9]))");
/** Replacement for IPv4 addresses. */
private static final String REPLACEMENT_IPV4 = " NOTE: this pattern aims to catch the most common IPv6 addresses. It is not meant to be
* RFC-complaint or free of false positives.
*/
private static final Pattern PATTERN_IPV6 =
Pattern.compile(
// Full address
"([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}"
// Abbreviated address, e.g. 2001:4860:4860::8888
+ "|([0-9a-fA-F]{1,4}:){1,6}(:[0-9a-fA-F]{1,4}){1,6}"
// Abbreviated network address, e.g. 2607:F8B0::
+ "|([0-9a-fA-F]{1,4}:){1,7}:"
// Abbreviated address, e.g. ::1
+ "|:(:[0-9a-fA-F]{1,4}){1,7}");
/** Replacement for IPv6 addresses. */
private static final String REPLACEMENT_IPV6 = " This includes segmented IMEI or IMEI/SV, as well as unsegmented IMEI/SV.
*/
private static final Pattern PATTERN_IMEI =
Pattern.compile(
"(^|[^0-9])(?:"
// IMEI, AABBBBBB-CCCCCC-D format; IMEI/SV, AABBBBBB-CCCCCC-EE format
+ "[0-9]{8}-[0-9]{6}-[0-9][0-9]?"
// IMEI, AA-BBBBBB-CCCCCC-D format; IMEI/SV, AA-BBBBBB-CCCCCC-EE format
+ "|[0-9]{2}-[0-9]{6}-[0-9]{6}-[0-9][0-9]?"
// IMEI/SV, unsegmented
+ "|[0-9]{16}"
+ ")($|[^0-9])");
/** Replacement for IMEI. */
private static final String REPLACEMENT_IMEI = "$1 This pattern differs from {@link android.util.Patterns.DOMAIN_NAME} in a few ways: it
* requires the name to have at least 3 segments (shorter names are nearly always public or
* typos, i.e. missing space after period), does not check the validity of TLDs, and does not
* support punycodes in TLDs.
*/
private static final Pattern PATTERN_HOSTNAME =
Pattern.compile("([0-9a-zA-Z][0-9a-zA-Z_\\-]{0,61}[0-9a-zA-Z]\\.){2,}[a-zA-Z]{2,}");
/** Replacement for hostnames. */
private static final String REPLACEMENT_HOSTNAME = " This pattern target numbers that are potential IDs in unknown formats. It should be
* replaced after all other replacements are done to ensure complete and correct filtering.
*
* Specifically, this pattern looks for any number (including hex) that is separated by dots
* or dashes has at least 6 significant digits, and any unsegmented numbers that has at least 5
* significant digits.
*/
private static final Pattern PATTERN_UNKNOWN_ID =
Pattern.compile(
"(^|[^0-9a-fA-F])(([-\\.]?0)*[1-9a-fA-F]([-\\.]?[0-9a-fA-F]){5,}"
+ "|0*[1-9a-fA-F]([0-9a-fA-F]){4,})");
/** Replacement for potential IDs. */
private static final String REPLACEMENT_UNKNOWN_ID = "$1 This method is also invoked whenever the registration state, feature capability, or
* feature availability changes.
*/
public synchronized void conclude() {
long now = getTimeMillis();
long duration = now - mLastTimestamp;
if (duration < MIN_REGISTRATION_DURATION_MILLIS) {
logw("conclude: discarding transient stats, duration=%d", duration);
} else {
ImsRegistrationStats stats = copyOfDimensionsOnly(mLastRegistrationStats);
if (stats.rat == TelephonyManager.NETWORK_TYPE_UNKNOWN) {
logw("conclude: discarding UNKNOWN RAT, duration=%d", duration);
mLastTimestamp = now;
return;
}
stats.registeredTimes = mLastRegistrationStats.registeredTimes;
// initialize registeredTimes after copying mLastRegistrationStats to be updated
mLastRegistrationStats.registeredTimes = 0;
switch (mLastRegistrationState) {
case REGISTRATION_STATE_REGISTERED:
stats.registeredMillis = duration;
stats.voiceAvailableMillis =
mLastAvailableFeatures.isCapable(CAPABILITY_TYPE_VOICE) ? duration : 0;
stats.videoAvailableMillis =
mLastAvailableFeatures.isCapable(CAPABILITY_TYPE_VIDEO) ? duration : 0;
stats.utAvailableMillis =
mLastAvailableFeatures.isCapable(CAPABILITY_TYPE_UT) ? duration : 0;
stats.smsAvailableMillis =
mLastAvailableFeatures.isCapable(CAPABILITY_TYPE_SMS) ? duration : 0;
MmTelCapabilities lastCapableFeatures =
stats.rat == TelephonyManager.NETWORK_TYPE_IWLAN
? mLastWlanCapableFeatures
: mLastWwanCapableFeatures;
stats.voiceCapableMillis =
lastCapableFeatures.isCapable(CAPABILITY_TYPE_VOICE) ? duration : 0;
stats.videoCapableMillis =
lastCapableFeatures.isCapable(CAPABILITY_TYPE_VIDEO) ? duration : 0;
stats.utCapableMillis =
lastCapableFeatures.isCapable(CAPABILITY_TYPE_UT) ? duration : 0;
stats.smsCapableMillis =
lastCapableFeatures.isCapable(CAPABILITY_TYPE_SMS) ? duration : 0;
break;
case REGISTRATION_STATE_REGISTERING:
stats.registeringMillis = duration;
break;
case REGISTRATION_STATE_NOT_REGISTERED:
stats.unregisteredMillis = duration;
break;
}
mStorage.addImsRegistrationStats(stats);
}
mLastTimestamp = now;
}
/** Updates the stats when registered features changed. */
public synchronized void onImsCapabilitiesChanged(
@ImsRegistrationTech int radioTech, MmTelCapabilities capabilities) {
conclude();
boolean ratChanged = false;
@NetworkType int newRat = convertRegistrationTechToNetworkType(radioTech);
mLastTransportType =
(newRat == TelephonyManager.NETWORK_TYPE_IWLAN)
? AccessNetworkConstants.TRANSPORT_TYPE_WLAN
: AccessNetworkConstants.TRANSPORT_TYPE_WWAN;
if (mLastRegistrationStats.rat != newRat) {
mLastRegistrationStats.rat = newRat;
ratChanged = true;
}
mLastRegistrationStats.isIwlanCrossSim = radioTech == REGISTRATION_TECH_CROSS_SIM;
boolean voiceAvailableNow = capabilities.isCapable(CAPABILITY_TYPE_VOICE);
boolean voiceAvailabilityChanged =
(mLastAvailableFeatures.isCapable(CAPABILITY_TYPE_VOICE) != voiceAvailableNow);
mLastAvailableFeatures = capabilities;
// Notify voice RAT change if 1. RAT changed while voice over IMS is available, or 2. voice
// over IMS availability changed
if ((ratChanged && voiceAvailableNow) || voiceAvailabilityChanged) {
mPhone.getDefaultPhone().getServiceStateTracker().getServiceStateStats()
.onImsVoiceRegistrationChanged();
}
}
/** Updates the stats when capable features changed. */
public synchronized void onSetFeatureResponse(
@MmTelCapability int feature, @ImsRegistrationTech int network, int value) {
MmTelCapabilities lastCapableFeatures = getLastCapableFeaturesForTech(network);
if (lastCapableFeatures != null) {
conclude();
if (value == ProvisioningManager.PROVISIONING_VALUE_ENABLED) {
lastCapableFeatures.addCapabilities(feature);
} else {
lastCapableFeatures.removeCapabilities(feature);
}
}
}
/** Updates the stats when IMS registration is progressing. */
public synchronized void onImsRegistering(@TransportType int imsRadioTech) {
conclude();
mLastTransportType = imsRadioTech;
updateImsRegistrationStats();
mLastRegistrationStats.rat = convertTransportTypeToNetworkType(imsRadioTech);
mLastRegistrationState = REGISTRATION_STATE_REGISTERING;
}
/** Updates the stats when IMS registration succeeds. */
public synchronized void onImsRegistered(ImsRegistrationAttributes attributes) {
// Updates registered_times as soon as the UE is registered
if (mLastRegistrationState != REGISTRATION_STATE_REGISTERED) {
// RegistrationStats captures in every state. Changing REGISTERED state has to capture
// only once.
mLastRegistrationStats.registeredTimes = 1;
}
conclude();
mLastTransportType = attributes.getTransportType();
// NOTE: status can be unregistered (no registering phase)
if (mLastRegistrationState == REGISTRATION_STATE_NOT_REGISTERED) {
updateImsRegistrationStats();
}
mLastRegistrationStats.rat =
convertTransportTypeToNetworkType(attributes.getTransportType());
mLastRegistrationStats.isIwlanCrossSim = attributes.getRegistrationTechnology()
== REGISTRATION_TECH_CROSS_SIM;
mLastRegistrationState = REGISTRATION_STATE_REGISTERED;
}
/** Updates the stats and generates a termination atom when IMS registration fails/ends. */
public synchronized void onImsUnregistered(ImsReasonInfo reasonInfo) {
conclude();
// Generate end reason atom.
ImsRegistrationTermination termination = new ImsRegistrationTermination();
if (mLastRegistrationState != REGISTRATION_STATE_NOT_REGISTERED) {
termination.carrierId = mLastRegistrationStats.carrierId;
termination.ratAtEnd = getRatAtEnd(mLastRegistrationStats.rat);
termination.isIwlanCrossSim = mLastRegistrationStats.isIwlanCrossSim;
} else {
// if the registration state is from unregistered to unregistered.
termination.carrierId = mPhone.getDefaultPhone().getCarrierId();
}
termination.ratAtEnd = getRatAtEnd(mLastRegistrationStats.rat);
termination.isMultiSim = SimSlotState.isMultiSim();
termination.setupFailed = (mLastRegistrationState != REGISTRATION_STATE_REGISTERED);
termination.reasonCode = reasonInfo.getCode();
termination.extraCode = reasonInfo.getExtraCode();
termination.extraMessage = filterExtraMessage(reasonInfo.getExtraMessage());
termination.count = 1;
mStorage.addImsRegistrationTermination(termination);
// Reset state to unregistered.
mLastRegistrationState = REGISTRATION_STATE_NOT_REGISTERED;
mLastAvailableFeatures = new MmTelCapabilities();
}
/** Updates the RAT when service state changes. */
public synchronized void onServiceStateChanged(ServiceState state) {
conclude();
@NetworkType int newRat = state.getDataNetworkType();
MmTelCapabilities lastCapableFeatures = getLastCapableFeaturesForNetworkType(newRat);
if (lastCapableFeatures != null) {
mLastRegistrationStats.rat = newRat;
} else {
mLastRegistrationStats.rat = TelephonyManager.NETWORK_TYPE_UNKNOWN;
}
}
/**
* Returns the current RAT used for IMS voice registration, or {@link
* TelephonyManager#NETWORK_TYPE_UNKNOWN} if there isn't any.
*/
@NetworkType
public synchronized int getImsVoiceRadioTech() {
if (mLastRegistrationState == REGISTRATION_STATE_NOT_REGISTERED
|| !mLastAvailableFeatures.isCapable(CAPABILITY_TYPE_VOICE)) {
return TelephonyManager.NETWORK_TYPE_UNKNOWN;
}
return mLastRegistrationStats.rat;
}
@NetworkType
private int getRatAtEnd(@NetworkType int lastStateRat) {
return lastStateRat == TelephonyManager.NETWORK_TYPE_IWLAN ? lastStateRat : getWwanPsRat();
}
@NetworkType
private int convertTransportTypeToNetworkType(@TransportType int transportType) {
switch (transportType) {
case AccessNetworkConstants.TRANSPORT_TYPE_WWAN:
return getWwanPsRat();
case AccessNetworkConstants.TRANSPORT_TYPE_WLAN:
return TelephonyManager.NETWORK_TYPE_IWLAN;
default:
return TelephonyManager.NETWORK_TYPE_UNKNOWN;
}
}
@NetworkType
private int getWwanPsRat() {
return ServiceStateStats.getRat(
mPhone.getServiceStateTracker().getServiceState(),
NetworkRegistrationInfo.DOMAIN_PS);
}
private ImsRegistrationStats getDefaultImsRegistrationStats() {
Phone phone = mPhone.getDefaultPhone();
ImsRegistrationStats stats = new ImsRegistrationStats();
stats.rat = TelephonyManager.NETWORK_TYPE_UNKNOWN;
return stats;
}
private void updateImsRegistrationStats() {
Phone phone = mPhone.getDefaultPhone();
mLastRegistrationStats.carrierId = phone.getCarrierId();
mLastRegistrationStats.simSlotIndex = phone.getPhoneId();
}
@Nullable
private MmTelCapabilities getLastCapableFeaturesForTech(@ImsRegistrationTech int radioTech) {
switch (radioTech) {
case REGISTRATION_TECH_NONE:
return null;
case REGISTRATION_TECH_IWLAN:
case REGISTRATION_TECH_CROSS_SIM:
return mLastWlanCapableFeatures;
default:
return mLastWwanCapableFeatures;
}
}
@Nullable
private MmTelCapabilities getLastCapableFeaturesForNetworkType(@NetworkType int netType) {
switch (netType) {
case TelephonyManager.NETWORK_TYPE_UNKNOWN:
return null;
case TelephonyManager.NETWORK_TYPE_IWLAN:
return mLastWlanCapableFeatures;
default:
return mLastWwanCapableFeatures;
}
}
@NetworkType
private int convertRegistrationTechToNetworkType(@ImsRegistrationTech int radioTech) {
switch (radioTech) {
case REGISTRATION_TECH_NONE:
return TelephonyManager.NETWORK_TYPE_UNKNOWN;
case REGISTRATION_TECH_LTE:
return TelephonyManager.NETWORK_TYPE_LTE;
case REGISTRATION_TECH_IWLAN:
case REGISTRATION_TECH_CROSS_SIM:
return TelephonyManager.NETWORK_TYPE_IWLAN;
case REGISTRATION_TECH_NR:
return TelephonyManager.NETWORK_TYPE_NR;
default:
loge("convertRegistrationTechToNetworkType: unknown radio tech %d", radioTech);
return getWwanPsRat();
}
}
private static ImsRegistrationStats copyOfDimensionsOnly(ImsRegistrationStats source) {
ImsRegistrationStats dest = new ImsRegistrationStats();
dest.carrierId = source.carrierId;
dest.simSlotIndex = source.simSlotIndex;
dest.rat = source.rat;
dest.isIwlanCrossSim = source.isIwlanCrossSim;
return dest;
}
@VisibleForTesting
protected long getTimeMillis() {
return SystemClock.elapsedRealtime();
}
/** Filters IMS extra messages to ensure length limit and remove IDs. */
public static String filterExtraMessage(@Nullable String str) {
if (str == null) {
return "";
}
str = PATTERN_UUID.matcher(str).replaceAll(REPLACEMENT_UUID);
str = PATTERN_URI.matcher(str).replaceAll(REPLACEMENT_URI);
str = PATTERN_HOSTNAME.matcher(str).replaceAll(REPLACEMENT_HOSTNAME);
str = PATTERN_IPV4.matcher(str).replaceAll(REPLACEMENT_IPV4);
str = PATTERN_IPV6.matcher(str).replaceAll(REPLACEMENT_IPV6);
str = PATTERN_IMEI.matcher(str).replaceAll(REPLACEMENT_IMEI);
str = PATTERN_UNSEGMENTED_IMEI_IMSI.matcher(str)
.replaceAll(REPLACEMENT_UNSEGMENTED_IMEI_IMSI);
str = PATTERN_UNKNOWN_ID.matcher(str).replaceAll(REPLACEMENT_UNKNOWN_ID);
return str.length() > MAX_EXTRA_MESSAGE_LENGTH
? str.substring(0, MAX_EXTRA_MESSAGE_LENGTH)
: str;
}
private void logw(String format, Object... args) {
Rlog.w(TAG, "[" + mPhone.getPhoneId() + "] " + String.format(format, args));
}
private void loge(String format, Object... args) {
Rlog.e(TAG, "[" + mPhone.getPhoneId() + "] " + String.format(format, args));
}
}