scons: Pull info.py generation out of SConscript and into build_tools.

Change-Id: I36e21901741a61673198011ce3889982e19f37f4
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/49404
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Gabe Black <gabe.black@gmail.com>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>

build_tools/infopy.py

@@ -0,0 +1,59 @@
+# Copyright (c) 2018, 2020 ARM Limited
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# Copyright (c) 2004-2005 The Regents of The University of Michigan
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import argparse
+import os.path
+import sys
+
+from code_formatter import code_formatter
+
+parser = argparse.ArgumentParser()
+parser.add_argument('info_py', help='info.py file path')
+parser.add_argument('files', help='file to include in info.py', nargs='*')
+
+args = parser.parse_args()
+
+# Generate python file containing info about the gem5 source code.
+code = code_formatter()
+
+for source in args.files:
+    src = os.path.basename(source)
+    with open(source, 'r') as f:
+        data = ''.join(f)
+    code('${src} = ${{repr(data)}}')
+
+code.write(args.info_py)

src/SConscript

@@ -633,19 +633,14 @@ env.Command('python/m5/defines.py', ToValue(dict(build_env)),
             MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
 PySource('m5', 'python/m5/defines.py')
 
-# Generate python file containing info about the M5 source code
-def makeInfoPyFile(target, source, env):
-    code = code_formatter()
-    for src in source:
-        with open(src.srcnode().abspath, 'r') as f:
-            data = ''.join(f)
-        code('$src = ${{repr(data)}}')
-    code.write(str(target[0]))
-
 # Generate a file that wraps the basic top level files
-env.Command('python/m5/info.py',
-            [ '#/COPYING', '#/LICENSE', '#/README', ],
-            MakeAction(makeInfoPyFile, Transform("INFO")))
+gem5py_env.Command('python/m5/info.py',
+            [ File('#/COPYING'), File('#/LICENSE'), File('#/README'),
+                "${GEM5PY}", "${INFOPY_PY}" ],
+            MakeAction('"${GEM5PY}" "${INFOPY_PY}" "${TARGET}" '
+                       '${SOURCES[:-2]}',
+                Transform("INFO", 3)),
+            INFOPY_PY=build_tools.File('infopy.py'))
 PySource('m5', 'python/m5/info.py')
 
 ########################################################################