UefiPayloadPkg/UniversalPayloadBuild.py

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