BaseTools: Fix nmake failure due to command-line length limitation

NMAKE is limited to command-line length of 4096 characters. Due to the
large number of /I directives specified on command line (one per include
directory), the path length of WORKSPACE is multiplied by the number of
/I directives and can exceed the limit.
This patch:
1. Add new build option -l, --cmd-len to set the maximum command line
length, default value is 4096.
2. Generate the response file only if the command line length exceed its
maximum characters (default is 4096) when build the module. Cover
PP_FLAGS, CC_FLAGS, VFRPP_FLAGS, APP_FLAGS, ASLPP_FLAGS, ASLCC_FLAGS and
ASM_FLAGS.
3. The content of the response file is combine from the FLAGS option and
INC option.
4. When build failure, it would print out the response file's file
location and its content.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

1 files changed, 12 insertions, 0 deletions

diff --git a/BaseTools/Source/Python/build/build.py b/BaseTools/Source/Python/build/build.py
index 5619638bd8..5c1fda1a93 100644
--- a/BaseTools/Source/Python/build/build.py
+++ b/BaseTools/Source/Python/build/build.py
@@ -304,6 +304,14 @@ def LaunchCommand(Command, WorkingDir):
     if Proc.returncode != 0:

         if type(Command) != type(""):

             Command = " ".join(Command)

+        # print out the Response file and its content when make failure

+        RespFile = os.path.join(WorkingDir, 'OUTPUT', 'respfilelist.txt')

+        if os.path.isfile(RespFile):

+            f = open(RespFile)

+            RespContent = f.read()

+            f.close()

+            EdkLogger.info(RespContent)

+

         EdkLogger.error("build", COMMAND_FAILURE, ExtraData="%s [%s]" % (Command, WorkingDir))

 

 ## The smallest unit that can be built in multi-thread build mode

@@ -775,6 +783,9 @@ class Build():
         self.UniFlag        = BuildOptions.Flag

         self.BuildModules = []

 

+        if BuildOptions.CommandLength:

+            GlobalData.gCommandMaxLength = BuildOptions.CommandLength

+

         # print dot character during doing some time-consuming work

         self.Progress = Utils.Progressor()

 

@@ -1931,6 +1942,7 @@ def MyOptionParser():
     Parser.add_option("--check-usage", action="store_true", dest="CheckUsage", default=False, help="Check usage content of entries listed in INF file.")

     Parser.add_option("--ignore-sources", action="store_true", dest="IgnoreSources", default=False, help="Focus to a binary build and ignore all source files")

     Parser.add_option("--pcd", action="append", dest="OptionPcd", help="Set PCD value by command line. Format: 'PcdName=Value' ")

+    Parser.add_option("-l", "--cmd-len", action="store", type="int", dest="CommandLength", help="Specify the maximum line length of build command. Default is 4096.")

 

     (Opt, Args) = Parser.parse_args()

     return (Opt, Args)