Skip to content

ElementLocation optimisations #10029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open

ElementLocation optimisations #10029

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
776ec7a
Remove redundant GetHashCode calls
drewnoakes Apr 17, 2024
37def11
Remove redundant null check
drewnoakes Apr 17, 2024
cb6ec14
Update comment
drewnoakes Apr 17, 2024
093bee7
Null annotate ElementLocation
drewnoakes Apr 18, 2024
65ed4dd
Pack line and column values into four bytes
drewnoakes Apr 18, 2024
bb30e4f
Remove redundant validation
drewnoakes Apr 18, 2024
57e0d5b
Simplify LocationString construction
drewnoakes Apr 18, 2024
80c1ea2
Consolidate validation
drewnoakes Apr 18, 2024
3ea9a86
Simplify names (IDE0001)
drewnoakes Apr 18, 2024
075ce08
Use auto properties
drewnoakes Apr 18, 2024
2f1c078
Use inheritdoc to avoid duplication
drewnoakes Apr 18, 2024
28cfb19
Make field readonly
drewnoakes Apr 18, 2024
2acc628
Use constants
drewnoakes Apr 18, 2024
596c574
Reduce branching when testing line/column values
drewnoakes Apr 18, 2024
d461522
Use pattern matching
drewnoakes Apr 18, 2024
5ef2a4b
Use standard API doc prefix
drewnoakes Apr 18, 2024
2b81d60
Use primary constructor
drewnoakes Apr 18, 2024
fc82d47
Seal private nested classes
drewnoakes Apr 18, 2024
be277f6
Improve hash function
drewnoakes Apr 18, 2024
2653348
Revert field packing
drewnoakes Apr 18, 2024
efb2f9a
Inline field
drewnoakes Apr 19, 2024
4d4a4ee
Pack ElementLocation more efficiently on 64-bit architectures
drewnoakes Apr 22, 2024
e5ab818
Reset the file index before running ElementLocation tests
drewnoakes Apr 22, 2024
c47008b
Simplify test a bit
drewnoakes Apr 22, 2024
be049a8
Add test that shows file index packing
drewnoakes Apr 22, 2024
3fb49a8
Add comment
drewnoakes Apr 22, 2024
c3de378
More info in assertion message
drewnoakes Apr 22, 2024
a3af7bf
Fix assertion
drewnoakes Apr 22, 2024
eeed871
Update test code
drewnoakes Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 67 additions & 165 deletions src/Build/ElementLocation/ElementLocation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
using Microsoft.Build.Collections;
using Microsoft.Build.Shared;

#nullable disable

namespace Microsoft.Build.Construction
{
/// <summary>
Expand All @@ -25,10 +23,10 @@ public abstract class ElementLocation : IElementLocation, ITranslatable, IImmuta
/// <summary>
/// The singleton empty element location.
/// </summary>
private static ElementLocation s_emptyElementLocation = new SmallElementLocation(null, 0, 0);
private static readonly ElementLocation s_emptyElementLocation = new SmallElementLocation("", 0, 0);

/// <summary>
/// The file from which this particular element originated. It may
/// Gets the file from which this particular element originated. It may
/// differ from the ProjectFile if, for instance, it was part of
/// an import or originated in a targets file.
/// If not known, returns empty string.
Expand All @@ -40,7 +38,7 @@ public abstract string File
}

/// <summary>
/// The line number where this element exists in its file.
/// Gets the line number where this element exists in its file.
/// The first line is numbered 1.
/// Zero indicates "unknown location".
/// </summary>
Expand All @@ -51,7 +49,7 @@ public abstract int Line
}

/// <summary>
/// The column number where this element exists in its file.
/// Gets the column number where this element exists in its file.
/// The first column is numbered 1.
/// Zero indicates "unknown location".
/// </summary>
Expand All @@ -62,7 +60,7 @@ public abstract int Column
}

/// <summary>
/// The location in a form suitable for replacement
/// Gets the location in a form suitable for replacement
/// into a message.
/// Example: "c:\foo\bar.csproj (12,34)"
/// Calling this creates and formats a new string.
Expand All @@ -71,7 +69,17 @@ public abstract int Column
/// </summary>
public string LocationString
{
get { return GetLocationString(File, Line, Column); }
get
{
int line = Line;
int column = Column;
return (line, column) switch
{
(not 0, not 0) => ResourceUtilities.FormatResourceStringIgnoreCodeAndKeyword("FileLocation", File, line, column),
(not 0, 0) => $"{File} ({line})",
_ => File,
};
}
}

