HIDL MemoryBlock

HIDL MemoryBlock 是建構在 hidl_memoryHIDL @1.0::IAllocatorHIDL @1.0::IMapper 上的抽象層。最適合具有多個記憶體區塊來共用單一記憶體堆積的 HIDL 服務。

提升效能

在應用程式中使用 MemoryBlock 可大幅減少 mmap/munmap 和使用者空間區隔錯誤的數量,進而提升效能。例如:

  • 針對每個緩衝區配置,每個 hidl_memory 平均分配到 238 us/1 配置。
  • 使用 MemoryBlock 並共用單一 hidl_memory 的平均分配量為 2.82 us/1。

建築

HIDL MemoryBlock 架構包含 HIDL 服務,其中有多個記憶體區塊共用單一記憶體堆疊:

HIDL MemoryBlock

圖 1. HIDL MemoryBlock 架構

一般使用

本節提供使用 MemoryBlock 的範例,首先宣告 HAL,然後實作 HAL。

宣告 HAL

以下是 IFoo HAL 的範例:

import android.hidl.memory.block@1.0::MemoryBlock;

interface IFoo {
    getSome() generates(MemoryBlock block);
    giveBack(MemoryBlock block);
};

Android.bp 如下所示:

hidl_interface {
    ...
    srcs: [
        "IFoo.hal",
    ],
    interfaces: [
        "android.hidl.memory.block@1.0",
        ...
};

實作 HAL

如要實作 HAL 範例,請按照下列步驟操作:

  1. 取得 hidl_memory (詳情請參閱 HIDL C++)。

    #include <android/hidl/allocator/1.0/IAllocator.h>
    
    using ::android::hidl::allocator::V1_0::IAllocator;
    using ::android::hardware::hidl_memory;
    ...
      sp<IAllocator> allocator = IAllocator::getService("ashmem");
      allocator->allocate(2048, [&](bool success, const hidl_memory& mem)
      {
            if (!success) { /* error */ }
            // you can now use the hidl_memory object 'mem' or pass it
      }));
    
  2. 使用已取得的 hidl_memory 建立 HidlMemoryDealer 例項:

    #include <hidlmemory/HidlMemoryDealer.h>
    
    using ::android::hardware::HidlMemoryDealer
    /* The mem argument is acquired in the Step1, returned by the ashmemAllocator->allocate */
    sp<HidlMemoryDealer> memory_dealer = HidlMemoryDealer::getInstance(mem);
    
  3. 分配 MemoryBlock,這是使用 HIDL 定義的結構體。

    MemoryBlock 範例:

    struct MemoryBlock {
    IMemoryToken token;
    uint64_t size;
    uint64_t offset;
    };
    

    使用 MemoryDealer 分配 MemoryBlock 的範例:

    #include <android/hidl/memory/block/1.0/types.h>
    
    using ::android::hidl::memory::block::V1_0::MemoryBlock;
    
    Return<void> Foo::getSome(getSome_cb _hidl_cb) {
        MemoryBlock block = memory_dealer->allocate(1024);
        if(HidlMemoryDealer::isOk(block)){
            _hidl_cb(block);
        ...
    
  4. 取消配置 MemoryBlock

    Return<void> Foo::giveBack(const MemoryBlock& block) {
        memory_dealer->deallocate(block.offset);
    ...
    
  5. 操控資料:

    #include <hidlmemory/mapping.h>
    #include <android/hidl/memory/1.0/IMemory.h>
    
    using ::android::hidl::memory::V1_0::IMemory;
    
    sp<IMemory> memory = mapMemory(block);
    uint8_t* data =
    
    static_cast<uint8_t*>(static_cast<void*>(memory->getPointer()));
    
  6. 設定 Android.bp

    shared_libs: [
            "android.hidl.memory@1.0",
    
            "android.hidl.memory.block@1.0"
    
            "android.hidl.memory.token@1.0",
            "libhidlbase",
            "libhidlmemory",
    
  7. 查看流程,判斷是否需要 lockMemory

    通常,MemoryBlock 會使用參照計數來維護共用 hidl_memory,而這項作業會在其 MemoryBlock instances is mapped and ismunmap()-ed when nothing refers to it. To keephidl_memoryalways mapped, you can uselockMemory, a RAII style object that keeps the correspondinghidl_memory` 第一次對應至整個鎖定週期時,以 mmap() 形式執行。例子:

    #include <hidlmemory/mapping.h>
    
    sp<RefBase> lockMemory(const sp<IMemoryToken> key);
    

擴充用途

本節提供 MemoryBlock 的延伸用法詳細資料。

使用參照計數管理 MemoryBlock

在大多數情況下,使用 MemoryBlock 最有效率的方法是明確地配置/釋放。不過,在複雜的應用程式中,使用參照計數進行垃圾收集可能會是較好的做法。如要在 MemoryBlock 上取得參考數量,您可以將 MemoryBlock 與繫結器物件繫結,這有助於計算參照,並在計數降為零時取消分配 MemoryBlock

宣告 HAL

宣告 HAL 時,請說明含有 MemoryBlock 例項和 IBase 的 HIDL 結構體:

import android.hidl.memory.block@1.0::MemoryBlock;

struct MemoryBlockAllocation {
    MemoryBlock block;
    IBase refcnt;
};

使用 MemoryBlockAllocation 取代 MemoryBlock,並移除傳回 MemoryBlock 的方法。系統會透過 MemoryBlockAllocation 的參照計數來釋放。例子:

interface IFoo {
    allocateSome() generates(MemoryBlockAllocation allocation);
};

實作 HAL

HAL 的服務端實作範例:

class MemoryBlockRefCnt: public virtual IBase {
   MemoryBlockRefCnt(uint64_t offset, sp<MemoryDealer> dealer)
     : mOffset(offset), mDealer(dealer) {}
   ~MemoryBlockRefCnt() {
       mDealer->deallocate(mOffset);
   }
 private:
   uint64_t mOffset;
   sp<MemoryDealer> mDealer;
};

Return<void> Foo::allocateSome(allocateSome_cb _hidl_cb) {
    MemoryBlockAllocation allocation;
    allocation.block = memory_dealer->allocate(1024);
    if(HidlMemoryDealer::isOk(block)){
        allocation.refcnt= new MemoryBlockRefCnt(...);
        _hidl_cb(allocation);

HAL 用戶端實作範例:

ifoo->allocateSome([&](const MemoryBlockAllocation& allocation){
    ...
);

附加及擷取中繼資料

部分應用程式需要額外資料才能綁定已分配的 MemoryBlock。您可以透過兩種方式附加及擷取中繼資料:

  • 如果應用程式存取中繼資料的頻率與區塊本身相同,請附加中繼資料,並在結構體中傳遞所有中繼資料。例子:

    import android.hidl.memory.block@1.0::MemoryBlock;
    
    struct MemoryBlockWithMetaData{
        MemoryBlock block;
        MetaDataStruct metaData;
    };
    
  • 如果應用程式存取中繼資料的頻率遠低於區塊,則使用介面被動傳遞中繼資料會更有效率。例子:

    import android.hidl.memory.block@1.0::MemoryBlock;
    
    struct MemoryBlockWithMetaData{
        MemoryBlock block;
        IMetaData metaData;
    };
    

    接下來,請使用 MemoryDealer 將中繼資料繫結至 MemoryBlock。例子:

    MemoryBlockWithMetaData memory_block;
    memory_block.block = dealer->allocate(size);
    if(HidlMemoryDealer::isOk(block)){
        memory_block.metaData = new MetaData(...);