sourcemod/AMBuildScript

# vim: set sts=2 ts=8 sw=2 tw=99 et ft=python:
import collections
import os, sys
import subprocess

def ResolveEnvPath(env, folder):
  if env in os.environ:
    path = os.environ[env]
    if os.path.isdir(path):
      return path
    return None

  head = os.getcwd()
  oldhead = None
  while head != None and head != oldhead:
    path = os.path.join(head, folder)
    if os.path.isdir(path):
      return path
    oldhead = head
    head, tail = os.path.split(head)

  return None

def Normalize(path):
  return os.path.abspath(os.path.normpath(path))
  
def SetArchFlags(compiler):
  if compiler.behavior == 'gcc':
    if compiler.target.arch == 'x86_64':
      compiler.cflags += ['-fPIC']
  elif compiler.like('msvc'):
    if compiler.target.arch == 'x86_64':
      compiler.defines += ['WIN64']

SdkHelpers = builder.Eval('hl2sdk-manifests/SdkHelpers.ambuild', {
    'Project': 'sourcemod'
})

class SMConfig(object):
  def __init__(self):
    self.sdk_manifests = []
    self.sdks = {}
    self.sdk_targets = []
    self.binaries = []
    self.spvm = []
    self.extensions = []
    self.generated_headers = None
    self.mms_root = None
    self.mysql_root = {}
    self.spcomp = None
    self.spcomp_bins = []
    self.smx_files = {}
    self.versionlib = None
    self.all_targets = []
    self.target_archs = set()
    self.enable_asan = getattr(builder.options, 'enable_asan', False)
    self.asan_libs = {}
    self.libsafetyhook = {}

    if builder.options.targets:
      target_archs = builder.options.targets.split(',')
    else:
      target_archs = ['x86']
      if builder.backend != 'amb2':
        target_archs.append('x86_64')

    for arch in target_archs:
        try:
            cxx = builder.DetectCxx(target_arch = arch)
            self.target_archs.add(cxx.target.arch)
        except Exception as e:
            # Error if archs were manually overridden.
            if builder.options.targets:
                raise
            print('Skipping target {}: {}'.format(arch, e))
            continue
        self.all_targets.append(cxx)

    if not self.all_targets:
        raise Exception('No suitable C/C++ compiler was found.')

  def use_auto_versioning(self):
    if builder.backend != 'amb2':
      return False
    return not getattr(builder.options, 'disable_auto_versioning', False)

  @property
  def tag(self):
    if builder.options.debug == '1':
      return 'Debug'
    return 'Release'

  def detectProductVersion(self):
    builder.AddConfigureFile('product.version')

    # For OS X dylib versioning
    import re
    with open(os.path.join(builder.sourcePath, 'product.version'), 'r') as fp:
      productContents = fp.read()
    m = re.match(r'(\d+)\.(\d+)\.(\d+).*', productContents)
    if m == None:
      self.productVersion = '1.0.0'
    else:
      major, minor, release = m.groups()
      self.productVersion = '{0}.{1}.{2}'.format(major, minor, release)

  def findSdkPath(self, sdk_name):
    dir_name = 'hl2sdk-{}'.format(sdk_name)
    if builder.options.hl2sdk_root:
      sdk_path = os.path.join(builder.options.hl2sdk_root, dir_name)
      if os.path.exists(sdk_path):
        return sdk_path
    return ResolveEnvPath('HL2SDK{}'.format(sdk_name.upper()), dir_name)

  def shouldIncludeSdk(self, sdk):
    return not sdk.get('source2', False)

  def detectSDKs(self):
    sdk_list = [s for s in builder.options.sdks.split(',') if s]
    SdkHelpers.sdk_filter = self.shouldIncludeSdk
    SdkHelpers.find_sdk_path = self.findSdkPath
    SdkHelpers.findSdks(builder, self.all_targets, sdk_list)

    self.sdks = SdkHelpers.sdks
    self.sdk_manifests = SdkHelpers.sdk_manifests
    self.sdk_targets = SdkHelpers.sdk_targets

    if builder.options.mms_path:
      self.mms_root = builder.options.mms_path
    else:
      self.mms_root = ResolveEnvPath('MMSOURCE112', 'mmsource-1.12')
      if not self.mms_root:
        self.mms_root = ResolveEnvPath('MMSOURCE_DEV', 'metamod-source')
      if not self.mms_root:
        self.mms_root = ResolveEnvPath('MMSOURCE_DEV', 'mmsource-central')

    if not self.mms_root or not os.path.isdir(self.mms_root):
      raise Exception('Could not find a source copy of Metamod:Source')
    self.mms_root = Normalize(self.mms_root)

    if builder.options.hasMySql:
      if 'x86' in self.target_archs:
        if builder.options.mysql_path:
          self.mysql_root['x86'] = builder.options.mysql_path
        else:
          for i in range(10):
            self.mysql_root['x86'] = ResolveEnvPath('MYSQL55', 'mysql-5.' + str(i))
            if self.mysql_root['x86']:
              break
        if not self.mysql_root['x86'] or not os.path.isdir(self.mysql_root['x86']):
          raise Exception('Could not find a path to MySQL. Configure with --no-mysql to disable it.')
        self.mysql_root['x86'] = Normalize(self.mysql_root['x86'])

      if 'x86_64' in self.target_archs:
        if builder.options.mysql64_path:
          self.mysql_root['x86_64'] = builder.options.mysql64_path
        else:
          for i in range(10):
            self.mysql_root['x86_64'] = ResolveEnvPath('MYSQL55_64', 'mysql-5.' + str(i) + '-x86_64')
            if self.mysql_root['x86_64']:
              break
        if not self.mysql_root['x86_64'] or not os.path.isdir(self.mysql_root['x86_64']):
          raise Exception('Could not find a path to 64-bit MySQL!')
        self.mysql_root['x86_64'] = Normalize(self.mysql_root['x86_64'])

  def configure(self):
    builder.AddConfigureFile('pushbuild.txt')
    
    allowed_archs = ['x86_64']
    if builder.host.platform == 'mac':
        if getattr(builder.options, 'scripting_only', False):
            allowed_archs += ['arm64']
    else:
        allowed_archs += ['x86']

    if not set(self.target_archs).issubset(allowed_archs):
      raise Exception('Unknown target architecture: {0}'.format(self.target_archs))

    for cxx in self.all_targets:
        self.configure_cxx(cxx)

  def configure_cxx(self, cxx):
    if cxx.family == 'msvc':
      if cxx.version < 1914 and builder.options.generator != 'vs':
        raise Exception(f'Only MSVC 2017 15.7 and later are supported, full C++17 support is required. ({str(cxx.version)} < 1914)')
    elif cxx.family == 'gcc':
      if cxx.version < 'gcc-9':
        raise Exception('Only GCC versions 9 or later are supported, full C++17 support is required.')
    elif cxx.family == 'clang':
      if cxx.version < 'clang-5':
        raise Exception('Only clang versions 5 or later are supported, full C++17 support is required.')

    if cxx.like('gcc'):
      self.configure_gcc(cxx)
    elif cxx.family == 'msvc':
      self.configure_msvc(cxx)

    # Optimizaiton
    if builder.options.opt == '1':
      cxx.defines += ['NDEBUG']

    # Debugging
    if builder.options.debug == '1':
      cxx.defines += ['DEBUG', '_DEBUG']

    # Platform-specifics
    if cxx.target.platform == 'linux':
      self.configure_linux(cxx)
    elif cxx.target.platform == 'mac':
      self.configure_mac(cxx)
    elif cxx.target.platform == 'windows':
      self.configure_windows(cxx)

    # Finish up.
    cxx.defines += [
      'SOURCEMOD_BUILD',
      'SM_USE_VERSIONLIB',
    ]
    cxx.includes += [
      os.path.join(builder.sourcePath, 'public'),
    ]
    if self.use_auto_versioning():
      cxx.defines += ['SM_GENERATED_BUILD']
      cxx.includes += [
        os.path.join(builder.buildPath, 'includes'),
        os.path.join(builder.sourcePath, 'versionlib'),
      ]

  def configure_gcc(self, cxx):
    cxx.defines += [
      'stricmp=strcasecmp',
      '_stricmp=strcasecmp',
      '_snprintf=snprintf',
      '_vsnprintf=vsnprintf',
      'HAVE_STDINT_H',
      'GNUC',
    ]
    cxx.cflags += [
      '-pipe',
      '-fno-strict-aliasing',
      '-Wall',
      '-Werror',
      '-Wno-unused',
      '-Wno-switch',
      '-Wno-array-bounds',
      '-fvisibility=hidden',
    ]
    if cxx.target.arch in ['x86', 'x86_64']:
      cxx.cflags += ['-msse']

    cxx.cxxflags += ['-std=c++17']

    cxx.cxxflags += [
      '-fno-threadsafe-statics',
      '-Wno-non-virtual-dtor',
      '-Wno-overloaded-virtual',
      '-Wno-register',
      '-fvisibility-inlines-hidden',
    ]

    have_gcc = cxx.family == 'gcc'
    have_clang = cxx.family == 'clang'
    if cxx.version >= 'clang-3.9' or cxx.version == 'clang-3.4' or cxx.version > 'apple-clang-6.0':
      cxx.cxxflags += ['-Wno-expansion-to-defined']
    if cxx.version == 'clang-3.9' or cxx.version == 'apple-clang-8.0':
      cxx.cflags += ['-Wno-varargs']
    if cxx.version >= 'clang-3.4' or cxx.version >= 'apple-clang-7.0':
      cxx.cxxflags += ['-Wno-inconsistent-missing-override']
    if cxx.version >= 'clang-2.9' or cxx.version >= 'apple-clang-3.0':
      cxx.cxxflags += ['-Wno-null-dereference']
    if have_clang or (cxx.version >= 'gcc-4.6'):
      cxx.cflags += ['-Wno-narrowing']
    if have_clang or (cxx.version >= 'gcc-4.7'):
      cxx.cxxflags += ['-Wno-delete-non-virtual-dtor']
    if cxx.version >= 'gcc-4.8':
      cxx.cflags += ['-Wno-unused-result']
    if cxx.version >= 'gcc-9.0':
      cxx.cxxflags += ['-Wno-class-memaccess', '-Wno-packed-not-aligned']
    if have_clang:
      cxx.cxxflags += ['-Wno-implicit-exception-spec-mismatch']
      if cxx.version >= 'apple-clang-5.1' or cxx.version >= 'clang-3.4':
        cxx.cxxflags += ['-Wno-deprecated-register']
      else:
        cxx.cxxflags += ['-Wno-deprecated']
      cxx.cflags += ['-Wno-sometimes-uninitialized']

    if self.enable_asan:
      if not have_clang:
        raise Exception('--enable-asan only supported when using Clang')
      self.configure_asan(cxx)

    # Work around SDK warnings.
    if cxx.version >= 'clang-10.0' or cxx.version >= 'apple-clang-12.0':
        cxx.cflags += [
            '-Wno-implicit-int-float-conversion',
            '-Wno-tautological-overlap-compare',
        ]

    if have_gcc:
      cxx.cflags += ['-mfpmath=sse']
      cxx.cflags += ['-Wno-maybe-uninitialized']

    if builder.options.opt == '1':
      if self.enable_asan:
        cxx.cflags += ['-O1']
      else:
        cxx.cflags += ['-O3']

    # Don't omit the frame pointer.
    cxx.cflags += ['-fno-omit-frame-pointer']

  def configure_msvc(self, cxx):
    if self.enable_asan:
      raise Exception('--enable-asan only supported when using Clang')

    if builder.options.debug == '1':
      cxx.cflags += ['/MTd']
      cxx.linkflags += ['/NODEFAULTLIB:libcmt']
    else:
      cxx.cflags += ['/MT']
    cxx.defines += [
      '_CRT_SECURE_NO_DEPRECATE',
      '_CRT_SECURE_NO_WARNINGS',
      '_CRT_NONSTDC_NO_DEPRECATE',
      '_ITERATOR_DEBUG_LEVEL=0',
    ]
    cxx.cflags += [
      '/W3',
    ]
    cxx.cxxflags += [
      '/EHsc',
      '/GR-',
      '/TP',
      '/std:c++17',
    ]
    cxx.linkflags += [
      'kernel32.lib',
      'user32.lib',
      'gdi32.lib',
      'winspool.lib',
      'comdlg32.lib',
      'advapi32.lib',
      'shell32.lib',
      'ole32.lib',
      'oleaut32.lib',
      'uuid.lib',
      'odbc32.lib',
      'odbccp32.lib',
    ]

    if builder.options.opt == '1':
      cxx.cflags += ['/Ox', '/Zo']
      cxx.linkflags += ['/OPT:ICF', '/OPT:REF']

    if builder.options.debug == '1':
      cxx.cflags += ['/Od', '/RTC1']

    # This needs to be after our optimization flags which could otherwise disable it.
    # Don't omit the frame pointer.
    cxx.cflags += ['/Oy-']

  def configure_asan(self, cxx):
    if cxx.target.platform != 'linux':
      raise Exception('--enable-asan only supported on Linux')
    cxx.cflags += ['-fsanitize=address']
    cxx.linkflags += ['-fsanitize=address']
    if cxx.target.arch == 'x86':
      libclang_rt = 'libclang_rt.asan-i386.so'
    else:
      libclang_rt = 'libclang_rt.asan-x86_64.so'

    try:
      argv = cxx.cxx_argv + ['--print-file-name', libclang_rt]
      output = subprocess.check_output(argv)
      output = output.decode('utf-8')
      output = output.strip()
    except:
      raise Exception('Could not find {}'.format(libclang_rt))

    print('ASAN library for {}: {}'.format(cxx.target.arch, output))
    print('You will need to LD_PRELOAD this into srcds.')

    self.asan_libs[cxx.target.arch] = os.path.dirname(output)

  def configure_linux(self, cxx):
    cxx.defines += ['LINUX', '_LINUX', 'POSIX', '_FILE_OFFSET_BITS=64']
    cxx.linkflags += ['-lm']
    if cxx.family == 'gcc':
      cxx.linkflags += ['-static-libgcc']
    elif cxx.family == 'clang':
      cxx.linkflags += ['-lgcc_eh']
    cxx.linkflags += ['-static-libstdc++']

  def configure_mac(self, cxx):
    cxx.defines += ['OSX', '_OSX', 'POSIX', 'KE_ABSOLUTELY_NO_STL']
    cxx.cflags += ['-mmacosx-version-min=10.15']
    cxx.linkflags += [
      '-mmacosx-version-min=10.15',
      '-stdlib=libc++',
      '-lc++',
    ]
    cxx.cxxflags += ['-stdlib=libc++']

  def configure_windows(self, cxx):
    cxx.defines += ['WIN32', '_WINDOWS']

  def add_libamtl(self):
    # Add libamtl.
    self.libamtl = {}
    for cxx in self.all_targets:
      def get_configure_fn(cxx):
        return lambda builder, name: self.StaticLibrary(builder, cxx, name)
      extra_vars = {'Configure': get_configure_fn(cxx)}
      libamtl = builder.Build('public/amtl/amtl/AMBuilder', extra_vars)
      self.libamtl[cxx.target.arch] = libamtl.binary

  def AddVersioning(self, binary):
    if binary.compiler.target.platform == 'windows':
      binary.sources += ['version.rc']
      binary.compiler.rcdefines += [
        'BINARY_NAME="{0}"'.format(binary.outputFile),
        'RC_COMPILE',
      ]
      if self.use_auto_versioning():
        binary.compiler.rcdefines += ['SM_GENERATED_BUILD']
    elif binary.compiler.target.platform == 'mac':
      if binary.type == 'library':
        binary.compiler.postlink += [
          '-compatibility_version', '1.0.0',
          '-current_version', self.productVersion
        ]
    if self.use_auto_versioning():
      binary.compiler.postlink += [self.versionlib[binary.compiler.target.arch]]
      binary.compiler.sourcedeps += SM.generated_headers
    return binary
    
  def LibraryBuilder(self, compiler, name):
    binary = compiler.Library(name)
    self.AddVersioning(binary)
    if binary.compiler.like('msvc'):
      binary.compiler.linkflags += ['/SUBSYSTEM:WINDOWS']
    self.AddCxxCompat(binary)

    # Dumb clang behavior means we have to manually find libclang_rt.
    if self.enable_asan:
      binary.compiler.linkflags += [
        '-shared-libsan',
        '-Wl,-rpath={}'.format(self.asan_libs[binary.compiler.target.arch]),
      ]
    return binary

  def ProgramBuilder(self, compiler, name):
    binary = compiler.Program(name)
    self.AddVersioning(binary)
    if '-static-libgcc' in binary.compiler.linkflags:
      binary.compiler.linkflags.remove('-static-libgcc')
    if self.enable_asan:
      binary.compiler.linkflags.append('-static-libsan')
    if '-lgcc_eh' in binary.compiler.linkflags:
      binary.compiler.linkflags.remove('-lgcc_eh')
    if binary.compiler.like('gcc'):
      binary.compiler.linkflags += ['-lstdc++', '-lpthread']
    if binary.compiler.like('msvc'):
      binary.compiler.linkflags += ['/SUBSYSTEM:CONSOLE']
    return binary
    
  def StaticLibraryBuilder(self, compiler, name):
    return compiler.StaticLibrary(name)

  def Library(self, context, compiler, name):
    compiler = compiler.clone()
    SetArchFlags(compiler)
    return self.LibraryBuilder(compiler, name)

  def Program(self, context, compiler, name):
    compiler = compiler.clone()
    SetArchFlags(compiler)
    return self.ProgramBuilder(compiler, name)
    
  def StaticLibrary(self, context, compiler, name):
    compiler = compiler.clone()
    SetArchFlags(compiler)
    return self.StaticLibraryBuilder(compiler, name)

  def ConfigureForExtension(self, context, compiler):
    compiler.cxxincludes += [
      os.path.join(context.currentSourcePath),
      os.path.join(context.currentSourcePath, 'sdk'),
      os.path.join(builder.sourcePath, 'public', 'extensions'),
      os.path.join(builder.sourcePath, 'sourcepawn', 'include'),
      os.path.join(builder.sourcePath, 'public', 'amtl', 'amtl'),
      os.path.join(builder.sourcePath, 'public', 'amtl'),
    ]
    return compiler

  def ExtLibrary(self, context, compiler, name):
    binary = self.Library(context, compiler, name)
    SetArchFlags(compiler)
    self.ConfigureForExtension(context, binary.compiler)
    return binary

  def AddCxxCompat(self, binary):
    if binary.compiler.target.platform == 'linux':
      binary.sources += [
        os.path.join(builder.sourcePath, 'public', 'amtl', 'compat', 'stdcxx.cpp'),
      ]

  def ConfigureForHL2(self, context, binary, sdk):
    compiler = binary.compiler
    SetArchFlags(compiler)

    compiler.cxxincludes += [
      os.path.join(self.mms_root, 'core'),
      os.path.join(self.mms_root, 'core', 'sourcehook'),
    ]

    for other_sdk in self.sdk_manifests:
      compiler.defines += ['SE_{}={}'.format(other_sdk['define'], other_sdk['code'])]

    SdkHelpers.configureCxx(context, binary, sdk)

    return binary

  def AddCDetour(self, binary):
    public_path = os.path.join(builder.sourcePath, 'public')
    binary.sources += [ os.path.join(public_path, 'CDetour', 'detours.cpp') ]
    binary.compiler.cxxincludes += [ os.path.join(public_path, 'safetyhook', 'include') ]

    for task in self.libsafetyhook:
      if task.target.arch == binary.compiler.target.arch:
        binary.compiler.linkflags += [task.binary]
        return
    raise Exception('No suitable build of safetyhook was found.')

  def HL2Library(self, context, compiler, name, sdk):
    binary = self.Library(context, compiler, name)
    self.ConfigureForExtension(context, binary.compiler)
    return self.ConfigureForHL2(context, binary, sdk)

  def HL2Config(self, project, context, compiler, name, sdk):
    binary = project.Configure(compiler, name,
                               '{0} - {1} {2}'.format(self.tag, sdk['name'], compiler.target.arch))
    self.AddCxxCompat(binary)
    self.AddVersioning(binary)
    return self.ConfigureForHL2(context, binary, sdk)

  def HL2ExtConfig(self, project, context, compiler, name, sdk):
    binary = project.Configure(compiler, name,
                               '{0} - {1} {2}'.format(self.tag, sdk['name'], compiler.target.arch))
    self.AddCxxCompat(binary)
    self.AddVersioning(binary)
    self.ConfigureForHL2(context, binary, sdk)
    self.ConfigureForExtension(context, binary.compiler)
    return binary

