gecko/mozglue/build/Makefile.in

#
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is mozilla.org code.
#
# The Initial Developer of the Original Code is
# Mozilla Foundation
# Portions created by the Initial Developer are Copyright (C) 2008
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
#  Ted Mielczarek <ted.mielczarek@gmail.com>
#
# Alternatively, the contents of this file may be used under the terms of
# either of the GNU General Public License Version 2 or later (the "GPL"),
# or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK *****

DEPTH		= ../..
topsrcdir	= @top_srcdir@
srcdir		= @srcdir@
VPATH		= @srcdir@

include $(DEPTH)/config/autoconf.mk

MODULE = mozglue
LIBRARY_NAME = mozglue
DIST_INSTALL = 1

ifdef MOZ_MEMORY
SHARED_LIBRARY_LIBS = $(call EXPAND_LIBNAME_PATH,jemalloc,$(DEPTH)/memory/jemalloc)
else
# Temporary, until bug 662814 lands
VISIBILITY_FLAGS =
CPPSRCS = dummy.cpp
endif
 
# Build mozglue as a shared lib on Windows, OSX and Android.
# If this is ever changed, update MOZ_SHARED_MOZGLUE in browser/installer/Makefile.in
ifneq (,$(filter WINNT Darwin Android,$(OS_TARGET)))
FORCE_SHARED_LIB = 1
else
FORCE_STATIC_LIB = 1
endif

MOZ_GLUE_LDFLAGS = # Don't link against ourselves

ifeq (WINNT,$(OS_TARGET))
DEFFILE = mozglue.def

mozglue.def: mozglue.def.in
	$(PYTHON) $(topsrcdir)/config/Preprocessor.py $(ACDEFINES) $< > $@

GARBAGE += mozglue.def

LDFLAGS += -ENTRY:DllMain

ifneq (,$(filter -DEFAULTLIB:mozcrt,$(MOZ_GLUE_LDFLAGS)))
# Don't install the import library if we use mozcrt
NO_INSTALL_IMPORT_LIBRARY = 1
endif
endif

ifeq (android, $(MOZ_WIDGET_TOOLKIT))
# Add Android specific code
EXTRA_DSO_LDOPTS += $(ZLIB_LIBS)
SHARED_LIBRARY_LIBS += $(call EXPAND_LIBNAME_PATH,android,$(DEPTH)/other-licenses/android)
SHARED_LIBRARY_LIBS += $(call EXPAND_LIBNAME_PATH,android,../android)
endif

ifdef MOZ_LINKER
# Add custom dynamic linker
SHARED_LIBRARY_LIBS += $(call EXPAND_LIBNAME_PATH,linker,../linker)
endif

ifeq (Android, $(OS_TARGET))
WRAP_LDFLAGS =
endif

include $(topsrcdir)/config/rules.mk

ifdef MOZ_MEMORY
ifeq (Darwin,$(OS_TARGET))
LDFLAGS += -init _jemalloc_darwin_init
endif

ifeq (WINNT,$(OS_TARGET))
# Roll our own custom logic here for the import library

###############################################################################
#
# Linking Mozilla itself to jemalloc is not particularly difficult.  To do this
# we avoid linking directly to the Microsoft-provided CRT import libraries.
# Instead, we link to our own import library which we generate here.  To
# replace the CRT's malloc/free/other memory management symbols we export
# our own versions out of jemalloc.dll.  We then take the import library that
# the compiler generates for jemalloc.dll and combine it with the MS CRT import
# libraries.  We put our library on the command line first, and the CRT symbols
# are discarded in favor of our versions!
#
# Unfortunately that was too easy.  The CRT import library is not a standard
# import library that contains a list of symbols and whatnot.  It also includes
# object files that are linked into generated programs.  One of these,
# crtdll.obj is (as one might expect) linked into all DLLs that link against
# the CRT.  This file does things like run static C++ constructors when the
# DLL is attached, call DllMain, etc.
#
# In the CRT source all malloc/free calls are made to malloc_crt and free_crt.
# In debug builds these are both defined to malloc_dbg and free_dbg.  In opt
# builds malloc_crt is an actual function, implemented and exposed from the
# CRT.  free_crt is, however, defined to be just plain old free.  This works
# fine inside the CRT where malloc_crt and free operate on the same heap.
# Outside the CRT malloc_crt is in the CRT's heap, but free is in jemalloc's
# heap.  This causes much pain at shutdown :-(
#
# The obvious solution here is to override malloc_crt too.  Unfortunately,
# that doesn't work because the CRT expects to be able to call msize on this
# piece of memory deep inside the CRT, which will fail because it'll call the
# CRT's msize on a pointer in jemalloc's heap.
#
# Our solution to this is quite devious.  We take apart the CRT's import lib
# and remove the problematic object file.  We then poke at the object file's
# symbol table and replace '__imp__free' (which means grab free from some
# other DLL) with '__imp__frex'.  Then we define our own dummy no-op function
# in jemalloc.dll and export it as frex.  Then we put the CRT import lib
# back together with the patched crtdll.obj, glue it to the end of jemalloc's
# import library and link the rest of Mozilla to that.
#
# The result?  A binary that uses jemalloc, doesn't crash, and leaks a tiny
# amount of memory (32 words per DLL in the 2010 CRT) at shutdown.
#
###############################################################################

libs:: mozcrt.lib
	$(INSTALL) $(IFLAGS2) mozcrt.lib $(DIST)/lib

# And finally combine that with the jemalloc import library to get an import
# library that has our malloc/free/etc and the CRT's everything else
mozcrt.lib: $(IMPORT_LIBRARY) msvc_modified.lib
	lib -OUT:$@ $^

# Put the fixed object file back in
msvc_modified.lib: msvc_removed.lib crtdll_fixed.obj
	lib -OUT:$@ $^

# Fix the object file
crtdll_fixed.obj: crtdll.obj
	$(PYTHON) $(srcdir)/fixcrt.py

# Find the path of crtdll.obj
CRTDLL_FULLPATH=$(subst \,\\,$(shell lib -list msvc_combined.lib | grep crtdll\\.obj))

# Remove the broken object file, only after we have extracted it
msvc_removed.lib: msvc_combined.lib crtdll.obj
	lib -OUT:$@ msvc_combined.lib -REMOVE:$(CRTDLL_FULLPATH)

# Extract the broken object file out of the combined library
crtdll.obj: msvc_combined.lib
	lib -OUT:$@ $^ -EXTRACT:$(CRTDLL_FULLPATH)

# Grab both CRT libraries and combine them into one library to simplify things
msvc_combined.lib:
	lib -OUT:$@ $(WIN32_CRT_LIBS)
endif
endif # MOZ_MEMORY