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

Commit 0037c3fe authored by Songchun Fan's avatar Songchun Fan
Browse files

[incremental] fundamental aidl interfaces 

Please review the fundamental AIDL interfaces for enabling
the Incremenetal feature. Basically there are three services:

+ android.os.incremental.IIncrementalService:
Provides basic file operation functions. Will be implemented in native.

+ android.os.incremental.IIncrementalServiceProxy:
Started by SystemServer, is it the proxy that starts native
Incremental Service. The proxy also handles Java tasks like finding
data loader service package, binding to data loader service and talking
to it. Essentially the native Incremental Service controls the
data loader service via this proxy. Will be implemented in Java.

+ android.service.incremental.IIncrementalDataLoaderService:
Defines inteface for the base data loader service. I understand that
data loader is being re-designed but I would like to get the
"placeholder" in master first, and we can iterate on the implementation
details in master.

Test: builds
Change-Id: Ifc3a43633356951b239486d66ee80d120bc4ab76
parent 045b3960

Android.bp

+40 −0
Original line number Diff line number Diff line
@@ -759,6 +759,46 @@ cc_library { 
    },

}



filegroup {

    name: "incremental_aidl",

    srcs: [

        "core/java/android/os/incremental/IIncrementalService.aidl",

        "core/java/android/os/incremental/IIncrementalServiceProxy.aidl",

        "core/java/android/os/incremental/IncrementalDataLoaderParamsParcel.aidl",

        "core/java/android/os/incremental/IncrementalFileSystemControlParcel.aidl",

        "core/java/android/os/incremental/NamedParcelFileDescriptor.aidl",

    ],

    path: "core/java",

}



filegroup {

    name: "incremental_data_loader_aidl",

    srcs: [

        "core/java/android/service/incremental/IIncrementalDataLoaderStatusListener.aidl",

        "core/java/android/service/incremental/IIncrementalDataLoaderService.aidl",

    ],

    path: "core/java",

}



aidl_interface {

    name: "libincremental_aidl",

    srcs: [

        ":incremental_aidl",

        ":incremental_data_loader_aidl",

    ],

    backend: {

        java: {

            sdk_version: "28",

        },

        cpp: {

            enabled: true,

        },

        ndk: {

            enabled: true,

        },

    },

    api_dir: "aidl/incremental",

}



gensrcs {

    name: "gen-platform-proto-constants",

core/java/android/os/incremental/IIncrementalService.aidl

0 → 100644
+96 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 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 android.os.incremental;



import android.os.incremental.IncrementalDataLoaderParamsParcel;



/** @hide */

interface IIncrementalService {

    /**

     * A set of flags for the |createMode| parameters when creating a new Incremental storage.

     */

    const int CREATE_MODE_TEMPORARY_BIND = 1;

    const int CREATE_MODE_PERMANENT_BIND = 2;

    const int CREATE_MODE_CREATE = 4;

    const int CREATE_MODE_OPEN_EXISTING = 8;



    /**

     * Opens or creates a storage given a target path and data loader params. Returns the storage ID.

     */

    int openStorage(in @utf8InCpp String path);

    int createStorage(in @utf8InCpp String path, in IncrementalDataLoaderParamsParcel params, int createMode);

    int createLinkedStorage(in @utf8InCpp String path, int otherStorageId, int createMode);



    /**

     * Bind-mounts a path under a storage to a full path. Can be permanent or temporary.

     */

    const int BIND_TEMPORARY = 0;

    const int BIND_PERMANENT = 1;

    int makeBindMount(int storageId, in @utf8InCpp String pathUnderStorage, in @utf8InCpp String targetFullPath, int bindType);



    /**

     * Deletes an existing bind mount on a path under a storage. Returns 0 on success, and -errno on failure.

     */

    int deleteBindMount(int storageId, in @utf8InCpp String targetFullPath);



    /**

     * Creates a directory under a storage. The target directory is specified by its relative path under the storage.

     */

    int makeDirectory(int storageId, in @utf8InCpp String pathUnderStorage);



    /**

     * Creates a file under a storage, specifying its name, size and metadata.

     */

    int makeFile(int storageId, in @utf8InCpp String pathUnderStorage, long size, in byte[] metadata);



    /**

     * Creates a file under a storage. Content of the file is from a range inside another file.

     * Both files are specified by relative paths under storage.

     */

    int makeFileFromRange(int storageId, in @utf8InCpp String targetPathUnderStorage, in @utf8InCpp String sourcePathUnderStorage, long start, long end);



    /**

     * Creates a hard link between two files in a storage.

     * Both source and destination are specified by relative paths under storage.

     */

    int makeLink(int storageId, in @utf8InCpp String sourcePathUnderStorage, in @utf8InCpp String destPathUnderStorage);



    /**

     * Deletes a hard link in a storage, specified by the relative path of the link target under storage.

     */

    int unlink(int storageId, in @utf8InCpp String pathUnderStorage);



    /**

     * Checks if a file's certain range is loaded. File is specified by relative file path under storage.

     */

    boolean isFileRangeLoaded(int storageId, in @utf8InCpp String pathUnderStorage, long start, long end);



    /**

     * Reads the metadata of a file. File is specified by relative path under storage.

     */

    byte[] getFileMetadata(int storageId, in @utf8InCpp String pathUnderStorage);



    /**

     * Returns the list of file paths under a storage.

     */

    @utf8InCpp String[] getFileList(int storageId);



    /**

     * Starts loading data for a storage.

     */

    boolean startLoading(int storageId);

}

core/java/android/os/incremental/IIncrementalServiceProxy.aidl

0 → 100644
+37 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 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 android.os.incremental;



import android.os.incremental.IncrementalFileSystemControlParcel;

import android.os.incremental.IncrementalDataLoaderParamsParcel;

import android.service.incremental.IIncrementalDataLoaderStatusListener;



/**

 * Binder service to receive calls from native Incremental Service and handle Java tasks such as

 * looking up data loader service package names, binding and talking to the data loader service.

 * @hide

 */

interface IIncrementalServiceProxy {

    boolean prepareDataLoader(int mountId,

        in IncrementalFileSystemControlParcel control,

        in IncrementalDataLoaderParamsParcel params,

        in IIncrementalDataLoaderStatusListener listener);

    boolean startDataLoader(int mountId);

    void showHealthBlockedUI(int mountId);

    void destroyDataLoader(int mountId);

    void newFileForDataLoader(int mountId, long inode, in byte[] metadata);

}

core/java/android/os/incremental/IncrementalDataLoaderParamsParcel.aidl

0 → 100644
+29 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 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 android.os.incremental;



import android.os.incremental.NamedParcelFileDescriptor;



/**

 * Class for holding data loader configuration parameters.

 * @hide

 */

parcelable IncrementalDataLoaderParamsParcel {

    @utf8InCpp String staticUri;

    @utf8InCpp String packageName;

    NamedParcelFileDescriptor[] dynamicArgs;

}

core/java/android/os/incremental/IncrementalFileSystemControlParcel.aidl

0 → 100644
+27 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 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 android.os.incremental;



/**

 * Wraps two file descriptors that Incremental Service uses to communicate

 * with Incremental FileSystem.

 * @hide

 */

parcelable IncrementalFileSystemControlParcel {

    @nullable ParcelFileDescriptor cmd;

    @nullable ParcelFileDescriptor log;

}