rocm-systems/source/lib/omnitrace/library/causal/components/blocking_gotcha.cpp

// MIT License
//
// Copyright (c) 2022 Advanced Micro Devices, Inc. All Rights Reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include "library/causal/components/blocking_gotcha.hpp"
#include "core/config.hpp"
#include "core/debug.hpp"
#include "core/state.hpp"
#include "library/causal/delay.hpp"
#include "library/causal/experiment.hpp"
#include "library/runtime.hpp"

#include <timemory/components/macros.hpp>
#include <timemory/hash/types.hpp>

#include <csignal>
#include <cstdint>
#include <pthread.h>
#include <stdexcept>

namespace omnitrace
{
namespace causal
{
namespace component
{
std::string
blocking_gotcha::label()
{
    return "causal_blocking_gotcha";
}

std::string
blocking_gotcha::description()
{
    return "Handles executing all necessary pauses before the thread performs some "
           "blocking function";
}

void
blocking_gotcha::preinit()
{
    configure();
}

void
blocking_gotcha::configure()
{
    blocking_gotcha_t::get_initializer() = []() {
        if(!config::get_use_causal()) return;

        blocking_gotcha_t::configure(
            comp::gotcha_config<0, int, pthread_mutex_t*>{ "pthread_mutex_lock" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<1, int, pthread_mutex_t*>{ "pthread_mutex_trylock" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<2, int, pthread_rwlock_t*>{ "pthread_rwlock_wrlock" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<3, int, pthread_rwlock_t*>{ "pthread_rwlock_trywrlock" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<4, int, pthread_spinlock_t*>{ "pthread_spin_lock" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<5, int, pthread_spinlock_t*>{ "pthread_spin_trylock" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<6, int, pthread_t, void**>{ "pthread_join" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<7, int, pthread_cond_t*, pthread_mutex_t*>{
                "pthread_cond_wait" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<8, int, pthread_cond_t*, pthread_mutex_t*,
                                const struct timespec*>{ "pthread_cond_timedwait" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<9, int, const sigset_t*, int*>{ "sigwait" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<10, int, const sigset_t*, int*, siginfo_t*>{
                "sigwaitinfo" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<11, int, const sigset_t*, int*, siginfo_t*,
                                const struct timespec*>{ "sigtimedwait" });

        blocking_gotcha_t::configure(
            comp::gotcha_config<12, int, const sigset_t*>{ "sigsuspend" });
    };
}

void
blocking_gotcha::shutdown()
{
    blocking_gotcha_t::disable();
}

void
blocking_gotcha::start()
{
    if(causal::experiment::is_active() &&
       get_thread_state() == ::omnitrace::ThreadState::Enabled && delay_value == 0)
        delay_value = causal::delay::get_global().load();
}

void
blocking_gotcha::audit(const comp::gotcha_data& _data, audit::outgoing, int _ret)
{
    // if one of the try/timed functions did not succeed, reset the delay value to zero
    if(_ret != 0 && _ret != ETIMEDOUT &&
       std::set<size_t>{ 1, 3, 5, 8, 11 }.count(_data.index) > 0)
    {
        delay_value = 0;
    }
}

void
blocking_gotcha::stop()
{
    if(delay_value > 0 && causal::experiment::is_active() &&
       get_thread_state() == ::omnitrace::ThreadState::Enabled)
    {
        causal::delay::postblock(delay_value);
        delay_value = 0;
    }
}
}  // namespace component
}  // namespace causal
}  // namespace omnitrace

TIMEMORY_INVOKE_PREINIT(omnitrace::causal::component::blocking_gotcha)