Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

Dukungan Sistem Bangun VNDK

Di Android 8.1 dan lebih tinggi, sistem build memiliki dukungan VNDK bawaan. Jika dukungan VNDK diaktifkan, sistem build akan memeriksa dependensi antar modul, membuat varian khusus vendor untuk modul vendor, dan secara otomatis menginstal modul tersebut ke direktori yang ditentukan.

Contoh dukungan build VNDK

Dalam contoh ini, definisi modul Android.bp mendefinisikan sebuah pustaka bernama libexample . Properti vendor_available menunjukkan modul kerangka kerja dan modul vendor mungkin bergantung pada libexample :

libexample vendor_available: true dan vndk.enabled: true

Gambar 1. Dukungan VNDK diaktifkan

Baik kerangka kerja yang dapat dieksekusi /system/bin/foo dan vendor yang dapat dieksekusi /vendor/bin/bar bergantung pada libexample dan memiliki libexample di properti shared_libs mereka.

Jika libexample digunakan oleh modul framework dan modul vendor, dua varian libexample akan dibuat. Varian inti (dinamai libexample ) digunakan oleh modul framework dan varian vendor (dinamai libexample.vendor ) digunakan oleh modul vendor. Kedua varian dipasang ke direktori yang berbeda:

  • Varian inti dipasang ke /system/lib[64]/libexample.so .
  • Varian vendor diinstal ke VNDK APEX karena vndk.enabled true .

Untuk detail selengkapnya, lihat Definisi modul .

Mengonfigurasi dukungan build

Untuk mengaktifkan dukungan sistem build penuh untuk perangkat produk, tambahkan BOARD_VNDK_VERSION ke BoardConfig.mk :

BOARD_VNDK_VERSION := current

Pengaturan ini memiliki efek global : Ketika ditentukan di BoardConfig.mk , semua modul dicentang. Karena tidak ada mekanisme untuk memasukkan ke daftar hitam atau daftar putih modul yang melanggar, Anda harus membersihkan semua dependensi yang tidak perlu sebelum menambahkan BOARD_VNDK_VERSION . Anda dapat menguji dan mengompilasi modul dengan menyetel BOARD_VNDK_VERSION di variabel lingkungan Anda:

$ BOARD_VNDK_VERSION=current m module_name.vendor

Saat BOARD_VNDK_VERSION diaktifkan, beberapa jalur pencarian header global default dihapus . Ini termasuk:

  • frameworks/av/include
  • frameworks/native/include
  • frameworks/native/opengl/include
  • hardware/libhardware/include
  • hardware/libhardware_legacy/include
  • hardware/ril/include
  • libnativehelper/include
  • libnativehelper/include_deprecated
  • system/core/include
  • system/media/audio/include

Jika modul bergantung pada header dari direktori ini, Anda harus menentukan (secara eksplisit) dependensi dengan header_libs , static_libs , dan / atau shared_libs .

VNDK APEX

Di Android 10 dan lebih rendah, modul dengan vndk.enabled diinstal di /system/lib[64]/vndk[-sp]-${VER} . Di Android 11 dan lebih tinggi, pustaka VNDK dikemas dalam format APEX dan nama VNDK APEX adalah com.android.vndk.v${VER} . Bergantung pada konfigurasi perangkat, VNDK APEX diratakan atau tidak diratakan dan tersedia dari jalur kanonis /apex/com.android.vndk.v${VER} .

VNDK APEX

Gambar 2. VNDK APEX

Definisi modul

Untuk membangun Android dengan BOARD_VNDK_VERSION , Anda harus merevisi definisi modul di Android.mk atau Android.bp . Bagian ini menjelaskan berbagai jenis definisi modul, beberapa properti modul terkait VNDK, dan pemeriksaan dependensi yang diimplementasikan dalam sistem build.

Modul vendor

Modul vendor adalah executable khusus vendor atau pustaka bersama yang harus diinstal ke dalam partisi vendor. Dalam file Android.bp , modul vendor harus menyetel vendor atau properti kepemilikan ke true . Dalam file Android.mk , modul vendor harus menyetel LOCAL_VENDOR_MODULE atau LOCAL_PROPRIETARY_MODULE menjadi true .

Jika BOARD_VNDK_VERSION ditentukan, sistem build akan melarang dependensi antara modul vendor dan modul framework dan mengeluarkan kesalahan jika:

  • modul tanpa vendor:true bergantung pada modul dengan vendor:true , atau
  • sebuah modul dengan vendor:true bergantung pada modul non- llndk_library yang tidak memiliki vendor:true atau vendor_available:true .

