UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py

## @file\r
# Generate AutoGen.h, AutoGen.c and *.depex files\r
#\r
# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>\r
# Copyright (c) 2018, Hewlett Packard Enterprise Development, L.P.<BR>\r
# Copyright (c) 2019, American Megatrends, Inc. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
## Import Modules\r
#\r
from __future__ import print_function\r
from __future__ import absolute_import\r
from Common.DataType import TAB_STAR\r
## Base class for AutoGen\r
#\r
#   This class just implements the cache mechanism of AutoGen objects.\r
#\r
class AutoGen(object):\r
    # database to maintain the objects in each child class\r
    __ObjectCache = {}    # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object\r
\r
    ## Factory method\r
    #\r
    #   @param  Class           class object of real AutoGen class\r
    #                           (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)\r
    #   @param  Workspace       Workspace directory or WorkspaceAutoGen object\r
    #   @param  MetaFile        The path of meta file\r
    #   @param  Target          Build target\r
    #   @param  Toolchain       Tool chain name\r
    #   @param  Arch            Target arch\r
    #   @param  *args           The specific class related parameters\r
    #   @param  **kwargs        The specific class related dict parameters\r
    #\r
\r
    def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
        # check if the object has been created\r
        Key = (Target, Toolchain, Arch, MetaFile)\r
        if Key in cls.__ObjectCache:\r
            # if it exists, just return it directly\r
            return cls.__ObjectCache[Key]\r
            # it didnt exist. create it, cache it, then return it\r
        RetVal = cls.__ObjectCache[Key] = super(AutoGen, cls).__new__(cls)\r
        return RetVal\r
\r
\r
    ## hash() operator\r
    #\r
    #  The file path of platform file will be used to represent hash value of this object\r
    #\r
    #   @retval int     Hash value of the file path of platform file\r
    #\r
    def __hash__(self):\r
        return hash(self.MetaFile)\r
\r
    ## str() operator\r
    #\r
    #  The file path of platform file will be used to represent this object\r
    #\r
    #   @retval string  String of platform file path\r
    #\r
    def __str__(self):\r
        return str(self.MetaFile)\r
\r
    ## "==" operator\r
    def __eq__(self, Other):\r
        return Other and self.MetaFile == Other\r
\r
    @classmethod\r
    def Cache(cls):\r
        return cls.__ObjectCache\r
\r
#\r
# The priority list while override build option\r
#\r
PrioList = {"0x11111"  : 16,     #  TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)\r
            "0x01111"  : 15,     #  ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
            "0x10111"  : 14,     #  TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
            "0x00111"  : 13,     #  ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
            "0x11011"  : 12,     #  TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
            "0x01011"  : 11,     #  ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
            "0x10011"  : 10,     #  TARGET_*********_****_COMMANDTYPE_ATTRIBUTE\r
            "0x00011"  : 9,      #  ******_*********_****_COMMANDTYPE_ATTRIBUTE\r
            "0x11101"  : 8,      #  TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
            "0x01101"  : 7,      #  ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
            "0x10101"  : 6,      #  TARGET_*********_ARCH_***********_ATTRIBUTE\r
            "0x00101"  : 5,      #  ******_*********_ARCH_***********_ATTRIBUTE\r
            "0x11001"  : 4,      #  TARGET_TOOLCHAIN_****_***********_ATTRIBUTE\r
            "0x01001"  : 3,      #  ******_TOOLCHAIN_****_***********_ATTRIBUTE\r
            "0x10001"  : 2,      #  TARGET_*********_****_***********_ATTRIBUTE\r
            "0x00001"  : 1}      #  ******_*********_****_***********_ATTRIBUTE (Lowest)\r
## Calculate the priority value of the build option\r
#\r
# @param    Key    Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
#\r
# @retval   Value  Priority value based on the priority list.\r
#\r
def CalculatePriorityValue(Key):\r
    Target, ToolChain, Arch, CommandType, Attr = Key.split('_')\r
    PriorityValue = 0x11111\r
    if Target == TAB_STAR:\r
        PriorityValue &= 0x01111\r
    if ToolChain == TAB_STAR:\r
        PriorityValue &= 0x10111\r
    if Arch == TAB_STAR:\r
        PriorityValue &= 0x11011\r
    if CommandType == TAB_STAR:\r
        PriorityValue &= 0x11101\r
    if Attr == TAB_STAR:\r
        PriorityValue &= 0x11110\r
\r
    return PrioList["0x%0.5x" % PriorityValue]\r