From: "Shi, Steven" <steven....@intel.com> BZ:https://bugzilla.tianocore.org/show_bug.cgi?id=2079
The Basetool CopyFileOnChange() and SaveFileOnChange() functions might raise the IOError occasionally when build in Windows with multi-process and build cache enabled. The CopyFileOnChange() and SaveFileOnChange() might be invoked in multiple sub-processes simultaneously, and this patch adds a global lock to sync these functions invoking which can harden their reliability. Cc: Liming Gao <liming....@intel.com> Cc: Bob Feng <bob.c.f...@intel.com> Signed-off-by: Steven Shi <steven....@intel.com> --- BaseTools/Source/Python/AutoGen/AutoGenWorker.py | 4 +++- BaseTools/Source/Python/AutoGen/GenC.py | 0 BaseTools/Source/Python/AutoGen/ModuleAutoGen.py | 18 +++++++++--------- BaseTools/Source/Python/Common/GlobalData.py | 2 ++ BaseTools/Source/Python/Common/Misc.py | 29 +++++++++++++++++++++++------ BaseTools/Source/Python/build/build.py | 5 ++++- 6 files changed, 41 insertions(+), 17 deletions(-) diff --git a/BaseTools/Source/Python/AutoGen/AutoGenWorker.py b/BaseTools/Source/Python/AutoGen/AutoGenWorker.py index 30d2f96fc7..21c5efbe6a 100755 --- a/BaseTools/Source/Python/AutoGen/AutoGenWorker.py +++ b/BaseTools/Source/Python/AutoGen/AutoGenWorker.py @@ -133,7 +133,7 @@ class AutoGenManager(threading.Thread): def kill(self): self.feedback_q.put(None) class AutoGenWorkerInProcess(mp.Process): - def __init__(self,module_queue,data_pipe_file_path,feedback_q,file_lock, share_data,log_q,error_event): + def __init__(self,module_queue,data_pipe_file_path,feedback_q,file_lock,cache_lock,share_data,log_q,error_event): mp.Process.__init__(self) self.module_queue = module_queue self.data_pipe_file_path =data_pipe_file_path @@ -141,6 +141,7 @@ class AutoGenWorkerInProcess(mp.Process): self.feedback_q = feedback_q self.PlatformMetaFileSet = {} self.file_lock = file_lock + self.cache_lock = cache_lock self.share_data = share_data self.log_q = log_q self.error_event = error_event @@ -187,6 +188,7 @@ class AutoGenWorkerInProcess(mp.Process): GlobalData.gCacheIR = self.data_pipe.Get("CacheIR") GlobalData.gEnableGenfdsMultiThread = self.data_pipe.Get("EnableGenfdsMultiThread") GlobalData.file_lock = self.file_lock + GlobalData.cache_lock = self.cache_lock CommandTarget = self.data_pipe.Get("CommandTarget") pcd_from_build_option = [] for pcd_tuple in self.data_pipe.Get("BuildOptPcd"): diff --git a/BaseTools/Source/Python/AutoGen/GenC.py b/BaseTools/Source/Python/AutoGen/GenC.py old mode 100644 new mode 100755 diff --git a/BaseTools/Source/Python/AutoGen/ModuleAutoGen.py b/BaseTools/Source/Python/AutoGen/ModuleAutoGen.py index c489c3b9c4..0f319e5b26 100755 --- a/BaseTools/Source/Python/AutoGen/ModuleAutoGen.py +++ b/BaseTools/Source/Python/AutoGen/ModuleAutoGen.py @@ -1806,7 +1806,7 @@ class ModuleAutoGen(AutoGen): MewIR.MakefilePath = MakefilePath MewIR.DependencyHeaderFileSet = Makefile.DependencyHeaderFileSet MewIR.CreateMakeFileDone = True - with GlobalData.file_lock: + with GlobalData.cache_lock: try: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.MakefilePath = MakefilePath @@ -1891,7 +1891,7 @@ class ModuleAutoGen(AutoGen): self.IsCodeFileCreated = True MewIR = ModuleBuildCacheIR(self.MetaFile.Path, self.Arch) MewIR.CreateCodeFileDone = True - with GlobalData.file_lock: + with GlobalData.cache_lock: try: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.CreateCodeFileDone = True @@ -2032,7 +2032,7 @@ class ModuleAutoGen(AutoGen): MewIR.ModuleFilesHashDigest = m.digest() MewIR.ModuleFilesHashHexDigest = m.hexdigest() MewIR.ModuleFilesChain = FileList - with GlobalData.file_lock: + with GlobalData.cache_lock: try: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.ModuleFilesHashDigest = m.digest() @@ -2091,7 +2091,7 @@ class ModuleAutoGen(AutoGen): # Add Module self m.update(gDict[(self.MetaFile.Path, self.Arch)].ModuleFilesHashDigest) - with GlobalData.file_lock: + with GlobalData.cache_lock: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.PreMakefileHashHexDigest = m.hexdigest() gDict[(self.MetaFile.Path, self.Arch)] = IR @@ -2159,7 +2159,7 @@ class ModuleAutoGen(AutoGen): m.update(Content) FileList.append((str(File), hashlib.md5(Content).hexdigest())) - with GlobalData.file_lock: + with GlobalData.cache_lock: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.AutoGenFileList = self.AutoGenFileList.keys() IR.MakeHeaderFilesHashChain = FileList @@ -2222,7 +2222,7 @@ class ModuleAutoGen(AutoGen): New.sort(key=lambda x: str(x)) MakeHashChain += New - with GlobalData.file_lock: + with GlobalData.cache_lock: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.MakeHashDigest = m.digest() IR.MakeHashHexDigest = m.hexdigest() @@ -2300,7 +2300,7 @@ class ModuleAutoGen(AutoGen): if self.Name == "PcdPeim" or self.Name == "PcdDxe": CreatePcdDatabaseCode(self, TemplateString(), TemplateString()) - with GlobalData.file_lock: + with GlobalData.cache_lock: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.PreMakeCacheHit = True gDict[(self.MetaFile.Path, self.Arch)] = IR @@ -2321,7 +2321,7 @@ class ModuleAutoGen(AutoGen): # .inc is contains binary information so do not skip by hash as well for f_ext in self.SourceFileList: if '.inc' in str(f_ext): - with GlobalData.file_lock: + with GlobalData.cache_lock: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.MakeCacheHit = False gDict[(self.MetaFile.Path, self.Arch)] = IR @@ -2383,7 +2383,7 @@ class ModuleAutoGen(AutoGen): if self.Name == "PcdPeim" or self.Name == "PcdDxe": CreatePcdDatabaseCode(self, TemplateString(), TemplateString()) - with GlobalData.file_lock: + with GlobalData.cache_lock: IR = gDict[(self.MetaFile.Path, self.Arch)] IR.MakeCacheHit = True gDict[(self.MetaFile.Path, self.Arch)] = IR diff --git a/BaseTools/Source/Python/Common/GlobalData.py b/BaseTools/Source/Python/Common/GlobalData.py index 452dca32f0..09e92ce08c 100755 --- a/BaseTools/Source/Python/Common/GlobalData.py +++ b/BaseTools/Source/Python/Common/GlobalData.py @@ -122,6 +122,8 @@ gBuildHashSkipTracking = dict() # Common dictionary to share module cache intermediate result and state gCacheIR = None +# Common lock for the module cache intermediate data +cache_lock = None # Common lock for the file access in multiple process AutoGens file_lock = None # Common dictionary to share platform libraries' constant Pcd diff --git a/BaseTools/Source/Python/Common/Misc.py b/BaseTools/Source/Python/Common/Misc.py old mode 100644 new mode 100755 index 554ec010dd..6a629c5211 --- a/BaseTools/Source/Python/Common/Misc.py +++ b/BaseTools/Source/Python/Common/Misc.py @@ -448,7 +448,7 @@ def RemoveDirectory(Directory, Recursively=False): # @retval True If the file content is changed and the file is renewed # @retval False If the file content is the same # -def SaveFileOnChange(File, Content, IsBinaryFile=True): +def SaveFileOnChange(File, Content, IsBinaryFile=True, FileLock=GlobalData.file_lock): if os.path.exists(File): if IsBinaryFile: @@ -479,6 +479,9 @@ def SaveFileOnChange(File, Content, IsBinaryFile=True): if IsBinaryFile: OpenMode = "wb" + if FileLock: + FileLock.acquire() + if GlobalData.gIsWindows and not os.path.exists(File): # write temp file, then rename the temp file to the real file # to make sure the file be immediate saved to disk @@ -487,8 +490,11 @@ def SaveFileOnChange(File, Content, IsBinaryFile=True): tempname = tf.name try: os.rename(tempname, File) - except: - EdkLogger.error(None, FILE_CREATE_FAILURE, ExtraData='IOError %s' % X) + except IOError as X: + if GlobalData.gBinCacheSource: + EdkLogger.quite(None, FILE_CREATE_FAILURE, ExtraData='IOError %s' % X) + else: + EdkLogger.error(None, FILE_CREATE_FAILURE, ExtraData='IOError %s' % X) else: try: with open(File, OpenMode) as Fd: @@ -496,6 +502,9 @@ def SaveFileOnChange(File, Content, IsBinaryFile=True): except IOError as X: EdkLogger.error(None, FILE_CREATE_FAILURE, ExtraData='IOError %s' % X) + if FileLock: + FileLock.release() + return True ## Copy source file only if it is different from the destination file @@ -510,7 +519,7 @@ def SaveFileOnChange(File, Content, IsBinaryFile=True): # @retval True The two files content are different and the file is copied # @retval False No copy really happen # -def CopyFileOnChange(SrcFile, Dst): +def CopyFileOnChange(SrcFile, Dst, FileLock=GlobalData.file_lock): if not os.path.exists(SrcFile): return False @@ -531,6 +540,9 @@ def CopyFileOnChange(SrcFile, Dst): if not os.access(DirName, os.W_OK): EdkLogger.error(None, PERMISSION_FAILURE, "Do not have write permission on directory %s" % DirName) + if FileLock: + FileLock.acquire() + # os.replace and os.rename are the atomic operations in python 3 and 2. # we use these two atomic operations to ensure the file copy is atomic: # copy the src to a temp file in the dst same folder firstly, then @@ -546,9 +558,14 @@ def CopyFileOnChange(SrcFile, Dst): if GlobalData.gIsWindows and os.path.exists(DstFile): os.remove(DstFile) os.rename(tempname, DstFile) - except IOError as X: - EdkLogger.error(None, FILE_COPY_FAILURE, ExtraData='IOError %s' % X) + if GlobalData.gBinCacheSource: + EdkLogger.quite(None, FILE_COPY_FAILURE, ExtraData='IOError %s' % X) + else: + EdkLogger.error(None, FILE_COPY_FAILURE, ExtraData='IOError %s' % X) + + if FileLock: + FileLock.release() return True diff --git a/BaseTools/Source/Python/build/build.py b/BaseTools/Source/Python/build/build.py index 299fa64311..2c10670a69 100755 --- a/BaseTools/Source/Python/build/build.py +++ b/BaseTools/Source/Python/build/build.py @@ -820,13 +820,15 @@ class Build(): file_lock = mp.Lock() error_event = mp.Event() GlobalData.file_lock = file_lock + cache_lock = mp.Lock() + GlobalData.cache_lock = cache_lock FfsCmd = DataPipe.Get("FfsCommand") if FfsCmd is None: FfsCmd = {} GlobalData.FfsCmd = FfsCmd GlobalData.libConstPcd = DataPipe.Get("LibConstPcd") GlobalData.Refes = DataPipe.Get("REFS") - auto_workers = [AutoGenWorkerInProcess(mqueue,DataPipe.dump_file,feedback_q,file_lock,share_data,self.log_q,error_event) for _ in range(self.ThreadNumber)] + auto_workers = [AutoGenWorkerInProcess(mqueue,DataPipe.dump_file,feedback_q,file_lock,cache_lock,share_data,self.log_q,error_event) for _ in range(self.ThreadNumber)] self.AutoGenMgr = AutoGenManager(auto_workers,feedback_q,error_event) self.AutoGenMgr.start() for w in auto_workers: @@ -1826,6 +1828,7 @@ class Build(): for PkgName in GlobalData.gPackageHash.keys(): GlobalData.gCacheIR[(PkgName, 'PackageHash')] = GlobalData.gPackageHash[PkgName] GlobalData.file_lock = mp.Lock() + GlobalData.cache_lock = mp.Lock() GlobalData.FfsCmd = CmdListDict self.Progress.Stop("done!") -- 2.17.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#45632): https://edk2.groups.io/g/devel/message/45632 Mute This Topic: https://groups.io/mt/32866766/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-