NDK入門:Android.mk的製作

0. Android.mk簡介:
Android.mk文件用來告知NDK Build 系統關於Source的信息。 Android.mk將是GNU Makefile的一部分,且將被Build System解析一次或多次。所以,請儘量少的在Android.mk中聲明變量,也不要假定任何東西不會在解析過程中定義。


Android.mk文件語法允許我們將Source打包成一個"modules". modules可以是:
靜態庫
動態庫。


只有動態庫可以被 install/copy到應用程序包(APK). 靜態庫則可以被鏈接入動態庫。
可以在一個Android.mk中定義一個或多個modules. 也可以將同一份source 加進多個modules.


Build System幫我們處理了很多細節而不需要我們再關心。例如:你不需要在Android.mk中列出頭文件和外部依賴文件。NDK Build System自動幫我們提供這些信息。這也意味着,當用戶升級NDK後,你將可以受益於新的toolchain/platform而不必再去修改Android.mk.




1. Android.mk語法:
首先看一個最簡單的Android.mk的例子:


LOCAL_PATH := $(call my-dir)


include $(CLEAR_VARS)


LOCAL_MODULE    := hello-jni
LOCAL_SRC_FILES := hello-jni.c


include $(BUILD_SHARED_LIBRARY)


講解如下:
LOCAL_PATH := $(call my-dir) 
每個Android.mk文件必須以定義LOCAL_PATH爲開始。它用於在開發tree中查找源文件。
宏my-dir 則由Build System提供。返回包含Android.mk的目錄路徑。


include $(CLEAR_VARS) 
CLEAR_VARS 變量由Build System提供。並指向一個指定的GNU Makefile,由它負責清理很多LOCAL_xxx.
例如:LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES等等。但不清理LOCAL_PATH. 這個清理動作是必須的,因爲所有的編譯控制文件由同一個GNU Make解析和執行,其變量是全局的。所以清理後才能避免相互影響。




LOCAL_MODULE    := hello-jni 
LOCAL_MODULE模塊必須定義,以表示Android.mk中的每一個模塊。名字必須唯一且不包含空格。Build System會自動添加適當的前綴和後綴。例如,foo,要產生動態庫,則生成libfoo.so.
但請注意:如果模塊名被定爲:libfoo.則生成libfoo.so. 不再加前綴。


LOCAL_SRC_FILES := hello-jni.c 
LOCAL_SRC_FILES變量必須包含將要打包如模塊的C/C++ 源碼。不必列出頭文件,build System 會自動幫我們找出依賴文件。
缺省的C++源碼的擴展名爲.cpp. 也可以修改,通過LOCAL_CPP_EXTENSION。




include $(BUILD_SHARED_LIBRARY) 
BUILD_SHARED_LIBRARY:是Build System提供的一個變量,指向一個GNU Makefile Script。它負責收集自從上次調用 include $(CLEAR_VARS)  後的所有LOCAL_XXX信息。並決定編譯爲什麼。


BUILD_STATIC_LIBRARY:編譯爲靜態庫。
BUILD_SHARED_LIBRARY :編譯爲動態庫
BUILD_EXECUTABLE:編譯爲Native C可執行程序






2. NDK Build System變量:
NDK Build System 保留以下變量名:
以LOCAL_  爲開頭的
以PRIVATE_ ,NDK_ 或者APP_ 開頭的名字。
小寫字母名字:如my-dir


如果想要定義自己在Android.mk中使用的變量名,建議添加 MY_ 前綴。


2.1: NDK提供的變量:
此類GNU Make變量是NDK Build System在解析Android.mk之前就定義好了的。


2.1.1:CLEAR_VARS:指向一個編譯腳本。必須在新模塊前包含之。
include $(CLEAR_VARS)


2.1.2:BUILD_SHARED_LIBRARY:指向一個編譯腳本,它收集自從上次調用 include $(CLEAR_VARS)  後的所有LOCAL_XXX信息。並決定如何將你列出的Source編譯成一個動態庫。
注意,在包含此文件前,至少應該包含:LOCAL_MODULE and LOCAL_SRC_FILES


例如:
include $(BUILD_SHARED_LIBRARY)




2.1.3:BUILD_STATIC_LIBRARY:與前面類似,它也指向一個編譯腳本,收集自從上次調用 include $(CLEAR_VARS)  後的所有LOCAL_XXX信息。並決定如何將你列出的Source編譯成一個靜態庫。
靜態庫不能夠加入到Project 或者APK中。但它可以用來生成動態庫。
LOCAL_STATIC_LIBRARIES and LOCAL_WHOLE_STATIC_LIBRARIES將描述之。


include $(BUILD_STATIC_LIBRARY)




