Dalvik vm make file config and source tree

Dalvik 虛擬機器編譯指令碼 和 原始碼樹

本文簡單的分析Dalvik虛擬機器源碼（dalvik/vm）的結構以及編譯指令碼（*.mk）

編譯指令碼

Dalvik源碼目錄結構並不複雜。其編譯指令碼也很簡單。主要有以下幾個檔案組成:

dalvik/vm/Android.mk 

dalvik/vm/ReconfigureDvm.mk

dalvik/vm/Dvm.mk

和android系統裡其他的模組類似，dalvik也是以Android.mk作為頂層編譯設定檔或者入口。它的內容如下所示：

https://github.com/android/platform_dalvik/blob/master/vm/Android.mk

我們從頭分析一下。首次按是注釋說明：

## Android.mk for Dalvik VM.## This makefile builds both for host and target, and so the very large# swath of common definitions are factored out into a separate file to# minimize duplication.## If you enable or disable optional features here (or in Dvm.mk),# rebuild the VM with:##  make clean-libdvm clean-libdvm_assert clean-libdvm_sv clean-libdvm_interp#  make -j4 libdvm#

他告訴我們，該編譯檔案把dalvik編程成兩部分，宿主機和目標機。對多數典型的配置下，宿主機就是我們的Linux編譯伺服器。而目標機就是我們的行動裝置。 為了減少重複，宿主機和目標機都需要的編譯配置被放到單獨的檔案裡。單獨的檔案就是後面要講道德（ReconfigureDvm.mk和Dvm.mk）。

同時，它也該出了在我們修改了dalvik源碼後，怎麼從頭編譯一個乾淨的實現出來。後面我們會動手實踐。

LOCAL_PATH:= $(call my-dir)

和多數模組一樣，接下來把dalvik源碼路徑賦值給LOCAL_PATH變數。以方便後面使用。這裡LOCAL_PATH應該就是 dalvik/vm.

## Build for the target (device).#ifeq ($(TARGET_CPU_SMP),true)    target_smp_flag := -DANDROID_SMP=1else    target_smp_flag := -DANDROID_SMP=0endifhost_smp_flag := -DANDROID_SMP=1# Build the installed version (libdvm.so) firstinclude $(LOCAL_PATH)/ReconfigureDvm.mk# Overwrite default settingsLOCAL_MODULE_TAGS := optionalLOCAL_MODULE := libdvmLOCAL_CFLAGS += $(target_smp_flag)include $(BUILD_SHARED_LIBRARY)

首先為目標機編譯。首先是根據目標機是否支援SMP，設定變數target_smp_flag。後面我們會看到該變數被用來傳給編譯器選項。而宿主機上現在絕大多數都是支援SMP的，所以就直接複製是指為支援。

緊接著就呼叫指令碼ReconfigureDvm.mk，從名字我們不難猜出改指令碼是用來為dvm編譯初始化編譯環境的。後面我們會看到它的主要內容。

下面接著就是現實dvm在宿主機上最終會被編譯的目標了。這是一個共用庫。名字叫libdvm。我們可以在編譯好的機器上找到他

out/target/xxx/libs/libdvm.so

# If WITH_JIT is configured, build multiple versions of libdvm.so to facilitate# correctness/performance bugs triageifeq ($(WITH_JIT),true)    # Derivation #1    # Enable assert and JIT tuning    include $(LOCAL_PATH)/ReconfigureDvm.mk    # Enable assertions and JIT-tuning    LOCAL_CFLAGS += -UNDEBUG -DDEBUG=1 -DLOG_NDEBUG=1 -DWITH_DALVIK_ASSERT \                    -DWITH_JIT_TUNING $(target_smp_flag)    LOCAL_MODULE := libdvm_assert    include $(BUILD_SHARED_LIBRARY)    # Derivation #2    # Enable assert and self-verification    include $(LOCAL_PATH)/ReconfigureDvm.mk    # Enable assertions and JIT self-verification    LOCAL_CFLAGS += -UNDEBUG -DDEBUG=1 -DLOG_NDEBUG=1 -DWITH_DALVIK_ASSERT \                    -DWITH_SELF_VERIFICATION $(target_smp_flag)    LOCAL_MODULE := libdvm_sv    include $(BUILD_SHARED_LIBRARY)    # Derivation #3    # Compile out the JIT    WITH_JIT := false    include $(LOCAL_PATH)/ReconfigureDvm.mk    LOCAL_CFLAGS += $(target_smp_flag)    LOCAL_MODULE := libdvm_interp    include $(BUILD_SHARED_LIBRARY)endif

這一部分是為JIT特有 的。當系統支援JIT編譯器是，dvm會編譯三個額外的目標共用庫，用於支援dvm的開發特性。他們分別是