Pemeriksaan ketergantungan berlaku untuk header_libs , static_libs , dan shared_libs di Android.bp , dan untuk LOCAL_HEADER_LIBRARIES , LOCAL_STATIC_LIBRARIES , dan LOCAL_SHARED_LIBRARIES di Android.mk .

LL-NDK

Library bersama LL-NDK adalah library bersama dengan ABI yang stabil. Baik kerangka kerja dan modul vendor berbagi implementasi yang sama dan terbaru. Untuk setiap library bersama LL-NDK, Android.bp berisi definisi modul llndk_library :

llndk_library {
    name: "libvndksupport",
    symbol_file: "libvndksupport.map.txt",
}

Definisi modul ini menetapkan nama modul dan file simbol yang menjelaskan simbol yang terlihat oleh modul vendor. Sebagai contoh:

LIBVNDKSUPPORT {
  global:
    android_load_sphal_library; # llndk
    android_unload_sphal_library; # llndk
  local:
    *;
};

Berdasarkan file simbol, sistem build menghasilkan pustaka bersama rintisan untuk modul vendor, yang ditautkan dengan pustaka ini saat BOARD_VNDK_VERSION diaktifkan. Simbol disertakan dalam pustaka bersama rintisan hanya jika:

  • Tidak ditentukan di bagian yang diakhiri dengan _PRIVATE atau _PLATFORM ,
  • Tidak memiliki #platform-only tag khusus #platform-only , dan
  • Tidak memiliki #introduce* tag #introduce* atau tag yang cocok dengan target.

VNDK

Dalam file Android.bp , definisi modul cc_library , cc_library_static , cc_library_shared , dan cc_library_headers mendukung tiga properti terkait vendor_available : vendor_available , vndk.enabled , dan vndk.support_system_process .

Jika vendor_available atau vndk.enabled true , dua varian ( inti dan vendor ) dapat dibuat. Varian inti harus diperlakukan sebagai modul kerangka kerja dan varian vendor harus diperlakukan sebagai modul vendor. Jika beberapa modul framework bergantung pada modul ini, varian inti akan dibuat. Jika beberapa modul vendor bergantung pada modul ini, varian vendor dibuat. Sistem build memberlakukan pemeriksaan dependensi berikut:

  • Varian inti selalu hanya untuk kerangka kerja dan tidak dapat diakses oleh modul vendor.
  • Varian vendor selalu tidak dapat diakses oleh modul framework.
  • Semua dependensi varian vendor, yang ditentukan di header_libs , static_libs , dan / atau shared_libs , harus berupa llndk_library atau modul dengan vendor_available atau vndk.enabled .
  • Jika vendor_available true , varian vendor dapat diakses oleh semua modul vendor.
  • Jika vendor_available false , varian vendor hanya dapat diakses oleh modul VNDK atau VNDK-SP lain (mis., Modul dengan vendor:true tidak dapat menautkan vendor_available:false modul vendor_available:false ).

Jalur penginstalan default untuk cc_library atau cc_library_shared ditentukan oleh aturan berikut:

  • Varian inti diinstal ke /system/lib[64] .
  • Jalur penginstalan varian vendor mungkin berbeda:
    • Jika vndk.enabled false , varian vendor diinstal ke /vendor/lib[64] .
    • Jika vndk.enabled true , varian vendor diinstal ke VNDK APEX ( com.android.vndk.v${VER} ).

Tabel di bawah merangkum cara sistem build menangani varian vendor:

vendor_available vndk
diaktifkan
vndk
support_same_process
Deskripsi varian vendor
true false false Varian vendor HANYA VND . Perpustakaan bersama dipasang ke /vendor/lib[64] .
true Tidak valid (Kesalahan versi)
true false Varian vendornya adalah VNDK . Perpustakaan bersama dipasang ke VNDK APEX.
true Varian vendornya adalah VNDK-SP . Perpustakaan bersama dipasang ke VNDK APEX.

false

false

false

Tidak ada varian vendor. Modul ini HANYA FWK .

true Tidak valid (Kesalahan versi)
true false Varian vendornya adalah VNDK-Private . Perpustakaan bersama dipasang ke VNDK APEX. Ini tidak boleh langsung digunakan oleh modul vendor.
true Varian vendornya adalah VNDK-SP-Private . Perpustakaan bersama dipasang ke VNDK APEX. Ini tidak boleh langsung digunakan oleh modul vendor.

