Android NDK——源码编译脚本之Makefile 基础语法和Android.mk小结

Posted 2021-09-29 CrazyMo_

文章大纲

• 引言
• 一、 Android.mk 概述
• 二、Android.mk 基本语法
• • 1、Makefile 是以模块为单位进行组织的
  • 2、编译系统预留的部分系统变量
  • • • 2.1、LOCAL_PATH（必须）
      • 2.2、CLEAR_VARS（必须）
      • 2.3、LOCAL_MODULE（必须）
      • 2.4、**LOCAL_SRC_FILES**（必须）
      • 2.5、LOCAL_DEFAULT_CPP_EXTENSION
      • 2.6、BUILD_SHARED_LIBRARY和BUILD_STATIC_LIBRARY
      • 2.7、TARGET_ARCH
      • 2.8、TARGET_PLATFORM
      • 2.9、TARGET_ARCH_ABI
      • 2.10、LOCAL_C_INCLUDES
      • 2.11、LOCAL_CFLAGS、LOCAL_CXXFLAGS和LOCAL_CPPFLAGS
      • 2.12、LOCAL_STATIC_LIBRARIES
      • 2.13、 LOCAL_SHARED_LIBRARIES
      • 2.14、 LOCAL_LDLIBS
      • 2.15、LOCAL_ARM_MODE
      • 2.16、LOCAL_CERTIFICATE
      • 2.17、BUILD_EXECUTABLE、BUILD_STATIC_LIBRARY和BUILD_SHARED_LIBRARY
      • 2.18、LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH
      • 2.19、LOCAL_PRIVILEGED_MODULE
      • 2.20、 LOCAL_PROGUARD_FLAG_FILES
      • 2.21、LOCAL_AAPT_FLAGS
  • 3、编译系统预留部分宏函数
  • • • 3.1、my-dir 和 all-subdir-makefiles
      • 3.2、include
      • 3.3、this-makefile、parent-makefile和 grand-parent-makefile
  • 4、Android.mk 常用的模板
  • • • 4.1、编译应用程序的模板
      • 4.2、编译静态库的模板
      • 4.3、编译动态库的模板

引言

虽然现在NDK开发中已经很少直接使用Makefile 来构建NDK程序了，但是android 原生的编译系统依然使用着Makefile作为构建脚本来编译系统。

一、 Android.mk 概述

Android.mk编译脚本是用于向Android NDK描述你想让NDK使用那些C、C++源代码文件来构建你的产物。一个Android.mk 文件是GNU Makefile的一小部分，会被编译系统解析一次或更多次的build系统。因此，您应尽量减少您声明的变量，不要认为某些变量在解析过程中不会被定义。

二、Android.mk 基本语法

1、Makefile 是以模块为单位进行组织的

Android.mk编译脚本的语法允许把你的源代码组织成模块，而一个模块属下列类型之一：

• 静态库（Static Libs）

• 共享库(Shared Libs)且只有共享库将被安装/复制到您的应用软件包，虽然静态库能被用于生成共享库。

  Makefile 脚本当然也可以把你的源代码文件编译为可执行文件。

Android.mk编译脚本支持在一个文件中定义一个或者多个模块（但每个模块的名称必须是唯一的且不包含任何空格），甚至是几个模块中使用同一个源代码文件。编译系统为智能地处理许多细节问题。比如不需要在你的Android.mk中列出头文件和依赖文件，NDK编译系统将会自动到对应的库目录下为你查找并加载对应的头文件（但如果需要引入第三方的头文件支持则需要自己显示声明），而且在升级NDK后，虽然编译链 toolchain/platform是新的但不需要改变你的Android.mk文件。

虽然这个语法同公开发布的Android平台的开源代码很接近，然而编译系统实现他们的方式却是不同的，这是故意这样设计的，可以让程序开发人员重用外部库的源代码更容易。

2、编译系统预留的部分系统变量

在Android.mk中依赖或定义的变量中，NDK编译系统按照以下规则保留下列变量名（GNU Make 变量）：

• 以LOCAL_开头的名字(例如 LOCAL_MODULE)

• 以PRIVATE_, NDK_ or APP_开头的名字(内部使用)

• 小写名字(内部使用，例如’my-dir’)

也可以定义其他变量为自己使用，LOCAL_XXXX等模块描述变量定义在’include $(CLEAR_VARS)'和’include $(BUILD_XXXXX)'之间。

2.1、LOCAL_PATH（必须）

