NDK<第六篇>：Android.mk在AS中的使用

【1】ndkBuild配置

android {
    compileSdk 32

    defaultConfig {
        // ...
        externalNativeBuild {
            ndkBuild {
                abiFilters 'armeabi-v7a'
            }
        }
        ndk { // "armeabi-v7a", "arm64-v8a"
            abiFilters 'armeabi-v7a'
        }
    }

     // ...

    externalNativeBuild {
        ndkBuild{
            path file('src/main/cpp/Android.mk')
        }
}

在模块下的 build.gradle 中配置 ndkBuild，确认CPU架构以及Android.mk路径。

【2】将源码编译成动态库

# 每个Android.mk文件必须以定义LOCAL_PATH为开始
# 宏my-dir则由Build System提供，返回包含Android.mk的目录路径
LOCAL_PATH := $(call my-dir)

# 清除所有LOCAL_开头的变量，除了LOCAL_PATH
include $(CLEAR_VARS)

# 模块名称，需要保证模块名称的唯一性
LOCAL_MODULE := native-lib

# 指定将要打包的源码，多个文件用空格隔开，如果需要换行，在换行处添加“\”
LOCAL_SRC_FILES := native-lib.cpp

# 负责收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息，并决定编译成什么
# BUILD_STATIC_LIBRARY：编译为静态库
# BUILD_SHARED_LIBRARY：编译为动态库
# BUILD_EXECUTABLE：编译为可执行程序
include $(BUILD_SHARED_LIBRARY)

编译之后，动态库libnative-lib.so会在模块下的 build/intermediates/ndkBuild/ 目录下生成。

image.png

【3】Android.mk 编译时日志

#输出字符串的方式有如下三种，程度越来越高，有点像Android里面的Log等级
$(info string)    #一般打印信息，仅仅是显示调试信息
$(warning string) #警告级别打印信息，不会停止脚本运行，一般用于严重警告
$(error string)   #错误级别，会停止编译直接退出来

【4】c/c++代码日志在AS控制台上现实

# 加载NDK的日志库
LOCAL_LDLIBS := -llog
# 负责收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息，并决定编译成什么
# BUILD_STATIC_LIBRARY：编译为静态库
# BUILD_SHARED_LIBRARY：编译为动态库
# BUILD_EXECUTABLE：编译为可执行程序
include $(BUILD_SHARED_LIBRARY)

需要在 include $(BUILD_SHARED_LIBRARY) 前面添加 LOCAL_LDLIBS := -llog，加载NDK中自带的日志库。

在源代码中定义宏：

#define LOG_TAG "native-lib"
#define LOGV(...) __android_log_print(ANDROID_LOG_VERBOSE, LOG_TAG, __VA_ARGS__)
#define LOGD(...) __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, __VA_ARGS__)
#define LOGI(...) __android_log_print(ANDROID_LOG_INFO, LOG_TAG, __VA_ARGS__)
#define LOGW(...) __android_log_print(ANDROID_LOG_WARN, LOG_TAG, __VA_ARGS__)
#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)

在源代码中，打印日志到AS控制台：

LOGI("start thread task");

【5】Android.mk 生成动态库

LOCAL_PATH := $(call my-dir)
# 清除所有LOCAL_开头的变量，除了LOCAL_PATH
include $(CLEAR_VARS)
# 模块名称，需要保证模块名称的唯一性
LOCAL_MODULE := Test
# 指定将要打包的源码，多个文件用空格隔开，如果需要换行，在换行处添加“\”
LOCAL_SRC_FILES := Test.cpp
# 负责收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息，并决定编译成什么
# BUILD_STATIC_LIBRARY：编译为静态库
# BUILD_SHARED_LIBRARY：编译为动态库
# BUILD_EXECUTABLE：编译为可执行程序
include $(BUILD_SHARED_LIBRARY)

编译之后，自动生成动态库，可以在build的以下目录中找到。

image.png

【6】使用预先编译好的动态库

编写mk：

# 每个Android.mk文件必须以定义LOCAL_PATH为开始
# 宏my-dir则由Build System提供，返回包含Android.mk的目录路径
LOCAL_PATH := $(call my-dir)

# 清除所有LOCAL_开头的变量，除了LOCAL_PATH
include $(CLEAR_VARS)
# 模块名称，需要保证模块名称的唯一性
LOCAL_MODULE := Test
# 指定将要打包的动态库
LOCAL_SRC_FILES := libTest.so
# PREBUILT_SHARED_LIBRARY：动态库
# PREBUILT_STATIC_LIBRARY：静态库
include $(PREBUILT_SHARED_LIBRARY)

# 清除所有LOCAL_开头的变量，除了LOCAL_PATH
include $(CLEAR_VARS)
# 模块名称，需要保证模块名称的唯一性
LOCAL_MODULE := native-lib
# 指定将要打包的源码，多个文件用空格隔开，如果需要换行，在换行处添加“\”
LOCAL_SRC_FILES := native-lib.cpp
# 加载Test库
LOCAL_SHARED_LIBRARIES := Test
# 加载NDK的日志库
LOCAL_LDLIBS := -llog
# 负责收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息，并决定编译成什么
# BUILD_STATIC_LIBRARY：编译为静态库
# BUILD_SHARED_LIBRARY：编译为动态库
# BUILD_EXECUTABLE：编译为可执行程序
include $(BUILD_SHARED_LIBRARY)

include $(PREBUILT_SHARED_LIBRARY) 预编译动态库，LOCAL_SHARED_LIBRARIES := Test 加载动态库到apk中：

image.png

在c++源码中声明libTest.so中的函数

// 如果是C，需要添加 extern "C"{}
extern int test();

如果调用的是C代码，需要更改为：

extern "C"{
    extern int test();
}

【7】变量和宏

定义自己的任意变量。在定义变量时请注意，NDK 构建系统会预留以下变量名称：

以 LOCAL_ 开头的名称，例如 LOCAL_MODULE。
以 PRIVATE_、NDK_ 或 APP 开头的名称。构建系统在内部使用这些变量。
小写名称，例如 my-dir。构建系统也是在内部使用这些变量。

如果为了方便而需要在 Android.mk 文件中定义自己的变量，建议在名称前附加 MY_。

【8】其它语法详解

1、`LOCAL_MODULE` 可以设置模块名称：

    LOCAL_MODULE := Test

2、使用 `LOCAL_MODULE_FILENAME` 可以覆盖 `LOCAL_MODULE` 设置的模块名称。

    LOCAL_MODULE_FILENAME := libTest

3、LOCAL_ARM_MODE

缺省模式下，ARM目标代码被编译为thumb模式。每个指令16位。如果指定此变量为'arm'，则指令为32位。

    LOCAL_ARM_MODE := arm  

4、TARGET_ARCH

目标CPU架构名，如果为“arm” 则声称ARM兼容的指令，与CPU架构版本无关。

    ifeq ($(TARGET_ARCH),arm)
      ...
    endif

5、TARGET_PLATFORM

目标平台的名字，对应android版本号，取值包括：android-8、android-9...android-21。

    ifeq ($(TARGET_PLATFORM),android-8)  
      ... 
    endif

6、TARGET_ARCH_ABI：cpu架构

取值包括：

32位：armeabi、armeabi-v7a、x86、mips；
64位：arm64-v8a、x86_64、mips64；

ifeq ($(TARGET_ARCH_ABI),armeabi-v7a)
  $(warning armeabi-v7a)
endif
ifeq ($(TARGET_ARCH_ABI),armeabi)
  $(warning armeabi)
endif
ifeq ($(TARGET_ARCH_ABI),mips)
  $(warning mips)
endif
ifeq ($(TARGET_ARCH_ABI),x86)
  $(warning x86)
endif

7、NDK_MODULE_PATH

NDK_MODULE_PATH 是一个环境变量，不是Android.mk中设置的变量，
可以在 Android.mk中设置NDK_MODULE_PATH：

$(call import-add-path,$(LOCAL_PATH))
$(call import-add-path,$(LOCAL_PATH)/../external)

环境变量可以设置多个，以上配置只设置了两个。

$(call import-module,android/cpufeatures)
$(call import-module,freetype2/prebuilt/android)
$(call import-module,platform/android)
$(call import-module,png/prebuilt/android)

以上配置的意思是：在环境变量的目录下：
    寻找android目录，在android目录下寻找cpufeatures目录；
    寻找freetype2目录，在freetype2目录下寻找prebuilt目录，在prebuilt目录下寻找android目录；
    寻找platform目录，在platform目录下寻找android目录；
    寻找png目录，在png目录下寻找prebuilt目录，在prebuilt目录下寻找android目录。

8、LOCAL_CPP_EXTENSION
（可选）指出C++扩展名。

    LOCAL_CPP_EXTENSION := .cxx

从NDK R7后，可以写多个：

    LOCAL_CPP_EXTENSION := .cxx .cpp .cc    

9、LOCAL_CPP_FEATURES
（可选）用来指定C++ features。

    LOCAL_CPP_FEATURES := rtti  
    LOCAL_CPP_FEATURES := exceptions

10、LOCAL_C_INCLUDES

一个可选的path列表，相对于NDK ROOT目录，编译时将会把这些目录附上，主要为了头文件的引用。

    LOCAL_C_INCLUDES := sources/foo  
    LOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo

11、LOCAL_CFLAGS

（可选）在编译C/C++ source 时添加如Flags，用来附加编译选项。
注意：不要尝试在此处修改编译的优化选项和Debug等级，它会通过您Application.mk中的信息自动指定。

-Wall：是打开警告开关。

-O：代表默认优化，可选：-O0不优化，-O1低级优化，-O2中级优化，-O3高级优化，-Os代码空间优化。

-g：是生成调试信息，生成的可执行文件具有和源代码关联的可调试的信息。

-fopenmp：OpenMp是由OpenMP Architecture Review Board牵头提出的，并已被广泛接受的，
    用于共享内存并行系统的多处理器程序设计的一套指导性的编译处理方案(Compiler Directive)。
    OpenMP支持的编程语言包括C语言、C++和Fortran；而支持OpenMp的编译器包括Sun Compiler，GNU Compiler和Intel Compiler等。
    OpenMp提供了对并行算法的高层的抽象描述，程序员通过在源代码中加入专用的pragma来指明自己的意图，
    由此编译器可以自动将程序进行并行化，并在必要之处加入同步互斥以及通信。 
    当选择忽略这些pragma，或者编译器不支持OpenMp时，程序又可退化为通常的程序(一般为串行)，
    代码仍然可以正常运作，只是不能利用多线程来加速程序执行。

-D：增加全局宏定义

-ffast-math：浮点优化选项，极大地提高浮点运算速度。

-mfloat-abi=softfp 浮点运算

12、LOCAL_CPPFLAGS

    C++ Source 编译时添加的C Flags，这些Flags将出现在LOCAL_CFLAGS flags 的后面。

13、LOCAL_WHOLE_STATIC_LIBRARIES

    静态库全链接，不同于LOCAL_STATIC_LIBRARIES，类似于使用--whole-archive，
    LOCAL_WHOLE_STATIC_LIBRARIES在连接静态连接库的时候不会移除"daed code"，
    何谓dead code呢，就是调用者模块永远都不会用到的代码段和变量。

14、LOCAL_LDLIBS

链接flags，链接的库不产生依赖关系，一般用于不需要重新编译的库，可以用它来添加系统库。

    LOCAL_LDLIBS += -lm –lz –lc -lcutils –lutils –llog …

15、LOCAL_ALLOW_UNDEFINED_SYMBOLS

默认情况下，在试图编译一个共享库时，任何未定义的引用将导致一个“未定义的符号”错误。
然而，如果你因为某些原因，需要不启动这项检查，把这个变量设为'true'。
注意相应的共享库可能在运行时加载失败。（这个一般尽量不要去设为true）

16、LOCAL_ARM_NEON

设置为true时，会将浮点编译成neon指令。
这会极大地加快浮点运算（前提是硬件支持），只有targeting为'armeabi-v7a'时才可以。

17、LOCAL_DISABLE_NO_EXECUTE

Android NDK r4版本开始支持这种"NX bit"的安全功能。
默认是启用的，你也可以设置该变量的值为true来禁用它。
但不推荐这么做。该功能不会修改ABI，只在ARMv6+CPU的设备内核上启用。

18、LOCAL_EXPORT_CFLAGS

定义这个变量用来记录C/C++编译器标志集合，
并且会被添加到其他任何以LOCAL_STATIC_LIBRARIES和LOCAL_SHARED_LIBRARIES的模块的LOCAL_CFLAGS定义中。

注意：此处NDK版本为NDK R7C。（不同NDK版本，ndk-build所产生的Makefile并不完全相同）

19、LOCAL_LDFLAGS 

# 指定动态库的路径以及ffmpeg库
LOCAL_LDFLAGS := -L$(LOCAL_PATH)/src/main/jniLibs/$(TARGET_ARCH_ABI) -lffmpeg

[本章完...]

NDK<第六篇>：Android.mk在AS中的使用

你可能感兴趣的:(NDK<第六篇>：Android.mk在AS中的使用)