[Library Ordering] Add an AutoDependenciesOrder option to projects that will allow them to opt into ordering their ouputs in dependency order.

* This is useful on linux platforms where link order matters more.

Author: kudaba

Sharpmake/Project.Configuration.cs

@@ -1080,6 +1080,13 @@ public Options.Vc.Compiler.Exceptions GetExceptionSettingForFile(string filename
                 return Sharpmake.Options.Vc.Compiler.Exceptions.Disable;
             }
 
+            /// <summary>
+            /// When enabled dependendent libraries will be sorted by their dependencies. This can be
+            /// used to fix linker errors on linux platforms that expect libraries to be included in a
+            /// specific order
+            /// </summary>
+            public bool AutoDependenciesOrder = false;
+
             /// <summary>
             /// Gets a list of the search directories for static libraries.
             /// </summary>
@@ -1151,7 +1158,7 @@ public void AddDependencyBuiltTargetLibraryFile(string libraryFile, int orderNum
             {
                 if (_linkState != LinkState.Linking)
                     throw new Error($"Cannot add built target lib '{libraryFile}' outside of the link process of the Project.Configuration");
-                DependenciesBuiltTargetsLibraryFiles.Add(libraryFile, orderNumber);
+                DependenciesBuiltTargetsLibraryFiles.Add(libraryFile, orderNumber, OrderableStrings.OrderResolve.Greater);
             }
 
             public OrderableStrings DependenciesForceUsingFiles = new OrderableStrings();
@@ -2850,15 +2857,17 @@ private static int SortConfigurationForLink(Configuration l, Configuration r)
 
             internal class DependencyNode
             {
-                internal DependencyNode(Configuration inConfiguration, DependencySetting inDependencySetting)
+                internal DependencyNode(Configuration inConfiguration, DependencySetting inDependencySetting, int autoDependenciesOrder = 0)
                 {
                     _configuration = inConfiguration;
                     _dependencySetting = inDependencySetting;
+                    _autoDependenciesOrder = autoDependenciesOrder;
                 }
 
                 internal Configuration _configuration;
                 internal DependencySetting _dependencySetting;
                 internal Dictionary<DependencyNode, DependencyType> _childNodes = new Dictionary<DependencyNode, DependencyType>();
+                internal int _autoDependenciesOrder;
             }
 
             public class VcxprojUserFileSettings
@@ -3105,8 +3114,9 @@ internal void Link(Builder builder)
                                     if (dependencySetting.HasFlag(DependencySetting.LibraryPaths))
                                         DependenciesOtherLibraryPaths.AddRange(dependency.LibraryPaths);
 
+                                    // Use dependency.TargetFileOrderNumber to make sure to group dependent libraries by their dependencies
                                     if (dependencySetting.HasFlag(DependencySetting.LibraryFiles))
-                                        DependenciesOtherLibraryFiles.AddRange(dependency.LibraryFiles);
+                                        DependenciesOtherLibraryFiles.AddRange(dependency.LibraryFiles, dependency.TargetFileOrderNumber, OrderableStrings.OrderResolve.Greater);
 
                                     if (dependencySetting.HasFlag(DependencySetting.ForceUsingAssembly))
                                         DependenciesForceUsingFiles.AddRange(dependency.ForceUsingFiles);
@@ -3138,8 +3148,9 @@ internal void Link(Builder builder)
                                         if (dependencySetting.HasFlag(DependencySetting.LibraryPaths))
                                             DependenciesOtherLibraryPaths.AddRange(dependency.LibraryPaths);
 
+                                        // Use dependency.TargetFileOrderNumber to make sure to group dependent libraries by their dependencies
                                         if (dependencySetting.HasFlag(DependencySetting.LibraryFiles))
-                                            DependenciesOtherLibraryFiles.AddRange(dependency.LibraryFiles);
+                                            DependenciesOtherLibraryFiles.AddRange(dependency.LibraryFiles, dependency.TargetFileOrderNumber, OrderableStrings.OrderResolve.Greater);
                                     }
                                 }
 
