Fixed one dead loop issue in the autogenlib.

[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / autogen / AutogenLibOrder.java

diff --git a/Tools/Java/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java b/Tools/Java/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java
index 6d6794d474e0931e460669c37ee194c50d43724c..37c54f50af2862a6948c7ae48faf3ed14a52bc9f 100644 (file)
--- a/Tools/Java/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java
+++ b/Tools/Java/Source/GenBuild/org/tianocore/build/autogen/AutogenLibOrder.java
@@ -1,15 +1,15 @@
 /**@file\r
  AutogenLibOrder class.\r
 \r
- This class is to reorder library instance sequence according to library \r
+ This class is to reorder library instance sequence according to library\r
  dependence.\r
- \r
+\r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. 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
- \r
+\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
@@ -62,12 +62,12 @@ public class AutogenLibOrder {
     /// String[1] is libraryConstructor name, String[2] is libDestructor name.\r
     ///\r
     private ModuleIdentification[] libInstanceList = null;\r
-    \r
+\r
     /**\r
       Constructor function\r
-    \r
+\r
       This function mainly initialize some member variable.\r
-     \r
+\r
       @param  libraryList   List of the library instance.\r
       @throws Exception\r
     **/\r
@@ -76,30 +76,22 @@ public class AutogenLibOrder {
         String[]       libClassDeclList = null;\r
         String[]       libClassConsmList = null;\r
 \r
-        libInstanceList = new ModuleIdentification[libraryList.length];\r
+        libInstanceList = libraryList;\r
         for (int i = 0; i < libraryList.length; i++) {\r
             libInstance = libraryList[i];\r
-            libInstanceList[i] = libInstance;\r
             //\r
-            // Add libraryInstance in to libInstanceList.\r
-            // \r
+            // Fetch the constructor & destructor.\r
+            //\r
             Map<String, XmlObject> libDoc = GlobalData.getDoc(libInstance, arch);\r
             SurfaceAreaQuery saq = new SurfaceAreaQuery(libDoc);\r
             libInstance.setConstructor(saq.getLibConstructorName());\r
             libInstance.setDestructor(saq.getLibDestructorName());\r
-            \r
+\r
             //\r
-            // Add library instance and consumed library class list to\r
-            // libInstanceConsumes.\r
+            // Create library class consume database.\r
             //\r
             libClassConsmList = saq.getLibraryClasses(CommonDefinition.ALWAYSCONSUMED, arch);\r
             if (libClassConsmList != null) {\r
-                /*\r
-                String[] classStr = new String[libClassConsmList.length];\r
-                for (int k = 0; k < libClassConsmList.length; k++) {\r
-                    classStr[k] = libClassConsmList[k];\r
-                }\r
-                */\r
                 if (this.libInstanceConsumes.containsKey(libInstance)) {\r
                     throw new AutoGenException(\r
                             libraryList[i].getName()\r
@@ -110,7 +102,7 @@ public class AutogenLibOrder {
             }\r
 \r
             //\r
-            // Add library class and library instance map.\r
+            // Create library class implementer database\r
             //\r
             libClassDeclList = saq.getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, arch);\r
             if (libClassDeclList != null) {\r
@@ -129,6 +121,9 @@ public class AutogenLibOrder {
             }\r
         }\r
 \r
+        //\r
+        // Create a consumed-by database\r
+        //\r
         for (Iterator it = libClassProducer.keySet().iterator(); it.hasNext();) {\r
             String className = (String)it.next();\r
             libInstance = libClassProducer.get(className);\r
@@ -150,8 +145,8 @@ public class AutogenLibOrder {
     /**\r
       orderLibInstance\r
 \r
-      This function reorder the library instance according the library class \r
-      dependency.\r
+      This function reorder the library instance according the library class\r
+      dependency, using DAG anaylysis algothim\r
 \r
       @return     List which content the ordered library instance.\r
     **/\r
@@ -159,6 +154,9 @@ public class AutogenLibOrder {
         LinkedList<ModuleIdentification> orderList = new LinkedList<ModuleIdentification>();\r
         LinkedList<ModuleIdentification> noConsumerList = new LinkedList<ModuleIdentification>();\r
 \r
+        //\r
+        // First, add the library instance without consumers to the Q\r
+        //\r
         for (int i = 0; i < libInstanceList.length; ++i) {\r
             if (libInstanceConsumedBy.get(libInstanceList[i]).size() == 0) {\r
                 noConsumerList.add(libInstanceList[i]);\r
@@ -176,6 +174,10 @@ public class AutogenLibOrder {
                     continue;\r
                 }\r
                 HashSet<ModuleIdentification> consumedBy = libInstanceConsumedBy.get(m);\r
+                if (consumedBy.size() == 0) {\r
+                  continue;\r
+                }\r
+\r
                 consumedBy.remove(n);\r
                 if (consumedBy.size() == 0) {\r
                     noConsumerList.addLast(m);\r
@@ -202,10 +204,11 @@ public class AutogenLibOrder {
                         if (consumer.hasConstructor()) {\r
                             continue;\r
                         }\r
+\r
                         //\r
-                        // if there's no constructor in the library instance's consumer, \r
+                        // if there's no constructor in the library instance's consumer,\r
                         // remove it from the consumer list\r
-                        // \r
+                        //\r
                         consumedBy.remove(consumer);\r
                         circularlyConsumed = false;\r
                         if (consumedBy.size() == 0) {\r
@@ -218,10 +221,23 @@ public class AutogenLibOrder {
                         break;\r
                     }\r
                 }\r
+\r
+                if (noConsumerList.size() == 0 && !circularlyConsumed) {\r
+                  break;\r
+                }\r
             }\r
         }\r
 \r
+        //\r
+        // Append the remaining library instance to the end of sorted list\r
+        //\r
         for (int i = 0; i < libInstanceList.length; ++i) {\r
+            if (libInstanceConsumedBy.get(libInstanceList[i]).size() > 0 && libInstanceList[i].hasConstructor()) {\r
+                EdkLog.log(EdkLog.EDK_ERROR, libInstanceList[i].getName()\r
+                           + " with constructor has a circular dependency!");\r
+                throw new AutoGenException("Circular dependency in library instances is found!");\r
+            }\r
+\r
             if (!orderList.contains(libInstanceList[i])) {\r
                 orderList.add(libInstanceList[i]);\r
             }\r