Ekstensi VNDK

Ekstensi VNDK adalah pustaka bersama VNDK dengan API tambahan. Ekstensi diinstal ke /vendor/lib[64]/vndk[-sp] (tanpa akhiran versi) dan menimpa pustaka bersama VNDK asli saat runtime.

Mendefinisikan ekstensi VNDK

Di Android 9 dan lebih tinggi, Android.bp secara native mendukung ekstensi VNDK. Untuk membangun ekstensi VNDK, tentukan modul lain dengan vendor:true dan properti extends :

cc_library {
    name: "libvndk",
    vendor_available: true,
    vndk: {
        enabled: true,
    },
}

cc_library {
    name: "libvndk_ext",
    vendor: true,
    vndk: {
        enabled: true,
        extends: "libvndk",
    },
}

Sebuah modul dengan properti vendor:true , vndk.enabled:true , dan extends mendefinisikan ekstensi VNDK:

  • Properti extends harus menentukan nama pustaka bersama VNDK dasar (atau nama pustaka bersama VNDK-SP).
  • Ekstensi VNDK (atau ekstensi VNDK-SP) dinamai menurut nama modul dasar yang digunakan untuk memperluasnya. Misalnya, biner keluaran libvndk_ext adalah libvndk.so bukan libvndk_ext.so .
  • Ekstensi VNDK diinstal ke /vendor/lib[64]/vndk .
  • Ekstensi VNDK-SP diinstal ke /vendor/lib[64]/vndk-sp .
  • Pustaka bersama dasar harus memiliki vndk.enabled:true dan vendor_available:true .

Ekstensi VNDK-SP harus diperluas dari perpustakaan bersama VNDK-SP ( vndk.support_system_process harus sama):

Kejelasan 502b70

Ekstensi VNDK (atau ekstensi VNDK-SP) mungkin bergantung pada pustaka bersama vendor lain:

cc_library {
    name: "libvndk",
    vendor_available: true,
    vndk: {
        enabled: true,
    },
}

cc_library {
    name: "libvndk_ext",
    vendor: true,
    vndk: {
        enabled: true,
        extends: "libvndk",
    },
    shared_libs: [
        "libvendor",
    ],
}

cc_library {
    name: "libvendor",
    vendor: true,
}

Menggunakan ekstensi VNDK

Jika modul vendor bergantung pada API tambahan yang ditentukan oleh ekstensi VNDK, modul harus menentukan nama ekstensi VNDK di properti shared_libs -nya:

// A vendor shared library example
cc_library {
    name: "libvendor",
    vendor: true,
    shared_libs: [
        "libvndk_ext",
    ],
}

// A vendor executable example
cc_binary {
    name: "vendor-example",
    vendor: true,
    shared_libs: [
        "libvndk_ext",
    ],
}

Jika modul vendor bergantung pada ekstensi VNDK, ekstensi VNDK tersebut diinstal ke /vendor/lib[64]/vndk[-sp] secara otomatis. Jika modul tidak lagi bergantung pada ekstensi VNDK, tambahkan langkah bersih ke CleanSpec.mk untuk menghapus pustaka bersama. Sebagai contoh:

$(call add-clean-step, rm -rf $(TARGET_OUT_VENDOR)/lib/libvndk.so)

Kompilasi bersyarat

Bagian ini menjelaskan cara menangani perbedaan halus (misalnya menambahkan atau menghapus fitur dari salah satu varian) antara tiga pustaka bersama VNDK berikut:

  • Varian inti (misalnya /system/lib[64]/libexample.so )
  • Varian vendor (mis. /apex/com.android.vndk.v${VER}/lib[64]/libexample.so )
  • Ekstensi VNDK (misalnya /vendor/lib[64]/vndk[-sp]/libexample.so )

Bendera kompilator bersyarat

Sistem build Android menentukan __ANDROID_VNDK__ untuk varian vendor dan ekstensi VNDK secara default. Anda dapat melindungi kode dengan penjaga praprosesor C:

void all() { }

#if !defined(__ANDROID_VNDK__)
void framework_only() { }
#endif

#if defined(__ANDROID_VNDK__)
void vndk_only() { }
#endif

