Skip to content

Simplify and fix the detection of XEL fields / actions #117

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

Merged
arvindshmicrosoft merged 1 commit into from
Mar 26, 2023
+12 −26
Merged

Simplify and fix the detection of XEL fields / actions #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions Engine/StackResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ public class StackResolver : IDisposable {
private static readonly Regex rgxAlreadySymbolizedFrame = new (@"((?<framenum>\d+)\s+)*(?<module>\w+)(\.(dll|exe))*!(?<symbolizedfunc>.+?)\s*\+\s*(0[xX])*(?<offset>[0-9a-fA-F]+)\s*", rgxOptions);
private static readonly Regex rgxmoduleaddress = new (@"^\s*(?<filepath>.+)(\t+| +)(?<baseaddress>(0x)?[0-9a-fA-F`]+)\s*$", RegexOptions.Multiline);

public Task<Tuple<List<string>, List<string>>> GetDistinctXELFieldsAsync(string[] xelFiles, int eventsToSample, CancellationTokenSource cts) {
return XELHelper.GetDistinctXELActionsFieldsAsync(xelFiles, eventsToSample, cts);
public Task<Tuple<List<string>, List<string>>> GetDistinctXELFieldsAsync(string[] xelFiles, int eventsToSample) {
return XELHelper.GetDistinctXELActionsFieldsAsync(xelFiles, eventsToSample);
}

/// Public method which to help import XEL files
Expand Down
16 changes: 7 additions & 9 deletions Engine/XELHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,29 +78,27 @@ await xeStream.ReadEventStream(evt => {
});
}

