1. 程式人生 > >安卓Android.mk 檔案語法詳解

安卓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/<abi> (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,<name>)
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<path>。 這個方法比使用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 
注意:此處NDK版本為NDK R7C.(不同NDK版本,ndk-build所產生的Makefile並不完全相同 
============================================================================
其他一些有關mk檔案資料:
1.Android JNI入門第四篇——Android.mk檔案分析:http://blog.csdn.net/xyz_lmn/article/details/6966259
2.android編譯系統makefile(Android.mk)寫法:http://www.cnblogs.com/hesiming/archive/2011/03/15/1984444.html
3.android makefile(android.mk)分析(序):http://blog.csdn.net/chief1985/article/details/4699831
4.Android.mk的用法和基礎:http://blog.csdn.net/zhandoushi1982/article/details/5316669