Skip to content
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.

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

add binary xml version to xml benchmarks #2557

Merged
merged 3 commits into from Mar 10, 2023

Conversation

Daniel-Svensson
Copy link
Contributor

@Daniel-Svensson Daniel-Svensson commented Aug 15, 2022

As suggested by @danmoseley in dotnet/runtime#73336 (comment)

This should help protect performance for binary xml scenarios such as corewcf.

Apart from PR mentioned above this should also cover the changes in

And generally make Datacontractserializer changes easier to spot since binary xml has lower overhead than text based version

@danmoseley
Copy link
Member

@StephenMolloy could you review? I'm not familiar with the API.

[Benchmark(Description = nameof(XmlDictionaryReader))]
public T DataContractSerializer_BinaryXml_()
{
((IXmlBinaryReaderInitializer)xmlDictionaryReader).SetInput(memoryBytes, 0, memoryBytes.Length, null, XmlDictionaryReaderQuotas.Max, null, null);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xmlDictionaryReader).SetInput

Consider using [IterationSetup] for this step. (https://github.com/dotnet/performance/blob/main/docs/microbenchmark-design-guidelines.md#iterationsetup)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did so earlier for my own benchmarks but that was not very successful for this case.

I think it might be fair game to benchmark with the SetInput call since that is needed for any real world scenario (corewcf , OpenRiaServices etc) where you want to read one "xml document" at a time but pool readers/writers for reuse.

When using iterationsetup the method itself should be quite long running (i think either above guidance or some other guidance says 100ms+) so it must process a lot of objects.

However I have prepared an alternative version using OperationsPerInvoke at https://github.com/Daniel-Svensson/dotnet_performance/tree/remote_setoutput with commit
128fcdf if you rather want that one. It will instead read N (100 but I am open for any value) similar objects inside a single "root" element. So the overhead will go from <= 1% to maybe 0,01% of the execution time, but will no longer match the other benchmarks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danmoseley Do you prefer the current version which mimics the end user scenario or should the binary xml version of the benchmarks serialize many more objects than the other benchmark versions ?

unless the ci-failures are related to the changes here I think this is ready for possible merge.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is @StephenMolloy area to answer..

Copy link
Member

@StephenMolloy StephenMolloy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple small comments. But looks fine otherwise.

@Daniel-Svensson
Copy link
Contributor Author

@StephenMolloy, do you think the current version looks fine and is ready to merge?

Most of your comments are fixed, except iterationsetup (see comment above on why).

@StephenMolloy
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@StephenMolloy StephenMolloy merged commit cc6f516 into dotnet:main Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants