[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FfsFileStatement.py

## @file\r
# process FFS generation from FILE statement\r
#\r
#  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
##\r
# Import Modules\r
#\r
from __future__ import absolute_import\r
from io import BytesIO\r
from struct import pack\r
from CommonDataClass.FdfClass import FileStatementClassObject\r
from Common import EdkLogger\r
from Common.BuildToolError import GENFDS_ERROR\r
from Common.Misc import GuidStructureByteArrayToGuidString, SaveFileOnChange\r
import Common.LongFilePathOs as os\r
from .GuidSection import GuidSection\r
from .FvImageSection import FvImageSection\r
from .Ffs import FdfFvFileTypeToFileType\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
\r
## generate FFS from FILE\r
#\r
#\r
class FileStatement (FileStatementClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FileStatementClassObject.__init__(self)\r
        self.CurrentLineNum = None\r
        self.CurrentLineContent = None\r
        self.FileName = None\r
        self.InfFileName = None\r
        self.SubAlignment = None\r
\r
    ## GenFfs() method\r
    #\r
    #   Generate FFS\r
    #\r
    #   @param  self         The object pointer\r
    #   @param  Dict         dictionary contains macro and value pair\r
    #   @param  FvChildAddr  Array of the inside FvImage base address\r
    #   @param  FvParentAddr Parent Fv base address\r
    #   @retval string       Generated FFS file name\r
    #\r
    def GenFfs(self, Dict = None, FvChildAddr=[], FvParentAddr=None, IsMakefile=False, FvName=None):\r
\r
        if self.NameGuid and self.NameGuid.startswith('PCD('):\r
            PcdValue = GenFdsGlobalVariable.GetPcdValue(self.NameGuid)\r
            if len(PcdValue) == 0:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, '%s NOT defined.' \\r
                            % (self.NameGuid))\r
            if PcdValue.startswith('{'):\r
                PcdValue = GuidStructureByteArrayToGuidString(PcdValue)\r
            RegistryGuidStr = PcdValue\r
            if len(RegistryGuidStr) == 0:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, 'GUID value for %s in wrong format.' \\r
                            % (self.NameGuid))\r
            self.NameGuid = RegistryGuidStr\r
\r
        Str = self.NameGuid\r
        if FvName:\r
            Str += FvName\r
        OutputDir = os.path.join(GenFdsGlobalVariable.FfsDir, Str)\r
        if not os.path.exists(OutputDir):\r
            os.makedirs(OutputDir)\r
\r
        if Dict is None:\r
            Dict = {}\r
\r
        Dict.update(self.DefineVarDict)\r
        SectionAlignments = None\r
        if self.FvName:\r
            Buffer = BytesIO()\r
            if self.FvName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FvDict:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (self.FvName))\r
            Fv = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName.upper())\r
            FileName = Fv.AddToBuffer(Buffer)\r
            SectionFiles = [FileName]\r
\r
        elif self.FdName:\r
            if self.FdName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FdDict:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, "FD (%s) is NOT described in FDF file!" % (self.FdName))\r
            Fd = GenFdsGlobalVariable.FdfParser.Profile.FdDict.get(self.FdName.upper())\r
            FileName = Fd.GenFd()\r
            SectionFiles = [FileName]\r
\r
        elif self.FileName:\r
            if hasattr(self, 'FvFileType') and self.FvFileType == 'RAW':\r
                if isinstance(self.FileName, list) and isinstance(self.SubAlignment, list) and len(self.FileName) == len(self.SubAlignment):\r
                    FileContent = BytesIO()\r
                    MaxAlignIndex = 0\r
                    MaxAlignValue = 1\r
                    for Index, File in enumerate(self.FileName):\r
                        try:\r
                            f = open(File, 'rb')\r
                        except:\r
                            GenFdsGlobalVariable.ErrorLogger("Error opening RAW file %s." % (File))\r
                        Content = f.read()\r
                        f.close()\r
                        AlignValue = 1\r
                        if self.SubAlignment[Index]:\r
                            AlignValue = GenFdsGlobalVariable.GetAlignment(self.SubAlignment[Index])\r
                        if AlignValue > MaxAlignValue:\r
                            MaxAlignIndex = Index\r
                            MaxAlignValue = AlignValue\r
                        FileContent.write(Content)\r
                        if len(FileContent.getvalue()) % AlignValue != 0:\r
                            Size = AlignValue - len(FileContent.getvalue()) % AlignValue\r
                            for i in range(0, Size):\r
                                FileContent.write(pack('B', 0xFF))\r
\r
                    if FileContent.getvalue() != b'':\r
                        OutputRAWFile = os.path.join(GenFdsGlobalVariable.FfsDir, self.NameGuid, self.NameGuid + '.raw')\r
                        SaveFileOnChange(OutputRAWFile, FileContent.getvalue(), True)\r
                        self.FileName = OutputRAWFile\r
                        self.SubAlignment = self.SubAlignment[MaxAlignIndex]\r
\r
                if self.Alignment and self.SubAlignment:\r
                    if GenFdsGlobalVariable.GetAlignment (self.Alignment) < GenFdsGlobalVariable.GetAlignment (self.SubAlignment):\r
                        self.Alignment = self.SubAlignment\r
                elif self.SubAlignment:\r
                    self.Alignment = self.SubAlignment\r
\r
            self.FileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
            #Replace $(SAPCE) with real space\r
            self.FileName = self.FileName.replace('$(SPACE)', ' ')\r
            SectionFiles = [GenFdsGlobalVariable.MacroExtend(self.FileName, Dict)]\r
\r
        else:\r
            SectionFiles = []\r
            Index = 0\r
            SectionAlignments = []\r
            for section in self.SectionList:\r
                Index = Index + 1\r
                SecIndex = '%d' %Index\r
                # process the inside FvImage from FvSection or GuidSection\r
                if FvChildAddr != []:\r
                    if isinstance(section, FvImageSection):\r
                        section.FvAddr = FvChildAddr.pop(0)\r
                    elif isinstance(section, GuidSection):\r
                        section.FvAddr = FvChildAddr\r
                if FvParentAddr and isinstance(section, GuidSection):\r
                    section.FvParentAddr = FvParentAddr\r
\r
                if self.KeepReloc == False:\r
                    section.KeepReloc = False\r
                sectList, align = section.GenSection(OutputDir, self.NameGuid, SecIndex, self.KeyStringList, None, Dict)\r
                if sectList != []:\r
                    for sect in sectList:\r
                        SectionFiles.append(sect)\r
                        SectionAlignments.append(align)\r
\r
        #\r
        # Prepare the parameter\r
        #\r
        FfsFileOutput = os.path.join(OutputDir, self.NameGuid + '.ffs')\r
        GenFdsGlobalVariable.GenerateFfs(FfsFileOutput, SectionFiles,\r
                                         FdfFvFileTypeToFileType.get(self.FvFileType),\r
                                         self.NameGuid,\r
                                         Fixed=self.Fixed,\r
                                         CheckSum=self.CheckSum,\r
                                         Align=self.Alignment,\r
                                         SectionAlign=SectionAlignments\r
                                        )\r
\r
        return FfsFileOutput\r
Commit	Line	Data
30fdf114 LG	1	## @file\r
	2	# process FFS generation from FILE statement\r
	3	#\r
9eb87141	4	# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
30fdf114	5	#\r
2e351cbe	6	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
30fdf114 LG	7	#\r
	8	\r
	9	##\r
	10	# Import Modules\r
	11	#\r
1ccc4d89	12	from __future__ import absolute_import\r
86379ac4	13	from io import BytesIO\r
9e47e6f9	14	from struct import pack\r
30fdf114 LG	15	from CommonDataClass.FdfClass import FileStatementClassObject\r
30fdf114 LG	16	from Common import EdkLogger\r
9e47e6f9 CJ	17	from Common.BuildToolError import GENFDS_ERROR\r
	18	from Common.Misc import GuidStructureByteArrayToGuidString, SaveFileOnChange\r
	19	import Common.LongFilePathOs as os\r
bfa65b61 GL	20	from .GuidSection import GuidSection\r
bfa65b61 GL	21	from .FvImageSection import FvImageSection\r
9e47e6f9 CJ	22	from .Ffs import FdfFvFileTypeToFileType\r
9e47e6f9 CJ	23	from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
30fdf114 LG	24	\r
	25	## generate FFS from FILE\r
	26	#\r
	27	#\r
9e47e6f9	28	class FileStatement (FileStatementClassObject):\r
30fdf114 LG	29	## The constructor\r
	30	#\r
	31	# @param self The object pointer\r
	32	#\r
	33	def __init__(self):\r
	34	FileStatementClassObject.__init__(self)\r
79b74a03 LG	35	self.CurrentLineNum = None\r
	36	self.CurrentLineContent = None\r
	37	self.FileName = None\r
	38	self.InfFileName = None\r
cfaaf99b	39	self.SubAlignment = None\r
30fdf114 LG	40	\r
	41	## GenFfs() method\r
	42	#\r
	43	# Generate FFS\r
	44	#\r
52302d4d LG	45	# @param self The object pointer\r
	46	# @param Dict dictionary contains macro and value pair\r
	47	# @param FvChildAddr Array of the inside FvImage base address\r
	48	# @param FvParentAddr Parent Fv base address\r
	49	# @retval string Generated FFS file name\r
30fdf114	50	#\r
e32f7bc9	51	def GenFfs(self, Dict = None, FvChildAddr=[], FvParentAddr=None, IsMakefile=False, FvName=None):\r
f7496d71	52	\r
9e47e6f9	53	if self.NameGuid and self.NameGuid.startswith('PCD('):\r
30fdf114 LG	54	PcdValue = GenFdsGlobalVariable.GetPcdValue(self.NameGuid)\r
	55	if len(PcdValue) == 0:\r
	56	EdkLogger.error("GenFds", GENFDS_ERROR, '%s NOT defined.' \\r
	57	% (self.NameGuid))\r
	58	if PcdValue.startswith('{'):\r
	59	PcdValue = GuidStructureByteArrayToGuidString(PcdValue)\r
	60	RegistryGuidStr = PcdValue\r
	61	if len(RegistryGuidStr) == 0:\r
	62	EdkLogger.error("GenFds", GENFDS_ERROR, 'GUID value for %s in wrong format.' \\r
	63	% (self.NameGuid))\r
	64	self.NameGuid = RegistryGuidStr\r
f7496d71	65	\r
a743986d YZ	66	Str = self.NameGuid\r
	67	if FvName:\r
	68	Str += FvName\r
	69	OutputDir = os.path.join(GenFdsGlobalVariable.FfsDir, Str)\r
30fdf114	70	if not os.path.exists(OutputDir):\r
0d2711a6	71	os.makedirs(OutputDir)\r
30fdf114	72	\r
e32f7bc9 FZ	73	if Dict is None:\r
	74	Dict = {}\r
	75	\r
30fdf114 LG	76	Dict.update(self.DefineVarDict)\r
30fdf114 LG	77	SectionAlignments = None\r
9e47e6f9	78	if self.FvName:\r
d943b0c3	79	Buffer = BytesIO()\r
9eb87141	80	if self.FvName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FvDict:\r
30fdf114 LG	81	EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (self.FvName))\r
	82	Fv = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName.upper())\r
	83	FileName = Fv.AddToBuffer(Buffer)\r
	84	SectionFiles = [FileName]\r
	85	\r
9e47e6f9	86	elif self.FdName:\r
9eb87141	87	if self.FdName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FdDict:\r
30fdf114 LG	88	EdkLogger.error("GenFds", GENFDS_ERROR, "FD (%s) is NOT described in FDF file!" % (self.FdName))\r
30fdf114 LG	89	Fd = GenFdsGlobalVariable.FdfParser.Profile.FdDict.get(self.FdName.upper())\r
fd171542	90	FileName = Fd.GenFd()\r
30fdf114 LG	91	SectionFiles = [FileName]\r
30fdf114 LG	92	\r
9e47e6f9	93	elif self.FileName:\r
860992ed	94	if hasattr(self, 'FvFileType') and self.FvFileType == 'RAW':\r
cfaaf99b	95	if isinstance(self.FileName, list) and isinstance(self.SubAlignment, list) and len(self.FileName) == len(self.SubAlignment):\r
d943b0c3	96	FileContent = BytesIO()\r
cfaaf99b YZ	97	MaxAlignIndex = 0\r
cfaaf99b YZ	98	MaxAlignValue = 1\r
860992ed YZ	99	for Index, File in enumerate(self.FileName):\r
860992ed YZ	100	try:\r
f8db6527	101	f = open(File, 'rb')\r
860992ed YZ	102	except:\r
	103	GenFdsGlobalVariable.ErrorLogger("Error opening RAW file %s." % (File))\r
	104	Content = f.read()\r
	105	f.close()\r
cfaaf99b	106	AlignValue = 1\r
9e47e6f9	107	if self.SubAlignment[Index]:\r
cfaaf99b YZ	108	AlignValue = GenFdsGlobalVariable.GetAlignment(self.SubAlignment[Index])\r
	109	if AlignValue > MaxAlignValue:\r
	110	MaxAlignIndex = Index\r
	111	MaxAlignValue = AlignValue\r
d943b0c3 FB	112	FileContent.write(Content)\r
	113	if len(FileContent.getvalue()) % AlignValue != 0:\r
	114	Size = AlignValue - len(FileContent.getvalue()) % AlignValue\r
860992ed	115	for i in range(0, Size):\r
d943b0c3	116	FileContent.write(pack('B', 0xFF))\r
860992ed	117	\r
d943b0c3	118	if FileContent.getvalue() != b'':\r
860992ed	119	OutputRAWFile = os.path.join(GenFdsGlobalVariable.FfsDir, self.NameGuid, self.NameGuid + '.raw')\r
d943b0c3	120	SaveFileOnChange(OutputRAWFile, FileContent.getvalue(), True)\r
860992ed	121	self.FileName = OutputRAWFile\r
cfaaf99b YZ	122	self.SubAlignment = self.SubAlignment[MaxAlignIndex]\r
	123	\r
	124	if self.Alignment and self.SubAlignment:\r
	125	if GenFdsGlobalVariable.GetAlignment (self.Alignment) < GenFdsGlobalVariable.GetAlignment (self.SubAlignment):\r
	126	self.Alignment = self.SubAlignment\r
	127	elif self.SubAlignment:\r
	128	self.Alignment = self.SubAlignment\r
	129	\r
30fdf114	130	self.FileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
97fa0ee9 YL	131	#Replace $(SAPCE) with real space\r
97fa0ee9 YL	132	self.FileName = self.FileName.replace('$(SPACE)', ' ')\r
30fdf114 LG	133	SectionFiles = [GenFdsGlobalVariable.MacroExtend(self.FileName, Dict)]\r
	134	\r
	135	else:\r
	136	SectionFiles = []\r
	137	Index = 0\r
	138	SectionAlignments = []\r
9e47e6f9	139	for section in self.SectionList:\r
30fdf114 LG	140	Index = Index + 1\r
30fdf114 LG	141	SecIndex = '%d' %Index\r
52302d4d LG	142	# process the inside FvImage from FvSection or GuidSection\r
	143	if FvChildAddr != []:\r
	144	if isinstance(section, FvImageSection):\r
	145	section.FvAddr = FvChildAddr.pop(0)\r
	146	elif isinstance(section, GuidSection):\r
	147	section.FvAddr = FvChildAddr\r
9e47e6f9	148	if FvParentAddr and isinstance(section, GuidSection):\r
52302d4d LG	149	section.FvParentAddr = FvParentAddr\r
52302d4d LG	150	\r
4afd3d04 LG	151	if self.KeepReloc == False:\r
4afd3d04 LG	152	section.KeepReloc = False\r
30fdf114 LG	153	sectList, align = section.GenSection(OutputDir, self.NameGuid, SecIndex, self.KeyStringList, None, Dict)\r
	154	if sectList != []:\r
	155	for sect in sectList:\r
	156	SectionFiles.append(sect)\r
	157	SectionAlignments.append(align)\r
	158	\r
	159	#\r
	160	# Prepare the parameter\r
	161	#\r
	162	FfsFileOutput = os.path.join(OutputDir, self.NameGuid + '.ffs')\r
	163	GenFdsGlobalVariable.GenerateFfs(FfsFileOutput, SectionFiles,\r
9e47e6f9	164	FdfFvFileTypeToFileType.get(self.FvFileType),\r
30fdf114 LG	165	self.NameGuid,\r
	166	Fixed=self.Fixed,\r
	167	CheckSum=self.CheckSum,\r
	168	Align=self.Alignment,\r
	169	SectionAlign=SectionAlignments\r
	170	)\r
	171	\r
	172	return FfsFileOutput\r