/// <summary>
Expand All @@ -85,29 +93,17 @@ public static ElementLocation EmptyLocation
get { return s_emptyElementLocation; }
}

/// <summary>
/// Get reasonable hash code.
/// </summary>
/// <inheritdoc />
public override int GetHashCode()
{
// Line and column are good enough
return Line.GetHashCode() ^ Column.GetHashCode();
return Line ^ Column;
}

/// <summary>
/// Override Equals so that identical
/// fields imply equal objects.
/// </summary>
public override bool Equals(object obj)
/// <inheritdoc />
public override bool Equals(object? obj)
{
if (obj == null)
{
return false;
}

IElementLocation that = obj as IElementLocation;

if (that == null)
if (obj is not IElementLocation that)
{
return false;
}
Expand All @@ -125,23 +121,19 @@ public override bool Equals(object obj)
return true;
}

/// <summary>
/// Location of element.
/// </summary>
/// <inheritdoc />
public override string ToString()
{
return LocationString;
}

/// <summary>
/// Writes the packet to the serializer.
/// Always send as ints, even if ushorts are being used: otherwise it'd
/// need a byte to discriminate and the savings would be microscopic.
/// </summary>
/// <inheritdoc />
void ITranslatable.Translate(ITranslator translator)
{
ErrorUtilities.VerifyThrow(translator.Mode == TranslationDirection.WriteToStream, "write only");

// Translate int, even if ushort is being used.
// Internally, the translator uses a variable length (prefix) encoding.
string file = File;
int line = Line;
int column = Column;
Expand All @@ -156,7 +148,7 @@ void ITranslatable.Translate(ITranslator translator)
/// </summary>
internal static ElementLocation FactoryForDeserialization(ITranslator translator)
{
string file = null;
string? file = null;
int line = 0;
int column = 0;
translator.Translate(ref file);
Expand Down Expand Up @@ -185,116 +177,50 @@ internal static ElementLocation Create(string file)
/// In AG there are 600 locations that have a file but zero line and column.
/// In theory yet another derived class could be made for these to save 4 bytes each.
/// </remarks>
internal static ElementLocation Create(string file, int line, int column)
internal static ElementLocation Create(string? file, int line, int column)
{
if (string.IsNullOrEmpty(file) && line == 0 && column == 0)
// Combine line and column values with bitwise OR so we can perform various
// checks on both values in a single comparison, reducing the amount of branching
// in the code.
int combinedValue = line | column;

if (string.IsNullOrEmpty(file) && combinedValue == 0)
{
// When combinedValue is zero, it implies that both line and column are zero.
return EmptyLocation;
}

if (line <= 65535 && column <= 65535)
{
return new ElementLocation.SmallElementLocation(file, line, column);
}
// When combinedValue is negative, it implies that either line or column were negative
ErrorUtilities.VerifyThrow(combinedValue > -1, "Use zero for unknown");

return new ElementLocation.RegularElementLocation(file, line, column);
}
file ??= "";

/// <summary>
/// The location in a form suitable for replacement
/// into a message.
/// Example: "c:\foo\bar.csproj (12,34)"
/// Calling this creates and formats a new string.
/// PREFER TO PUT THE LOCATION INFORMATION AT THE START OF THE MESSAGE INSTEAD.
/// Only in rare cases should the location go within the message itself.
/// </summary>
private static string GetLocationString(string file, int line, int column)
{
string locationString;
if (line != 0 && column != 0)
{
locationString = ResourceUtilities.FormatResourceStringIgnoreCodeAndKeyword("FileLocation", file, line, column);
}
else if (line != 0)
// When combinedValue is less than a threshold, it implies that both line and column are less
// than that threshold.
if (combinedValue <= ushort.MaxValue)
{
locationString = file + " (" + line + ")";
}
else
{
locationString = file;
return new SmallElementLocation(file, line, column);
}

return locationString;
return new RegularElementLocation(file, line, column);
}

/// <summary>
/// Rarer variation for when the line and column won't each fit in a ushort.
/// </summary>
private class RegularElementLocation : ElementLocation
private sealed class RegularElementLocation(string file, int line, int column) : ElementLocation
{
/// <summary>
/// The source file.
/// </summary>
private string file;

/// <summary>
/// The source line.
/// </summary>
private int line;

/// <summary>
/// The source column.
/// </summary>
private int column;

/// <summary>
/// Constructor for the case where we have most or all information.
/// Numerical values must be 1-based, non-negative; 0 indicates unknown
/// File may be null, indicating the file was not loaded from disk.
/// </summary>
internal RegularElementLocation(string file, int line, int column)
{
ErrorUtilities.VerifyThrowArgumentLengthIfNotNull(file, nameof(file));
ErrorUtilities.VerifyThrow(line > -1 && column > -1, "Use zero for unknown");

this.file = file ?? String.Empty;
this.line = line;
this.column = column;
}

/// <summary>
/// The file from which this particular element originated. It may
/// differ from the ProjectFile if, for instance, it was part of
/// an import or originated in a targets file.
/// If not known, returns empty string.
/// </summary>
/// <inheritdoc />
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public override string File
{
get { return file; }
}
public override string File { get; } = file;

/// <summary>
/// The line number where this element exists in its file.
/// The first line is numbered 1.
/// Zero indicates "unknown location".
/// </summary>
/// <inheritdoc />
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public override int Line
{
get { return line; }
}
public override int Line { get; } = line;

/// <summary>
/// The column number where this element exists in its file.
/// The first column is numbered 1.
/// Zero indicates "unknown location".
/// </summary>
/// <inheritdoc />
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public override int Column
{
get { return column; }
}
public override int Column { get; } = column;
}

/// <summary>
Expand All @@ -306,70 +232,46 @@ public override int Column
/// A "very small" variation that used two bytes (or halves of a short) would fit about half of them
/// and save 4 more bytes each, but the CLR packs each field to 4 bytes, so it isn't actually any smaller.
/// </summary>
private class SmallElementLocation : ElementLocation
private sealed class SmallElementLocation : ElementLocation
{
/// <summary>
/// The source file.
/// </summary>
private string file;

/// <summary>
/// The source line.
/// </summary>
private ushort line;

/// <summary>
/// The source column.
/// Packs both the line and column values into a single four-byte element.
/// The high two bytes are the line, and low two bytes are the column.
/// </summary>
private ushort column;
/// <remarks>
/// If we had two <see cref="ushort"/> fields, the CLR would pad them each to
/// four-byte boundaries, meaning no space would actually be saved here.
/// So instead, we pack them manually.
/// </remarks>
private int packedData;

/// <summary>
/// Constructor for the case where we have most or all information.
/// Numerical values must be 1-based, non-negative; 0 indicates unknown
/// File may be null or empty, indicating the file was not loaded from disk.
/// File may empty, indicating the file was not loaded from disk.
/// </summary>
internal SmallElementLocation(string file, int line, int column)
{
ErrorUtilities.VerifyThrow(line > -1 && column > -1, "Use zero for unknown");
ErrorUtilities.VerifyThrow(line <= 65535 && column <= 65535, "Use ElementLocation instead");

this.file = file ?? String.Empty;
this.line = Convert.ToUInt16(line);
this.column = Convert.ToUInt16(column);
File = file;
packedData = (line << 16) | column;
}

/// <summary>
/// The file from which this particular element originated. It may
/// differ from the ProjectFile if, for instance, it was part of
/// an import or originated in a targets file.
/// If not known, returns empty string.
/// </summary>
/// <inheritdoc />
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public override string File
{
get { return file; }
}
public override string File { get; }

/// <summary>
/// The line number where this element exists in its file.
/// The first line is numbered 1.
/// Zero indicates "unknown location".
/// </summary>
/// <inheritdoc />
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public override int Line
{
get { return (int)line; }
get { return (packedData >> 16) & 0xFFFF; }
}

/// <summary>
/// The column number where this element exists in its file.
/// The first column is numbered 1.
/// Zero indicates "unknown location".
/// </summary>
/// <inheritdoc />
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
public override int Column
{
get { return (int)column; }
get { return packedData & ushort.MaxValue; }
}
}
}
Expand Down
4 changes: 3 additions & 1 deletion src/Shared/ErrorUtilities.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,17 +537,19 @@ internal static void VerifyThrowArgumentInvalidPath(string parameter, string par
}
}

#nullable enable
/// <summary>
/// Throws an ArgumentException if the string has zero length, unless it is
/// null, in which case no exception is thrown.
/// </summary>
internal static void VerifyThrowArgumentLengthIfNotNull(string parameter, string parameterName)
internal static void VerifyThrowArgumentLengthIfNotNull(string? parameter, string parameterName)
{
if (parameter?.Length == 0)
{
ThrowArgumentLength(parameterName);
}
}
#nullable disable

/// <summary>
/// Throws an ArgumentNullException if the given parameter is null.
Expand Down
Loading