@@ -3303,6 +3314,7 @@ static private DependencyNode BuildDependencyNodeTree(Builder builder, Configura
 
                 Stack<DependencyNode> visiting = new Stack<DependencyNode>();
                 visiting.Push(rootNode);
+
                 while (visiting.Count > 0)
                 {
                     DependencyNode visitedNode = visiting.Pop();
@@ -3322,6 +3334,11 @@ static private DependencyNode BuildDependencyNodeTree(Builder builder, Configura
 
                     visited.Add(visitedConfiguration, visitedNode);
 
+                    if (visitedConfiguration.AutoDependenciesOrder)
+                    {
+                        visitedConfiguration.TargetFileOrderNumber = Math.Max(visitedConfiguration.TargetFileOrderNumber, visitedNode._autoDependenciesOrder);
+                    }
+
                     var unresolvedDependencies = new[] { visitedConfiguration.UnResolvedPublicDependencies, visitedConfiguration.UnResolvedPrivateDependencies };
                     foreach (Dictionary<Type, ITarget> dependencies in unresolvedDependencies)
                     {
@@ -3340,7 +3357,8 @@ static private DependencyNode BuildDependencyNodeTree(Builder builder, Configura
                             if (!visitedConfiguration._dependenciesSetting.TryGetValue(pair, out dependencySetting))
                                 dependencySetting = DependencySetting.Default;
 
-                            DependencyNode childNode = new DependencyNode(dependencyConf, dependencySetting);
+                            // We use steps of 1000 to allow for related libraries to be grouped alongside their dependencies
+                            DependencyNode childNode = new DependencyNode(dependencyConf, dependencySetting, visitedNode._autoDependenciesOrder + 1000);
                             System.Diagnostics.Debug.Assert(!visitedNode._childNodes.ContainsKey(childNode));
                             visitedNode._childNodes.Add(childNode, dependencyType);
 

Sharpmake/Strings.cs

@@ -253,7 +253,14 @@ public void Add(string item)
                 _list.Add(new StringEntry(item));
         }
 
-        public void Add(string item, int orderNumber)
+        public enum OrderResolve
+        {
+            None,
+            Less,
+            Greater
+        }
+
+        public void Add(string item, int orderNumber, OrderResolve resolveMethod = OrderResolve.None)
         {
             if (_hashSet.Add(item))
                 _list.Add(new StringEntry(item, orderNumber));
@@ -268,9 +275,22 @@ public void Add(string item, int orderNumber)
                             _list[i] = new StringEntry(item, orderNumber);
                         else if (_list[i].OrderNumber != orderNumber)
                         {
-                            throw new Error(
-                                "Cannot specify 2 different non-zero order number for \"" +
-                                item + "\": " + _list[i].OrderNumber + " and " + orderNumber);
+                            if (resolveMethod == OrderResolve.Less)
+                            {
+                                if (orderNumber < _list[i].OrderNumber)
+                                    _list[i] = new StringEntry(item, orderNumber);
+                            }
+                            else if (resolveMethod == OrderResolve.Greater)
+                            {
+                                if (orderNumber > _list[i].OrderNumber)
+                                    _list[i] = new StringEntry(item, orderNumber);
+                            }
+                            else
+                            {
+                                throw new Error(
+                                    "Cannot specify 2 different non-zero order number for \"" +
+                                    item + "\": " + _list[i].OrderNumber + " and " + orderNumber);
+                            }
                         }
                     }
                 }
@@ -283,18 +303,20 @@ public void AddRange(IEnumerable<string> collection)
                 Add(item);
         }
 
-        public void AddRange(OrderableStrings collection)
+        public void AddRange(OrderableStrings collection, int outerOrderNumber = 0, OrderResolve resolveMethod = OrderResolve.None)
         {
             List<StringEntry> existingEntriesToAdd = null;
             foreach (var entry in collection._list)
             {
+                var newEntry = new StringEntry(entry.StringValue, entry.OrderNumber + outerOrderNumber);
+
                 if (_hashSet.Add(entry.StringValue))
-                    _list.Add(entry);
-                else if (entry.OrderNumber != 0)  // make sure to have orderNumber
+                    _list.Add(newEntry);
+                else if (newEntry.OrderNumber != 0)  // make sure to have orderNumber
                 {
                     if (existingEntriesToAdd == null)
                         existingEntriesToAdd = new List<StringEntry>();
-                    existingEntriesToAdd.Add(entry);
+                    existingEntriesToAdd.Add(newEntry);
                 }
             }
             if (existingEntriesToAdd != null)
@@ -309,9 +331,22 @@ public void AddRange(OrderableStrings collection)
                             _list[i] = new StringEntry(_list[i].StringValue, orderNumber);
                         else if (_list[i].OrderNumber != orderNumber)
                         {
-                            throw new Error(
-                                "Cannot specify 2 different non-zero order number for \"" +
-                                _list[i].StringValue + "\": " + _list[i].OrderNumber + " and " + orderNumber);
+                            if (resolveMethod == OrderResolve.Less)
+                            {
+                                if (orderNumber < _list[i].OrderNumber)
+                                    _list[i] = new StringEntry(_list[i].StringValue, orderNumber);
+                            }
+                            else if (resolveMethod == OrderResolve.Greater)
+                            {
+                                if (orderNumber > _list[i].OrderNumber)
+                                    _list[i] = new StringEntry(_list[i].StringValue, orderNumber);
+                            }
+                            else
+                            {
+                                throw new Error(
+                                    "Cannot specify 2 different non-zero order number for \"" +
+                                    _list[i].StringValue + "\": " + _list[i].OrderNumber + " and " + orderNumber);
+                            }
                         }
                     }
                 }