2.1.4: BUILD_EXECUTABLE: 與前面類似,它也指向一個編譯腳本,收集自從上次調用 include $(CLEAR_VARS)  後的所有LOCAL_XXX信息。並決定如何將你列出的Source編譯成一個可執行Native程序。
include $(BUILD_EXECUTABLE)






2.1.5:PREBUILT_SHARED_LIBRARY:把這個共享庫聲明爲 “一個” 獨立的模塊。
指向一個build 腳本,用來指定一個預先編譯好多動態庫。
與BUILD_SHARED_LIBRARY and BUILD_STATIC_LIBRARY不同,此時模塊的LOCAL_SRC_FILES應該被指定爲一個預先編譯好的動態庫,而非source file.
 LOCAL_PATH := $(call my-dir)
    
include $(CLEAR_VARS)
LOCAL_MODULE := foo-prebuilt     # 模塊名
LOCAL_SRC_FILES := libfoo.so     # 模塊的文件路徑(相對於 LOCAL_PATH)
    
include $(PREBUILT_SHARED_LIBRARY) # 注意這裏不是 BUILD_SHARED_LIBRARY


這個共享庫將被拷貝到 $PROJECT/obj/local 和 $PROJECT/libs/(stripped) 
主要是用在將已經編譯好的第三方庫使用在本Android Project中。爲什麼不直接將其COPY到libs/armabi目錄呢?因爲這樣做缺陷很多。下一節再詳細說明。








2.1.6: PREBUILT_STATIC_LIBRARY: 預先編譯的靜態庫。
同上。




2.1.7: TARGET_ARCH:
目標CPU架構名。如果爲 “arm” 則聲稱ARM兼容的指令。 與CPU架構版本無關。




2.1.8: TARGET_PLATFORM: 
目標平臺的名字。




2.1.9:TARGET_ARCH_ABI
Name of the target CPU+ABI
armeabi For ARMv5TE 
armeabi-v7a


2.1.10:TARGET_ABI






2.2: NDK提供的功能宏:
GNU Make 提供的功能宏,只有通過類似: $(call function)  
的方式來得到其值,它將返回文本化的信息。


2.2.1: my-dir:
$(call my-dir): 返回最近一次include的Makefile的路徑。通常返回Android.mk所在的路徑。它用來作爲Android.mk的開頭來定義LOCAL_PATH.
LOCAL_PATH := $(call my-dir)
請注意:返回的是最近一次include的Makefile的路徑。所以在Include其它Makefile後,再調用$(call my-dir)會返回其它Android.mk 所在路徑。


例如:
LOCAL_PATH := $(call my-dir) 
 ... declare one module 
 include $(LOCAL_PATH)/foo/Android.mk 
 LOCAL_PATH := $(call my-dir) 
 ... declare another module
則第二次返回的LOCAL_PATH 爲:$PATH/foo。 而非$PATH.


2.2.2: all-subdir-makefiles:
返回一個列表,包含'my-dir'中所有子目錄中的Android.mk。


例如:
結構如下:
sources/foo/Android.mk 
sources/foo/lib1/Android.mk 
sources/foo/lib2/Android.mk
在If sources/foo/Android.mk 中,
include $(call all-subdir-makefiles)


那則自動include 了sources/foo/lib1/Android.mk and sources/foo/lib2/Android.mk。






2.2.3:this-makefile:
當前Makefile的路徑。




2.2.4:parent-makefile:
返回include tree中父Makefile 路徑。 也就是include 當前Makefile的Makefile Path。




2.2.5:import-module:
允許尋找並inport其它modules到本Android.mk中來。
它會從NDK_MODULE_PATH尋找指定的模塊名。
$(call import-module,)












2.3: 模塊描述變量:
此類變量用來給Build System描述模塊信息。在'include $(CLEAR_VARS)' 和 'include $(BUILD_XXXXX)'之間。必須定義此類變量。


include $(CLEAR_VARS) script用來清空這些變量。 




include $(BUILD_XXXXX)收集和使用這些變量。




2.3.1: LOCAL_PATH: 
這個值用來給定當前目錄。必須在Android.mk的開是位置定義之。
例如:
LOCAL_PATH := $(call my-dir)


LOCAL_PATH不會被include $(CLEAR_VARS) 清理。




2.3.2: LOCAL_MODULE: 
modules名。在include $(BUILD_XXXXX)之前,必須定義這個變量。此變量必須唯一且不能有空格。


通常,由此變量名決定最終生成的目標文件名。




2.3.3: LOCAL_MODULE_FILENAME:
可選。用來override LOCAL_MODULE. 即允許用戶重新定義最終生成的目標文件名。


LOCAL_MODULE := foo-version-1 
LOCAL_MODULE_FILENAME := libfoo