internal async static Task<Tuple<List<string>, List<string>>> GetDistinctXELActionsFieldsAsync(string[] xelFiles, int eventsToSampleFromEachFile, CancellationTokenSource cts) {
internal async static Task<Tuple<List<string>, List<string>>> GetDistinctXELActionsFieldsAsync(string[] xelFiles, int eventsToSampleFromEachFile) {
return await Task.Run(async () => {
Contract.Requires(xelFiles != null && eventsToSampleFromEachFile > 0);
var allActions = new HashSet<string>();
var allFields = new HashSet<string>();
bool internalCancel = false;
foreach (var file in xelFiles) {
var numEvents = 0;
var xeStream = new XEFileEventStreamer(file);
try {
// If preceeding file had issued an "internal cancel" (due to number of sampled events reached)
// then create a new CTS to ensure subsequent files (if any) are also sampled correctly.
using var cts = new CancellationTokenSource();
await xeStream.ReadEventStream(evt => {
if (Interlocked.Increment(ref numEvents) > eventsToSampleFromEachFile) {
internalCancel = true;
cts.Cancel();
}
if (Interlocked.Increment(ref numEvents) > eventsToSampleFromEachFile) cts.Cancel();
lock (allActions) evt.Actions.Select(action => allActions.Add(action.Key)).Count();
lock (allFields) evt.Fields.Select(field => allFields.Add(field.Key)).Count();
return Task.CompletedTask;
}, cts.Token);
} catch (AggregateException e) {
if (e.InnerException is OperationCanceledException) if (!internalCancel) return new Tuple<List<string>, List<string>>(new List<string>(), new List<string>());
else throw;
} catch (OperationCanceledException) { if (!internalCancel) return new Tuple<List<string>, List<string>>(new List<string>(), new List<string>()); }
if (e.InnerException is not OperationCanceledException) throw;
} catch (OperationCanceledException) { /* nothing to do, as cancel the operation at the end of sampling */ }
}

return new Tuple<List<string>, List<string>>(allActions.OrderBy(k => k).ToList(), allFields.OrderBy(k => k).ToList());
Expand Down
3 changes: 1 addition & 2 deletions GUI/MainForm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,9 +223,8 @@ private async void CallStackInput_DragDrop(object sender, DragEventArgs e) {

private async Task<List<string>> GetUserSelectedXEFieldsAsync(string[] fileNames) {
using var fieldsListDialog = new FieldSelection();
using var cts = new CancellationTokenSource();
fieldsListDialog.Text = "Select relevant XEvent fields";
var xeEventItems = await this._resolver.GetDistinctXELFieldsAsync(fileNames, 1000, cts);
var xeEventItems = await this._resolver.GetDistinctXELFieldsAsync(fileNames, 1000);
if (xeEventItems.Item1.Count + xeEventItems.Item2.Count == 0) return new List<string>();
fieldsListDialog.AllActions = xeEventItems.Item1;
fieldsListDialog.AllFields = xeEventItems.Item2;
Expand Down
15 changes: 2 additions & 13 deletions Tests/Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,7 @@ private string PrepareLargeXEventInput() {

[TestMethod][TestCategory("Unit")] public async Task XELActionsAndFieldsAsync() {
using var csr = new StackResolver();
using var cts = new CancellationTokenSource();
var ret = await csr.GetDistinctXELFieldsAsync(new[] { @"..\..\..\Tests\TestCases\ImportXEL\xe_wait_completed_0_132353446563350000.xel" }, 1000, cts);
var ret = await csr.GetDistinctXELFieldsAsync(new[] { @"..\..\..\Tests\TestCases\ImportXEL\xe_wait_completed_0_132353446563350000.xel" }, 5);
Assert.AreEqual(1, ret.Item1.Count); // just the callstack action
Assert.AreEqual("callstack", ret.Item1.First()); // verify the name
Assert.AreEqual(5, ret.Item2.Count); // 5 fields
Expand All @@ -316,8 +315,7 @@ private string PrepareLargeXEventInput() {

[TestMethod][TestCategory("Unit")] public async Task XELActionsAndFieldsAsyncMultipleFiles() {
using var csr = new StackResolver();
using var cts = new CancellationTokenSource();
var ret = await csr.GetDistinctXELFieldsAsync(new[] { @"..\..\..\Tests\TestCases\ImportXEL\xe_wait_completed_0_132353446563350000.xel", @"..\..\..\Tests\TestCases\ImportXEL\XESpins_0_131627061603030000.xel" }, 1000, cts);
var ret = await csr.GetDistinctXELFieldsAsync(new[] { @"..\..\..\Tests\TestCases\ImportXEL\xe_wait_completed_0_132353446563350000.xel", @"..\..\..\Tests\TestCases\ImportXEL\XESpins_0_131627061603030000.xel" }, 5);
Assert.AreEqual(1, ret.Item1.Count); // just the callstack action
Assert.AreEqual("callstack", ret.Item1.First()); // verify the name
Assert.AreEqual(9, ret.Item2.Count); // 9 fields in total across the 2 XEL files
Expand Down Expand Up @@ -776,15 +774,6 @@ private string PrepareLargeXEventInput() {
Assert.AreEqual(0, xelTask.Result.Item1);
Assert.AreEqual(StackResolver.OperationCanceled, xelTask.Result.Item2);

using var cts2 = new CancellationTokenSource();
var xelFieldsTask = csr.GetDistinctXELFieldsAsync(new[] { @"..\..\..\Tests\TestCases\ImportXEL\XESpins_0_131627061603030000.xel" }, int.MaxValue, cts2);
while (true) {
if (xelFieldsTask.Wait(StackResolver.OperationWaitIntervalMilliseconds)) break;
cts2.Cancel();
}
Assert.AreEqual(0, xelFieldsTask.Result.Item1.Count);
Assert.AreEqual(0, xelFieldsTask.Result.Item2.Count);

Assert.IsTrue(csr.ProcessBaseAddresses(@"c:\mssql\binn\sqldk.dll 00000001`00400000"));
var xeventInput = PrepareLargeXEventInput().ToString();
using var cts3 = new CancellationTokenSource();
Expand Down