CXX-123 force inits at link w/ static archive

force inclusion of translation units with MONGO_INITIAILIZERS when
linking with the static archive by adding magic symbols into relevant
cpp files that are referenced from base/initializer.cpp

This prevents unreferenced initiailizers from getting dropped, which
obviously screws up behavior

Author: hanumantmk

README.md

@@ -9,8 +9,8 @@ the server sources: this repo is the only approved source for driver builds.
 
 ## Components
 
-  libmongoclient.[so|dylib|dll] - The shared mongoclient library
-  libmongoclient.a - The static mongoclient library (but see notes)
+  libmongoclient.[so|dylib|dll] - The shared mongoclient library (but see notes)
+  libmongoclient.a - The static mongoclient library
 
 ## Building
 
@@ -21,11 +21,11 @@ the server sources: this repo is the only approved source for driver builds.
 
 ## Notes
 
-  Use of the static library is discouraged, and support may be removed soon. To properly
-  link against the static library on ELF platforms, you must link it with the
-  --whole-archive flag to ld. The static library is not useable on Windows since
-  there is no analogue to --whole-archive. The static library may work on OS X, but
-  we still strongly recommend using the dynamic library.
+  Use of the shared library is experimental on windows and is currently
+  discouraged.  This is primarily due to the complexity of ensuring a matching
+  implementation of STL types between library and consumer code.  This problem
+  is unique to windows, as the consistent use of system libraries largely
+  mitigates this danger.
 
 ## Documentation
 

SConstruct

@@ -1410,6 +1410,10 @@ def doConfigure(myenv):
         conf.FindSysLibDep( "v8", v8_lib_choices )
 
     conf.env['MONGO_BUILD_SASL_CLIENT'] = bool(has_option("use-sasl-client"))
