UniversalPayloadBuild.py 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. ## @file
  2. # This file contains the script to build UniversalPayload
  3. #
  4. # Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
  5. # SPDX-License-Identifier: BSD-2-Clause-Patent
  6. ##
  7. import argparse
  8. import subprocess
  9. import os
  10. import shutil
  11. import sys
  12. from ctypes import *
  13. sys.dont_write_bytecode = True
  14. class UPLD_INFO_HEADER(LittleEndianStructure):
  15. _pack_ = 1
  16. _fields_ = [
  17. ('Identifier', ARRAY(c_char, 4)),
  18. ('HeaderLength', c_uint32),
  19. ('SpecRevision', c_uint16),
  20. ('Reserved', c_uint16),
  21. ('Revision', c_uint32),
  22. ('Attribute', c_uint32),
  23. ('Capability', c_uint32),
  24. ('ProducerId', ARRAY(c_char, 16)),
  25. ('ImageId', ARRAY(c_char, 16)),
  26. ]
  27. def __init__(self):
  28. self.Identifier = b'PLDH'
  29. self.HeaderLength = sizeof(UPLD_INFO_HEADER)
  30. self.SpecRevision = 0x0009
  31. self.Revision = 0x0000010105
  32. self.ImageId = b'UEFI'
  33. self.ProducerId = b'INTEL'
  34. def RunCommand(cmd):
  35. print(cmd)
  36. p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,cwd=os.environ['WORKSPACE'])
  37. while True:
  38. line = p.stdout.readline()
  39. if not line:
  40. break
  41. print(line.strip().decode(errors='ignore'))
  42. p.communicate()
  43. if p.returncode != 0:
  44. print("- Failed - error happened when run command: %s"%cmd)
  45. raise Exception("ERROR: when run command: %s"%cmd)
  46. def BuildUniversalPayload(Args, MacroList):
  47. BuildTarget = Args.Target
  48. ToolChain = Args.ToolChain
  49. Quiet = "--quiet" if Args.Quiet else ""
  50. ElfToolChain = 'CLANGDWARF'
  51. BuildDir = os.path.join(os.environ['WORKSPACE'], os.path.normpath("Build/UefiPayloadPkgX64"))
  52. if Args.Arch == 'X64':
  53. BuildArch = "X64"
  54. ObjCopyFlag = "elf64-x86-64"
  55. EntryOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ElfToolChain), os.path.normpath("X64/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))
  56. else:
  57. BuildArch = "IA32 -a X64"
  58. ObjCopyFlag = "elf32-i386"
  59. EntryOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ElfToolChain), os.path.normpath("IA32/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))
  60. EntryModuleInf = os.path.normpath("UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.inf")
  61. DscPath = os.path.normpath("UefiPayloadPkg/UefiPayloadPkg.dsc")
  62. FvOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ToolChain), os.path.normpath("FV/DXEFV.Fv"))
  63. PayloadReportPath = os.path.join(BuildDir, "UefiUniversalPayload.txt")
  64. ModuleReportPath = os.path.join(BuildDir, "UefiUniversalPayloadEntry.txt")
  65. UpldInfoFile = os.path.join(BuildDir, "UniversalPayloadInfo.bin")
  66. if "CLANG_BIN" in os.environ:
  67. LlvmObjcopyPath = os.path.join(os.environ["CLANG_BIN"], "llvm-objcopy")
  68. else:
  69. LlvmObjcopyPath = "llvm-objcopy"
  70. try:
  71. RunCommand('"%s" --version'%LlvmObjcopyPath)
  72. except:
  73. print("- Failed - Please check if LLVM is installed or if CLANG_BIN is set correctly")
  74. sys.exit(1)
  75. Pcds = ""
  76. if (Args.pcd != None):
  77. for PcdItem in Args.pcd:
  78. Pcds += " --pcd {}".format (PcdItem)
  79. Defines = ""
  80. for key in MacroList:
  81. Defines +=" -D {0}={1}".format(key, MacroList[key])
  82. #
  83. # Building DXE core and DXE drivers as DXEFV.
  84. #
  85. BuildPayload = "build -p {} -b {} -a X64 -t {} -y {} {}".format (DscPath, BuildTarget, ToolChain, PayloadReportPath, Quiet)
  86. BuildPayload += Pcds
  87. BuildPayload += Defines
  88. RunCommand(BuildPayload)
  89. #
  90. # Building Universal Payload entry.
  91. #
  92. BuildModule = "build -p {} -b {} -a {} -m {} -t {} -y {} {}".format (DscPath, BuildTarget, BuildArch, EntryModuleInf, ElfToolChain, ModuleReportPath, Quiet)
  93. BuildModule += Pcds
  94. BuildModule += Defines
  95. RunCommand(BuildModule)
  96. #
  97. # Buid Universal Payload Information Section ".upld_info"
  98. #
  99. upld_info_hdr = UPLD_INFO_HEADER()
  100. upld_info_hdr.ImageId = Args.ImageId.encode()[:16]
  101. upld_info_hdr.Attribute |= 1 if BuildTarget == "DEBUG" else 0
  102. fp = open(UpldInfoFile, 'wb')
  103. fp.write(bytearray(upld_info_hdr))
  104. fp.close()
  105. #
  106. # Copy the DXEFV as a section in elf format Universal Payload entry.
  107. #
  108. remove_section = '"{}" -I {} -O {} --remove-section .upld_info --remove-section .upld.uefi_fv {}'.format (
  109. LlvmObjcopyPath,
  110. ObjCopyFlag,
  111. ObjCopyFlag,
  112. EntryOutputDir
  113. )
  114. add_section = '"{}" -I {} -O {} --add-section .upld_info={} --add-section .upld.uefi_fv={} {}'.format (
  115. LlvmObjcopyPath,
  116. ObjCopyFlag,
  117. ObjCopyFlag,
  118. UpldInfoFile,
  119. FvOutputDir,
  120. EntryOutputDir
  121. )
  122. set_section = '"{}" -I {} -O {} --set-section-alignment .upld_info=4 --set-section-alignment .upld.uefi_fv=16 {}'.format (
  123. LlvmObjcopyPath,
  124. ObjCopyFlag,
  125. ObjCopyFlag,
  126. EntryOutputDir
  127. )
  128. RunCommand(remove_section)
  129. RunCommand(add_section)
  130. RunCommand(set_section)
  131. shutil.copy (EntryOutputDir, os.path.join(BuildDir, 'UniversalPayload.elf'))
  132. def main():
  133. parser = argparse.ArgumentParser(description='For building Universal Payload')
  134. parser.add_argument('-t', '--ToolChain')
  135. parser.add_argument('-b', '--Target', default='DEBUG')
  136. parser.add_argument('-a', '--Arch', choices=['IA32', 'X64'], help='Specify the ARCH for payload entry module. Default build X64 image.', default ='X64')
  137. parser.add_argument("-D", "--Macro", action="append", default=["UNIVERSAL_PAYLOAD=TRUE"])
  138. parser.add_argument('-i', '--ImageId', type=str, help='Specify payload ID (16 bytes maximal).', default ='UEFI')
  139. parser.add_argument('-q', '--Quiet', action='store_true', help='Disable all build messages except FATAL ERRORS.')
  140. parser.add_argument("-p", "--pcd", action="append")
  141. MacroList = {}
  142. args = parser.parse_args()
  143. if args.Macro is not None:
  144. for Argument in args.Macro:
  145. if Argument.count('=') != 1:
  146. print("Unknown variable passed in: %s"%Argument)
  147. raise Exception("ERROR: Unknown variable passed in: %s"%Argument)
  148. tokens = Argument.strip().split('=')
  149. MacroList[tokens[0].upper()] = tokens[1]
  150. BuildUniversalPayload(args, MacroList)
  151. print ("Successfully build Universal Payload")
  152. if __name__ == '__main__':
  153. main()