libdvm_assert 用來開啟dvm源碼中的斷言（assert）。我們在後面的分析文章中會看到，dvm實現中大量使用斷言來增加運行時的檢查。當開啟這些斷言是，任何斷言檢查失敗都將直接導致dvm異常退出。我們從trace file就能夠找到那個宣告失敗，從而檢查出可能存在的bug。在最終發布版本中，斷言會被關閉，哪些斷言相當於空語句。因而不會再最終發布版本中是dvm異常退出。

libdvm_sv 除了代開斷言外，還帶開了自我檢查能力，用來在某些重要時刻檢查當前dvm狀態沒有異常。我們在後面的文章裡會詳細分析dvm到底做了哪些自我檢查。

最後一個版本 libdvm_interp 用來關掉JIT，而編譯出一個純解譯器實現的dvm執行個體。這樣子我們就可以檢查開啟JIT後行為有沒有出現和解譯器實現的dvm有行為差異。

我們可以在如下目錄裡找到這三個為調試產生的dvm共用庫：

out/target/xxx/symbol/libs/

最後的內容是用來為宿主機編譯的。所有的內容包裹在如下代碼裡：

## Build for the host.#ifeq ($(WITH_HOST_DALVIK),true)

...

endif

首先是清空本地變數內容：

    include $(CLEAR_VARS)

然後是根據編譯環境設定三個編譯變數：

    # Variables used in the included Dvm.mk.    dvm_os := $(HOST_OS)    dvm_arch := $(HOST_ARCH)    # Note: HOST_ARCH_VARIANT isn't defined.    dvm_arch_variant := $(HOST_ARCH)

這三個變數最終會傳給編譯器。它們會引入平台特有的行為。 由於宿主機不必支援JIT，所以將它設定為false。

WITH_JIT := false

include $(LOCAL_PATH)/Dvm.mk

Dvm.mk我們後面會接著分析。

接下來根據目標平台，有選擇性的引入編譯需要的庫：

    LOCAL_SHARED_LIBRARIES += libcrypto libssl libicuuc libicui18n    LOCAL_LDLIBS := -lpthread -ldl    ifeq ($(HOST_OS),linux)      # need this for clock_gettime() in profiling      LOCAL_LDLIBS += -lrt    endif    # Build as a WHOLE static library so dependencies are available at link    # time. When building this target as a regular static library, certain    # dependencies like expat are not found by the linker.    LOCAL_WHOLE_STATIC_LIBRARIES += libexpat libcutils libdex liblog libnativehelper libz    # The libffi from the source tree should never be used by host builds.    # The recommendation is that host builds should always either    # have sufficient custom code so that libffi isn't needed at all,    # or they should use the platform's provided libffi. So, if the common    # build rules decided to include it, axe it back out here.    ifneq (,$(findstring libffi,$(LOCAL_SHARED_LIBRARIES)))        LOCAL_SHARED_LIBRARIES := \            $(patsubst libffi, ,$(LOCAL_SHARED_LIBRARIES))    endif

最後告訴編譯系統，dvm在宿主機上的編譯結果有兩個：

LOCAL_CFLAGS += $(host_smp_flag)    LOCAL_MODULE_TAGS := optional    LOCAL_MODULE := libdvm    include $(BUILD_HOST_SHARED_LIBRARY)    # Copy the dalvik shell script to the host's bin directory    include $(CLEAR_VARS)    LOCAL_IS_HOST_MODULE := true    LOCAL_MODULE_TAGS := optional    LOCAL_MODULE_CLASS := EXECUTABLES    LOCAL_MODULE := dalvik    include $(BUILD_SYSTEM)/base_rules.mk$(LOCAL_BUILT_MODULE): $(LOCAL_PATH)/dalvik | $(ACP)@echo "Copy: $(PRIVATE_MODULE) ($@)"$(copy-file-to-new-target)$(hide) chmod 755 $@

它們分別是 dvm共用庫libdvm.so 和可執行檔dalvikvm。我們編譯後的目錄裡能找到它們：

out/host/xxx/libs/libdvm.so

out/host/xxx/bin/dalvikvm

前面我們看到，dvm在目標機上編譯的結果可能有好幾個，最終的共用庫libdvm.so，以及幾個開發使用的共用庫libsdvm_xx.so。編譯這些目標是我們需要首先清理當前的編譯環境，以排除編譯前一個目標多帶來的副作用。這個工作單獨放到編譯指令碼ReconfigureDvm.mk，以減少重複。ReconfigureDvm.mk內容如下：

include $(CLEAR_VARS)# Variables used in the included Dvm.mk.dvm_os := $(TARGET_OS)dvm_arch := $(TARGET_ARCH)dvm_arch_variant := $(TARGET_ARCH_VARIANT)# for now, disable x86-atom variantifeq ($(dvm_arch_variant),x86-atom)dvm_arch_variant := x86endifinclude $(LOCAL_PATH)/Dvm.mkLOCAL_SHARED_LIBRARIES += liblog libcutils libnativehelper libz libdlLOCAL_STATIC_LIBRARIES += libdexLOCAL_C_INCLUDES += external/stlport/stlport bionic/ bionic/libstdc++/includeLOCAL_SHARED_LIBRARIES += libstlport# Don't install on any build by defaultLOCAL_MODULE_TAGS := optional

它的內容也不出意外。清除本地變數，設定dvm變數，引入dvm需要的庫。最後設定LOCAL_MODULE_TAGS為optional來告訴編譯系統除非顯式指明（include dalvik/vm/android.mk），否則不會編譯dvm。

最後一個檔案dvm.mk設定了宿主機和目標機都需要的定義。其內容也很直觀。完整的內容如下：

https://github.com/android/platform_dalvik/blob/master/vm/Dvm.mk

首先是設定編譯器選項：

## Compiler defines.#LOCAL_CFLAGS += -fstrict-aliasing -Wstrict-aliasing=2 -fno-align-jumpsLOCAL_CFLAGS += -Wall -Wextra -Wno-unused-parameterLOCAL_CFLAGS += -DARCH_VARIANT=\"$(dvm_arch_variant)\"

接著判斷編譯時間有沒有指定DEBUG_DALVIK_VM：

## Optional features.  These may impact the size or performance of the VM.## Make a debugging version when building the simulator (if not told# otherwise) and when explicitly asked.dvm_make_debug_vm := falseifneq ($(strip $(DEBUG_DALVIK_VM)),)  dvm_make_debug_vm := $(DEBUG_DALVIK_VM)endif

如果指定了該選項，則開啟額外的編譯選項，否則什麼都不多做：

ifeq ($(dvm_make_debug_vm),true)  #  # "Debug" profile:  # - debugger enabled  # - profiling enabled  # - tracked-reference verification enabled  # - allocation limits enabled  # - GDB helpers enabled  # - LOGV  # - assert()  #  LOCAL_CFLAGS += -DWITH_INSTR_CHECKS  LOCAL_CFLAGS += -DWITH_EXTRA_OBJECT_VALIDATION  LOCAL_CFLAGS += -DWITH_TRACKREF_CHECKS  LOCAL_CFLAGS += -DWITH_EXTRA_GC_CHECKS=1  #LOCAL_CFLAGS += -DCHECK_MUTEX  LOCAL_CFLAGS += -DDVM_SHOW_EXCEPTION=3  # add some extra stuff to make it easier to examine with GDB  LOCAL_CFLAGS += -DEASY_GDB  # overall config may be for a "release" build, so reconfigure these  LOCAL_CFLAGS += -UNDEBUG -DDEBUG=1 -DLOG_NDEBUG=1 -DWITH_DALVIK_ASSERTelse  # !dvm_make_debug_vm  #  # "Performance" profile:  # - all development features disabled  # - compiler optimizations enabled (redundant for "release" builds)  # - (debugging and profiling still enabled)  #  #LOCAL_CFLAGS += -DNDEBUG -DLOG_NDEBUG=1  # "-O2" is redundant for device (release) but useful for sim (debug)  #LOCAL_CFLAGS += -O2 -Winline  #LOCAL_CFLAGS += -DWITH_EXTRA_OBJECT_VALIDATION  LOCAL_CFLAGS += -DDVM_SHOW_EXCEPTION=1  # if you want to try with assertions on the device, add:  #LOCAL_CFLAGS += -UNDEBUG -DDEBUG=1 -DLOG_NDEBUG=1 -DWITH_DALVIK_ASSERTendif  # !dvm_make_debug_vm

緊接著是該檔案的大頭，引入編譯源檔案。其中包括 所有平台都會使用到的源檔案，如 AllocTracker.cpp等。為支援JIT特有的檔案，如compiler/Compiler.cpp等。其中以下部分特別需要我們關註：

ifeq ($(WITH_COPYING_GC),true)  LOCAL_CFLAGS += -DWITH_COPYING_GC  LOCAL_SRC_FILES += \alloc/Copying.cpp.armelse  LOCAL_SRC_FILES += \alloc/HeapSource.cpp \alloc/MarkSweep.cpp.armendif

這是在指定垃圾收集器的類型。當在編譯選項中指定WITH_COPYING_GC後就使用拷貝垃圾收集器，否則就是用標記-清除垃圾收集器。我們後面會在單獨的章節裡介紹dvm垃圾收集。

至此編譯指令碼的解析全部完成。dvm原始碼結構簡單，其編譯指令碼也很清晰。

源碼分類樹

下面是dvm源碼分類樹。後面章節會分別介紹其中最重要的部分：

https://github.com/android/platform_dalvik/tree/master/vm