]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/FdfParser.py
Sync BaseTools Branch (version r2149) to EDKII main trunk.
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py
index 4ce276124318613d88e2335bfbb69520e1f04698..9e7771dc7de8b2c14cb266426c5400ad1130cb90 100644 (file)
@@ -1,9 +1,9 @@
 ## @file\r
 # parse FDF file\r
 #\r
-#  Copyright (c) 2007, Intel Corporation\r
+#  Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
 #\r
-#  All rights reserved. This program and the accompanying materials\r
+#  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
 #  which accompanies this distribution.  The full text of the license may be found at\r
 #  http://opensource.org/licenses/bsd-license.php\r
@@ -43,6 +43,8 @@ import OptRomFileStatement
 from GenFdsGlobalVariable import GenFdsGlobalVariable\r
 from Common.BuildToolError import *\r
 from Common import EdkLogger\r
+from Common.Misc import PathClass\r
+from Common.String import NormPath\r
 \r
 import re\r
 import os\r
@@ -205,6 +207,8 @@ class FdfParser:
         self.__SkippedChars = ""\r
 \r
         self.__WipeOffArea = []\r
+        if GenFdsGlobalVariable.WorkSpaceDir == '':\r
+            GenFdsGlobalVariable.WorkSpaceDir = os.getenv("WORKSPACE")\r
 \r
     ## __IsWhiteSpace() method\r
     #\r
@@ -415,6 +419,21 @@ class FdfParser:
             Offset += 1\r
 \r
 \r
+    def __GetMacroName(self):\r
+        if not self.__GetNextToken():\r
+            raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
+        MacroName = self.__Token\r
+        NotFlag = False\r
+        if MacroName.startswith('!'):\r
+            NotFlag = True\r
+            MacroName = MacroName[1:].strip()\r
+         \r
+        if not MacroName.startswith('$(') or not MacroName.endswith(')'):\r
+            raise Warning("Macro name expected(Please use '$(%(Token)s)' if '%(Token)s' is a macro.)" % {"Token" : MacroName},\r
+                          self.FileName, self.CurrentLineNumber)\r
+        MacroName = MacroName[2:-1]\r
+        return MacroName, NotFlag\r
+    \r
     ## PreprocessFile() method\r
     #\r
     #   Preprocess file contents, replace comments with spaces.\r
@@ -545,9 +564,20 @@ class FdfParser:
 \r
         self.Rewind()\r
 \r
-    ## PreprocessIncludeFile() method\r
+    def __GetIfListCurrentItemStat(self, IfList):\r
+        if len(IfList) == 0:\r
+            return True\r
+        \r
+        for Item in IfList:\r
+            if Item[1] == False:\r
+                return False\r
+        \r
+        return True\r
+                   \r
+\r
+    ## PreprocessConditionalStatement() method\r
     #\r
-    #   Preprocess file contents, replace !include statements with file contents.\r
+    #   Preprocess conditional statement.\r
     #   In the end, rewind the file buffer pointer to the beginning\r
     #\r
     #   @param  self        The object pointer\r
@@ -557,41 +587,35 @@ class FdfParser:
         IfList = []\r
         while self.__GetNextToken():\r
             if self.__Token == 'DEFINE':\r