if getattr(builder, 'target', None) is not None:
    sys.stderr.write("Your output folder was configured for AMBuild 2.1, and SourceMod is now\n")
    sys.stderr.write("configured to use AMBuild 2.2. Please remove your output folder and\n")
    sys.stderr.write("reconfigure to continue.\n")
    os._exit(1)

SM = SMConfig()
SM.detectProductVersion()
if not getattr(builder.options, 'scripting_only', False):
  SM.detectSDKs()
SM.configure()
SM.add_libamtl()

# This will clone the list and each cxx object as we recurse, preventing child
# scripts from messing up global state.
builder.targets = builder.CloneableList(SM.all_targets)

if SM.use_auto_versioning():
  SM.generated_headers = builder.Build(
    'tools/buildbot/Versioning',
    { 'SM': SM }
  )
  SM.versionlib = builder.Build(
    'versionlib/AMBuilder',
    { 'SM': SM }
  )

class SafetyHookShim(object):
  def __init__(self):
    self.all_targets = {}
    self.libsafetyhook = {}

SafetyHook = SafetyHookShim()
SafetyHook.all_targets = SM.all_targets
builder.Build('public/safetyhook/AMBuilder', {'SafetyHook': SafetyHook })
SM.libsafetyhook = SafetyHook.libsafetyhook