必须在Android.mk的开头定义，用于告知编译系统当前文件的路径，这个变量不会被$(CLEAR_VARS)清除，因此每个Android.mk只需要定义一次(即使你在一个文件中定义了几个模块的情况下)。

每个Android.mk文件必须以定义LOCAL_PATH为开始，它用于在开发tree中查找源文件

LOCAL_PATH := $(call my-dir)

2.2、CLEAR_VARS（必须）

指定让GNU MAKEFILE为你清除除了LOCAL_PATH 外，其他像LOCAL_MODULE、LOCAL_SRC_FILES、 LOCAL_STATIC_LIBRARIES等等LOCAL_XXX变量。因为所有的编译控制文件都在同一个GNU MAKE执行环境中，所有的变量都是全局的。

include $(CLEAR_VARS)

CLEAR_VARS 指向一个编译脚本，几乎所有未定义的LOCAL_XXX变量都在"Module-description"节中列出。因此你必须在开始一个新模块之前通过include $(CLEAR_VARS)包含这个脚本.

2.3、LOCAL_MODULE（必须）

用于在 Android.mk文件中指定的模块名称（唯一的且不能包含空格），必须在包含任一的$(BUILD_XXXX)脚本之前定义它，模块的名字决定了生成文件的名字，一个被命名为’hello’的共享库模块，编译系统会自动产生合适的前缀和后缀，将会生成’libhello.so’文件（如果你的模块名称已经包含了lib则产物不会再添加"lib"前缀）

LOCAL_MODULE := hello

• LOCAL_MODULE_TAGS := optional ——optional指该模块在所有版本下都编译；user只在user版本下才编译；eng只在eng版本下才编译；tests只在tests版本下才编译
• LOCAL_PACKAGE_NAME := SystemUI——应用编译后的名称
• LOCAL_PRIVATE_PLATFORM_APIS := true——可使用sdk的hide的api來编译

2.4、LOCAL_SRC_FILES（必须）

编译的源代码文件列表，包含将要编译打包进模块中的C或C++源代码文件（不需要在这列出系统库下的头文件，因为编译系统将会自动为你找出依赖型的文件，仅仅列出直接传递给编译器的源代码文件即可），源代码名称是相对于LOCAL_PATH的，可以使用相对名称，也可以直接列出来，还可以通过引用其他变量的形式。

LOCAL_SRC_FILES := helloworld.c

LOCAL_SRC_FILES := $(call all-java-files-under, src) 

MY_SOURCES := foo.c
LOCAL_SRC_FILES += $(MY_SOURCES)

在生成文件中都要使用UNIX风格的斜杠(/)，windows风格的反斜杠不会被正确的处理。

2.5、LOCAL_DEFAULT_CPP_EXTENSION

用来指定C++代码文件的扩展名（默认是'.cpp'）， 可以通过设置这个变量改变它

LOCAL_DEFAULT_CPP_EXTENSION :='.cxx'

2.6、BUILD_SHARED_LIBRARY和BUILD_STATIC_LIBRARY

BUILD_SHARED_LIBRARY指向一个GNU Makefile脚本(在aosp/build/core 目录下的shared_library.mk)，用于收集自上次调用include $(CLEAR_VARS)以来，定义在LOCAL_XXX变量中的所有信息，进而决定编译什么以及如何正确地去编并根据其规则生成动态库（共享库），简而言之，执行到include $(BUILD_SHARED_LIBRARY)时会包含这个脚本并收集所有的你在LOCAL_XXX变量中提供的信息（因此至少在include $(BUILD_SHARED_LIBRARY)之前定义LOCAL_MODULE和LOCAL_SRC_FILES），并且决定如何把你列出的源代码文件编译成一个共享库。;而BUILD_STATIC_LIBRARY则是用于生成静态库。

一个BUILD_SHARED_LIBRARY变量用于编译一个动态库，同理BUILD_STATIC_LIBRARY。

　# 这将生成一个名为lib$(LOCAL_MODULE).so的文件
　include $(BUILD_SHARED_LIBRARY) 
　#这将生成一个名为lib$(LOCAL_MODULE).a的文件，静态库不会复制到你的project/packages中，但是能够用于编译共享库
　include $(BUILD_STATIC_LIBRARY) 

2.7、TARGET_ARCH

目标CPU平台的名字与Android开放源码中指定的一致，如果是arm表示要生成ARM兼容的指令，与CPU架构的修订版无关。

2.8、TARGET_PLATFORM

