NotificationsYou must be signed in to change notification settings
Fork0
Star0

Commit7d26cd8

committed

Merged PR 707: Removing hardcoded address bit width by changing to command line input

Removing hardcoded address bit width by changing to command line input and minor error log improvement

1 parent1e27357 commit7d26cd8Copy full SHA for 7d26cd8

File tree

4 files changed

+20

-15

lines changed

UefiTestingPkg/AuditTests/PagingAudit
- README.md
- Windows

4 files changed

+20

-15

lines changed

`‎UefiTestingPkg/AuditTests/PagingAudit/README.md‎`

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,10 @@ If the USB disk is FS0:\, the files should be in FS1:\\. Copy them to the flash`
`78`	`78`	`copy FS1:\*.dat FS0:\`
`79`	`79`	```
`80`	`80`
`81`		`-On a Windows PC, run the Python script on the data found on your USB key.`
	`81`	`+On a Windows PC, run Windows\PagingReportGenerator.py script with the data found on your USB key. Please use the following command for detailed script instruction:`
	`82`	+```
	`83`	`+PagingReportGenerator.py -h`
	`84`	+```
`82`	`85`
`83`	`86`	`Finally, double-click the HTML output file and check your results.`
`84`	`87`

`‎UefiTestingPkg/AuditTests/PagingAudit/Windows/BinaryParsing.py‎`

Lines changed: 6 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,6 @@`
`30`	`30`	`importlogging`
`31`	`31`	`importcsv`
`32`	`32`
`33`		`-ADDRESS_BITS=0x0000007FFFFFF000`
`34`		`-`
`35`	`33`	`defParseFileToBytes(fileName):`
`36`	`34`	`file=open(fileName,"rb")`
`37`	`35`	`d=memoryview(file.read())`
`@@ -50,7 +48,7 @@ def ParseInfoFile(fileName):`
`50`	`48`	`returnMemoryRanges`
`51`	`49`
`52`	`50`
`53`		`-defParse4kPages(fileName):`
	`51`	`+defParse4kPages(fileName,addressbits):`
`54`	`52`	`num=0`
`55`	`53`	`pages= []`
`56`	`54`	`logging.debug("-- Processing file '%s'..."%fileName)`
`@@ -64,7 +62,7 @@ def Parse4kPages(fileName):`
`64`	`62`	`ReadWrite= ((ByteArray[byteZeroIndex+0]&0x2)>>1)`
`65`	`63`	`User= ((ByteArray[byteZeroIndex+0]&0x4)>>2)`
`66`	`64`	`# PageTableBaseAddress is 40 bits long`
`67`		`-PageTableBaseAddress= (((((ByteArray[byteZeroIndex+1]&0xF0)>>4))+ (ByteArray[byteZeroIndex+2]<<4)+ (ByteArray[byteZeroIndex+3]<<12)+ (ByteArray[byteZeroIndex+4]<<20)+ (ByteArray[byteZeroIndex+5]<<28)+ ((ByteArray[byteZeroIndex+6]&0xF)<<36)<<12)&ADDRESS_BITS)`
	`65`	`+PageTableBaseAddress= (((((ByteArray[byteZeroIndex+1]&0xF0)>>4))+ (ByteArray[byteZeroIndex+2]<<4)+ (ByteArray[byteZeroIndex+3]<<12)+ (ByteArray[byteZeroIndex+4]<<20)+ (ByteArray[byteZeroIndex+5]<<28)+ ((ByteArray[byteZeroIndex+6]&0xF)<<36)<<12)&addressbits)`
`68`	`66`	`Nx= ((ByteArray[byteZeroIndex+7]&0x80)>>7)`
`69`	`67`	`ifPresent==0:`
`70`	`68`	`raiseException ("Data error")`
`@@ -76,7 +74,7 @@ def Parse4kPages(fileName):`
`76`	`74`	`returnpages`
`77`	`75`
`78`	`76`
`79`		`-defParse2mPages(fileName):`
	`77`	`+defParse2mPages(fileName,addressbits):`
`80`	`78`	`num=0`
`81`	`79`	`pages= []`
`82`	`80`	`logging.debug("-- Processing file '%s'..."%fileName)`
`@@ -91,7 +89,7 @@ def Parse2mPages(fileName):`
`91`	`89`	`MustBe1= ((ByteArray[byteZeroIndex+0]&0x80)>>7)`
`92`	`90`	`User= ((ByteArray[byteZeroIndex+0]&0x4)>>2)`
`93`	`91`	`# PageTableBaseAddress is 31 bits long`
`94`		`-PageTableBaseAddress= (((((ByteArray[byteZeroIndex+2]&0xE0)>>5))+ (ByteArray[byteZeroIndex+3]<<3)+ (ByteArray[byteZeroIndex+4]<<11)+ (ByteArray[byteZeroIndex+5]<<19)+ ((ByteArray[byteZeroIndex+6]&0xF)<<27)<<21)&ADDRESS_BITS)`
	`92`	`+PageTableBaseAddress= (((((ByteArray[byteZeroIndex+2]&0xE0)>>5))+ (ByteArray[byteZeroIndex+3]<<3)+ (ByteArray[byteZeroIndex+4]<<11)+ (ByteArray[byteZeroIndex+5]<<19)+ ((ByteArray[byteZeroIndex+6]&0xF)<<27)<<21)&addressbits)`
`95`	`93`	`Nx= ((ByteArray[byteZeroIndex+7]&0x80)>>7)`
`96`	`94`
`97`	`95`	`byteZeroIndex+=8`
`@@ -101,7 +99,7 @@ def Parse2mPages(fileName):`
`101`	`99`	`returnpages`
`102`	`100`
`103`	`101`
`104`		`-defParse1gPages(fileName):`
	`102`	`+defParse1gPages(fileName,addressbits):`
`105`	`103`	`num=0`
`106`	`104`	`pages= []`
`107`	`105`	`logging.debug("-- Processing file '%s'..."%fileName)`
`@@ -116,7 +114,7 @@ def Parse1gPages(fileName):`
`116`	`114`	`MustBe1= ((ByteArray[byteZeroIndex+0]&0x80)>>7)`
`117`	`115`	`User= ((ByteArray[byteZeroIndex+0]&0x4)>>2)`
`118`	`116`	`# PageTableBaseAddress is 22 bits long`
`119`		`-PageTableBaseAddress= (((((ByteArray[byteZeroIndex+3]&0xC0)>>6))+ (ByteArray[byteZeroIndex+4]<<2)+ (ByteArray[byteZeroIndex+5]<<10)+ ((ByteArray[byteZeroIndex+6]&0xF)<<18)<<30)&ADDRESS_BITS)# shift and address bits`
	`117`	`+PageTableBaseAddress= (((((ByteArray[byteZeroIndex+3]&0xC0)>>6))+ (ByteArray[byteZeroIndex+4]<<2)+ (ByteArray[byteZeroIndex+5]<<10)+ ((ByteArray[byteZeroIndex+6]&0xF)<<18)<<30)&addressbits)# shift and address bits`
`120`	`118`	`Nx= ((ByteArray[byteZeroIndex+7]&0x80)>>7)`
`121`	`119`
`122`	`120`	`byteZeroIndex+=8`

`‎UefiTestingPkg/AuditTests/PagingAudit/Windows/MemoryRangeObjects.py‎`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -149,11 +149,12 @@ def MemoryRangeToString(self):`
`149`	`149`	`------------------------------------------------------------------`
`150`	`150`	`Type : %s`
`151`	`151`	`PhysicalStart : 0x%010X`
	`152`	`+ PhysicalEnd : 0x%010X`
`152`	`153`	`VirtualStart : 0x%010X`
`153`	`154`	`NumberOfPages : 0x%010X`
`154`	`155`	`Attribute : 0x%010X`
`155`	`156`	`PhysicalSize : 0x%010X`
`156`		`-"""% (self.GetMemoryTypeDescription(),self.PhysicalStart,self.VirtualStart,self.NumberOfPages,self.Attribute,0)`
	`157`	`+"""% (self.GetMemoryTypeDescription(),self.PhysicalStart,self.PhysicalEnd,self.VirtualStart,self.NumberOfPages,self.Attribute,self.PhysicalSize)`
`157`	`158`
`158`	`159`	`#`
`159`	`160`	`# Intializes memory contents description`

`‎UefiTestingPkg/AuditTests/PagingAudit/Windows/PagingReportGenerator.py‎`

Lines changed: 8 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@`
`45`	`45`
`46`	`46`	`classParsingTool(object):`
`47`	`47`
`48`		`-def__init__(self,DatFolderPath,PlatformName,PlatformVersion,Type):`
	`48`	`+def__init__(self,DatFolderPath,PlatformName,PlatformVersion,Type,AddressBits):`
`49`	`49`	`self.Logger=logging.getLogger("ParsingTool")`
`50`	`50`	`self.MemoryAttributesTable= []`
`51`	`51`	`self.MemoryRangeInfo= []`
`@@ -55,6 +55,7 @@ def __init__(self, DatFolderPath, PlatformName, PlatformVersion, Type):`
`55`	`55`	`self.PlatformName=PlatformName`
`56`	`56`	`self.PlatformVersion=PlatformVersion`
`57`	`57`	`self.Type=Type`
	`58`	`+self.AddressBits= (1<<AddressBits)-1`
`58`	`59`
`59`	`60`	`defParse(self):`
`60`	`61`	`#Get Info Files`
`@@ -80,13 +81,13 @@ def Parse(self):`
`80`	`81`	`self.MemoryRangeInfo.extend(ParseInfoFile(info))`
`81`	`82`
`82`	`83`	`forpte1ginPte1gbFileList:`
`83`		`-self.PageDirectoryInfo.extend(Parse1gPages(pte1g))`
	`84`	`+self.PageDirectoryInfo.extend(Parse1gPages(pte1g,self.AddressBits))`
`84`	`85`
`85`	`86`	`forpte2minPte2mbFileList:`
`86`		`-self.PageDirectoryInfo.extend(Parse2mPages(pte2m))`
	`87`	`+self.PageDirectoryInfo.extend(Parse2mPages(pte2m,self.AddressBits))`
`87`	`88`
`88`	`89`	`forpte4kinPte4kbFileList:`
`89`		`-self.PageDirectoryInfo.extend(Parse4kPages(pte4k))`
	`90`	`+self.PageDirectoryInfo.extend(Parse4kPages(pte4k,self.AddressBits))`
`90`	`91`
`91`	`92`	`forguardpageinGuardPageFileList:`
`92`	`93`	`self.PageDirectoryInfo.extend(ParseInfoFile(guardpage))`
`@@ -209,6 +210,8 @@ def main():`
`209`	`210`	`parser.add_argument('-o',"--OutputReport",dest="OutputReport",help="Path to output html report (default is report.html)",default=os.path.join(os.getcwd(),"report.html"))`
`210`	`211`	`parser.add_argument('-p',"--PlatformName",dest="PlatformName",help="Name of Platform. Will show up on report",default="Test Platform")`
`211`	`212`	`parser.add_argument('-t',"--type",choices=['SMM','DXE'],dest="Type",help="SMM or DXE Paging Report",required=True)`
	`213`	`+parser.add_argument('-b',"--AddressBits",dest="AddressBits",help="Bit width of CPU address, could be found in processor datasheet or EFI_HOB_TYPE_CPU.\`
	`214`	`+ i.e. For a processor supports 39 bits in address bit width, please pass in '-b 39'",type=int,required=True)`
`212`	`215`	`parser.add_argument("--PlatformVersion",dest="PlatformVersion",help="Version of Platform. Will show up report",default="1.0.0")`
`213`	`216`
`214`	`217`	`#Turn on dubug level logging`
`@@ -248,7 +251,7 @@ def main():`
`248`	`251`	`logging.debug("Input Folder Path is: %s"%options.InputFolder)`
`249`	`252`	`logging.debug("Output Report is: %s"%options.OutputReport)`
`250`	`253`
`251`		`-spt=ParsingTool(options.InputFolder,options.PlatformName,options.PlatformVersion,options.Type)`
	`254`	`+spt=ParsingTool(options.InputFolder,options.PlatformName,options.PlatformVersion,options.Type,options.AddressBits)`
`252`	`255`	`spt.Parse()`
`253`	`256`	`returnspt.OutputHtmlReport(VERSION,options.OutputReport)`
`254`	`257`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit7d26cd8

File tree

4 files changed

4 files changed

`‎UefiTestingPkg/AuditTests/PagingAudit/README.md‎`

`‎UefiTestingPkg/AuditTests/PagingAudit/Windows/BinaryParsing.py‎`

`‎UefiTestingPkg/AuditTests/PagingAudit/Windows/MemoryRangeObjects.py‎`

`‎UefiTestingPkg/AuditTests/PagingAudit/Windows/PagingReportGenerator.py‎`

0 commit comments