diff options
| -rw-r--r-- | SConstruct | 13 | ||||
| -rw-r--r-- | etc/scons/xcode_macosx.vars | 2 | ||||
| -rw-r--r-- | site_scons/site_tools/auto_install_binaries.py | 26 | ||||
| -rw-r--r-- | site_scons/site_tools/separate_debug.py | 153 | ||||
| -rw-r--r-- | src/mongo/embedded/mongo_embedded/SConscript | 75 | ||||
| -rw-r--r-- | src/mongo/embedded/mongoc_embedded/SConscript | 87 |
6 files changed, 121 insertions, 235 deletions
diff --git a/SConstruct b/SConstruct index ab35f7005d1..efd2df1a046 100644 --- a/SConstruct +++ b/SConstruct @@ -744,6 +744,10 @@ env_vars.Add('DESTDIR', help='Where hygienic builds will install files', default='$BUILD_ROOT/install') +env_vars.Add('DSYMUTIL', + help='Path to the dsymutil utility', +) + env_vars.Add('GITDIFFFLAGS', help='Sets flags for git diff', default='') @@ -936,6 +940,10 @@ env_vars.Add('SHLINKFLAGS', help='Sets flags for the linker when building shared libraries', converter=variable_shlex_converter) +env_vars.Add('STRIP', + help='Path to the strip utility (non-darwin platforms probably use OBJCOPY for this)', +) + env_vars.Add('TARGET_ARCH', help='Sets the architecture to build for', converter=variable_arch_converter, @@ -3940,7 +3948,10 @@ if get_option('ninja') != 'disabled': if get_option('install-mode') == 'hygienic': if get_option('separate-debug') == "on" or env.TargetOSIs("windows"): - env.Tool('separate_debug') + separate_debug = Tool('separate_debug') + if not separate_debug.exists(env): + env.FatalError('Cannot honor --separate-debug because the separate_debug.py Tool reported as nonexistent') + separate_debug(env) env["AUTO_ARCHIVE_TARBALL_SUFFIX"] = "tgz" diff --git a/etc/scons/xcode_macosx.vars b/etc/scons/xcode_macosx.vars index cefe380ccf9..1c64c7435c0 100644 --- a/etc/scons/xcode_macosx.vars +++ b/etc/scons/xcode_macosx.vars @@ -4,6 +4,8 @@ import subprocess CC = subprocess.check_output(['xcrun', '-f', '--sdk', 'macosx', 'clang']).decode('utf-8').strip() CXX = subprocess.check_output(['xcrun', '-f', '--sdk', 'macosx', 'clang++']).decode('utf-8').strip() +DSYMUTIL = subprocess.check_output(['xcrun', '-f', '--sdk', 'macosx', 'dsymutil']).decode('utf-8').strip() +STRIP = subprocess.check_output(['xcrun', '-f', '--sdk', 'macosx', 'strip']).decode('utf-8').strip() sdk_path = subprocess.check_output(['xcrun', '--sdk', 'macosx', '--show-sdk-path']).decode('utf-8').strip() diff --git a/site_scons/site_tools/auto_install_binaries.py b/site_scons/site_tools/auto_install_binaries.py index fcc67fe4001..cbe2c553a17 100644 --- a/site_scons/site_tools/auto_install_binaries.py +++ b/site_scons/site_tools/auto_install_binaries.py @@ -361,14 +361,22 @@ def auto_install_pseudobuilder(env, target, source, **kwargs): installed_files = [] for s in source: if not target: - auto_install_mapping = env[SUFFIX_MAP].get(s.get_suffix()) + + # AIB currently uses file suffixes to do mapping. However, sometimes we need + # to do the mapping based on a different suffix. This is used for things like + # dSYM files, where we really just want to describe where .dSYM bundles should + # be placed, but need to actually handle the substructure. Currently, this is + # only used by separate_debug.py. + # + # TODO: Find a way to do this without the tools needing to coordinate. + suffix = getattr(s.attributes, "aib_effective_suffix", s.get_suffix()) + auto_install_mapping = env[SUFFIX_MAP].get(suffix) + if not auto_install_mapping: raise Exception( "No target provided and no auto install mapping found for:", str(s) ) - target = auto_install_mapping.directory - # We've already auto installed this file and it may have belonged to a # different role since it wouldn't get retagged above. So we just skip # this files since SCons will already wire the dependency since s is a @@ -379,11 +387,13 @@ def auto_install_pseudobuilder(env, target, source, **kwargs): if existing_installed_files: continue - # We must do an eearly subst here so that the _aib_debugdir + # We must do an early subst here so that the _aib_debugdir # generator has a chance to run while seeing 'source'. - # - # TODO: Find a way to not need this early subst. target = env.Dir(env.subst(target, source=s)) + aib_additional_directory = getattr(s.attributes, "aib_additional_directory", None) + if aib_additional_directory is not None: + target = env.Dir(aib_additional_directory, directory=target) + new_installed_files = env.Install(target=target, source=s) setattr(s.attributes, INSTALLED_FILES, new_installed_files) @@ -435,7 +445,6 @@ def auto_install_emitter(target, source, env): if isinstance(t, str): t = env.File(t) - suffix = t.get_suffix() if env.get("AIB_IGNORE", False): continue @@ -448,7 +457,10 @@ def auto_install_emitter(target, source, env): if "conftest" in str(t): continue + # Get the suffix, unless overridden + suffix = getattr(t.attributes, "aib_effective_suffix", t.get_suffix()) auto_install_mapping = env[SUFFIX_MAP].get(suffix) + if auto_install_mapping is not None: env.AutoInstall( auto_install_mapping.directory, diff --git a/site_scons/site_tools/separate_debug.py b/site_scons/site_tools/separate_debug.py index 4347f3031ab..aa0105f2358 100644 --- a/site_scons/site_tools/separate_debug.py +++ b/site_scons/site_tools/separate_debug.py @@ -15,7 +15,7 @@ import SCons -def _update_builder(env, builder, bitcode): +def _update_builder(env, builder): old_scanner = builder.target_scanner old_path_function = old_scanner.path_function @@ -23,15 +23,14 @@ def _update_builder(env, builder, bitcode): def new_scanner(node, env, path=()): results = old_scanner.function(node, env, path) origin = getattr(node.attributes, "debug_file_for", None) - if origin: + if origin is not None: origin_results = old_scanner(origin, env, path) for origin_result in origin_results: - origin_result_debug_file = getattr( - origin_result.attributes, "separate_debug_file", None + origin_result_debug_files = getattr( + origin_result.attributes, "separate_debug_files", None ) - if origin_result_debug_file: - results.append(origin_result_debug_file) - # TODO: Do we need to do the same sort of drag along for bcsymbolmap files? + if origin_result_debug_files is not None: + results.extend(origin_result_debug_files) return results builder.target_scanner = SCons.Scanner.Scanner( @@ -50,34 +49,28 @@ def _update_builder(env, builder, bitcode): # setup from the etc/scons/xcode_*.vars files, which would be a # win as well. if env.TargetOSIs("darwin"): - if bitcode: - base_action.list.append( + base_action.list.extend( + [ SCons.Action.Action( - "dsymutil -num-threads=1 $TARGET --symbol-map=${TARGET}.bcsymbolmap -o ${TARGET}.dSYM", - "Generating debug info for $TARGET into ${TARGET}.dSYM", - ) - ) - - else: - base_action.list.append( + "$DSYMUTIL -num-threads 1 $TARGET -o ${TARGET}.dSYM", + "$DSYMUTILCOMSTR" + ), SCons.Action.Action( - "dsymutil -num-threads=1 $TARGET -o ${TARGET}.dSYM", - "Generating debug info for $TARGET into ${TARGET}.dSYM", - ) - ) - base_action.list.append( - SCons.Action.Action("strip -Sx ${TARGET}", "Stripping ${TARGET}") + "$STRIP -Sx ${TARGET}", + "$DEBUGSTRIPCOMSTR" + ), + ] ) elif env.TargetOSIs("posix"): base_action.list.extend( [ SCons.Action.Action( - "${OBJCOPY} --only-keep-debug $TARGET ${TARGET}.debug", - "Generating debug info for $TARGET into ${TARGET}.debug", + "$OBJCOPY --only-keep-debug $TARGET ${TARGET}.debug", + "$OBJCOPY_ONLY_KEEP_DEBUG_COMSTR" ), SCons.Action.Action( - "${OBJCOPY} --strip-debug --add-gnu-debuglink ${TARGET}.debug ${TARGET}", - "Stripping debug info from ${TARGET} and adding .gnu.debuglink to ${TARGET}.debug", + "$OBJCOPY --strip-debug --add-gnu-debuglink ${TARGET}.debug ${TARGET}", + "$DEBUGSTRIPCOMSTR" ), ] ) @@ -90,30 +83,52 @@ def _update_builder(env, builder, bitcode): def new_emitter(target, source, env): - bitcode_file = None + debug_files = [] if env.TargetOSIs("darwin"): - debug_file = env.Entry(str(target[0]) + ".dSYM") - env.Precious(debug_file) - if bitcode: - bitcode_file = env.File(str(target[0]) + ".bcsymbolmap") + + # There isn't a lot of great documentation about the structure of dSYM bundles. + # For general bundles, see: + # + # https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html + # + # But we expect to find two files in the bundle. An + # Info.plist file under Contents, and a file with the same + # name as the target under Contents/Resources/DWARF. + + target0 = env.File(target[0]) + dsym_dir_name = str(target[0]) + ".dSYM" + dsym_dir = env.Dir(dsym_dir_name, directory=target0.get_dir()) + + plist_file = env.File("Contents/Info.plist", directory=dsym_dir) + setattr(plist_file.attributes, "aib_effective_suffix", ".dSYM") + setattr(plist_file.attributes, "aib_additional_directory", "{}/Contents".format(dsym_dir_name)) + + dwarf_dir = env.Dir("Contents/Resources/DWARF", directory=dsym_dir) + + dwarf_file = env.File(target0.name, directory=dwarf_dir) + setattr(dwarf_file.attributes, "aib_effective_suffix", ".dSYM") + setattr(dwarf_file.attributes, "aib_additional_directory", "{}/Contents/Resources/DWARF".format(dsym_dir_name)) + + debug_files.extend([plist_file, dwarf_file]) + elif env.TargetOSIs("posix"): debug_file = env.File(str(target[0]) + ".debug") + debug_files.append(debug_file) elif env.TargetOSIs("windows"): debug_file = env.File(env.subst("${PDB}", target=target)) + debug_files.append(debug_file) else: pass - setattr(debug_file.attributes, "debug_file_for", target[0]) - setattr(target[0].attributes, "separate_debug_file", debug_file) - - target.append(debug_file) + # Establish bidirectional linkages between the target and each debug file by setting + # attributes on th nodes. We use these in the scanner above to ensure that transitive + # dependencies among libraries are projected into transitive dependencies between + # debug files. + for debug_file in debug_files: + setattr(debug_file.attributes, "debug_file_for", target[0]) + setattr(target[0].attributes, "separate_debug_files", debug_files) - if bitcode_file: - setattr(bitcode_file.attributes, "bcsymbolmap_file_for", target[0]) - setattr(target[0].attributes, "bcsymbolmap_file", bitcode_file) - target.append(bitcode_file) - - return (target, source) + return (target + debug_files, source) new_emitter = SCons.Builder.ListEmitter([base_emitter, new_emitter]) builder.emitter = new_emitter @@ -123,33 +138,41 @@ def generate(env): if not exists(env): return - # If we are generating bitcode, add the magic linker flags that - # hide the bitcode symbols, and override the name of the bitcode - # symbol map file so that it is determinstically known to SCons - # rather than being a UUID. We need this so that we can install it - # under a well known name. We leave it to the evergreen - # postprocessing to rename to the correct name. I'd like to do - # this better, but struggled for a long time and decided that - # later was a better time to address this. We should also consider - # moving all bitcode setup into a separate tool. - bitcode = False - if env.TargetOSIs("darwin") and any( - flag == "-fembed-bitcode" for flag in env["LINKFLAGS"] - ): - bitcode = True - env.AppendUnique( - LINKFLAGS=[ - "-Wl,-bitcode_hide_symbols", - "-Wl,-bitcode_symbol_map,${TARGET}.bcsymbolmap", - ] - ) + if env.TargetOSIs("darwin"): + + if env.get("DSYMUTIL", None) is None: + env["DSYMUTIL"] = env.WhereIs("dsymutil") + + if env.get("STRIP", None) is None: + env["STRIP"] = env.WhereIs("strip") + + if not env.Verbose(): + env.Append( + DSYMUTILCOMSTR="Generating debug info for $TARGET into ${TARGET}.dSYM", + DEBUGSTRIPCOMSTR="Stripping debug info from ${TARGET}", + ) + + elif env.TargetOSIs("posix"): + if env.get("OBJCOPY", None) is None: + env["OBJCOPY"] = env.Whereis("objcopy") + + if not env.Verbose(): + env.Append( + OBJCOPY_ONLY_KEEP_DEBUG_COMSTR="Generating debug info for $TARGET into ${TARGET}.dSYM", + DEBUGSTRIPCOMSTR="Stripping debug info from ${TARGET} and adding .gnu.debuglink to ${TARGET}.debug", + ) - # TODO: For now, not doing this for programs. Need to update - # auto_install_binaries to understand to install the debug symbol - # for target X to the same target location as X. for builder in ["Program", "SharedLibrary", "LoadableModule"]: - _update_builder(env, env["BUILDERS"][builder], bitcode) + _update_builder(env, env["BUILDERS"][builder]) def exists(env): + if env.TargetOSIs("darwin"): + if env.get("DSYMUTIL", None) is None and env.WhereIs("dsymutil") is None: + return False + if env.get("STRIP", None) is None and env.WhereIs("strip") is None: + return False + elif env.TargetOSIs("posix"): + if env.get("OBJCOPY", None) is None and env.WhereIs("objcopy") is None: + return False return True diff --git a/src/mongo/embedded/mongo_embedded/SConscript b/src/mongo/embedded/mongo_embedded/SConscript index 99bf61ad99c..040e94f0ce0 100644 --- a/src/mongo/embedded/mongo_embedded/SConscript +++ b/src/mongo/embedded/mongo_embedded/SConscript @@ -105,78 +105,3 @@ if get_option('link-model') != 'dynamic-sdk': UNITTEST_HAS_CUSTOM_MAINLINE=True, AIB_COMPONENT='embedded-test', ) - -# Frameworkization craziness begins here. Honestly, we should do this -# better in the future in some re-usable way, but we need to get this -# thing out the door, so here goes. - -# First, we only do this in hygienic mode for the mobile targets, -# which are darwin but not macOS. For all others, we abort here. Maybe -# this should be a build flag? Since we aren't doing this for macOS, -# we can also ignore all the framework version nonsense. -if get_option('link-model') != 'dynamic-sdk' or get_option('install-mode') != 'hygienic' or not env.TargetOSIs('darwin') or env.TargetOSIs('macOS'): - Return() - -frameworkDir = env.Dir('$DESTDIR/Frameworks/mongo_embedded.framework') -env.Alias('install-embedded-dev', frameworkDir) - -resourceDir = frameworkDir -if env.TargetOSIs('macOS'): - resourceDir = resourceDir.Dir('Resources') - -env.Install( - target=frameworkDir.Dir('Headers'), - source=env.File('mongo_embedded.h') -) - -env.InstallAs( - target=frameworkDir.File('Modules/module.modulemap'), - source="mongo_embedded.modulemap" -) - -mongoEmbeddedPlist = env.Substfile( - target="Info.plist", - source='../Info.plist.in', - SUBST_DICT=[ - ('@CFBundleExecutable@', 'mongo_embedded'), - ('@CFBundleIdentifier@', 'org.mongodb.mongo-embedded'), - ('@CFBundleVersion@', env['PLIST_MONGO_BUNDLE_VERSION']), - ('@CFBundleShortVersionString@', env['PLIST_MONGO_BUNDLE_VERSION']), - ('@MinimumOSVersion@', env['PLIST_MINIMUM_OS_VERSION']) - ] -) - -env.Install( - target=resourceDir, - source=mongoEmbeddedPlist, -) - -mongoEmbeddedFwLib = env.InstallAs( - target=frameworkDir.File('mongo_embedded'), - source=mongoEmbeddedTargets[0], -) - -env.AddPostAction( - files=mongoEmbeddedFwLib, - action=[ - "install_name_tool -delete_rpath @loader_path/../lib $TARGET", - "install_name_tool -id @rpath/mongo_embedded.framework/mongo_embedded $TARGET", - ] -) - -mongoEmbeddedDSYM = getattr(mongoEmbeddedTargets[0].attributes, "separate_debug_file", None) -if mongoEmbeddedDSYM: - frameworkDSYMDir = '$DESTDIR/Frameworks/mongo_embedded.framework.dSYM' - env.Alias('install-embedded-dev', frameworkDSYMDir) - - env.InstallAs( - target=frameworkDSYMDir, - source=mongoEmbeddedDSYM, - ) - -mongoEmbeddedBCSymbolMap = getattr(mongoEmbeddedTargets[0].attributes, "bcsymbolmap_file", None) -if mongoEmbeddedBCSymbolMap: - env.Install( - target=frameworkDir.Dir('BCSymbolMaps'), - source=mongoEmbeddedBCSymbolMap, - ) diff --git a/src/mongo/embedded/mongoc_embedded/SConscript b/src/mongo/embedded/mongoc_embedded/SConscript index d4bca37472c..743769b55f6 100644 --- a/src/mongo/embedded/mongoc_embedded/SConscript +++ b/src/mongo/embedded/mongoc_embedded/SConscript @@ -103,90 +103,3 @@ if get_option('link-model') != 'dynamic-sdk': UNITTEST_HAS_CUSTOM_MAINLINE=True, AIB_COMPONENT='embedded-test', ) - -# Frameworkization craziness begins here. Honestly, we should do this -# better in the future in some re-usable way, but we need to get this -# thing out the door, so here goes. - -# First, we only do this in hygienic mode for the mobile targets, -# which are darwin but not macOS. For all others, we abort here. Maybe -# this should be a build flag? Since we aren't doing this for macOS, -# we can also ignore all the framework version nonsense. -if get_option('link-model') != 'dynamic-sdk' or get_option('install-mode') != 'hygienic' or not env.TargetOSIs('darwin') or env.TargetOSIs('macOS'): - Return() - -frameworkDir = env.Dir('$DESTDIR/Frameworks/mongoc_embedded.framework') -env.Alias('install-embedded-dev', frameworkDir) - -resourceDir = frameworkDir -if env.TargetOSIs('macOS'): - resourceDir = resourceDir.Dir('Resources') - -env.Install( - target=resourceDir, - source=env.File( - name=[ - 'LICENSE-Community.txt', - 'LICENSE-Embedded.txt', - ], - directory=env.Dir('$PREFIX_DOCDIR/mongoc_embedded'), - ), -) - -env.Install( - target=frameworkDir.Dir('Headers'), - source=env.File('mongoc_embedded.h'), -) - -env.InstallAs( - target=frameworkDir.File('Modules/module.modulemap'), - source="mongoc_embedded.modulemap" -) - -mongocEmbeddedPlist = env.Substfile( - target="Info.plist", - source='../Info.plist.in', - SUBST_DICT=[ - ('@CFBundleExecutable@', 'mongoc_embedded'), - ('@CFBundleIdentifier@', 'org.mongodb.mongoc-embedded'), - ('@CFBundleVersion@', env['PLIST_MONGO_BUNDLE_VERSION']), - ('@CFBundleShortVersionString@', env['PLIST_MONGO_BUNDLE_VERSION']), - ('@MinimumOSVersion@', env['PLIST_MINIMUM_OS_VERSION']) - ] -) - -env.Install( - target=resourceDir, - source=mongocEmbeddedPlist, -) - -mongocEmbeddedFwLib = env.InstallAs( - target=frameworkDir.File('mongoc_embedded'), - source=mongocEmbeddedTargets[0], -) - -env.AddPostAction( - files=mongocEmbeddedFwLib, - action=[ - "install_name_tool -delete_rpath @loader_path/../lib $TARGET", - "install_name_tool -id @rpath/mongoc_embedded.framework/mongoc_embedded $TARGET", - "install_name_tool -change @rpath/libmongo_embedded.dylib @rpath/mongo_embedded.framework/mongo_embedded $TARGET", - ], -) - -mongocEmbeddedDSYM = getattr(mongocEmbeddedTargets[0].attributes, "separate_debug_file", None) -if mongocEmbeddedDSYM: - frameworkDSYMDir = '$DESTDIR/Frameworks/mongoc_embedded.framework.dSYM' - env.Alias('install-embedded-dev', frameworkDSYMDir) - - env.InstallAs( - target=frameworkDSYMDir, - source=mongocEmbeddedDSYM, - ) - -mongocEmbeddedBCSymbolMap = getattr(mongocEmbeddedTargets[0].attributes, "bcsymbolmap_file", None) -if mongocEmbeddedBCSymbolMap: - env.Install( - target=frameworkDir.Dir('BCSymbolMaps'), - source=mongocEmbeddedBCSymbolMap, - ) |