-                DefineLine = self.CurrentLineNumber - 1\r
-                DefineOffset = self.CurrentOffsetWithinLine - len('DEFINE')\r
-                if not self.__GetNextToken():\r
-                    raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
-                Macro = self.__Token\r
-                if not self.__IsToken( "="):\r
-                    raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
-\r
-                if not self.__GetNextToken():\r
-                    raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
-\r
-                if self.__GetStringData():\r
-                    pass\r
-                Value = self.__Token\r
-                if not Macro in InputMacroDict:\r
-                    FileLineTuple = GetRealFileLine(self.FileName, DefineLine + 1)\r
-                    MacProfile = MacroProfile(FileLineTuple[0], FileLineTuple[1])\r
-                    MacProfile.MacroName = Macro\r
-                    MacProfile.MacroValue = Value\r
-                    AllMacroList.append(MacProfile)\r
-                self.__WipeOffArea.append(((DefineLine, DefineOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
+                if self.__GetIfListCurrentItemStat(IfList):\r
+                    DefineLine = self.CurrentLineNumber - 1\r
+                    DefineOffset = self.CurrentOffsetWithinLine - len('DEFINE')\r
+                    if not self.__GetNextToken():\r
+                        raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
+                    Macro = self.__Token\r
+                    if not self.__IsToken( "="):\r
+                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+    \r
+                    if not self.__GetNextToken():\r
+                        raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
+    \r
+                    if self.__GetStringData():\r
+                        pass\r
+                    Value = self.__Token\r
+                    if not Macro in InputMacroDict:\r
+                        FileLineTuple = GetRealFileLine(self.FileName, DefineLine + 1)\r
+                        MacProfile = MacroProfile(FileLineTuple[0], FileLineTuple[1])\r
+                        MacProfile.MacroName = Macro\r
+                        MacProfile.MacroValue = Value\r
+                        AllMacroList.append(MacProfile)\r
+                    self.__WipeOffArea.append(((DefineLine, DefineOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
 \r
             elif self.__Token in ('!ifdef', '!ifndef', '!if'):\r
                 IfStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))\r
                 IfList.append([IfStartPos, None, None])\r
                 CondLabel = self.__Token\r
-\r
-                if not self.__GetNextToken():\r
-                    raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
-                MacroName = self.__Token\r
-                NotFlag = False\r
-                if MacroName.startswith('!'):\r
-                    NotFlag = True\r
-                    MacroName = MacroName[1:]\r
-\r
+                \r
+                MacroName, NotFlag = self.__GetMacroName() \r
                 NotDefineFlag = False\r
                 if CondLabel == '!ifndef':\r
                     NotDefineFlag = True\r
@@ -645,14 +669,7 @@ class FdfParser:
                     self.__WipeOffArea.append((IfList[-1][0], ElseStartPos))\r
                     IfList[-1] = [ElseStartPos, True, IfList[-1][2]]\r
                     if self.__Token == '!elseif':\r
-                        if not self.__GetNextToken():\r
-                            raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
-                        MacroName = self.__Token\r
-                        NotFlag = False\r
-                        if MacroName.startswith('!'):\r
-                            NotFlag = True\r
-                            MacroName = MacroName[1:]\r
-\r
+                        MacroName, NotFlag = self.__GetMacroName() \r
                         if not self.__GetNextOp():\r
                             raise Warning("expected !endif", self.FileName, self.CurrentLineNumber)\r
 \r
@@ -745,7 +762,7 @@ class FdfParser:
                     raise Warning("Value %s is not a number", self.FileName, Line)\r
 \r
         for Profile in AllMacroList:\r
-            if Profile.FileName == FileLineTuple[0] and Profile.MacroName == Name and Profile.DefinedAtLine <= FileLineTuple[1]:\r
+            if Profile.MacroName == Name and Profile.DefinedAtLine <= FileLineTuple[1]:\r
                 if Op == None:\r
                     if Value == 'Bool' and Profile.MacroValue == None or Profile.MacroValue.upper() == 'FALSE':\r
                         return False\r
@@ -1258,6 +1275,12 @@ class FdfParser:
             raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
 \r
         while self.__GetNextWord():\r
+            # handle the SET statement\r
+            if self.__Token == 'SET':\r
+                self.__UndoToken()\r
+                self.__GetSetStatement(None)\r
+                continue\r
+            \r
             Macro = self.__Token\r
             \r
             if not self.__IsToken("="):\r
@@ -1483,7 +1506,7 @@ class FdfParser:
         \r
         for Item in Obj.BlockSizeList:\r
             if Item[0] == None or Item[1] == None:\r
-                raise Warning("expected block statement for Fd Section", self.FileName, self.CurrentLineNumber)\r
+                raise Warning("expected block statement", self.FileName, self.CurrentLineNumber)\r
 \r
     ## __GetBlockStatement() method\r
     #\r
@@ -1502,7 +1525,7 @@ class FdfParser:
             raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
 \r
         if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():\r
-            raise Warning("expected Hex block size", self.FileName, self.CurrentLineNumber)\r
+            raise Warning("expected Hex or Integer block size", self.FileName, self.CurrentLineNumber)\r
 \r
         BlockSize = self.__Token\r
         BlockSizePcd = None\r
@@ -1603,7 +1626,8 @@ class FdfParser:
                     raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
                 Value += self.__SkippedChars\r
 \r
-            Obj.SetVarDict[PcdPair] = Value\r
+            if Obj:\r
+                Obj.SetVarDict[PcdPair] = Value\r
             self.Profile.PcdDict[PcdPair] = Value\r
             return True\r
 \r
@@ -1785,19 +1809,27 @@ class FdfParser:
         if not self.__GetNextHexNumber():\r
             raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
 \r
-        if len(self.__Token) > 4:\r
-            raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
+        if len(self.__Token) > 18:\r
+            raise Warning("Hex string can't be converted to a valid UINT64 value", self.FileName, self.CurrentLineNumber)\r
 \r
-        DataString = self.__Token\r
-        DataString += ","\r
+        # convert hex string value to byte hex string array\r
+        AllString = self.__Token\r
+        AllStrLen = len (AllString)\r
+        DataString = ""\r
+        while AllStrLen > 4:\r
+            DataString = DataString + "0x" + AllString[AllStrLen - 2: AllStrLen] + ","\r
+            AllStrLen  = AllStrLen - 2\r
+        DataString = DataString + AllString[:AllStrLen] + ","\r
 \r
-        while self.__IsToken(","):\r
-            if not self.__GetNextHexNumber():\r
-                raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
-            if len(self.__Token) > 4:\r
-                raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
-            DataString += self.__Token\r
-            DataString += ","\r
+        # byte value array\r
+        if len (self.__Token) <= 4:\r
+            while self.__IsToken(","):\r
+                if not self.__GetNextHexNumber():\r
+                    raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
+                if len(self.__Token) > 4:\r
+                    raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
+                DataString += self.__Token\r
+                DataString += ","\r
 \r
         if not self.__IsToken( "}"):\r
             raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
@@ -1817,18 +1849,27 @@ class FdfParser:
             if not self.__GetNextHexNumber():\r
                 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
 \r
-            if len(self.__Token) > 4:\r
-                raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
+            if len(self.__Token) > 18:\r
+                raise Warning("Hex string can't be converted to a valid UINT64 value", self.FileName, self.CurrentLineNumber)\r
 \r
-            DataString = self.__Token\r
-            DataString += ","\r
+            # convert hex string value to byte hex string array\r
+            AllString = self.__Token\r
+            AllStrLen = len (AllString)\r
+            DataString = ""\r
+            while AllStrLen > 4:\r
+                DataString = DataString + "0x" + AllString[AllStrLen - 2: AllStrLen] + ","\r
+                AllStrLen  = AllStrLen - 2\r
+            DataString = DataString + AllString[:AllStrLen] + ","\r
 \r
-            while self.__IsToken(","):\r
-                self.__GetNextHexNumber()\r
-                if len(self.__Token) > 4:\r
-                    raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
-                DataString += self.__Token\r
-                DataString += ","\r
+            # byte value array\r
+            if len (self.__Token) <= 4:\r
+                while self.__IsToken(","):\r
+                    if not self.__GetNextHexNumber():\r
+                        raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
+                    if len(self.__Token) > 4:\r
+                        raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
+                    DataString += self.__Token\r
+                    DataString += ","\r
 \r
             if not self.__IsToken( "}"):\r
                 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
@@ -1881,7 +1922,8 @@ class FdfParser:
 \r
         self.__GetAddressStatements(FvObj)\r
 \r
-        self.__GetBlockStatement(FvObj)\r
+        while self.__GetBlockStatement(FvObj):\r
+            pass\r
 \r
         self.__GetSetStatements(FvObj)\r
 \r
@@ -2126,6 +2168,11 @@ class FdfParser:
         if not self.__GetNextToken():\r
             raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)\r
         ffsInf.InfFileName = self.__Token\r
+        if ffsInf.InfFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
+            #do case sensitive check for file path\r
+            ErrorCode, ErrorInfo = PathClass(NormPath(ffsInf.InfFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+            if ErrorCode != 0:\r
+                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         if not ffsInf.InfFileName in self.Profile.InfList:\r
             self.Profile.InfList.append(ffsInf.InfFileName)\r
@@ -2333,6 +2380,11 @@ class FdfParser:
             self.__GetSectionData( FfsFileObj, MacroDict)\r
         else:\r
             FfsFileObj.FileName = self.__Token\r
+            if FfsFileObj.FileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
+                #do case sensitive check for file path\r
+                ErrorCode, ErrorInfo = PathClass(NormPath(FfsFileObj.FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+                if ErrorCode != 0:\r
+                    EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         if not self.__IsToken( "}"):\r
             raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
@@ -2369,9 +2421,11 @@ class FdfParser:
             FfsFileObj.CheckSum = True\r
 \r
         if self.__GetAlignment():\r
-            FfsFileObj.Alignment = self.__Token\r
-\r
-\r
+            if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
+                raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
+            #For FFS, Auto is default option same to ""\r
+            if not self.__Token == "Auto":\r
+                FfsFileObj.Alignment = self.__Token\r
 \r
     ## __GetAlignment() method\r
     #\r
@@ -2576,6 +2630,11 @@ class FdfParser:
                 if not self.__GetNextToken():\r
                     raise Warning("expected section file path", self.FileName, self.CurrentLineNumber)\r
                 DataSectionObj.SectFileName = self.__Token\r
+                if DataSectionObj.SectFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
+                    #do case sensitive check for file path\r
+                    ErrorCode, ErrorInfo = PathClass(NormPath(DataSectionObj.SectFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+                    if ErrorCode != 0:\r
+                        EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
             else:\r
                 if not self.__GetCglSection(DataSectionObj):\r
                     return False\r
@@ -2663,8 +2722,8 @@ class FdfParser:
     def __GetGuidAttrib(self):\r
 \r
         AttribDict = {}\r
-        AttribDict["PROCESSING_REQUIRED"] = False\r
-        AttribDict["AUTH_STATUS_VALID"] = False\r
+        AttribDict["PROCESSING_REQUIRED"] = "NONE"\r
+        AttribDict["AUTH_STATUS_VALID"] = "NONE"\r
         if self.__IsKeyword("PROCESSING_REQUIRED") or self.__IsKeyword("AUTH_STATUS_VALID"):\r
             AttribKey = self.__Token\r
 \r
@@ -3492,6 +3551,11 @@ class FdfParser:
                 raise Warning("expected Reset file", self.FileName, self.CurrentLineNumber)\r
 \r
             VtfObj.ResetBin = self.__Token\r
+            if VtfObj.ResetBin.replace('$(WORKSPACE)', '').find('$') == -1:\r
+                #check for file path\r
+                ErrorCode, ErrorInfo = PathClass(NormPath(VtfObj.ResetBin), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+                if ErrorCode != 0:\r
+                    EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         while self.__GetComponentStatement(VtfObj):\r
             pass\r
@@ -3594,6 +3658,11 @@ class FdfParser:
             raise Warning("expected Component file", self.FileName, self.CurrentLineNumber)\r
 \r
         CompStatementObj.CompBin = self.__Token\r
+        if CompStatementObj.CompBin != '-' and CompStatementObj.CompBin.replace('$(WORKSPACE)', '').find('$') == -1:\r
+            #check for file path\r
+            ErrorCode, ErrorInfo = PathClass(NormPath(CompStatementObj.CompBin), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+            if ErrorCode != 0:\r
+                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         if not self.__IsKeyword("COMP_SYM"):\r
             raise Warning("expected COMP_SYM", self.FileName, self.CurrentLineNumber)\r
@@ -3605,6 +3674,11 @@ class FdfParser:
             raise Warning("expected Component symbol file", self.FileName, self.CurrentLineNumber)\r
 \r
         CompStatementObj.CompSym = self.__Token\r
+        if CompStatementObj.CompSym != '-' and CompStatementObj.CompSym.replace('$(WORKSPACE)', '').find('$') == -1:\r
+            #check for file path\r
+            ErrorCode, ErrorInfo = PathClass(NormPath(CompStatementObj.CompSym), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+            if ErrorCode != 0:\r
+                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         if not self.__IsKeyword("COMP_SIZE"):\r
             raise Warning("expected COMP_SIZE", self.FileName, self.CurrentLineNumber)\r
@@ -3682,6 +3756,11 @@ class FdfParser:
         if not self.__GetNextToken():\r
             raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)\r
         ffsInf.InfFileName = self.__Token\r
+        if ffsInf.InfFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
+            #check for file path\r
+            ErrorCode, ErrorInfo = PathClass(NormPath(ffsInf.InfFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+            if ErrorCode != 0:\r
+                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         if not ffsInf.InfFileName in self.Profile.InfList:\r
             self.Profile.InfList.append(ffsInf.InfFileName)\r
@@ -3774,6 +3853,11 @@ class FdfParser:
         if not self.__GetNextToken():\r
             raise Warning("expected File path", self.FileName, self.CurrentLineNumber)\r
         FfsFileObj.FileName = self.__Token\r
+        if FfsFileObj.FileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
+            #check for file path\r
+            ErrorCode, ErrorInfo = PathClass(NormPath(FfsFileObj.FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+            if ErrorCode != 0:\r
+                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
 \r
         if FfsFileObj.FileType == 'EFI':\r
             self.__GetOptRomOverrides(FfsFileObj)\r