指定解析Android.mk时目标Android平台的名字，对应关系可以参照/development/ndk/docs/stable- apis.txt。

2.9、TARGET_ARCH_ABI

指定编译指令集的CPU架构ABI的类别，取值有：armeabi、armeabi-v7a、arm64-v8a等。目标平台和ABI的组合，它事实上被定义成$(TARGE{T}_{P}LATFORM)-$(TARGET_ARCH)，默认是 android-3-arm。

2.10、LOCAL_C_INCLUDES

头文件路径的可选配置，是从根目录开始的。即配置所需要包含的头文件路径。

LOCAL_C_INCLUDES := $(LOCAL_PATH)/../hello

需要在任何包含LOCAL_CFLAGS / LOCAL_CPPFLAGS标志之前。

2.11、LOCAL_CFLAGS、LOCAL_CXXFLAGS和LOCAL_CPPFLAGS

可选的编译器选项，在编译C代码文件的时候使用。可用于指定一个附加的包含路径(相对于NDK的顶层目录)、宏定义。

不要在Android.mk中改变 optimization/debugging级别，只要在Application.mk中指定合适的信息就会自动地为你处理这个问题，在调试期间，会让NDK自动生成有用的数据文件。

LOCAL_CXXFLAGS则是只适用C++文件；而LOCAL_CPPFLAGS则同时适用于C和C++。

2.12、LOCAL_STATIC_LIBRARIES

配置要链接到当前模块的静态库列表(使用BUILD_STATIC_LIBRARY生成)，这仅仅对生成的是共享库模块才有意义。

2.13、 LOCAL_SHARED_LIBRARIES

配置当前模块在运行时要依赖的共享库模块列表，在链接时会自动在生成文件时嵌入的相应的信息。

这不会将附加列出的模块到编译图，即仍然需要在 Application.mk中把它们添加到程序要求的模块中。

LOCAL_STATIC_LIBRARIES加入所需要链接的静态库(.a)的名称，LOCAL_SHARED_LIBRARIES中加入所需要链接的动态库(.so)的名称。

2.14、 LOCAL_LDLIBS

配置编译你的模块要使用的附加的链接器选项，这对于使用-l(L的小写)前缀传递指定库的名字是有用的。

　　# 下面将告诉链接器生成的模块要在加载时刻链接到 /system/lib/libz.so 
　　LOCAL_LDLIBS := -lz

查阅docs/STABLE-APIS.TXT获取NDK发行版能链接到的开放的系统库列表

2.15、LOCAL_ARM_MODE

默认情况下arm目标二进制会以thumb的形式生成(16位)，可以通过设置这个变量为arm使得Module是以32位指令的形式生成。

LOCAL_ALLOW_UNDEFINED_SYMBOLS默认为false，在试图编译一个共享库时，任何未定义的引用将导致一个“未定义的符号”错误。如果你因为某些原因，需要不启动这项检查，把这个变量设为‘true’，那么引用未定义错误也不会报错，但是可能带来严重的危害，所以不建议这么做。

编译的时候告诉系统编译特定的类型。

# 告诉系统总是将bar.c以arm的模式编译
LOCAL_SRC_FILES := foo.c bar.c.arm

2.16、LOCAL_CERTIFICATE

配置编译时使用的签名版本，platform指定用系统级签名，即所在进程的UID为system；testkey普通APK，默认；shared需要和home/contacts进程共享数据；media是media/download系统中的一环。

LOCAL_CERTIFICATE := platform

# 使用Android 中默认的platform 级别的签名文件
LOCAL_CERTIFICATE := platform

2.17、BUILD_EXECUTABLE、BUILD_STATIC_LIBRARY和BUILD_SHARED_LIBRARY

• BUILD_EXECUTABLE——以一个可执行程序的方式进行编译
• BUILD_STATIC_LIBRARY——以一个静态库的方式编译
• BUILD_SHARED_LIBRARY——以一个动态（共享）库的方式编译

以上三者的生成结果分别在如下（generic依具体target会变）：

　　out/target/product/generic/obj/EXECUTABLE
　　out/target/product/generic/obj/STATIC_LIBRARY
　　out/target/product/generic/obj/SHARED_LIBRARY

每个模块的目标文件夹分别为：

• 可执行程序——XXX_intermediates
• 静态库——XXX_static_intermediates
• 动态库——XXX_shared_intermediates

2.18、LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH

在Android.mk文件中还可以用LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH来指定最后的目标安装路径，不同的文件系统路径用以下的宏进行选择：

