src.com.android.server.blob.BlobStoreConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
/*
* Copyright 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
package com.android.server.blob;
import static android.provider.DeviceConfig.NAMESPACE_BLOBSTORE;
import static android.text.format.Formatter.FLAG_IEC_UNITS;
import static android.text.format.Formatter.formatFileSize;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.content.Context;
import android.os.Environment;
import android.provider.DeviceConfig;
import android.provider.DeviceConfig.Properties;
import android.text.TextUtils;
import android.util.DataUnit;
import android.util.IndentingPrintWriter;
import android.util.Log;
import android.util.Slog;
import android.util.TimeUtils;
import java.io.File;
import java.util.concurrent.TimeUnit;
class BlobStoreConfig {
public static final String TAG = "BlobStore";
public static final boolean LOGV = Log.isLoggable(TAG, Log.VERBOSE);
// Initial version.
public static final int XML_VERSION_INIT = 1;
// Added a string variant of lease description.
public static final int XML_VERSION_ADD_STRING_DESC = 2;
public static final int XML_VERSION_ADD_DESC_RES_NAME = 3;
public static final int XML_VERSION_ADD_COMMIT_TIME = 4;
public static final int XML_VERSION_ADD_SESSION_CREATION_TIME = 5;
public static final int XML_VERSION_ALLOW_ACCESS_ACROSS_USERS = 6;
public static final int XML_VERSION_CURRENT = XML_VERSION_ALLOW_ACCESS_ACROSS_USERS;
public static final long INVALID_BLOB_ID = 0;
public static final long INVALID_BLOB_SIZE = 0;
private static final String ROOT_DIR_NAME = "blobstore";
private static final String BLOBS_DIR_NAME = "blobs";
private static final String SESSIONS_INDEX_FILE_NAME = "sessions_index.xml";
private static final String BLOBS_INDEX_FILE_NAME = "blobs_index.xml";
/**
* Job Id for idle maintenance job ({@link BlobStoreIdleJobService}).
*/
public static final int IDLE_JOB_ID = 0xB70B1D7; // 191934935L
public static class DeviceConfigProperties {
/**
* Denotes the max time period (in millis) between each idle maintenance job run.
*/
public static final String KEY_IDLE_JOB_PERIOD_MS = "idle_job_period_ms";
public static final long DEFAULT_IDLE_JOB_PERIOD_MS = TimeUnit.DAYS.toMillis(1);
public static long IDLE_JOB_PERIOD_MS = DEFAULT_IDLE_JOB_PERIOD_MS;
/**
* Denotes the timeout in millis after which sessions with no updates will be deleted.
*/
public static final String KEY_SESSION_EXPIRY_TIMEOUT_MS =
"session_expiry_timeout_ms";
public static final long DEFAULT_SESSION_EXPIRY_TIMEOUT_MS = TimeUnit.DAYS.toMillis(7);
public static long SESSION_EXPIRY_TIMEOUT_MS = DEFAULT_SESSION_EXPIRY_TIMEOUT_MS;
/**
* Denotes how low the limit for the amount of data, that an app will be allowed to acquire
* a lease on, can be.
*/
public static final String KEY_TOTAL_BYTES_PER_APP_LIMIT_FLOOR =
"total_bytes_per_app_limit_floor";
public static final long DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FLOOR =
DataUnit.MEBIBYTES.toBytes(300); // 300 MiB
public static long TOTAL_BYTES_PER_APP_LIMIT_FLOOR =
DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FLOOR;
/**
* Denotes the maximum amount of data an app can acquire a lease on, in terms of fraction
* of total disk space.
*/
public static final String KEY_TOTAL_BYTES_PER_APP_LIMIT_FRACTION =
"total_bytes_per_app_limit_fraction";
public static final float DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FRACTION = 0.01f;
public static float TOTAL_BYTES_PER_APP_LIMIT_FRACTION =
DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FRACTION;
/**
* Denotes the duration from the time a blob is committed that we wait for a lease to
* be acquired before deciding to delete the blob for having no leases.
*/
public static final String KEY_LEASE_ACQUISITION_WAIT_DURATION_MS =
"lease_acquisition_wait_time_ms";
public static final long DEFAULT_LEASE_ACQUISITION_WAIT_DURATION_MS =
TimeUnit.HOURS.toMillis(6);
public static long LEASE_ACQUISITION_WAIT_DURATION_MS =
DEFAULT_LEASE_ACQUISITION_WAIT_DURATION_MS;
/**
* Denotes the duration from the time a blob is committed that any new commits of the same
* data blob from the same committer will be treated as if they occurred at the earlier
* commit time.
*/
public static final String KEY_COMMIT_COOL_OFF_DURATION_MS =
"commit_cool_off_duration_ms";
public static final long DEFAULT_COMMIT_COOL_OFF_DURATION_MS =
TimeUnit.HOURS.toMillis(48);
public static long COMMIT_COOL_OFF_DURATION_MS =
DEFAULT_COMMIT_COOL_OFF_DURATION_MS;
/**
* Denotes whether to use RevocableFileDescriptor when apps try to read session/blob data.
*/
public static final String KEY_USE_REVOCABLE_FD_FOR_READS =
"use_revocable_fd_for_reads";
public static final boolean DEFAULT_USE_REVOCABLE_FD_FOR_READS = false;
public static boolean USE_REVOCABLE_FD_FOR_READS =
DEFAULT_USE_REVOCABLE_FD_FOR_READS;
/**
* Denotes how long before a blob is deleted, once the last lease on it is released.
*/
public static final String KEY_DELETE_ON_LAST_LEASE_DELAY_MS =
"delete_on_last_lease_delay_ms";
public static final long DEFAULT_DELETE_ON_LAST_LEASE_DELAY_MS =
TimeUnit.HOURS.toMillis(6);
public static long DELETE_ON_LAST_LEASE_DELAY_MS =
DEFAULT_DELETE_ON_LAST_LEASE_DELAY_MS;
/**
* Denotes the maximum number of active sessions per app at any time.
*/
public static final String KEY_MAX_ACTIVE_SESSIONS = "max_active_sessions";
public static int DEFAULT_MAX_ACTIVE_SESSIONS = 250;
public static int MAX_ACTIVE_SESSIONS = DEFAULT_MAX_ACTIVE_SESSIONS;
/**
* Denotes the maximum number of committed blobs per app at any time.
*/
public static final String KEY_MAX_COMMITTED_BLOBS = "max_committed_blobs";
public static int DEFAULT_MAX_COMMITTED_BLOBS = 1000;
public static int MAX_COMMITTED_BLOBS = DEFAULT_MAX_COMMITTED_BLOBS;
/**
* Denotes the maximum number of leased blobs per app at any time.
*/
public static final String KEY_MAX_LEASED_BLOBS = "max_leased_blobs";
public static int DEFAULT_MAX_LEASED_BLOBS = 500;
public static int MAX_LEASED_BLOBS = DEFAULT_MAX_LEASED_BLOBS;
/**
* Denotes the maximum number of packages explicitly permitted to access a blob
* (permitted as part of creating a {@link BlobAccessMode}).
*/
public static final String KEY_MAX_BLOB_ACCESS_PERMITTED_PACKAGES = "max_permitted_pks";
public static int DEFAULT_MAX_BLOB_ACCESS_PERMITTED_PACKAGES = 300;
public static int MAX_BLOB_ACCESS_PERMITTED_PACKAGES =
DEFAULT_MAX_BLOB_ACCESS_PERMITTED_PACKAGES;
/**
* Denotes the maximum number of characters that a lease description can have.
*/
public static final String KEY_LEASE_DESC_CHAR_LIMIT = "lease_desc_char_limit";
public static int DEFAULT_LEASE_DESC_CHAR_LIMIT = 300;
public static int LEASE_DESC_CHAR_LIMIT = DEFAULT_LEASE_DESC_CHAR_LIMIT;
static void refresh(Properties properties) {
if (!NAMESPACE_BLOBSTORE.equals(properties.getNamespace())) {
return;
}
properties.getKeyset().forEach(key -> {
switch (key) {
case KEY_IDLE_JOB_PERIOD_MS:
IDLE_JOB_PERIOD_MS = properties.getLong(key, DEFAULT_IDLE_JOB_PERIOD_MS);
break;
case KEY_SESSION_EXPIRY_TIMEOUT_MS:
SESSION_EXPIRY_TIMEOUT_MS = properties.getLong(key,
DEFAULT_SESSION_EXPIRY_TIMEOUT_MS);
break;
case KEY_TOTAL_BYTES_PER_APP_LIMIT_FLOOR:
TOTAL_BYTES_PER_APP_LIMIT_FLOOR = properties.getLong(key,
DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FLOOR);
break;
case KEY_TOTAL_BYTES_PER_APP_LIMIT_FRACTION:
TOTAL_BYTES_PER_APP_LIMIT_FRACTION = properties.getFloat(key,
DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FRACTION);
break;
case KEY_LEASE_ACQUISITION_WAIT_DURATION_MS:
LEASE_ACQUISITION_WAIT_DURATION_MS = properties.getLong(key,
DEFAULT_LEASE_ACQUISITION_WAIT_DURATION_MS);
break;
case KEY_COMMIT_COOL_OFF_DURATION_MS:
COMMIT_COOL_OFF_DURATION_MS = properties.getLong(key,
DEFAULT_COMMIT_COOL_OFF_DURATION_MS);
break;
case KEY_USE_REVOCABLE_FD_FOR_READS:
USE_REVOCABLE_FD_FOR_READS = properties.getBoolean(key,
DEFAULT_USE_REVOCABLE_FD_FOR_READS);
break;
case KEY_DELETE_ON_LAST_LEASE_DELAY_MS:
DELETE_ON_LAST_LEASE_DELAY_MS = properties.getLong(key,
DEFAULT_DELETE_ON_LAST_LEASE_DELAY_MS);
break;
case KEY_MAX_ACTIVE_SESSIONS:
MAX_ACTIVE_SESSIONS = properties.getInt(key, DEFAULT_MAX_ACTIVE_SESSIONS);
break;
case KEY_MAX_COMMITTED_BLOBS:
MAX_COMMITTED_BLOBS = properties.getInt(key, DEFAULT_MAX_COMMITTED_BLOBS);
break;
case KEY_MAX_LEASED_BLOBS:
MAX_LEASED_BLOBS = properties.getInt(key, DEFAULT_MAX_LEASED_BLOBS);
break;
case KEY_MAX_BLOB_ACCESS_PERMITTED_PACKAGES:
MAX_BLOB_ACCESS_PERMITTED_PACKAGES = properties.getInt(key,
DEFAULT_MAX_BLOB_ACCESS_PERMITTED_PACKAGES);
break;
case KEY_LEASE_DESC_CHAR_LIMIT:
LEASE_DESC_CHAR_LIMIT = properties.getInt(key,
DEFAULT_LEASE_DESC_CHAR_LIMIT);
break;
default:
Slog.wtf(TAG, "Unknown key in device config properties: " + key);
}
});
}
static void dump(IndentingPrintWriter fout, Context context) {
final String dumpFormat = "%s: [cur: %s, def: %s]";
fout.println(String.format(dumpFormat, KEY_IDLE_JOB_PERIOD_MS,
TimeUtils.formatDuration(IDLE_JOB_PERIOD_MS),
TimeUtils.formatDuration(DEFAULT_IDLE_JOB_PERIOD_MS)));
fout.println(String.format(dumpFormat, KEY_SESSION_EXPIRY_TIMEOUT_MS,
TimeUtils.formatDuration(SESSION_EXPIRY_TIMEOUT_MS),
TimeUtils.formatDuration(DEFAULT_SESSION_EXPIRY_TIMEOUT_MS)));
fout.println(String.format(dumpFormat, KEY_TOTAL_BYTES_PER_APP_LIMIT_FLOOR,
formatFileSize(context, TOTAL_BYTES_PER_APP_LIMIT_FLOOR, FLAG_IEC_UNITS),
formatFileSize(context, DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FLOOR,
FLAG_IEC_UNITS)));
fout.println(String.format(dumpFormat, KEY_TOTAL_BYTES_PER_APP_LIMIT_FRACTION,
TOTAL_BYTES_PER_APP_LIMIT_FRACTION,
DEFAULT_TOTAL_BYTES_PER_APP_LIMIT_FRACTION));
fout.println(String.format(dumpFormat, KEY_LEASE_ACQUISITION_WAIT_DURATION_MS,
TimeUtils.formatDuration(LEASE_ACQUISITION_WAIT_DURATION_MS),
TimeUtils.formatDuration(DEFAULT_LEASE_ACQUISITION_WAIT_DURATION_MS)));
fout.println(String.format(dumpFormat, KEY_COMMIT_COOL_OFF_DURATION_MS,
TimeUtils.formatDuration(COMMIT_COOL_OFF_DURATION_MS),
TimeUtils.formatDuration(DEFAULT_COMMIT_COOL_OFF_DURATION_MS)));
fout.println(String.format(dumpFormat, KEY_USE_REVOCABLE_FD_FOR_READS,
USE_REVOCABLE_FD_FOR_READS, DEFAULT_USE_REVOCABLE_FD_FOR_READS));
fout.println(String.format(dumpFormat, KEY_DELETE_ON_LAST_LEASE_DELAY_MS,
TimeUtils.formatDuration(DELETE_ON_LAST_LEASE_DELAY_MS),
TimeUtils.formatDuration(DEFAULT_DELETE_ON_LAST_LEASE_DELAY_MS)));
fout.println(String.format(dumpFormat, KEY_MAX_ACTIVE_SESSIONS,
MAX_ACTIVE_SESSIONS, DEFAULT_MAX_ACTIVE_SESSIONS));
fout.println(String.format(dumpFormat, KEY_MAX_COMMITTED_BLOBS,
MAX_COMMITTED_BLOBS, DEFAULT_MAX_COMMITTED_BLOBS));
fout.println(String.format(dumpFormat, KEY_MAX_LEASED_BLOBS,
MAX_LEASED_BLOBS, DEFAULT_MAX_LEASED_BLOBS));
fout.println(String.format(dumpFormat, KEY_MAX_BLOB_ACCESS_PERMITTED_PACKAGES,
MAX_BLOB_ACCESS_PERMITTED_PACKAGES,
DEFAULT_MAX_BLOB_ACCESS_PERMITTED_PACKAGES));
fout.println(String.format(dumpFormat, KEY_LEASE_DESC_CHAR_LIMIT,
LEASE_DESC_CHAR_LIMIT, DEFAULT_LEASE_DESC_CHAR_LIMIT));
}
}
public static void initialize(Context context) {
DeviceConfig.addOnPropertiesChangedListener(NAMESPACE_BLOBSTORE,
context.getMainExecutor(),
properties -> DeviceConfigProperties.refresh(properties));
DeviceConfigProperties.refresh(DeviceConfig.getProperties(NAMESPACE_BLOBSTORE));
}
/**
* Returns the max time period (in millis) between each idle maintenance job run.
*/
public static long getIdleJobPeriodMs() {
return DeviceConfigProperties.IDLE_JOB_PERIOD_MS;
}
/**
* Returns whether a session is expired or not. A session is considered expired if the session
* has not been modified in a while (i.e. SESSION_EXPIRY_TIMEOUT_MS).
*/
public static boolean hasSessionExpired(long sessionLastModifiedMs) {
return sessionLastModifiedMs
< System.currentTimeMillis() - DeviceConfigProperties.SESSION_EXPIRY_TIMEOUT_MS;
}
/**
* Returns the maximum amount of data that an app can acquire a lease on.
*/
public static long getAppDataBytesLimit() {
final long totalBytesLimit = (long) (Environment.getDataSystemDirectory().getTotalSpace()
* DeviceConfigProperties.TOTAL_BYTES_PER_APP_LIMIT_FRACTION);
return Math.max(DeviceConfigProperties.TOTAL_BYTES_PER_APP_LIMIT_FLOOR, totalBytesLimit);
}
/**
* Returns whether the wait time for lease acquisition for a blob has elapsed.
*/
public static boolean hasLeaseWaitTimeElapsed(long commitTimeMs) {
return commitTimeMs + DeviceConfigProperties.LEASE_ACQUISITION_WAIT_DURATION_MS
< System.currentTimeMillis();
}
/**
* Returns an adjusted commit time depending on whether commit cool-off period has elapsed.
*
* If this is the initial commit or the earlier commit cool-off period has elapsed, then
* the new commit time is used. Otherwise, the earlier commit time is used.
*/
public static long getAdjustedCommitTimeMs(long oldCommitTimeMs, long newCommitTimeMs) {
if (oldCommitTimeMs == 0 || hasCommitCoolOffPeriodElapsed(oldCommitTimeMs)) {
return newCommitTimeMs;
}
return oldCommitTimeMs;
}
/**
* Returns whether the commit cool-off period has elapsed.
*/
private static boolean hasCommitCoolOffPeriodElapsed(long commitTimeMs) {
return commitTimeMs + DeviceConfigProperties.COMMIT_COOL_OFF_DURATION_MS
< System.currentTimeMillis();
}
/**
* Return whether to use RevocableFileDescriptor when apps try to read session/blob data.
*/
public static boolean shouldUseRevocableFdForReads() {
return DeviceConfigProperties.USE_REVOCABLE_FD_FOR_READS;
}
/**
* Returns the duration to wait before a blob is deleted, once the last lease on it is released.
*/
public static long getDeletionOnLastLeaseDelayMs() {
return DeviceConfigProperties.DELETE_ON_LAST_LEASE_DELAY_MS;
}
/**
* Returns the maximum number of active sessions per app.
*/
public static int getMaxActiveSessions() {
return DeviceConfigProperties.MAX_ACTIVE_SESSIONS;
}
/**
* Returns the maximum number of committed blobs per app.
*/
public static int getMaxCommittedBlobs() {
return DeviceConfigProperties.MAX_COMMITTED_BLOBS;
}
/**
* Returns the maximum number of leased blobs per app.
*/
public static int getMaxLeasedBlobs() {
return DeviceConfigProperties.MAX_LEASED_BLOBS;
}
/**
* Returns the maximum number of packages explicitly permitted to access a blob.
*/
public static int getMaxPermittedPackages() {
return DeviceConfigProperties.MAX_BLOB_ACCESS_PERMITTED_PACKAGES;
}
/**
* Returns the lease description truncated to
* {@link DeviceConfigProperties#LEASE_DESC_CHAR_LIMIT} characters.
*/
public static CharSequence getTruncatedLeaseDescription(CharSequence description) {
if (TextUtils.isEmpty(description)) {
return description;
}
return TextUtils.trimToLengthWithEllipsis(description,
DeviceConfigProperties.LEASE_DESC_CHAR_LIMIT);
}
@Nullable
public static File prepareBlobFile(long sessionId) {
final File blobsDir = prepareBlobsDir();
return blobsDir == null ? null : getBlobFile(blobsDir, sessionId);
}
@NonNull
public static File getBlobFile(long sessionId) {
return getBlobFile(getBlobsDir(), sessionId);
}
@NonNull
private static File getBlobFile(File blobsDir, long sessionId) {
return new File(blobsDir, String.valueOf(sessionId));
}
@Nullable
public static File prepareBlobsDir() {
final File blobsDir = getBlobsDir(prepareBlobStoreRootDir());
if (!blobsDir.exists() && !blobsDir.mkdir()) {
Slog.e(TAG, "Failed to mkdir(): " + blobsDir);
return null;
}
return blobsDir;
}
@NonNull
public static File getBlobsDir() {
return getBlobsDir(getBlobStoreRootDir());
}
@NonNull
private static File getBlobsDir(File blobsRootDir) {
return new File(blobsRootDir, BLOBS_DIR_NAME);
}
@Nullable
public static File prepareSessionIndexFile() {
final File blobStoreRootDir = prepareBlobStoreRootDir();
if (blobStoreRootDir == null) {
return null;
}
return new File(blobStoreRootDir, SESSIONS_INDEX_FILE_NAME);
}
@Nullable
public static File prepareBlobsIndexFile() {
final File blobsStoreRootDir = prepareBlobStoreRootDir();
if (blobsStoreRootDir == null) {
return null;
}
return new File(blobsStoreRootDir, BLOBS_INDEX_FILE_NAME);
}
@Nullable
public static File prepareBlobStoreRootDir() {
final File blobStoreRootDir = getBlobStoreRootDir();
if (!blobStoreRootDir.exists() && !blobStoreRootDir.mkdir()) {
Slog.e(TAG, "Failed to mkdir(): " + blobStoreRootDir);
return null;
}
return blobStoreRootDir;
}
@NonNull
public static File getBlobStoreRootDir() {
return new File(Environment.getDataSystemDirectory(), ROOT_DIR_NAME);
}
public static void dump(IndentingPrintWriter fout, Context context) {
fout.println("XML current version: " + XML_VERSION_CURRENT);
fout.println("Idle job ID: " + IDLE_JOB_ID);
fout.println("Total bytes per app limit: " + formatFileSize(context,
getAppDataBytesLimit(), FLAG_IEC_UNITS));
fout.println("Device config properties:");
fout.increaseIndent();
DeviceConfigProperties.dump(fout, context);
fout.decreaseIndent();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy