BaseTools: Convert Split tool to python
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3165 There are 2 reasons to convert Split tool from C to Python. 1. We are in the process of moving the Basetools Python code to a separate repository. But there still are many C tools under edk2/BaseTools. To make all Basetools be in the separate repo, we can convert the C tools to Python tools. 2. The original Split tool is very slow. This python tool can reduce 90% time. Signed-off-by: Bob Feng <bob.c.feng@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Yuwei Chen <yuwei.chen@intel.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn> Reviewed-by: Yuwei Chen <yuwei.chen@intel.com>
This commit is contained in:
Bob Feng
mergify[bot]
202
BaseTools/Source/Python/Split/Split.py
Normal file
202
BaseTools/Source/Python/Split/Split.py
Normal file
@ -0,0 +1,202 @@
|
||||
# @file
|
||||
# Split a file into two pieces at the request offset.
|
||||
#
|
||||
# Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
|
||||
#
|
||||
# SPDX-License-Identifier: BSD-2-Clause-Patent
|
||||
#
|
||||
##
|
||||
|
||||
# Import Modules
|
||||
#
|
||||
import argparse
|
||||
import os
|
||||
import io
|
||||
import shutil
|
||||
import logging
|
||||
import sys
|
||||
import tempfile
|
||||
|
||||
parser = argparse.ArgumentParser(description='''
|
||||
SplitFile creates two Binary files either in the same directory as the current working directory or in the specified directory.
|
||||
''')
|
||||
parser.add_argument("-f", "--filename", dest="inputfile",
|
||||
required=True, help="The input file to split tool.")
|
||||
parser.add_argument("-s", "--split", dest="position",
|
||||
required=True, help="The number of bytes in the first file. The valid format are HEX, Decimal and Decimal[KMG].")
|
||||
parser.add_argument("-p", "--prefix", dest="output",
|
||||
help="The output folder.")
|
||||
parser.add_argument("-o", "--firstfile", help="The first file name")
|
||||
parser.add_argument("-t", "--secondfile", help="The second file name")
|
||||
parser.add_argument("--version", action="version", version='%(prog)s Version 2.0',
|
||||
help="Print debug information.")
|
||||
|
||||
group = parser.add_mutually_exclusive_group()
|
||||
group.add_argument("-v", "--verbose", action="store_true",
|
||||
help="Print debug information.")
|
||||
group.add_argument("-q", "--quiet", action="store_true",
|
||||
help="Disable all messages except fatal errors")
|
||||
|
||||
SizeDict = {
|
||||
"K": 1024,
|
||||
"M": 1024*1024,
|
||||
"G": 1024*1024*1024
|
||||
}
|
||||
|
||||
|
||||
def GetPositionValue(position):
|
||||
'''
|
||||
Parse the string of the argument position and return a decimal number.
|
||||
The valid position formats are
|
||||
1. HEX
|
||||
e.g. 0x1000 or 0X1000
|
||||
2. Decimal
|
||||
e.g. 100
|
||||
3. Decimal[KMG]
|
||||
e.g. 100K or 100M or 100G or 100k or 100m or 100g
|
||||
'''
|
||||
logger = logging.getLogger('Split')
|
||||
PosVal = 0
|
||||
header = position[:2].upper()
|
||||
tailer = position[-1].upper()
|
||||
|
||||
try:
|
||||
if tailer in SizeDict:
|
||||
PosVal = int(position[:-1]) * SizeDict[tailer]
|
||||
else:
|
||||
if header == "0X":
|
||||
PosVal = int(position, 16)
|
||||
else:
|
||||
PosVal = int(position)
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
"The parameter %s format is incorrect. The valid format is HEX, Decimal and Decimal[KMG]." % position)
|
||||
raise(e)
|
||||
|
||||
return PosVal
|
||||
|
||||
|
||||
def getFileSize(filename):
|
||||
'''
|
||||
Read the input file and return the file size.
|
||||
'''
|
||||
logger = logging.getLogger('Split')
|
||||
length = 0
|
||||
try:
|
||||
with open(filename, "rb") as fin:
|
||||
fin.seek(0, io.SEEK_END)
|
||||
length = fin.tell()
|
||||
except Exception as e:
|
||||
logger.error("Access file failed: %s", filename)
|
||||
raise(e)
|
||||
|
||||
return length
|
||||
|
||||
|
||||
def splitFile(inputfile, position, outputdir=None, outputfile1=None, outputfile2=None):
|
||||
'''
|
||||
Split the inputfile into outputfile1 and outputfile2 from the position.
|
||||
'''
|
||||
logger = logging.getLogger('Split')
|
||||
|
||||
inputfile = os.path.abspath(inputfile)
|
||||
workspace = os.path.dirname(inputfile)
|
||||
if not os.path.exists(inputfile):
|
||||
logger.error("File Not Found: %s" % inputfile)
|
||||
raise(Exception)
|
||||
|
||||
if outputfile1 and outputfile2 and outputfile1 == outputfile2:
|
||||
logger.error(
|
||||
"The firstfile and the secondfile can't be the same: %s" % outputfile1)
|
||||
raise(Exception)
|
||||
|
||||
if not outputdir:
|
||||
outputdir = workspace
|
||||
elif not os.path.isabs(outputdir):
|
||||
outputdir = os.path.join(workspace, outputdir)
|
||||
|
||||
# Create dir for the output files
|
||||
try:
|
||||
if not outputfile1:
|
||||
outputfile1 = os.path.abspath(os.path.join(
|
||||
outputdir, "{}1".format(os.path.basename(inputfile))))
|
||||
else:
|
||||
outputfile1 = os.path.abspath(os.path.join(outputdir, outputfile1))
|
||||
outputdir = os.path.dirname(outputfile1)
|
||||
if not os.path.exists(outputdir):
|
||||
os.makedirs(outputdir)
|
||||
|
||||
if not outputfile2:
|
||||
outputfile2 = os.path.abspath(os.path.join(
|
||||
outputdir, "{}2".format(os.path.basename(inputfile))))
|
||||
else:
|
||||
outputfile2 = os.path.abspath(os.path.join(outputdir, outputfile2))
|
||||
outputdir = os.path.dirname(outputfile2)
|
||||
if not os.path.exists(outputdir):
|
||||
os.makedirs(outputdir)
|
||||
except Exception as e:
|
||||
logger.error("Can't make dir: %s" % outputdir)
|
||||
raise(e)
|
||||
|
||||
if position <= 0:
|
||||
if outputfile2 != inputfile:
|
||||
shutil.copy2(inputfile, outputfile2)
|
||||
with open(outputfile1, "wb") as fout:
|
||||
fout.write(b'')
|
||||
else:
|
||||
inputfilesize = getFileSize(inputfile)
|
||||
if position >= inputfilesize:
|
||||
if outputfile1 != inputfile:
|
||||
shutil.copy2(inputfile, outputfile1)
|
||||
with open(outputfile2, "wb") as fout:
|
||||
fout.write(b'')
|
||||
else:
|
||||
try:
|
||||
tempdir = tempfile.mkdtemp()
|
||||
tempfile1 = os.path.join(tempdir, "file1.bin")
|
||||
tempfile2 = os.path.join(tempdir, "file2.bin")
|
||||
with open(inputfile, "rb") as fin:
|
||||
content1 = fin.read(position)
|
||||
with open(tempfile1, "wb") as fout1:
|
||||
fout1.write(content1)
|
||||
|
||||
content2 = fin.read(inputfilesize - position)
|
||||
with open(tempfile2, "wb") as fout2:
|
||||
fout2.write(content2)
|
||||
shutil.copy2(tempfile1, outputfile1)
|
||||
shutil.copy2(tempfile2, outputfile2)
|
||||
except Exception as e:
|
||||
logger.error("Split file failed")
|
||||
raise(e)
|
||||
finally:
|
||||
if os.path.exists(tempdir):
|
||||
shutil.rmtree(tempdir)
|
||||
|
||||
|
||||
def main():
|
||||
args = parser.parse_args()
|
||||
status = 0
|
||||
|
||||
logger = logging.getLogger('Split')
|
||||
if args.quiet:
|
||||
logger.setLevel(logging.CRITICAL)
|
||||
if args.verbose:
|
||||
logger.setLevel(logging.DEBUG)
|
||||
|
||||
lh = logging.StreamHandler(sys.stdout)
|
||||
lf = logging.Formatter("%(levelname)-8s: %(message)s")
|
||||
lh.setFormatter(lf)
|
||||
logger.addHandler(lh)
|
||||
|
||||
try:
|
||||
position = GetPositionValue(args.position)
|
||||
splitFile(args.inputfile, position, args.output,
|
||||
args.firstfile, args.secondfile)
|
||||
except Exception as e:
|
||||
status = 1
|
||||
|
||||
return status
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
exit(main())
|
||||
Reference in New Issue
Block a user