class SPRoot(object):
  def __init__(self):
    self.generated_headers = SM.generated_headers
  # SourcePawn's build scripts are always one-offs, and attach the current target
  # to the builder, so we have to provide a shim to our StaticLibrary() method.
  def StaticLibrary(self, builder, name):
    return SM.StaticLibrary(builder, builder.cxx, name)
  def Program(self, builder, name):
    return SM.Program(builder, builder.cxx, name)
  def Library(self, builder, name):
    return SM.Library(builder, builder.cxx, name)

  @property
  def targets(self):
    return SM.all_targets

  @property
  def libamtl(self):
    return SM.libamtl

SP_build_parts = ['core']
if getattr(builder.options, 'scripting_only', False):
  SP_build_parts = ['spcomp']

# Build SourcePawn externally.
SP = builder.Build('sourcepawn/AMBuildScript', {
  'external_root': SPRoot(),
  'external_amtl': os.path.join(builder.sourcePath, 'public', 'amtl'),
  'external_build': SP_build_parts,
})

def IsBetterDefaultSpcomp(spcomp, other):
    if other is None:
        return True
    if spcomp.target.arch == 'universal':
        return True
    if other.target.arch == 'universal':
        return False
    return spcomp.target.arch == 'x86'

for spcomp in SP.spcomp:
    if IsBetterDefaultSpcomp(spcomp, SM.spcomp):
        SM.spcomp = spcomp
    SM.spcomp_bins.append(spcomp)

