Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 500ce9ea authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

Explicit API for allocating disk space. 

Now that we're giving apps better guidance around how much cached
disk space they can use, we also need to provide a way to help clear
some of those cached files.  The final logic is coming in a future
CL, but it will be designed to prevent abuse.

Test: newly added CTS tests
Bug: 34690590
Change-Id: I1e46ade0cdabbc33162fc7bfa76abec711992f92
parent aab4e11c

api/current.txt

+5 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ package android { 
    field public static final java.lang.String ACCESS_WIFI_STATE = "android.permission.ACCESS_WIFI_STATE";

    field public static final java.lang.String ACCOUNT_MANAGER = "android.permission.ACCOUNT_MANAGER";

    field public static final java.lang.String ADD_VOICEMAIL = "com.android.voicemail.permission.ADD_VOICEMAIL";

    field public static final java.lang.String ALLOCATE_AGGRESSIVE = "android.permission.ALLOCATE_AGGRESSIVE";

    field public static final java.lang.String BATTERY_STATS = "android.permission.BATTERY_STATS";

    field public static final java.lang.String BIND_ACCESSIBILITY_SERVICE = "android.permission.BIND_ACCESSIBILITY_SERVICE";

    field public static final java.lang.String BIND_APPWIDGET = "android.permission.BIND_APPWIDGET";
@@ -31212,6 +31213,9 @@ package android.os.storage { 
  }















  public class StorageManager {













    method public void allocateBytes(java.io.File, long, int) throws java.io.IOException;













    method public void allocateBytes(java.io.FileDescriptor, long, int) throws java.io.IOException;













    method public long getAllocatableBytes(java.io.File, int) throws java.io.IOException;















    method public long getCacheQuotaBytes();















    method public long getCacheSizeBytes();















    method public long getExternalCacheQuotaBytes();









@@ -31230,6 +31234,7 @@ package android.os.storage {













    method public void setCacheBehaviorTombstone(java.io.File, boolean) throws java.io.IOException;















    method public boolean unmountObb(java.lang.String, boolean, android.os.storage.OnObbStateChangeListener);















    field public static final java.lang.String ACTION_MANAGE_STORAGE = "android.os.storage.action.MANAGE_STORAGE";













    field public static final int FLAG_ALLOCATE_AGGRESSIVE = 1; // 0x1















  }





























  public final class StorageVolume implements android.os.Parcelable {

























api/system-current.txt



+5
−0






























Original line number
Diff line number
Diff line








@@ -23,6 +23,7 @@ package android {













    field public static final java.lang.String ACCESS_WIFI_STATE = "android.permission.ACCESS_WIFI_STATE";















    field public static final java.lang.String ACCOUNT_MANAGER = "android.permission.ACCOUNT_MANAGER";















    field public static final java.lang.String ADD_VOICEMAIL = "com.android.voicemail.permission.ADD_VOICEMAIL";













    field public static final java.lang.String ALLOCATE_AGGRESSIVE = "android.permission.ALLOCATE_AGGRESSIVE";















    field public static final java.lang.String ALLOW_ANY_CODEC_FOR_PLAYBACK = "android.permission.ALLOW_ANY_CODEC_FOR_PLAYBACK";















    field public static final java.lang.String BACKUP = "android.permission.BACKUP";















    field public static final java.lang.String BATTERY_STATS = "android.permission.BATTERY_STATS";










@@ -34082,6 +34083,9 @@ package android.os.storage {













  }





























  public class StorageManager {













    method public void allocateBytes(java.io.File, long, int) throws java.io.IOException;













    method public void allocateBytes(java.io.FileDescriptor, long, int) throws java.io.IOException;













    method public long getAllocatableBytes(java.io.File, int) throws java.io.IOException;















    method public long getCacheQuotaBytes();















    method public long getCacheSizeBytes();















    method public long getExternalCacheQuotaBytes();









@@ -34100,6 +34104,7 @@ package android.os.storage {













    method public void setCacheBehaviorTombstone(java.io.File, boolean) throws java.io.IOException;















    method public boolean unmountObb(java.lang.String, boolean, android.os.storage.OnObbStateChangeListener);















    field public static final java.lang.String ACTION_MANAGE_STORAGE = "android.os.storage.action.MANAGE_STORAGE";













    field public static final int FLAG_ALLOCATE_AGGRESSIVE = 1; // 0x1















  }





























  public final class StorageVolume implements android.os.Parcelable {

























api/test-current.txt



+5
−0






























Original line number
Diff line number
Diff line








@@ -15,6 +15,7 @@ package android {













    field public static final java.lang.String ACCESS_WIFI_STATE = "android.permission.ACCESS_WIFI_STATE";















    field public static final java.lang.String ACCOUNT_MANAGER = "android.permission.ACCOUNT_MANAGER";















    field public static final java.lang.String ADD_VOICEMAIL = "com.android.voicemail.permission.ADD_VOICEMAIL";













    field public static final java.lang.String ALLOCATE_AGGRESSIVE = "android.permission.ALLOCATE_AGGRESSIVE";















    field public static final java.lang.String BATTERY_STATS = "android.permission.BATTERY_STATS";















    field public static final java.lang.String BIND_ACCESSIBILITY_SERVICE = "android.permission.BIND_ACCESSIBILITY_SERVICE";















    field public static final java.lang.String BIND_APPWIDGET = "android.permission.BIND_APPWIDGET";










@@ -31327,6 +31328,9 @@ package android.os.storage {













  }





























  public class StorageManager {













    method public void allocateBytes(java.io.File, long, int) throws java.io.IOException;













    method public void allocateBytes(java.io.FileDescriptor, long, int) throws java.io.IOException;













    method public long getAllocatableBytes(java.io.File, int) throws java.io.IOException;















    method public long getCacheQuotaBytes();















    method public long getCacheSizeBytes();















    method public long getExternalCacheQuotaBytes();









@@ -31345,6 +31349,7 @@ package android.os.storage {













    method public void setCacheBehaviorTombstone(java.io.File, boolean) throws java.io.IOException;















    method public boolean unmountObb(java.lang.String, boolean, android.os.storage.OnObbStateChangeListener);















    field public static final java.lang.String ACTION_MANAGE_STORAGE = "android.os.storage.action.MANAGE_STORAGE";













    field public static final int FLAG_ALLOCATE_AGGRESSIVE = 1; // 0x1















  }





























  public final class StorageVolume implements android.os.Parcelable {

























core/java/android/os/storage/IStorageManager.aidl



+2
−0






























Original line number
Diff line number
Diff line








@@ -293,4 +293,6 @@ interface IStorageManager {













    ParcelFileDescriptor openProxyFileDescriptor(int mountPointId, int fileId, int mode) = 74;















    long getCacheQuotaBytes(String volumeUuid, int uid) = 75;















    long getCacheSizeBytes(String volumeUuid, int uid) = 76;













    long getAllocatableBytes(String path, int flags) = 77;













    void allocateBytes(String path, long bytes, int flags) = 78;















}
























core/java/android/os/storage/StorageManager.java



+139
−6






























Original line number
Diff line number
Diff line








@@ -18,8 +18,10 @@ package android.os.storage;





























import static android.net.TrafficStats.MB_IN_BYTES;





























import android.annotation.IntDef;















import android.annotation.NonNull;















import android.annotation.Nullable;













import android.annotation.RequiresPermission;















import android.annotation.SdkConstant;















import android.app.ActivityThread;















import android.content.ContentResolver;









@@ -34,6 +36,7 @@ import android.os.Handler;













import android.os.Looper;















import android.os.Message;















import android.os.ParcelFileDescriptor;













import android.os.ParcelableException;















import android.os.ProxyFileDescriptorCallback;















import android.os.RemoteException;















import android.os.ServiceManager;









@@ -60,10 +63,13 @@ import com.android.internal.util.Preconditions;





























import java.io.BufferedReader;















import java.io.File;













import java.io.FileDescriptor;















import java.io.FileInputStream;















import java.io.FileNotFoundException;















import java.io.IOException;















import java.io.InputStreamReader;













import java.lang.annotation.Retention;













import java.lang.annotation.RetentionPolicy;















import java.lang.ref.WeakReference;















import java.nio.charset.StandardCharsets;















import java.util.ArrayList;










@@ -1424,10 +1430,7 @@ public class StorageManager {













     * as a single unit.















     * </p>















     *













     * @see #getCacheQuotaBytes()















     * @see #getCacheSizeBytes()













     * @see #getExternalCacheQuotaBytes()













     * @see #getExternalCacheSizeBytes()















     */















    public long getCacheQuotaBytes() {















        try {









@@ -1453,9 +1456,6 @@ public class StorageManager {













     * </p>















     *















     * @see #getCacheQuotaBytes()













     * @see #getCacheSizeBytes()













     * @see #getExternalCacheQuotaBytes()













     * @see #getExternalCacheSizeBytes()















     */















    public long getCacheSizeBytes() {















        try {










@@ -1520,6 +1520,139 @@ public class StorageManager {













        }















    }





























    /**













     * Flag indicating that a disk space allocation request should operate in an













     * aggressive mode. This flag should only be rarely used in situations that













     * are critical to system health or security.













     * <p>













     * When set, the system is more aggressive about the data that it considers













     * for possible deletion when allocating disk space.













     * <p class="note">













     * Note: your app must hold the













     * {@link android.Manifest.permission#ALLOCATE_AGGRESSIVE} permission for













     * this flag to take effect.













     * </p>













     *













     * @see #getAllocatableBytes(File, int)













     * @see #allocateBytes(File, long, int)













     * @see #allocateBytes(FileDescriptor, long, int)













     */













    @RequiresPermission(android.Manifest.permission.ALLOCATE_AGGRESSIVE)













    public static final int FLAG_ALLOCATE_AGGRESSIVE = 1;



























    /** @hide */













    @IntDef(flag = true, value = {













            FLAG_ALLOCATE_AGGRESSIVE,













    })













    @Retention(RetentionPolicy.SOURCE)













    public @interface AllocateFlags {}



























    /**













     * Return the maximum number of new bytes that your app can allocate for













     * itself using {@link #allocateBytes(File, long, int)} at the given path.













     * This value is typically larger than {@link File#getUsableSpace()}, since













     * the system may automatically delete cached files to satisfy your request.













     * <p>













     * This method is best used as a pre-flight check, such as deciding if there













     * is enough space to store an entire music album before you allocate space













     * for each audio file in the album. Attempts to allocate disk space beyond













     * this value will fail.













     * <p class="note">













     * Note: if your app uses the {@code android:sharedUserId} manifest feature,













     * then allocatable space for all packages in your shared UID is tracked













     * together as a single unit.













     * </p>













     *













     * @param file the directory where you're considering allocating disk space,













     *            since allocatable space can vary widely depending on the













     *            underlying storage device.













     * @param flags to apply to the request.













     * @return the maximum number of new bytes that the calling app can allocate













     *         using {@link #allocateBytes(File, long, int)}.













     */













    public long getAllocatableBytes(File file, @AllocateFlags int flags) throws IOException {













        try {













            return mStorageManager.getAllocatableBytes(file.getAbsolutePath(), flags);













        } catch (ParcelableException e) {













            e.maybeRethrow(IOException.class);













            throw new RuntimeException(e);













        } catch (RemoteException e) {













            throw e.rethrowFromSystemServer();













        }













    }



























    /**













     * Allocate the requested number of bytes for your application to use at the













     * given path. This will cause the system to delete any cached files













     * necessary to satisfy your request.













     * <p>













     * Attempts to allocate disk space beyond the value returned by













     * {@link #getAllocatableBytes(File, int)} will fail.













     * <p>













     * Since multiple apps can be running simultaneously, this method may be













     * subject to race conditions. If possible, consider using













     * {@link #allocateBytes(FileDescriptor, long, int)} which will guarantee













     * that bytes are allocated to an opened file.













     *













     * @param file the directory where you'd like to allocate disk space.













     * @param bytes the number of bytes to allocate.













     * @param flags to apply to the request.













     * @see #getAllocatableBytes(File, int)













     */













    public void allocateBytes(File file, long bytes, @AllocateFlags int flags) throws IOException {













        try {













            mStorageManager.allocateBytes(file.getAbsolutePath(), bytes, flags);













        } catch (ParcelableException e) {













            e.maybeRethrow(IOException.class);













        } catch (RemoteException e) {













            throw e.rethrowFromSystemServer();













        }













    }



























    /**













     * Allocate the requested number of bytes for your application to use at the













     * given path. This will cause the system to delete any cached files













     * necessary to satisfy your request.













     * <p>













     * Attempts to allocate disk space beyond the value returned by













     * {@link #getAllocatableBytes(File, int)} will fail.













     * <p>













     * This method guarantees that bytes are allocated to the opened file,













     * otherwise it will throw if fast allocation not possible. Fast allocation













     * is typically only supported in private app data directories, and on













     * shared/external storage devices which are emulated.













     *













     * @param fd the directory where you'd like to allocate disk space.













     * @param bytes the number of bytes to allocate.













     * @param flags to apply to the request.













     * @see #getAllocatableBytes(File, int)













     * @see Environment#isExternalStorageEmulated(File)













     */













    public void allocateBytes(FileDescriptor fd, long bytes, @AllocateFlags int flags)













            throws IOException {













        final File file;













        try {













            file = new File(Os.readlink("/proc/self/fd/" + fd.getInt$()));













        } catch (ErrnoException e) {













            throw e.rethrowAsIOException();













        }













        for (int i = 0; i < 3; i++) {













            allocateBytes(file, bytes, flags);



























            try {













                Os.posix_fallocate(fd, 0, bytes);













            } catch (ErrnoException e) {













                if (e.errno == OsConstants.ENOSPC) {













                    Log.w(TAG, "Odd, not enough space; let's try again?");













                    continue;













                }













                throw e.rethrowAsIOException();













            }













        }













        throw new IOException(













                "Well this is embarassing; we can't allocate " + bytes + " for " + file);













    }





























    private static final String XATTR_ATOMIC = "user.atomic";















    private static final String XATTR_TOMBSTONE = "user.tombstone";