Selain __ANDROID_VNDK__ , berbeda cflags atau cppflags dapat ditentukan dalam Android.bp . The cflags atau cppflags ditentukan dalam target.vendor khusus untuk vendor varian.

Misalnya, Android.bp berikut mendefinisikan libexample dan libexample_ext :

cc_library {
    name: "libexample",
    srcs: ["src/example.c"],
    vendor_available: true,
    vndk: {
        enabled: true,
    },
    target: {
        vendor: {
            cflags: ["-DLIBEXAMPLE_ENABLE_VNDK=1"],
        },
    },
}

cc_library {
    name: "libexample_ext",
    srcs: ["src/example.c"],
    vendor: true,
    vndk: {
        enabled: true,
        extends: "libexample",
    },
    cflags: [
        "-DLIBEXAMPLE_ENABLE_VNDK=1",
        "-DLIBEXAMPLE_ENABLE_VNDK_EXT=1",
    ],
}

Dan ini adalah daftar kode src/example.c :

void all() { }

#if !defined(LIBEXAMPLE_ENABLE_VNDK)
void framework_only() { }
#endif

#if defined(LIBEXAMPLE_ENABLE_VNDK)
void vndk() { }
#endif

#if defined(LIBEXAMPLE_ENABLE_VNDK_EXT)
void vndk_ext() { }
#endif

Menurut dua file ini, sistem build menghasilkan pustaka bersama dengan simbol yang diekspor berikut:

Jalur instalasi Simbol yang diekspor
/system/lib[64]/libexample.so all , framework_only
/apex/com.android.vndk.v${VER}/lib[64]/libexample.so all , vndk
/vendor/lib[64]/vndk/libexample.so all , vndk , vndk_ext

Persyaratan pada simbol yang diekspor

Pemeriksa VNDK ABI membandingkan ABI varian vendor VNDK dan ekstensi VNDK dengan referensi dump ABI di bawah prebuilts/abi-dumps/vndk .

  • Simbol yang diekspor oleh varian vendor VNDK (misalnya /apex/com.android.vndk.v${VER}/lib[64]/libexample.so ) harus identik dengan (bukan superset dari) simbol yang ditentukan dalam dump ABI.
  • Simbol yang diekspor oleh ekstensi VNDK (misalnya /vendor/lib[64]/vndk/libexample.so ) harus berupa superset dari simbol yang ditentukan dalam dump ABI.

Jika varian vendor VNDK atau ekstensi VNDK gagal mengikuti persyaratan di atas, pemeriksa VNDK ABI mengeluarkan error build dan menghentikan build.

Mengecualikan file sumber atau pustaka bersama dari varian vendor

Untuk mengecualikan file sumber dari varian vendor, tambahkan file tersebut ke properti exclude_srcs . Demikian pula, untuk memastikan pustaka bersama tidak ditautkan dengan varian vendor, tambahkan pustaka tersebut ke properti exclude_shared_libs . Sebagai contoh:

cc_library {
    name: "libexample_cond_exclude",
    srcs: ["fwk.c", "both.c"],
    shared_libs: ["libfwk_only", "libboth"],
    vendor_available: true,
    target: {
        vendor: {
            exclude_srcs: ["fwk.c"],
            exclude_shared_libs: ["libfwk_only"],
        },
    },
}

Dalam contoh ini, varian inti libexample_cond_exclude menyertakan kode dari fwk.c dan both.c dan bergantung pada pustaka bersama libfwk_only dan libboth . Varian vendor libexample_cond_exclude hanya menyertakan kode dari both.c karena fwk.c dikecualikan oleh properti exclude_srcs . Demikian pula, ini hanya bergantung pada pustaka bersama libboth karena libfwk_only dikecualikan oleh properti exclude_shared_libs .

Ekspor header dari ekstensi VNDK

Ekstensi VNDK dapat menambahkan kelas baru atau fungsi baru ke perpustakaan bersama VNDK. Sebaiknya simpan deklarasi tersebut di header independen dan hindari mengubah header yang ada.

Misalnya, file header baru include-ext/example/ext/feature_name.h dibuat untuk ekstensi libexample_ext :

  • Android.bp
  • sertakan-ext / contoh / ext / feature_name.h
  • sertakan / contoh / contoh.h
  • src / example.c
  • src / ext / feature_name.c

Di Android.bp berikut, ekspor libexample hanya include , sedangkan libexample_ext mengekspor include dan include-ext . Ini memastikan feature_name.h tidak akan salah disertakan oleh pengguna libexample :

