GN: Propagate top-level host_toolchain through to all toolchains

build/config/BUILDCONFIG.gn

 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 # =============================================================================
 # PLATFORM SELECTION
 # =============================================================================
 #
 # There are two main things to set: "os" and "cpu". The "toolchain" is the name
 # of the GN thing that encodes combinations of these things.
@@ skipping 32 matching lines @@
     # If we're building for Android, we should assume that we want to
     # build for ARM by default, not the host_cpu (which is likely x64).
     # This allows us to not have to specify both target_os and target_cpu
     # on the command line.
     target_cpu = "arm"
   } else {
     target_cpu = host_cpu
   }
 }
 
+# The current_cpu and current_os variables are empty on the first
+# run through this file.  When this file is evaluated again in a
+# specific toolchain context, the toolchain_args() block will have
+# set these explicitly.  So them being empty is the best available
+# proxy for a "is this the first time through" predicate.
+buildconfig_in_default_toolchain = current_cpu == "" && current_os == ""

[brettw, 2015/12/01 22:08:19]

I'm not super fond of this hack and I'd prefer to avoid this type of thing. I
don't actually think it will be a big problem.

 I have some ideas of how toolchain setup can be improved. If forgetting the
host toolchain ends up being a problem in practice, we can implement that for a
precise way to tell this.

[Roland McGrath, 2015/12/01 22:12:18]

My concern is that when it goes wrong the failure modes are likely to be quite
subtle.  I'd really like to have something to ensure that the host_toolchain
calculation is never carried out a second time inside a toolchain context.  If
there is nothing reliable we can do now but there will be something eventually,
then I'm fine with just replacing the assert with a TODO.  But I'm not at all
sanguine about just dropping the assert and hand-waving that it won't bite us in
the future.

+
 if (current_cpu == "") {
   current_cpu = target_cpu
 }
 if (current_os == "") {
   current_os = target_os
 }
 
 # =============================================================================
 # BUILD FLAGS
 # =============================================================================
@@ skipping 59 matching lines @@
 
   # Set to true when compiling with the Clang compiler. Typically this is used
   # to configure warnings.
   is_clang = current_os == "mac" || current_os == "ios" ||
              current_os == "linux" || current_os == "chromeos"
 
   # Allows the path to a custom target toolchain to be injected as a single
   # argument, and set as the default toolchain.
   custom_toolchain = ""
 
+  # This should not normally be set as a build argument.  It's here so that
+  # every toolchain can pass through the "global" value via toolchain_args().
+  host_toolchain = ""
+
   # DON'T ADD MORE FLAGS HERE. Read the comment above.
 }
 
 # ==============================================================================
 # TOOLCHAIN SETUP
 # ==============================================================================
 #
 # Here we set the default toolchain, as well as the variable host_toolchain
 # which will identify the toolchain corresponding to the local system when
 # doing cross-compiles. When not cross-compiling, this will be the same as the
 # default toolchain.
 #
 # We do this before anything else to make sure we complain about any
 # unsupported os/cpu combinations as early as possible.
 
-if (host_os == "linux") {
-  if (target_os != "linux") {
-    # TODO(dpranke) - is_clang normally applies only to the target
-    # build, and there is no way to indicate that you want to override
-    # it for both the target build *and* the host build. Do we need to
-    # support this?
-    host_toolchain = "//build/toolchain/linux:clang_$host_cpu"
-  } else if (is_clang) {
-    host_toolchain = "//build/toolchain/linux:clang_$host_cpu"
+if (host_toolchain == "") {
+  # This should only happen in the top-level context.
+  # In a specific toolchain context, the toolchain_args()
+  # block should have propagated a value down.
+  assert(buildconfig_in_default_toolchain,
+         "All toolchains must plumb through host_toolchain in toolchain_args()")
+
+  if (host_os == "linux") {
+    if (is_clang) {
+      host_toolchain = "//build/toolchain/linux:clang_$host_cpu"
+    } else {
+      host_toolchain = "//build/toolchain/linux:$host_cpu"
+    }
+  } else if (host_os == "mac") {
+    host_toolchain = "//build/toolchain/mac:clang_$host_cpu"
+  } else if (host_os == "win") {
+    # TODO(crbug.com/467159): win cross-compiles don't actually work yet, so
+    # use the target_cpu instead of the host_cpu.
+    if (is_clang) {
+      host_toolchain = "//build/toolchain/win:clang_$target_cpu"
+    } else {
+      host_toolchain = "//build/toolchain/win:$target_cpu"
+    }
   } else {
-    host_toolchain = "//build/toolchain/linux:$host_cpu"
+    assert(false, "Unsupported host_os: $host_os")
   }
-} else if (host_os == "mac") {
-  host_toolchain = "//build/toolchain/mac:clang_$host_cpu"
-} else if (host_os == "win") {
-  # TODO(crbug.com/467159): win cross-compiles don't actually work yet, so
-  # use the target_cpu instead of the host_cpu.
-  if (is_clang) {
-    host_toolchain = "//build/toolchain/win:clang_$target_cpu"
-  } else {
-    host_toolchain = "//build/toolchain/win:$target_cpu"
-  }
-} else {
-  assert(false, "Unsupported host_os: $host_os")
 }
 
 _default_toolchain = ""
 
 if (target_os == "android") {
   assert(host_os == "linux" || host_os == "mac",
          "Android builds are only supported on Linux and Mac hosts.")
   if (is_clang) {
     _default_toolchain = "//build/toolchain/android:clang_$target_cpu"
   } else {
@@ skipping 12 matching lines @@
 } else if (target_os == "linux") {
   if (is_clang) {
     _default_toolchain = "//build/toolchain/linux:clang_$target_cpu"
   } else {
     _default_toolchain = "//build/toolchain/linux:$target_cpu"
   }
 } else if (target_os == "mac") {
   assert(host_os == "mac", "Mac cross-compiles are unsupported.")
   _default_toolchain = host_toolchain
 } else if (target_os == "win") {
-  # On windows we use the same toolchain for host and target by default.
+  # On Windows we use the same toolchain for host and target by default.
   assert(target_os == host_os, "Win cross-compiles only work on win hosts.")
   if (is_clang) {
     _default_toolchain = "//build/toolchain/win:clang_$target_cpu"
   } else {
     _default_toolchain = "//build/toolchain/win:$target_cpu"
   }
 } else if (target_os == "winrt_81" || target_os == "winrt_81_phone" ||
            target_os == "winrt_10") {
   _default_toolchain = "//build/toolchain/win:winrt_$target_cpu"
 } else {
@@ skipping 367 matching lines @@
     forward_variables_from(invoker, "*")
 
     # All shared libraries must have the sanitizer deps to properly link in
     # asan mode (this target will be empty in other cases).
     if (!defined(deps)) {
       deps = []
     }
     deps += [ "//build/config/sanitizers:deps" ]
   }
 }