2.3.4:LOCAL_SRC_FILES:
爲Build Modules而提供的Source 文件列表。不需要列出依賴文件。
注意:文件相對於LOCAL_PATH存放,且可以提供相對路徑。
例如:
LOCAL_SRC_FILES := foo.c 
            \ toto/bar.c


2.3.5: LOCAL_CPP_EXTENSION:
指出C++ 擴展名。(可選)
LOCAL_CPP_EXTENSION := .cxx
從NDK R7後,可以寫多個:
LOCAL_CPP_EXTENSION := .cxx .cpp .cc




2.3.6:LOCAL_CPP_FEATURES:
可選。用來指定C++ features。
LOCAL_CPP_FEATURES := rtti
LOCAL_CPP_FEATURES := exceptions




2.3.7:LOCAL_C_INCLUDES:
一個可選的path列表。相對於NDK ROOT 目錄。編譯時,將會把這些目錄附上。
LOCAL_C_INCLUDES := sources/foo 
LOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo




2.3.8: LOCAL_CFLAGS:
一個可選的設置,在編譯C/C++ source 時添加如Flags。 用來附加編譯選項。
注意:不要嘗試在此處修改編譯的優化選項和Debug等級。它會通過您Application.mk中的信息自動指定。


也可以指定include 目錄通過:LOCAL_CFLAGS += -I。 這個方法比使用LOCAL_C_INCLUDES要好。因爲這樣也可以被ndk-debug使用。




2.3.9: LOCAL_CXXFLAGS: 
LOCAL_CPPFLAGS的別名。








2.3.10: LOCAL_CPPFLAGS: 
C++ Source 編譯時添加的C Flags。這些Flags將出現在LOCAL_CFLAGS flags 的後面。




2.3.11: LOCAL_STATIC_LIBRARIES:
要鏈接到本模塊的靜態庫list。(built with BUILD_STATIC_LIBRARY)




2.3.12: LOCAL_SHARED_LIBRARIES: 
要鏈接到本模塊的動態庫。




2.3.13:LOCAL_WHOLE_STATIC_LIBRARIES:
靜態庫全鏈接。 不同於LOCAL_STATIC_LIBRARIES,類似於使用--whole-archive




2.3.14:LOCAL_LDLIBS:
 linker flags。 可以用它來添加系統庫。 如 -lz: 
 LOCAL_LDLIBS := -lz




2.3.15: LOCAL_ALLOW_UNDEFINED_SYMBOLS:




2.3.16: LOCAL_ARM_MODE: 
缺省模式下,ARM目標代碼被編譯爲thumb模式。每個指令16位。如果指定此變量爲:arm。 則指令爲32位。
LOCAL_ARM_MODE := arm


其實也可以指定某一個或者某幾個文件的ARM指令模式。




2.3.17: LOCAL_ARM_NEON: 
設置爲true時,會講浮點編譯成neon指令。這會極大地加快浮點運算(前提是硬件支持)
只有targeting 爲 'armeabi-v7a'時纔可以。




2.3.18:LOCAL_DISABLE_NO_EXECUTE:




2.3.19: LOCAL_EXPORT_CFLAGS:
定義這個變量用來記錄C/C++編譯器標誌集合,並且會被添加到其他任何以LOCAL_STATIC_LIBRARIES和LOCAL_SHARED_LIBRARIES的模塊的LOCAL_CFLAGS定義中 






LOCAL_SRC_FILES := foo.c bar.c.arm








附1: Android.mk與jni目錄的關係:
在某目錄下,如/src/modules1/下存放Android.mk和Application.mk,調用ndk-build試圖編譯時,會遇到如下錯誤:
Android NDK: Could not find application project directory !    
Android NDK: Please define the NDK_PROJECT_PATH variable to point to it.    
/opt/android-ndk-r9d/build/core/build-local.mk:148: *** Android NDK: Aborting    .  Stop.


這是因爲,當前Android.mk 未放置在jni目錄內。所以ndk-build無法找到Android.mk. (ndk-build會從此目錄向上一直找到jni目錄,並從jni目錄中找到Android.mk)且NDK_PROJECT_PATH, APP_BUILD_SCRIPT, NDK_APPLICATION_MK 是一個空的值。
如何解決這個問題呢。首先當然是創建jni目錄,並在其中添加Android.mk和Application.mk.


但另一方面,也可以顯性的指出這三個值:
目錄結構如下:
/src/modules1/Android.mk
在此目錄下:
/opt/android-ndk-r9d/ndk-build -B V=1 NDK_PROJECT_PATH=. APP_BUILD_SCRIPT=./Android.mk NDK_APPLICATION_MK=./Application.mk
也可以正常編譯。




注意:此處NDK版本爲NDK R7C.(不同NDK版本,ndk-build所產生的Makefile並不完全相同)


原文:Android NDK學習 <二>  Android.mk的製作


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章