From cb4d97bd83b4a570f84cee128f9021038b21f967 Mon Sep 17 00:00:00 2001 From: qouyang Date: Thu, 24 Aug 2006 09:24:29 +0000 Subject: [PATCH] Modify code according suggestion from code review meeting. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1379 6f19259b-4bc3-4df7-8a09-765794883524 --- .../org/tianocore/build/autogen/AutoGen.java | 634 ++++++++++-------- .../build/autogen/AutogenLibOrder.java | 25 +- .../build/autogen/CommonDefinition.java | 178 +++-- 3 files changed, 460 insertions(+), 377 deletions(-) diff --git a/Tools/Source/GenBuild/org/tianocore/build/autogen/AutoGen.java b/Tools/Source/GenBuild/org/tianocore/build/autogen/AutoGen.java index dea679b407..80cdecf992 100644 --- a/Tools/Source/GenBuild/org/tianocore/build/autogen/AutoGen.java +++ b/Tools/Source/GenBuild/org/tianocore/build/autogen/AutoGen.java @@ -22,6 +22,7 @@ import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.FileReader; import java.io.FileWriter; +import java.io.IOException; import java.util.ArrayList; import java.util.HashSet; import java.util.Iterator; @@ -39,13 +40,13 @@ import org.tianocore.build.global.SurfaceAreaQuery; import org.tianocore.build.id.ModuleIdentification; import org.tianocore.build.id.PackageIdentification; import org.tianocore.build.pcd.action.PCDAutoGenAction; - import org.tianocore.common.logger.EdkLog; +import org.tianocore.common.definitions.ToolDefinitions; /** - * This class is to generate Autogen.h and Autogen.c according to module surface - * area or library surface area. - */ + This class is to generate Autogen.h and Autogen.c according to module surface + area or library surface area. +**/ public class AutoGen { /// /// The output path of Autogen.h and Autogen.c @@ -96,38 +97,40 @@ public class AutoGen { /// private Set mGuidList = new HashSet(); - // - // The dependence package list which recoreded in module or library surface - // area and it's dependence on library instance surface are. - // + /// + /// The dependence package list which recoreded in module or library surface + /// area and it's dependence on library instance surface area. + /// private List mDepPkgList = new LinkedList(); - // - // For non library module, add its library instance's construct and destructor to - // list. - // + /// + /// For non library module, add its library instance's construct and destructor to + /// list. + /// private List libConstructList = new ArrayList(); private List libDestructList = new ArrayList(); - // - // List to store SetVirtalAddressMapCallBack, ExitBootServiceCallBack - // + /// + /// List to store SetVirtalAddressMapCallBack, ExitBootServiceCallBack + /// private List setVirtalAddList = new ArrayList(); private List exitBootServiceList = new ArrayList(); /** - * Construct function - * - * This function mainly initialize some member variable. - * - * @param outputPath - * Output path of AutoGen file. - * @param baseName - * Module base name. - * @param arch - * Target architecture. - */ + Construct function + + This function mainly initialize some member variable. + + @param fvDir + Absolute path of FV directory. + @param outputPath + Output path of AutoGen file. + @param moduleId + Module identification. + @param arch + Target architecture. + **/ public AutoGen(String fvDir, String outputPath, ModuleIdentification moduleId, String arch) { this.outputPath = outputPath; this.moduleId = moduleId; @@ -137,55 +140,72 @@ public class AutoGen { } /** - * saveFile function - * - * This function save the content in stringBuffer to file. - * - * @param fileName - * The name of file. - * @param fileBuffer - * The content of AutoGen file in buffer. - * @return "true" successful, "false" failed. - */ + saveFile function + + This function save the content in stringBuffer to file. + + @param fileName + The name of file. + @param fileBuffer + The content of AutoGen file in buffer. + @return boolean + "true" successful + "false" failed + **/ private boolean saveFile(String fileName, StringBuffer fileBuffer) { - try { - File autoGenH = new File(fileName); + + File autoGenH = new File(fileName); // // if the file exists, compare their content // - if (autoGenH.exists()) { - FileReader fIn = new FileReader(autoGenH); - char[] oldFileBuffer = new char[(int) autoGenH.length()]; - fIn.read(oldFileBuffer, 0, (int) autoGenH.length()); + if (autoGenH.exists()) { + char[] oldFileBuffer = new char[(int) autoGenH.length()]; + try { + FileReader fIn = new FileReader(autoGenH); + fIn.read(oldFileBuffer, 0, (int) autoGenH.length()); fIn.close(); + } catch (IOException e) { + EdkLog.log(EdkLog.EDK_INFO, this.moduleId.getName() + + "'s " + + fileName + + " is exist, but can't be open!!"); + return false; + } - // - // if we got the same file, don't re-generate it to prevent - // sources depending on it from re-building - // - if (fileBuffer.toString().compareTo(new String(oldFileBuffer)) == 0) { - return true; - } + // + // if we got the same file, don't re-generate it to prevent + // sources depending on it from re-building + // + if (fileBuffer.toString().compareTo(new String(oldFileBuffer)) == 0) { + return true; } - FileWriter fOut = new FileWriter(autoGenH); + } + + try { + FileWriter fOut = new FileWriter(autoGenH); fOut.write(fileBuffer.toString()); + fOut.flush(); fOut.close(); - } catch (Exception e) { - return false; - } + } catch (IOException e) { + EdkLog.log(EdkLog.EDK_INFO, this.moduleId.getName() + + "'s " + + fileName + + " can't be create!!"); + return false; + } return true; } /** - * genAutogen function - * - * This function call libGenAutoGen or moduleGenAutogen function, which - * dependence on generate library autogen or module autogen. - * - * @throws BuildException - * Failed to creat AutoGen.c & AutoGen.h. - */ + genAutogen function + + This function call libGenAutoGen or moduleGenAutogen function, which + dependence on generate library autogen or module autogen. + + @throws BuildException + Failed to creat AutoGen.c & AutoGen.h. + **/ public void genAutogen() throws BuildException { try { // @@ -212,13 +232,13 @@ public class AutoGen { } /** - * moduleGenAutogen function - * - * This function generates AutoGen.c & AutoGen.h for module. - * - * @throws BuildException - * Faile to create module AutoGen.c & AutoGen.h. - */ + moduleGenAutogen function + + This function generates AutoGen.c & AutoGen.h for module. + + @throws BuildException + Faile to create module AutoGen.c & AutoGen.h. + **/ void moduleGenAutogen() throws BuildException { try { @@ -233,13 +253,13 @@ public class AutoGen { } /** - * libGenAutogen function - * - * This function generates AutoGen.c & AutoGen.h for library. - * - * @throws BuildException - * Faile to create library AutoGen.c & AutoGen.h - */ + libGenAutogen function + + This function generates AutoGen.c & AutoGen.h for library. + + @throws BuildException + Faile to create library AutoGen.c & AutoGen.h + **/ void libGenAutogen() throws BuildException { try { libGenAutogenC(); @@ -252,13 +272,13 @@ public class AutoGen { } /** - * moduleGenAutogenH - * - * This function generates AutoGen.h for module. - * - * @throws BuildException - * Failed to generate AutoGen.h. - */ + moduleGenAutogenH + + This function generates AutoGen.h for module. + + @throws BuildException + Failed to generate AutoGen.h. + **/ void moduleGenAutogenH() throws AutoGenException { Set libClassIncludeH; @@ -271,14 +291,21 @@ public class AutoGen { // // Write Autogen.h header notation // - fileBuffer.append(CommonDefinition.autogenHNotation); + fileBuffer.append(CommonDefinition.AUTOGENHNOTATION); // // Add #ifndef ${BaseName}_AUTOGENH // #def ${BseeName}_AUTOGENH // - fileBuffer.append("#ifndef " + "_AUTOGENH_" + this.moduleId.getGuid().replaceAll("-", "_") +"\r\n"); - fileBuffer.append("#define " + "_AUTOGENH_" + this.moduleId.getGuid().replaceAll("-", "_") +"\r\n\r\n"); + fileBuffer.append(CommonDefinition.IFNDEF + + CommonDefinition.AUTOGENH + + this.moduleId.getGuid().replaceAll("-", "_") + + ToolDefinitions.LINE_SEPARATOR); + fileBuffer.append(CommonDefinition.DEFINE + + CommonDefinition.AUTOGENH + + this.moduleId.getGuid().replaceAll("-", "_") + + ToolDefinitions.LINE_SEPARATOR + + ToolDefinitions.LINE_SEPARATOR); // // Write the specification version and release version at the begine @@ -293,14 +320,14 @@ public class AutoGen { // Add "extern int __make_me_compile_correctly;" at begin of // AutoGen.h. // - fileBuffer.append(CommonDefinition.autoGenHbegin); + fileBuffer.append(CommonDefinition.AUTOGENHBEGIN); // // Put EFI_SPECIFICATION_VERSION, and EDK_RELEASE_VERSION. // String[] specList = SurfaceAreaQuery.getExternSpecificaiton(); for (int i = 0; i < specList.length; i++) { - fileBuffer.append(CommonDefinition.marcDefineStr + specList[i] + fileBuffer.append(CommonDefinition.DEFINE + specList[i] + "\r\n"); } // @@ -322,7 +349,7 @@ public class AutoGen { // Write library class's related *.h file to autogen.h. // String[] libClassList = SurfaceAreaQuery - .getLibraryClasses(CommonDefinition.AlwaysConsumed,this.arch); + .getLibraryClasses(CommonDefinition.ALWAYSCONSUMED,this.arch); if (libClassList != null) { libClassIncludeH = LibraryClassToAutogenH(libClassList); item = libClassIncludeH.iterator(); @@ -332,7 +359,7 @@ public class AutoGen { } libClassList = SurfaceAreaQuery - .getLibraryClasses(CommonDefinition.AlwaysProduced, this.arch); + .getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, this.arch); if (libClassList != null) { libClassIncludeH = LibraryClassToAutogenH(libClassList); item = libClassIncludeH.iterator(); @@ -347,9 +374,9 @@ public class AutoGen { // {DEST_DIR_DRBUG}/FlashMap.h // if (SurfaceAreaQuery.isHaveTianoR8FlashMap()) { - fileBuffer.append(CommonDefinition.include); + fileBuffer.append(CommonDefinition.INCLUDE); fileBuffer.append(" <"); - fileBuffer.append(CommonDefinition.tianoR8FlashMapH + ">\r\n"); + fileBuffer.append(CommonDefinition.TIANOR8PLASHMAPH + ">\r\n"); copyFlashMapHToDebugDir(); } @@ -374,25 +401,25 @@ public class AutoGen { } /** - * moduleGenAutogenC - * - * This function generates AutoGen.c for module. - * - * @throws BuildException - * Failed to generate AutoGen.c. - */ + moduleGenAutogenC + + This function generates AutoGen.c for module. + + @throws BuildException + Failed to generate AutoGen.c. + **/ void moduleGenAutogenC() throws AutoGenException { StringBuffer fileBuffer = new StringBuffer(8192); // // Write Autogen.c header notation // - fileBuffer.append(CommonDefinition.autogenCNotation); + fileBuffer.append(CommonDefinition.AUTOGENCNOTATION); // // Write #include at beginning of AutoGen.c // - fileBuffer.append(CommonDefinition.includeAutogenH); + fileBuffer.append(CommonDefinition.INCLUDEAUTOGENH); // // Get the native MSA file infomation. Since before call autogen, @@ -419,7 +446,10 @@ public class AutoGen { // Write EntryPoint to autgoGen.c // String[] entryPointList = SurfaceAreaQuery.getModuleEntryPointArray(); - EntryPointToAutoGen(CommonDefinition.remDupString(entryPointList), fileBuffer); + String[] unloadImageList = SurfaceAreaQuery.getModuleUnloadImageArray(); + EntryPointToAutoGen(CommonDefinition.remDupString(entryPointList), + CommonDefinition.remDupString(unloadImageList), + fileBuffer); pcdDriverType = SurfaceAreaQuery.getPcdDriverType(); @@ -501,13 +531,13 @@ public class AutoGen { } /** - * libGenAutogenH - * - * This function generates AutoGen.h for library. - * - * @throws BuildException - * Failed to generate AutoGen.c. - */ + libGenAutogenH + + This function generates AutoGen.h for library. + + @throws BuildException + Failed to generate AutoGen.c. + **/ void libGenAutogenH() throws AutoGenException { Set libClassIncludeH; @@ -519,14 +549,21 @@ public class AutoGen { // // Write Autogen.h header notation // - fileBuffer.append(CommonDefinition.autogenHNotation); + fileBuffer.append(CommonDefinition.AUTOGENHNOTATION); // // Add #ifndef ${BaseName}_AUTOGENH // #def ${BseeName}_AUTOGENH // - fileBuffer.append("#ifndef " + "_AUTOGENH_" + this.moduleId.getGuid().replaceAll("-", "_") + "\r\n"); - fileBuffer.append("#define " + "_AUTOGENH_" + this.moduleId.getGuid().replaceAll("-", "_") + "\r\n\r\n"); + fileBuffer.append(CommonDefinition.IFNDEF + + CommonDefinition.AUTOGENH + + this.moduleId.getGuid().replaceAll("-", "_") + + ToolDefinitions.LINE_SEPARATOR); + fileBuffer.append(CommonDefinition.DEFINE + + CommonDefinition.AUTOGENH + + this.moduleId.getGuid().replaceAll("-", "_") + + ToolDefinitions.LINE_SEPARATOR + + ToolDefinitions.LINE_SEPARATOR); // // Write EFI_SPECIFICATION_VERSION and EDK_RELEASE_VERSION @@ -534,10 +571,10 @@ public class AutoGen { // Note: the specification version and release version should // be get from module surface area instead of hard code. // - fileBuffer.append(CommonDefinition.autoGenHbegin); + fileBuffer.append(CommonDefinition.AUTOGENHBEGIN); String[] specList = SurfaceAreaQuery.getExternSpecificaiton(); for (int i = 0; i < specList.length; i++) { - fileBuffer.append(CommonDefinition.marcDefineStr + specList[i] + fileBuffer.append(CommonDefinition.DEFINE + specList[i] + "\r\n"); } // fileBuffer.append(CommonDefinition.autoGenHLine1); @@ -558,7 +595,7 @@ public class AutoGen { // Write library class's related *.h file to autogen.h // String[] libClassList = SurfaceAreaQuery - .getLibraryClasses(CommonDefinition.AlwaysConsumed, this.arch); + .getLibraryClasses(CommonDefinition.ALWAYSCONSUMED, this.arch); if (libClassList != null) { libClassIncludeH = LibraryClassToAutogenH(libClassList); item = libClassIncludeH.iterator(); @@ -568,7 +605,7 @@ public class AutoGen { } libClassList = SurfaceAreaQuery - .getLibraryClasses(CommonDefinition.AlwaysProduced, this.arch); + .getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, this.arch); if (libClassList != null) { libClassIncludeH = LibraryClassToAutogenH(libClassList); item = libClassIncludeH.iterator(); @@ -576,16 +613,16 @@ public class AutoGen { fileBuffer.append(item.next().toString()); } } - fileBuffer.append("\r\n"); + fileBuffer.append(ToolDefinitions.LINE_SEPARATOR); // // If is TianoR8FlashMap, copy {Fv_DIR}/FlashMap.h to // {DEST_DIR_DRBUG}/FlashMap.h // if (SurfaceAreaQuery.isHaveTianoR8FlashMap()) { - fileBuffer.append(CommonDefinition.include); + fileBuffer.append(CommonDefinition.INCLUDE); fileBuffer.append(" <"); - fileBuffer.append(CommonDefinition.tianoR8FlashMapH + ">\r\n"); + fileBuffer.append(CommonDefinition.TIANOR8PLASHMAPH + ">\r\n"); copyFlashMapHToDebugDir(); } @@ -611,23 +648,23 @@ public class AutoGen { } /** - * libGenAutogenC - * - * This function generates AutoGen.h for library. - * - * @throws BuildException - * Failed to generate AutoGen.c. - */ + libGenAutogenC + + This function generates AutoGen.h for library. + + @throws BuildException + Failed to generate AutoGen.c. + **/ void libGenAutogenC() throws BuildException, PcdAutogenException { StringBuffer fileBuffer = new StringBuffer(10240); // // Write Autogen.c header notation // - fileBuffer.append(CommonDefinition.autogenCNotation); + fileBuffer.append(CommonDefinition.AUTOGENCNOTATION); - fileBuffer.append(CommonDefinition.autoGenCLine1); - fileBuffer.append("\r\n"); + fileBuffer.append(ToolDefinitions.LINE_SEPARATOR); + fileBuffer.append(ToolDefinitions.LINE_SEPARATOR); // // Call pcd autogen. @@ -644,7 +681,7 @@ public class AutoGen { } if (this.myPcdAutogen != null) { - fileBuffer.append("\r\n"); + fileBuffer.append(ToolDefinitions.LINE_SEPARATOR); fileBuffer.append(this.myPcdAutogen.getCAutoGenString()); } @@ -654,20 +691,20 @@ public class AutoGen { } /** - * LibraryClassToAutogenH - * - * This function returns *.h files declared by library classes which are - * consumed or produced by current build module or library. - * - * @param libClassList - * List of library class which consumed or produce by current - * build module or library. - * @return includeStrList List of *.h file. - */ + LibraryClassToAutogenH + + This function returns *.h files declared by library classes which are + consumed or produced by current build module or library. + + @param libClassList + List of library class which consumed or produce by current + build module or library. + @return includeStrList List of *.h file. + **/ Set LibraryClassToAutogenH(String[] libClassList) throws AutoGenException { - Set includStrList = new LinkedHashSet(); - String includerName[]; + Set includeStrList = new LinkedHashSet(); + String includeName[]; String str = ""; // @@ -675,37 +712,37 @@ public class AutoGen { // library class name. // for (int i = 0; i < libClassList.length; i++) { - includerName = GlobalData.getLibraryClassHeaderFiles( + includeName = GlobalData.getLibraryClassHeaderFiles( SurfaceAreaQuery.getDependencePkg(this.arch), libClassList[i]); - if (includerName == null) { + if (includeName == null) { throw new AutoGenException("Can not find library class [" + libClassList[i] + "] declaration in any SPD package. "); } - for (int j = 0; j < includerName.length; j++) { - String includeNameStr = includerName[j]; + for (int j = 0; j < includeName.length; j++) { + String includeNameStr = includeName[j]; if (includeNameStr != null) { - str = CommonDefinition.include + " " + "<"; + str = CommonDefinition.INCLUDE + " " + "<"; str = str + includeNameStr + ">\r\n"; - includStrList.add(str); + includeStrList.add(str); includeNameStr = null; } } } - return includStrList; + return includeStrList; } /** - * IncludesToAutogenH - * - * This function add include file in AutoGen.h file. - * - * @param packageNameList - * List of module depended package. - * @param moduleType - * Module type. - * @return - */ + IncludesToAutogenH + + This function add include file in AutoGen.h file. + + @param packageNameList + List of module depended package. + @param moduleType + Module type. + @return + **/ List depPkgToAutogenH(PackageIdentification[] packageNameList, String moduleType) throws AutoGenException { @@ -724,7 +761,7 @@ public class AutoGen { + packageNameList[i] + "] declaration in any SPD package. "); } else if (!pkgHeader.equalsIgnoreCase("")) { - includeStr = CommonDefinition.include + " <" + pkgHeader + includeStr = CommonDefinition.INCLUDE + " <" + pkgHeader + ">\r\n"; includeStrList.add(includeStr); } @@ -734,21 +771,23 @@ public class AutoGen { } /** - * EntryPointToAutoGen - * - * This function convert & - * information in mas to AutoGen.c - * - * @param entryPointList - * List of entry point. - * @param fileBuffer - * String buffer fo AutoGen.c. - * @throws Exception - */ - void EntryPointToAutoGen(String[] entryPointList, StringBuffer fileBuffer) + EntryPointToAutoGen + + This function convert & + information in mas to AutoGen.c + + @param entryPointList + List of entry point. + @param fileBuffer + String buffer fo AutoGen.c. + @throws Exception + **/ + void EntryPointToAutoGen(String[] entryPointList, String[] unloadImageList, StringBuffer fileBuffer) throws BuildException { String typeStr = SurfaceAreaQuery.getModuleType(); + int unloadImageCount = 0; + int entryPointCount = 0; // // The parameters and return value of entryPoint is difference @@ -815,7 +854,7 @@ public class AutoGen { break; case CommonDefinition.ModuleTypePeim: - int entryPointCount = 0; + entryPointCount = 0; fileBuffer .append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = 0;\r\n"); if (entryPointList == null || entryPointList.length == 0) { @@ -960,26 +999,27 @@ public class AutoGen { // // Add "ModuleUnloadImage" for DxeSmmDriver module type; // - entryPointList = SurfaceAreaQuery.getModuleUnloadImageArray(); - entryPointList = CommonDefinition.remDupString(entryPointList); - entryPointCount = 0; + //entryPointList = SurfaceAreaQuery.getModuleUnloadImageArray(); + //entryPointList = CommonDefinition.remDupString(entryPointList); + //entryPointCount = 0; - if (entryPointList != null) { - for (int i = 0; i < entryPointList.length; i++) { + unloadImageCount = 0; + if (unloadImageList != null) { + for (int i = 0; i < unloadImageList.length; i++) { fileBuffer.append("EFI_STATUS\r\n"); fileBuffer.append("EFIAPI\r\n"); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append(" (\r\n"); fileBuffer .append(" IN EFI_HANDLE ImageHandle\r\n"); fileBuffer.append(" );\r\n"); - entryPointCount++; + unloadImageCount++; } } fileBuffer .append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = "); - fileBuffer.append(Integer.toString(entryPointCount)); + fileBuffer.append(Integer.toString(unloadImageCount)); fileBuffer.append(";\r\n\r\n"); fileBuffer.append("EFI_STATUS\r\n"); @@ -989,28 +1029,28 @@ public class AutoGen { fileBuffer.append(" )\r\n"); fileBuffer.append("{\r\n"); - if (entryPointCount == 0) { + if (unloadImageCount == 0) { fileBuffer.append(" return EFI_SUCCESS;\r\n"); - } else if (entryPointCount == 1) { + } else if (unloadImageCount == 1) { fileBuffer.append(" return "); - fileBuffer.append(entryPointList[0]); + fileBuffer.append(unloadImageList[0]); fileBuffer.append("(ImageHandle);\r\n"); } else { fileBuffer.append(" EFI_STATUS Status;\r\n\r\n"); fileBuffer.append(" Status = EFI_SUCCESS;\r\n\r\n"); - for (int i = 0; i < entryPointList.length; i++) { + for (int i = 0; i < unloadImageList.length; i++) { if (i == 0) { fileBuffer.append(" Status = "); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append("(ImageHandle);\r\n"); } else { fileBuffer.append(" if (EFI_ERROR (Status)) {\r\n"); fileBuffer.append(" "); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append("(ImageHandle);\r\n"); fileBuffer.append(" } else {\r\n"); fileBuffer.append(" Status = "); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append("(ImageHandle);\r\n"); fileBuffer.append(" }\r\n"); } @@ -1126,28 +1166,29 @@ public class AutoGen { // // Add ModuleUnloadImage for DxeDriver and UefiDriver module type. // - entryPointList = SurfaceAreaQuery.getModuleUnloadImageArray(); + //entryPointList = SurfaceAreaQuery.getModuleUnloadImageArray(); // // Remover duplicate unload entry point. // - entryPointList = CommonDefinition.remDupString(entryPointList); - entryPointCount = 0; - if (entryPointList != null) { - for (int i = 0; i < entryPointList.length; i++) { + //entryPointList = CommonDefinition.remDupString(entryPointList); + //entryPointCount = 0; + unloadImageCount = 0; + if (unloadImageList != null) { + for (int i = 0; i < unloadImageList.length; i++) { fileBuffer.append("EFI_STATUS\r\n"); fileBuffer.append("EFIAPI\r\n"); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append(" (\r\n"); fileBuffer .append(" IN EFI_HANDLE ImageHandle\r\n"); fileBuffer.append(" );\r\n"); - entryPointCount++; + unloadImageCount++; } } fileBuffer .append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = "); - fileBuffer.append(Integer.toString(entryPointCount)); + fileBuffer.append(Integer.toString(unloadImageCount)); fileBuffer.append(";\r\n\r\n"); fileBuffer.append("EFI_STATUS\n"); @@ -1157,28 +1198,28 @@ public class AutoGen { fileBuffer.append(" )\r\n"); fileBuffer.append("{\r\n"); - if (entryPointCount == 0) { + if (unloadImageCount == 0) { fileBuffer.append(" return EFI_SUCCESS;\r\n"); - } else if (entryPointCount == 1) { + } else if (unloadImageCount == 1) { fileBuffer.append(" return "); - fileBuffer.append(entryPointList[0]); + fileBuffer.append(unloadImageList[0]); fileBuffer.append("(ImageHandle);\r\n"); } else { fileBuffer.append(" EFI_STATUS Status;\r\n\r\n"); fileBuffer.append(" Status = EFI_SUCCESS;\r\n\r\n"); - for (int i = 0; i < entryPointList.length; i++) { + for (int i = 0; i < unloadImageList.length; i++) { if (i == 0) { fileBuffer.append(" Status = "); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append("(ImageHandle);\r\n"); } else { fileBuffer.append(" if (EFI_ERROR (Status)) {\r\n"); fileBuffer.append(" "); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append("(ImageHandle);\r\n"); fileBuffer.append(" } else {\r\n"); fileBuffer.append(" Status = "); - fileBuffer.append(entryPointList[i]); + fileBuffer.append(unloadImageList[i]); fileBuffer.append("(ImageHandle);\r\n"); fileBuffer.append(" }\r\n"); } @@ -1191,16 +1232,16 @@ public class AutoGen { } /** - * PpiGuidToAutogenc - * - * This function gets GUIDs from SPD file accrodeing to information - * and write those GUIDs to AutoGen.c. - * - * @param fileBuffer - * String Buffer for Autogen.c file. - * @throws BuildException - * Guid must set value! - */ + PpiGuidToAutogenc + + This function gets GUIDs from SPD file accrodeing to information + and write those GUIDs to AutoGen.c. + + @param fileBuffer + String Buffer for Autogen.c file. + @throws BuildException + Guid must set value! + **/ void PpiGuidToAutogenC(StringBuffer fileBuffer) throws AutoGenException { String[] cNameGuid = null; @@ -1245,16 +1286,16 @@ public class AutoGen { } /** - * ProtocolGuidToAutogenc - * - * This function gets GUIDs from SPD file accrodeing to - * information and write those GUIDs to AutoGen.c. - * - * @param fileBuffer - * String Buffer for Autogen.c file. - * @throws BuildException - * Protocol name must set. - */ + ProtocolGuidToAutogenc + + This function gets GUIDs from SPD file accrodeing to + information and write those GUIDs to AutoGen.c. + + @param fileBuffer + String Buffer for Autogen.c file. + @throws BuildException + Protocol name must set. + **/ void ProtocolGuidToAutogenC(StringBuffer fileBuffer) throws BuildException { String[] cNameGuid = null; @@ -1302,15 +1343,15 @@ public class AutoGen { } /** - * GuidGuidToAutogenc - * - * This function gets GUIDs from SPD file accrodeing to information - * and write those GUIDs to AutoGen.c. - * - * @param fileBuffer - * String Buffer for Autogen.c file. - * - */ + GuidGuidToAutogenc + + This function gets GUIDs from SPD file accrodeing to information + and write those GUIDs to AutoGen.c. + + @param fileBuffer + String Buffer for Autogen.c file. + + **/ void GuidGuidToAutogenC(StringBuffer fileBuffer) throws AutoGenException { String[] cNameGuid = null; String guidKeyWord = null; @@ -1346,16 +1387,16 @@ public class AutoGen { } /** - * LibInstanceToAutogenC - * - * This function adds dependent library instance to autogen.c,which - * includeing library's constructor, destructor, and library dependent ppi, - * protocol, guid, pcd information. - * - * @param fileBuffer - * String buffer for AutoGen.c - * @throws BuildException - */ + LibInstanceToAutogenC + + This function adds dependent library instance to autogen.c,which + includeing library's constructor, destructor, and library dependent ppi, + protocol, guid, pcd information. + + @param fileBuffer + String buffer for AutoGen.c + @throws BuildException + **/ void LibInstanceToAutogenC(StringBuffer fileBuffer) throws BuildException { try { String moduleType = this.moduleId.getModuleType(); @@ -1374,19 +1415,19 @@ public class AutoGen { } /** - * LibConstructorToAutogenc - * - * This function writes library constructor list to AutoGen.c. The library - * constructor's parameter and return value depend on module type. - * - * @param libInstanceList - * List of library construct name. - * @param moduleType - * Module type. - * @param fileBuffer - * String buffer for AutoGen.c - * @throws Exception - */ + LibConstructorToAutogenc + + This function writes library constructor list to AutoGen.c. The library + constructor's parameter and return value depend on module type. + + @param libInstanceList + List of library construct name. + @param moduleType + Module type. + @param fileBuffer + String buffer for AutoGen.c + @throws Exception + **/ void LibConstructorToAutogenC(List libInstanceList, String moduleType, StringBuffer fileBuffer) throws Exception { boolean isFirst = true; @@ -1515,19 +1556,19 @@ public class AutoGen { } /** - * LibDestructorToAutogenc - * - * This function writes library destructor list to AutoGen.c. The library - * destructor's parameter and return value depend on module type. - * - * @param libInstanceList - * List of library destructor name. - * @param moduleType - * Module type. - * @param fileBuffer - * String buffer for AutoGen.c - * @throws Exception - */ + LibDestructorToAutogenc + + This function writes library destructor list to AutoGen.c. The library + destructor's parameter and return value depend on module type. + + @param libInstanceList + List of library destructor name. + @param moduleType + Module type. + @param fileBuffer + String buffer for AutoGen.c + @throws Exception + **/ void LibDestructorToAutogenC(List libInstanceList, String moduleType, StringBuffer fileBuffer) throws Exception { boolean isFirst = true; @@ -1615,14 +1656,14 @@ public class AutoGen { } /** - * ExternsDriverBindingToAutoGenC - * - * This function is to write DRIVER_BINDING, COMPONENT_NAME, - * DRIVER_CONFIGURATION, DRIVER_DIAGNOSTIC in AutoGen.c. - * - * @param fileBuffer - * String buffer for AutoGen.c - */ + ExternsDriverBindingToAutoGenC + + This function is to write DRIVER_BINDING, COMPONENT_NAME, + DRIVER_CONFIGURATION, DRIVER_DIAGNOSTIC in AutoGen.c. + + @param fileBuffer + String buffer for AutoGen.c + **/ void ExternsDriverBindingToAutoGenC(StringBuffer fileBuffer) throws BuildException { @@ -1769,15 +1810,15 @@ public class AutoGen { } /** - * ExternCallBackToAutoGenC - * - * This function adds and - * infomation to AutoGen.c - * - * @param fileBuffer - * String buffer for AutoGen.c - * @throws BuildException - */ + ExternCallBackToAutoGenC + + This function adds and + infomation to AutoGen.c + + @param fileBuffer + String buffer for AutoGen.c + @throws BuildException + **/ void ExternCallBackToAutoGenC(StringBuffer fileBuffer) throws BuildException { // @@ -1973,12 +2014,21 @@ public class AutoGen { } + /** + copyFlashMapHToDebugDir + + This function is to copy the falshmap.h to debug directory and change + its name to TianoR8FlashMap.h + + @param + @return + **/ private void copyFlashMapHToDebugDir() throws AutoGenException{ - File inFile = new File(fvDir + File.separatorChar + CommonDefinition.flashMapH); + File inFile = new File(fvDir + File.separatorChar + CommonDefinition.FLASHMAPH); int size = (int)inFile.length(); byte[] buffer = new byte[size]; - File outFile = new File (this.outputPath + File.separatorChar + CommonDefinition.tianoR8FlashMapH); + File outFile = new File (this.outputPath + File.separatorChar + CommonDefinition.TIANOR8PLASHMAPH); // // If TianoR8FlashMap.h existed and the flashMap.h don't change, // do nothing. @@ -2002,11 +2052,13 @@ public class AutoGen { } /** - *This function first order the library instances, then collect - *library instance 's PPI, Protocol, GUID, - *SetVirtalAddressMapCallBack, ExitBootServiceCallBack, and - *Destructor, Constructor. - * + This function first order the library instances, then collect + library instance 's PPI, Protocol, GUID, + SetVirtalAddressMapCallBack, ExitBootServiceCallBack, and + Destructor, Constructor. + + @param + @return **/ private void collectLibInstanceInfo(){ int index; diff --git a/Tools/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java b/Tools/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java index 403b8c32ee..9fb7a43ce9 100644 --- a/Tools/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java +++ b/Tools/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java @@ -22,7 +22,6 @@ import java.util.List; import java.util.Map; import org.apache.xmlbeans.XmlObject; - import org.tianocore.build.global.GlobalData; import org.tianocore.build.global.SurfaceAreaQuery; import org.tianocore.build.id.ModuleIdentification; @@ -75,7 +74,7 @@ public class AutogenLibOrder { // libInstanceMap. // libClassConsmList = SurfaceAreaQuery - .getLibraryClasses(CommonDefinition.AlwaysConsumed, arch); + .getLibraryClasses(CommonDefinition.ALWAYSCONSUMED, arch); if (libClassConsmList != null) { String[] classStr = new String[libClassConsmList.length]; for (int k = 0; k < libClassConsmList.length; k++) { @@ -94,7 +93,7 @@ public class AutogenLibOrder { // Add library class and library instance map. // libClassDeclList = SurfaceAreaQuery - .getLibraryClasses(CommonDefinition.AlwaysProduced, arch); + .getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, arch); if (libClassDeclList != null) { for (int j = 0; j < libClassDeclList.length; j++) { if (this.libClassMap.containsKey(libClassDeclList[j])) { @@ -114,12 +113,12 @@ public class AutogenLibOrder { // // Check is the library instance list meet the require; // - for (int s = 0; s < this.libInstanceList.size(); s++) { - String[] libClass = this.libInstanceMap.get(this.libInstanceList - .get(s)); - if (libClass != null) { - for (int t = 0; t < libClass.length; t++) { - if (this.libClassMap.get(libClass[t]) == null) { + //for (int s = 0; s < this.libInstanceList.size(); s++) { + // String[] libClass = this.libInstanceMap.get(this.libInstanceList + // .get(s)); + // if (libClass != null) { + // for (int t = 0; t < libClass.length; t++) { + // if (this.libClassMap.get(libClass[t]) == null) { // // Note: There exist a kind of module which depend on // library class with no instance or whose instance will @@ -130,10 +129,10 @@ public class AutogenLibOrder { // will be a warnig message given here after a standard // log way has been decided. // - } - } - } - } + // } + // } + // } + //} } /** diff --git a/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java b/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java index 3d0bf7ab34..cb750ffd47 100644 --- a/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java +++ b/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java @@ -18,7 +18,8 @@ package org.tianocore.build.autogen; import java.util.Iterator; import java.util.LinkedHashSet; import java.util.Set; - +import org.tianocore.common.definitions.EdkDefinitions; +import org.tianocore.common.definitions.ToolDefinitions; /** CommonDefinition @@ -27,88 +28,119 @@ import java.util.Set; **/ public class CommonDefinition { - public final static String LibraryStr = "LIBRARY"; - public final static String autoGenHbegin = "extern int __make_me_compile_correctly;\r\n"; - public final static String include = "#include"; - public final static String autoGenCLine1 = "\r\n"; + /// + /// final static string + /// + public final static String LIBRARY = "LIBRARY"; + + public final static String AUTOGENHBEGIN = "extern int __make_me_compile_correctly;" + + ToolDefinitions.LINE_SEPARATOR; + + public final static String INCLUDE = "#include"; + + //public final static String DEBUGPROPERYMASK = "const UINT8 _gDebugPropertyMask " + // + "= DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED" + // + " | DEBUG_PROPERTY_DEBUG_PRINT_ENABLED" + // + " | DEBUG_PROPERTY_DEBUG_CODE_ENABLED;" + // + ToolDefinitions.LINE_SEPARATOR; + + //public final static String DEFAULERROLEVEL = "const UINTN _gModuleDefaultErrorLevel" + // + " = EFI_D_ERROR | EFI_D_LOAD;" + // + ToolDefinitions.LINE_SEPARATOR; + + + public final static String INCLUDEAUTOGENH = INCLUDE + + " " + + ToolDefinitions.LINE_SEPARATOR; + + public final static String DEFINE = "#define "; + + public final static String GEFI = "gEfi"; - public final static String autoGenCLine2 = "const UINT8 _gDebugPropertyMask " - + "= DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED" - + " | DEBUG_PROPERTY_DEBUG_PRINT_ENABLED" - + " | DEBUG_PROPERTY_DEBUG_CODE_ENABLED;\r\n"; + public final static String PRTOCOLGUID = "ProtocolGuid"; - public final static String autoGenCLine3 = "const UINTN _gModuleDefaultErrorLevel" - + " = EFI_D_ERROR | EFI_D_LOAD;\r\n"; + public final static String PPIGUID = "PpiGuid"; - public final static String autoGenHLine1 = "#define EFI_SPECIFICATION_VERSION 0x00020000\r\n"; - public final static String autoGenHVersionDefault = "#define EFI_SPECIFICATION_VERSION 0x00000000\r\n"; - public final static String autoGenHLine2 = "#define EDK_RELEASE_VERSION 0x00090000\r\n"; - public final static String autoGenHReleaseDefault = "#define EDK_RELEASE_VERSION 0x00000000\r\n"; + public final static String GUID = "Guid"; - public final static String includeAutogenH = "#include \r\n" ; - public final static String marcDefineStr = "#define "; + public final static String TIANOR8PLASHMAPH = "TianoR8FlashMap.h"; - public final static String gEfi = "gEfi"; - public final static String protocolGuid = "ProtocolGuid"; - public final static String ppiGuid = "PpiGuid"; - public final static String guidGuid = "Guid"; + public final static String FLASHMAPH = "FlashMap.h"; - public final static String tianoR8FlashMapH = "TianoR8FlashMap.h"; - public final static String flashMapH = "FlashMap.h"; + public final static String IFNDEF = "#ifndef "; + + public final static String AUTOGENH = "_AUTOGENH_"; + + + /// + /// AutoGen.h and AutoGen.c file's header + /// + public final static String AUTOGENHNOTATION = "/**" + + ToolDefinitions.LINE_SEPARATOR + + " DO NOT EDIT" + + ToolDefinitions.LINE_SEPARATOR + + " FILE auto-generated by GenBuild tasks" + + ToolDefinitions.LINE_SEPARATOR + + " Module name:" + + ToolDefinitions.LINE_SEPARATOR + + " AutoGen.h" + + ToolDefinitions.LINE_SEPARATOR + + " Abstract:" + + " Auto-generated AutoGen.h for building module or library." + + ToolDefinitions.LINE_SEPARATOR + + "**/" + + ToolDefinitions.LINE_SEPARATOR + + ToolDefinitions.LINE_SEPARATOR; + + public final static String AUTOGENCNOTATION = "/**" + + ToolDefinitions.LINE_SEPARATOR + + " DO NOT EDIT" + + ToolDefinitions.LINE_SEPARATOR + + " FILE auto-generated by GenBuild tasks" + + ToolDefinitions.LINE_SEPARATOR + + " Module name:" + + ToolDefinitions.LINE_SEPARATOR + + " AutoGen.c" + + ToolDefinitions.LINE_SEPARATOR + + " Abstract:" + + " Auto-generated AutoGen.c for building module or library." + + ToolDefinitions.LINE_SEPARATOR + + "**/" + + ToolDefinitions.LINE_SEPARATOR + + ToolDefinitions.LINE_SEPARATOR; /// /// The defintions for identifying current module /// is PEI Pcd driver or Dxe Pcd driver. /// public static enum PCD_DRIVER_TYPE { NOT_PCD_DRIVER, - PEI_PCD_DRIVER, - DXE_PCD_DRIVER, - UNKNOWN_PCD_DRIVER}; + PEI_PCD_DRIVER, + DXE_PCD_DRIVER, + UNKNOWN_PCD_DRIVER + }; - /// - /// AutoGen.h and AutoGen.c file's header - /// - public final static String autogenHNotation = - "/**\r\n" + - " DO NOT EDIT\r\n" + - " FILE auto-generated by GenBuild tasks\r\n" + - " Module name:\r\n" + - " AutoGen.h\r\n" + - " Abstract:" + - " Auto-generated AutoGen.h for building module or library.\r\n" + - "**/\r\n\r\n"; - - public final static String autogenCNotation = - "/**\r\n" + - " DO NOT EDIT\r\n" + - " FILE auto-generated by GenBuild tasks\r\n" + - " Module name:\r\n" + - " AutoGen.c\r\n" + - " Abstract:" + - " Auto-generated AutoGen.c for building module or library.\r\n" + - "**/\r\n\r\n"; /// /// module type /// - public final static int ModuleTypeBase = 0; - public final static int ModuleTypeSec = 1; - public final static int ModuleTypePeiCore = 2; - public final static int ModuleTypePeim = 3; - public final static int ModuleTypeDxeCore = 4; - public final static int ModuleTypeDxeDriver = 5; + public final static int ModuleTypeBase = 0; + public final static int ModuleTypeSec = 1; + public final static int ModuleTypePeiCore = 2; + public final static int ModuleTypePeim = 3; + public final static int ModuleTypeDxeCore = 4; + public final static int ModuleTypeDxeDriver = 5; public final static int ModuleTypeDxeRuntimeDriver = 6; - public final static int ModuleTypeDxeSmmDriver = 7; - public final static int ModuleTypeDxeSalDriver = 8; - public final static int ModuleTypeUefiDriver = 9; - public final static int ModuleTypeUefiApplication = 10; - public final static int ModuleTypeUnknown = 11; + public final static int ModuleTypeDxeSmmDriver = 7; + public final static int ModuleTypeDxeSalDriver = 8; + public final static int ModuleTypeUefiDriver = 9; + public final static int ModuleTypeUefiApplication = 10; + public final static int ModuleTypeUnknown = 11; /// /// Usaged style /// - public final static String AlwaysConsumed = "ALWAYS_CONSUMED"; - public final static String AlwaysProduced = "ALWAYS_PRODUCED"; + public final static String ALWAYSCONSUMED = "ALWAYS_CONSUMED"; + public final static String ALWAYSPRODUCED = "ALWAYS_PRODUCED"; public static class MyEnum { @@ -132,17 +164,17 @@ public class CommonDefinition { /// Module type /// public static final MyEnum[] moduleEnum = new MyEnum[] { - new MyEnum("BASE", ModuleTypeBase), - new MyEnum("SEC", ModuleTypeSec), - new MyEnum("PEI_CORE", ModuleTypePeiCore), - new MyEnum("PEIM", ModuleTypePeim), - new MyEnum("DXE_CORE", ModuleTypeDxeCore), - new MyEnum("DXE_DRIVER", ModuleTypeDxeDriver), - new MyEnum("DXE_RUNTIME_DRIVER", ModuleTypeDxeRuntimeDriver), - new MyEnum("DXE_SAL_DRIVER", ModuleTypeDxeSalDriver), - new MyEnum("DXE_SMM_DRIVER", ModuleTypeDxeSmmDriver), - new MyEnum("UEFI_DRIVER", ModuleTypeUefiDriver), - new MyEnum("UEFI_APPLICATION", ModuleTypeUefiApplication)}; + new MyEnum(EdkDefinitions.MODULE_TYPE_BASE, ModuleTypeBase), + new MyEnum(EdkDefinitions.MODULE_TYPE_SEC, ModuleTypeSec), + new MyEnum(EdkDefinitions.MODULE_TYPE_PEI_CORE, ModuleTypePeiCore), + new MyEnum(EdkDefinitions.MODULE_TYPE_PEIM, ModuleTypePeim), + new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_CORE, ModuleTypeDxeCore), + new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_DRIVER, ModuleTypeDxeDriver), + new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_RUNTIME_DRIVER, ModuleTypeDxeRuntimeDriver), + new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_SAL_DRIVER, ModuleTypeDxeSalDriver), + new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_SMM_DRIVER, ModuleTypeDxeSmmDriver), + new MyEnum(EdkDefinitions.MODULE_TYPE_UEFI_DRIVER, ModuleTypeUefiDriver), + new MyEnum(EdkDefinitions.MODULE_TYPE_UEFI_APPLICATION, ModuleTypeUefiApplication)}; /** getModuleType @@ -152,7 +184,7 @@ public class CommonDefinition { @param moduleTypeStr String of modlue type. @return **/ - static public int getModuleType(String moduleTypeStr) { + public static int getModuleType(String moduleTypeStr) { int returnValue = -1; for (int i = 0; i < CommonDefinition.moduleEnum.length; i++) { returnValue = CommonDefinition.moduleEnum[i].ForInt(moduleTypeStr); -- 2.39.5