Skip to content

Conversation

@lslusarczyk
Copy link
Contributor

@lslusarczyk lslusarczyk commented Nov 19, 2025

Part of #20668 related to making tracing kernels shorter.

Core optimization is based on making checking that traces are disabled as fast & short as possible by

  • use __builtin_expect indicating common path
  • putting all code of non-common path in a separate not inlined function (in cpp)
  • remove "bool ResetCache" parameter and not handling its logic on common path

So inlined check is now just "if" and one function call branch which is a small instruction set and moreover should be optimized out by compiler to non-common path of instructions predicted.

    if (__builtin_expect(SYCLConfigTrace::isTraceInMemCache(), false))
      traceKernelImpl(Msg, KernelName, isFastKernelCache);

By chance I did some refactor

SYCLConfig<SYCL_CACHE_TRACE> is a specialized class but code does not utilize fact that it is a template, that is SyclConfig is never called with generic type which evaluates to SYCL_CACHE_TRACE. Therefore this specialization should be a simple class. This eases coding stuff in it.

// not a valid number, the disk cache tracing will be enabled (depreciated
// behavior). The default value is 0 and no tracing is enabled.
template <> class SYCLConfig<SYCL_CACHE_TRACE> {
class SYCLConfigTrace {
Copy link
Contributor

Choose a reason for hiding this comment

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

As I understand, the main point of optimization is that you removed from the hot path the check if traces are enabled because you changed the reset logic. But why did you replace the template specialization with a new SYCLConfigTrace class? Why not apply this optimization to the SYCLConfig template class, so that it is enabled for all configs?

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 have seen only this one having impact on flamegraphs. You are righ - it is worth to look at other ones and try to unify approach. Changing pattern for others may be a next step. I just wanted to save time now and focus on hunting next perf bottlenecks.

SYCLConfig template class was already specialized for traces. It does not use common code from SYCLConfig. Maybe it is possible to unify this code also for all other config values. Maybe it is not - for some reason we had this specialization. I did not analyzed the rest of variables deeply.

Copy link
Contributor

Choose a reason for hiding this comment

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

It sounds like you suggest accumulating the tech debt in favor of performance.
So, since we already achieved the initial perf targets the pressure from our customers is decreased, so we should look for clean solution instead of intermediate steps.

In that particular case, what was the reason to get rid of template specialization?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It sounds like you suggest accumulating the tech debt in favor of performance.

I do not introduce tech debt. I do not optimize all the code. Just the most important one. I don't do premature optimization.

In that particular case, what was the reason to get rid of template specialization?

Because this particular template specialization is useless. The simpler code, the better. A class without a template is simpler than templated class.

Copy link
Contributor

Choose a reason for hiding this comment

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

Because this particular template specialization is useless. The simpler code, the better. A class without a template is simpler than templated class.

This is exactly my concern: this PR introduces a discrepancy. So far, we have a unified design (maybe not the best) with template specializations for a particular config. Now we have a dedicated class (perhaps it is a simpler approach and more readable) for a particular config.

I do not introduce tech debt. I do not optimize all the code. Just the most important one. I don't do premature optimization.

I agree that we should not do premature optimizations. But in that particular case I just suggest that we need to unify the design for all config types.

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 can change all specialization to concrete classes. I like simplifying the code. Will that be OK for now?

static void trace(const std::string &msg, const std::string &path = "") {
static const bool traceEnabled =
SYCLConfig<SYCL_CACHE_TRACE>::isTraceDiskCache();
static const bool traceEnabled = SYCLConfigTrace::isTraceDiskCache();
Copy link
Contributor

Choose a reason for hiding this comment

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

With your new approach, when the hot path for getting the config value is optimized do we really need this static variable? Can we just do:

if (SYCLConfigTrace::isTraceDiskCache()) {
   ...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point, and with _builtin_expect, fixed in all 3 places

@aelovikov-intel
Copy link
Contributor

PR description should describe what exact optimizations your performed.

It looks to me that at least one of them is to remove if (needsReset) condition because that only happens in unittests, so we can move the reset into a separate internal API. Is that correct? Is there anything else done?

@lslusarczyk
Copy link
Contributor Author

PR description should describe what exact optimizations your performed.

Right. I have updated review description.

It looks to me that at least one of them is to remove if (needsReset) condition because that only happens in unittests, so we can move the reset into a separate internal API. Is that correct? Is there anything else done?

It was this one and a bit more - I've described in PR description.

@lslusarczyk
Copy link
Contributor Author

@vinser52 , @aelovikov-intel , @sergey-semenov , have I addressed/answered your concerns correctly? If so, could you please approve and merge?
There is one fail in CI related to hung test on one windows machine, seems not to be related to my change.

@aelovikov-intel
Copy link
Contributor

@vinser52 , @aelovikov-intel , @sergey-semenov , have I addressed/answered your concerns correctly? If so, could you please approve and merge? There is one fail in CI related to hung test on one windows machine, seems not to be related to my change.

Description is 👍 now, thanks! I'll leave code review to Sergey.

Copy link
Contributor

@sergey-semenov sergey-semenov left a comment

Choose a reason for hiding this comment

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

LGTM assuming the question of SYCL config class consistency gets resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants