common.mk

   1 # This top-level build file is included by all modules that implement
   2 # the hardware OpenGL ES emulation for Android.
   3 #
   4 # We use it to ensure that all sub-Makefiles are included in the right
   5 # order for various variable definitions and usage to happen in the correct
   6 # order.
   7 #
   8
   9 # The following macros are used to start a new GLES emulation module.
  10 #
  11 # This will define LOCAL_MODULE as $1, plus a few other variables
  12 # needed by the build system (e.g. LOCAL_MODULE_TAGS, LOCAL_MODULE_CLASS...)
  13 #
  14 # NOTE: You still need to define LOCAL_PATH before this
  15 #
  16 # Usage example:
  17 #
  18 #   $(call emugl-begin-static-library,<name>)
  19 #       LOCAL_SRC_FILES := ....
  20 #       LOCAL_C_INCLUDES += ....
  21 #   $(call emugl-end-module)
  22 #
  23 emugl-begin-static-library = $(call emugl-begin-module,$1,STATIC_LIBRARY)
  24 emugl-begin-shared-library = $(call emugl-begin-module,$1,SHARED_LIBRARY)
  25
  26 # Internal list of all declared modules (used for sanity checking)
  27 _emugl_modules :=
  28 _emugl_HOST_modules :=
  29
  30 # do not use directly, see functions above instead
  31 emugl-begin-module = \
  32     $(eval include $(CLEAR_VARS)) \
  33     $(eval LOCAL_MODULE := $1) \
  34     $(eval LOCAL_MODULE_CLASS := $(patsubst HOST_%,%,$(patsubst %EXECUTABLE,%EXECUTABLES,$(patsubst %LIBRARY,%LIBRARIES,$2)))) \
  35     $(eval LOCAL_IS_HOST_MODULE := $(if $3,true,))\
  36     $(eval LOCAL_C_INCLUDES := $(EMUGL_COMMON_INCLUDES)) \
  37     $(eval LOCAL_CFLAGS := $(EMUGL_COMMON_CFLAGS)) \
  38     $(eval _EMUGL_INCLUDE_TYPE := $(BUILD_$2)) \
  39     $(call _emugl-init-module,$1,$2,$3)
  40
  41 ifeq ($(shell test $(PLATFORM_SDK_VERSION) -lt 23 && echo PreMarshmallow),PreMarshmallow)
  42     emugl-begin-module += $(eval include external/stlport/libstlport.mk)
  43 endif
  44 ifeq ($(shell test $(PLATFORM_SDK_VERSION) -lt 21 && echo PreLollipop),PreLollipop)
  45     emugl-begin-module += $(eval LOCAL_PRELINK_MODULE := false)
  46 endif
  47 ifeq ($(shell test $(PLATFORM_SDK_VERSION) -lt 19 && echo PreKitkat),PreKitkat)
  48     emugl-begin-module += $(eval LOCAL_MODULE_TAGS := debug)
  49     emugl-begin-module += $(eval LOCAL_SHARED_LIBRARIES += libstlport)
  50 endif
  51
  52 # Used to end a module definition, see function definitions above
  53 emugl-end-module = \
  54     $(eval include $(_EMUGL_INCLUDE_TYPE))\
  55     $(eval _EMUGL_INCLUDE_TYPE :=) \
  56     $(eval _emugl_$(_emugl_HOST)modules += $(_emugl_MODULE))\
  57     $(if $(EMUGL_DEBUG),$(call emugl-dump-module))
  58
  59 # Managing module exports and imports.
  60 #
  61 # A module can 'import' another module, by calling emugl-import. This will
  62 # make the current LOCAL_MODULE inherit various definitions exported from
  63 # the imported module.
  64 #
  65 # Module exports are defined by calling emugl-export. Here is an example:
  66 #
  67 #      $(call emugl-begin-static-library,foo)
  68 #      LOCAL_SRC_FILES := foo.c
  69 #      $(call emugl-export,C_INCLUDES,$(LOCAL_PATH))
  70 #      $(call emugl-export,SHARED_LIBRARIES,libcutils)
  71 #      $(call emugl-end-module)
  72 #
  73 #      $(call emugl-begin-shared-library,bar)
  74 #      LOCAL_SRC_FILES := bar.cpp
  75 #      $(call emugl-import,foo)
  76 #      $(call emugl-end-module)
  77 #
  78 # Here, we define a static library named 'foo' which exports an include
  79 # path and a shared library requirement, and a shared library 'bar' which
  80 # imports it.
  81 #
  82 # What this means is that:
  83 #
  84 #    - 'bar' will automatically inherit foo's LOCAL_PATH in its LOCAL_C_INCLUDES
  85 #    - 'bar' will automatically inherit libcutils in its own LOCAL_SHARED_LIBRARIES
  86 #
  87 # Note that order of declaration matters. If 'foo' is defined after 'bar' in
  88 # the example above, nothing will work correctly because dependencies are
  89 # computed at import time.
  90 #
  91 #
  92 # IMPORTANT: Imports are transitive, i.e. when module A imports B,
  93 #            it automatically imports anything imported by B too.
  94
  95 # This is the list of recognized export types we support for now.
  96 EMUGL_EXPORT_TYPES := \
  97     CFLAGS \
  98     LDLIBS \
  99     LDFLAGS \
 100     C_INCLUDES \
 101     SHARED_LIBRARIES \
 102     STATIC_LIBRARIES \
 103     ADDITIONAL_DEPENDENCIES
 104
 105 # Initialize a module in our database
 106 # $1: Module name
 107 # $2: Module type
 108 # $3: "HOST" for a host module, empty for a target one.
 109 _emugl-init-module = \
 110     $(eval _emugl_HOST := $(if $3,HOST_,))\
 111     $(eval _emugl_MODULE := $(_emugl_HOST)$1)\
 112     $(if $(filter $(_emugl_$(_emugl_HOST)modules),$(_emugl_MODULE)),\
 113         $(error There is already a $(if $3,host,) module named $1!)\
 114     )\
 115     $(eval _mod = $(_emugl_MODULE)) \
 116     $(eval _emugl.$(_mod).type := $(patsubst HOST_%,%,$2))\
 117     $(eval _emugl.$(_mod).imports :=) \
 118     $(eval _emugl,$(_mod).moved :=) \
 119     $(foreach _type,$(EMUGL_EXPORT_TYPES),\
 120         $(eval _emugl.$(_mod).export.$(_type) :=)\
 121     )
 122
 123 # Called to indicate that a module exports a given local variable for its
 124 # users. This also adds this to LOCAL_$1
 125 # $1: Local variable type (e.g. CFLAGS, LDLIBS, etc...)
 126 # $2: Value(s) to append to the export
 127 emugl-export = \
 128     $(eval _emugl.$(_emugl_MODULE).export.$1 += $2)\
 129     $(eval LOCAL_$1 := $2 $(LOCAL_$1))
 130
 131 emugl-export-outer = \
 132     $(eval _emugl.$(_emugl_MODULE).export.$1 += $2)
 133
 134 # Called to indicate that a module imports the exports of another module
 135 # $1: list of modules to import
 136 #
 137 emugl-import = \
 138     $(foreach _imod,$1,\
 139         $(call _emugl-module-import,$(_emugl_HOST)$(_imod))\
 140     )
 141
 142 _emugl-module-import = \
 143     $(eval _mod := $(_emugl_MODULE))\
 144     $(if $(filter-out $(_emugl_$(_emugl_HOST)modules),$1),\
 145         $(info Unknown imported emugles module: $1)\
 146         $(if $(_emugl_HOST),\
 147             $(eval _names := $(patsubst HOST_%,%,$(_emugl_HOST_modules))),\
 148             $(eval _names := $(_emugl_modules))\
 149         )\
 150         $(info Please one of the following names: $(_names))\
 151         $(error Aborting)\
 152     )\
 153     $(if $(filter-out $(_emugl.$(_mod).imports),$1),\
 154         $(eval _emugl.$(_mod).imports += $1)\
 155         $(foreach _sub,$(_emugl.$1.imports),\
 156             $(call _emugl-module-import,$(_sub))\
 157         )\
 158         $(foreach _type,$(EMUGL_EXPORT_TYPES),\
 159             $(eval LOCAL_$(_type) := $(_emugl.$1.export.$(_type)) $(LOCAL_$(_type)))\
 160         )\
 161         $(if $(filter EXECUTABLE SHARED_LIBRARY,$(_emugl.$(_emugl_MODULE).type)),\
 162             $(if $(filter STATIC_LIBRARY,$(_emugl.$1.type)),\
 163                 $(eval LOCAL_STATIC_LIBRARIES := $(1:HOST_%=%) $(LOCAL_STATIC_LIBRARIES))\
 164             )\
 165             $(if $(filter SHARED_LIBRARY,$(_emugl.$1.type)),\
 166                 $(if $(_emugl.$1.moved),,\
 167                   $(eval LOCAL_SHARED_LIBRARIES := $(1:HOST_%=%) $(LOCAL_SHARED_LIBRARIES))\
 168                 )\
 169             )\
 170         )\
 171     )
 172
 173 _emugl-dump-list = \
 174     $(foreach _list_item,$(strip $1),$(info .    $(_list_item)))
 175
 176 emugl-dump-module = \
 177     $(info MODULE=$(_emugl_MODULE))\
 178     $(info .  HOST=$(_emugl_HOST))\
 179     $(info .  TYPE=$(_emugl.$(_emugl_MODULE).type))\
 180     $(info .  IMPORTS=$(_emugl.$(_emugl_MODULE).imports))\
 181     $(foreach _type,$(EMUGL_EXPORT_TYPES),\
 182         $(if $(filter C_INCLUDES ADDITIONAL_DEPENDENCIES,$(_type)),\
 183             $(info .  EXPORT.$(_type) :=)\
 184             $(call _emugl-dump-list,$(_emugl.$(_emugl_MODULE).export.$(_type)))\
 185             $(info .  LOCAL_$(_type)  :=)\
 186             $(call _emugl-dump-list,$(LOCAL_$(_type)))\
 187         ,\
 188             $(info .  EXPORT.$(_type) := $(strip $(_emugl.$(_emugl_MODULE).export.$(_type))))\
 189             $(info .  LOCAL_$(_type)  := $(strip $(LOCAL_$(_type))))\
 190         )\
 191     )\
 192     $(info .  LOCAL_SRC_FILES := $(LOCAL_SRC_FILES))\
 193
 194 # This function can be called to generate the wrapper source files.
 195 # LOCAL_MODULE and LOCAL_MODULE_CLASS must be defined or the build will abort.
 196 # Source files will be stored in the local intermediates directory that will
 197 # be automatically added to your LOCAL_C_INCLUDES.
 198 # Usage:
 199 #    $(call emugl-gen-wrapper,<input-dir>,<basename>)
 200 #
 201 emugl-gen-wrapper = \
 202     $(eval _emugl_out := $(call local-intermediates-dir)) \
 203     $(call emugl-gen-wrapper-generic,$(_emugl_out),$1,$2) \
 204     $(call emugl-export,C_INCLUDES,$(_emugl_out))
 205
 206 # DO NOT CALL DIRECTLY, USE emugl-gen-wrapper instead.
 207 #
 208 # The following function can be called to generate GL library wrapper
 209 # Usage is:
 210 #
 211 #  $(call emugl-gen-wrapper-generic,<dst-dir>,<src-dir>,<basename>)
 212 #
 213 #  <dst-dir> is the destination directory where the generated sources are stored
 214 #  <src-dir> is the source directory where to find <basename>.attrib, etc..
 215 #  <basename> is the emugen basename (see host/tools/emugen/README)
 216 #
 217 emugl-gen-wrapper-generic = $(eval $(emugl-gen-wrapper-generic-ev))
 218
 219 define emugl-gen-wrapper-generic-ev
 220 _emugl_wrap := $$1/$$3
 221 _emugl_src  := $$2/$$3
 222 GEN := $$(_emugl_wrap)_wrapper_entry.cpp \
 223        $$(_emugl_wrap)_wrapper_context.cpp \
 224        $$(_emugl_wrap)_wrapper_context.h \
 225        $$(_emugl_wrap)_wrapper_proc.h
 226
 227 $$(GEN): PRIVATE_PATH := $$(LOCAL_PATH)
 228 $$(GEN): PRIVATE_CUSTOM_TOOL := $$(EMUGL_EMUGEN) -W $$1 -i $$2 $$3
 229 $$(GEN): $$(EMUGL_EMUGEN) $$(_emugl_src).attrib $$(_emugl_src).in $$(_emugl_src).types
 230         $$(transform-generated-source)
 231
 232 $$(call emugl-export,ADDITIONAL_DEPENDENCIES,$$(GEN))
 233 LOCAL_GENERATED_SOURCES += $$(GEN)
 234 LOCAL_C_INCLUDES += $$1
 235
 236 #ifneq ($$(HOST_OS),windows)
 237 $$(call emugl-export,LDFLAGS,-ldl)
 238 #endif
 239
 240 endef
 241
 242 # Call this function when your shared library must be placed in a non-standard
 243 # library path (i.e. not under /system/lib
 244 # $1: library sub-path,relative to /system/lib
 245 # For example: $(call emugl-set-shared-library-subpath,egl)
 246
 247 ifeq ($(shell test $(PLATFORM_SDK_VERSION) -lt 21 && echo PreLollipop),PreLollipop)
 248     emugl-set-shared-library-subpath = \
 249         $(eval LOCAL_MODULE_PATH := $(TARGET_OUT_SHARED_LIBRARIES)/$1)\
 250         $(eval LOCAL_UNSTRIPPED_PATH := $(TARGET_OUT_SHARED_LIBRARIES_UNSTRIPPED)/$1)\
 251         $(eval _emugl.$(LOCAL_MODULE).moved := true)\
 252         $(call emugl-export-outer,ADDITIONAL_DEPENDENCIES,$(LOCAL_MODULE_PATH)/$(LOCAL_MODULE)$(TARGET_SHLIB_SUFFIX))
 253 else
 254     emugl-set-shared-library-subpath = \
 255         $(eval LOCAL_MODULE_RELATIVE_PATH := $1)\
 256         $(eval _emugl.$(LOCAL_MODULE).moved := true)
 257 endif
 258