+
+    if conf.env['MONGO_BUILD_SASL_CLIENT']:
+        env.Append( CPPDEFINES=["MONGO_SASL"] )
+
     if conf.env['MONGO_BUILD_SASL_CLIENT'] and not conf.CheckLibWithHeader(
             "sasl2", 
             ["stddef.h","sasl/sasl.h"], 

src/mongo/base/init.cpp

@@ -16,3 +16,5 @@
 #include "mongo/base/init.h"
 
 MONGO_INITIALIZER_GROUP(default, MONGO_NO_PREREQUISITES, MONGO_NO_DEPENDENTS)
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(base_init)

src/mongo/base/init.h

@@ -130,3 +130,6 @@
  * named "NAME".
  */
 #define _MONGO_INITIALIZER_FUNCTION_NAME(NAME) _mongoInitializerFunction_##NAME
+
+#define MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(NAME) \
+    namespace mongo { void _mongoInitializerFunctionAssure_##NAME() {} }

src/mongo/base/initializer.cpp

@@ -24,6 +24,29 @@ namespace mongo {
     Initializer::Initializer() {}
     Initializer::~Initializer() {}
 
+/* This array of function pointers is necessary to force inclusion of
+ * translation units with global initializers when linking against a static
+ * archive version of the client.  In their absence, the related code may
+ * resolve no symbols in a potential output binary, failing to pull in the
+ * initializers and leaving the client in a broken state.
+ *
+ * Working around this with --whole-archive or an equivalent is painful where
+ * possible and renders the static archive useless where not possible (on
+ * windows).
+ *
+ * Sorry for the hack...
+ */
+#define INSTALL_FUNCTION(NAME) void _mongoInitializerFunctionAssure_##NAME();
+#include "mongo/base/initializer_functions.h"
+#undef INSTALL_FUNCTION
+
+    void (* _mongoGlobalInitializers [])() = {
+#define INSTALL_FUNCTION(NAME) &(_mongoInitializerFunctionAssure_##NAME),
+#include "mongo/base/initializer_functions.h"
+#undef INSTALL_FUNCTION
+    NULL
+    };
+
     Status Initializer::execute(const InitializerContext::ArgumentVector& args,
                                 const InitializerContext::EnvironmentMap& env) const {
 

src/mongo/base/initializer_functions.h

@@ -0,0 +1,13 @@
+INSTALL_FUNCTION(base_init) // "default"
+INSTALL_FUNCTION(platform_backtrace) // "SolarisBacktrace"
+INSTALL_FUNCTION(logger_logstream_builder) // "LogstreamBuilder"
+INSTALL_FUNCTION(logger_ramlog) // "RamLogCatalog"
+INSTALL_FUNCTION(logger_logger) // "GlobalLogManager"
+#ifdef MONGO_SASL
+INSTALL_FUNCTION(client_sasl_client_authenticate_impl) // "SaslClientAuthenticateFunction"
+INSTALL_FUNCTION(client_sasl_client_session) // "CyrusSaslAllocatorsAndMutexes,SaslClientContext"
+INSTALL_FUNCTION(client_sasl_sspi) // "SaslSspiClientPlugin,SaslCramClientPlugin,SaslPlainClientPlugin"
+#endif
+INSTALL_FUNCTION(util_fail_point_service) // "FailPointRegistry,AllFailPointsRegistered"
+INSTALL_FUNCTION(util_net_socket_poll) // "DynamicLinkWin32Poll"
+INSTALL_FUNCTION(util_net_ssl_manager) // "SSLManager"

src/mongo/client/sasl_client_authenticate_impl.cpp

@@ -251,3 +251,5 @@ namespace {
 
 }  // namespace
 }  // namespace mongo
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(client_sasl_client_authenticate_impl)

src/mongo/client/sasl_client_session.cpp

@@ -317,3 +317,5 @@ namespace {
     }
 
 }  // namespace mongo
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(client_sasl_client_session)

src/mongo/client/sasl_sspi.cpp

@@ -14,6 +14,8 @@
  *    limitations under the License.
  */
 
+#include "mongo/base/init.h"
+
 #ifdef _WIN32
 
 #define SECURITY_WIN32 1 // Required for SSPI support.
@@ -25,7 +27,6 @@
 #include <sasl/saslplug.h>
 #include <sspi.h>
 
-#include "mongo/base/init.h"
 #include "mongo/util/mongoutils/str.h"
 #include "mongo/base/status.h"
 #include "mongo/util/scopeguard.h"
@@ -527,3 +528,5 @@ namespace {
 } // namespace mongo
 
 #endif // ifdef _WIN32
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(client_sasl_sspi)

src/mongo/logger/logger.cpp

@@ -52,3 +52,5 @@ namespace logger {
 
 }  // namespace logger
 }  // namespace mongo
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(logger_logger)

src/mongo/logger/logstream_builder.cpp

@@ -132,3 +132,5 @@ namespace logger {
 
 }  // namespace logger
 }  // namespace mongo
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(logger_logstream_builder)

src/mongo/logger/ramlog.cpp

@@ -245,3 +245,5 @@ namespace {
         return Status::OK();
     }
 }
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(logger_ramlog)

src/mongo/platform/backtrace.cpp

@@ -13,6 +13,8 @@
  *    limitations under the License.
  */
 
+#include "mongo/base/init.h"
+
 #if !defined(_WIN32)
 #if defined(__sunos__) || !defined(MONGO_HAVE_EXECINFO_BACKTRACE)
 
@@ -25,7 +27,6 @@
 #include <ucontext.h>
 #include <vector>
 
-#include "mongo/base/init.h"
 #include "mongo/base/status.h"
 
 using std::string;
@@ -213,3 +214,5 @@ namespace {
 
 #endif // #if defined(__sunos__)
 #endif // #if !defined(_WIN32)
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(platform_backtrace)

src/mongo/util/fail_point_service.cpp

@@ -36,3 +36,5 @@ namespace mongo {
         return _fpRegistry.get();
     }
 }
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(util_fail_point_service)

src/mongo/util/net/socket_poll.cpp

@@ -60,3 +60,4 @@ namespace mongo {
 
 
 
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(util_net_socket_poll)

src/mongo/util/net/ssl_manager.cpp

@@ -930,3 +930,5 @@ namespace mongo {
     }
 #endif // #ifdef MONGO_SSL
 }
+
+MONGO_INITIALIZER_FUNCTION_ASSURE_FILE(util_net_ssl_manager)