• TARGET_ROOT_OUT——表示根文件系统。
• TARGET_OUT——表示system文件系统。
• TARGET_OUT_DATA——表示data文件系统。

LOCAL_MODULE_PATH:=$(TARGET_ROOT_OUT) 

2.19、LOCAL_PRIVILEGED_MODULE

true 表示应用编译后为系统路径：/system/pri-app/SystemUI false 表示应用在目录/system/app/下

LOCAL_PRIVILEGED_MODULE := true

2.20、 LOCAL_PROGUARD_FLAG_FILES

混淆配置文件来保留文件（proguard.flags文件中内容）不要被混淆

 LOCAL_PROGUARD_FLAG_FILES := proguard.flags

2.21、LOCAL_AAPT_FLAGS

可以查看，创建， 更新ZIP格式的文档附件(zip, jar, apk)。也可将资源文件编译成二进制文件。

LOCAL_AAPT_FLAGS := --extra-packages com.android.keyguard

3、编译系统预留部分宏函数

• 部分GNU Make 宏函数必须通过使用’$(call )'来求值，他们返回文本化的信息

• 也可以调用shell 部分函数

  TO_GET_APK_DLL := $(shell rm -rf $(LOCAL_PATH)/$(LOCAL_DLL_PATH))
  TO_GET_APK_DLL := $(shell unzip $(LOCAL_PATH)/$(LOCAL_SRC_FILES) "*lib/*.*" -d $(LOCAL_PATH) )
  ALL_DLL_NAME_AND_PATH := $(shell find $(LOCAL_PATH)/$(LOCAL_DLL_PATH) -name "*.so")
  

3.1、my-dir 和 all-subdir-makefiles

• my-dir ——编译系统提供，用于返回当前路径(即Android.mk file文件的所在目录)。

• all-subdir-makefiles——返回一个位于当前’my-dir’路径的子目录列表。

$(call my-dir)
$(call all-subdir-makefiles)

这项功能用于向编译系统提供深层次嵌套的代码目录层次（默认NDK将会只搜索在sources/*/Android.mk里定义的内容），相对于这样的路径来说 sources/foo/Android.mk和sources/foo/lib1/Android.mksources/foo/lib2/Android.mk，在sources/foo/Android.mk里定义了 include $(call all-subdir-makefiles)，则自动包含sources/foo/lib1/Android.mk 和sources/foo/lib2/Android.mk。

3.2、include

• include $(BUILD_STATIC_JAVA_LIBRARY) ——收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息，编译为编译为静态库
• include $(BUILD_PACKAGE)——生成apk文件

包含，编译系统处理到这个宏函数就会去把对应的内容包含进来。

3.3、this-makefile、parent-makefile和 grand-parent-makefile

• this-makefile—— 返回当前Makefile的路径(即这个函数调用的地方)

• parent-makefile—— 返回调用树中父Makefile路径。即包含当前Makefile的Makefile路径。

• grand-parent-makefile ——返回调用树中父的父Makefile路径。

4、Android.mk 常用的模板

在一个Android.mk中可以生成多个可执行程序、动态库和静态库。

简单理解 :=是赋值的意思；$是引用某变量的值。

4.1、编译应用程序的模板

　#for Exe

LOCAL_PATH := $(call my-dir)

#include $(CLEAR_VARS)

LOCAL_SRC_FILES:= main.c
LOCAL_MODULE:= test_exe

#LOCAL_C_INCLUDES :=
#LOCAL_STATIC_LIBRARIES :=
#LOCAL_SHARED_LIBRARIES :=

include $(BUILD_EXECUTABLE)

4.2、编译静态库的模板

　#for Static Lib

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)

LOCAL_SRC_FILES:=helloworld.c

LOCAL_MODULE:= libtest_static

#LOCAL_C_INCLUDES :=
#LOCAL_STATIC_LIBRARIES :=
#LOCAL_SHARED_LIBRARIES :=

include $(BUILD_STATIC_LIBRARY)

4.3、编译动态库的模板

#for Shared Lib

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)

LOCAL_SRC_FILES:=helloworld.c

LOCAL_MODULE:= libtest_shared

TARGET_PRELINK_MODULES := false

#LOCAL_C_INCLUDES :=
#LOCAL_STATIC_LIBRARIES :=
#LOCAL_SHARED_LIBRARIES :=

include $(BUILD_SHARED_LIBRARY)

未完待续…