# If we have a universal binary, ignore all other spcomps.
if SM.spcomp.target.arch == 'universal':
    SM.spcomp_bins = [SM.spcomp]

if not getattr(builder.options, 'scripting_only', False):
  for cxx in SM.all_targets:
    SM.spvm += [
      SP.libsourcepawn[cxx.target.arch]
    ]

if getattr(builder.options, 'scripting_only', False):
  BuildScripts = [
    'tools/buildbot/PackageHelpers',
    'tools/buildbot/ToolsPackageScript',
  ]
else:
  BuildScripts = [
    'loader/AMBuilder',
    'core/AMBuilder',
    'core/logic/AMBuilder',
    'extensions/bintools/AMBuilder',
    'extensions/clientprefs/AMBuilder',
    'extensions/curl/AMBuilder',
    'extensions/cstrike/AMBuilder',
    'extensions/dhooks/AMBuilder',
    'extensions/geoip/AMBuilder',
    'extensions/mysql/AMBuilder',
    'extensions/pgsql/AMBuilder',
    'extensions/regex/AMBuilder',
    'extensions/sdkhooks/AMBuilder',
    'extensions/sdktools/AMBuilder',
    'extensions/sqlite/AMBuilder',
    'extensions/tf2/AMBuilder',
    'extensions/topmenus/AMBuilder',
    'extensions/updater/AMBuilder',
  ]

  if builder.backend == 'amb2':
    BuildScripts += [
      'plugins/AMBuilder',
      'tools/buildbot/PackageHelpers',
      'tools/buildbot/PackageScript',
    ]

builder.Build(BuildScripts, { 'SM': SM })

if builder.options.breakpad_dump:
  builder.Build('tools/buildbot/BreakpadSymbols', { 'SM': SM })