onednn-src 0.1.13

/*******************************************************************************
* Copyright 2020 Intel Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/

#include "ittnotify.hpp"
#include "utils.hpp"

#if defined(DNNL_ENABLE_ITT_TASKS)
#include "dnnl_debug.h"
#include "ittnotify/ittnotify.h"
#endif

namespace dnnl {
namespace impl {
namespace itt {

static setting_t<int> itt_task_level {__itt_task_level_high};

bool get_itt(__itt_task_level level) {
    if (!itt_task_level.initialized()) {
        // Assumes that all threads see the same environment
        static int val
                = getenv_int_user("ITT_TASK_LEVEL", itt_task_level.get());
        itt_task_level.set(val);
    }
    return level <= itt_task_level.get();
}

__itt_id make_itt_id(const char *tname, double stamp) {
    return __itt_id_make(
            const_cast<char *>(tname), static_cast<uint64_t>(stamp));
}

#if defined(DNNL_ENABLE_ITT_TASKS)

namespace {

thread_local primitive_kind_t thread_primitive_kind;
thread_local const char *thread_primitive_info;
thread_local const char *thread_primitive_log_kind;
thread_local __itt_id thread_primitive_task_id;
__itt_string_handle *thread_primitive_meta_fmt
        = __itt_string_handle_create("%s");

__itt_domain *itt_domain(const char *log_kind) {

    const bool is_exec = (std::strncmp(log_kind, "exec", sizeof("exec")) == 0);
    assert(is_exec
            || (std::strncmp(log_kind, "create", sizeof("create")) == 0));

    if (is_exec) {
        static __itt_domain *d_exec
                = __itt_domain_create("dnnl::primitive::execute");
        return d_exec;
    } else {
        static __itt_domain *d_create
                = __itt_domain_create("dnnl::primitive::create");
        return d_create;
    }
}

} // namespace

void primitive_task_start(primitive_kind_t kind, const char *log_kind) {
    if (kind == primitive_kind::undefined) return;
    __itt_domain *pd_domain = itt_domain(log_kind);
#define CASE(x) \
    __itt_string_handle_create(dnnl_prim_kind2str(primitive_kind::x))
    static __itt_string_handle *prim_kind_itt_strings[] = {
            CASE(undefined),
            CASE(reorder),
            CASE(shuffle),
            CASE(concat),
            CASE(sum),
            CASE(convolution),
            CASE(deconvolution),
            CASE(eltwise),
            CASE(lrn),
            CASE(batch_normalization),
            CASE(inner_product),
            CASE(rnn),
            CASE(gemm),
            CASE(binary),
            CASE(matmul),
            CASE(resampling),
            CASE(pooling),
            CASE(reduction),
            CASE(prelu),
            CASE(softmax),
            CASE(layer_normalization),
            CASE(group_normalization),
            CASE(sdpa),
            CASE(gated_mlp),
    };
#undef CASE
    int kind_idx = (int)kind;
    assert(kind_idx >= 0);
    if (kind_idx < primitive_kind::internal_only_start
            && (size_t)kind_idx < sizeof(prim_kind_itt_strings)
                            / sizeof(prim_kind_itt_strings[0])) {
        __itt_task_begin(pd_domain, thread_primitive_task_id, __itt_null,
                prim_kind_itt_strings[kind_idx]);
    }
    thread_primitive_kind = kind;
    thread_primitive_log_kind = log_kind;
}

void primitive_add_metadata_and_id(
        const char *pd_info, const char *log_kind, __itt_id task_id) {
    // A separate method for adding metadata and IDs to the primitive ITT tasks
    // provide the option to skip this step during primitive operation to avoid
    // performance impact from construction of very large metadata strings.
    if (thread_primitive_kind == primitive_kind::undefined) return;

    __itt_domain *pd_domain = itt_domain(log_kind);
    __itt_formatted_metadata_add(pd_domain, thread_primitive_meta_fmt, pd_info);
    thread_primitive_info = pd_info;

    // While the task ID is unique for each instance of the primitive operation,
    // it is shared across multi-threaded executions of the same instance.
    thread_primitive_task_id = task_id;
    __itt_id_create(pd_domain, thread_primitive_task_id);
}

primitive_kind_t primitive_task_get_current_kind() {
    return thread_primitive_kind;
}

const char *primitive_task_get_current_info() {
    return thread_primitive_info;
}

const char *primitive_task_get_current_log_kind() {
    return thread_primitive_log_kind;
}

__itt_id primitive_task_get_itt_id() {
    return thread_primitive_task_id;
}

void primitive_task_end(const char *log_kind) {
    if (thread_primitive_kind != primitive_kind::undefined) {
        __itt_task_end(itt_domain(log_kind));
        thread_primitive_kind = primitive_kind::undefined;
        thread_primitive_info = nullptr;
        thread_primitive_log_kind = nullptr;
        // The ITT ID must always be destroyed after the task ends as it
        // can break task-ID association - the ITT task expects
        // the ID to remain valid for the entire task lifetime.
        __itt_id_destroy(itt_domain(log_kind), thread_primitive_task_id);
        thread_primitive_task_id = __itt_null;
    }
}
#else
void primitive_task_start(primitive_kind_t kind) {
    UNUSED(kind);
}
primitive_kind_t primitive_task_get_current_kind() {
    return primitive_kind::undefined;
}
const char *primitive_task_get_current_info() {
    return "";
}
const char *primitive_task_get_current_log_kind() {
    return "";
}
__itt_id primitive_task_get_itt_id() {
    return __itt_null;
}
void primitive_task_end(const char *log_kind) {}
#endif

} // namespace itt
} // namespace impl
} // namespace dnnl