Android एनडीके, आपके ऐप्लिकेशन के लिए C और C++ कोड को कंपाइल करने के लिए, CMake का इस्तेमाल करने की सुविधा देता है. इस पेज पर, Android Gradle प्लग इन के ExternalNativeBuild या सीधे CMake को कॉल करके, एनडीके के साथ CMake इस्तेमाल करने का तरीका बताया गया है.
CMake टूलचेन फ़ाइल
NDK, टूलचेन फ़ाइल के ज़रिए CMake के साथ काम करता है. टूलचेन फ़ाइलें, CMake फ़ाइलें होती हैं. ये क्रॉस-कंपाइल करने के लिए, टूलचेन के काम करने के तरीके को पसंद के मुताबिक बनाती हैं. NDK के लिए इस्तेमाल की जाने वाली टूल चेन फ़ाइल, NDK में <NDK>/build/cmake/android.toolchain.cmake पर मौजूद होती है.
cmake को शुरू करते समय, कमांड लाइन पर एबीआई, minSdkVersion वगैरह जैसे बिल्ड पैरामीटर दिए जाते हैं. इस्तेमाल किए जा सकने वाले आर्ग्युमेंट की सूची देखने के लिए, टूलचेन आर्ग्युमेंट सेक्शन देखें.
"नई" टूलचेन फ़ाइल
NDK के पुराने वर्शन में, टूलचेन फ़ाइल को लागू करने के नए तरीके को आज़माया गया था. इससे, NDK की टूलचेन फ़ाइल और पहले से मौजूद CMake की सुविधा का इस्तेमाल करने के बीच के अंतर को कम किया जा सकता था. इसकी वजह से, हमें काफ़ी काम करना पड़ा (जो अब तक पूरा नहीं हुआ है). हालांकि, इससे असल में कोई सुधार नहीं हुआ. इसलिए, अब हम इस पर काम नहीं कर रहे हैं.
"लेगसी" टूल चेन फ़ाइल की तुलना में, "नई" टूल चेन फ़ाइल के काम करने के तरीके में कुछ गड़बड़ियां हैं. डिफ़ॉल्ट ऐक्शन और सेटिंग, सुझाया गया वर्कफ़्लो है. अगर -DANDROID_USE_LEGACY_TOOLCHAIN_FILE=OFF का इस्तेमाल किया जा रहा है, तो हमारा सुझाव है कि आप अपने बिल्ड से उस फ़्लैग को हटा दें. नई टूलचेन फ़ाइल, लेगसी टूलचेन फ़ाइल के बराबर कभी नहीं थी. इसलिए, हो सकता है कि इसके काम करने के तरीके में कुछ गड़बड़ियां हों.
हमारा सुझाव है कि नई टूलचेन फ़ाइल का इस्तेमाल न करें. हालांकि, फ़िलहाल इसे एनडीके से हटाने का कोई प्लान नहीं है. ऐसा करने से, उन बिल्ड पर असर पड़ेगा जो नए और लेगसी टूल चेन फ़ाइलों के बीच के व्यवहार के अंतर पर निर्भर करते हैं. साथ ही, विकल्प का नाम बदलकर यह साफ़ तौर पर बताना कि "लेगसी" का इस्तेमाल करने का सुझाव दिया जाता है, उस विकल्प का इस्तेमाल करने वाले उपयोगकर्ताओं पर भी असर डालेगा. अगर आपको नई टूल चेन फ़ाइल का इस्तेमाल करने में कोई समस्या नहीं आ रही है, तो आपको डेटा दूसरी जगह भेजने की ज़रूरत नहीं है. हालांकि, ध्यान रखें कि नई टूल चेन फ़ाइल के काम करने के तरीके से जुड़ी किसी भी गड़बड़ी को शायद ठीक न किया जाए. इसके बजाय, आपको डेटा दूसरी जगह भेजना होगा.
इस्तेमाल
ग्रेडल
externalNativeBuild का इस्तेमाल करने पर, CMake टूलचेन फ़ाइल का इस्तेमाल अपने-आप होता है. ज़्यादा जानकारी के लिए, Android Studio की अपने प्रोजेक्ट में C और C++ कोड जोड़ें गाइड देखें.
आदेश पंक्ति
Gradle के बाहर CMake के साथ बिल्ड करते समय, टूलचेन फ़ाइल और उसके आर्ग्युमेंट को CMake को पास करना ज़रूरी है. उदाहरण के लिए:
$ cmake \
-DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake \
-DANDROID_ABI=$ABI \
-DANDROID_PLATFORM=android-$MINSDKVERSION \
$OTHER_ARGS
टूल चेन आर्ग्युमेंट
CMake टूलचेन फ़ाइल में ये आर्ग्युमेंट पास किए जा सकते हैं. अगर Gradle का इस्तेमाल करके बिल्ड किया जा रहा है, तो android.defaultConfig.externalNativeBuild.cmake.arguments में आर्ग्युमेंट जोड़ें. इसके बारे में ExternalNativeBuild दस्तावेज़ में बताया गया है. अगर कमांड लाइन से बिल्ड किया जा रहा है, तो -D के साथ CMake को आर्ग्युमेंट पास करें. उदाहरण के लिए, armeabi-v7a को Neon की सुविधा के साथ न बनाने के लिए, -DANDROID_ARM_NEON=FALSE पास करें.
ANDROID_ABI
टारगेट एबीआई. इस्तेमाल किए जा सकने वाले एबीआई के बारे में जानकारी पाने के लिए, Android एबीआई देखें.
ग्रेडल
Gradle, इस आर्ग्युमेंट को अपने-आप उपलब्ध कराता है. अपनी build.gradle फ़ाइल में इस आर्ग्युमेंट को साफ़ तौर पर सेट न करें. Gradle किन एबीआई को टारगेट करे, यह कंट्रोल करने के लिए abiFilters का इस्तेमाल करें. इसके बारे में Android एबीआई में बताया गया है.
आदेश पंक्ति
CMake, हर बिल्ड के लिए एक टारगेट बनाता है. एक से ज़्यादा Android एबीआई को टारगेट करने के लिए, आपको हर एबीआई के लिए एक बार बिल्ड करना होगा. हमारा सुझाव है कि हर एबीआई के लिए अलग-अलग बिल्ड डायरेक्ट्री का इस्तेमाल करें, ताकि बिल्ड के बीच टकराव न हो.
| वैल्यू | नोट |
|---|---|
armeabi-v7a |
|
armeabi-v7a with NEON |
armeabi-v7a की तरह. |
arm64-v8a |
|
x86 |
|
x86_64 |
ANDROID_ARM_MODE
इससे यह तय होता है कि armeabi-v7a के लिए, arm या thumb निर्देश जनरेट करने हैं या नहीं. इसका असर अन्य एबीआई पर नहीं पड़ता. ज़्यादा जानकारी के लिए, Android एबीआई का दस्तावेज़ देखें.
| वैल्यू | नोट |
|---|---|
| ग्रुप | |
| अंगूठा | डिफ़ॉल्ट ऐक्शन और सेटिंग. |
ANDROID_NATIVE_API_LEVEL
ANDROID_PLATFORM का दूसरा नाम.
ANDROID_PLATFORM
इससे पता चलता है कि ऐप्लिकेशन या लाइब्रेरी, कम से कम किस एपीआई लेवल पर काम करती है. यह वैल्यू, ऐप्लिकेशन के minSdkVersion से मेल खाती है.
ग्रेडल
Android Gradle प्लग इन का इस्तेमाल करने पर, यह वैल्यू अपने-आप सेट हो जाती है, ताकि ऐप्लिकेशन के minSdkVersion से मैच हो सके. इसे मैन्युअल तरीके से सेट नहीं किया जाना चाहिए.
आदेश पंक्ति
CMake को सीधे तौर पर शुरू करने पर, यह वैल्यू डिफ़ॉल्ट रूप से इस्तेमाल किए जा रहे एनडीके के साथ काम करने वाले सबसे कम एपीआई लेवल पर सेट हो जाती है. उदाहरण के लिए, NDK r20 के साथ यह वैल्यू डिफ़ॉल्ट रूप से एपीआई लेवल 16 पर सेट होती है.
इस पैरामीटर के लिए, एक से ज़्यादा फ़ॉर्मैट स्वीकार किए जाते हैं:
android-$API_LEVEL$API_LEVELandroid-$API_LETTER
$API_LETTER फ़ॉर्मैट की मदद से, android-N की जानकारी दी जा सकती है. इसके लिए, आपको उस रिलीज़ से जुड़ी संख्या तय करने की ज़रूरत नहीं होती. ध्यान दें कि कुछ रिलीज़ में,
एपीआई लेवल तो बढ़ा, लेकिन लेटर नहीं. इन एपीआई के बारे में बताने के लिए, सफ़िक्स के तौर पर -MR1 जोड़ें. उदाहरण के लिए, एपीआई लेवल 25, android-N-MR1 है.
ANDROID_STL
इससे पता चलता है कि इस ऐप्लिकेशन के लिए किस एसटीएल का इस्तेमाल करना है. ज़्यादा जानकारी के लिए, C++ लाइब्रेरी के लिए सहायता लेख पढ़ें. डिफ़ॉल्ट रूप से, c++_static का इस्तेमाल किया जाएगा.
| वैल्यू | नोट |
|---|---|
| c++_shared | libc++ का शेयर की गई लाइब्रेरी वाला वैरिएंट. |
| c++_static | libc++ का स्टैटिक लाइब्रेरी वैरिएंट. |
| कोई नहीं | C++ स्टैंडर्ड लाइब्रेरी का इस्तेमाल नहीं किया जा सकता. |
| सिस्टम | सिस्टम एसटीएल |
कंपाइलर फ़्लैग मैनेज करना
अगर आपको अपने बिल्ड के लिए कंपाइलर या लिंकर को खास फ़्लैग पास करने हैं, तो set_target_compile_options और इससे जुड़े विकल्पों के लिए, CMake दस्तावेज़ देखें. उस पेज पर सबसे नीचे मौजूद "यह भी देखें" सेक्शन में, कुछ मददगार संकेत दिए गए हैं.
आम तौर पर, सबसे सही तरीका यह है कि कंपाइलर फ़्लैग को सबसे छोटे उपलब्ध स्कोप के तौर पर लागू किया जाए. ऐसे फ़्लैग जिन्हें आपको अपने सभी टारगेट पर लागू करना है (जैसे कि -Werror), उन्हें हर मॉड्यूल के लिए दोहराना मुश्किल होता है. हालांकि, उन्हें अब भी ग्लोबल तौर पर (CMAKE_CXX_FLAGS) लागू नहीं किया जाना चाहिए, क्योंकि इससे आपके प्रोजेक्ट में तीसरे पक्ष की डिपेंडेंसी पर अनचाहे असर पड़ सकते हैं. ऐसे मामलों में, फ़्लैग को डायरेक्ट्री-स्कोप (add_compile_options) पर लागू किया जा सकता है.
कंपाइलर फ़्लैग के छोटे सबसेट के लिए, उन्हें cppFlags या मिलती-जुलती प्रॉपर्टी का इस्तेमाल करके, आपकी build.gradle फ़ाइल में भी सेट किया जा सकता है. आपको ऐसा नहीं करना चाहिए. Gradle से CMake को पास किए गए फ़्लैग, प्राथमिकता के हिसाब से काम करेंगे. कुछ मामलों में, ये फ़्लैग उन फ़्लैग को बदल देंगे जो Android कोड बनाने के लिए ज़रूरी हैं. CMake के व्यवहार को सीधे CMake में मैनेज करना हमेशा बेहतर होता है. अगर आपको हर एजीपी buildType के लिए कंपाइलर फ़्लैग कंट्रोल करने हैं, तो CMake में एजीपी बिल्ड टाइप के साथ काम करना लेख पढ़ें.
CMake में एजीपी बिल्ड टाइप के साथ काम करना
अगर आपको CMake के व्यवहार को कस्टम Gradle buildType के हिसाब से बनाना है, तो उस बिल्ड टाइप का इस्तेमाल करके, एक अतिरिक्त CMake फ़्लैग (कंपाइलर फ़्लैग नहीं) पास करें, जिसे आपकी CMake बिल्ड स्क्रिप्ट पढ़ सकें. उदाहरण के लिए, अगर आपके पास "मुफ़्त" और "प्रीमियम" बिल्ड के वैरिएंट हैं जिन्हें build.gradle.kts से कंट्रोल किया जाता है और आपको वह डेटा CMake को पास करना है, तो:
android {
buildTypes {
free {
externalNativeBuild {
cmake {
arguments.add("-DPRODUCT_VARIANT_PREMIUM=OFF")
}
}
}
premium {
externalNativeBuild {
cmake {
arguments.add("-DPRODUCT_VARIANT_PREMIUM=ON")
}
}
}
}
}
इसके बाद, CMakeLists.txt में:
if (DPRODUCT_VARIANT_PREMIUM)
# Do stuff for the premium build.
else()
# Do stuff for the free build.
endif()
वैरिएबल का नाम कुछ भी रखा जा सकता है. हालांकि, पक्का करें कि नाम में ANDROID_, APP_ या CMAKE_ प्रीफ़िक्स का इस्तेमाल न किया गया हो. इससे, मौजूदा फ़्लैग के साथ टकराव या भ्रम की स्थिति से बचा जा सकता है.
उदाहरण के लिए, सैनिटाइज़र एनडीके सैंपल देखें.
CMake बिल्ड कमांड को समझना
CMake बिल्ड से जुड़ी समस्याओं को डीबग करते समय, उन बिल्ड आर्ग्युमेंट के बारे में जानना मददगार होता है जिनका इस्तेमाल Gradle, Android के लिए क्रॉस-कंपाइल करते समय करता है.
Android Gradle प्लगिन, हर एबीआई और बिल्ड टाइप के लिए, CMake बिल्ड को लागू करने के लिए इस्तेमाल किए जाने वाले बिल्ड आर्ग्युमेंट को build_command.txt में सेव करता है. ये फ़ाइलें इस डायरेक्ट्री में मौजूद होती हैं:
<project-root>/<module-root>/.cxx/cmake/<build-type>/<ABI>/
यहां दिए गए स्निपेट में, CMake आर्ग्युमेंट का एक उदाहरण दिया गया है. इससे armeabi-v7a आर्किटेक्चर को टारगेट करने वाले hello-jni सैंपल की डीबग करने लायक रिलीज़ बनाई जा सकती है.
Executable : ${HOME}/Android/Sdk/cmake/3.10.2.4988404/bin/cmake
arguments :
-H${HOME}/Dev/github-projects/googlesamples/ndk-samples/hello-jni/app/src/main/cpp
-DCMAKE_FIND_ROOT_PATH=${HOME}/Dev/github-projects/googlesamples/ndk-samples/hello-jni/app/.cxx/cmake/universalDebug/prefab/armeabi-v7a/prefab
-DCMAKE_BUILD_TYPE=Debug
-DCMAKE_TOOLCHAIN_FILE=${HOME}/Android/Sdk/ndk/22.1.7171670/build/cmake/android.toolchain.cmake
-DANDROID_ABI=armeabi-v7a
-DANDROID_NDK=${HOME}/Android/Sdk/ndk/22.1.7171670
-DANDROID_PLATFORM=android-23
-DCMAKE_ANDROID_ARCH_ABI=armeabi-v7a
-DCMAKE_ANDROID_NDK=${HOME}/Android/Sdk/ndk/22.1.7171670
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=${HOME}/Dev/github-projects/googlesamples/ndk-samples/hello-jni/app/build/intermediates/cmake/universalDebug/obj/armeabi-v7a
-DCMAKE_RUNTIME_OUTPUT_DIRECTORY=${HOME}/Dev/github-projects/googlesamples/ndk-samples/hello-jni/app/build/intermediates/cmake/universalDebug/obj/armeabi-v7a
-DCMAKE_MAKE_PROGRAM=${HOME}/Android/Sdk/cmake/3.10.2.4988404/bin/ninja
-DCMAKE_SYSTEM_NAME=Android
-DCMAKE_SYSTEM_VERSION=23
-B${HOME}/Dev/github-projects/googlesamples/ndk-samples/hello-jni/app/.cxx/cmake/universalDebug/armeabi-v7a
-GNinja
jvmArgs :
Build command args: []
Version: 1
पहले से बनी लाइब्रेरी का इस्तेमाल करना
अगर आपको पहले से बनी ऐसी लाइब्रेरी इंपोर्ट करनी है जिसे एएआर के तौर पर डिस्ट्रिब्यूट किया गया है, तो उसे इंपोर्ट और इस्तेमाल करने के लिए, Studio के डिपेंडेंसी दस्तावेज़ देखें. अगर एजीपी का इस्तेमाल नहीं किया जा रहा है, तो https://google.github.io/prefab/example-workflow.html पर जाएं. हालांकि, एजीपी पर माइग्रेट करना ज़्यादा आसान है.
ऐसी लाइब्रेरी जो एएआर के तौर पर उपलब्ध नहीं कराई जाती हैं उनके लिए, CMake के साथ पहले से बनी लाइब्रेरी इस्तेमाल करने के निर्देश देखें. इसके लिए, CMake मैन्युअल में IMPORTED टारगेट के बारे में add_library दस्तावेज़ देखें.
तीसरे पक्ष का कोड बनाना
अपने CMake प्रोजेक्ट के हिस्से के तौर पर, तीसरे पक्ष का कोड बनाने के कुछ तरीके हैं. इनमें से कौनसा विकल्प सबसे सही रहेगा, यह आपकी स्थिति पर निर्भर करेगा. सबसे अच्छा विकल्प यह होगा कि ऐसा बिलकुल न किया जाए. इसके बजाय, लाइब्रेरी के लिए एक एएआर बनाएं और उसे अपने ऐप्लिकेशन में इस्तेमाल करें. यह ज़रूरी नहीं है कि आप उस एएआर को पब्लिश करें. यह आपके Gradle प्रोजेक्ट का इंटरनल मॉड्यूल हो सकता है.
अगर ऐसा नहीं किया जा सकता, तो:
- तीसरे पक्ष के सोर्स को अपने डेटाबेस में कॉपी करें और उसे बनाने के लिए, add_subdirectory का इस्तेमाल करें. यह सिर्फ़ तब काम करता है, जब दूसरी लाइब्रेरी भी CMake की मदद से बनाई गई हो.
- ExternalProject तय करें.
- लाइब्रेरी को अपने प्रोजेक्ट से अलग बनाएं और इसे पहले से बनी लाइब्रेरी के तौर पर इंपोर्ट करने के लिए, पहले से बनी लाइब्रेरी का इस्तेमाल करें को फ़ॉलो करें.
CMake में YASM की सुविधा
NDK, YASM में लिखे गए असेंबली कोड को बनाने के लिए CMake की सुविधा देता है. इससे, x86 और x86-64 आर्किटेक्चर पर कोड को चलाया जा सकता है. YASM, x86 और x86-64 आर्किटेक्चर के लिए एक ओपन-सोर्स असेंबलर है. यह NASM असेंबलर पर आधारित है.
CMake की मदद से असेंबली कोड बनाने के लिए, अपने प्रोजेक्ट के CMakeLists.txt में ये बदलाव करें:
enable_languageको कॉल करें और वैल्यू कोASM_NASMपर सेट करें.- शेयर की गई लाइब्रेरी या एक्ज़ीक्यूटेबल बाइनरी बनाने के आधार पर,
add_libraryयाadd_executableको कॉल करें. आर्ग्युमेंट में, सोर्स फ़ाइलों की एक सूची पास करें. इसमें YASM में असेंबली प्रोग्राम के लिए.asmफ़ाइलें और उससे जुड़ी C लाइब्रेरी या फ़ंक्शन के लिए.cफ़ाइलें शामिल हों.
यहां दिए गए स्निपेट में बताया गया है कि YASM प्रोग्राम को शेयर की गई लाइब्रेरी के तौर पर बनाने के लिए, CMakeLists.txt को कैसे कॉन्फ़िगर किया जा सकता है.
cmake_minimum_required(VERSION 3.6.0)
enable_language(ASM_NASM)
add_library(test-yasm SHARED jni/test-yasm.c jni/print_hello.asm)
YASM प्रोग्राम को एक्ज़ीक्यूटेबल के तौर पर बनाने का उदाहरण देखने के लिए, एनडीके Git रिपॉज़िटरी में yasm टेस्ट देखें.
समस्याओं की शिकायत करना
अगर आपको एनडीके या इसकी CMake टूलचेन फ़ाइल से जुड़ी कोई समस्या आती है, तो GitHub पर android-ndk/ndk समस्या ट्रैकर की मदद से उसकी शिकायत करें. Gradle या Android Gradle प्लग इन से जुड़ी समस्याओं के लिए, Studio की गड़बड़ी की शिकायत करें.