cc_library {
    name: "libexample",
    srcs: ["src/example.c"],
    export_include_dirs: ["include"],
    vendor_available: true,
    vndk: {
        enabled: true,
    },
}

cc_library {
    name: "libexample_ext",
    srcs: [
        "src/example.c",
        "src/ext/feature_name.c",
    ],
    export_include_dirs: [
        "include",
        "include-ext",
    ],
    vendor: true,
    vndk: {
        enabled: true,
        extends: "libexample",
    },
}

Jika memisahkan ekstensi ke file header independen tidak memungkinkan, alternatifnya adalah menambahkan pelindung #ifdef . Namun, pastikan bahwa semua pengguna ekstensi VNDK menambahkan flag define. Anda dapat mendefinisikan cc_defaults untuk menambahkan bendera define ke cflags dan menautkan pustaka bersama dengan shared_libs .

Misalnya, untuk menambahkan fungsi anggota baru Example2::get_b() ke ekstensi libexample2_ext , Anda harus mengubah file header yang ada dan menambahkan pelindung #ifdef :

#ifndef LIBEXAMPLE2_EXAMPLE_H_
#define LIBEXAMPLE2_EXAMPLE_H_

class Example2 {
 public:
  Example2();

  void get_a();

#ifdef LIBEXAMPLE2_ENABLE_VNDK_EXT
  void get_b();
#endif

 private:
  void *impl_;
};

#endif  // LIBEXAMPLE2_EXAMPLE_H_

Sebuah cc_defaults bernama libexample2_ext_defaults ditentukan untuk pengguna libexample2_ext :

cc_library {
    name: "libexample2",
    srcs: ["src/example2.cpp"],
    export_include_dirs: ["include"],
    vendor_available: true,
    vndk: {
        enabled: true,
    },
}

cc_library {
    name: "libexample2_ext",
    srcs: ["src/example2.cpp"],
    export_include_dirs: ["include"],
    vendor: true,
    vndk: {
        enabled: true,
        extends: "libexample2",
    },
    cflags: [
        "-DLIBEXAMPLE2_ENABLE_VNDK_EXT=1",
    ],
}

cc_defaults {
    name: "libexample2_ext_defaults",
    shared_libs: [
        "libexample2_ext",
    ],
    cflags: [
        "-DLIBEXAMPLE2_ENABLE_VNDK_EXT=1",
    ],
}

Pengguna libexample2_ext mungkin hanya menyertakan libexample2_ext_defaults di properti defaults mereka:

cc_binary {
    name: "example2_user_executable",
    defaults: ["libexample2_ext_defaults"],
    vendor: true,
}

Paket produk

Dalam sistem build Android, variabel PRODUCT_PACKAGES menentukan file executable, pustaka bersama, atau paket yang harus dipasang ke perangkat. Dependensi transitif dari modul yang ditentukan juga secara implisit diinstal ke perangkat.

Jika BOARD_VNDK_VERSION diaktifkan, modul dengan vendor_available atau vndk.enabled mendapatkan perlakuan khusus. Jika modul framework bergantung pada modul dengan vendor_available atau vndk.enabled , varian inti disertakan dalam set penginstalan transitif. Jika modul vendor bergantung pada modul dengan vendor_available , varian vendor disertakan dalam set penginstalan transitif. Namun, varian vendor modul dengan vndk.enabled diinstal apakah digunakan oleh modul vendor atau tidak.

Jika dependensi tidak terlihat oleh sistem build (mis. Pustaka bersama yang dapat dibuka dengan dlopen() runtime), Anda harus menentukan nama modul di PRODUCT_PACKAGES untuk menginstal modul tersebut secara eksplisit.

Jika modul memiliki vendor_available atau vndk.enabled , nama modul adalah singkatan dari varian intinya. Untuk menentukan varian vendor secara eksplisit di PRODUCT_PACKAGES , tambahkan akhiran .vendor ke nama modul. Sebagai contoh:

cc_library {
    name: "libexample",
    srcs: ["example.c"],
    vendor_available: true,
}

Dalam contoh ini, libexample adalah singkatan dari /system/lib[64]/libexample.so dan libexample.vendor adalah singkatan dari /vendor/lib[64]/libexample.so . Untuk memasang /vendor/lib[64]/libexample.so , tambahkan libexample.vendor ke PRODUCT_PACKAGES :

PRODUCT_PACKAGES += libexample.vendor