Introduce a pbproxy library to solve macOS linker issues.

On SDKs which use protobufs, the engine has objects compiled against a specific
version of protobuf. Normally this is fine, we take care on Linux to use the
same C++ ABI. On macOS however, we use libc++ to enable C++11 functionality,
whereas the protobuf library has been compiled with libstc++. These ABIs are
not compatible.

To address the problem, we introduce PbHandle. PbHandle is a wrapper around
protobuf::Message with two added pieces of state: whether or not the handle
"owns" the message (and can free it in its destructor), and whether or not
the handle was created by the engine (private) or created by SourceMod
(local).

Whenever we transfer a protobuf::Message pointer to SourceMod, we must take
care to convert it to a Local version first. Whenever we transfer a protobuf
pointer to the engine, we must convert it to a Private handle.

For platforms with no ABI differences (almost all of them), the handle is a
no-op. The private and local localities are compatible and no translation
takes place.

On macOS, CS:GO does require translation. SourceMod loads a tiny shim
library that contains a copy of the protobuf sources compiled against the
game's ABI. It then provides serialization and deserialization methods.
SourceMod must not interact with the game's protobuf objects without first
going through this proxy library.

Note that PbHandle is not quite like unique_ptr. It can be converted into a
PbHandle that does not destroy the underlying object. This is mainly because
UserMessages.cpp has rather complex state, so it is useful to track locality
without destroying an object. An unowned PbHandle must not outlive the
owning PbHandle.

Author: dvander

AMBuildScript

@@ -553,25 +553,7 @@ class SMConfig(object):
     if builder.target.platform == 'linux':
       if sdk.name in ['csgo', 'blade']:
         compiler.linkflags.remove('-static-libstdc++')
-        compiler.linkflags += ['-lstdc++']
         compiler.defines += ['_GLIBCXX_USE_CXX11_ABI=0']
-    elif builder.target.platform == 'mac':
-      if sdk.name in ['csgo']:
-        # Switch libc++ to libstdc++ for protobuf linkage.
-        compiler.cxxflags.remove('-stdlib=libc++')
-        compiler.linkflags.remove('-stdlib=libc++')
-        compiler.linkflags.remove('-lc++')
-
-        compiler.cxxflags += ['-stdlib=libstdc++']
-        compiler.linkflags += ['-stdlib=libstdc++']
-        compiler.linkflags += ['-lstdc++']
-
-        if 'c++1y' in compiler.cxxflags:
-          compiler.cxxflags.remove('-std=c++1y')
-          compiler.cxxflags += ['-std=c++11']
-        elif 'c++14' in compiler.cxxflags:
-          compiler.cxxflags.remove('-std=c++14')
-          compiler.cxxflags += ['-std=c++11']
 
     for path in paths:
       compiler.cxxincludes += [os.path.join(sdk.path, *path)]

core/AMBuilder

@@ -4,42 +4,43 @@ import os
 project = SM.HL2Project(builder, 'sourcemod')
 
 project.sources += [
-  'MenuStyle_Valve.cpp',
-  'logic_bridge.cpp',
-  'smn_entities.cpp',
-  'sm_stringutil.cpp',
-  'MenuVoting.cpp',
-  'smn_events.cpp',
-  'frame_hooks.cpp',
-  'smn_nextmap.cpp',
-  'sourcemm_api.cpp',
   'ChatTriggers.cpp',
-  'smn_player.cpp',
-  'sourcemod.cpp',
-  'concmd_cleaner.cpp',
-  'HalfLife2.cpp',
-  'NextMap.cpp',
   'ConCmdManager.cpp',
   'ConVarManager.cpp',
-  'PlayerManager.cpp',
-  'TimerSys.cpp',
+  'ConsoleDetours.cpp',
   'CoreConfig.cpp',
+  'EventManager.cpp',
+  'GameHooks.cpp',
+  'HalfLife2.cpp',
   'Logger.cpp',
-  'smn_halflife.cpp',
-  'smn_console.cpp',
-  'UserMessages.cpp',
   'MenuManager.cpp',
-  'smn_hudtext.cpp',
-  'smn_usermsgs.cpp',
   'MenuStyle_Base.cpp',
-  'smn_keyvalues.cpp',
-  'smn_vector.cpp',
-  'EventManager.cpp',
   'MenuStyle_Radio.cpp',
+  'MenuStyle_Valve.cpp',
+  'MenuVoting.cpp',
+  'NextMap.cpp',
+  'PlayerManager.cpp',
+  'TimerSys.cpp',
+  'UserMessages.cpp',
+  'concmd_cleaner.cpp',
+  'frame_hooks.cpp',
+  'logic_bridge.cpp',
+  'pb_handle.cpp',
   'sm_autonatives.cpp',
-  'ConsoleDetours.cpp',
+  'sm_stringutil.cpp',
   'smn_commandline.cpp',
-  'GameHooks.cpp',
+  'smn_console.cpp',
+  'smn_entities.cpp',
+  'smn_events.cpp',
+  'smn_halflife.cpp',
+  'smn_hudtext.cpp',
+  'smn_keyvalues.cpp',
+  'smn_nextmap.cpp',
+  'smn_player.cpp',
+  'smn_usermsgs.cpp',
+  'smn_vector.cpp',
+  'sourcemm_api.cpp',
+  'sourcemod.cpp',
 ]
 
 for sdk_name in SM.sdks:
@@ -57,18 +58,20 @@ for sdk_name in SM.sdks:
       builder.sourcePath
     ]
 
+    pb_includes = []
     if sdk.name == 'csgo':
-      compiler.cxxincludes += [
+      pb_includes = [
         os.path.join(sdk.path, 'common', 'protobuf-2.5.0', 'src'),
         os.path.join(sdk.path, 'public', 'engine', 'protobuf'),
         os.path.join(sdk.path, 'public', 'game', 'shared', 'csgo', 'protobuf')
       ]
     elif sdk.name == 'blade':
-      compiler.cxxincludes += [
+      pb_includes = [
         os.path.join(sdk.path, 'common', 'protobuf-2.5.0', 'src'),
         os.path.join(sdk.path, 'public', 'engine', 'protobuf'),
         os.path.join(sdk.path, 'public', 'game', 'shared', 'berimbau', 'protobuf')
       ]
+    compiler.cxxincludes += pb_includes
 
     if compiler.like('msvc'):
       compiler.defines += ['_ALLOW_KEYWORD_MACROS']
@@ -84,9 +87,9 @@ for sdk_name in SM.sdks:
         compiler.linkflags += ['-Wl,--exclude-libs=libprotobuf.a']
       elif builder.target.platform == 'mac':
         if arch == 'x86':
-          lib_path = os.path.join(sdk.path, 'lib', 'osx32', 'release', 'libprotobuf.a')
+          lib_path = os.path.join(sdk.path, 'lib', 'osx32', 'release', 'libprotobuf-libcxx.a')
         elif arch == 'x64':
-          lib_path = os.path.join(sdk.path, 'lib', 'osx64', 'release', 'libprotobuf.a')
+          lib_path = os.path.join(sdk.path, 'lib', 'osx64', 'release', 'libprotobuf-libcxx.a')
       elif builder.target.platform == 'windows':
         msvc_ver = compiler.version
         vs_year = ''
@@ -111,18 +114,53 @@ for sdk_name in SM.sdks:
         'vprof_tool.cpp',
       ]
 
+    pb_sources = []
     if sdk.name == 'csgo':
-      binary.sources += [
+      pb_sources = [
         os.path.join(sdk.path, 'public', 'engine', 'protobuf', 'netmessages.pb.cc'),
         os.path.join(sdk.path, 'public', 'game', 'shared', 'csgo', 'protobuf', 'cstrike15_usermessages.pb.cc'),
         os.path.join(sdk.path, 'public', 'game', 'shared', 'csgo', 'protobuf', 'cstrike15_usermessage_helpers.cpp'),
       ]
     elif sdk.name == 'blade':
-      binary.sources += [
+      pb_sources = [
         os.path.join(sdk.path, 'public', 'engine', 'protobuf', 'netmessages.pb.cc'),
         os.path.join(sdk.path, 'public', 'game', 'shared', 'berimbau', 'protobuf', 'berimbau_usermessages.pb.cc'),
         os.path.join(sdk.path, 'public', 'game', 'shared', 'berimbau', 'protobuf', 'berimbau_usermessage_helpers.cpp'),
       ]
+    if len(pb_sources):
+      binary.sources += pb_sources
+      binary.compiler.cxxdefines += ['PROTOBUF_ENABLE']
 
-SM.binaries += builder.Add(project)
+    if builder.target.platform == 'mac' and sdk.name in ['csgo']:
+      # We need a proxy library since the game uses libstdc++.
+      pb_binary = SM.HL2Library(builder, 'pbproxy.' + sdk.ext, sdk, arch)
+      pb_binary.sources += pb_sources
+      pb_binary.sources += ['pb_proxy.cpp']
+      pb_binary.compiler.cxxincludes += pb_includes
+
+      # Switch from libc++ to libstdc++.
+      pb_binary.compiler.cxxflags.remove('-stdlib=libc++')
+      pb_binary.compiler.linkflags.remove('-lc++')
+      pb_binary.compiler.linkflags.remove('-stdlib=libc++')
+      pb_binary.compiler.cxxflags.append('-stdlib=libstdc++')
+      pb_binary.compiler.linkflags.append('-lstdc++')
+      pb_binary.compiler.linkflags.append('-stdlib=libstdc++')
+      if '-std=c++1y' in pb_binary.compiler.cxxflags:
+        pb_binary.compiler.cxxflags.remove('-std=c++1y')
+      elif '-std=c++14' in pb_binary.compiler.cxxflags:
+        pb_binary.compiler.cxxflags.remove('-std=c++14')
+
+      if arch == 'x86':
+        pb_lib_path = os.path.join(sdk.path, 'lib', 'osx32', 'release', 'libprotobuf.a')
+      elif arch == 'x64':
+        pb_lib_path = os.path.join(sdk.path, 'lib', 'osx64', 'release', 'libprotobuf.a')
+      pb_binary.compiler.linkflags.append(pb_lib_path)
+
+      SM.binaries += [builder.Add(pb_binary)]
 
+      binary.compiler.cxxdefines += [
+          'PROTOBUF_PROXY_ENABLE',
+          'PROTOBUF_PROXY_BINARY_NAME="pbproxy.{}"'.format(sdk.ext),
+      ]
+
+SM.binaries += builder.Add(project)